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 typedef struct xfs_trans_reservations {
  22         uint    tr_write;       /* extent alloc trans */
  23         uint    tr_itruncate;   /* truncate trans */
  24         uint    tr_rename;      /* rename trans */
  25         uint    tr_link;        /* link trans */
  26         uint    tr_remove;      /* unlink trans */
  27         uint    tr_symlink;     /* symlink trans */
  28         uint    tr_create;      /* create trans */
  29         uint    tr_mkdir;       /* mkdir trans */
  30         uint    tr_ifree;       /* inode free trans */
  31         uint    tr_ichange;     /* inode update trans */
  32         uint    tr_growdata;    /* fs data section grow trans */
  33         uint    tr_swrite;      /* sync write inode trans */
  34         uint    tr_addafork;    /* cvt inode to attributed trans */
  35         uint    tr_writeid;     /* write setuid/setgid file */
  36         uint    tr_attrinval;   /* attr fork buffer invalidation */
  37         uint    tr_attrset;     /* set/create an attribute */
  38         uint    tr_attrrm;      /* remove an attribute */
  39         uint    tr_clearagi;    /* clear bad agi unlinked ino bucket */
  40         uint    tr_growrtalloc; /* grow realtime allocations */
  41         uint    tr_growrtzero;  /* grow realtime zeroing */
  42         uint    tr_growrtfree;  /* grow realtime freeing */
  43 } xfs_trans_reservations_t;
  44
  45 #ifndef __KERNEL__
  46
  47 #define xfs_daddr_to_agno(mp,d) \
  48         ((xfs_agnumber_t)(XFS_BB_TO_FSBT(mp, d) / (mp)->m_sb.sb_agblocks))
  49 #define xfs_daddr_to_agbno(mp,d) \
  50         ((xfs_agblock_t)(XFS_BB_TO_FSBT(mp, d) % (mp)->m_sb.sb_agblocks))
  51
  52 #else /* __KERNEL__ */
  53
  54 #include "xfs_sync.h"
  55
  56 struct cred;
  57 struct log;
  58 struct xfs_mount_args;
  59 struct xfs_inode;
  60 struct xfs_bmbt_irec;
  61 struct xfs_bmap_free;
  62 struct xfs_extdelta;
  63 struct xfs_swapext;
  64 struct xfs_mru_cache;
  65 struct xfs_nameops;
  66 struct xfs_ail;
  67 struct xfs_quotainfo;
  68
  69 #ifdef HAVE_PERCPU_SB
  70
  71 /*
  72  * Valid per-cpu incore superblock counters. Note that if you add new counters,
  73  * you may need to define new counter disabled bit field descriptors as there
  74  * are more possible fields in the superblock that can fit in a bitfield on a
  75  * 32 bit platform. The XFS_SBS_* values for the current current counters just
  76  * fit.
  77  */
  78 typedef struct xfs_icsb_cnts {
  79         uint64_t        icsb_fdblocks;
  80         uint64_t        icsb_ifree;
  81         uint64_t        icsb_icount;
  82         unsigned long   icsb_flags;
  83 } xfs_icsb_cnts_t;
  84
  85 #define XFS_ICSB_FLAG_LOCK      (1 << 0)        /* counter lock bit */
  86
  87 #define XFS_ICSB_LAZY_COUNT     (1 << 1)        /* accuracy not needed */
  88
  89 extern int      xfs_icsb_init_counters(struct xfs_mount *);
  90 extern void     xfs_icsb_reinit_counters(struct xfs_mount *);
  91 extern void     xfs_icsb_destroy_counters(struct xfs_mount *);
  92 extern void     xfs_icsb_sync_counters(struct xfs_mount *, int);
  93 extern void     xfs_icsb_sync_counters_locked(struct xfs_mount *, int);
  94
  95 #else
  96 #define xfs_icsb_init_counters(mp)              (0)
  97 #define xfs_icsb_destroy_counters(mp)           do { } while (0)
  98 #define xfs_icsb_reinit_counters(mp)            do { } while (0)
  99 #define xfs_icsb_sync_counters(mp, flags)       do { } while (0)
 100 #define xfs_icsb_sync_counters_locked(mp, flags) do { } while (0)
 101 #endif
 102
 103 typedef struct xfs_mount {
 104         struct super_block      *m_super;
 105         xfs_tid_t               m_tid;          /* next unused tid for fs */
 106         struct xfs_ail          *m_ail;         /* fs active log item list */
 107         xfs_sb_t                m_sb;           /* copy of fs superblock */
 108         spinlock_t              m_sb_lock;      /* sb counter lock */
 109         struct xfs_buf          *m_sb_bp;       /* buffer for superblock */
 110         char                    *m_fsname;      /* filesystem name */
 111         int                     m_fsname_len;   /* strlen of fs name */
 112         char                    *m_rtname;      /* realtime device name */
 113         char                    *m_logname;     /* external log device name */
 114         int                     m_bsize;        /* fs logical block size */
 115         xfs_agnumber_t          m_agfrotor;     /* last ag where space found */
 116         xfs_agnumber_t          m_agirotor;     /* last ag dir inode alloced */
 117         spinlock_t              m_agirotor_lock;/* .. and lock protecting it */
 118         xfs_agnumber_t          m_maxagi;       /* highest inode alloc group */
 119         uint                    m_readio_log;   /* min read size log bytes */
 120         uint                    m_readio_blocks; /* min read size blocks */
 121         uint                    m_writeio_log;  /* min write size log bytes */
 122         uint                    m_writeio_blocks; /* min write size blocks */
 123         struct log              *m_log;         /* log specific stuff */
 124         int                     m_logbufs;      /* number of log buffers */
 125         int                     m_logbsize;     /* size of each log buffer */
 126         uint                    m_rsumlevels;   /* rt summary levels */
 127         uint                    m_rsumsize;     /* size of rt summary, bytes */
 128         struct xfs_inode        *m_rbmip;       /* pointer to bitmap inode */
 129         struct xfs_inode        *m_rsumip;      /* pointer to summary inode */
 130         struct xfs_inode        *m_rootip;      /* pointer to root directory */
 131         struct xfs_quotainfo    *m_quotainfo;   /* disk quota information */
 132         xfs_buftarg_t           *m_ddev_targp;  /* saves taking the address */
 133         xfs_buftarg_t           *m_logdev_targp;/* ptr to log device */
 134         xfs_buftarg_t           *m_rtdev_targp; /* ptr to rt device */
 135         __uint8_t               m_blkbit_log;   /* blocklog + NBBY */
 136         __uint8_t               m_blkbb_log;    /* blocklog - BBSHIFT */
 137         __uint8_t               m_agno_log;     /* log #ag's */
 138         __uint8_t               m_agino_log;    /* #bits for agino in inum */
 139         __uint16_t              m_inode_cluster_size;/* min inode buf size */
 140         uint                    m_blockmask;    /* sb_blocksize-1 */
 141         uint                    m_blockwsize;   /* sb_blocksize in words */
 142         uint                    m_blockwmask;   /* blockwsize-1 */
 143         uint                    m_alloc_mxr[2]; /* max alloc btree records */
 144         uint                    m_alloc_mnr[2]; /* min alloc btree records */
 145         uint                    m_bmap_dmxr[2]; /* max bmap btree records */
 146         uint                    m_bmap_dmnr[2]; /* min bmap btree records */
 147         uint                    m_inobt_mxr[2]; /* max inobt btree records */
 148         uint                    m_inobt_mnr[2]; /* min inobt btree records */
 149         uint                    m_ag_maxlevels; /* XFS_AG_MAXLEVELS */
 150         uint                    m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
 151         uint                    m_in_maxlevels; /* max inobt btree levels. */
 152         struct radix_tree_root  m_perag_tree;   /* per-ag accounting info */
 153         spinlock_t              m_perag_lock;   /* lock for m_perag_tree */
 154         struct mutex            m_growlock;     /* growfs mutex */
 155         int                     m_fixedfsid[2]; /* unchanged for life of FS */
 156         uint                    m_dmevmask;     /* DMI events for this FS */
 157         __uint64_t              m_flags;        /* global mount flags */
 158         uint                    m_dir_node_ents; /* #entries in a dir danode */
 159         uint                    m_attr_node_ents; /* #entries in attr danode */
 160         int                     m_ialloc_inos;  /* inodes in inode allocation */
 161         int                     m_ialloc_blks;  /* blocks in inode allocation */
 162         int                     m_inoalign_mask;/* mask sb_inoalignmt if used */
 163         uint                    m_qflags;       /* quota status flags */
 164         xfs_trans_reservations_t m_reservations;/* precomputed res values */
 165         __uint64_t              m_maxicount;    /* maximum inode count */
 166         __uint64_t              m_maxioffset;   /* maximum inode offset */
 167         __uint64_t              m_resblks;      /* total reserved blocks */
 168         __uint64_t              m_resblks_avail;/* available reserved blocks */
 169         __uint64_t              m_resblks_save; /* reserved blks @ remount,ro */
 170         int                     m_dalign;       /* stripe unit */
 171         int                     m_swidth;       /* stripe width */
 172         int                     m_sinoalign;    /* stripe unit inode alignment */
 173         int                     m_attr_magicpct;/* 37% of the blocksize */
 174         int                     m_dir_magicpct; /* 37% of the dir blocksize */
 175         __uint8_t               m_sectbb_log;   /* sectlog - BBSHIFT */
 176         const struct xfs_nameops *m_dirnameops; /* vector of dir name ops */
 177         int                     m_dirblksize;   /* directory block sz--bytes */
 178         int                     m_dirblkfsbs;   /* directory block sz--fsbs */
 179         xfs_dablk_t             m_dirdatablk;   /* blockno of dir data v2 */
 180         xfs_dablk_t             m_dirleafblk;   /* blockno of dir non-data v2 */
 181         xfs_dablk_t             m_dirfreeblk;   /* blockno of dirfreeindex v2 */
 182         uint                    m_chsize;       /* size of next field */
 183         struct xfs_chash        *m_chash;       /* fs private inode per-cluster
 184                                                  * hash table */
 185         atomic_t                m_active_trans; /* number trans frozen */
 186 #ifdef HAVE_PERCPU_SB
 187         xfs_icsb_cnts_t __percpu *m_sb_cnts;    /* per-cpu superblock counters */
 188         unsigned long           m_icsb_counters; /* disabled per-cpu counters */
 189         struct notifier_block   m_icsb_notifier; /* hotplug cpu notifier */
 190         struct mutex            m_icsb_mutex;   /* balancer sync lock */
 191 #endif
 192         struct xfs_mru_cache    *m_filestream;  /* per-mount filestream data */
 193         struct task_struct      *m_sync_task;   /* generalised sync thread */
 194         xfs_sync_work_t         m_sync_work;    /* work item for VFS_SYNC */
 195         struct list_head        m_sync_list;    /* sync thread work item list */
 196         spinlock_t              m_sync_lock;    /* work item list lock */
 197         int                     m_sync_seq;     /* sync thread generation no. */
 198         wait_queue_head_t       m_wait_single_sync_task;
 199         __int64_t               m_update_flags; /* sb flags we need to update
 200                                                    on the next remount,rw */
 201         struct shrinker         m_inode_shrink; /* inode reclaim shrinker */
 202 } xfs_mount_t;
 203
 204 /*
 205  * Flags for m_flags.
 206  */
 207 #define XFS_MOUNT_WSYNC         (1ULL << 0)     /* for nfs - all metadata ops
 208                                                    must be synchronous except
 209                                                    for space allocations */
 210 #define XFS_MOUNT_DELAYLOG      (1ULL << 1)     /* delayed logging is enabled */
 211 #define XFS_MOUNT_WAS_CLEAN     (1ULL << 3)
 212 #define XFS_MOUNT_FS_SHUTDOWN   (1ULL << 4)     /* atomic stop of all filesystem
 213                                                    operations, typically for
 214                                                    disk errors in metadata */
 215 #define XFS_MOUNT_RETERR        (1ULL << 6)     /* return alignment errors to
 216                                                    user */
 217 #define XFS_MOUNT_NOALIGN       (1ULL << 7)     /* turn off stripe alignment
 218                                                    allocations */
 219 #define XFS_MOUNT_ATTR2         (1ULL << 8)     /* allow use of attr2 format */
 220 #define XFS_MOUNT_GRPID         (1ULL << 9)     /* group-ID assigned from directory */
 221 #define XFS_MOUNT_NORECOVERY    (1ULL << 10)    /* no recovery - dirty fs */
 222 #define XFS_MOUNT_DFLT_IOSIZE   (1ULL << 12)    /* set default i/o size */
 223 #define XFS_MOUNT_32BITINODES   (1ULL << 14)    /* do not create inodes above
 224                                                  * 32 bits in size */
 225 #define XFS_MOUNT_SMALL_INUMS   (1ULL << 15)    /* users wants 32bit inodes */
 226 #define XFS_MOUNT_NOUUID        (1ULL << 16)    /* ignore uuid during mount */
 227 #define XFS_MOUNT_BARRIER       (1ULL << 17)
 228 #define XFS_MOUNT_IKEEP         (1ULL << 18)    /* keep empty inode clusters*/
 229 #define XFS_MOUNT_SWALLOC       (1ULL << 19)    /* turn on stripe width
 230                                                  * allocation */
 231 #define XFS_MOUNT_RDONLY        (1ULL << 20)    /* read-only fs */
 232 #define XFS_MOUNT_DIRSYNC       (1ULL << 21)    /* synchronous directory ops */
 233 #define XFS_MOUNT_COMPAT_IOSIZE (1ULL << 22)    /* don't report large preferred
 234                                                  * I/O size in stat() */
 235 #define XFS_MOUNT_NO_PERCPU_SB  (1ULL << 23)    /* don't use per-cpu superblock
 236                                                    counters */
 237 #define XFS_MOUNT_FILESTREAMS   (1ULL << 24)    /* enable the filestreams
 238                                                    allocator */
 239 #define XFS_MOUNT_NOATTR2       (1ULL << 25)    /* disable use of attr2 format */
 240
 241
 242 /*
 243  * Default minimum read and write sizes.
 244  */
 245 #define XFS_READIO_LOG_LARGE    16
 246 #define XFS_WRITEIO_LOG_LARGE   16
 247
 248 /*
 249  * Max and min values for mount-option defined I/O
 250  * preallocation sizes.
 251  */
 252 #define XFS_MAX_IO_LOG          30      /* 1G */
 253 #define XFS_MIN_IO_LOG          PAGE_SHIFT
 254
 255 /*
 256  * Synchronous read and write sizes.  This should be
 257  * better for NFSv2 wsync filesystems.
 258  */
 259 #define XFS_WSYNC_READIO_LOG    15      /* 32k */
 260 #define XFS_WSYNC_WRITEIO_LOG   14      /* 16k */
 261
 262 /*
 263  * Allow large block sizes to be reported to userspace programs if the
 264  * "largeio" mount option is used.
 265  *
 266  * If compatibility mode is specified, simply return the basic unit of caching
 267  * so that we don't get inefficient read/modify/write I/O from user apps.
 268  * Otherwise....
 269  *
 270  * If the underlying volume is a stripe, then return the stripe width in bytes
 271  * as the recommended I/O size. It is not a stripe and we've set a default
 272  * buffered I/O size, return that, otherwise return the compat default.
 273  */
 274 static inline unsigned long
 275 xfs_preferred_iosize(xfs_mount_t *mp)
 276 {
 277         if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
 278                 return PAGE_CACHE_SIZE;
 279         return (mp->m_swidth ?
 280                 (mp->m_swidth << mp->m_sb.sb_blocklog) :
 281                 ((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
 282                         (1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
 283                         PAGE_CACHE_SIZE));
 284 }
 285
 286 #define XFS_MAXIOFFSET(mp)      ((mp)->m_maxioffset)
 287
 288 #define XFS_LAST_UNMOUNT_WAS_CLEAN(mp)  \
 289                                 ((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
 290 #define XFS_FORCED_SHUTDOWN(mp) ((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
 291 void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
 292                 int lnnum);
 293 #define xfs_force_shutdown(m,f) \
 294         xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
 295
 296 #define SHUTDOWN_META_IO_ERROR  0x0001  /* write attempt to metadata failed */
 297 #define SHUTDOWN_LOG_IO_ERROR   0x0002  /* write attempt to the log failed */
 298 #define SHUTDOWN_FORCE_UMOUNT   0x0004  /* shutdown from a forced unmount */
 299 #define SHUTDOWN_CORRUPT_INCORE 0x0008  /* corrupt in-memory data structures */
 300 #define SHUTDOWN_REMOTE_REQ     0x0010  /* shutdown came from remote cell */
 301 #define SHUTDOWN_DEVICE_REQ     0x0020  /* failed all paths to the device */
 302
 303 #define xfs_test_for_freeze(mp)         ((mp)->m_super->s_frozen)
 304 #define xfs_wait_for_freeze(mp,l)       vfs_check_frozen((mp)->m_super, (l))
 305
 306 /*
 307  * Flags for xfs_mountfs
 308  */
 309 #define XFS_MFSI_QUIET          0x40    /* Be silent if mount errors found */
 310
 311 static inline xfs_agnumber_t
 312 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
 313 {
 314         xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
 315         do_div(ld, mp->m_sb.sb_agblocks);
 316         return (xfs_agnumber_t) ld;
 317 }
 318
 319 static inline xfs_agblock_t
 320 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
 321 {
 322         xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
 323         return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
 324 }
 325
 326 /*
 327  * perag get/put wrappers for ref counting
 328  */
 329 struct xfs_perag *xfs_perag_get(struct xfs_mount *mp, xfs_agnumber_t agno);
 330 void    xfs_perag_put(struct xfs_perag *pag);
 331
 332 /*
 333  * Per-cpu superblock locking functions
 334  */
 335 #ifdef HAVE_PERCPU_SB
 336 static inline void
 337 xfs_icsb_lock(xfs_mount_t *mp)
 338 {
 339         mutex_lock(&mp->m_icsb_mutex);
 340 }
 341
 342 static inline void
 343 xfs_icsb_unlock(xfs_mount_t *mp)
 344 {
 345         mutex_unlock(&mp->m_icsb_mutex);
 346 }
 347 #else
 348 #define xfs_icsb_lock(mp)
 349 #define xfs_icsb_unlock(mp)
 350 #endif
 351
 352 /*
 353  * This structure is for use by the xfs_mod_incore_sb_batch() routine.
 354  * xfs_growfs can specify a few fields which are more than int limit
 355  */
 356 typedef struct xfs_mod_sb {
 357         xfs_sb_field_t  msb_field;      /* Field to modify, see below */
 358         int64_t         msb_delta;      /* Change to make to specified field */
 359 } xfs_mod_sb_t;
 360
 361 extern int      xfs_log_sbcount(xfs_mount_t *, uint);
 362 extern __uint64_t xfs_default_resblks(xfs_mount_t *mp);
 363 extern int      xfs_mountfs(xfs_mount_t *mp);
 364
 365 extern void     xfs_unmountfs(xfs_mount_t *);
 366 extern int      xfs_unmountfs_writesb(xfs_mount_t *);
 367 extern int      xfs_mod_incore_sb(xfs_mount_t *, xfs_sb_field_t, int64_t, int);
 368 extern int      xfs_mod_incore_sb_batch(xfs_mount_t *, xfs_mod_sb_t *,
 369                         uint, int);
 370 extern int      xfs_mount_log_sb(xfs_mount_t *, __int64_t);
 371 extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
 372 extern int      xfs_readsb(xfs_mount_t *, int);
 373 extern void     xfs_freesb(xfs_mount_t *);
 374 extern int      xfs_fs_writable(xfs_mount_t *);
 375 extern int      xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
 376
 377 extern int      xfs_dev_is_read_only(struct xfs_mount *, char *);
 378
 379 #endif  /* __KERNEL__ */
 380
 381 extern void     xfs_mod_sb(struct xfs_trans *, __int64_t);
 382 extern int      xfs_initialize_perag(struct xfs_mount *, xfs_agnumber_t,
 383                                         xfs_agnumber_t *);
 384 extern void     xfs_sb_from_disk(struct xfs_sb *, struct xfs_dsb *);
 385 extern void     xfs_sb_to_disk(struct xfs_dsb *, struct xfs_sb *, __int64_t);
 386
 387 #endif  /* __XFS_MOUNT_H__ */