include/uapi/linux/fs.h

   1 #ifndef _UAPI_LINUX_FS_H
   2 #define _UAPI_LINUX_FS_H
   3
   4 /*
   5  * This file has definitions for some important file table
   6  * structures etc.
   7  */
   8
   9 #include <linux/limits.h>
  10 #include <linux/ioctl.h>
  11 #include <linux/types.h>
  12
  13 /*
  14  * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
  15  * the file limit at runtime and only root can increase the per-process
  16  * nr_file rlimit, so it's safe to set up a ridiculously high absolute
  17  * upper limit on files-per-process.
  18  *
  19  * Some programs (notably those using select()) may have to be
  20  * recompiled to take full advantage of the new limits..
  21  */
  22
  23 /* Fixed constants first: */
  24 #undef NR_OPEN
  25 #define INR_OPEN_CUR 1024       /* Initial setting for nfile rlimits */
  26 #define INR_OPEN_MAX 4096       /* Hard limit for nfile rlimits */
  27
  28 #define BLOCK_SIZE_BITS 10
  29 #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
  30
  31 #define SEEK_SET        0       /* seek relative to beginning of file */
  32 #define SEEK_CUR        1       /* seek relative to current file position */
  33 #define SEEK_END        2       /* seek relative to end of file */
  34 #define SEEK_DATA       3       /* seek to the next data */
  35 #define SEEK_HOLE       4       /* seek to the next hole */
  36 #define SEEK_MAX        SEEK_HOLE
  37
  38 struct fstrim_range {
  39         __u64 start;
  40         __u64 len;
  41         __u64 minlen;
  42 };
  43
  44 /* And dynamically-tunable limits and defaults: */
  45 struct files_stat_struct {
  46         unsigned long nr_files;         /* read only */
  47         unsigned long nr_free_files;    /* read only */
  48         unsigned long max_files;                /* tunable */
  49 };
  50
  51 struct inodes_stat_t {
  52         int nr_inodes;
  53         int nr_unused;
  54         int dummy[5];           /* padding for sysctl ABI compatibility */
  55 };
  56
  57
  58 #define NR_FILE  8192   /* this can well be larger on a larger system */
  59
  60 #define MAY_EXEC                0x00000001
  61 #define MAY_WRITE               0x00000002
  62 #define MAY_READ                0x00000004
  63 #define MAY_APPEND              0x00000008
  64 #define MAY_ACCESS              0x00000010
  65 #define MAY_OPEN                0x00000020
  66 #define MAY_CHDIR               0x00000040
  67 /* called from RCU mode, don't block */
  68 #define MAY_NOT_BLOCK           0x00000080
  69
  70 /*
  71  * flags in file.f_mode.  Note that FMODE_READ and FMODE_WRITE must correspond
  72  * to O_WRONLY and O_RDWR via the strange trick in __dentry_open()
  73  */
  74
  75 /* file is open for reading */
  76 #define FMODE_READ              ((__force fmode_t)0x1)
  77 /* file is open for writing */
  78 #define FMODE_WRITE             ((__force fmode_t)0x2)
  79 /* file is seekable */
  80 #define FMODE_LSEEK             ((__force fmode_t)0x4)
  81 /* file can be accessed using pread */
  82 #define FMODE_PREAD             ((__force fmode_t)0x8)
  83 /* file can be accessed using pwrite */
  84 #define FMODE_PWRITE            ((__force fmode_t)0x10)
  85 /* File is opened for execution with sys_execve / sys_uselib */
  86 #define FMODE_EXEC              ((__force fmode_t)0x20)
  87 /* File is opened with O_NDELAY (only set for block devices) */
  88 #define FMODE_NDELAY            ((__force fmode_t)0x40)
  89 /* File is opened with O_EXCL (only set for block devices) */
  90 #define FMODE_EXCL              ((__force fmode_t)0x80)
  91 /* File is opened using open(.., 3, ..) and is writeable only for ioctls
  92    (specialy hack for floppy.c) */
  93 #define FMODE_WRITE_IOCTL       ((__force fmode_t)0x100)
  94 /* 32bit hashes as llseek() offset (for directories) */
  95 #define FMODE_32BITHASH         ((__force fmode_t)0x200)
  96 /* 64bit hashes as llseek() offset (for directories) */
  97 #define FMODE_64BITHASH         ((__force fmode_t)0x400)
  98
  99 /*
 100  * Don't update ctime and mtime.
 101  *
 102  * Currently a special hack for the XFS open_by_handle ioctl, but we'll
 103  * hopefully graduate it to a proper O_CMTIME flag supported by open(2) soon.
 104  */
 105 #define FMODE_NOCMTIME          ((__force fmode_t)0x800)
 106
 107 /* Expect random access pattern */
 108 #define FMODE_RANDOM            ((__force fmode_t)0x1000)
 109
 110 /* File is huge (eg. /dev/kmem): treat loff_t as unsigned */
 111 #define FMODE_UNSIGNED_OFFSET   ((__force fmode_t)0x2000)
 112
 113 /* File is opened with O_PATH; almost nothing can be done with it */
 114 #define FMODE_PATH              ((__force fmode_t)0x4000)
 115
 116 /* File was opened by fanotify and shouldn't generate fanotify events */
 117 #define FMODE_NONOTIFY          ((__force fmode_t)0x1000000)
 118
 119 /*
 120  * Flag for rw_copy_check_uvector and compat_rw_copy_check_uvector
 121  * that indicates that they should check the contents of the iovec are
 122  * valid, but not check the memory that the iovec elements
 123  * points too.
 124  */
 125 #define CHECK_IOVEC_ONLY -1
 126
 127 #define SEL_IN          1
 128 #define SEL_OUT         2
 129 #define SEL_EX          4
 130
 131 /* public flags for file_system_type */
 132 #define FS_REQUIRES_DEV 1
 133 #define FS_BINARY_MOUNTDATA 2
 134 #define FS_HAS_SUBTYPE 4
 135 #define FS_REVAL_DOT    16384   /* Check the paths ".", ".." for staleness */
 136 #define FS_RENAME_DOES_D_MOVE   32768   /* FS will handle d_move()
 137                                          * during rename() internally.
 138                                          */
 139
 140 /*
 141  * These are the fs-independent mount-flags: up to 32 flags are supported
 142  */
 143 #define MS_RDONLY        1      /* Mount read-only */
 144 #define MS_NOSUID        2      /* Ignore suid and sgid bits */
 145 #define MS_NODEV         4      /* Disallow access to device special files */
 146 #define MS_NOEXEC        8      /* Disallow program execution */
 147 #define MS_SYNCHRONOUS  16      /* Writes are synced at once */
 148 #define MS_REMOUNT      32      /* Alter flags of a mounted FS */
 149 #define MS_MANDLOCK     64      /* Allow mandatory locks on an FS */
 150 #define MS_DIRSYNC      128     /* Directory modifications are synchronous */
 151 #define MS_NOATIME      1024    /* Do not update access times. */
 152 #define MS_NODIRATIME   2048    /* Do not update directory access times */
 153 #define MS_BIND         4096
 154 #define MS_MOVE         8192
 155 #define MS_REC          16384
 156 #define MS_VERBOSE      32768   /* War is peace. Verbosity is silence.
 157                                    MS_VERBOSE is deprecated. */
 158 #define MS_SILENT       32768
 159 #define MS_POSIXACL     (1<<16) /* VFS does not apply the umask */
 160 #define MS_UNBINDABLE   (1<<17) /* change to unbindable */
 161 #define MS_PRIVATE      (1<<18) /* change to private */
 162 #define MS_SLAVE        (1<<19) /* change to slave */
 163 #define MS_SHARED       (1<<20) /* change to shared */
 164 #define MS_RELATIME     (1<<21) /* Update atime relative to mtime/ctime. */
 165 #define MS_KERNMOUNT    (1<<22) /* this is a kern_mount call */
 166 #define MS_I_VERSION    (1<<23) /* Update inode I_version field */
 167 #define MS_STRICTATIME  (1<<24) /* Always perform atime updates */
 168 #define MS_NOSEC        (1<<28)
 169 #define MS_BORN         (1<<29)
 170 #define MS_ACTIVE       (1<<30)
 171 #define MS_NOUSER       (1<<31)
 172
 173 /*
 174  * Superblock flags that can be altered by MS_REMOUNT
 175  */
 176 #define MS_RMT_MASK     (MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_I_VERSION)
 177
 178 /*
 179  * Old magic mount flag and mask
 180  */
 181 #define MS_MGC_VAL 0xC0ED0000
 182 #define MS_MGC_MSK 0xffff0000
 183
 184 /* Inode flags - they have nothing to superblock flags now */
 185
 186 #define S_SYNC          1       /* Writes are synced at once */
 187 #define S_NOATIME       2       /* Do not update access times */
 188 #define S_APPEND        4       /* Append-only file */
 189 #define S_IMMUTABLE     8       /* Immutable file */
 190 #define S_DEAD          16      /* removed, but still open directory */
 191 #define S_NOQUOTA       32      /* Inode is not counted to quota */
 192 #define S_DIRSYNC       64      /* Directory modifications are synchronous */
 193 #define S_NOCMTIME      128     /* Do not update file c/mtime */
 194 #define S_SWAPFILE      256     /* Do not truncate: swapon got its bmaps */
 195 #define S_PRIVATE       512     /* Inode is fs-internal */
 196 #define S_IMA           1024    /* Inode has an associated IMA struct */
 197 #define S_AUTOMOUNT     2048    /* Automount/referral quasi-directory */
 198 #define S_NOSEC         4096    /* no suid or xattr security attributes */
 199
 200 /*
 201  * Note that nosuid etc flags are inode-specific: setting some file-system
 202  * flags just means all the inodes inherit those flags by default. It might be
 203  * possible to override it selectively if you really wanted to with some
 204  * ioctl() that is not currently implemented.
 205  *
 206  * Exception: MS_RDONLY is always applied to the entire file system.
 207  *
 208  * Unfortunately, it is possible to change a filesystems flags with it mounted
 209  * with files in use.  This means that all of the inodes will not have their
 210  * i_flags updated.  Hence, i_flags no longer inherit the superblock mount
 211  * flags, so these have to be checked separately. -- rmk@arm.uk.linux.org
 212  */
 213 #define __IS_FLG(inode,flg) ((inode)->i_sb->s_flags & (flg))
 214
 215 #define IS_RDONLY(inode) ((inode)->i_sb->s_flags & MS_RDONLY)
 216 #define IS_SYNC(inode)          (__IS_FLG(inode, MS_SYNCHRONOUS) || \
 217                                         ((inode)->i_flags & S_SYNC))
 218 #define IS_DIRSYNC(inode)       (__IS_FLG(inode, MS_SYNCHRONOUS|MS_DIRSYNC) || \
 219                                         ((inode)->i_flags & (S_SYNC|S_DIRSYNC)))
 220 #define IS_MANDLOCK(inode)      __IS_FLG(inode, MS_MANDLOCK)
 221 #define IS_NOATIME(inode)   __IS_FLG(inode, MS_RDONLY|MS_NOATIME)
 222 #define IS_I_VERSION(inode)   __IS_FLG(inode, MS_I_VERSION)
 223
 224 #define IS_NOQUOTA(inode)       ((inode)->i_flags & S_NOQUOTA)
 225 #define IS_APPEND(inode)        ((inode)->i_flags & S_APPEND)
 226 #define IS_IMMUTABLE(inode)     ((inode)->i_flags & S_IMMUTABLE)
 227 #define IS_POSIXACL(inode)      __IS_FLG(inode, MS_POSIXACL)
 228
 229 #define IS_DEADDIR(inode)       ((inode)->i_flags & S_DEAD)
 230 #define IS_NOCMTIME(inode)      ((inode)->i_flags & S_NOCMTIME)
 231 #define IS_SWAPFILE(inode)      ((inode)->i_flags & S_SWAPFILE)
 232 #define IS_PRIVATE(inode)       ((inode)->i_flags & S_PRIVATE)
 233 #define IS_IMA(inode)           ((inode)->i_flags & S_IMA)
 234 #define IS_AUTOMOUNT(inode)     ((inode)->i_flags & S_AUTOMOUNT)
 235 #define IS_NOSEC(inode)         ((inode)->i_flags & S_NOSEC)
 236
 237 /* the read-only stuff doesn't really belong here, but any other place is
 238    probably as bad and I don't want to create yet another include file. */
 239
 240 #define BLKROSET   _IO(0x12,93) /* set device read-only (0 = read-write) */
 241 #define BLKROGET   _IO(0x12,94) /* get read-only status (0 = read_write) */
 242 #define BLKRRPART  _IO(0x12,95) /* re-read partition table */
 243 #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
 244 #define BLKFLSBUF  _IO(0x12,97) /* flush buffer cache */
 245 #define BLKRASET   _IO(0x12,98) /* set read ahead for block device */
 246 #define BLKRAGET   _IO(0x12,99) /* get current read ahead setting */
 247 #define BLKFRASET  _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
 248 #define BLKFRAGET  _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
 249 #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
 250 #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
 251 #define BLKSSZGET  _IO(0x12,104)/* get block device sector size */
 252 #if 0
 253 #define BLKPG      _IO(0x12,105)/* See blkpg.h */
 254
 255 /* Some people are morons.  Do not use sizeof! */
 256
 257 #define BLKELVGET  _IOR(0x12,106,size_t)/* elevator get */
 258 #define BLKELVSET  _IOW(0x12,107,size_t)/* elevator set */
 259 /* This was here just to show that the number is taken -
 260    probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
 261 #endif
 262 /* A jump here: 108-111 have been used for various private purposes. */
 263 #define BLKBSZGET  _IOR(0x12,112,size_t)
 264 #define BLKBSZSET  _IOW(0x12,113,size_t)
 265 #define BLKGETSIZE64 _IOR(0x12,114,size_t)      /* return device size in bytes (u64 *arg) */
 266 #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
 267 #define BLKTRACESTART _IO(0x12,116)
 268 #define BLKTRACESTOP _IO(0x12,117)
 269 #define BLKTRACETEARDOWN _IO(0x12,118)
 270 #define BLKDISCARD _IO(0x12,119)
 271 #define BLKIOMIN _IO(0x12,120)
 272 #define BLKIOOPT _IO(0x12,121)
 273 #define BLKALIGNOFF _IO(0x12,122)
 274 #define BLKPBSZGET _IO(0x12,123)
 275 #define BLKDISCARDZEROES _IO(0x12,124)
 276 #define BLKSECDISCARD _IO(0x12,125)
 277 #define BLKROTATIONAL _IO(0x12,126)
 278 #define BLKZEROOUT _IO(0x12,127)
 279
 280 #define BMAP_IOCTL 1            /* obsolete - kept for compatibility */
 281 #define FIBMAP     _IO(0x00,1)  /* bmap access */
 282 #define FIGETBSZ   _IO(0x00,2)  /* get the block size used for bmap */
 283 #define FIFREEZE        _IOWR('X', 119, int)    /* Freeze */
 284 #define FITHAW          _IOWR('X', 120, int)    /* Thaw */
 285 #define FITRIM          _IOWR('X', 121, struct fstrim_range)    /* Trim */
 286
 287 #define FS_IOC_GETFLAGS                 _IOR('f', 1, long)
 288 #define FS_IOC_SETFLAGS                 _IOW('f', 2, long)
 289 #define FS_IOC_GETVERSION               _IOR('v', 1, long)
 290 #define FS_IOC_SETVERSION               _IOW('v', 2, long)
 291 #define FS_IOC_FIEMAP                   _IOWR('f', 11, struct fiemap)
 292 #define FS_IOC32_GETFLAGS               _IOR('f', 1, int)
 293 #define FS_IOC32_SETFLAGS               _IOW('f', 2, int)
 294 #define FS_IOC32_GETVERSION             _IOR('v', 1, int)
 295 #define FS_IOC32_SETVERSION             _IOW('v', 2, int)
 296
 297 /*
 298  * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
 299  */
 300 #define FS_SECRM_FL                     0x00000001 /* Secure deletion */
 301 #define FS_UNRM_FL                      0x00000002 /* Undelete */
 302 #define FS_COMPR_FL                     0x00000004 /* Compress file */
 303 #define FS_SYNC_FL                      0x00000008 /* Synchronous updates */
 304 #define FS_IMMUTABLE_FL                 0x00000010 /* Immutable file */
 305 #define FS_APPEND_FL                    0x00000020 /* writes to file may only append */
 306 #define FS_NODUMP_FL                    0x00000040 /* do not dump file */
 307 #define FS_NOATIME_FL                   0x00000080 /* do not update atime */
 308 /* Reserved for compression usage... */
 309 #define FS_DIRTY_FL                     0x00000100
 310 #define FS_COMPRBLK_FL                  0x00000200 /* One or more compressed clusters */
 311 #define FS_NOCOMP_FL                    0x00000400 /* Don't compress */
 312 #define FS_ECOMPR_FL                    0x00000800 /* Compression error */
 313 /* End compression flags --- maybe not all used */
 314 #define FS_BTREE_FL                     0x00001000 /* btree format dir */
 315 #define FS_INDEX_FL                     0x00001000 /* hash-indexed directory */
 316 #define FS_IMAGIC_FL                    0x00002000 /* AFS directory */
 317 #define FS_JOURNAL_DATA_FL              0x00004000 /* Reserved for ext3 */
 318 #define FS_NOTAIL_FL                    0x00008000 /* file tail should not be merged */
 319 #define FS_DIRSYNC_FL                   0x00010000 /* dirsync behaviour (directories only) */
 320 #define FS_TOPDIR_FL                    0x00020000 /* Top of directory hierarchies*/
 321 #define FS_EXTENT_FL                    0x00080000 /* Extents */
 322 #define FS_DIRECTIO_FL                  0x00100000 /* Use direct i/o */
 323 #define FS_NOCOW_FL                     0x00800000 /* Do not cow file */
 324 #define FS_RESERVED_FL                  0x80000000 /* reserved for ext2 lib */
 325
 326 #define FS_FL_USER_VISIBLE              0x0003DFFF /* User visible flags */
 327 #define FS_FL_USER_MODIFIABLE           0x000380FF /* User modifiable flags */
 328
 329
 330 #define SYNC_FILE_RANGE_WAIT_BEFORE     1
 331 #define SYNC_FILE_RANGE_WRITE           2
 332 #define SYNC_FILE_RANGE_WAIT_AFTER      4
 333
 334 #endif /* _UAPI_LINUX_FS_H */