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
42 #include "c99_protos.h"
47 #define complex __complex__
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 typedef unsigned short uint16_t;
69 typedef unsigned int uint32_t;
70 typedef unsigned long long uint64_t;
74 #include <sys/types.h>
76 typedef off_t gfc_offset;
79 #define NULL (void *) 0
83 #define __attribute__(x)
86 /* For a library, a standard prefix is a requirement in order to partition
87 the namespace. IPREFIX is for symbols intended to be internal to the
89 #define PREFIX(x) _gfortran_ ## x
90 #define IPREFIX(x) _gfortrani_ ## x
92 /* Magic to rename a symbol at the compiler level. You continue to refer
93 to the symbol as OLD in the source, but it'll be named NEW in the asm. */
94 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
95 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
96 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
98 /* There are several classifications of routines:
100 (1) Symbols used only within the library,
101 (2) Symbols to be exported from the library,
102 (3) Symbols to be exported from the library, but
103 also used inside the library.
105 By telling the compiler about these different classifications we can
106 tightly control the interface seen by the user, and get better code
107 from the compiler at the same time.
109 One of the following should be used immediately after the declaration
112 internal_proto Marks a symbol used only within the library,
113 and adds IPREFIX to the assembly-level symbol
114 name. The later is important for maintaining
115 the namespace partition for the static library.
117 export_proto Marks a symbol to be exported, and adds PREFIX
118 to the assembly-level symbol name.
120 export_proto_np Marks a symbol to be exported without adding PREFIX.
122 iexport_proto Marks a function to be exported, but with the
123 understanding that it can be used inside as well.
125 iexport_data_proto Similarly, marks a data symbol to be exported.
126 Unfortunately, some systems can't play the hidden
127 symbol renaming trick on data symbols, thanks to
128 the horribleness of COPY relocations.
130 If iexport_proto or iexport_data_proto is used, you must also use
131 iexport or iexport_data after the *definition* of the symbol. */
133 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
134 # define internal_proto(x) \
135 sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
137 # define internal_proto(x) sym_rename(x, IPREFIX(x))
140 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
141 # define export_proto(x) sym_rename(x, PREFIX(x))
142 # define export_proto_np(x) extern char swallow_semicolon
143 # define iexport_proto(x) internal_proto(x)
144 # define iexport(x) iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x))
145 # define iexport1(x,p,y) iexport2(x,p,y)
146 # define iexport2(x,p,y) \
147 extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y)))
148 /* ??? We're not currently building a dll, and it's wrong to add dllexport
149 to objects going into a static library archive. */
150 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
151 # define export_proto_np(x) extern __typeof(x) x __attribute__((dllexport))
152 # define export_proto(x) sym_rename(x, PREFIX(x)) __attribute__((dllexport))
153 # define iexport_proto(x) export_proto(x)
154 # define iexport(x) extern char swallow_semicolon
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) export_proto(x)
159 # define iexport(x) extern char swallow_semicolon
162 /* TODO: detect the case when we *can* hide the symbol. */
163 #define iexport_data_proto(x) export_proto(x)
164 #define iexport_data(x) extern char swallow_semicolon
166 /* The only reliable way to get the offset of a field in a struct
167 in a system independent way is via this macro. */
169 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
172 /* The isfinite macro is only available with C99, but some non-C99
173 systems still provide fpclassify, and there is a `finite' function
176 Also, isfinite is broken on Cygwin.
178 When isfinite is not available, try to use one of the
179 alternatives, or bail out. */
180 #if (!defined(isfinite) || defined(__CYGWIN__))
182 #if defined(fpclassify)
183 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
185 #define isfinite(x) ((x) - (x) == 0)
187 #endif /* !defined(isfinite) */
189 /* TODO: find the C99 version of these an move into above ifdef. */
190 #define REALPART(z) (__real__(z))
191 #define IMAGPART(z) (__imag__(z))
192 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
196 /* The following two definitions must be consistent with the types used
198 /* The type used of array indices, amongst other things. */
199 typedef ssize_t index_type;
200 /* The type used for the lengths of character variables. */
201 typedef GFC_INTEGER_4 gfc_charlen_type;
203 /* This will be 0 on little-endian machines and one on big-endian machines. */
204 extern int l8_to_l4_offset;
205 internal_proto(l8_to_l4_offset);
207 #define GFOR_POINTER_L8_TO_L4(p8) \
208 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
210 #define GFC_INTEGER_4_HUGE \
211 (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
212 #define GFC_INTEGER_8_HUGE \
213 (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
214 #define GFC_REAL_4_HUGE FLT_MAX
215 #define GFC_REAL_8_HUGE DBL_MAX
217 #ifndef GFC_MAX_DIMENSIONS
218 #define GFC_MAX_DIMENSIONS 7
221 typedef struct descriptor_dimension
227 descriptor_dimension;
229 #define GFC_ARRAY_DESCRIPTOR(r, type) \
234 descriptor_dimension dim[r];\
237 /* Commonly used array descriptor types. */
238 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
239 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
240 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
241 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
242 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
243 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
244 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
245 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
246 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
247 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
249 #define GFC_DTYPE_RANK_MASK 0x07
250 #define GFC_DTYPE_TYPE_SHIFT 3
251 #define GFC_DTYPE_TYPE_MASK 0x38
252 #define GFC_DTYPE_SIZE_SHIFT 6
256 GFC_DTYPE_UNKNOWN = 0,
258 /* TODO: recognize logical types. */
266 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
267 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
268 >> GFC_DTYPE_TYPE_SHIFT)
269 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
270 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
271 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
273 /* Runtime library include. */
274 #define stringize(x) expand_macro(x)
275 #define expand_macro(x) # x
277 /* Runtime options structure. */
281 int stdin_unit, stdout_unit, stderr_unit, optional_plus;
282 int allocate_init_flag, allocate_init_value;
286 const char *separator;
289 int use_stderr, all_unbuffered, default_recl;
291 int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
292 fpu_overflow, fpu_underflow, fpu_precision_loss;
298 extern options_t options;
299 internal_proto(options);
302 /* Compile-time options that will influence the library. */
311 extern compile_options_t compile_options;
312 internal_proto(compile_options);
314 extern void init_compile_options (void);
315 internal_proto(init_compile_options);
318 /* Structure for statement options. */
327 /* Runtime errors. The EOR and EOF errors are required to be negative. */
331 ERROR_FIRST = -3, /* Marker for the first error. */
334 ERROR_OK = 0, /* Indicates success, must be zero. */
335 ERROR_OS, /* Operating system error, more info in errno. */
336 ERROR_OPTION_CONFLICT,
338 ERROR_MISSING_OPTION,
347 ERROR_LAST /* Not a real error, the last error # + 1. */
352 /* Flags to specify which standard/extension contains a feature.
353 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
354 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
355 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
356 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
357 /* Note that no features were obsoleted nor deleted in F2003. */
358 #define GFC_STD_F95 (1<<3) /* New in F95. */
359 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
360 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
361 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
364 /* The filename and line number don't go inside the globals structure.
365 They are set by the rest of the program and must be linked to. */
367 /* Location of the current library call (optional). */
368 extern unsigned line;
369 iexport_data_proto(line);
371 extern char *filename;
372 iexport_data_proto(filename);
374 /* Avoid conflicting prototypes of alloca() in system headers by using
375 GCC's builtin alloca(). */
376 #define gfc_alloca(x) __builtin_alloca(x)
381 extern void library_start (void);
382 internal_proto(library_start);
384 extern void library_end (void);
385 internal_proto(library_end);
387 extern void set_args (int, char **);
388 export_proto(set_args);
390 extern void get_args (int *, char ***);
391 internal_proto(get_args);
395 extern char *gfc_itoa (GFC_INTEGER_LARGEST);
396 internal_proto(gfc_itoa);
398 extern char *xtoa (GFC_UINTEGER_LARGEST);
399 internal_proto(xtoa);
401 extern void os_error (const char *) __attribute__ ((noreturn));
402 internal_proto(os_error);
404 extern void show_locus (void);
405 internal_proto(show_locus);
407 extern void runtime_error (const char *) __attribute__ ((noreturn));
408 iexport_proto(runtime_error);
410 extern void internal_error (const char *) __attribute__ ((noreturn));
411 internal_proto(internal_error);
413 extern const char *get_oserror (void);
414 internal_proto(get_oserror);
416 extern void sys_exit (int) __attribute__ ((noreturn));
417 internal_proto(sys_exit);
419 extern int st_printf (const char *, ...)
420 __attribute__ ((format (printf, 1, 2)));
421 internal_proto(st_printf);
423 extern void st_sprintf (char *, const char *, ...)
424 __attribute__ ((format (printf, 2, 3)));
425 internal_proto(st_sprintf);
427 extern const char *translate_error (int);
428 internal_proto(translate_error);
430 extern void generate_error (int, const char *);
431 internal_proto(generate_error);
435 extern void *get_mem (size_t) __attribute__ ((malloc));
436 internal_proto(get_mem);
438 extern void free_mem (void *);
439 internal_proto(free_mem);
441 extern void *internal_malloc_size (size_t);
442 internal_proto(internal_malloc_size);
444 extern void internal_free (void *);
445 iexport_proto(internal_free);
449 extern int check_buffered (int);
450 internal_proto(check_buffered);
452 extern void init_variables (void);
453 internal_proto(init_variables);
455 extern void show_variables (void);
456 internal_proto(show_variables);
460 extern int find_option (const char *, int, st_option *, const char *);
461 internal_proto(find_option);
463 extern int fstrlen (const char *, int);
464 internal_proto(fstrlen);
466 extern void fstrcpy (char *, int, const char *, int);
467 internal_proto(fstrcpy);
469 extern void cf_strcpy (char *, int, const char *);
470 internal_proto(cf_strcpy);
474 extern void init_units (void);
475 internal_proto(init_units);
477 extern void close_units (void);
478 internal_proto(close_units);
482 extern void stop_numeric (GFC_INTEGER_4);
483 iexport_proto(stop_numeric);
485 /* reshape_packed.c */
487 extern void reshape_packed (char *, index_type, const char *, index_type,
488 const char *, index_type);
489 internal_proto(reshape_packed);
491 /* Repacking functions. */
493 /* ??? These eight aren't currently used by the compiler, though we
494 certainly could do so. */
495 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
496 internal_proto(internal_pack_4);
498 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
499 internal_proto(internal_pack_8);
501 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
502 internal_proto(internal_pack_c4);
504 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
505 internal_proto(internal_pack_c8);
507 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
508 internal_proto(internal_unpack_4);
510 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
511 internal_proto(internal_unpack_8);
513 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
514 internal_proto(internal_unpack_c4);
516 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
517 internal_proto(internal_unpack_c8);
519 /* string_intrinsics.c */
521 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
522 GFC_INTEGER_4, const char *);
523 iexport_proto(compare_string);
527 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
529 iexport_proto(random_seed);
533 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
534 internal_proto(normalize_r4_i4);
536 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
537 internal_proto(normalize_r8_i8);
541 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
543 extern index_type size0 (const array_t * array);
544 iexport_proto(size0);
546 #endif /* LIBGFOR_H */