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. */
39 #define M_PI 3.14159265358979323846264338327
45 #define complex __complex__
49 #include "c99_protos.h"
58 #include <sys/types.h>
60 typedef off_t gfc_offset
;
63 #define NULL (void *) 0
67 #define __attribute__(x)
70 /* For a library, a standard prefix is a requirement in order to partition
71 the namespace. IPREFIX is for symbols intended to be internal to the
73 #define PREFIX(x) _gfortran_ ## x
74 #define IPREFIX(x) _gfortrani_ ## x
76 /* Magic to rename a symbol at the compiler level. You continue to refer
77 to the symbol as OLD in the source, but it'll be named NEW in the asm. */
78 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
79 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
80 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
82 /* There are several classifications of routines:
84 (1) Symbols used only within the library,
85 (2) Symbols to be exported from the library,
86 (3) Symbols to be exported from the library, but
87 also used inside the library.
89 By telling the compiler about these different classifications we can
90 tightly control the interface seen by the user, and get better code
91 from the compiler at the same time.
93 One of the following should be used immediately after the declaration
96 internal_proto Marks a symbol used only within the library,
97 and adds IPREFIX to the assembly-level symbol
98 name. The later is important for maintaining
99 the namespace partition for the static library.
101 export_proto Marks a symbol to be exported, and adds PREFIX
102 to the assembly-level symbol name.
104 export_proto_np Marks a symbol to be exported without adding PREFIX.
106 iexport_proto Marks a function to be exported, but with the
107 understanding that it can be used inside as well.
109 iexport_data_proto Similarly, marks a data symbol to be exported.
110 Unfortunately, some systems can't play the hidden
111 symbol renaming trick on data symbols, thanks to
112 the horribleness of COPY relocations.
114 If iexport_proto or iexport_data_proto is used, you must also use
115 iexport or iexport_data after the *definition* of the symbol. */
117 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
118 # define internal_proto(x) \
119 sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
121 # define internal_proto(x) sym_rename(x, IPREFIX(x))
124 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
125 # define export_proto(x) sym_rename(x, PREFIX(x))
126 # define export_proto_np(x) extern char swallow_semicolon
127 # define iexport_proto(x) internal_proto(x)
128 # define iexport(x) iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x))
129 # define iexport1(x,p,y) iexport2(x,p,y)
130 # define iexport2(x,p,y) \
131 extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y)))
132 /* ??? We're not currently building a dll, and it's wrong to add dllexport
133 to objects going into a static library archive. */
134 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
135 # define export_proto_np(x) extern __typeof(x) x __attribute__((dllexport))
136 # define export_proto(x) sym_rename(x, PREFIX(x)) __attribute__((dllexport))
137 # define iexport_proto(x) export_proto(x)
138 # define iexport(x) extern char swallow_semicolon
140 # define export_proto(x) sym_rename(x, PREFIX(x))
141 # define export_proto_np(x) extern char swallow_semicolon
142 # define iexport_proto(x) export_proto(x)
143 # define iexport(x) extern char swallow_semicolon
146 /* TODO: detect the case when we *can* hide the symbol. */
147 #define iexport_data_proto(x) export_proto(x)
148 #define iexport_data(x) extern char swallow_semicolon
150 /* The only reliable way to get the offset of a field in a struct
151 in a system independent way is via this macro. */
153 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
156 /* The isfinite macro is only available with C99, but some non-C99
157 systems still provide fpclassify, and there is a `finite' function
160 Also, isfinite is broken on Cygwin.
162 When isfinite is not available, try to use one of the
163 alternatives, or bail out. */
165 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
169 #if defined(HAVE_BROKEN_ISNAN)
173 #if defined(HAVE_BROKEN_FPCLASSIFY)
177 #if !defined(isfinite)
178 #if !defined(fpclassify)
179 #define isfinite(x) ((x) - (x) == 0)
181 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
182 #endif /* !defined(fpclassify) */
183 #endif /* !defined(isfinite) */
186 #if !defined(fpclassify)
187 #define isnan(x) ((x) != (x))
189 #define isnan(x) (fpclassify(x) == FP_NAN)
190 #endif /* !defined(fpclassify) */
191 #endif /* !defined(isfinite) */
193 /* TODO: find the C99 version of these an move into above ifdef. */
194 #define REALPART(z) (__real__(z))
195 #define IMAGPART(z) (__imag__(z))
196 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
200 /* Define the type used for the current record number for large file I/O.
201 The size must be consistent with the size defined on the compiler side. */
202 #ifdef HAVE_GFC_INTEGER_8
203 typedef GFC_INTEGER_8 GFC_IO_INT
;
205 #ifdef HAVE_GFC_INTEGER_4
206 typedef GFC_INTEGER_4 GFC_IO_INT
;
208 #error "GFC_INTEGER_4 should be available for the library to compile".
212 /* The following two definitions must be consistent with the types used
214 /* The type used of array indices, amongst other things. */
215 typedef ssize_t index_type
;
216 /* The type used for the lengths of character variables. */
217 typedef GFC_INTEGER_4 gfc_charlen_type
;
219 /* This will be 0 on little-endian machines and one on big-endian machines. */
220 extern int l8_to_l4_offset
;
221 internal_proto(l8_to_l4_offset
);
223 #define GFOR_POINTER_L8_TO_L4(p8) \
224 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
226 #define GFC_INTEGER_1_HUGE \
227 (GFC_INTEGER_1)((((GFC_UINTEGER_1)1) << 7) - 1)
228 #define GFC_INTEGER_2_HUGE \
229 (GFC_INTEGER_2)((((GFC_UINTEGER_2)1) << 15) - 1)
230 #define GFC_INTEGER_4_HUGE \
231 (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
232 #define GFC_INTEGER_8_HUGE \
233 (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
234 #ifdef HAVE_GFC_INTEGER_16
235 #define GFC_INTEGER_16_HUGE \
236 (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
239 #define GFC_REAL_4_HUGE FLT_MAX
240 #define GFC_REAL_8_HUGE DBL_MAX
241 #ifdef HAVE_GFC_REAL_10
242 #define GFC_REAL_10_HUGE LDBL_MAX
244 #ifdef HAVE_GFC_REAL_16
245 #define GFC_REAL_16_HUGE LDBL_MAX
248 #define GFC_REAL_4_DIGITS FLT_MANT_DIG
249 #define GFC_REAL_8_DIGITS DBL_MANT_DIG
250 #ifdef HAVE_GFC_REAL_10
251 #define GFC_REAL_10_DIGITS LDBL_MANT_DIG
253 #ifdef HAVE_GFC_REAL_16
254 #define GFC_REAL_16_DIGITS LDBL_MANT_DIG
257 #define GFC_REAL_4_RADIX FLT_RADIX
258 #define GFC_REAL_8_RADIX FLT_RADIX
259 #ifdef HAVE_GFC_REAL_10
260 #define GFC_REAL_10_RADIX FLT_RADIX
262 #ifdef HAVE_GFC_REAL_16
263 #define GFC_REAL_16_RADIX FLT_RADIX
266 #ifndef GFC_MAX_DIMENSIONS
267 #define GFC_MAX_DIMENSIONS 7
270 typedef struct descriptor_dimension
276 descriptor_dimension
;
278 #define GFC_ARRAY_DESCRIPTOR(r, type) \
283 descriptor_dimension dim[r];\
286 /* Commonly used array descriptor types. */
287 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, void) gfc_array_void
;
288 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, char) gfc_array_char
;
289 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_1
) gfc_array_i1
;
290 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_2
) gfc_array_i2
;
291 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_4
) gfc_array_i4
;
292 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_8
) gfc_array_i8
;
293 #ifdef HAVE_GFC_INTEGER_16
294 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_INTEGER_16
) gfc_array_i16
;
296 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_4
) gfc_array_r4
;
297 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_8
) gfc_array_r8
;
298 #ifdef HAVE_GFC_REAL_10
299 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_10
) gfc_array_r10
;
301 #ifdef HAVE_GFC_REAL_16
302 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_REAL_16
) gfc_array_r16
;
304 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_4
) gfc_array_c4
;
305 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_8
) gfc_array_c8
;
306 #ifdef HAVE_GFC_COMPLEX_10
307 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_10
) gfc_array_c10
;
309 #ifdef HAVE_GFC_COMPLEX_16
310 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_COMPLEX_16
) gfc_array_c16
;
312 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_4
) gfc_array_l4
;
313 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_8
) gfc_array_l8
;
314 #ifdef HAVE_GFC_LOGICAL_16
315 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, GFC_LOGICAL_16
) gfc_array_l16
;
318 #define GFC_DTYPE_RANK_MASK 0x07
319 #define GFC_DTYPE_TYPE_SHIFT 3
320 #define GFC_DTYPE_TYPE_MASK 0x38
321 #define GFC_DTYPE_SIZE_SHIFT 6
325 GFC_DTYPE_UNKNOWN
= 0,
327 /* TODO: recognize logical types. */
335 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
336 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
337 >> GFC_DTYPE_TYPE_SHIFT)
338 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
339 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
340 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
342 /* Runtime library include. */
343 #define stringize(x) expand_macro(x)
344 #define expand_macro(x) # x
346 /* Runtime options structure. */
350 int stdin_unit
, stdout_unit
, stderr_unit
, optional_plus
;
351 int allocate_init_flag
, allocate_init_value
;
355 const char *separator
;
358 int use_stderr
, all_unbuffered
, default_recl
;
360 int fpu_round
, fpu_precision
, fpe
;
366 extern options_t options
;
367 internal_proto(options
);
370 /* Compile-time options that will influence the library. */
378 size_t record_marker
;
379 int max_subrecord_length
;
383 extern compile_options_t compile_options
;
384 internal_proto(compile_options
);
386 extern void init_compile_options (void);
387 internal_proto(init_compile_options
);
389 #define GFC_MAX_SUBRECORD_LENGTH 2147483639 /* 2**31 - 9 */
391 /* Structure for statement options. */
400 /* Runtime errors. The EOR and EOF errors are required to be negative. */
404 ERROR_FIRST
= -3, /* Marker for the first error. */
407 ERROR_OK
= 0, /* Indicates success, must be zero. */
408 ERROR_OS
, /* Operating system error, more info in errno. */
409 ERROR_OPTION_CONFLICT
,
411 ERROR_MISSING_OPTION
,
426 ERROR_LAST
/* Not a real error, the last error # + 1. */
431 /* Flags to specify which standard/extension contains a feature.
432 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
433 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
434 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
435 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
436 /* Note that no features were obsoleted nor deleted in F2003. */
437 #define GFC_STD_F95 (1<<3) /* New in F95. */
438 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
439 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
440 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
442 /* Bitmasks for the various FPE that can be enabled.
443 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
444 #define GFC_FPE_INVALID (1<<0)
445 #define GFC_FPE_DENORMAL (1<<1)
446 #define GFC_FPE_ZERO (1<<2)
447 #define GFC_FPE_OVERFLOW (1<<3)
448 #define GFC_FPE_UNDERFLOW (1<<4)
449 #define GFC_FPE_PRECISION (1<<5)
451 /* This is returned by notification_std to know if, given the flags
452 that were given (-std=, -pedantic) we should issue an error, a warning
455 { SILENT
, WARNING
, ERROR
}
458 /* This is returned by notify_std and several io functions. */
460 { SUCCESS
= 1, FAILURE
}
463 /* The filename and line number don't go inside the globals structure.
464 They are set by the rest of the program and must be linked to. */
466 /* Location of the current library call (optional). */
467 extern unsigned line
;
468 iexport_data_proto(line
);
470 extern char *filename
;
471 iexport_data_proto(filename
);
473 /* Avoid conflicting prototypes of alloca() in system headers by using
474 GCC's builtin alloca(). */
475 #define gfc_alloca(x) __builtin_alloca(x)
480 extern void stupid_function_name_for_static_linking (void);
481 internal_proto(stupid_function_name_for_static_linking
);
483 struct st_parameter_common
;
484 extern void library_start (struct st_parameter_common
*);
485 internal_proto(library_start
);
487 #define library_end()
489 extern void set_args (int, char **);
490 export_proto(set_args
);
492 extern void get_args (int *, char ***);
493 internal_proto(get_args
);
497 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
498 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
499 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
500 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
502 extern const char *gfc_itoa (GFC_INTEGER_LARGEST
, char *, size_t);
503 internal_proto(gfc_itoa
);
505 extern const char *xtoa (GFC_UINTEGER_LARGEST
, char *, size_t);
506 internal_proto(xtoa
);
508 extern void os_error (const char *) __attribute__ ((noreturn
));
509 internal_proto(os_error
);
511 extern void show_locus (struct st_parameter_common
*);
512 internal_proto(show_locus
);
514 extern void runtime_error (const char *) __attribute__ ((noreturn
));
515 iexport_proto(runtime_error
);
517 extern void internal_error (struct st_parameter_common
*, const char *)
518 __attribute__ ((noreturn
));
519 internal_proto(internal_error
);
521 extern const char *get_oserror (void);
522 internal_proto(get_oserror
);
524 extern void sys_exit (int) __attribute__ ((noreturn
));
525 internal_proto(sys_exit
);
527 extern int st_printf (const char *, ...)
528 __attribute__ ((format (printf
, 1, 2)));
529 internal_proto(st_printf
);
531 extern void st_sprintf (char *, const char *, ...)
532 __attribute__ ((format (printf
, 2, 3)));
533 internal_proto(st_sprintf
);
535 extern const char *translate_error (int);
536 internal_proto(translate_error
);
538 extern void generate_error (struct st_parameter_common
*, int, const char *);
539 internal_proto(generate_error
);
541 extern try notify_std (struct st_parameter_common
*, int, const char *);
542 internal_proto(notify_std
);
546 extern void set_fpu (void);
547 internal_proto(set_fpu
);
551 extern void *get_mem (size_t) __attribute__ ((malloc
));
552 internal_proto(get_mem
);
554 extern void free_mem (void *);
555 internal_proto(free_mem
);
557 extern void *internal_malloc_size (size_t);
558 internal_proto(internal_malloc_size
);
560 extern void internal_free (void *);
561 iexport_proto(internal_free
);
565 extern int check_buffered (int);
566 internal_proto(check_buffered
);
568 extern void init_variables (void);
569 internal_proto(init_variables
);
571 extern void show_variables (void);
572 internal_proto(show_variables
);
576 extern int find_option (struct st_parameter_common
*, const char *, int,
577 const st_option
*, const char *);
578 internal_proto(find_option
);
580 extern int fstrlen (const char *, int);
581 internal_proto(fstrlen
);
583 extern void fstrcpy (char *, int, const char *, int);
584 internal_proto(fstrcpy
);
586 extern void cf_strcpy (char *, int, const char *);
587 internal_proto(cf_strcpy
);
591 extern void init_units (void);
592 internal_proto(init_units
);
594 extern void close_units (void);
595 internal_proto(close_units
);
597 extern int unit_to_fd (int);
598 internal_proto(unit_to_fd
);
602 extern void stop_numeric (GFC_INTEGER_4
);
603 iexport_proto(stop_numeric
);
605 /* reshape_packed.c */
607 extern void reshape_packed (char *, index_type
, const char *, index_type
,
608 const char *, index_type
);
609 internal_proto(reshape_packed
);
611 /* Repacking functions. */
613 /* ??? These aren't currently used by the compiler, though we
614 certainly could do so. */
615 GFC_INTEGER_4
*internal_pack_4 (gfc_array_i4
*);
616 internal_proto(internal_pack_4
);
618 GFC_INTEGER_8
*internal_pack_8 (gfc_array_i8
*);
619 internal_proto(internal_pack_8
);
621 #if defined HAVE_GFC_INTEGER_16
622 GFC_INTEGER_16
*internal_pack_16 (gfc_array_i16
*);
623 internal_proto(internal_pack_16
);
626 GFC_COMPLEX_4
*internal_pack_c4 (gfc_array_c4
*);
627 internal_proto(internal_pack_c4
);
629 GFC_COMPLEX_8
*internal_pack_c8 (gfc_array_c8
*);
630 internal_proto(internal_pack_c8
);
632 #if defined HAVE_GFC_COMPLEX_10
633 GFC_COMPLEX_10
*internal_pack_c10 (gfc_array_c10
*);
634 internal_proto(internal_pack_c10
);
637 extern void internal_unpack_4 (gfc_array_i4
*, const GFC_INTEGER_4
*);
638 internal_proto(internal_unpack_4
);
640 extern void internal_unpack_8 (gfc_array_i8
*, const GFC_INTEGER_8
*);
641 internal_proto(internal_unpack_8
);
643 #if defined HAVE_GFC_INTEGER_16
644 extern void internal_unpack_16 (gfc_array_i16
*, const GFC_INTEGER_16
*);
645 internal_proto(internal_unpack_16
);
648 extern void internal_unpack_c4 (gfc_array_c4
*, const GFC_COMPLEX_4
*);
649 internal_proto(internal_unpack_c4
);
651 extern void internal_unpack_c8 (gfc_array_c8
*, const GFC_COMPLEX_8
*);
652 internal_proto(internal_unpack_c8
);
654 #if defined HAVE_GFC_COMPLEX_10
655 extern void internal_unpack_c10 (gfc_array_c10
*, const GFC_COMPLEX_10
*);
656 internal_proto(internal_unpack_c10
);
659 #if defined HAVE_GFC_COMPLEX_16
660 extern void internal_unpack_c16 (gfc_array_c16
*, const GFC_COMPLEX_16
*);
661 internal_proto(internal_unpack_c16
);
664 /* string_intrinsics.c */
666 extern GFC_INTEGER_4
compare_string (GFC_INTEGER_4
, const char *,
667 GFC_INTEGER_4
, const char *);
668 iexport_proto(compare_string
);
672 extern void random_seed (GFC_INTEGER_4
* size
, gfc_array_i4
* put
,
674 iexport_proto(random_seed
);
678 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS
, void) array_t
;
680 extern index_type
size0 (const array_t
* array
);
681 iexport_proto(size0
);
683 #endif /* LIBGFOR_H */