2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
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.
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.
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
18 #ifndef __XFS_MOUNT_H__
19 #define __XFS_MOUNT_H__
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;
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))
52 #else /* __KERNEL__ */
58 struct xfs_mount_args;
71 * Prototypes and functions for the Data Migration subsystem.
74 typedef int (*xfs_send_data_t)(int, struct xfs_inode *,
75 xfs_off_t, size_t, int, int *);
76 typedef int (*xfs_send_mmap_t)(struct vm_area_struct *, uint);
77 typedef int (*xfs_send_destroy_t)(struct xfs_inode *, dm_right_t);
78 typedef int (*xfs_send_namesp_t)(dm_eventtype_t, struct xfs_mount *,
79 struct xfs_inode *, dm_right_t,
80 struct xfs_inode *, dm_right_t,
81 const char *, const char *, mode_t, int, int);
82 typedef int (*xfs_send_mount_t)(struct xfs_mount *, dm_right_t,
84 typedef void (*xfs_send_unmount_t)(struct xfs_mount *, struct xfs_inode *,
85 dm_right_t, mode_t, int, int);
87 typedef struct xfs_dmops {
88 xfs_send_data_t xfs_send_data;
89 xfs_send_mmap_t xfs_send_mmap;
90 xfs_send_destroy_t xfs_send_destroy;
91 xfs_send_namesp_t xfs_send_namesp;
92 xfs_send_mount_t xfs_send_mount;
93 xfs_send_unmount_t xfs_send_unmount;
96 #define XFS_SEND_DATA(mp, ev,ip,off,len,fl,lock) \
97 (*(mp)->m_dm_ops->xfs_send_data)(ev,ip,off,len,fl,lock)
98 #define XFS_SEND_MMAP(mp, vma,fl) \
99 (*(mp)->m_dm_ops->xfs_send_mmap)(vma,fl)
100 #define XFS_SEND_DESTROY(mp, ip,right) \
101 (*(mp)->m_dm_ops->xfs_send_destroy)(ip,right)
102 #define XFS_SEND_NAMESP(mp, ev,b1,r1,b2,r2,n1,n2,mode,rval,fl) \
103 (*(mp)->m_dm_ops->xfs_send_namesp)(ev,NULL,b1,r1,b2,r2,n1,n2,mode,rval,fl)
104 #define XFS_SEND_PREUNMOUNT(mp,b1,r1,b2,r2,n1,n2,mode,rval,fl) \
105 (*(mp)->m_dm_ops->xfs_send_namesp)(DM_EVENT_PREUNMOUNT,mp,b1,r1,b2,r2,n1,n2,mode,rval,fl)
106 #define XFS_SEND_MOUNT(mp,right,path,name) \
107 (*(mp)->m_dm_ops->xfs_send_mount)(mp,right,path,name)
108 #define XFS_SEND_UNMOUNT(mp, ip,right,mode,rval,fl) \
109 (*(mp)->m_dm_ops->xfs_send_unmount)(mp,ip,right,mode,rval,fl)
112 #ifdef HAVE_PERCPU_SB
115 * Valid per-cpu incore superblock counters. Note that if you add new counters,
116 * you may need to define new counter disabled bit field descriptors as there
117 * are more possible fields in the superblock that can fit in a bitfield on a
118 * 32 bit platform. The XFS_SBS_* values for the current current counters just
121 typedef struct xfs_icsb_cnts {
122 uint64_t icsb_fdblocks;
124 uint64_t icsb_icount;
125 unsigned long icsb_flags;
128 #define XFS_ICSB_FLAG_LOCK (1 << 0) /* counter lock bit */
130 #define XFS_ICSB_LAZY_COUNT (1 << 1) /* accuracy not needed */
132 extern int xfs_icsb_init_counters(struct xfs_mount *);
133 extern void xfs_icsb_reinit_counters(struct xfs_mount *);
134 extern void xfs_icsb_destroy_counters(struct xfs_mount *);
135 extern void xfs_icsb_sync_counters(struct xfs_mount *, int);
136 extern void xfs_icsb_sync_counters_locked(struct xfs_mount *, int);
139 #define xfs_icsb_init_counters(mp) (0)
140 #define xfs_icsb_destroy_counters(mp) do { } while (0)
141 #define xfs_icsb_reinit_counters(mp) do { } while (0)
142 #define xfs_icsb_sync_counters(mp, flags) do { } while (0)
143 #define xfs_icsb_sync_counters_locked(mp, flags) do { } while (0)
146 typedef struct xfs_mount {
147 struct super_block *m_super;
148 xfs_tid_t m_tid; /* next unused tid for fs */
149 struct xfs_ail *m_ail; /* fs active log item list */
150 xfs_sb_t m_sb; /* copy of fs superblock */
151 spinlock_t m_sb_lock; /* sb counter lock */
152 struct xfs_buf *m_sb_bp; /* buffer for superblock */
153 char *m_fsname; /* filesystem name */
154 int m_fsname_len; /* strlen of fs name */
155 char *m_rtname; /* realtime device name */
156 char *m_logname; /* external log device name */
157 int m_bsize; /* fs logical block size */
158 xfs_agnumber_t m_agfrotor; /* last ag where space found */
159 xfs_agnumber_t m_agirotor; /* last ag dir inode alloced */
160 spinlock_t m_agirotor_lock;/* .. and lock protecting it */
161 xfs_agnumber_t m_maxagi; /* highest inode alloc group */
162 uint m_readio_log; /* min read size log bytes */
163 uint m_readio_blocks; /* min read size blocks */
164 uint m_writeio_log; /* min write size log bytes */
165 uint m_writeio_blocks; /* min write size blocks */
166 struct log *m_log; /* log specific stuff */
167 int m_logbufs; /* number of log buffers */
168 int m_logbsize; /* size of each log buffer */
169 uint m_rsumlevels; /* rt summary levels */
170 uint m_rsumsize; /* size of rt summary, bytes */
171 struct xfs_inode *m_rbmip; /* pointer to bitmap inode */
172 struct xfs_inode *m_rsumip; /* pointer to summary inode */
173 struct xfs_inode *m_rootip; /* pointer to root directory */
174 struct xfs_quotainfo *m_quotainfo; /* disk quota information */
175 xfs_buftarg_t *m_ddev_targp; /* saves taking the address */
176 xfs_buftarg_t *m_logdev_targp;/* ptr to log device */
177 xfs_buftarg_t *m_rtdev_targp; /* ptr to rt device */
178 __uint8_t m_blkbit_log; /* blocklog + NBBY */
179 __uint8_t m_blkbb_log; /* blocklog - BBSHIFT */
180 __uint8_t m_agno_log; /* log #ag's */
181 __uint8_t m_agino_log; /* #bits for agino in inum */
182 __uint16_t m_inode_cluster_size;/* min inode buf size */
183 uint m_blockmask; /* sb_blocksize-1 */
184 uint m_blockwsize; /* sb_blocksize in words */
185 uint m_blockwmask; /* blockwsize-1 */
186 uint m_alloc_mxr[2]; /* max alloc btree records */
187 uint m_alloc_mnr[2]; /* min alloc btree records */
188 uint m_bmap_dmxr[2]; /* max bmap btree records */
189 uint m_bmap_dmnr[2]; /* min bmap btree records */
190 uint m_inobt_mxr[2]; /* max inobt btree records */
191 uint m_inobt_mnr[2]; /* min inobt btree records */
192 uint m_ag_maxlevels; /* XFS_AG_MAXLEVELS */
193 uint m_bm_maxlevels[2]; /* XFS_BM_MAXLEVELS */
194 uint m_in_maxlevels; /* max inobt btree levels. */
195 struct xfs_perag *m_perag; /* per-ag accounting info */
196 struct rw_semaphore m_peraglock; /* lock for m_perag (pointer) */
197 struct mutex m_growlock; /* growfs mutex */
198 int m_fixedfsid[2]; /* unchanged for life of FS */
199 uint m_dmevmask; /* DMI events for this FS */
200 __uint64_t m_flags; /* global mount flags */
201 uint m_dir_node_ents; /* #entries in a dir danode */
202 uint m_attr_node_ents; /* #entries in attr danode */
203 int m_ialloc_inos; /* inodes in inode allocation */
204 int m_ialloc_blks; /* blocks in inode allocation */
205 int m_inoalign_mask;/* mask sb_inoalignmt if used */
206 uint m_qflags; /* quota status flags */
207 xfs_trans_reservations_t m_reservations;/* precomputed res values */
208 __uint64_t m_maxicount; /* maximum inode count */
209 __uint64_t m_maxioffset; /* maximum inode offset */
210 __uint64_t m_resblks; /* total reserved blocks */
211 __uint64_t m_resblks_avail;/* available reserved blocks */
212 int m_dalign; /* stripe unit */
213 int m_swidth; /* stripe width */
214 int m_sinoalign; /* stripe unit inode alignment */
215 int m_attr_magicpct;/* 37% of the blocksize */
216 int m_dir_magicpct; /* 37% of the dir blocksize */
217 __uint8_t m_sectbb_log; /* sectlog - BBSHIFT */
218 const struct xfs_nameops *m_dirnameops; /* vector of dir name ops */
219 int m_dirblksize; /* directory block sz--bytes */
220 int m_dirblkfsbs; /* directory block sz--fsbs */
221 xfs_dablk_t m_dirdatablk; /* blockno of dir data v2 */
222 xfs_dablk_t m_dirleafblk; /* blockno of dir non-data v2 */
223 xfs_dablk_t m_dirfreeblk; /* blockno of dirfreeindex v2 */
224 uint m_chsize; /* size of next field */
225 struct xfs_chash *m_chash; /* fs private inode per-cluster
227 struct xfs_dmops *m_dm_ops; /* vector of DMI ops */
228 struct xfs_qmops *m_qm_ops; /* vector of XQM ops */
229 atomic_t m_active_trans; /* number trans frozen */
230 #ifdef HAVE_PERCPU_SB
231 xfs_icsb_cnts_t *m_sb_cnts; /* per-cpu superblock counters */
232 unsigned long m_icsb_counters; /* disabled per-cpu counters */
233 struct notifier_block m_icsb_notifier; /* hotplug cpu notifier */
234 struct mutex m_icsb_mutex; /* balancer sync lock */
236 struct xfs_mru_cache *m_filestream; /* per-mount filestream data */
237 struct task_struct *m_sync_task; /* generalised sync thread */
238 xfs_sync_work_t m_sync_work; /* work item for VFS_SYNC */
239 struct list_head m_sync_list; /* sync thread work item list */
240 spinlock_t m_sync_lock; /* work item list lock */
241 int m_sync_seq; /* sync thread generation no. */
242 wait_queue_head_t m_wait_single_sync_task;
243 __int64_t m_update_flags; /* sb flags we need to update
244 on the next remount,rw */
250 #define XFS_MOUNT_WSYNC (1ULL << 0) /* for nfs - all metadata ops
251 must be synchronous except
252 for space allocations */
253 #define XFS_MOUNT_DMAPI (1ULL << 2) /* dmapi is enabled */
254 #define XFS_MOUNT_WAS_CLEAN (1ULL << 3)
255 #define XFS_MOUNT_FS_SHUTDOWN (1ULL << 4) /* atomic stop of all filesystem
256 operations, typically for
257 disk errors in metadata */
258 #define XFS_MOUNT_RETERR (1ULL << 6) /* return alignment errors to
260 #define XFS_MOUNT_NOALIGN (1ULL << 7) /* turn off stripe alignment
262 #define XFS_MOUNT_ATTR2 (1ULL << 8) /* allow use of attr2 format */
263 #define XFS_MOUNT_GRPID (1ULL << 9) /* group-ID assigned from directory */
264 #define XFS_MOUNT_NORECOVERY (1ULL << 10) /* no recovery - dirty fs */
265 #define XFS_MOUNT_DFLT_IOSIZE (1ULL << 12) /* set default i/o size */
266 #define XFS_MOUNT_OSYNCISOSYNC (1ULL << 13) /* o_sync is REALLY o_sync */
267 /* osyncisdsync is now default*/
268 #define XFS_MOUNT_32BITINODES (1ULL << 14) /* do not create inodes above
270 #define XFS_MOUNT_SMALL_INUMS (1ULL << 15) /* users wants 32bit inodes */
271 #define XFS_MOUNT_NOUUID (1ULL << 16) /* ignore uuid during mount */
272 #define XFS_MOUNT_BARRIER (1ULL << 17)
273 #define XFS_MOUNT_IKEEP (1ULL << 18) /* keep empty inode clusters*/
274 #define XFS_MOUNT_SWALLOC (1ULL << 19) /* turn on stripe width
276 #define XFS_MOUNT_RDONLY (1ULL << 20) /* read-only fs */
277 #define XFS_MOUNT_DIRSYNC (1ULL << 21) /* synchronous directory ops */
278 #define XFS_MOUNT_COMPAT_IOSIZE (1ULL << 22) /* don't report large preferred
279 * I/O size in stat() */
280 #define XFS_MOUNT_NO_PERCPU_SB (1ULL << 23) /* don't use per-cpu superblock
282 #define XFS_MOUNT_FILESTREAMS (1ULL << 24) /* enable the filestreams
284 #define XFS_MOUNT_NOATTR2 (1ULL << 25) /* disable use of attr2 format */
288 * Default minimum read and write sizes.
290 #define XFS_READIO_LOG_LARGE 16
291 #define XFS_WRITEIO_LOG_LARGE 16
294 * Max and min values for mount-option defined I/O
295 * preallocation sizes.
297 #define XFS_MAX_IO_LOG 30 /* 1G */
298 #define XFS_MIN_IO_LOG PAGE_SHIFT
301 * Synchronous read and write sizes. This should be
302 * better for NFSv2 wsync filesystems.
304 #define XFS_WSYNC_READIO_LOG 15 /* 32k */
305 #define XFS_WSYNC_WRITEIO_LOG 14 /* 16k */
308 * Allow large block sizes to be reported to userspace programs if the
309 * "largeio" mount option is used.
311 * If compatibility mode is specified, simply return the basic unit of caching
312 * so that we don't get inefficient read/modify/write I/O from user apps.
315 * If the underlying volume is a stripe, then return the stripe width in bytes
316 * as the recommended I/O size. It is not a stripe and we've set a default
317 * buffered I/O size, return that, otherwise return the compat default.
319 static inline unsigned long
320 xfs_preferred_iosize(xfs_mount_t *mp)
322 if (mp->m_flags & XFS_MOUNT_COMPAT_IOSIZE)
323 return PAGE_CACHE_SIZE;
324 return (mp->m_swidth ?
325 (mp->m_swidth << mp->m_sb.sb_blocklog) :
326 ((mp->m_flags & XFS_MOUNT_DFLT_IOSIZE) ?
327 (1 << (int)MAX(mp->m_readio_log, mp->m_writeio_log)) :
331 #define XFS_MAXIOFFSET(mp) ((mp)->m_maxioffset)
333 #define XFS_LAST_UNMOUNT_WAS_CLEAN(mp) \
334 ((mp)->m_flags & XFS_MOUNT_WAS_CLEAN)
335 #define XFS_FORCED_SHUTDOWN(mp) ((mp)->m_flags & XFS_MOUNT_FS_SHUTDOWN)
336 void xfs_do_force_shutdown(struct xfs_mount *mp, int flags, char *fname,
338 #define xfs_force_shutdown(m,f) \
339 xfs_do_force_shutdown(m, f, __FILE__, __LINE__)
341 #define SHUTDOWN_META_IO_ERROR 0x0001 /* write attempt to metadata failed */
342 #define SHUTDOWN_LOG_IO_ERROR 0x0002 /* write attempt to the log failed */
343 #define SHUTDOWN_FORCE_UMOUNT 0x0004 /* shutdown from a forced unmount */
344 #define SHUTDOWN_CORRUPT_INCORE 0x0008 /* corrupt in-memory data structures */
345 #define SHUTDOWN_REMOTE_REQ 0x0010 /* shutdown came from remote cell */
346 #define SHUTDOWN_DEVICE_REQ 0x0020 /* failed all paths to the device */
348 #define xfs_test_for_freeze(mp) ((mp)->m_super->s_frozen)
349 #define xfs_wait_for_freeze(mp,l) vfs_check_frozen((mp)->m_super, (l))
352 * Flags for xfs_mountfs
354 #define XFS_MFSI_QUIET 0x40 /* Be silent if mount errors found */
356 static inline xfs_agnumber_t
357 xfs_daddr_to_agno(struct xfs_mount *mp, xfs_daddr_t d)
359 xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
360 do_div(ld, mp->m_sb.sb_agblocks);
361 return (xfs_agnumber_t) ld;
364 static inline xfs_agblock_t
365 xfs_daddr_to_agbno(struct xfs_mount *mp, xfs_daddr_t d)
367 xfs_daddr_t ld = XFS_BB_TO_FSBT(mp, d);
368 return (xfs_agblock_t) do_div(ld, mp->m_sb.sb_agblocks);
372 * perag get/put wrappers for eventual ref counting
374 static inline xfs_perag_t *
375 xfs_get_perag(struct xfs_mount *mp, xfs_ino_t ino)
377 return &mp->m_perag[XFS_INO_TO_AGNO(mp, ino)];
381 xfs_put_perag(struct xfs_mount *mp, xfs_perag_t *pag)
383 /* nothing to see here, move along */
387 * Per-cpu superblock locking functions
389 #ifdef HAVE_PERCPU_SB
391 xfs_icsb_lock(xfs_mount_t *mp)
393 mutex_lock(&mp->m_icsb_mutex);
397 xfs_icsb_unlock(xfs_mount_t *mp)
399 mutex_unlock(&mp->m_icsb_mutex);
402 #define xfs_icsb_lock(mp)
403 #define xfs_icsb_unlock(mp)
407 * This structure is for use by the xfs_mod_incore_sb_batch() routine.
408 * xfs_growfs can specify a few fields which are more than int limit
410 typedef struct xfs_mod_sb {
411 xfs_sb_field_t msb_field; /* Field to modify, see below */
412 int64_t msb_delta; /* Change to make to specified field */
415 extern int xfs_log_sbcount(xfs_mount_t *, uint);
416 extern int xfs_mountfs(xfs_mount_t *mp);
417 extern void xfs_mountfs_check_barriers(xfs_mount_t *mp);
419 extern void xfs_unmountfs(xfs_mount_t *);
420 extern int xfs_unmountfs_writesb(xfs_mount_t *);
421 extern int xfs_mod_incore_sb(xfs_mount_t *, xfs_sb_field_t, int64_t, int);
422 extern int xfs_mod_incore_sb_unlocked(xfs_mount_t *, xfs_sb_field_t,
424 extern int xfs_mod_incore_sb_batch(xfs_mount_t *, xfs_mod_sb_t *,
426 extern int xfs_mount_log_sb(xfs_mount_t *, __int64_t);
427 extern struct xfs_buf *xfs_getsb(xfs_mount_t *, int);
428 extern int xfs_readsb(xfs_mount_t *, int);
429 extern void xfs_freesb(xfs_mount_t *);
430 extern int xfs_fs_writable(xfs_mount_t *);
431 extern int xfs_sb_validate_fsb_count(struct xfs_sb *, __uint64_t);
433 extern int xfs_dmops_get(struct xfs_mount *);
434 extern void xfs_dmops_put(struct xfs_mount *);
436 extern struct xfs_dmops xfs_dmcore_xfs;
438 #endif /* __KERNEL__ */
440 extern void xfs_mod_sb(struct xfs_trans *, __int64_t);
441 extern xfs_agnumber_t xfs_initialize_perag(struct xfs_mount *, xfs_agnumber_t);
442 extern void xfs_sb_from_disk(struct xfs_sb *, struct xfs_dsb *);
443 extern void xfs_sb_to_disk(struct xfs_dsb *, struct xfs_sb *, __int64_t);
445 #endif /* __XFS_MOUNT_H__ */