thinkpad-acpi: documentation cleanup
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / fs / hfs / hfs_fs.h
blob9955232fdf8c977abae64e327ca250468ee74654
1 /*
2 * linux/fs/hfs/hfs_fs.h
4 * Copyright (C) 1995-1997 Paul H. Hargrove
5 * (C) 2003 Ardis Technologies <roman@ardistech.com>
6 * This file may be distributed under the terms of the GNU General Public License.
7 */
9 #ifndef _LINUX_HFS_FS_H
10 #define _LINUX_HFS_FS_H
12 #include <linux/slab.h>
13 #include <linux/types.h>
14 #include <linux/mutex.h>
15 #include <linux/buffer_head.h>
16 #include <linux/fs.h>
18 #include <asm/byteorder.h>
19 #include <asm/uaccess.h>
21 #include "hfs.h"
23 #define DBG_BNODE_REFS 0x00000001
24 #define DBG_BNODE_MOD 0x00000002
25 #define DBG_CAT_MOD 0x00000004
26 #define DBG_INODE 0x00000008
27 #define DBG_SUPER 0x00000010
28 #define DBG_EXTENT 0x00000020
29 #define DBG_BITMAP 0x00000040
31 //#define DBG_MASK (DBG_EXTENT|DBG_INODE|DBG_BNODE_MOD|DBG_CAT_MOD|DBG_BITMAP)
32 //#define DBG_MASK (DBG_BNODE_MOD|DBG_CAT_MOD|DBG_INODE)
33 //#define DBG_MASK (DBG_CAT_MOD|DBG_BNODE_REFS|DBG_INODE|DBG_EXTENT)
34 #define DBG_MASK (0)
36 #define dprint(flg, fmt, args...) \
37 if (flg & DBG_MASK) printk(fmt , ## args)
40 * struct hfs_inode_info
42 * The HFS-specific part of a Linux (struct inode)
44 struct hfs_inode_info {
45 atomic_t opencnt;
47 unsigned int flags;
49 /* to deal with localtime ugliness */
50 int tz_secondswest;
52 struct hfs_cat_key cat_key;
54 struct list_head open_dir_list;
55 struct inode *rsrc_inode;
57 struct mutex extents_lock;
59 u16 alloc_blocks, clump_blocks;
60 sector_t fs_blocks;
61 /* Allocation extents from catlog record or volume header */
62 hfs_extent_rec first_extents;
63 u16 first_blocks;
64 hfs_extent_rec cached_extents;
65 u16 cached_start, cached_blocks;
67 loff_t phys_size;
68 struct inode vfs_inode;
71 #define HFS_FLG_RSRC 0x0001
72 #define HFS_FLG_EXT_DIRTY 0x0002
73 #define HFS_FLG_EXT_NEW 0x0004
75 #define HFS_IS_RSRC(inode) (HFS_I(inode)->flags & HFS_FLG_RSRC)
78 * struct hfs_sb_info
80 * The HFS-specific part of a Linux (struct super_block)
82 struct hfs_sb_info {
83 struct buffer_head *mdb_bh; /* The hfs_buffer
84 holding the real
85 superblock (aka VIB
86 or MDB) */
87 struct hfs_mdb *mdb;
88 struct buffer_head *alt_mdb_bh; /* The hfs_buffer holding
89 the alternate superblock */
90 struct hfs_mdb *alt_mdb;
91 __be32 *bitmap; /* The page holding the
92 allocation bitmap */
93 struct hfs_btree *ext_tree; /* Information about
94 the extents b-tree */
95 struct hfs_btree *cat_tree; /* Information about
96 the catalog b-tree */
97 u32 file_count; /* The number of
98 regular files in
99 the filesystem */
100 u32 folder_count; /* The number of
101 directories in the
102 filesystem */
103 u32 next_id; /* The next available
104 file id number */
105 u32 clumpablks; /* The number of allocation
106 blocks to try to add when
107 extending a file */
108 u32 fs_start; /* The first 512-byte
109 block represented
110 in the bitmap */
111 u32 part_start;
112 u16 root_files; /* The number of
113 regular
114 (non-directory)
115 files in the root
116 directory */
117 u16 root_dirs; /* The number of
118 directories in the
119 root directory */
120 u16 fs_ablocks; /* The number of
121 allocation blocks
122 in the filesystem */
123 u16 free_ablocks; /* the number of unused
124 allocation blocks
125 in the filesystem */
126 u32 alloc_blksz; /* The size of an
127 "allocation block" */
128 int s_quiet; /* Silent failure when
129 changing owner or mode? */
130 __be32 s_type; /* Type for new files */
131 __be32 s_creator; /* Creator for new files */
132 umode_t s_file_umask; /* The umask applied to the
133 permissions on all files */
134 umode_t s_dir_umask; /* The umask applied to the
135 permissions on all dirs */
136 uid_t s_uid; /* The uid of all files */
137 gid_t s_gid; /* The gid of all files */
139 int session, part;
141 struct nls_table *nls_io, *nls_disk;
143 struct mutex bitmap_lock;
145 unsigned long flags;
147 u16 blockoffset;
149 int fs_div;
151 struct hlist_head rsrc_inodes;
154 #define HFS_FLG_BITMAP_DIRTY 0
155 #define HFS_FLG_MDB_DIRTY 1
156 #define HFS_FLG_ALT_MDB_DIRTY 2
158 /* bitmap.c */
159 extern u32 hfs_vbm_search_free(struct super_block *, u32, u32 *);
160 extern int hfs_clear_vbm_bits(struct super_block *, u16, u16);
162 /* catalog.c */
163 extern int hfs_cat_keycmp(const btree_key *, const btree_key *);
164 struct hfs_find_data;
165 extern int hfs_cat_find_brec(struct super_block *, u32, struct hfs_find_data *);
166 extern int hfs_cat_create(u32, struct inode *, struct qstr *, struct inode *);
167 extern int hfs_cat_delete(u32, struct inode *, struct qstr *);
168 extern int hfs_cat_move(u32, struct inode *, struct qstr *,
169 struct inode *, struct qstr *);
170 extern void hfs_cat_build_key(struct super_block *, btree_key *, u32, struct qstr *);
172 /* dir.c */
173 extern const struct file_operations hfs_dir_operations;
174 extern const struct inode_operations hfs_dir_inode_operations;
176 /* extent.c */
177 extern int hfs_ext_keycmp(const btree_key *, const btree_key *);
178 extern int hfs_free_fork(struct super_block *, struct hfs_cat_file *, int);
179 extern void hfs_ext_write_extent(struct inode *);
180 extern int hfs_extend_file(struct inode *);
181 extern void hfs_file_truncate(struct inode *);
183 extern int hfs_get_block(struct inode *, sector_t, struct buffer_head *, int);
185 /* inode.c */
186 extern const struct address_space_operations hfs_aops;
187 extern const struct address_space_operations hfs_btree_aops;
189 extern struct inode *hfs_new_inode(struct inode *, struct qstr *, int);
190 extern void hfs_inode_write_fork(struct inode *, struct hfs_extent *, __be32 *, __be32 *);
191 extern int hfs_write_inode(struct inode *, int);
192 extern int hfs_inode_setattr(struct dentry *, struct iattr *);
193 extern void hfs_inode_read_fork(struct inode *inode, struct hfs_extent *ext,
194 __be32 log_size, __be32 phys_size, u32 clump_size);
195 extern struct inode *hfs_iget(struct super_block *, struct hfs_cat_key *, hfs_cat_rec *);
196 extern void hfs_clear_inode(struct inode *);
197 extern void hfs_delete_inode(struct inode *);
199 /* attr.c */
200 extern int hfs_setxattr(struct dentry *dentry, const char *name,
201 const void *value, size_t size, int flags);
202 extern ssize_t hfs_getxattr(struct dentry *dentry, const char *name,
203 void *value, size_t size);
204 extern ssize_t hfs_listxattr(struct dentry *dentry, char *buffer, size_t size);
206 /* mdb.c */
207 extern int hfs_mdb_get(struct super_block *);
208 extern void hfs_mdb_commit(struct super_block *);
209 extern void hfs_mdb_close(struct super_block *);
210 extern void hfs_mdb_put(struct super_block *);
212 /* part_tbl.c */
213 extern int hfs_part_find(struct super_block *, sector_t *, sector_t *);
215 /* string.c */
216 extern struct dentry_operations hfs_dentry_operations;
218 extern int hfs_hash_dentry(struct dentry *, struct qstr *);
219 extern int hfs_strcmp(const unsigned char *, unsigned int,
220 const unsigned char *, unsigned int);
221 extern int hfs_compare_dentry(struct dentry *, struct qstr *, struct qstr *);
223 /* trans.c */
224 extern void hfs_asc2mac(struct super_block *, struct hfs_name *, struct qstr *);
225 extern int hfs_mac2asc(struct super_block *, char *, const struct hfs_name *);
227 extern struct timezone sys_tz;
230 * There are two time systems. Both are based on seconds since
231 * a particular time/date.
232 * Unix: unsigned lil-endian since 00:00 GMT, Jan. 1, 1970
233 * mac: unsigned big-endian since 00:00 GMT, Jan. 1, 1904
236 #define __hfs_u_to_mtime(sec) cpu_to_be32(sec + 2082844800U - sys_tz.tz_minuteswest * 60)
237 #define __hfs_m_to_utime(sec) (be32_to_cpu(sec) - 2082844800U + sys_tz.tz_minuteswest * 60)
239 #define HFS_I(inode) (list_entry(inode, struct hfs_inode_info, vfs_inode))
240 #define HFS_SB(sb) ((struct hfs_sb_info *)(sb)->s_fs_info)
242 #define hfs_m_to_utime(time) (struct timespec){ .tv_sec = __hfs_m_to_utime(time) }
243 #define hfs_u_to_mtime(time) __hfs_u_to_mtime((time).tv_sec)
244 #define hfs_mtime() __hfs_u_to_mtime(get_seconds())
246 static inline const char *hfs_mdb_name(struct super_block *sb)
248 return sb->s_id;
251 static inline void hfs_bitmap_dirty(struct super_block *sb)
253 set_bit(HFS_FLG_BITMAP_DIRTY, &HFS_SB(sb)->flags);
254 sb->s_dirt = 1;
257 static inline void hfs_buffer_sync(struct buffer_head *bh)
259 while (buffer_locked(bh)) {
260 wait_on_buffer(bh);
262 if (buffer_dirty(bh)) {
263 ll_rw_block(WRITE, 1, &bh);
264 wait_on_buffer(bh);
268 #define sb_bread512(sb, sec, data) ({ \
269 struct buffer_head *__bh; \
270 sector_t __block; \
271 loff_t __start; \
272 int __offset; \
274 __start = (loff_t)(sec) << HFS_SECTOR_SIZE_BITS;\
275 __block = __start >> (sb)->s_blocksize_bits; \
276 __offset = __start & ((sb)->s_blocksize - 1); \
277 __bh = sb_bread((sb), __block); \
278 if (likely(__bh != NULL)) \
279 data = (void *)(__bh->b_data + __offset);\
280 else \
281 data = NULL; \
282 __bh; \
285 #endif