blob: 170a4e6332adc857398eb49097ff2169ad585f99 [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001/* 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, 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 || defined __USE_ATFILE
33# if defined __USE_XOPEN || defined __USE_XOPEN2K
34# define __need_time_t
35# endif
36# if defined __USE_MISC || defined __USE_ATFILE
37# define __need_timespec
38# endif
39# include <time.h> /* For time_t resp. timespec. */
40#endif
41
42#if defined __USE_XOPEN || defined __USE_XOPEN2K
43/* The Single Unix specification says that some more types are
44 available here. */
45# ifndef __dev_t_defined
46typedef __dev_t dev_t;
47# define __dev_t_defined
48# endif
49
50# ifndef __gid_t_defined
51typedef __gid_t gid_t;
52# define __gid_t_defined
53# endif
54
55# ifndef __ino_t_defined
56# ifndef __USE_FILE_OFFSET64
57typedef __ino_t ino_t;
58# else
59typedef __ino64_t ino_t;
60# endif
61# define __ino_t_defined
62# endif
63
64# ifndef __mode_t_defined
65typedef __mode_t mode_t;
66# define __mode_t_defined
67# endif
68
69# ifndef __nlink_t_defined
70typedef __nlink_t nlink_t;
71# define __nlink_t_defined
72# endif
73
74# ifndef __off_t_defined
75# ifndef __USE_FILE_OFFSET64
76typedef __off_t off_t;
77# else
78typedef __off64_t off_t;
79# endif
80# define __off_t_defined
81# endif
82
83# ifndef __uid_t_defined
84typedef __uid_t uid_t;
85# define __uid_t_defined
86# endif
87#endif /* X/Open */
88
89#ifdef __USE_UNIX98
90# ifndef __blkcnt_t_defined
91# ifndef __USE_FILE_OFFSET64
92typedef __blkcnt_t blkcnt_t;
93# else
94typedef __blkcnt64_t blkcnt_t;
95# endif
96# define __blkcnt_t_defined
97# endif
98
99# ifndef __blksize_t_defined
100typedef __blksize_t blksize_t;
101# define __blksize_t_defined
102# endif
103#endif /* Unix98 */
104
105__BEGIN_DECLS
106
107#include <bits/stat.h>
108
109#if defined __USE_BSD || defined __USE_MISC || defined __USE_XOPEN
110# define S_IFMT __S_IFMT
111# define S_IFDIR __S_IFDIR
112# define S_IFCHR __S_IFCHR
113# define S_IFBLK __S_IFBLK
114# define S_IFREG __S_IFREG
115# ifdef __S_IFIFO
116# define S_IFIFO __S_IFIFO
117# endif
118# ifdef __S_IFLNK
119# define S_IFLNK __S_IFLNK
120# endif
121# if (defined __USE_BSD || defined __USE_MISC || defined __USE_UNIX98) \
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) \
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. */
209extern int stat (__const char *__restrict __file,
210 struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
211libc_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. */
215extern int fstat (int __fd, struct stat *__buf) __THROW __nonnull ((2));
216libc_hidden_proto(fstat)
217#else
218# ifdef __REDIRECT_NTH
219extern int __REDIRECT_NTH (stat, (__const char *__restrict __file,
220 struct stat *__restrict __buf), stat64)
221 __nonnull ((1, 2));
222extern 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
230extern int stat64 (__const char *__restrict __file,
231 struct stat64 *__restrict __buf) __THROW __nonnull ((1, 2));
232extern int fstat64 (int __fd, struct stat64 *__buf) __THROW __nonnull ((2));
233libc_hidden_proto(stat64)
234libc_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
242extern int fstatat (int __fd, __const char *__restrict __file,
243 struct stat *__restrict __buf, int __flag)
244 __THROW __nonnull ((2, 3));
245# else
246# ifdef __REDIRECT_NTH
247extern int __REDIRECT_NTH (fstatat, (int __fd, __const char *__restrict __file,
248 struct stat *__restrict __buf,
249 int __flag),
250 fstatat64) __nonnull ((2, 3));
251# else
252# define fstatat fstatat64
253# endif
254# endif
255
256# ifdef __USE_LARGEFILE64
257extern int fstatat64 (int __fd, __const char *__restrict __file,
258 struct stat64 *__restrict __buf, int __flag)
259 __THROW __nonnull ((2, 3));
260# endif
261#endif
262
263#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K
264# ifndef __USE_FILE_OFFSET64
265/* Get file attributes about FILE and put them in BUF.
266 If FILE is a symbolic link, do not follow it. */
267extern int lstat (__const char *__restrict __file,
268 struct stat *__restrict __buf) __THROW __nonnull ((1, 2));
269libc_hidden_proto(lstat)
270# else
271# ifdef __REDIRECT_NTH
272extern int __REDIRECT_NTH (lstat,
273 (__const char *__restrict __file,
274 struct stat *__restrict __buf), lstat64)
275 __nonnull ((1, 2));
276# else
277# define lstat lstat64
278# endif
279# endif
280# ifdef __USE_LARGEFILE64
281extern int lstat64 (__const char *__restrict __file,
282 struct stat64 *__restrict __buf)
283 __THROW __nonnull ((1, 2));
284libc_hidden_proto(lstat64)
285# endif
286#endif
287
288/* Set file access permissions for FILE to MODE.
289 If FILE is a symbolic link, this affects its target instead. */
290extern int chmod (__const char *__file, __mode_t __mode)
291 __THROW __nonnull ((1));
292libc_hidden_proto(chmod)
293
294#if 0 /*def __USE_BSD*/
295/* Set file access permissions for FILE to MODE.
296 If FILE is a symbolic link, this affects the link itself
297 rather than its target. */
298extern int lchmod (__const char *__file, __mode_t __mode)
299 __THROW __nonnull ((1));
300#endif
301
302/* Set file access permissions of the file FD is open on to MODE. */
303#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
304extern int fchmod (int __fd, __mode_t __mode) __THROW;
305#endif
306
307#ifdef __USE_ATFILE
308/* Set file access permissions of FILE relative to
309 the directory FD is open on. */
310extern int fchmodat (int __fd, __const char *__file, __mode_t __mode,
311 int __flag)
312 __THROW __nonnull ((2)) __wur;
313#endif /* Use ATFILE. */
314
315
316
317/* Set the file creation mask of the current process to MASK,
318 and return the old creation mask. */
319extern __mode_t umask (__mode_t __mask) __THROW;
320
321#if 0 /*def __USE_GNU*/
322/* Get the current `umask' value without changing it.
323 This function is only available under the GNU Hurd. */
324extern __mode_t getumask (void) __THROW;
325#endif
326
327/* Create a new directory named PATH, with permission bits MODE. */
328extern int mkdir (__const char *__path, __mode_t __mode)
329 __THROW __nonnull ((1));
330libc_hidden_proto(mkdir)
331
332#ifdef __USE_ATFILE
333/* Like mkdir, create a new directory with permission bits MODE. But
334 interpret relative PATH names relative to the directory associated
335 with FD. */
336extern int mkdirat (int __fd, __const char *__path, __mode_t __mode)
337 __THROW __nonnull ((2));
338#endif
339
340/* Create a device file named PATH, with permission and special bits MODE
341 and device number DEV (which can be constructed from major and minor
342 device numbers with the `makedev' macro above). */
343#if defined __USE_MISC || defined __USE_BSD || defined __USE_XOPEN_EXTENDED
344extern int mknod (__const char *__path, __mode_t __mode, __dev_t __dev)
345 __THROW __nonnull ((1));
346libc_hidden_proto(mknod)
347
348# ifdef __USE_ATFILE
349/* Like mknod, create a new device file with permission bits MODE and
350 device number DEV. But interpret relative PATH names relative to
351 the directory associated with FD. */
352extern int mknodat (int __fd, __const char *__path, __mode_t __mode,
353 __dev_t __dev) __THROW __nonnull ((2));
354libc_hidden_proto(mknodat)
355# endif
356#endif
357
358
359/* Create a new FIFO named PATH, with permission bits MODE. */
360extern int mkfifo (__const char *__path, __mode_t __mode)
361 __THROW __nonnull ((1));
362
363#ifdef __USE_ATFILE
364/* Like mkfifo, create a new FIFO with permission bits MODE. But
365 interpret relative PATH names relative to the directory associated
366 with FD. */
367extern int mkfifoat (int __fd, __const char *__path, __mode_t __mode)
368 __THROW __nonnull ((2));
369#endif
370
371#ifdef __USE_ATFILE
372/* Set file access and modification times relative to directory file
373 descriptor. */
374extern int utimensat (int __fd, __const char *__path,
375 __const struct timespec __times[2],
376 int __flags)
377 __THROW __nonnull ((2));
378libc_hidden_proto(utimensat)
379#endif
380
381#ifdef __USE_XOPEN2K8
382/* Set file access and modification times of the file associated with FD. */
383extern int futimens (int __fd, __const struct timespec __times[2]) __THROW;
384#endif
385
386/* on uClibc we have unversioned struct stat and mknod.
387 * bits/stat.h is filled with wrong info, so we undo it here. */
388#undef _STAT_VER
389#define _STAT_VER 0
390#undef _MKNOD_VER
391#define _MKNOD_VER 0
392
393__END_DECLS
394
395
396#endif /* sys/stat.h */