1 /* Copyright (C) 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
2 Contributed by Andy Vaught
4 This file is part of the GNU Fortran 95 runtime library (libgfortran).
6 Libgfortran is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 Libgfortran is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with Libgfortran; see the file COPYING. If not, write to
18 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA. */
21 /* As a special exception, if you link this library with other files,
22 some of which are compiled with GCC, to produce an executable,
23 this library does not by itself cause the resulting executable
24 to be covered by the GNU General Public License.
25 This exception does not however invalidate any other reasons why
26 the executable file might be covered by the GNU General Public License. */
31 /* IO library include. */
34 #include "libgfortran.h"
38 #define DEFAULT_TEMPDIR "/tmp"
40 /* Basic types used in data transfers. */
43 { BT_NULL, BT_INTEGER, BT_LOGICAL, BT_CHARACTER, BT_REAL,
50 { SUCCESS = 1, FAILURE }
53 struct st_parameter_dt;
57 char *(*alloc_w_at) (struct stream *, int *, gfc_offset);
58 char *(*alloc_r_at) (struct stream *, int *, gfc_offset);
59 try (*sfree) (struct stream *);
60 try (*close) (struct stream *);
61 try (*seek) (struct stream *, gfc_offset);
62 try (*truncate) (struct stream *);
63 int (*read) (struct stream *, void *, size_t *);
64 int (*write) (struct stream *, const void *, size_t *);
65 try (*set) (struct stream *, int, size_t);
70 /* Macros for doing file I/O given a stream. */
72 #define sfree(s) ((s)->sfree)(s)
73 #define sclose(s) ((s)->close)(s)
75 #define salloc_r(s, len) ((s)->alloc_r_at)(s, len, -1)
76 #define salloc_w(s, len) ((s)->alloc_w_at)(s, len, -1)
78 #define salloc_r_at(s, len, where) ((s)->alloc_r_at)(s, len, where)
79 #define salloc_w_at(s, len, where) ((s)->alloc_w_at)(s, len, where)
81 #define sseek(s, pos) ((s)->seek)(s, pos)
82 #define struncate(s) ((s)->truncate)(s)
83 #define sread(s, buf, nbytes) ((s)->read)(s, buf, nbytes)
84 #define swrite(s, buf, nbytes) ((s)->write)(s, buf, nbytes)
86 #define sset(s, c, n) ((s)->set)(s, c, n)
88 /* The array_loop_spec contains the variables for the loops over index ranges
89 that are encountered. Since the variables can be negative, ssize_t
92 typedef struct array_loop_spec
94 /* Index counter for this dimension. */
97 /* Start for the index counter. */
100 /* End for the index counter. */
103 /* Step for the index counter. */
108 /* Representation of a namelist object in libgfortran
111 &GROUPNAME OBJECT=value[s] [,OBJECT=value[s]].../
113 &GROUPNAME OBJECT=value[s] [,OBJECT=value[s]]...&END
115 The object can be a fully qualified, compound name for an instrinsic
116 type, derived types or derived type components. So, a substring
117 a(:)%b(4)%ch(2:4)(1:7) has to be treated correctly in namelist
118 read. Hence full information about the structure of the object has
119 to be available to list_read.c and write.
121 These requirements are met by the following data structures.
123 namelist_info type contains all the scalar information about the
124 object and arrays of descriptor_dimension and array_loop_spec types for
127 typedef struct namelist_type
130 /* Object type, stored as GFC_DTYPE_xxxx. */
136 /* Address for the start of the object's data. */
139 /* Flag to show that a read is to be attempted for this node. */
142 /* Length of intrinsic type in bytes. */
145 /* Rank of the object. */
148 /* Overall size of the object in bytes. */
151 /* Length of character string. */
152 index_type string_length;
154 descriptor_dimension * dim;
155 array_loop_spec * ls;
156 struct namelist_type * next;
160 /* Options for the OPEN statement. */
163 { ACCESS_SEQUENTIAL, ACCESS_DIRECT, ACCESS_APPEND,
169 { ACTION_READ, ACTION_WRITE, ACTION_READWRITE,
175 { BLANK_NULL, BLANK_ZERO, BLANK_UNSPECIFIED }
179 { DELIM_NONE, DELIM_APOSTROPHE, DELIM_QUOTE,
185 { FORM_FORMATTED, FORM_UNFORMATTED, FORM_UNSPECIFIED }
189 { POSITION_ASIS, POSITION_REWIND, POSITION_APPEND,
195 { STATUS_UNKNOWN, STATUS_OLD, STATUS_NEW, STATUS_SCRATCH,
196 STATUS_REPLACE, STATUS_UNSPECIFIED
201 { PAD_YES, PAD_NO, PAD_UNSPECIFIED }
205 { ADVANCE_YES, ADVANCE_NO, ADVANCE_UNSPECIFIED }
213 { CONVERT_NONE=-1, CONVERT_NATIVE, CONVERT_SWAP, CONVERT_BIG, CONVERT_LITTLE }
216 #define CHARACTER1(name) \
218 gfc_charlen_type name ## _len
219 #define CHARACTER2(name) \
220 gfc_charlen_type name ## _len; \
223 #define IOPARM_LIBRETURN_MASK (3 << 0)
224 #define IOPARM_LIBRETURN_OK (0 << 0)
225 #define IOPARM_LIBRETURN_ERROR (1 << 0)
226 #define IOPARM_LIBRETURN_END (2 << 0)
227 #define IOPARM_LIBRETURN_EOR (3 << 0)
228 #define IOPARM_ERR (1 << 2)
229 #define IOPARM_END (1 << 3)
230 #define IOPARM_EOR (1 << 4)
231 #define IOPARM_HAS_IOSTAT (1 << 5)
232 #define IOPARM_HAS_IOMSG (1 << 6)
234 #define IOPARM_COMMON_MASK ((1 << 7) - 1)
236 typedef struct st_parameter_common
240 const char *filename;
243 GFC_INTEGER_4 *iostat;
247 #define IOPARM_OPEN_HAS_RECL_IN (1 << 7)
248 #define IOPARM_OPEN_HAS_FILE (1 << 8)
249 #define IOPARM_OPEN_HAS_STATUS (1 << 9)
250 #define IOPARM_OPEN_HAS_ACCESS (1 << 10)
251 #define IOPARM_OPEN_HAS_FORM (1 << 11)
252 #define IOPARM_OPEN_HAS_BLANK (1 << 12)
253 #define IOPARM_OPEN_HAS_POSITION (1 << 13)
254 #define IOPARM_OPEN_HAS_ACTION (1 << 14)
255 #define IOPARM_OPEN_HAS_DELIM (1 << 15)
256 #define IOPARM_OPEN_HAS_PAD (1 << 16)
257 #define IOPARM_OPEN_HAS_CONVERT (1 << 17)
261 st_parameter_common common;
262 GFC_INTEGER_4 recl_in;
268 CHARACTER1 (position);
272 CHARACTER1 (convert);
276 #define IOPARM_CLOSE_HAS_STATUS (1 << 7)
280 st_parameter_common common;
287 st_parameter_common common;
289 st_parameter_filepos;
291 #define IOPARM_INQUIRE_HAS_EXIST (1 << 7)
292 #define IOPARM_INQUIRE_HAS_OPENED (1 << 8)
293 #define IOPARM_INQUIRE_HAS_NUMBER (1 << 9)
294 #define IOPARM_INQUIRE_HAS_NAMED (1 << 10)
295 #define IOPARM_INQUIRE_HAS_NEXTREC (1 << 11)
296 #define IOPARM_INQUIRE_HAS_RECL_OUT (1 << 12)
297 #define IOPARM_INQUIRE_HAS_FILE (1 << 13)
298 #define IOPARM_INQUIRE_HAS_ACCESS (1 << 14)
299 #define IOPARM_INQUIRE_HAS_FORM (1 << 15)
300 #define IOPARM_INQUIRE_HAS_BLANK (1 << 16)
301 #define IOPARM_INQUIRE_HAS_POSITION (1 << 17)
302 #define IOPARM_INQUIRE_HAS_ACTION (1 << 18)
303 #define IOPARM_INQUIRE_HAS_DELIM (1 << 19)
304 #define IOPARM_INQUIRE_HAS_PAD (1 << 20)
305 #define IOPARM_INQUIRE_HAS_NAME (1 << 21)
306 #define IOPARM_INQUIRE_HAS_SEQUENTIAL (1 << 22)
307 #define IOPARM_INQUIRE_HAS_DIRECT (1 << 23)
308 #define IOPARM_INQUIRE_HAS_FORMATTED (1 << 24)
309 #define IOPARM_INQUIRE_HAS_UNFORMATTED (1 << 25)
310 #define IOPARM_INQUIRE_HAS_READ (1 << 26)
311 #define IOPARM_INQUIRE_HAS_WRITE (1 << 27)
312 #define IOPARM_INQUIRE_HAS_READWRITE (1 << 28)
313 #define IOPARM_INQUIRE_HAS_CONVERT (1 << 29)
317 st_parameter_common common;
318 GFC_INTEGER_4 *exist, *opened, *number, *named;
319 GFC_INTEGER_4 *nextrec, *recl_out;
324 CHARACTER1 (position);
329 CHARACTER2 (sequential);
331 CHARACTER2 (formatted);
332 CHARACTER1 (unformatted);
335 CHARACTER2 (readwrite);
336 CHARACTER1 (convert);
338 st_parameter_inquire;
343 #define IOPARM_DT_LIST_FORMAT (1 << 7)
344 #define IOPARM_DT_NAMELIST_READ_MODE (1 << 8)
345 #define IOPARM_DT_HAS_REC (1 << 9)
346 #define IOPARM_DT_HAS_SIZE (1 << 10)
347 #define IOPARM_DT_HAS_IOLENGTH (1 << 11)
348 #define IOPARM_DT_HAS_FORMAT (1 << 12)
349 #define IOPARM_DT_HAS_ADVANCE (1 << 13)
350 #define IOPARM_DT_HAS_INTERNAL_UNIT (1 << 14)
351 #define IOPARM_DT_HAS_NAMELIST_NAME (1 << 15)
352 /* Internal use bit. */
353 #define IOPARM_DT_IONML_SET (1 << 31)
355 typedef struct st_parameter_dt
357 st_parameter_common common;
359 GFC_INTEGER_4 *size, *iolength;
360 gfc_array_char *internal_unit_desc;
362 CHARACTER2 (advance);
363 CHARACTER1 (internal_unit);
364 CHARACTER2 (namelist_name);
365 /* Private part of the structure. The compiler just needs
366 to reserve enough space. */
371 void (*transfer) (struct st_parameter_dt *, bt, void *, int,
373 struct gfc_unit *current_unit;
374 /* Item number in a formatted data transfer. Also used in namelist
375 read_logical as an index into line_buffer. */
378 unit_blank blank_status;
379 enum {SIGN_S, SIGN_SS, SIGN_SP} sign_status;
381 int max_pos; /* Maximum righthand column written to. */
382 /* Number of skips + spaces to be done for T and X-editing. */
384 /* Number of spaces to be done for T and X-editing. */
386 /* Whether an EOR condition was encountered. Value is:
387 0 if no EOR was encountered
388 1 if an EOR was encountered due to a 1-byte marker (LF)
389 2 if an EOR was encountered due to a 2-bytes marker (CRLF) */
391 unit_advance advance_status;
393 unsigned reversion_flag : 1; /* Format reversion has occurred. */
394 unsigned first_item : 1;
395 unsigned seen_dollar : 1;
396 unsigned eor_condition : 1;
397 unsigned no_leading_blank : 1;
398 unsigned char_flag : 1;
399 unsigned input_complete : 1;
401 unsigned comma_flag : 1;
402 /* A namelist specific flag used in the list directed library
403 to flag that calls are being made from namelist read (eg. to
404 ignore comments or to treat '/' as a terminator) */
405 unsigned namelist_mode : 1;
406 /* A namelist specific flag used in the list directed library
407 to flag read errors and return, so that an attempt can be
408 made to read a new object name. */
409 unsigned nml_read_error : 1;
410 /* A sequential formatted read specific flag used to signal that a
411 character string is being read so don't use commas to shorten a
412 formatted field width. */
413 unsigned sf_read_comma : 1;
414 /* A namelist specific flag used to enable reading input from
415 line_buffer for logical reads. */
416 unsigned line_buffer_enabled : 1;
417 /* 18 unused bits. */
429 struct format_data *fmt;
431 namelist_info *ionml;
433 /* Storage area for values except for strings. Must be large
434 enough to hold a complex value (two reals) of the largest
438 char pad[16 * sizeof (char *) + 34 * sizeof (int)];
454 unit_position position;
457 unit_convert convert;
462 /* The default value of record length for preconnected units is defined
463 here. This value can be overriden by an environment variable.
464 Default value is 1 Gb. */
466 #define DEFAULT_RECL 1073741824
469 typedef struct gfc_unit
475 struct gfc_unit *left, *right;
478 int read_bad, current_record;
480 { NO_ENDFILE, AT_ENDFILE, AFTER_ENDFILE }
486 /* recl -- Record length of the file.
487 last_record -- Last record number read or written
488 maxrec -- Maximum record number in a direct access file
489 bytes_left -- Bytes left in current record. */
490 gfc_offset recl, last_record, maxrec, bytes_left;
492 __gthread_mutex_t lock;
493 /* Number of threads waiting to acquire this unit's lock.
494 When non-zero, close_unit doesn't only removes the unit
495 from the UNIT_ROOT tree, but doesn't free it and the
496 last of the waiting threads will do that.
497 This must be either atomically increased/decreased, or
498 always guarded by UNIT_LOCK. */
500 /* Flag set by close_unit if the unit as been closed.
501 Must be manipulated under unit's lock. */
504 /* For traversing arrays */
513 /* Format tokens. Only about half of these can be stored in the
518 FMT_NONE = 0, FMT_UNKNOWN, FMT_SIGNED_INT, FMT_ZERO, FMT_POSINT, FMT_PERIOD,
519 FMT_COMMA, FMT_COLON, FMT_SLASH, FMT_DOLLAR, FMT_T, FMT_TR, FMT_TL,
520 FMT_LPAREN, FMT_RPAREN, FMT_X, FMT_S, FMT_SS, FMT_SP, FMT_STRING,
521 FMT_BADSTRING, FMT_P, FMT_I, FMT_B, FMT_BN, FMT_BZ, FMT_O, FMT_Z, FMT_F,
522 FMT_E, FMT_EN, FMT_ES, FMT_G, FMT_L, FMT_A, FMT_D, FMT_H, FMT_END
527 /* Format nodes. A format string is converted into a tree of these
528 structures, which is traversed as part of a data transfer statement. */
567 /* Members for traversing the tree during data transfer. */
570 struct fnode *current;
578 extern int move_pos_offset (stream *, int);
579 internal_proto(move_pos_offset);
581 extern int compare_files (stream *, stream *);
582 internal_proto(compare_files);
584 extern stream *open_external (st_parameter_open *, unit_flags *);
585 internal_proto(open_external);
587 extern stream *open_internal (char *, int);
588 internal_proto(open_internal);
590 extern stream *input_stream (void);
591 internal_proto(input_stream);
593 extern stream *output_stream (void);
594 internal_proto(output_stream);
596 extern stream *error_stream (void);
597 internal_proto(error_stream);
599 extern int compare_file_filename (gfc_unit *, const char *, int);
600 internal_proto(compare_file_filename);
602 extern gfc_unit *find_file (const char *file, gfc_charlen_type file_len);
603 internal_proto(find_file);
605 extern void flush_all_units (void);
606 internal_proto(flush_all_units);
608 extern int stream_at_bof (stream *);
609 internal_proto(stream_at_bof);
611 extern int stream_at_eof (stream *);
612 internal_proto(stream_at_eof);
614 extern int delete_file (gfc_unit *);
615 internal_proto(delete_file);
617 extern int file_exists (const char *file, gfc_charlen_type file_len);
618 internal_proto(file_exists);
620 extern const char *inquire_sequential (const char *, int);
621 internal_proto(inquire_sequential);
623 extern const char *inquire_direct (const char *, int);
624 internal_proto(inquire_direct);
626 extern const char *inquire_formatted (const char *, int);
627 internal_proto(inquire_formatted);
629 extern const char *inquire_unformatted (const char *, int);
630 internal_proto(inquire_unformatted);
632 extern const char *inquire_read (const char *, int);
633 internal_proto(inquire_read);
635 extern const char *inquire_write (const char *, int);
636 internal_proto(inquire_write);
638 extern const char *inquire_readwrite (const char *, int);
639 internal_proto(inquire_readwrite);
641 extern gfc_offset file_length (stream *);
642 internal_proto(file_length);
644 extern gfc_offset file_position (stream *);
645 internal_proto(file_position);
647 extern int is_seekable (stream *);
648 internal_proto(is_seekable);
650 extern int is_preconnected (stream *);
651 internal_proto(is_preconnected);
653 extern void flush_if_preconnected (stream *);
654 internal_proto(flush_if_preconnected);
656 extern void empty_internal_buffer(stream *);
657 internal_proto(empty_internal_buffer);
659 extern try flush (stream *);
660 internal_proto(flush);
662 extern int stream_isatty (stream *);
663 internal_proto(stream_isatty);
665 extern char * stream_ttyname (stream *);
666 internal_proto(stream_ttyname);
668 extern gfc_offset stream_offset (stream *s);
669 internal_proto(stream_offset);
671 extern int unit_to_fd (int);
672 internal_proto(unit_to_fd);
674 extern int unpack_filename (char *, const char *, int);
675 internal_proto(unpack_filename);
679 /* Maximum file offset, computed at library initialization time. */
680 extern gfc_offset max_offset;
681 internal_proto(max_offset);
683 /* Unit tree root. */
684 extern gfc_unit *unit_root;
685 internal_proto(unit_root);
687 extern __gthread_mutex_t unit_lock;
688 internal_proto(unit_lock);
690 extern int close_unit (gfc_unit *);
691 internal_proto(close_unit);
693 extern int is_internal_unit (st_parameter_dt *);
694 internal_proto(is_internal_unit);
696 extern int is_array_io (st_parameter_dt *);
697 internal_proto(is_array_io);
699 extern gfc_unit *find_unit (int);
700 internal_proto(find_unit);
702 extern gfc_unit *find_or_create_unit (int);
703 internal_proto(find_unit);
705 extern gfc_unit *get_unit (st_parameter_dt *, int);
706 internal_proto(get_unit);
708 extern void unlock_unit (gfc_unit *);
709 internal_proto(unlock_unit);
713 extern void test_endfile (gfc_unit *);
714 internal_proto(test_endfile);
716 extern gfc_unit *new_unit (st_parameter_open *, gfc_unit *, unit_flags *);
717 internal_proto(new_unit);
721 extern void parse_format (st_parameter_dt *);
722 internal_proto(parse_format);
724 extern const fnode *next_format (st_parameter_dt *);
725 internal_proto(next_format);
727 extern void unget_format (st_parameter_dt *, const fnode *);
728 internal_proto(unget_format);
730 extern void format_error (st_parameter_dt *, const fnode *, const char *);
731 internal_proto(format_error);
733 extern void free_format_data (st_parameter_dt *);
734 internal_proto(free_format_data);
738 #define SCRATCH_SIZE 300
740 extern const char *type_name (bt);
741 internal_proto(type_name);
743 extern void *read_block (st_parameter_dt *, int *);
744 internal_proto(read_block);
746 extern char *read_sf (st_parameter_dt *, int *, int);
747 internal_proto(read_sf);
749 extern void *write_block (st_parameter_dt *, int);
750 internal_proto(write_block);
752 extern gfc_offset next_array_record (st_parameter_dt *, array_loop_spec *);
753 internal_proto(next_array_record);
755 extern gfc_offset init_loop_spec (gfc_array_char *, array_loop_spec *);
756 internal_proto(init_loop_spec);
758 extern void next_record (st_parameter_dt *, int);
759 internal_proto(next_record);
761 extern void reverse_memcpy (void *, const void *, size_t);
762 internal_proto (reverse_memcpy);
766 extern void set_integer (void *, GFC_INTEGER_LARGEST, int);
767 internal_proto(set_integer);
769 extern GFC_UINTEGER_LARGEST max_value (int, int);
770 internal_proto(max_value);
772 extern int convert_real (st_parameter_dt *, void *, const char *, int);
773 internal_proto(convert_real);
775 extern void read_a (st_parameter_dt *, const fnode *, char *, int);
776 internal_proto(read_a);
778 extern void read_f (st_parameter_dt *, const fnode *, char *, int);
779 internal_proto(read_f);
781 extern void read_l (st_parameter_dt *, const fnode *, char *, int);
782 internal_proto(read_l);
784 extern void read_x (st_parameter_dt *, int);
785 internal_proto(read_x);
787 extern void read_radix (st_parameter_dt *, const fnode *, char *, int, int);
788 internal_proto(read_radix);
790 extern void read_decimal (st_parameter_dt *, const fnode *, char *, int);
791 internal_proto(read_decimal);
795 extern void list_formatted_read (st_parameter_dt *, bt, void *, int, size_t,
797 internal_proto(list_formatted_read);
799 extern void finish_list_read (st_parameter_dt *);
800 internal_proto(finish_list_read);
802 extern void namelist_read (st_parameter_dt *);
803 internal_proto(namelist_read);
805 extern void namelist_write (st_parameter_dt *);
806 internal_proto(namelist_write);
810 extern void write_a (st_parameter_dt *, const fnode *, const char *, int);
811 internal_proto(write_a);
813 extern void write_b (st_parameter_dt *, const fnode *, const char *, int);
814 internal_proto(write_b);
816 extern void write_d (st_parameter_dt *, const fnode *, const char *, int);
817 internal_proto(write_d);
819 extern void write_e (st_parameter_dt *, const fnode *, const char *, int);
820 internal_proto(write_e);
822 extern void write_en (st_parameter_dt *, const fnode *, const char *, int);
823 internal_proto(write_en);
825 extern void write_es (st_parameter_dt *, const fnode *, const char *, int);
826 internal_proto(write_es);
828 extern void write_f (st_parameter_dt *, const fnode *, const char *, int);
829 internal_proto(write_f);
831 extern void write_i (st_parameter_dt *, const fnode *, const char *, int);
832 internal_proto(write_i);
834 extern void write_l (st_parameter_dt *, const fnode *, char *, int);
835 internal_proto(write_l);
837 extern void write_o (st_parameter_dt *, const fnode *, const char *, int);
838 internal_proto(write_o);
840 extern void write_x (st_parameter_dt *, int, int);
841 internal_proto(write_x);
843 extern void write_z (st_parameter_dt *, const fnode *, const char *, int);
844 internal_proto(write_z);
846 extern void list_formatted_write (st_parameter_dt *, bt, void *, int, size_t,
848 internal_proto(list_formatted_write);
851 extern try notify_std (int, const char *);
852 internal_proto(notify_std);
854 extern notification notification_std(int);
855 internal_proto(notification_std);
857 /* size_from_kind.c */
858 extern size_t size_from_real_kind (int);
859 internal_proto(size_from_real_kind);
861 extern size_t size_from_complex_kind (int);
862 internal_proto(size_from_complex_kind);
865 extern void free_ionml (st_parameter_dt *);
866 internal_proto(free_ionml);
869 inc_waiting_locked (gfc_unit *u)
871 #ifdef HAVE_SYNC_FETCH_AND_ADD
872 (void) __sync_fetch_and_add (&u->waiting, 1);
879 predec_waiting_locked (gfc_unit *u)
881 #ifdef HAVE_SYNC_FETCH_AND_ADD
882 return __sync_add_and_fetch (&u->waiting, -1);
889 dec_waiting_unlocked (gfc_unit *u)
891 #ifdef HAVE_SYNC_FETCH_AND_ADD
892 (void) __sync_fetch_and_add (&u->waiting, -1);
894 __gthread_mutex_lock (&unit_lock);
896 __gthread_mutex_unlock (&unit_lock);
902 /* ../runtime/environ.c This is here because we return unit_convert. */
904 unit_convert get_unformatted_convert (int);
905 internal_proto(get_unformatted_convert);