ntfs.h revision 83229
154095Ssemenu/* $NetBSD: ntfs.h,v 1.9 1999/10/31 19:45:26 jdolecek Exp $ */ 247060Ssemenu 343552Ssemenu/*- 443552Ssemenu * Copyright (c) 1998, 1999 Semen Ustimenko 543552Ssemenu * All rights reserved. 643552Ssemenu * 743552Ssemenu * Redistribution and use in source and binary forms, with or without 843552Ssemenu * modification, are permitted provided that the following conditions 943552Ssemenu * are met: 1043552Ssemenu * 1. Redistributions of source code must retain the above copyright 1143552Ssemenu * notice, this list of conditions and the following disclaimer. 1243552Ssemenu * 2. Redistributions in binary form must reproduce the above copyright 1343552Ssemenu * notice, this list of conditions and the following disclaimer in the 1443552Ssemenu * documentation and/or other materials provided with the distribution. 1543552Ssemenu * 1643552Ssemenu * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1743552Ssemenu * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1843552Ssemenu * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1943552Ssemenu * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2043552Ssemenu * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2143552Ssemenu * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2243552Ssemenu * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2343552Ssemenu * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2443552Ssemenu * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2543552Ssemenu * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2643552Ssemenu * SUCH DAMAGE. 2743552Ssemenu * 2850477Speter * $FreeBSD: head/sys/fs/ntfs/ntfs.h 83229 2001-09-08 23:03:52Z semenu $ 2943552Ssemenu */ 3043552Ssemenu 3143552Ssemenu/*#define NTFS_DEBUG 1*/ 3254095Ssemenu#if defined(__NetBSD__) && defined(_KERNEL) && !defined(_LKM) 3354095Ssemenu#include "opt_ntfs.h" 3454095Ssemenu#endif 3543552Ssemenu 3643552Ssemenutypedef u_int64_t cn_t; 3743552Ssemenutypedef u_int16_t wchar; 3843552Ssemenu 3943552Ssemenu#pragma pack(1) 4043552Ssemenu#define BBSIZE 1024 4143552Ssemenu#define BBOFF ((off_t)(0)) 4243552Ssemenu#define BBLOCK ((daddr_t)(0)) 4343552Ssemenu#define NTFS_MFTINO 0 4443552Ssemenu#define NTFS_VOLUMEINO 3 4543552Ssemenu#define NTFS_ATTRDEFINO 4 4643552Ssemenu#define NTFS_ROOTINO 5 4743552Ssemenu#define NTFS_BITMAPINO 6 4843552Ssemenu#define NTFS_BOOTINO 7 4943552Ssemenu#define NTFS_BADCLUSINO 8 5043552Ssemenu#define NTFS_UPCASEINO 10 5143552Ssemenu#define NTFS_MAXFILENAME 255 5243552Ssemenu 5343552Ssemenustruct fixuphdr { 5443552Ssemenu u_int32_t fh_magic; 5543552Ssemenu u_int16_t fh_foff; 5643552Ssemenu u_int16_t fh_fnum; 5743552Ssemenu}; 5843552Ssemenu 5943552Ssemenu#define NTFS_AF_INRUN 0x00000001 6043552Ssemenustruct attrhdr { 6143552Ssemenu u_int32_t a_type; 6243552Ssemenu u_int32_t reclen; 6343552Ssemenu u_int8_t a_flag; 6443552Ssemenu u_int8_t a_namelen; 6543552Ssemenu u_int8_t a_nameoff; 6643552Ssemenu u_int8_t reserved1; 6743552Ssemenu u_int8_t a_compression; 6843552Ssemenu u_int8_t reserved2; 6943552Ssemenu u_int16_t a_index; 7043552Ssemenu}; 7143552Ssemenu#define NTFS_A_STD 0x10 7243552Ssemenu#define NTFS_A_ATTRLIST 0x20 7343552Ssemenu#define NTFS_A_NAME 0x30 7443552Ssemenu#define NTFS_A_VOLUMENAME 0x60 7543552Ssemenu#define NTFS_A_DATA 0x80 7643552Ssemenu#define NTFS_A_INDXROOT 0x90 7743552Ssemenu#define NTFS_A_INDX 0xA0 7843552Ssemenu#define NTFS_A_INDXBITMAP 0xB0 7943552Ssemenu 8043552Ssemenu#define NTFS_MAXATTRNAME 255 8143552Ssemenustruct attr { 8243552Ssemenu struct attrhdr a_hdr; 8343552Ssemenu union { 8443552Ssemenu struct { 8543552Ssemenu u_int16_t a_datalen; 8643552Ssemenu u_int16_t reserved1; 8743552Ssemenu u_int16_t a_dataoff; 8843552Ssemenu u_int16_t a_indexed; 8943552Ssemenu } a_S_r; 9043552Ssemenu struct { 9143552Ssemenu cn_t a_vcnstart; 9243552Ssemenu cn_t a_vcnend; 9343552Ssemenu u_int16_t a_dataoff; 9443552Ssemenu u_int16_t a_compressalg; 9543552Ssemenu u_int32_t reserved1; 9643552Ssemenu u_int64_t a_allocated; 9743552Ssemenu u_int64_t a_datalen; 9843552Ssemenu u_int64_t a_initialized; 9943552Ssemenu } a_S_nr; 10043552Ssemenu } a_S; 10143552Ssemenu}; 10243552Ssemenu#define a_r a_S.a_S_r 10343552Ssemenu#define a_nr a_S.a_S_nr 10443552Ssemenu 10543552Ssemenutypedef struct { 10643552Ssemenu u_int64_t t_create; 10743552Ssemenu u_int64_t t_write; 10843552Ssemenu u_int64_t t_mftwrite; 10943552Ssemenu u_int64_t t_access; 11043552Ssemenu} ntfs_times_t; 11143552Ssemenu 11243552Ssemenu#define NTFS_FFLAG_RDONLY 0x01LL 11343552Ssemenu#define NTFS_FFLAG_HIDDEN 0x02LL 11443552Ssemenu#define NTFS_FFLAG_SYSTEM 0x04LL 11543552Ssemenu#define NTFS_FFLAG_ARCHIVE 0x20LL 11643552Ssemenu#define NTFS_FFLAG_COMPRESSED 0x0800LL 11743552Ssemenu#define NTFS_FFLAG_DIR 0x10000000LL 11843552Ssemenu 11943552Ssemenustruct attr_name { 12043552Ssemenu u_int32_t n_pnumber; /* Parent ntnode */ 12143552Ssemenu u_int32_t reserved; 12243552Ssemenu ntfs_times_t n_times; 12343552Ssemenu u_int64_t n_size; 12443552Ssemenu u_int64_t n_attrsz; 12543552Ssemenu u_int64_t n_flag; 12643552Ssemenu u_int8_t n_namelen; 12743552Ssemenu u_int8_t n_nametype; 12843552Ssemenu u_int16_t n_name[1]; 12943552Ssemenu}; 13043552Ssemenu 13143552Ssemenu#define NTFS_IRFLAG_INDXALLOC 0x00000001 13243552Ssemenustruct attr_indexroot { 13343552Ssemenu u_int32_t ir_unkn1; /* always 0x30 */ 13443552Ssemenu u_int32_t ir_unkn2; /* always 0x1 */ 13543552Ssemenu u_int32_t ir_size;/* ??? */ 13643552Ssemenu u_int32_t ir_unkn3; /* number of cluster */ 13743552Ssemenu u_int32_t ir_unkn4; /* always 0x10 */ 13843552Ssemenu u_int32_t ir_datalen; /* sizeof simething */ 13943552Ssemenu u_int32_t ir_allocated; /* same as above */ 14043552Ssemenu u_int16_t ir_flag;/* ?? always 1 */ 14143552Ssemenu u_int16_t ir_unkn7; 14243552Ssemenu}; 14343552Ssemenu 14443552Ssemenustruct attr_attrlist { 14543552Ssemenu u_int32_t al_type; /* Attribute type */ 14643552Ssemenu u_int16_t reclen; /* length of this entry */ 14743552Ssemenu u_int8_t al_namelen; /* Attribute name len */ 14843552Ssemenu u_int8_t al_nameoff; /* Name offset from entry start */ 14943552Ssemenu u_int64_t al_vcnstart; /* VCN number */ 15043552Ssemenu u_int32_t al_inumber; /* Parent ntnode */ 15143552Ssemenu u_int32_t reserved; 15243552Ssemenu u_int16_t al_index; /* Attribute index in MFT record */ 15343552Ssemenu u_int16_t al_name[1]; /* Name */ 15443552Ssemenu}; 15543552Ssemenu 15643552Ssemenu#define NTFS_INDXMAGIC (u_int32_t)(0x58444E49) 15743552Ssemenustruct attr_indexalloc { 15843552Ssemenu struct fixuphdr ia_fixup; 15943552Ssemenu u_int64_t unknown1; 16043552Ssemenu cn_t ia_bufcn; 16143552Ssemenu u_int16_t ia_hdrsize; 16243552Ssemenu u_int16_t unknown2; 16343552Ssemenu u_int32_t ia_inuse; 16443552Ssemenu u_int32_t ia_allocated; 16543552Ssemenu}; 16643552Ssemenu 16743552Ssemenu#define NTFS_IEFLAG_SUBNODE 0x00000001 16843552Ssemenu#define NTFS_IEFLAG_LAST 0x00000002 16943552Ssemenu 17043552Ssemenustruct attr_indexentry { 17143552Ssemenu u_int32_t ie_number; 17243552Ssemenu u_int32_t unknown1; 17343552Ssemenu u_int16_t reclen; 17443552Ssemenu u_int16_t ie_size; 17543552Ssemenu u_int32_t ie_flag;/* 1 - has subnodes, 2 - last */ 17643552Ssemenu u_int32_t ie_fpnumber; 17743552Ssemenu u_int32_t unknown2; 17843552Ssemenu ntfs_times_t ie_ftimes; 17943552Ssemenu u_int64_t ie_fallocated; 18043552Ssemenu u_int64_t ie_fsize; 18143552Ssemenu u_int64_t ie_fflag; 18243552Ssemenu u_int8_t ie_fnamelen; 18343552Ssemenu u_int8_t ie_fnametype; 18443552Ssemenu wchar ie_fname[NTFS_MAXFILENAME]; 18543552Ssemenu /* cn_t ie_bufcn; buffer with subnodes */ 18643552Ssemenu}; 18743552Ssemenu 18843552Ssemenu#define NTFS_FILEMAGIC (u_int32_t)(0x454C4946) 18944142Ssemenu#define NTFS_FRFLAG_DIR 0x0002 19043552Ssemenustruct filerec { 19143552Ssemenu struct fixuphdr fr_fixup; 19243552Ssemenu u_int8_t reserved[8]; 19343552Ssemenu u_int16_t fr_seqnum; /* Sequence number */ 19443552Ssemenu u_int16_t fr_nlink; 19543552Ssemenu u_int16_t fr_attroff; /* offset to attributes */ 19643552Ssemenu u_int16_t fr_flags; /* 1-nonresident attr, 2-directory */ 19743552Ssemenu u_int32_t fr_size;/* hdr + attributes */ 19843552Ssemenu u_int32_t fr_allocated; /* allocated length of record */ 19943552Ssemenu u_int64_t fr_mainrec; /* main record */ 20043552Ssemenu u_int16_t fr_attrnum; /* maximum attr number + 1 ??? */ 20143552Ssemenu}; 20243552Ssemenu 20344142Ssemenu#define NTFS_ATTRNAME_MAXLEN 0x40 20443552Ssemenu#define NTFS_ADFLAG_NONRES 0x0080 /* Attrib can be non resident */ 20543552Ssemenu#define NTFS_ADFLAG_INDEX 0x0002 /* Attrib can be indexed */ 20643552Ssemenustruct attrdef { 20744142Ssemenu wchar ad_name[NTFS_ATTRNAME_MAXLEN]; 20843552Ssemenu u_int32_t ad_type; 20943552Ssemenu u_int32_t reserved1[2]; 21043552Ssemenu u_int32_t ad_flag; 21143552Ssemenu u_int64_t ad_minlen; 21243552Ssemenu u_int64_t ad_maxlen; /* -1 for nonlimited */ 21343552Ssemenu}; 21443552Ssemenu 21543552Ssemenustruct ntvattrdef { 21643552Ssemenu char ad_name[0x40]; 21743552Ssemenu int ad_namelen; 21843552Ssemenu u_int32_t ad_type; 21943552Ssemenu}; 22043552Ssemenu 22145879Ssemenu#define NTFS_BBID "NTFS " 22245879Ssemenu#define NTFS_BBIDLEN 8 22343552Ssemenustruct bootfile { 22443552Ssemenu u_int8_t reserved1[3]; /* asm jmp near ... */ 22543552Ssemenu u_int8_t bf_sysid[8]; /* 'NTFS ' */ 22643552Ssemenu u_int16_t bf_bps; /* bytes per sector */ 22743552Ssemenu u_int8_t bf_spc; /* sectors per cluster */ 22843552Ssemenu u_int8_t reserved2[7]; /* unused (zeroed) */ 22943552Ssemenu u_int8_t bf_media; /* media desc. (0xF8) */ 23043552Ssemenu u_int8_t reserved3[2]; 23143552Ssemenu u_int16_t bf_spt; /* sectors per track */ 23243552Ssemenu u_int16_t bf_heads; /* number of heads */ 23343552Ssemenu u_int8_t reserver4[12]; 23443552Ssemenu u_int64_t bf_spv; /* sectors per volume */ 23543552Ssemenu cn_t bf_mftcn; /* $MFT cluster number */ 23643552Ssemenu cn_t bf_mftmirrcn; /* $MFTMirr cn */ 23743552Ssemenu u_int8_t bf_mftrecsz; /* MFT record size (clust) */ 23843552Ssemenu /* 0xF6 inducates 1/4 */ 23943552Ssemenu u_int32_t bf_ibsz; /* index buffer size */ 24043552Ssemenu u_int32_t bf_volsn; /* volume ser. num. */ 24143552Ssemenu}; 24243552Ssemenu 24343552Ssemenu#define NTFS_SYSNODESNUM 0x0B 24443552Ssemenustruct ntfsmount { 24554095Ssemenu struct mount *ntm_mountp; /* filesystem vfs structure */ 24643552Ssemenu struct bootfile ntm_bootfile; 24754095Ssemenu dev_t ntm_dev; /* device mounted */ 24854095Ssemenu struct vnode *ntm_devvp; /* block device mounted vnode */ 24943552Ssemenu struct vnode *ntm_sysvn[NTFS_SYSNODESNUM]; 25043552Ssemenu u_int32_t ntm_bpmftrec; 25143552Ssemenu uid_t ntm_uid; 25243552Ssemenu gid_t ntm_gid; 25343552Ssemenu mode_t ntm_mode; 25443552Ssemenu u_long ntm_flag; 25545879Ssemenu cn_t ntm_cfree; 25643552Ssemenu struct ntvattrdef *ntm_ad; 25743552Ssemenu int ntm_adnum; 25875934Sphk#if !defined(__FreeBSD__) 25954095Ssemenu struct netexport ntm_export; /* export information */ 26075934Sphk#endif 26183229Ssemenu wchar * ntm_82u; /* 8bit to Unicode */ 26283229Ssemenu char ** ntm_u28; /* Unicode to 8 bit */ 26343552Ssemenu}; 26443552Ssemenu 26543552Ssemenu#define ntm_mftcn ntm_bootfile.bf_mftcn 26643552Ssemenu#define ntm_mftmirrcn ntm_bootfile.bf_mftmirrcn 26743552Ssemenu#define ntm_mftrecsz ntm_bootfile.bf_mftrecsz 26843552Ssemenu#define ntm_spc ntm_bootfile.bf_spc 26943552Ssemenu#define ntm_bps ntm_bootfile.bf_bps 27043552Ssemenu 27143552Ssemenu#pragma pack() 27243552Ssemenu 27343552Ssemenu#define NTFS_NEXTREC(s, type) ((type)(((caddr_t) s) + (s)->reclen)) 27443552Ssemenu 27543552Ssemenu/* Convert mount ptr to ntfsmount ptr. */ 27643552Ssemenu#define VFSTONTFS(mp) ((struct ntfsmount *)((mp)->mnt_data)) 27744142Ssemenu#define VTONT(v) FTONT(VTOF(v)) 27844142Ssemenu#define VTOF(v) ((struct fnode *)((v)->v_data)) 27944142Ssemenu#define FTOV(f) ((f)->f_vp) 28044142Ssemenu#define FTONT(f) ((f)->f_ip) 28143552Ssemenu#define ntfs_cntobn(cn) (daddr_t)((cn) * (ntmp->ntm_spc)) 28243552Ssemenu#define ntfs_cntob(cn) (off_t)((cn) * (ntmp)->ntm_spc * (ntmp)->ntm_bps) 28343552Ssemenu#define ntfs_btocn(off) (cn_t)((off) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 28443552Ssemenu#define ntfs_btocl(off) (cn_t)((off + ntfs_cntob(1) - 1) / ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 28543552Ssemenu#define ntfs_btocnoff(off) (off_t)((off) % ((ntmp)->ntm_spc * (ntmp)->ntm_bps)) 28643552Ssemenu#define ntfs_bntob(bn) (daddr_t)((bn) * (ntmp)->ntm_bps) 28743552Ssemenu 28843552Ssemenu#define ntfs_bpbl (daddr_t)((ntmp)->ntm_bps) 28943552Ssemenu 29055989Sbde#ifdef MALLOC_DECLARE 29143552SsemenuMALLOC_DECLARE(M_NTFSMNT); 29244142SsemenuMALLOC_DECLARE(M_NTFSNTNODE); 29344142SsemenuMALLOC_DECLARE(M_NTFSFNODE); 29443552SsemenuMALLOC_DECLARE(M_NTFSDIR); 29544142SsemenuMALLOC_DECLARE(M_NTFSNTHASH); 29643552Ssemenu#endif 29743552Ssemenu 29847060Ssemenu#ifdef __NetBSD__ 29947060Ssemenu#define MALLOC_DEFINE(a, b, c) 30054095Ssemenu#define M_NTFSNTHASH M_NTFS 30154095Ssemenu#define M_NTFSNTVATTR M_NTFS 30254095Ssemenu#define M_NTFSRDATA M_NTFS 30354095Ssemenu#define M_NTFSRUN M_NTFS 30454095Ssemenu#define M_NTFSDECOMP M_NTFS 30554095Ssemenu#define M_NTFSMNT M_NTFS 30654095Ssemenu#define M_NTFSNTNODE M_NTFS 30754095Ssemenu#define M_NTFSFNODE M_NTFS 30854095Ssemenu#define M_NTFSDIR M_NTFS 30947060Ssemenutypedef int (vop_t) __P((void *)); 31047060Ssemenu#define HASHINIT(a, b, c, d) hashinit((a), (b), (c), (d)) 31147060Ssemenu#define bqrelse(bp) brelse(bp) 31254095Ssemenu#define VOP__UNLOCK(a, b, c) VOP_UNLOCK((a), (b)) 31354095Ssemenu#define VGET(a, b, c) vget((a), (b)) 31454095Ssemenu#define VN_LOCK(a, b, c) vn_lock((a), (b)) 31554095Ssemenu#define LOCKMGR(a, b, c) lockmgr((a), (b), (c)) 31654095Ssemenu#else /* !NetBSD */ 31747060Ssemenu#define HASHINIT(a, b, c, d) hashinit((a), (b), (d)) 31847060Ssemenu#define VOP__UNLOCK(a, b, c) VOP_UNLOCK((a), (b), (c)) 31947060Ssemenu#define VGET(a, b, c) vget((a), (b), (c)) 32047060Ssemenu#define VN_LOCK(a, b, c) vn_lock((a), (b), (c)) 32154095Ssemenu#define LOCKMGR(a, b, c) lockmgr((a), (b), (c), NULL) 32254095Ssemenu#endif /* NetBSD */ 32354095Ssemenu 32443552Ssemenu#if defined(NTFS_DEBUG) 32543552Ssemenu#define dprintf(a) printf a 32643552Ssemenu#if NTFS_DEBUG > 1 32743552Ssemenu#define ddprintf(a) printf a 32843552Ssemenu#else 32943552Ssemenu#define ddprintf(a) 33043552Ssemenu#endif 33143552Ssemenu#else 33243552Ssemenu#define dprintf(a) 33343552Ssemenu#define ddprintf(a) 33443552Ssemenu#endif 33543552Ssemenu 33643552Ssemenuextern vop_t **ntfs_vnodeop_p; 337