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