ntfs.h revision 44142
143552Ssemenu/*- 243552Ssemenu * Copyright (c) 1998, 1999 Semen Ustimenko 343552Ssemenu * All rights reserved. 443552Ssemenu * 543552Ssemenu * Redistribution and use in source and binary forms, with or without 643552Ssemenu * modification, are permitted provided that the following conditions 743552Ssemenu * are met: 843552Ssemenu * 1. Redistributions of source code must retain the above copyright 943552Ssemenu * notice, this list of conditions and the following disclaimer. 1043552Ssemenu * 2. Redistributions in binary form must reproduce the above copyright 1143552Ssemenu * notice, this list of conditions and the following disclaimer in the 1243552Ssemenu * documentation and/or other materials provided with the distribution. 1343552Ssemenu * 1443552Ssemenu * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1543552Ssemenu * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1643552Ssemenu * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1743552Ssemenu * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1843552Ssemenu * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1943552Ssemenu * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2043552Ssemenu * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2143552Ssemenu * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2243552Ssemenu * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2343552Ssemenu * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2443552Ssemenu * SUCH DAMAGE. 2543552Ssemenu * 2643552Ssemenu * $Id: ntfs.h,v 1.9 1999/02/02 01:54:54 semen Exp $ 2743552Ssemenu */ 2843552Ssemenu 2943552Ssemenu#define DIAGNOSTIC 3043552Ssemenu/*#define NTFS_DEBUG 1*/ 3143552Ssemenu 3243552Ssemenutypedef u_int64_t cn_t; 3343552Ssemenutypedef u_int16_t wchar; 3443552Ssemenu 3543552Ssemenu#pragma pack(1) 3643552Ssemenu#define BBSIZE 1024 3743552Ssemenu#define BBOFF ((off_t)(0)) 3843552Ssemenu#define BBLOCK ((daddr_t)(0)) 3943552Ssemenu#define NTFS_MFTINO 0 4043552Ssemenu#define NTFS_VOLUMEINO 3 4143552Ssemenu#define NTFS_ATTRDEFINO 4 4243552Ssemenu#define NTFS_ROOTINO 5 4343552Ssemenu#define NTFS_BITMAPINO 6 4443552Ssemenu#define NTFS_BOOTINO 7 4543552Ssemenu#define NTFS_BADCLUSINO 8 4643552Ssemenu#define NTFS_UPCASEINO 10 4743552Ssemenu#define NTFS_MAXFILENAME 255 4843552Ssemenu 4943552Ssemenustruct fixuphdr { 5043552Ssemenu u_int32_t fh_magic; 5143552Ssemenu u_int16_t fh_foff; 5243552Ssemenu u_int16_t fh_fnum; 5343552Ssemenu}; 5443552Ssemenu 5543552Ssemenu#define NTFS_AF_INRUN 0x00000001 5643552Ssemenustruct attrhdr { 5743552Ssemenu u_int32_t a_type; 5843552Ssemenu u_int32_t reclen; 5943552Ssemenu u_int8_t a_flag; 6043552Ssemenu u_int8_t a_namelen; 6143552Ssemenu u_int8_t a_nameoff; 6243552Ssemenu u_int8_t reserved1; 6343552Ssemenu u_int8_t a_compression; 6443552Ssemenu u_int8_t reserved2; 6543552Ssemenu u_int16_t a_index; 6643552Ssemenu}; 6743552Ssemenu#define NTFS_A_STD 0x10 6843552Ssemenu#define NTFS_A_ATTRLIST 0x20 6943552Ssemenu#define NTFS_A_NAME 0x30 7043552Ssemenu#define NTFS_A_VOLUMENAME 0x60 7143552Ssemenu#define NTFS_A_DATA 0x80 7243552Ssemenu#define NTFS_A_INDXROOT 0x90 7343552Ssemenu#define NTFS_A_INDX 0xA0 7443552Ssemenu#define NTFS_A_INDXBITMAP 0xB0 7543552Ssemenu 7643552Ssemenu#define NTFS_MAXATTRNAME 255 7743552Ssemenustruct attr { 7843552Ssemenu struct attrhdr a_hdr; 7943552Ssemenu union { 8043552Ssemenu struct { 8143552Ssemenu u_int16_t a_datalen; 8243552Ssemenu u_int16_t reserved1; 8343552Ssemenu u_int16_t a_dataoff; 8443552Ssemenu u_int16_t a_indexed; 8543552Ssemenu } a_S_r; 8643552Ssemenu struct { 8743552Ssemenu cn_t a_vcnstart; 8843552Ssemenu cn_t a_vcnend; 8943552Ssemenu u_int16_t a_dataoff; 9043552Ssemenu u_int16_t a_compressalg; 9143552Ssemenu u_int32_t reserved1; 9243552Ssemenu u_int64_t a_allocated; 9343552Ssemenu u_int64_t a_datalen; 9443552Ssemenu u_int64_t a_initialized; 9543552Ssemenu } a_S_nr; 9643552Ssemenu } a_S; 9743552Ssemenu}; 9843552Ssemenu#define a_r a_S.a_S_r 9943552Ssemenu#define a_nr a_S.a_S_nr 10043552Ssemenu 10143552Ssemenutypedef struct { 10243552Ssemenu u_int64_t t_create; 10343552Ssemenu u_int64_t t_write; 10443552Ssemenu u_int64_t t_mftwrite; 10543552Ssemenu u_int64_t t_access; 10643552Ssemenu} ntfs_times_t; 10743552Ssemenu 10843552Ssemenu#define NTFS_FFLAG_RDONLY 0x01LL 10943552Ssemenu#define NTFS_FFLAG_HIDDEN 0x02LL 11043552Ssemenu#define NTFS_FFLAG_SYSTEM 0x04LL 11143552Ssemenu#define NTFS_FFLAG_ARCHIVE 0x20LL 11243552Ssemenu#define NTFS_FFLAG_COMPRESSED 0x0800LL 11343552Ssemenu#define NTFS_FFLAG_DIR 0x10000000LL 11443552Ssemenu 11543552Ssemenustruct attr_name { 11643552Ssemenu u_int32_t n_pnumber; /* Parent ntnode */ 11743552Ssemenu u_int32_t reserved; 11843552Ssemenu ntfs_times_t n_times; 11943552Ssemenu u_int64_t n_size; 12043552Ssemenu u_int64_t n_attrsz; 12143552Ssemenu u_int64_t n_flag; 12243552Ssemenu u_int8_t n_namelen; 12343552Ssemenu u_int8_t n_nametype; 12443552Ssemenu u_int16_t n_name[1]; 12543552Ssemenu}; 12643552Ssemenu 12743552Ssemenu#define NTFS_IRFLAG_INDXALLOC 0x00000001 12843552Ssemenustruct attr_indexroot { 12943552Ssemenu u_int32_t ir_unkn1; /* always 0x30 */ 13043552Ssemenu u_int32_t ir_unkn2; /* always 0x1 */ 13143552Ssemenu u_int32_t ir_size;/* ??? */ 13243552Ssemenu u_int32_t ir_unkn3; /* number of cluster */ 13343552Ssemenu u_int32_t ir_unkn4; /* always 0x10 */ 13443552Ssemenu u_int32_t ir_datalen; /* sizeof simething */ 13543552Ssemenu u_int32_t ir_allocated; /* same as above */ 13643552Ssemenu u_int16_t ir_flag;/* ?? always 1 */ 13743552Ssemenu u_int16_t ir_unkn7; 13843552Ssemenu}; 13943552Ssemenu 14043552Ssemenustruct attr_attrlist { 14143552Ssemenu u_int32_t al_type; /* Attribute type */ 14243552Ssemenu u_int16_t reclen; /* length of this entry */ 14343552Ssemenu u_int8_t al_namelen; /* Attribute name len */ 14443552Ssemenu u_int8_t al_nameoff; /* Name offset from entry start */ 14543552Ssemenu u_int64_t al_vcnstart; /* VCN number */ 14643552Ssemenu u_int32_t al_inumber; /* Parent ntnode */ 14743552Ssemenu u_int32_t reserved; 14843552Ssemenu u_int16_t al_index; /* Attribute index in MFT record */ 14943552Ssemenu u_int16_t al_name[1]; /* Name */ 15043552Ssemenu}; 15143552Ssemenu 15243552Ssemenu#define NTFS_INDXMAGIC (u_int32_t)(0x58444E49) 15343552Ssemenustruct attr_indexalloc { 15443552Ssemenu struct fixuphdr ia_fixup; 15543552Ssemenu u_int64_t unknown1; 15643552Ssemenu cn_t ia_bufcn; 15743552Ssemenu u_int16_t ia_hdrsize; 15843552Ssemenu u_int16_t unknown2; 15943552Ssemenu u_int32_t ia_inuse; 16043552Ssemenu u_int32_t ia_allocated; 16143552Ssemenu}; 16243552Ssemenu 16343552Ssemenu#define NTFS_IEFLAG_SUBNODE 0x00000001 16443552Ssemenu#define NTFS_IEFLAG_LAST 0x00000002 16543552Ssemenu 16643552Ssemenustruct attr_indexentry { 16743552Ssemenu u_int32_t ie_number; 16843552Ssemenu u_int32_t unknown1; 16943552Ssemenu u_int16_t reclen; 17043552Ssemenu u_int16_t ie_size; 17143552Ssemenu u_int32_t ie_flag;/* 1 - has subnodes, 2 - last */ 17243552Ssemenu u_int32_t ie_fpnumber; 17343552Ssemenu u_int32_t unknown2; 17443552Ssemenu ntfs_times_t ie_ftimes; 17543552Ssemenu u_int64_t ie_fallocated; 17643552Ssemenu u_int64_t ie_fsize; 17743552Ssemenu u_int64_t ie_fflag; 17843552Ssemenu u_int8_t ie_fnamelen; 17943552Ssemenu u_int8_t ie_fnametype; 18043552Ssemenu wchar ie_fname[NTFS_MAXFILENAME]; 18143552Ssemenu /* cn_t ie_bufcn; buffer with subnodes */ 18243552Ssemenu}; 18343552Ssemenu 18443552Ssemenu#define NTFS_FILEMAGIC (u_int32_t)(0x454C4946) 18544142Ssemenu#define NTFS_FRFLAG_DIR 0x0002 18643552Ssemenustruct filerec { 18743552Ssemenu struct fixuphdr fr_fixup; 18843552Ssemenu u_int8_t reserved[8]; 18943552Ssemenu u_int16_t fr_seqnum; /* Sequence number */ 19043552Ssemenu u_int16_t fr_nlink; 19143552Ssemenu u_int16_t fr_attroff; /* offset to attributes */ 19243552Ssemenu u_int16_t fr_flags; /* 1-nonresident attr, 2-directory */ 19343552Ssemenu u_int32_t fr_size;/* hdr + attributes */ 19443552Ssemenu u_int32_t fr_allocated; /* allocated length of record */ 19543552Ssemenu u_int64_t fr_mainrec; /* main record */ 19643552Ssemenu u_int16_t fr_attrnum; /* maximum attr number + 1 ??? */ 19743552Ssemenu}; 19843552Ssemenu 19944142Ssemenu#define NTFS_ATTRNAME_MAXLEN 0x40 20043552Ssemenu#define NTFS_ADFLAG_NONRES 0x0080 /* Attrib can be non resident */ 20143552Ssemenu#define NTFS_ADFLAG_INDEX 0x0002 /* Attrib can be indexed */ 20243552Ssemenustruct attrdef { 20344142Ssemenu wchar ad_name[NTFS_ATTRNAME_MAXLEN]; 20443552Ssemenu u_int32_t ad_type; 20543552Ssemenu u_int32_t reserved1[2]; 20643552Ssemenu u_int32_t ad_flag; 20743552Ssemenu u_int64_t ad_minlen; 20843552Ssemenu u_int64_t ad_maxlen; /* -1 for nonlimited */ 20943552Ssemenu}; 21043552Ssemenu 21143552Ssemenustruct ntvattrdef { 21243552Ssemenu char ad_name[0x40]; 21343552Ssemenu int ad_namelen; 21443552Ssemenu u_int32_t ad_type; 21543552Ssemenu}; 21643552Ssemenu 21743552Ssemenustruct bootfile { 21843552Ssemenu u_int8_t reserved1[3]; /* asm jmp near ... */ 21943552Ssemenu u_int8_t bf_sysid[8]; /* 'NTFS ' */ 22043552Ssemenu u_int16_t bf_bps; /* bytes per sector */ 22143552Ssemenu u_int8_t bf_spc; /* sectors per cluster */ 22243552Ssemenu u_int8_t reserved2[7]; /* unused (zeroed) */ 22343552Ssemenu u_int8_t bf_media; /* media desc. (0xF8) */ 22443552Ssemenu u_int8_t reserved3[2]; 22543552Ssemenu u_int16_t bf_spt; /* sectors per track */ 22643552Ssemenu u_int16_t bf_heads; /* number of heads */ 22743552Ssemenu u_int8_t reserver4[12]; 22843552Ssemenu u_int64_t bf_spv; /* sectors per volume */ 22943552Ssemenu cn_t bf_mftcn; /* $MFT cluster number */ 23043552Ssemenu cn_t bf_mftmirrcn; /* $MFTMirr cn */ 23143552Ssemenu u_int8_t bf_mftrecsz; /* MFT record size (clust) */ 23243552Ssemenu /* 0xF6 inducates 1/4 */ 23343552Ssemenu u_int32_t bf_ibsz; /* index buffer size */ 23443552Ssemenu u_int32_t bf_volsn; /* volume ser. num. */ 23543552Ssemenu}; 23643552Ssemenu 23743552Ssemenu#define NTFS_SYSNODESNUM 0x0B 23843552Ssemenustruct ntfsmount { 23943552Ssemenu struct mount *ntm_mountp; 24043552Ssemenu struct bootfile ntm_bootfile; 24143552Ssemenu dev_t ntm_dev; 24243552Ssemenu struct vnode *ntm_devvp; 24343552Ssemenu struct vnode *ntm_sysvn[NTFS_SYSNODESNUM]; 24443552Ssemenu wchar *ntm_upcase; 24543552Ssemenu u_int32_t ntm_bpmftrec; 24643552Ssemenu uid_t ntm_uid; 24743552Ssemenu gid_t ntm_gid; 24843552Ssemenu mode_t ntm_mode; 24943552Ssemenu u_long ntm_flag; 25043552Ssemenu struct ntvattrdef *ntm_ad; 25143552Ssemenu int ntm_adnum; 25243552Ssemenu}; 25343552Ssemenu 25443552Ssemenu#define ntm_mftcn ntm_bootfile.bf_mftcn 25543552Ssemenu#define ntm_mftmirrcn ntm_bootfile.bf_mftmirrcn 25643552Ssemenu#define ntm_mftrecsz ntm_bootfile.bf_mftrecsz 25743552Ssemenu#define ntm_spc ntm_bootfile.bf_spc 25843552Ssemenu#define ntm_bps ntm_bootfile.bf_bps 25943552Ssemenu 26043552Ssemenu#pragma pack() 26143552Ssemenu 26243552Ssemenu#define NTFS_NEXTREC(s, type) ((type)(((caddr_t) s) + (s)->reclen)) 26343552Ssemenu 26443552Ssemenu/* Convert mount ptr to ntfsmount ptr. */ 26543552Ssemenu#define VFSTONTFS(mp) ((struct ntfsmount *)((mp)->mnt_data)) 26644142Ssemenu#define VTONT(v) FTONT(VTOF(v)) 26744142Ssemenu#define VTOF(v) ((struct fnode *)((v)->v_data)) 26844142Ssemenu#define FTOV(f) ((f)->f_vp) 26944142Ssemenu#define FTONT(f) ((f)->f_ip) 27043552Ssemenu#define ntfs_cntobn(cn) (daddr_t)((cn) * (ntmp->ntm_spc)) 27143552Ssemenu#define ntfs_cntob(cn) (off_t)((cn) * (ntmp)->ntm_spc * (ntmp)->ntm_bps) 27243552Ssemenu#define ntfs_btocn(off) (cn_t)((off) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 27343552Ssemenu#define ntfs_btocl(off) (cn_t)((off + ntfs_cntob(1) - 1) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 27443552Ssemenu#define ntfs_btocnoff(off) (off_t)((off) % ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 27543552Ssemenu#define ntfs_bntob(bn) (daddr_t)((bn) * (ntmp)->ntm_bps) 27643552Ssemenu 27743552Ssemenu#define ntfs_bpbl (daddr_t)((ntmp)->ntm_bps) 27843552Ssemenu 27943552Ssemenu#if __FreeBSD_version >= 300000 28043552SsemenuMALLOC_DECLARE(M_NTFSMNT); 28144142SsemenuMALLOC_DECLARE(M_NTFSNTNODE); 28244142SsemenuMALLOC_DECLARE(M_NTFSFNODE); 28343552SsemenuMALLOC_DECLARE(M_NTFSDIR); 28444142SsemenuMALLOC_DECLARE(M_NTFSNTHASH); 28543552Ssemenu#endif 28643552Ssemenu 28743552Ssemenu#if defined(NTFS_DEBUG) 28843552Ssemenu#define dprintf(a) printf a 28943552Ssemenu#if NTFS_DEBUG > 1 29043552Ssemenu#define ddprintf(a) printf a 29143552Ssemenu#else 29243552Ssemenu#define ddprintf(a) 29343552Ssemenu#endif 29443552Ssemenu#else 29543552Ssemenu#define dprintf(a) 29643552Ssemenu#define ddprintf(a) 29743552Ssemenu#endif 29843552Ssemenu 29943552Ssemenuextern vop_t **ntfs_vnodeop_p; 300