1 /* Common declarations for all of libgfor.
2 Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 Contributed by Paul Brook <paul@nowt.org>, and
4 Andy Vaught <andy@xena.eas.asu.edu>
6 This file is part of the GNU Fortran 95 runtime library (libgfortran).
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.
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.
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. */
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. */
38 #define M_PI 3.14159265358979323846264338327
44 #define complex __complex__
48 #include "c99_protos.h"
62 #if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && defined(TARGET_ILP32)
64 typedef short int16_t;
66 typedef long long int64_t;
67 typedef unsigned char uint8_t;
68 #if defined(__sun) && defined(__svr4__)
69 /* Prevent <pthread.h> from redefining uint8_t on Solaris 2.5.1
70 FIXME when the header inclusion scheme is revisited. */
73 typedef unsigned short uint16_t;
74 typedef unsigned int uint32_t;
75 #if defined(__sun) && defined(__svr4__)
76 /* Prevent <pthread.h> from redefining uint32_t on Solaris 2.5.1
77 FIXME when the header inclusion scheme is revisited. */
80 typedef unsigned long long uint64_t;
81 #if defined(__sun) && defined(__svr4__)
82 /* Prevent <pthread.h> from redefining uint64_t on Solaris 2.5.1
83 FIXME when the header inclusion scheme is revisited. */
89 #include <sys/types.h>
91 typedef off_t gfc_offset
;
94 #define NULL (void *) 0
98 #define __attribute__(x)
101 /* For a library, a standard prefix is a requirement in order to partition
102 the namespace. IPREFIX is for symbols intended to be internal to the
104 #define PREFIX(x) _gfortran_ ## x
105 #define IPREFIX(x) _gfortrani_ ## x
107 /* Magic to rename a symbol at the compiler level. You continue to refer
108 to the symbol as OLD in the source, but it'll be named NEW in the asm. */
109 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
110 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
111 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
113 /* There are several classifications of routines:
115 (1) Symbols used only within the library,
116 (2) Symbols to be exported from the library,
117 (3) Symbols to be exported from the library, but
118 also used inside the library.
120 By telling the compiler about these different classifications we can
121 tightly control the interface seen by the user, and get better code
122 from the compiler at the same time.
124 One of the following should be used immediately after the declaration
127 internal_proto Marks a symbol used only within the library,
128 and adds IPREFIX to the assembly-level symbol
129 name. The later is important for maintaining
130 the namespace partition for the static library.
132 export_proto Marks a symbol to be exported, and adds PREFIX
133 to the assembly-level symbol name.
135 export_proto_np Marks a symbol to be exported without adding PREFIX.
137 iexport_proto Marks a function to be exported, but with the
138 understanding that it can be used inside as well.
140 iexport_data_proto Similarly, marks a data symbol to be exported.
141 Unfortunately, some systems can't play the hidden
142 symbol renaming trick on data symbols, thanks to
143 the horribleness of COPY relocations.
145 If iexport_proto or iexport_data_proto is used, you must also use
146 iexport or iexport_data after the *definition* of the symbol. */
148 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
149 # define internal_proto(x) \
150 sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
152 # define internal_proto(x) sym_rename(x, IPREFIX(x))
155 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
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) internal_proto(x)
159 # define iexport(x) iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x))
160 # define iexport1(x,p,y) iexport2(x,p,y)
161 # define iexport2(x,p,y) \
162 extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y)))
163 /* ??? We're not currently building a dll, and it's wrong to add dllexport
164 to objects going into a static library archive. */
165 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
166 # define export_proto_np(x) extern __typeof(x) x __attribute__((dllexport))
167 # define export_proto(x) sym_rename(x, PREFIX(x)) __attribute__((dllexport))
168 # define iexport_proto(x) export_proto(x)
169 # define iexport(x) extern char swallow_semicolon
171 # define export_proto(x) sym_rename(x, PREFIX(x))
172 # define export_proto_np(x) extern char swallow_semicolon
173 # define iexport_proto(x) export_proto(x)
174 # define iexport(x) extern char swallow_semicolon
177 /* TODO: detect the case when we *can* hide the symbol. */
178 #define iexport_data_proto(x) export_proto(x)
179 #define iexport_data(x) extern char swallow_semicolon
181 /* The only reliable way to get the offset of a field in a struct
182 in a system independent way is via this macro. */
184 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
187 /* The isfinite macro is only available with C99, but some non-C99
188 systems still provide fpclassify, and there is a `finite' function
191 Also, isfinite is broken on Cygwin.
193 When isfinite is not available, try to use one of the
194 alternatives, or bail out. */
196 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
200 #if defined(HAVE_BROKEN_ISNAN)
204 #if defined(HAVE_BROKEN_FPCLASSIFY)
208 #if !defined(isfinite)
209 #if !defined(fpclassify)
210 #define isfinite(x) ((x) - (x) == 0)
212 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
213 #endif /* !defined(fpclassify) */
214 #endif /* !defined(isfinite) */
217 #if !defined(fpclassify)
218 #define isnan(x) ((x) != (x))
220 #define isnan(x) (fpclassify(x) == FP_NAN)
221 #endif /* !defined(fpclassify) */
222 #endif /* !defined(isfinite) */
224 /* TODO: find the C99 version of these an move into above ifdef. */
225 #define REALPART(z) (__real__(z))
226 #define IMAGPART(z) (__imag__(z))
227 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
231 /* The following two definitions must be consistent with the types used
233 /* The type used of array indices, amongst other things. */
234 typedef ssize_t index_type
;
235 /* The type used for the lengths of character variables. */
236 typedef GFC_INTEGER_4 gfc_charlen_type
;
238 /* This will be 0 on little-endian machines and one on big-endian machines. */
239 extern int l8_to_l4_offset
;
240 internal_proto(l8_to_l4_offset
);
242 #define GFOR_POINTER_L8_TO_L4(p8) \
243 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
245 #define GFC_INTEGER_4_HUGE \
246 (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
247 #define GFC_INTEGER_8_HUGE \
248 (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
249 #ifdef HAVE_GFC_INTEGER_16
250 #define GFC_INTEGER_16_HUGE \
251 (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
254 #define GFC_REAL_4_HUGE FLT_MAX
255 #define GFC_REAL_8_HUGE DBL_MAX
256 #ifdef HAVE_GFC_REAL_10
257 #define GFC_REAL_10_HUGE LDBL_MAX
259 #ifdef HAVE_GFC_REAL_16
260 #define GFC_REAL_16_HUGE LDBL_MAX
263 #ifndef GFC_MAX_DIMENSIONS
264 #define GFC_MAX_DIMENSIONS 7
267 typedef struct descriptor_dimension
273 descriptor_dimension
;
275 #define GFC_ARRAY_DESCRIPTOR(r, type) \
280 descriptor_dimension dim[r];\
283 /* Commonly used array descriptor types. */
284 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, void) gfc_array_void
;
285 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, char) gfc_array_char
;
286 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_4
) gfc_array_i4
;
287 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_8
) gfc_array_i8
;
288 #ifdef HAVE_GFC_INTEGER_16
289 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_16
) gfc_array_i16
;
291 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_4
) gfc_array_r4
;
292 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_8
) gfc_array_r8
;
293 #ifdef HAVE_GFC_REAL_10
294 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_10
) gfc_array_r10
;
296 #ifdef HAVE_GFC_REAL_16
297 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_16
) gfc_array_r16
;
299 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_4
) gfc_array_c4
;
300 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_8
) gfc_array_c8
;
301 #ifdef HAVE_GFC_COMPLEX_10
302 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_10
) gfc_array_c10
;
304 #ifdef HAVE_GFC_COMPLEX_16
305 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_16
) gfc_array_c16
;
307 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_4
) gfc_array_l4
;
308 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_8
) gfc_array_l8
;
309 #ifdef HAVE_GFC_LOGICAL_16
310 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_16
) gfc_array_l16
;
313 #define GFC_DTYPE_RANK_MASK 0x07
314 #define GFC_DTYPE_TYPE_SHIFT 3
315 #define GFC_DTYPE_TYPE_MASK 0x38
316 #define GFC_DTYPE_SIZE_SHIFT 6
320 GFC_DTYPE_UNKNOWN
= 0,
322 /* TODO: recognize logical types. */
330 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
331 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
332 >> GFC_DTYPE_TYPE_SHIFT)
333 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
334 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
335 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
337 /* Runtime library include. */
338 #define stringize(x) expand_macro(x)
339 #define expand_macro(x) # x
341 /* Runtime options structure. */
345 int stdin_unit
, stdout_unit
, stderr_unit
, optional_plus
;
346 int allocate_init_flag
, allocate_init_value
;
350 const char *separator
;
353 int use_stderr
, all_unbuffered
, default_recl
;
355 int fpu_round
, fpu_precision
, fpe
;
361 extern options_t options
;
362 internal_proto(options
);
365 /* Compile-time options that will influence the library. */
374 extern compile_options_t compile_options
;
375 internal_proto(compile_options
);
377 extern void init_compile_options (void);
378 internal_proto(init_compile_options
);
381 /* Structure for statement options. */
390 /* Runtime errors. The EOR and EOF errors are required to be negative. */
394 ERROR_FIRST
= -3, /* Marker for the first error. */
397 ERROR_OK
= 0, /* Indicates success, must be zero. */
398 ERROR_OS
, /* Operating system error, more info in errno. */
399 ERROR_OPTION_CONFLICT
,
401 ERROR_MISSING_OPTION
,
412 ERROR_LAST
/* Not a real error, the last error # + 1. */
417 /* Flags to specify which standard/extension contains a feature.
418 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
419 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
420 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
421 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
422 /* Note that no features were obsoleted nor deleted in F2003. */
423 #define GFC_STD_F95 (1<<3) /* New in F95. */
424 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
425 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
426 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
428 /* Bitmasks for the various FPE that can be enabled.
429 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
430 #define GFC_FPE_INVALID (1<<0)
431 #define GFC_FPE_DENORMAL (1<<1)
432 #define GFC_FPE_ZERO (1<<2)
433 #define GFC_FPE_OVERFLOW (1<<3)
434 #define GFC_FPE_UNDERFLOW (1<<4)
435 #define GFC_FPE_PRECISION (1<<5)
437 /* The filename and line number don't go inside the globals structure.
438 They are set by the rest of the program and must be linked to. */
440 /* Location of the current library call (optional). */
441 extern unsigned line
;
442 iexport_data_proto(line
);
444 extern char *filename
;
445 iexport_data_proto(filename
);
447 /* Avoid conflicting prototypes of alloca() in system headers by using
448 GCC's builtin alloca(). */
449 #define gfc_alloca(x) __builtin_alloca(x)
454 extern void stupid_function_name_for_static_linking (void);
455 internal_proto(stupid_function_name_for_static_linking
);
457 struct st_parameter_common
;
458 extern void library_start (struct st_parameter_common
*);
459 internal_proto(library_start
);
461 #define library_end()
463 extern void set_args (int, char **);
464 export_proto(set_args
);
466 extern void get_args (int *, char ***);
467 internal_proto(get_args
);
471 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
472 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
473 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
474 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
476 extern const char *gfc_itoa (GFC_INTEGER_LARGEST
, char *, size_t);
477 internal_proto(gfc_itoa
);
479 extern const char *xtoa (GFC_UINTEGER_LARGEST
, char *, size_t);
480 internal_proto(xtoa
);
482 extern void os_error (const char *) __attribute__ ((noreturn
));
483 internal_proto(os_error
);
485 extern void show_locus (struct st_parameter_common
*);
486 internal_proto(show_locus
);
488 extern void runtime_error (const char *) __attribute__ ((noreturn
));
489 iexport_proto(runtime_error
);
491 extern void internal_error (struct st_parameter_common
*, const char *)
492 __attribute__ ((noreturn
));
493 internal_proto(internal_error
);
495 extern const char *get_oserror (void);
496 internal_proto(get_oserror
);
498 extern void sys_exit (int) __attribute__ ((noreturn
));
499 internal_proto(sys_exit
);
501 extern int st_printf (const char *, ...)
502 __attribute__ ((format (printf
, 1, 2)));
503 internal_proto(st_printf
);
505 extern void st_sprintf (char *, const char *, ...)
506 __attribute__ ((format (printf
, 2, 3)));
507 internal_proto(st_sprintf
);
509 extern const char *translate_error (int);
510 internal_proto(translate_error
);
512 extern void generate_error (struct st_parameter_common
*, int, const char *);
513 internal_proto(generate_error
);
517 extern void set_fpu (void);
518 internal_proto(set_fpu
);
522 extern void *get_mem (size_t) __attribute__ ((malloc
));
523 internal_proto(get_mem
);
525 extern void free_mem (void *);
526 internal_proto(free_mem
);
528 extern void *internal_malloc_size (size_t);
529 internal_proto(internal_malloc_size
);
531 extern void internal_free (void *);
532 iexport_proto(internal_free
);
536 extern int check_buffered (int);
537 internal_proto(check_buffered
);
539 extern void init_variables (void);
540 internal_proto(init_variables
);
542 extern void show_variables (void);
543 internal_proto(show_variables
);
547 extern int find_option (struct st_parameter_common
*, const char *, int,
548 const st_option
*, const char *);
549 internal_proto(find_option
);
551 extern int fstrlen (const char *, int);
552 internal_proto(fstrlen
);
554 extern void fstrcpy (char *, int, const char *, int);
555 internal_proto(fstrcpy
);
557 extern void cf_strcpy (char *, int, const char *);
558 internal_proto(cf_strcpy
);
562 extern void init_units (void);
563 internal_proto(init_units
);
565 extern void close_units (void);
566 internal_proto(close_units
);
570 extern void stop_numeric (GFC_INTEGER_4
);
571 iexport_proto(stop_numeric
);
573 /* reshape_packed.c */
575 extern void reshape_packed (char *, index_type
, const char *, index_type
,
576 const char *, index_type
);
577 internal_proto(reshape_packed
);
579 /* Repacking functions. */
581 /* ??? These aren't currently used by the compiler, though we
582 certainly could do so. */
583 GFC_INTEGER_4
*internal_pack_4 (gfc_array_i4
*);
584 internal_proto(internal_pack_4
);
586 GFC_INTEGER_8
*internal_pack_8 (gfc_array_i8
*);
587 internal_proto(internal_pack_8
);
589 #if defined HAVE_GFC_INTEGER_16
590 GFC_INTEGER_16
*internal_pack_16 (gfc_array_i16
*);
591 internal_proto(internal_pack_16
);
594 GFC_COMPLEX_4
*internal_pack_c4 (gfc_array_c4
*);
595 internal_proto(internal_pack_c4
);
597 GFC_COMPLEX_8
*internal_pack_c8 (gfc_array_c8
*);
598 internal_proto(internal_pack_c8
);
600 #if defined HAVE_GFC_COMPLEX_10
601 GFC_COMPLEX_10
*internal_pack_c10 (gfc_array_c10
*);
602 internal_proto(internal_pack_c10
);
605 extern void internal_unpack_4 (gfc_array_i4
*, const GFC_INTEGER_4
*);
606 internal_proto(internal_unpack_4
);
608 extern void internal_unpack_8 (gfc_array_i8
*, const GFC_INTEGER_8
*);
609 internal_proto(internal_unpack_8
);
611 #if defined HAVE_GFC_INTEGER_16
612 extern void internal_unpack_16 (gfc_array_i16
*, const GFC_INTEGER_16
*);
613 internal_proto(internal_unpack_16
);
616 extern void internal_unpack_c4 (gfc_array_c4
*, const GFC_COMPLEX_4
*);
617 internal_proto(internal_unpack_c4
);
619 extern void internal_unpack_c8 (gfc_array_c8
*, const GFC_COMPLEX_8
*);
620 internal_proto(internal_unpack_c8
);
622 #if defined HAVE_GFC_COMPLEX_10
623 extern void internal_unpack_c10 (gfc_array_c10
*, const GFC_COMPLEX_10
*);
624 internal_proto(internal_unpack_c10
);
627 /* string_intrinsics.c */
629 extern GFC_INTEGER_4
compare_string (GFC_INTEGER_4
, const char *,
630 GFC_INTEGER_4
, const char *);
631 iexport_proto(compare_string
);
635 extern void random_seed (GFC_INTEGER_4
* size
, gfc_array_i4
* put
,
637 iexport_proto(random_seed
);
641 extern GFC_REAL_4
normalize_r4_i4 (GFC_UINTEGER_4
, GFC_UINTEGER_4
);
642 internal_proto(normalize_r4_i4
);
644 extern GFC_REAL_8
normalize_r8_i8 (GFC_UINTEGER_8
, GFC_UINTEGER_8
);
645 internal_proto(normalize_r8_i8
);
649 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, void) array_t
;
651 extern index_type
size0 (const array_t
* array
);
652 iexport_proto(size0
);
654 #endif /* LIBGFOR_H */