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 /* Define the type used for the current record number for large file I/O.
200 The size must be consistent with the size defined on the compiler side. */
201 #ifdef HAVE_GFC_INTEGER_8
202 typedef GFC_INTEGER_8 GFC_LARGE_IO_INT;
204 #ifdef HAVE_GFC_INTEGER_4
205 typedef GFC_INTEGER_4 GFC_LARGE_IO_INT;
207 #error "GFC_INTEGER_4 should be available for the library to compile".
211 /* The following two definitions must be consistent with the types used
213 /* The type used of array indices, amongst other things. */
214 typedef ssize_t index_type;
215 /* The type used for the lengths of character variables. */
216 typedef GFC_INTEGER_4 gfc_charlen_type;
218 /* This will be 0 on little-endian machines and one on big-endian machines. */
219 extern int l8_to_l4_offset;
220 internal_proto(l8_to_l4_offset);
222 #define GFOR_POINTER_L8_TO_L4(p8) \
223 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
225 #define GFC_INTEGER_4_HUGE \
226 (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
227 #define GFC_INTEGER_8_HUGE \
228 (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
229 #ifdef HAVE_GFC_INTEGER_16
230 #define GFC_INTEGER_16_HUGE \
231 (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
234 #define GFC_REAL_4_HUGE FLT_MAX
235 #define GFC_REAL_8_HUGE DBL_MAX
236 #ifdef HAVE_GFC_REAL_10
237 #define GFC_REAL_10_HUGE LDBL_MAX
239 #ifdef HAVE_GFC_REAL_16
240 #define GFC_REAL_16_HUGE LDBL_MAX
243 #ifndef GFC_MAX_DIMENSIONS
244 #define GFC_MAX_DIMENSIONS 7
247 typedef struct descriptor_dimension
253 descriptor_dimension;
255 #define GFC_ARRAY_DESCRIPTOR(r, type) \
260 descriptor_dimension dim[r];\
263 /* Commonly used array descriptor types. */
264 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
265 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
266 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
267 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
268 #ifdef HAVE_GFC_INTEGER_16
269 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_16) gfc_array_i16;
271 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
272 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
273 #ifdef HAVE_GFC_REAL_10
274 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_10) gfc_array_r10;
276 #ifdef HAVE_GFC_REAL_16
277 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_16) gfc_array_r16;
279 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
280 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
281 #ifdef HAVE_GFC_COMPLEX_10
282 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_10) gfc_array_c10;
284 #ifdef HAVE_GFC_COMPLEX_16
285 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_16) gfc_array_c16;
287 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
288 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
289 #ifdef HAVE_GFC_LOGICAL_16
290 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_16) gfc_array_l16;
293 #define GFC_DTYPE_RANK_MASK 0x07
294 #define GFC_DTYPE_TYPE_SHIFT 3
295 #define GFC_DTYPE_TYPE_MASK 0x38
296 #define GFC_DTYPE_SIZE_SHIFT 6
300 GFC_DTYPE_UNKNOWN = 0,
302 /* TODO: recognize logical types. */
310 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
311 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
312 >> GFC_DTYPE_TYPE_SHIFT)
313 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
314 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
315 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
317 /* Runtime library include. */
318 #define stringize(x) expand_macro(x)
319 #define expand_macro(x) # x
321 /* Runtime options structure. */
325 int stdin_unit, stdout_unit, stderr_unit, optional_plus;
326 int allocate_init_flag, allocate_init_value;
330 const char *separator;
333 int use_stderr, all_unbuffered, default_recl;
335 int fpu_round, fpu_precision, fpe;
341 extern options_t options;
342 internal_proto(options);
345 /* Compile-time options that will influence the library. */
353 size_t record_marker;
357 extern compile_options_t compile_options;
358 internal_proto(compile_options);
360 extern void init_compile_options (void);
361 internal_proto(init_compile_options);
364 /* Structure for statement options. */
373 /* Runtime errors. The EOR and EOF errors are required to be negative. */
377 ERROR_FIRST = -3, /* Marker for the first error. */
380 ERROR_OK = 0, /* Indicates success, must be zero. */
381 ERROR_OS, /* Operating system error, more info in errno. */
382 ERROR_OPTION_CONFLICT,
384 ERROR_MISSING_OPTION,
397 ERROR_LAST /* Not a real error, the last error # + 1. */
402 /* Flags to specify which standard/extension contains a feature.
403 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
404 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
405 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
406 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
407 /* Note that no features were obsoleted nor deleted in F2003. */
408 #define GFC_STD_F95 (1<<3) /* New in F95. */
409 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
410 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
411 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
413 /* Bitmasks for the various FPE that can be enabled.
414 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
415 #define GFC_FPE_INVALID (1<<0)
416 #define GFC_FPE_DENORMAL (1<<1)
417 #define GFC_FPE_ZERO (1<<2)
418 #define GFC_FPE_OVERFLOW (1<<3)
419 #define GFC_FPE_UNDERFLOW (1<<4)
420 #define GFC_FPE_PRECISION (1<<5)
422 /* This is returned by notification_std to know if, given the flags
423 that were given (-std=, -pedantic) we should issue an error, a warning
426 { SILENT, WARNING, ERROR }
429 /* This is returned by notify_std and several io functions. */
431 { SUCCESS = 1, FAILURE }
434 /* The filename and line number don't go inside the globals structure.
435 They are set by the rest of the program and must be linked to. */
437 /* Location of the current library call (optional). */
438 extern unsigned line;
439 iexport_data_proto(line);
441 extern char *filename;
442 iexport_data_proto(filename);
444 /* Avoid conflicting prototypes of alloca() in system headers by using
445 GCC's builtin alloca(). */
446 #define gfc_alloca(x) __builtin_alloca(x)
451 extern void stupid_function_name_for_static_linking (void);
452 internal_proto(stupid_function_name_for_static_linking);
454 struct st_parameter_common;
455 extern void library_start (struct st_parameter_common *);
456 internal_proto(library_start);
458 #define library_end()
460 extern void set_args (int, char **);
461 export_proto(set_args);
463 extern void get_args (int *, char ***);
464 internal_proto(get_args);
468 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
469 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
470 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
471 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
473 extern const char *gfc_itoa (GFC_INTEGER_LARGEST, char *, size_t);
474 internal_proto(gfc_itoa);
476 extern const char *xtoa (GFC_UINTEGER_LARGEST, char *, size_t);
477 internal_proto(xtoa);
479 extern void os_error (const char *) __attribute__ ((noreturn));
480 internal_proto(os_error);
482 extern void show_locus (struct st_parameter_common *);
483 internal_proto(show_locus);
485 extern void runtime_error (const char *) __attribute__ ((noreturn));
486 iexport_proto(runtime_error);
488 extern void internal_error (struct st_parameter_common *, const char *)
489 __attribute__ ((noreturn));
490 internal_proto(internal_error);
492 extern const char *get_oserror (void);
493 internal_proto(get_oserror);
495 extern void sys_exit (int) __attribute__ ((noreturn));
496 internal_proto(sys_exit);
498 extern int st_printf (const char *, ...)
499 __attribute__ ((format (printf, 1, 2)));
500 internal_proto(st_printf);
502 extern void st_sprintf (char *, const char *, ...)
503 __attribute__ ((format (printf, 2, 3)));
504 internal_proto(st_sprintf);
506 extern const char *translate_error (int);
507 internal_proto(translate_error);
509 extern void generate_error (struct st_parameter_common *, int, const char *);
510 internal_proto(generate_error);
512 extern try notify_std (struct st_parameter_common *, int, const char *);
513 internal_proto(notify_std);
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);
568 extern int unit_to_fd (int);
569 internal_proto(unit_to_fd);
573 extern void stop_numeric (GFC_INTEGER_4);
574 iexport_proto(stop_numeric);
576 /* reshape_packed.c */
578 extern void reshape_packed (char *, index_type, const char *, index_type,
579 const char *, index_type);
580 internal_proto(reshape_packed);
582 /* Repacking functions. */
584 /* ??? These aren't currently used by the compiler, though we
585 certainly could do so. */
586 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
587 internal_proto(internal_pack_4);
589 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
590 internal_proto(internal_pack_8);
592 #if defined HAVE_GFC_INTEGER_16
593 GFC_INTEGER_16 *internal_pack_16 (gfc_array_i16 *);
594 internal_proto(internal_pack_16);
597 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
598 internal_proto(internal_pack_c4);
600 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
601 internal_proto(internal_pack_c8);
603 #if defined HAVE_GFC_COMPLEX_10
604 GFC_COMPLEX_10 *internal_pack_c10 (gfc_array_c10 *);
605 internal_proto(internal_pack_c10);
608 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
609 internal_proto(internal_unpack_4);
611 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
612 internal_proto(internal_unpack_8);
614 #if defined HAVE_GFC_INTEGER_16
615 extern void internal_unpack_16 (gfc_array_i16 *, const GFC_INTEGER_16 *);
616 internal_proto(internal_unpack_16);
619 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
620 internal_proto(internal_unpack_c4);
622 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
623 internal_proto(internal_unpack_c8);
625 #if defined HAVE_GFC_COMPLEX_10
626 extern void internal_unpack_c10 (gfc_array_c10 *, const GFC_COMPLEX_10 *);
627 internal_proto(internal_unpack_c10);
630 /* string_intrinsics.c */
632 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
633 GFC_INTEGER_4, const char *);
634 iexport_proto(compare_string);
638 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
640 iexport_proto(random_seed);
644 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
645 internal_proto(normalize_r4_i4);
647 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
648 internal_proto(normalize_r8_i8);
652 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
654 extern index_type size0 (const array_t * array);
655 iexport_proto(size0);
657 #endif /* LIBGFOR_H */