fs/xfs/xfs_mount.h

   1 /*
   2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3  * All Rights Reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it would be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write the Free Software Foundation,
  16  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  */
  18 #ifndef __XFS_MOUNT_H__
  19 #define __XFS_MOUNT_H__
  20
  21 #ifdef __KERNEL__
  22
  23 struct xlog;
  24 struct xfs_inode;
  25 struct xfs_mru_cache;
  26 struct xfs_nameops;
  27 struct xfs_ail;
  28 struct xfs_quotainfo;
  29 struct xfs_dir_ops;
  30 struct xfs_da_geometry;
  31
  32 #ifdef HAVE_PERCPU_SB
  33
  34 /*
  35  * Valid per-cpu incore superblock counters. Note that if you add new counters,
  36  * you may need to define new counter disabled bit field descriptors as there
  37  * are more possible fields in the superblock that can fit in a bitfield on a
  38  * 32 bit platform. The XFS_SBS_* values for the current current counters just
  39  * fit.
  40  */
  41 typedef struct xfs_icsb_cnts {
  42         uint64_t        icsb_fdblocks;
  43         uint64_t        icsb_ifree;
  44         unsigned long   icsb_flags;
  45 } xfs_icsb_cnts_t;
  46
  47 #define XFS_ICSB_FLAG_LOCK      (1 << 0)        /* counter lock bit */
  48
  49 #define XFS_ICSB_LAZY_COUNT     (1 << 1)        /* accuracy not needed */
  50
  51 extern int      xfs_icsb_init_counters(struct xfs_mount *);
  52 extern void     xfs_icsb_reinit_counters(struct xfs_mount *);
  53 extern void     xfs_icsb_destroy_counters(struct xfs_mount *);
  54 extern void     xfs_icsb_sync_counters(struct xfs_mount *, int);
  55 extern void     xfs_icsb_sync_counters_locked(struct xfs_mount *, int);
  56 extern int      xfs_icsb_modify_counters(struct xfs_mount *, xfs_sb_field_t,
  57                                                 int64_t, int);
  58
  59 #else
  60 #define xfs_icsb_init_counters(mp)              (0)
  61 #define xfs_icsb_destroy_counters(mp)           do { } while (0)
  62 #define xfs_icsb_reinit_counters(mp)            do { } while (0)
  63 #define xfs_icsb_sync_counters(mp, flags)       do { } while (0)
  64 #define xfs_icsb_sync_counters_locked(mp, flags) do { } while (0)
  65 #define xfs_icsb_modify_counters(mp, field, delta, rsvd) \
  66         xfs_mod_incore_sb(mp, field, delta, rsvd)
  67 #endif
  68
  69 /* dynamic preallocation free space thresholds, 5% down to 1% */
  70 enum {
  71         XFS_LOWSP_1_PCNT = 0,
  72         XFS_LOWSP_2_PCNT,
  73         XFS_LOWSP_3_PCNT,
  74         XFS_LOWSP_4_PCNT,
  75         XFS_LOWSP_5_PCNT,
  76         XFS_LOWSP_MAX,
  77 };
  78
  79 typedef struct xfs_mount {
  80         struct super_block      *m_super;
  81         xfs_tid_t               m_tid;          /* next unused tid for fs */
  82         struct xfs_ail          *m_ail;         /* fs active log item list */
  83
  84         struct xfs_sb           m_sb;           /* copy of fs superblock */
  85         spinlock_t              m_sb_lock;      /* sb counter lock */
  86         struct percpu_counter   m_icount;       /* allocated inodes counter */
  87
  88         struct xfs_buf          *m_sb_bp;       /* buffer for superblock */
  89         char                    *m_fsname;      /* filesystem name */
  90         int                     m_fsname_len;   /* strlen of fs name */
  91         char                    *m_rtname;      /* realtime device name */
  92         char                    *m_logname;     /* external log device name */
  93         int                     m_bsize;        /* fs logical block size */
  94         xfs_agnumber_t          m_agfrotor;     /* last ag where space found */
  95         xfs_agnumber_t          m_agirotor;     /* last ag dir inode alloced */
  96         spinlock_t              m_agirotor_lock;/* .. and lock protecting it */
  97         xfs_agnumber_t          m_maxagi;       /* highest inode alloc group */
  98         uint                    m_readio_log;   /* min read size log bytes */
  99         uint                    m_readio_blocks; /* min read size blocks */
 100         uint                    m_writeio_log;  /* min write size log bytes */
 101         uint                    m_writeio_blocks; /* min write size blocks */
 102         struct xfs_da_geometry  *m_dir_geo;     /* directory block geometry */
 103         struct xfs_da_geometry  *m_attr_geo;    /* attribute block geometry */
 104         struct xlog             *m_log;         /* log specific stuff */
 105         int                     m_logbufs;      /* number of log buffers */
 106         int                     m_logbsize;     /* size of each log buffer */
 107         uint                    m_rsumlevels;   /* rt summary levels */
 108         uint                    m_rsumsize;     /* size of rt summary, bytes */
 109         struct xfs_inode        *m_rbmip;       /* pointer to bitmap inode */
 110         struct xfs_inode        *m_rsumip;      /* pointer to summary inode */
 111         struct xfs_inode        *m_rootip;      /* pointer to root directory */
 112         struct xfs_quotainfo    *m_quotainfo;   /* disk quota information */
 113         xfs_buftarg_t           *m_ddev_targp;  /* saves taking the address */
 114         xfs_buftarg_t           *m_logdev_targp;/* ptr to log device */
 115         xfs_buftarg_t           *m_rtdev_targp; /* ptr to rt device */
 116         __uint8_t               m_blkbit_log;   /* blocklog + NBBY */
 117         __uint8_t               m_blkbb_log;    /* blocklog - BBSHIFT */
 118         __uint8_t               m_agno_log;     /* log #ag's */
 119         __uint8_t               m_agino_log;    /* #bits for agino in inum */
 120         uint                    m_inode_cluster_size;/* min inode buf size */
 121         uint                    m_blockmask;    /* sb_blocksize-1 */
 122         uint                    m_blockwsize;   /* sb_blocksize in words */
 123         uint                    m_blockwmask;   /* blockwsize-1 */
 124         uint                    m_alloc_mxr[2]; /* max alloc btree records */
 125         uint                    m_alloc_mnr[2]; /* min alloc btree records */
 126         uint                    m_bmap_dmxr[2]; /* max bmap btree records */
 127         uint                    m_bmap_dmnr[2]; /* min bmap btree records */
 128         uint                    m_inobt_mxr[2]; /* max inobt btree records */
 129         uint                    m_inobt_mnr[2]; /* min inobt btree records */
 130         uint                    m_ag_maxlevels; /* XFS_AG_MAXLEVELS */
 131         uint                    m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
 132         uint                    m_in_maxlevels; /* max inobt btree levels. */
 133         struct radix_tree_root  m_perag_tree;   /* per-ag accounting info */
 134         spinlock_t              m_perag_lock;   /* lock for m_perag_tree */
 135         struct mutex            m_growlock;     /* growfs mutex */
 136         int                     m_fixedfsid[2]; /* unchanged for life of FS */
 137         uint                    m_dmevmask;     /* DMI events for this FS */
 138         __uint64_t              m_flags;        /* global mount flags */
 139         int                     m_ialloc_inos;  /* inodes in inode allocation */
 140         int                     m_ialloc_blks;  /* blocks in inode allocation */
 141         int                     m_inoalign_mask;/* mask sb_inoalignmt if used */
 142         uint                    m_qflags;       /* quota status flags */
 143         struct xfs_trans_resv   m_resv;         /* precomputed res values */
 144         __uint64_t              m_maxicount;    /* maximum inode count */
 145         __uint64_t              m_resblks;      /* total reserved blocks */
 146         __uint64_t              m_resblks_avail;/* available reserved blocks */
 147         __uint64_t              m_resblks_save; /* reserved blks @ remount,ro */
 148         int                     m_dalign;       /* stripe unit */
 149         int                     m_swidth;       /* stripe width */
 150         int                     m_sinoalign;    /* stripe unit inode alignment */
 151         __uint8_t               m_sectbb_log;   /* sectlog - BBSHIFT */
 152         const struct xfs_nameops *m_dirnameops; /* vector of dir name ops */
 153         const struct xfs_dir_ops *m_dir_inode_ops; /* vector of dir inode ops */
 154         const struct xfs_dir_ops *m_nondir_inode_ops; /* !dir inode ops */
 155         uint                    m_chsize;       /* size of next field */
 156         atomic_t                m_active_trans; /* number trans frozen */
 157 #ifdef HAVE_PERCPU_SB
 158         xfs_icsb_cnts_t __percpu *m_sb_cnts;    /* per-cpu superblock counters */
 159         unsigned long           m_icsb_counters; /* disabled per-cpu counters */
 160         struct notifier_block   m_icsb_notifier; /* hotplug cpu notifier */
 161         struct mutex            m_icsb_mutex;   /* balancer sync lock */
 162 #endif
 163         struct xfs_mru_cache    *m_filestream;  /* per-mount filestream data */
 164         struct delayed_work     m_reclaim_work; /* background inode reclaim */
 165         struct delayed_work     m_eofblocks_work; /* background eof blocks
 166                                                      trimming */
 167         bool                    m_update_sb;    /* sb needs update in mount */
 168         int64_t                 m_low_space[XFS_LOWSP_MAX];
 169                                                 /* low free space thresholds */
 170         struct xfs_kobj         m_kobj;
 171
 172         struct workqueue_struct *m_buf_workqueue;
 173         struct workqueue_struct *m_data_workqueue;
 174         struct workqueue_struct *m_unwritten_workqueue;
 175         struct workqueue_struct *m_cil_workqueue;
 176         struct workqueue_struct *m_reclaim_workqueue;
 177         struct workqueue_struct *m_log_workqueue;
 178         struct workqueue_struct *m_eofblocks_workqueue;
 179
 180         /*
 181          * Generation of the filesysyem layout.  This is incremented by each
 182          * growfs, and used by the pNFS server to ensure the client updates
 183          * its view of the block device once it gets a layout that might
 184          * reference the newly added blocks.  Does not need to be persistent
 185          * as long as we only allow file system size increments, but if we
 186          * ever support shrinks it would have to be persisted in addition
 187          * to various other kinds of pain inflicted on the pNFS server.
 188          */
 189         __uint32_t              m_generation;
 190 } xfs_mount_t;
 191
 192 /*
 193  * Flags for m_flags.
 194  */
 195 #define XFS_MOUNT_WSYNC         (1ULL << 0)     /* for nfs - all metadata ops
 196                                                    must be synchronous except
 197                                                    for space allocations */
 198 #define XFS_MOUNT_WAS_CLEAN     (1ULL << 3)
 199 #define XFS_MOUNT_FS_SHUTDOWN   (1ULL << 4)     /* atomic stop of all filesystem
 200                                                    operations, typically for
 201                                                    disk errors in metadata */
 202 #define XFS_MOUNT_DISCARD       (1ULL << 5)     /* discard unused blocks */
 203 #define XFS_MOUNT_NOALIGN       (1ULL << 7)     /* turn off stripe alignment
 204                                                    allocations */
 205 #define XFS_MOUNT_ATTR2         (1ULL << 8)     /* allow use of attr2 format */
 206 #define XFS_MOUNT_GRPID         (1ULL << 9)     /* group-ID assigned from directory */
 207 #define XFS_MOUNT_NORECOVERY    (1ULL << 10)    /* no recovery - dirty fs */
 208 #define XFS_MOUNT_DFLT_IOSIZE   (1ULL << 12)    /* set default i/o size */
 209 #define XFS_MOUNT_32BITINODES   (1ULL << 14)    /* do not create inodes above
 210                                                  * 32 bits in size */
 211 #define XFS_MOUNT_SMALL_INUMS   (1ULL << 15)    /* users wants 32bit inodes */
 212 #define XFS_MOUNT_NOUUID        (1ULL << 16)    /* ignore uuid during mount */
 213 #define XFS_MOUNT_BARRIER       (1ULL << 17)
 214 #define XFS_MOUNT_IKEEP         (1ULL << 18)    /* keep empty inode clusters*/
 215 #define XFS_MOUNT_SWALLOC       (1ULL << 19)    /* turn on stripe width
 216                                                  * allocation */
 217 #define XFS_MOUNT_RDONLY        (1ULL << 20)    /* read-only fs */
 218 #define XFS_MOUNT_DIRSYNC       (1ULL << 21)    /* synchronous directory ops */
 219 #define XFS_MOUNT_COMPAT_IOSIZE (1ULL << 22)    /* don't report large preferred
 220                                                  * I/O size in stat() */
 221 #define XFS_MOUNT_FILESTREAMS   (1ULL << 24)    /* enable the filestreams
 222                                                    allocator */
 223 #define XFS_MOUNT_NOATTR2       (1ULL << 25)    /* disable use of attr2 format */
 224
 225
 226 /*
 227  * Default minimum read and write sizes.
 228  */
 229 #define XFS_READIO_LOG_LARGE    16
 230 #define XFS_WRITEIO_LOG_LARGE   16
 231
 232 /*
 233  * Max and min values for mount-option defined I/O
 234  * preallocation sizes.
 235  */
 236 #define XFS_MAX_IO_LOG          30      /* 1G */
 237 #define XFS_MIN_IO_LOG          PAGE_SHIFT
 238
 239 /*
 240  * Synchronous read and write sizes.  This should be
 241  * better for NFSv2 wsync filesystems.
 242  */
 243 #define XFS_WSYNC_READIO_LOG    15      /* 32k */
 244 #define XFS_WSYNC_WRITEIO_LOG   14      /* 16k */
 245
 246 /*
 247  * Allow large block sizes to be reported to userspace programs if the
 248  * "largeio" mount option is used.
 249  *
 250  * If compatibility mode is specified, simply return the basic unit of caching
 251  * so that we don't get inefficient read/modify/write I/O from user apps.
 252  * Otherwise....
 253  *
 254  * If the underlying volume is a stripe, then return the stripe width in bytes
 255  * as the recommended I/O size. It is not a stripe and we've set a default
 256  * buffered I/O size, return that, otherwise return the compat default.
 257  */
 258 static inline unsigned long
 259 xfs_preferred_iosize(xfs_mount_t *mp)
 260 {
 261         if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
 262                 return PAGE_CACHE_SIZE;
 263         return (mp->m_swidth ?
 264                 (mp->m_swidth << mp->m_sb.sb_blocklog) :
 265                 ((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
 266                         (1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
 267                         PAGE_CACHE_SIZE));
 268 }
 269
 270 #define XFS_LAST_UNMOUNT_WAS_CLEAN(mp)  \
 271                                 ((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
 272 #define XFS_FORCED_SHUTDOWN(mp) ((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
 273 void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
 274                 int lnnum);
 275 #define xfs_force_shutdown(m,f) \
 276         xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
 277
 278 #define SHUTDOWN_META_IO_ERROR  0x0001  /* write attempt to metadata failed */
 279 #define SHUTDOWN_LOG_IO_ERROR   0x0002  /* write attempt to the log failed */
 280 #define SHUTDOWN_FORCE_UMOUNT   0x0004  /* shutdown from a forced unmount */
 281 #define SHUTDOWN_CORRUPT_INCORE 0x0008  /* corrupt in-memory data structures */
 282 #define SHUTDOWN_REMOTE_REQ     0x0010  /* shutdown came from remote cell */
 283 #define SHUTDOWN_DEVICE_REQ     0x0020  /* failed all paths to the device */
 284
 285 /*
 286  * Flags for xfs_mountfs
 287  */
 288 #define XFS_MFSI_QUIET          0x40    /* Be silent if mount errors found */
 289
 290 static inline xfs_agnumber_t
 291 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
 292 {
 293         xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
 294         do_div(ld, mp->m_sb.sb_agblocks);
 295         return (xfs_agnumber_t) ld;
 296 }
 297
 298 static inline xfs_agblock_t
 299 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
 300 {
 301         xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
 302         return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
 303 }
 304
 305 /*
 306  * Per-cpu superblock locking functions
 307  */
 308 #ifdef HAVE_PERCPU_SB
 309 static inline void
 310 xfs_icsb_lock(xfs_mount_t *mp)
 311 {
 312         mutex_lock(&mp->m_icsb_mutex);
 313 }
 314
 315 static inline void
 316 xfs_icsb_unlock(xfs_mount_t *mp)
 317 {
 318         mutex_unlock(&mp->m_icsb_mutex);
 319 }
 320 #else
 321 #define xfs_icsb_lock(mp)
 322 #define xfs_icsb_unlock(mp)
 323 #endif
 324
 325 /*
 326  * This structure is for use by the xfs_mod_incore_sb_batch() routine.
 327  * xfs_growfs can specify a few fields which are more than int limit
 328  */
 329 typedef struct xfs_mod_sb {
 330         xfs_sb_field_t  msb_field;      /* Field to modify, see below */
 331         int64_t         msb_delta;      /* Change to make to specified field */
 332 } xfs_mod_sb_t;
 333
 334 /*
 335  * Per-ag incore structure, copies of information in agf and agi, to improve the
 336  * performance of allocation group selection.
 337  */
 338 typedef struct xfs_perag {
 339         struct xfs_mount *pag_mount;    /* owner filesystem */
 340         xfs_agnumber_t  pag_agno;       /* AG this structure belongs to */
 341         atomic_t        pag_ref;        /* perag reference count */
 342         char            pagf_init;      /* this agf's entry is initialized */
 343         char            pagi_init;      /* this agi's entry is initialized */
 344         char            pagf_metadata;  /* the agf is preferred to be metadata */
 345         char            pagi_inodeok;   /* The agi is ok for inodes */
 346         __uint8_t       pagf_levels[XFS_BTNUM_AGF];
 347                                         /* # of levels in bno & cnt btree */
 348         __uint32_t      pagf_flcount;   /* count of blocks in freelist */
 349         xfs_extlen_t    pagf_freeblks;  /* total free blocks */
 350         xfs_extlen_t    pagf_longest;   /* longest free space */
 351         __uint32_t      pagf_btreeblks; /* # of blocks held in AGF btrees */
 352         xfs_agino_t     pagi_freecount; /* number of free inodes */
 353         xfs_agino_t     pagi_count;     /* number of allocated inodes */
 354
 355         /*
 356          * Inode allocation search lookup optimisation.
 357          * If the pagino matches, the search for new inodes
 358          * doesn't need to search the near ones again straight away
 359          */
 360         xfs_agino_t     pagl_pagino;
 361         xfs_agino_t     pagl_leftrec;
 362         xfs_agino_t     pagl_rightrec;
 363         spinlock_t      pagb_lock;      /* lock for pagb_tree */
 364         struct rb_root  pagb_tree;      /* ordered tree of busy extents */
 365
 366         atomic_t        pagf_fstrms;    /* # of filestreams active in this AG */
 367
 368         spinlock_t      pag_ici_lock;   /* incore inode cache lock */
 369         struct radix_tree_root pag_ici_root;    /* incore inode cache root */
 370         int             pag_ici_reclaimable;    /* reclaimable inodes */
 371         struct mutex    pag_ici_reclaim_lock;   /* serialisation point */
 372         unsigned long   pag_ici_reclaim_cursor; /* reclaim restart point */
 373
 374         /* buffer cache index */
 375         spinlock_t      pag_buf_lock;   /* lock for pag_buf_tree */
 376         struct rb_root  pag_buf_tree;   /* ordered tree of active buffers */
 377
 378         /* for rcu-safe freeing */
 379         struct rcu_head rcu_head;
 380         int             pagb_count;     /* pagb slots in use */
 381 } xfs_perag_t;
 382
 383 extern int      xfs_log_sbcount(xfs_mount_t *);
 384 extern __uint64_t xfs_default_resblks(xfs_mount_t *mp);
 385 extern int      xfs_mountfs(xfs_mount_t *mp);
 386 extern int      xfs_initialize_perag(xfs_mount_t *mp, xfs_agnumber_t agcount,
 387                                      xfs_agnumber_t *maxagi);
 388
 389 extern void     xfs_unmountfs(xfs_mount_t *);
 390 extern int      xfs_mod_incore_sb(xfs_mount_t *, xfs_sb_field_t, int64_t, int);
 391 extern int      xfs_mod_incore_sb_batch(xfs_mount_t *, xfs_mod_sb_t *,
 392                         uint, int);
 393 extern int      xfs_mod_icount(struct xfs_mount *mp, int64_t delta);
 394 extern int      xfs_mount_log_sb(xfs_mount_t *);
 395 extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
 396 extern int      xfs_readsb(xfs_mount_t *, int);
 397 extern void     xfs_freesb(xfs_mount_t *);
 398 extern bool     xfs_fs_writable(struct xfs_mount *mp, int level);
 399 extern int      xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
 400
 401 extern int      xfs_dev_is_read_only(struct xfs_mount *, char *);
 402
 403 extern void     xfs_set_low_space_thresholds(struct xfs_mount *);
 404
 405 #endif  /* __KERNEL__ */
 406
 407 #endif  /* __XFS_MOUNT_H__ */