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