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>
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"
57 #include <sys/types.h>
59 typedef off_t gfc_offset;
62 #define NULL (void *) 0
66 #define __attribute__(x)
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
72 #define PREFIX(x) _gfortran_ ## x
73 #define IPREFIX(x) _gfortrani_ ## x
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)
81 /* There are several classifications of routines:
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.
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.
92 One of the following should be used immediately after the declaration
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.
100 export_proto Marks a symbol to be exported, and adds PREFIX
101 to the assembly-level symbol name.
103 export_proto_np Marks a symbol to be exported without adding PREFIX.
105 iexport_proto Marks a function to be exported, but with the
106 understanding that it can be used inside as well.
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.
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. */
116 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
117 # define internal_proto(x) \
118 sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
120 # define internal_proto(x) sym_rename(x, IPREFIX(x))
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
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
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
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. */
152 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
155 /* The isfinite macro is only available with C99, but some non-C99
156 systems still provide fpclassify, and there is a `finite' function
159 Also, isfinite is broken on Cygwin.
161 When isfinite is not available, try to use one of the
162 alternatives, or bail out. */
164 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
168 #if defined(HAVE_BROKEN_ISNAN)
172 #if defined(HAVE_BROKEN_FPCLASSIFY)
176 #if !defined(isfinite)
177 #if !defined(fpclassify)
178 #define isfinite(x) ((x) - (x) == 0)
180 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
181 #endif /* !defined(fpclassify) */
182 #endif /* !defined(isfinite) */
185 #if !defined(fpclassify)
186 #define isnan(x) ((x) != (x))
188 #define isnan(x) (fpclassify(x) == FP_NAN)
189 #endif /* !defined(fpclassify) */
190 #endif /* !defined(isfinite) */
192 /* TODO: find the C99 version of these an move into above ifdef. */
193 #define REALPART(z) (__real__(z))
194 #define IMAGPART(z) (__imag__(z))
195 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
199 /* The following two definitions must be consistent with the types used
201 /* The type used of array indices, amongst other things. */
202 typedef ssize_t index_type;
203 /* The type used for the lengths of character variables. */
204 typedef GFC_INTEGER_4 gfc_charlen_type;
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);
210 #define GFOR_POINTER_L8_TO_L4(p8) \
211 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
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 #ifdef HAVE_GFC_INTEGER_16
218 #define GFC_INTEGER_16_HUGE \
219 (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
222 #define GFC_REAL_4_HUGE FLT_MAX
223 #define GFC_REAL_8_HUGE DBL_MAX
224 #ifdef HAVE_GFC_REAL_10
225 #define GFC_REAL_10_HUGE LDBL_MAX
227 #ifdef HAVE_GFC_REAL_16
228 #define GFC_REAL_16_HUGE LDBL_MAX
231 #ifndef GFC_MAX_DIMENSIONS
232 #define GFC_MAX_DIMENSIONS 7
235 typedef struct descriptor_dimension
241 descriptor_dimension;
243 #define GFC_ARRAY_DESCRIPTOR(r, type) \
248 descriptor_dimension dim[r];\
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 #ifdef HAVE_GFC_INTEGER_16
257 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_16) gfc_array_i16;
259 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
260 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
261 #ifdef HAVE_GFC_REAL_10
262 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_10) gfc_array_r10;
264 #ifdef HAVE_GFC_REAL_16
265 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_16) gfc_array_r16;
267 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
268 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
269 #ifdef HAVE_GFC_COMPLEX_10
270 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_10) gfc_array_c10;
272 #ifdef HAVE_GFC_COMPLEX_16
273 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_16) gfc_array_c16;
275 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
276 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
277 #ifdef HAVE_GFC_LOGICAL_16
278 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_16) gfc_array_l16;
281 #define GFC_DTYPE_RANK_MASK 0x07
282 #define GFC_DTYPE_TYPE_SHIFT 3
283 #define GFC_DTYPE_TYPE_MASK 0x38
284 #define GFC_DTYPE_SIZE_SHIFT 6
288 GFC_DTYPE_UNKNOWN = 0,
290 /* TODO: recognize logical types. */
298 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
299 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
300 >> GFC_DTYPE_TYPE_SHIFT)
301 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
302 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
303 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
305 /* Runtime library include. */
306 #define stringize(x) expand_macro(x)
307 #define expand_macro(x) # x
309 /* Runtime options structure. */
313 int stdin_unit, stdout_unit, stderr_unit, optional_plus;
314 int allocate_init_flag, allocate_init_value;
318 const char *separator;
321 int use_stderr, all_unbuffered, default_recl;
323 int fpu_round, fpu_precision, fpe;
329 extern options_t options;
330 internal_proto(options);
333 /* Compile-time options that will influence the library. */
343 extern compile_options_t compile_options;
344 internal_proto(compile_options);
346 extern void init_compile_options (void);
347 internal_proto(init_compile_options);
350 /* Structure for statement options. */
359 /* Runtime errors. The EOR and EOF errors are required to be negative. */
363 ERROR_FIRST = -3, /* Marker for the first error. */
366 ERROR_OK = 0, /* Indicates success, must be zero. */
367 ERROR_OS, /* Operating system error, more info in errno. */
368 ERROR_OPTION_CONFLICT,
370 ERROR_MISSING_OPTION,
381 ERROR_LAST /* Not a real error, the last error # + 1. */
386 /* Flags to specify which standard/extension contains a feature.
387 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
388 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
389 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
390 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
391 /* Note that no features were obsoleted nor deleted in F2003. */
392 #define GFC_STD_F95 (1<<3) /* New in F95. */
393 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
394 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
395 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
397 /* Bitmasks for the various FPE that can be enabled.
398 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
399 #define GFC_FPE_INVALID (1<<0)
400 #define GFC_FPE_DENORMAL (1<<1)
401 #define GFC_FPE_ZERO (1<<2)
402 #define GFC_FPE_OVERFLOW (1<<3)
403 #define GFC_FPE_UNDERFLOW (1<<4)
404 #define GFC_FPE_PRECISION (1<<5)
406 /* The filename and line number don't go inside the globals structure.
407 They are set by the rest of the program and must be linked to. */
409 /* Location of the current library call (optional). */
410 extern unsigned line;
411 iexport_data_proto(line);
413 extern char *filename;
414 iexport_data_proto(filename);
416 /* Avoid conflicting prototypes of alloca() in system headers by using
417 GCC's builtin alloca(). */
418 #define gfc_alloca(x) __builtin_alloca(x)
423 extern void stupid_function_name_for_static_linking (void);
424 internal_proto(stupid_function_name_for_static_linking);
426 struct st_parameter_common;
427 extern void library_start (struct st_parameter_common *);
428 internal_proto(library_start);
430 #define library_end()
432 extern void set_args (int, char **);
433 export_proto(set_args);
435 extern void get_args (int *, char ***);
436 internal_proto(get_args);
440 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
441 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
442 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
443 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
445 extern const char *gfc_itoa (GFC_INTEGER_LARGEST, char *, size_t);
446 internal_proto(gfc_itoa);
448 extern const char *xtoa (GFC_UINTEGER_LARGEST, char *, size_t);
449 internal_proto(xtoa);
451 extern void os_error (const char *) __attribute__ ((noreturn));
452 internal_proto(os_error);
454 extern void show_locus (struct st_parameter_common *);
455 internal_proto(show_locus);
457 extern void runtime_error (const char *) __attribute__ ((noreturn));
458 iexport_proto(runtime_error);
460 extern void internal_error (struct st_parameter_common *, const char *)
461 __attribute__ ((noreturn));
462 internal_proto(internal_error);
464 extern const char *get_oserror (void);
465 internal_proto(get_oserror);
467 extern void sys_exit (int) __attribute__ ((noreturn));
468 internal_proto(sys_exit);
470 extern int st_printf (const char *, ...)
471 __attribute__ ((format (printf, 1, 2)));
472 internal_proto(st_printf);
474 extern void st_sprintf (char *, const char *, ...)
475 __attribute__ ((format (printf, 2, 3)));
476 internal_proto(st_sprintf);
478 extern const char *translate_error (int);
479 internal_proto(translate_error);
481 extern void generate_error (struct st_parameter_common *, int, const char *);
482 internal_proto(generate_error);
486 extern void set_fpu (void);
487 internal_proto(set_fpu);
491 extern void *get_mem (size_t) __attribute__ ((malloc));
492 internal_proto(get_mem);
494 extern void free_mem (void *);
495 internal_proto(free_mem);
497 extern void *internal_malloc_size (size_t);
498 internal_proto(internal_malloc_size);
500 extern void internal_free (void *);
501 iexport_proto(internal_free);
505 extern int check_buffered (int);
506 internal_proto(check_buffered);
508 extern void init_variables (void);
509 internal_proto(init_variables);
511 extern void show_variables (void);
512 internal_proto(show_variables);
516 extern int find_option (struct st_parameter_common *, const char *, int,
517 const st_option *, const char *);
518 internal_proto(find_option);
520 extern int fstrlen (const char *, int);
521 internal_proto(fstrlen);
523 extern void fstrcpy (char *, int, const char *, int);
524 internal_proto(fstrcpy);
526 extern void cf_strcpy (char *, int, const char *);
527 internal_proto(cf_strcpy);
531 extern void init_units (void);
532 internal_proto(init_units);
534 extern void close_units (void);
535 internal_proto(close_units);
539 extern void stop_numeric (GFC_INTEGER_4);
540 iexport_proto(stop_numeric);
542 /* reshape_packed.c */
544 extern void reshape_packed (char *, index_type, const char *, index_type,
545 const char *, index_type);
546 internal_proto(reshape_packed);
548 /* Repacking functions. */
550 /* ??? These aren't currently used by the compiler, though we
551 certainly could do so. */
552 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
553 internal_proto(internal_pack_4);
555 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
556 internal_proto(internal_pack_8);
558 #if defined HAVE_GFC_INTEGER_16
559 GFC_INTEGER_16 *internal_pack_16 (gfc_array_i16 *);
560 internal_proto(internal_pack_16);
563 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
564 internal_proto(internal_pack_c4);
566 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
567 internal_proto(internal_pack_c8);
569 #if defined HAVE_GFC_COMPLEX_10
570 GFC_COMPLEX_10 *internal_pack_c10 (gfc_array_c10 *);
571 internal_proto(internal_pack_c10);
574 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
575 internal_proto(internal_unpack_4);
577 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
578 internal_proto(internal_unpack_8);
580 #if defined HAVE_GFC_INTEGER_16
581 extern void internal_unpack_16 (gfc_array_i16 *, const GFC_INTEGER_16 *);
582 internal_proto(internal_unpack_16);
585 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
586 internal_proto(internal_unpack_c4);
588 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
589 internal_proto(internal_unpack_c8);
591 #if defined HAVE_GFC_COMPLEX_10
592 extern void internal_unpack_c10 (gfc_array_c10 *, const GFC_COMPLEX_10 *);
593 internal_proto(internal_unpack_c10);
596 /* string_intrinsics.c */
598 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
599 GFC_INTEGER_4, const char *);
600 iexport_proto(compare_string);
604 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
606 iexport_proto(random_seed);
610 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
611 internal_proto(normalize_r4_i4);
613 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
614 internal_proto(normalize_r8_i8);
618 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
620 extern index_type size0 (const array_t * array);
621 iexport_proto(size0);
623 #endif /* LIBGFOR_H */