1 /* Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007
2 Free Software Foundation, Inc.
3 Contributed by Andy Vaught
5 This file is part of the GNU Fortran 95 runtime library (libgfortran).
7 Libgfortran is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 In addition to the permissions in the GNU General Public License, the
13 Free Software Foundation gives you unlimited permission to link the
14 compiled version of this file into combinations with other programs,
15 and to distribute those combinations without any restriction coming
16 from the use of this file. (The General Public License restrictions
17 do apply in other respects; for example, they cover modification of
18 the file, and distribution when not linked into a combine
21 Libgfortran is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with Libgfortran; see the file COPYING. If not, write to
28 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
29 Boston, MA 02110-1301, USA. */
31 /* Unix stream I/O module */
47 #include "libgfortran.h"
51 #define SSIZE_MAX SHRT_MAX
66 /* These flags aren't defined on all targets (mingw32), so provide them
85 /* Unix stream I/O module */
87 #define BUFFER_SIZE 8192
94 gfc_offset buffer_offset; /* File offset of the start of the buffer */
95 gfc_offset physical_offset; /* Current physical file offset */
96 gfc_offset logical_offset; /* Current logical file offset */
97 gfc_offset dirty_offset; /* Start of modified bytes in buffer */
98 gfc_offset file_length; /* Length of the file, -1 if not seekable. */
101 int len; /* Physical length of the current buffer */
102 int active; /* Length of valid bytes in the buffer */
105 int ndirty; /* Dirty bytes starting at dirty_offset */
107 int special_file; /* =1 if the fd refers to a special file */
109 unsigned unbuffered:1;
111 char small_buffer[BUFFER_SIZE];
116 extern stream *init_error_stream (unix_stream *);
117 internal_proto(init_error_stream);
120 /* This implementation of stream I/O is based on the paper:
122 * "Exploiting the advantages of mapped files for stream I/O",
123 * O. Krieger, M. Stumm and R. Umrau, "Proceedings of the 1992 Winter
124 * USENIX conference", p. 27-42.
126 * It differs in a number of ways from the version described in the
127 * paper. First of all, threads are not an issue during I/O and we
128 * also don't have to worry about having multiple regions, since
129 * fortran's I/O model only allows you to be one place at a time.
131 * On the other hand, we have to be able to writing at the end of a
132 * stream, read from the start of a stream or read and write blocks of
133 * bytes from an arbitrary position. After opening a file, a pointer
134 * to a stream structure is returned, which is used to handle file
135 * accesses until the file is closed.
137 * salloc_at_r(stream, len, where)-- Given a stream pointer, return a
138 * pointer to a block of memory that mirror the file at position
139 * 'where' that is 'len' bytes long. The len integer is updated to
140 * reflect how many bytes were actually read. The only reason for a
141 * short read is end of file. The file pointer is updated. The
142 * pointer is valid until the next call to salloc_*.
144 * salloc_at_w(stream, len, where)-- Given the stream pointer, returns
145 * a pointer to a block of memory that is updated to reflect the state
146 * of the file. The length of the buffer is always equal to that
147 * requested. The buffer must be completely set by the caller. When
148 * data has been written, the sfree() function must be called to
149 * indicate that the caller is done writing data to the buffer. This
150 * may or may not cause a physical write.
152 * Short forms of these are salloc_r() and salloc_w() which drop the
153 * 'where' parameter and use the current file pointer. */
156 /*move_pos_offset()-- Move the record pointer right or left
157 *relative to current position */
160 move_pos_offset (stream* st, int pos_off)
162 unix_stream * str = (unix_stream*)st;
165 str->logical_offset += pos_off;
167 if (str->dirty_offset + str->ndirty > str->logical_offset)
169 if (str->ndirty + pos_off > 0)
170 str->ndirty += pos_off;
173 str->dirty_offset += pos_off + pos_off;
184 /* fix_fd()-- Given a file descriptor, make sure it is not one of the
185 * standard descriptors, returning a non-standard descriptor. If the
186 * user specifies that system errors should go to standard output,
187 * then closes standard output, we don't want the system errors to a
188 * file that has been given file descriptor 1 or 0. We want to send
189 * the error to the invalid descriptor. */
194 int input, output, error;
196 input = output = error = 0;
198 /* Unix allocates the lowest descriptors first, so a loop is not
199 required, but this order is. */
201 if (fd == STDIN_FILENO)
206 if (fd == STDOUT_FILENO)
211 if (fd == STDERR_FILENO)
218 close (STDIN_FILENO);
220 close (STDOUT_FILENO);
222 close (STDERR_FILENO);
228 is_preconnected (stream * s)
232 fd = ((unix_stream *) s)->fd;
233 if (fd == STDIN_FILENO || fd == STDOUT_FILENO || fd == STDERR_FILENO)
239 /* If the stream corresponds to a preconnected unit, we flush the
240 corresponding C stream. This is bugware for mixed C-Fortran codes
241 where the C code doesn't flush I/O before returning. */
243 flush_if_preconnected (stream * s)
247 fd = ((unix_stream *) s)->fd;
248 if (fd == STDIN_FILENO)
250 else if (fd == STDOUT_FILENO)
252 else if (fd == STDERR_FILENO)
257 /* Reset a stream after reading/writing. Assumes that the buffers have
261 reset_stream (unix_stream * s, size_t bytes_rw)
263 s->physical_offset += bytes_rw;
264 s->logical_offset = s->physical_offset;
265 if (s->file_length != -1 && s->physical_offset > s->file_length)
266 s->file_length = s->physical_offset;
270 /* Read bytes into a buffer, allowing for short reads. If the nbytes
271 * argument is less on return than on entry, it is because we've hit
272 * the end of file. */
275 do_read (unix_stream * s, void * buf, size_t * nbytes)
283 bytes_left = *nbytes;
284 buf_st = (char *) buf;
286 /* We must read in a loop since some systems don't restart system
287 calls in case of a signal. */
288 while (bytes_left > 0)
290 /* Requests between SSIZE_MAX and SIZE_MAX are undefined by SUSv3,
291 so we must read in chunks smaller than SSIZE_MAX. */
292 trans = (bytes_left < SSIZE_MAX) ? bytes_left : SSIZE_MAX;
293 trans = read (s->fd, buf_st, trans);
304 else if (trans == 0) /* We hit EOF. */
310 *nbytes -= bytes_left;
315 /* Write a buffer to a stream, allowing for short writes. */
318 do_write (unix_stream * s, const void * buf, size_t * nbytes)
326 bytes_left = *nbytes;
327 buf_st = (char *) buf;
329 /* We must write in a loop since some systems don't restart system
330 calls in case of a signal. */
331 while (bytes_left > 0)
333 /* Requests between SSIZE_MAX and SIZE_MAX are undefined by SUSv3,
334 so we must write in chunks smaller than SSIZE_MAX. */
335 trans = (bytes_left < SSIZE_MAX) ? bytes_left : SSIZE_MAX;
336 trans = write (s->fd, buf_st, trans);
351 *nbytes -= bytes_left;
356 /* get_oserror()-- Get the most recent operating system error. For
357 * unix, this is errno. */
362 return strerror (errno);
366 /* sys_exit()-- Terminate the program with an exit code */
375 /*********************************************************************
376 File descriptor stream functions
377 *********************************************************************/
380 /* fd_flush()-- Write bytes that need to be written */
383 fd_flush (unix_stream * s)
390 if (s->file_length != -1 && s->physical_offset != s->dirty_offset &&
391 lseek (s->fd, s->dirty_offset, SEEK_SET) < 0)
394 writelen = s->ndirty;
395 if (do_write (s, s->buffer + (s->dirty_offset - s->buffer_offset),
399 s->physical_offset = s->dirty_offset + writelen;
401 /* don't increment file_length if the file is non-seekable */
402 if (s->file_length != -1 && s->physical_offset > s->file_length)
403 s->file_length = s->physical_offset;
405 s->ndirty -= writelen;
413 /* fd_alloc()-- Arrange a buffer such that the salloc() request can be
414 * satisfied. This subroutine gets the buffer ready for whatever is
418 fd_alloc (unix_stream * s, gfc_offset where,
419 int *len __attribute__ ((unused)))
424 if (*len <= BUFFER_SIZE)
426 new_buffer = s->small_buffer;
427 read_len = BUFFER_SIZE;
431 new_buffer = get_mem (*len);
435 /* Salvage bytes currently within the buffer. This is important for
436 * devices that cannot seek. */
438 if (s->buffer != NULL && s->buffer_offset <= where &&
439 where <= s->buffer_offset + s->active)
442 n = s->active - (where - s->buffer_offset);
443 memmove (new_buffer, s->buffer + (where - s->buffer_offset), n);
448 { /* new buffer starts off empty */
452 s->buffer_offset = where;
454 /* free the old buffer if necessary */
456 if (s->buffer != NULL && s->buffer != s->small_buffer)
457 free_mem (s->buffer);
459 s->buffer = new_buffer;
464 /* fd_alloc_r_at()-- Allocate a stream buffer for reading. Either
465 * we've already buffered the data or we need to load it. Returns
466 * NULL on I/O error. */
469 fd_alloc_r_at (unix_stream * s, int *len, gfc_offset where)
474 where = s->logical_offset;
476 if (s->buffer != NULL && s->buffer_offset <= where &&
477 where + *len <= s->buffer_offset + s->active)
480 /* Return a position within the current buffer */
482 s->logical_offset = where + *len;
483 return s->buffer + where - s->buffer_offset;
486 fd_alloc (s, where, len);
488 m = where + s->active;
490 if (s->physical_offset != m && lseek (s->fd, m, SEEK_SET) < 0)
493 /* do_read() hangs on read from terminals for *BSD-systems. Only
494 use read() in that case. */
500 n = read (s->fd, s->buffer + s->active, s->len - s->active);
504 s->physical_offset = where + n;
511 n = s->len - s->active;
512 if (do_read (s, s->buffer + s->active, &n) != 0)
515 s->physical_offset = where + n;
519 if (s->active < *len)
520 *len = s->active; /* Bytes actually available */
522 s->logical_offset = where + *len;
528 /* fd_alloc_w_at()-- Allocate a stream buffer for writing. Either
529 * we've already buffered the data or we need to load it. */
532 fd_alloc_w_at (unix_stream * s, int *len, gfc_offset where)
537 where = s->logical_offset;
539 if (s->buffer == NULL || s->buffer_offset > where ||
540 where + *len > s->buffer_offset + s->len)
543 if (fd_flush (s) == FAILURE)
545 fd_alloc (s, where, len);
548 /* Return a position within the current buffer */
550 || where > s->dirty_offset + s->ndirty
551 || s->dirty_offset > where + *len)
552 { /* Discontiguous blocks, start with a clean buffer. */
553 /* Flush the buffer. */
556 s->dirty_offset = where;
561 gfc_offset start; /* Merge with the existing data. */
562 if (where < s->dirty_offset)
565 start = s->dirty_offset;
566 if (where + *len > s->dirty_offset + s->ndirty)
567 s->ndirty = where + *len - start;
569 s->ndirty = s->dirty_offset + s->ndirty - start;
570 s->dirty_offset = start;
573 s->logical_offset = where + *len;
575 /* Don't increment file_length if the file is non-seekable. */
577 if (s->file_length != -1 && s->logical_offset > s->file_length)
578 s->file_length = s->logical_offset;
580 n = s->logical_offset - s->buffer_offset;
584 return s->buffer + where - s->buffer_offset;
589 fd_sfree (unix_stream * s)
591 if (s->ndirty != 0 &&
592 (s->buffer != s->small_buffer || options.all_unbuffered ||
601 fd_seek (unix_stream * s, gfc_offset offset)
604 if (s->file_length == -1)
607 if (s->physical_offset == offset) /* Are we lucky and avoid syscall? */
609 s->logical_offset = offset;
613 s->physical_offset = s->logical_offset = offset;
616 return (lseek (s->fd, offset, SEEK_SET) < 0) ? FAILURE : SUCCESS;
620 /* truncate_file()-- Given a unit, truncate the file at the current
621 * position. Sets the physical location to the new end of the file.
622 * Returns nonzero on error. */
625 fd_truncate (unix_stream * s)
627 /* Non-seekable files, like terminals and fifo's fail the lseek so just
628 return success, there is nothing to truncate. If its not a pipe there
629 is a real problem. */
630 if (lseek (s->fd, s->logical_offset, SEEK_SET) == -1)
638 /* Using ftruncate on a seekable special file (like /dev/null)
639 is undefined, so we treat it as if the ftruncate succeeded. */
640 #ifdef HAVE_FTRUNCATE
641 if (s->special_file || ftruncate (s->fd, s->logical_offset))
644 if (s->special_file || chsize (s->fd, s->logical_offset))
648 s->physical_offset = s->file_length = 0;
652 s->physical_offset = s->file_length = s->logical_offset;
658 /* Similar to memset(), but operating on a stream instead of a string.
659 Takes care of not using too much memory. */
662 fd_sset (unix_stream * s, int c, size_t n)
670 while (bytes_left > 0)
672 /* memset() in chunks of BUFFER_SIZE. */
673 trans = (bytes_left < BUFFER_SIZE) ? bytes_left : BUFFER_SIZE;
675 p = fd_alloc_w_at (s, &trans, -1);
677 memset (p, c, trans);
688 /* Stream read function. Avoids using a buffer for big reads. The
689 interface is like POSIX read(), but the nbytes argument is a
690 pointer; on return it contains the number of bytes written. The
691 function return value is the status indicator (0 for success). */
694 fd_read (unix_stream * s, void * buf, size_t * nbytes)
699 if (*nbytes < BUFFER_SIZE && !s->unbuffered)
702 p = fd_alloc_r_at (s, &tmp, -1);
706 memcpy (buf, p, *nbytes);
716 /* If the request is bigger than BUFFER_SIZE we flush the buffers
717 and read directly. */
718 if (fd_flush (s) == FAILURE)
724 if (is_seekable ((stream *) s) && fd_seek (s, s->logical_offset) == FAILURE)
730 status = do_read (s, buf, nbytes);
731 reset_stream (s, *nbytes);
736 /* Stream write function. Avoids using a buffer for big writes. The
737 interface is like POSIX write(), but the nbytes argument is a
738 pointer; on return it contains the number of bytes written. The
739 function return value is the status indicator (0 for success). */
742 fd_write (unix_stream * s, const void * buf, size_t * nbytes)
747 if (*nbytes < BUFFER_SIZE && !s->unbuffered)
750 p = fd_alloc_w_at (s, &tmp, -1);
754 memcpy (p, buf, *nbytes);
764 /* If the request is bigger than BUFFER_SIZE we flush the buffers
765 and write directly. */
766 if (fd_flush (s) == FAILURE)
772 if (is_seekable ((stream *) s) && fd_seek (s, s->logical_offset) == FAILURE)
778 status = do_write (s, buf, nbytes);
779 reset_stream (s, *nbytes);
785 fd_close (unix_stream * s)
787 if (fd_flush (s) == FAILURE)
790 if (s->buffer != NULL && s->buffer != s->small_buffer)
791 free_mem (s->buffer);
793 if (s->fd != STDOUT_FILENO && s->fd != STDERR_FILENO)
795 if (close (s->fd) < 0)
806 fd_open (unix_stream * s)
811 s->st.alloc_r_at = (void *) fd_alloc_r_at;
812 s->st.alloc_w_at = (void *) fd_alloc_w_at;
813 s->st.sfree = (void *) fd_sfree;
814 s->st.close = (void *) fd_close;
815 s->st.seek = (void *) fd_seek;
816 s->st.truncate = (void *) fd_truncate;
817 s->st.read = (void *) fd_read;
818 s->st.write = (void *) fd_write;
819 s->st.set = (void *) fd_sset;
827 /*********************************************************************
828 memory stream functions - These are used for internal files
830 The idea here is that a single stream structure is created and all
831 requests must be satisfied from it. The location and size of the
832 buffer is the character variable supplied to the READ or WRITE
835 *********************************************************************/
839 mem_alloc_r_at (unix_stream * s, int *len, gfc_offset where)
844 where = s->logical_offset;
846 if (where < s->buffer_offset || where > s->buffer_offset + s->active)
849 s->logical_offset = where + *len;
851 n = s->buffer_offset + s->active - where;
855 return s->buffer + (where - s->buffer_offset);
860 mem_alloc_w_at (unix_stream * s, int *len, gfc_offset where)
864 assert (*len >= 0); /* Negative values not allowed. */
867 where = s->logical_offset;
871 if (where < s->buffer_offset)
874 if (m > s->file_length)
877 s->logical_offset = m;
879 return s->buffer + (where - s->buffer_offset);
883 /* Stream read function for internal units. This is not actually used
884 at the moment, as all internal IO is formatted and the formatted IO
885 routines use mem_alloc_r_at. */
888 mem_read (unix_stream * s, void * buf, size_t * nbytes)
894 p = mem_alloc_r_at (s, &tmp, -1);
898 memcpy (buf, p, *nbytes);
909 /* Stream write function for internal units. This is not actually used
910 at the moment, as all internal IO is formatted and the formatted IO
911 routines use mem_alloc_w_at. */
914 mem_write (unix_stream * s, const void * buf, size_t * nbytes)
922 p = mem_alloc_w_at (s, &tmp, -1);
926 memcpy (p, buf, *nbytes);
938 mem_seek (unix_stream * s, gfc_offset offset)
940 if (offset > s->file_length)
946 s->logical_offset = offset;
952 mem_set (unix_stream * s, int c, size_t n)
959 p = mem_alloc_w_at (s, &len, -1);
971 mem_truncate (unix_stream * s __attribute__ ((unused)))
978 mem_close (unix_stream * s)
988 mem_sfree (unix_stream * s __attribute__ ((unused)))
995 /*********************************************************************
996 Public functions -- A reimplementation of this module needs to
997 define functional equivalents of the following.
998 *********************************************************************/
1000 /* empty_internal_buffer()-- Zero the buffer of Internal file */
1003 empty_internal_buffer(stream *strm)
1005 unix_stream * s = (unix_stream *) strm;
1006 memset(s->buffer, ' ', s->file_length);
1009 /* open_internal()-- Returns a stream structure from an internal file */
1012 open_internal (char *base, int length)
1016 s = get_mem (sizeof (unix_stream));
1017 memset (s, '\0', sizeof (unix_stream));
1020 s->buffer_offset = 0;
1022 s->logical_offset = 0;
1023 s->active = s->file_length = length;
1025 s->st.alloc_r_at = (void *) mem_alloc_r_at;
1026 s->st.alloc_w_at = (void *) mem_alloc_w_at;
1027 s->st.sfree = (void *) mem_sfree;
1028 s->st.close = (void *) mem_close;
1029 s->st.seek = (void *) mem_seek;
1030 s->st.truncate = (void *) mem_truncate;
1031 s->st.read = (void *) mem_read;
1032 s->st.write = (void *) mem_write;
1033 s->st.set = (void *) mem_set;
1035 return (stream *) s;
1039 /* fd_to_stream()-- Given an open file descriptor, build a stream
1043 fd_to_stream (int fd, int prot)
1045 struct stat statbuf;
1048 s = get_mem (sizeof (unix_stream));
1049 memset (s, '\0', sizeof (unix_stream));
1052 s->buffer_offset = 0;
1053 s->physical_offset = 0;
1054 s->logical_offset = 0;
1057 /* Get the current length of the file. */
1059 fstat (fd, &statbuf);
1061 if (lseek (fd, 0, SEEK_CUR) == (off_t) -1)
1062 s->file_length = -1;
1064 s->file_length = S_ISREG (statbuf.st_mode) ? statbuf.st_size : -1;
1066 s->special_file = !S_ISREG (statbuf.st_mode);
1070 return (stream *) s;
1074 /* Given the Fortran unit number, convert it to a C file descriptor. */
1077 unit_to_fd (int unit)
1082 us = find_unit (unit);
1086 fd = ((unix_stream *) us->s)->fd;
1092 /* unpack_filename()-- Given a fortran string and a pointer to a
1093 * buffer that is PATH_MAX characters, convert the fortran string to a
1094 * C string in the buffer. Returns nonzero if this is not possible. */
1097 unpack_filename (char *cstring, const char *fstring, int len)
1099 len = fstrlen (fstring, len);
1100 if (len >= PATH_MAX)
1103 memmove (cstring, fstring, len);
1104 cstring[len] = '\0';
1110 /* tempfile()-- Generate a temporary filename for a scratch file and
1111 * open it. mkstemp() opens the file for reading and writing, but the
1112 * library mode prevents anything that is not allowed. The descriptor
1113 * is returned, which is -1 on error. The template is pointed to by
1114 * opp->file, which is copied into the unit structure
1115 * and freed later. */
1118 tempfile (st_parameter_open *opp)
1120 const char *tempdir;
1124 tempdir = getenv ("GFORTRAN_TMPDIR");
1125 if (tempdir == NULL)
1126 tempdir = getenv ("TMP");
1127 if (tempdir == NULL)
1128 tempdir = getenv ("TEMP");
1129 if (tempdir == NULL)
1130 tempdir = DEFAULT_TEMPDIR;
1132 template = get_mem (strlen (tempdir) + 20);
1134 st_sprintf (template, "%s/gfortrantmpXXXXXX", tempdir);
1138 fd = mkstemp (template);
1140 #else /* HAVE_MKSTEMP */
1142 if (mktemp (template))
1144 #if defined(HAVE_CRLF) && defined(O_BINARY)
1145 fd = open (template, O_RDWR | O_CREAT | O_EXCL | O_BINARY,
1146 S_IREAD | S_IWRITE);
1148 fd = open (template, O_RDWR | O_CREAT | O_EXCL, S_IREAD | S_IWRITE);
1150 while (!(fd == -1 && errno == EEXIST) && mktemp (template));
1154 #endif /* HAVE_MKSTEMP */
1157 free_mem (template);
1160 opp->file = template;
1161 opp->file_len = strlen (template); /* Don't include trailing nul */
1168 /* regular_file()-- Open a regular file.
1169 * Change flags->action if it is ACTION_UNSPECIFIED on entry,
1170 * unless an error occurs.
1171 * Returns the descriptor, which is less than zero on error. */
1174 regular_file (st_parameter_open *opp, unit_flags *flags)
1176 char path[PATH_MAX + 1];
1182 if (unpack_filename (path, opp->file, opp->file_len))
1184 errno = ENOENT; /* Fake an OS error */
1190 switch (flags->action)
1200 case ACTION_READWRITE:
1201 case ACTION_UNSPECIFIED:
1206 internal_error (&opp->common, "regular_file(): Bad action");
1209 switch (flags->status)
1212 crflag = O_CREAT | O_EXCL;
1215 case STATUS_OLD: /* open will fail if the file does not exist*/
1219 case STATUS_UNKNOWN:
1220 case STATUS_SCRATCH:
1224 case STATUS_REPLACE:
1225 crflag = O_CREAT | O_TRUNC;
1229 internal_error (&opp->common, "regular_file(): Bad status");
1232 /* rwflag |= O_LARGEFILE; */
1234 #if defined(HAVE_CRLF) && defined(O_BINARY)
1238 mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
1239 fd = open (path, rwflag | crflag, mode);
1240 if (flags->action != ACTION_UNSPECIFIED)
1245 flags->action = ACTION_READWRITE;
1248 if (errno != EACCES)
1251 /* retry for read-only access */
1253 fd = open (path, rwflag | crflag, mode);
1256 flags->action = ACTION_READ;
1257 return fd; /* success */
1260 if (errno != EACCES)
1261 return fd; /* failure */
1263 /* retry for write-only access */
1265 fd = open (path, rwflag | crflag, mode);
1268 flags->action = ACTION_WRITE;
1269 return fd; /* success */
1271 return fd; /* failure */
1275 /* open_external()-- Open an external file, unix specific version.
1276 * Change flags->action if it is ACTION_UNSPECIFIED on entry.
1277 * Returns NULL on operating system error. */
1280 open_external (st_parameter_open *opp, unit_flags *flags)
1284 if (flags->status == STATUS_SCRATCH)
1286 fd = tempfile (opp);
1287 if (flags->action == ACTION_UNSPECIFIED)
1288 flags->action = ACTION_READWRITE;
1290 #if HAVE_UNLINK_OPEN_FILE
1291 /* We can unlink scratch files now and it will go away when closed. */
1298 /* regular_file resets flags->action if it is ACTION_UNSPECIFIED and
1300 fd = regular_file (opp, flags);
1307 switch (flags->action)
1317 case ACTION_READWRITE:
1318 prot = PROT_READ | PROT_WRITE;
1322 internal_error (&opp->common, "open_external(): Bad action");
1325 return fd_to_stream (fd, prot);
1329 /* input_stream()-- Return a stream pointer to the default input stream.
1330 * Called on initialization. */
1335 return fd_to_stream (STDIN_FILENO, PROT_READ);
1339 /* output_stream()-- Return a stream pointer to the default output stream.
1340 * Called on initialization. */
1343 output_stream (void)
1345 #if defined(HAVE_CRLF) && defined(HAVE_SETMODE)
1346 setmode (STDOUT_FILENO, O_BINARY);
1348 return fd_to_stream (STDOUT_FILENO, PROT_WRITE);
1352 /* error_stream()-- Return a stream pointer to the default error stream.
1353 * Called on initialization. */
1358 #if defined(HAVE_CRLF) && defined(HAVE_SETMODE)
1359 setmode (STDERR_FILENO, O_BINARY);
1361 return fd_to_stream (STDERR_FILENO, PROT_WRITE);
1364 /* init_error_stream()-- Return a pointer to the error stream. This
1365 * subroutine is called when the stream is needed, rather than at
1366 * initialization. We want to work even if memory has been seriously
1370 init_error_stream (unix_stream *error)
1372 memset (error, '\0', sizeof (*error));
1374 error->fd = options.use_stderr ? STDERR_FILENO : STDOUT_FILENO;
1376 error->st.alloc_w_at = (void *) fd_alloc_w_at;
1377 error->st.sfree = (void *) fd_sfree;
1379 error->unbuffered = 1;
1380 error->buffer = error->small_buffer;
1382 return (stream *) error;
1385 /* st_printf()-- simple printf() function for streams that handles the
1386 * formats %d, %s and %c. This function handles printing of error
1387 * messages that originate within the library itself, not from a user
1391 st_printf (const char *format, ...)
1398 char itoa_buf[GFC_ITOA_BUF_SIZE];
1399 unix_stream err_stream;
1402 s = init_error_stream (&err_stream);
1403 va_start (arg, format);
1409 while (format[count] != '%' && format[count] != '\0')
1414 p = salloc_w (s, &count);
1415 memmove (p, format, count);
1421 if (*format++ == '\0')
1429 p = salloc_w (s, &count);
1430 *p = (char) va_arg (arg, int);
1436 q = gfc_itoa (va_arg (arg, int), itoa_buf, sizeof (itoa_buf));
1439 p = salloc_w (s, &count);
1440 memmove (p, q, count);
1445 q = xtoa (va_arg (arg, unsigned), itoa_buf, sizeof (itoa_buf));
1448 p = salloc_w (s, &count);
1449 memmove (p, q, count);
1454 q = va_arg (arg, char *);
1457 p = salloc_w (s, &count);
1458 memmove (p, q, count);
1467 p = salloc_w (s, &count);
1483 /* compare_file_filename()-- Given an open stream and a fortran string
1484 * that is a filename, figure out if the file is the same as the
1488 compare_file_filename (gfc_unit *u, const char *name, int len)
1490 char path[PATH_MAX + 1];
1492 #ifdef HAVE_WORKING_STAT
1496 if (unpack_filename (path, name, len))
1497 return 0; /* Can't be the same */
1499 /* If the filename doesn't exist, then there is no match with the
1502 if (stat (path, &st1) < 0)
1505 #ifdef HAVE_WORKING_STAT
1506 fstat (((unix_stream *) (u->s))->fd, &st2);
1507 return (st1.st_dev == st2.st_dev) && (st1.st_ino == st2.st_ino);
1509 if (len != u->file_len)
1511 return (memcmp(path, u->file, len) == 0);
1516 #ifdef HAVE_WORKING_STAT
1517 # define FIND_FILE0_DECL struct stat *st
1518 # define FIND_FILE0_ARGS st
1520 # define FIND_FILE0_DECL const char *file, gfc_charlen_type file_len
1521 # define FIND_FILE0_ARGS file, file_len
1524 /* find_file0()-- Recursive work function for find_file() */
1527 find_file0 (gfc_unit *u, FIND_FILE0_DECL)
1534 #ifdef HAVE_WORKING_STAT
1536 && fstat (((unix_stream *) u->s)->fd, &st[1]) >= 0 &&
1537 st[0].st_dev == st[1].st_dev && st[0].st_ino == st[1].st_ino)
1540 if (compare_string (u->file_len, u->file, file_len, file) == 0)
1544 v = find_file0 (u->left, FIND_FILE0_ARGS);
1548 v = find_file0 (u->right, FIND_FILE0_ARGS);
1556 /* find_file()-- Take the current filename and see if there is a unit
1557 * that has the file already open. Returns a pointer to the unit if so. */
1560 find_file (const char *file, gfc_charlen_type file_len)
1562 char path[PATH_MAX + 1];
1566 if (unpack_filename (path, file, file_len))
1569 if (stat (path, &st[0]) < 0)
1572 __gthread_mutex_lock (&unit_lock);
1574 u = find_file0 (unit_root, FIND_FILE0_ARGS);
1578 if (! __gthread_mutex_trylock (&u->lock))
1580 /* assert (u->closed == 0); */
1581 __gthread_mutex_unlock (&unit_lock);
1585 inc_waiting_locked (u);
1587 __gthread_mutex_unlock (&unit_lock);
1590 __gthread_mutex_lock (&u->lock);
1593 __gthread_mutex_lock (&unit_lock);
1594 __gthread_mutex_unlock (&u->lock);
1595 if (predec_waiting_locked (u) == 0)
1600 dec_waiting_unlocked (u);
1606 flush_all_units_1 (gfc_unit *u, int min_unit)
1610 if (u->unit_number > min_unit)
1612 gfc_unit *r = flush_all_units_1 (u->left, min_unit);
1616 if (u->unit_number >= min_unit)
1618 if (__gthread_mutex_trylock (&u->lock))
1622 __gthread_mutex_unlock (&u->lock);
1630 flush_all_units (void)
1635 __gthread_mutex_lock (&unit_lock);
1638 u = flush_all_units_1 (unit_root, min_unit);
1640 inc_waiting_locked (u);
1641 __gthread_mutex_unlock (&unit_lock);
1645 __gthread_mutex_lock (&u->lock);
1647 min_unit = u->unit_number + 1;
1652 __gthread_mutex_lock (&unit_lock);
1653 __gthread_mutex_unlock (&u->lock);
1654 (void) predec_waiting_locked (u);
1658 __gthread_mutex_lock (&unit_lock);
1659 __gthread_mutex_unlock (&u->lock);
1660 if (predec_waiting_locked (u) == 0)
1668 /* stream_at_bof()-- Returns nonzero if the stream is at the beginning
1672 stream_at_bof (stream * s)
1676 if (!is_seekable (s))
1679 us = (unix_stream *) s;
1681 return us->logical_offset == 0;
1685 /* stream_at_eof()-- Returns nonzero if the stream is at the end
1689 stream_at_eof (stream * s)
1693 if (!is_seekable (s))
1696 us = (unix_stream *) s;
1698 return us->logical_offset == us->dirty_offset;
1702 /* delete_file()-- Given a unit structure, delete the file associated
1703 * with the unit. Returns nonzero if something went wrong. */
1706 delete_file (gfc_unit * u)
1708 char path[PATH_MAX + 1];
1710 if (unpack_filename (path, u->file, u->file_len))
1711 { /* Shouldn't be possible */
1716 return unlink (path);
1720 /* file_exists()-- Returns nonzero if the current filename exists on
1724 file_exists (const char *file, gfc_charlen_type file_len)
1726 char path[PATH_MAX + 1];
1727 struct stat statbuf;
1729 if (unpack_filename (path, file, file_len))
1732 if (stat (path, &statbuf) < 0)
1740 static const char yes[] = "YES", no[] = "NO", unknown[] = "UNKNOWN";
1742 /* inquire_sequential()-- Given a fortran string, determine if the
1743 * file is suitable for sequential access. Returns a C-style
1747 inquire_sequential (const char *string, int len)
1749 char path[PATH_MAX + 1];
1750 struct stat statbuf;
1752 if (string == NULL ||
1753 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1756 if (S_ISREG (statbuf.st_mode) ||
1757 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1760 if (S_ISDIR (statbuf.st_mode) || S_ISBLK (statbuf.st_mode))
1767 /* inquire_direct()-- Given a fortran string, determine if the file is
1768 * suitable for direct access. Returns a C-style string. */
1771 inquire_direct (const char *string, int len)
1773 char path[PATH_MAX + 1];
1774 struct stat statbuf;
1776 if (string == NULL ||
1777 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1780 if (S_ISREG (statbuf.st_mode) || S_ISBLK (statbuf.st_mode))
1783 if (S_ISDIR (statbuf.st_mode) ||
1784 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1791 /* inquire_formatted()-- Given a fortran string, determine if the file
1792 * is suitable for formatted form. Returns a C-style string. */
1795 inquire_formatted (const char *string, int len)
1797 char path[PATH_MAX + 1];
1798 struct stat statbuf;
1800 if (string == NULL ||
1801 unpack_filename (path, string, len) || stat (path, &statbuf) < 0)
1804 if (S_ISREG (statbuf.st_mode) ||
1805 S_ISBLK (statbuf.st_mode) ||
1806 S_ISCHR (statbuf.st_mode) || S_ISFIFO (statbuf.st_mode))
1809 if (S_ISDIR (statbuf.st_mode))
1816 /* inquire_unformatted()-- Given a fortran string, determine if the file
1817 * is suitable for unformatted form. Returns a C-style string. */
1820 inquire_unformatted (const char *string, int len)
1822 return inquire_formatted (string, len);
1826 /* inquire_access()-- Given a fortran string, determine if the file is
1827 * suitable for access. */
1830 inquire_access (const char *string, int len, int mode)
1832 char path[PATH_MAX + 1];
1834 if (string == NULL || unpack_filename (path, string, len) ||
1835 access (path, mode) < 0)
1842 /* inquire_read()-- Given a fortran string, determine if the file is
1843 * suitable for READ access. */
1846 inquire_read (const char *string, int len)
1848 return inquire_access (string, len, R_OK);
1852 /* inquire_write()-- Given a fortran string, determine if the file is
1853 * suitable for READ access. */
1856 inquire_write (const char *string, int len)
1858 return inquire_access (string, len, W_OK);
1862 /* inquire_readwrite()-- Given a fortran string, determine if the file is
1863 * suitable for read and write access. */
1866 inquire_readwrite (const char *string, int len)
1868 return inquire_access (string, len, R_OK | W_OK);
1872 /* file_length()-- Return the file length in bytes, -1 if unknown */
1875 file_length (stream * s)
1877 return ((unix_stream *) s)->file_length;
1881 /* file_position()-- Return the current position of the file */
1884 file_position (stream * s)
1886 return ((unix_stream *) s)->logical_offset;
1890 /* is_seekable()-- Return nonzero if the stream is seekable, zero if
1894 is_seekable (stream * s)
1896 /* By convention, if file_length == -1, the file is not
1898 return ((unix_stream *) s)->file_length!=-1;
1904 return fd_flush( (unix_stream *) s);
1908 stream_isatty (stream *s)
1910 return isatty (((unix_stream *) s)->fd);
1914 stream_ttyname (stream *s)
1917 return ttyname (((unix_stream *) s)->fd);
1924 stream_offset (stream *s)
1926 return (((unix_stream *) s)->logical_offset);
1930 /* How files are stored: This is an operating-system specific issue,
1931 and therefore belongs here. There are three cases to consider.
1934 Records are written as block of bytes corresponding to the record
1935 length of the file. This goes for both formatted and unformatted
1936 records. Positioning is done explicitly for each data transfer,
1937 so positioning is not much of an issue.
1939 Sequential Formatted:
1940 Records are separated by newline characters. The newline character
1941 is prohibited from appearing in a string. If it does, this will be
1942 messed up on the next read. End of file is also the end of a record.
1944 Sequential Unformatted:
1945 In this case, we are merely copying bytes to and from main storage,
1946 yet we need to keep track of varying record lengths. We adopt
1947 the solution used by f2c. Each record contains a pair of length
1950 Length of record n in bytes
1952 Length of record n in bytes
1954 Length of record n+1 in bytes
1956 Length of record n+1 in bytes
1958 The length is stored at the end of a record to allow backspacing to the
1959 previous record. Between data transfer statements, the file pointer
1960 is left pointing to the first length of the current record.
1962 ENDFILE records are never explicitly stored.