Do not bias REG_N_REFS by loop_depth when optimising for size.
[official-gcc.git] / gcc / system.h
blob89d389cac9ac9ccaf63f362f7c753f577bee813a
1 /* Get common system includes and various definitions and declarations based
2 on autoconf macros.
3 Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #ifndef __GCC_SYSTEM_H__
24 #define __GCC_SYSTEM_H__
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>"
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
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
46 #include <stdio.h>
48 /* Define a generic NULL if one hasn't already been defined. */
49 #ifndef NULL
50 #define NULL 0
51 #endif
53 /* The compiler is not a multi-threaded application and therefore we
54 do not have to use the locking functions.
56 NEED_DECLARATION_PUTC_UNLOCKED actually indicates whether or not
57 the IO code is multi-thread safe by default. If it is not declared,
58 then do not worry about using the _unlocked functions.
60 fputs_unlocked is an extension and needs to be prototyped specially. */
62 #if defined HAVE_PUTC_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
63 # undef putc
64 # define putc(C, Stream) putc_unlocked (C, Stream)
65 #endif
66 #if defined HAVE_FPUTC_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
67 # undef fputc
68 # define fputc(C, Stream) fputc_unlocked (C, Stream)
69 #endif
70 #if defined HAVE_FPUTS_UNLOCKED && !defined NEED_DECLARATION_PUTC_UNLOCKED
71 # undef fputs
72 # define fputs(String, Stream) fputs_unlocked (String, Stream)
73 # ifdef NEED_DECLARATION_FPUTS_UNLOCKED
74 extern int fputs_unlocked PARAMS ((const char *, FILE *));
75 # endif
76 #endif
78 #include <ctype.h>
80 /* Jim Meyering writes:
82 "... Some ctype macros are valid only for character codes that
83 isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
84 using /bin/cc or gcc but without giving an ansi option). So, all
85 ctype uses should be through macros like ISPRINT... If
86 STDC_HEADERS is defined, then autoconf has verified that the ctype
87 macros don't need to be guarded with references to isascii. ...
88 Defining isascii to 1 should let any compiler worth its salt
89 eliminate the && through constant folding."
91 Bruno Haible adds:
93 "... Furthermore, isupper(c) etc. have an undefined result if c is
94 outside the range -1 <= c <= 255. One is tempted to write isupper(c)
95 with c being of type `char', but this is wrong if c is an 8-bit
96 character >= 128 which gets sign-extended to a negative value.
97 The macro ISUPPER protects against this as well." */
99 #if defined (STDC_HEADERS) || (!defined (isascii) && !defined (HAVE_ISASCII)) || defined(HOST_EBCDIC)
100 # define IN_CTYPE_DOMAIN(c) 1
101 #else
102 # define IN_CTYPE_DOMAIN(c) isascii(c)
103 #endif
105 /* The ctype functions are often implemented as macros which do
106 lookups in arrays using the parameter as the offset. If the ctype
107 function parameter is a char, then gcc will (appropriately) warn
108 that a "subscript has type char". Using a (signed) char as a subscript
109 is bad because you may get negative offsets and thus it is not 8-bit
110 safe. The CTYPE_CONV macro ensures that the parameter is cast to an
111 unsigned char when a char is passed in. When an int is passed in, the
112 parameter is left alone so we don't lose EOF.
115 #define CTYPE_CONV(CH) \
116 (sizeof(CH) == sizeof(unsigned char) ? (int)(unsigned char)(CH) : (int)(CH))
119 /* WARNING! The argument to the ctype replacement macros below is
120 evaluated more than once so it must not have side effects! */
122 #ifdef isblank
123 # define ISBLANK(c) (IN_CTYPE_DOMAIN (c) && isblank (CTYPE_CONV(c)))
124 #else
125 # define ISBLANK(c) ((c) == ' ' || (c) == '\t')
126 #endif
127 #ifdef isgraph
128 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isgraph (CTYPE_CONV(c)))
129 #else
130 # define ISGRAPH(c) (IN_CTYPE_DOMAIN (c) && isprint (CTYPE_CONV(c)) && !isspace (CTYPE_CONV(c)))
131 #endif
133 #define ISPRINT(c) (IN_CTYPE_DOMAIN (c) && isprint (CTYPE_CONV(c)))
134 #define ISALNUM(c) (IN_CTYPE_DOMAIN (c) && isalnum (CTYPE_CONV(c)))
135 #define ISALPHA(c) (IN_CTYPE_DOMAIN (c) && isalpha (CTYPE_CONV(c)))
136 #define ISCNTRL(c) (IN_CTYPE_DOMAIN (c) && iscntrl (CTYPE_CONV(c)))
137 #define ISLOWER(c) (IN_CTYPE_DOMAIN (c) && islower (CTYPE_CONV(c)))
138 #define ISPUNCT(c) (IN_CTYPE_DOMAIN (c) && ispunct (CTYPE_CONV(c)))
139 #define ISSPACE(c) (IN_CTYPE_DOMAIN (c) && isspace (CTYPE_CONV(c)))
140 #define ISUPPER(c) (IN_CTYPE_DOMAIN (c) && isupper (CTYPE_CONV(c)))
141 #define ISXDIGIT(c) (IN_CTYPE_DOMAIN (c) && isxdigit (CTYPE_CONV(c)))
142 #define ISDIGIT_LOCALE(c) (IN_CTYPE_DOMAIN (c) && isdigit (CTYPE_CONV(c)))
144 #if STDC_HEADERS
145 # define TOLOWER(c) (tolower (CTYPE_CONV(c)))
146 # define TOUPPER(c) (toupper (CTYPE_CONV(c)))
147 #else
148 # define TOLOWER(c) (ISUPPER (c) ? tolower (CTYPE_CONV(c)) : (c))
149 # define TOUPPER(c) (ISLOWER (c) ? toupper (CTYPE_CONV(c)) : (c))
150 #endif
152 /* ISDIGIT differs from ISDIGIT_LOCALE, as follows:
153 - Its arg may be any int or unsigned int; it need not be an unsigned char.
154 - It's guaranteed to evaluate its argument exactly once.
155 - It's typically faster.
156 Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
157 only '0' through '9' are digits. Prefer ISDIGIT to ISDIGIT_LOCALE unless
158 it's important to use the locale's definition of `digit' even when the
159 host does not conform to Posix. */
160 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
162 /* Define a default escape character; its different for EBCDIC. */
163 #ifndef TARGET_ESC
164 #define TARGET_ESC 033
165 #endif
167 #include <sys/types.h>
169 #include <errno.h>
171 #ifndef errno
172 extern int errno;
173 #endif
175 #ifdef STRING_WITH_STRINGS
176 # include <string.h>
177 # include <strings.h>
178 #else
179 # ifdef HAVE_STRING_H
180 # include <string.h>
181 # else
182 # ifdef HAVE_STRINGS_H
183 # include <strings.h>
184 # endif
185 # endif
186 #endif
188 #ifdef HAVE_STDLIB_H
189 # include <stdlib.h>
190 # ifdef USE_C_ALLOCA
191 /* Note that systems that use glibc have a <stdlib.h> that includes
192 <alloca.h> that defines alloca, so let USE_C_ALLOCA override this. */
193 # undef alloca
194 #endif
195 #endif
197 #ifdef HAVE_UNISTD_H
198 # include <unistd.h>
199 #endif
201 #ifdef HAVE_SYS_PARAM_H
202 # include <sys/param.h>
203 #endif
205 #if HAVE_LIMITS_H
206 # include <limits.h>
207 #endif
209 /* Find HOST_WIDEST_INT and set its bit size, type and print macros.
210 It will be the largest integer mode supported by the host which may
211 (or may not) be larger than HOST_WIDE_INT. This must appear after
212 <limits.h> since we only use `long long' if its bigger than a
213 `long' and also if it is supported by macros in limits.h. For old
214 hosts which don't have a limits.h (and thus won't include it in
215 stage2 cause we don't rerun configure) we assume gcc supports long
216 long.) Note, you won't get these defined if you don't include
217 {ht}config.h before this file to set the HOST_BITS_PER_* macros. */
219 #ifndef HOST_WIDEST_INT
220 # if defined (HOST_BITS_PER_LONG) && defined (HOST_BITS_PER_LONGLONG)
221 # if (HOST_BITS_PER_LONGLONG > HOST_BITS_PER_LONG) && (defined (LONG_LONG_MAX) || defined (LONGLONG_MAX) || defined (LLONG_MAX) || defined (__GNUC__))
222 # define HOST_BITS_PER_WIDEST_INT HOST_BITS_PER_LONGLONG
223 # define HOST_WIDEST_INT long long
224 # define HOST_WIDEST_INT_PRINT_DEC "%lld"
225 # define HOST_WIDEST_INT_PRINT_UNSIGNED "%llu"
226 # define HOST_WIDEST_INT_PRINT_HEX "0x%llx"
227 # else
228 # define HOST_BITS_PER_WIDEST_INT HOST_BITS_PER_LONG
229 # define HOST_WIDEST_INT long
230 # define HOST_WIDEST_INT_PRINT_DEC "%ld"
231 # define HOST_WIDEST_INT_PRINT_UNSIGNED "%lu"
232 # define HOST_WIDEST_INT_PRINT_HEX "0x%lx"
233 # endif /*(long long>long) && (LONG_LONG_MAX||LONGLONG_MAX||LLONG_MAX||GNUC)*/
234 # endif /* defined(HOST_BITS_PER_LONG) && defined(HOST_BITS_PER_LONGLONG) */
235 #endif /* ! HOST_WIDEST_INT */
237 #ifdef TIME_WITH_SYS_TIME
238 # include <sys/time.h>
239 # include <time.h>
240 #else
241 # if HAVE_SYS_TIME_H
242 # include <sys/time.h>
243 # else
244 # ifdef HAVE_TIME_H
245 # include <time.h>
246 # endif
247 # endif
248 #endif
250 #ifdef HAVE_FCNTL_H
251 # include <fcntl.h>
252 #else
253 # ifdef HAVE_SYS_FILE_H
254 # include <sys/file.h>
255 # endif
256 #endif
258 #ifndef SEEK_SET
259 # define SEEK_SET 0
260 # define SEEK_CUR 1
261 # define SEEK_END 2
262 #endif
263 #ifndef F_OK
264 # define F_OK 0
265 # define X_OK 1
266 # define W_OK 2
267 # define R_OK 4
268 #endif
269 #ifndef O_RDONLY
270 # define O_RDONLY 0
271 #endif
272 #ifndef O_WRONLY
273 # define O_WRONLY 1
274 #endif
276 /* Some systems define these in, e.g., param.h. We undefine these names
277 here to avoid the warnings. We prefer to use our definitions since we
278 know they are correct. */
280 #undef MIN
281 #undef MAX
282 #define MIN(X,Y) ((X) < (Y) ? (X) : (Y))
283 #define MAX(X,Y) ((X) > (Y) ? (X) : (Y))
285 /* Returns the least number N such that N * Y >= X. */
286 #define CEIL(x,y) (((x) + (y) - 1) / (y))
288 #ifdef HAVE_SYS_WAIT_H
289 #include <sys/wait.h>
290 #endif
292 #ifndef WIFSIGNALED
293 #define WIFSIGNALED(S) (((S) & 0xff) != 0 && ((S) & 0xff) != 0x7f)
294 #endif
295 #ifndef WTERMSIG
296 #define WTERMSIG(S) ((S) & 0x7f)
297 #endif
298 #ifndef WIFEXITED
299 #define WIFEXITED(S) (((S) & 0xff) == 0)
300 #endif
301 #ifndef WEXITSTATUS
302 #define WEXITSTATUS(S) (((S) & 0xff00) >> 8)
303 #endif
304 #ifndef WSTOPSIG
305 #define WSTOPSIG WEXITSTATUS
306 #endif
310 #ifndef bcopy
311 # ifdef HAVE_BCOPY
312 # ifdef NEED_DECLARATION_BCOPY
313 extern void bcopy PARAMS ((const PTR, PTR, size_t));
314 # endif
315 # else /* ! HAVE_BCOPY */
316 # define bcopy(src,dst,len) memmove((dst),(src),(len))
317 # endif
318 #endif
320 #ifndef bcmp
321 # ifdef HAVE_BCMP
322 # ifdef NEED_DECLARATION_BCMP
323 extern int bcmp PARAMS ((const PTR, const PTR, size_t));
324 # endif
325 # else /* ! HAVE_BCMP */
326 # define bcmp(left,right,len) memcmp ((left),(right),(len))
327 # endif
328 #endif
330 #ifndef bzero
331 # ifdef HAVE_BZERO
332 # ifdef NEED_DECLARATION_BZERO
333 extern void bzero PARAMS ((PTR, size_t));
334 # endif
335 # else /* ! HAVE_BZERO */
336 # define bzero(dst,len) memset ((dst),0,(len))
337 # endif
338 #endif
340 #ifndef index
341 # ifdef HAVE_INDEX
342 # ifdef NEED_DECLARATION_INDEX
343 extern char *index PARAMS ((const char *, int));
344 # endif
345 # else /* ! HAVE_INDEX */
346 # define index strchr
347 # endif
348 #endif
350 #ifndef rindex
351 # ifdef HAVE_RINDEX
352 # ifdef NEED_DECLARATION_RINDEX
353 extern char *rindex PARAMS ((const char *, int));
354 # endif
355 # else /* ! HAVE_RINDEX */
356 # define rindex strrchr
357 # endif
358 #endif
360 #ifdef NEED_DECLARATION_ATOF
361 extern double atof PARAMS ((const char *));
362 #endif
364 #ifdef NEED_DECLARATION_ATOL
365 extern long atol PARAMS ((const char *));
366 #endif
368 #ifdef NEED_DECLARATION_FREE
369 extern void free PARAMS ((PTR));
370 #endif
372 #ifdef NEED_DECLARATION_GETCWD
373 extern char *getcwd PARAMS ((char *, size_t));
374 #endif
376 #ifdef NEED_DECLARATION_GETENV
377 extern char *getenv PARAMS ((const char *));
378 #endif
380 #ifdef NEED_DECLARATION_GETWD
381 extern char *getwd PARAMS ((char *));
382 #endif
384 #ifdef NEED_DECLARATION_SBRK
385 extern PTR sbrk PARAMS ((int));
386 #endif
388 #ifdef NEED_DECLARATION_STRSTR
389 extern char *strstr PARAMS ((const char *, const char *));
390 #endif
392 #ifdef HAVE_MALLOC_H
393 #include <malloc.h>
394 #endif
396 #ifdef NEED_DECLARATION_MALLOC
397 extern PTR malloc PARAMS ((size_t));
398 #endif
400 #ifdef NEED_DECLARATION_CALLOC
401 extern PTR calloc PARAMS ((size_t, size_t));
402 #endif
404 #ifdef NEED_DECLARATION_REALLOC
405 extern PTR realloc PARAMS ((PTR, size_t));
406 #endif
408 /* If the system doesn't provide strsignal, we get it defined in
409 libiberty but no declaration is supplied. */
410 #ifdef NEED_DECLARATION_STRSIGNAL
411 # ifndef strsignal
412 extern const char *strsignal PARAMS ((int));
413 # endif
414 #endif
416 #ifdef HAVE_GETRLIMIT
417 # ifdef NEED_DECLARATION_GETRLIMIT
418 # ifndef getrlimit
419 # ifdef ANSI_PROTOTYPES
420 struct rlimit;
421 # endif
422 extern int getrlimit PARAMS ((int, struct rlimit *));
423 # endif
424 # endif
425 #endif
427 #ifdef HAVE_SETRLIMIT
428 # ifdef NEED_DECLARATION_SETRLIMIT
429 # ifndef setrlimit
430 # ifdef ANSI_PROTOTYPES
431 struct rlimit;
432 # endif
433 extern int setrlimit PARAMS ((int, const struct rlimit *));
434 # endif
435 # endif
436 #endif
438 /* HAVE_VOLATILE only refers to the stage1 compiler. We also check
439 __STDC__ and assume gcc sets it and has volatile in stage >=2. */
440 #if !defined(HAVE_VOLATILE) && !defined(__STDC__) && !defined(volatile)
441 #define volatile
442 #endif
444 #ifdef NEED_DECLARATION_ABORT
445 extern void abort PARAMS ((void));
446 #endif
448 /* Define a STRINGIFY macro that's right for ANSI or traditional C.
449 Note: if the argument passed to STRINGIFY is itself a macro, eg
450 #define foo bar, STRINGIFY(foo) will produce "foo", not "bar".
451 Although the __STDC__ case could be made to expand this via a layer
452 of indirection, the traditional C case can not do so. Therefore
453 this behavior is not supported. */
454 #ifndef STRINGIFY
455 # ifdef HAVE_STRINGIZE
456 # define STRINGIFY(STRING) #STRING
457 # else
458 # define STRINGIFY(STRING) "STRING"
459 # endif
460 #endif /* ! STRINGIFY */
462 #if HAVE_SYS_STAT_H
463 # include <sys/stat.h>
464 #endif
466 /* Test if something is a normal file. */
467 #ifndef S_ISREG
468 #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
469 #endif
471 /* Test if something is a directory. */
472 #ifndef S_ISDIR
473 #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
474 #endif
476 /* Test if something is a character special file. */
477 #ifndef S_ISCHR
478 #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
479 #endif
481 /* Test if something is a block special file. */
482 #ifndef S_ISBLK
483 #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
484 #endif
486 /* Test if something is a socket. */
487 #ifndef S_ISSOCK
488 # ifdef S_IFSOCK
489 # define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
490 # else
491 # define S_ISSOCK(m) 0
492 # endif
493 #endif
495 /* Test if something is a FIFO. */
496 #ifndef S_ISFIFO
497 # ifdef S_IFIFO
498 # define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
499 # else
500 # define S_ISFIFO(m) 0
501 # endif
502 #endif
504 /* Approximate O_NONBLOCK. */
505 #ifndef O_NONBLOCK
506 #define O_NONBLOCK O_NDELAY
507 #endif
509 /* Approximate O_NOCTTY. */
510 #ifndef O_NOCTTY
511 #define O_NOCTTY 0
512 #endif
514 /* Define well known filenos if the system does not define them. */
515 #ifndef STDIN_FILENO
516 # define STDIN_FILENO 0
517 #endif
518 #ifndef STDOUT_FILENO
519 # define STDOUT_FILENO 1
520 #endif
521 #ifndef STDERR_FILENO
522 # define STDERR_FILENO 2
523 #endif
525 /* Some systems have mkdir that takes a single argument. */
526 #ifdef MKDIR_TAKES_ONE_ARG
527 # define mkdir(a,b) mkdir(a)
528 #endif
530 /* Provide a way to print an address via printf. */
531 #ifndef HOST_PTR_PRINTF
532 # ifdef HAVE_PRINTF_PTR
533 # define HOST_PTR_PRINTF "%p"
534 # else
535 # define HOST_PTR_PRINTF \
536 (sizeof (int) == sizeof (char *) ? "%x" \
537 : sizeof (long) == sizeof (char *) ? "%lx" : "%llx")
538 # endif
539 #endif /* ! HOST_PTR_PRINTF */
541 /* By default, colon separates directories in a path. */
542 #ifndef PATH_SEPARATOR
543 #define PATH_SEPARATOR ':'
544 #endif
546 #ifndef DIR_SEPARATOR
547 #define DIR_SEPARATOR '/'
548 #endif
550 /* Define IS_DIR_SEPARATOR. */
551 #ifndef DIR_SEPARATOR_2
552 # define IS_DIR_SEPARATOR(ch) ((ch) == DIR_SEPARATOR)
553 #else /* DIR_SEPARATOR_2 */
554 # define IS_DIR_SEPARATOR(ch) \
555 (((ch) == DIR_SEPARATOR) || ((ch) == DIR_SEPARATOR_2))
556 #endif /* DIR_SEPARATOR_2 */
558 /* Get libiberty declarations. */
559 #include "libiberty.h"
561 /* Make sure that ONLY_INT_FIELDS has an integral value. */
562 #ifdef ONLY_INT_FIELDS
563 #undef ONLY_INT_FIELDS
564 #define ONLY_INT_FIELDS 1
565 #else
566 #define ONLY_INT_FIELDS 0
567 #endif
569 /* Enumerated bitfields are safe to use unless we've been explictly told
570 otherwise or if they are signed. */
572 #define USE_ENUM_BITFIELDS (__GNUC__ || (!ONLY_INT_FIELDS && ENUM_BITFIELDS_ARE_UNSIGNED))
574 #if USE_ENUM_BITFIELDS
575 #define ENUM_BITFIELD(TYPE) enum TYPE
576 #else
577 #define ENUM_BITFIELD(TYPE) unsigned int
578 #endif
581 #endif /* __GCC_SYSTEM_H__ */