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