wimlib.net Git - wimlib/blob - src/lookup_table.h

   1 #ifndef _WIMLIB_LOOKUP_TABLE_H
   2 #define _WIMLIB_LOOKUP_TABLE_H
   3 #include "wimlib_internal.h"
   4 #include "dentry.h"
   5 #include "sha1.h"
   6 #include <sys/types.h>
   7
   8 /* Size of each lookup table entry in the WIM file. */
   9 #define WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE 50
  10
  11 #define LOOKUP_FLAG_ADS_OK              0x00000001
  12 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
  13
  14 /* Not yet used */
  15 //#define LOOKUP_FLAG_FOLLOW_SYMLINKS   0x00000004
  16
  17
  18 /* A lookup table that is used to translate the hash codes of dentries into the
  19  * offsets and sizes of uncompressed or compressed file resources.  It is
  20  * implemented as a hash table. */
  21 struct lookup_table {
  22         struct hlist_head *array;
  23         u64 num_entries;
  24         u64 capacity;
  25 };
  26
  27 struct wimlib_fd;
  28
  29 #ifdef WITH_NTFS_3G
  30 struct ntfs_location {
  31         char *path_utf8;
  32         char *stream_name_utf16;
  33         u16 stream_name_utf16_num_chars;
  34         struct _ntfs_volume **ntfs_vol_p;
  35         bool is_reparse_point;
  36 };
  37 #endif
  38
  39 /*
  40  * An entry in the lookup table in the WIM file.
  41  *
  42  * It is used to find data streams for files in the WIM.
  43  *
  44  * Metadata resources and reparse point data buffers will also have lookup table
  45  * entries associated with the data.
  46  *
  47  * The lookup_table_entry for a given dentry or alternate stream entry in the
  48  * WIM is found using the SHA1 message digest field.
  49  */
  50 struct lookup_table_entry {
  51
  52         /* List of lookup table entries in this hash bucket */
  53         union {
  54                 struct hlist_node hash_list;
  55                 struct list_head list;
  56         };
  57
  58         /* Location and size of the stream in the WIM, whether it is compressed
  59          * or not, and whether it's a metadata resource or not.  This is an
  60          * on-disk field. */
  61         struct resource_entry resource_entry;
  62
  63         /* Specifies which part of the split WIM the resource is located in.
  64          * This is on on-disk field.
  65          *
  66          * In stand-alone WIMs, this must be 1.
  67          *
  68          * In split WIMs, every split WIM part has its own lookup table, and in
  69          * read_lookup_table() it's currently expected that the part number of
  70          * each lookup table entry in a split WIM part's lookup table is the
  71          * same as the part number of that split WIM part.  So this makes this
  72          * field redundant since we store a pointer to the corresponding
  73          * WIMStruct in the lookup table entry anyway.
  74          */
  75         u16 part_number;
  76
  77         /* An enumerated type that identifies where the stream corresponding to
  78          * this lookup table entry is actually located.
  79          *
  80          * Obviously if we open a WIM and read its lookup table, the location is
  81          * set to RESOURCE_IN_WIM since all the streams will initially be
  82          * located in the WIM.  However, to deal with problems such as image
  83          * capture and image mount, we allow the actual location of the stream
  84          * to be somewhere else, such as an external file.
  85          */
  86         enum {
  87                 /* The lookup table entry does not correspond to a stream (this
  88                  * state should exist only temporarily) */
  89                 RESOURCE_NONEXISTENT = 0,
  90
  91                 /* The stream resource is located in a WIM file.  The WIMStruct
  92                  * for the WIM file will be pointed to by the @wim member. */
  93                 RESOURCE_IN_WIM,
  94
  95                 /* The stream resource is located in an external file.  The
  96                  * name of the file will be provided by @file_on_disk member.
  97                  * In addition, if @file_on_disk_fp is not NULL, it will be an
  98                  * open FILE * to the file. */
  99                 RESOURCE_IN_FILE_ON_DISK,
 100
 101                 /* The stream resource is located in an external file in the
 102                  * staging directory for a read-write mount.  */
 103                 RESOURCE_IN_STAGING_FILE,
 104
 105                 /* The stream resource is directly attached in an in-memory
 106                  * buffer pointed to by @attached_buffer. */
 107                 RESOURCE_IN_ATTACHED_BUFFER,
 108
 109                 /* The stream resource is located in an NTFS volume.  It is
 110                  * identified by volume, filename, data stream name, and by
 111                  * whether it is a reparse point or not. @ntfs_loc points to a
 112                  * structure containing this information. */
 113                 RESOURCE_IN_NTFS_VOLUME,
 114         } resource_location;
 115
 116         /* (On-disk field)
 117          * Number of times this lookup table entry is referenced by dentries.
 118          * Unfortunately, this field is not always set correctly in Microsoft's
 119          * WIMs, so we have no choice but to fix it if more references to the
 120          * lookup table entry are found than stated here. */
 121         u32 refcnt;
 122
 123         union {
 124                 /* (On-disk field) SHA1 message digest of the stream referenced
 125                  * by this lookup table entry */
 126                 u8  hash[SHA1_HASH_SIZE];
 127
 128                 /* First 4 or 8 bytes of the SHA1 message digest, used for
 129                  * inserting the entry into the hash table.  Since the SHA1
 130                  * message digest can be considered random, we don't really need
 131                  * the full 20 byte hash just to insert the entry in a hash
 132                  * table. */
 133                 size_t hash_short;
 134         };
 135
 136         /* Pointers to somewhere where the stream is actually located.  See the
 137          * comments for the @resource_location field above. */
 138         union {
 139                 WIMStruct *wim;
 140                 char *file_on_disk;
 141                 char *staging_file_name;
 142                 u8 *attached_buffer;
 143         #ifdef WITH_NTFS_3G
 144                 struct ntfs_location *ntfs_loc;
 145         #endif
 146         };
 147         union {
 148                 /* @file_on_disk_fp and @attr are both used to cache file/stream
 149                  * handles so we don't have re-open them on every read */
 150
 151                 /* Valid iff resource_location == RESOURCE_IN_FILE_ON_DISK */
 152                 FILE *file_on_disk_fp;
 153         #ifdef WITH_NTFS_3G
 154                 /* Valid iff resource_location == RESOURCE_IN_NTFS_VOLUME */
 155                 struct _ntfs_attr *attr;
 156         #endif
 157
 158                 /* Pointer to inode that contains the opened file descriptors to
 159                  * this stream (valid iff resource_location ==
 160                  * RESOURCE_IN_STAGING_FILE) */
 161                 struct inode *lte_inode;
 162         };
 163 #ifdef WITH_FUSE
 164         u16 num_opened_fds;
 165 #endif
 166
 167         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
 168          * whenever the file resource pointed to by this lookup table entry
 169          * needs to be written.  The file resource only need to be written when
 170          * out_refcnt is nonzero, since otherwise it is not referenced by any
 171          * dentries. */
 172         u32 out_refcnt;
 173
 174         u32 real_refcnt;
 175
 176         /* When a WIM file is written, @output_resource_entry is filled
 177          * in with the resource entry for the output WIM.  This will not
 178          * necessarily be the same as the @resource_entry since:
 179          *      - The stream may have a different offset in the new WIM
 180          *      - The stream may have a different compressed size in the
 181          *      new WIM if the compression type changed
 182          */
 183         struct resource_entry output_resource_entry;
 184
 185         /* This field is used for the special hardlink or symlink image
 186          * extraction mode.   In these mode, all identical files are linked
 187          * together, and @extracted_file will be set to the filename of the
 188          * first extracted file containing this stream.  */
 189         char *extracted_file;
 190
 191         union {
 192                 /* List of lookup table entries that correspond to streams that have
 193                  * been extracted to the staging directory when modifying a read-write
 194                  * mounted WIM. */
 195                 struct list_head staging_list;
 196
 197                 /* Temporary field for creating a singly linked list. */
 198                 struct lookup_table_entry *next_lte_in_swm;
 199         };
 200 };
 201
 202 static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
 203 {
 204         return lte->resource_entry.original_size;
 205 }
 206
 207 static inline u64
 208 wim_resource_compressed_size(const struct lookup_table_entry *lte)
 209 {
 210         return lte->resource_entry.size;
 211 }
 212
 213 /*
 214  * XXX Probably should store the compression type directly in the lookup table
 215  * entry
 216  */
 217 static inline int
 218 wim_resource_compression_type(const struct lookup_table_entry *lte)
 219 {
 220         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
 221             || lte->resource_location != RESOURCE_IN_WIM)
 222                 return WIM_COMPRESSION_TYPE_NONE;
 223         return wimlib_get_compression_type(lte->wim);
 224 }
 225
 226
 227 extern struct lookup_table *new_lookup_table(size_t capacity);
 228
 229 extern void lookup_table_insert(struct lookup_table *table,
 230                                 struct lookup_table_entry *lte);
 231
 232 /* Unlinks a lookup table entry from the table; does not free it. */
 233 static inline void lookup_table_unlink(struct lookup_table *table,
 234                                        struct lookup_table_entry *lte)
 235 {
 236         hlist_del(&lte->hash_list);
 237         table->num_entries--;
 238 }
 239
 240 extern struct lookup_table_entry *new_lookup_table_entry();
 241
 242 extern struct lookup_table_entry *
 243 clone_lookup_table_entry(const struct lookup_table_entry *lte);
 244
 245 extern int for_lookup_table_entry(struct lookup_table *table,
 246                                   int (*visitor)(struct lookup_table_entry *, void *),
 247                                   void *arg);
 248
 249 extern struct lookup_table_entry *
 250 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
 251
 252 extern int lookup_resource(WIMStruct *w, const char *path,
 253                            int lookup_flags, struct dentry **dentry_ret,
 254                            struct lookup_table_entry **lte_ret,
 255                            u16 *stream_idx_ret);
 256
 257 extern void lte_decrement_refcnt(struct lookup_table_entry *lte,
 258                                  struct lookup_table *table);
 259 extern void lte_decrement_num_opened_fds(struct lookup_table_entry *lte,
 260                                          struct lookup_table *table);
 261
 262 extern int lte_zero_out_refcnt(struct lookup_table_entry *entry, void *ignore);
 263 extern int lte_zero_real_refcnt(struct lookup_table_entry *entry, void *ignore);
 264 extern int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignone);
 265
 266 extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
 267
 268 extern int read_lookup_table(WIMStruct *w);
 269
 270 extern void free_lookup_table(struct lookup_table *table);
 271
 272 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
 273
 274 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
 275
 276 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
 277 extern int dentry_unresolve_ltes(struct dentry *dentry, void *ignore);
 278
 279 /* Writes the lookup table to the output file. */
 280 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
 281 {
 282         return for_lookup_table_entry(table, write_lookup_table_entry, out);
 283 }
 284
 285 /* Unlinks and frees an entry from a lookup table. */
 286 static inline void lookup_table_remove(struct lookup_table *table,
 287                                        struct lookup_table_entry *lte)
 288 {
 289         lookup_table_unlink(table, lte);
 290         free_lookup_table_entry(lte);
 291 }
 292
 293 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
 294 {
 295         return &w->image_metadata[
 296                         w->current_image - 1].metadata_lte->resource_entry;
 297 }
 298
 299 static inline struct lookup_table_entry *
 300 inode_stream_lte_resolved(const struct inode *inode, unsigned stream_idx)
 301 {
 302         wimlib_assert(inode->resolved);
 303         wimlib_assert(stream_idx <= inode->num_ads);
 304         if (stream_idx == 0)
 305                 return inode->lte;
 306         else
 307                 return inode->ads_entries[stream_idx - 1].lte;
 308 }
 309
 310 static inline struct lookup_table_entry *
 311 inode_stream_lte_unresolved(const struct inode *inode, unsigned stream_idx,
 312                             const struct lookup_table *table)
 313 {
 314         wimlib_assert(!inode->resolved);
 315         wimlib_assert(stream_idx <= inode->num_ads);
 316         if (!table)
 317                 return NULL;
 318         if (stream_idx == 0)
 319                 return __lookup_resource(table, inode->hash);
 320         else
 321                 return __lookup_resource(table,
 322                                          inode->ads_entries[
 323                                                 stream_idx - 1].hash);
 324 }
 325 /*
 326  * Returns the lookup table entry for stream @stream_idx of the inode, where
 327  * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
 328  * corresponds to an alternate data stream.
 329  *
 330  * This works for both resolved and un-resolved dentries.
 331  */
 332 static inline struct lookup_table_entry *
 333 inode_stream_lte(const struct inode *inode, unsigned stream_idx,
 334                  const struct lookup_table *table)
 335 {
 336         if (inode->resolved)
 337                 return inode_stream_lte_resolved(inode, stream_idx);
 338         else
 339                 return inode_stream_lte_unresolved(inode, stream_idx, table);
 340 }
 341
 342
 343 static inline const u8 *inode_stream_hash_unresolved(const struct inode *inode,
 344                                                      unsigned stream_idx)
 345 {
 346         wimlib_assert(!inode->resolved);
 347         wimlib_assert(stream_idx <= inode->num_ads);
 348         if (stream_idx == 0)
 349                 return inode->hash;
 350         else
 351                 return inode->ads_entries[stream_idx - 1].hash;
 352 }
 353
 354
 355 static inline const u8 *inode_stream_hash_resolved(const struct inode *inode,
 356                                                    unsigned stream_idx)
 357 {
 358         struct lookup_table_entry *lte;
 359         lte = inode_stream_lte_resolved(inode, stream_idx);
 360         if (lte)
 361                 return lte->hash;
 362         else
 363                 return zero_hash;
 364 }
 365
 366 /*
 367  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
 368  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
 369  * alternate data stream.
 370  *
 371  * This works for both resolved and un-resolved dentries.
 372  */
 373 static inline const u8 *inode_stream_hash(const struct inode *inode,
 374                                           unsigned stream_idx)
 375 {
 376         if (inode->resolved)
 377                 return inode_stream_hash_resolved(inode, stream_idx);
 378         else
 379                 return inode_stream_hash_unresolved(inode, stream_idx);
 380 }
 381
 382 static inline u16 inode_stream_name_len(const struct inode *inode,
 383                                         unsigned stream_idx)
 384 {
 385         wimlib_assert(stream_idx <= inode->num_ads);
 386         if (stream_idx == 0)
 387                 return 0;
 388         else
 389                 return inode->ads_entries[stream_idx - 1].stream_name_len;
 390 }
 391
 392 static inline struct lookup_table_entry *
 393 inode_unnamed_lte_resolved(const struct inode *inode)
 394 {
 395         wimlib_assert(inode->resolved);
 396         for (unsigned i = 0; i <= inode->num_ads; i++)
 397                 if (inode_stream_name_len(inode, i) == 0 &&
 398                      !is_zero_hash(inode_stream_hash_resolved(inode, i)))
 399                         return inode_stream_lte_resolved(inode, i);
 400         return NULL;
 401 }
 402
 403 static inline struct lookup_table_entry *
 404 inode_unnamed_lte_unresolved(const struct inode *inode,
 405                              const struct lookup_table *table)
 406 {
 407         wimlib_assert(!inode->resolved);
 408         for (unsigned i = 0; i <= inode->num_ads; i++)
 409                 if (inode_stream_name_len(inode, i) == 0 &&
 410                      !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
 411                         return inode_stream_lte_unresolved(inode, i, table);
 412         return NULL;
 413 }
 414
 415 extern struct lookup_table_entry *
 416 inode_unnamed_lte(const struct inode *inode,
 417                   const struct lookup_table *table);
 418
 419
 420 #endif