libgfortran/io/io.h

   1 /* Copyright (C) 2002-2017 Free Software Foundation, Inc.
   2    Contributed by Andy Vaught
   3    F2003 I/O support contributed by Jerry DeLisle
   4
   5 This file is part of the GNU Fortran runtime library (libgfortran).
   6
   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 3, or (at your option)
  10 any later version.
  11
  12 Libgfortran is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 Under Section 7 of GPL version 3, you are granted additional
  18 permissions described in the GCC Runtime Library Exception, version
  19 3.1, as published by the Free Software Foundation.
  20
  21 You should have received a copy of the GNU General Public License and
  22 a copy of the GCC Runtime Library Exception along with this program;
  23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 <http://www.gnu.org/licenses/>.  */
  25
  26 #ifndef GFOR_IO_H
  27 #define GFOR_IO_H
  28
  29 /* IO library include.  */
  30
  31 #include "libgfortran.h"
  32
  33 #include <gthr.h>
  34
  35
  36 /* POSIX 2008 specifies that the extended locale stuff is found in
  37    locale.h, but some systems have them in xlocale.h.  */
  38
  39 #include <locale.h>
  40
  41 #ifdef HAVE_XLOCALE_H
  42 #include <xlocale.h>
  43 #endif
  44
  45
  46 /* Forward declarations.  */
  47 struct st_parameter_dt;
  48 typedef struct stream stream;
  49 struct fbuf;
  50 struct format_data;
  51 typedef struct fnode fnode;
  52 struct gfc_unit;
  53
  54 #ifdef HAVE_NEWLOCALE
  55 /* We have POSIX 2008 extended locale stuff.  */
  56 extern locale_t c_locale;
  57 internal_proto(c_locale);
  58 #else
  59 extern char* old_locale;
  60 internal_proto(old_locale);
  61 extern int old_locale_ctr;
  62 internal_proto(old_locale_ctr);
  63 extern __gthread_mutex_t old_locale_lock;
  64 internal_proto(old_locale_lock);
  65 #endif
  66
  67
  68 /* Macros for testing what kinds of I/O we are doing.  */
  69
  70 #define is_array_io(dtp) ((dtp)->internal_unit_desc)
  71
  72 #define is_internal_unit(dtp) ((dtp)->u.p.current_unit->internal_unit_kind)
  73
  74 #define is_stream_io(dtp) ((dtp)->u.p.current_unit->flags.access == ACCESS_STREAM)
  75
  76 #define is_char4_unit(dtp) ((dtp)->u.p.current_unit->internal_unit_kind == 4)
  77
  78 /* The array_loop_spec contains the variables for the loops over index ranges
  79    that are encountered.  */
  80
  81 typedef struct array_loop_spec
  82 {
  83   /* Index counter for this dimension.  */
  84   index_type idx;
  85
  86   /* Start for the index counter.  */
  87   index_type start;
  88
  89   /* End for the index counter.  */
  90   index_type end;
  91
  92   /* Step for the index counter.  */
  93   index_type step;
  94 }
  95 array_loop_spec;
  96
  97 /* User defined input/output iomsg length. */
  98
  99 #define IOMSG_LEN 256
 100
 101 /* Subroutine formatted_dtio (struct, unit, iotype, v_list, iostat,
 102                               iomsg, (_iotype), (_iomsg))  */
 103 typedef void (*formatted_dtio)(void *, GFC_INTEGER_4 *, char *, gfc_array_i4 *,
 104                                GFC_INTEGER_4 *, char *,
 105                                gfc_charlen_type, gfc_charlen_type);
 106
 107 /* Subroutine unformatted_dtio (struct, unit, iostat, iomsg, (_iomsg))  */
 108 typedef void (*unformatted_dtio)(void *, GFC_INTEGER_4 *, GFC_INTEGER_4 *,
 109                                  char *, gfc_charlen_type);
 110
 111 /* The dtio calls for namelist require a CLASS object to be built.  */
 112 typedef struct gfc_class
 113 {
 114   void *data;
 115   void *vptr;
 116   index_type len;
 117 }
 118 gfc_class;
 119
 120
 121 /* A structure to build a hash table for format data.  */
 122
 123 #define FORMAT_HASH_SIZE 16
 124
 125 typedef struct format_hash_entry
 126 {
 127   char *key;
 128   gfc_charlen_type key_len;
 129   struct format_data *hashed_fmt;
 130 }
 131 format_hash_entry;
 132
 133 /* Representation of a namelist object in libgfortran
 134
 135    Namelist Records
 136       &GROUPNAME  OBJECT=value[s] [,OBJECT=value[s]].../
 137      or
 138       &GROUPNAME  OBJECT=value[s] [,OBJECT=value[s]]...&END
 139
 140    The object can be a fully qualified, compound name for an intrinsic
 141    type, derived types or derived type components.  So, a substring
 142    a(:)%b(4)%ch(2:4)(1:7) has to be treated correctly in namelist
 143    read. Hence full information about the structure of the object has
 144    to be available to list_read.c and write.
 145
 146    These requirements are met by the following data structures.
 147
 148    namelist_info type contains all the scalar information about the
 149    object and arrays of descriptor_dimension and array_loop_spec types for
 150    arrays.  */
 151
 152 typedef struct namelist_type
 153 {
 154   /* Object type.  */
 155   bt type;
 156
 157   /* Object name.  */
 158   char * var_name;
 159
 160   /* Address for the start of the object's data.  */
 161   void * mem_pos;
 162
 163   /* Address of specific DTIO subroutine.  */
 164   void * dtio_sub;
 165
 166   /* Address of vtable if dtio_sub non-null.  */
 167   void * vtable;
 168
 169   /* Flag to show that a read is to be attempted for this node.  */
 170   int touched;
 171
 172   /* Length of intrinsic type in bytes.  */
 173   int len;
 174
 175   /* Rank of the object.  */
 176   int var_rank;
 177
 178   /* Overall size of the object in bytes.  */
 179   index_type size;
 180
 181   /* Length of character string.  */
 182   index_type string_length;
 183
 184   descriptor_dimension * dim;
 185   array_loop_spec * ls;
 186   struct namelist_type * next;
 187 }
 188 namelist_info;
 189
 190 /* Options for the OPEN statement.  */
 191
 192 typedef enum
 193 { ACCESS_SEQUENTIAL, ACCESS_DIRECT, ACCESS_APPEND, ACCESS_STREAM,
 194   ACCESS_UNSPECIFIED
 195 }
 196 unit_access;
 197
 198 typedef enum
 199 { ACTION_READ, ACTION_WRITE, ACTION_READWRITE,
 200   ACTION_UNSPECIFIED
 201 }
 202 unit_action;
 203
 204 typedef enum
 205 { BLANK_NULL, BLANK_ZERO, BLANK_UNSPECIFIED }
 206 unit_blank;
 207
 208 typedef enum
 209 { DELIM_NONE, DELIM_APOSTROPHE, DELIM_QUOTE,
 210   DELIM_UNSPECIFIED
 211 }
 212 unit_delim;
 213
 214 typedef enum
 215 { FORM_FORMATTED, FORM_UNFORMATTED, FORM_UNSPECIFIED }
 216 unit_form;
 217
 218 typedef enum
 219 { POSITION_ASIS, POSITION_REWIND, POSITION_APPEND,
 220   POSITION_UNSPECIFIED
 221 }
 222 unit_position;
 223
 224 typedef enum
 225 { STATUS_UNKNOWN, STATUS_OLD, STATUS_NEW, STATUS_SCRATCH,
 226   STATUS_REPLACE, STATUS_UNSPECIFIED
 227 }
 228 unit_status;
 229
 230 typedef enum
 231 { PAD_YES, PAD_NO, PAD_UNSPECIFIED }
 232 unit_pad;
 233
 234 typedef enum
 235 { DECIMAL_POINT, DECIMAL_COMMA, DECIMAL_UNSPECIFIED }
 236 unit_decimal;
 237
 238 typedef enum
 239 { ENCODING_UTF8, ENCODING_DEFAULT, ENCODING_UNSPECIFIED }
 240 unit_encoding;
 241
 242 typedef enum
 243 { ROUND_UP = GFC_FPE_UPWARD,
 244   ROUND_DOWN = GFC_FPE_DOWNWARD,
 245   ROUND_ZERO = GFC_FPE_TOWARDZERO,
 246   ROUND_NEAREST = GFC_FPE_TONEAREST,
 247   ROUND_COMPATIBLE = 10, /* round away from zero.  */
 248   ROUND_PROCDEFINED, /* Here as ROUND_NEAREST. */
 249   ROUND_UNSPECIFIED /* Should never occur. */
 250 }
 251 unit_round;
 252
 253 /* NOTE: unit_sign must correspond with the sign_status enumerator in
 254    st_parameter_dt to not break the ABI.  */
 255 typedef enum
 256 { SIGN_PROCDEFINED, SIGN_SUPPRESS, SIGN_PLUS, SIGN_UNSPECIFIED }
 257 unit_sign;
 258
 259 typedef enum
 260 { ADVANCE_YES, ADVANCE_NO, ADVANCE_UNSPECIFIED }
 261 unit_advance;
 262
 263 typedef enum
 264 {READING, WRITING, LIST_READING, LIST_WRITING}
 265 unit_mode;
 266
 267 typedef enum
 268 { ASYNC_YES, ASYNC_NO, ASYNC_UNSPECIFIED }
 269 unit_async;
 270
 271 typedef enum
 272 { SHARE_DENYRW, SHARE_DENYNONE,
 273   SHARE_UNSPECIFIED
 274 }
 275 unit_share;
 276
 277 typedef enum
 278 { CC_LIST, CC_FORTRAN, CC_NONE,
 279   CC_UNSPECIFIED
 280 }
 281 unit_cc;
 282
 283 /* End-of-record types for CC_FORTRAN.  */
 284 typedef enum
 285 { CCF_DEFAULT=0x0,
 286   CCF_OVERPRINT=0x1,
 287   CCF_ONE_LF=0x2,
 288   CCF_TWO_LF=0x4,
 289   CCF_PAGE_FEED=0x8,
 290   CCF_PROMPT=0x10,
 291   CCF_OVERPRINT_NOA=0x20,
 292 } /* 6 bits */
 293 cc_fortran;
 294
 295 typedef enum
 296 { SIGN_S, SIGN_SS, SIGN_SP }
 297 unit_sign_s;
 298
 299 /* Make sure to keep st_parameter_* in sync with gcc/fortran/ioparm.def.  */
 300
 301 #define CHARACTER1(name) \
 302               char * name; \
 303               gfc_charlen_type name ## _len
 304 #define CHARACTER2(name) \
 305               gfc_charlen_type name ## _len; \
 306               char * name
 307
 308 typedef struct
 309 {
 310   st_parameter_common common;
 311   GFC_INTEGER_4 recl_in;
 312   CHARACTER2 (file);
 313   CHARACTER1 (status);
 314   CHARACTER2 (access);
 315   CHARACTER1 (form);
 316   CHARACTER2 (blank);
 317   CHARACTER1 (position);
 318   CHARACTER2 (action);
 319   CHARACTER1 (delim);
 320   CHARACTER2 (pad);
 321   CHARACTER1 (convert);
 322   CHARACTER2 (decimal);
 323   CHARACTER1 (encoding);
 324   CHARACTER2 (round);
 325   CHARACTER1 (sign);
 326   CHARACTER2 (asynchronous);
 327   GFC_INTEGER_4 *newunit;
 328   GFC_INTEGER_4 readonly;
 329   CHARACTER2 (cc);
 330   CHARACTER1 (share);
 331 }
 332 st_parameter_open;
 333
 334 #define IOPARM_CLOSE_HAS_STATUS         (1 << 7)
 335
 336 typedef struct
 337 {
 338   st_parameter_common common;
 339   CHARACTER1 (status);
 340 }
 341 st_parameter_close;
 342
 343 typedef struct
 344 {
 345   st_parameter_common common;
 346 }
 347 st_parameter_filepos;
 348
 349 #define IOPARM_INQUIRE_HAS_EXIST        (1 << 7)
 350 #define IOPARM_INQUIRE_HAS_OPENED       (1 << 8)
 351 #define IOPARM_INQUIRE_HAS_NUMBER       (1 << 9)
 352 #define IOPARM_INQUIRE_HAS_NAMED        (1 << 10)
 353 #define IOPARM_INQUIRE_HAS_NEXTREC      (1 << 11)
 354 #define IOPARM_INQUIRE_HAS_RECL_OUT     (1 << 12)
 355 #define IOPARM_INQUIRE_HAS_STRM_POS_OUT (1 << 13)
 356 #define IOPARM_INQUIRE_HAS_FILE         (1 << 14)
 357 #define IOPARM_INQUIRE_HAS_ACCESS       (1 << 15)
 358 #define IOPARM_INQUIRE_HAS_FORM         (1 << 16)
 359 #define IOPARM_INQUIRE_HAS_BLANK        (1 << 17)
 360 #define IOPARM_INQUIRE_HAS_POSITION     (1 << 18)
 361 #define IOPARM_INQUIRE_HAS_ACTION       (1 << 19)
 362 #define IOPARM_INQUIRE_HAS_DELIM        (1 << 20)
 363 #define IOPARM_INQUIRE_HAS_PAD          (1 << 21)
 364 #define IOPARM_INQUIRE_HAS_NAME         (1 << 22)
 365 #define IOPARM_INQUIRE_HAS_SEQUENTIAL   (1 << 23)
 366 #define IOPARM_INQUIRE_HAS_DIRECT       (1 << 24)
 367 #define IOPARM_INQUIRE_HAS_FORMATTED    (1 << 25)
 368 #define IOPARM_INQUIRE_HAS_UNFORMATTED  (1 << 26)
 369 #define IOPARM_INQUIRE_HAS_READ         (1 << 27)
 370 #define IOPARM_INQUIRE_HAS_WRITE        (1 << 28)
 371 #define IOPARM_INQUIRE_HAS_READWRITE    (1 << 29)
 372 #define IOPARM_INQUIRE_HAS_CONVERT      (1 << 30)
 373 #define IOPARM_INQUIRE_HAS_FLAGS2       (1u << 31)
 374
 375 #define IOPARM_INQUIRE_HAS_ASYNCHRONOUS (1 << 0)
 376 #define IOPARM_INQUIRE_HAS_DECIMAL      (1 << 1)
 377 #define IOPARM_INQUIRE_HAS_ENCODING     (1 << 2)
 378 #define IOPARM_INQUIRE_HAS_ROUND        (1 << 3)
 379 #define IOPARM_INQUIRE_HAS_SIGN         (1 << 4)
 380 #define IOPARM_INQUIRE_HAS_PENDING      (1 << 5)
 381 #define IOPARM_INQUIRE_HAS_SIZE         (1 << 6)
 382 #define IOPARM_INQUIRE_HAS_ID           (1 << 7)
 383 #define IOPARM_INQUIRE_HAS_IQSTREAM     (1 << 8)
 384 #define IOPARM_INQUIRE_HAS_SHARE        (1 << 9)
 385 #define IOPARM_INQUIRE_HAS_CC           (1 << 10)
 386
 387 typedef struct
 388 {
 389   st_parameter_common common;
 390   GFC_INTEGER_4 *exist, *opened, *number, *named;
 391   GFC_INTEGER_4 *nextrec, *recl_out;
 392   GFC_IO_INT *strm_pos_out;
 393   CHARACTER1 (file);
 394   CHARACTER2 (access);
 395   CHARACTER1 (form);
 396   CHARACTER2 (blank);
 397   CHARACTER1 (position);
 398   CHARACTER2 (action);
 399   CHARACTER1 (delim);
 400   CHARACTER2 (pad);
 401   CHARACTER1 (name);
 402   CHARACTER2 (sequential);
 403   CHARACTER1 (direct);
 404   CHARACTER2 (formatted);
 405   CHARACTER1 (unformatted);
 406   CHARACTER2 (read);
 407   CHARACTER1 (write);
 408   CHARACTER2 (readwrite);
 409   CHARACTER1 (convert);
 410   GFC_INTEGER_4 flags2;
 411   CHARACTER1 (asynchronous);
 412   CHARACTER2 (decimal);
 413   CHARACTER1 (encoding);
 414   CHARACTER2 (round);
 415   CHARACTER1 (sign);
 416   GFC_INTEGER_4 *pending;
 417   GFC_IO_INT *size;
 418   GFC_INTEGER_4 *id;
 419   CHARACTER1 (iqstream);
 420   CHARACTER2 (share);
 421   CHARACTER1 (cc);
 422 }
 423 st_parameter_inquire;
 424
 425
 426 #define IOPARM_DT_LIST_FORMAT                   (1 << 7)
 427 #define IOPARM_DT_NAMELIST_READ_MODE            (1 << 8)
 428 #define IOPARM_DT_HAS_REC                       (1 << 9)
 429 #define IOPARM_DT_HAS_SIZE                      (1 << 10)
 430 #define IOPARM_DT_HAS_IOLENGTH                  (1 << 11)
 431 #define IOPARM_DT_HAS_FORMAT                    (1 << 12)
 432 #define IOPARM_DT_HAS_ADVANCE                   (1 << 13)
 433 #define IOPARM_DT_HAS_INTERNAL_UNIT             (1 << 14)
 434 #define IOPARM_DT_HAS_NAMELIST_NAME             (1 << 15)
 435 #define IOPARM_DT_HAS_ID                        (1 << 16)
 436 #define IOPARM_DT_HAS_POS                       (1 << 17)
 437 #define IOPARM_DT_HAS_ASYNCHRONOUS              (1 << 18)
 438 #define IOPARM_DT_HAS_BLANK                     (1 << 19)
 439 #define IOPARM_DT_HAS_DECIMAL                   (1 << 20)
 440 #define IOPARM_DT_HAS_DELIM                     (1 << 21)
 441 #define IOPARM_DT_HAS_PAD                       (1 << 22)
 442 #define IOPARM_DT_HAS_ROUND                     (1 << 23)
 443 #define IOPARM_DT_HAS_SIGN                      (1 << 24)
 444 #define IOPARM_DT_HAS_F2003                     (1 << 25)
 445 #define IOPARM_DT_HAS_UDTIO                     (1 << 26)
 446 #define IOPARM_DT_DEFAULT_EXP                   (1 << 27)
 447 /* Internal use bit.  */
 448 #define IOPARM_DT_IONML_SET                     (1u << 31)
 449
 450
 451 typedef struct st_parameter_dt
 452 {
 453   st_parameter_common common;
 454   GFC_IO_INT rec;
 455   GFC_IO_INT *size, *iolength;
 456   gfc_array_char *internal_unit_desc;
 457   CHARACTER1 (format);
 458   CHARACTER2 (advance);
 459   CHARACTER1 (internal_unit);
 460   CHARACTER2 (namelist_name);
 461   GFC_INTEGER_4 *id;
 462   GFC_IO_INT pos;
 463   CHARACTER1 (asynchronous);
 464   CHARACTER2 (blank);
 465   CHARACTER1 (decimal);
 466   CHARACTER2 (delim);
 467   CHARACTER1 (pad);
 468   CHARACTER2 (round);
 469   CHARACTER1 (sign);
 470   /* Private part of the structure.  The compiler just needs
 471      to reserve enough space.  */
 472   union
 473     {
 474       struct
 475         {
 476           void (*transfer) (struct st_parameter_dt *, bt, void *, int,
 477                             size_t, size_t);
 478           struct gfc_unit *current_unit;
 479           /* Item number in a formatted data transfer.  Also used in namelist
 480              read_logical as an index into line_buffer.  */
 481           int item_count;
 482           unit_mode mode;
 483           unit_blank blank_status;
 484           unit_sign sign_status;
 485           int scale_factor;
 486           /* Maximum righthand column written to.  */
 487           int max_pos;
 488           /* Number of skips + spaces to be done for T and X-editing.  */
 489           int skips;
 490           /* Number of spaces to be done for T and X-editing.  */
 491           int pending_spaces;
 492           /* Whether an EOR condition was encountered. Value is:
 493                0 if no EOR was encountered
 494                1 if an EOR was encountered due to a 1-byte marker (LF)
 495                2 if an EOR was encountered due to a 2-bytes marker (CRLF) */
 496           int sf_seen_eor;
 497           unit_advance advance_status;
 498           unsigned reversion_flag : 1; /* Format reversion has occurred.  */
 499           unsigned first_item : 1;
 500           unsigned seen_dollar : 1;
 501           unsigned eor_condition : 1;
 502           unsigned no_leading_blank : 1;
 503           unsigned char_flag : 1;
 504           unsigned input_complete : 1;
 505           unsigned at_eol : 1;
 506           unsigned comma_flag : 1;
 507           /* A namelist specific flag used in the list directed library
 508              to flag that calls are being made from namelist read (e.g. to
 509              ignore comments or to treat '/' as a terminator)  */
 510           unsigned namelist_mode : 1;
 511           /* A namelist specific flag used in the list directed library
 512              to flag read errors and return, so that an attempt can be
 513              made to read a new object name.  */
 514           unsigned nml_read_error : 1;
 515           /* A sequential formatted read specific flag used to signal that a
 516              character string is being read so don't use commas to shorten a
 517              formatted field width.  */
 518           unsigned sf_read_comma : 1;
 519           /* A namelist specific flag used to enable reading input from
 520              line_buffer for logical reads.  */
 521           unsigned line_buffer_enabled : 1;
 522           /* An internal unit specific flag used to identify that the associated
 523              unit is internal.  */
 524           unsigned unit_is_internal : 1;
 525           /* An internal unit specific flag to signify an EOF condition for list
 526              directed read.  */
 527           unsigned at_eof : 1;
 528           /* Used for g0 floating point output.  */
 529           unsigned g0_no_blanks : 1;
 530           /* Used to signal use of free_format_data.  */
 531           unsigned format_not_saved : 1;
 532           /* A flag used to identify when a non-standard expanded namelist read
 533              has occurred.  */
 534           unsigned expanded_read : 1;
 535           /* 13 unused bits.  */
 536
 537           int child_saved_iostat;
 538           int nml_delim;
 539           int repeat_count;
 540           int saved_length;
 541           int saved_used;
 542           bt saved_type;
 543           char *saved_string;
 544           char *scratch;
 545           char *line_buffer;
 546           struct format_data *fmt;
 547           namelist_info *ionml;
 548 #ifdef HAVE_NEWLOCALE
 549           locale_t old_locale;
 550 #endif
 551           /* Current position within the look-ahead line buffer.  */
 552           int line_buffer_pos;
 553           /* Storage area for values except for strings.  Must be
 554              large enough to hold a complex value (two reals) of the
 555              largest kind.  */
 556           char value[32];
 557           GFC_IO_INT not_used; /* Needed for alignment. */
 558           formatted_dtio fdtio_ptr;
 559           unformatted_dtio ufdtio_ptr;
 560           /* With CC_FORTRAN, the first character of a record determines the
 561              style of record end (and start) to use. We must mark down the type
 562              when we write first in write_a so we remember the end type later in
 563              next_record_w.  */
 564           struct
 565             {
 566               unsigned type : 6; /* See enum cc_fortran.  */
 567               unsigned len  : 2; /* Always 0, 1, or 2.  */
 568               /* The union is updated after start-of-record is written.  */
 569               union
 570                 {
 571                   char start; /* Output character for start of record.  */
 572                   char end;   /* Output character for end of record.  */
 573                 } u;
 574             } cc;
 575         } p;
 576       /* This pad size must be equal to the pad_size declared in
 577          trans-io.c (gfc_build_io_library_fndecls).  The above structure
 578          must be smaller or equal to this array.  */
 579       char pad[16 * sizeof (char *) + 32 * sizeof (int)];
 580     } u;
 581 }
 582 st_parameter_dt;
 583
 584 /* Ensure st_parameter_dt's u.pad is bigger or equal to u.p.  */
 585 extern char check_st_parameter_dt[sizeof (((st_parameter_dt *) 0)->u.pad)
 586                                   >= sizeof (((st_parameter_dt *) 0)->u.p)
 587                                   ? 1 : -1];
 588
 589 #define IOPARM_WAIT_HAS_ID              (1 << 7)
 590
 591 typedef struct
 592 {
 593   st_parameter_common common;
 594   CHARACTER1 (id);
 595 }
 596 st_parameter_wait;
 597
 598
 599 #undef CHARACTER1
 600 #undef CHARACTER2
 601
 602 typedef struct
 603 {
 604   unit_access access;
 605   unit_action action;
 606   unit_blank blank;
 607   unit_delim delim;
 608   unit_form form;
 609   int is_notpadded;
 610   unit_position position;
 611   unit_status status;
 612   unit_pad pad;
 613   unit_convert convert;
 614   int has_recl;
 615   unit_decimal decimal;
 616   unit_encoding encoding;
 617   unit_round round;
 618   unit_sign sign;
 619   unit_async async;
 620   unit_share share;
 621   unit_cc cc;
 622   int readonly;
 623 }
 624 unit_flags;
 625
 626
 627 typedef struct gfc_unit
 628 {
 629   int unit_number;
 630   stream *s;
 631
 632   /* Treap links.  */
 633   struct gfc_unit *left, *right;
 634   int priority;
 635
 636   int read_bad, current_record, saved_pos, previous_nonadvancing_write;
 637
 638   enum
 639   { NO_ENDFILE, AT_ENDFILE, AFTER_ENDFILE }
 640   endfile;
 641
 642   unit_mode mode;
 643   unit_flags flags;
 644   unit_pad pad_status;
 645   unit_decimal decimal_status;
 646   unit_delim delim_status;
 647   unit_round round_status;
 648
 649   /* recl                 -- Record length of the file.
 650      last_record          -- Last record number read or written
 651      maxrec               -- Maximum record number in a direct access file
 652      bytes_left           -- Bytes left in current record.
 653      strm_pos             -- Current position in file for STREAM I/O.
 654      recl_subrecord       -- Maximum length for subrecord.
 655      bytes_left_subrecord -- Bytes left in current subrecord.  */
 656   gfc_offset recl, last_record, maxrec, bytes_left, strm_pos,
 657     recl_subrecord, bytes_left_subrecord;
 658
 659   /* Set to 1 if we have read a subrecord.  */
 660
 661   int continued;
 662
 663   __gthread_mutex_t lock;
 664   /* Number of threads waiting to acquire this unit's lock.
 665      When non-zero, close_unit doesn't only removes the unit
 666      from the UNIT_ROOT tree, but doesn't free it and the
 667      last of the waiting threads will do that.
 668      This must be either atomically increased/decreased, or
 669      always guarded by UNIT_LOCK.  */
 670   int waiting;
 671   /* Flag set by close_unit if the unit as been closed.
 672      Must be manipulated under unit's lock.  */
 673   int closed;
 674
 675   /* For traversing arrays */
 676   array_loop_spec *ls;
 677   int rank;
 678
 679   /* Name of the file at the time OPEN was executed, as a
 680      null-terminated C string.  */
 681   char *filename;
 682
 683   /* The format hash table.  */
 684   struct format_hash_entry format_hash_table[FORMAT_HASH_SIZE];
 685
 686   /* Formatting buffer.  */
 687   struct fbuf *fbuf;
 688
 689   /* Function pointer, points to list_read worker functions.  */
 690   int (*next_char_fn_ptr) (st_parameter_dt *);
 691   void (*push_char_fn_ptr) (st_parameter_dt *, int);
 692
 693   /* Internal unit char string data.  */
 694   char * internal_unit;
 695   gfc_charlen_type internal_unit_len;
 696   gfc_array_char *string_unit_desc;
 697   int internal_unit_kind;
 698
 699   /* DTIO Parent/Child procedure, 0 = parent, >0 = child level.  */
 700   int child_dtio;
 701
 702   /* Used for ungetc() style functionality. Possible values
 703      are an unsigned char, EOF, or EOF - 1 used to mark the
 704      field as not valid.  */
 705   int last_char;
 706   bool has_size;
 707   GFC_IO_INT size_used;
 708 }
 709 gfc_unit;
 710
 711 typedef struct gfc_saved_unit
 712 {
 713   GFC_INTEGER_4 unit_number;
 714   gfc_unit *unit;
 715 }
 716 gfc_saved_unit;
 717
 718 /* TEMP_FAILURE_RETRY macro from glibc.  */
 719
 720 #ifndef TEMP_FAILURE_RETRY
 721 /* Evaluate EXPRESSION, and repeat as long as it returns -1 with `errno'
 722    set to EINTR.  */
 723
 724 # define TEMP_FAILURE_RETRY(expression) \
 725   (__extension__                                                              \
 726     ({ long int __result;                                                     \
 727        do __result = (long int) (expression);                                 \
 728        while (__result == -1L && errno == EINTR);                             \
 729        __result; }))
 730 #endif
 731
 732
 733 /* unit.c */
 734
 735 /* Maximum file offset, computed at library initialization time.  */
 736 extern gfc_offset max_offset;
 737 internal_proto(max_offset);
 738
 739 /* Unit tree root.  */
 740 extern gfc_unit *unit_root;
 741 internal_proto(unit_root);
 742
 743 extern __gthread_mutex_t unit_lock;
 744 internal_proto(unit_lock);
 745
 746 extern int close_unit (gfc_unit *);
 747 internal_proto(close_unit);
 748
 749 extern gfc_unit *set_internal_unit (st_parameter_dt *, gfc_unit *, int);
 750 internal_proto(set_internal_unit);
 751
 752 extern void stash_internal_unit (st_parameter_dt *);
 753 internal_proto(stash_internal_unit);
 754
 755 extern gfc_unit *find_unit (int);
 756 internal_proto(find_unit);
 757
 758 extern gfc_unit *find_or_create_unit (int);
 759 internal_proto(find_or_create_unit);
 760
 761 extern gfc_unit *get_unit (st_parameter_dt *, int);
 762 internal_proto(get_unit);
 763
 764 extern void unlock_unit (gfc_unit *);
 765 internal_proto(unlock_unit);
 766
 767 extern void finish_last_advance_record (gfc_unit *u);
 768 internal_proto (finish_last_advance_record);
 769
 770 extern int unit_truncate (gfc_unit *, gfc_offset, st_parameter_common *);
 771 internal_proto (unit_truncate);
 772
 773 extern int newunit_alloc (void);
 774 internal_proto(newunit_alloc);
 775
 776
 777 /* open.c */
 778
 779 extern gfc_unit *new_unit (st_parameter_open *, gfc_unit *, unit_flags *);
 780 internal_proto(new_unit);
 781
 782
 783 /* transfer.c */
 784
 785 #define SCRATCH_SIZE 300
 786
 787 extern const char *type_name (bt);
 788 internal_proto(type_name);
 789
 790 extern void * read_block_form (st_parameter_dt *, int *);
 791 internal_proto(read_block_form);
 792
 793 extern void * read_block_form4 (st_parameter_dt *, int *);
 794 internal_proto(read_block_form4);
 795
 796 extern void *write_block (st_parameter_dt *, int);
 797 internal_proto(write_block);
 798
 799 extern gfc_offset next_array_record (st_parameter_dt *, array_loop_spec *,
 800                                      int*);
 801 internal_proto(next_array_record);
 802
 803 extern gfc_offset init_loop_spec (gfc_array_char *, array_loop_spec *,
 804                                   gfc_offset *);
 805 internal_proto(init_loop_spec);
 806
 807 extern void next_record (st_parameter_dt *, int);
 808 internal_proto(next_record);
 809
 810 extern void st_wait (st_parameter_wait *);
 811 export_proto(st_wait);
 812
 813 extern void hit_eof (st_parameter_dt *);
 814 internal_proto(hit_eof);
 815
 816 /* read.c */
 817
 818 extern void set_integer (void *, GFC_INTEGER_LARGEST, int);
 819 internal_proto(set_integer);
 820
 821 extern GFC_UINTEGER_LARGEST si_max (int);
 822 internal_proto(si_max);
 823
 824 extern int convert_real (st_parameter_dt *, void *, const char *, int);
 825 internal_proto(convert_real);
 826
 827 extern int convert_infnan (st_parameter_dt *, void *, const char *, int);
 828 internal_proto(convert_infnan);
 829
 830 extern void read_a (st_parameter_dt *, const fnode *, char *, int);
 831 internal_proto(read_a);
 832
 833 extern void read_a_char4 (st_parameter_dt *, const fnode *, char *, int);
 834 internal_proto(read_a);
 835
 836 extern void read_f (st_parameter_dt *, const fnode *, char *, int);
 837 internal_proto(read_f);
 838
 839 extern void read_l (st_parameter_dt *, const fnode *, char *, int);
 840 internal_proto(read_l);
 841
 842 extern void read_x (st_parameter_dt *, int);
 843 internal_proto(read_x);
 844
 845 extern void read_radix (st_parameter_dt *, const fnode *, char *, int, int);
 846 internal_proto(read_radix);
 847
 848 extern void read_decimal (st_parameter_dt *, const fnode *, char *, int);
 849 internal_proto(read_decimal);
 850
 851 extern void read_user_defined (st_parameter_dt *, void *);
 852 internal_proto(read_user_defined);
 853
 854 extern void read_user_defined (st_parameter_dt *, void *);
 855 internal_proto(read_user_defined);
 856
 857 /* list_read.c */
 858
 859 extern void list_formatted_read (st_parameter_dt *, bt, void *, int, size_t,
 860                                  size_t);
 861 internal_proto(list_formatted_read);
 862
 863 extern void finish_list_read (st_parameter_dt *);
 864 internal_proto(finish_list_read);
 865
 866 extern void namelist_read (st_parameter_dt *);
 867 internal_proto(namelist_read);
 868
 869 extern void namelist_write (st_parameter_dt *);
 870 internal_proto(namelist_write);
 871
 872 /* write.c */
 873
 874 extern void write_a (st_parameter_dt *, const fnode *, const char *, int);
 875 internal_proto(write_a);
 876
 877 extern void write_a_char4 (st_parameter_dt *, const fnode *, const char *, int);
 878 internal_proto(write_a_char4);
 879
 880 extern void write_b (st_parameter_dt *, const fnode *, const char *, int);
 881 internal_proto(write_b);
 882
 883 extern void write_d (st_parameter_dt *, const fnode *, const char *, int);
 884 internal_proto(write_d);
 885
 886 extern void write_e (st_parameter_dt *, const fnode *, const char *, int);
 887 internal_proto(write_e);
 888
 889 extern void write_en (st_parameter_dt *, const fnode *, const char *, int);
 890 internal_proto(write_en);
 891
 892 extern void write_es (st_parameter_dt *, const fnode *, const char *, int);
 893 internal_proto(write_es);
 894
 895 extern void write_f (st_parameter_dt *, const fnode *, const char *, int);
 896 internal_proto(write_f);
 897
 898 extern void write_i (st_parameter_dt *, const fnode *, const char *, int);
 899 internal_proto(write_i);
 900
 901 extern void write_l (st_parameter_dt *, const fnode *, char *, int);
 902 internal_proto(write_l);
 903
 904 extern void write_o (st_parameter_dt *, const fnode *, const char *, int);
 905 internal_proto(write_o);
 906
 907 extern void write_real (st_parameter_dt *, const char *, int);
 908 internal_proto(write_real);
 909
 910 extern void write_real_g0 (st_parameter_dt *, const char *, int, int);
 911 internal_proto(write_real_g0);
 912
 913 extern void write_x (st_parameter_dt *, int, int);
 914 internal_proto(write_x);
 915
 916 extern void write_z (st_parameter_dt *, const fnode *, const char *, int);
 917 internal_proto(write_z);
 918
 919 extern void write_user_defined (st_parameter_dt *, void *);
 920 internal_proto(write_user_defined);
 921
 922 extern void write_user_defined (st_parameter_dt *, void *);
 923 internal_proto(write_user_defined);
 924
 925 extern void list_formatted_write (st_parameter_dt *, bt, void *, int, size_t,
 926                                   size_t);
 927 internal_proto(list_formatted_write);
 928
 929 /* size_from_kind.c */
 930 extern size_t size_from_real_kind (int);
 931 internal_proto(size_from_real_kind);
 932
 933 extern size_t size_from_complex_kind (int);
 934 internal_proto(size_from_complex_kind);
 935
 936
 937 /* lock.c */
 938 extern void free_ionml (st_parameter_dt *);
 939 internal_proto(free_ionml);
 940
 941 static inline void
 942 inc_waiting_locked (gfc_unit *u)
 943 {
 944 #ifdef HAVE_SYNC_FETCH_AND_ADD
 945   (void) __sync_fetch_and_add (&u->waiting, 1);
 946 #else
 947   u->waiting++;
 948 #endif
 949 }
 950
 951 static inline int
 952 predec_waiting_locked (gfc_unit *u)
 953 {
 954 #ifdef HAVE_SYNC_FETCH_AND_ADD
 955   return __sync_add_and_fetch (&u->waiting, -1);
 956 #else
 957   return --u->waiting;
 958 #endif
 959 }
 960
 961 static inline void
 962 dec_waiting_unlocked (gfc_unit *u)
 963 {
 964 #ifdef HAVE_SYNC_FETCH_AND_ADD
 965   (void) __sync_fetch_and_add (&u->waiting, -1);
 966 #else
 967   __gthread_mutex_lock (&unit_lock);
 968   u->waiting--;
 969   __gthread_mutex_unlock (&unit_lock);
 970 #endif
 971 }
 972
 973
 974 static inline void
 975 memset4 (gfc_char4_t *p, gfc_char4_t c, int k)
 976 {
 977   int j;
 978   for (j = 0; j < k; j++)
 979     *p++ = c;
 980 }
 981
 982 #endif
 983