OSDN Git Service

* flow.c (clear_log_links): Use free_INSN_LIST_list, not
[pf3gnuchains/gcc-fork.git] / gcc / system.h
1 /* Get common system includes and various definitions and declarations based
2    on autoconf macros.
3    Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING.  If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.  */
21
22
23 #ifndef GCC_SYSTEM_H
24 #define GCC_SYSTEM_H
25
26 /* This is the location of the online document giving information how
27    to report bugs. If you change this string, also check for strings
28    not under control of the preprocessor.  */
29 #define GCCBUGURL "<URL:http://www.gnu.org/software/gcc/bugs.html>"
30
31 /* We must include stdarg.h/varargs.h before stdio.h.  */
32 #ifdef ANSI_PROTOTYPES
33 #include <stdarg.h>
34 #else
35 #include <varargs.h>
36 #endif
37
38 #ifndef va_copy
39 # ifdef __va_copy
40 #   define va_copy(d,s)  __va_copy((d),(s))
41 # else
42 #   define va_copy(d,s)  ((d) = (s))
43 # endif
44 #endif
45
46 #ifdef HAVE_STDDEF_H
47 # include <stddef.h>
48 #endif
49
50 #include <stdio.h>
51
52 /* Define a generic NULL if one hasn't already been defined.  */
53 #ifndef NULL
54 #define NULL 0
55 #endif
56
57 /* The compiler is not a multi-threaded application and therefore we
58    do not have to use the locking functions.  In fact, using the locking
59    functions can cause the compiler to be significantly slower under
60    I/O bound conditions (such as -g -O0 on very large source files).
61
62    HAVE_DECL_PUTC_UNLOCKED actually indicates whether or not the stdio
63    code is multi-thread safe by default.  If it is set to 0, then do
64    not worry about using the _unlocked functions.
65    
66    fputs_unlocked, fwrite_unlocked, and fprintf_unlocked are
67    extensions and need to be prototyped by hand (since we do not
68    define _GNU_SOURCE).  */
69
70 #if defined HAVE_DECL_PUTC_UNLOCKED && HAVE_DECL_PUTC_UNLOCKED
71
72 # ifdef HAVE_PUTC_UNLOCKED
73 #  undef putc
74 #  define putc(C, Stream) putc_unlocked (C, Stream)
75 # endif
76 # ifdef HAVE_FPUTC_UNLOCKED
77 #  undef fputc
78 #  define fputc(C, Stream) fputc_unlocked (C, Stream)
79 # endif
80
81 # ifdef HAVE_FPUTS_UNLOCKED
82 #  undef fputs
83 #  define fputs(String, Stream) fputs_unlocked (String, Stream)
84 #  if defined (HAVE_DECL_FPUTS_UNLOCKED) && !HAVE_DECL_FPUTS_UNLOCKED
85 extern int fputs_unlocked PARAMS ((const char *, FILE *));
86 #  endif
87 # endif
88 # ifdef HAVE_FWRITE_UNLOCKED
89 #  undef fwrite
90 #  define fwrite(Ptr, Size, N, Stream) fwrite_unlocked (Ptr, Size, N, Stream)
91 #  if defined (HAVE_DECL_FWRITE_UNLOCKED) && !HAVE_DECL_FWRITE_UNLOCKED
92 extern int fwrite_unlocked PARAMS ((const PTR, size_t, size_t, FILE *));
93 #  endif
94 # endif
95 # ifdef HAVE_FPRINTF_UNLOCKED
96 #  undef fprintf
97 /* We can't use a function-like macro here because we don't know if
98    we have varargs macros.  */
99 #  define fprintf fprintf_unlocked
100 #  if defined (HAVE_DECL_FPRINTF_UNLOCKED) && !HAVE_DECL_FPRINTF_UNLOCKED
101 extern int fprintf_unlocked PARAMS ((FILE *, const char *, ...));
102 #  endif
103 # endif
104
105 #endif
106
107 /* There are an extraordinary number of issues with <ctype.h>.
108    The last straw is that it varies with the locale.  Use libiberty's
109    replacement instead.  */
110 #include <safe-ctype.h>
111
112 #include <sys/types.h>
113
114 #include <errno.h>
115
116 #if !defined (errno) && defined (HAVE_DECL_ERRNO) && !HAVE_DECL_ERRNO
117 extern int errno;
118 #endif
119
120 #ifdef STRING_WITH_STRINGS
121 # include <string.h>
122 # include <strings.h>
123 #else
124 # ifdef HAVE_STRING_H
125 #  include <string.h>
126 # else
127 #  ifdef HAVE_STRINGS_H
128 #   include <strings.h>
129 #  endif
130 # endif
131 #endif
132
133 #ifdef HAVE_STDLIB_H
134 # include <stdlib.h>
135 #endif
136
137 /* If we don't have an overriding definition, set SUCCESS_EXIT_CODE and
138    FATAL_EXIT_CODE to EXIT_SUCCESS and EXIT_FAILURE respectively,
139    or 0 and 1 if those macros are not defined.  */
140 #ifndef SUCCESS_EXIT_CODE
141 # ifdef EXIT_SUCCESS
142 #  define SUCCESS_EXIT_CODE EXIT_SUCCESS
143 # else
144 #  define SUCCESS_EXIT_CODE 0
145 # endif
146 #endif
147
148 #ifndef FATAL_EXIT_CODE
149 # ifdef EXIT_FAILURE
150 #  define FATAL_EXIT_CODE EXIT_FAILURE
151 # else
152 #  define FATAL_EXIT_CODE 1
153 # endif
154 #endif
155
156 #ifdef HAVE_UNISTD_H
157 # include <unistd.h>
158 #endif
159
160 #ifdef HAVE_SYS_PARAM_H
161 # include <sys/param.h>
162 #endif
163
164 #if HAVE_LIMITS_H
165 # include <limits.h>
166 #endif
167
168 /* Get definitions of HOST_WIDE_INT and HOST_WIDEST_INT.  */
169 #include "hwint.h"
170
171 /* A macro to determine whether a VALUE lies inclusively within a
172    certain range without evaluating the VALUE more than once.  This
173    macro won't warn if the VALUE is unsigned and the LOWER bound is
174    zero, as it would e.g. with "VALUE >= 0 && ...".  Note the LOWER
175    bound *is* evaluated twice, and LOWER must not be greater than
176    UPPER.  However the bounds themselves can be either positive or
177    negative.  */
178 #define IN_RANGE(VALUE, LOWER, UPPER) \
179   ((unsigned HOST_WIDE_INT)((VALUE) - (LOWER)) <= ((UPPER) - (LOWER)))
180
181 /* Infrastructure for defining missing _MAX and _MIN macros.  Note that
182    macros defined with these cannot be used in #if.  */
183
184 /* The extra casts work around common compiler bugs.  */
185 #define INTTYPE_SIGNED(t) (! ((t) 0 < (t) -1))
186 /* The outer cast is needed to work around a bug in Cray C 5.0.3.0.
187    It is necessary at least when t == time_t.  */
188 #define INTTYPE_MINIMUM(t) ((t) (INTTYPE_SIGNED (t) \
189                              ? ~ (t) 0 << (sizeof(t) * CHAR_BIT - 1) : (t) 0))
190 #define INTTYPE_MAXIMUM(t) ((t) (~ (t) 0 - INTTYPE_MINIMUM (t)))
191
192 /* Use that infrastructure to provide a few constants.  */
193 #ifndef UCHAR_MAX
194 # define UCHAR_MAX INTTYPE_MAXIMUM (unsigned char)
195 #endif
196
197 #ifdef TIME_WITH_SYS_TIME
198 # include <sys/time.h>
199 # include <time.h>
200 #else
201 # if HAVE_SYS_TIME_H
202 #  include <sys/time.h>
203 # else
204 #  ifdef HAVE_TIME_H
205 #   include <time.h>
206 #  endif
207 # endif
208 #endif
209
210 #ifdef HAVE_FCNTL_H
211 # include <fcntl.h>
212 #else
213 # ifdef HAVE_SYS_FILE_H
214 #  include <sys/file.h>
215 # endif
216 #endif
217
218 #ifndef SEEK_SET
219 # define SEEK_SET 0
220 # define SEEK_CUR 1
221 # define SEEK_END 2
222 #endif
223 #ifndef F_OK
224 # define F_OK 0
225 # define X_OK 1
226 # define W_OK 2
227 # define R_OK 4
228 #endif
229 #ifndef O_RDONLY
230 # define O_RDONLY 0
231 #endif
232 #ifndef O_WRONLY
233 # define O_WRONLY 1
234 #endif
235
236 /* Some systems define these in, e.g., param.h.  We undefine these names
237    here to avoid the warnings.  We prefer to use our definitions since we
238    know they are correct.  */
239
240 #undef MIN
241 #undef MAX
242 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
243 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
244
245 /* Returns the least number N such that N * Y >= X.  */
246 #define CEIL(x,y) (((x) + (y) - 1) / (y))
247
248 #ifdef HAVE_SYS_WAIT_H
249 #include <sys/wait.h>
250 #endif
251
252 #ifndef WIFSIGNALED
253 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
254 #endif
255 #ifndef WTERMSIG
256 #define WTERMSIG(S) ((S) & 0x7f)
257 #endif
258 #ifndef WIFEXITED
259 #define WIFEXITED(S) (((S) & 0xff) == 0)
260 #endif
261 #ifndef WEXITSTATUS
262 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
263 #endif
264 #ifndef WSTOPSIG
265 #define WSTOPSIG WEXITSTATUS
266 #endif
267
268 /* The HAVE_DECL_* macros are three-state, undefined, 0 or 1.  If they
269    are defined to 0 then we must provide the relevant declaration
270    here.  These checks will be in the undefined state while configure
271    is running so be careful to test "defined (HAVE_DECL_*)".  */
272
273 #if defined (HAVE_DECL_ATOF) && !HAVE_DECL_ATOF
274 extern double atof PARAMS ((const char *));
275 #endif
276
277 #if defined (HAVE_DECL_ATOL) && !HAVE_DECL_ATOL
278 extern long atol PARAMS ((const char *));
279 #endif
280
281 #if defined (HAVE_DECL_FREE) && !HAVE_DECL_FREE
282 extern void free PARAMS ((PTR));
283 #endif
284
285 #if defined (HAVE_DECL_GETCWD) && !HAVE_DECL_GETCWD
286 extern char *getcwd PARAMS ((char *, size_t));
287 #endif
288
289 #if defined (HAVE_DECL_GETENV) && !HAVE_DECL_GETENV
290 extern char *getenv PARAMS ((const char *));
291 #endif
292
293 #if defined (HAVE_DECL_GETOPT) && !HAVE_DECL_GETOPT
294 extern int getopt PARAMS ((int, char * const *, const char *));
295 #endif
296
297 #if defined (HAVE_DECL_GETWD) && !HAVE_DECL_GETWD
298 extern char *getwd PARAMS ((char *));
299 #endif
300
301 #if defined (HAVE_DECL_SBRK) && !HAVE_DECL_SBRK
302 extern PTR sbrk PARAMS ((int));
303 #endif
304
305 #if defined (HAVE_DECL_STRSTR) && !HAVE_DECL_STRSTR
306 extern char *strstr PARAMS ((const char *, const char *));
307 #endif
308
309 #ifdef HAVE_MALLOC_H
310 #include <malloc.h>
311 #endif
312
313 #if defined (HAVE_DECL_MALLOC) && !HAVE_DECL_MALLOC
314 extern PTR malloc PARAMS ((size_t));
315 #endif
316
317 #if defined (HAVE_DECL_CALLOC) && !HAVE_DECL_CALLOC
318 extern PTR calloc PARAMS ((size_t, size_t));
319 #endif
320
321 #if defined (HAVE_DECL_REALLOC) && !HAVE_DECL_REALLOC
322 extern PTR realloc PARAMS ((PTR, size_t));
323 #endif
324
325 /* If the system doesn't provide strsignal, we get it defined in
326    libiberty but no declaration is supplied.  */
327 #ifndef HAVE_STRSIGNAL
328 # ifndef strsignal
329 extern const char *strsignal PARAMS ((int));
330 # endif
331 #endif
332
333 #ifdef HAVE_GETRLIMIT
334 # if defined (HAVE_DECL_GETRLIMIT) && !HAVE_DECL_GETRLIMIT
335 #  ifndef getrlimit
336 #   ifdef ANSI_PROTOTYPES
337 struct rlimit;
338 #   endif
339 extern int getrlimit PARAMS ((int, struct rlimit *));
340 #  endif
341 # endif
342 #endif
343
344 #ifdef HAVE_SETRLIMIT
345 # if defined (HAVE_DECL_SETRLIMIT) && !HAVE_DECL_SETRLIMIT
346 #  ifndef setrlimit
347 #   ifdef ANSI_PROTOTYPES
348 struct rlimit;
349 #   endif
350 extern int setrlimit PARAMS ((int, const struct rlimit *));
351 #  endif
352 # endif
353 #endif
354
355 /* HAVE_VOLATILE only refers to the stage1 compiler.  We also check
356    __STDC__ and assume gcc sets it and has volatile in stage >=2.  */
357 #if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile)
358 #define volatile
359 #endif
360
361 #if defined (HAVE_DECL_ABORT) && !HAVE_DECL_ABORT
362 extern void abort PARAMS ((void));
363 #endif
364
365 /* 1 if we have C99 designated initializers.  */
366 #if !defined(HAVE_DESIGNATED_INITIALIZERS)
367 #define HAVE_DESIGNATED_INITIALIZERS \
368   ((GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L))
369 #endif
370
371 /* 1 if we have _Bool.  */
372 #ifndef HAVE__BOOL
373 # define HAVE__BOOL \
374    ((GCC_VERSION >= 3000) || (__STDC_VERSION__ >= 199901L))
375 #endif
376
377
378 #if HAVE_SYS_STAT_H
379 # include <sys/stat.h>
380 #endif
381
382 /* Test if something is a normal file.  */
383 #ifndef S_ISREG
384 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
385 #endif
386
387 /* Test if something is a directory.  */
388 #ifndef S_ISDIR
389 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
390 #endif
391
392 /* Test if something is a character special file.  */
393 #ifndef S_ISCHR
394 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
395 #endif
396
397 /* Test if something is a block special file.  */
398 #ifndef S_ISBLK
399 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
400 #endif
401
402 /* Test if something is a socket.  */
403 #ifndef S_ISSOCK
404 # ifdef S_IFSOCK
405 #   define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
406 # else
407 #   define S_ISSOCK(m) 0
408 # endif
409 #endif
410
411 /* Test if something is a FIFO.  */
412 #ifndef S_ISFIFO
413 # ifdef S_IFIFO
414 #  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
415 # else
416 #  define S_ISFIFO(m) 0
417 # endif
418 #endif
419
420 /* Approximate O_NONBLOCK.  */
421 #ifndef O_NONBLOCK
422 #define O_NONBLOCK O_NDELAY
423 #endif
424
425 /* Approximate O_NOCTTY.  */
426 #ifndef O_NOCTTY
427 #define O_NOCTTY 0
428 #endif
429
430 /* Define well known filenos if the system does not define them.  */
431 #ifndef STDIN_FILENO
432 # define STDIN_FILENO   0
433 #endif
434 #ifndef STDOUT_FILENO
435 # define STDOUT_FILENO  1
436 #endif
437 #ifndef STDERR_FILENO
438 # define STDERR_FILENO  2
439 #endif
440
441 /* Some systems have mkdir that takes a single argument.  */
442 #ifdef MKDIR_TAKES_ONE_ARG
443 # define mkdir(a,b) mkdir(a)
444 #endif
445
446 /* Provide a way to print an address via printf.  */
447 #ifndef HOST_PTR_PRINTF
448 # ifdef HAVE_PRINTF_PTR
449 #  define HOST_PTR_PRINTF "%p"
450 # else
451 #  define HOST_PTR_PRINTF \
452     (sizeof (int) == sizeof (char *) ? "%x" \
453      : sizeof (long) == sizeof (char *) ? "%lx" : "%llx")
454 # endif
455 #endif /* ! HOST_PTR_PRINTF */
456
457 /* By default, colon separates directories in a path.  */
458 #ifndef PATH_SEPARATOR
459 #define PATH_SEPARATOR ':'
460 #endif
461
462 #ifndef DIR_SEPARATOR
463 #define DIR_SEPARATOR '/'
464 #endif
465
466 /* Define IS_DIR_SEPARATOR.  */
467 #ifndef DIR_SEPARATOR_2
468 # define IS_DIR_SEPARATOR(CH) ((CH) == DIR_SEPARATOR)
469 #else /* DIR_SEPARATOR_2 */
470 # define IS_DIR_SEPARATOR(CH) \
471         (((CH) == DIR_SEPARATOR) || ((CH) == DIR_SEPARATOR_2))
472 #endif /* DIR_SEPARATOR_2 */
473
474 /* Say how to test for an absolute pathname.  On Unix systems, this is if
475    it starts with a leading slash or a '$', the latter meaning the value of
476    an environment variable is to be used.  On machien with DOS-based
477    file systems, it is also absolute if it starts with a drive identifier.  */
478 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
479 #define IS_ABSOLUTE_PATHNAME(STR) \
480   (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$' \
481    || ((STR)[0] != '\0' && (STR)[1] == ':' && IS_DIR_SEPARATOR ((STR)[2])))
482 #else
483 #define IS_ABSOLUTE_PATHNAME(STR) \
484   (IS_DIR_SEPARATOR ((STR)[0]) || (STR)[0] == '$')
485 #endif
486
487 /* Get libiberty declarations.  */
488 #include "libiberty.h"
489 #include "symcat.h"
490
491 /* Provide a default for the HOST_BIT_BUCKET.
492    This suffices for POSIX-like hosts.  */
493
494 #ifndef HOST_BIT_BUCKET
495 #define HOST_BIT_BUCKET "/dev/null"
496 #endif
497
498 /* Be conservative and only use enum bitfields with GCC.
499    FIXME: provide a complete autoconf test for buggy enum bitfields.  */
500
501 #if (GCC_VERSION > 2000)
502 #define ENUM_BITFIELD(TYPE) enum TYPE
503 #else
504 #define ENUM_BITFIELD(TYPE) unsigned int
505 #endif
506
507 #ifndef offsetof
508 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *)0)->MEMBER)
509 #endif
510
511 /* Traditional C cannot initialize union members of structs.  Provide
512    a macro which expands appropriately to handle it.  This only works
513    if you intend to initalize the union member to zero since it relies
514    on default initialization to zero in the traditional C case.  */
515 #ifdef __STDC__
516 #define UNION_INIT_ZERO , {0}
517 #else
518 #define UNION_INIT_ZERO
519 #endif
520
521 /* Various error reporting routines want to use __FUNCTION__.  */
522 #if (GCC_VERSION < 2007)
523 #ifndef __FUNCTION__
524 #define __FUNCTION__ "?"
525 #endif /* ! __FUNCTION__ */
526 #endif
527
528 /* __builtin_expect(A, B) evaluates to A, but notifies the compiler that
529    the most likely value of A is B.  This feature was added at some point
530    between 2.95 and 3.0.  Let's use 3.0 as the lower bound for now.  */
531 #if (GCC_VERSION < 3000)
532 #define __builtin_expect(a, b) (a)
533 #endif
534
535 /* Provide some sort of boolean type.  We use stdbool.h if it's
536   available.  This must be after all inclusion of system headers,
537   as some of them will mess us up.  */
538 #undef bool
539 #undef true
540 #undef false
541 #undef TRUE
542 #undef FALSE
543
544 #ifdef HAVE_STDBOOL_H
545 # include <stdbool.h>
546 #else
547 # if !HAVE__BOOL
548 typedef char _Bool;
549 # endif
550 # define bool _Bool
551 # define true 1
552 # define false 0
553 #endif
554
555 #define TRUE true
556 #define FALSE false
557
558 /* Provide three core typedefs used by everything, if we are compiling
559    GCC.  These used to be found in rtl.h and tree.h, but this is no
560    longer practical.  */
561 #ifdef IN_GCC
562 struct rtx_def;
563 struct rtvec_def;
564 union tree_node;
565 typedef struct rtx_def *rtx;
566 typedef struct rtvec_def *rtvec;
567 typedef union tree_node *tree;
568 #endif
569
570 /* As the last action in this file, we poison the identifiers that
571    shouldn't be used.  Note, luckily gcc-3.0's token-based integrated
572    preprocessor won't trip on poisoned identifiers that arrive from
573    the expansion of macros.  E.g. #define strrchr rindex, won't error
574    if rindex is poisoned after this directive is issued and later on
575    strrchr is called.
576
577    Note: We define bypass macros for the few cases where we really
578    want to use the libc memory allocation routines.  Otherwise we
579    insist you use the "x" versions from libiberty.  */
580
581 #define really_call_malloc malloc
582 #define really_call_calloc calloc
583 #define really_call_realloc realloc
584
585 #if (GCC_VERSION >= 3000)
586
587 /* Note autoconf checks for prototype declarations and includes
588    system.h while doing so.  Only poison these tokens if actually
589    compiling gcc, so that the autoconf declaration tests for malloc
590    etc don't spuriously fail.  */
591 #ifdef IN_GCC
592 #undef malloc
593 #undef realloc
594 #undef calloc
595 #undef strdup
596  #pragma GCC poison malloc realloc calloc strdup
597
598 /* Old target macros that have moved to the target hooks structure.  */
599  #pragma GCC poison ASM_OPEN_PAREN ASM_CLOSE_PAREN                      \
600         FUNCTION_PROLOGUE FUNCTION_EPILOGUE                             \
601         FUNCTION_END_PROLOGUE FUNCTION_BEGIN_EPILOGUE                   \
602         DECL_MACHINE_ATTRIBUTES COMP_TYPE_ATTRIBUTES INSERT_ATTRIBUTES  \
603         VALID_MACHINE_DECL_ATTRIBUTE VALID_MACHINE_TYPE_ATTRIBUTE       \
604         SET_DEFAULT_TYPE_ATTRIBUTES SET_DEFAULT_DECL_ATTRIBUTES         \
605         MERGE_MACHINE_TYPE_ATTRIBUTES MERGE_MACHINE_DECL_ATTRIBUTES     \
606         MD_INIT_BUILTINS MD_EXPAND_BUILTIN
607 #endif /* IN_GCC */
608
609 /* Note: not all uses of the `index' token (e.g. variable names and
610    structure members) have been eliminated.  */
611 #undef bcopy
612 #undef bzero
613 #undef bcmp
614 #undef rindex
615  #pragma GCC poison bcopy bzero bcmp rindex
616
617 #endif /* GCC >= 3.0 */
618
619 #endif /* ! GCC_SYSTEM_H */