ntfs.h revision 1.11 1 /* $NetBSD: ntfs.h,v 1.11 2005/10/23 04:28:53 christos Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 1999 Semen Ustimenko
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * Id: ntfs.h,v 1.5 1999/05/12 09:42:51 semenu Exp
29 */
30
31 #if defined(__NetBSD__) && defined(_KERNEL_OPT)
32 #include "opt_ntfs.h"
33 #endif
34
35 typedef u_int64_t cn_t;
36 typedef u_int16_t wchar;
37
38 #pragma pack(1)
39 #define BBSIZE 1024
40 #define BBOFF ((off_t)(0))
41 #define BBLOCK ((daddr_t)(0))
42 #define NTFS_MFTINO 0
43 #define NTFS_VOLUMEINO 3
44 #define NTFS_ATTRDEFINO 4
45 #define NTFS_ROOTINO 5
46 #define NTFS_BITMAPINO 6
47 #define NTFS_BOOTINO 7
48 #define NTFS_BADCLUSINO 8
49 #define NTFS_UPCASEINO 10
50 #define NTFS_MAXFILENAME 255
51
52 struct fixuphdr {
53 u_int32_t fh_magic;
54 u_int16_t fh_foff;
55 u_int16_t fh_fnum;
56 };
57
58 #define NTFS_AF_INRUN 0x00000001
59 struct attrhdr {
60 u_int32_t a_type;
61 u_int32_t reclen;
62 u_int8_t a_flag;
63 u_int8_t a_namelen;
64 u_int8_t a_nameoff;
65 u_int8_t reserved1;
66 u_int8_t a_compression;
67 u_int8_t reserved2;
68 u_int16_t a_index;
69 };
70 #define NTFS_A_STD 0x10
71 #define NTFS_A_ATTRLIST 0x20
72 #define NTFS_A_NAME 0x30
73 #define NTFS_A_VOLUMENAME 0x60
74 #define NTFS_A_DATA 0x80
75 #define NTFS_A_INDXROOT 0x90
76 #define NTFS_A_INDX 0xA0
77 #define NTFS_A_INDXBITMAP 0xB0
78
79 #define NTFS_MAXATTRNAME 255
80 struct attr {
81 struct attrhdr a_hdr;
82 union {
83 struct {
84 u_int16_t a_datalen;
85 u_int16_t reserved1;
86 u_int16_t a_dataoff;
87 u_int16_t a_indexed;
88 } a_S_r;
89 struct {
90 cn_t a_vcnstart;
91 cn_t a_vcnend;
92 u_int16_t a_dataoff;
93 u_int16_t a_compressalg;
94 u_int32_t reserved1;
95 u_int64_t a_allocated;
96 u_int64_t a_datalen;
97 u_int64_t a_initialized;
98 } a_S_nr;
99 } a_S;
100 };
101 #define a_r a_S.a_S_r
102 #define a_nr a_S.a_S_nr
103
104 typedef struct {
105 u_int64_t t_create;
106 u_int64_t t_write;
107 u_int64_t t_mftwrite;
108 u_int64_t t_access;
109 } ntfs_times_t;
110
111 #define NTFS_FFLAG_RDONLY 0x01LL
112 #define NTFS_FFLAG_HIDDEN 0x02LL
113 #define NTFS_FFLAG_SYSTEM 0x04LL
114 #define NTFS_FFLAG_ARCHIVE 0x20LL
115 #define NTFS_FFLAG_COMPRESSED 0x0800LL
116 #define NTFS_FFLAG_DIR 0x10000000LL
117
118 struct attr_name {
119 u_int32_t n_pnumber; /* Parent ntnode */
120 u_int32_t reserved;
121 ntfs_times_t n_times;
122 u_int64_t n_size;
123 u_int64_t n_attrsz;
124 u_int64_t n_flag;
125 u_int8_t n_namelen;
126 u_int8_t n_nametype;
127 u_int16_t n_name[1];
128 };
129
130 #define NTFS_IRFLAG_INDXALLOC 0x00000001
131 struct attr_indexroot {
132 u_int32_t ir_unkn1; /* always 0x30 */
133 u_int32_t ir_unkn2; /* always 0x1 */
134 u_int32_t ir_size;/* ??? */
135 u_int32_t ir_unkn3; /* number of cluster */
136 u_int32_t ir_unkn4; /* always 0x10 */
137 u_int32_t ir_datalen; /* sizeof simething */
138 u_int32_t ir_allocated; /* same as above */
139 u_int16_t ir_flag;/* ?? always 1 */
140 u_int16_t ir_unkn7;
141 };
142
143 struct attr_attrlist {
144 u_int32_t al_type; /* Attribute type */
145 u_int16_t reclen; /* length of this entry */
146 u_int8_t al_namelen; /* Attribute name len */
147 u_int8_t al_nameoff; /* Name offset from entry start */
148 u_int64_t al_vcnstart; /* VCN number */
149 u_int32_t al_inumber; /* Parent ntnode */
150 u_int32_t reserved;
151 u_int16_t al_index; /* Attribute index in MFT record */
152 u_int16_t al_name[1]; /* Name */
153 };
154
155 #define NTFS_INDXMAGIC (u_int32_t)(0x58444E49)
156 struct attr_indexalloc {
157 struct fixuphdr ia_fixup;
158 u_int64_t unknown1;
159 cn_t ia_bufcn;
160 u_int16_t ia_hdrsize;
161 u_int16_t unknown2;
162 u_int32_t ia_inuse;
163 u_int32_t ia_allocated;
164 };
165
166 #define NTFS_IEFLAG_SUBNODE 0x00000001
167 #define NTFS_IEFLAG_LAST 0x00000002
168
169 struct attr_indexentry {
170 u_int32_t ie_number;
171 u_int32_t unknown1;
172 u_int16_t reclen;
173 u_int16_t ie_size;
174 u_int32_t ie_flag;/* 1 - has subnodes, 2 - last */
175 u_int32_t ie_fpnumber;
176 u_int32_t unknown2;
177 ntfs_times_t ie_ftimes;
178 u_int64_t ie_fallocated;
179 u_int64_t ie_fsize;
180 u_int64_t ie_fflag;
181 u_int8_t ie_fnamelen;
182 u_int8_t ie_fnametype;
183 wchar ie_fname[NTFS_MAXFILENAME];
184 /* cn_t ie_bufcn; buffer with subnodes */
185 };
186
187 #define NTFS_FILEMAGIC (u_int32_t)(0x454C4946)
188 #define NTFS_FRFLAG_DIR 0x0002
189 struct filerec {
190 struct fixuphdr fr_fixup;
191 u_int8_t reserved[8];
192 u_int16_t fr_seqnum; /* Sequence number */
193 u_int16_t fr_nlink;
194 u_int16_t fr_attroff; /* offset to attributes */
195 u_int16_t fr_flags; /* 1-nonresident attr, 2-directory */
196 u_int32_t fr_size;/* hdr + attributes */
197 u_int32_t fr_allocated; /* allocated length of record */
198 u_int64_t fr_mainrec; /* main record */
199 u_int16_t fr_attrnum; /* maximum attr number + 1 ??? */
200 };
201
202 #define NTFS_ATTRNAME_MAXLEN 0x40
203 #define NTFS_ADFLAG_NONRES 0x0080 /* Attrib can be non resident */
204 #define NTFS_ADFLAG_INDEX 0x0002 /* Attrib can be indexed */
205 struct attrdef {
206 wchar ad_name[NTFS_ATTRNAME_MAXLEN];
207 u_int32_t ad_type;
208 u_int32_t reserved1[2];
209 u_int32_t ad_flag;
210 u_int64_t ad_minlen;
211 u_int64_t ad_maxlen; /* -1 for nonlimited */
212 };
213
214 struct ntvattrdef {
215 char ad_name[0x40];
216 int ad_namelen;
217 u_int32_t ad_type;
218 };
219
220 #define NTFS_BBID "NTFS "
221 #define NTFS_BBIDLEN 8
222 struct bootfile {
223 u_int8_t reserved1[3]; /* asm jmp near ... */
224 u_int8_t bf_sysid[8]; /* 'NTFS ' */
225 u_int16_t bf_bps; /* bytes per sector */
226 u_int8_t bf_spc; /* sectors per cluster */
227 u_int8_t reserved2[7]; /* unused (zeroed) */
228 u_int8_t bf_media; /* media desc. (0xF8) */
229 u_int8_t reserved3[2];
230 u_int16_t bf_spt; /* sectors per track */
231 u_int16_t bf_heads; /* number of heads */
232 u_int8_t reserver4[12];
233 u_int64_t bf_spv; /* sectors per volume */
234 cn_t bf_mftcn; /* $MFT cluster number */
235 cn_t bf_mftmirrcn; /* $MFTMirr cn */
236 u_int8_t bf_mftrecsz; /* MFT record size (clust) */
237 /* 0xF6 inducates 1/4 */
238 u_int32_t bf_ibsz; /* index buffer size */
239 u_int32_t bf_volsn; /* volume ser. num. */
240 };
241
242 #pragma pack()
243
244 typedef wchar (ntfs_wget_func_t)(const char **, size_t *);
245 typedef int (ntfs_wput_func_t)(char *, size_t, wchar);
246 typedef int (ntfs_wcmp_func_t)(wchar, wchar);
247
248 #define NTFS_SYSNODESNUM 0x0B
249 struct ntfsmount {
250 struct mount *ntm_mountp; /* filesystem vfs structure */
251 struct bootfile ntm_bootfile;
252 dev_t ntm_dev; /* device mounted */
253 struct vnode *ntm_devvp; /* block device mounted vnode */
254 struct vnode *ntm_sysvn[NTFS_SYSNODESNUM];
255 u_int32_t ntm_bpmftrec;
256 uid_t ntm_uid;
257 gid_t ntm_gid;
258 mode_t ntm_mode;
259 u_long ntm_flag;
260 cn_t ntm_cfree;
261 struct ntvattrdef *ntm_ad;
262 int ntm_adnum;
263 ntfs_wget_func_t *ntm_wget; /* decode string to Unicode string */
264 ntfs_wput_func_t *ntm_wput; /* encode Unicode string to string */
265 ntfs_wcmp_func_t *ntm_wcmp; /* compare to wide characters */
266 };
267
268 #define ntm_mftcn ntm_bootfile.bf_mftcn
269 #define ntm_mftmirrcn ntm_bootfile.bf_mftmirrcn
270 #define ntm_mftrecsz ntm_bootfile.bf_mftrecsz
271 #define ntm_spc ntm_bootfile.bf_spc
272 #define ntm_bps ntm_bootfile.bf_bps
273
274 #define NTFS_NEXTREC(s, type) ((type)(((caddr_t) s) + (s)->reclen))
275
276 /* Convert mount ptr to ntfsmount ptr. */
277 #define VFSTONTFS(mp) ((struct ntfsmount *)((mp)->mnt_data))
278 #define VTONT(v) FTONT(VTOF(v))
279 #define VTOF(v) ((struct fnode *)((v)->v_data))
280 #define FTOV(f) ((f)->f_vp)
281 #define FTONT(f) ((f)->f_ip)
282 #define ntfs_cntobn(cn) (daddr_t)((cn) * (ntmp->ntm_spc))
283 #define ntfs_cntob(cn) (off_t)((cn) * (ntmp)->ntm_spc * (ntmp)->ntm_bps)
284 #define ntfs_btocn(off) (cn_t)((off) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps))
285 #define ntfs_btocl(off) (cn_t)((off + ntfs_cntob(1) - 1) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps))
286 #define ntfs_btocnoff(off) (off_t)((off) % ((ntmp)->ntm_spc * (ntmp)->ntm_bps))
287 #define ntfs_bntob(bn) (daddr_t)((bn) * (ntmp)->ntm_bps)
288
289 #define ntfs_bpbl (daddr_t)((ntmp)->ntm_bps)
290
291 #if __FreeBSD_version >= 300000 || defined(__NetBSD__)
292 MALLOC_DECLARE(M_NTFSMNT);
293 MALLOC_DECLARE(M_NTFSNTNODE);
294 MALLOC_DECLARE(M_NTFSFNODE);
295 MALLOC_DECLARE(M_NTFSDIR);
296 MALLOC_DECLARE(M_NTFSNTHASH);
297 MALLOC_DECLARE(M_NTFSNTVATTR);
298 MALLOC_DECLARE(M_NTFSRDATA);
299 MALLOC_DECLARE(M_NTFSDECOMP);
300 MALLOC_DECLARE(M_NTFSRUN);
301 #endif
302
303 #ifdef __NetBSD__
304 typedef int (vop_t)(void *);
305 #define HASHINIT(a, b, c, d) hashinit((a), HASH_LIST, (b), (c), (d))
306 #define bqrelse(bp) brelse(bp)
307 #if 0
308 #define VOP__UNLOCK(a, b, c) VOP_UNLOCK((a), (b))
309 #define VGET(a, b, c) vget((a), (b))
310 #define VN_LOCK(a, b, c) vn_lock((a), (b))
311 #endif
312 #else /* !NetBSD */
313 #define HASHINIT(a, b, c, d) hashinit((a), (b), (d))
314 #define VOP__UNLOCK(a, b, c) VOP_UNLOCK((a), (b), (c))
315 #define VGET(a, b, c) vget((a), (b), (c))
316 #define VN_LOCK(a, b, c) vn_lock((a), (b), (c))
317
318 /* PDIRUNLOCK is used by NetBSD to mark if vfs_lookup() unlocked parent dir;
319 * on FreeBSD, it's not defined and nothing similar exists */
320 #define PDIRUNLOCK 0
321 #endif /* NetBSD */
322
323 #ifdef NTFS_DEBUG
324 extern int ntfs_debug;
325 #define DPRINTF(X, Y) do { if(ntfs_debug >= (X)) printf Y; } while(0)
326 #define dprintf(a) DPRINTF(1, a)
327 #define ddprintf(a) DPRINTF(2, a)
328 #else /* NTFS_DEBUG */
329 #define DPRINTF(X, Y)
330 #define dprintf(a)
331 #define ddprintf(a)
332 #endif
333
334 extern vop_t **ntfs_vnodeop_p;
335