a97ead889a68beb2671f5a1c054671973ba7a77c
[linux-2.6.git] / fs / jfs / jfs_incore.h
1 /*
2  *   Copyright (C) International Business Machines Corp., 2000-2004
3  *   Portions Copyright (C) Christoph Hellwig, 2001-2002
4  *
5  *   This program is free software;  you can redistribute it and/or modify
6  *   it under the terms of the GNU General Public License as published by
7  *   the Free Software Foundation; either version 2 of the License, or 
8  *   (at your option) any later version.
9  * 
10  *   This program is distributed in the hope that it will be useful,
11  *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
13  *   the GNU General Public License for more details.
14  *
15  *   You should have received a copy of the GNU General Public License
16  *   along with this program;  if not, write to the Free Software 
17  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */ 
19 #ifndef _H_JFS_INCORE
20 #define _H_JFS_INCORE
21
22 #include <linux/mutex.h>
23 #include <linux/rwsem.h>
24 #include <linux/slab.h>
25 #include <linux/bitops.h>
26 #include "jfs_types.h"
27 #include "jfs_xtree.h"
28 #include "jfs_dtree.h"
29
30 /*
31  * JFS magic number
32  */
33 #define JFS_SUPER_MAGIC 0x3153464a /* "JFS1" */
34
35 /*
36  * JFS-private inode information
37  */
38 struct jfs_inode_info {
39         int     fileset;        /* fileset number (always 16)*/
40         uint    mode2;          /* jfs-specific mode            */
41         pxd_t   ixpxd;          /* inode extent descriptor      */
42         dxd_t   acl;            /* dxd describing acl   */
43         dxd_t   ea;             /* dxd describing ea    */
44         time_t  otime;          /* time created */
45         uint    next_index;     /* next available directory entry index */
46         int     acltype;        /* Type of ACL  */
47         short   btorder;        /* access order */
48         short   btindex;        /* btpage entry index*/
49         struct inode *ipimap;   /* inode map                    */
50         long    cflag;          /* commit flags         */
51         u16     bxflag;         /* xflag of pseudo buffer?      */
52         unchar  agno;           /* ag number                    */
53         signed char active_ag;  /* ag currently allocating from */
54         lid_t   blid;           /* lid of pseudo buffer?        */
55         lid_t   atlhead;        /* anonymous tlock list head    */
56         lid_t   atltail;        /* anonymous tlock list tail    */
57         spinlock_t ag_lock;     /* protects active_ag           */
58         struct list_head anon_inode_list; /* inodes having anonymous txns */
59         /*
60          * rdwrlock serializes xtree between reads & writes and synchronizes
61          * changes to special inodes.  It's use would be redundant on
62          * directories since the i_mutex taken in the VFS is sufficient.
63          */
64         struct rw_semaphore rdwrlock;
65         /*
66          * commit_mutex serializes transaction processing on an inode.
67          * It must be taken after beginning a transaction (txBegin), since
68          * dirty inodes may be committed while a new transaction on the
69          * inode is blocked in txBegin or TxBeginAnon
70          */
71         struct mutex commit_mutex;
72         /* xattr_sem allows us to access the xattrs without taking i_mutex */
73         struct rw_semaphore xattr_sem;
74         lid_t   xtlid;          /* lid of xtree lock on directory */
75 #ifdef CONFIG_JFS_POSIX_ACL
76         struct posix_acl *i_acl;
77         struct posix_acl *i_default_acl;
78 #endif
79         union {
80                 struct {
81                         xtpage_t _xtroot;       /* 288: xtree root */
82                         struct inomap *_imap;   /* 4: inode map header  */
83                 } file;
84                 struct {
85                         struct dir_table_slot _table[12]; /* 96: dir index */
86                         dtroot_t _dtroot;       /* 288: dtree root */
87                 } dir;
88                 struct {
89                         unchar _unused[16];     /* 16: */
90                         dxd_t _dxd;             /* 16: */
91                         unchar _inline[128];    /* 128: inline symlink */
92                         /* _inline_ea may overlay the last part of
93                          * file._xtroot if maxentry = XTROOTINITSLOT
94                          */
95                         unchar _inline_ea[128]; /* 128: inline extended attr */
96                 } link;
97         } u;
98         u32 dev;        /* will die when we get wide dev_t */
99         struct inode    vfs_inode;
100 };
101 #define i_xtroot u.file._xtroot
102 #define i_imap u.file._imap
103 #define i_dirtable u.dir._table
104 #define i_dtroot u.dir._dtroot
105 #define i_inline u.link._inline
106 #define i_inline_ea u.link._inline_ea
107
108 #define JFS_ACL_NOT_CACHED ((void *)-1)
109
110 #define IREAD_LOCK(ip)          down_read(&JFS_IP(ip)->rdwrlock)
111 #define IREAD_UNLOCK(ip)        up_read(&JFS_IP(ip)->rdwrlock)
112 #define IWRITE_LOCK(ip)         down_write(&JFS_IP(ip)->rdwrlock)
113 #define IWRITE_UNLOCK(ip)       up_write(&JFS_IP(ip)->rdwrlock)
114
115 /*
116  * cflag
117  */
118 enum cflags {
119         COMMIT_Nolink,          /* inode committed with zero link count */
120         COMMIT_Inlineea,        /* commit inode inline EA */
121         COMMIT_Freewmap,        /* free WMAP at iClose() */
122         COMMIT_Dirty,           /* Inode is really dirty */
123         COMMIT_Dirtable,        /* commit changes to di_dirtable */
124         COMMIT_Stale,           /* data extent is no longer valid */
125         COMMIT_Synclist,        /* metadata pages on group commit synclist */
126 };
127
128 #define set_cflag(flag, ip)     set_bit(flag, &(JFS_IP(ip)->cflag))
129 #define clear_cflag(flag, ip)   clear_bit(flag, &(JFS_IP(ip)->cflag))
130 #define test_cflag(flag, ip)    test_bit(flag, &(JFS_IP(ip)->cflag))
131 #define test_and_clear_cflag(flag, ip) \
132         test_and_clear_bit(flag, &(JFS_IP(ip)->cflag))
133 /*
134  * JFS-private superblock information.
135  */
136 struct jfs_sb_info {
137         struct super_block *sb;         /* Point back to vfs super block */
138         unsigned long   mntflag;        /* aggregate attributes */
139         struct inode    *ipbmap;        /* block map inode              */
140         struct inode    *ipaimap;       /* aggregate inode map inode    */
141         struct inode    *ipaimap2;      /* secondary aimap inode        */
142         struct inode    *ipimap;        /* aggregate inode map inode    */
143         struct jfs_log  *log;           /* log                  */
144         struct list_head log_list;      /* volumes associated with a journal */
145         short           bsize;          /* logical block size   */
146         short           l2bsize;        /* log2 logical block size      */
147         short           nbperpage;      /* blocks per page              */
148         short           l2nbperpage;    /* log2 blocks per page */
149         short           l2niperblk;     /* log2 inodes per page */
150         dev_t           logdev;         /* external log device  */
151         uint            aggregate;      /* volume identifier in log record */
152         pxd_t           logpxd;         /* pxd describing log   */
153         pxd_t           fsckpxd;        /* pxd describing fsck wkspc */
154         pxd_t           ait2;           /* pxd describing AIT copy      */
155         char            uuid[16];       /* 128-bit uuid for volume      */
156         char            loguuid[16];    /* 128-bit uuid for log */
157         /*
158          * commit_state is used for synchronization of the jfs_commit
159          * threads.  It is protected by LAZY_LOCK().
160          */
161         int             commit_state;   /* commit state */
162         /* Formerly in ipimap */
163         uint            gengen;         /* inode generation generator*/
164         uint            inostamp;       /* shows inode belongs to fileset*/
165
166         /* Formerly in ipbmap */
167         struct bmap     *bmap;          /* incore bmap descriptor       */
168         struct nls_table *nls_tab;      /* current codepage             */
169         struct inode *direct_inode;     /* metadata inode */
170         uint            state;          /* mount/recovery state */
171         unsigned long   flag;           /* mount time flags */
172         uint            p_state;        /* state prior to going no integrity */
173 };
174
175 /* jfs_sb_info commit_state */
176 #define IN_LAZYCOMMIT 1
177
178 static inline struct jfs_inode_info *JFS_IP(struct inode *inode)
179 {
180         return list_entry(inode, struct jfs_inode_info, vfs_inode);
181 }
182
183 static inline int jfs_dirtable_inline(struct inode *inode)
184 {
185         return (JFS_IP(inode)->next_index <= (MAX_INLINE_DIRTABLE_ENTRY + 1));
186 }
187
188 static inline struct jfs_sb_info *JFS_SBI(struct super_block *sb)
189 {
190         return sb->s_fs_info;
191 }
192
193 static inline int isReadOnly(struct inode *inode)
194 {
195         if (JFS_SBI(inode->i_sb)->log)
196                 return 0;
197         return 1;
198 }
199 #endif /* _H_JFS_INCORE */