release/src/router/ntfs-3g/include/ntfs-3g/volume.h

   1 /*
   2  * volume.h - Exports for NTFS volume handling. Originated from the Linux-NTFS project.
   3  *
   4  * Copyright (c) 2000-2004 Anton Altaparmakov
   5  * Copyright (c) 2004-2005 Richard Russon
   6  * Copyright (c) 2005-2006 Yura Pakhuchiy
   7  * Copyright (c) 2005-2009 Szabolcs Szakacsits
   8  * Copyright (c) 2010      Jean-Pierre Andre
   9  *
  10  * This program/include file is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as published
  12  * by the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program/include file is distributed in the hope that it will be
  16  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  17  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program (in the main directory of the NTFS-3G
  22  * distribution in the file COPYING); if not, write to the Free Software
  23  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #ifndef _NTFS_VOLUME_H
  27 #define _NTFS_VOLUME_H
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #ifdef HAVE_STDIO_H
  34 #include <stdio.h>
  35 #endif
  36 #ifdef HAVE_SYS_PARAM_H
  37 #include <sys/param.h>
  38 #endif
  39 #ifdef HAVE_SYS_MOUNT_H
  40 #include <sys/mount.h>
  41 #endif
  42 #ifdef HAVE_MNTENT_H
  43 #include <mntent.h>
  44 #endif
  45
  46 /*
  47  * Under Cygwin, DJGPP and FreeBSD we do not have MS_RDONLY,
  48  * so we define them ourselves.
  49  */
  50 #ifndef MS_RDONLY
  51 #define MS_RDONLY 1
  52 #endif
  53
  54 #define MS_EXCLUSIVE 0x08000000
  55
  56 #ifndef MS_RECOVER
  57 #define MS_RECOVER   0x10000000
  58 #endif
  59
  60 #define MS_IGNORE_HIBERFILE   0x20000000
  61 #define MS_FORENSIC           0x04000000 /* No modification during mount */
  62
  63 /* Forward declaration */
  64 typedef struct _ntfs_volume ntfs_volume;
  65
  66 #include "param.h"
  67 #include "types.h"
  68 #include "support.h"
  69 #include "device.h"
  70 #include "inode.h"
  71 #include "attrib.h"
  72 #include "index.h"
  73
  74 /**
  75  * enum ntfs_mount_flags -
  76  *
  77  * Flags returned by the ntfs_check_if_mounted() function.
  78  */
  79 typedef enum {
  80         NTFS_MF_MOUNTED         = 1,    /* Device is mounted. */
  81         NTFS_MF_ISROOT          = 2,    /* Device is mounted as system root. */
  82         NTFS_MF_READONLY        = 4,    /* Device is mounted read-only. */
  83 } ntfs_mount_flags;
  84
  85 extern int ntfs_check_if_mounted(const char *file, unsigned long *mnt_flags);
  86
  87 typedef enum {
  88         NTFS_VOLUME_OK                  = 0,
  89         NTFS_VOLUME_SYNTAX_ERROR        = 11,
  90         NTFS_VOLUME_NOT_NTFS            = 12,
  91         NTFS_VOLUME_CORRUPT             = 13,
  92         NTFS_VOLUME_HIBERNATED          = 14,
  93         NTFS_VOLUME_UNCLEAN_UNMOUNT     = 15,
  94         NTFS_VOLUME_LOCKED              = 16,
  95         NTFS_VOLUME_RAID                = 17,
  96         NTFS_VOLUME_UNKNOWN_REASON      = 18,
  97         NTFS_VOLUME_NO_PRIVILEGE        = 19,
  98         NTFS_VOLUME_OUT_OF_MEMORY       = 20,
  99         NTFS_VOLUME_FUSE_ERROR          = 21,
 100         NTFS_VOLUME_INSECURE            = 22
 101 } ntfs_volume_status;
 102
 103 /**
 104  * enum ntfs_volume_state_bits -
 105  *
 106  * Defined bits for the state field in the ntfs_volume structure.
 107  */
 108 typedef enum {
 109         NV_ReadOnly,            /* 1: Volume is read-only. */
 110         NV_CaseSensitive,       /* 1: Volume is mounted case-sensitive. */
 111         NV_LogFileEmpty,        /* 1: $logFile journal is empty. */
 112         NV_ShowSysFiles,        /* 1: Show NTFS metafiles. */
 113         NV_ShowHidFiles,        /* 1: Show files marked hidden. */
 114         NV_HideDotFiles,        /* 1: Set hidden flag on dot files */
 115         NV_Compression,         /* 1: allow compression */
 116 } ntfs_volume_state_bits;
 117
 118 #define  test_nvol_flag(nv, flag)        test_bit(NV_##flag, (nv)->state)
 119 #define   set_nvol_flag(nv, flag)         set_bit(NV_##flag, (nv)->state)
 120 #define clear_nvol_flag(nv, flag)       clear_bit(NV_##flag, (nv)->state)
 121
 122 #define NVolReadOnly(nv)                 test_nvol_flag(nv, ReadOnly)
 123 #define NVolSetReadOnly(nv)               set_nvol_flag(nv, ReadOnly)
 124 #define NVolClearReadOnly(nv)           clear_nvol_flag(nv, ReadOnly)
 125
 126 #define NVolCaseSensitive(nv)            test_nvol_flag(nv, CaseSensitive)
 127 #define NVolSetCaseSensitive(nv)          set_nvol_flag(nv, CaseSensitive)
 128 #define NVolClearCaseSensitive(nv)      clear_nvol_flag(nv, CaseSensitive)
 129
 130 #define NVolLogFileEmpty(nv)             test_nvol_flag(nv, LogFileEmpty)
 131 #define NVolSetLogFileEmpty(nv)           set_nvol_flag(nv, LogFileEmpty)
 132 #define NVolClearLogFileEmpty(nv)       clear_nvol_flag(nv, LogFileEmpty)
 133
 134 #define NVolShowSysFiles(nv)             test_nvol_flag(nv, ShowSysFiles)
 135 #define NVolSetShowSysFiles(nv)           set_nvol_flag(nv, ShowSysFiles)
 136 #define NVolClearShowSysFiles(nv)       clear_nvol_flag(nv, ShowSysFiles)
 137
 138 #define NVolShowHidFiles(nv)             test_nvol_flag(nv, ShowHidFiles)
 139 #define NVolSetShowHidFiles(nv)           set_nvol_flag(nv, ShowHidFiles)
 140 #define NVolClearShowHidFiles(nv)       clear_nvol_flag(nv, ShowHidFiles)
 141
 142 #define NVolHideDotFiles(nv)             test_nvol_flag(nv, HideDotFiles)
 143 #define NVolSetHideDotFiles(nv)           set_nvol_flag(nv, HideDotFiles)
 144 #define NVolClearHideDotFiles(nv)       clear_nvol_flag(nv, HideDotFiles)
 145
 146 #define NVolCompression(nv)              test_nvol_flag(nv, Compression)
 147 #define NVolSetCompression(nv)            set_nvol_flag(nv, Compression)
 148 #define NVolClearCompression(nv)        clear_nvol_flag(nv, Compression)
 149
 150 /*
 151  * NTFS version 1.1 and 1.2 are used by Windows NT4.
 152  * NTFS version 2.x is used by Windows 2000 Beta
 153  * NTFS version 3.0 is used by Windows 2000.
 154  * NTFS version 3.1 is used by Windows XP, 2003 and Vista.
 155  */
 156
 157 #define NTFS_V1_1(major, minor) ((major) == 1 && (minor) == 1)
 158 #define NTFS_V1_2(major, minor) ((major) == 1 && (minor) == 2)
 159 #define NTFS_V2_X(major, minor) ((major) == 2)
 160 #define NTFS_V3_0(major, minor) ((major) == 3 && (minor) == 0)
 161 #define NTFS_V3_1(major, minor) ((major) == 3 && (minor) == 1)
 162
 163 #define NTFS_BUF_SIZE 8192
 164
 165 /**
 166  * struct _ntfs_volume - structure describing an open volume in memory.
 167  */
 168 struct _ntfs_volume {
 169         union {
 170                 struct ntfs_device *dev;        /* NTFS device associated with
 171                                                    the volume. */
 172                 void *sb;       /* For kernel porting compatibility. */
 173         };
 174         char *vol_name;         /* Name of the volume. */
 175         unsigned long state;    /* NTFS specific flags describing this volume.
 176                                    See ntfs_volume_state_bits above. */
 177
 178         ntfs_inode *vol_ni;     /* ntfs_inode structure for FILE_Volume. */
 179         u8 major_ver;           /* Ntfs major version of volume. */
 180         u8 minor_ver;           /* Ntfs minor version of volume. */
 181         le16 flags;             /* Bit array of VOLUME_* flags. */
 182
 183         u16 sector_size;        /* Byte size of a sector. */
 184         u8 sector_size_bits;    /* Log(2) of the byte size of a sector. */
 185         u32 cluster_size;       /* Byte size of a cluster. */
 186         u32 mft_record_size;    /* Byte size of a mft record. */
 187         u32 indx_record_size;   /* Byte size of a INDX record. */
 188         u8 cluster_size_bits;   /* Log(2) of the byte size of a cluster. */
 189         u8 mft_record_size_bits;/* Log(2) of the byte size of a mft record. */
 190         u8 indx_record_size_bits;/* Log(2) of the byte size of a INDX record. */
 191
 192         /* Variables used by the cluster and mft allocators. */
 193         u8 mft_zone_multiplier; /* Initial mft zone multiplier. */
 194         u8 full_zones;          /* cluster zones which are full */
 195         s64 mft_data_pos;       /* Mft record number at which to allocate the
 196                                    next mft record. */
 197         LCN mft_zone_start;     /* First cluster of the mft zone. */
 198         LCN mft_zone_end;       /* First cluster beyond the mft zone. */
 199         LCN mft_zone_pos;       /* Current position in the mft zone. */
 200         LCN data1_zone_pos;     /* Current position in the first data zone. */
 201         LCN data2_zone_pos;     /* Current position in the second data zone. */
 202
 203         s64 nr_clusters;        /* Volume size in clusters, hence also the
 204                                    number of bits in lcn_bitmap. */
 205         ntfs_inode *lcnbmp_ni;  /* ntfs_inode structure for FILE_Bitmap. */
 206         ntfs_attr *lcnbmp_na;   /* ntfs_attr structure for the data attribute
 207                                    of FILE_Bitmap. Each bit represents a
 208                                    cluster on the volume, bit 0 representing
 209                                    lcn 0 and so on. A set bit means that the
 210                                    cluster and vice versa. */
 211
 212         LCN mft_lcn;            /* Logical cluster number of the data attribute
 213                                    for FILE_MFT. */
 214         ntfs_inode *mft_ni;     /* ntfs_inode structure for FILE_MFT. */
 215         ntfs_attr *mft_na;      /* ntfs_attr structure for the data attribute
 216                                    of FILE_MFT. */
 217         ntfs_attr *mftbmp_na;   /* ntfs_attr structure for the bitmap attribute
 218                                    of FILE_MFT. Each bit represents an mft
 219                                    record in the $DATA attribute, bit 0
 220                                    representing mft record 0 and so on. A set
 221                                    bit means that the mft record is in use and
 222                                    vice versa. */
 223
 224         ntfs_inode *secure_ni;  /* ntfs_inode structure for FILE $Secure */
 225         ntfs_index_context *secure_xsii; /* index for using $Secure:$SII */
 226         ntfs_index_context *secure_xsdh; /* index for using $Secure:$SDH */
 227         int secure_reentry;  /* check for non-rentries */
 228         unsigned int secure_flags;  /* flags, see security.h for values */
 229
 230         int mftmirr_size;       /* Size of the FILE_MFTMirr in mft records. */
 231         LCN mftmirr_lcn;        /* Logical cluster number of the data attribute
 232                                    for FILE_MFTMirr. */
 233         ntfs_inode *mftmirr_ni; /* ntfs_inode structure for FILE_MFTMirr. */
 234         ntfs_attr *mftmirr_na;  /* ntfs_attr structure for the data attribute
 235                                    of FILE_MFTMirr. */
 236
 237         ntfschar *upcase;       /* Upper case equivalents of all 65536 2-byte
 238                                    Unicode characters. Obtained from
 239                                    FILE_UpCase. */
 240         u32 upcase_len;         /* Length in Unicode characters of the upcase
 241                                    table. */
 242         ntfschar *locase;       /* Lower case equivalents of all 65536 2-byte
 243                                    Unicode characters. Only if option
 244                                    case_ignore is set. */
 245
 246         ATTR_DEF *attrdef;      /* Attribute definitions. Obtained from
 247                                    FILE_AttrDef. */
 248         s32 attrdef_len;        /* Size of the attribute definition table in
 249                                    bytes. */
 250
 251         s64 free_clusters;      /* Track the number of free clusters which
 252                                    greatly improves statfs() performance */
 253         s64 free_mft_records;   /* Same for free mft records (see above) */
 254         BOOL efs_raw;           /* volume is mounted for raw access to
 255                                    efs-encrypted files */
 256 #ifdef XATTR_MAPPINGS
 257         struct XATTRMAPPING *xattr_mapping;
 258 #endif /* XATTR_MAPPINGS */
 259 #if CACHE_INODE_SIZE
 260         struct CACHE_HEADER *xinode_cache;
 261 #endif
 262 #if CACHE_NIDATA_SIZE
 263         struct CACHE_HEADER *nidata_cache;
 264 #endif
 265 #if CACHE_LOOKUP_SIZE
 266         struct CACHE_HEADER *lookup_cache;
 267 #endif
 268 #if CACHE_SECURID_SIZE
 269         struct CACHE_HEADER *securid_cache;
 270 #endif
 271 #if CACHE_LEGACY_SIZE
 272         struct CACHE_HEADER *legacy_cache;
 273 #endif
 274
 275 };
 276
 277 extern const char *ntfs_home;
 278
 279 extern ntfs_volume *ntfs_volume_alloc(void);
 280
 281 extern ntfs_volume *ntfs_volume_startup(struct ntfs_device *dev,
 282                 unsigned long flags);
 283
 284 extern ntfs_volume *ntfs_device_mount(struct ntfs_device *dev,
 285                 unsigned long flags);
 286
 287 extern ntfs_volume *ntfs_mount(const char *name, unsigned long flags);
 288 extern int ntfs_umount(ntfs_volume *vol, const BOOL force);
 289
 290 extern int ntfs_version_is_supported(ntfs_volume *vol);
 291 extern int ntfs_volume_check_hiberfile(ntfs_volume *vol, int verbose);
 292 extern int ntfs_logfile_reset(ntfs_volume *vol);
 293
 294 extern int ntfs_volume_write_flags(ntfs_volume *vol, const le16 flags);
 295
 296 extern int ntfs_volume_error(int err);
 297 extern void ntfs_mount_error(const char *vol, const char *mntpoint, int err);
 298
 299 extern int ntfs_volume_get_free_space(ntfs_volume *vol);
 300
 301 extern int ntfs_set_shown_files(ntfs_volume *vol,
 302                 BOOL show_sys_files, BOOL show_hid_files, BOOL hide_dot_files);
 303 extern int ntfs_set_locale(void);
 304 extern int ntfs_set_ignore_case(ntfs_volume *vol);
 305
 306 #endif /* defined _NTFS_VOLUME_H */
 307