S60 3rd Edition API Reference: stat.h Source File

00001 /*-
00002  * Copyright (c) 1982, 1986, 1989, 1993
00003  *      The Regents of the University of California.  All rights reserved.
00004  * (c) UNIX System Laboratories, Inc.
00005  * All or some portions of this file are derived from material licensed
00006  * to the University of California by American Telephone and Telegraph
00007  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
00008  * the permission of UNIX System Laboratories, Inc.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in the
00017  *    documentation and/or other materials provided with the distribution.
00018  * 4. Neither the name of the University nor the names of its contributors
00019  *    may be used to endorse or promote products derived from this software
00020  *    without specific prior written permission.
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00023  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00025  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00026  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00027  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00028  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00029  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00030  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00031  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00032  * SUCH DAMAGE.
00033  * © Portions copyright (c) 2007 Symbian Software Ltd. All rights reserved.
00034  *      @(#)stat.h      8.12 (Berkeley) 6/16/95
00035  * $FreeBSD: src/sys/sys/stat.h,v 1.41 2005/03/22 01:19:18 das Exp $
00036  */
00037 
00038 #ifndef _SYS_STAT_H_
00039 #define _SYS_STAT_H_
00040 
00041 #include <sys/cdefs.h>
00042 #include <sys/_types.h>
00043 
00044 #ifndef _BLKSIZE_T_DECLARED
00045 typedef __blksize_t     blksize_t;
00046 #define _BLKSIZE_T_DECLARED
00047 #endif
00048 
00049 #ifndef _BLKCNT_T_DECLARED
00050 typedef __blkcnt_t      blkcnt_t;
00051 #define _BLKCNT_T_DECLARED
00052 #endif
00053 
00054 #ifndef _DEV_T_DECLARED
00055 typedef __dev_t         dev_t;
00056 #define _DEV_T_DECLARED
00057 #endif
00058 
00059 #ifndef _FFLAGS_T_DECLARED
00060 typedef __fflags_t      fflags_t;
00061 #define _FFLAGS_T_DECLARED
00062 #endif
00063 
00064 #ifndef _GID_T_DECLARED
00065 typedef __gid_t         gid_t;
00066 #define _GID_T_DECLARED
00067 #endif
00068 
00069 #ifndef _INO_T_DECLARED
00070 typedef __ino_t         ino_t;
00071 #define _INO_T_DECLARED
00072 #endif
00073 
00074 #ifndef _MODE_T_DECLARED
00075 typedef __mode_t        mode_t;
00076 #define _MODE_T_DECLARED
00077 #endif
00078 
00079 #ifndef _NLINK_T_DECLARED
00080 typedef __nlink_t       nlink_t;
00081 #define _NLINK_T_DECLARED
00082 #endif
00083 
00084 #ifndef _OFF_T_DECLARED
00085 typedef __off_t         off_t;
00086 #define _OFF_T_DECLARED
00087 #endif
00088 
00089 #ifndef _TIME_T_DECLARED
00090 typedef __time_t        time_t;
00091 #define _TIME_T_DECLARED
00092 #endif
00093 
00094 #ifndef _UID_T_DECLARED
00095 typedef __uid_t         uid_t;
00096 #define _UID_T_DECLARED
00097 #endif
00098 
00099 #if !defined(_KERNEL) && __BSD_VISIBLE
00100 /*
00101  * XXX we need this for struct timespec.  We get miscellaneous namespace
00102  * pollution with it.
00103  */
00104 #include <sys/time.h>
00105 #endif
00106 
00107 #if !__BSD_VISIBLE
00108 #include <sys/_timespec.h>
00109 #endif
00110 
00111 #if __BSD_VISIBLE
00112 struct ostat {
00113         __uint16_t st_dev;              /* inode's device */
00114         ino_t     st_ino;               /* inode's number */
00115         mode_t    st_mode;              /* inode protection mode */
00116         nlink_t   st_nlink;             /* number of hard links */
00117         __uint16_t st_uid;              /* user ID of the file's owner */
00118         __uint16_t st_gid;              /* group ID of the file's group */
00119         __uint16_t st_rdev;             /* device type */
00120         __int32_t st_size;              /* file size, in bytes */
00121         struct  timespec st_atimespec;  /* time of last access */
00122         struct  timespec st_mtimespec;  /* time of last data modification */
00123         struct  timespec st_ctimespec;  /* time of last file status change */
00124         __int32_t st_blksize;           /* optimal blocksize for I/O */
00125         __int32_t st_blocks;            /* blocks allocated for file */
00126         fflags_t  st_flags;             /* user defined flags for file */
00127         __uint32_t st_gen;              /* file generation number */
00128 };
00129 #endif /* __BSD_VISIBLE */
00130 
00131 struct stat {
00132         __dev_t   st_dev;               /* inode's device */
00133         ino_t     st_ino;               /* inode's number */
00134         mode_t    st_mode;              /* inode protection mode */
00135         nlink_t   st_nlink;             /* number of hard links */
00136         uid_t     st_uid;               /* user ID of the file's owner */
00137         gid_t     st_gid;               /* group ID of the file's group */
00138         __dev_t   st_rdev;              /* device type */
00139 #if __BSD_VISIBLE
00140         struct  timespec st_atimespec;  /* time of last access */
00141         struct  timespec st_mtimespec;  /* time of last data modification */
00142         struct  timespec st_ctimespec;  /* time of last file status change */
00143 #else
00144         time_t    st_atime;             /* time of last access */
00145         long      __st_atimensec;       /* nsec of last access */
00146         time_t    st_mtime;             /* time of last data modification */
00147         long      __st_mtimensec;       /* nsec of last data modification */
00148         time_t    st_ctime;             /* time of last file status change */
00149         long      __st_ctimensec;       /* nsec of last file status change */
00150 #endif
00151         off_t     st_size;              /* file size, in bytes */
00152         blkcnt_t st_blocks;             /* blocks allocated for file */
00153         blksize_t st_blksize;           /* optimal blocksize for I/O */
00154         fflags_t  st_flags;             /* user defined flags for file */
00155         __uint32_t st_gen;              /* file generation number */
00156         __int32_t st_lspare;
00157 #if __BSD_VISIBLE
00158         struct timespec st_birthtimespec; /* time of file creation */
00159         /*
00160          * Explicitly pad st_birthtimespec to 16 bytes so that the size of
00161          * struct stat is backwards compatible.  We use bitfields instead
00162          * of an array of chars so that this doesn't require a C99 compiler
00163          * to compile if the size of the padding is 0.  We use 2 bitfields
00164          * to cover up to 64 bits on 32-bit machines.  We assume that
00165          * CHAR_BIT is 8...
00166          */
00167         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
00168         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
00169 #else
00170         time_t    st_birthtime;         /* time of file creation */
00171         long      st_birthtimensec;     /* nsec of file creation */
00172         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
00173         unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
00174 #endif
00175 };
00176 
00177 #if __BSD_VISIBLE
00178 struct nstat {
00179         __dev_t   st_dev;               /* inode's device */
00180         ino_t     st_ino;               /* inode's number */
00181         __uint32_t st_mode;             /* inode protection mode */
00182         __uint32_t st_nlink;            /* number of hard links */
00183         uid_t     st_uid;               /* user ID of the file's owner */
00184         gid_t     st_gid;               /* group ID of the file's group */
00185         __dev_t   st_rdev;              /* device type */
00186         struct  timespec st_atimespec;  /* time of last access */
00187         struct  timespec st_mtimespec;  /* time of last data modification */
00188         struct  timespec st_ctimespec;  /* time of last file status change */
00189         off_t     st_size;              /* file size, in bytes */
00190         blkcnt_t st_blocks;             /* blocks allocated for file */
00191         blksize_t st_blksize;           /* optimal blocksize for I/O */
00192         fflags_t  st_flags;             /* user defined flags for file */
00193         __uint32_t st_gen;              /* file generation number */
00194         struct timespec st_birthtimespec; /* time of file creation */
00195         /*
00196          * See above about the following padding.
00197          */
00198         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
00199         unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
00200 };
00201 #endif
00202 
00203 #if __BSD_VISIBLE
00204 #define st_atime st_atimespec.tv_sec
00205 #define st_mtime st_mtimespec.tv_sec
00206 #define st_ctime st_ctimespec.tv_sec
00207 #define st_birthtime st_birthtimespec.tv_sec
00208 #endif
00209 
00210 #define S_ISUID 0004000                 /* set user id on execution */
00211 #define S_ISGID 0002000                 /* set group id on execution */
00212 #if __BSD_VISIBLE
00213 #define S_ISTXT 0001000                 /* sticky bit */
00214 #endif
00215 
00216 #define S_IRWXU 0000700                 /* RWX mask for owner */
00217 #define S_IRUSR 0000400                 /* R for owner */
00218 #define S_IWUSR 0000200                 /* W for owner */
00219 #define S_IXUSR 0000100                 /* X for owner */
00220 
00221 #if __BSD_VISIBLE
00222 #define S_IREAD         S_IRUSR
00223 #define S_IWRITE        S_IWUSR
00224 #define S_IEXEC         S_IXUSR
00225 #endif
00226 
00227 #define S_IRWXG 0000070                 /* RWX mask for group */
00228 #define S_IRGRP 0000040                 /* R for group */
00229 #define S_IWGRP 0000020                 /* W for group */
00230 #define S_IXGRP 0000010                 /* X for group */
00231 
00232 #define S_IRWXO 0000007                 /* RWX mask for other */
00233 #define S_IROTH 0000004                 /* R for other */
00234 #define S_IWOTH 0000002                 /* W for other */
00235 #define S_IXOTH 0000001                 /* X for other */
00236 
00237 #if __XSI_VISIBLE
00238 #define S_IFMT   0170000                /* type of file mask */
00239 #define S_IFIFO  0010000                /* named pipe (fifo) */
00240 #define S_IFCHR  0020000                /* character special */
00241 #define S_IFDIR  0040000                /* directory */
00242 #define S_IFBLK  0060000                /* block special */
00243 #define S_IFREG  0100000                /* regular */
00244 #define S_IFLNK  0120000                /* symbolic link */
00245 #define S_IFSOCK 0140000                /* socket */
00246 #define S_ISVTX  0001000                /* save swapped text even after use */
00247 #endif
00248 #if __BSD_VISIBLE
00249 #define S_IFWHT  0160000                /* whiteout */
00250 #endif
00251 
00252 #define S_ISDIR(m)      (((m) & 0170000) == 0040000)    /* directory */
00253 #define S_ISCHR(m)      (((m) & 0170000) == 0020000)    /* char special */
00254 #define S_ISBLK(m)      (((m) & 0170000) == 0060000)    /* block special */
00255 #define S_ISREG(m)      (((m) & 0170000) == 0100000)    /* regular file */
00256 #define S_ISFIFO(m)     (((m) & 0170000) == 0010000)    /* fifo or socket */
00257 #if __POSIX_VISIBLE >= 200112
00258 #define S_ISLNK(m)      (((m) & 0170000) == 0120000)    /* symbolic link */
00259 #define S_ISSOCK(m)     (((m) & 0170000) == 0140000)    /* socket */
00260 #endif
00261 #if __BSD_VISIBLE
00262 #define S_ISWHT(m)      (((m) & 0170000) == 0160000)    /* whiteout */
00263 #endif
00264 
00265 #if __BSD_VISIBLE
00266 #define ACCESSPERMS     (S_IRWXU|S_IRWXG|S_IRWXO)       /* 0777 */
00267                                                         /* 7777 */
00268 #define ALLPERMS        (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
00269                                                         /* 0666 */
00270 #ifndef DEFFILEMODE     
00271 #define DEFFILEMODE     (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
00272 #endif//DEFFILEMODE     
00273 
00274 #define S_BLKSIZE       512             /* block size used in the stat struct */
00275 
00276 /*
00277  * Definitions of flags stored in file flags word.
00278  *
00279  * Super-user and owner changeable flags.
00280  */
00281 #define UF_SETTABLE     0x0000ffff      /* mask of owner changeable flags */
00282 #define UF_NODUMP       0x00000001      /* do not dump file */
00283 #define UF_IMMUTABLE    0x00000002      /* file may not be changed */
00284 #define UF_APPEND       0x00000004      /* writes to file may only append */
00285 #define UF_OPAQUE       0x00000008      /* directory is opaque wrt. union */
00286 #define UF_NOUNLINK     0x00000010      /* file may not be removed or renamed */
00287 /*
00288  * Super-user changeable flags.
00289  */
00290 #define SF_SETTABLE     0xffff0000      /* mask of superuser changeable flags */
00291 #define SF_ARCHIVED     0x00010000      /* file is archived */
00292 #define SF_IMMUTABLE    0x00020000      /* file may not be changed */
00293 #define SF_APPEND       0x00040000      /* writes to file may only append */
00294 #define SF_NOUNLINK     0x00100000      /* file may not be removed or renamed */
00295 #define SF_SNAPSHOT     0x00200000      /* snapshot inode */
00296 
00297 #ifdef _KERNEL
00298 /*
00299  * Shorthand abbreviations of above.
00300  */
00301 #define OPAQUE          (UF_OPAQUE)
00302 #define APPEND          (UF_APPEND | SF_APPEND)
00303 #define IMMUTABLE       (UF_IMMUTABLE | SF_IMMUTABLE)
00304 #define NOUNLINK        (UF_NOUNLINK | SF_NOUNLINK)
00305 #endif
00306 
00307 #endif /* __BSD_VISIBLE */
00308 
00309 #ifndef _KERNEL
00310 __BEGIN_DECLS
00311 IMPORT_C
00312 int     chmod(const char *, mode_t);
00313 #if __BSD_VISIBLE
00314 IMPORT_C
00315 int     fchmod(int, mode_t);
00316 #endif
00317 IMPORT_C int    fstat(int, struct stat *);
00318 #if __POSIX_VISIBLE >= 200112
00319 IMPORT_C int    lstat(const char * __restrict, struct stat * __restrict);
00320 #endif
00321 IMPORT_C int __xstat(int vers, const char *file, struct stat *buf);
00322 IMPORT_C int __lxstat (int version, const char *file, struct stat *buf);
00323 IMPORT_C int    mkdir(const char *, mode_t);
00324 IMPORT_C int    mkfifo(const char *, mode_t);
00325 IMPORT_C int    stat(const char * __restrict, struct stat * __restrict);
00326 IMPORT_C mode_t umask(mode_t);
00327 __END_DECLS
00328 #endif /* !_KERNEL */
00329 
00330 #endif /* !_SYS_STAT_H_ */