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