1 /* Copyright (C) 1991, 1992, 1995-2004, 2005, 2006, 2007, 2009
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, see
17    <http://www.gnu.org/licenses/>.  */
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_XOPEN2K || defined __USE_MISC \
31          || defined __USE_ATFILE
32 # if defined __USE_XOPEN || defined __USE_XOPEN2K
33 #  define __need_time_t
34 # endif
35 # if defined __USE_MISC || defined __USE_ATFILE || defined __USE_XOPEN2K8
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 __USE_XOPEN2K) \
122      && defined __S_IFSOCK
123 #  define S_IFSOCK	__S_IFSOCK
124 # endif
125 #endif
126 
127 /* Test macros for file types.	*/
128 
129 #define	__S_ISTYPE(mode, mask)	(((mode) & __S_IFMT) == (mask))
130 
131 #define	S_ISDIR(mode)	 __S_ISTYPE((mode), __S_IFDIR)
132 #define	S_ISCHR(mode)	 __S_ISTYPE((mode), __S_IFCHR)
133 #define	S_ISBLK(mode)	 __S_ISTYPE((mode), __S_IFBLK)
134 #define	S_ISREG(mode)	 __S_ISTYPE((mode), __S_IFREG)
135 #ifdef __S_IFIFO
136 # define S_ISFIFO(mode)	 __S_ISTYPE((mode), __S_IFIFO)
137 #endif
138 #ifdef __S_IFLNK
139 # define S_ISLNK(mode)	 __S_ISTYPE((mode), __S_IFLNK)
140 #endif
141 
142 #if defined __USE_BSD && !defined __S_IFLNK
143 # define S_ISLNK(mode)  0
144 #endif
145 
146 #if (defined __USE_BSD || defined __USE_UNIX98 || defined __USE_XOPEN2K) \
147     && defined __S_IFSOCK
148 # define S_ISSOCK(mode) __S_ISTYPE((mode), __S_IFSOCK)
149 #endif
150 
151 /* These are from POSIX.1b.  If the objects are not implemented using separate
152    distinct file types, the macros always will evaluate to zero.  Unlike the
153    other S_* macros the following three take a pointer to a `struct stat'
154    object as the argument.  */
155 #ifdef	__USE_POSIX199309
156 # define S_TYPEISMQ(buf) __S_TYPEISMQ(buf)
157 # define S_TYPEISSEM(buf) __S_TYPEISSEM(buf)
158 # define S_TYPEISSHM(buf) __S_TYPEISSHM(buf)
159 #endif
160 
161 
162 /* Protection bits.  */
163 
164 #define	S_ISUID __S_ISUID	/* Set user ID on execution.  */
165 #define	S_ISGID	__S_ISGID	/* Set group ID on execution.  */
166 
167 #if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
168 /* Save swapped text after use (sticky bit).  This is pretty well obsolete.  */
169 # define S_ISVTX	__S_ISVTX
170 #endif
171 
172 #define	S_IRUSR	__S_IREAD	/* Read by owner.  */
173 #define	S_IWUSR	__S_IWRITE	/* Write by owner.  */
174 #define	S_IXUSR	__S_IEXEC	/* Execute by owner.  */
175 /* Read, write, and execute by owner.  */
176 #define	S_IRWXU	(__S_IREAD|__S_IWRITE|__S_IEXEC)
177 
178 #if defined __USE_MISC && defined __USE_BSD
179 # define S_IREAD	S_IRUSR
180 # define S_IWRITE	S_IWUSR
181 # define S_IEXEC	S_IXUSR
182 #endif
183 
184 #define	S_IRGRP	(S_IRUSR >> 3)	/* Read by group.  */
185 #define	S_IWGRP	(S_IWUSR >> 3)	/* Write by group.  */
186 #define	S_IXGRP	(S_IXUSR >> 3)	/* Execute by group.  */
187 /* Read, write, and execute by group.  */
188 #define	S_IRWXG	(S_IRWXU >> 3)
189 
190 #define	S_IROTH	(S_IRGRP >> 3)	/* Read by others.  */
191 #define	S_IWOTH	(S_IWGRP >> 3)	/* Write by others.  */
192 #define	S_IXOTH	(S_IXGRP >> 3)	/* Execute by others.  */
193 /* Read, write, and execute by others.  */
194 #define	S_IRWXO	(S_IRWXG >> 3)
195 
196 
197 #ifdef	__USE_BSD
198 /* Macros for common mode bit masks.  */
199 # define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
200 # define ALLPERMS (S_ISUID|S_ISGID|S_ISVTX|S_IRWXU|S_IRWXG|S_IRWXO)/* 07777 */
201 # define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)/* 0666*/
202 
203 # define S_BLKSIZE	512	/* Block size for `st_blocks'.  */
204 #endif
205 
206 
207 #ifndef __USE_FILE_OFFSET64
208 /* Get file attributes for FILE and put them in BUF.  */
209 extern int stat (const char *__restrict __file,
210 		 struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
211 libc_hidden_proto(stat)
212 
213 /* Get file attributes for the file, device, pipe, or socket
214    that file descriptor FD is open on and put them in BUF.  */
215 extern int fstat (int __fd, struct stat *__buf) __THROW __nonnull ((2));
216 libc_hidden_proto(fstat)
217 #else
218 # ifdef __REDIRECT_NTH
219 extern int __REDIRECT_NTH (stat, (const char *__restrict __file,
220 				  struct stat *__restrict __buf), stat64)
221      __nonnull ((1, 2));
222 extern int __REDIRECT_NTH (fstat, (int __fd, struct stat *__buf), fstat64)
223      __nonnull ((2));
224 # else
225 #  define stat stat64
226 #  define fstat fstat64
227 # endif
228 #endif
229 #ifdef __USE_LARGEFILE64
230 extern int stat64 (const char *__restrict __file,
231 		   struct stat64 *__restrict __buf) __THROW __nonnull ((1, 2));
232 extern int fstat64 (int __fd, struct stat64 *__buf) __THROW __nonnull ((2));
233 libc_hidden_proto(stat64)
234 libc_hidden_proto(fstat64)
235 #endif
236 
237 #ifdef __USE_ATFILE
238 /* Similar to stat, get the attributes for FILE and put them in BUF.
239    Relative path names are interpreted relative to FD unless FD is
240    AT_FDCWD.  */
241 # ifndef __USE_FILE_OFFSET64
242 extern int fstatat (int __fd, const char *__restrict __file,
243 		    struct stat *__restrict __buf, int __flag)
244      __THROW __nonnull ((2, 3));
245 libc_hidden_proto(fstatat)
246 # else
247 #  ifdef __REDIRECT_NTH
248 extern int __REDIRECT_NTH (fstatat, (int __fd, const char *__restrict __file,
249 				     struct stat *__restrict __buf,
250 				     int __flag),
251 			   fstatat64) __nonnull ((2, 3));
252 #  else
253 #   define fstatat fstatat64
254 #  endif
255 # endif
256 
257 # ifdef __USE_LARGEFILE64
258 extern int fstatat64 (int __fd, const char *__restrict __file,
259 		      struct stat64 *__restrict __buf, int __flag)
260      __THROW __nonnull ((2, 3));
261 libc_hidden_proto(fstatat64)
262 # endif
263 #endif
264 
265 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
266 # ifndef __USE_FILE_OFFSET64
267 /* Get file attributes about FILE and put them in BUF.
268    If FILE is a symbolic link, do not follow it.  */
269 extern int lstat (const char *__restrict __file,
270 		  struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
271 libc_hidden_proto(lstat)
272 # else
273 #  ifdef __REDIRECT_NTH
274 extern int __REDIRECT_NTH (lstat,
275 			   (const char *__restrict __file,
276 			    struct stat *__restrict __buf), lstat64)
277      __nonnull ((1, 2));
278 #  else
279 #   define lstat lstat64
280 #  endif
281 # endif
282 # ifdef __USE_LARGEFILE64
283 extern int lstat64 (const char *__restrict __file,
284 		    struct stat64 *__restrict __buf)
285      __THROW __nonnull ((1, 2));
286 libc_hidden_proto(lstat64)
287 # endif
288 #endif
289 
290 /* Set file access permissions for FILE to MODE.
291    If FILE is a symbolic link, this affects its target instead.  */
292 extern int chmod (const char *__file, __mode_t __mode)
293      __THROW __nonnull ((1));
294 libc_hidden_proto(chmod)
295 
296 #if 0 /*def __USE_BSD*/
297 /* Set file access permissions for FILE to MODE.
298    If FILE is a symbolic link, this affects the link itself
299    rather than its target.  */
300 extern int lchmod (const char *__file, __mode_t __mode)
301      __THROW __nonnull ((1));
302 #endif
303 
304 /* Set file access permissions of the file FD is open on to MODE.  */
305 #if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
306 extern int fchmod (int __fd, __mode_t __mode) __THROW;
307 #endif
308 
309 #ifdef __USE_ATFILE
310 /* Set file access permissions of FILE relative to
311    the directory FD is open on.  */
312 extern int fchmodat (int __fd, const char *__file, __mode_t __mode,
313 		     int __flag)
314      __THROW __nonnull ((2)) __wur;
315 libc_hidden_proto(fchmodat)
316 #endif /* Use ATFILE.  */
317 
318 
319 
320 /* Set the file creation mask of the current process to MASK,
321    and return the old creation mask.  */
322 extern __mode_t umask (__mode_t __mask) __THROW;
323 
324 #if 0 /*def	__USE_GNU*/
325 /* Get the current `umask' value without changing it.
326    This function is only available under the GNU Hurd.  */
327 extern __mode_t getumask (void) __THROW;
328 #endif
329 
330 /* Create a new directory named PATH, with permission bits MODE.  */
331 extern int mkdir (const char *__path, __mode_t __mode)
332      __THROW __nonnull ((1));
333 libc_hidden_proto(mkdir)
334 
335 #ifdef __USE_ATFILE
336 /* Like mkdir, create a new directory with permission bits MODE.  But
337    interpret relative PATH names relative to the directory associated
338    with FD.  */
339 extern int mkdirat (int __fd, const char *__path, __mode_t __mode)
340      __THROW __nonnull ((2));
341 libc_hidden_proto(mkdirat)
342 #endif
343 
344 /* Create a device file named PATH, with permission and special bits MODE
345    and device number DEV (which can be constructed from major and minor
346    device numbers with the `makedev' macro above).  */
347 #if defined __USE_MISC || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
348 extern int mknod (const char *__path, __mode_t __mode, __dev_t __dev)
349      __THROW __nonnull ((1));
350 libc_hidden_proto(mknod)
351 
352 # ifdef __USE_ATFILE
353 /* Like mknod, create a new device file with permission bits MODE and
354    device number DEV.  But interpret relative PATH names relative to
355    the directory associated with FD.  */
356 extern int mknodat (int __fd, const char *__path, __mode_t __mode,
357 		    __dev_t __dev) __THROW __nonnull ((2));
358 libc_hidden_proto(mknodat)
359 # endif
360 #endif
361 
362 
363 /* Create a new FIFO named PATH, with permission bits MODE.  */
364 extern int mkfifo (const char *__path, __mode_t __mode)
365      __THROW __nonnull ((1));
366 
367 #ifdef __USE_ATFILE
368 /* Like mkfifo, create a new FIFO with permission bits MODE.  But
369    interpret relative PATH names relative to the directory associated
370    with FD.  */
371 extern int mkfifoat (int __fd, const char *__path, __mode_t __mode)
372      __THROW __nonnull ((2));
373 #endif
374 
375 #ifdef __USE_ATFILE
376 /* Set file access and modification times relative to directory file
377    descriptor.  */
378 extern int utimensat (int __fd, const char *__path,
379 		      const struct timespec __times[2],
380 		      int __flags)
381      __THROW __nonnull ((2));
382 libc_hidden_proto(utimensat)
383 #endif
384 
385 #ifdef __USE_XOPEN2K8
386 /* Set file access and modification times of the file associated with FD.  */
387 extern int futimens (int __fd, const struct timespec __times[2]) __THROW;
388 #endif
389 
390 /* on uClibc we have unversioned struct stat and mknod.
391  * bits/stat.h is filled with wrong info, so we undo it here.  */
392 #undef _STAT_VER
393 #define _STAT_VER 0
394 #undef _MKNOD_VER
395 #define _MKNOD_VER 0
396 
397 #ifdef __UCLIBC_HAVE_STATX__
398 #ifdef __USE_GNU
399 # include <bits/statx.h>
400 #endif
401 #endif
402 
403 
404 __END_DECLS
405 
406 
407 #endif /* sys/stat.h  */
408