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