blob: 1445e3a56ed45695428a1633a344c2f5f6462d1b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/fs/hfs/hfs.h
3 *
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 */
8
9#ifndef _HFS_H
10#define _HFS_H
11
12/* offsets to various blocks */
13#define HFS_DD_BLK 0 /* Driver Descriptor block */
14#define HFS_PMAP_BLK 1 /* First block of partition map */
15#define HFS_MDB_BLK 2 /* Block (w/i partition) of MDB */
16
17/* magic numbers for various disk blocks */
18#define HFS_DRVR_DESC_MAGIC 0x4552 /* "ER": driver descriptor map */
19#define HFS_OLD_PMAP_MAGIC 0x5453 /* "TS": old-type partition map */
20#define HFS_NEW_PMAP_MAGIC 0x504D /* "PM": new-type partition map */
21#define HFS_SUPER_MAGIC 0x4244 /* "BD": HFS MDB (super block) */
22#define HFS_MFS_SUPER_MAGIC 0xD2D7 /* MFS MDB (super block) */
23
24/* various FIXED size parameters */
25#define HFS_SECTOR_SIZE 512 /* size of an HFS sector */
26#define HFS_SECTOR_SIZE_BITS 9 /* log_2(HFS_SECTOR_SIZE) */
27#define HFS_NAMELEN 31 /* maximum length of an HFS filename */
Roman Zippel328b9222005-09-06 15:18:49 -070028#define HFS_MAX_NAMELEN 128
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#define HFS_MAX_VALENCE 32767U
30
31/* Meanings of the drAtrb field of the MDB,
32 * Reference: _Inside Macintosh: Files_ p. 2-61
33 */
34#define HFS_SB_ATTRIB_HLOCK (1 << 7)
35#define HFS_SB_ATTRIB_UNMNT (1 << 8)
36#define HFS_SB_ATTRIB_SPARED (1 << 9)
37#define HFS_SB_ATTRIB_INCNSTNT (1 << 11)
38#define HFS_SB_ATTRIB_SLOCK (1 << 15)
39
40/* Some special File ID numbers */
41#define HFS_POR_CNID 1 /* Parent Of the Root */
42#define HFS_ROOT_CNID 2 /* ROOT directory */
43#define HFS_EXT_CNID 3 /* EXTents B-tree */
44#define HFS_CAT_CNID 4 /* CATalog B-tree */
45#define HFS_BAD_CNID 5 /* BAD blocks file */
46#define HFS_ALLOC_CNID 6 /* ALLOCation file (HFS+) */
47#define HFS_START_CNID 7 /* STARTup file (HFS+) */
48#define HFS_ATTR_CNID 8 /* ATTRibutes file (HFS+) */
49#define HFS_EXCH_CNID 15 /* ExchangeFiles temp id */
50#define HFS_FIRSTUSER_CNID 16
51
52/* values for hfs_cat_rec.cdrType */
53#define HFS_CDR_DIR 0x01 /* folder (directory) */
54#define HFS_CDR_FIL 0x02 /* file */
55#define HFS_CDR_THD 0x03 /* folder (directory) thread */
56#define HFS_CDR_FTH 0x04 /* file thread */
57
58/* legal values for hfs_ext_key.FkType and hfs_file.fork */
59#define HFS_FK_DATA 0x00
60#define HFS_FK_RSRC 0xFF
61
62/* bits in hfs_fil_entry.Flags */
63#define HFS_FIL_LOCK 0x01 /* locked */
64#define HFS_FIL_THD 0x02 /* file thread */
65#define HFS_FIL_DOPEN 0x04 /* data fork open */
66#define HFS_FIL_ROPEN 0x08 /* resource fork open */
67#define HFS_FIL_DIR 0x10 /* directory (always clear) */
68#define HFS_FIL_NOCOPY 0x40 /* copy-protected file */
69#define HFS_FIL_USED 0x80 /* open */
70
71/* bits in hfs_dir_entry.Flags. dirflags is 16 bits. */
72#define HFS_DIR_LOCK 0x01 /* locked */
73#define HFS_DIR_THD 0x02 /* directory thread */
74#define HFS_DIR_INEXPFOLDER 0x04 /* in a shared area */
75#define HFS_DIR_MOUNTED 0x08 /* mounted */
76#define HFS_DIR_DIR 0x10 /* directory (always set) */
77#define HFS_DIR_EXPFOLDER 0x20 /* share point */
78
79/* bits hfs_finfo.fdFlags */
80#define HFS_FLG_INITED 0x0100
81#define HFS_FLG_LOCKED 0x1000
82#define HFS_FLG_INVISIBLE 0x4000
83
84/*======== HFS structures as they appear on the disk ========*/
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086/* Pascal-style string of up to 31 characters */
87struct hfs_name {
88 u8 len;
89 u8 name[HFS_NAMELEN];
90} __packed;
91
92struct hfs_point {
93 __be16 v;
94 __be16 h;
95} __packed;
96
97struct hfs_rect {
98 __be16 top;
99 __be16 left;
100 __be16 bottom;
101 __be16 right;
102} __packed;
103
104struct hfs_finfo {
105 __be32 fdType;
106 __be32 fdCreator;
107 __be16 fdFlags;
108 struct hfs_point fdLocation;
109 __be16 fdFldr;
110} __packed;
111
112struct hfs_fxinfo {
113 __be16 fdIconID;
114 u8 fdUnused[8];
115 __be16 fdComment;
116 __be32 fdPutAway;
117} __packed;
118
119struct hfs_dinfo {
120 struct hfs_rect frRect;
121 __be16 frFlags;
122 struct hfs_point frLocation;
123 __be16 frView;
124} __packed;
125
126struct hfs_dxinfo {
127 struct hfs_point frScroll;
128 __be32 frOpenChain;
129 __be16 frUnused;
130 __be16 frComment;
131 __be32 frPutAway;
132} __packed;
133
134union hfs_finder_info {
135 struct {
136 struct hfs_finfo finfo;
137 struct hfs_fxinfo fxinfo;
138 } file;
139 struct {
140 struct hfs_dinfo dinfo;
141 struct hfs_dxinfo dxinfo;
142 } dir;
143} __packed;
144
145/* Cast to a pointer to a generic bkey */
146#define HFS_BKEY(X) (((void)((X)->KeyLen)), ((struct hfs_bkey *)(X)))
147
148/* The key used in the catalog b-tree: */
149struct hfs_cat_key {
150 u8 key_len; /* number of bytes in the key */
151 u8 reserved; /* padding */
152 __be32 ParID; /* CNID of the parent dir */
153 struct hfs_name CName; /* The filename of the entry */
154} __packed;
155
156/* The key used in the extents b-tree: */
157struct hfs_ext_key {
158 u8 key_len; /* number of bytes in the key */
159 u8 FkType; /* HFS_FK_{DATA,RSRC} */
160 __be32 FNum; /* The File ID of the file */
161 __be16 FABN; /* allocation blocks number*/
162} __packed;
163
164typedef union hfs_btree_key {
165 u8 key_len; /* number of bytes in the key */
166 struct hfs_cat_key cat;
167 struct hfs_ext_key ext;
168} hfs_btree_key;
169
170typedef union hfs_btree_key btree_key;
171
172struct hfs_extent {
173 __be16 block;
174 __be16 count;
175};
176typedef struct hfs_extent hfs_extent_rec[3];
177
178/* The catalog record for a file */
179struct hfs_cat_file {
180 s8 type; /* The type of entry */
181 u8 reserved;
182 u8 Flags; /* Flags such as read-only */
183 s8 Typ; /* file version number = 0 */
184 struct hfs_finfo UsrWds; /* data used by the Finder */
185 __be32 FlNum; /* The CNID */
186 __be16 StBlk; /* obsolete */
187 __be32 LgLen; /* The logical EOF of the data fork*/
188 __be32 PyLen; /* The physical EOF of the data fork */
189 __be16 RStBlk; /* obsolete */
190 __be32 RLgLen; /* The logical EOF of the rsrc fork */
191 __be32 RPyLen; /* The physical EOF of the rsrc fork */
192 __be32 CrDat; /* The creation date */
193 __be32 MdDat; /* The modified date */
194 __be32 BkDat; /* The last backup date */
195 struct hfs_fxinfo FndrInfo; /* more data for the Finder */
196 __be16 ClpSize; /* number of bytes to allocate
197 when extending files */
198 hfs_extent_rec ExtRec; /* first extent record
199 for the data fork */
200 hfs_extent_rec RExtRec; /* first extent record
201 for the resource fork */
202 u32 Resrv; /* reserved by Apple */
203} __packed;
204
205/* the catalog record for a directory */
206struct hfs_cat_dir {
207 s8 type; /* The type of entry */
208 u8 reserved;
209 __be16 Flags; /* flags */
210 __be16 Val; /* Valence: number of files and
211 dirs in the directory */
212 __be32 DirID; /* The CNID */
213 __be32 CrDat; /* The creation date */
214 __be32 MdDat; /* The modification date */
215 __be32 BkDat; /* The last backup date */
216 struct hfs_dinfo UsrInfo; /* data used by the Finder */
217 struct hfs_dxinfo FndrInfo; /* more data used by Finder */
218 u8 Resrv[16]; /* reserved by Apple */
219} __packed;
220
221/* the catalog record for a thread */
222struct hfs_cat_thread {
223 s8 type; /* The type of entry */
224 u8 reserved[9]; /* reserved by Apple */
225 __be32 ParID; /* CNID of parent directory */
226 struct hfs_name CName; /* The name of this entry */
227} __packed;
228
229/* A catalog tree record */
230typedef union hfs_cat_rec {
231 s8 type; /* The type of entry */
232 struct hfs_cat_file file;
233 struct hfs_cat_dir dir;
234 struct hfs_cat_thread thread;
235} hfs_cat_rec;
236
237struct hfs_mdb {
238 __be16 drSigWord; /* Signature word indicating fs type */
239 __be32 drCrDate; /* fs creation date/time */
240 __be32 drLsMod; /* fs modification date/time */
241 __be16 drAtrb; /* fs attributes */
242 __be16 drNmFls; /* number of files in root directory */
243 __be16 drVBMSt; /* location (in 512-byte blocks)
244 of the volume bitmap */
245 __be16 drAllocPtr; /* location (in allocation blocks)
246 to begin next allocation search */
247 __be16 drNmAlBlks; /* number of allocation blocks */
248 __be32 drAlBlkSiz; /* bytes in an allocation block */
249 __be32 drClpSiz; /* clumpsize, the number of bytes to
250 allocate when extending a file */
251 __be16 drAlBlSt; /* location (in 512-byte blocks)
252 of the first allocation block */
253 __be32 drNxtCNID; /* CNID to assign to the next
254 file or directory created */
255 __be16 drFreeBks; /* number of free allocation blocks */
256 u8 drVN[28]; /* the volume label */
257 __be32 drVolBkUp; /* fs backup date/time */
258 __be16 drVSeqNum; /* backup sequence number */
259 __be32 drWrCnt; /* fs write count */
260 __be32 drXTClpSiz; /* clumpsize for the extents B-tree */
261 __be32 drCTClpSiz; /* clumpsize for the catalog B-tree */
262 __be16 drNmRtDirs; /* number of directories in
263 the root directory */
264 __be32 drFilCnt; /* number of files in the fs */
265 __be32 drDirCnt; /* number of directories in the fs */
266 u8 drFndrInfo[32]; /* data used by the Finder */
267 __be16 drEmbedSigWord; /* embedded volume signature */
268 __be32 drEmbedExtent; /* starting block number (xdrStABN)
269 and number of allocation blocks
270 (xdrNumABlks) occupied by embedded
271 volume */
272 __be32 drXTFlSize; /* bytes in the extents B-tree */
273 hfs_extent_rec drXTExtRec; /* extents B-tree's first 3 extents */
274 __be32 drCTFlSize; /* bytes in the catalog B-tree */
275 hfs_extent_rec drCTExtRec; /* catalog B-tree's first 3 extents */
276} __packed;
277
278/*======== Data structures kept in memory ========*/
279
280struct hfs_readdir_data {
281 struct list_head list;
282 struct file *file;
283 struct hfs_cat_key key;
284};
285
286#endif