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