blob: adf5e2ebc2c436b60992dfc39ae506327aaf9054 [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
Joel Becker47460d62009-02-10 16:05:07 -080050
51/* Caching of metadata buffers */
52
Mark Fashehccd979b2005-12-15 14:31:24 -080053/* Most user visible OCFS2 inodes will have very few pieces of
54 * metadata, but larger files (including bitmaps, etc) must be taken
55 * into account when designing an access scheme. We allow a small
56 * amount of inlined blocks to be stored on an array and grow the
57 * structure into a rb tree when necessary. */
Joel Becker47460d62009-02-10 16:05:07 -080058#define OCFS2_CACHE_INFO_MAX_ARRAY 2
59
60/* Flags for ocfs2_caching_info */
61
62enum ocfs2_caching_info_flags {
63 /* Indicates that the metadata cache is using the inline array */
64 OCFS2_CACHE_FL_INLINE = 1<<1,
65};
Mark Fashehccd979b2005-12-15 14:31:24 -080066
Joel Becker6e5a3d72009-02-10 19:00:37 -080067struct ocfs2_caching_operations;
Mark Fashehccd979b2005-12-15 14:31:24 -080068struct ocfs2_caching_info {
Joel Becker47460d62009-02-10 16:05:07 -080069 /*
70 * The parent structure provides the locks, but because the
Joel Becker6e5a3d72009-02-10 19:00:37 -080071 * parent structure can differ, it provides locking operations
72 * to struct ocfs2_caching_info.
Joel Becker47460d62009-02-10 16:05:07 -080073 */
Joel Becker6e5a3d72009-02-10 19:00:37 -080074 const struct ocfs2_caching_operations *ci_ops;
Joel Becker47460d62009-02-10 16:05:07 -080075
Joel Becker292dd272009-02-12 15:41:59 -080076 /* next two are protected by trans_inc_lock */
77 /* which transaction were we created on? Zero if none. */
78 unsigned long ci_created_trans;
Joel Becker66fb3452009-02-12 15:24:40 -080079 /* last transaction we were a part of. */
80 unsigned long ci_last_trans;
81
82 /* Cache structures */
Joel Becker47460d62009-02-10 16:05:07 -080083 unsigned int ci_flags;
Mark Fashehccd979b2005-12-15 14:31:24 -080084 unsigned int ci_num_cached;
85 union {
Joel Becker47460d62009-02-10 16:05:07 -080086 sector_t ci_array[OCFS2_CACHE_INFO_MAX_ARRAY];
Mark Fashehccd979b2005-12-15 14:31:24 -080087 struct rb_root ci_tree;
88 } ci_cache;
89};
Joel Becker0cf2f762009-02-12 16:41:25 -080090/*
91 * Need this prototype here instead of in uptodate.h because journal.h
92 * uses it.
93 */
94struct super_block *ocfs2_metadata_cache_get_super(struct ocfs2_caching_info *ci);
Mark Fashehccd979b2005-12-15 14:31:24 -080095
96/* this limits us to 256 nodes
97 * if we need more, we can do a kmalloc for the map */
98#define OCFS2_NODE_MAP_MAX_NODES 256
99struct ocfs2_node_map {
100 u16 num_nodes;
101 unsigned long map[BITS_TO_LONGS(OCFS2_NODE_MAP_MAX_NODES)];
102};
103
104enum ocfs2_ast_action {
105 OCFS2_AST_INVALID = 0,
106 OCFS2_AST_ATTACH,
107 OCFS2_AST_CONVERT,
108 OCFS2_AST_DOWNCONVERT,
109};
110
111/* actions for an unlockast function to take. */
112enum ocfs2_unlock_action {
113 OCFS2_UNLOCK_INVALID = 0,
114 OCFS2_UNLOCK_CANCEL_CONVERT,
115 OCFS2_UNLOCK_DROP_LOCK,
116};
117
118/* ocfs2_lock_res->l_flags flags. */
Coly Li3b5da012008-11-05 15:16:24 +0800119#define OCFS2_LOCK_ATTACHED (0x00000001) /* we have initialized
Mark Fashehccd979b2005-12-15 14:31:24 -0800120 * the lvb */
121#define OCFS2_LOCK_BUSY (0x00000002) /* we are currently in
122 * dlm_lock */
123#define OCFS2_LOCK_BLOCKED (0x00000004) /* blocked waiting to
124 * downconvert*/
125#define OCFS2_LOCK_LOCAL (0x00000008) /* newly created inode */
126#define OCFS2_LOCK_NEEDS_REFRESH (0x00000010)
127#define OCFS2_LOCK_REFRESHING (0x00000020)
128#define OCFS2_LOCK_INITIALIZED (0x00000040) /* track initialization
129 * for shutdown paths */
130#define OCFS2_LOCK_FREEING (0x00000080) /* help dlmglue track
131 * when to skip queueing
132 * a lock because it's
133 * about to be
134 * dropped. */
135#define OCFS2_LOCK_QUEUED (0x00000100) /* queued for downconvert */
Mark Fashehcf8e06f2007-12-20 16:43:10 -0800136#define OCFS2_LOCK_NOCACHE (0x00000200) /* don't use a holder count */
Joel Beckerde551242008-02-01 14:45:08 -0800137#define OCFS2_LOCK_PENDING (0x00000400) /* This lockres is pending a
138 call to dlm_lock. Only
139 exists with BUSY set. */
Sunil Mushrana1912822010-01-21 10:50:03 -0800140#define OCFS2_LOCK_UPCONVERT_FINISHING (0x00000800) /* blocks the dc thread
141 * from downconverting
142 * before the upconvert
143 * has completed */
Mark Fashehccd979b2005-12-15 14:31:24 -0800144
145struct ocfs2_lock_res_ops;
146
147typedef void (*ocfs2_lock_callback)(int status, unsigned long data);
148
149struct ocfs2_lock_res {
150 void *l_priv;
151 struct ocfs2_lock_res_ops *l_ops;
152 spinlock_t l_lock;
153
154 struct list_head l_blocked_list;
155 struct list_head l_mask_waiters;
156
157 enum ocfs2_lock_type l_type;
158 unsigned long l_flags;
159 char l_name[OCFS2_LOCK_ID_MAX_LEN];
160 int l_level;
161 unsigned int l_ro_holders;
162 unsigned int l_ex_holders;
Joel Beckerc0e41332010-01-29 14:46:44 -0800163 struct ocfs2_dlm_lksb l_lksb;
Mark Fashehccd979b2005-12-15 14:31:24 -0800164
165 /* used from AST/BAST funcs. */
166 enum ocfs2_ast_action l_action;
167 enum ocfs2_unlock_action l_unlock_action;
168 int l_requested;
169 int l_blocking;
Joel Beckerde551242008-02-01 14:45:08 -0800170 unsigned int l_pending_gen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800171
172 wait_queue_head_t l_event;
173
174 struct list_head l_debug_list;
Sunil Mushran8ddb7b02008-05-13 13:45:15 -0700175
176#ifdef CONFIG_OCFS2_FS_STATS
177 unsigned long long l_lock_num_prmode; /* PR acquires */
178 unsigned long long l_lock_num_exmode; /* EX acquires */
179 unsigned int l_lock_num_prmode_failed; /* Failed PR gets */
180 unsigned int l_lock_num_exmode_failed; /* Failed EX gets */
181 unsigned long long l_lock_total_prmode; /* Tot wait for PR */
182 unsigned long long l_lock_total_exmode; /* Tot wait for EX */
183 unsigned int l_lock_max_prmode; /* Max wait for PR */
184 unsigned int l_lock_max_exmode; /* Max wait for EX */
185 unsigned int l_lock_refresh; /* Disk refreshes */
186#endif
Jan Karacb257972009-06-04 15:26:50 +0200187#ifdef CONFIG_DEBUG_LOCK_ALLOC
188 struct lockdep_map l_lockdep_map;
189#endif
Mark Fashehccd979b2005-12-15 14:31:24 -0800190};
191
Sunil Mushran692684e2009-06-19 16:53:17 -0700192enum ocfs2_orphan_scan_state {
193 ORPHAN_SCAN_ACTIVE,
194 ORPHAN_SCAN_INACTIVE
195};
196
Srinivas Eeda83273932009-06-03 17:02:55 -0700197struct ocfs2_orphan_scan {
198 struct mutex os_lock;
199 struct ocfs2_super *os_osb;
200 struct ocfs2_lock_res os_lockres; /* lock to synchronize scans */
201 struct delayed_work os_orphan_scan_work;
Srinivas Eeda15633a22009-06-03 17:02:56 -0700202 struct timespec os_scantime; /* time this node ran the scan */
203 u32 os_count; /* tracks node specific scans */
204 u32 os_seqno; /* tracks cluster wide scans */
Sunil Mushran692684e2009-06-19 16:53:17 -0700205 atomic_t os_state; /* ACTIVE or INACTIVE */
Srinivas Eeda83273932009-06-03 17:02:55 -0700206};
207
Mark Fashehccd979b2005-12-15 14:31:24 -0800208struct ocfs2_dlm_debug {
209 struct kref d_refcnt;
210 struct dentry *d_locking_state;
211 struct list_head d_lockres_tracking;
212};
213
214enum ocfs2_vol_state
215{
216 VOLUME_INIT = 0,
217 VOLUME_MOUNTED,
Jan Kara19ece542008-08-21 20:13:17 +0200218 VOLUME_MOUNTED_QUOTAS,
Mark Fashehccd979b2005-12-15 14:31:24 -0800219 VOLUME_DISMOUNTED,
220 VOLUME_DISABLED
221};
222
223struct ocfs2_alloc_stats
224{
225 atomic_t moves;
226 atomic_t local_data;
227 atomic_t bitmap_data;
228 atomic_t bg_allocs;
229 atomic_t bg_extends;
230};
231
232enum ocfs2_local_alloc_state
233{
Mark Fasheh9c7af402008-07-28 18:02:53 -0700234 OCFS2_LA_UNUSED = 0, /* Local alloc will never be used for
235 * this mountpoint. */
236 OCFS2_LA_ENABLED, /* Local alloc is in use. */
237 OCFS2_LA_THROTTLED, /* Local alloc is in use, but number
238 * of bits has been reduced. */
239 OCFS2_LA_DISABLED /* Local alloc has temporarily been
240 * disabled. */
Mark Fashehccd979b2005-12-15 14:31:24 -0800241};
242
243enum ocfs2_mount_options
244{
245 OCFS2_MOUNT_HB_LOCAL = 1 << 0, /* Heartbeat started in local mode */
246 OCFS2_MOUNT_BARRIER = 1 << 1, /* Use block barriers */
247 OCFS2_MOUNT_NOINTR = 1 << 2, /* Don't catch signals */
248 OCFS2_MOUNT_ERRORS_PANIC = 1 << 3, /* Panic on errors */
249 OCFS2_MOUNT_DATA_WRITEBACK = 1 << 4, /* No data ordering */
Mark Fasheh53fc6222007-12-20 16:49:04 -0800250 OCFS2_MOUNT_LOCALFLOCKS = 1 << 5, /* No cluster aware user file locks */
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800251 OCFS2_MOUNT_NOUSERXATTR = 1 << 6, /* No user xattr */
Joel Becker12462f12008-09-03 20:03:40 -0700252 OCFS2_MOUNT_INODE64 = 1 << 7, /* Allow inode numbers > 2^32 */
Jan Kara5297aad2009-10-15 14:54:04 +0200253 OCFS2_MOUNT_POSIX_ACL = 1 << 8, /* Force POSIX access control lists */
254 OCFS2_MOUNT_NO_POSIX_ACL = 1 << 9, /* Disable POSIX access
255 control lists */
256 OCFS2_MOUNT_USRQUOTA = 1 << 10, /* We support user quotas */
257 OCFS2_MOUNT_GRPQUOTA = 1 << 11, /* We support group quotas */
Mark Fashehccd979b2005-12-15 14:31:24 -0800258};
259
Jan Karaf7b1aa62009-07-20 12:12:36 +0200260#define OCFS2_OSB_SOFT_RO 0x0001
261#define OCFS2_OSB_HARD_RO 0x0002
262#define OCFS2_OSB_ERROR_FS 0x0004
263#define OCFS2_OSB_DROP_DENTRY_LOCK_IMMED 0x0008
264
265#define OCFS2_DEFAULT_ATIME_QUANTUM 60
Mark Fashehccd979b2005-12-15 14:31:24 -0800266
267struct ocfs2_journal;
Joel Beckerd85b20e2008-02-01 12:01:05 -0800268struct ocfs2_slot_info;
Joel Becker553abd02008-02-01 12:03:57 -0800269struct ocfs2_recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800270struct ocfs2_replay_map;
Jan Kara22053632008-10-20 23:50:38 +0200271struct ocfs2_quota_recovery;
Jan Karaea455f82009-01-12 23:20:31 +0100272struct ocfs2_dentry_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800273struct ocfs2_super
274{
Mark Fashehccd979b2005-12-15 14:31:24 -0800275 struct task_struct *commit_task;
276 struct super_block *sb;
277 struct inode *root_inode;
278 struct inode *sys_root_inode;
279 struct inode *system_inodes[NUM_SYSTEM_INODES];
280
281 struct ocfs2_slot_info *slot_info;
282
Sunil Mushran539d8262008-07-14 17:31:10 -0700283 u32 *slot_recovery_generations;
284
Mark Fashehccd979b2005-12-15 14:31:24 -0800285 spinlock_t node_map_lock;
Mark Fashehccd979b2005-12-15 14:31:24 -0800286
Mark Fashehccd979b2005-12-15 14:31:24 -0800287 u64 root_blkno;
288 u64 system_dir_blkno;
289 u64 bitmap_blkno;
290 u32 bitmap_cpg;
291 u8 *uuid;
292 char *uuid_str;
Tiger Yangcf1d6c72008-08-18 17:11:00 +0800293 u32 uuid_hash;
Mark Fashehccd979b2005-12-15 14:31:24 -0800294 u8 *vol_label;
295 u64 first_cluster_group_blkno;
296 u32 fs_generation;
297
298 u32 s_feature_compat;
299 u32 s_feature_incompat;
300 u32 s_feature_ro_compat;
301
Tao Ma4d0ddb22008-03-05 16:11:46 +0800302 /* Protects s_next_generation, osb_flags and s_inode_steal_slot.
303 * Could protect more on osb as it's very short lived.
304 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800305 spinlock_t osb_lock;
306 u32 s_next_generation;
307 unsigned long osb_flags;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800308 s16 s_inode_steal_slot;
Tiger Yangb89c5422010-01-25 14:11:06 +0800309 s16 s_meta_steal_slot;
Tao Ma4d0ddb22008-03-05 16:11:46 +0800310 atomic_t s_num_inodes_stolen;
Tiger Yangb89c5422010-01-25 14:11:06 +0800311 atomic_t s_num_meta_stolen;
Mark Fashehccd979b2005-12-15 14:31:24 -0800312
313 unsigned long s_mount_opt;
Tiger Yang7f1a37e2006-11-15 15:48:42 +0800314 unsigned int s_atime_quantum;
Mark Fashehccd979b2005-12-15 14:31:24 -0800315
Joel Beckerfc881fa2008-02-01 12:04:48 -0800316 unsigned int max_slots;
Joel Becker19fdb622008-01-30 15:38:24 -0800317 unsigned int node_num;
Joel Beckerfc881fa2008-02-01 12:04:48 -0800318 int slot_num;
319 int preferred_slot;
Mark Fashehccd979b2005-12-15 14:31:24 -0800320 int s_sectsize_bits;
321 int s_clustersize;
322 int s_clustersize_bits;
Tiger Yangfdd77702008-08-18 17:08:55 +0800323 unsigned int s_xattr_inline_size;
Mark Fashehccd979b2005-12-15 14:31:24 -0800324
325 atomic_t vol_state;
Arjan van de Venc74ec2f2006-01-13 21:54:23 -0800326 struct mutex recovery_lock;
Joel Becker553abd02008-02-01 12:03:57 -0800327 struct ocfs2_recovery_map *recovery_map;
Srinivas Eeda9140db02009-03-06 14:21:46 -0800328 struct ocfs2_replay_map *replay_map;
Mark Fashehccd979b2005-12-15 14:31:24 -0800329 struct task_struct *recovery_thread_task;
330 int disable_recovery;
331 wait_queue_head_t checkpoint_event;
332 atomic_t needs_checkpoint;
333 struct ocfs2_journal *journal;
Mark Fashehd147b3d2007-11-07 14:40:36 -0800334 unsigned long osb_commit_interval;
Mark Fashehccd979b2005-12-15 14:31:24 -0800335
Mark Fasheh9c7af402008-07-28 18:02:53 -0700336 struct delayed_work la_enable_wq;
337
338 /*
339 * Must hold local alloc i_mutex and osb->osb_lock to change
340 * local_alloc_bits. Reads can be done under either lock.
341 */
Mark Fashehebcee4b2008-07-28 14:55:20 -0700342 unsigned int local_alloc_bits;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700343 unsigned int local_alloc_default_bits;
344
345 enum ocfs2_local_alloc_state local_alloc_state; /* protected
346 * by osb_lock */
347
Mark Fashehccd979b2005-12-15 14:31:24 -0800348 struct buffer_head *local_alloc_bh;
Mark Fasheh9c7af402008-07-28 18:02:53 -0700349
Mark Fasheh883d4ca2006-06-05 16:41:00 -0400350 u64 la_last_gd;
Mark Fashehccd979b2005-12-15 14:31:24 -0800351
Jan Kara22053632008-10-20 23:50:38 +0200352 /* Next three fields are for local node slot recovery during
Mark Fashehccd979b2005-12-15 14:31:24 -0800353 * mount. */
354 int dirty;
355 struct ocfs2_dinode *local_alloc_copy;
Jan Kara22053632008-10-20 23:50:38 +0200356 struct ocfs2_quota_recovery *quota_rec;
Mark Fashehccd979b2005-12-15 14:31:24 -0800357
Joel Becker73be1922009-01-06 14:57:08 -0800358 struct ocfs2_blockcheck_stats osb_ecc_stats;
Mark Fashehccd979b2005-12-15 14:31:24 -0800359 struct ocfs2_alloc_stats alloc_stats;
360 char dev_str[20]; /* "major,minor" of the device */
361
Joel Beckerb61817e2008-02-01 15:08:23 -0800362 char osb_cluster_stack[OCFS2_STACK_LABEL_LEN + 1];
Joel Becker4670c462008-02-01 14:39:35 -0800363 struct ocfs2_cluster_connection *cconn;
Mark Fashehccd979b2005-12-15 14:31:24 -0800364 struct ocfs2_lock_res osb_super_lockres;
365 struct ocfs2_lock_res osb_rename_lockres;
wengang wang6ca497a2009-03-06 21:29:10 +0800366 struct ocfs2_lock_res osb_nfs_sync_lockres;
Mark Fashehccd979b2005-12-15 14:31:24 -0800367 struct ocfs2_dlm_debug *osb_dlm_debug;
368
369 struct dentry *osb_debug_root;
Sunil Mushran50397502008-12-17 14:17:43 -0800370 struct dentry *osb_ctxt;
Mark Fashehccd979b2005-12-15 14:31:24 -0800371
372 wait_queue_head_t recovery_event;
373
Mark Fasheh34d024f2007-09-24 15:56:19 -0700374 spinlock_t dc_task_lock;
375 struct task_struct *dc_task;
376 wait_queue_head_t dc_event;
377 unsigned long dc_wake_sequence;
378 unsigned long dc_work_sequence;
Mark Fashehccd979b2005-12-15 14:31:24 -0800379
Mark Fasheh7ec373c2008-01-23 16:54:48 -0800380 /*
381 * Any thread can add locks to the list, but the downconvert
382 * thread is the only one allowed to remove locks. Any change
383 * to this rule requires updating
384 * ocfs2_downconvert_thread_do_work().
385 */
Mark Fashehccd979b2005-12-15 14:31:24 -0800386 struct list_head blocked_lock_list;
387 unsigned long blocked_lock_count;
388
Jan Karaea455f82009-01-12 23:20:31 +0100389 /* List of dentry locks to release. Anyone can add locks to
390 * the list, ocfs2_wq processes the list */
391 struct ocfs2_dentry_lock *dentry_lock_list;
392 struct work_struct dentry_lock_work;
393
Mark Fashehccd979b2005-12-15 14:31:24 -0800394 wait_queue_head_t osb_mount_event;
395
396 /* Truncate log info */
397 struct inode *osb_tl_inode;
398 struct buffer_head *osb_tl_bh;
David Howellsc4028952006-11-22 14:57:56 +0000399 struct delayed_work osb_truncate_log_wq;
Mark Fashehb4df6ed2006-02-22 17:35:08 -0800400
401 struct ocfs2_node_map osb_recovering_orphan_dirs;
402 unsigned int *osb_orphan_wipes;
403 wait_queue_head_t osb_wipe_event;
Tao Mac8b9cf92009-02-24 17:40:26 -0800404
Srinivas Eeda83273932009-06-03 17:02:55 -0700405 struct ocfs2_orphan_scan osb_orphan_scan;
406
Tao Mac8b9cf92009-02-24 17:40:26 -0800407 /* used to protect metaecc calculation check of xattr. */
408 spinlock_t osb_xattr_lock;
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800409
410 unsigned int osb_dx_mask;
411 u32 osb_dx_seed[4];
Tao Mafeb473a2009-02-25 00:53:25 +0800412
413 /* the group we used to allocate inodes. */
414 u64 osb_inode_alloc_group;
Tao Ma374a2632009-08-24 11:13:37 +0800415
416 /* rb tree root for refcount lock. */
417 struct rb_root osb_rf_lock_tree;
418 struct ocfs2_refcount_tree *osb_ref_tree_lru;
Mark Fashehccd979b2005-12-15 14:31:24 -0800419};
420
421#define OCFS2_SB(sb) ((struct ocfs2_super *)(sb)->s_fs_info)
Mark Fashehccd979b2005-12-15 14:31:24 -0800422
Joel Becker13723d02008-10-17 19:25:01 -0700423/* Useful typedef for passing around journal access functions */
Joel Becker0cf2f762009-02-12 16:41:25 -0800424typedef int (*ocfs2_journal_access_func)(handle_t *handle,
425 struct ocfs2_caching_info *ci,
Joel Becker13723d02008-10-17 19:25:01 -0700426 struct buffer_head *bh, int type);
427
Mark Fashehccd979b2005-12-15 14:31:24 -0800428static inline int ocfs2_should_order_data(struct inode *inode)
429{
430 if (!S_ISREG(inode->i_mode))
431 return 0;
432 if (OCFS2_SB(inode->i_sb)->s_mount_opt & OCFS2_MOUNT_DATA_WRITEBACK)
433 return 0;
434 return 1;
435}
436
Mark Fashehdcd05382007-01-16 11:32:23 -0800437static inline int ocfs2_sparse_alloc(struct ocfs2_super *osb)
438{
439 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_SPARSE_ALLOC)
440 return 1;
441 return 0;
442}
443
Mark Fasheh328d5752007-06-18 10:48:04 -0700444static inline int ocfs2_writes_unwritten_extents(struct ocfs2_super *osb)
445{
446 /*
447 * Support for sparse files is a pre-requisite
448 */
449 if (!ocfs2_sparse_alloc(osb))
450 return 0;
451
452 if (osb->s_feature_ro_compat & OCFS2_FEATURE_RO_COMPAT_UNWRITTEN)
453 return 1;
454 return 0;
455}
456
Mark Fasheh15b1e362007-09-07 13:58:15 -0700457static inline int ocfs2_supports_inline_data(struct ocfs2_super *osb)
458{
459 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INLINE_DATA)
460 return 1;
461 return 0;
462}
463
Tiger Yang8154da32008-08-18 17:11:46 +0800464static inline int ocfs2_supports_xattr(struct ocfs2_super *osb)
465{
466 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_XATTR)
467 return 1;
468 return 0;
469}
470
Joel Becker70ad1ba2008-10-16 17:54:25 -0700471static inline int ocfs2_meta_ecc(struct ocfs2_super *osb)
472{
473 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_META_ECC)
474 return 1;
475 return 0;
476}
477
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800478static inline int ocfs2_supports_indexed_dirs(struct ocfs2_super *osb)
479{
480 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_INDEXED_DIRS)
481 return 1;
482 return 0;
483}
484
Mark Fasheh198a1ca2008-11-20 17:54:57 -0800485static inline unsigned int ocfs2_link_max(struct ocfs2_super *osb)
486{
487 if (ocfs2_supports_indexed_dirs(osb))
488 return OCFS2_DX_LINK_MAX;
489 return OCFS2_LINK_MAX;
490}
491
492static inline unsigned int ocfs2_read_links_count(struct ocfs2_dinode *di)
493{
494 u32 nlink = le16_to_cpu(di->i_links_count);
495 u32 hi = le16_to_cpu(di->i_links_count_hi);
496
497 if (di->i_dyn_features & cpu_to_le16(OCFS2_INDEXED_DIR_FL))
498 nlink |= (hi << OCFS2_LINKS_HI_SHIFT);
499
500 return nlink;
501}
502
503static inline void ocfs2_set_links_count(struct ocfs2_dinode *di, u32 nlink)
504{
505 u16 lo, hi;
506
507 lo = nlink;
508 hi = nlink >> OCFS2_LINKS_HI_SHIFT;
509
510 di->i_links_count = cpu_to_le16(lo);
511 di->i_links_count_hi = cpu_to_le16(hi);
512}
513
514static inline void ocfs2_add_links_count(struct ocfs2_dinode *di, int n)
515{
516 u32 links = ocfs2_read_links_count(di);
517
518 links += n;
519
520 ocfs2_set_links_count(di, links);
521}
522
Tao Ma1aa75fe2009-08-18 11:28:39 +0800523static inline int ocfs2_refcount_tree(struct ocfs2_super *osb)
524{
525 if (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_REFCOUNT_TREE)
526 return 1;
527 return 0;
528}
529
Mark Fashehccd979b2005-12-15 14:31:24 -0800530/* set / clear functions because cluster events can make these happen
531 * in parallel so we want the transitions to be atomic. this also
532 * means that any future flags osb_flags must be protected by spinlock
533 * too! */
534static inline void ocfs2_set_osb_flag(struct ocfs2_super *osb,
535 unsigned long flag)
536{
537 spin_lock(&osb->osb_lock);
538 osb->osb_flags |= flag;
539 spin_unlock(&osb->osb_lock);
540}
541
Jan Karaf7b1aa62009-07-20 12:12:36 +0200542
543static inline unsigned long ocfs2_test_osb_flag(struct ocfs2_super *osb,
544 unsigned long flag)
545{
546 unsigned long ret;
547
548 spin_lock(&osb->osb_lock);
549 ret = osb->osb_flags & flag;
550 spin_unlock(&osb->osb_lock);
551 return ret;
552}
553
Mark Fashehccd979b2005-12-15 14:31:24 -0800554static inline void ocfs2_set_ro_flag(struct ocfs2_super *osb,
555 int hard)
556{
557 spin_lock(&osb->osb_lock);
558 osb->osb_flags &= ~(OCFS2_OSB_SOFT_RO|OCFS2_OSB_HARD_RO);
559 if (hard)
560 osb->osb_flags |= OCFS2_OSB_HARD_RO;
561 else
562 osb->osb_flags |= OCFS2_OSB_SOFT_RO;
563 spin_unlock(&osb->osb_lock);
564}
565
566static inline int ocfs2_is_hard_readonly(struct ocfs2_super *osb)
567{
568 int ret;
569
570 spin_lock(&osb->osb_lock);
571 ret = osb->osb_flags & OCFS2_OSB_HARD_RO;
572 spin_unlock(&osb->osb_lock);
573
574 return ret;
575}
576
577static inline int ocfs2_is_soft_readonly(struct ocfs2_super *osb)
578{
579 int ret;
580
581 spin_lock(&osb->osb_lock);
582 ret = osb->osb_flags & OCFS2_OSB_SOFT_RO;
583 spin_unlock(&osb->osb_lock);
584
585 return ret;
586}
587
Joel Beckerb61817e2008-02-01 15:08:23 -0800588static inline int ocfs2_userspace_stack(struct ocfs2_super *osb)
589{
590 return (osb->s_feature_incompat &
591 OCFS2_FEATURE_INCOMPAT_USERSPACE_STACK);
592}
593
Sunil Mushranc271c5c2006-12-05 17:56:35 -0800594static inline int ocfs2_mount_local(struct ocfs2_super *osb)
595{
596 return (osb->s_feature_incompat & OCFS2_FEATURE_INCOMPAT_LOCAL_MOUNT);
597}
598
Joel Becker386a2ef2008-02-01 12:06:54 -0800599static inline int ocfs2_uses_extended_slot_map(struct ocfs2_super *osb)
600{
601 return (osb->s_feature_incompat &
602 OCFS2_FEATURE_INCOMPAT_EXTENDED_SLOT_MAP);
603}
604
605
Mark Fashehccd979b2005-12-15 14:31:24 -0800606#define OCFS2_IS_VALID_DINODE(ptr) \
607 (!strcmp((ptr)->i_signature, OCFS2_INODE_SIGNATURE))
608
Mark Fashehccd979b2005-12-15 14:31:24 -0800609#define OCFS2_IS_VALID_EXTENT_BLOCK(ptr) \
610 (!strcmp((ptr)->h_signature, OCFS2_EXTENT_BLOCK_SIGNATURE))
611
Mark Fashehccd979b2005-12-15 14:31:24 -0800612#define OCFS2_IS_VALID_GROUP_DESC(ptr) \
613 (!strcmp((ptr)->bg_signature, OCFS2_GROUP_DESC_SIGNATURE))
614
Mark Fashehccd979b2005-12-15 14:31:24 -0800615
Joel Beckerf6087fb2008-10-20 18:20:43 -0700616#define OCFS2_IS_VALID_XATTR_BLOCK(ptr) \
617 (!strcmp((ptr)->xb_signature, OCFS2_XATTR_BLOCK_SIGNATURE))
618
Mark Fasheh87d35a72008-12-10 17:36:25 -0800619#define OCFS2_IS_VALID_DIR_TRAILER(ptr) \
620 (!strcmp((ptr)->db_signature, OCFS2_DIR_TRAILER_SIGNATURE))
621
Mark Fasheh9b7895e2008-11-12 16:27:44 -0800622#define OCFS2_IS_VALID_DX_ROOT(ptr) \
623 (!strcmp((ptr)->dr_signature, OCFS2_DX_ROOT_SIGNATURE))
624
625#define OCFS2_IS_VALID_DX_LEAF(ptr) \
626 (!strcmp((ptr)->dl_signature, OCFS2_DX_LEAF_SIGNATURE))
627
Tao Maf2c870e2009-08-18 11:19:26 +0800628#define OCFS2_IS_VALID_REFCOUNT_BLOCK(ptr) \
629 (!strcmp((ptr)->rf_signature, OCFS2_REFCOUNT_BLOCK_SIGNATURE))
630
Mark Fashehccd979b2005-12-15 14:31:24 -0800631static inline unsigned long ino_from_blkno(struct super_block *sb,
632 u64 blkno)
633{
634 return (unsigned long)(blkno & (u64)ULONG_MAX);
635}
636
637static inline u64 ocfs2_clusters_to_blocks(struct super_block *sb,
638 u32 clusters)
639{
640 int c_to_b_bits = OCFS2_SB(sb)->s_clustersize_bits -
641 sb->s_blocksize_bits;
642
643 return (u64)clusters << c_to_b_bits;
644}
645
646static inline u32 ocfs2_blocks_to_clusters(struct super_block *sb,
647 u64 blocks)
648{
649 int b_to_c_bits = OCFS2_SB(sb)->s_clustersize_bits -
650 sb->s_blocksize_bits;
651
652 return (u32)(blocks >> b_to_c_bits);
653}
654
655static inline unsigned int ocfs2_clusters_for_bytes(struct super_block *sb,
656 u64 bytes)
657{
658 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
659 unsigned int clusters;
660
661 bytes += OCFS2_SB(sb)->s_clustersize - 1;
662 /* OCFS2 just cannot have enough clusters to overflow this */
663 clusters = (unsigned int)(bytes >> cl_bits);
664
665 return clusters;
666}
667
668static inline u64 ocfs2_blocks_for_bytes(struct super_block *sb,
669 u64 bytes)
670{
671 bytes += sb->s_blocksize - 1;
672 return bytes >> sb->s_blocksize_bits;
673}
674
675static inline u64 ocfs2_clusters_to_bytes(struct super_block *sb,
676 u32 clusters)
677{
678 return (u64)clusters << OCFS2_SB(sb)->s_clustersize_bits;
679}
680
Mark Fasheh1d46dc02009-02-19 13:17:05 -0800681static inline u64 ocfs2_block_to_cluster_start(struct super_block *sb,
682 u64 blocks)
683{
684 int bits = OCFS2_SB(sb)->s_clustersize_bits - sb->s_blocksize_bits;
685 unsigned int clusters;
686
687 clusters = ocfs2_blocks_to_clusters(sb, blocks);
688 return (u64)clusters << bits;
689}
690
Mark Fashehccd979b2005-12-15 14:31:24 -0800691static inline u64 ocfs2_align_bytes_to_clusters(struct super_block *sb,
692 u64 bytes)
693{
694 int cl_bits = OCFS2_SB(sb)->s_clustersize_bits;
695 unsigned int clusters;
696
697 clusters = ocfs2_clusters_for_bytes(sb, bytes);
698 return (u64)clusters << cl_bits;
699}
700
701static inline u64 ocfs2_align_bytes_to_blocks(struct super_block *sb,
702 u64 bytes)
703{
704 u64 blocks;
705
706 blocks = ocfs2_blocks_for_bytes(sb, bytes);
707 return blocks << sb->s_blocksize_bits;
708}
709
710static inline unsigned long ocfs2_align_bytes_to_sectors(u64 bytes)
711{
712 return (unsigned long)((bytes + 511) >> 9);
713}
714
Mark Fasheh9517bac2007-02-09 20:24:12 -0800715static inline unsigned int ocfs2_page_index_to_clusters(struct super_block *sb,
716 unsigned long pg_index)
717{
718 u32 clusters = pg_index;
719 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
720
721 if (unlikely(PAGE_CACHE_SHIFT > cbits))
722 clusters = pg_index << (PAGE_CACHE_SHIFT - cbits);
723 else if (PAGE_CACHE_SHIFT < cbits)
724 clusters = pg_index >> (cbits - PAGE_CACHE_SHIFT);
725
726 return clusters;
727}
728
729/*
730 * Find the 1st page index which covers the given clusters.
731 */
Mark Fasheh7c08d702007-07-20 11:58:36 -0700732static inline pgoff_t ocfs2_align_clusters_to_page_index(struct super_block *sb,
Mark Fasheh9517bac2007-02-09 20:24:12 -0800733 u32 clusters)
734{
735 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
Mark Fasheh7c08d702007-07-20 11:58:36 -0700736 pgoff_t index = clusters;
Mark Fasheh9517bac2007-02-09 20:24:12 -0800737
738 if (PAGE_CACHE_SHIFT > cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700739 index = (pgoff_t)clusters >> (PAGE_CACHE_SHIFT - cbits);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800740 } else if (PAGE_CACHE_SHIFT < cbits) {
Mark Fasheh7c08d702007-07-20 11:58:36 -0700741 index = (pgoff_t)clusters << (cbits - PAGE_CACHE_SHIFT);
Mark Fasheh9517bac2007-02-09 20:24:12 -0800742 }
743
744 return index;
745}
746
Mark Fasheh60b11392007-02-16 11:46:50 -0800747static inline unsigned int ocfs2_pages_per_cluster(struct super_block *sb)
748{
749 unsigned int cbits = OCFS2_SB(sb)->s_clustersize_bits;
750 unsigned int pages_per_cluster = 1;
751
752 if (PAGE_CACHE_SHIFT < cbits)
753 pages_per_cluster = 1 << (cbits - PAGE_CACHE_SHIFT);
754
755 return pages_per_cluster;
756}
757
Mark Fashehebcee4b2008-07-28 14:55:20 -0700758static inline unsigned int ocfs2_megabytes_to_clusters(struct super_block *sb,
759 unsigned int megs)
760{
761 BUILD_BUG_ON(OCFS2_MAX_CLUSTERSIZE > 1048576);
762
763 return megs << (20 - OCFS2_SB(sb)->s_clustersize_bits);
764}
765
Mark Fashehb4414ee2010-03-11 18:31:09 -0800766static inline void _ocfs2_set_bit(unsigned int bit, unsigned long *bitmap)
767{
768 ext2_set_bit(bit, bitmap);
769}
770#define ocfs2_set_bit(bit, addr) _ocfs2_set_bit((bit), (unsigned long *)(addr))
771
772static inline void _ocfs2_clear_bit(unsigned int bit, unsigned long *bitmap)
773{
774 ext2_clear_bit(bit, bitmap);
775}
776#define ocfs2_clear_bit(bit, addr) _ocfs2_clear_bit((bit), (unsigned long *)(addr))
777
Mark Fashehccd979b2005-12-15 14:31:24 -0800778#define ocfs2_test_bit ext2_test_bit
779#define ocfs2_find_next_zero_bit ext2_find_next_zero_bit
Joel Becker70ad1ba2008-10-16 17:54:25 -0700780#define ocfs2_find_next_bit ext2_find_next_bit
Mark Fashehccd979b2005-12-15 14:31:24 -0800781#endif /* OCFS2_H */
782