blob: b27fe2489e0c722bce174c704bd2b1df7d32e6b0 [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"
45
Joel Becker73be1922009-01-06 14:57:08 -080046/* For struct ocfs2_blockcheck_stats */
47#include "blockcheck.h"
48
Joel Becker47460d62009-02-10 16:05:07 -080049
50/* Caching of metadata buffers */
51
Mark Fashehccd979b2005-12-15 14:31:24 -080052/* Most user visible OCFS2 inodes will have very few pieces of
53 * metadata, but larger files (including bitmaps, etc) must be taken
54 * into account when designing an access scheme. We allow a small
55 * amount of inlined blocks to be stored on an array and grow the
56 * structure into a rb tree when necessary. */
Joel Becker47460d62009-02-10 16:05:07 -080057#define OCFS2_CACHE_INFO_MAX_ARRAY 2
58
59/* Flags for ocfs2_caching_info */
60
61enum ocfs2_caching_info_flags {
62 /* Indicates that the metadata cache is using the inline array */
63 OCFS2_CACHE_FL_INLINE = 1<<1,
64};
Mark Fashehccd979b2005-12-15 14:31:24 -080065
Joel Becker6e5a3d72009-02-10 19:00:37 -080066struct ocfs2_caching_operations;
Mark Fashehccd979b2005-12-15 14:31:24 -080067struct ocfs2_caching_info {
Joel Becker47460d62009-02-10 16:05:07 -080068 /*
69 * The parent structure provides the locks, but because the
Joel Becker6e5a3d72009-02-10 19:00:37 -080070 * parent structure can differ, it provides locking operations
71 * to struct ocfs2_caching_info.
Joel Becker47460d62009-02-10 16:05:07 -080072 */
Joel Becker6e5a3d72009-02-10 19:00:37 -080073 const struct ocfs2_caching_operations *ci_ops;
Joel Becker47460d62009-02-10 16:05:07 -080074
Joel Becker292dd272009-02-12 15:41:59 -080075 /* next two are protected by trans_inc_lock */
76 /* which transaction were we created on? Zero if none. */
77 unsigned long ci_created_trans;
Joel Becker66fb3452009-02-12 15:24:40 -080078 /* last transaction we were a part of. */
79 unsigned long ci_last_trans;
80
81 /* Cache structures */
Joel Becker47460d62009-02-10 16:05:07 -080082 unsigned int ci_flags;
Mark Fashehccd979b2005-12-15 14:31:24 -080083 unsigned int ci_num_cached;
84 union {
Joel Becker47460d62009-02-10 16:05:07 -080085 sector_t ci_array[OCFS2_CACHE_INFO_MAX_ARRAY];
Mark Fashehccd979b2005-12-15 14:31:24 -080086 struct rb_root ci_tree;
87 } ci_cache;
88};
Joel Becker0cf2f762009-02-12 16:41:25 -080089/*
90 * Need this prototype here instead of in uptodate.h because journal.h
91 * uses it.
92 */
93struct super_block *ocfs2_metadata_cache_get_super(struct ocfs2_caching_info *ci);
Mark Fashehccd979b2005-12-15 14:31:24 -080094
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. */
Sunil Mushrana1912822010-01-21 10:50:03 -0800139#define OCFS2_LOCK_UPCONVERT_FINISHING (0x00000800) /* blocks the dc thread
140 * from downconverting
141 * before the upconvert
142 * has completed */
Mark Fashehccd979b2005-12-15 14:31:24 -0800143
144struct ocfs2_lock_res_ops;
145
146typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
147
148struct ocfs2_lock_res {
149 void *l_priv;
150 struct ocfs2_lock_res_ops *l_ops;
151 spinlock_t l_lock;
152
153 struct list_head l_blocked_list;
154 struct list_head l_mask_waiters;
155
156 enum ocfs2_lock_type l_type;
157 unsigned long l_flags;
158 char l_name[OCFS2_LOCK_ID_MAX_LEN];
159 int l_level;
160 unsigned int l_ro_holders;
161 unsigned int l_ex_holders;
Joel Beckerc0e41332010-01-29 14:46:44 -0800162 struct ocfs2_dlm_lksb l_lksb;
Mark Fashehccd979b2005-12-15 14:31:24 -0800163
164 /* used from AST/BAST funcs. */
165 enum ocfs2_ast_action l_action;
166 enum ocfs2_unlock_action l_unlock_action;
167 int l_requested;
168 int l_blocking;
Joel Beckerde551242008-02-01 14:45:08 -0800169 unsigned int l_pending_gen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800170
171 wait_queue_head_t l_event;
172
173 struct list_head l_debug_list;
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700174
175#ifdef CONFIG_OCFS2_FS_STATS
176 unsigned long long l_lock_num_prmode; /* PR acquires */
177 unsigned long long l_lock_num_exmode; /* EX acquires */
178 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
179 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
180 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
181 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
182 unsigned int l_lock_max_prmode; /* Max wait for PR */
183 unsigned int l_lock_max_exmode; /* Max wait for EX */
184 unsigned int l_lock_refresh; /* Disk refreshes */
185#endif
Jan Karacb257972009-06-04 15:26:50 +0200186#ifdef CONFIG_DEBUG_LOCK_ALLOC
187 struct lockdep_map l_lockdep_map;
188#endif
Mark Fashehccd979b2005-12-15 14:31:24 -0800189};
190
Sunil Mushran692684e2009-06-19 16:53:17 -0700191enum ocfs2_orphan_scan_state {
192 ORPHAN_SCAN_ACTIVE,
193 ORPHAN_SCAN_INACTIVE
194};
195
Srinivas Eeda83273932009-06-03 17:02:55 -0700196struct ocfs2_orphan_scan {
197 struct mutex os_lock;
198 struct ocfs2_super *os_osb;
199 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
200 struct delayed_work os_orphan_scan_work;
Srinivas Eeda15633a22009-06-03 17:02:56 -0700201 struct timespec os_scantime; /* time this node ran the scan */
202 u32 os_count; /* tracks node specific scans */
203 u32 os_seqno; /* tracks cluster wide scans */
Sunil Mushran692684e2009-06-19 16:53:17 -0700204 atomic_t os_state; /* ACTIVE or INACTIVE */
Srinivas Eeda83273932009-06-03 17:02:55 -0700205};
206
Mark Fashehccd979b2005-12-15 14:31:24 -0800207struct ocfs2_dlm_debug {
208 struct kref d_refcnt;
209 struct dentry *d_locking_state;
210 struct list_head d_lockres_tracking;
211};
212
213enum ocfs2_vol_state
214{
215 VOLUME_INIT = 0,
216 VOLUME_MOUNTED,
Jan Kara19ece542008-08-21 20:13:17 +0200217 VOLUME_MOUNTED_QUOTAS,
Mark Fashehccd979b2005-12-15 14:31:24 -0800218 VOLUME_DISMOUNTED,
219 VOLUME_DISABLED
220};
221
222struct ocfs2_alloc_stats
223{
224 atomic_t moves;
225 atomic_t local_data;
226 atomic_t bitmap_data;
227 atomic_t bg_allocs;
228 atomic_t bg_extends;
229};
230
231enum ocfs2_local_alloc_state
232{
Mark Fasheh9c7af402008-07-28 18:02:53 -0700233 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
234 * this mountpoint. */
235 OCFS2_LA_ENABLED, /* Local alloc is in use. */
236 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
237 * of bits has been reduced. */
238 OCFS2_LA_DISABLED /* Local alloc has temporarily been
239 * disabled. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800240};
241
242enum ocfs2_mount_options
243{
244 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
245 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
246 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
247 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
248 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800249 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800250 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
Joel Becker12462f12008-09-03 20:03:40 -0700251 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
Jan Kara5297aad2009-10-15 14:54:04 +0200252 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* Force POSIX access control lists */
253 OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9, /* Disable POSIX access
254 control lists */
255 OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
256 OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
Mark Fashehccd979b2005-12-15 14:31:24 -0800257};
258
Jan Karaf7b1aa62009-07-20 12:12:36 +0200259#define OCFS2_OSB_SOFT_RO 0x0001
260#define OCFS2_OSB_HARD_RO 0x0002
261#define OCFS2_OSB_ERROR_FS 0x0004
262#define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED 0x0008
263
264#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800265
266struct ocfs2_journal;
Joel Beckerd85b20e2008-02-01 12:01:05 -0800267struct ocfs2_slot_info;
Joel Becker553abd02008-02-01 12:03:57 -0800268struct ocfs2_recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800269struct ocfs2_replay_map;
Jan Kara22053632008-10-20 23:50:38 +0200270struct ocfs2_quota_recovery;
Jan Karaea455f82009-01-12 23:20:31 +0100271struct ocfs2_dentry_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800272struct ocfs2_super
273{
Mark Fashehccd979b2005-12-15 14:31:24 -0800274 struct task_struct *commit_task;
275 struct super_block *sb;
276 struct inode *root_inode;
277 struct inode *sys_root_inode;
278 struct inode *system_inodes[NUM_SYSTEM_INODES];
279
280 struct ocfs2_slot_info *slot_info;
281
Sunil Mushran539d8262008-07-14 17:31:10 -0700282 u32 *slot_recovery_generations;
283
Mark Fashehccd979b2005-12-15 14:31:24 -0800284 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800285
Mark Fashehccd979b2005-12-15 14:31:24 -0800286 u64 root_blkno;
287 u64 system_dir_blkno;
288 u64 bitmap_blkno;
289 u32 bitmap_cpg;
290 u8 *uuid;
291 char *uuid_str;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800292 u32 uuid_hash;
Mark Fashehccd979b2005-12-15 14:31:24 -0800293 u8 *vol_label;
294 u64 first_cluster_group_blkno;
295 u32 fs_generation;
296
297 u32 s_feature_compat;
298 u32 s_feature_incompat;
299 u32 s_feature_ro_compat;
300
Tao Ma4d0ddb22008-03-05 16:11:46 +0800301 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
302 * Could protect more on osb as it's very short lived.
303 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800304 spinlock_t osb_lock;
305 u32 s_next_generation;
306 unsigned long osb_flags;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800307 s16 s_inode_steal_slot;
Tiger Yangb89c5422010-01-25 14:11:06 +0800308 s16 s_meta_steal_slot;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800309 atomic_t s_num_inodes_stolen;
Tiger Yangb89c5422010-01-25 14:11:06 +0800310 atomic_t s_num_meta_stolen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800311
312 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800313 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800314
Joel Beckerfc881fa2008-02-01 12:04:48 -0800315 unsigned int max_slots;
Joel Becker19fdb622008-01-30 15:38:24 -0800316 unsigned int node_num;
Joel Beckerfc881fa2008-02-01 12:04:48 -0800317 int slot_num;
318 int preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800319 int s_sectsize_bits;
320 int s_clustersize;
321 int s_clustersize_bits;
Tiger Yangfdd77702008-08-18 17:08:55 +0800322 unsigned int s_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800323
324 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800325 struct mutex recovery_lock;
Joel Becker553abd02008-02-01 12:03:57 -0800326 struct ocfs2_recovery_map *recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800327 struct ocfs2_replay_map *replay_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800328 struct task_struct *recovery_thread_task;
329 int disable_recovery;
330 wait_queue_head_t checkpoint_event;
331 atomic_t needs_checkpoint;
332 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800333 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800334
Mark Fasheh9c7af402008-07-28 18:02:53 -0700335 struct delayed_work la_enable_wq;
336
337 /*
338 * Must hold local alloc i_mutex and osb->osb_lock to change
339 * local_alloc_bits. Reads can be done under either lock.
340 */
Mark Fashehebcee4b2008-07-28 14:55:20 -0700341 unsigned int local_alloc_bits;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700342 unsigned int local_alloc_default_bits;
343
344 enum ocfs2_local_alloc_state local_alloc_state; /* protected
345 * by osb_lock */
346
Mark Fashehccd979b2005-12-15 14:31:24 -0800347 struct buffer_head *local_alloc_bh;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700348
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400349 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800350
Jan Kara22053632008-10-20 23:50:38 +0200351 /* Next three fields are for local node slot recovery during
Mark Fashehccd979b2005-12-15 14:31:24 -0800352 * mount. */
353 int dirty;
354 struct ocfs2_dinode *local_alloc_copy;
Jan Kara22053632008-10-20 23:50:38 +0200355 struct ocfs2_quota_recovery *quota_rec;
Mark Fashehccd979b2005-12-15 14:31:24 -0800356
Joel Becker73be1922009-01-06 14:57:08 -0800357 struct ocfs2_blockcheck_stats osb_ecc_stats;
Mark Fashehccd979b2005-12-15 14:31:24 -0800358 struct ocfs2_alloc_stats alloc_stats;
359 char dev_str[20]; /* "major,minor" of the device */
360
Joel Beckerb61817e2008-02-01 15:08:23 -0800361 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
Joel Becker4670c462008-02-01 14:39:35 -0800362 struct ocfs2_cluster_connection *cconn;
Mark Fashehccd979b2005-12-15 14:31:24 -0800363 struct ocfs2_lock_res osb_super_lockres;
364 struct ocfs2_lock_res osb_rename_lockres;
wengang wang6ca497a2009-03-06 21:29:10 +0800365 struct ocfs2_lock_res osb_nfs_sync_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -0800366 struct ocfs2_dlm_debug *osb_dlm_debug;
367
368 struct dentry *osb_debug_root;
Sunil Mushran50397502008-12-17 14:17:43 -0800369 struct dentry *osb_ctxt;
Mark Fashehccd979b2005-12-15 14:31:24 -0800370
371 wait_queue_head_t recovery_event;
372
Mark Fasheh34d024f2007-09-24 15:56:19 -0700373 spinlock_t dc_task_lock;
374 struct task_struct *dc_task;
375 wait_queue_head_t dc_event;
376 unsigned long dc_wake_sequence;
377 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800378
Mark Fasheh7ec373c2008-01-23 16:54:48 -0800379 /*
380 * Any thread can add locks to the list, but the downconvert
381 * thread is the only one allowed to remove locks. Any change
382 * to this rule requires updating
383 * ocfs2_downconvert_thread_do_work().
384 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800385 struct list_head blocked_lock_list;
386 unsigned long blocked_lock_count;
387
Jan Karaea455f82009-01-12 23:20:31 +0100388 /* List of dentry locks to release. Anyone can add locks to
389 * the list, ocfs2_wq processes the list */
390 struct ocfs2_dentry_lock *dentry_lock_list;
391 struct work_struct dentry_lock_work;
392
Mark Fashehccd979b2005-12-15 14:31:24 -0800393 wait_queue_head_t osb_mount_event;
394
395 /* Truncate log info */
396 struct inode *osb_tl_inode;
397 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000398 struct delayed_work osb_truncate_log_wq;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800399
400 struct ocfs2_node_map osb_recovering_orphan_dirs;
401 unsigned int *osb_orphan_wipes;
402 wait_queue_head_t osb_wipe_event;
Tao Mac8b9cf92009-02-24 17:40:26 -0800403
Srinivas Eeda83273932009-06-03 17:02:55 -0700404 struct ocfs2_orphan_scan osb_orphan_scan;
405
Tao Mac8b9cf92009-02-24 17:40:26 -0800406 /* used to protect metaecc calculation check of xattr. */
407 spinlock_t osb_xattr_lock;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800408
409 unsigned int osb_dx_mask;
410 u32 osb_dx_seed[4];
Tao Mafeb473a2009-02-25 00:53:25 +0800411
412 /* the group we used to allocate inodes. */
413 u64 osb_inode_alloc_group;
Tao Ma374a2632009-08-24 11:13:37 +0800414
415 /* rb tree root for refcount lock. */
416 struct rb_root osb_rf_lock_tree;
417 struct ocfs2_refcount_tree *osb_ref_tree_lru;
Mark Fashehccd979b2005-12-15 14:31:24 -0800418};
419
420#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800421
Joel Becker13723d02008-10-17 19:25:01 -0700422/* Useful typedef for passing around journal access functions */
Joel Becker0cf2f762009-02-12 16:41:25 -0800423typedef int (*ocfs2_journal_access_func)(handle_t *handle,
424 struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700425 struct buffer_head *bh, int type);
426
Mark Fashehccd979b2005-12-15 14:31:24 -0800427static inline int ocfs2_should_order_data(struct inode *inode)
428{
429 if (!S_ISREG(inode->i_mode))
430 return 0;
431 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
432 return 0;
433 return 1;
434}
435
Mark Fashehdcd05382007-01-16 11:32:23 -0800436static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
437{
438 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
439 return 1;
440 return 0;
441}
442
Mark Fasheh328d5752007-06-18 10:48:04 -0700443static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
444{
445 /*
446 * Support for sparse files is a pre-requisite
447 */
448 if (!ocfs2_sparse_alloc(osb))
449 return 0;
450
451 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
452 return 1;
453 return 0;
454}
455
Mark Fasheh15b1e362007-09-07 13:58:15 -0700456static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
457{
458 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
459 return 1;
460 return 0;
461}
462
Tiger Yang8154da32008-08-18 17:11:46 +0800463static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
464{
465 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
466 return 1;
467 return 0;
468}
469
Joel Becker70ad1ba2008-10-16 17:54:25 -0700470static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
471{
472 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
473 return 1;
474 return 0;
475}
476
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800477static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
478{
479 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
480 return 1;
481 return 0;
482}
483
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800484static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
485{
486 if (ocfs2_supports_indexed_dirs(osb))
487 return OCFS2_DX_LINK_MAX;
488 return OCFS2_LINK_MAX;
489}
490
491static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
492{
493 u32 nlink = le16_to_cpu(di->i_links_count);
494 u32 hi = le16_to_cpu(di->i_links_count_hi);
495
496 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
497 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
498
499 return nlink;
500}
501
502static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
503{
504 u16 lo, hi;
505
506 lo = nlink;
507 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
508
509 di->i_links_count = cpu_to_le16(lo);
510 di->i_links_count_hi = cpu_to_le16(hi);
511}
512
513static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
514{
515 u32 links = ocfs2_read_links_count(di);
516
517 links += n;
518
519 ocfs2_set_links_count(di, links);
520}
521
Tao Ma1aa75fe2009-08-18 11:28:39 +0800522static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
523{
524 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
525 return 1;
526 return 0;
527}
528
Mark Fashehccd979b2005-12-15 14:31:24 -0800529/* set / clear functions because cluster events can make these happen
530 * in parallel so we want the transitions to be atomic. this also
531 * means that any future flags osb_flags must be protected by spinlock
532 * too! */
533static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
534 unsigned long flag)
535{
536 spin_lock(&osb->osb_lock);
537 osb->osb_flags |= flag;
538 spin_unlock(&osb->osb_lock);
539}
540
Jan Karaf7b1aa62009-07-20 12:12:36 +0200541
542static inline unsigned long ocfs2_test_osb_flag(struct ocfs2_super *osb,
543 unsigned long flag)
544{
545 unsigned long ret;
546
547 spin_lock(&osb->osb_lock);
548 ret = osb->osb_flags & flag;
549 spin_unlock(&osb->osb_lock);
550 return ret;
551}
552
Mark Fashehccd979b2005-12-15 14:31:24 -0800553static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
554 int hard)
555{
556 spin_lock(&osb->osb_lock);
557 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
558 if (hard)
559 osb->osb_flags |= OCFS2_OSB_HARD_RO;
560 else
561 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
562 spin_unlock(&osb->osb_lock);
563}
564
565static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
566{
567 int ret;
568
569 spin_lock(&osb->osb_lock);
570 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
571 spin_unlock(&osb->osb_lock);
572
573 return ret;
574}
575
576static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
577{
578 int ret;
579
580 spin_lock(&osb->osb_lock);
581 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
582 spin_unlock(&osb->osb_lock);
583
584 return ret;
585}
586
Joel Beckerb61817e2008-02-01 15:08:23 -0800587static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
588{
589 return (osb->s_feature_incompat &
590 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
591}
592
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800593static inline int ocfs2_mount_local(struct ocfs2_super *osb)
594{
595 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
596}
597
Joel Becker386a2ef2008-02-01 12:06:54 -0800598static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
599{
600 return (osb->s_feature_incompat &
601 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
602}
603
604
Mark Fashehccd979b2005-12-15 14:31:24 -0800605#define OCFS2_IS_VALID_DINODE(ptr) \
606 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
607
Mark Fashehccd979b2005-12-15 14:31:24 -0800608#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
609 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
610
Mark Fashehccd979b2005-12-15 14:31:24 -0800611#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
612 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
613
Mark Fashehccd979b2005-12-15 14:31:24 -0800614
Joel Beckerf6087fb2008-10-20 18:20:43 -0700615#define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
616 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
617
Mark Fasheh87d35a72008-12-10 17:36:25 -0800618#define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
619 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
620
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800621#define OCFS2_IS_VALID_DX_ROOT(ptr) \
622 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
623
624#define OCFS2_IS_VALID_DX_LEAF(ptr) \
625 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
626
Tao Maf2c870e2009-08-18 11:19:26 +0800627#define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr) \
628 (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
629
Mark Fashehccd979b2005-12-15 14:31:24 -0800630static inline unsigned long ino_from_blkno(struct super_block *sb,
631 u64 blkno)
632{
633 return (unsigned long)(blkno & (u64)ULONG_MAX);
634}
635
636static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
637 u32 clusters)
638{
639 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
640 sb->s_blocksize_bits;
641
642 return (u64)clusters << c_to_b_bits;
643}
644
645static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
646 u64 blocks)
647{
648 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
649 sb->s_blocksize_bits;
650
651 return (u32)(blocks >> b_to_c_bits);
652}
653
654static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
655 u64 bytes)
656{
657 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
658 unsigned int clusters;
659
660 bytes += OCFS2_SB(sb)->s_clustersize - 1;
661 /* OCFS2 just cannot have enough clusters to overflow this */
662 clusters = (unsigned int)(bytes >> cl_bits);
663
664 return clusters;
665}
666
667static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
668 u64 bytes)
669{
670 bytes += sb->s_blocksize - 1;
671 return bytes >> sb->s_blocksize_bits;
672}
673
674static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
675 u32 clusters)
676{
677 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
678}
679
Mark Fasheh1d46dc02009-02-19 13:17:05 -0800680static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
681 u64 blocks)
682{
683 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
684 unsigned int clusters;
685
686 clusters = ocfs2_blocks_to_clusters(sb, blocks);
687 return (u64)clusters << bits;
688}
689
Mark Fashehccd979b2005-12-15 14:31:24 -0800690static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
691 u64 bytes)
692{
693 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
694 unsigned int clusters;
695
696 clusters = ocfs2_clusters_for_bytes(sb, bytes);
697 return (u64)clusters << cl_bits;
698}
699
700static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
701 u64 bytes)
702{
703 u64 blocks;
704
705 blocks = ocfs2_blocks_for_bytes(sb, bytes);
706 return blocks << sb->s_blocksize_bits;
707}
708
709static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
710{
711 return (unsigned long)((bytes + 511) >> 9);
712}
713
Mark Fasheh9517bac2007-02-09 20:24:12 -0800714static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
715 unsigned long pg_index)
716{
717 u32 clusters = pg_index;
718 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
719
720 if (unlikely(PAGE_CACHE_SHIFT > cbits))
721 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
722 else if (PAGE_CACHE_SHIFT < cbits)
723 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
724
725 return clusters;
726}
727
728/*
729 * Find the 1st page index which covers the given clusters.
730 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700731static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800732 u32 clusters)
733{
734 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700735 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800736
737 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700738 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800739 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700740 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800741 }
742
743 return index;
744}
745
Mark Fasheh60b11392007-02-16 11:46:50 -0800746static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
747{
748 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
749 unsigned int pages_per_cluster = 1;
750
751 if (PAGE_CACHE_SHIFT < cbits)
752 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
753
754 return pages_per_cluster;
755}
756
Mark Fashehebcee4b2008-07-28 14:55:20 -0700757static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
758 unsigned int megs)
759{
760 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
761
762 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
763}
764
Mark Fashehccd979b2005-12-15 14:31:24 -0800765#define ocfs2_set_bit ext2_set_bit
766#define ocfs2_clear_bit ext2_clear_bit
767#define ocfs2_test_bit ext2_test_bit
768#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
Joel Becker70ad1ba2008-10-16 17:54:25 -0700769#define ocfs2_find_next_bit ext2_find_next_bit
Mark Fashehccd979b2005-12-15 14:31:24 -0800770#endif /* OCFS2_H */
771