blob: 18b5fea98c91d1f4480f3d7a2881247156724ba2 [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>
Jan Karacb257972009-06-04 15:26:50 +020037#include <linux/lockdep.h>
Joel Becker2b4e30f2008-09-03 20:03:41 -070038#ifndef CONFIG_OCFS2_COMPAT_JBD
39# include <linux/jbd2.h>
40#else
41# include <linux/jbd.h>
42# include "ocfs2_jbd_compat.h"
43#endif
Mark Fashehccd979b2005-12-15 14:31:24 -080044
Joel Becker8f2c9c12008-02-01 12:16:57 -080045/* For union ocfs2_dlm_lksb */
46#include "stackglue.h"
Mark Fashehccd979b2005-12-15 14:31:24 -080047
48#include "ocfs2_fs.h"
Mark Fashehccd979b2005-12-15 14:31:24 -080049#include "ocfs2_lockid.h"
50
Joel Becker73be1922009-01-06 14:57:08 -080051/* For struct ocfs2_blockcheck_stats */
52#include "blockcheck.h"
53
Joel Becker47460d62009-02-10 16:05:07 -080054
55/* Caching of metadata buffers */
56
Mark Fashehccd979b2005-12-15 14:31:24 -080057/* Most user visible OCFS2 inodes will have very few pieces of
58 * metadata, but larger files (including bitmaps, etc) must be taken
59 * into account when designing an access scheme. We allow a small
60 * amount of inlined blocks to be stored on an array and grow the
61 * structure into a rb tree when necessary. */
Joel Becker47460d62009-02-10 16:05:07 -080062#define OCFS2_CACHE_INFO_MAX_ARRAY 2
63
64/* Flags for ocfs2_caching_info */
65
66enum ocfs2_caching_info_flags {
67 /* Indicates that the metadata cache is using the inline array */
68 OCFS2_CACHE_FL_INLINE = 1<<1,
69};
Mark Fashehccd979b2005-12-15 14:31:24 -080070
Joel Becker6e5a3d72009-02-10 19:00:37 -080071struct ocfs2_caching_operations;
Mark Fashehccd979b2005-12-15 14:31:24 -080072struct ocfs2_caching_info {
Joel Becker47460d62009-02-10 16:05:07 -080073 /*
74 * The parent structure provides the locks, but because the
Joel Becker6e5a3d72009-02-10 19:00:37 -080075 * parent structure can differ, it provides locking operations
76 * to struct ocfs2_caching_info.
Joel Becker47460d62009-02-10 16:05:07 -080077 */
Joel Becker6e5a3d72009-02-10 19:00:37 -080078 const struct ocfs2_caching_operations *ci_ops;
Joel Becker47460d62009-02-10 16:05:07 -080079
Joel Becker292dd272009-02-12 15:41:59 -080080 /* next two are protected by trans_inc_lock */
81 /* which transaction were we created on? Zero if none. */
82 unsigned long ci_created_trans;
Joel Becker66fb3452009-02-12 15:24:40 -080083 /* last transaction we were a part of. */
84 unsigned long ci_last_trans;
85
86 /* Cache structures */
Joel Becker47460d62009-02-10 16:05:07 -080087 unsigned int ci_flags;
Mark Fashehccd979b2005-12-15 14:31:24 -080088 unsigned int ci_num_cached;
89 union {
Joel Becker47460d62009-02-10 16:05:07 -080090 sector_t ci_array[OCFS2_CACHE_INFO_MAX_ARRAY];
Mark Fashehccd979b2005-12-15 14:31:24 -080091 struct rb_root ci_tree;
92 } ci_cache;
93};
94
95/* this limits us to 256 nodes
96 * if we need more, we can do a kmalloc for the map */
97#define OCFS2_NODE_MAP_MAX_NODES 256
98struct ocfs2_node_map {
99 u16 num_nodes;
100 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
101};
102
103enum ocfs2_ast_action {
104 OCFS2_AST_INVALID = 0,
105 OCFS2_AST_ATTACH,
106 OCFS2_AST_CONVERT,
107 OCFS2_AST_DOWNCONVERT,
108};
109
110/* actions for an unlockast function to take. */
111enum ocfs2_unlock_action {
112 OCFS2_UNLOCK_INVALID = 0,
113 OCFS2_UNLOCK_CANCEL_CONVERT,
114 OCFS2_UNLOCK_DROP_LOCK,
115};
116
117/* ocfs2_lock_res->l_flags flags. */
Coly Li3b5da012008-11-05 15:16:24 +0800118#define OCFS2_LOCK_ATTACHED (0x00000001) /* we have initialized
Mark Fashehccd979b2005-12-15 14:31:24 -0800119 * the lvb */
120#define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
121 * dlm_lock */
122#define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
123 * downconvert*/
124#define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
125#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
126#define OCFS2_LOCK_REFRESHING (0x00000020)
127#define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
128 * for shutdown paths */
129#define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
130 * when to skip queueing
131 * a lock because it's
132 * about to be
133 * dropped. */
134#define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
Mark Fashehcf8e06f2007-12-20 16:43:10 -0800135#define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
Joel Beckerde551242008-02-01 14:45:08 -0800136#define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
137 call to dlm_lock. Only
138 exists with BUSY set. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800139
140struct ocfs2_lock_res_ops;
141
142typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
143
144struct ocfs2_lock_res {
145 void *l_priv;
146 struct ocfs2_lock_res_ops *l_ops;
147 spinlock_t l_lock;
148
149 struct list_head l_blocked_list;
150 struct list_head l_mask_waiters;
151
152 enum ocfs2_lock_type l_type;
153 unsigned long l_flags;
154 char l_name[OCFS2_LOCK_ID_MAX_LEN];
155 int l_level;
156 unsigned int l_ro_holders;
157 unsigned int l_ex_holders;
Joel Becker8f2c9c12008-02-01 12:16:57 -0800158 union ocfs2_dlm_lksb l_lksb;
Mark Fashehccd979b2005-12-15 14:31:24 -0800159
160 /* used from AST/BAST funcs. */
161 enum ocfs2_ast_action l_action;
162 enum ocfs2_unlock_action l_unlock_action;
163 int l_requested;
164 int l_blocking;
Joel Beckerde551242008-02-01 14:45:08 -0800165 unsigned int l_pending_gen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800166
167 wait_queue_head_t l_event;
168
169 struct list_head l_debug_list;
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700170
171#ifdef CONFIG_OCFS2_FS_STATS
172 unsigned long long l_lock_num_prmode; /* PR acquires */
173 unsigned long long l_lock_num_exmode; /* EX acquires */
174 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
175 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
176 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
177 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
178 unsigned int l_lock_max_prmode; /* Max wait for PR */
179 unsigned int l_lock_max_exmode; /* Max wait for EX */
180 unsigned int l_lock_refresh; /* Disk refreshes */
181#endif
Jan Karacb257972009-06-04 15:26:50 +0200182#ifdef CONFIG_DEBUG_LOCK_ALLOC
183 struct lockdep_map l_lockdep_map;
184#endif
Mark Fashehccd979b2005-12-15 14:31:24 -0800185};
186
Sunil Mushran692684e2009-06-19 16:53:17 -0700187enum ocfs2_orphan_scan_state {
188 ORPHAN_SCAN_ACTIVE,
189 ORPHAN_SCAN_INACTIVE
190};
191
Srinivas Eeda83273932009-06-03 17:02:55 -0700192struct ocfs2_orphan_scan {
193 struct mutex os_lock;
194 struct ocfs2_super *os_osb;
195 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
196 struct delayed_work os_orphan_scan_work;
Srinivas Eeda15633a22009-06-03 17:02:56 -0700197 struct timespec os_scantime; /* time this node ran the scan */
198 u32 os_count; /* tracks node specific scans */
199 u32 os_seqno; /* tracks cluster wide scans */
Sunil Mushran692684e2009-06-19 16:53:17 -0700200 atomic_t os_state; /* ACTIVE or INACTIVE */
Srinivas Eeda83273932009-06-03 17:02:55 -0700201};
202
Mark Fashehccd979b2005-12-15 14:31:24 -0800203struct ocfs2_dlm_debug {
204 struct kref d_refcnt;
205 struct dentry *d_locking_state;
206 struct list_head d_lockres_tracking;
207};
208
209enum ocfs2_vol_state
210{
211 VOLUME_INIT = 0,
212 VOLUME_MOUNTED,
Jan Kara19ece542008-08-21 20:13:17 +0200213 VOLUME_MOUNTED_QUOTAS,
Mark Fashehccd979b2005-12-15 14:31:24 -0800214 VOLUME_DISMOUNTED,
215 VOLUME_DISABLED
216};
217
218struct ocfs2_alloc_stats
219{
220 atomic_t moves;
221 atomic_t local_data;
222 atomic_t bitmap_data;
223 atomic_t bg_allocs;
224 atomic_t bg_extends;
225};
226
227enum ocfs2_local_alloc_state
228{
Mark Fasheh9c7af402008-07-28 18:02:53 -0700229 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
230 * this mountpoint. */
231 OCFS2_LA_ENABLED, /* Local alloc is in use. */
232 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
233 * of bits has been reduced. */
234 OCFS2_LA_DISABLED /* Local alloc has temporarily been
235 * disabled. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800236};
237
238enum ocfs2_mount_options
239{
240 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
241 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
242 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
243 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
244 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800245 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800246 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
Joel Becker12462f12008-09-03 20:03:40 -0700247 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
Tiger Yang929fb012008-11-14 11:17:04 +0800248 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* POSIX access control lists */
Jan Kara19ece542008-08-21 20:13:17 +0200249 OCFS2_MOUNT_USRQUOTA = 1 << 9, /* We support user quotas */
250 OCFS2_MOUNT_GRPQUOTA = 1 << 10, /* We support group quotas */
Mark Fashehccd979b2005-12-15 14:31:24 -0800251};
252
Jan Karaf7b1aa62009-07-20 12:12:36 +0200253#define OCFS2_OSB_SOFT_RO 0x0001
254#define OCFS2_OSB_HARD_RO 0x0002
255#define OCFS2_OSB_ERROR_FS 0x0004
256#define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED 0x0008
257
258#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800259
260struct ocfs2_journal;
Joel Beckerd85b20e2008-02-01 12:01:05 -0800261struct ocfs2_slot_info;
Joel Becker553abd02008-02-01 12:03:57 -0800262struct ocfs2_recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800263struct ocfs2_replay_map;
Jan Kara22053632008-10-20 23:50:38 +0200264struct ocfs2_quota_recovery;
Jan Karaea455f82009-01-12 23:20:31 +0100265struct ocfs2_dentry_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800266struct ocfs2_super
267{
Mark Fashehccd979b2005-12-15 14:31:24 -0800268 struct task_struct *commit_task;
269 struct super_block *sb;
270 struct inode *root_inode;
271 struct inode *sys_root_inode;
272 struct inode *system_inodes[NUM_SYSTEM_INODES];
273
274 struct ocfs2_slot_info *slot_info;
275
Sunil Mushran539d8262008-07-14 17:31:10 -0700276 u32 *slot_recovery_generations;
277
Mark Fashehccd979b2005-12-15 14:31:24 -0800278 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800279
Mark Fashehccd979b2005-12-15 14:31:24 -0800280 u64 root_blkno;
281 u64 system_dir_blkno;
282 u64 bitmap_blkno;
283 u32 bitmap_cpg;
284 u8 *uuid;
285 char *uuid_str;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800286 u32 uuid_hash;
Mark Fashehccd979b2005-12-15 14:31:24 -0800287 u8 *vol_label;
288 u64 first_cluster_group_blkno;
289 u32 fs_generation;
290
291 u32 s_feature_compat;
292 u32 s_feature_incompat;
293 u32 s_feature_ro_compat;
294
Tao Ma4d0ddb22008-03-05 16:11:46 +0800295 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
296 * Could protect more on osb as it's very short lived.
297 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800298 spinlock_t osb_lock;
299 u32 s_next_generation;
300 unsigned long osb_flags;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800301 s16 s_inode_steal_slot;
302 atomic_t s_num_inodes_stolen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800303
304 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800305 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800306
Joel Beckerfc881fa2008-02-01 12:04:48 -0800307 unsigned int max_slots;
Joel Becker19fdb622008-01-30 15:38:24 -0800308 unsigned int node_num;
Joel Beckerfc881fa2008-02-01 12:04:48 -0800309 int slot_num;
310 int preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800311 int s_sectsize_bits;
312 int s_clustersize;
313 int s_clustersize_bits;
Tiger Yangfdd77702008-08-18 17:08:55 +0800314 unsigned int s_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800315
316 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800317 struct mutex recovery_lock;
Joel Becker553abd02008-02-01 12:03:57 -0800318 struct ocfs2_recovery_map *recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800319 struct ocfs2_replay_map *replay_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800320 struct task_struct *recovery_thread_task;
321 int disable_recovery;
322 wait_queue_head_t checkpoint_event;
323 atomic_t needs_checkpoint;
324 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800325 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800326
Mark Fasheh9c7af402008-07-28 18:02:53 -0700327 struct delayed_work la_enable_wq;
328
329 /*
330 * Must hold local alloc i_mutex and osb->osb_lock to change
331 * local_alloc_bits. Reads can be done under either lock.
332 */
Mark Fashehebcee4b2008-07-28 14:55:20 -0700333 unsigned int local_alloc_bits;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700334 unsigned int local_alloc_default_bits;
335
336 enum ocfs2_local_alloc_state local_alloc_state; /* protected
337 * by osb_lock */
338
Mark Fashehccd979b2005-12-15 14:31:24 -0800339 struct buffer_head *local_alloc_bh;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700340
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400341 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800342
Jan Kara22053632008-10-20 23:50:38 +0200343 /* Next three fields are for local node slot recovery during
Mark Fashehccd979b2005-12-15 14:31:24 -0800344 * mount. */
345 int dirty;
346 struct ocfs2_dinode *local_alloc_copy;
Jan Kara22053632008-10-20 23:50:38 +0200347 struct ocfs2_quota_recovery *quota_rec;
Mark Fashehccd979b2005-12-15 14:31:24 -0800348
Joel Becker73be1922009-01-06 14:57:08 -0800349 struct ocfs2_blockcheck_stats osb_ecc_stats;
Mark Fashehccd979b2005-12-15 14:31:24 -0800350 struct ocfs2_alloc_stats alloc_stats;
351 char dev_str[20]; /* "major,minor" of the device */
352
Joel Beckerb61817e2008-02-01 15:08:23 -0800353 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
Joel Becker4670c462008-02-01 14:39:35 -0800354 struct ocfs2_cluster_connection *cconn;
Mark Fashehccd979b2005-12-15 14:31:24 -0800355 struct ocfs2_lock_res osb_super_lockres;
356 struct ocfs2_lock_res osb_rename_lockres;
wengang wang6ca497a2009-03-06 21:29:10 +0800357 struct ocfs2_lock_res osb_nfs_sync_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -0800358 struct ocfs2_dlm_debug *osb_dlm_debug;
359
360 struct dentry *osb_debug_root;
Sunil Mushran50397502008-12-17 14:17:43 -0800361 struct dentry *osb_ctxt;
Mark Fashehccd979b2005-12-15 14:31:24 -0800362
363 wait_queue_head_t recovery_event;
364
Mark Fasheh34d024f2007-09-24 15:56:19 -0700365 spinlock_t dc_task_lock;
366 struct task_struct *dc_task;
367 wait_queue_head_t dc_event;
368 unsigned long dc_wake_sequence;
369 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800370
Mark Fasheh7ec373c2008-01-23 16:54:48 -0800371 /*
372 * Any thread can add locks to the list, but the downconvert
373 * thread is the only one allowed to remove locks. Any change
374 * to this rule requires updating
375 * ocfs2_downconvert_thread_do_work().
376 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800377 struct list_head blocked_lock_list;
378 unsigned long blocked_lock_count;
379
Jan Karaea455f82009-01-12 23:20:31 +0100380 /* List of dentry locks to release. Anyone can add locks to
381 * the list, ocfs2_wq processes the list */
382 struct ocfs2_dentry_lock *dentry_lock_list;
383 struct work_struct dentry_lock_work;
384
Mark Fashehccd979b2005-12-15 14:31:24 -0800385 wait_queue_head_t osb_mount_event;
386
387 /* Truncate log info */
388 struct inode *osb_tl_inode;
389 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000390 struct delayed_work osb_truncate_log_wq;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800391
392 struct ocfs2_node_map osb_recovering_orphan_dirs;
393 unsigned int *osb_orphan_wipes;
394 wait_queue_head_t osb_wipe_event;
Tao Mac8b9cf92009-02-24 17:40:26 -0800395
Srinivas Eeda83273932009-06-03 17:02:55 -0700396 struct ocfs2_orphan_scan osb_orphan_scan;
397
Tao Mac8b9cf92009-02-24 17:40:26 -0800398 /* used to protect metaecc calculation check of xattr. */
399 spinlock_t osb_xattr_lock;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800400
401 unsigned int osb_dx_mask;
402 u32 osb_dx_seed[4];
Tao Mafeb473a2009-02-25 00:53:25 +0800403
404 /* the group we used to allocate inodes. */
405 u64 osb_inode_alloc_group;
Mark Fashehccd979b2005-12-15 14:31:24 -0800406};
407
408#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800409
Joel Becker13723d02008-10-17 19:25:01 -0700410/* Useful typedef for passing around journal access functions */
411typedef int (*ocfs2_journal_access_func)(handle_t *handle, struct inode *inode,
412 struct buffer_head *bh, int type);
413
Mark Fashehccd979b2005-12-15 14:31:24 -0800414static inline int ocfs2_should_order_data(struct inode *inode)
415{
416 if (!S_ISREG(inode->i_mode))
417 return 0;
418 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
419 return 0;
420 return 1;
421}
422
Mark Fashehdcd05382007-01-16 11:32:23 -0800423static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
424{
425 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
426 return 1;
427 return 0;
428}
429
Mark Fasheh328d5752007-06-18 10:48:04 -0700430static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
431{
432 /*
433 * Support for sparse files is a pre-requisite
434 */
435 if (!ocfs2_sparse_alloc(osb))
436 return 0;
437
438 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
439 return 1;
440 return 0;
441}
442
Mark Fasheh15b1e362007-09-07 13:58:15 -0700443static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
444{
445 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
446 return 1;
447 return 0;
448}
449
Tiger Yang8154da32008-08-18 17:11:46 +0800450static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
451{
452 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
453 return 1;
454 return 0;
455}
456
Joel Becker70ad1ba2008-10-16 17:54:25 -0700457static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
458{
459 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
460 return 1;
461 return 0;
462}
463
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800464static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
465{
466 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
467 return 1;
468 return 0;
469}
470
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800471static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
472{
473 if (ocfs2_supports_indexed_dirs(osb))
474 return OCFS2_DX_LINK_MAX;
475 return OCFS2_LINK_MAX;
476}
477
478static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
479{
480 u32 nlink = le16_to_cpu(di->i_links_count);
481 u32 hi = le16_to_cpu(di->i_links_count_hi);
482
483 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
484 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
485
486 return nlink;
487}
488
489static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
490{
491 u16 lo, hi;
492
493 lo = nlink;
494 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
495
496 di->i_links_count = cpu_to_le16(lo);
497 di->i_links_count_hi = cpu_to_le16(hi);
498}
499
500static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
501{
502 u32 links = ocfs2_read_links_count(di);
503
504 links += n;
505
506 ocfs2_set_links_count(di, links);
507}
508
Mark Fashehccd979b2005-12-15 14:31:24 -0800509/* set / clear functions because cluster events can make these happen
510 * in parallel so we want the transitions to be atomic. this also
511 * means that any future flags osb_flags must be protected by spinlock
512 * too! */
513static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
514 unsigned long flag)
515{
516 spin_lock(&osb->osb_lock);
517 osb->osb_flags |= flag;
518 spin_unlock(&osb->osb_lock);
519}
520
Jan Karaf7b1aa62009-07-20 12:12:36 +0200521
522static inline unsigned long ocfs2_test_osb_flag(struct ocfs2_super *osb,
523 unsigned long flag)
524{
525 unsigned long ret;
526
527 spin_lock(&osb->osb_lock);
528 ret = osb->osb_flags & flag;
529 spin_unlock(&osb->osb_lock);
530 return ret;
531}
532
Mark Fashehccd979b2005-12-15 14:31:24 -0800533static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
534 int hard)
535{
536 spin_lock(&osb->osb_lock);
537 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
538 if (hard)
539 osb->osb_flags |= OCFS2_OSB_HARD_RO;
540 else
541 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
542 spin_unlock(&osb->osb_lock);
543}
544
545static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
546{
547 int ret;
548
549 spin_lock(&osb->osb_lock);
550 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
551 spin_unlock(&osb->osb_lock);
552
553 return ret;
554}
555
556static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
557{
558 int ret;
559
560 spin_lock(&osb->osb_lock);
561 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
562 spin_unlock(&osb->osb_lock);
563
564 return ret;
565}
566
Joel Beckerb61817e2008-02-01 15:08:23 -0800567static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
568{
569 return (osb->s_feature_incompat &
570 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
571}
572
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800573static inline int ocfs2_mount_local(struct ocfs2_super *osb)
574{
575 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
576}
577
Joel Becker386a2ef2008-02-01 12:06:54 -0800578static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
579{
580 return (osb->s_feature_incompat &
581 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
582}
583
584
Mark Fashehccd979b2005-12-15 14:31:24 -0800585#define OCFS2_IS_VALID_DINODE(ptr) \
586 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
587
Mark Fashehccd979b2005-12-15 14:31:24 -0800588#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
589 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
590
Mark Fashehccd979b2005-12-15 14:31:24 -0800591#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
592 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
593
Mark Fashehccd979b2005-12-15 14:31:24 -0800594
Joel Beckerf6087fb2008-10-20 18:20:43 -0700595#define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
596 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
597
Mark Fasheh87d35a72008-12-10 17:36:25 -0800598#define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
599 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
600
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800601#define OCFS2_IS_VALID_DX_ROOT(ptr) \
602 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
603
604#define OCFS2_IS_VALID_DX_LEAF(ptr) \
605 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
606
Mark Fashehccd979b2005-12-15 14:31:24 -0800607static inline unsigned long ino_from_blkno(struct super_block *sb,
608 u64 blkno)
609{
610 return (unsigned long)(blkno & (u64)ULONG_MAX);
611}
612
613static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
614 u32 clusters)
615{
616 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
617 sb->s_blocksize_bits;
618
619 return (u64)clusters << c_to_b_bits;
620}
621
622static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
623 u64 blocks)
624{
625 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
626 sb->s_blocksize_bits;
627
628 return (u32)(blocks >> b_to_c_bits);
629}
630
631static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
632 u64 bytes)
633{
634 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
635 unsigned int clusters;
636
637 bytes += OCFS2_SB(sb)->s_clustersize - 1;
638 /* OCFS2 just cannot have enough clusters to overflow this */
639 clusters = (unsigned int)(bytes >> cl_bits);
640
641 return clusters;
642}
643
644static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
645 u64 bytes)
646{
647 bytes += sb->s_blocksize - 1;
648 return bytes >> sb->s_blocksize_bits;
649}
650
651static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
652 u32 clusters)
653{
654 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
655}
656
Mark Fasheh1d46dc02009-02-19 13:17:05 -0800657static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
658 u64 blocks)
659{
660 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
661 unsigned int clusters;
662
663 clusters = ocfs2_blocks_to_clusters(sb, blocks);
664 return (u64)clusters << bits;
665}
666
Mark Fashehccd979b2005-12-15 14:31:24 -0800667static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
668 u64 bytes)
669{
670 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
671 unsigned int clusters;
672
673 clusters = ocfs2_clusters_for_bytes(sb, bytes);
674 return (u64)clusters << cl_bits;
675}
676
677static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
678 u64 bytes)
679{
680 u64 blocks;
681
682 blocks = ocfs2_blocks_for_bytes(sb, bytes);
683 return blocks << sb->s_blocksize_bits;
684}
685
686static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
687{
688 return (unsigned long)((bytes + 511) >> 9);
689}
690
Mark Fasheh9517bac2007-02-09 20:24:12 -0800691static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
692 unsigned long pg_index)
693{
694 u32 clusters = pg_index;
695 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
696
697 if (unlikely(PAGE_CACHE_SHIFT > cbits))
698 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
699 else if (PAGE_CACHE_SHIFT < cbits)
700 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
701
702 return clusters;
703}
704
705/*
706 * Find the 1st page index which covers the given clusters.
707 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700708static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800709 u32 clusters)
710{
711 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700712 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800713
714 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700715 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800716 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700717 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800718 }
719
720 return index;
721}
722
Mark Fasheh60b11392007-02-16 11:46:50 -0800723static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
724{
725 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
726 unsigned int pages_per_cluster = 1;
727
728 if (PAGE_CACHE_SHIFT < cbits)
729 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
730
731 return pages_per_cluster;
732}
733
Mark Fashehebcee4b2008-07-28 14:55:20 -0700734static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
735 unsigned int megs)
736{
737 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
738
739 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
740}
741
Tao Ma4d0ddb22008-03-05 16:11:46 +0800742static inline void ocfs2_init_inode_steal_slot(struct ocfs2_super *osb)
743{
744 spin_lock(&osb->osb_lock);
745 osb->s_inode_steal_slot = OCFS2_INVALID_SLOT;
746 spin_unlock(&osb->osb_lock);
747 atomic_set(&osb->s_num_inodes_stolen, 0);
748}
749
750static inline void ocfs2_set_inode_steal_slot(struct ocfs2_super *osb,
751 s16 slot)
752{
753 spin_lock(&osb->osb_lock);
754 osb->s_inode_steal_slot = slot;
755 spin_unlock(&osb->osb_lock);
756}
757
758static inline s16 ocfs2_get_inode_steal_slot(struct ocfs2_super *osb)
759{
760 s16 slot;
761
762 spin_lock(&osb->osb_lock);
763 slot = osb->s_inode_steal_slot;
764 spin_unlock(&osb->osb_lock);
765
766 return slot;
767}
768
Mark Fashehccd979b2005-12-15 14:31:24 -0800769#define ocfs2_set_bit ext2_set_bit
770#define ocfs2_clear_bit ext2_clear_bit
771#define ocfs2_test_bit ext2_test_bit
772#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
Joel Becker70ad1ba2008-10-16 17:54:25 -0700773#define ocfs2_find_next_bit ext2_find_next_bit
Mark Fashehccd979b2005-12-15 14:31:24 -0800774#endif /* OCFS2_H */
775