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 int item_count; /* Item number in a formatted data transfer. */
376 unit_blank blank_status;
377 enum {SIGN_S, SIGN_SS, SIGN_SP} sign_status;
379 int max_pos; /* Maximum righthand column written to. */
380 /* Number of skips + spaces to be done for T and X-editing. */
382 /* Number of spaces to be done for T and X-editing. */
384 /* Whether an EOR condition was encountered. Value is:
385 0 if no EOR was encountered
386 1 if an EOR was encountered due to a 1-byte marker (LF)
387 2 if an EOR was encountered due to a 2-bytes marker (CRLF) */
389 unit_advance advance_status;
391 unsigned reversion_flag : 1; /* Format reversion has occurred. */
392 unsigned first_item : 1;
393 unsigned seen_dollar : 1;
394 unsigned eor_condition : 1;
395 unsigned no_leading_blank : 1;
396 unsigned char_flag : 1;
397 unsigned input_complete : 1;
399 unsigned comma_flag : 1;
400 /* A namelist specific flag used in the list directed library
401 to flag that calls are being made from namelist read (eg. to
402 ignore comments or to treat '/' as a terminator) */
403 unsigned namelist_mode : 1;
404 /* A namelist specific flag used in the list directed library
405 to flag read errors and return, so that an attempt can be
406 made to read a new object name. */
407 unsigned nml_read_error : 1;
408 /* A sequential formatted read specific flag used to signal that a
409 character string is being read so don't use commas to shorten a
410 formatted field width. */
411 unsigned sf_read_comma : 1;
412 /* 19 unused bits. */
424 struct format_data *fmt;
426 namelist_info *ionml;
428 /* Storage area for values except for strings. Must be large
429 enough to hold a complex value (two reals) of the largest
433 char pad[16 * sizeof (char *) + 34 * sizeof (int)];
449 unit_position position;
452 unit_convert convert;
457 /* The default value of record length for preconnected units is defined
458 here. This value can be overriden by an environment variable.
459 Default value is 1 Gb. */
461 #define DEFAULT_RECL 1073741824
464 typedef struct gfc_unit
470 struct gfc_unit *left, *right;
473 int read_bad, current_record;
475 { NO_ENDFILE, AT_ENDFILE, AFTER_ENDFILE }
481 /* recl -- Record length of the file.
482 last_record -- Last record number read or written
483 maxrec -- Maximum record number in a direct access file
484 bytes_left -- Bytes left in current record. */
485 gfc_offset recl, last_record, maxrec, bytes_left;
487 __gthread_mutex_t lock;
488 /* Number of threads waiting to acquire this unit's lock.
489 When non-zero, close_unit doesn't only removes the unit
490 from the UNIT_ROOT tree, but doesn't free it and the
491 last of the waiting threads will do that.
492 This must be either atomically increased/decreased, or
493 always guarded by UNIT_LOCK. */
495 /* Flag set by close_unit if the unit as been closed.
496 Must be manipulated under unit's lock. */
499 /* For traversing arrays */
508 /* Format tokens. Only about half of these can be stored in the
513 FMT_NONE = 0, FMT_UNKNOWN, FMT_SIGNED_INT, FMT_ZERO, FMT_POSINT, FMT_PERIOD,
514 FMT_COMMA, FMT_COLON, FMT_SLASH, FMT_DOLLAR, FMT_T, FMT_TR, FMT_TL,
515 FMT_LPAREN, FMT_RPAREN, FMT_X, FMT_S, FMT_SS, FMT_SP, FMT_STRING,
516 FMT_BADSTRING, FMT_P, FMT_I, FMT_B, FMT_BN, FMT_BZ, FMT_O, FMT_Z, FMT_F,
517 FMT_E, FMT_EN, FMT_ES, FMT_G, FMT_L, FMT_A, FMT_D, FMT_H, FMT_END
522 /* Format nodes. A format string is converted into a tree of these
523 structures, which is traversed as part of a data transfer statement. */
562 /* Members for traversing the tree during data transfer. */
565 struct fnode *current;
573 extern int move_pos_offset (stream *, int);
574 internal_proto(move_pos_offset);
576 extern int compare_files (stream *, stream *);
577 internal_proto(compare_files);
579 extern stream *open_external (st_parameter_open *, unit_flags *);
580 internal_proto(open_external);
582 extern stream *open_internal (char *, int);
583 internal_proto(open_internal);
585 extern stream *input_stream (void);
586 internal_proto(input_stream);
588 extern stream *output_stream (void);
589 internal_proto(output_stream);
591 extern stream *error_stream (void);
592 internal_proto(error_stream);
594 extern int compare_file_filename (gfc_unit *, const char *, int);
595 internal_proto(compare_file_filename);
597 extern gfc_unit *find_file (const char *file, gfc_charlen_type file_len);
598 internal_proto(find_file);
600 extern void flush_all_units (void);
601 internal_proto(flush_all_units);
603 extern int stream_at_bof (stream *);
604 internal_proto(stream_at_bof);
606 extern int stream_at_eof (stream *);
607 internal_proto(stream_at_eof);
609 extern int delete_file (gfc_unit *);
610 internal_proto(delete_file);
612 extern int file_exists (const char *file, gfc_charlen_type file_len);
613 internal_proto(file_exists);
615 extern const char *inquire_sequential (const char *, int);
616 internal_proto(inquire_sequential);
618 extern const char *inquire_direct (const char *, int);
619 internal_proto(inquire_direct);
621 extern const char *inquire_formatted (const char *, int);
622 internal_proto(inquire_formatted);
624 extern const char *inquire_unformatted (const char *, int);
625 internal_proto(inquire_unformatted);
627 extern const char *inquire_read (const char *, int);
628 internal_proto(inquire_read);
630 extern const char *inquire_write (const char *, int);
631 internal_proto(inquire_write);
633 extern const char *inquire_readwrite (const char *, int);
634 internal_proto(inquire_readwrite);
636 extern gfc_offset file_length (stream *);
637 internal_proto(file_length);
639 extern gfc_offset file_position (stream *);
640 internal_proto(file_position);
642 extern int is_seekable (stream *);
643 internal_proto(is_seekable);
645 extern int is_preconnected (stream *);
646 internal_proto(is_preconnected);
648 extern void flush_if_preconnected (stream *);
649 internal_proto(flush_if_preconnected);
651 extern void empty_internal_buffer(stream *);
652 internal_proto(empty_internal_buffer);
654 extern try flush (stream *);
655 internal_proto(flush);
657 extern int stream_isatty (stream *);
658 internal_proto(stream_isatty);
660 extern char * stream_ttyname (stream *);
661 internal_proto(stream_ttyname);
663 extern gfc_offset stream_offset (stream *s);
664 internal_proto(stream_offset);
666 extern int unit_to_fd (int);
667 internal_proto(unit_to_fd);
669 extern int unpack_filename (char *, const char *, int);
670 internal_proto(unpack_filename);
674 /* Maximum file offset, computed at library initialization time. */
675 extern gfc_offset max_offset;
676 internal_proto(max_offset);
678 /* Unit tree root. */
679 extern gfc_unit *unit_root;
680 internal_proto(unit_root);
682 extern __gthread_mutex_t unit_lock;
683 internal_proto(unit_lock);
685 extern int close_unit (gfc_unit *);
686 internal_proto(close_unit);
688 extern int is_internal_unit (st_parameter_dt *);
689 internal_proto(is_internal_unit);
691 extern int is_array_io (st_parameter_dt *);
692 internal_proto(is_array_io);
694 extern gfc_unit *find_unit (int);
695 internal_proto(find_unit);
697 extern gfc_unit *find_or_create_unit (int);
698 internal_proto(find_unit);
700 extern gfc_unit *get_unit (st_parameter_dt *, int);
701 internal_proto(get_unit);
703 extern void unlock_unit (gfc_unit *);
704 internal_proto(unlock_unit);
708 extern void test_endfile (gfc_unit *);
709 internal_proto(test_endfile);
711 extern gfc_unit *new_unit (st_parameter_open *, gfc_unit *, unit_flags *);
712 internal_proto(new_unit);
716 extern void parse_format (st_parameter_dt *);
717 internal_proto(parse_format);
719 extern const fnode *next_format (st_parameter_dt *);
720 internal_proto(next_format);
722 extern void unget_format (st_parameter_dt *, const fnode *);
723 internal_proto(unget_format);
725 extern void format_error (st_parameter_dt *, const fnode *, const char *);
726 internal_proto(format_error);
728 extern void free_format_data (st_parameter_dt *);
729 internal_proto(free_format_data);
733 #define SCRATCH_SIZE 300
735 extern const char *type_name (bt);
736 internal_proto(type_name);
738 extern void *read_block (st_parameter_dt *, int *);
739 internal_proto(read_block);
741 extern void *write_block (st_parameter_dt *, int);
742 internal_proto(write_block);
744 extern gfc_offset next_array_record (st_parameter_dt *, array_loop_spec *);
745 internal_proto(next_array_record);
747 extern gfc_offset init_loop_spec (gfc_array_char *, array_loop_spec *);
748 internal_proto(init_loop_spec);
750 extern void next_record (st_parameter_dt *, int);
751 internal_proto(next_record);
753 extern void reverse_memcpy (void *, const void *, size_t);
754 internal_proto (reverse_memcpy);
758 extern void set_integer (void *, GFC_INTEGER_LARGEST, int);
759 internal_proto(set_integer);
761 extern GFC_UINTEGER_LARGEST max_value (int, int);
762 internal_proto(max_value);
764 extern int convert_real (st_parameter_dt *, void *, const char *, int);
765 internal_proto(convert_real);
767 extern void read_a (st_parameter_dt *, const fnode *, char *, int);
768 internal_proto(read_a);
770 extern void read_f (st_parameter_dt *, const fnode *, char *, int);
771 internal_proto(read_f);
773 extern void read_l (st_parameter_dt *, const fnode *, char *, int);
774 internal_proto(read_l);
776 extern void read_x (st_parameter_dt *, int);
777 internal_proto(read_x);
779 extern void read_radix (st_parameter_dt *, const fnode *, char *, int, int);
780 internal_proto(read_radix);
782 extern void read_decimal (st_parameter_dt *, const fnode *, char *, int);
783 internal_proto(read_decimal);
787 extern void list_formatted_read (st_parameter_dt *, bt, void *, int, size_t,
789 internal_proto(list_formatted_read);
791 extern void finish_list_read (st_parameter_dt *);
792 internal_proto(finish_list_read);
794 extern void namelist_read (st_parameter_dt *);
795 internal_proto(namelist_read);
797 extern void namelist_write (st_parameter_dt *);
798 internal_proto(namelist_write);
802 extern void write_a (st_parameter_dt *, const fnode *, const char *, int);
803 internal_proto(write_a);
805 extern void write_b (st_parameter_dt *, const fnode *, const char *, int);
806 internal_proto(write_b);
808 extern void write_d (st_parameter_dt *, const fnode *, const char *, int);
809 internal_proto(write_d);
811 extern void write_e (st_parameter_dt *, const fnode *, const char *, int);
812 internal_proto(write_e);
814 extern void write_en (st_parameter_dt *, const fnode *, const char *, int);
815 internal_proto(write_en);
817 extern void write_es (st_parameter_dt *, const fnode *, const char *, int);
818 internal_proto(write_es);
820 extern void write_f (st_parameter_dt *, const fnode *, const char *, int);
821 internal_proto(write_f);
823 extern void write_i (st_parameter_dt *, const fnode *, const char *, int);
824 internal_proto(write_i);
826 extern void write_l (st_parameter_dt *, const fnode *, char *, int);
827 internal_proto(write_l);
829 extern void write_o (st_parameter_dt *, const fnode *, const char *, int);
830 internal_proto(write_o);
832 extern void write_x (st_parameter_dt *, int, int);
833 internal_proto(write_x);
835 extern void write_z (st_parameter_dt *, const fnode *, const char *, int);
836 internal_proto(write_z);
838 extern void list_formatted_write (st_parameter_dt *, bt, void *, int, size_t,
840 internal_proto(list_formatted_write);
843 extern try notify_std (int, const char *);
844 internal_proto(notify_std);
846 extern notification notification_std(int);
847 internal_proto(notification_std);
849 /* size_from_kind.c */
850 extern size_t size_from_real_kind (int);
851 internal_proto(size_from_real_kind);
853 extern size_t size_from_complex_kind (int);
854 internal_proto(size_from_complex_kind);
857 extern void free_ionml (st_parameter_dt *);
858 internal_proto(free_ionml);
861 inc_waiting_locked (gfc_unit *u)
863 #ifdef HAVE_SYNC_FETCH_AND_ADD
864 (void) __sync_fetch_and_add (&u->waiting, 1);
871 predec_waiting_locked (gfc_unit *u)
873 #ifdef HAVE_SYNC_FETCH_AND_ADD
874 return __sync_add_and_fetch (&u->waiting, -1);
881 dec_waiting_unlocked (gfc_unit *u)
883 #ifdef HAVE_SYNC_FETCH_AND_ADD
884 (void) __sync_fetch_and_add (&u->waiting, -1);
886 __gthread_mutex_lock (&unit_lock);
888 __gthread_mutex_unlock (&unit_lock);
894 /* ../runtime/environ.c This is here because we return unit_convert. */
896 unit_convert get_unformatted_convert (int);
897 internal_proto(get_unformatted_convert);