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