libgfortran/libgfortran.h

   1 /* Common declarations for all of libgfor.
   2    Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
   3    Contributed by Paul Brook <paul@nowt.org>, and
   4    Andy Vaught <andy@xena.eas.asu.edu>
   5
   6 This file is part of the GNU Fortran 95 runtime library (libgfortran).
   7
   8 Libgfortran is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU Lesser General Public
  10 License as published by the Free Software Foundation; either
  11 version 2.1 of the License, or (at your option) any later version.
  12
  13 Libgfortran is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU Lesser General Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with libgfor; see the file COPYING.LIB.  If not,
  20 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21 Boston, MA 02110-1301, USA.  */
  22
  23 /* As a special exception, if you link this library with other files,
  24    some of which are compiled with GCC, to produce an executable,
  25    this library does not by itself cause the resulting executable
  26    to be covered by the GNU General Public License.
  27    This exception does not however invalidate any other reasons why
  28    the executable file might be covered by the GNU General Public License.  */
  29
  30
  31 #ifndef LIBGFOR_H
  32 #define LIBGFOR_H
  33
  34 #include <math.h>
  35 #include <stddef.h>
  36
  37 #ifndef M_PI
  38 #define M_PI 3.14159265358979323846264338327
  39 #endif
  40
  41 #include "config.h"
  42 #include "c99_protos.h"
  43
  44 #if HAVE_COMPLEX_H
  45 # include <complex.h>
  46 #else
  47 #define complex __complex__
  48 #endif
  49
  50 #if HAVE_IEEEFP_H
  51 #include <ieeefp.h>
  52 #endif
  53
  54 #if HAVE_STDINT_H
  55 #include <stdint.h>
  56 #endif
  57
  58 #if HAVE_INTTYPES_H
  59 #include <inttypes.h>
  60 #endif
  61
  62 #if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && defined(TARGET_ILP32)
  63 typedef char int8_t;
  64 typedef short int16_t;
  65 typedef int int32_t;
  66 typedef long long int64_t;
  67 typedef unsigned char uint8_t;
  68 typedef unsigned short uint16_t;
  69 typedef unsigned int uint32_t;
  70 typedef unsigned long long uint64_t;
  71 #endif
  72
  73 #if HAVE_SYS_TYPES_H
  74 #include <sys/types.h>
  75 #endif
  76 typedef off_t gfc_offset;
  77
  78 #ifndef NULL
  79 #define NULL (void *) 0
  80 #endif
  81
  82 #ifndef __GNUC__
  83 #define __attribute__(x)
  84 #endif
  85
  86 /* For a library, a standard prefix is a requirement in order to partition
  87    the namespace.  IPREFIX is for symbols intended to be internal to the
  88    library.  */
  89 #define PREFIX(x)       _gfortran_ ## x
  90 #define IPREFIX(x)      _gfortrani_ ## x
  91
  92 /* Magic to rename a symbol at the compiler level.  You continue to refer
  93    to the symbol as OLD in the source, but it'll be named NEW in the asm.  */
  94 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
  95 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
  96 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
  97
  98 /* There are several classifications of routines:
  99
 100      (1) Symbols used only within the library,
 101      (2) Symbols to be exported from the library,
 102      (3) Symbols to be exported from the library, but
 103          also used inside the library.
 104
 105    By telling the compiler about these different classifications we can
 106    tightly control the interface seen by the user, and get better code
 107    from the compiler at the same time.
 108
 109    One of the following should be used immediately after the declaration
 110    of each symbol:
 111
 112      internal_proto     Marks a symbol used only within the library,
 113                         and adds IPREFIX to the assembly-level symbol
 114                         name.  The later is important for maintaining
 115                         the namespace partition for the static library.
 116
 117      export_proto       Marks a symbol to be exported, and adds PREFIX
 118                         to the assembly-level symbol name.
 119
 120      export_proto_np    Marks a symbol to be exported without adding PREFIX.
 121
 122      iexport_proto      Marks a function to be exported, but with the
 123                         understanding that it can be used inside as well.
 124
 125      iexport_data_proto Similarly, marks a data symbol to be exported.
 126                         Unfortunately, some systems can't play the hidden
 127                         symbol renaming trick on data symbols, thanks to
 128                         the horribleness of COPY relocations.
 129
 130    If iexport_proto or iexport_data_proto is used, you must also use
 131    iexport or iexport_data after the *definition* of the symbol.  */
 132
 133 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
 134 # define internal_proto(x) \
 135         sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
 136 #else
 137 # define internal_proto(x)      sym_rename(x, IPREFIX(x))
 138 #endif
 139
 140 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
 141 # define export_proto(x)        sym_rename(x, PREFIX(x))
 142 # define export_proto_np(x)     extern char swallow_semicolon
 143 # define iexport_proto(x)       internal_proto(x)
 144 # define iexport(x)             iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x))
 145 # define iexport1(x,p,y)        iexport2(x,p,y)
 146 # define iexport2(x,p,y) \
 147         extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y)))
 148 /* ??? We're not currently building a dll, and it's wrong to add dllexport
 149    to objects going into a static library archive.  */
 150 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
 151 # define export_proto_np(x)     extern __typeof(x) x __attribute__((dllexport))
 152 # define export_proto(x)    sym_rename(x, PREFIX(x)) __attribute__((dllexport))
 153 # define iexport_proto(x)       export_proto(x)
 154 # define iexport(x)             extern char swallow_semicolon
 155 #else
 156 # define export_proto(x)        sym_rename(x, PREFIX(x))
 157 # define export_proto_np(x)     extern char swallow_semicolon
 158 # define iexport_proto(x)       export_proto(x)
 159 # define iexport(x)             extern char swallow_semicolon
 160 #endif
 161
 162 /* TODO: detect the case when we *can* hide the symbol.  */
 163 #define iexport_data_proto(x)   export_proto(x)
 164 #define iexport_data(x)         extern char swallow_semicolon
 165
 166 /* The only reliable way to get the offset of a field in a struct
 167    in a system independent way is via this macro.  */
 168 #ifndef offsetof
 169 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 170 #endif
 171
 172 /* The isfinite macro is only available with C99, but some non-C99
 173    systems still provide fpclassify, and there is a `finite' function
 174    in BSD.
 175
 176    Also, isfinite is broken on Cygwin.
 177
 178    When isfinite is not available, try to use one of the
 179    alternatives, or bail out.  */
 180 #if (!defined(isfinite) || defined(__CYGWIN__))
 181 #undef isfinite
 182 #if defined(fpclassify)
 183 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
 184 #else
 185 #define isfinite(x) ((x) - (x) == 0)
 186 #endif
 187 #endif /* !defined(isfinite)  */
 188
 189 /* TODO: find the C99 version of these an move into above ifdef.  */
 190 #define REALPART(z) (__real__(z))
 191 #define IMAGPART(z) (__imag__(z))
 192 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
 193
 194 #include "kinds.h"
 195
 196 /* The following two definitions must be consistent with the types used
 197    by the compiler.  */
 198 /* The type used of array indices, amongst other things.  */
 199 typedef ssize_t index_type;
 200 /* The type used for the lengths of character variables.  */
 201 typedef GFC_INTEGER_4 gfc_charlen_type;
 202
 203 /* This will be 0 on little-endian machines and one on big-endian machines.  */
 204 extern int l8_to_l4_offset;
 205 internal_proto(l8_to_l4_offset);
 206
 207 #define GFOR_POINTER_L8_TO_L4(p8) \
 208   (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
 209
 210 #define GFC_INTEGER_4_HUGE \
 211   (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
 212 #define GFC_INTEGER_8_HUGE \
 213   (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
 214 #define GFC_REAL_4_HUGE FLT_MAX
 215 #define GFC_REAL_8_HUGE DBL_MAX
 216
 217 #ifndef GFC_MAX_DIMENSIONS
 218 #define GFC_MAX_DIMENSIONS 7
 219 #endif
 220
 221 typedef struct descriptor_dimension
 222 {
 223   index_type stride;
 224   index_type lbound;
 225   index_type ubound;
 226 }
 227 descriptor_dimension;
 228
 229 #define GFC_ARRAY_DESCRIPTOR(r, type) \
 230 struct {\
 231   type *data;\
 232   size_t offset;\
 233   index_type dtype;\
 234   descriptor_dimension dim[r];\
 235 }
 236
 237 /* Commonly used array descriptor types.  */
 238 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
 239 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
 240 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
 241 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
 242 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
 243 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
 244 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
 245 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
 246 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
 247 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
 248
 249 #define GFC_DTYPE_RANK_MASK 0x07
 250 #define GFC_DTYPE_TYPE_SHIFT 3
 251 #define GFC_DTYPE_TYPE_MASK 0x38
 252 #define GFC_DTYPE_SIZE_SHIFT 6
 253
 254 enum
 255 {
 256   GFC_DTYPE_UNKNOWN = 0,
 257   GFC_DTYPE_INTEGER,
 258   /* TODO: recognize logical types.  */
 259   GFC_DTYPE_LOGICAL,
 260   GFC_DTYPE_REAL,
 261   GFC_DTYPE_COMPLEX,
 262   GFC_DTYPE_DERIVED,
 263   GFC_DTYPE_CHARACTER
 264 };
 265
 266 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
 267 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
 268                                    >> GFC_DTYPE_TYPE_SHIFT)
 269 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
 270 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
 271 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
 272
 273 /* Runtime library include.  */
 274 #define stringize(x) expand_macro(x)
 275 #define expand_macro(x) # x
 276
 277 /* Runtime options structure.  */
 278
 279 typedef struct
 280 {
 281   int stdin_unit, stdout_unit, stderr_unit, optional_plus;
 282   int allocate_init_flag, allocate_init_value;
 283   int locus;
 284
 285   int separator_len;
 286   const char *separator;
 287
 288   int mem_check;
 289   int use_stderr, all_unbuffered, default_recl;
 290
 291   int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
 292     fpu_overflow, fpu_underflow, fpu_precision_loss;
 293
 294   int sighup, sigint;
 295 }
 296 options_t;
 297
 298 extern options_t options;
 299 internal_proto(options);
 300
 301
 302 /* Compile-time options that will influence the library.  */
 303
 304 typedef struct
 305 {
 306   int warn_std;
 307   int allow_std;
 308 }
 309 compile_options_t;
 310
 311 extern compile_options_t compile_options;
 312 internal_proto(compile_options);
 313
 314
 315
 316
 317 /* Structure for statement options.  */
 318
 319 typedef struct
 320 {
 321   const char *name;
 322   int value;
 323 }
 324 st_option;
 325
 326 /* Runtime errors.  The EOR and EOF errors are required to be negative.  */
 327
 328 typedef enum
 329 {
 330   ERROR_FIRST = -3,             /* Marker for the first error.  */
 331   ERROR_EOR = -2,
 332   ERROR_END = -1,
 333   ERROR_OK = 0,                 /* Indicates success, must be zero.  */
 334   ERROR_OS,                     /* Operating system error, more info in errno.  */
 335   ERROR_OPTION_CONFLICT,
 336   ERROR_BAD_OPTION,
 337   ERROR_MISSING_OPTION,
 338   ERROR_ALREADY_OPEN,
 339   ERROR_BAD_UNIT,
 340   ERROR_FORMAT,
 341   ERROR_BAD_ACTION,
 342   ERROR_ENDFILE,
 343   ERROR_BAD_US,
 344   ERROR_READ_VALUE,
 345   ERROR_READ_OVERFLOW,
 346   ERROR_LAST                    /* Not a real error, the last error # + 1.  */
 347 }
 348 error_codes;
 349
 350
 351 /* Flags to specify which standard/extension contains a feature.
 352    Keep them in sync with their counterparts in gcc/fortran/gfortran.h.  */
 353 #define GFC_STD_LEGACY          (1<<6) /* Backward compatibility.  */
 354 #define GFC_STD_GNU             (1<<5)    /* GNU Fortran extension.  */
 355 #define GFC_STD_F2003           (1<<4)    /* New in F2003.  */
 356 /* Note that no features were obsoleted nor deleted in F2003.  */
 357 #define GFC_STD_F95             (1<<3)    /* New in F95.  */
 358 #define GFC_STD_F95_DEL         (1<<2)    /* Deleted in F95.  */
 359 #define GFC_STD_F95_OBS         (1<<1)    /* Obsoleted in F95.  */
 360 #define GFC_STD_F77             (1<<0)    /* Up to and including F77.  */
 361
 362
 363 /* The filename and line number don't go inside the globals structure.
 364    They are set by the rest of the program and must be linked to.  */
 365
 366 /* Location of the current library call (optional).  */
 367 extern unsigned line;
 368 iexport_data_proto(line);
 369
 370 extern char *filename;
 371 iexport_data_proto(filename);
 372
 373 /* Avoid conflicting prototypes of alloca() in system headers by using
 374    GCC's builtin alloca().  */
 375 #define gfc_alloca(x)  __builtin_alloca(x)
 376
 377
 378 /* main.c */
 379
 380 extern void library_start (void);
 381 internal_proto(library_start);
 382
 383 extern void library_end (void);
 384 internal_proto(library_end);
 385
 386 extern void set_args (int, char **);
 387 export_proto(set_args);
 388
 389 extern void get_args (int *, char ***);
 390 internal_proto(get_args);
 391
 392 /* error.c */
 393
 394 extern char *gfc_itoa (GFC_INTEGER_LARGEST);
 395 internal_proto(gfc_itoa);
 396
 397 extern char *xtoa (GFC_UINTEGER_LARGEST);
 398 internal_proto(xtoa);
 399
 400 extern void os_error (const char *) __attribute__ ((noreturn));
 401 internal_proto(os_error);
 402
 403 extern void show_locus (void);
 404 internal_proto(show_locus);
 405
 406 extern void runtime_error (const char *) __attribute__ ((noreturn));
 407 iexport_proto(runtime_error);
 408
 409 extern void internal_error (const char *) __attribute__ ((noreturn));
 410 internal_proto(internal_error);
 411
 412 extern const char *get_oserror (void);
 413 internal_proto(get_oserror);
 414
 415 extern void sys_exit (int) __attribute__ ((noreturn));
 416 internal_proto(sys_exit);
 417
 418 extern int st_printf (const char *, ...)
 419   __attribute__ ((format (printf, 1, 2)));
 420 internal_proto(st_printf);
 421
 422 extern void st_sprintf (char *, const char *, ...)
 423   __attribute__ ((format (printf, 2, 3)));
 424 internal_proto(st_sprintf);
 425
 426 extern const char *translate_error (int);
 427 internal_proto(translate_error);
 428
 429 extern void generate_error (int, const char *);
 430 internal_proto(generate_error);
 431
 432 /* memory.c */
 433
 434 extern void *get_mem (size_t) __attribute__ ((malloc));
 435 internal_proto(get_mem);
 436
 437 extern void free_mem (void *);
 438 internal_proto(free_mem);
 439
 440 extern void *internal_malloc_size (size_t);
 441 internal_proto(internal_malloc_size);
 442
 443 extern void internal_free (void *);
 444 iexport_proto(internal_free);
 445
 446 /* environ.c */
 447
 448 extern int check_buffered (int);
 449 internal_proto(check_buffered);
 450
 451 extern void init_variables (void);
 452 internal_proto(init_variables);
 453
 454 extern void show_variables (void);
 455 internal_proto(show_variables);
 456
 457 /* string.c */
 458
 459 extern int find_option (const char *, int, st_option *, const char *);
 460 internal_proto(find_option);
 461
 462 extern int fstrlen (const char *, int);
 463 internal_proto(fstrlen);
 464
 465 extern void fstrcpy (char *, int, const char *, int);
 466 internal_proto(fstrcpy);
 467
 468 extern void cf_strcpy (char *, int, const char *);
 469 internal_proto(cf_strcpy);
 470
 471 /* io.c */
 472
 473 extern void init_units (void);
 474 internal_proto(init_units);
 475
 476 extern void close_units (void);
 477 internal_proto(close_units);
 478
 479 /* stop.c */
 480
 481 extern void stop_numeric (GFC_INTEGER_4);
 482 iexport_proto(stop_numeric);
 483
 484 /* reshape_packed.c */
 485
 486 extern void reshape_packed (char *, index_type, const char *, index_type,
 487                             const char *, index_type);
 488 internal_proto(reshape_packed);
 489
 490 /* Repacking functions.  */
 491
 492 /* ??? These eight aren't currently used by the compiler, though we
 493    certainly could do so.  */
 494 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
 495 internal_proto(internal_pack_4);
 496
 497 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
 498 internal_proto(internal_pack_8);
 499
 500 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
 501 internal_proto(internal_pack_c4);
 502
 503 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
 504 internal_proto(internal_pack_c8);
 505
 506 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
 507 internal_proto(internal_unpack_4);
 508
 509 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
 510 internal_proto(internal_unpack_8);
 511
 512 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
 513 internal_proto(internal_unpack_c4);
 514
 515 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
 516 internal_proto(internal_unpack_c8);
 517
 518 /* string_intrinsics.c */
 519
 520 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
 521                                      GFC_INTEGER_4, const char *);
 522 iexport_proto(compare_string);
 523
 524 /* random.c */
 525
 526 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
 527                          gfc_array_i4 * get);
 528 iexport_proto(random_seed);
 529
 530 /* normalize.c */
 531
 532 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
 533 internal_proto(normalize_r4_i4);
 534
 535 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
 536 internal_proto(normalize_r8_i8);
 537
 538 /* size.c */
 539
 540 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
 541
 542 extern index_type size0 (const array_t * array);
 543 iexport_proto(size0);
 544
 545 #endif  /* LIBGFOR_H  */