blob: 22e334d125d0fad419bdd6eb21d1828f5102ede5 [file] [log] [blame]
Mark Fashehccd979b2005-12-15 14:31:24 -08001/* -*- 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>
Arjan van de Venc74ec2f2006-01-13 21:54:23 -080036#include <linux/mutex.h>
Mark Fasheh1fabe142006-10-09 18:11:45 -070037#include <linux/jbd.h>
Mark Fashehccd979b2005-12-15 14:31:24 -080038
39#include "cluster/nodemanager.h"
40#include "cluster/heartbeat.h"
41#include "cluster/tcp.h"
42
43#include "dlm/dlmapi.h"
44
45#include "ocfs2_fs.h"
46#include "endian.h"
47#include "ocfs2_lockid.h"
48
Mark Fashehccd979b2005-12-15 14:31:24 -080049/* Most user visible OCFS2 inodes will have very few pieces of
50 * metadata, but larger files (including bitmaps, etc) must be taken
51 * into account when designing an access scheme. We allow a small
52 * amount of inlined blocks to be stored on an array and grow the
53 * structure into a rb tree when necessary. */
54#define OCFS2_INODE_MAX_CACHE_ARRAY 2
55
56struct ocfs2_caching_info {
57 unsigned int ci_num_cached;
58 union {
59 sector_t ci_array[OCFS2_INODE_MAX_CACHE_ARRAY];
60 struct rb_root ci_tree;
61 } ci_cache;
62};
63
64/* this limits us to 256 nodes
65 * if we need more, we can do a kmalloc for the map */
66#define OCFS2_NODE_MAP_MAX_NODES 256
67struct ocfs2_node_map {
68 u16 num_nodes;
69 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
70};
71
72enum ocfs2_ast_action {
73 OCFS2_AST_INVALID = 0,
74 OCFS2_AST_ATTACH,
75 OCFS2_AST_CONVERT,
76 OCFS2_AST_DOWNCONVERT,
77};
78
79/* actions for an unlockast function to take. */
80enum ocfs2_unlock_action {
81 OCFS2_UNLOCK_INVALID = 0,
82 OCFS2_UNLOCK_CANCEL_CONVERT,
83 OCFS2_UNLOCK_DROP_LOCK,
84};
85
86/* ocfs2_lock_res->l_flags flags. */
87#define OCFS2_LOCK_ATTACHED (0x00000001) /* have we initialized
88 * the lvb */
89#define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
90 * dlm_lock */
91#define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
92 * downconvert*/
93#define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
94#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
95#define OCFS2_LOCK_REFRESHING (0x00000020)
96#define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
97 * for shutdown paths */
98#define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
99 * when to skip queueing
100 * a lock because it's
101 * about to be
102 * dropped. */
103#define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
Mark Fashehcf8e06f2007-12-20 16:43:10 -0800104#define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
Mark Fashehccd979b2005-12-15 14:31:24 -0800105
106struct ocfs2_lock_res_ops;
107
108typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
109
110struct ocfs2_lock_res {
111 void *l_priv;
112 struct ocfs2_lock_res_ops *l_ops;
113 spinlock_t l_lock;
114
115 struct list_head l_blocked_list;
116 struct list_head l_mask_waiters;
117
118 enum ocfs2_lock_type l_type;
119 unsigned long l_flags;
120 char l_name[OCFS2_LOCK_ID_MAX_LEN];
121 int l_level;
122 unsigned int l_ro_holders;
123 unsigned int l_ex_holders;
124 struct dlm_lockstatus l_lksb;
125
126 /* used from AST/BAST funcs. */
127 enum ocfs2_ast_action l_action;
128 enum ocfs2_unlock_action l_unlock_action;
129 int l_requested;
130 int l_blocking;
131
132 wait_queue_head_t l_event;
133
134 struct list_head l_debug_list;
135};
136
137struct ocfs2_dlm_debug {
138 struct kref d_refcnt;
139 struct dentry *d_locking_state;
140 struct list_head d_lockres_tracking;
141};
142
143enum ocfs2_vol_state
144{
145 VOLUME_INIT = 0,
146 VOLUME_MOUNTED,
147 VOLUME_DISMOUNTED,
148 VOLUME_DISABLED
149};
150
151struct ocfs2_alloc_stats
152{
153 atomic_t moves;
154 atomic_t local_data;
155 atomic_t bitmap_data;
156 atomic_t bg_allocs;
157 atomic_t bg_extends;
158};
159
160enum ocfs2_local_alloc_state
161{
162 OCFS2_LA_UNUSED = 0,
163 OCFS2_LA_ENABLED,
164 OCFS2_LA_DISABLED
165};
166
167enum ocfs2_mount_options
168{
169 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
170 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
171 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
172 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
173 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800174 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Mark Fashehccd979b2005-12-15 14:31:24 -0800175};
176
177#define OCFS2_OSB_SOFT_RO 0x0001
178#define OCFS2_OSB_HARD_RO 0x0002
179#define OCFS2_OSB_ERROR_FS 0x0004
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800180#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800181
182struct ocfs2_journal;
Mark Fashehccd979b2005-12-15 14:31:24 -0800183struct ocfs2_super
184{
Mark Fashehccd979b2005-12-15 14:31:24 -0800185 struct task_struct *commit_task;
186 struct super_block *sb;
187 struct inode *root_inode;
188 struct inode *sys_root_inode;
189 struct inode *system_inodes[NUM_SYSTEM_INODES];
190
191 struct ocfs2_slot_info *slot_info;
192
193 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800194 struct ocfs2_node_map recovery_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800195
Mark Fashehccd979b2005-12-15 14:31:24 -0800196 u64 root_blkno;
197 u64 system_dir_blkno;
198 u64 bitmap_blkno;
199 u32 bitmap_cpg;
200 u8 *uuid;
201 char *uuid_str;
202 u8 *vol_label;
203 u64 first_cluster_group_blkno;
204 u32 fs_generation;
205
206 u32 s_feature_compat;
207 u32 s_feature_incompat;
208 u32 s_feature_ro_compat;
209
210 /* Protects s_next_generaion, osb_flags. Could protect more on
211 * osb as it's very short lived. */
212 spinlock_t osb_lock;
213 u32 s_next_generation;
214 unsigned long osb_flags;
215
216 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800217 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800218
219 u16 max_slots;
Mark Fashehccd979b2005-12-15 14:31:24 -0800220 s16 node_num;
221 s16 slot_num;
Sunil Mushranbaf46612007-06-18 17:00:24 -0700222 s16 preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800223 int s_sectsize_bits;
224 int s_clustersize;
225 int s_clustersize_bits;
Mark Fashehccd979b2005-12-15 14:31:24 -0800226
227 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800228 struct mutex recovery_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800229 struct task_struct *recovery_thread_task;
230 int disable_recovery;
231 wait_queue_head_t checkpoint_event;
232 atomic_t needs_checkpoint;
233 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800234 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800235
Sunil Mushran2fbe8d12007-12-20 14:58:11 -0800236 int local_alloc_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800237 enum ocfs2_local_alloc_state local_alloc_state;
238 struct buffer_head *local_alloc_bh;
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400239 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800240
241 /* Next two fields are for local node slot recovery during
242 * mount. */
243 int dirty;
244 struct ocfs2_dinode *local_alloc_copy;
245
246 struct ocfs2_alloc_stats alloc_stats;
247 char dev_str[20]; /* "major,minor" of the device */
248
249 struct dlm_ctxt *dlm;
250 struct ocfs2_lock_res osb_super_lockres;
251 struct ocfs2_lock_res osb_rename_lockres;
252 struct dlm_eviction_cb osb_eviction_cb;
253 struct ocfs2_dlm_debug *osb_dlm_debug;
254
255 struct dentry *osb_debug_root;
256
257 wait_queue_head_t recovery_event;
258
Mark Fasheh34d024f2007-09-24 15:56:19 -0700259 spinlock_t dc_task_lock;
260 struct task_struct *dc_task;
261 wait_queue_head_t dc_event;
262 unsigned long dc_wake_sequence;
263 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800264
265 struct list_head blocked_lock_list;
266 unsigned long blocked_lock_count;
267
Mark Fashehccd979b2005-12-15 14:31:24 -0800268 wait_queue_head_t osb_mount_event;
269
270 /* Truncate log info */
271 struct inode *osb_tl_inode;
272 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000273 struct delayed_work osb_truncate_log_wq;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800274
275 struct ocfs2_node_map osb_recovering_orphan_dirs;
276 unsigned int *osb_orphan_wipes;
277 wait_queue_head_t osb_wipe_event;
Mark Fashehccd979b2005-12-15 14:31:24 -0800278};
279
280#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800281
282static inline int ocfs2_should_order_data(struct inode *inode)
283{
284 if (!S_ISREG(inode->i_mode))
285 return 0;
286 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
287 return 0;
288 return 1;
289}
290
Mark Fashehdcd05382007-01-16 11:32:23 -0800291static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
292{
293 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
294 return 1;
295 return 0;
296}
297
Mark Fasheh328d5752007-06-18 10:48:04 -0700298static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
299{
300 /*
301 * Support for sparse files is a pre-requisite
302 */
303 if (!ocfs2_sparse_alloc(osb))
304 return 0;
305
306 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
307 return 1;
308 return 0;
309}
310
Mark Fasheh15b1e362007-09-07 13:58:15 -0700311static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
312{
313 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
314 return 1;
315 return 0;
316}
317
Mark Fashehccd979b2005-12-15 14:31:24 -0800318/* set / clear functions because cluster events can make these happen
319 * in parallel so we want the transitions to be atomic. this also
320 * means that any future flags osb_flags must be protected by spinlock
321 * too! */
322static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
323 unsigned long flag)
324{
325 spin_lock(&osb->osb_lock);
326 osb->osb_flags |= flag;
327 spin_unlock(&osb->osb_lock);
328}
329
330static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
331 int hard)
332{
333 spin_lock(&osb->osb_lock);
334 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
335 if (hard)
336 osb->osb_flags |= OCFS2_OSB_HARD_RO;
337 else
338 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
339 spin_unlock(&osb->osb_lock);
340}
341
342static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
343{
344 int ret;
345
346 spin_lock(&osb->osb_lock);
347 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
348 spin_unlock(&osb->osb_lock);
349
350 return ret;
351}
352
353static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
354{
355 int ret;
356
357 spin_lock(&osb->osb_lock);
358 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
359 spin_unlock(&osb->osb_lock);
360
361 return ret;
362}
363
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800364static inline int ocfs2_mount_local(struct ocfs2_super *osb)
365{
366 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
367}
368
Mark Fashehccd979b2005-12-15 14:31:24 -0800369#define OCFS2_IS_VALID_DINODE(ptr) \
370 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
371
372#define OCFS2_RO_ON_INVALID_DINODE(__sb, __di) do { \
373 typeof(__di) ____di = (__di); \
374 ocfs2_error((__sb), \
Mark Fashehb06970532006-03-03 10:24:33 -0800375 "Dinode # %llu has bad signature %.*s", \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700376 (unsigned long long)le64_to_cpu((____di)->i_blkno), 7, \
Mark Fashehccd979b2005-12-15 14:31:24 -0800377 (____di)->i_signature); \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700378} while (0)
Mark Fashehccd979b2005-12-15 14:31:24 -0800379
380#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
381 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
382
383#define OCFS2_RO_ON_INVALID_EXTENT_BLOCK(__sb, __eb) do { \
384 typeof(__eb) ____eb = (__eb); \
385 ocfs2_error((__sb), \
Mark Fashehb06970532006-03-03 10:24:33 -0800386 "Extent Block # %llu has bad signature %.*s", \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700387 (unsigned long long)le64_to_cpu((____eb)->h_blkno), 7, \
Mark Fashehccd979b2005-12-15 14:31:24 -0800388 (____eb)->h_signature); \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700389} while (0)
Mark Fashehccd979b2005-12-15 14:31:24 -0800390
391#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
392 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
393
394#define OCFS2_RO_ON_INVALID_GROUP_DESC(__sb, __gd) do { \
395 typeof(__gd) ____gd = (__gd); \
396 ocfs2_error((__sb), \
Mark Fashehb06970532006-03-03 10:24:33 -0800397 "Group Descriptor # %llu has bad signature %.*s", \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700398 (unsigned long long)le64_to_cpu((____gd)->bg_blkno), 7, \
Mark Fashehccd979b2005-12-15 14:31:24 -0800399 (____gd)->bg_signature); \
Mark Fasheh1ca1a112007-04-27 16:01:25 -0700400} while (0)
Mark Fashehccd979b2005-12-15 14:31:24 -0800401
402static inline unsigned long ino_from_blkno(struct super_block *sb,
403 u64 blkno)
404{
405 return (unsigned long)(blkno & (u64)ULONG_MAX);
406}
407
408static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
409 u32 clusters)
410{
411 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
412 sb->s_blocksize_bits;
413
414 return (u64)clusters << c_to_b_bits;
415}
416
417static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
418 u64 blocks)
419{
420 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
421 sb->s_blocksize_bits;
422
423 return (u32)(blocks >> b_to_c_bits);
424}
425
426static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
427 u64 bytes)
428{
429 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
430 unsigned int clusters;
431
432 bytes += OCFS2_SB(sb)->s_clustersize - 1;
433 /* OCFS2 just cannot have enough clusters to overflow this */
434 clusters = (unsigned int)(bytes >> cl_bits);
435
436 return clusters;
437}
438
439static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
440 u64 bytes)
441{
442 bytes += sb->s_blocksize - 1;
443 return bytes >> sb->s_blocksize_bits;
444}
445
446static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
447 u32 clusters)
448{
449 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
450}
451
452static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
453 u64 bytes)
454{
455 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
456 unsigned int clusters;
457
458 clusters = ocfs2_clusters_for_bytes(sb, bytes);
459 return (u64)clusters << cl_bits;
460}
461
462static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
463 u64 bytes)
464{
465 u64 blocks;
466
467 blocks = ocfs2_blocks_for_bytes(sb, bytes);
468 return blocks << sb->s_blocksize_bits;
469}
470
471static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
472{
473 return (unsigned long)((bytes + 511) >> 9);
474}
475
Mark Fasheh9517bac2007-02-09 20:24:12 -0800476static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
477 unsigned long pg_index)
478{
479 u32 clusters = pg_index;
480 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
481
482 if (unlikely(PAGE_CACHE_SHIFT > cbits))
483 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
484 else if (PAGE_CACHE_SHIFT < cbits)
485 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
486
487 return clusters;
488}
489
490/*
491 * Find the 1st page index which covers the given clusters.
492 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700493static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800494 u32 clusters)
495{
496 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700497 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800498
499 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700500 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800501 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700502 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800503 }
504
505 return index;
506}
507
Mark Fasheh60b11392007-02-16 11:46:50 -0800508static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
509{
510 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
511 unsigned int pages_per_cluster = 1;
512
513 if (PAGE_CACHE_SHIFT < cbits)
514 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
515
516 return pages_per_cluster;
517}
518
Mark Fashehccd979b2005-12-15 14:31:24 -0800519#define ocfs2_set_bit ext2_set_bit
520#define ocfs2_clear_bit ext2_clear_bit
521#define ocfs2_test_bit ext2_test_bit
522#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
523#endif /* OCFS2_H */
524