usr/include/linux/fs.h

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