blob: c67003b6b5a257d9e914ff1088d132425d8a2cba [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
150struct ocfs2_lock_res {
151 void *l_priv;
152 struct ocfs2_lock_res_ops *l_ops;
153 spinlock_t l_lock;
154
155 struct list_head l_blocked_list;
156 struct list_head l_mask_waiters;
157
158 enum ocfs2_lock_type l_type;
159 unsigned long l_flags;
160 char l_name[OCFS2_LOCK_ID_MAX_LEN];
161 int l_level;
162 unsigned int l_ro_holders;
163 unsigned int l_ex_holders;
Joel Beckerc0e41332010-01-29 14:46:44 -0800164 struct ocfs2_dlm_lksb l_lksb;
Mark Fashehccd979b2005-12-15 14:31:24 -0800165
166 /* used from AST/BAST funcs. */
167 enum ocfs2_ast_action l_action;
168 enum ocfs2_unlock_action l_unlock_action;
169 int l_requested;
170 int l_blocking;
Joel Beckerde551242008-02-01 14:45:08 -0800171 unsigned int l_pending_gen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800172
173 wait_queue_head_t l_event;
174
175 struct list_head l_debug_list;
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700176
177#ifdef CONFIG_OCFS2_FS_STATS
178 unsigned long long l_lock_num_prmode; /* PR acquires */
179 unsigned long long l_lock_num_exmode; /* EX acquires */
180 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
181 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
182 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
183 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
184 unsigned int l_lock_max_prmode; /* Max wait for PR */
185 unsigned int l_lock_max_exmode; /* Max wait for EX */
186 unsigned int l_lock_refresh; /* Disk refreshes */
187#endif
Jan Karacb257972009-06-04 15:26:50 +0200188#ifdef CONFIG_DEBUG_LOCK_ALLOC
189 struct lockdep_map l_lockdep_map;
190#endif
Mark Fashehccd979b2005-12-15 14:31:24 -0800191};
192
Sunil Mushran692684e2009-06-19 16:53:17 -0700193enum ocfs2_orphan_scan_state {
194 ORPHAN_SCAN_ACTIVE,
195 ORPHAN_SCAN_INACTIVE
196};
197
Srinivas Eeda83273932009-06-03 17:02:55 -0700198struct ocfs2_orphan_scan {
199 struct mutex os_lock;
200 struct ocfs2_super *os_osb;
201 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
202 struct delayed_work os_orphan_scan_work;
Srinivas Eeda15633a22009-06-03 17:02:56 -0700203 struct timespec os_scantime; /* time this node ran the scan */
204 u32 os_count; /* tracks node specific scans */
205 u32 os_seqno; /* tracks cluster wide scans */
Sunil Mushran692684e2009-06-19 16:53:17 -0700206 atomic_t os_state; /* ACTIVE or INACTIVE */
Srinivas Eeda83273932009-06-03 17:02:55 -0700207};
208
Mark Fashehccd979b2005-12-15 14:31:24 -0800209struct ocfs2_dlm_debug {
210 struct kref d_refcnt;
211 struct dentry *d_locking_state;
212 struct list_head d_lockres_tracking;
213};
214
215enum ocfs2_vol_state
216{
217 VOLUME_INIT = 0,
218 VOLUME_MOUNTED,
Jan Kara19ece542008-08-21 20:13:17 +0200219 VOLUME_MOUNTED_QUOTAS,
Mark Fashehccd979b2005-12-15 14:31:24 -0800220 VOLUME_DISMOUNTED,
221 VOLUME_DISABLED
222};
223
224struct ocfs2_alloc_stats
225{
226 atomic_t moves;
227 atomic_t local_data;
228 atomic_t bitmap_data;
229 atomic_t bg_allocs;
230 atomic_t bg_extends;
231};
232
233enum ocfs2_local_alloc_state
234{
Mark Fasheh9c7af402008-07-28 18:02:53 -0700235 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
236 * this mountpoint. */
237 OCFS2_LA_ENABLED, /* Local alloc is in use. */
238 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
239 * of bits has been reduced. */
240 OCFS2_LA_DISABLED /* Local alloc has temporarily been
241 * disabled. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800242};
243
244enum ocfs2_mount_options
245{
246 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
247 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
248 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
249 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
250 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800251 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800252 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
Joel Becker12462f12008-09-03 20:03:40 -0700253 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
Jan Kara5297aad2009-10-15 14:54:04 +0200254 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* Force POSIX access control lists */
255 OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9, /* Disable POSIX access
256 control lists */
257 OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
258 OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
Mark Fashehccd979b2005-12-15 14:31:24 -0800259};
260
Jan Karaf7b1aa62009-07-20 12:12:36 +0200261#define OCFS2_OSB_SOFT_RO 0x0001
262#define OCFS2_OSB_HARD_RO 0x0002
263#define OCFS2_OSB_ERROR_FS 0x0004
264#define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED 0x0008
265
266#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800267
268struct ocfs2_journal;
Joel Beckerd85b20e2008-02-01 12:01:05 -0800269struct ocfs2_slot_info;
Joel Becker553abd02008-02-01 12:03:57 -0800270struct ocfs2_recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800271struct ocfs2_replay_map;
Jan Kara22053632008-10-20 23:50:38 +0200272struct ocfs2_quota_recovery;
Jan Karaea455f82009-01-12 23:20:31 +0100273struct ocfs2_dentry_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800274struct ocfs2_super
275{
Mark Fashehccd979b2005-12-15 14:31:24 -0800276 struct task_struct *commit_task;
277 struct super_block *sb;
278 struct inode *root_inode;
279 struct inode *sys_root_inode;
280 struct inode *system_inodes[NUM_SYSTEM_INODES];
281
282 struct ocfs2_slot_info *slot_info;
283
Sunil Mushran539d8262008-07-14 17:31:10 -0700284 u32 *slot_recovery_generations;
285
Mark Fashehccd979b2005-12-15 14:31:24 -0800286 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800287
Mark Fashehccd979b2005-12-15 14:31:24 -0800288 u64 root_blkno;
289 u64 system_dir_blkno;
290 u64 bitmap_blkno;
291 u32 bitmap_cpg;
292 u8 *uuid;
293 char *uuid_str;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800294 u32 uuid_hash;
Mark Fashehccd979b2005-12-15 14:31:24 -0800295 u8 *vol_label;
296 u64 first_cluster_group_blkno;
297 u32 fs_generation;
298
299 u32 s_feature_compat;
300 u32 s_feature_incompat;
301 u32 s_feature_ro_compat;
302
Tao Ma4d0ddb22008-03-05 16:11:46 +0800303 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
304 * Could protect more on osb as it's very short lived.
305 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800306 spinlock_t osb_lock;
307 u32 s_next_generation;
308 unsigned long osb_flags;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800309 s16 s_inode_steal_slot;
Tiger Yangb89c5422010-01-25 14:11:06 +0800310 s16 s_meta_steal_slot;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800311 atomic_t s_num_inodes_stolen;
Tiger Yangb89c5422010-01-25 14:11:06 +0800312 atomic_t s_num_meta_stolen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800313
314 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800315 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800316
Joel Beckerfc881fa2008-02-01 12:04:48 -0800317 unsigned int max_slots;
Joel Becker19fdb622008-01-30 15:38:24 -0800318 unsigned int node_num;
Joel Beckerfc881fa2008-02-01 12:04:48 -0800319 int slot_num;
320 int preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800321 int s_sectsize_bits;
322 int s_clustersize;
323 int s_clustersize_bits;
Tiger Yangfdd77702008-08-18 17:08:55 +0800324 unsigned int s_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800325
326 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800327 struct mutex recovery_lock;
Joel Becker553abd02008-02-01 12:03:57 -0800328 struct ocfs2_recovery_map *recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800329 struct ocfs2_replay_map *replay_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800330 struct task_struct *recovery_thread_task;
331 int disable_recovery;
332 wait_queue_head_t checkpoint_event;
333 atomic_t needs_checkpoint;
334 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800335 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800336
Mark Fasheh9c7af402008-07-28 18:02:53 -0700337 struct delayed_work la_enable_wq;
338
339 /*
340 * Must hold local alloc i_mutex and osb->osb_lock to change
341 * local_alloc_bits. Reads can be done under either lock.
342 */
Mark Fashehebcee4b2008-07-28 14:55:20 -0700343 unsigned int local_alloc_bits;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700344 unsigned int local_alloc_default_bits;
Mark Fasheh6b820212010-04-05 18:17:14 -0700345 /* osb_clusters_at_boot can become stale! Do not trust it to
346 * be up to date. */
347 unsigned int osb_clusters_at_boot;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700348
349 enum ocfs2_local_alloc_state local_alloc_state; /* protected
350 * by osb_lock */
351
Mark Fashehccd979b2005-12-15 14:31:24 -0800352 struct buffer_head *local_alloc_bh;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700353
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400354 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800355
Mark Fashehd02f00c2009-12-07 13:10:48 -0800356 struct ocfs2_reservation_map osb_la_resmap;
357
358 unsigned int osb_resv_level;
Mark Fasheh83f92312010-04-05 18:17:16 -0700359 unsigned int osb_dir_resv_level;
Mark Fashehd02f00c2009-12-07 13:10:48 -0800360
Jan Kara22053632008-10-20 23:50:38 +0200361 /* Next three fields are for local node slot recovery during
Mark Fashehccd979b2005-12-15 14:31:24 -0800362 * mount. */
363 int dirty;
364 struct ocfs2_dinode *local_alloc_copy;
Jan Kara22053632008-10-20 23:50:38 +0200365 struct ocfs2_quota_recovery *quota_rec;
Mark Fashehccd979b2005-12-15 14:31:24 -0800366
Joel Becker73be1922009-01-06 14:57:08 -0800367 struct ocfs2_blockcheck_stats osb_ecc_stats;
Mark Fashehccd979b2005-12-15 14:31:24 -0800368 struct ocfs2_alloc_stats alloc_stats;
369 char dev_str[20]; /* "major,minor" of the device */
370
Joel Beckerb61817e2008-02-01 15:08:23 -0800371 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
Joel Becker4670c462008-02-01 14:39:35 -0800372 struct ocfs2_cluster_connection *cconn;
Mark Fashehccd979b2005-12-15 14:31:24 -0800373 struct ocfs2_lock_res osb_super_lockres;
374 struct ocfs2_lock_res osb_rename_lockres;
wengang wang6ca497a2009-03-06 21:29:10 +0800375 struct ocfs2_lock_res osb_nfs_sync_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -0800376 struct ocfs2_dlm_debug *osb_dlm_debug;
377
378 struct dentry *osb_debug_root;
Sunil Mushran50397502008-12-17 14:17:43 -0800379 struct dentry *osb_ctxt;
Mark Fashehccd979b2005-12-15 14:31:24 -0800380
381 wait_queue_head_t recovery_event;
382
Mark Fasheh34d024f2007-09-24 15:56:19 -0700383 spinlock_t dc_task_lock;
384 struct task_struct *dc_task;
385 wait_queue_head_t dc_event;
386 unsigned long dc_wake_sequence;
387 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800388
Mark Fasheh7ec373c2008-01-23 16:54:48 -0800389 /*
390 * Any thread can add locks to the list, but the downconvert
391 * thread is the only one allowed to remove locks. Any change
392 * to this rule requires updating
393 * ocfs2_downconvert_thread_do_work().
394 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800395 struct list_head blocked_lock_list;
396 unsigned long blocked_lock_count;
397
Jan Karaea455f82009-01-12 23:20:31 +0100398 /* List of dentry locks to release. Anyone can add locks to
399 * the list, ocfs2_wq processes the list */
400 struct ocfs2_dentry_lock *dentry_lock_list;
401 struct work_struct dentry_lock_work;
402
Mark Fashehccd979b2005-12-15 14:31:24 -0800403 wait_queue_head_t osb_mount_event;
404
405 /* Truncate log info */
406 struct inode *osb_tl_inode;
407 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000408 struct delayed_work osb_truncate_log_wq;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800409
410 struct ocfs2_node_map osb_recovering_orphan_dirs;
411 unsigned int *osb_orphan_wipes;
412 wait_queue_head_t osb_wipe_event;
Tao Mac8b9cf92009-02-24 17:40:26 -0800413
Srinivas Eeda83273932009-06-03 17:02:55 -0700414 struct ocfs2_orphan_scan osb_orphan_scan;
415
Tao Mac8b9cf92009-02-24 17:40:26 -0800416 /* used to protect metaecc calculation check of xattr. */
417 spinlock_t osb_xattr_lock;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800418
419 unsigned int osb_dx_mask;
420 u32 osb_dx_seed[4];
Tao Mafeb473a2009-02-25 00:53:25 +0800421
422 /* the group we used to allocate inodes. */
423 u64 osb_inode_alloc_group;
Tao Ma374a2632009-08-24 11:13:37 +0800424
425 /* rb tree root for refcount lock. */
426 struct rb_root osb_rf_lock_tree;
427 struct ocfs2_refcount_tree *osb_ref_tree_lru;
Mark Fashehccd979b2005-12-15 14:31:24 -0800428};
429
430#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800431
Joel Becker13723d02008-10-17 19:25:01 -0700432/* Useful typedef for passing around journal access functions */
Joel Becker0cf2f762009-02-12 16:41:25 -0800433typedef int (*ocfs2_journal_access_func)(handle_t *handle,
434 struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700435 struct buffer_head *bh, int type);
436
Mark Fashehccd979b2005-12-15 14:31:24 -0800437static inline int ocfs2_should_order_data(struct inode *inode)
438{
439 if (!S_ISREG(inode->i_mode))
440 return 0;
441 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
442 return 0;
443 return 1;
444}
445
Mark Fashehdcd05382007-01-16 11:32:23 -0800446static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
447{
448 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
449 return 1;
450 return 0;
451}
452
Mark Fasheh328d5752007-06-18 10:48:04 -0700453static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
454{
455 /*
456 * Support for sparse files is a pre-requisite
457 */
458 if (!ocfs2_sparse_alloc(osb))
459 return 0;
460
461 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
462 return 1;
463 return 0;
464}
465
Mark Fasheh15b1e362007-09-07 13:58:15 -0700466static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
467{
468 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
469 return 1;
470 return 0;
471}
472
Tiger Yang8154da32008-08-18 17:11:46 +0800473static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
474{
475 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
476 return 1;
477 return 0;
478}
479
Joel Becker70ad1ba2008-10-16 17:54:25 -0700480static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
481{
482 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
483 return 1;
484 return 0;
485}
486
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800487static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
488{
489 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
490 return 1;
491 return 0;
492}
493
Tao Ma47119542010-04-22 14:09:15 +0800494static inline int ocfs2_supports_discontig_bg(struct ocfs2_super *osb)
Joel Becker798db352010-04-13 14:26:32 +0800495{
496 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_DISCONTIG_BG)
497 return 1;
498 return 0;
499}
500
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800501static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
502{
503 if (ocfs2_supports_indexed_dirs(osb))
504 return OCFS2_DX_LINK_MAX;
505 return OCFS2_LINK_MAX;
506}
507
508static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
509{
510 u32 nlink = le16_to_cpu(di->i_links_count);
511 u32 hi = le16_to_cpu(di->i_links_count_hi);
512
513 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
514 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
515
516 return nlink;
517}
518
519static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
520{
521 u16 lo, hi;
522
523 lo = nlink;
524 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
525
526 di->i_links_count = cpu_to_le16(lo);
527 di->i_links_count_hi = cpu_to_le16(hi);
528}
529
530static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
531{
532 u32 links = ocfs2_read_links_count(di);
533
534 links += n;
535
536 ocfs2_set_links_count(di, links);
537}
538
Tao Ma1aa75fe2009-08-18 11:28:39 +0800539static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
540{
541 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
542 return 1;
543 return 0;
544}
545
Mark Fashehccd979b2005-12-15 14:31:24 -0800546/* set / clear functions because cluster events can make these happen
547 * in parallel so we want the transitions to be atomic. this also
548 * means that any future flags osb_flags must be protected by spinlock
549 * too! */
550static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
551 unsigned long flag)
552{
553 spin_lock(&osb->osb_lock);
554 osb->osb_flags |= flag;
555 spin_unlock(&osb->osb_lock);
556}
557
Jan Karaf7b1aa62009-07-20 12:12:36 +0200558
559static inline unsigned long ocfs2_test_osb_flag(struct ocfs2_super *osb,
560 unsigned long flag)
561{
562 unsigned long ret;
563
564 spin_lock(&osb->osb_lock);
565 ret = osb->osb_flags & flag;
566 spin_unlock(&osb->osb_lock);
567 return ret;
568}
569
Mark Fashehccd979b2005-12-15 14:31:24 -0800570static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
571 int hard)
572{
573 spin_lock(&osb->osb_lock);
574 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
575 if (hard)
576 osb->osb_flags |= OCFS2_OSB_HARD_RO;
577 else
578 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
579 spin_unlock(&osb->osb_lock);
580}
581
582static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
583{
584 int ret;
585
586 spin_lock(&osb->osb_lock);
587 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
588 spin_unlock(&osb->osb_lock);
589
590 return ret;
591}
592
593static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
594{
595 int ret;
596
597 spin_lock(&osb->osb_lock);
598 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
599 spin_unlock(&osb->osb_lock);
600
601 return ret;
602}
603
Joel Beckerb61817e2008-02-01 15:08:23 -0800604static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
605{
606 return (osb->s_feature_incompat &
607 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
608}
609
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800610static inline int ocfs2_mount_local(struct ocfs2_super *osb)
611{
612 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
613}
614
Joel Becker386a2ef2008-02-01 12:06:54 -0800615static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
616{
617 return (osb->s_feature_incompat &
618 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
619}
620
621
Mark Fashehccd979b2005-12-15 14:31:24 -0800622#define OCFS2_IS_VALID_DINODE(ptr) \
623 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
624
Mark Fashehccd979b2005-12-15 14:31:24 -0800625#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
626 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
627
Mark Fashehccd979b2005-12-15 14:31:24 -0800628#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
629 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
630
Mark Fashehccd979b2005-12-15 14:31:24 -0800631
Joel Beckerf6087fb2008-10-20 18:20:43 -0700632#define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
633 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
634
Mark Fasheh87d35a72008-12-10 17:36:25 -0800635#define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
636 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
637
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800638#define OCFS2_IS_VALID_DX_ROOT(ptr) \
639 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
640
641#define OCFS2_IS_VALID_DX_LEAF(ptr) \
642 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
643
Tao Maf2c870e2009-08-18 11:19:26 +0800644#define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr) \
645 (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
646
Mark Fashehccd979b2005-12-15 14:31:24 -0800647static inline unsigned long ino_from_blkno(struct super_block *sb,
648 u64 blkno)
649{
650 return (unsigned long)(blkno & (u64)ULONG_MAX);
651}
652
653static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
654 u32 clusters)
655{
656 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
657 sb->s_blocksize_bits;
658
659 return (u64)clusters << c_to_b_bits;
660}
661
662static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
663 u64 blocks)
664{
665 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
666 sb->s_blocksize_bits;
667
668 return (u32)(blocks >> b_to_c_bits);
669}
670
671static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
672 u64 bytes)
673{
674 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
675 unsigned int clusters;
676
677 bytes += OCFS2_SB(sb)->s_clustersize - 1;
678 /* OCFS2 just cannot have enough clusters to overflow this */
679 clusters = (unsigned int)(bytes >> cl_bits);
680
681 return clusters;
682}
683
684static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
685 u64 bytes)
686{
687 bytes += sb->s_blocksize - 1;
688 return bytes >> sb->s_blocksize_bits;
689}
690
691static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
692 u32 clusters)
693{
694 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
695}
696
Mark Fasheh1d46dc02009-02-19 13:17:05 -0800697static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
698 u64 blocks)
699{
700 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
701 unsigned int clusters;
702
703 clusters = ocfs2_blocks_to_clusters(sb, blocks);
704 return (u64)clusters << bits;
705}
706
Mark Fashehccd979b2005-12-15 14:31:24 -0800707static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
708 u64 bytes)
709{
710 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
711 unsigned int clusters;
712
713 clusters = ocfs2_clusters_for_bytes(sb, bytes);
714 return (u64)clusters << cl_bits;
715}
716
717static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
718 u64 bytes)
719{
720 u64 blocks;
721
722 blocks = ocfs2_blocks_for_bytes(sb, bytes);
723 return blocks << sb->s_blocksize_bits;
724}
725
726static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
727{
728 return (unsigned long)((bytes + 511) >> 9);
729}
730
Mark Fasheh9517bac2007-02-09 20:24:12 -0800731static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
732 unsigned long pg_index)
733{
734 u32 clusters = pg_index;
735 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
736
737 if (unlikely(PAGE_CACHE_SHIFT > cbits))
738 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
739 else if (PAGE_CACHE_SHIFT < cbits)
740 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
741
742 return clusters;
743}
744
745/*
746 * Find the 1st page index which covers the given clusters.
747 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700748static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800749 u32 clusters)
750{
751 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700752 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800753
754 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700755 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800756 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700757 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800758 }
759
760 return index;
761}
762
Mark Fasheh60b11392007-02-16 11:46:50 -0800763static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
764{
765 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
766 unsigned int pages_per_cluster = 1;
767
768 if (PAGE_CACHE_SHIFT < cbits)
769 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
770
771 return pages_per_cluster;
772}
773
Mark Fashehebcee4b2008-07-28 14:55:20 -0700774static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
775 unsigned int megs)
776{
777 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
778
779 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
780}
781
Mark Fasheh73c8a802010-04-05 18:17:13 -0700782static inline unsigned int ocfs2_clusters_to_megabytes(struct super_block *sb,
783 unsigned int clusters)
784{
785 return clusters >> (20 - OCFS2_SB(sb)->s_clustersize_bits);
786}
787
Mark Fashehb4414ee2010-03-11 18:31:09 -0800788static inline void _ocfs2_set_bit(unsigned int bit, unsigned long *bitmap)
789{
790 ext2_set_bit(bit, bitmap);
791}
792#define ocfs2_set_bit(bit, addr) _ocfs2_set_bit((bit), (unsigned long *)(addr))
793
794static inline void _ocfs2_clear_bit(unsigned int bit, unsigned long *bitmap)
795{
796 ext2_clear_bit(bit, bitmap);
797}
798#define ocfs2_clear_bit(bit, addr) _ocfs2_clear_bit((bit), (unsigned long *)(addr))
799
Mark Fashehccd979b2005-12-15 14:31:24 -0800800#define ocfs2_test_bit ext2_test_bit
801#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
Joel Becker70ad1ba2008-10-16 17:54:25 -0700802#define ocfs2_find_next_bit ext2_find_next_bit
Mark Fashehccd979b2005-12-15 14:31:24 -0800803#endif /* OCFS2_H */
804