epoc32/include/stdapis/sys/stat.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*-
     2  * Copyright (c) 1982, 1986, 1989, 1993
     3  *	The Regents of the University of California.  All rights reserved.
     4  * (c) UNIX System Laboratories, Inc.
     5  * All or some portions of this file are derived from material licensed
     6  * to the University of California by American Telephone and Telegraph
     7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
     8  * the permission of UNIX System Laboratories, Inc.
     9  *
    10  * Redistribution and use in source and binary forms, with or without
    11  * modification, are permitted provided that the following conditions
    12  * are met:
    13  * 1. Redistributions of source code must retain the above copyright
    14  *    notice, this list of conditions and the following disclaimer.
    15  * 2. Redistributions in binary form must reproduce the above copyright
    16  *    notice, this list of conditions and the following disclaimer in the
    17  *    documentation and/or other materials provided with the distribution.
    18  * 4. Neither the name of the University nor the names of its contributors
    19  *    may be used to endorse or promote products derived from this software
    20  *    without specific prior written permission.
    21  *
    22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    32  * SUCH DAMAGE.
    33  * © * Portions Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
    34  *	@(#)stat.h	8.12 (Berkeley) 6/16/95
    35  * $FreeBSD: src/sys/sys/stat.h,v 1.41 2005/03/22 01:19:18 das Exp $
    36  */
    37 
    38 #ifndef _SYS_STAT_H_
    39 #define	_SYS_STAT_H_
    40 
    41 #include <sys/cdefs.h>
    42 #include <sys/_types.h>
    43 
    44 #ifndef _BLKSIZE_T_DECLARED
    45 typedef	__blksize_t	blksize_t;
    46 #define	_BLKSIZE_T_DECLARED
    47 #endif
    48 
    49 #ifndef _BLKCNT_T_DECLARED
    50 typedef	__blkcnt_t	blkcnt_t;
    51 
    52 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
    53 typedef __blkcnt_t blkcnt64_t;
    54 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
    55 
    56 #define	_BLKCNT_T_DECLARED
    57 #endif
    58 
    59 #ifndef _DEV_T_DECLARED
    60 typedef	__dev_t		dev_t;
    61 #define	_DEV_T_DECLARED
    62 #endif
    63 
    64 #ifndef _FFLAGS_T_DECLARED
    65 typedef	__fflags_t	fflags_t;
    66 #define	_FFLAGS_T_DECLARED
    67 #endif
    68 
    69 #ifndef _GID_T_DECLARED
    70 typedef	__gid_t		gid_t;
    71 #define	_GID_T_DECLARED
    72 #endif
    73 
    74 #ifndef _INO_T_DECLARED
    75 typedef	__ino_t		ino_t;
    76 
    77 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
    78 typedef __ino64_t	ino64_t;
    79 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
    80 
    81 #define	_INO_T_DECLARED
    82 #endif
    83 
    84 #ifndef _MODE_T_DECLARED
    85 typedef	__mode_t	mode_t;
    86 #define	_MODE_T_DECLARED
    87 #endif
    88 
    89 #ifndef _NLINK_T_DECLARED
    90 typedef	__nlink_t	nlink_t;
    91 #define	_NLINK_T_DECLARED
    92 #endif
    93 
    94 #ifndef _OFF_T_DECLARED
    95 typedef	__off_t		off_t;
    96 #define	_OFF_T_DECLARED
    97 #endif
    98 
    99 #ifndef _TIME_T_DECLARED
   100 typedef	__time_t	time_t;
   101 #define	_TIME_T_DECLARED
   102 #endif
   103 
   104 #ifndef _UID_T_DECLARED
   105 typedef	__uid_t		uid_t;
   106 #define	_UID_T_DECLARED
   107 #endif
   108 
   109 #if !defined(_KERNEL) && __BSD_VISIBLE
   110 /*
   111  * XXX we need this for struct timespec.  We get miscellaneous namespace
   112  * pollution with it.
   113  */
   114 #include <sys/time.h>
   115 #endif
   116 
   117 #if !__BSD_VISIBLE
   118 #include <sys/_timespec.h>
   119 #endif
   120 
   121 #if __BSD_VISIBLE
   122 struct ostat {
   123 	__uint16_t st_dev;		/* inode's device */
   124 	ino_t	  st_ino;		/* inode's number */
   125 	mode_t	  st_mode;		/* inode protection mode */
   126 	nlink_t	  st_nlink;		/* number of hard links */
   127 	__uint16_t st_uid;		/* user ID of the file's owner */
   128 	__uint16_t st_gid;		/* group ID of the file's group */
   129 	__uint16_t st_rdev;		/* device type */
   130 	__int32_t st_size;		/* file size, in bytes */
   131 	struct	timespec st_atimespec;	/* time of last access */
   132 	struct	timespec st_mtimespec;	/* time of last data modification */
   133 	struct	timespec st_ctimespec;	/* time of last file status change */
   134 	__int32_t st_blksize;		/* optimal blocksize for I/O */
   135 	__int32_t st_blocks;		/* blocks allocated for file */
   136 	fflags_t  st_flags;		/* user defined flags for file */
   137 	__uint32_t st_gen;		/* file generation number */
   138 };
   139 #endif /* __BSD_VISIBLE */
   140 
   141 struct stat {
   142 	__dev_t   st_dev;		/* inode's device */
   143 	ino_t	  st_ino;		/* inode's number */
   144 	mode_t	  st_mode;		/* inode protection mode */
   145 	nlink_t	  st_nlink;		/* number of hard links */
   146 	uid_t	  st_uid;		/* user ID of the file's owner */
   147 	gid_t	  st_gid;		/* group ID of the file's group */
   148 	__dev_t   st_rdev;		/* device type */
   149 #if __BSD_VISIBLE
   150 	struct	timespec st_atimespec;	/* time of last access */
   151 	struct	timespec st_mtimespec;	/* time of last data modification */
   152 	struct	timespec st_ctimespec;	/* time of last file status change */
   153 #else
   154 	time_t	  st_atime;		/* time of last access */
   155 	long	  __st_atimensec;	/* nsec of last access */
   156 	time_t	  st_mtime;		/* time of last data modification */
   157 	long	  __st_mtimensec;	/* nsec of last data modification */
   158 	time_t	  st_ctime;		/* time of last file status change */
   159 	long	  __st_ctimensec;	/* nsec of last file status change */
   160 #endif
   161 	off_t	  st_size;		/* file size, in bytes */
   162 	blkcnt_t st_blocks;		/* blocks allocated for file */
   163 	blksize_t st_blksize;		/* optimal blocksize for I/O */
   164 	fflags_t  st_flags;		/* user defined flags for file */
   165 	__uint32_t st_gen;		/* file generation number */
   166 	__int32_t st_lspare;
   167 #if __BSD_VISIBLE
   168 	struct timespec st_birthtimespec; /* time of file creation */
   169 	/*
   170 	 * Explicitly pad st_birthtimespec to 16 bytes so that the size of
   171 	 * struct stat is backwards compatible.  We use bitfields instead
   172 	 * of an array of chars so that this doesn't require a C99 compiler
   173 	 * to compile if the size of the padding is 0.  We use 2 bitfields
   174 	 * to cover up to 64 bits on 32-bit machines.  We assume that
   175 	 * CHAR_BIT is 8...
   176 	 */
   177 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
   178 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
   179 #else
   180 	time_t	  st_birthtime;		/* time of file creation */
   181 	long	  st_birthtimensec;	/* nsec of file creation */
   182 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
   183 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct __timespec));
   184 #endif
   185 };
   186 
   187 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   188 #define stat64 stat 
   189 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   190 
   191 #if __BSD_VISIBLE
   192 struct nstat {
   193 	__dev_t   st_dev;		/* inode's device */
   194 	ino_t	  st_ino;		/* inode's number */
   195 	__uint32_t st_mode;		/* inode protection mode */
   196 	__uint32_t st_nlink;		/* number of hard links */
   197 	uid_t	  st_uid;		/* user ID of the file's owner */
   198 	gid_t	  st_gid;		/* group ID of the file's group */
   199 	__dev_t   st_rdev;		/* device type */
   200 	struct	timespec st_atimespec;	/* time of last access */
   201 	struct	timespec st_mtimespec;	/* time of last data modification */
   202 	struct	timespec st_ctimespec;	/* time of last file status change */
   203 	off_t	  st_size;		/* file size, in bytes */
   204 	blkcnt_t st_blocks;		/* blocks allocated for file */
   205 	blksize_t st_blksize;		/* optimal blocksize for I/O */
   206 	fflags_t  st_flags;		/* user defined flags for file */
   207 	__uint32_t st_gen;		/* file generation number */
   208 	struct timespec st_birthtimespec; /* time of file creation */
   209 	/*
   210 	 * See above about the following padding.
   211 	 */
   212 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
   213 	unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
   214 };
   215 #endif
   216 
   217 #if __BSD_VISIBLE
   218 #define st_atime st_atimespec.tv_sec
   219 #define st_mtime st_mtimespec.tv_sec
   220 #define st_ctime st_ctimespec.tv_sec
   221 #define st_birthtime st_birthtimespec.tv_sec
   222 #endif
   223 
   224 #define	S_ISUID	0004000			/* set user id on execution */
   225 #define	S_ISGID	0002000			/* set group id on execution */
   226 #if __BSD_VISIBLE
   227 #define	S_ISTXT	0001000			/* sticky bit */
   228 #endif
   229 
   230 #define	S_IRWXU	0000700			/* RWX mask for owner */
   231 #define	S_IRUSR	0000400			/* R for owner */
   232 #define	S_IWUSR	0000200			/* W for owner */
   233 #define	S_IXUSR	0000100			/* X for owner */
   234 
   235 #if __BSD_VISIBLE
   236 #define	S_IREAD		S_IRUSR
   237 #define	S_IWRITE	S_IWUSR
   238 #define	S_IEXEC		S_IXUSR
   239 #endif
   240 
   241 #define	S_IRWXG	0000070			/* RWX mask for group */
   242 #define	S_IRGRP	0000040			/* R for group */
   243 #define	S_IWGRP	0000020			/* W for group */
   244 #define	S_IXGRP	0000010			/* X for group */
   245 
   246 #define	S_IRWXO	0000007			/* RWX mask for other */
   247 #define	S_IROTH	0000004			/* R for other */
   248 #define	S_IWOTH	0000002			/* W for other */
   249 #define	S_IXOTH	0000001			/* X for other */
   250 
   251 #if __XSI_VISIBLE
   252 #define	S_IFMT	 0170000		/* type of file mask */
   253 #define	S_IFIFO	 0010000		/* named pipe (fifo) */
   254 #define	S_IFCHR	 0020000		/* character special */
   255 #define	S_IFDIR	 0040000		/* directory */
   256 #define	S_IFBLK	 0060000		/* block special */
   257 #define	S_IFREG	 0100000		/* regular */
   258 #define	S_IFLNK	 0120000		/* symbolic link */
   259 #define	S_IFSOCK 0140000		/* socket */
   260 #define	S_ISVTX	 0001000		/* save swapped text even after use */
   261 #endif
   262 #if __BSD_VISIBLE
   263 #define	S_IFWHT  0160000		/* whiteout */
   264 #endif
   265 
   266 #define	S_ISDIR(m)	(((m) & 0170000) == 0040000)	/* directory */
   267 #define	S_ISCHR(m)	(((m) & 0170000) == 0020000)	/* char special */
   268 #define	S_ISBLK(m)	(((m) & 0170000) == 0060000)	/* block special */
   269 #define	S_ISREG(m)	(((m) & 0170000) == 0100000)	/* regular file */
   270 #define	S_ISFIFO(m)	(((m) & 0170000) == 0010000)	/* fifo or socket */
   271 #if __POSIX_VISIBLE >= 200112
   272 #define	S_ISLNK(m)	(((m) & 0170000) == 0120000)	/* symbolic link */
   273 #define	S_ISSOCK(m)	(((m) & 0170000) == 0140000)	/* socket */
   274 #endif
   275 #if __BSD_VISIBLE
   276 #define	S_ISWHT(m)	(((m) & 0170000) == 0160000)	/* whiteout */
   277 #endif
   278 
   279 #if __BSD_VISIBLE
   280 #define	ACCESSPERMS	(S_IRWXU|S_IRWXG|S_IRWXO)	/* 0777 */
   281 							/* 7777 */
   282 #define	ALLPERMS	(S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
   283 							/* 0666 */
   284 #ifndef DEFFILEMODE	
   285 #define	DEFFILEMODE	(S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
   286 #endif//DEFFILEMODE	
   287 
   288 #define S_BLKSIZE	512		/* block size used in the stat struct */
   289 
   290 /*
   291  * Definitions of flags stored in file flags word.
   292  *
   293  * Super-user and owner changeable flags.
   294  */
   295 #define	UF_SETTABLE	0x0000ffff	/* mask of owner changeable flags */
   296 #define	UF_NODUMP	0x00000001	/* do not dump file */
   297 #define	UF_IMMUTABLE	0x00000002	/* file may not be changed */
   298 #define	UF_APPEND	0x00000004	/* writes to file may only append */
   299 #define UF_OPAQUE	0x00000008	/* directory is opaque wrt. union */
   300 #define UF_NOUNLINK	0x00000010	/* file may not be removed or renamed */
   301 /*
   302  * Super-user changeable flags.
   303  */
   304 #define	SF_SETTABLE	0xffff0000	/* mask of superuser changeable flags */
   305 #define	SF_ARCHIVED	0x00010000	/* file is archived */
   306 #define	SF_IMMUTABLE	0x00020000	/* file may not be changed */
   307 #define	SF_APPEND	0x00040000	/* writes to file may only append */
   308 #define	SF_NOUNLINK	0x00100000	/* file may not be removed or renamed */
   309 #define	SF_SNAPSHOT	0x00200000	/* snapshot inode */
   310 
   311 #ifdef _KERNEL
   312 /*
   313  * Shorthand abbreviations of above.
   314  */
   315 #define	OPAQUE		(UF_OPAQUE)
   316 #define	APPEND		(UF_APPEND | SF_APPEND)
   317 #define	IMMUTABLE	(UF_IMMUTABLE | SF_IMMUTABLE)
   318 #define	NOUNLINK	(UF_NOUNLINK | SF_NOUNLINK)
   319 #endif
   320 
   321 #endif /* __BSD_VISIBLE */
   322 
   323 #ifndef _KERNEL
   324 __BEGIN_DECLS
   325 IMPORT_C
   326 int	chmod(const char *, mode_t);
   327 #if __BSD_VISIBLE
   328 IMPORT_C
   329 int	fchmod(int, mode_t);
   330 #endif
   331 IMPORT_C int	fstat(int, struct stat *);
   332 #if __POSIX_VISIBLE >= 200112
   333 IMPORT_C int	lstat(const char * __restrict, struct stat * __restrict);
   334 #endif
   335 IMPORT_C int __xstat(int /* vers */, const char *file, struct stat *buf);
   336 IMPORT_C int __lxstat (int /* version*/, const char *file, struct stat *buf);
   337 IMPORT_C int	mkdir(const char *, mode_t);
   338 IMPORT_C int	mkfifo(const char *, mode_t);
   339 IMPORT_C int	stat(const char * __restrict, struct stat * __restrict);
   340 IMPORT_C mode_t	umask(mode_t);
   341 
   342 #if defined(SYMBIAN_OE_LARGE_FILE_SUPPORT) && !defined(SYMBIAN_OE_NO_LFS)
   343 
   344 #define fstat64	fstat
   345 #define stat64	stat
   346 #define __lxstat64	__lxstat
   347 #define __xstat64	__xstat
   348 
   349 #if __POSIX_VISIBLE >= 200112
   350 #define lstat64 lstat
   351 #endif /* __POSIX_VISIBLE >= 200112 */
   352 
   353 #endif /* SYMBIAN_OE_LARGE_FILE_SUPPORT && !SYMBIAN_OE_NO_LFS */
   354 
   355 __END_DECLS
   356 #endif /* !_KERNEL */
   357 
   358 #endif /* !_SYS_STAT_H_ */