]>
git.ipfire.org Git - thirdparty/glibc.git/blob - io/sys/stat.h
7a8c8b3e1e91566876bba492487b1ccc49888898
1 /* Copyright (C) 1991, 92, 1995-1999, 2000 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
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 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. */
20 * POSIX Standard: 5.6 File Characteristics <sys/stat.h>
28 #include <bits/types.h> /* For __mode_t and __dev_t. */
31 # define __need_time_t
32 # include <time.h> /* For time_t. */
34 /* The Single Unix specification says that some more types are
36 # ifndef __dev_t_defined
37 typedef __dev_t dev_t
;
38 # define __dev_t_defined
41 # ifndef __gid_t_defined
42 typedef __gid_t gid_t
;
43 # define __gid_t_defined
46 # ifndef __ino_t_defined
47 # ifndef __USE_FILE_OFFSET64
48 typedef __ino_t ino_t
;
50 typedef __ino64_t ino_t
;
52 # define __ino_t_defined
55 # ifndef __mode_t_defined
56 typedef __mode_t mode_t
;
57 # define __mode_t_defined
60 # ifndef __nlink_t_defined
61 typedef __nlink_t nlink_t
;
62 # define __nlink_t_defined
65 # ifndef __off_t_defined
66 # ifndef __USE_FILE_OFFSET64
67 typedef __off_t off_t
;
69 typedef __off64_t off_t
;
71 # define __off_t_defined
74 # ifndef __uid_t_defined
75 typedef __uid_t uid_t
;
76 # define __uid_t_defined
81 # ifndef __blkcnt_t_defined
82 # ifndef __USE_FILE_OFFSET64
83 typedef __blkcnt_t blkcnt_t
;
85 typedef __blkcnt64_t blkcnt_t
;
87 # define __blkcnt_t_defined
90 # ifndef __blksize_t_defined
91 typedef __blksize_t blksize_t
;
92 # define __blksize_t_defined
98 #include <bits/stat.h>
100 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
101 # define S_IFMT __S_IFMT
102 # define S_IFDIR __S_IFDIR
103 # define S_IFCHR __S_IFCHR
104 # define S_IFBLK __S_IFBLK
105 # define S_IFREG __S_IFREG
107 # define S_IFIFO __S_IFIFO
110 # define S_IFLNK __S_IFLNK
112 # if (defined __USE_BSD || defined __USE_MISC) && defined __S_IFSOCK
113 # define S_IFSOCK __S_IFSOCK
117 /* Test macros for file types. */
119 #define __S_ISTYPE(mode, mask) (((mode) & __S_IFMT) == (mask))
121 #define S_ISDIR(mode) __S_ISTYPE((mode), __S_IFDIR)
122 #define S_ISCHR(mode) __S_ISTYPE((mode), __S_IFCHR)
123 #define S_ISBLK(mode) __S_ISTYPE((mode), __S_IFBLK)
124 #define S_ISREG(mode) __S_ISTYPE((mode), __S_IFREG)
126 # define S_ISFIFO(mode) __S_ISTYPE((mode), __S_IFIFO)
129 # define S_ISLNK(mode) __S_ISTYPE((mode), __S_IFLNK)
134 # define S_ISLNK(mode) 0
137 # define S_ISSOCK(mode) __S_ISTYPE((mode), __S_IFSOCK)
141 /* These are from POSIX.1b. If the objects are not implemented using separate
142 distinct file types, the macros always will evaluate to zero. Unlike the
143 other S_* macros the following three take a pointer to a `struct stat'
144 object as the argument. */
145 #ifdef __USE_POSIX199309
146 # define S_TYPEISMQ(buf) __S_TYPEISMQ(buf)
147 # define S_TYPEISSEM(buf) __S_TYPEISSEM(buf)
148 # define S_TYPEISSHM(buf) __S_TYPEISSHM(buf)
152 /* Protection bits. */
154 #define S_ISUID __S_ISUID /* Set user ID on execution. */
155 #define S_ISGID __S_ISGID /* Set group ID on execution. */
157 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
158 /* Save swapped text after use (sticky bit). This is pretty well obsolete. */
159 # define S_ISVTX __S_ISVTX
162 #define S_IRUSR __S_IREAD /* Read by owner. */
163 #define S_IWUSR __S_IWRITE /* Write by owner. */
164 #define S_IXUSR __S_IEXEC /* Execute by owner. */
165 /* Read, write, and execute by owner. */
166 #define S_IRWXU (__S_IREAD|__S_IWRITE|__S_IEXEC)
168 #if defined __USE_MISC && defined __USE_BSD
169 # define S_IREAD S_IRUSR
170 # define S_IWRITE S_IWUSR
171 # define S_IEXEC S_IXUSR
174 #define S_IRGRP (S_IRUSR >> 3) /* Read by group. */
175 #define S_IWGRP (S_IWUSR >> 3) /* Write by group. */
176 #define S_IXGRP (S_IXUSR >> 3) /* Execute by group. */
177 /* Read, write, and execute by group. */
178 #define S_IRWXG (S_IRWXU >> 3)
180 #define S_IROTH (S_IRGRP >> 3) /* Read by others. */
181 #define S_IWOTH (S_IWGRP >> 3) /* Write by others. */
182 #define S_IXOTH (S_IXGRP >> 3) /* Execute by others. */
183 /* Read, write, and execute by others. */
184 #define S_IRWXO (S_IRWXG >> 3)
188 /* Macros for common mode bit masks. */
189 # define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
190 # define ALLPERMS (S_ISUID|S_ISGID|S_ISVTX|S_IRWXU|S_IRWXG|S_IRWXO)/* 07777 */
191 # define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)/* 0666*/
193 # define S_BLKSIZE 512 /* Block size for `st_blocks'. */
197 #ifndef __USE_FILE_OFFSET64
198 /* Get file attributes for FILE and put them in BUF. */
199 extern int stat (__const
char *__file
, struct stat
*__buf
) __THROW
;
201 /* Get file attributes for the file, device, pipe, or socket
202 that file descriptor FD is open on and put them in BUF. */
203 extern int fstat (int __fd
, struct stat
*__buf
) __THROW
;
206 extern int __REDIRECT (stat
,
207 (__const
char *__file
, struct stat
*__buf
) __THROW
,
209 extern int __REDIRECT (fstat
, (int __fd
, struct stat
*__buf
) __THROW
, fstat64
);
212 # define fstat fstat64
215 #ifdef __USE_LARGEFILE64
216 extern int stat64 (__const
char *__file
, struct stat64
*__buf
) __THROW
;
217 extern int fstat64 (int __fd
, struct stat64
*__buf
) __THROW
;
220 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
221 # ifndef __USE_FILE_OFFSET64
222 /* Get file attributes about FILE and put them in BUF.
223 If FILE is a symbolic link, do not follow it. */
224 extern int lstat (__const
char *__file
, struct stat
*__buf
) __THROW
;
227 extern int __REDIRECT (lstat
,
228 (__const
char *__file
, struct stat
*__buf
) __THROW
,
231 # define lstat lstat64
234 # ifdef __USE_LARGEFILE64
235 extern int lstat64 (__const
char *__file
, struct stat64
*__buf
) __THROW
;
239 /* Set file access permissions for FILE to MODE.
240 This takes an `int' MODE argument because that
241 is what `mode_t's get widened to. */
242 extern int chmod (__const
char *__file
, __mode_t __mode
) __THROW
;
244 /* Set file access permissions of the file FD is open on to MODE. */
245 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
246 extern int fchmod (int __fd
, __mode_t __mode
) __THROW
;
250 /* Set the file creation mask of the current process to MASK,
251 and return the old creation mask. */
252 extern __mode_t
umask (__mode_t __mask
) __THROW
;
255 /* Get the current `umask' value without changing it.
256 This function is only available under the GNU Hurd. */
257 extern __mode_t
getumask (void) __THROW
;
260 /* Create a new directory named PATH, with permission bits MODE. */
261 extern int mkdir (__const
char *__path
, __mode_t __mode
) __THROW
;
263 /* Create a device file named PATH, with permission and special bits MODE
264 and device number DEV (which can be constructed from major and minor
265 device numbers with the `makedev' macro above). */
266 #if defined __USE_MISC || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
267 extern int mknod (__const
char *__path
, __mode_t __mode
, __dev_t __dev
)
272 /* Create a new FIFO named PATH, with permission bits MODE. */
273 extern int mkfifo (__const
char *__path
, __mode_t __mode
) __THROW
;
275 /* To allow the `struct stat' structure and the file type `mode_t'
276 bits to vary without changing shared library major version number,
277 the `stat' family of functions and `mknod' are in fact inline
278 wrappers around calls to `xstat', `fxstat', `lxstat', and `xmknod',
279 which all take a leading version-number argument designating the
280 data structure and bits used. <bits/stat.h> defines _STAT_VER with
281 the version number corresponding to `struct stat' as defined in
282 that file; and _MKNOD_VER with the version number corresponding to
283 the S_IF* macros defined therein. It is arranged that when not
284 inlined these function are always statically linked; that way a
285 dynamically-linked executable always encodes the version number
286 corresponding to the data structures it uses, so the `x' functions
287 in the shared library can adapt without needing to recompile all
294 # define _MKNOD_VER 0
297 /* Wrappers for stat and mknod system calls. */
298 #ifndef __USE_FILE_OFFSET64
299 extern int __fxstat (int __ver
, int __fildes
, struct stat
*__stat_buf
) __THROW
;
300 extern int __xstat (int __ver
, __const
char *__filename
,
301 struct stat
*__stat_buf
) __THROW
;
302 extern int __lxstat (int __ver
, __const
char *__filename
,
303 struct stat
*__stat_buf
) __THROW
;
306 extern int __REDIRECT (__fxstat
, (int __ver
, int __fildes
,
307 struct stat
*__stat_buf
) __THROW
,
309 extern int __REDIRECT (__xstat
, (int __ver
, __const
char *__filename
,
310 struct stat
*__stat_buf
) __THROW
, __xstat64
);
311 extern int __REDIRECT (__lxstat
, (int __ver
, __const
char *__filename
,
312 struct stat
*__stat_buf
) __THROW
,
316 # define __fxstat __fxstat64
317 # define __xstat __xstat64
318 # define __lxstat __lxstat64
322 #ifdef __USE_LARGEFILE64
323 extern int __fxstat64 (int __ver
, int __fildes
, struct stat64
*__stat_buf
)
325 extern int __xstat64 (int __ver
, __const
char *__filename
,
326 struct stat64
*__stat_buf
) __THROW
;
327 extern int __lxstat64 (int __ver
, __const
char *__filename
,
328 struct stat64
*__stat_buf
) __THROW
;
330 extern int __xmknod (int __ver
, __const
char *__path
, __mode_t __mode
,
331 __dev_t
*__dev
) __THROW
;
333 #if defined __GNUC__ && __GNUC__ >= 2
334 /* Inlined versions of the real stat and mknod functions. */
336 extern __inline__
int stat (__const
char *__path
,
337 struct stat
*__statbuf
) __THROW
339 return __xstat (_STAT_VER
, __path
, __statbuf
);
342 # if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
343 extern __inline__
int lstat (__const
char *__path
,
344 struct stat
*__statbuf
) __THROW
346 return __lxstat (_STAT_VER
, __path
, __statbuf
);
350 extern __inline__
int fstat (int __fd
, struct stat
*__statbuf
) __THROW
352 return __fxstat (_STAT_VER
, __fd
, __statbuf
);
355 # if defined __USE_MISC || defined __USE_BSD
356 extern __inline__
int mknod (__const
char *__path
, __mode_t __mode
,
357 __dev_t __dev
) __THROW
359 return __xmknod (_MKNOD_VER
, __path
, __mode
, &__dev
);
363 # if defined __USE_LARGEFILE64 \
364 && (! defined __USE_FILE_OFFSET64 \
365 || (defined __REDIRECT && defined __OPTIMIZE__))
366 extern __inline__
int stat64 (__const
char *__path
,
367 struct stat64
*__statbuf
) __THROW
369 return __xstat64 (_STAT_VER
, __path
, __statbuf
);
372 # if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
373 extern __inline__
int lstat64 (__const
char *__path
,
374 struct stat64
*__statbuf
) __THROW
376 return __lxstat64 (_STAT_VER
, __path
, __statbuf
);
380 extern __inline__
int fstat64 (int __fd
, struct stat64
*__statbuf
) __THROW
382 return __fxstat64 (_STAT_VER
, __fd
, __statbuf
);
391 #endif /* sys/stat.h */