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