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