libgfortran/libgfortran.h

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