fs/hfsplus/hfsplus_raw.h

   1 /*
   2  *  linux/include/linux/hfsplus_raw.h
   3  *
   4  * Copyright (C) 1999
   5  * Brad Boyer (flar@pants.nu)
   6  * (C) 2003 Ardis Technologies <roman@ardistech.com>
   7  *
   8  * Format of structures on disk
   9  * Information taken from Apple Technote #1150 (HFS Plus Volume Format)
  10  *
  11  */
  12
  13 #ifndef _LINUX_HFSPLUS_RAW_H
  14 #define _LINUX_HFSPLUS_RAW_H
  15
  16 #include <linux/types.h>
  17
  18 #define __packed __attribute__ ((packed))
  19
  20 /* Some constants */
  21 #define HFSPLUS_SECTOR_SIZE        512
  22 #define HFSPLUS_SECTOR_SHIFT         9
  23 #define HFSPLUS_VOLHEAD_SECTOR       2
  24 #define HFSPLUS_VOLHEAD_SIG     0x482b
  25 #define HFSPLUS_SUPER_MAGIC     0x482b
  26 #define HFSPLUS_CURRENT_VERSION      4
  27
  28 #define HFSP_WRAP_MAGIC         0x4244
  29 #define HFSP_WRAP_ATTRIB_SLOCK  0x8000
  30 #define HFSP_WRAP_ATTRIB_SPARED 0x0200
  31
  32 #define HFSP_WRAPOFF_SIG          0x00
  33 #define HFSP_WRAPOFF_ATTRIB       0x0A
  34 #define HFSP_WRAPOFF_ABLKSIZE     0x14
  35 #define HFSP_WRAPOFF_ABLKSTART    0x1C
  36 #define HFSP_WRAPOFF_EMBEDSIG     0x7C
  37 #define HFSP_WRAPOFF_EMBEDEXT     0x7E
  38
  39 #define HFSP_HIDDENDIR_NAME     "\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80\xe2\x90\x80HFS+ Private Data"
  40
  41 #define HFSP_HARDLINK_TYPE      0x686c6e6b      /* 'hlnk' */
  42 #define HFSP_HFSPLUS_CREATOR    0x6866732b      /* 'hfs+' */
  43
  44 #define HFSP_MOUNT_VERSION      0x482b4c78      /* 'H+Lx' */
  45
  46 /* Structures used on disk */
  47
  48 typedef u32 hfsplus_cnid;
  49 typedef u16 hfsplus_unichr;
  50
  51 /* A "string" as used in filenames, etc. */
  52 struct hfsplus_unistr {
  53         u16 length;
  54         hfsplus_unichr unicode[255];
  55 } __packed;
  56
  57 #define HFSPLUS_MAX_STRLEN 255
  58
  59 /* POSIX permissions */
  60 struct hfsplus_perm {
  61         u32 owner;
  62         u32 group;
  63         u8  rootflags;
  64         u8  userflags;
  65         u16 mode;
  66         u32 dev;
  67 } __packed;
  68
  69 #define HFSPLUS_FLG_NODUMP      0x01
  70 #define HFSPLUS_FLG_IMMUTABLE   0x02
  71 #define HFSPLUS_FLG_APPEND      0x04
  72
  73 /* A single contiguous area of a file */
  74 struct hfsplus_extent {
  75         u32 start_block;
  76         u32 block_count;
  77 } __packed;
  78 typedef struct hfsplus_extent hfsplus_extent_rec[8];
  79
  80 /* Information for a "Fork" in a file */
  81 struct hfsplus_fork_raw {
  82         u64 total_size;
  83         u32 clump_size;
  84         u32 total_blocks;
  85         hfsplus_extent_rec extents;
  86 } __packed;
  87
  88 /* HFS+ Volume Header */
  89 struct hfsplus_vh {
  90         u16 signature;
  91         u16 version;
  92         u32 attributes;
  93         u32 last_mount_vers;
  94         u32 reserved;
  95
  96         u32 create_date;
  97         u32 modify_date;
  98         u32 backup_date;
  99         u32 checked_date;
 100
 101         u32 file_count;
 102         u32 folder_count;
 103
 104         u32 blocksize;
 105         u32 total_blocks;
 106         u32 free_blocks;
 107
 108         u32 next_alloc;
 109         u32 rsrc_clump_sz;
 110         u32 data_clump_sz;
 111         hfsplus_cnid next_cnid;
 112
 113         u32 write_count;
 114         u64 encodings_bmp;
 115
 116         u8 finder_info[32];
 117
 118         struct hfsplus_fork_raw alloc_file;
 119         struct hfsplus_fork_raw ext_file;
 120         struct hfsplus_fork_raw cat_file;
 121         struct hfsplus_fork_raw attr_file;
 122         struct hfsplus_fork_raw start_file;
 123 } __packed;
 124
 125 /* HFS+ volume attributes */
 126 #define HFSPLUS_VOL_UNMNT     (1 << 8)
 127 #define HFSPLUS_VOL_SPARE_BLK (1 << 9)
 128 #define HFSPLUS_VOL_NOCACHE   (1 << 10)
 129 #define HFSPLUS_VOL_INCNSTNT  (1 << 11)
 130 #define HFSPLUS_VOL_SOFTLOCK  (1 << 15)
 131
 132 /* HFS+ BTree node descriptor */
 133 struct hfs_bnode_desc {
 134         u32 next;
 135         u32 prev;
 136         s8 type;
 137         u8 height;
 138         u16 num_recs;
 139         u16 reserved;
 140 } __packed;
 141
 142 /* HFS+ BTree node types */
 143 #define HFS_NODE_INDEX  0x00
 144 #define HFS_NODE_HEADER 0x01
 145 #define HFS_NODE_MAP    0x02
 146 #define HFS_NODE_LEAF   0xFF
 147
 148 /* HFS+ BTree header */
 149 struct hfs_btree_header_rec {
 150         u16 depth;
 151         u32 root;
 152         u32 leaf_count;
 153         u32 leaf_head;
 154         u32 leaf_tail;
 155         u16 node_size;
 156         u16 max_key_len;
 157         u32 node_count;
 158         u32 free_nodes;
 159         u16 reserved1;
 160         u32 clump_size;
 161         u8 btree_type;
 162         u8 reserved2;
 163         u32 attributes;
 164         u32 reserved3[16];
 165 } __packed;
 166
 167 /* BTree attributes */
 168 #define HFS_TREE_BIGKEYS        2
 169 #define HFS_TREE_VARIDXKEYS     4
 170
 171 /* HFS+ BTree misc info */
 172 #define HFSPLUS_TREE_HEAD 0
 173 #define HFSPLUS_NODE_MXSZ 32768
 174
 175 /* Some special File ID numbers (stolen from hfs.h) */
 176 #define HFSPLUS_POR_CNID                1       /* Parent Of the Root */
 177 #define HFSPLUS_ROOT_CNID               2       /* ROOT directory */
 178 #define HFSPLUS_EXT_CNID                3       /* EXTents B-tree */
 179 #define HFSPLUS_CAT_CNID                4       /* CATalog B-tree */
 180 #define HFSPLUS_BAD_CNID                5       /* BAD blocks file */
 181 #define HFSPLUS_ALLOC_CNID              6       /* ALLOCation file */
 182 #define HFSPLUS_START_CNID              7       /* STARTup file */
 183 #define HFSPLUS_ATTR_CNID               8       /* ATTRibutes file */
 184 #define HFSPLUS_EXCH_CNID               15      /* ExchangeFiles temp id */
 185 #define HFSPLUS_FIRSTUSER_CNID          16      /* first available user id */
 186
 187 /* HFS+ catalog entry key */
 188 struct hfsplus_cat_key {
 189         u16 key_len;
 190         hfsplus_cnid parent;
 191         struct hfsplus_unistr name;
 192 } __packed;
 193
 194
 195 /* Structs from hfs.h */
 196 struct hfsp_point {
 197         u16 v;
 198         u16 h;
 199 } __packed;
 200
 201 struct hfsp_rect {
 202         u16 top;
 203         u16 left;
 204         u16 bottom;
 205         u16 right;
 206 } __packed;
 207
 208
 209 /* HFS directory info (stolen from hfs.h */
 210 struct DInfo {
 211         struct hfsp_rect frRect;
 212         u16 frFlags;
 213         struct hfsp_point frLocation;
 214         u16 frView;
 215 } __packed;
 216
 217 struct DXInfo {
 218         struct hfsp_point frScroll;
 219         u32 frOpenChain;
 220         u16 frUnused;
 221         u16 frComment;
 222         u32 frPutAway;
 223 } __packed;
 224
 225 /* HFS+ folder data (part of an hfsplus_cat_entry) */
 226 struct hfsplus_cat_folder {
 227         s16 type;
 228         u16 flags;
 229         u32 valence;
 230         hfsplus_cnid id;
 231         u32 create_date;
 232         u32 content_mod_date;
 233         u32 attribute_mod_date;
 234         u32 access_date;
 235         u32 backup_date;
 236         struct hfsplus_perm permissions;
 237         struct DInfo user_info;
 238         struct DXInfo finder_info;
 239         u32 text_encoding;
 240         u32 reserved;
 241 } __packed;
 242
 243 /* HFS file info (stolen from hfs.h) */
 244 struct FInfo {
 245         u32 fdType;
 246         u32 fdCreator;
 247         u16 fdFlags;
 248         struct hfsp_point fdLocation;
 249         u16 fdFldr;
 250 } __packed;
 251
 252 struct FXInfo {
 253         u16 fdIconID;
 254         u8 fdUnused[8];
 255         u16 fdComment;
 256         u32 fdPutAway;
 257 } __packed;
 258
 259 /* HFS+ file data (part of a cat_entry) */
 260 struct hfsplus_cat_file {
 261         s16 type;
 262         u16 flags;
 263         u32 reserved1;
 264         hfsplus_cnid id;
 265         u32 create_date;
 266         u32 content_mod_date;
 267         u32 attribute_mod_date;
 268         u32 access_date;
 269         u32 backup_date;
 270         struct hfsplus_perm permissions;
 271         struct FInfo user_info;
 272         struct FXInfo finder_info;
 273         u32 text_encoding;
 274         u32 reserved2;
 275
 276         struct hfsplus_fork_raw data_fork;
 277         struct hfsplus_fork_raw rsrc_fork;
 278 } __packed;
 279
 280 /* File attribute bits */
 281 #define HFSPLUS_FILE_LOCKED             0x0001
 282 #define HFSPLUS_FILE_THREAD_EXISTS      0x0002
 283
 284 /* HFS+ catalog thread (part of a cat_entry) */
 285 struct hfsplus_cat_thread {
 286         s16 type;
 287         s16 reserved;
 288         hfsplus_cnid parentID;
 289         struct hfsplus_unistr nodeName;
 290 } __packed;
 291
 292 #define HFSPLUS_MIN_THREAD_SZ 10
 293
 294 /* A data record in the catalog tree */
 295 typedef union {
 296         s16 type;
 297         struct hfsplus_cat_folder folder;
 298         struct hfsplus_cat_file file;
 299         struct hfsplus_cat_thread thread;
 300 } __packed hfsplus_cat_entry;
 301
 302 /* HFS+ catalog entry type */
 303 #define HFSPLUS_FOLDER         0x0001
 304 #define HFSPLUS_FILE           0x0002
 305 #define HFSPLUS_FOLDER_THREAD  0x0003
 306 #define HFSPLUS_FILE_THREAD    0x0004
 307
 308 /* HFS+ extents tree key */
 309 struct hfsplus_ext_key {
 310         u16 key_len;
 311         u8 fork_type;
 312         u8 pad;
 313         hfsplus_cnid cnid;
 314         u32 start_block;
 315 } __packed;
 316
 317 #define HFSPLUS_EXT_KEYLEN 12
 318
 319 /* HFS+ generic BTree key */
 320 typedef union {
 321         u16 key_len;
 322         struct hfsplus_cat_key cat;
 323         struct hfsplus_ext_key ext;
 324 } __packed hfsplus_btree_key;
 325
 326 #endif