1 /* Copyright (C) 2002, 2003, 2004, 2005 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"
35 #ifdef HAVE_PRAGMA_WEAK
37 #define SUPPORTS_WEAK 1
42 #define _LARGE_FILE_API
47 #define DEFAULT_TEMPDIR "/tmp"
49 /* Basic types used in data transfers. */
52 { BT_NULL, BT_INTEGER, BT_LOGICAL, BT_CHARACTER, BT_REAL,
59 { SUCCESS = 1, FAILURE }
62 struct st_parameter_dt;
66 char *(*alloc_w_at) (struct stream *, int *, gfc_offset);
67 char *(*alloc_r_at) (struct stream *, int *, gfc_offset);
68 try (*sfree) (struct stream *);
69 try (*close) (struct stream *);
70 try (*seek) (struct stream *, gfc_offset);
71 try (*truncate) (struct stream *);
72 int (*read) (struct stream *, void *, size_t *);
73 int (*write) (struct stream *, const void *, size_t *);
78 /* Macros for doing file I/O given a stream. */
80 #define sfree(s) ((s)->sfree)(s)
81 #define sclose(s) ((s)->close)(s)
83 #define salloc_r(s, len) ((s)->alloc_r_at)(s, len, -1)
84 #define salloc_w(s, len) ((s)->alloc_w_at)(s, len, -1)
86 #define salloc_r_at(s, len, where) ((s)->alloc_r_at)(s, len, where)
87 #define salloc_w_at(s, len, where) ((s)->alloc_w_at)(s, len, where)
89 #define sseek(s, pos) ((s)->seek)(s, pos)
90 #define struncate(s) ((s)->truncate)(s)
91 #define sread(s, buf, nbytes) ((s)->read)(s, buf, nbytes)
92 #define swrite(s, buf, nbytes) ((s)->write)(s, buf, nbytes)
94 /* The array_loop_spec contains the variables for the loops over index ranges
95 that are encountered. Since the variables can be negative, ssize_t
98 typedef struct array_loop_spec
100 /* Index counter for this dimension. */
103 /* Start for the index counter. */
106 /* End for the index counter. */
109 /* Step for the index counter. */
114 /* Representation of a namelist object in libgfortran
117 &GROUPNAME OBJECT=value[s] [,OBJECT=value[s]].../
119 &GROUPNAME OBJECT=value[s] [,OBJECT=value[s]]...&END
121 The object can be a fully qualified, compound name for an instrinsic
122 type, derived types or derived type components. So, a substring
123 a(:)%b(4)%ch(2:4)(1:7) has to be treated correctly in namelist
124 read. Hence full information about the structure of the object has
125 to be available to list_read.c and write.
127 These requirements are met by the following data structures.
129 namelist_info type contains all the scalar information about the
130 object and arrays of descriptor_dimension and array_loop_spec types for
133 typedef struct namelist_type
136 /* Object type, stored as GFC_DTYPE_xxxx. */
142 /* Address for the start of the object's data. */
145 /* Flag to show that a read is to be attempted for this node. */
148 /* Length of intrinsic type in bytes. */
151 /* Rank of the object. */
154 /* Overall size of the object in bytes. */
157 /* Length of character string. */
158 index_type string_length;
160 descriptor_dimension * dim;
161 array_loop_spec * ls;
162 struct namelist_type * next;
166 /* Options for the OPEN statement. */
169 { ACCESS_SEQUENTIAL, ACCESS_DIRECT, ACCESS_APPEND,
175 { ACTION_READ, ACTION_WRITE, ACTION_READWRITE,
181 { BLANK_NULL, BLANK_ZERO, BLANK_UNSPECIFIED }
185 { DELIM_NONE, DELIM_APOSTROPHE, DELIM_QUOTE,
191 { FORM_FORMATTED, FORM_UNFORMATTED, FORM_UNSPECIFIED }
195 { POSITION_ASIS, POSITION_REWIND, POSITION_APPEND,
201 { STATUS_UNKNOWN, STATUS_OLD, STATUS_NEW, STATUS_SCRATCH,
202 STATUS_REPLACE, STATUS_UNSPECIFIED
207 { PAD_YES, PAD_NO, PAD_UNSPECIFIED }
211 { ADVANCE_YES, ADVANCE_NO, ADVANCE_UNSPECIFIED }
218 #define CHARACTER1(name) \
220 gfc_charlen_type name ## _len
221 #define CHARACTER2(name) \
222 gfc_charlen_type name ## _len; \
225 #define IOPARM_LIBRETURN_MASK (3 << 0)
226 #define IOPARM_LIBRETURN_OK (0 << 0)
227 #define IOPARM_LIBRETURN_ERROR (1 << 0)
228 #define IOPARM_LIBRETURN_END (2 << 0)
229 #define IOPARM_LIBRETURN_EOR (3 << 0)
230 #define IOPARM_ERR (1 << 2)
231 #define IOPARM_END (1 << 3)
232 #define IOPARM_EOR (1 << 4)
233 #define IOPARM_HAS_IOSTAT (1 << 5)
234 #define IOPARM_HAS_IOMSG (1 << 6)
236 #define IOPARM_COMMON_MASK ((1 << 7) - 1)
238 typedef struct st_parameter_common
242 const char *filename;
245 GFC_INTEGER_4 *iostat;
249 #define IOPARM_OPEN_HAS_RECL_IN (1 << 7)
250 #define IOPARM_OPEN_HAS_FILE (1 << 8)
251 #define IOPARM_OPEN_HAS_STATUS (1 << 9)
252 #define IOPARM_OPEN_HAS_ACCESS (1 << 10)
253 #define IOPARM_OPEN_HAS_FORM (1 << 11)
254 #define IOPARM_OPEN_HAS_BLANK (1 << 12)
255 #define IOPARM_OPEN_HAS_POSITION (1 << 13)
256 #define IOPARM_OPEN_HAS_ACTION (1 << 14)
257 #define IOPARM_OPEN_HAS_DELIM (1 << 15)
258 #define IOPARM_OPEN_HAS_PAD (1 << 16)
262 st_parameter_common common;
263 GFC_INTEGER_4 recl_in;
269 CHARACTER1 (position);
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)
316 st_parameter_common common;
317 GFC_INTEGER_4 *exist, *opened, *number, *named;
318 GFC_INTEGER_4 *nextrec, *recl_out;
323 CHARACTER1 (position);
328 CHARACTER2 (sequential);
330 CHARACTER2 (formatted);
331 CHARACTER1 (unformatted);
334 CHARACTER2 (readwrite);
336 st_parameter_inquire;
341 #define IOPARM_DT_LIST_FORMAT (1 << 7)
342 #define IOPARM_DT_NAMELIST_READ_MODE (1 << 8)
343 #define IOPARM_DT_HAS_REC (1 << 9)
344 #define IOPARM_DT_HAS_SIZE (1 << 10)
345 #define IOPARM_DT_HAS_IOLENGTH (1 << 11)
346 #define IOPARM_DT_HAS_FORMAT (1 << 12)
347 #define IOPARM_DT_HAS_ADVANCE (1 << 13)
348 #define IOPARM_DT_HAS_INTERNAL_UNIT (1 << 14)
349 #define IOPARM_DT_HAS_NAMELIST_NAME (1 << 15)
350 /* Internal use bit. */
351 #define IOPARM_DT_IONML_SET (1 << 31)
353 typedef struct st_parameter_dt
355 st_parameter_common common;
357 GFC_INTEGER_4 *size, *iolength;
358 gfc_array_char *internal_unit_desc;
360 CHARACTER2 (advance);
361 CHARACTER1 (internal_unit);
362 CHARACTER2 (namelist_name);
363 /* Private part of the structure. The compiler just needs
364 to reserve enough space. */
369 void (*transfer) (struct st_parameter_dt *, bt, void *, int,
371 struct gfc_unit *current_unit;
372 int item_count; /* Item number in a formatted data transfer. */
374 unit_blank blank_status;
375 enum {SIGN_S, SIGN_SS, SIGN_SP} sign_status;
377 int max_pos; /* Maximum righthand column written to. */
378 /* Number of skips + spaces to be done for T and X-editing. */
380 /* Number of spaces to be done for T and X-editing. */
382 /* Whether an EOR condition was encountered. Value is:
383 0 if no EOR was encountered
384 1 if an EOR was encountered due to a 1-byte marker (LF)
385 2 if an EOR was encountered due to a 2-bytes marker (CRLF) */
387 unit_advance advance_status;
389 unsigned reversion_flag : 1; /* Format reversion has occurred. */
390 unsigned first_item : 1;
391 unsigned seen_dollar : 1;
392 unsigned eor_condition : 1;
393 unsigned no_leading_blank : 1;
394 unsigned char_flag : 1;
395 unsigned input_complete : 1;
397 unsigned comma_flag : 1;
398 /* A namelist specific flag used in the list directed library
399 to flag that calls are being made from namelist read (eg. to
400 ignore comments or to treat '/' as a terminator) */
401 unsigned namelist_mode : 1;
402 /* A namelist specific flag used in the list directed library
403 to flag read errors and return, so that an attempt can be
404 made to read a new object name. */
405 unsigned nml_read_error : 1;
406 /* 20 unused bits. */
418 struct format_data *fmt;
420 namelist_info *ionml;
422 /* Storage area for values except for strings. Must be large
423 enough to hold a complex value (two reals) of the largest
427 char pad[16 * sizeof (char *) + 32 * sizeof (int)];
443 unit_position position;
450 /* The default value of record length for preconnected units is defined
451 here. This value can be overriden by an environment variable.
452 Default value is 1 Gb. */
454 #define DEFAULT_RECL 1073741824
457 typedef struct gfc_unit
463 struct gfc_unit *left, *right;
466 int read_bad, current_record;
468 { NO_ENDFILE, AT_ENDFILE, AFTER_ENDFILE }
474 /* recl -- Record length of the file.
475 last_record -- Last record number read or written
476 maxrec -- Maximum record number in a direct access file
477 bytes_left -- Bytes left in current record. */
478 gfc_offset recl, last_record, maxrec, bytes_left;
480 __gthread_mutex_t lock;
481 /* Number of threads waiting to acquire this unit's lock.
482 When non-zero, close_unit doesn't only removes the unit
483 from the UNIT_ROOT tree, but doesn't free it and the
484 last of the waiting threads will do that.
485 This must be either atomically increased/decreased, or
486 always guarded by UNIT_LOCK. */
488 /* Flag set by close_unit if the unit as been closed.
489 Must be manipulated under unit's lock. */
492 /* For traversing arrays */
501 /* Format tokens. Only about half of these can be stored in the
506 FMT_NONE = 0, FMT_UNKNOWN, FMT_SIGNED_INT, FMT_ZERO, FMT_POSINT, FMT_PERIOD,
507 FMT_COMMA, FMT_COLON, FMT_SLASH, FMT_DOLLAR, FMT_T, FMT_TR, FMT_TL,
508 FMT_LPAREN, FMT_RPAREN, FMT_X, FMT_S, FMT_SS, FMT_SP, FMT_STRING,
509 FMT_BADSTRING, FMT_P, FMT_I, FMT_B, FMT_BN, FMT_BZ, FMT_O, FMT_Z, FMT_F,
510 FMT_E, FMT_EN, FMT_ES, FMT_G, FMT_L, FMT_A, FMT_D, FMT_H, FMT_END
515 /* Format nodes. A format string is converted into a tree of these
516 structures, which is traversed as part of a data transfer statement. */
555 /* Members for traversing the tree during data transfer. */
558 struct fnode *current;
566 extern int move_pos_offset (stream *, int);
567 internal_proto(move_pos_offset);
569 extern int compare_files (stream *, stream *);
570 internal_proto(compare_files);
572 extern stream *open_external (st_parameter_open *, unit_flags *);
573 internal_proto(open_external);
575 extern stream *open_internal (char *, int);
576 internal_proto(open_internal);
578 extern stream *input_stream (void);
579 internal_proto(input_stream);
581 extern stream *output_stream (void);
582 internal_proto(output_stream);
584 extern stream *error_stream (void);
585 internal_proto(error_stream);
587 extern int compare_file_filename (gfc_unit *, const char *, int);
588 internal_proto(compare_file_filename);
590 extern gfc_unit *find_file (const char *file, gfc_charlen_type file_len);
591 internal_proto(find_file);
593 extern void flush_all_units (void);
594 internal_proto(flush_all_units);
596 extern int stream_at_bof (stream *);
597 internal_proto(stream_at_bof);
599 extern int stream_at_eof (stream *);
600 internal_proto(stream_at_eof);
602 extern int delete_file (gfc_unit *);
603 internal_proto(delete_file);
605 extern int file_exists (const char *file, gfc_charlen_type file_len);
606 internal_proto(file_exists);
608 extern const char *inquire_sequential (const char *, int);
609 internal_proto(inquire_sequential);
611 extern const char *inquire_direct (const char *, int);
612 internal_proto(inquire_direct);
614 extern const char *inquire_formatted (const char *, int);
615 internal_proto(inquire_formatted);
617 extern const char *inquire_unformatted (const char *, int);
618 internal_proto(inquire_unformatted);
620 extern const char *inquire_read (const char *, int);
621 internal_proto(inquire_read);
623 extern const char *inquire_write (const char *, int);
624 internal_proto(inquire_write);
626 extern const char *inquire_readwrite (const char *, int);
627 internal_proto(inquire_readwrite);
629 extern gfc_offset file_length (stream *);
630 internal_proto(file_length);
632 extern gfc_offset file_position (stream *);
633 internal_proto(file_position);
635 extern int is_seekable (stream *);
636 internal_proto(is_seekable);
638 extern int is_preconnected (stream *);
639 internal_proto(is_preconnected);
641 extern void flush_if_preconnected (stream *);
642 internal_proto(flush_if_preconnected);
644 extern void empty_internal_buffer(stream *);
645 internal_proto(empty_internal_buffer);
647 extern try flush (stream *);
648 internal_proto(flush);
650 extern int stream_isatty (stream *);
651 internal_proto(stream_isatty);
653 extern char * stream_ttyname (stream *);
654 internal_proto(stream_ttyname);
656 extern gfc_offset stream_offset (stream *s);
657 internal_proto(stream_offset);
659 extern int unit_to_fd (int);
660 internal_proto(unit_to_fd);
662 extern int unpack_filename (char *, const char *, int);
663 internal_proto(unpack_filename);
667 /* Maximum file offset, computed at library initialization time. */
668 extern gfc_offset max_offset;
669 internal_proto(max_offset);
671 /* Unit tree root. */
672 extern gfc_unit *unit_root;
673 internal_proto(unit_root);
675 extern __gthread_mutex_t unit_lock;
676 internal_proto(unit_lock);
678 extern int close_unit (gfc_unit *);
679 internal_proto(close_unit);
681 extern int is_internal_unit (st_parameter_dt *);
682 internal_proto(is_internal_unit);
684 extern int is_array_io (st_parameter_dt *);
685 internal_proto(is_array_io);
687 extern gfc_unit *find_unit (int);
688 internal_proto(find_unit);
690 extern gfc_unit *find_or_create_unit (int);
691 internal_proto(find_unit);
693 extern gfc_unit *get_unit (st_parameter_dt *, int);
694 internal_proto(get_unit);
696 extern void unlock_unit (gfc_unit *);
697 internal_proto(unlock_unit);
701 extern void test_endfile (gfc_unit *);
702 internal_proto(test_endfile);
704 extern gfc_unit *new_unit (st_parameter_open *, gfc_unit *, unit_flags *);
705 internal_proto(new_unit);
709 extern void parse_format (st_parameter_dt *);
710 internal_proto(parse_format);
712 extern const fnode *next_format (st_parameter_dt *);
713 internal_proto(next_format);
715 extern void unget_format (st_parameter_dt *, const fnode *);
716 internal_proto(unget_format);
718 extern void format_error (st_parameter_dt *, const fnode *, const char *);
719 internal_proto(format_error);
721 extern void free_format_data (st_parameter_dt *);
722 internal_proto(free_format_data);
726 #define SCRATCH_SIZE 300
728 extern const char *type_name (bt);
729 internal_proto(type_name);
731 extern void *read_block (st_parameter_dt *, int *);
732 internal_proto(read_block);
734 extern void *write_block (st_parameter_dt *, int);
735 internal_proto(write_block);
737 extern gfc_offset next_array_record (st_parameter_dt *, array_loop_spec *);
738 internal_proto(next_array_record);
740 extern gfc_offset init_loop_spec (gfc_array_char *, array_loop_spec *);
741 internal_proto(init_loop_spec);
743 extern void next_record (st_parameter_dt *, int);
744 internal_proto(next_record);
748 extern void set_integer (void *, GFC_INTEGER_LARGEST, int);
749 internal_proto(set_integer);
751 extern GFC_UINTEGER_LARGEST max_value (int, int);
752 internal_proto(max_value);
754 extern int convert_real (st_parameter_dt *, void *, const char *, int);
755 internal_proto(convert_real);
757 extern void read_a (st_parameter_dt *, const fnode *, char *, int);
758 internal_proto(read_a);
760 extern void read_f (st_parameter_dt *, const fnode *, char *, int);
761 internal_proto(read_f);
763 extern void read_l (st_parameter_dt *, const fnode *, char *, int);
764 internal_proto(read_l);
766 extern void read_x (st_parameter_dt *, int);
767 internal_proto(read_x);
769 extern void read_radix (st_parameter_dt *, const fnode *, char *, int, int);
770 internal_proto(read_radix);
772 extern void read_decimal (st_parameter_dt *, const fnode *, char *, int);
773 internal_proto(read_decimal);
777 extern void list_formatted_read (st_parameter_dt *, bt, void *, int, size_t,
779 internal_proto(list_formatted_read);
781 extern void finish_list_read (st_parameter_dt *);
782 internal_proto(finish_list_read);
784 extern void namelist_read (st_parameter_dt *);
785 internal_proto(namelist_read);
787 extern void namelist_write (st_parameter_dt *);
788 internal_proto(namelist_write);
792 extern void write_a (st_parameter_dt *, const fnode *, const char *, int);
793 internal_proto(write_a);
795 extern void write_b (st_parameter_dt *, const fnode *, const char *, int);
796 internal_proto(write_b);
798 extern void write_d (st_parameter_dt *, const fnode *, const char *, int);
799 internal_proto(write_d);
801 extern void write_e (st_parameter_dt *, const fnode *, const char *, int);
802 internal_proto(write_e);
804 extern void write_en (st_parameter_dt *, const fnode *, const char *, int);
805 internal_proto(write_en);
807 extern void write_es (st_parameter_dt *, const fnode *, const char *, int);
808 internal_proto(write_es);
810 extern void write_f (st_parameter_dt *, const fnode *, const char *, int);
811 internal_proto(write_f);
813 extern void write_i (st_parameter_dt *, const fnode *, const char *, int);
814 internal_proto(write_i);
816 extern void write_l (st_parameter_dt *, const fnode *, char *, int);
817 internal_proto(write_l);
819 extern void write_o (st_parameter_dt *, const fnode *, const char *, int);
820 internal_proto(write_o);
822 extern void write_x (st_parameter_dt *, int, int);
823 internal_proto(write_x);
825 extern void write_z (st_parameter_dt *, const fnode *, const char *, int);
826 internal_proto(write_z);
828 extern void list_formatted_write (st_parameter_dt *, bt, void *, int, size_t,
830 internal_proto(list_formatted_write);
833 extern try notify_std (int, const char *);
834 internal_proto(notify_std);
836 /* size_from_kind.c */
837 extern size_t size_from_real_kind (int);
838 internal_proto(size_from_real_kind);
840 extern size_t size_from_complex_kind (int);
841 internal_proto(size_from_complex_kind);
844 extern void free_ionml (st_parameter_dt *);
845 internal_proto(free_ionml);
848 inc_waiting_locked (gfc_unit *u)
850 #ifdef HAVE_SYNC_FETCH_AND_ADD
851 (void) __sync_fetch_and_add (&u->waiting, 1);
858 predec_waiting_locked (gfc_unit *u)
860 #ifdef HAVE_SYNC_FETCH_AND_ADD
861 return __sync_add_and_fetch (&u->waiting, -1);
868 dec_waiting_unlocked (gfc_unit *u)
870 #ifdef HAVE_SYNC_FETCH_AND_ADD
871 (void) __sync_fetch_and_add (&u->waiting, -1);
873 __gthread_mutex_lock (&unit_lock);
875 __gthread_mutex_unlock (&unit_lock);