ocfs2: Add the 'inode64' mount option.
[safe/jmp/linux-2.6] / fs / ocfs2 / ocfs2.h
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * ocfs2.h
5  *
6  * Defines macros and structures used in OCFS2
7  *
8  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public
21  * License along with this program; if not, write to the
22  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23  * Boston, MA 021110-1307, USA.
24  */
25
26 #ifndef OCFS2_H
27 #define OCFS2_H
28
29 #include <linux/spinlock.h>
30 #include <linux/sched.h>
31 #include <linux/wait.h>
32 #include <linux/list.h>
33 #include <linux/rbtree.h>
34 #include <linux/workqueue.h>
35 #include <linux/kref.h>
36 #include <linux/mutex.h>
37 #include <linux/jbd.h>
38
39 /* For union ocfs2_dlm_lksb */
40 #include "stackglue.h"
41
42 #include "ocfs2_fs.h"
43 #include "ocfs2_lockid.h"
44
45 /* Most user visible OCFS2 inodes will have very few pieces of
46  * metadata, but larger files (including bitmaps, etc) must be taken
47  * into account when designing an access scheme. We allow a small
48  * amount of inlined blocks to be stored on an array and grow the
49  * structure into a rb tree when necessary. */
50 #define OCFS2_INODE_MAX_CACHE_ARRAY 2
51
52 struct ocfs2_caching_info {
53         unsigned int            ci_num_cached;
54         union {
55                 sector_t        ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
56                 struct rb_root  ci_tree;
57         } ci_cache;
58 };
59
60 /* this limits us to 256 nodes
61  * if we need more, we can do a kmalloc for the map */
62 #define OCFS2_NODE_MAP_MAX_NODES    256
63 struct ocfs2_node_map {
64         u16 num_nodes;
65         unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
66 };
67
68 enum ocfs2_ast_action {
69         OCFS2_AST_INVALID = 0,
70         OCFS2_AST_ATTACH,
71         OCFS2_AST_CONVERT,
72         OCFS2_AST_DOWNCONVERT,
73 };
74
75 /* actions for an unlockast function to take. */
76 enum ocfs2_unlock_action {
77         OCFS2_UNLOCK_INVALID = 0,
78         OCFS2_UNLOCK_CANCEL_CONVERT,
79         OCFS2_UNLOCK_DROP_LOCK,
80 };
81
82 /* ocfs2_lock_res->l_flags flags. */
83 #define OCFS2_LOCK_ATTACHED      (0x00000001) /* have we initialized
84                                                * the lvb */
85 #define OCFS2_LOCK_BUSY          (0x00000002) /* we are currently in
86                                                * dlm_lock */
87 #define OCFS2_LOCK_BLOCKED       (0x00000004) /* blocked waiting to
88                                                * downconvert*/
89 #define OCFS2_LOCK_LOCAL         (0x00000008) /* newly created inode */
90 #define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
91 #define OCFS2_LOCK_REFRESHING    (0x00000020)
92 #define OCFS2_LOCK_INITIALIZED   (0x00000040) /* track initialization
93                                                * for shutdown paths */
94 #define OCFS2_LOCK_FREEING       (0x00000080) /* help dlmglue track
95                                                * when to skip queueing
96                                                * a lock because it's
97                                                * about to be
98                                                * dropped. */
99 #define OCFS2_LOCK_QUEUED        (0x00000100) /* queued for downconvert */
100 #define OCFS2_LOCK_NOCACHE       (0x00000200) /* don't use a holder count */
101 #define OCFS2_LOCK_PENDING       (0x00000400) /* This lockres is pending a
102                                                  call to dlm_lock.  Only
103                                                  exists with BUSY set. */
104
105 struct ocfs2_lock_res_ops;
106
107 typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
108
109 struct ocfs2_lock_res {
110         void                    *l_priv;
111         struct ocfs2_lock_res_ops *l_ops;
112         spinlock_t               l_lock;
113
114         struct list_head         l_blocked_list;
115         struct list_head         l_mask_waiters;
116
117         enum ocfs2_lock_type     l_type;
118         unsigned long            l_flags;
119         char                     l_name[OCFS2_LOCK_ID_MAX_LEN];
120         int                      l_level;
121         unsigned int             l_ro_holders;
122         unsigned int             l_ex_holders;
123         union ocfs2_dlm_lksb     l_lksb;
124
125         /* used from AST/BAST funcs. */
126         enum ocfs2_ast_action    l_action;
127         enum ocfs2_unlock_action l_unlock_action;
128         int                      l_requested;
129         int                      l_blocking;
130         unsigned int             l_pending_gen;
131
132         wait_queue_head_t        l_event;
133
134         struct list_head         l_debug_list;
135
136 #ifdef CONFIG_OCFS2_FS_STATS
137         unsigned long long       l_lock_num_prmode;        /* PR acquires */
138         unsigned long long       l_lock_num_exmode;        /* EX acquires */
139         unsigned int             l_lock_num_prmode_failed; /* Failed PR gets */
140         unsigned int             l_lock_num_exmode_failed; /* Failed EX gets */
141         unsigned long long       l_lock_total_prmode;      /* Tot wait for PR */
142         unsigned long long       l_lock_total_exmode;      /* Tot wait for EX */
143         unsigned int             l_lock_max_prmode;        /* Max wait for PR */
144         unsigned int             l_lock_max_exmode;        /* Max wait for EX */
145         unsigned int             l_lock_refresh;           /* Disk refreshes */
146 #endif
147 };
148
149 struct ocfs2_dlm_debug {
150         struct kref d_refcnt;
151         struct dentry *d_locking_state;
152         struct list_head d_lockres_tracking;
153 };
154
155 enum ocfs2_vol_state
156 {
157         VOLUME_INIT = 0,
158         VOLUME_MOUNTED,
159         VOLUME_DISMOUNTED,
160         VOLUME_DISABLED
161 };
162
163 struct ocfs2_alloc_stats
164 {
165         atomic_t moves;
166         atomic_t local_data;
167         atomic_t bitmap_data;
168         atomic_t bg_allocs;
169         atomic_t bg_extends;
170 };
171
172 enum ocfs2_local_alloc_state
173 {
174         OCFS2_LA_UNUSED = 0,    /* Local alloc will never be used for
175                                  * this mountpoint. */
176         OCFS2_LA_ENABLED,       /* Local alloc is in use. */
177         OCFS2_LA_THROTTLED,     /* Local alloc is in use, but number
178                                  * of bits has been reduced. */
179         OCFS2_LA_DISABLED       /* Local alloc has temporarily been
180                                  * disabled. */
181 };
182
183 enum ocfs2_mount_options
184 {
185         OCFS2_MOUNT_HB_LOCAL   = 1 << 0, /* Heartbeat started in local mode */
186         OCFS2_MOUNT_BARRIER = 1 << 1,   /* Use block barriers */
187         OCFS2_MOUNT_NOINTR  = 1 << 2,   /* Don't catch signals */
188         OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
189         OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
190         OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
191         OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
192         OCFS2_MOUNT_INODE64 = 1 << 7,   /* Allow inode numbers > 2^32 */
193 };
194
195 #define OCFS2_OSB_SOFT_RO       0x0001
196 #define OCFS2_OSB_HARD_RO       0x0002
197 #define OCFS2_OSB_ERROR_FS      0x0004
198 #define OCFS2_DEFAULT_ATIME_QUANTUM     60
199
200 struct ocfs2_journal;
201 struct ocfs2_slot_info;
202 struct ocfs2_recovery_map;
203 struct ocfs2_super
204 {
205         struct task_struct *commit_task;
206         struct super_block *sb;
207         struct inode *root_inode;
208         struct inode *sys_root_inode;
209         struct inode *system_inodes[NUM_SYSTEM_INODES];
210
211         struct ocfs2_slot_info *slot_info;
212
213         u32 *slot_recovery_generations;
214
215         spinlock_t node_map_lock;
216
217         u64 root_blkno;
218         u64 system_dir_blkno;
219         u64 bitmap_blkno;
220         u32 bitmap_cpg;
221         u8 *uuid;
222         char *uuid_str;
223         u32 uuid_hash;
224         u8 *vol_label;
225         u64 first_cluster_group_blkno;
226         u32 fs_generation;
227
228         u32 s_feature_compat;
229         u32 s_feature_incompat;
230         u32 s_feature_ro_compat;
231
232         /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
233          * Could protect more on osb as it's very short lived.
234          */
235         spinlock_t osb_lock;
236         u32 s_next_generation;
237         unsigned long osb_flags;
238         s16 s_inode_steal_slot;
239         atomic_t s_num_inodes_stolen;
240
241         unsigned long s_mount_opt;
242         unsigned int s_atime_quantum;
243
244         unsigned int max_slots;
245         unsigned int node_num;
246         int slot_num;
247         int preferred_slot;
248         int s_sectsize_bits;
249         int s_clustersize;
250         int s_clustersize_bits;
251         unsigned int s_xattr_inline_size;
252
253         atomic_t vol_state;
254         struct mutex recovery_lock;
255         struct ocfs2_recovery_map *recovery_map;
256         struct task_struct *recovery_thread_task;
257         int disable_recovery;
258         wait_queue_head_t checkpoint_event;
259         atomic_t needs_checkpoint;
260         struct ocfs2_journal *journal;
261         unsigned long osb_commit_interval;
262
263         struct delayed_work             la_enable_wq;
264
265         /*
266          * Must hold local alloc i_mutex and osb->osb_lock to change
267          * local_alloc_bits. Reads can be done under either lock.
268          */
269         unsigned int local_alloc_bits;
270         unsigned int local_alloc_default_bits;
271
272         enum ocfs2_local_alloc_state local_alloc_state; /* protected
273                                                          * by osb_lock */
274
275         struct buffer_head *local_alloc_bh;
276
277         u64 la_last_gd;
278
279 #ifdef CONFIG_OCFS2_FS_STATS
280         struct dentry *local_alloc_debug;
281         char *local_alloc_debug_buf;
282 #endif
283
284         /* Next two fields are for local node slot recovery during
285          * mount. */
286         int dirty;
287         struct ocfs2_dinode *local_alloc_copy;
288
289         struct ocfs2_alloc_stats alloc_stats;
290         char dev_str[20];               /* "major,minor" of the device */
291
292         char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
293         struct ocfs2_cluster_connection *cconn;
294         struct ocfs2_lock_res osb_super_lockres;
295         struct ocfs2_lock_res osb_rename_lockres;
296         struct ocfs2_dlm_debug *osb_dlm_debug;
297
298         struct dentry *osb_debug_root;
299
300         wait_queue_head_t recovery_event;
301
302         spinlock_t dc_task_lock;
303         struct task_struct *dc_task;
304         wait_queue_head_t dc_event;
305         unsigned long dc_wake_sequence;
306         unsigned long dc_work_sequence;
307
308         /*
309          * Any thread can add locks to the list, but the downconvert
310          * thread is the only one allowed to remove locks. Any change
311          * to this rule requires updating
312          * ocfs2_downconvert_thread_do_work().
313          */
314         struct list_head blocked_lock_list;
315         unsigned long blocked_lock_count;
316
317         wait_queue_head_t               osb_mount_event;
318
319         /* Truncate log info */
320         struct inode                    *osb_tl_inode;
321         struct buffer_head              *osb_tl_bh;
322         struct delayed_work             osb_truncate_log_wq;
323
324         struct ocfs2_node_map           osb_recovering_orphan_dirs;
325         unsigned int                    *osb_orphan_wipes;
326         wait_queue_head_t               osb_wipe_event;
327 };
328
329 #define OCFS2_SB(sb)        ((struct ocfs2_super *)(sb)->s_fs_info)
330
331 static inline int ocfs2_should_order_data(struct inode *inode)
332 {
333         if (!S_ISREG(inode->i_mode))
334                 return 0;
335         if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
336                 return 0;
337         return 1;
338 }
339
340 static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
341 {
342         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
343                 return 1;
344         return 0;
345 }
346
347 static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
348 {
349         /*
350          * Support for sparse files is a pre-requisite
351          */
352         if (!ocfs2_sparse_alloc(osb))
353                 return 0;
354
355         if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
356                 return 1;
357         return 0;
358 }
359
360 static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
361 {
362         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
363                 return 1;
364         return 0;
365 }
366
367 static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
368 {
369         if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
370                 return 1;
371         return 0;
372 }
373
374 /* set / clear functions because cluster events can make these happen
375  * in parallel so we want the transitions to be atomic. this also
376  * means that any future flags osb_flags must be protected by spinlock
377  * too! */
378 static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
379                                       unsigned long flag)
380 {
381         spin_lock(&osb->osb_lock);
382         osb->osb_flags |= flag;
383         spin_unlock(&osb->osb_lock);
384 }
385
386 static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
387                                      int hard)
388 {
389         spin_lock(&osb->osb_lock);
390         osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
391         if (hard)
392                 osb->osb_flags |= OCFS2_OSB_HARD_RO;
393         else
394                 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
395         spin_unlock(&osb->osb_lock);
396 }
397
398 static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
399 {
400         int ret;
401
402         spin_lock(&osb->osb_lock);
403         ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
404         spin_unlock(&osb->osb_lock);
405
406         return ret;
407 }
408
409 static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
410 {
411         int ret;
412
413         spin_lock(&osb->osb_lock);
414         ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
415         spin_unlock(&osb->osb_lock);
416
417         return ret;
418 }
419
420 static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
421 {
422         return (osb->s_feature_incompat &
423                 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
424 }
425
426 static inline int ocfs2_mount_local(struct ocfs2_super *osb)
427 {
428         return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
429 }
430
431 static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
432 {
433         return (osb->s_feature_incompat &
434                 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
435 }
436
437
438 #define OCFS2_IS_VALID_DINODE(ptr)                                      \
439         (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
440
441 #define OCFS2_RO_ON_INVALID_DINODE(__sb, __di)  do {                    \
442         typeof(__di) ____di = (__di);                                   \
443         ocfs2_error((__sb),                                             \
444                 "Dinode # %llu has bad signature %.*s",                 \
445                 (unsigned long long)le64_to_cpu((____di)->i_blkno), 7,  \
446                 (____di)->i_signature);                                 \
447 } while (0)
448
449 #define OCFS2_IS_VALID_EXTENT_BLOCK(ptr)                                \
450         (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
451
452 #define OCFS2_RO_ON_INVALID_EXTENT_BLOCK(__sb, __eb)    do {            \
453         typeof(__eb) ____eb = (__eb);                                   \
454         ocfs2_error((__sb),                                             \
455                 "Extent Block # %llu has bad signature %.*s",           \
456                 (unsigned long long)le64_to_cpu((____eb)->h_blkno), 7,  \
457                 (____eb)->h_signature);                                 \
458 } while (0)
459
460 #define OCFS2_IS_VALID_GROUP_DESC(ptr)                                  \
461         (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
462
463 #define OCFS2_RO_ON_INVALID_GROUP_DESC(__sb, __gd)      do {            \
464         typeof(__gd) ____gd = (__gd);                                   \
465                 ocfs2_error((__sb),                                     \
466                 "Group Descriptor # %llu has bad signature %.*s",       \
467                 (unsigned long long)le64_to_cpu((____gd)->bg_blkno), 7, \
468                 (____gd)->bg_signature);                                \
469 } while (0)
470
471 static inline unsigned long ino_from_blkno(struct super_block *sb,
472                                            u64 blkno)
473 {
474         return (unsigned long)(blkno & (u64)ULONG_MAX);
475 }
476
477 static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
478                                            u32 clusters)
479 {
480         int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
481                 sb->s_blocksize_bits;
482
483         return (u64)clusters << c_to_b_bits;
484 }
485
486 static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
487                                            u64 blocks)
488 {
489         int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
490                 sb->s_blocksize_bits;
491
492         return (u32)(blocks >> b_to_c_bits);
493 }
494
495 static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
496                                                     u64 bytes)
497 {
498         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
499         unsigned int clusters;
500
501         bytes += OCFS2_SB(sb)->s_clustersize - 1;
502         /* OCFS2 just cannot have enough clusters to overflow this */
503         clusters = (unsigned int)(bytes >> cl_bits);
504
505         return clusters;
506 }
507
508 static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
509                                          u64 bytes)
510 {
511         bytes += sb->s_blocksize - 1;
512         return bytes >> sb->s_blocksize_bits;
513 }
514
515 static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
516                                           u32 clusters)
517 {
518         return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
519 }
520
521 static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
522                                                 u64 bytes)
523 {
524         int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
525         unsigned int clusters;
526
527         clusters = ocfs2_clusters_for_bytes(sb, bytes);
528         return (u64)clusters << cl_bits;
529 }
530
531 static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
532                                               u64 bytes)
533 {
534         u64 blocks;
535
536         blocks = ocfs2_blocks_for_bytes(sb, bytes);
537         return blocks << sb->s_blocksize_bits;
538 }
539
540 static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
541 {
542         return (unsigned long)((bytes + 511) >> 9);
543 }
544
545 static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
546                                                         unsigned long pg_index)
547 {
548         u32 clusters = pg_index;
549         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
550
551         if (unlikely(PAGE_CACHE_SHIFT > cbits))
552                 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
553         else if (PAGE_CACHE_SHIFT < cbits)
554                 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
555
556         return clusters;
557 }
558
559 /*
560  * Find the 1st page index which covers the given clusters.
561  */
562 static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
563                                                         u32 clusters)
564 {
565         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
566         pgoff_t index = clusters;
567
568         if (PAGE_CACHE_SHIFT > cbits) {
569                 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
570         } else if (PAGE_CACHE_SHIFT < cbits) {
571                 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
572         }
573
574         return index;
575 }
576
577 static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
578 {
579         unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
580         unsigned int pages_per_cluster = 1;
581
582         if (PAGE_CACHE_SHIFT < cbits)
583                 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
584
585         return pages_per_cluster;
586 }
587
588 static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
589                                                        unsigned int megs)
590 {
591         BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
592
593         return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
594 }
595
596 static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
597 {
598         spin_lock(&osb->osb_lock);
599         osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
600         spin_unlock(&osb->osb_lock);
601         atomic_set(&osb->s_num_inodes_stolen, 0);
602 }
603
604 static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
605                                               s16 slot)
606 {
607         spin_lock(&osb->osb_lock);
608         osb->s_inode_steal_slot = slot;
609         spin_unlock(&osb->osb_lock);
610 }
611
612 static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
613 {
614         s16 slot;
615
616         spin_lock(&osb->osb_lock);
617         slot = osb->s_inode_steal_slot;
618         spin_unlock(&osb->osb_lock);
619
620         return slot;
621 }
622
623 #define ocfs2_set_bit ext2_set_bit
624 #define ocfs2_clear_bit ext2_clear_bit
625 #define ocfs2_test_bit ext2_test_bit
626 #define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
627 #endif  /* OCFS2_H */
628