1 /* Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
3 Free Software Foundation, Inc.
4 Contributed by Andy Vaught
5 F2003 I/O support contributed by Jerry DeLisle
7 This file is part of the GNU Fortran runtime library (libgfortran).
9 Libgfortran is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3, or (at your option)
14 Libgfortran is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 Under Section 7 of GPL version 3, you are granted additional
20 permissions described in the GCC Runtime Library Exception, version
21 3.1, as published by the Free Software Foundation.
23 You should have received a copy of the GNU General Public License and
24 a copy of the GCC Runtime Library Exception along with this program;
25 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
26 <http://www.gnu.org/licenses/>. */
28 /* Unix stream I/O module */
44 /* For mingw, we don't identify files by their inode number, but by a
45 64-bit identifier created from a BY_HANDLE_FILE_INFORMATION. */
48 #define WIN32_LEAN_AND_MEAN
51 #if !defined(_FILE_OFFSET_BITS) || _FILE_OFFSET_BITS != 64
53 #define lseek _lseeki64
55 #define fstat _fstati64
60 #ifndef HAVE_WORKING_STAT
62 id_from_handle (HANDLE hFile)
64 BY_HANDLE_FILE_INFORMATION FileInformation;
66 if (hFile == INVALID_HANDLE_VALUE)
69 memset (&FileInformation, 0, sizeof(FileInformation));
70 if (!GetFileInformationByHandle (hFile, &FileInformation))
73 return ((uint64_t) FileInformation.nFileIndexLow)
74 | (((uint64_t) FileInformation.nFileIndexHigh) << 32);
79 id_from_path (const char *path)
84 if (!path || !*path || access (path, F_OK))
87 hFile = CreateFile (path, 0, 0, NULL, OPEN_EXISTING,
88 FILE_FLAG_BACKUP_SEMANTICS | FILE_ATTRIBUTE_READONLY,
90 res = id_from_handle (hFile);
97 id_from_fd (const int fd)
99 return id_from_handle ((HANDLE) _get_osfhandle (fd));
106 #define PATH_MAX 1024
109 /* These flags aren't defined on all targets (mingw32), so provide them
142 /* Fallback implementation of access() on systems that don't have it.
143 Only modes R_OK, W_OK and F_OK are used in this file. */
146 fallback_access (const char *path, int mode)
150 if ((mode & R_OK) && (fd = open (path, O_RDONLY)) < 0)
154 if ((mode & W_OK) && (fd = open (path, O_WRONLY)) < 0)
161 return stat (path, &st);
168 #define access fallback_access
172 /* Unix and internal stream I/O module */
174 static const int BUFFER_SIZE = 8192;
180 gfc_offset buffer_offset; /* File offset of the start of the buffer */
181 gfc_offset physical_offset; /* Current physical file offset */
182 gfc_offset logical_offset; /* Current logical file offset */
183 gfc_offset file_length; /* Length of the file, -1 if not seekable. */
185 char *buffer; /* Pointer to the buffer. */
186 int fd; /* The POSIX file descriptor. */
188 int active; /* Length of valid bytes in the buffer */
190 int ndirty; /* Dirty bytes starting at buffer_offset */
192 int special_file; /* =1 if the fd refers to a special file */
194 /* Cached stat(2) values. */
201 /* fix_fd()-- Given a file descriptor, make sure it is not one of the
202 * standard descriptors, returning a non-standard descriptor. If the
203 * user specifies that system errors should go to standard output,
204 * then closes standard output, we don't want the system errors to a
205 * file that has been given file descriptor 1 or 0. We want to send
206 * the error to the invalid descriptor. */
212 int input, output, error;
214 input = output = error = 0;
216 /* Unix allocates the lowest descriptors first, so a loop is not
217 required, but this order is. */
218 if (fd == STDIN_FILENO)
223 if (fd == STDOUT_FILENO)
228 if (fd == STDERR_FILENO)
235 close (STDIN_FILENO);
237 close (STDOUT_FILENO);
239 close (STDERR_FILENO);
246 /* If the stream corresponds to a preconnected unit, we flush the
247 corresponding C stream. This is bugware for mixed C-Fortran codes
248 where the C code doesn't flush I/O before returning. */
250 flush_if_preconnected (stream * s)
254 fd = ((unix_stream *) s)->fd;
255 if (fd == STDIN_FILENO)
257 else if (fd == STDOUT_FILENO)
259 else if (fd == STDERR_FILENO)
264 /********************************************************************
265 Raw I/O functions (read, write, seek, tell, truncate, close).
267 These functions wrap the basic POSIX I/O syscalls. Any deviation in
268 semantics is a bug, except the following: write restarts in case
269 of being interrupted by a signal, and as the first argument the
270 functions take the unix_stream struct rather than an integer file
271 descriptor. Also, for POSIX read() and write() a nbyte argument larger
272 than SSIZE_MAX is undefined; here the type of nbyte is ssize_t rather
273 than size_t as for POSIX read/write.
274 *********************************************************************/
277 raw_flush (unix_stream * s __attribute__ ((unused)))
283 raw_read (unix_stream * s, void * buf, ssize_t nbyte)
285 /* For read we can't do I/O in a loop like raw_write does, because
286 that will break applications that wait for interactive I/O. */
287 return read (s->fd, buf, nbyte);
291 raw_write (unix_stream * s, const void * buf, ssize_t nbyte)
293 ssize_t trans, bytes_left;
297 buf_st = (char *) buf;
299 /* We must write in a loop since some systems don't restart system
300 calls in case of a signal. */
301 while (bytes_left > 0)
303 trans = write (s->fd, buf_st, bytes_left);
315 return nbyte - bytes_left;
319 raw_seek (unix_stream * s, gfc_offset offset, int whence)
321 return lseek (s->fd, offset, whence);
325 raw_tell (unix_stream * s)
327 return lseek (s->fd, 0, SEEK_CUR);
331 raw_truncate (unix_stream * s, gfc_offset length)
342 h = (HANDLE) _get_osfhandle (s->fd);
343 if (h == INVALID_HANDLE_VALUE)
348 cur = lseek (s->fd, 0, SEEK_CUR);
351 if (lseek (s->fd, length, SEEK_SET) == -1)
353 if (!SetEndOfFile (h))
358 if (lseek (s->fd, cur, SEEK_SET) == -1)
362 lseek (s->fd, cur, SEEK_SET);
364 #elif defined HAVE_FTRUNCATE
365 return ftruncate (s->fd, length);
366 #elif defined HAVE_CHSIZE
367 return chsize (s->fd, length);
369 runtime_error ("required ftruncate or chsize support not present");
375 raw_close (unix_stream * s)
379 if (s->fd != STDOUT_FILENO
380 && s->fd != STDERR_FILENO
381 && s->fd != STDIN_FILENO)
382 retval = close (s->fd);
390 raw_init (unix_stream * s)
392 s->st.read = (void *) raw_read;
393 s->st.write = (void *) raw_write;
394 s->st.seek = (void *) raw_seek;
395 s->st.tell = (void *) raw_tell;
396 s->st.trunc = (void *) raw_truncate;
397 s->st.close = (void *) raw_close;
398 s->st.flush = (void *) raw_flush;
405 /*********************************************************************
406 Buffered I/O functions. These functions have the same semantics as the
407 raw I/O functions above, except that they are buffered in order to
408 improve performance. The buffer must be flushed when switching from
409 reading to writing and vice versa.
410 *********************************************************************/
413 buf_flush (unix_stream * s)
417 /* Flushing in read mode means discarding read bytes. */
423 if (s->file_length != -1 && s->physical_offset != s->buffer_offset
424 && lseek (s->fd, s->buffer_offset, SEEK_SET) < 0)
427 writelen = raw_write (s, s->buffer, s->ndirty);
429 s->physical_offset = s->buffer_offset + writelen;
431 /* Don't increment file_length if the file is non-seekable. */
432 if (s->file_length != -1 && s->physical_offset > s->file_length)
433 s->file_length = s->physical_offset;
435 s->ndirty -= writelen;
447 buf_read (unix_stream * s, void * buf, ssize_t nbyte)
450 s->buffer_offset = s->logical_offset;
452 /* Is the data we want in the buffer? */
453 if (s->logical_offset + nbyte <= s->buffer_offset + s->active
454 && s->buffer_offset <= s->logical_offset)
455 memcpy (buf, s->buffer + (s->logical_offset - s->buffer_offset), nbyte);
458 /* First copy the active bytes if applicable, then read the rest
459 either directly or filling the buffer. */
462 ssize_t to_read, did_read;
463 gfc_offset new_logical;
466 if (s->logical_offset >= s->buffer_offset
467 && s->buffer_offset + s->active >= s->logical_offset)
469 nread = s->active - (s->logical_offset - s->buffer_offset);
470 memcpy (buf, s->buffer + (s->logical_offset - s->buffer_offset),
474 /* At this point we consider all bytes in the buffer discarded. */
475 to_read = nbyte - nread;
476 new_logical = s->logical_offset + nread;
477 if (s->file_length != -1 && s->physical_offset != new_logical
478 && lseek (s->fd, new_logical, SEEK_SET) < 0)
480 s->buffer_offset = s->physical_offset = new_logical;
481 if (to_read <= BUFFER_SIZE/2)
483 did_read = raw_read (s, s->buffer, BUFFER_SIZE);
484 s->physical_offset += did_read;
485 s->active = did_read;
486 did_read = (did_read > to_read) ? to_read : did_read;
487 memcpy (p, s->buffer, did_read);
491 did_read = raw_read (s, p, to_read);
492 s->physical_offset += did_read;
495 nbyte = did_read + nread;
497 s->logical_offset += nbyte;
502 buf_write (unix_stream * s, const void * buf, ssize_t nbyte)
505 s->buffer_offset = s->logical_offset;
507 /* Does the data fit into the buffer? As a special case, if the
508 buffer is empty and the request is bigger than BUFFER_SIZE/2,
509 write directly. This avoids the case where the buffer would have
510 to be flushed at every write. */
511 if (!(s->ndirty == 0 && nbyte > BUFFER_SIZE/2)
512 && s->logical_offset + nbyte <= s->buffer_offset + BUFFER_SIZE
513 && s->buffer_offset <= s->logical_offset
514 && s->buffer_offset + s->ndirty >= s->logical_offset)
516 memcpy (s->buffer + (s->logical_offset - s->buffer_offset), buf, nbyte);
517 int nd = (s->logical_offset - s->buffer_offset) + nbyte;
523 /* Flush, and either fill the buffer with the new data, or if
524 the request is bigger than the buffer size, write directly
525 bypassing the buffer. */
527 if (nbyte <= BUFFER_SIZE/2)
529 memcpy (s->buffer, buf, nbyte);
530 s->buffer_offset = s->logical_offset;
535 if (s->file_length != -1 && s->physical_offset != s->logical_offset)
537 if (lseek (s->fd, s->logical_offset, SEEK_SET) < 0)
539 s->physical_offset = s->logical_offset;
542 nbyte = raw_write (s, buf, nbyte);
543 s->physical_offset += nbyte;
546 s->logical_offset += nbyte;
547 /* Don't increment file_length if the file is non-seekable. */
548 if (s->file_length != -1 && s->logical_offset > s->file_length)
549 s->file_length = s->logical_offset;
554 buf_seek (unix_stream * s, gfc_offset offset, int whence)
561 offset += s->logical_offset;
564 offset += s->file_length;
574 s->logical_offset = offset;
579 buf_tell (unix_stream * s)
581 return s->logical_offset;
585 buf_truncate (unix_stream * s, gfc_offset length)
589 if (buf_flush (s) != 0)
591 r = raw_truncate (s, length);
593 s->file_length = length;
598 buf_close (unix_stream * s)
600 if (buf_flush (s) != 0)
603 return raw_close (s);
607 buf_init (unix_stream * s)
609 s->st.read = (void *) buf_read;
610 s->st.write = (void *) buf_write;
611 s->st.seek = (void *) buf_seek;
612 s->st.tell = (void *) buf_tell;
613 s->st.trunc = (void *) buf_truncate;
614 s->st.close = (void *) buf_close;
615 s->st.flush = (void *) buf_flush;
617 s->buffer = get_mem (BUFFER_SIZE);
622 /*********************************************************************
623 memory stream functions - These are used for internal files
625 The idea here is that a single stream structure is created and all
626 requests must be satisfied from it. The location and size of the
627 buffer is the character variable supplied to the READ or WRITE
630 *********************************************************************/
633 mem_alloc_r (stream * strm, int * len)
635 unix_stream * s = (unix_stream *) strm;
637 gfc_offset where = s->logical_offset;
639 if (where < s->buffer_offset || where > s->buffer_offset + s->active)
642 n = s->buffer_offset + s->active - where;
646 s->logical_offset = where + *len;
648 return s->buffer + (where - s->buffer_offset);
653 mem_alloc_r4 (stream * strm, int * len)
655 unix_stream * s = (unix_stream *) strm;
657 gfc_offset where = s->logical_offset;
659 if (where < s->buffer_offset || where > s->buffer_offset + s->active)
662 n = s->buffer_offset + s->active - where;
666 s->logical_offset = where + *len;
668 return s->buffer + (where - s->buffer_offset) * 4;
673 mem_alloc_w (stream * strm, int * len)
675 unix_stream * s = (unix_stream *) strm;
677 gfc_offset where = s->logical_offset;
681 if (where < s->buffer_offset)
684 if (m > s->file_length)
687 s->logical_offset = m;
689 return s->buffer + (where - s->buffer_offset);
694 mem_alloc_w4 (stream * strm, int * len)
696 unix_stream * s = (unix_stream *) strm;
698 gfc_offset where = s->logical_offset;
699 gfc_char4_t *result = (gfc_char4_t *) s->buffer;
703 if (where < s->buffer_offset)
706 if (m > s->file_length)
709 s->logical_offset = m;
710 return &result[where - s->buffer_offset];
714 /* Stream read function for character(kine=1) internal units. */
717 mem_read (stream * s, void * buf, ssize_t nbytes)
722 p = mem_alloc_r (s, &nb);
733 /* Stream read function for chracter(kind=4) internal units. */
736 mem_read4 (stream * s, void * buf, ssize_t nbytes)
741 p = mem_alloc_r (s, &nb);
752 /* Stream write function for character(kind=1) internal units. */
755 mem_write (stream * s, const void * buf, ssize_t nbytes)
760 p = mem_alloc_w (s, &nb);
771 /* Stream write function for character(kind=4) internal units. */
774 mem_write4 (stream * s, const void * buf, ssize_t nwords)
779 p = mem_alloc_w4 (s, &nw);
783 *p++ = (gfc_char4_t) *((char *) buf);
792 mem_seek (stream * strm, gfc_offset offset, int whence)
794 unix_stream * s = (unix_stream *) strm;
800 offset += s->logical_offset;
803 offset += s->file_length;
809 /* Note that for internal array I/O it's actually possible to have a
810 negative offset, so don't check for that. */
811 if (offset > s->file_length)
817 s->logical_offset = offset;
819 /* Returning < 0 is the error indicator for sseek(), so return 0 if
820 offset is negative. Thus if the return value is 0, the caller
821 has to use stell() to get the real value of logical_offset. */
829 mem_tell (stream * s)
831 return ((unix_stream *)s)->logical_offset;
836 mem_truncate (unix_stream * s __attribute__ ((unused)),
837 gfc_offset length __attribute__ ((unused)))
844 mem_flush (unix_stream * s __attribute__ ((unused)))
851 mem_close (unix_stream * s)
860 /*********************************************************************
861 Public functions -- A reimplementation of this module needs to
862 define functional equivalents of the following.
863 *********************************************************************/
865 /* open_internal()-- Returns a stream structure from a character(kind=1)
869 open_internal (char *base, int length, gfc_offset offset)
873 s = get_mem (sizeof (unix_stream));
874 memset (s, '\0', sizeof (unix_stream));
877 s->buffer_offset = offset;
879 s->logical_offset = 0;
880 s->active = s->file_length = length;
882 s->st.close = (void *) mem_close;
883 s->st.seek = (void *) mem_seek;
884 s->st.tell = (void *) mem_tell;
885 s->st.trunc = (void *) mem_truncate;
886 s->st.read = (void *) mem_read;
887 s->st.write = (void *) mem_write;
888 s->st.flush = (void *) mem_flush;
893 /* open_internal4()-- Returns a stream structure from a character(kind=4)
897 open_internal4 (char *base, int length, gfc_offset offset)
901 s = get_mem (sizeof (unix_stream));
902 memset (s, '\0', sizeof (unix_stream));
905 s->buffer_offset = offset;
907 s->logical_offset = 0;
908 s->active = s->file_length = length;
910 s->st.close = (void *) mem_close;
911 s->st.seek = (void *) mem_seek;
912 s->st.tell = (void *) mem_tell;
913 s->st.trunc = (void *) mem_truncate;
914 s->st.read = (void *) mem_read4;
915 s->st.write = (void *) mem_write4;
916 s->st.flush = (void *) mem_flush;
922 /* fd_to_stream()-- Given an open file descriptor, build a stream
926 fd_to_stream (int fd)
931 s = get_mem (sizeof (unix_stream));
932 memset (s, '\0', sizeof (unix_stream));
935 s->buffer_offset = 0;
936 s->physical_offset = 0;
937 s->logical_offset = 0;
939 /* Get the current length of the file. */
941 fstat (fd, &statbuf);
943 s->st_dev = statbuf.st_dev;
944 s->st_ino = statbuf.st_ino;
945 s->special_file = !S_ISREG (statbuf.st_mode);
947 if (S_ISREG (statbuf.st_mode))
948 s->file_length = statbuf.st_size;
949 else if (S_ISBLK (statbuf.st_mode))
951 /* Hopefully more portable than ioctl(fd, BLKGETSIZE64, &size)? */
952 gfc_offset cur = lseek (fd, 0, SEEK_CUR);
953 s->file_length = lseek (fd, 0, SEEK_END);
954 lseek (fd, cur, SEEK_SET);
959 if (!(S_ISREG (statbuf.st_mode) || S_ISBLK (statbuf.st_mode))
960 || options.all_unbuffered
961 ||(options.unbuffered_preconnected &&
962 (s->fd == STDIN_FILENO
963 || s->fd == STDOUT_FILENO
964 || s->fd == STDERR_FILENO))
974 /* Given the Fortran unit number, convert it to a C file descriptor. */
977 unit_to_fd (int unit)
982 us = find_unit (unit);
986 fd = ((unix_stream *) us->s)->fd;
992 /* unpack_filename()-- Given a fortran string and a pointer to a
993 * buffer that is PATH_MAX characters, convert the fortran string to a
994 * C string in the buffer. Returns nonzero if this is not possible. */
997 unpack_filename (char *cstring, const char *fstring, int len)
1001 len = fstrlen (fstring, len);
1002 if (len >= PATH_MAX)
1005 memmove (cstring, fstring, len);
1006 cstring[len] = '\0';
1012 /* tempfile()-- Generate a temporary filename for a scratch file and
1013 * open it. mkstemp() opens the file for reading and writing, but the
1014 * library mode prevents anything that is not allowed. The descriptor
1015 * is returned, which is -1 on error. The template is pointed to by
1016 * opp->file, which is copied into the unit structure
1017 * and freed later. */
1020 tempfile (st_parameter_open *opp)
1022 const char *tempdir;
1024 const char *slash = "/";
1028 #ifndef HAVE_MKSTEMP
1033 tempdir = getenv ("GFORTRAN_TMPDIR");
1035 if (tempdir == NULL)
1037 char buffer[MAX_PATH + 1];
1039 ret = GetTempPath (MAX_PATH, buffer);
1040 /* If we are not able to get a temp-directory, we use
1041 current directory. */
1042 if (ret > MAX_PATH || !ret)
1046 tempdir = strdup (buffer);
1049 if (tempdir == NULL)
1050 tempdir = getenv ("TMP");
1051 if (tempdir == NULL)
1052 tempdir = getenv ("TEMP");
1053 if (tempdir == NULL)
1054 tempdir = DEFAULT_TEMPDIR;
1057 /* Check for special case that tempdir contains slash
1058 or backslash at end. */
1059 tempdirlen = strlen (tempdir);
1060 if (*tempdir == 0 || tempdir[tempdirlen - 1] == '/'
1062 || tempdir[tempdirlen - 1] == '\\'
1067 // Take care that the template is longer in the mktemp() branch.
1068 template = get_mem (tempdirlen + 23);
1071 sprintf (template, "%s%sgfortrantmpXXXXXX", tempdir, slash);
1073 fd = mkstemp (template);
1075 #else /* HAVE_MKSTEMP */
1078 slashlen = strlen (slash);
1081 sprintf (template, "%s%sgfortrantmpaaaXXXXXX", tempdir, slash);
1085 template[tempdirlen + slashlen + 13] = 'a' + (c% 26);
1087 template[tempdirlen + slashlen + 12] = 'a' + (c % 26);
1089 template[tempdirlen + slashlen + 11] = 'a' + (c % 26);
1094 if (!mktemp (template))
1101 #if defined(HAVE_CRLF) && defined(O_BINARY)
1102 fd = open (template, O_RDWR | O_CREAT | O_EXCL | O_BINARY,
1103 S_IREAD | S_IWRITE);
1105 fd = open (template, O_RDWR | O_CREAT | O_EXCL, S_IREAD | S_IWRITE);
1108 while (fd == -1 && errno == EEXIST);
1109 #endif /* HAVE_MKSTEMP */
1111 opp->file = template;
1112 opp->file_len = strlen (template); /* Don't include trailing nul */
1118 /* regular_file()-- Open a regular file.
1119 * Change flags->action if it is ACTION_UNSPECIFIED on entry,
1120 * unless an error occurs.
1121 * Returns the descriptor, which is less than zero on error. */
1124 regular_file (st_parameter_open *opp, unit_flags *flags)
1126 char path[PATH_MAX + 1];
1132 if (unpack_filename (path, opp->file, opp->file_len))
1134 errno = ENOENT; /* Fake an OS error */
1139 if (opp->file_len == 7)
1141 if (strncmp (path, "CONOUT$", 7) == 0
1142 || strncmp (path, "CONERR$", 7) == 0)
1144 fd = open ("/dev/conout", O_WRONLY);
1145 flags->action = ACTION_WRITE;
1150 if (opp->file_len == 6 && strncmp (path, "CONIN$", 6) == 0)
1152 fd = open ("/dev/conin", O_RDONLY);
1153 flags->action = ACTION_READ;
1160 if (opp->file_len == 7)
1162 if (strncmp (path, "CONOUT$", 7) == 0
1163 || strncmp (path, "CONERR$", 7) == 0)
1165 fd = open ("CONOUT$", O_WRONLY);
1166 flags->action = ACTION_WRITE;
1171 if (opp->file_len == 6 && strncmp (path, "CONIN$", 6) == 0)
1173 fd = open ("CONIN$", O_RDONLY);
1174 flags->action = ACTION_READ;
1181 switch (flags->action)
1191 case ACTION_READWRITE:
1192 case ACTION_UNSPECIFIED:
1197 internal_error (&opp->common, "regular_file(): Bad action");
1200 switch (flags->status)
1203 crflag = O_CREAT | O_EXCL;
1206 case STATUS_OLD: /* open will fail if the file does not exist*/
1210 case STATUS_UNKNOWN:
1211 case STATUS_SCRATCH:
1215 case STATUS_REPLACE:
1216 crflag = O_CREAT | O_TRUNC;
1220 internal_error (&opp->common, "regular_file(): Bad status");
1223 /* rwflag |= O_LARGEFILE; */
1225 #if defined(HAVE_CRLF) && defined(O_BINARY)
1229 mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
1230 fd = open (path, rwflag | crflag, mode);
1231 if (flags->action != ACTION_UNSPECIFIED)
1236 flags->action = ACTION_READWRITE;
1239 if (errno != EACCES && errno != EROFS)
1242 /* retry for read-only access */
1244 fd = open (path, rwflag | crflag, mode);
1247 flags->action = ACTION_READ;
1248 return fd; /* success */
1251 if (errno != EACCES)
1252 return fd; /* failure */
1254 /* retry for write-only access */
1256 fd = open (path, rwflag | crflag, mode);
1259 flags->action = ACTION_WRITE;
1260 return fd; /* success */
1262 return fd; /* failure */
1266 /* open_external()-- Open an external file, unix specific version.
1267 * Change flags->action if it is ACTION_UNSPECIFIED on entry.
1268 * Returns NULL on operating system error. */
1271 open_external (st_parameter_open *opp, unit_flags *flags)
1275 if (flags->status == STATUS_SCRATCH)
1277 fd = tempfile (opp);
1278 if (flags->action == ACTION_UNSPECIFIED)
1279 flags->action = ACTION_READWRITE;
1281 #if HAVE_UNLINK_OPEN_FILE
1282 /* We can unlink scratch files now and it will go away when closed. */
1289 /* regular_file resets flags->action if it is ACTION_UNSPECIFIED and
1291 fd = regular_file (opp, flags);
1298 return fd_to_stream (fd);
1302 /* input_stream()-- Return a stream pointer to the default input stream.
1303 * Called on initialization. */
1308 return fd_to_stream (STDIN_FILENO);
1312 /* output_stream()-- Return a stream pointer to the default output stream.
1313 * Called on initialization. */
1316 output_stream (void)
1320 #if defined(HAVE_CRLF) && defined(HAVE_SETMODE)
1321 setmode (STDOUT_FILENO, O_BINARY);
1324 s = fd_to_stream (STDOUT_FILENO);
1329 /* error_stream()-- Return a stream pointer to the default error stream.
1330 * Called on initialization. */
1337 #if defined(HAVE_CRLF) && defined(HAVE_SETMODE)
1338 setmode (STDERR_FILENO, O_BINARY);
1341 s = fd_to_stream (STDERR_FILENO);
1346 /* st_vprintf()-- vprintf function for error output. To avoid buffer
1347 overruns, we limit the length of the buffer to ST_VPRINTF_SIZE. 2k
1348 is big enough to completely fill a 80x25 terminal, so it shuld be
1349 OK. We use a direct write() because it is simpler and least likely
1350 to be clobbered by memory corruption. Writing an error message
1351 longer than that is an error. */
1353 #define ST_VPRINTF_SIZE 2048
1356 st_vprintf (const char *format, va_list ap)
1358 static char buffer[ST_VPRINTF_SIZE];
1362 fd = options.use_stderr ? STDERR_FILENO : STDOUT_FILENO;
1363 #ifdef HAVE_VSNPRINTF
1364 written = vsnprintf(buffer, ST_VPRINTF_SIZE, format, ap);
1366 written = vsprintf(buffer, format, ap);
1368 if (written >= ST_VPRINTF_SIZE-1)
1370 /* The error message was longer than our buffer. Ouch. Because
1371 we may have messed up things badly, report the error and
1373 #define ERROR_MESSAGE "Internal error: buffer overrun in st_vprintf()\n"
1374 write (fd, buffer, ST_VPRINTF_SIZE-1);
1375 write (fd, ERROR_MESSAGE, strlen(ERROR_MESSAGE));
1377 #undef ERROR_MESSAGE
1382 written = write (fd, buffer, written);
1386 /* st_printf()-- printf() function for error output. This just calls
1387 st_vprintf() to do the actual work. */
1390 st_printf (const char *format, ...)
1394 va_start (ap, format);
1395 written = st_vprintf(format, ap);
1401 /* compare_file_filename()-- Given an open stream and a fortran string
1402 * that is a filename, figure out if the file is the same as the
1406 compare_file_filename (gfc_unit *u, const char *name, int len)
1408 char path[PATH_MAX + 1];
1410 #ifdef HAVE_WORKING_STAT
1418 if (unpack_filename (path, name, len))
1419 return 0; /* Can't be the same */
1421 /* If the filename doesn't exist, then there is no match with the
1424 if (stat (path, &st) < 0)
1427 #ifdef HAVE_WORKING_STAT
1428 s = (unix_stream *) (u->s);
1429 return (st.st_dev == s->st_dev) && (st.st_ino == s->st_ino);
1433 /* We try to match files by a unique ID. On some filesystems (network
1434 fs and FAT), we can't generate this unique ID, and will simply compare
1436 id1 = id_from_path (path);
1437 id2 = id_from_fd (((unix_stream *) (u->s))->fd);
1439 return (id1 == id2);
1442 if (len != u->file_len)
1444 return (memcmp(path, u->file, len) == 0);
1449 #ifdef HAVE_WORKING_STAT
1450 # define FIND_FILE0_DECL struct stat *st
1451 # define FIND_FILE0_ARGS st
1453 # define FIND_FILE0_DECL uint64_t id, const char *file, gfc_charlen_type file_len
1454 # define FIND_FILE0_ARGS id, file, file_len
1457 /* find_file0()-- Recursive work function for find_file() */
1460 find_file0 (gfc_unit *u, FIND_FILE0_DECL)
1463 #if defined(__MINGW32__) && !HAVE_WORKING_STAT
1470 #ifdef HAVE_WORKING_STAT
1473 unix_stream *s = (unix_stream *) (u->s);
1474 if (st[0].st_dev == s->st_dev && st[0].st_ino == s->st_ino)
1479 if (u->s && ((id1 = id_from_fd (((unix_stream *) u->s)->fd)) || id1))
1486 if (compare_string (u->file_len, u->file, file_len, file) == 0)
1490 v = find_file0 (u->left, FIND_FILE0_ARGS);
1494 v = find_file0 (u->right, FIND_FILE0_ARGS);
1502 /* find_file()-- Take the current filename and see if there is a unit
1503 * that has the file already open. Returns a pointer to the unit if so. */
1506 find_file (const char *file, gfc_charlen_type file_len)
1508 char path[PATH_MAX + 1];
1511 #if defined(__MINGW32__) && !HAVE_WORKING_STAT
1515 if (unpack_filename (path, file, file_len))
1518 if (stat (path, &st[0]) < 0)
1521 #if defined(__MINGW32__) && !HAVE_WORKING_STAT
1522 id = id_from_path (path);
1525 __gthread_mutex_lock (&unit_lock);
1527 u = find_file0 (unit_root, FIND_FILE0_ARGS);
1531 if (! __gthread_mutex_trylock (&u->lock))
1533 /* assert (u->closed == 0); */
1534 __gthread_mutex_unlock (&unit_lock);
1538 inc_waiting_locked (u);
1540 __gthread_mutex_unlock (&unit_lock);
1543 __gthread_mutex_lock (&u->lock);
1546 __gthread_mutex_lock (&unit_lock);
1547 __gthread_mutex_unlock (&u->lock);
1548 if (predec_waiting_locked (u) == 0)
1553 dec_waiting_unlocked (u);
1559 flush_all_units_1 (gfc_unit *u, int min_unit)
1563 if (u->unit_number > min_unit)
1565 gfc_unit *r = flush_all_units_1 (u->left, min_unit);
1569 if (u->unit_number >= min_unit)
1571 if (__gthread_mutex_trylock (&u->lock))
1575 __gthread_mutex_unlock (&u->lock);
1583 flush_all_units (void)
1588 __gthread_mutex_lock (&unit_lock);
1591 u = flush_all_units_1 (unit_root, min_unit);
1593 inc_waiting_locked (u);
1594 __gthread_mutex_unlock (&unit_lock);
1598 __gthread_mutex_lock (&u->lock);
1600 min_unit = u->unit_number + 1;
1605 __gthread_mutex_lock (&unit_lock);
1606 __gthread_mutex_unlock (&u->lock);
1607 (void) predec_waiting_locked (u);
1611 __gthread_mutex_lock (&unit_lock);
1612 __gthread_mutex_unlock (&u->lock);
1613 if (predec_waiting_locked (u) == 0)
1621 /* delete_file()-- Given a unit structure, delete the file associated
1622 * with the unit. Returns nonzero if something went wrong. */
1625 delete_file (gfc_unit * u)
1627 char path[PATH_MAX + 1];
1629 if (unpack_filename (path, u->file, u->file_len))
1630 { /* Shouldn't be possible */
1635 return unlink (path);
1639 /* file_exists()-- Returns nonzero if the current filename exists on
1643 file_exists (const char *file, gfc_charlen_type file_len)
1645 char path[PATH_MAX + 1];
1647 if (unpack_filename (path, file, file_len))
1650 return !(access (path, F_OK));
1654 /* file_size()-- Returns the size of the file. */
1657 file_size (const char *file, gfc_charlen_type file_len)
1659 char path[PATH_MAX + 1];
1660 struct stat statbuf;
1662 if (unpack_filename (path, file, file_len))
1665 if (stat (path, &statbuf) < 0)
1668 return (GFC_IO_INT) statbuf.st_size;
1671 static const char yes[] = "YES", no[] = "NO", unknown[] = "UNKNOWN";
1673 /* inquire_sequential()-- Given a fortran string, determine if the
1674 * file is suitable for sequential access. Returns a C-style
1678 inquire_sequential (const char *string, int len)
1680 char path[PATH_MAX + 1];
1681 struct stat statbuf;
1683 if (string == NULL ||
1684 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1687 if (S_ISREG (statbuf.st_mode) ||
1688 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1691 if (S_ISDIR (statbuf.st_mode) || S_ISBLK (statbuf.st_mode))
1698 /* inquire_direct()-- Given a fortran string, determine if the file is
1699 * suitable for direct access. Returns a C-style string. */
1702 inquire_direct (const char *string, int len)
1704 char path[PATH_MAX + 1];
1705 struct stat statbuf;
1707 if (string == NULL ||
1708 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1711 if (S_ISREG (statbuf.st_mode) || S_ISBLK (statbuf.st_mode))
1714 if (S_ISDIR (statbuf.st_mode) ||
1715 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1722 /* inquire_formatted()-- Given a fortran string, determine if the file
1723 * is suitable for formatted form. Returns a C-style string. */
1726 inquire_formatted (const char *string, int len)
1728 char path[PATH_MAX + 1];
1729 struct stat statbuf;
1731 if (string == NULL ||
1732 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1735 if (S_ISREG (statbuf.st_mode) ||
1736 S_ISBLK (statbuf.st_mode) ||
1737 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1740 if (S_ISDIR (statbuf.st_mode))
1747 /* inquire_unformatted()-- Given a fortran string, determine if the file
1748 * is suitable for unformatted form. Returns a C-style string. */
1751 inquire_unformatted (const char *string, int len)
1753 return inquire_formatted (string, len);
1757 /* inquire_access()-- Given a fortran string, determine if the file is
1758 * suitable for access. */
1761 inquire_access (const char *string, int len, int mode)
1763 char path[PATH_MAX + 1];
1765 if (string == NULL || unpack_filename (path, string, len) ||
1766 access (path, mode) < 0)
1773 /* inquire_read()-- Given a fortran string, determine if the file is
1774 * suitable for READ access. */
1777 inquire_read (const char *string, int len)
1779 return inquire_access (string, len, R_OK);
1783 /* inquire_write()-- Given a fortran string, determine if the file is
1784 * suitable for READ access. */
1787 inquire_write (const char *string, int len)
1789 return inquire_access (string, len, W_OK);
1793 /* inquire_readwrite()-- Given a fortran string, determine if the file is
1794 * suitable for read and write access. */
1797 inquire_readwrite (const char *string, int len)
1799 return inquire_access (string, len, R_OK | W_OK);
1803 /* file_length()-- Return the file length in bytes, -1 if unknown */
1806 file_length (stream * s)
1808 gfc_offset curr, end;
1809 if (!is_seekable (s))
1814 end = sseek (s, 0, SEEK_END);
1815 sseek (s, curr, SEEK_SET);
1820 /* is_seekable()-- Return nonzero if the stream is seekable, zero if
1824 is_seekable (stream *s)
1826 /* By convention, if file_length == -1, the file is not
1828 return ((unix_stream *) s)->file_length!=-1;
1832 /* is_special()-- Return nonzero if the stream is not a regular file. */
1835 is_special (stream *s)
1837 return ((unix_stream *) s)->special_file;
1842 stream_isatty (stream *s)
1844 return isatty (((unix_stream *) s)->fd);
1848 stream_ttyname (stream *s __attribute__ ((unused)),
1849 char * buf __attribute__ ((unused)),
1850 size_t buflen __attribute__ ((unused)))
1852 #ifdef HAVE_TTYNAME_R
1853 return ttyname_r (((unix_stream *) s)->fd, buf, buflen);
1854 #elif defined HAVE_TTYNAME
1857 p = ttyname (((unix_stream *) s)->fd);
1863 memcpy (buf, p, plen);
1873 /* How files are stored: This is an operating-system specific issue,
1874 and therefore belongs here. There are three cases to consider.
1877 Records are written as block of bytes corresponding to the record
1878 length of the file. This goes for both formatted and unformatted
1879 records. Positioning is done explicitly for each data transfer,
1880 so positioning is not much of an issue.
1882 Sequential Formatted:
1883 Records are separated by newline characters. The newline character
1884 is prohibited from appearing in a string. If it does, this will be
1885 messed up on the next read. End of file is also the end of a record.
1887 Sequential Unformatted:
1888 In this case, we are merely copying bytes to and from main storage,
1889 yet we need to keep track of varying record lengths. We adopt
1890 the solution used by f2c. Each record contains a pair of length
1893 Length of record n in bytes
1895 Length of record n in bytes
1897 Length of record n+1 in bytes
1899 Length of record n+1 in bytes
1901 The length is stored at the end of a record to allow backspacing to the
1902 previous record. Between data transfer statements, the file pointer
1903 is left pointing to the first length of the current record.
1905 ENDFILE records are never explicitly stored.