1 /* Check system header files for ISO 9899:1990 (ISO C) compliance.
2 Copyright (C) 1996, 1997 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Jens Schweikhardt <schweikh@noc.dfn.de>, 1996.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public License
8 as published by the Free Software Foundation; either version 2 of
9 the License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be
12 useful, but WITHOUT ANY WARRANTY; without even the implied warranty
13 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with the GNU C Library; see the file COPYING.LIB. If
18 not, write to the Free Software Foundation, Inc., 59 Temple Place -
19 Suite 330, Boston, MA 02111-1307, USA. */
21 /* This is a simple minded program that tries to find illegal macro
22 definitions in system header files. Illegal macro definitions are
23 those not from the implementation namespace (i.e. not starting with
24 an underscore) or not matching any identifier mandated by The
25 Standard. Some common macro names are considered okay, e.g. all those
26 beginning with E (which may be defined in <errno.h>) or ending in
27 _MAX. See the arrays prefix[] and suffix[] below for details.
29 In a compliant implementation no other macros can be defined, because
30 you could write strictly conforming programs that may fail to compile
31 due to syntax errors: suppose <stdio.h> defines PIPE_BUF, then the
35 #include <stdio.h> <- or where the bogus macro is defined
38 #define XSTR(x) STR(x)
42 assert (strcmp ("PIPE_BUF", XSTR (PIPE_BUF)) == 0);
46 is expected to compile and meet the assertion. If it does not, your
47 compiler compiles some other language than Standard C.
50 This program calls gcc to get the list of defined macros. If you
51 don't have gcc you're probably out of luck unless your compiler or
52 preprocessor has something similar to gcc's -dM option. Tune
53 PRINT_MACROS in this case. This program assumes headers are found
54 under /usr/include and that there is a writable /tmp directory.
55 Tune SYSTEM_INCLUDE and TMPFILE if your system differs.
56 #define BROKEN_SYSTEM if system(NULL) bombs -- one more violation
60 Each header file name is printed, followed by illegal macro names
61 and their definition. For the above example, you would see
66 If your implementation does not yet incorporate Amendment 1 you
67 will see messages about iso646.h, wctype.h and wchar.h not being
71 # define _GNU_SOURCE 1
78 #define TMPFILE "/tmp/macros"
79 #define HEADER_MAX 256
81 /* ISO C header names including Amendment 1 (without ".h" suffix). */
82 static char *header
[] =
84 "assert", "ctype", "errno", "float", "iso646", "limits", "locale",
85 "math", "setjmp", "signal", "stdarg", "stddef", "stdio", "stdlib",
86 "string", "time", "wchar", "wctype"
89 /* Macros with these prefixes are considered okay. */
90 static char *prefix
[] =
92 "_", "E", "is", "str", "mem", "SIG", "FLT_", "DBL_", "LDBL_",
96 /* Macros with these suffixes are considered okay. Will not work for
97 parametrized macros with arguments. */
98 static char *suffix
[] =
103 /* These macros are considered okay. In fact, these are just more prefixes. */
104 static char *macros
[] =
106 "BUFSIZ", "CHAR_BIT", "CHAR_MAX", "CHAR_MIN", "CLOCKS_PER_SEC",
107 "DBL_DIG", "DBL_EPSILON", "DBL_MANT_DIG", "DBL_MAX",
108 "DBL_MAX_10_EXP", "DBL_MAX_EXP", "DBL_MIN", "DBL_MIN_10_EXP",
109 "DBL_MIN_EXP", "EDOM", "EILSEQ", "EOF", "ERANGE", "EXIT_FAILURE",
110 "EXIT_SUCCESS", "FILENAME_MAX", "FLT_DIG", "FLT_EPSILON",
111 "FLT_MANT_DIG", "FLT_MAX", "FLT_MAX_10_EXP", "FLT_MAX_EXP",
112 "FLT_MIN", "FLT_MIN_10_EXP", "FLT_MIN_EXP", "FLT_RADIX",
113 "FLT_ROUNDS", "FOPEN_MAX", "HUGE_VAL", "INT_MAX", "INT_MIN",
114 "LC_ALL", "LC_COLLATE", "LC_CTYPE", "LC_MONETARY", "LC_NUMERIC",
115 "LC_TIME", "LDBL_DIG", "LDBL_EPSILON", "LDBL_MANT_DIG", "LDBL_MAX",
116 "LDBL_MAX_10_EXP", "LDBL_MAX_EXP", "LDBL_MIN", "LDBL_MIN_10_EXP",
117 "LDBL_MIN_EXP", "LONG_MAX", "LONG_MIN", "L_tmpnam", "MB_CUR_MAX",
118 "MB_LEN_MAX", "NDEBUG", "NULL", "RAND_MAX", "SCHAR_MAX",
119 "SCHAR_MIN", "SEEK_CUR", "SEEK_END", "SEEK_SET", "SHRT_MAX",
120 "SHRT_MIN", "SIGABRT", "SIGFPE", "SIGILL", "SIGINT", "SIGSEGV",
121 "SIGTERM", "SIG_DFL", "SIG_ERR", "SIG_IGN", "TMP_MAX", "UCHAR_MAX",
122 "UINT_MAX", "ULONG_MAX", "USHRT_MAX", "WCHAR_MAX", "WCHAR_MIN",
123 "WEOF", "_IOFBF", "_IOLBF", "_IONBF", "abort", "abs", "acos",
124 "acosf", "acosl", "and", "and_eq", "asctime", "asin", "asinf",
125 "asinl", "assert", "atan", "atan2", "atan2f", "atan2l", "atanf",
126 "atanl", "atexit", "atof", "atoi", "atol", "bitand", "bitor",
127 "bsearch", "btowc", "calloc", "ceil", "ceilf", "ceill", "clearerr",
128 "clock", "clock_t", "compl", "cos", "cosf", "cosh", "coshf",
129 "coshl", "cosl", "ctime", "difftime", "div", "div_t", "errno",
130 "exit", "exp", "expf", "expl", "fabs", "fabsf", "fabsl", "fclose",
131 "feof", "ferror", "fflush", "fgetc", "fgetpos", "fgets", "fgetwc",
132 "fgetws", "floor", "floorf", "floorl", "fmod", "fmodf", "fmodl",
133 "fopen", "fprintf", "fputc", "fputs", "fputwc", "fputws", "fread",
134 "free", "freopen", "frexp", "frexpf", "frexpl", "fscanf", "fseek",
135 "fsetpos", "ftell", "fwide", "fwprintf", "fwrite", "fwscanf",
136 "getc", "getchar", "getenv", "gets", "getwc", "getwchar", "gmtime",
137 "isalnum", "isalpha", "iscntrl", "isdigit", "isgraph", "islower",
138 "isprint", "ispunct", "isspace", "isupper", "iswalnum", "iswalpha",
139 "iswcntrl", "iswctype", "iswdigit", "iswgraph", "iswlower",
140 "iswprint", "iswpunct", "iswspace", "iswupper", "iswxdigit",
141 "isxdigit", "labs", "ldexp", "ldexpf", "ldexpl", "ldiv", "ldiv_t",
142 "localeconv", "localtime", "log", "log10", "log10f", "log10l",
143 "logf", "logl", "longjmp", "malloc", "mblen", "mbrlen", "mbrtowc",
144 "mbsinit", "mbsrtowcs", "mbstate_t", "mbstowcs", "mbtowc", "memchr",
145 "memcmp", "memcpy", "memmove", "memset", "mktime", "modf", "modff",
146 "modfl", "not", "not_eq", "offsetof", "or", "or_eq", "perror",
147 "pow", "powf", "powl", "printf", "ptrdiff_t", "putc", "putchar",
148 "puts", "putwc", "putwchar", "qsort", "raise", "rand", "realloc",
149 "remove", "rename", "rewind", "scanf", "setbuf", "setjmp",
150 "setlocale", "setvbuf", "sig_atomic_t", "signal", "sin", "sinf",
151 "sinh", "sinhf", "sinhl", "sinl", "size_t", "sprintf", "sqrt",
152 "sqrtf", "sqrtl", "srand", "sscanf", "stderr", "stdin", "stdout",
153 "strcat", "strchr", "strcmp", "strcoll", "strcpy", "strcspn",
154 "strerror", "strftime", "strlen", "strncat", "strncmp", "strncpy",
155 "strpbrk", "strrchr", "strspn", "strstr", "strtod", "strtok",
156 "strtol", "strtoul", "strxfrm", "swprintf", "swscanf", "system",
157 "tan", "tanf", "tanh", "tanhf", "tanhl", "tanl", "time", "time_t",
158 "tmpfile", "tmpnam", "tolower", "toupper", "towctrans", "towlower",
159 "towupper", "ungetc", "ungetwc", "va_arg", "va_end", "va_start",
160 "vfprintf", "vfwprintf", "vprintf", "vsprintf", "vswprintf",
161 "vwprintf", "wchar_t", "wcrtomb", "wcscat", "wcschr", "wcscmp",
162 "wcscoll", "wcscpy", "wcscspn", "wcsftime", "wcslen", "wcsncat",
163 "wcsncmp", "wcsncpy", "wcspbrk", "wcsrchr", "wcsrtombs", "wcsspn",
164 "wcsstr", "wcstod", "wcstok", "wcstol", "wcstombs", "wcstoul",
165 "wcsxfrm", "wctob", "wctomb", "wctrans", "wctrans_t", "wctype",
166 "wctype_t", "wint_t", "wmemchr", "wmemcmp", "wmemcpy", "wmemmove",
167 "wmemset", "wprintf", "wscanf", "xor", "xor_eq"
170 #define NUMBER_OF_HEADERS (sizeof header / sizeof *header)
171 #define NUMBER_OF_PREFIXES (sizeof prefix / sizeof *prefix)
172 #define NUMBER_OF_SUFFIXES (sizeof suffix / sizeof *suffix)
173 #define NUMBER_OF_MACROS (sizeof macros / sizeof *macros)
176 /* Format string to build command to invoke compiler. */
177 static const char fmt
[] = "\
178 echo \"#include <%s>\" |\
179 %s -E -dM -ansi -pedantic %s -D_LIBC -I. -I `%s --print-prog-name=include` -\
183 /* The compiler we use (given on the command line). */
185 /* The -I parameters for CC to find all headers. */
188 static const char **get_null_defines (void);
189 static int check_header (const char *, const char **);
192 main (int argc
, char *argv
[])
196 const char **ignore_list
;
198 CC
= argc
> 1 ? argv
[1] : "gcc";
199 INC
= argc
> 2 ? argv
[2] : "";
201 if (system (NULL
) == 0)
203 puts ("Sorry, no command processor.");
207 /* First get list of symbols which are defined by the compiler. */
208 ignore_list
= get_null_defines ();
210 for (h
= 0; h
< NUMBER_OF_HEADERS
; ++h
)
212 char file_name
[HEADER_MAX
];
213 sprintf (file_name
, "%s.h", header
[h
]);
214 result
|= check_header (file_name
, ignore_list
);
217 /* The test suite should return errors but for now this is not
218 practical. Give a warning and ask the user to correct the bugs. */
224 get_null_defines (void)
226 char line
[BUFSIZ
], *command
;
227 char **result
= NULL
;
228 size_t result_len
= 0;
229 size_t result_max
= 0;
233 command
= malloc (sizeof fmt
+ sizeof "/dev/null" + 2 * strlen (CC
)
234 + strlen (INC
) + strlen (TMPFILE
));
238 puts ("No more memory.");
242 sprintf (command
, fmt
, "/dev/null", CC
, INC
, CC
, TMPFILE
);
244 if (system (command
))
246 puts ("system() returned nonzero");
250 input
= fopen (TMPFILE
, "r");
254 printf ("Could not read %s: ", TMPFILE
);
259 while (fgets (line
, sizeof line
, input
) != NULL
)
264 if (strlen (line
) < 9 || line
[7] != ' ')
266 printf ("Malformed input, expected '#define MACRO'\ngot '%s'\n",
271 /* It's a safe identifier. */
273 if (result_len
== result_max
)
276 result
= realloc (result
, result_max
* sizeof (char **));
279 puts ("No more memory.");
284 for (end
= start
+ 1; !isspace (*end
) && *end
!= '\0'; ++end
)
286 result
[result_len
++] = strndup (start
, end
- start
);
290 fputs ("The following identifiers will be ignored since the compiler defines them\nby default:\n", stdout
);
293 puts (result
[result_len
- 1]);
298 return (const char **) result
;
303 check_header (const char *file_name
, const char **except
)
305 char line
[BUFSIZ
], *command
;
309 command
= malloc (sizeof fmt
+ strlen (file_name
) + 2 * strlen (CC
)
310 + strlen (INC
) + strlen (TMPFILE
));
314 puts ("No more memory.");
319 sprintf (command
, fmt
, file_name
, CC
, INC
, CC
, TMPFILE
);
321 if (system (command
))
323 puts ("system() returned nonzero");
327 input
= fopen (TMPFILE
, "r");
331 printf ("Could not read %s: ", TMPFILE
);
336 while (fgets (line
, sizeof line
, input
) != NULL
)
341 if (strlen (line
) < 9 || line
[7] != ' ')
343 printf ("Malformed input, expected '#define MACRO'\ngot '%s'\n",
348 for (i
= 0; i
< NUMBER_OF_PREFIXES
; ++i
)
350 if (!strncmp (line
+8, prefix
[i
], strlen (prefix
[i
]))) {
357 for (i
= 0; i
< NUMBER_OF_MACROS
; ++i
)
359 if (!strncmp (line
+ 8, macros
[i
], strlen (macros
[i
])))
367 /* Find next char after the macro identifier; this can be either
368 a space or an open parenthesis. */
369 endmac
= strcspn (line
+ 8, " (");
370 if (line
[8+endmac
] == '\0')
372 printf ("malformed input, expected '#define MACRO VALUE'\n"
377 for (i
= 0; i
< NUMBER_OF_SUFFIXES
; ++i
)
379 size_t len
= strlen (suffix
[i
]);
380 if (!strncmp (line
+ 8 + endmac
- len
, suffix
[i
], len
))
389 for (cpp
= except
; *cpp
!= NULL
; ++cpp
)
391 size_t len
= strlen (*cpp
);
392 if (!strncmp (line
+ 8, *cpp
, len
) && isspace (line
[8 + len
]))
400 fputs (line
, stdout
);