system.h

   1 /**
   2  * \file system.h
   3  */
   4
   5 #ifndef H_SYSTEM
   6 #define H_SYSTEM
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include "config.h"
  10 #endif
  11
  12 #include <sys/types.h>
  13
  14 #if defined(__LCLINT__)
  15 /*@-redef@*/
  16 typedef unsigned int u_int32_t;
  17 typedef unsigned short u_int16_t;
  18 typedef unsigned char u_int8_t;
  19 /*@-incondefs@*/        /* LCLint 3.0.0.15 */
  20 typedef int int32_t;
  21 /*@=incondefs@*/
  22 /* XXX from /usr/include/bits/sigset.h */
  23 /*@-sizeoftype@*/
  24 # define _SIGSET_NWORDS (1024 / (8 * sizeof (unsigned long int)))
  25 typedef struct
  26   {
  27     unsigned long int __val[_SIGSET_NWORDS];
  28   } __sigset_t;
  29 /*@=sizeoftype@*/
  30 /*@=redef@*/
  31 #endif
  32
  33 #include <sys/stat.h>
  34 #include <stdio.h>
  35
  36 #ifdef HAVE_SYS_PARAM_H
  37 #include <sys/param.h>
  38 #endif
  39
  40 /* <unistd.h> should be included before any preprocessor test
  41    of _POSIX_VERSION.  */
  42 #ifdef HAVE_UNISTD_H
  43 #include <unistd.h>
  44 #if defined(__LCLINT__)
  45 /*@-superuser -declundef -incondefs @*/ /* LCL: modifies clause missing */
  46 extern int chroot (const char *__path)
  47         /*@globals errno, systemState @*/
  48         /*@modifies errno, systemState @*/;
  49 /*@=superuser =declundef =incondefs @*/
  50 #endif
  51 #if !defined(__GLIBC__) && !defined(__LCLINT__)
  52 extern char ** environ;
  53 #endif
  54 #endif
  55
  56 #if TIME_WITH_SYS_TIME
  57 # include <sys/time.h>
  58 # include <time.h>
  59 #else
  60 # if HAVE_SYS_TIME_H
  61 #  include <sys/time.h>
  62 # else
  63 #  include <time.h>
  64 # endif
  65 #endif
  66
  67 #if NEED_TIMEZONE
  68 extern time_t timezone;
  69 #endif
  70
  71 /* Since major is a function on SVR4, we can't use `ifndef major'.  */
  72 #if MAJOR_IN_MKDEV
  73 #include <sys/mkdev.h>
  74 #define HAVE_MAJOR
  75 #endif
  76 #if MAJOR_IN_SYSMACROS
  77 #include <sys/sysmacros.h>
  78 #define HAVE_MAJOR
  79 #endif
  80 #ifdef major                    /* Might be defined in sys/types.h.  */
  81 #define HAVE_MAJOR
  82 #endif
  83
  84 #ifndef HAVE_MAJOR
  85 #define major(dev)  (((dev) >> 8) & 0xff)
  86 #define minor(dev)  ((dev) & 0xff)
  87 #define makedev(maj, min)  (((maj) << 8) | (min))
  88 #endif
  89 #undef HAVE_MAJOR
  90
  91 #ifdef HAVE_UTIME_H
  92 #include <utime.h>
  93 #endif
  94
  95 #ifdef HAVE_STRING_H
  96 # if !STDC_HEADERS && HAVE_MEMORY_H
  97 #  include <memory.h>
  98 # endif
  99 # include <string.h>
 100 #else
 101 # include <strings.h>
 102 char *memchr ();
 103 #endif
 104
 105 #if !defined(HAVE_STPCPY)
 106 char * stpcpy(/*@out@*/ char * dest, const char * src);
 107 #endif
 108
 109 #if !defined(HAVE_STPNCPY)
 110 char * stpncpy(/*@out@*/ char * dest, const char * src, size_t n);
 111 #endif
 112
 113 #include <errno.h>
 114 #ifndef errno
 115 /*@-declundef @*/
 116 extern int errno;
 117 /*@=declundef @*/
 118 #endif
 119
 120 #if defined(__LCLINT__)
 121 /*@-declundef @*/
 122 /*@exits@*/
 123 extern void error(int status, int errnum, const char *format, ...)
 124         __attribute__ ((__format__ (__printf__, 3, 4)))
 125         /*@globals fileSystem @*/
 126         /*@modifies fileSystem @*/;
 127 /*@=declundef @*/
 128 #else
 129 #if HAVE_ERROR && HAVE_ERROR_H
 130 #include <error.h>
 131 #endif
 132 #endif
 133
 134 #if HAVE___SECURE_GETENV && !defined(__LCLINT__)
 135 #define getenv(_s)      __secure_getenv(_s)
 136 #endif
 137
 138 #ifdef STDC_HEADERS
 139 /*@-macrounrecog -incondefs -globuse -mustmod @*/ /* FIX: shrug */
 140 #define getopt system_getopt
 141 /*@=macrounrecog =incondefs =globuse =mustmod @*/
 142 /*@-skipansiheaders@*/
 143 #include <stdlib.h>
 144 /*@=skipansiheaders@*/
 145 #undef getopt
 146 #if defined(__LCLINT__)
 147 /*@-declundef -incondefs @*/    /* LCL: modifies clause missing */
 148 extern char * realpath (const char * file_name, /*@out@*/ char * resolved_name)
 149         /*@globals errno, fileSystem @*/
 150         /*@requires maxSet(resolved_name) >=  (PATH_MAX - 1); @*/
 151         /*@modifies *resolved_name, errno, fileSystem @*/;
 152 /*@=declundef =incondefs @*/
 153 #endif
 154 #else /* not STDC_HEADERS */
 155 char *getenv (const char *name);
 156 #if ! HAVE_REALPATH
 157 char *realpath(const char *path, char resolved_path []);
 158 #endif
 159 #endif /* STDC_HEADERS */
 160
 161 /* XXX solaris2.5.1 has not */
 162 #if !defined(EXIT_FAILURE)
 163 #define EXIT_FAILURE    1
 164 #endif
 165
 166 #ifdef HAVE_FCNTL_H
 167 #include <fcntl.h>
 168 #else
 169 #include <sys/file.h>
 170 #endif
 171
 172 #if !defined(SEEK_SET) && !defined(__LCLINT__)
 173 #define SEEK_SET 0
 174 #define SEEK_CUR 1
 175 #define SEEK_END 2
 176 #endif
 177 #if !defined(F_OK) && !defined(__LCLINT__)
 178 #define F_OK 0
 179 #define X_OK 1
 180 #define W_OK 2
 181 #define R_OK 4
 182 #endif
 183
 184 #ifdef HAVE_DIRENT_H
 185 # include <dirent.h>
 186 # define NLENGTH(direct) (strlen((direct)->d_name))
 187 #else /* not HAVE_DIRENT_H */
 188 # define dirent direct
 189 # define NLENGTH(direct) ((direct)->d_namlen)
 190 # ifdef HAVE_SYS_NDIR_H
 191 #  include <sys/ndir.h>
 192 # endif /* HAVE_SYS_NDIR_H */
 193 # ifdef HAVE_SYS_DIR_H
 194 #  include <sys/dir.h>
 195 # endif /* HAVE_SYS_DIR_H */
 196 # ifdef HAVE_NDIR_H
 197 #  include <ndir.h>
 198 # endif /* HAVE_NDIR_H */
 199 #endif /* HAVE_DIRENT_H */
 200
 201 #if defined(__LCLINT__)
 202 /*@-declundef -incondefs @*/ /* LCL: missing annotation */
 203 /*@only@*/ /*@out@*/ void * alloca (size_t __size)
 204         /*@ensures maxSet(result) == (__size - 1) @*/
 205         /*@*/;
 206 /*@=declundef =incondefs @*/
 207 #endif
 208
 209 #ifdef __GNUC__
 210 # undef alloca
 211 # define alloca __builtin_alloca
 212 #else
 213 # ifdef HAVE_ALLOCA_H
 214 #  include <alloca.h>
 215 # else
 216 #  ifndef _AIX
 217 /* AIX alloca decl has to be the first thing in the file, bletch! */
 218 char *alloca ();
 219 #  endif
 220 # endif
 221 #endif
 222
 223 #if defined (__GLIBC__) && defined(__LCLINT__)
 224 /*@-declundef@*/
 225 /*@unchecked@*/
 226 extern __const __int32_t *__ctype_tolower;
 227 /*@unchecked@*/
 228 extern __const __int32_t *__ctype_toupper;
 229 /*@=declundef@*/
 230 #endif
 231
 232 #include <ctype.h>
 233
 234 #if defined (__GLIBC__) && defined(__LCLINT__)
 235 /*@-exportlocal@*/
 236 extern int isalnum(int) __THROW /*@*/;
 237 extern int iscntrl(int) __THROW /*@*/;
 238 extern int isgraph(int) __THROW /*@*/;
 239 extern int islower(int) __THROW /*@*/;
 240 extern int ispunct(int) __THROW /*@*/;
 241 extern int isxdigit(int) __THROW        /*@*/;
 242 extern int isascii(int) __THROW /*@*/;
 243 extern int toascii(int) __THROW /*@*/;
 244 extern int _toupper(int) __THROW        /*@*/;
 245 extern int _tolower(int) __THROW        /*@*/;
 246 /*@=exportlocal@*/
 247
 248 #endif
 249
 250 #if HAVE_SYS_MMAN_H && !defined(__LCLINT__)
 251 #include <sys/mman.h>
 252 #endif
 253
 254 /* XXX FIXME: popt on sunos4.1.3: <sys/resource.h> requires <sys/time.h> */
 255 #if HAVE_SYS_RESOURCE_H && HAVE_SYS_TIME_H
 256 #include <sys/resource.h>
 257 #endif
 258
 259 #if HAVE_SYS_UTSNAME_H
 260 #include <sys/utsname.h>
 261 #endif
 262
 263 #if HAVE_SYS_WAIT_H
 264 #include <sys/wait.h>
 265 #endif
 266
 267 #if HAVE_GETOPT_H
 268 /*@-noparams@*/
 269 #include <getopt.h>
 270 /*@=noparams@*/
 271 #endif
 272
 273 #if HAVE_GRP_H
 274 #include <grp.h>
 275 #endif
 276
 277 #if HAVE_LIMITS_H
 278 #include <limits.h>
 279 #endif
 280
 281 #if HAVE_ERR_H
 282 #include <err.h>
 283 #endif
 284
 285 #if HAVE_MALLOC_H && !defined(__LCLINT__)
 286 #include <malloc.h>
 287 #endif
 288
 289 /*@-declundef -incondefs @*/ /* FIX: these are macros */
 290 /**
 291  */
 292 /*@mayexit@*/ /*@only@*/ /*@out@*/ void * xmalloc (size_t size)
 293         /*@globals errno @*/
 294         /*@ensures maxSet(result) == (size - 1) @*/
 295         /*@modifies errno @*/;
 296
 297 /**
 298  */
 299 /*@mayexit@*/ /*@only@*/ void * xcalloc (size_t nmemb, size_t size)
 300         /*@ensures maxSet(result) == (nmemb - 1) @*/
 301         /*@*/;
 302
 303 /**
 304  * @todo Annotate ptr with returned/out.
 305  */
 306 /*@mayexit@*/ /*@only@*/ void * xrealloc (/*@null@*/ /*@only@*/ void * ptr,
 307                                         size_t size)
 308         /*@ensures maxSet(result) == (size - 1) @*/
 309         /*@modifies *ptr @*/;
 310
 311 /**
 312  */
 313 /*@mayexit@*/ /*@only@*/ char * xstrdup (const char *str)
 314         /*@*/;
 315 /*@=declundef =incondefs @*/
 316
 317 /**
 318  */
 319 /*@unused@*/ /*@exits@*/ /*@only@*/ void * vmefail(size_t size)
 320         /*@*/;
 321
 322 #if HAVE_MCHECK_H
 323 #include <mcheck.h>
 324 #if defined(__LCLINT__)
 325 /*@-declundef -incondefs @*/ /* LCL: missing annotations */
 326 #if 0
 327 enum mcheck_status
 328   {
 329     MCHECK_DISABLED = -1,       /* Consistency checking is not turned on.  */
 330     MCHECK_OK,                  /* Block is fine.  */
 331     MCHECK_FREE,                /* Block freed twice.  */
 332     MCHECK_HEAD,                /* Memory before the block was clobbered.  */
 333     MCHECK_TAIL                 /* Memory after the block was clobbered.  */
 334   };
 335 #endif
 336
 337 extern int mcheck (void (*__abortfunc) (enum mcheck_status))
 338         /*@globals internalState@*/
 339         /*@modifies internalState @*/;
 340 extern int mcheck_pedantic (void (*__abortfunc) (enum mcheck_status))
 341         /*@globals internalState@*/
 342         /*@modifies internalState @*/;
 343 extern void mcheck_check_all (void)
 344         /*@globals internalState@*/
 345         /*@modifies internalState @*/;
 346 extern enum mcheck_status mprobe (void *__ptr)
 347         /*@globals internalState@*/
 348         /*@modifies internalState @*/;
 349 extern void mtrace (void)
 350         /*@globals internalState@*/
 351         /*@modifies internalState @*/;
 352 extern void muntrace (void)
 353         /*@globals internalState@*/
 354         /*@modifies internalState @*/;
 355 /*@=declundef =incondefs @*/
 356 #endif /* defined(__LCLINT__) */
 357
 358 /* Memory allocation via macro defs to get meaningful locations from mtrace() */
 359 #if defined(__GNUC__)
 360 #define xmalloc(_size)          (malloc(_size) ? : vmefail(_size))
 361 #define xcalloc(_nmemb, _size)  (calloc((_nmemb), (_size)) ? : vmefail(_size))
 362 #define xrealloc(_ptr, _size)   (realloc((_ptr), (_size)) ? : vmefail(_size))
 363 #define xstrdup(_str)   (strcpy((malloc(strlen(_str)+1) ? : vmefail(strlen(_str)+1)), (_str)))
 364 #endif  /* defined(__GNUC__) */
 365 #endif  /* HAVE_MCHECK_H */
 366
 367 /* Retrofit glibc __progname */
 368 #if defined __GLIBC__ && __GLIBC__ >= 2
 369 #if __GLIBC_MINOR__ >= 1
 370 #define __progname      __assert_program_name
 371 #endif
 372 #define setprogname(pn)
 373 #else
 374 #define __progname      program_name
 375 #define setprogname(pn) \
 376   { if ((__progname = strrchr(pn, '/')) != NULL) __progname++; \
 377     else __progname = pn;               \
 378   }
 379 #endif
 380 /*@unchecked@*/
 381 const char *__progname;
 382
 383 #if HAVE_NETDB_H
 384 #include <netdb.h>
 385 #endif
 386
 387 #if HAVE_PWD_H
 388 #include <pwd.h>
 389 #endif
 390
 391 /* Take care of NLS matters.  */
 392
 393 #if HAVE_LOCALE_H
 394 # include <locale.h>
 395 #endif
 396 #if !HAVE_SETLOCALE
 397 # define setlocale(Category, Locale) /* empty */
 398 #endif
 399
 400 #if ENABLE_NLS && !defined(__LCLINT__)
 401 # include <libintl.h>
 402 # define _(Text) gettext (Text)
 403 #else
 404 # undef bindtextdomain
 405 # define bindtextdomain(Domain, Directory) /* empty */
 406 # undef textdomain
 407 # define textdomain(Domain) /* empty */
 408 # define _(Text) Text
 409 # undef dgettext
 410 # define dgettext(DomainName, Text) Text
 411 #endif
 412
 413 #define N_(Text) Text
 414
 415 /* ============== from misc/miscfn.h */
 416
 417 #if !defined(USE_GNU_GLOB)
 418 #if HAVE_FNMATCH_H
 419 /*@-noparams@*/
 420 #include <fnmatch.h>
 421 /*@=noparams@*/
 422 #endif
 423
 424 #if HAVE_GLOB_H
 425 /*@-noparams@*/
 426 #include <glob.h>
 427 /*@=noparams@*/
 428 #endif
 429 #else
 430 /*@-noparams@*/
 431 #include "misc/glob.h"
 432 #include "misc/fnmatch.h"
 433 /*@=noparams@*/
 434 #endif
 435
 436 #if defined(__LCLINT__)
 437 /*@-declundef -incondefs @*/ /* LCL: missing annotation */
 438 #if 0
 439 typedef /*@concrete@*/ struct
 440   {
 441     size_t gl_pathc;
 442     char **gl_pathv;
 443     size_t gl_offs;
 444     int gl_flags;
 445
 446     void (*gl_closedir) (void *);
 447 #ifdef _GNU_SOURCE
 448     struct dirent *(*gl_readdir) (void *);
 449 #else
 450     void *(*gl_readdir) (void *);
 451 #endif
 452     ptr_t (*gl_opendir) (const char *);
 453 #ifdef _GNU_SOURCE
 454     int (*gl_lstat) (const char *restrict, struct stat *restrict);
 455     int (*gl_stat) (const char *restrict, struct stat *restrict);
 456 #else
 457     int (*gl_lstat) (const char *restrict, void *restrict);
 458     int (*gl_stat) (const char *restrict, void *restrict);
 459 #endif
 460   } glob_t;
 461 #endif
 462
 463 #if 0
 464 /*@-constuse@*/
 465 /*@constant int GLOB_ERR@*/
 466 /*@constant int GLOB_MARK@*/
 467 /*@constant int GLOB_NOSORT@*/
 468 /*@constant int GLOB_DOOFFS@*/
 469 /*@constant int GLOB_NOCHECK@*/
 470 /*@constant int GLOB_APPEND@*/
 471 /*@constant int GLOB_NOESCAPE@*/
 472 /*@constant int GLOB_PERIOD@*/
 473
 474 #ifdef _GNU_SOURCE
 475 /*@constant int GLOB_MAGCHAR@*/
 476 /*@constant int GLOB_ALTDIRFUNC@*/
 477 /*@constant int GLOB_BRACE@*/
 478 /*@constant int GLOB_NOMAGIC@*/
 479 /*@constant int GLOB_TILDE@*/
 480 /*@constant int GLOB_ONLYDIR@*/
 481 /*@constant int GLOB_TILDE_CHECK@*/
 482 #endif
 483
 484 /*@constant int GLOB_FLAGS@*/
 485
 486 /*@constant int GLOB_NOSPACE@*/
 487 /*@constant int GLOB_ABORTED@*/
 488 /*@constant int GLOB_NOMATCH@*/
 489 /*@constant int GLOB_NOSYS@*/
 490 #ifdef _GNU_SOURCE
 491 /*@constant int GLOB_ABEND@*/
 492 #endif
 493 /*@=constuse@*/
 494 #endif
 495
 496 extern int glob (const char *pattern, int flags,
 497                       int (*errfunc) (const char *, int),
 498                       /*@out@*/ glob_t *pglob)
 499         /*@globals errno, fileSystem @*/
 500         /*@modifies *pglob, errno, fileSystem @*/;
 501         /* XXX only annotation is a white lie */
 502 extern void globfree (/*@only@*/ glob_t *pglob)
 503         /*@modifies *pglob @*/;
 504 #ifdef _GNU_SOURCE
 505 extern int glob_pattern_p (const char *pattern, int quote)
 506         /*@*/;
 507 #endif
 508
 509 #if 0
 510 /*@-constuse@*/
 511 /*@constant int FNM_PATHNAME@*/
 512 /*@constant int FNM_NOESCAPE@*/
 513 /*@constant int FNM_PERIOD@*/
 514
 515 #ifdef _GNU_SOURCE
 516 /*@constant int FNM_FILE_NAME@*/        /* GNU extension */
 517 /*@constant int FNM_LEADING_DIR@*/      /* GNU extension */
 518 /*@constant int FNM_CASEFOLD@*/         /* GNU extension */
 519 /*@constant int FNM_EXTMATCH@*/         /* GNU extension */
 520 #endif
 521
 522 /*@constant int FNM_NOMATCH@*/
 523
 524 #ifdef _XOPEN_SOURCE
 525 /*@constant int FNM_NOSYS@*/            /* X/Open */
 526 #endif
 527 /*@=constuse@*/
 528 #endif
 529
 530 extern int fnmatch (const char *pattern, const char *string, int flags)
 531         /*@*/;
 532 /*@=declundef =incondefs @*/
 533 #endif
 534
 535 #if ! HAVE_S_IFSOCK
 536 #define S_IFSOCK (0xc000)
 537 #endif
 538
 539 #if ! HAVE_S_ISLNK
 540 #define S_ISLNK(mode) ((mode & 0xf000) == S_IFLNK)
 541 #endif
 542
 543 #if ! HAVE_S_ISSOCK
 544 #define S_ISSOCK(mode) ((mode & 0xf000) == S_IFSOCK)
 545 #endif
 546
 547 #if NEED_STRINGS_H
 548 #include <strings.h>
 549 #endif
 550
 551 #if NEED_MYREALLOC
 552 #define realloc(ptr,size) myrealloc(ptr,size)
 553 extern void *myrealloc(void *, size_t);
 554 #endif
 555
 556 #if ! HAVE_SETENV
 557 extern int setenv(const char *name, const char *value, int replace);
 558 extern void unsetenv(const char *name);
 559 #endif
 560
 561 #if HAVE_SYS_SOCKET_H
 562 #include <sys/types.h>
 563 #include <sys/socket.h>
 564 #endif
 565
 566 #if HAVE_SYS_SELECT_H && !defined(__LCLINT__)
 567 #include <sys/select.h>
 568 #endif
 569
 570 /* Solaris <= 2.6 limits getpass return to only 8 chars */
 571 #if HAVE_GETPASSPHRASE
 572 #define getpass getpassphrase
 573 #endif
 574
 575 #if ! HAVE_LCHOWN
 576 #define lchown chown
 577 #endif
 578
 579 #if HAVE_GETMNTINFO_R || HAVE_MNTCTL
 580 # define GETMNTENT_ONE 0
 581 # define GETMNTENT_TWO 0
 582 # if HAVE_SYS_MNTCTL_H
 583 #  include <sys/mntctl.h>
 584 # endif
 585 # if HAVE_SYS_VMOUNT_H
 586 #  include <sys/vmount.h>
 587 # endif
 588 # if HAVE_SYS_MOUNT_H
 589 #  include <sys/mount.h>
 590 # endif
 591 #elif HAVE_MNTENT_H || !(HAVE_GETMNTENT) || HAVE_STRUCT_MNTTAB
 592 # if HAVE_MNTENT_H
 593 #  include <stdio.h>
 594 #  include <mntent.h>
 595 #  define our_mntent struct mntent
 596 #  define our_mntdir mnt_dir
 597 # elif HAVE_STRUCT_MNTTAB
 598 #  include <stdio.h>
 599 #  include <mnttab.h>
 600    struct our_mntent {
 601        char * our_mntdir;
 602    };
 603    struct our_mntent *getmntent(FILE *filep);
 604 #  define our_mntent struct our_mntent
 605 # else
 606 #  include <stdio.h>
 607    struct our_mntent {
 608        char * our_mntdir;
 609    };
 610    struct our_mntent *getmntent(FILE *filep);
 611 #  define our_mntent struct our_mntent
 612 # endif
 613 # define GETMNTENT_ONE 1
 614 # define GETMNTENT_TWO 0
 615 #elif HAVE_SYS_MNTTAB_H
 616 # include <stdio.h>
 617 # include <sys/mnttab.h>
 618 # define GETMNTENT_ONE 0
 619 # define GETMNTENT_TWO 1
 620 # define our_mntent struct mnttab
 621 # define our_mntdir mnt_mountp
 622 #else /* if !HAVE_MNTCTL */
 623 # error Neither mntent.h, mnttab.h, or mntctl() exists. I cannot build on this system.
 624 #endif
 625
 626 #ifndef MOUNTED
 627 #define MOUNTED "/etc/mnttab"
 628 #endif
 629
 630 #if defined(__LCLINT__)
 631 #define FILE_RCSID(id)
 632 #else
 633 #define FILE_RCSID(id) \
 634 static inline const char *rcsid(const char *p) { \
 635         return rcsid(p = id); \
 636 }
 637 #endif
 638
 639 #endif  /* H_SYSTEM */