| /* Common declarations for all of libgfor. |
| Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc. |
| Contributed by Paul Brook <paul@nowt.org>, and |
| Andy Vaught <andy@xena.eas.asu.edu> |
| |
| This file is part of the GNU Fortran 95 runtime library (libgfortran). |
| |
| Libgfortran is free software; you can redistribute it and/or |
| modify it under the terms of the GNU Lesser General Public |
| License as published by the Free Software Foundation; either |
| version 2.1 of the License, or (at your option) any later version. |
| |
| Libgfortran is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU Lesser General Public License for more details. |
| |
| You should have received a copy of the GNU Lesser General Public |
| License along with libgfor; see the file COPYING.LIB. If not, |
| write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| Boston, MA 02111-1307, USA. */ |
| |
| /* As a special exception, if you link this library with other files, |
| some of which are compiled with GCC, to produce an executable, |
| this library does not by itself cause the resulting executable |
| to be covered by the GNU General Public License. |
| This exception does not however invalidate any other reasons why |
| the executable file might be covered by the GNU General Public License. */ |
| |
| |
| #ifndef LIBGFOR_H |
| #define LIBGFOR_H |
| |
| #include <math.h> |
| #include <stddef.h> |
| |
| #ifndef M_PI |
| #define M_PI 3.14159265358979323846264338327 |
| #endif |
| |
| #include "config.h" |
| #include "c99_protos.h" |
| |
| #if HAVE_COMPLEX_H |
| # include <complex.h> |
| #else |
| #define complex __complex__ |
| #endif |
| |
| #if HAVE_IEEEFP_H |
| #include <ieeefp.h> |
| #endif |
| |
| #if HAVE_STDINT_H |
| #include <stdint.h> |
| #endif |
| |
| #if HAVE_INTTYPES_H |
| #include <inttypes.h> |
| #endif |
| |
| #if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && defined(TARGET_ILP32) |
| typedef char int8_t; |
| typedef short int16_t; |
| typedef int int32_t; |
| typedef long long int64_t; |
| typedef unsigned char uint8_t; |
| typedef unsigned short uint16_t; |
| typedef unsigned int uint32_t; |
| typedef unsigned long long uint64_t; |
| #endif |
| |
| #if HAVE_SYS_TYPES_H |
| #include <sys/types.h> |
| #endif |
| typedef off_t gfc_offset; |
| |
| #ifndef NULL |
| #define NULL (void *) 0 |
| #endif |
| |
| #ifndef __GNUC__ |
| #define __attribute__(x) |
| #endif |
| |
| /* For a library, a standard prefix is a requirement in order to partition |
| the namespace. IPREFIX is for symbols intended to be internal to the |
| library. */ |
| #define PREFIX(x) _gfortran_ ## x |
| #define IPREFIX(x) _gfortrani_ ## x |
| |
| /* Magic to rename a symbol at the compiler level. You continue to refer |
| to the symbol as OLD in the source, but it'll be named NEW in the asm. */ |
| #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new) |
| #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new) |
| #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new) |
| |
| /* There are several classifications of routines: |
| |
| (1) Symbols used only within the library, |
| (2) Symbols to be exported from the library, |
| (3) Symbols to be exported from the library, but |
| also used inside the library. |
| |
| By telling the compiler about these different classifications we can |
| tightly control the interface seen by the user, and get better code |
| from the compiler at the same time. |
| |
| One of the following should be used immediately after the declaration |
| of each symbol: |
| |
| internal_proto Marks a symbol used only within the library, |
| and adds IPREFIX to the assembly-level symbol |
| name. The later is important for maintaining |
| the namespace partition for the static library. |
| |
| export_proto Marks a symbol to be exported, and adds PREFIX |
| to the assembly-level symbol name. |
| |
| export_proto_np Marks a symbol to be exported without adding PREFIX. |
| |
| iexport_proto Marks a function to be exported, but with the |
| understanding that it can be used inside as well. |
| |
| iexport_data_proto Similarly, marks a data symbol to be exported. |
| Unfortunately, some systems can't play the hidden |
| symbol renaming trick on data symbols, thanks to |
| the horribleness of COPY relocations. |
| |
| If iexport_proto or iexport_data_proto is used, you must also use |
| iexport or iexport_data after the *definition* of the symbol. */ |
| |
| #if defined(HAVE_ATTRIBUTE_VISIBILITY) |
| # define internal_proto(x) \ |
| sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden"))) |
| #else |
| # define internal_proto(x) sym_rename(x, IPREFIX(x)) |
| #endif |
| |
| #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS) |
| # define export_proto(x) sym_rename(x, PREFIX(x)) |
| # define export_proto_np(x) extern char swallow_semicolon |
| # define iexport_proto(x) internal_proto(x) |
| # define iexport(x) iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x)) |
| # define iexport1(x,p,y) iexport2(x,p,y) |
| # define iexport2(x,p,y) \ |
| extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y))) |
| /* ??? We're not currently building a dll, and it's wrong to add dllexport |
| to objects going into a static library archive. */ |
| #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT) |
| # define export_proto_np(x) extern __typeof(x) x __attribute__((dllexport)) |
| # define export_proto(x) sym_rename(x, PREFIX(x)) __attribute__((dllexport)) |
| # define iexport_proto(x) export_proto(x) |
| # define iexport(x) extern char swallow_semicolon |
| #else |
| # define export_proto(x) sym_rename(x, PREFIX(x)) |
| # define export_proto_np(x) extern char swallow_semicolon |
| # define iexport_proto(x) export_proto(x) |
| # define iexport(x) extern char swallow_semicolon |
| #endif |
| |
| /* TODO: detect the case when we *can* hide the symbol. */ |
| #define iexport_data_proto(x) export_proto(x) |
| #define iexport_data(x) extern char swallow_semicolon |
| |
| /* The only reliable way to get the offset of a field in a struct |
| in a system independent way is via this macro. */ |
| #ifndef offsetof |
| #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER) |
| #endif |
| |
| /* The isfinite macro is only available with C99, but some non-C99 |
| systems still provide fpclassify, and there is a `finite' function |
| in BSD. |
| |
| Also, isfinite is broken on Cygwin. |
| |
| When isfinite is not available, try to use one of the |
| alternatives, or bail out. */ |
| #if (!defined(isfinite) || defined(__CYGWIN__)) |
| #undef isfinite |
| static inline int |
| isfinite (double x) |
| { |
| #if defined(fpclassify) |
| return (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE); |
| #elif defined(HAVE_FINITE) |
| return finite (x); |
| #else |
| #error "libgfortran needs isfinite, fpclassify, or finite" |
| #endif |
| } |
| #endif /* !defined(isfinite) */ |
| |
| /* TODO: find the C99 version of these an move into above ifdef. */ |
| #define REALPART(z) (__real__(z)) |
| #define IMAGPART(z) (__imag__(z)) |
| #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);} |
| |
| typedef int8_t GFC_INTEGER_1; |
| typedef int16_t GFC_INTEGER_2; |
| typedef int32_t GFC_INTEGER_4; |
| typedef int64_t GFC_INTEGER_8; |
| typedef uint8_t GFC_UINTEGER_1; |
| typedef uint16_t GFC_UINTEGER_2; |
| typedef uint32_t GFC_UINTEGER_4; |
| typedef uint64_t GFC_UINTEGER_8; |
| typedef GFC_INTEGER_4 GFC_LOGICAL_4; |
| typedef GFC_INTEGER_8 GFC_LOGICAL_8; |
| typedef float GFC_REAL_4; |
| typedef double GFC_REAL_8; |
| typedef complex float GFC_COMPLEX_4; |
| typedef complex double GFC_COMPLEX_8; |
| |
| /* The following two definitions must be consistent with the types used |
| by the compiler. */ |
| /* The type used of array indices, amongst other things. */ |
| typedef ssize_t index_type; |
| /* The type used for the lengths of character variables. */ |
| typedef GFC_INTEGER_4 gfc_charlen_type; |
| |
| /* This will be 0 on little-endian machines and one on big-endian machines. */ |
| extern int l8_to_l4_offset; |
| internal_proto(l8_to_l4_offset); |
| |
| #define GFOR_POINTER_L8_TO_L4(p8) \ |
| (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8)) |
| |
| #define GFC_INTEGER_4_HUGE \ |
| (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1) |
| #define GFC_INTEGER_8_HUGE \ |
| (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1) |
| #define GFC_REAL_4_HUGE FLT_MAX |
| #define GFC_REAL_8_HUGE DBL_MAX |
| |
| #ifndef GFC_MAX_DIMENSIONS |
| #define GFC_MAX_DIMENSIONS 7 |
| #endif |
| |
| typedef struct descriptor_dimension |
| { |
| index_type stride; |
| index_type lbound; |
| index_type ubound; |
| } |
| descriptor_dimension; |
| |
| #define GFC_ARRAY_DESCRIPTOR(r, type) \ |
| struct {\ |
| type *data;\ |
| type *base;\ |
| index_type dtype;\ |
| descriptor_dimension dim[r];\ |
| } |
| |
| /* Commonly used array descriptor types. */ |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4; |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8; |
| |
| #define GFC_DTYPE_RANK_MASK 0x07 |
| #define GFC_DTYPE_TYPE_SHIFT 3 |
| #define GFC_DTYPE_TYPE_MASK 0x38 |
| #define GFC_DTYPE_SIZE_SHIFT 6 |
| |
| enum |
| { |
| GFC_DTYPE_UNKNOWN = 0, |
| GFC_DTYPE_INTEGER, |
| /* TODO: recognize logical types. */ |
| GFC_DTYPE_LOGICAL, |
| GFC_DTYPE_REAL, |
| GFC_DTYPE_COMPLEX, |
| GFC_DTYPE_DERIVED, |
| GFC_DTYPE_CHARACTER |
| }; |
| |
| #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK) |
| #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \ |
| >> GFC_DTYPE_TYPE_SHIFT) |
| #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT) |
| #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data) |
| #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype) |
| |
| /* Runtime library include. */ |
| #define stringize(x) expand_macro(x) |
| #define expand_macro(x) # x |
| |
| /* Runtime options structure. */ |
| |
| typedef struct |
| { |
| int stdin_unit, stdout_unit, stderr_unit, optional_plus; |
| int allocate_init_flag, allocate_init_value; |
| int locus; |
| |
| int separator_len; |
| const char *separator; |
| |
| int mem_check; |
| int use_stderr, all_unbuffered, default_recl; |
| |
| int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv, |
| fpu_overflow, fpu_underflow, fpu_precision_loss; |
| |
| int sighup, sigint; |
| } |
| options_t; |
| |
| |
| extern options_t options; |
| internal_proto(options); |
| |
| |
| /* Structure for statement options. */ |
| |
| typedef struct |
| { |
| const char *name; |
| int value; |
| } |
| st_option; |
| |
| /* Runtime errors. The EOR and EOF errors are required to be negative. */ |
| |
| typedef enum |
| { |
| ERROR_FIRST = -3, /* Marker for the first error. */ |
| ERROR_EOR = -2, |
| ERROR_END = -1, |
| ERROR_OK = 0, /* Indicates success, must be zero. */ |
| ERROR_OS, /* Operating system error, more info in errno. */ |
| ERROR_OPTION_CONFLICT, |
| ERROR_BAD_OPTION, |
| ERROR_MISSING_OPTION, |
| ERROR_ALREADY_OPEN, |
| ERROR_BAD_UNIT, |
| ERROR_FORMAT, |
| ERROR_BAD_ACTION, |
| ERROR_ENDFILE, |
| ERROR_BAD_US, |
| ERROR_READ_VALUE, |
| ERROR_READ_OVERFLOW, |
| ERROR_LAST /* Not a real error, the last error # + 1. */ |
| } |
| error_codes; |
| |
| |
| /* The filename and line number don't go inside the globals structure. |
| They are set by the rest of the program and must be linked to. */ |
| |
| /* Location of the current library call (optional). */ |
| extern unsigned line; |
| iexport_data_proto(line); |
| |
| extern char *filename; |
| iexport_data_proto(filename); |
| |
| /* Avoid conflicting prototypes of alloca() in system headers by using |
| GCC's builtin alloca(). */ |
| #define gfc_alloca(x) __builtin_alloca(x) |
| |
| |
| /* main.c */ |
| |
| extern void library_start (void); |
| internal_proto(library_start); |
| |
| extern void library_end (void); |
| internal_proto(library_end); |
| |
| extern void set_args (int, char **); |
| export_proto(set_args); |
| |
| extern void get_args (int *, char ***); |
| internal_proto(get_args); |
| |
| /* error.c */ |
| |
| extern char *gfc_itoa (int64_t); |
| internal_proto(gfc_itoa); |
| |
| extern char *xtoa (uint64_t); |
| internal_proto(xtoa); |
| |
| extern void os_error (const char *) __attribute__ ((noreturn)); |
| internal_proto(os_error); |
| |
| extern void show_locus (void); |
| internal_proto(show_locus); |
| |
| extern void runtime_error (const char *) __attribute__ ((noreturn)); |
| iexport_proto(runtime_error); |
| |
| extern void internal_error (const char *) __attribute__ ((noreturn)); |
| internal_proto(internal_error); |
| |
| extern const char *get_oserror (void); |
| internal_proto(get_oserror); |
| |
| extern void sys_exit (int) __attribute__ ((noreturn)); |
| internal_proto(sys_exit); |
| |
| extern int st_printf (const char *, ...) |
| __attribute__ ((format (printf, 1, 2))); |
| internal_proto(st_printf); |
| |
| extern void st_sprintf (char *, const char *, ...) |
| __attribute__ ((format (printf, 2, 3))); |
| internal_proto(st_sprintf); |
| |
| extern const char *translate_error (int); |
| internal_proto(translate_error); |
| |
| extern void generate_error (int, const char *); |
| internal_proto(generate_error); |
| |
| /* memory.c */ |
| |
| extern void *get_mem (size_t) __attribute__ ((malloc)); |
| internal_proto(get_mem); |
| |
| extern void free_mem (void *); |
| internal_proto(free_mem); |
| |
| extern void *internal_malloc_size (size_t); |
| internal_proto(internal_malloc_size); |
| |
| extern void internal_free (void *); |
| iexport_proto(internal_free); |
| |
| /* environ.c */ |
| |
| extern int check_buffered (int); |
| internal_proto(check_buffered); |
| |
| extern void init_variables (void); |
| internal_proto(init_variables); |
| |
| extern void show_variables (void); |
| internal_proto(show_variables); |
| |
| /* string.c */ |
| |
| extern int find_option (const char *, int, st_option *, const char *); |
| internal_proto(find_option); |
| |
| extern int fstrlen (const char *, int); |
| internal_proto(fstrlen); |
| |
| extern void fstrcpy (char *, int, const char *, int); |
| internal_proto(fstrcpy); |
| |
| extern void cf_strcpy (char *, int, const char *); |
| internal_proto(cf_strcpy); |
| |
| /* io.c */ |
| |
| extern void init_units (void); |
| internal_proto(init_units); |
| |
| extern void close_units (void); |
| internal_proto(close_units); |
| |
| /* stop.c */ |
| |
| extern void stop_numeric (GFC_INTEGER_4); |
| iexport_proto(stop_numeric); |
| |
| /* reshape_packed.c */ |
| |
| extern void reshape_packed (char *, index_type, const char *, index_type, |
| const char *, index_type); |
| internal_proto(reshape_packed); |
| |
| /* Repacking functions. */ |
| |
| /* ??? These four aren't currently used by the compiler, though we |
| certainly could do so. */ |
| GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *); |
| internal_proto(internal_pack_4); |
| |
| GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *); |
| internal_proto(internal_pack_8); |
| |
| extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *); |
| internal_proto(internal_unpack_4); |
| |
| extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *); |
| internal_proto(internal_unpack_8); |
| |
| /* string_intrinsics.c */ |
| |
| extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *, |
| GFC_INTEGER_4, const char *); |
| iexport_proto(compare_string); |
| |
| /* random.c */ |
| |
| extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put, |
| gfc_array_i4 * get); |
| iexport_proto(random_seed); |
| |
| /* normalize.c */ |
| |
| extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4); |
| internal_proto(normalize_r4_i4); |
| |
| extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8); |
| internal_proto(normalize_r8_i8); |
| |
| /* size.c */ |
| |
| typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t; |
| |
| extern index_type size0 (const array_t * array); |
| iexport_proto(size0); |
| |
| #endif /* LIBGFOR_H */ |