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