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., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, 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.  When isfinite is not available, try to use one of the
 175    alternatives, or bail out.  */
 176 #if !defined(isfinite)
 177 static inline int
 178 isfinite (double x)
 179 {
 180 #if defined(fpclassify)
 181   return (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE);
 182 #elif defined(HAVE_FINITE)
 183   return finite (x);
 184 #else
 185 #error "libgfortran needs isfinite, fpclassify, or finite"
 186 #endif
 187 }
 188 #endif /* !defined(isfinite)  */
 189
 190 /* TODO: find the C99 version of these an move into above ifdef.  */
 191 #define REALPART(z) (__real__(z))
 192 #define IMAGPART(z) (__imag__(z))
 193 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
 194
 195 typedef int8_t GFC_INTEGER_1;
 196 typedef int16_t GFC_INTEGER_2;
 197 typedef int32_t GFC_INTEGER_4;
 198 typedef int64_t GFC_INTEGER_8;
 199 typedef uint8_t GFC_UINTEGER_1;
 200 typedef uint16_t GFC_UINTEGER_2;
 201 typedef uint32_t GFC_UINTEGER_4;
 202 typedef uint64_t GFC_UINTEGER_8;
 203 typedef GFC_INTEGER_4 GFC_LOGICAL_4;
 204 typedef GFC_INTEGER_8 GFC_LOGICAL_8;
 205 typedef float GFC_REAL_4;
 206 typedef double GFC_REAL_8;
 207 typedef complex float GFC_COMPLEX_4;
 208 typedef complex double GFC_COMPLEX_8;
 209
 210 /* The following two definitions must be consistent with the types used
 211    by the compiler.  */
 212 /* The type used of array indices, amongst other things.  */
 213 typedef size_t index_type;
 214 /* The type used for the lengths of character variables.  */
 215 typedef GFC_INTEGER_4 gfc_charlen_type;
 216
 217 /* This will be 0 on little-endian machines and one on big-endian machines.  */
 218 extern int l8_to_l4_offset;
 219 internal_proto(l8_to_l4_offset);
 220
 221 #define GFOR_POINTER_L8_TO_L4(p8) \
 222   (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
 223
 224 #define GFC_INTEGER_4_HUGE \
 225   (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
 226 #define GFC_INTEGER_8_HUGE \
 227   (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
 228 #define GFC_REAL_4_HUGE FLT_MAX
 229 #define GFC_REAL_8_HUGE DBL_MAX
 230
 231 #ifndef GFC_MAX_DIMENSIONS
 232 #define GFC_MAX_DIMENSIONS 7
 233 #endif
 234
 235 typedef struct descriptor_dimension
 236 {
 237   index_type stride;
 238   index_type lbound;
 239   index_type ubound;
 240 }
 241 descriptor_dimension;
 242
 243 #define GFC_ARRAY_DESCRIPTOR(r, type) \
 244 struct {\
 245   type *data;\
 246   type *base;\
 247   index_type dtype;\
 248   descriptor_dimension dim[r];\
 249 }
 250
 251 /* Commonly used array descriptor types.  */
 252 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
 253 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
 254 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
 255 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
 256 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
 257 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
 258 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
 259 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
 260 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
 261 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
 262
 263 #define GFC_DTYPE_RANK_MASK 0x07
 264 #define GFC_DTYPE_TYPE_SHIFT 3
 265 #define GFC_DTYPE_TYPE_MASK 0x38
 266 #define GFC_DTYPE_SIZE_SHIFT 6
 267
 268 enum
 269 {
 270   GFC_DTYPE_UNKNOWN = 0,
 271   GFC_DTYPE_INTEGER,
 272   /* TODO: recognize logical types.  */
 273   GFC_DTYPE_LOGICAL,
 274   GFC_DTYPE_REAL,
 275   GFC_DTYPE_COMPLEX,
 276   GFC_DTYPE_DERIVED,
 277   GFC_DTYPE_CHARACTER
 278 };
 279
 280 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
 281 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
 282                                    >> GFC_DTYPE_TYPE_SHIFT)
 283 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
 284 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
 285 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
 286
 287 /* Runtime library include.  */
 288 #define stringize(x) expand_macro(x)
 289 #define expand_macro(x) # x
 290
 291 /* Runtime options structure.  */
 292
 293 typedef struct
 294 {
 295   int stdin_unit, stdout_unit, stderr_unit, optional_plus;
 296   int allocate_init_flag, allocate_init_value;
 297   int locus;
 298
 299   int separator_len;
 300   const char *separator;
 301
 302   int mem_check;
 303   int use_stderr, all_unbuffered, default_recl;
 304
 305   int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
 306     fpu_overflow, fpu_underflow, fpu_precision_loss;
 307
 308   int sighup, sigint;
 309 }
 310 options_t;
 311
 312
 313 extern options_t options;
 314 internal_proto(options);
 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 /* The filename and line number don't go inside the globals structure.
 352    They are set by the rest of the program and must be linked to.  */
 353
 354 /* Location of the current library call (optional).  */
 355 extern unsigned line;
 356 iexport_data_proto(line);
 357
 358 extern char *filename;
 359 iexport_data_proto(filename);
 360
 361 /* Avoid conflicting prototypes of alloca() in system headers by using
 362    GCC's builtin alloca().  */
 363 #define gfc_alloca(x)  __builtin_alloca(x)
 364
 365
 366 /* main.c */
 367
 368 extern void library_start (void);
 369 internal_proto(library_start);
 370
 371 extern void library_end (void);
 372 internal_proto(library_end);
 373
 374 extern void set_args (int, char **);
 375 export_proto(set_args);
 376
 377 extern void get_args (int *, char ***);
 378 internal_proto(get_args);
 379
 380 /* error.c */
 381
 382 extern char *gfc_itoa (int64_t);
 383 internal_proto(gfc_itoa);
 384
 385 extern char *xtoa (uint64_t);
 386 internal_proto(xtoa);
 387
 388 extern void os_error (const char *) __attribute__ ((noreturn));
 389 internal_proto(os_error);
 390
 391 extern void show_locus (void);
 392 internal_proto(show_locus);
 393
 394 extern void runtime_error (const char *) __attribute__ ((noreturn));
 395 iexport_proto(runtime_error);
 396
 397 extern void internal_error (const char *) __attribute__ ((noreturn));
 398 internal_proto(internal_error);
 399
 400 extern const char *get_oserror (void);
 401 internal_proto(get_oserror);
 402
 403 extern void sys_exit (int) __attribute__ ((noreturn));
 404 internal_proto(sys_exit);
 405
 406 extern int st_printf (const char *, ...)
 407   __attribute__ ((format (printf, 1, 2)));
 408 internal_proto(st_printf);
 409
 410 extern void st_sprintf (char *, const char *, ...)
 411   __attribute__ ((format (printf, 2, 3)));
 412 internal_proto(st_sprintf);
 413
 414 extern const char *translate_error (int);
 415 internal_proto(translate_error);
 416
 417 extern void generate_error (int, const char *);
 418 internal_proto(generate_error);
 419
 420 /* memory.c */
 421
 422 extern void *get_mem (size_t) __attribute__ ((malloc));
 423 internal_proto(get_mem);
 424
 425 extern void free_mem (void *);
 426 internal_proto(free_mem);
 427
 428 extern void *internal_malloc_size (size_t);
 429 internal_proto(internal_malloc_size);
 430
 431 extern void internal_free (void *);
 432 iexport_proto(internal_free);
 433
 434 /* environ.c */
 435
 436 extern int check_buffered (int);
 437 internal_proto(check_buffered);
 438
 439 extern void init_variables (void);
 440 internal_proto(init_variables);
 441
 442 extern void show_variables (void);
 443 internal_proto(show_variables);
 444
 445 /* string.c */
 446
 447 extern int find_option (const char *, int, st_option *, const char *);
 448 internal_proto(find_option);
 449
 450 extern int fstrlen (const char *, int);
 451 internal_proto(fstrlen);
 452
 453 extern void fstrcpy (char *, int, const char *, int);
 454 internal_proto(fstrcpy);
 455
 456 extern void cf_strcpy (char *, int, const char *);
 457 internal_proto(cf_strcpy);
 458
 459 /* io.c */
 460
 461 extern void init_units (void);
 462 internal_proto(init_units);
 463
 464 extern void close_units (void);
 465 internal_proto(close_units);
 466
 467 /* stop.c */
 468
 469 extern void stop_numeric (GFC_INTEGER_4);
 470 iexport_proto(stop_numeric);
 471
 472 /* reshape_packed.c */
 473
 474 extern void reshape_packed (char *, index_type, const char *, index_type,
 475                             const char *, index_type);
 476 internal_proto(reshape_packed);
 477
 478 /* Repacking functions.  */
 479
 480 /* ??? These four aren't currently used by the compiler, though we
 481    certainly could do so.  */
 482 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
 483 internal_proto(internal_pack_4);
 484
 485 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
 486 internal_proto(internal_pack_8);
 487
 488 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
 489 internal_proto(internal_unpack_4);
 490
 491 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
 492 internal_proto(internal_unpack_8);
 493
 494 /* string_intrinsics.c */
 495
 496 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
 497                                      GFC_INTEGER_4, const char *);
 498 iexport_proto(compare_string);
 499
 500 /* random.c */
 501
 502 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
 503                          gfc_array_i4 * get);
 504 iexport_proto(random_seed);
 505
 506 /* normalize.c */
 507
 508 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
 509 internal_proto(normalize_r4_i4);
 510
 511 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
 512 internal_proto(normalize_r8_i8);
 513
 514 /* size.c */
 515
 516 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
 517
 518 extern index_type size0 (const array_t * array);
 519 iexport_proto(size0);
 520
 521 #endif  /* LIBGFOR_H  */