stdlib/isomac.c

   1 /* Check system header files for ISO 9899:1990 (ISO C) compliance.
   2    Copyright (C) 1996-2013 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Jens Schweikhardt <schweikh@noc.dfn.de>, 1996.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    The GNU C Library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with the GNU C Library; if not, see
  18    <http://www.gnu.org/licenses/>.  */
  19
  20 /* This is a simple minded program that tries to find illegal macro
  21    definitions in system header files. Illegal macro definitions are
  22    those not from the implementation namespace (i.e. not starting with
  23    an underscore) or not matching any identifier mandated by The
  24    Standard. Some common macro names are considered okay, e.g. all those
  25    beginning with E (which may be defined in <errno.h>) or ending in
  26    _MAX. See the arrays prefix[] and suffix[] below for details.
  27
  28    In a compliant implementation no other macros can be defined, because
  29    you could write strictly conforming programs that may fail to compile
  30    due to syntax errors: suppose <stdio.h> defines PIPE_BUF, then the
  31    conforming
  32
  33    #include <assert.h>
  34    #include <stdio.h>      <- or where the bogus macro is defined
  35    #include <string.h>
  36    #define STR(x) #x
  37    #define XSTR(x) STR(x)
  38    int main (void)
  39    {
  40      int PIPE_BUF = 0;
  41      assert (strcmp ("PIPE_BUF", XSTR (PIPE_BUF)) == 0);
  42      return 0;
  43    }
  44
  45    is expected to compile and meet the assertion. If it does not, your
  46    compiler compiles some other language than Standard C.
  47
  48    REQUIREMENTS:
  49      This program calls gcc to get the list of defined macros. If you
  50      don't have gcc you're probably out of luck unless your compiler or
  51      preprocessor has something similar to gcc's -dM option. Tune
  52      PRINT_MACROS in this case. This program assumes headers are found
  53      under /usr/include and that there is a writable /tmp directory.
  54      Tune SYSTEM_INCLUDE if your system differs.
  55      #define BROKEN_SYSTEM if system(NULL) bombs -- one more violation
  56      of ISO C, by the way.
  57
  58    OUTPUT:
  59      Each header file name is printed, followed by illegal macro names
  60      and their definition. For the above example, you would see
  61      ...
  62      /usr/include/stdio.h
  63      #define PIPE_BUF 5120
  64      ...
  65      If your implementation does not yet incorporate Amendment 1 you
  66      will see messages about iso646.h, wctype.h and wchar.h not being
  67      found.  */
  68
  69 #ifndef _GNU_SOURCE
  70 # define _GNU_SOURCE 1
  71 #endif
  72
  73 #include <stdio.h>
  74 #include <stdlib.h>
  75 #include <string.h>
  76
  77 #define HEADER_MAX          256
  78
  79 static const char *macrofile;
  80
  81 /* ISO C header names including Amendment 1 (without ".h" suffix).  */
  82 static char *header[] =
  83 {
  84   "assert", "ctype", "errno", "float", "iso646", "limits", "locale",
  85   "math", "setjmp", "signal", "stdarg", "stddef", "stdio", "stdlib",
  86   "string", "time", "wchar", "wctype"
  87 };
  88
  89 /* Macros with these prefixes are considered okay.  */
  90 static char *prefix[] =
  91 {
  92   "_", "E", "is", "str", "mem", "SIG", "FLT_", "DBL_", "LDBL_",
  93   "LC_", "wmem", "wcs"
  94 };
  95
  96 /* Macros with these suffixes are considered okay.  Will not work for
  97    parametrized macros with arguments.  */
  98 static char *suffix[] =
  99 {
 100   "_MAX", "_MIN"
 101 };
 102
 103 /* These macros are considered okay. In fact, these are just more prefixes.  */
 104 static char *macros[] =
 105 {
 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_copy", "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"
 168 };
 169
 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)
 174
 175
 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 -D_ISOMAC -DNOT_IN_libc -I. \
 180 -isystem `%s --print-prog-name=include` - 2> /dev/null > %s";
 181
 182
 183 /* The compiler we use (given on the command line).  */
 184 char *CC;
 185 /* The -I parameters for CC to find all headers.  */
 186 char *INC;
 187
 188 static char *xstrndup (const char *, size_t);
 189 static const char **get_null_defines (void);
 190 static int check_header (const char *, const char **);
 191
 192 int
 193 main (int argc, char *argv[])
 194 {
 195   int h;
 196   int result = 0;
 197   const char **ignore_list;
 198
 199   CC = argc > 1 ? argv[1] : "gcc";
 200   INC = argc > 2 ? argv[2] : "";
 201
 202   if (system (NULL) == 0)
 203     {
 204       puts ("Sorry, no command processor.");
 205       return EXIT_FAILURE;
 206     }
 207
 208   /* First get list of symbols which are defined by the compiler.  */
 209   ignore_list = get_null_defines ();
 210
 211   fputs ("Tested files:\n", stdout);
 212
 213   for (h = 0; h < NUMBER_OF_HEADERS; ++h)
 214     {
 215       char file_name[HEADER_MAX];
 216       sprintf (file_name, "%s.h", header[h]);
 217       result |= check_header (file_name, ignore_list);
 218     }
 219
 220   /* The test suite should return errors but for now this is not
 221      practical.  Give a warning and ask the user to correct the bugs.  */
 222   return result;
 223 }
 224
 225
 226 static char *
 227 xstrndup (const char *s, size_t n)
 228 {
 229   size_t len = n;
 230   char *new = malloc (len + 1);
 231
 232   if (new == NULL)
 233     return NULL;
 234
 235   new[len] = '\0';
 236   return memcpy (new, s, len);
 237 }
 238
 239
 240 static const char **
 241 get_null_defines (void)
 242 {
 243   char line[BUFSIZ], *command;
 244   char **result = NULL;
 245   size_t result_len = 0;
 246   size_t result_max = 0;
 247   FILE *input;
 248   int first = 1;
 249
 250   macrofile = tmpnam (NULL);
 251
 252   command = malloc (sizeof fmt + sizeof "/dev/null" + 2 * strlen (CC)
 253                     + strlen (INC) + strlen (macrofile));
 254
 255   if (command == NULL)
 256     {
 257       puts ("No more memory.");
 258       exit (1);
 259     }
 260
 261   sprintf (command, fmt, "/dev/null", CC, INC, CC, macrofile);
 262
 263   if (system (command))
 264     {
 265       puts ("system() returned nonzero");
 266       free (command);
 267       return NULL;
 268     }
 269   free (command);
 270   input = fopen (macrofile, "r");
 271
 272   if (input == NULL)
 273     {
 274       printf ("Could not read %s: ", macrofile);
 275       perror (NULL);
 276       return NULL;
 277     }
 278
 279   while (fgets (line, sizeof line, input) != NULL)
 280     {
 281       int i, okay = 0;
 282       size_t endmac;
 283       char *start, *end;
 284       if (strlen (line) < 9 || line[7] != ' ')
 285         { /* "#define A" */
 286           printf ("Malformed input, expected '#define MACRO'\ngot '%s'\n",
 287                   line);
 288           continue;
 289         }
 290       if (line[8] == '_')
 291         /* It's a safe identifier.  */
 292         continue;
 293       if (result_len == result_max)
 294         {
 295           result_max += 10;
 296           result = realloc (result, result_max * sizeof (char **));
 297           if (result == NULL)
 298             {
 299               puts ("No more memory.");
 300               exit (1);
 301             }
 302         }
 303       start = &line[8];
 304       for (end = start + 1; !isspace (*end) && *end != '\0'; ++end)
 305         ;
 306       result[result_len] = xstrndup (start, end - start);
 307
 308       if (strcmp (result[result_len], "NOT_IN_libc") != 0)
 309         {
 310           if (first)
 311             {
 312               fputs ("The following identifiers will be ignored since the compiler defines them\nby default:\n", stdout);
 313               first = 0;
 314             }
 315           puts (result[result_len]);
 316         }
 317       ++result_len;
 318     }
 319   if (result_len == result_max)
 320     {
 321       result_max += 1;
 322       result = realloc (result, result_max * sizeof (char **));
 323       if (result == NULL)
 324         {
 325           puts ("No more memory.");
 326           exit (1);
 327         }
 328     }
 329   result[result_len] = NULL;
 330   fclose (input);
 331   remove (macrofile);
 332
 333   return (const char **) result;
 334 }
 335
 336
 337 static int
 338 check_header (const char *file_name, const char **except)
 339 {
 340   char line[BUFSIZ], *command;
 341   FILE *input;
 342   int result = 0;
 343
 344   command = malloc (sizeof fmt + strlen (file_name) + 2 * strlen (CC)
 345                     + strlen (INC) + strlen (macrofile));
 346
 347   if (command == NULL)
 348     {
 349       puts ("No more memory.");
 350       exit (1);
 351     }
 352
 353   puts (file_name);
 354   sprintf (command, fmt, file_name, CC, INC, CC, macrofile);
 355
 356   if (system (command))
 357     {
 358       puts ("system() returned nonzero");
 359       result = 1;
 360     }
 361   free (command);
 362   input = fopen (macrofile, "r");
 363
 364   if (input == NULL)
 365     {
 366       printf ("Could not read %s: ", macrofile);
 367       perror (NULL);
 368       return 1;
 369     }
 370
 371   while (fgets (line, sizeof line, input) != NULL)
 372     {
 373       int i, okay = 0;
 374       size_t endmac;
 375       const char **cpp;
 376       if (strlen (line) < 9 || line[7] != ' ')
 377         { /* "#define A" */
 378           printf ("Malformed input, expected '#define MACRO'\ngot '%s'\n",
 379                   line);
 380           result = 1;
 381           continue;
 382         }
 383       for (i = 0; i < NUMBER_OF_PREFIXES; ++i)
 384         {
 385           if (!strncmp (line+8, prefix[i], strlen (prefix[i]))) {
 386             ++okay;
 387             break;
 388           }
 389         }
 390       if (okay)
 391         continue;
 392       for (i = 0; i < NUMBER_OF_MACROS; ++i)
 393         {
 394           if (!strncmp (line + 8, macros[i], strlen (macros[i])))
 395             {
 396               ++okay;
 397               break;
 398             }
 399         }
 400       if (okay)
 401         continue;
 402       /* Find next char after the macro identifier; this can be either
 403          a space or an open parenthesis.  */
 404       endmac = strcspn (line + 8, " (");
 405       if (line[8+endmac] == '\0')
 406         {
 407           printf ("malformed input, expected '#define MACRO VALUE'\n"
 408                   "got '%s'\n", line);
 409           result = 1;
 410           continue;
 411         }
 412       for (i = 0; i < NUMBER_OF_SUFFIXES; ++i)
 413         {
 414           size_t len = strlen (suffix[i]);
 415           if (!strncmp (line + 8 + endmac - len, suffix[i], len))
 416             {
 417               ++okay;
 418               break;
 419             }
 420         }
 421       if (okay)
 422         continue;
 423       if (except != NULL)
 424         for (cpp = except; *cpp != NULL; ++cpp)
 425           {
 426             size_t len = strlen (*cpp);
 427             if (!strncmp (line + 8, *cpp, len) && isspace (line[8 + len]))
 428               {
 429                 ++okay;
 430                 break;
 431               }
 432           }
 433       if (!okay)
 434         {
 435           fputs (line, stdout);
 436           result = 2;
 437         }
 438     }
 439   fclose (input);
 440   remove (macrofile);
 441
 442   return result;
 443 }
 444
 445 /* EOF */