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