blob: 409285854f647e2357223bc7a8d24c36b376a6bb [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>
Sunil Mushran7aee47b2009-11-06 14:50:22 -080038#include <linux/jbd2.h>
Mark Fashehccd979b2005-12-15 14:31:24 -080039
Joel Becker8f2c9c12008-02-01 12:16:57 -080040/* For union ocfs2_dlm_lksb */
41#include "stackglue.h"
Mark Fashehccd979b2005-12-15 14:31:24 -080042
43#include "ocfs2_fs.h"
Mark Fashehccd979b2005-12-15 14:31:24 -080044#include "ocfs2_lockid.h"
Tristan Ye9df57782010-03-02 13:59:42 +080045#include "ocfs2_ioctl.h"
Mark Fashehccd979b2005-12-15 14:31:24 -080046
Joel Becker73be1922009-01-06 14:57:08 -080047/* For struct ocfs2_blockcheck_stats */
48#include "blockcheck.h"
49
Mark Fashehd02f00c2009-12-07 13:10:48 -080050#include "reservations.h"
Joel Becker47460d62009-02-10 16:05:07 -080051
52/* Caching of metadata buffers */
53
Mark Fashehccd979b2005-12-15 14:31:24 -080054/* Most user visible OCFS2 inodes will have very few pieces of
55 * metadata, but larger files (including bitmaps, etc) must be taken
56 * into account when designing an access scheme. We allow a small
57 * amount of inlined blocks to be stored on an array and grow the
58 * structure into a rb tree when necessary. */
Joel Becker47460d62009-02-10 16:05:07 -080059#define OCFS2_CACHE_INFO_MAX_ARRAY 2
60
61/* Flags for ocfs2_caching_info */
62
63enum ocfs2_caching_info_flags {
64 /* Indicates that the metadata cache is using the inline array */
65 OCFS2_CACHE_FL_INLINE = 1<<1,
66};
Mark Fashehccd979b2005-12-15 14:31:24 -080067
Joel Becker6e5a3d72009-02-10 19:00:37 -080068struct ocfs2_caching_operations;
Mark Fashehccd979b2005-12-15 14:31:24 -080069struct ocfs2_caching_info {
Joel Becker47460d62009-02-10 16:05:07 -080070 /*
71 * The parent structure provides the locks, but because the
Joel Becker6e5a3d72009-02-10 19:00:37 -080072 * parent structure can differ, it provides locking operations
73 * to struct ocfs2_caching_info.
Joel Becker47460d62009-02-10 16:05:07 -080074 */
Joel Becker6e5a3d72009-02-10 19:00:37 -080075 const struct ocfs2_caching_operations *ci_ops;
Joel Becker47460d62009-02-10 16:05:07 -080076
Joel Becker292dd272009-02-12 15:41:59 -080077 /* next two are protected by trans_inc_lock */
78 /* which transaction were we created on? Zero if none. */
79 unsigned long ci_created_trans;
Joel Becker66fb3452009-02-12 15:24:40 -080080 /* last transaction we were a part of. */
81 unsigned long ci_last_trans;
82
83 /* Cache structures */
Joel Becker47460d62009-02-10 16:05:07 -080084 unsigned int ci_flags;
Mark Fashehccd979b2005-12-15 14:31:24 -080085 unsigned int ci_num_cached;
86 union {
Joel Becker47460d62009-02-10 16:05:07 -080087 sector_t ci_array[OCFS2_CACHE_INFO_MAX_ARRAY];
Mark Fashehccd979b2005-12-15 14:31:24 -080088 struct rb_root ci_tree;
89 } ci_cache;
90};
Joel Becker0cf2f762009-02-12 16:41:25 -080091/*
92 * Need this prototype here instead of in uptodate.h because journal.h
93 * uses it.
94 */
95struct super_block *ocfs2_metadata_cache_get_super(struct ocfs2_caching_info *ci);
Mark Fashehccd979b2005-12-15 14:31:24 -080096
97/* this limits us to 256 nodes
98 * if we need more, we can do a kmalloc for the map */
99#define OCFS2_NODE_MAP_MAX_NODES 256
100struct ocfs2_node_map {
101 u16 num_nodes;
102 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
103};
104
105enum ocfs2_ast_action {
106 OCFS2_AST_INVALID = 0,
107 OCFS2_AST_ATTACH,
108 OCFS2_AST_CONVERT,
109 OCFS2_AST_DOWNCONVERT,
110};
111
112/* actions for an unlockast function to take. */
113enum ocfs2_unlock_action {
114 OCFS2_UNLOCK_INVALID = 0,
115 OCFS2_UNLOCK_CANCEL_CONVERT,
116 OCFS2_UNLOCK_DROP_LOCK,
117};
118
119/* ocfs2_lock_res->l_flags flags. */
Coly Li3b5da012008-11-05 15:16:24 +0800120#define OCFS2_LOCK_ATTACHED (0x00000001) /* we have initialized
Mark Fashehccd979b2005-12-15 14:31:24 -0800121 * the lvb */
122#define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
123 * dlm_lock */
124#define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
125 * downconvert*/
126#define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
127#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
128#define OCFS2_LOCK_REFRESHING (0x00000020)
129#define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
130 * for shutdown paths */
131#define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
132 * when to skip queueing
133 * a lock because it's
134 * about to be
135 * dropped. */
136#define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
Mark Fashehcf8e06f2007-12-20 16:43:10 -0800137#define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
Joel Beckerde551242008-02-01 14:45:08 -0800138#define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
139 call to dlm_lock. Only
140 exists with BUSY set. */
Sunil Mushrana1912822010-01-21 10:50:03 -0800141#define OCFS2_LOCK_UPCONVERT_FINISHING (0x00000800) /* blocks the dc thread
142 * from downconverting
143 * before the upconvert
144 * has completed */
Mark Fashehccd979b2005-12-15 14:31:24 -0800145
146struct ocfs2_lock_res_ops;
147
148typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
149
Sunil Mushran5bc970e2010-12-28 23:26:03 -0800150#ifdef CONFIG_OCFS2_FS_STATS
151struct ocfs2_lock_stats {
152 u64 ls_total; /* Total wait in NSEC */
153 u32 ls_gets; /* Num acquires */
154 u32 ls_fail; /* Num failed acquires */
155
156 /* Storing max wait in usecs saves 24 bytes per inode */
157 u32 ls_max; /* Max wait in USEC */
158};
159#endif
160
Mark Fashehccd979b2005-12-15 14:31:24 -0800161struct ocfs2_lock_res {
162 void *l_priv;
163 struct ocfs2_lock_res_ops *l_ops;
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -0500164
Mark Fashehccd979b2005-12-15 14:31:24 -0800165
166 struct list_head l_blocked_list;
167 struct list_head l_mask_waiters;
168
Mark Fashehccd979b2005-12-15 14:31:24 -0800169 unsigned long l_flags;
170 char l_name[OCFS2_LOCK_ID_MAX_LEN];
Mark Fashehccd979b2005-12-15 14:31:24 -0800171 unsigned int l_ro_holders;
172 unsigned int l_ex_holders;
Milton Millera2a2f552010-11-17 22:20:11 -0600173 signed char l_level;
174 signed char l_requested;
175 signed char l_blocking;
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -0500176
177 /* Data packed - type enum ocfs2_lock_type */
178 unsigned char l_type;
Mark Fashehccd979b2005-12-15 14:31:24 -0800179
180 /* used from AST/BAST funcs. */
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -0500181 /* Data packed - enum type ocfs2_ast_action */
182 unsigned char l_action;
183 /* Data packed - enum type ocfs2_unlock_action */
184 unsigned char l_unlock_action;
Joel Beckerde551242008-02-01 14:45:08 -0800185 unsigned int l_pending_gen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800186
Goldwyn Rodrigues83fd9c72010-06-10 17:21:36 -0500187 spinlock_t l_lock;
188
189 struct ocfs2_dlm_lksb l_lksb;
190
Mark Fashehccd979b2005-12-15 14:31:24 -0800191 wait_queue_head_t l_event;
192
193 struct list_head l_debug_list;
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700194
195#ifdef CONFIG_OCFS2_FS_STATS
Sunil Mushran5bc970e2010-12-28 23:26:03 -0800196 struct ocfs2_lock_stats l_lock_prmode; /* PR mode stats */
197 u32 l_lock_refresh; /* Disk refreshes */
198 struct ocfs2_lock_stats l_lock_exmode; /* EX mode stats */
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700199#endif
Jan Karacb257972009-06-04 15:26:50 +0200200#ifdef CONFIG_DEBUG_LOCK_ALLOC
201 struct lockdep_map l_lockdep_map;
202#endif
Mark Fashehccd979b2005-12-15 14:31:24 -0800203};
204
Sunil Mushran692684e2009-06-19 16:53:17 -0700205enum ocfs2_orphan_scan_state {
206 ORPHAN_SCAN_ACTIVE,
207 ORPHAN_SCAN_INACTIVE
208};
209
Srinivas Eeda83273932009-06-03 17:02:55 -0700210struct ocfs2_orphan_scan {
211 struct mutex os_lock;
212 struct ocfs2_super *os_osb;
213 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
214 struct delayed_work os_orphan_scan_work;
Srinivas Eeda15633a22009-06-03 17:02:56 -0700215 struct timespec os_scantime; /* time this node ran the scan */
216 u32 os_count; /* tracks node specific scans */
217 u32 os_seqno; /* tracks cluster wide scans */
Sunil Mushran692684e2009-06-19 16:53:17 -0700218 atomic_t os_state; /* ACTIVE or INACTIVE */
Srinivas Eeda83273932009-06-03 17:02:55 -0700219};
220
Mark Fashehccd979b2005-12-15 14:31:24 -0800221struct ocfs2_dlm_debug {
222 struct kref d_refcnt;
223 struct dentry *d_locking_state;
224 struct list_head d_lockres_tracking;
225};
226
227enum ocfs2_vol_state
228{
229 VOLUME_INIT = 0,
230 VOLUME_MOUNTED,
Jan Kara19ece542008-08-21 20:13:17 +0200231 VOLUME_MOUNTED_QUOTAS,
Mark Fashehccd979b2005-12-15 14:31:24 -0800232 VOLUME_DISMOUNTED,
233 VOLUME_DISABLED
234};
235
236struct ocfs2_alloc_stats
237{
238 atomic_t moves;
239 atomic_t local_data;
240 atomic_t bitmap_data;
241 atomic_t bg_allocs;
242 atomic_t bg_extends;
243};
244
245enum ocfs2_local_alloc_state
246{
Mark Fasheh9c7af402008-07-28 18:02:53 -0700247 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
248 * this mountpoint. */
249 OCFS2_LA_ENABLED, /* Local alloc is in use. */
250 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
251 * of bits has been reduced. */
252 OCFS2_LA_DISABLED /* Local alloc has temporarily been
253 * disabled. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800254};
255
256enum ocfs2_mount_options
257{
Sunil Mushran2c442712010-10-07 15:23:50 -0700258 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Local heartbeat */
Mark Fashehccd979b2005-12-15 14:31:24 -0800259 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
260 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
261 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
262 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800263 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800264 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
Joel Becker12462f12008-09-03 20:03:40 -0700265 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
Jan Kara5297aad2009-10-15 14:54:04 +0200266 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* Force POSIX access control lists */
267 OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9, /* Disable POSIX access
268 control lists */
269 OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
270 OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
Joel Beckerfc371892010-10-15 13:03:09 -0700271 OCFS2_MOUNT_COHERENCY_BUFFERED = 1 << 12, /* Allow concurrent O_DIRECT
272 writes */
273 OCFS2_MOUNT_HB_NONE = 1 << 13, /* No heartbeat */
274 OCFS2_MOUNT_HB_GLOBAL = 1 << 14, /* Global heartbeat */
Mark Fashehccd979b2005-12-15 14:31:24 -0800275};
276
Jan Karaf7b1aa62009-07-20 12:12:36 +0200277#define OCFS2_OSB_SOFT_RO 0x0001
278#define OCFS2_OSB_HARD_RO 0x0002
279#define OCFS2_OSB_ERROR_FS 0x0004
280#define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED 0x0008
281
282#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800283
284struct ocfs2_journal;
Joel Beckerd85b20e2008-02-01 12:01:05 -0800285struct ocfs2_slot_info;
Joel Becker553abd02008-02-01 12:03:57 -0800286struct ocfs2_recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800287struct ocfs2_replay_map;
Jan Kara22053632008-10-20 23:50:38 +0200288struct ocfs2_quota_recovery;
Jan Karaea455f82009-01-12 23:20:31 +0100289struct ocfs2_dentry_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800290struct ocfs2_super
291{
Mark Fashehccd979b2005-12-15 14:31:24 -0800292 struct task_struct *commit_task;
293 struct super_block *sb;
294 struct inode *root_inode;
295 struct inode *sys_root_inode;
Tao Mab4d693f2010-08-16 16:58:21 +0800296 struct inode *global_system_inodes[NUM_GLOBAL_SYSTEM_INODES];
297 struct inode **local_system_inodes;
Mark Fashehccd979b2005-12-15 14:31:24 -0800298
299 struct ocfs2_slot_info *slot_info;
300
Sunil Mushran539d8262008-07-14 17:31:10 -0700301 u32 *slot_recovery_generations;
302
Mark Fashehccd979b2005-12-15 14:31:24 -0800303 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800304
Mark Fashehccd979b2005-12-15 14:31:24 -0800305 u64 root_blkno;
306 u64 system_dir_blkno;
307 u64 bitmap_blkno;
308 u32 bitmap_cpg;
309 u8 *uuid;
310 char *uuid_str;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800311 u32 uuid_hash;
Mark Fashehccd979b2005-12-15 14:31:24 -0800312 u8 *vol_label;
313 u64 first_cluster_group_blkno;
314 u32 fs_generation;
315
316 u32 s_feature_compat;
317 u32 s_feature_incompat;
318 u32 s_feature_ro_compat;
319
Tao Ma4d0ddb22008-03-05 16:11:46 +0800320 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
321 * Could protect more on osb as it's very short lived.
322 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800323 spinlock_t osb_lock;
324 u32 s_next_generation;
325 unsigned long osb_flags;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800326 s16 s_inode_steal_slot;
Tiger Yangb89c5422010-01-25 14:11:06 +0800327 s16 s_meta_steal_slot;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800328 atomic_t s_num_inodes_stolen;
Tiger Yangb89c5422010-01-25 14:11:06 +0800329 atomic_t s_num_meta_stolen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800330
331 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800332 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800333
Joel Beckerfc881fa2008-02-01 12:04:48 -0800334 unsigned int max_slots;
Joel Becker19fdb622008-01-30 15:38:24 -0800335 unsigned int node_num;
Joel Beckerfc881fa2008-02-01 12:04:48 -0800336 int slot_num;
337 int preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800338 int s_sectsize_bits;
339 int s_clustersize;
340 int s_clustersize_bits;
Tiger Yangfdd77702008-08-18 17:08:55 +0800341 unsigned int s_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800342
343 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800344 struct mutex recovery_lock;
Joel Becker553abd02008-02-01 12:03:57 -0800345 struct ocfs2_recovery_map *recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800346 struct ocfs2_replay_map *replay_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800347 struct task_struct *recovery_thread_task;
348 int disable_recovery;
349 wait_queue_head_t checkpoint_event;
350 atomic_t needs_checkpoint;
351 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800352 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800353
Mark Fasheh9c7af402008-07-28 18:02:53 -0700354 struct delayed_work la_enable_wq;
355
356 /*
357 * Must hold local alloc i_mutex and osb->osb_lock to change
358 * local_alloc_bits. Reads can be done under either lock.
359 */
Mark Fashehebcee4b2008-07-28 14:55:20 -0700360 unsigned int local_alloc_bits;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700361 unsigned int local_alloc_default_bits;
Mark Fasheh6b820212010-04-05 18:17:14 -0700362 /* osb_clusters_at_boot can become stale! Do not trust it to
363 * be up to date. */
364 unsigned int osb_clusters_at_boot;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700365
366 enum ocfs2_local_alloc_state local_alloc_state; /* protected
367 * by osb_lock */
368
Mark Fashehccd979b2005-12-15 14:31:24 -0800369 struct buffer_head *local_alloc_bh;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700370
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400371 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800372
Mark Fashehd02f00c2009-12-07 13:10:48 -0800373 struct ocfs2_reservation_map osb_la_resmap;
374
375 unsigned int osb_resv_level;
Mark Fasheh83f92312010-04-05 18:17:16 -0700376 unsigned int osb_dir_resv_level;
Mark Fashehd02f00c2009-12-07 13:10:48 -0800377
Jan Kara22053632008-10-20 23:50:38 +0200378 /* Next three fields are for local node slot recovery during
Mark Fashehccd979b2005-12-15 14:31:24 -0800379 * mount. */
380 int dirty;
381 struct ocfs2_dinode *local_alloc_copy;
Jan Kara22053632008-10-20 23:50:38 +0200382 struct ocfs2_quota_recovery *quota_rec;
Mark Fashehccd979b2005-12-15 14:31:24 -0800383
Joel Becker73be1922009-01-06 14:57:08 -0800384 struct ocfs2_blockcheck_stats osb_ecc_stats;
Mark Fashehccd979b2005-12-15 14:31:24 -0800385 struct ocfs2_alloc_stats alloc_stats;
386 char dev_str[20]; /* "major,minor" of the device */
387
Sunil Mushran98f486f22010-10-09 10:24:46 -0700388 u8 osb_stackflags;
389
Joel Beckerb61817e2008-02-01 15:08:23 -0800390 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
Joel Becker4670c462008-02-01 14:39:35 -0800391 struct ocfs2_cluster_connection *cconn;
Mark Fashehccd979b2005-12-15 14:31:24 -0800392 struct ocfs2_lock_res osb_super_lockres;
393 struct ocfs2_lock_res osb_rename_lockres;
wengang wang6ca497a2009-03-06 21:29:10 +0800394 struct ocfs2_lock_res osb_nfs_sync_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -0800395 struct ocfs2_dlm_debug *osb_dlm_debug;
396
397 struct dentry *osb_debug_root;
Sunil Mushran50397502008-12-17 14:17:43 -0800398 struct dentry *osb_ctxt;
Mark Fashehccd979b2005-12-15 14:31:24 -0800399
400 wait_queue_head_t recovery_event;
401
Mark Fasheh34d024f2007-09-24 15:56:19 -0700402 spinlock_t dc_task_lock;
403 struct task_struct *dc_task;
404 wait_queue_head_t dc_event;
405 unsigned long dc_wake_sequence;
406 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800407
Mark Fasheh7ec373c2008-01-23 16:54:48 -0800408 /*
409 * Any thread can add locks to the list, but the downconvert
410 * thread is the only one allowed to remove locks. Any change
411 * to this rule requires updating
412 * ocfs2_downconvert_thread_do_work().
413 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800414 struct list_head blocked_lock_list;
415 unsigned long blocked_lock_count;
416
Jan Karaea455f82009-01-12 23:20:31 +0100417 /* List of dentry locks to release. Anyone can add locks to
418 * the list, ocfs2_wq processes the list */
419 struct ocfs2_dentry_lock *dentry_lock_list;
420 struct work_struct dentry_lock_work;
421
Mark Fashehccd979b2005-12-15 14:31:24 -0800422 wait_queue_head_t osb_mount_event;
423
424 /* Truncate log info */
425 struct inode *osb_tl_inode;
426 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000427 struct delayed_work osb_truncate_log_wq;
Tao Ma50308d82010-11-04 15:14:11 +0800428 /*
429 * How many clusters in our truncate log.
430 * It must be protected by osb_tl_inode->i_mutex.
431 */
432 unsigned int truncated_clusters;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800433
434 struct ocfs2_node_map osb_recovering_orphan_dirs;
435 unsigned int *osb_orphan_wipes;
436 wait_queue_head_t osb_wipe_event;
Tao Mac8b9cf92009-02-24 17:40:26 -0800437
Srinivas Eeda83273932009-06-03 17:02:55 -0700438 struct ocfs2_orphan_scan osb_orphan_scan;
439
Tao Mac8b9cf92009-02-24 17:40:26 -0800440 /* used to protect metaecc calculation check of xattr. */
441 spinlock_t osb_xattr_lock;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800442
443 unsigned int osb_dx_mask;
444 u32 osb_dx_seed[4];
Tao Mafeb473a2009-02-25 00:53:25 +0800445
446 /* the group we used to allocate inodes. */
447 u64 osb_inode_alloc_group;
Tao Ma374a2632009-08-24 11:13:37 +0800448
449 /* rb tree root for refcount lock. */
450 struct rb_root osb_rf_lock_tree;
451 struct ocfs2_refcount_tree *osb_ref_tree_lru;
Mark Fashehccd979b2005-12-15 14:31:24 -0800452};
453
454#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800455
Joel Becker13723d02008-10-17 19:25:01 -0700456/* Useful typedef for passing around journal access functions */
Joel Becker0cf2f762009-02-12 16:41:25 -0800457typedef int (*ocfs2_journal_access_func)(handle_t *handle,
458 struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700459 struct buffer_head *bh, int type);
460
Mark Fashehccd979b2005-12-15 14:31:24 -0800461static inline int ocfs2_should_order_data(struct inode *inode)
462{
463 if (!S_ISREG(inode->i_mode))
464 return 0;
465 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
466 return 0;
467 return 1;
468}
469
Mark Fashehdcd05382007-01-16 11:32:23 -0800470static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
471{
472 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
473 return 1;
474 return 0;
475}
476
Mark Fasheh328d5752007-06-18 10:48:04 -0700477static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
478{
479 /*
480 * Support for sparse files is a pre-requisite
481 */
482 if (!ocfs2_sparse_alloc(osb))
483 return 0;
484
485 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
486 return 1;
487 return 0;
488}
489
Mark Fasheh15b1e362007-09-07 13:58:15 -0700490static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
491{
492 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
493 return 1;
494 return 0;
495}
496
Tiger Yang8154da32008-08-18 17:11:46 +0800497static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
498{
499 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
500 return 1;
501 return 0;
502}
503
Joel Becker70ad1ba2008-10-16 17:54:25 -0700504static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
505{
506 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
507 return 1;
508 return 0;
509}
510
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800511static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
512{
513 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
514 return 1;
515 return 0;
516}
517
Tao Ma47119542010-04-22 14:09:15 +0800518static inline int ocfs2_supports_discontig_bg(struct ocfs2_super *osb)
Joel Becker798db352010-04-13 14:26:32 +0800519{
520 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_DISCONTIG_BG)
521 return 1;
522 return 0;
523}
524
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800525static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
526{
527 if (ocfs2_supports_indexed_dirs(osb))
528 return OCFS2_DX_LINK_MAX;
529 return OCFS2_LINK_MAX;
530}
531
532static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
533{
534 u32 nlink = le16_to_cpu(di->i_links_count);
535 u32 hi = le16_to_cpu(di->i_links_count_hi);
536
537 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
538 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
539
540 return nlink;
541}
542
543static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
544{
545 u16 lo, hi;
546
547 lo = nlink;
548 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
549
550 di->i_links_count = cpu_to_le16(lo);
551 di->i_links_count_hi = cpu_to_le16(hi);
552}
553
554static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
555{
556 u32 links = ocfs2_read_links_count(di);
557
558 links += n;
559
560 ocfs2_set_links_count(di, links);
561}
562
Tao Ma1aa75fe2009-08-18 11:28:39 +0800563static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
564{
565 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
566 return 1;
567 return 0;
568}
569
Mark Fashehccd979b2005-12-15 14:31:24 -0800570/* set / clear functions because cluster events can make these happen
571 * in parallel so we want the transitions to be atomic. this also
572 * means that any future flags osb_flags must be protected by spinlock
573 * too! */
574static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
575 unsigned long flag)
576{
577 spin_lock(&osb->osb_lock);
578 osb->osb_flags |= flag;
579 spin_unlock(&osb->osb_lock);
580}
581
Jan Karaf7b1aa62009-07-20 12:12:36 +0200582
583static inline unsigned long ocfs2_test_osb_flag(struct ocfs2_super *osb,
584 unsigned long flag)
585{
586 unsigned long ret;
587
588 spin_lock(&osb->osb_lock);
589 ret = osb->osb_flags & flag;
590 spin_unlock(&osb->osb_lock);
591 return ret;
592}
593
Mark Fashehccd979b2005-12-15 14:31:24 -0800594static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
595 int hard)
596{
597 spin_lock(&osb->osb_lock);
598 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
599 if (hard)
600 osb->osb_flags |= OCFS2_OSB_HARD_RO;
601 else
602 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
603 spin_unlock(&osb->osb_lock);
604}
605
606static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
607{
608 int ret;
609
610 spin_lock(&osb->osb_lock);
611 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
612 spin_unlock(&osb->osb_lock);
613
614 return ret;
615}
616
617static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
618{
619 int ret;
620
621 spin_lock(&osb->osb_lock);
622 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
623 spin_unlock(&osb->osb_lock);
624
625 return ret;
626}
627
Sunil Mushran98f486f22010-10-09 10:24:46 -0700628static inline int ocfs2_clusterinfo_valid(struct ocfs2_super *osb)
Joel Beckerb61817e2008-02-01 15:08:23 -0800629{
630 return (osb->s_feature_incompat &
Sunil Mushran98f486f22010-10-09 10:24:46 -0700631 (OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK |
632 OCFS2_FEATURE_INCOMPAT_CLUSTERINFO));
633}
634
635static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
636{
637 if (ocfs2_clusterinfo_valid(osb) &&
638 memcmp(osb->osb_cluster_stack, OCFS2_CLASSIC_CLUSTER_STACK,
639 OCFS2_STACK_LABEL_LEN))
640 return 1;
641 return 0;
642}
643
644static inline int ocfs2_o2cb_stack(struct ocfs2_super *osb)
645{
646 if (ocfs2_clusterinfo_valid(osb) &&
647 !memcmp(osb->osb_cluster_stack, OCFS2_CLASSIC_CLUSTER_STACK,
648 OCFS2_STACK_LABEL_LEN))
649 return 1;
650 return 0;
651}
652
653static inline int ocfs2_cluster_o2cb_global_heartbeat(struct ocfs2_super *osb)
654{
655 return ocfs2_o2cb_stack(osb) &&
656 (osb->osb_stackflags & OCFS2_CLUSTER_O2CB_GLOBAL_HEARTBEAT);
Joel Beckerb61817e2008-02-01 15:08:23 -0800657}
658
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800659static inline int ocfs2_mount_local(struct ocfs2_super *osb)
660{
661 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
662}
663
Joel Becker386a2ef2008-02-01 12:06:54 -0800664static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
665{
666 return (osb->s_feature_incompat &
667 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
668}
669
670
Mark Fashehccd979b2005-12-15 14:31:24 -0800671#define OCFS2_IS_VALID_DINODE(ptr) \
672 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
673
Mark Fashehccd979b2005-12-15 14:31:24 -0800674#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
675 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
676
Mark Fashehccd979b2005-12-15 14:31:24 -0800677#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
678 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
679
Mark Fashehccd979b2005-12-15 14:31:24 -0800680
Joel Beckerf6087fb2008-10-20 18:20:43 -0700681#define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
682 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
683
Mark Fasheh87d35a72008-12-10 17:36:25 -0800684#define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
685 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
686
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800687#define OCFS2_IS_VALID_DX_ROOT(ptr) \
688 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
689
690#define OCFS2_IS_VALID_DX_LEAF(ptr) \
691 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
692
Tao Maf2c870e2009-08-18 11:19:26 +0800693#define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr) \
694 (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
695
Mark Fashehccd979b2005-12-15 14:31:24 -0800696static inline unsigned long ino_from_blkno(struct super_block *sb,
697 u64 blkno)
698{
699 return (unsigned long)(blkno & (u64)ULONG_MAX);
700}
701
702static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
703 u32 clusters)
704{
705 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
706 sb->s_blocksize_bits;
707
708 return (u64)clusters << c_to_b_bits;
709}
710
711static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
712 u64 blocks)
713{
714 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
715 sb->s_blocksize_bits;
716
717 return (u32)(blocks >> b_to_c_bits);
718}
719
720static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
721 u64 bytes)
722{
723 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
724 unsigned int clusters;
725
726 bytes += OCFS2_SB(sb)->s_clustersize - 1;
727 /* OCFS2 just cannot have enough clusters to overflow this */
728 clusters = (unsigned int)(bytes >> cl_bits);
729
730 return clusters;
731}
732
733static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
734 u64 bytes)
735{
736 bytes += sb->s_blocksize - 1;
737 return bytes >> sb->s_blocksize_bits;
738}
739
740static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
741 u32 clusters)
742{
743 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
744}
745
Mark Fasheh1d46dc02009-02-19 13:17:05 -0800746static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
747 u64 blocks)
748{
749 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
750 unsigned int clusters;
751
752 clusters = ocfs2_blocks_to_clusters(sb, blocks);
753 return (u64)clusters << bits;
754}
755
Mark Fashehccd979b2005-12-15 14:31:24 -0800756static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
757 u64 bytes)
758{
759 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
760 unsigned int clusters;
761
762 clusters = ocfs2_clusters_for_bytes(sb, bytes);
763 return (u64)clusters << cl_bits;
764}
765
766static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
767 u64 bytes)
768{
769 u64 blocks;
770
771 blocks = ocfs2_blocks_for_bytes(sb, bytes);
772 return blocks << sb->s_blocksize_bits;
773}
774
775static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
776{
777 return (unsigned long)((bytes + 511) >> 9);
778}
779
Mark Fasheh9517bac2007-02-09 20:24:12 -0800780static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
781 unsigned long pg_index)
782{
783 u32 clusters = pg_index;
784 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
785
786 if (unlikely(PAGE_CACHE_SHIFT > cbits))
787 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
788 else if (PAGE_CACHE_SHIFT < cbits)
789 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
790
791 return clusters;
792}
793
794/*
795 * Find the 1st page index which covers the given clusters.
796 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700797static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800798 u32 clusters)
799{
800 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700801 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800802
803 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700804 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800805 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700806 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800807 }
808
809 return index;
810}
811
Mark Fasheh60b11392007-02-16 11:46:50 -0800812static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
813{
814 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
815 unsigned int pages_per_cluster = 1;
816
817 if (PAGE_CACHE_SHIFT < cbits)
818 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
819
820 return pages_per_cluster;
821}
822
Mark Fashehebcee4b2008-07-28 14:55:20 -0700823static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
824 unsigned int megs)
825{
826 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
827
828 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
829}
830
Mark Fasheh73c8a802010-04-05 18:17:13 -0700831static inline unsigned int ocfs2_clusters_to_megabytes(struct super_block *sb,
832 unsigned int clusters)
833{
834 return clusters >> (20 - OCFS2_SB(sb)->s_clustersize_bits);
835}
836
Mark Fashehb4414ee2010-03-11 18:31:09 -0800837static inline void _ocfs2_set_bit(unsigned int bit, unsigned long *bitmap)
838{
Akinobu Mitac4354d02011-03-23 16:42:08 -0700839 __test_and_set_bit_le(bit, bitmap);
Mark Fashehb4414ee2010-03-11 18:31:09 -0800840}
841#define ocfs2_set_bit(bit, addr) _ocfs2_set_bit((bit), (unsigned long *)(addr))
842
843static inline void _ocfs2_clear_bit(unsigned int bit, unsigned long *bitmap)
844{
Akinobu Mitac4354d02011-03-23 16:42:08 -0700845 __test_and_clear_bit_le(bit, bitmap);
Mark Fashehb4414ee2010-03-11 18:31:09 -0800846}
847#define ocfs2_clear_bit(bit, addr) _ocfs2_clear_bit((bit), (unsigned long *)(addr))
848
Akinobu Mitac4354d02011-03-23 16:42:08 -0700849#define ocfs2_test_bit test_bit_le
850#define ocfs2_find_next_zero_bit find_next_zero_bit_le
851#define ocfs2_find_next_bit find_next_bit_le
Mark Fashehccd979b2005-12-15 14:31:24 -0800852#endif /* OCFS2_H */
853