c7af094e18
and CIFS file attributes as BSD stat(2) flags. This work is intended to be compatible with ZFS, the Solaris CIFS server's interaction with ZFS, somewhat compatible with MacOS X, and of course compatible with Windows. The Windows attributes that are implemented were chosen based on the attributes that ZFS already supports. The summary of the flags is as follows: UF_SYSTEM: Command line name: "system" or "usystem" ZFS name: XAT_SYSTEM, ZFS_SYSTEM Windows: FILE_ATTRIBUTE_SYSTEM This flag means that the file is used by the operating system. FreeBSD does not enforce any special handling when this flag is set. UF_SPARSE: Command line name: "sparse" or "usparse" ZFS name: XAT_SPARSE, ZFS_SPARSE Windows: FILE_ATTRIBUTE_SPARSE_FILE This flag means that the file is sparse. Although ZFS may modify this in some situations, there is not generally any special handling for this flag. UF_OFFLINE: Command line name: "offline" or "uoffline" ZFS name: XAT_OFFLINE, ZFS_OFFLINE Windows: FILE_ATTRIBUTE_OFFLINE This flag means that the file has been moved to offline storage. FreeBSD does not have any special handling for this flag. UF_REPARSE: Command line name: "reparse" or "ureparse" ZFS name: XAT_REPARSE, ZFS_REPARSE Windows: FILE_ATTRIBUTE_REPARSE_POINT This flag means that the file is a Windows reparse point. ZFS has special handling code for reparse points, but we don't currently have the other supporting infrastructure for them. UF_HIDDEN: Command line name: "hidden" or "uhidden" ZFS name: XAT_HIDDEN, ZFS_HIDDEN Windows: FILE_ATTRIBUTE_HIDDEN This flag means that the file may be excluded from a directory listing if the application honors it. FreeBSD has no special handling for this flag. The name and bit definition for UF_HIDDEN are identical to the definition in MacOS X. UF_READONLY: Command line name: "urdonly", "rdonly", "readonly" ZFS name: XAT_READONLY, ZFS_READONLY Windows: FILE_ATTRIBUTE_READONLY This flag means that the file may not written or appended, but its attributes may be changed. ZFS currently enforces this flag, but Illumos developers have discussed disabling enforcement. The behavior of this flag is different than MacOS X. MacOS X uses UF_IMMUTABLE to represent the DOS readonly permission, but that flag has a stronger meaning than the semantics of DOS readonly permissions. UF_ARCHIVE: Command line name: "uarch", "uarchive" ZFS_NAME: XAT_ARCHIVE, ZFS_ARCHIVE Windows name: FILE_ATTRIBUTE_ARCHIVE The UF_ARCHIVED flag means that the file has changed and needs to be archived. The meaning is same as the Windows FILE_ATTRIBUTE_ARCHIVE attribute, and the ZFS XAT_ARCHIVE and ZFS_ARCHIVE attribute. msdosfs and ZFS have special handling for this flag. i.e. they will set it when the file changes. sys/param.h: Bump __FreeBSD_version to 1000047 for the addition of new stat(2) flags. chflags.1: Document the new command line flag names (e.g. "system", "hidden") available to the user. ls.1: Reference chflags(1) for a list of file flags and their meanings. strtofflags.c: Implement the mapping between the new command line flag names and new stat(2) flags. chflags.2: Document all of the new stat(2) flags, and explain the intended behavior in a little more detail. Explain how they map to Windows file attributes. Different filesystems behave differently with respect to flags, so warn the application developer to take care when using them. zfs_vnops.c: Add support for getting and setting the UF_ARCHIVE, UF_READONLY, UF_SYSTEM, UF_HIDDEN, UF_REPARSE, UF_OFFLINE, and UF_SPARSE flags. All of these flags are implemented using attributes that ZFS already supports, so the on-disk format has not changed. ZFS currently doesn't allow setting the UF_REPARSE flag, and we don't really have the other infrastructure to support reparse points. msdosfs_denode.c, msdosfs_vnops.c: Add support for getting and setting UF_HIDDEN, UF_SYSTEM and UF_READONLY in MSDOSFS. It supported SF_ARCHIVED, but this has been changed to be UF_ARCHIVE, which has the same semantics as the DOS archive attribute instead of inverse semantics like SF_ARCHIVED. After discussion with Bruce Evans, change several things in the msdosfs behavior: Use UF_READONLY to indicate whether a file is writeable instead of file permissions, but don't actually enforce it. Refuse to change attributes on the root directory, because it is special in FAT filesystems, but allow most other attribute changes on directories. Don't set the archive attribute on a directory when its modification time is updated. Windows and DOS don't set the archive attribute in that scenario, so we are now bug-for-bug compatible. smbfs_node.c, smbfs_vnops.c: Add support for UF_HIDDEN, UF_SYSTEM, UF_READONLY and UF_ARCHIVE in SMBFS. This is similar to changes that Apple has made in their version of SMBFS (as of smb-583.8, posted on opensource.apple.com), but not quite the same. We map SMB_FA_READONLY to UF_READONLY, because UF_READONLY is intended to match the semantics of the DOS readonly flag. The MacOS X code maps both UF_IMMUTABLE and SF_IMMUTABLE to SMB_FA_READONLY, but the immutable flags have stronger meaning than the DOS readonly bit. stat.h: Add definitions for UF_SYSTEM, UF_SPARSE, UF_OFFLINE, UF_REPARSE, UF_ARCHIVE, UF_READONLY and UF_HIDDEN. The definition of UF_HIDDEN is the same as the MacOS X definition. Add commented-out definitions of UF_COMPRESSED and UF_TRACKED. They are defined in MacOS X (as of 10.8.2), but we do not implement them (yet). ufs_vnops.c: Add support for getting and setting UF_ARCHIVE, UF_HIDDEN, UF_OFFLINE, UF_READONLY, UF_REPARSE, UF_SPARSE, and UF_SYSTEM in UFS. Alphabetize the flags that are supported. These new flags are only stored, UFS does not take any action if the flag is set. Sponsored by: Spectra Logic Reviewed by: bde (earlier version)
354 lines
12 KiB
C
354 lines
12 KiB
C
/*-
|
|
* Copyright (c) 1982, 1986, 1989, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
* (c) UNIX System Laboratories, Inc.
|
|
* All or some portions of this file are derived from material licensed
|
|
* to the University of California by American Telephone and Telegraph
|
|
* Co. or Unix System Laboratories, Inc. and are reproduced herein with
|
|
* the permission of UNIX System Laboratories, Inc.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 4. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* @(#)stat.h 8.12 (Berkeley) 6/16/95
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _SYS_STAT_H_
|
|
#define _SYS_STAT_H_
|
|
|
|
#include <sys/cdefs.h>
|
|
#include <sys/_timespec.h>
|
|
#include <sys/_types.h>
|
|
|
|
#ifndef _BLKSIZE_T_DECLARED
|
|
typedef __blksize_t blksize_t;
|
|
#define _BLKSIZE_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _BLKCNT_T_DECLARED
|
|
typedef __blkcnt_t blkcnt_t;
|
|
#define _BLKCNT_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _DEV_T_DECLARED
|
|
typedef __dev_t dev_t;
|
|
#define _DEV_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _FFLAGS_T_DECLARED
|
|
typedef __fflags_t fflags_t;
|
|
#define _FFLAGS_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _GID_T_DECLARED
|
|
typedef __gid_t gid_t;
|
|
#define _GID_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _INO_T_DECLARED
|
|
typedef __ino_t ino_t;
|
|
#define _INO_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _MODE_T_DECLARED
|
|
typedef __mode_t mode_t;
|
|
#define _MODE_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _NLINK_T_DECLARED
|
|
typedef __nlink_t nlink_t;
|
|
#define _NLINK_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _OFF_T_DECLARED
|
|
typedef __off_t off_t;
|
|
#define _OFF_T_DECLARED
|
|
#endif
|
|
|
|
#ifndef _UID_T_DECLARED
|
|
typedef __uid_t uid_t;
|
|
#define _UID_T_DECLARED
|
|
#endif
|
|
|
|
#if !defined(_KERNEL) && __BSD_VISIBLE
|
|
/*
|
|
* XXX We get miscellaneous namespace pollution with this.
|
|
*/
|
|
#include <sys/time.h>
|
|
#endif
|
|
|
|
#ifdef _KERNEL
|
|
struct ostat {
|
|
__uint16_t st_dev; /* inode's device */
|
|
ino_t st_ino; /* inode's number */
|
|
mode_t st_mode; /* inode protection mode */
|
|
nlink_t st_nlink; /* number of hard links */
|
|
__uint16_t st_uid; /* user ID of the file's owner */
|
|
__uint16_t st_gid; /* group ID of the file's group */
|
|
__uint16_t st_rdev; /* device type */
|
|
__int32_t st_size; /* file size, in bytes */
|
|
struct timespec st_atim; /* time of last access */
|
|
struct timespec st_mtim; /* time of last data modification */
|
|
struct timespec st_ctim; /* time of last file status change */
|
|
__int32_t st_blksize; /* optimal blocksize for I/O */
|
|
__int32_t st_blocks; /* blocks allocated for file */
|
|
fflags_t st_flags; /* user defined flags for file */
|
|
__uint32_t st_gen; /* file generation number */
|
|
};
|
|
#endif
|
|
|
|
struct stat {
|
|
__dev_t st_dev; /* inode's device */
|
|
ino_t st_ino; /* inode's number */
|
|
mode_t st_mode; /* inode protection mode */
|
|
nlink_t st_nlink; /* number of hard links */
|
|
uid_t st_uid; /* user ID of the file's owner */
|
|
gid_t st_gid; /* group ID of the file's group */
|
|
__dev_t st_rdev; /* device type */
|
|
struct timespec st_atim; /* time of last access */
|
|
struct timespec st_mtim; /* time of last data modification */
|
|
struct timespec st_ctim; /* time of last file status change */
|
|
off_t st_size; /* file size, in bytes */
|
|
blkcnt_t st_blocks; /* blocks allocated for file */
|
|
blksize_t st_blksize; /* optimal blocksize for I/O */
|
|
fflags_t st_flags; /* user defined flags for file */
|
|
__uint32_t st_gen; /* file generation number */
|
|
__int32_t st_lspare;
|
|
struct timespec st_birthtim; /* time of file creation */
|
|
/*
|
|
* Explicitly pad st_birthtim to 16 bytes so that the size of
|
|
* struct stat is backwards compatible. We use bitfields instead
|
|
* of an array of chars so that this doesn't require a C99 compiler
|
|
* to compile if the size of the padding is 0. We use 2 bitfields
|
|
* to cover up to 64 bits on 32-bit machines. We assume that
|
|
* CHAR_BIT is 8...
|
|
*/
|
|
unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
|
|
unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
|
|
};
|
|
|
|
#ifdef _KERNEL
|
|
struct nstat {
|
|
__dev_t st_dev; /* inode's device */
|
|
ino_t st_ino; /* inode's number */
|
|
__uint32_t st_mode; /* inode protection mode */
|
|
__uint32_t st_nlink; /* number of hard links */
|
|
uid_t st_uid; /* user ID of the file's owner */
|
|
gid_t st_gid; /* group ID of the file's group */
|
|
__dev_t st_rdev; /* device type */
|
|
struct timespec st_atim; /* time of last access */
|
|
struct timespec st_mtim; /* time of last data modification */
|
|
struct timespec st_ctim; /* time of last file status change */
|
|
off_t st_size; /* file size, in bytes */
|
|
blkcnt_t st_blocks; /* blocks allocated for file */
|
|
blksize_t st_blksize; /* optimal blocksize for I/O */
|
|
fflags_t st_flags; /* user defined flags for file */
|
|
__uint32_t st_gen; /* file generation number */
|
|
struct timespec st_birthtim; /* time of file creation */
|
|
/*
|
|
* See above about the following padding.
|
|
*/
|
|
unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
|
|
unsigned int :(8 / 2) * (16 - (int)sizeof(struct timespec));
|
|
};
|
|
#endif
|
|
|
|
#ifndef _KERNEL
|
|
#define st_atime st_atim.tv_sec
|
|
#define st_mtime st_mtim.tv_sec
|
|
#define st_ctime st_ctim.tv_sec
|
|
#if __BSD_VISIBLE
|
|
#define st_birthtime st_birthtim.tv_sec
|
|
#endif
|
|
|
|
/* For compatibility. */
|
|
#if __BSD_VISIBLE
|
|
#define st_atimespec st_atim
|
|
#define st_mtimespec st_mtim
|
|
#define st_ctimespec st_ctim
|
|
#define st_birthtimespec st_birthtim
|
|
#endif
|
|
#endif /* !_KERNEL */
|
|
|
|
#define S_ISUID 0004000 /* set user id on execution */
|
|
#define S_ISGID 0002000 /* set group id on execution */
|
|
#if __BSD_VISIBLE
|
|
#define S_ISTXT 0001000 /* sticky bit */
|
|
#endif
|
|
|
|
#define S_IRWXU 0000700 /* RWX mask for owner */
|
|
#define S_IRUSR 0000400 /* R for owner */
|
|
#define S_IWUSR 0000200 /* W for owner */
|
|
#define S_IXUSR 0000100 /* X for owner */
|
|
|
|
#if __BSD_VISIBLE
|
|
#define S_IREAD S_IRUSR
|
|
#define S_IWRITE S_IWUSR
|
|
#define S_IEXEC S_IXUSR
|
|
#endif
|
|
|
|
#define S_IRWXG 0000070 /* RWX mask for group */
|
|
#define S_IRGRP 0000040 /* R for group */
|
|
#define S_IWGRP 0000020 /* W for group */
|
|
#define S_IXGRP 0000010 /* X for group */
|
|
|
|
#define S_IRWXO 0000007 /* RWX mask for other */
|
|
#define S_IROTH 0000004 /* R for other */
|
|
#define S_IWOTH 0000002 /* W for other */
|
|
#define S_IXOTH 0000001 /* X for other */
|
|
|
|
#if __XSI_VISIBLE
|
|
#define S_IFMT 0170000 /* type of file mask */
|
|
#define S_IFIFO 0010000 /* named pipe (fifo) */
|
|
#define S_IFCHR 0020000 /* character special */
|
|
#define S_IFDIR 0040000 /* directory */
|
|
#define S_IFBLK 0060000 /* block special */
|
|
#define S_IFREG 0100000 /* regular */
|
|
#define S_IFLNK 0120000 /* symbolic link */
|
|
#define S_IFSOCK 0140000 /* socket */
|
|
#define S_ISVTX 0001000 /* save swapped text even after use */
|
|
#endif
|
|
#if __BSD_VISIBLE
|
|
#define S_IFWHT 0160000 /* whiteout */
|
|
#endif
|
|
|
|
#define S_ISDIR(m) (((m) & 0170000) == 0040000) /* directory */
|
|
#define S_ISCHR(m) (((m) & 0170000) == 0020000) /* char special */
|
|
#define S_ISBLK(m) (((m) & 0170000) == 0060000) /* block special */
|
|
#define S_ISREG(m) (((m) & 0170000) == 0100000) /* regular file */
|
|
#define S_ISFIFO(m) (((m) & 0170000) == 0010000) /* fifo or socket */
|
|
#if __POSIX_VISIBLE >= 200112
|
|
#define S_ISLNK(m) (((m) & 0170000) == 0120000) /* symbolic link */
|
|
#define S_ISSOCK(m) (((m) & 0170000) == 0140000) /* socket */
|
|
#endif
|
|
#if __BSD_VISIBLE
|
|
#define S_ISWHT(m) (((m) & 0170000) == 0160000) /* whiteout */
|
|
#endif
|
|
|
|
#if __BSD_VISIBLE
|
|
#define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
|
|
/* 7777 */
|
|
#define ALLPERMS (S_ISUID|S_ISGID|S_ISTXT|S_IRWXU|S_IRWXG|S_IRWXO)
|
|
/* 0666 */
|
|
#define DEFFILEMODE (S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH)
|
|
|
|
#define S_BLKSIZE 512 /* block size used in the stat struct */
|
|
|
|
/*
|
|
* Definitions of flags stored in file flags word.
|
|
*
|
|
* Super-user and owner changeable flags.
|
|
*/
|
|
#define UF_SETTABLE 0x0000ffff /* mask of owner changeable flags */
|
|
#define UF_NODUMP 0x00000001 /* do not dump file */
|
|
#define UF_IMMUTABLE 0x00000002 /* file may not be changed */
|
|
#define UF_APPEND 0x00000004 /* writes to file may only append */
|
|
#define UF_OPAQUE 0x00000008 /* directory is opaque wrt. union */
|
|
#define UF_NOUNLINK 0x00000010 /* file may not be removed or renamed */
|
|
/*
|
|
* These two bits are defined in MacOS X. They are not currently used in
|
|
* FreeBSD.
|
|
*/
|
|
#if 0
|
|
#define UF_COMPRESSED 0x00000020 /* file is compressed */
|
|
#define UF_TRACKED 0x00000040 /* renames and deletes are tracked */
|
|
#endif
|
|
|
|
#define UF_SYSTEM 0x00000080 /* Windows system file bit */
|
|
#define UF_SPARSE 0x00000100 /* sparse file */
|
|
#define UF_OFFLINE 0x00000200 /* file is offline */
|
|
#define UF_REPARSE 0x00000400 /* Windows reparse point file bit */
|
|
#define UF_ARCHIVE 0x00000800 /* file needs to be archived */
|
|
#define UF_READONLY 0x00001000 /* Windows readonly file bit */
|
|
/* This is the same as the MacOS X definition of UF_HIDDEN. */
|
|
#define UF_HIDDEN 0x00008000 /* file is hidden */
|
|
|
|
/*
|
|
* Super-user changeable flags.
|
|
*/
|
|
#define SF_SETTABLE 0xffff0000 /* mask of superuser changeable flags */
|
|
#define SF_ARCHIVED 0x00010000 /* file is archived */
|
|
#define SF_IMMUTABLE 0x00020000 /* file may not be changed */
|
|
#define SF_APPEND 0x00040000 /* writes to file may only append */
|
|
#define SF_NOUNLINK 0x00100000 /* file may not be removed or renamed */
|
|
#define SF_SNAPSHOT 0x00200000 /* snapshot inode */
|
|
|
|
#ifdef _KERNEL
|
|
/*
|
|
* Shorthand abbreviations of above.
|
|
*/
|
|
#define OPAQUE (UF_OPAQUE)
|
|
#define APPEND (UF_APPEND | SF_APPEND)
|
|
#define IMMUTABLE (UF_IMMUTABLE | SF_IMMUTABLE)
|
|
#define NOUNLINK (UF_NOUNLINK | SF_NOUNLINK)
|
|
#endif
|
|
|
|
#endif /* __BSD_VISIBLE */
|
|
|
|
#ifndef _KERNEL
|
|
__BEGIN_DECLS
|
|
#if __BSD_VISIBLE
|
|
int chflags(const char *, unsigned long);
|
|
int chflagsat(int, const char *, unsigned long, int);
|
|
#endif
|
|
int chmod(const char *, mode_t);
|
|
#if __BSD_VISIBLE
|
|
int fchflags(int, unsigned long);
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200112
|
|
int fchmod(int, mode_t);
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200809
|
|
int fchmodat(int, const char *, mode_t, int);
|
|
#endif
|
|
int fstat(int, struct stat *);
|
|
#if __BSD_VISIBLE
|
|
int lchflags(const char *, unsigned long);
|
|
int lchmod(const char *, mode_t);
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200112
|
|
int lstat(const char * __restrict, struct stat * __restrict);
|
|
#endif
|
|
int mkdir(const char *, mode_t);
|
|
int mkfifo(const char *, mode_t);
|
|
#if !defined(_MKNOD_DECLARED) && __XSI_VISIBLE
|
|
int mknod(const char *, mode_t, dev_t);
|
|
#define _MKNOD_DECLARED
|
|
#endif
|
|
int stat(const char * __restrict, struct stat * __restrict);
|
|
mode_t umask(mode_t);
|
|
#if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
|
|
int fstatat(int, const char *, struct stat *, int);
|
|
int mkdirat(int, const char *, mode_t);
|
|
int mkfifoat(int, const char *, mode_t);
|
|
#endif
|
|
#if __BSD_VISIBLE || __XSI_VISIBLE >= 700
|
|
int mknodat(int, const char *, mode_t, dev_t);
|
|
#endif
|
|
__END_DECLS
|
|
#endif /* !_KERNEL */
|
|
|
|
#endif /* !_SYS_STAT_H_ */
|