io/sys/stat.h

   1 /* Copyright (C) 1991, 1992, 1995-2004, 2005, 2006, 2007
   2    Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 /*
  21  *      POSIX Standard: 5.6 File Characteristics        <sys/stat.h>
  22  */
  23
  24 #ifndef _SYS_STAT_H
  25 #define _SYS_STAT_H     1
  26
  27 #include <features.h>
  28
  29 #include <bits/types.h>         /* For __mode_t and __dev_t.  */
  30
  31 #if defined __USE_XOPEN || defined __USE_XOPEN2K || defined __USE_MISC
  32 # if defined __USE_XOPEN || defined __USE_XOPEN2K
  33 #  define __need_time_t
  34 # endif
  35 # ifdef __USE_MISC
  36 #  define __need_timespec
  37 # endif
  38 # include <time.h>              /* For time_t resp. timespec.  */
  39 #endif
  40
  41 #if defined __USE_XOPEN || defined __USE_XOPEN2K
  42 /* The Single Unix specification says that some more types are
  43    available here.  */
  44 # ifndef __dev_t_defined
  45 typedef __dev_t dev_t;
  46 #  define __dev_t_defined
  47 # endif
  48
  49 # ifndef __gid_t_defined
  50 typedef __gid_t gid_t;
  51 #  define __gid_t_defined
  52 # endif
  53
  54 # ifndef __ino_t_defined
  55 #  ifndef __USE_FILE_OFFSET64
  56 typedef __ino_t ino_t;
  57 #  else
  58 typedef __ino64_t ino_t;
  59 #  endif
  60 #  define __ino_t_defined
  61 # endif
  62
  63 # ifndef __mode_t_defined
  64 typedef __mode_t mode_t;
  65 #  define __mode_t_defined
  66 # endif
  67
  68 # ifndef __nlink_t_defined
  69 typedef __nlink_t nlink_t;
  70 #  define __nlink_t_defined
  71 # endif
  72
  73 # ifndef __off_t_defined
  74 #  ifndef __USE_FILE_OFFSET64
  75 typedef __off_t off_t;
  76 #  else
  77 typedef __off64_t off_t;
  78 #  endif
  79 #  define __off_t_defined
  80 # endif
  81
  82 # ifndef __uid_t_defined
  83 typedef __uid_t uid_t;
  84 #  define __uid_t_defined
  85 # endif
  86 #endif  /* X/Open */
  87
  88 #ifdef __USE_UNIX98
  89 # ifndef __blkcnt_t_defined
  90 #  ifndef __USE_FILE_OFFSET64
  91 typedef __blkcnt_t blkcnt_t;
  92 #  else
  93 typedef __blkcnt64_t blkcnt_t;
  94 #  endif
  95 #  define __blkcnt_t_defined
  96 # endif
  97
  98 # ifndef __blksize_t_defined
  99 typedef __blksize_t blksize_t;
 100 #  define __blksize_t_defined
 101 # endif
 102 #endif  /* Unix98 */
 103
 104 __BEGIN_DECLS
 105
 106 #include <bits/stat.h>
 107
 108 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
 109 # define S_IFMT         __S_IFMT
 110 # define S_IFDIR        __S_IFDIR
 111 # define S_IFCHR        __S_IFCHR
 112 # define S_IFBLK        __S_IFBLK
 113 # define S_IFREG        __S_IFREG
 114 # ifdef __S_IFIFO
 115 #  define S_IFIFO       __S_IFIFO
 116 # endif
 117 # ifdef __S_IFLNK
 118 #  define S_IFLNK       __S_IFLNK
 119 # endif
 120 # if (defined __USE_BSD || defined __USE_MISC || defined __USE_UNIX98) \
 121      && defined __S_IFSOCK
 122 #  define S_IFSOCK      __S_IFSOCK
 123 # endif
 124 #endif
 125
 126 /* Test macros for file types.  */
 127
 128 #define __S_ISTYPE(mode, mask)  (((mode) & __S_IFMT) == (mask))
 129
 130 #define S_ISDIR(mode)    __S_ISTYPE((mode), __S_IFDIR)
 131 #define S_ISCHR(mode)    __S_ISTYPE((mode), __S_IFCHR)
 132 #define S_ISBLK(mode)    __S_ISTYPE((mode), __S_IFBLK)
 133 #define S_ISREG(mode)    __S_ISTYPE((mode), __S_IFREG)
 134 #ifdef __S_IFIFO
 135 # define S_ISFIFO(mode)  __S_ISTYPE((mode), __S_IFIFO)
 136 #endif
 137 #ifdef __S_IFLNK
 138 # define S_ISLNK(mode)   __S_ISTYPE((mode), __S_IFLNK)
 139 #endif
 140
 141 #if defined __USE_BSD && !defined __S_IFLNK
 142 # define S_ISLNK(mode)  0
 143 #endif
 144
 145 #if (defined __USE_BSD || defined __USE_UNIX98) \
 146     && defined __S_IFSOCK
 147 # define S_ISSOCK(mode) __S_ISTYPE((mode), __S_IFSOCK)
 148 #endif
 149
 150 /* These are from POSIX.1b.  If the objects are not implemented using separate
 151    distinct file types, the macros always will evaluate to zero.  Unlike the
 152    other S_* macros the following three take a pointer to a `struct stat'
 153    object as the argument.  */
 154 #ifdef  __USE_POSIX199309
 155 # define S_TYPEISMQ(buf) __S_TYPEISMQ(buf)
 156 # define S_TYPEISSEM(buf) __S_TYPEISSEM(buf)
 157 # define S_TYPEISSHM(buf) __S_TYPEISSHM(buf)
 158 #endif
 159
 160
 161 /* Protection bits.  */
 162
 163 #define S_ISUID __S_ISUID       /* Set user ID on execution.  */
 164 #define S_ISGID __S_ISGID       /* Set group ID on execution.  */
 165
 166 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
 167 /* Save swapped text after use (sticky bit).  This is pretty well obsolete.  */
 168 # define S_ISVTX        __S_ISVTX
 169 #endif
 170
 171 #define S_IRUSR __S_IREAD       /* Read by owner.  */
 172 #define S_IWUSR __S_IWRITE      /* Write by owner.  */
 173 #define S_IXUSR __S_IEXEC       /* Execute by owner.  */
 174 /* Read, write, and execute by owner.  */
 175 #define S_IRWXU (__S_IREAD|__S_IWRITE|__S_IEXEC)
 176
 177 #if defined __USE_MISC && defined __USE_BSD
 178 # define S_IREAD        S_IRUSR
 179 # define S_IWRITE       S_IWUSR
 180 # define S_IEXEC        S_IXUSR
 181 #endif
 182
 183 #define S_IRGRP (S_IRUSR >> 3)  /* Read by group.  */
 184 #define S_IWGRP (S_IWUSR >> 3)  /* Write by group.  */
 185 #define S_IXGRP (S_IXUSR >> 3)  /* Execute by group.  */
 186 /* Read, write, and execute by group.  */
 187 #define S_IRWXG (S_IRWXU >> 3)
 188
 189 #define S_IROTH (S_IRGRP >> 3)  /* Read by others.  */
 190 #define S_IWOTH (S_IWGRP >> 3)  /* Write by others.  */
 191 #define S_IXOTH (S_IXGRP >> 3)  /* Execute by others.  */
 192 /* Read, write, and execute by others.  */
 193 #define S_IRWXO (S_IRWXG >> 3)
 194
 195
 196 #ifdef  __USE_BSD
 197 /* Macros for common mode bit masks.  */
 198 # define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
 199 # define ALLPERMS (S_ISUID|S_ISGID|S_ISVTX|S_IRWXU|S_IRWXG|S_IRWXO)/* 07777 */
 200 # define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)/* 0666*/
 201
 202 # define S_BLKSIZE      512     /* Block size for `st_blocks'.  */
 203 #endif
 204
 205
 206 #ifndef __USE_FILE_OFFSET64
 207 /* Get file attributes for FILE and put them in BUF.  */
 208 extern int stat (__const char *__restrict __file,
 209                  struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
 210
 211 /* Get file attributes for the file, device, pipe, or socket
 212    that file descriptor FD is open on and put them in BUF.  */
 213 extern int fstat (int __fd, struct stat *__buf) __THROW __nonnull ((2));
 214 #else
 215 # ifdef __REDIRECT_NTH
 216 extern int __REDIRECT_NTH (stat, (__const char *__restrict __file,
 217                                   struct stat *__restrict __buf), stat64)
 218      __nonnull ((1, 2));
 219 extern int __REDIRECT_NTH (fstat, (int __fd, struct stat *__buf), fstat64)
 220      __nonnull ((2));
 221 # else
 222 #  define stat stat64
 223 #  define fstat fstat64
 224 # endif
 225 #endif
 226 #ifdef __USE_LARGEFILE64
 227 extern int stat64 (__const char *__restrict __file,
 228                    struct stat64 *__restrict __buf) __THROW __nonnull ((1, 2));
 229 extern int fstat64 (int __fd, struct stat64 *__buf) __THROW __nonnull ((2));
 230 #endif
 231
 232 #ifdef __USE_ATFILE
 233 /* Similar to stat, get the attributes for FILE and put them in BUF.
 234    Relative path names are interpreted relative to FD unless FD is
 235    AT_FDCWD.  */
 236 # ifndef __USE_FILE_OFFSET64
 237 extern int fstatat (int __fd, __const char *__restrict __file,
 238                     struct stat *__restrict __buf, int __flag)
 239      __THROW __nonnull ((2, 3));
 240 # else
 241 #  ifdef __REDIRECT_NTH
 242 extern int __REDIRECT_NTH (fstatat, (int __fd, __const char *__restrict __file,
 243                                      struct stat *__restrict __buf,
 244                                      int __flag),
 245                            fstatat64) __nonnull ((2, 3));
 246 #  else
 247 #   define fstatat fstatat64
 248 #  endif
 249 # endif
 250
 251 extern int fstatat64 (int __fd, __const char *__restrict __file,
 252                       struct stat64 *__restrict __buf, int __flag)
 253      __THROW __nonnull ((2, 3));
 254 #endif
 255
 256 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 257 # ifndef __USE_FILE_OFFSET64
 258 /* Get file attributes about FILE and put them in BUF.
 259    If FILE is a symbolic link, do not follow it.  */
 260 extern int lstat (__const char *__restrict __file,
 261                   struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
 262 # else
 263 #  ifdef __REDIRECT_NTH
 264 extern int __REDIRECT_NTH (lstat,
 265                            (__const char *__restrict __file,
 266                             struct stat *__restrict __buf), lstat64)
 267      __nonnull ((1, 2));
 268 #  else
 269 #   define lstat lstat64
 270 #  endif
 271 # endif
 272 # ifdef __USE_LARGEFILE64
 273 extern int lstat64 (__const char *__restrict __file,
 274                     struct stat64 *__restrict __buf)
 275      __THROW __nonnull ((1, 2));
 276 # endif
 277 #endif
 278
 279 /* Set file access permissions for FILE to MODE.
 280    If FILE is a symbolic link, this affects its target instead.  */
 281 extern int chmod (__const char *__file, __mode_t __mode)
 282      __THROW __nonnull ((1));
 283
 284 #ifdef __USE_BSD
 285 /* Set file access permissions for FILE to MODE.
 286    If FILE is a symbolic link, this affects the link itself
 287    rather than its target.  */
 288 extern int lchmod (__const char *__file, __mode_t __mode)
 289      __THROW __nonnull ((1));
 290 #endif
 291
 292 /* Set file access permissions of the file FD is open on to MODE.  */
 293 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 294 extern int fchmod (int __fd, __mode_t __mode) __THROW;
 295 #endif
 296
 297 #ifdef __USE_ATFILE
 298 /* Set file access permissions of FILE relative to
 299    the directory FD is open on.  */
 300 extern int fchmodat (int __fd, __const char *__file, __mode_t mode, int __flag)
 301      __THROW __nonnull ((2)) __wur;
 302 #endif /* Use ATFILE.  */
 303
 304
 305
 306 /* Set the file creation mask of the current process to MASK,
 307    and return the old creation mask.  */
 308 extern __mode_t umask (__mode_t __mask) __THROW;
 309
 310 #ifdef  __USE_GNU
 311 /* Get the current `umask' value without changing it.
 312    This function is only available under the GNU Hurd.  */
 313 extern __mode_t getumask (void) __THROW;
 314 #endif
 315
 316 /* Create a new directory named PATH, with permission bits MODE.  */
 317 extern int mkdir (__const char *__path, __mode_t __mode)
 318      __THROW __nonnull ((1));
 319
 320 #ifdef __USE_ATFILE
 321 /* Like mkdir, create a new directory with permission bits MODE.  But
 322    interpret relative PATH names relative to the directory associated
 323    with FD.  */
 324 extern int mkdirat (int __fd, __const char *__path, __mode_t __mode)
 325      __THROW __nonnull ((2));
 326 #endif
 327
 328 /* Create a device file named PATH, with permission and special bits MODE
 329    and device number DEV (which can be constructed from major and minor
 330    device numbers with the `makedev' macro above).  */
 331 #if defined __USE_MISC || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 332 extern int mknod (__const char *__path, __mode_t __mode, __dev_t __dev)
 333      __THROW __nonnull ((1));
 334 #endif
 335
 336 #ifdef __USE_ATFILE
 337 /* Like mknod, create a new device file with permission bits MODE and
 338    device number DEV.  But interpret relative PATH names relative to
 339    the directory associated with FD.  */
 340 extern int mknodat (int __fd, __const char *__path, __mode_t __mode,
 341                     __dev_t __dev) __THROW __nonnull ((2));
 342 #endif
 343
 344
 345 /* Create a new FIFO named PATH, with permission bits MODE.  */
 346 extern int mkfifo (__const char *__path, __mode_t __mode)
 347      __THROW __nonnull ((1));
 348
 349 #ifdef __USE_ATFILE
 350 /* Like mkfifo, create a new FIFO with permission bits MODE.  But
 351    interpret relative PATH names relative to the directory associated
 352    with FD.  */
 353 extern int mkfifoat (int __fd, __const char *__path, __mode_t __mode)
 354      __THROW __nonnull ((2));
 355 #endif
 356 \f
 357 #ifdef __USE_ATFILE
 358 /* Set file access and modification times relative to directory file
 359    descriptor.  */
 360 extern int utimensat (int __fd, __const char *__path,
 361                       __const struct timespec __times[2],
 362                       int __flags)
 363      __THROW __nonnull ((2));
 364 #endif
 365
 366 #ifdef __USE_GNU
 367 /* XXX This will change to the macro for the next 2008 POSIX revision.  */
 368 /* Set file access and modification times of the file associated with FD.  */
 369 extern int futimens (int __fd, __const struct timespec __times[2]) __THROW;
 370 #endif
 371 \f
 372 /* To allow the `struct stat' structure and the file type `mode_t'
 373    bits to vary without changing shared library major version number,
 374    the `stat' family of functions and `mknod' are in fact inline
 375    wrappers around calls to `xstat', `fxstat', `lxstat', and `xmknod',
 376    which all take a leading version-number argument designating the
 377    data structure and bits used.  <bits/stat.h> defines _STAT_VER with
 378    the version number corresponding to `struct stat' as defined in
 379    that file; and _MKNOD_VER with the version number corresponding to
 380    the S_IF* macros defined therein.  It is arranged that when not
 381    inlined these function are always statically linked; that way a
 382    dynamically-linked executable always encodes the version number
 383    corresponding to the data structures it uses, so the `x' functions
 384    in the shared library can adapt without needing to recompile all
 385    callers.  */
 386
 387 #ifndef _STAT_VER
 388 # define _STAT_VER      0
 389 #endif
 390 #ifndef _MKNOD_VER
 391 # define _MKNOD_VER     0
 392 #endif
 393
 394 /* Wrappers for stat and mknod system calls.  */
 395 #ifndef __USE_FILE_OFFSET64
 396 extern int __fxstat (int __ver, int __fildes, struct stat *__stat_buf)
 397      __THROW __nonnull ((3));
 398 extern int __xstat (int __ver, __const char *__filename,
 399                     struct stat *__stat_buf) __THROW __nonnull ((2, 3));
 400 extern int __lxstat (int __ver, __const char *__filename,
 401                      struct stat *__stat_buf) __THROW __nonnull ((2, 3));
 402 extern int __fxstatat (int __ver, int __fildes, __const char *__filename,
 403                        struct stat *__stat_buf, int __flag)
 404      __THROW __nonnull ((3, 4));
 405 #else
 406 # ifdef __REDIRECT_NTH
 407 extern int __REDIRECT_NTH (__fxstat, (int __ver, int __fildes,
 408                                       struct stat *__stat_buf), __fxstat64)
 409      __nonnull ((3));
 410 extern int __REDIRECT_NTH (__xstat, (int __ver, __const char *__filename,
 411                                      struct stat *__stat_buf), __xstat64)
 412      __nonnull ((2, 3));
 413 extern int __REDIRECT_NTH (__lxstat, (int __ver, __const char *__filename,
 414                                       struct stat *__stat_buf), __lxstat64)
 415      __nonnull ((2, 3));
 416 extern int __REDIRECT_NTH (__fxstatat, (int __ver, int __fildes,
 417                                         __const char *__filename,
 418                                         struct stat *__stat_buf, int __flag),
 419                            __fxstatat64) __nonnull ((3, 4));
 420
 421 # else
 422 #  define __fxstat __fxstat64
 423 #  define __xstat __xstat64
 424 #  define __lxstat __lxstat64
 425 # endif
 426 #endif
 427
 428 #ifdef __USE_LARGEFILE64
 429 extern int __fxstat64 (int __ver, int __fildes, struct stat64 *__stat_buf)
 430      __THROW __nonnull ((3));
 431 extern int __xstat64 (int __ver, __const char *__filename,
 432                       struct stat64 *__stat_buf) __THROW __nonnull ((2, 3));
 433 extern int __lxstat64 (int __ver, __const char *__filename,
 434                        struct stat64 *__stat_buf) __THROW __nonnull ((2, 3));
 435 extern int __fxstatat64 (int __ver, int __fildes, __const char *__filename,
 436                          struct stat64 *__stat_buf, int __flag)
 437      __THROW __nonnull ((3, 4));
 438 #endif
 439 extern int __xmknod (int __ver, __const char *__path, __mode_t __mode,
 440                      __dev_t *__dev) __THROW __nonnull ((2, 4));
 441
 442 extern int __xmknodat (int __ver, int __fd, __const char *__path,
 443                        __mode_t __mode, __dev_t *__dev)
 444      __THROW __nonnull ((3, 5));
 445
 446 #if defined __GNUC__ && __GNUC__ >= 2
 447 /* Inlined versions of the real stat and mknod functions.  */
 448
 449 __extern_inline int
 450 __NTH (stat (__const char *__path, struct stat *__statbuf))
 451 {
 452   return __xstat (_STAT_VER, __path, __statbuf);
 453 }
 454
 455 # if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 456 __extern_inline int
 457 __NTH (lstat (__const char *__path, struct stat *__statbuf))
 458 {
 459   return __lxstat (_STAT_VER, __path, __statbuf);
 460 }
 461 # endif
 462
 463 __extern_inline int
 464 __NTH (fstat (int __fd, struct stat *__statbuf))
 465 {
 466   return __fxstat (_STAT_VER, __fd, __statbuf);
 467 }
 468
 469 # ifdef __USE_ATFILE
 470 __extern_inline int
 471 __NTH (fstatat (int __fd, __const char *__filename, struct stat *__statbuf,
 472                 int __flag))
 473 {
 474   return __fxstatat (_STAT_VER, __fd, __filename, __statbuf, __flag);
 475 }
 476 # endif
 477
 478 # if defined __USE_MISC || defined __USE_BSD
 479 __extern_inline int
 480 __NTH (mknod (__const char *__path, __mode_t __mode, __dev_t __dev))
 481 {
 482   return __xmknod (_MKNOD_VER, __path, __mode, &__dev);
 483 }
 484 # endif
 485
 486 # ifdef __USE_ATFILE
 487 __extern_inline int
 488 __NTH (mknodat (int __fd, __const char *__path, __mode_t __mode,
 489                 __dev_t __dev))
 490 {
 491   return __xmknodat (_MKNOD_VER, __fd, __path, __mode, &__dev);
 492 }
 493 # endif
 494
 495 # if defined __USE_LARGEFILE64 \
 496   && (! defined __USE_FILE_OFFSET64 \
 497       || (defined __REDIRECT_NTH && defined __OPTIMIZE__))
 498 __extern_inline int
 499 __NTH (stat64 (__const char *__path, struct stat64 *__statbuf))
 500 {
 501   return __xstat64 (_STAT_VER, __path, __statbuf);
 502 }
 503
 504 #  if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
 505 __extern_inline int
 506 __NTH (lstat64 (__const char *__path, struct stat64 *__statbuf))
 507 {
 508   return __lxstat64 (_STAT_VER, __path, __statbuf);
 509 }
 510 #  endif
 511
 512 __extern_inline int
 513 __NTH (fstat64 (int __fd, struct stat64 *__statbuf))
 514 {
 515   return __fxstat64 (_STAT_VER, __fd, __statbuf);
 516 }
 517
 518 #  ifdef __USE_GNU
 519 __extern_inline int
 520 __NTH (fstatat64 (int __fd, __const char *__filename, struct stat64 *__statbuf,
 521                   int __flag))
 522 {
 523   return __fxstatat64 (_STAT_VER, __fd, __filename, __statbuf, __flag);
 524 }
 525 #  endif
 526
 527 # endif
 528
 529 #endif
 530
 531 __END_DECLS
 532
 533
 534 #endif /* sys/stat.h  */