xref: /openbmc/linux/fs/gfs2/incore.h (revision 732a675a)
1 /*
2  * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
3  * Copyright (C) 2004-2008 Red Hat, Inc.  All rights reserved.
4  *
5  * This copyrighted material is made available to anyone wishing to use,
6  * modify, copy, or redistribute it subject to the terms and conditions
7  * of the GNU General Public License version 2.
8  */
9 
10 #ifndef __INCORE_DOT_H__
11 #define __INCORE_DOT_H__
12 
13 #include <linux/fs.h>
14 #include <linux/workqueue.h>
15 
16 #define DIO_WAIT	0x00000010
17 #define DIO_METADATA	0x00000020
18 #define DIO_ALL		0x00000100
19 
20 struct gfs2_log_operations;
21 struct gfs2_log_element;
22 struct gfs2_holder;
23 struct gfs2_glock;
24 struct gfs2_quota_data;
25 struct gfs2_trans;
26 struct gfs2_ail;
27 struct gfs2_jdesc;
28 struct gfs2_sbd;
29 
30 typedef void (*gfs2_glop_bh_t) (struct gfs2_glock *gl, unsigned int ret);
31 
32 struct gfs2_log_header_host {
33 	u64 lh_sequence;	/* Sequence number of this transaction */
34 	u32 lh_flags;		/* GFS2_LOG_HEAD_... */
35 	u32 lh_tail;		/* Block number of log tail */
36 	u32 lh_blkno;
37 	u32 lh_hash;
38 };
39 
40 /*
41  * Structure of operations that are associated with each
42  * type of element in the log.
43  */
44 
45 struct gfs2_log_operations {
46 	void (*lo_add) (struct gfs2_sbd *sdp, struct gfs2_log_element *le);
47 	void (*lo_before_commit) (struct gfs2_sbd *sdp);
48 	void (*lo_after_commit) (struct gfs2_sbd *sdp, struct gfs2_ail *ai);
49 	void (*lo_before_scan) (struct gfs2_jdesc *jd,
50 				struct gfs2_log_header_host *head, int pass);
51 	int (*lo_scan_elements) (struct gfs2_jdesc *jd, unsigned int start,
52 				 struct gfs2_log_descriptor *ld, __be64 *ptr,
53 				 int pass);
54 	void (*lo_after_scan) (struct gfs2_jdesc *jd, int error, int pass);
55 	const char *lo_name;
56 };
57 
58 struct gfs2_log_element {
59 	struct list_head le_list;
60 	const struct gfs2_log_operations *le_ops;
61 };
62 
63 struct gfs2_bitmap {
64 	struct buffer_head *bi_bh;
65 	char *bi_clone;
66 	u32 bi_offset;
67 	u32 bi_start;
68 	u32 bi_len;
69 };
70 
71 struct gfs2_rgrp_host {
72 	u32 rg_free;
73 	u32 rg_dinodes;
74 	u64 rg_igeneration;
75 };
76 
77 struct gfs2_rgrpd {
78 	struct list_head rd_list;	/* Link with superblock */
79 	struct list_head rd_list_mru;
80 	struct list_head rd_recent;	/* Recently used rgrps */
81 	struct gfs2_glock *rd_gl;	/* Glock for this rgrp */
82 	u64 rd_addr;			/* grp block disk address */
83 	u64 rd_data0;			/* first data location */
84 	u32 rd_length;			/* length of rgrp header in fs blocks */
85 	u32 rd_data;			/* num of data blocks in rgrp */
86 	u32 rd_bitbytes;		/* number of bytes in data bitmaps */
87 	struct gfs2_rgrp_host rd_rg;
88 	struct gfs2_bitmap *rd_bits;
89 	unsigned int rd_bh_count;
90 	struct mutex rd_mutex;
91 	u32 rd_free_clone;
92 	struct gfs2_log_element rd_le;
93 	u32 rd_last_alloc;
94 	struct gfs2_sbd *rd_sbd;
95 	unsigned char rd_flags;
96 #define GFS2_RDF_CHECK        0x01      /* Need to check for unlinked inodes */
97 #define GFS2_RDF_NOALLOC      0x02      /* rg prohibits allocation */
98 #define GFS2_RDF_UPTODATE     0x04      /* rg is up to date */
99 };
100 
101 enum gfs2_state_bits {
102 	BH_Pinned = BH_PrivateStart,
103 	BH_Escaped = BH_PrivateStart + 1,
104 };
105 
106 BUFFER_FNS(Pinned, pinned)
107 TAS_BUFFER_FNS(Pinned, pinned)
108 BUFFER_FNS(Escaped, escaped)
109 TAS_BUFFER_FNS(Escaped, escaped)
110 
111 struct gfs2_bufdata {
112 	struct buffer_head *bd_bh;
113 	struct gfs2_glock *bd_gl;
114 
115 	union {
116 		struct list_head list_tr;
117 		u64 blkno;
118 	} u;
119 #define bd_list_tr u.list_tr
120 #define bd_blkno u.blkno
121 
122 	struct gfs2_log_element bd_le;
123 
124 	struct gfs2_ail *bd_ail;
125 	struct list_head bd_ail_st_list;
126 	struct list_head bd_ail_gl_list;
127 };
128 
129 struct gfs2_glock_operations {
130 	void (*go_xmote_th) (struct gfs2_glock *gl);
131 	void (*go_xmote_bh) (struct gfs2_glock *gl);
132 	void (*go_inval) (struct gfs2_glock *gl, int flags);
133 	int (*go_demote_ok) (struct gfs2_glock *gl);
134 	int (*go_lock) (struct gfs2_holder *gh);
135 	void (*go_unlock) (struct gfs2_holder *gh);
136 	const int go_type;
137 	const unsigned long go_min_hold_time;
138 };
139 
140 enum {
141 	/* States */
142 	HIF_HOLDER		= 6,
143 	HIF_FIRST		= 7,
144 	HIF_ABORTED		= 9,
145 	HIF_WAIT		= 10,
146 };
147 
148 struct gfs2_holder {
149 	struct list_head gh_list;
150 
151 	struct gfs2_glock *gh_gl;
152 	struct pid *gh_owner_pid;
153 	unsigned int gh_state;
154 	unsigned gh_flags;
155 
156 	int gh_error;
157 	unsigned long gh_iflags;
158 	unsigned long gh_ip;
159 };
160 
161 enum {
162 	GLF_LOCK		= 1,
163 	GLF_STICKY		= 2,
164 	GLF_DEMOTE		= 3,
165 	GLF_PENDING_DEMOTE	= 4,
166 	GLF_DIRTY		= 5,
167 	GLF_DEMOTE_IN_PROGRESS	= 6,
168 	GLF_LFLUSH		= 7,
169 	GLF_WAITERS2		= 8,
170 	GLF_CONV_DEADLK		= 9,
171 };
172 
173 struct gfs2_glock {
174 	struct hlist_node gl_list;
175 	unsigned long gl_flags;		/* GLF_... */
176 	struct lm_lockname gl_name;
177 	atomic_t gl_ref;
178 
179 	spinlock_t gl_spin;
180 
181 	unsigned int gl_state;
182 	unsigned int gl_hash;
183 	unsigned int gl_demote_state; /* state requested by remote node */
184 	unsigned long gl_demote_time; /* time of first demote request */
185 	struct pid *gl_owner_pid;
186 	unsigned long gl_ip;
187 	struct list_head gl_holders;
188 	struct list_head gl_waiters1;	/* HIF_MUTEX */
189 	struct list_head gl_waiters3;	/* HIF_PROMOTE */
190 
191 	const struct gfs2_glock_operations *gl_ops;
192 
193 	struct gfs2_holder *gl_req_gh;
194 
195 	void *gl_lock;
196 	char *gl_lvb;
197 	atomic_t gl_lvb_count;
198 
199 	unsigned long gl_stamp;
200 	unsigned long gl_tchange;
201 	void *gl_object;
202 
203 	struct list_head gl_reclaim;
204 
205 	struct gfs2_sbd *gl_sbd;
206 
207 	struct inode *gl_aspace;
208 	struct list_head gl_ail_list;
209 	atomic_t gl_ail_count;
210 	struct delayed_work gl_work;
211 };
212 
213 #define GFS2_MIN_LVB_SIZE 32	/* Min size of LVB that gfs2 supports */
214 
215 struct gfs2_alloc {
216 	/* Quota stuff */
217 
218 	struct gfs2_quota_data *al_qd[2*MAXQUOTAS];
219 	struct gfs2_holder al_qd_ghs[2*MAXQUOTAS];
220 	unsigned int al_qd_num;
221 
222 	u32 al_requested; /* Filled in by caller of gfs2_inplace_reserve() */
223 	u32 al_alloced; /* Filled in by gfs2_alloc_*() */
224 
225 	/* Filled in by gfs2_inplace_reserve() */
226 
227 	unsigned int al_line;
228 	char *al_file;
229 	struct gfs2_holder al_ri_gh;
230 	struct gfs2_holder al_rgd_gh;
231 	struct gfs2_rgrpd *al_rgd;
232 
233 };
234 
235 enum {
236 	GIF_INVALID		= 0,
237 	GIF_QD_LOCKED		= 1,
238 	GIF_SW_PAGED		= 3,
239 	GIF_USER                = 4, /* user inode, not metadata addr space */
240 };
241 
242 struct gfs2_dinode_host {
243 	u64 di_size;		/* number of bytes in file */
244 	u64 di_generation;	/* generation number for NFS */
245 	u32 di_flags;		/* GFS2_DIF_... */
246 	/* These only apply to directories  */
247 	u32 di_entries;		/* The number of entries in the directory */
248 	u64 di_eattr;		/* extended attribute block number */
249 };
250 
251 struct gfs2_inode {
252 	struct inode i_inode;
253 	u64 i_no_addr;
254 	u64 i_no_formal_ino;
255 	unsigned long i_flags;		/* GIF_... */
256 
257 	struct gfs2_dinode_host i_di; /* To be replaced by ref to block */
258 
259 	struct gfs2_glock *i_gl; /* Move into i_gh? */
260 	struct gfs2_holder i_iopen_gh;
261 	struct gfs2_holder i_gh; /* for prepare/commit_write only */
262 	struct gfs2_alloc *i_alloc;
263 	u64 i_goal;	/* goal block for allocations */
264 	struct rw_semaphore i_rw_mutex;
265 	u8 i_height;
266 	u8 i_depth;
267 };
268 
269 /*
270  * Since i_inode is the first element of struct gfs2_inode,
271  * this is effectively a cast.
272  */
273 static inline struct gfs2_inode *GFS2_I(struct inode *inode)
274 {
275 	return container_of(inode, struct gfs2_inode, i_inode);
276 }
277 
278 static inline struct gfs2_sbd *GFS2_SB(const struct inode *inode)
279 {
280 	return inode->i_sb->s_fs_info;
281 }
282 
283 struct gfs2_file {
284 	struct mutex f_fl_mutex;
285 	struct gfs2_holder f_fl_gh;
286 };
287 
288 struct gfs2_revoke_replay {
289 	struct list_head rr_list;
290 	u64 rr_blkno;
291 	unsigned int rr_where;
292 };
293 
294 enum {
295 	QDF_USER		= 0,
296 	QDF_CHANGE		= 1,
297 	QDF_LOCKED		= 2,
298 };
299 
300 struct gfs2_quota_data {
301 	struct list_head qd_list;
302 	unsigned int qd_count;
303 
304 	u32 qd_id;
305 	unsigned long qd_flags;		/* QDF_... */
306 
307 	s64 qd_change;
308 	s64 qd_change_sync;
309 
310 	unsigned int qd_slot;
311 	unsigned int qd_slot_count;
312 
313 	struct buffer_head *qd_bh;
314 	struct gfs2_quota_change *qd_bh_qc;
315 	unsigned int qd_bh_count;
316 
317 	struct gfs2_glock *qd_gl;
318 	struct gfs2_quota_lvb qd_qb;
319 
320 	u64 qd_sync_gen;
321 	unsigned long qd_last_warn;
322 	unsigned long qd_last_touched;
323 };
324 
325 struct gfs2_trans {
326 	unsigned long tr_ip;
327 
328 	unsigned int tr_blocks;
329 	unsigned int tr_revokes;
330 	unsigned int tr_reserved;
331 
332 	struct gfs2_holder tr_t_gh;
333 
334 	int tr_touched;
335 
336 	unsigned int tr_num_buf;
337 	unsigned int tr_num_buf_new;
338 	unsigned int tr_num_databuf_new;
339 	unsigned int tr_num_buf_rm;
340 	unsigned int tr_num_databuf_rm;
341 	struct list_head tr_list_buf;
342 
343 	unsigned int tr_num_revoke;
344 	unsigned int tr_num_revoke_rm;
345 };
346 
347 struct gfs2_ail {
348 	struct list_head ai_list;
349 
350 	unsigned int ai_first;
351 	struct list_head ai_ail1_list;
352 	struct list_head ai_ail2_list;
353 
354 	u64 ai_sync_gen;
355 };
356 
357 struct gfs2_journal_extent {
358 	struct list_head extent_list;
359 
360 	unsigned int lblock; /* First logical block */
361 	u64 dblock; /* First disk block */
362 	u64 blocks;
363 };
364 
365 struct gfs2_jdesc {
366 	struct list_head jd_list;
367 	struct list_head extent_list;
368 
369 	struct inode *jd_inode;
370 	unsigned int jd_jid;
371 	int jd_dirty;
372 
373 	unsigned int jd_blocks;
374 };
375 
376 struct gfs2_statfs_change_host {
377 	s64 sc_total;
378 	s64 sc_free;
379 	s64 sc_dinodes;
380 };
381 
382 #define GFS2_GLOCKD_DEFAULT	1
383 #define GFS2_GLOCKD_MAX		16
384 
385 #define GFS2_QUOTA_DEFAULT	GFS2_QUOTA_OFF
386 #define GFS2_QUOTA_OFF		0
387 #define GFS2_QUOTA_ACCOUNT	1
388 #define GFS2_QUOTA_ON		2
389 
390 #define GFS2_DATA_DEFAULT	GFS2_DATA_ORDERED
391 #define GFS2_DATA_WRITEBACK	1
392 #define GFS2_DATA_ORDERED	2
393 
394 struct gfs2_args {
395 	char ar_lockproto[GFS2_LOCKNAME_LEN]; /* Name of the Lock Protocol */
396 	char ar_locktable[GFS2_LOCKNAME_LEN]; /* Name of the Lock Table */
397 	char ar_hostdata[GFS2_LOCKNAME_LEN]; /* Host specific data */
398 	int ar_spectator; /* Don't get a journal because we're always RO */
399 	int ar_ignore_local_fs; /* Don't optimize even if local_fs is 1 */
400 	int ar_localflocks; /* Let the VFS do flock|fcntl locks for us */
401 	int ar_localcaching; /* Local-style caching (dangerous on multihost) */
402 	int ar_debug; /* Oops on errors instead of trying to be graceful */
403 	int ar_upgrade; /* Upgrade ondisk/multihost format */
404 	unsigned int ar_num_glockd; /* Number of glockd threads */
405 	int ar_posix_acl; /* Enable posix acls */
406 	int ar_quota; /* off/account/on */
407 	int ar_suiddir; /* suiddir support */
408 	int ar_data; /* ordered/writeback */
409 };
410 
411 struct gfs2_tune {
412 	spinlock_t gt_spin;
413 
414 	unsigned int gt_demote_secs; /* Cache retention for unheld glock */
415 	unsigned int gt_incore_log_blocks;
416 	unsigned int gt_log_flush_secs;
417 
418 	unsigned int gt_recoverd_secs;
419 	unsigned int gt_logd_secs;
420 	unsigned int gt_quotad_secs;
421 
422 	unsigned int gt_quota_simul_sync; /* Max quotavals to sync at once */
423 	unsigned int gt_quota_warn_period; /* Secs between quota warn msgs */
424 	unsigned int gt_quota_scale_num; /* Numerator */
425 	unsigned int gt_quota_scale_den; /* Denominator */
426 	unsigned int gt_quota_cache_secs;
427 	unsigned int gt_quota_quantum; /* Secs between syncs to quota file */
428 	unsigned int gt_atime_quantum; /* Min secs between atime updates */
429 	unsigned int gt_new_files_jdata;
430 	unsigned int gt_new_files_directio;
431 	unsigned int gt_max_readahead; /* Max bytes to read-ahead from disk */
432 	unsigned int gt_stall_secs; /* Detects trouble! */
433 	unsigned int gt_complain_secs;
434 	unsigned int gt_statfs_quantum;
435 	unsigned int gt_statfs_slow;
436 };
437 
438 enum {
439 	SDF_JOURNAL_CHECKED	= 0,
440 	SDF_JOURNAL_LIVE	= 1,
441 	SDF_SHUTDOWN		= 2,
442 	SDF_NOATIME		= 3,
443 };
444 
445 #define GFS2_FSNAME_LEN		256
446 
447 struct gfs2_inum_host {
448 	u64 no_formal_ino;
449 	u64 no_addr;
450 };
451 
452 struct gfs2_sb_host {
453 	u32 sb_magic;
454 	u32 sb_type;
455 	u32 sb_format;
456 
457 	u32 sb_fs_format;
458 	u32 sb_multihost_format;
459 	u32 sb_bsize;
460 	u32 sb_bsize_shift;
461 
462 	struct gfs2_inum_host sb_master_dir;
463 	struct gfs2_inum_host sb_root_dir;
464 
465 	char sb_lockproto[GFS2_LOCKNAME_LEN];
466 	char sb_locktable[GFS2_LOCKNAME_LEN];
467 };
468 
469 struct gfs2_sbd {
470 	struct super_block *sd_vfs;
471 	struct super_block *sd_vfs_meta;
472 	struct kobject sd_kobj;
473 	unsigned long sd_flags;	/* SDF_... */
474 	struct gfs2_sb_host sd_sb;
475 
476 	/* Constants computed on mount */
477 
478 	u32 sd_fsb2bb;
479 	u32 sd_fsb2bb_shift;
480 	u32 sd_diptrs;	/* Number of pointers in a dinode */
481 	u32 sd_inptrs;	/* Number of pointers in a indirect block */
482 	u32 sd_jbsize;	/* Size of a journaled data block */
483 	u32 sd_hash_bsize;	/* sizeof(exhash block) */
484 	u32 sd_hash_bsize_shift;
485 	u32 sd_hash_ptrs;	/* Number of pointers in a hash block */
486 	u32 sd_qc_per_block;
487 	u32 sd_max_dirres;	/* Max blocks needed to add a directory entry */
488 	u32 sd_max_height;	/* Max height of a file's metadata tree */
489 	u64 sd_heightsize[GFS2_MAX_META_HEIGHT + 1];
490 	u32 sd_max_jheight; /* Max height of journaled file's meta tree */
491 	u64 sd_jheightsize[GFS2_MAX_META_HEIGHT + 1];
492 
493 	struct gfs2_args sd_args;	/* Mount arguments */
494 	struct gfs2_tune sd_tune;	/* Filesystem tuning structure */
495 
496 	/* Lock Stuff */
497 
498 	struct lm_lockstruct sd_lockstruct;
499 	struct list_head sd_reclaim_list;
500 	spinlock_t sd_reclaim_lock;
501 	wait_queue_head_t sd_reclaim_wq;
502 	atomic_t sd_reclaim_count;
503 	struct gfs2_holder sd_live_gh;
504 	struct gfs2_glock *sd_rename_gl;
505 	struct gfs2_glock *sd_trans_gl;
506 
507 	/* Inode Stuff */
508 
509 	struct inode *sd_master_dir;
510 	struct inode *sd_jindex;
511 	struct inode *sd_inum_inode;
512 	struct inode *sd_statfs_inode;
513 	struct inode *sd_ir_inode;
514 	struct inode *sd_sc_inode;
515 	struct inode *sd_qc_inode;
516 	struct inode *sd_rindex;
517 	struct inode *sd_quota_inode;
518 
519 	/* Inum stuff */
520 
521 	struct mutex sd_inum_mutex;
522 
523 	/* StatFS stuff */
524 
525 	spinlock_t sd_statfs_spin;
526 	struct gfs2_statfs_change_host sd_statfs_master;
527 	struct gfs2_statfs_change_host sd_statfs_local;
528 	unsigned long sd_statfs_sync_time;
529 
530 	/* Resource group stuff */
531 
532 	int sd_rindex_uptodate;
533 	spinlock_t sd_rindex_spin;
534 	struct mutex sd_rindex_mutex;
535 	struct list_head sd_rindex_list;
536 	struct list_head sd_rindex_mru_list;
537 	struct list_head sd_rindex_recent_list;
538 	struct gfs2_rgrpd *sd_rindex_forward;
539 	unsigned int sd_rgrps;
540 
541 	/* Journal index stuff */
542 
543 	struct list_head sd_jindex_list;
544 	spinlock_t sd_jindex_spin;
545 	struct mutex sd_jindex_mutex;
546 	unsigned int sd_journals;
547 	unsigned long sd_jindex_refresh_time;
548 
549 	struct gfs2_jdesc *sd_jdesc;
550 	struct gfs2_holder sd_journal_gh;
551 	struct gfs2_holder sd_jinode_gh;
552 
553 	struct gfs2_holder sd_ir_gh;
554 	struct gfs2_holder sd_sc_gh;
555 	struct gfs2_holder sd_qc_gh;
556 
557 	/* Daemon stuff */
558 
559 	struct task_struct *sd_recoverd_process;
560 	struct task_struct *sd_logd_process;
561 	struct task_struct *sd_quotad_process;
562 	struct task_struct *sd_glockd_process[GFS2_GLOCKD_MAX];
563 	unsigned int sd_glockd_num;
564 
565 	/* Quota stuff */
566 
567 	struct list_head sd_quota_list;
568 	atomic_t sd_quota_count;
569 	spinlock_t sd_quota_spin;
570 	struct mutex sd_quota_mutex;
571 
572 	unsigned int sd_quota_slots;
573 	unsigned int sd_quota_chunks;
574 	unsigned char **sd_quota_bitmap;
575 
576 	u64 sd_quota_sync_gen;
577 	unsigned long sd_quota_sync_time;
578 
579 	/* Log stuff */
580 
581 	spinlock_t sd_log_lock;
582 
583 	unsigned int sd_log_blks_reserved;
584 	unsigned int sd_log_commited_buf;
585 	unsigned int sd_log_commited_databuf;
586 	unsigned int sd_log_commited_revoke;
587 
588 	unsigned int sd_log_num_buf;
589 	unsigned int sd_log_num_revoke;
590 	unsigned int sd_log_num_rg;
591 	unsigned int sd_log_num_databuf;
592 
593 	struct list_head sd_log_le_buf;
594 	struct list_head sd_log_le_revoke;
595 	struct list_head sd_log_le_rg;
596 	struct list_head sd_log_le_databuf;
597 	struct list_head sd_log_le_ordered;
598 
599 	atomic_t sd_log_blks_free;
600 	struct mutex sd_log_reserve_mutex;
601 
602 	u64 sd_log_sequence;
603 	unsigned int sd_log_head;
604 	unsigned int sd_log_tail;
605 	int sd_log_idle;
606 
607 	unsigned long sd_log_flush_time;
608 	struct rw_semaphore sd_log_flush_lock;
609 	atomic_t sd_log_in_flight;
610 	wait_queue_head_t sd_log_flush_wait;
611 
612 	unsigned int sd_log_flush_head;
613 	u64 sd_log_flush_wrapped;
614 
615 	struct list_head sd_ail1_list;
616 	struct list_head sd_ail2_list;
617 	u64 sd_ail_sync_gen;
618 
619 	/* Replay stuff */
620 
621 	struct list_head sd_revoke_list;
622 	unsigned int sd_replay_tail;
623 
624 	unsigned int sd_found_blocks;
625 	unsigned int sd_found_revokes;
626 	unsigned int sd_replayed_blocks;
627 
628 	/* For quiescing the filesystem */
629 
630 	struct gfs2_holder sd_freeze_gh;
631 	struct mutex sd_freeze_lock;
632 	unsigned int sd_freeze_count;
633 
634 	/* Counters */
635 
636 	atomic_t sd_reclaimed;
637 
638 	char sd_fsname[GFS2_FSNAME_LEN];
639 	char sd_table_name[GFS2_FSNAME_LEN];
640 	char sd_proto_name[GFS2_FSNAME_LEN];
641 
642 	/* Debugging crud */
643 
644 	unsigned long sd_last_warning;
645 	struct vfsmount *sd_gfs2mnt;
646 	struct dentry *debugfs_dir;    /* debugfs directory */
647 	struct dentry *debugfs_dentry_glocks; /* for debugfs */
648 };
649 
650 #endif /* __INCORE_DOT_H__ */
651 
652