1/* 2 * volume.h - Defines for volume structures in NTFS Linux kernel driver. Part 3 * of the Linux-NTFS project. 4 * 5 * Copyright (c) 2001-2006 Anton Altaparmakov 6 * Copyright (c) 2002 Richard Russon 7 * 8 * This program/include file is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License as published 10 * by the Free Software Foundation; either version 2 of the License, or 11 * (at your option) any later version. 12 * 13 * This program/include file is distributed in the hope that it will be 14 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty 15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 * GNU General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program (in the main directory of the Linux-NTFS 20 * distribution in the file COPYING); if not, write to the Free Software 21 * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 22 */ 23 24#ifndef _LINUX_NTFS_VOLUME_H 25#define _LINUX_NTFS_VOLUME_H 26 27#include <linux/rwsem.h> 28 29#include "types.h" 30#include "layout.h" 31 32/* 33 * The NTFS in memory super block structure. 34 */ 35typedef struct { 36 /* Device specifics. */ 37 struct super_block *sb; /* Pointer back to the super_block. */ 38 LCN nr_blocks; /* Number of sb->s_blocksize bytes 39 sized blocks on the device. */ 40 /* Configuration provided by user at mount time. */ 41 unsigned long flags; /* Miscellaneous flags, see below. */ 42 uid_t uid; /* uid that files will be mounted as. */ 43 gid_t gid; /* gid that files will be mounted as. */ 44 mode_t fmask; /* The mask for file permissions. */ 45 mode_t dmask; /* The mask for directory 46 permissions. */ 47 u8 mft_zone_multiplier; /* Initial mft zone multiplier. */ 48 u8 on_errors; /* What to do on filesystem errors. */ 49 /* NTFS bootsector provided information. */ 50 u16 sector_size; /* in bytes */ 51 u8 sector_size_bits; /* log2(sector_size) */ 52 u32 cluster_size; /* in bytes */ 53 u32 cluster_size_mask; /* cluster_size - 1 */ 54 u8 cluster_size_bits; /* log2(cluster_size) */ 55 u32 mft_record_size; /* in bytes */ 56 u32 mft_record_size_mask; /* mft_record_size - 1 */ 57 u8 mft_record_size_bits; /* log2(mft_record_size) */ 58 u32 index_record_size; /* in bytes */ 59 u32 index_record_size_mask; /* index_record_size - 1 */ 60 u8 index_record_size_bits; /* log2(index_record_size) */ 61 LCN nr_clusters; /* Volume size in clusters == number of 62 bits in lcn bitmap. */ 63 LCN mft_lcn; /* Cluster location of mft data. */ 64 LCN mftmirr_lcn; /* Cluster location of copy of mft. */ 65 u64 serial_no; /* The volume serial number. */ 66 /* Mount specific NTFS information. */ 67 u32 upcase_len; /* Number of entries in upcase[]. */ 68 ntfschar *upcase; /* The upcase table. */ 69 70 s32 attrdef_size; /* Size of the attribute definition 71 table in bytes. */ 72 ATTR_DEF *attrdef; /* Table of attribute definitions. 73 Obtained from FILE_AttrDef. */ 74 75#ifdef NTFS_RW 76 /* Variables used by the cluster and mft allocators. */ 77 s64 mft_data_pos; /* Mft record number at which to 78 allocate the next mft record. */ 79 LCN mft_zone_start; /* First cluster of the mft zone. */ 80 LCN mft_zone_end; /* First cluster beyond the mft zone. */ 81 LCN mft_zone_pos; /* Current position in the mft zone. */ 82 LCN data1_zone_pos; /* Current position in the first data 83 zone. */ 84 LCN data2_zone_pos; /* Current position in the second data 85 zone. */ 86#endif /* NTFS_RW */ 87 88 struct inode *mft_ino; /* The VFS inode of $MFT. */ 89 90 struct inode *mftbmp_ino; /* Attribute inode for $MFT/$BITMAP. */ 91 struct rw_semaphore mftbmp_lock; /* Lock for serializing accesses to the 92 mft record bitmap ($MFT/$BITMAP). */ 93#ifdef NTFS_RW 94 struct inode *mftmirr_ino; /* The VFS inode of $MFTMirr. */ 95 int mftmirr_size; /* Size of mft mirror in mft records. */ 96 97 struct inode *logfile_ino; /* The VFS inode of $LogFile. */ 98#endif /* NTFS_RW */ 99 100 struct inode *lcnbmp_ino; /* The VFS inode of $Bitmap. */ 101 struct rw_semaphore lcnbmp_lock; /* Lock for serializing accesses to the 102 cluster bitmap ($Bitmap/$DATA). */ 103 104 struct inode *vol_ino; /* The VFS inode of $Volume. */ 105 VOLUME_FLAGS vol_flags; /* Volume flags. */ 106 u8 major_ver; /* Ntfs major version of volume. */ 107 u8 minor_ver; /* Ntfs minor version of volume. */ 108 109 struct inode *root_ino; /* The VFS inode of the root 110 directory. */ 111 struct inode *secure_ino; /* The VFS inode of $Secure (NTFS3.0+ 112 only, otherwise NULL). */ 113 struct inode *extend_ino; /* The VFS inode of $Extend (NTFS3.0+ 114 only, otherwise NULL). */ 115#ifdef NTFS_RW 116 /* $Quota stuff is NTFS3.0+ specific. Unused/NULL otherwise. */ 117 struct inode *quota_ino; /* The VFS inode of $Quota. */ 118 struct inode *quota_q_ino; /* Attribute inode for $Quota/$Q. */ 119 /* $UsnJrnl stuff is NTFS3.0+ specific. Unused/NULL otherwise. */ 120 struct inode *usnjrnl_ino; /* The VFS inode of $UsnJrnl. */ 121 struct inode *usnjrnl_max_ino; /* Attribute inode for $UsnJrnl/$Max. */ 122 struct inode *usnjrnl_j_ino; /* Attribute inode for $UsnJrnl/$J. */ 123#endif /* NTFS_RW */ 124 struct nls_table *nls_map; 125} ntfs_volume; 126 127/* 128 * Defined bits for the flags field in the ntfs_volume structure. 129 */ 130typedef enum { 131 NV_Errors, /* 1: Volume has errors, prevent remount rw. */ 132 NV_ShowSystemFiles, /* 1: Return system files in ntfs_readdir(). */ 133 NV_CaseSensitive, /* 1: Treat file names as case sensitive and 134 create filenames in the POSIX namespace. 135 Otherwise be case insensitive but still 136 create file names in POSIX namespace. */ 137 NV_LogFileEmpty, /* 1: $LogFile journal is empty. */ 138 NV_QuotaOutOfDate, /* 1: $Quota is out of date. */ 139 NV_UsnJrnlStamped, /* 1: $UsnJrnl has been stamped. */ 140 NV_SparseEnabled, /* 1: May create sparse files. */ 141} ntfs_volume_flags; 142 143/* 144 * Macro tricks to expand the NVolFoo(), NVolSetFoo(), and NVolClearFoo() 145 * functions. 146 */ 147#define DEFINE_NVOL_BIT_OPS(flag) \ 148static inline int NVol##flag(ntfs_volume *vol) \ 149{ \ 150 return test_bit(NV_##flag, &(vol)->flags); \ 151} \ 152static inline void NVolSet##flag(ntfs_volume *vol) \ 153{ \ 154 set_bit(NV_##flag, &(vol)->flags); \ 155} \ 156static inline void NVolClear##flag(ntfs_volume *vol) \ 157{ \ 158 clear_bit(NV_##flag, &(vol)->flags); \ 159} 160 161/* Emit the ntfs volume bitops functions. */ 162DEFINE_NVOL_BIT_OPS(Errors) 163DEFINE_NVOL_BIT_OPS(ShowSystemFiles) 164DEFINE_NVOL_BIT_OPS(CaseSensitive) 165DEFINE_NVOL_BIT_OPS(LogFileEmpty) 166DEFINE_NVOL_BIT_OPS(QuotaOutOfDate) 167DEFINE_NVOL_BIT_OPS(UsnJrnlStamped) 168DEFINE_NVOL_BIT_OPS(SparseEnabled) 169 170#endif /* _LINUX_NTFS_VOLUME_H */ 171