1 /* Common declarations for all of libgfor.
2 Copyright (C) 2002, 2003, 2004 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., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, 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;
299 extern options_t options;
300 internal_proto(options);
303 /* Structure for statement options. */
312 /* Runtime errors. The EOR and EOF errors are required to be negative. */
316 ERROR_FIRST = -3, /* Marker for the first error. */
319 ERROR_OK = 0, /* Indicates success, must be zero. */
320 ERROR_OS, /* Operating system error, more info in errno. */
321 ERROR_OPTION_CONFLICT,
323 ERROR_MISSING_OPTION,
332 ERROR_LAST /* Not a real error, the last error # + 1. */
337 /* The filename and line number don't go inside the globals structure.
338 They are set by the rest of the program and must be linked to. */
340 /* Location of the current library call (optional). */
341 extern unsigned line;
342 iexport_data_proto(line);
344 extern char *filename;
345 iexport_data_proto(filename);
347 /* Avoid conflicting prototypes of alloca() in system headers by using
348 GCC's builtin alloca(). */
349 #define gfc_alloca(x) __builtin_alloca(x)
354 extern void library_start (void);
355 internal_proto(library_start);
357 extern void library_end (void);
358 internal_proto(library_end);
360 extern void set_args (int, char **);
361 export_proto(set_args);
363 extern void get_args (int *, char ***);
364 internal_proto(get_args);
368 extern char *gfc_itoa (GFC_INTEGER_LARGEST);
369 internal_proto(gfc_itoa);
371 extern char *xtoa (GFC_UINTEGER_LARGEST);
372 internal_proto(xtoa);
374 extern void os_error (const char *) __attribute__ ((noreturn));
375 internal_proto(os_error);
377 extern void show_locus (void);
378 internal_proto(show_locus);
380 extern void runtime_error (const char *) __attribute__ ((noreturn));
381 iexport_proto(runtime_error);
383 extern void internal_error (const char *) __attribute__ ((noreturn));
384 internal_proto(internal_error);
386 extern const char *get_oserror (void);
387 internal_proto(get_oserror);
389 extern void sys_exit (int) __attribute__ ((noreturn));
390 internal_proto(sys_exit);
392 extern int st_printf (const char *, ...)
393 __attribute__ ((format (printf, 1, 2)));
394 internal_proto(st_printf);
396 extern void st_sprintf (char *, const char *, ...)
397 __attribute__ ((format (printf, 2, 3)));
398 internal_proto(st_sprintf);
400 extern const char *translate_error (int);
401 internal_proto(translate_error);
403 extern void generate_error (int, const char *);
404 internal_proto(generate_error);
408 extern void *get_mem (size_t) __attribute__ ((malloc));
409 internal_proto(get_mem);
411 extern void free_mem (void *);
412 internal_proto(free_mem);
414 extern void *internal_malloc_size (size_t);
415 internal_proto(internal_malloc_size);
417 extern void internal_free (void *);
418 iexport_proto(internal_free);
422 extern int check_buffered (int);
423 internal_proto(check_buffered);
425 extern void init_variables (void);
426 internal_proto(init_variables);
428 extern void show_variables (void);
429 internal_proto(show_variables);
433 extern int find_option (const char *, int, st_option *, const char *);
434 internal_proto(find_option);
436 extern int fstrlen (const char *, int);
437 internal_proto(fstrlen);
439 extern void fstrcpy (char *, int, const char *, int);
440 internal_proto(fstrcpy);
442 extern void cf_strcpy (char *, int, const char *);
443 internal_proto(cf_strcpy);
447 extern void init_units (void);
448 internal_proto(init_units);
450 extern void close_units (void);
451 internal_proto(close_units);
455 extern void stop_numeric (GFC_INTEGER_4);
456 iexport_proto(stop_numeric);
458 /* reshape_packed.c */
460 extern void reshape_packed (char *, index_type, const char *, index_type,
461 const char *, index_type);
462 internal_proto(reshape_packed);
464 /* Repacking functions. */
466 /* ??? These eight aren't currently used by the compiler, though we
467 certainly could do so. */
468 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
469 internal_proto(internal_pack_4);
471 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
472 internal_proto(internal_pack_8);
474 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
475 internal_proto(internal_pack_c4);
477 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
478 internal_proto(internal_pack_c8);
480 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
481 internal_proto(internal_unpack_4);
483 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
484 internal_proto(internal_unpack_8);
486 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
487 internal_proto(internal_unpack_c4);
489 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
490 internal_proto(internal_unpack_c8);
492 /* string_intrinsics.c */
494 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
495 GFC_INTEGER_4, const char *);
496 iexport_proto(compare_string);
500 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
502 iexport_proto(random_seed);
506 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
507 internal_proto(normalize_r4_i4);
509 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
510 internal_proto(normalize_r8_i8);
514 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
516 extern index_type size0 (const array_t * array);
517 iexport_proto(size0);
519 #endif /* LIBGFOR_H */