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

   1 #ifndef _WIMLIB_LOOKUP_TABLE_H
   2 #define _WIMLIB_LOOKUP_TABLE_H
   3
   4 #include "wimlib/assert.h"
   5 #include "wimlib/dentry.h"
   6 #include "wimlib/list.h"
   7 #include "wimlib/sha1.h"
   8 #include "wimlib/types.h"
   9 #include "wimlib/wim.h"
  10
  11 #define LOOKUP_FLAG_ADS_OK              0x00000001
  12 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
  13
  14
  15 /* The lookup table of a WIM file maps SHA1 message digests to streams of data.
  16  * Here, the in-memory structure is implemented as a hash table.
  17  *
  18  * Given a SHA1 message digest, the mapped-to stream is specified by an offset
  19  * in the WIM, an uncompressed and compressed size, and resource flags (see
  20  * 'struct resource_entry').  But, we associate additional information, such as
  21  * a reference count, with each stream, so the actual mapping is from SHA1
  22  * message digests to 'struct wim_lookup_table_entry's, each of which contains
  23  * an embedded 'struct resource_entry'.
  24  *
  25  * Note: Everything will break horribly if there is a SHA1 collision.
  26  */
  27 struct wim_lookup_table {
  28         struct hlist_head *array;
  29         u64 num_entries;
  30         u64 capacity;
  31         struct list_head *unhashed_streams;
  32 };
  33
  34 #ifdef WITH_NTFS_3G
  35
  36 struct _ntfs_volume;
  37
  38 struct ntfs_location {
  39         tchar *path;
  40         utf16lechar *stream_name;
  41         u16 stream_name_nchars;
  42         struct _ntfs_volume *ntfs_vol;
  43         bool is_reparse_point;
  44 };
  45 #endif
  46
  47 /* An enumerated type that identifies where the stream corresponding to this
  48  * lookup table entry is actually located.
  49  *
  50  * If we open a WIM and read its lookup table, the location is set to
  51  * RESOURCE_IN_WIM since all the streams will initially be located in the WIM.
  52  * However, to deal with problems such as image capture and image mount, we
  53  * allow the actual location of the stream to be somewhere else, such as an
  54  * external file.
  55  */
  56 enum resource_location {
  57         /* The lookup table entry does not correspond to a stream (this state
  58          * should exist only temporarily) */
  59         RESOURCE_NONEXISTENT = 0,
  60
  61         /* The stream resource is located in a WIM file.  The WIMStruct for the
  62          * WIM file will be pointed to by the @wim member.  The compression type
  63          * of the resource will be cached in @compression_type, and the pipable
  64          * status of the resource will be cached in @pipable.  */
  65         RESOURCE_IN_WIM,
  66
  67         /* The stream resource is located in an external file.  The name of the
  68          * file will be provided by @file_on_disk member.
  69          *
  70          * Note: On Windows @file_on_disk may actually specify a named data
  71          * stream.  */
  72         RESOURCE_IN_FILE_ON_DISK,
  73
  74         /* The stream resource is directly attached in an in-memory buffer
  75          * pointed to by @attached_buffer.  */
  76         RESOURCE_IN_ATTACHED_BUFFER,
  77
  78 #ifdef WITH_FUSE
  79         /* The stream resource is located in an external file in the staging
  80          * directory for a read-write mount.  */
  81         RESOURCE_IN_STAGING_FILE,
  82 #endif
  83
  84 #ifdef WITH_NTFS_3G
  85         /* The stream resource is located in an NTFS volume.  It is identified
  86          * by volume, filename, data stream name, and by whether it is a reparse
  87          * point or not. @ntfs_loc points to a structure containing this
  88          * information.  */
  89         RESOURCE_IN_NTFS_VOLUME,
  90 #endif
  91
  92 #ifdef __WIN32__
  93         /* Windows only: the file is on disk in the file named @file_on_disk,
  94          * but the file is encrypted and must be read using special functions.
  95          * */
  96         RESOURCE_WIN32_ENCRYPTED,
  97 #endif
  98
  99 };
 100
 101 /*
 102  * An entry in the lookup table in the WIM file.
 103  *
 104  * It is used to find data streams for files in the WIM.
 105  *
 106  * Metadata resources and reparse point data buffers will also have lookup table
 107  * entries associated with the data.
 108  *
 109  * The lookup_table_entry for a given dentry or alternate stream entry in the
 110  * WIM is found using the SHA1 message digest field.
 111  */
 112 struct wim_lookup_table_entry {
 113
 114         /* List of lookup table entries in this hash bucket */
 115         struct hlist_node hash_list;
 116
 117         /* Uncompressed size of the stream.  */
 118         u64 size;
 119
 120         /* Stream flags (WIM_RESHDR_FLAG_*).  */
 121         u16 flags : 8;
 122
 123         /* One of the `enum resource_location' values documented above. */
 124         u16 resource_location : 5;
 125
 126         /* 1 if this stream is a unique size (only set while writing streams). */
 127         u16 unique_size : 1;
 128
 129         /* 1 if this stream has not had a SHA1 message digest calculated for it
 130          * yet */
 131         u16 unhashed : 1;
 132
 133         u16 deferred : 1;
 134
 135         u16 no_progress : 1;
 136
 137         /* Set to 1 when a metadata entry has its checksum changed; in such
 138          * cases the hash is no longer valid to verify the data if the metadata
 139          * resource is read again.  */
 140         u16 dont_check_metadata_hash : 1;
 141
 142         /* Only used during WIM write.  Normal value is 0 (resource not
 143          * filtered).  */
 144         u16 filtered : 2;
 145 #define FILTERED_SAME_WIM       0x1  /* Resource already in same WIM  */
 146 #define FILTERED_EXTERNAL_WIM   0x2  /* Resource already in external WIM  */
 147
 148         /* (On-disk field)
 149          * Number of times this lookup table entry is referenced by dentries.
 150          * Unfortunately, this field is not always set correctly in Microsoft's
 151          * WIMs, so we have no choice but to fix it if more references to the
 152          * lookup table entry are found than stated here.  */
 153         u32 refcnt;
 154
 155         union {
 156                 /* (On-disk field) SHA1 message digest of the stream referenced
 157                  * by this lookup table entry.  */
 158                 u8  hash[SHA1_HASH_SIZE];
 159
 160                 /* First 4 or 8 bytes of the SHA1 message digest, used for
 161                  * inserting the entry into the hash table.  Since the SHA1
 162                  * message digest can be considered random, we don't really need
 163                  * the full 20 byte hash just to insert the entry in a hash
 164                  * table.  */
 165                 size_t hash_short;
 166
 167                 /* Unhashed entries only (unhashed == 1): these variables make
 168                  * it possible to find the pointer to this 'struct
 169                  * wim_lookup_table_entry' contained in either 'struct
 170                  * wim_ads_entry' or 'struct wim_inode'.  There can be at most 1
 171                  * such pointer, as we can only join duplicate streams after
 172                  * they have been hashed.  */
 173                 struct {
 174                         struct wim_inode *back_inode;
 175                         u32 back_stream_id;
 176                 };
 177         };
 178
 179         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
 180          * whenever the stream pointed to by this lookup table entry needs to be
 181          * written.  The stream only need to be written when out_refcnt is
 182          * nonzero, since otherwise it is not referenced by any dentries. */
 183         u32 out_refcnt;
 184
 185         /* Pointers to somewhere where the stream is actually located.  See the
 186          * comments for the @resource_location field above. */
 187         union {
 188                 struct {
 189                         struct wim_resource_spec *rspec;
 190                         u64 offset_in_res;
 191                 };
 192                 tchar *file_on_disk;
 193                 void *attached_buffer;
 194         #ifdef WITH_FUSE
 195                 tchar *staging_file_name;
 196         #endif
 197         #ifdef WITH_NTFS_3G
 198                 struct ntfs_location *ntfs_loc;
 199         #endif
 200         };
 201
 202         /* Actual reference count to this stream (only used while
 203          * verifying an image). */
 204         u32 real_refcnt;
 205
 206         union {
 207         #ifdef WITH_FUSE
 208                 /* Number of times this stream has been opened (used only during
 209                  * mounting) */
 210                 u16 num_opened_fds;
 211         #endif
 212
 213                 /* This field is used for the special hardlink or symlink image
 214                  * extraction mode.   In these mode, all identical files are linked
 215                  * together, and @extracted_file will be set to the filename of the
 216                  * first extracted file containing this stream.  */
 217                 tchar *extracted_file;
 218         };
 219
 220         /* Temporary fields  */
 221         union {
 222                 /* Used temporarily during WIM file writing  */
 223                 struct {
 224                         struct hlist_node hash_list_2;
 225
 226                         /* Links streams being written to the WIM.  */
 227                         struct list_head write_streams_list;
 228                 };
 229
 230                 /* Used temporarily during WIM file writing (after above)  */
 231                 struct {
 232                         struct list_head msg_list;
 233                         struct list_head being_compressed_list;
 234                 };
 235
 236                 /* When a WIM file is written, @output_reshdr is filled in with
 237                  * the resource header for the output WIM.  */
 238                 struct wim_reshdr out_reshdr;
 239
 240                 /* Used temporarily during extraction  */
 241                 union {
 242                         /* out_refcnt tracks number of slots filled */
 243                         struct wim_dentry *inline_lte_dentries[4];
 244                         struct {
 245                                 struct wim_dentry **lte_dentries;
 246                                 unsigned long alloc_lte_dentries;
 247                         };
 248                 };
 249         };
 250
 251         /* Temporary list fields */
 252         union {
 253                 /* Links streams when writing lookup table.  */
 254                 struct list_head lookup_table_list;
 255
 256                 /* Links streams being extracted.  */
 257                 struct list_head extraction_list;
 258
 259                 /* Links streams being exported.  */
 260                 struct list_head export_stream_list;
 261         };
 262
 263         /* Links streams that are still unhashed after being been added
 264          * to a WIM.  */
 265         struct list_head unhashed_list;
 266
 267         struct list_head wim_resource_list;
 268 };
 269
 270 static inline int
 271 lte_ctype(const struct wim_lookup_table_entry *lte)
 272 {
 273         if (lte->resource_location == RESOURCE_IN_WIM)
 274                 return lte->rspec->ctype;
 275         else
 276                 return WIMLIB_COMPRESSION_TYPE_NONE;
 277 }
 278
 279 static inline u32
 280 lte_cchunk_size(const struct wim_lookup_table_entry * lte)
 281 {
 282         if (lte->resource_location == RESOURCE_IN_WIM &&
 283             lte->rspec->ctype != WIMLIB_COMPRESSION_TYPE_NONE)
 284                 return lte->rspec->cchunk_size;
 285         else
 286                 return 32768;
 287 }
 288
 289 static inline bool
 290 lte_is_partial(const struct wim_lookup_table_entry * lte)
 291 {
 292         return lte->resource_location == RESOURCE_IN_WIM &&
 293                lte->size != lte->rspec->uncompressed_size;
 294 }
 295
 296 static inline bool
 297 lte_filename_valid(const struct wim_lookup_table_entry *lte)
 298 {
 299         return     lte->resource_location == RESOURCE_IN_FILE_ON_DISK
 300         #ifdef __WIN32__
 301                 || lte->resource_location == RESOURCE_WIN32_ENCRYPTED
 302         #endif
 303         #ifdef WITH_FUSE
 304                 || lte->resource_location == RESOURCE_IN_STAGING_FILE
 305         #endif
 306                 ;
 307 }
 308
 309 extern struct wim_lookup_table *
 310 new_lookup_table(size_t capacity) _malloc_attribute;
 311
 312 extern int
 313 read_wim_lookup_table(WIMStruct *wim);
 314
 315 extern int
 316 write_wim_lookup_table(WIMStruct *wim, int image, int write_flags,
 317                        struct wim_reshdr *out_reshdr,
 318                        struct list_head *stream_list_override);
 319
 320 extern void
 321 free_lookup_table(struct wim_lookup_table *table);
 322
 323 extern void
 324 lookup_table_insert(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte);
 325
 326 /* Unlinks a lookup table entry from the table; does not free it. */
 327 static inline void
 328 lookup_table_unlink(struct wim_lookup_table *table, struct wim_lookup_table_entry *lte)
 329 {
 330         wimlib_assert(!lte->unhashed);
 331         hlist_del(&lte->hash_list);
 332         wimlib_assert(table->num_entries != 0);
 333         table->num_entries--;
 334 }
 335
 336 extern struct wim_lookup_table_entry *
 337 new_lookup_table_entry(void) _malloc_attribute;
 338
 339 extern struct wim_lookup_table_entry *
 340 clone_lookup_table_entry(const struct wim_lookup_table_entry *lte)
 341                         _malloc_attribute;
 342
 343 extern void
 344 print_lookup_table_entry(const struct wim_lookup_table_entry *lte, FILE *out);
 345
 346 extern void
 347 free_lookup_table_entry(struct wim_lookup_table_entry *lte);
 348
 349 extern void
 350 lte_to_wimlib_resource_entry(const struct wim_lookup_table_entry *lte,
 351                              struct wimlib_resource_entry *wentry);
 352
 353 extern int
 354 for_lookup_table_entry(struct wim_lookup_table *table,
 355                        int (*visitor)(struct wim_lookup_table_entry *, void *),
 356                        void *arg);
 357
 358 extern int
 359 sort_stream_list_by_sequential_order(struct list_head *stream_list,
 360                                      size_t list_head_offset);
 361
 362 extern int
 363 for_lookup_table_entry_pos_sorted(struct wim_lookup_table *table,
 364                                   int (*visitor)(struct wim_lookup_table_entry *,
 365                                                  void *),
 366                                   void *arg);
 367
 368 extern struct wim_lookup_table_entry *
 369 lookup_resource(const struct wim_lookup_table *table, const u8 hash[]);
 370
 371 extern int
 372 wim_pathname_to_stream(WIMStruct *wim, const tchar *path,
 373                        int lookup_flags,
 374                        struct wim_dentry **dentry_ret,
 375                        struct wim_lookup_table_entry **lte_ret,
 376                        u16 *stream_idx_ret);
 377
 378 extern void
 379 lte_decrement_refcnt(struct wim_lookup_table_entry *lte,
 380                      struct wim_lookup_table *table);
 381 #ifdef WITH_FUSE
 382 extern void
 383 lte_decrement_num_opened_fds(struct wim_lookup_table_entry *lte);
 384 #endif
 385
 386 extern int
 387 lte_zero_out_refcnt(struct wim_lookup_table_entry *lte, void *ignore);
 388
 389 extern int
 390 lte_zero_real_refcnt(struct wim_lookup_table_entry *lte, void *ignore);
 391
 392 extern int
 393 lte_free_extracted_file(struct wim_lookup_table_entry *lte, void *ignore);
 394
 395 static inline void
 396 lte_bind_wim_resource_spec(struct wim_lookup_table_entry *lte,
 397                            struct wim_resource_spec *rspec)
 398 {
 399         lte->resource_location = RESOURCE_IN_WIM;
 400         lte->rspec = rspec;
 401         list_add_tail(&lte->wim_resource_list, &rspec->lte_list);
 402 }
 403
 404 static inline void
 405 lte_unbind_wim_resource_spec(struct wim_lookup_table_entry *lte)
 406 {
 407         list_del(&lte->wim_resource_list);
 408         lte->rspec = NULL;
 409         lte->resource_location = RESOURCE_NONEXISTENT;
 410 }
 411
 412 extern int
 413 inode_resolve_ltes(struct wim_inode *inode, struct wim_lookup_table *table,
 414                    bool force);
 415
 416 extern int
 417 resource_not_found_error(const struct wim_inode *inode, const u8 *hash);
 418
 419 extern void
 420 inode_unresolve_ltes(struct wim_inode *inode);
 421
 422 static inline struct wim_lookup_table_entry *
 423 inode_stream_lte_resolved(const struct wim_inode *inode, unsigned stream_idx)
 424 {
 425         wimlib_assert(inode->i_resolved);
 426         wimlib_assert(stream_idx <= inode->i_num_ads);
 427         if (stream_idx == 0)
 428                 return inode->i_lte;
 429         else
 430                 return inode->i_ads_entries[stream_idx - 1].lte;
 431 }
 432
 433 static inline struct wim_lookup_table_entry *
 434 inode_stream_lte_unresolved(const struct wim_inode *inode, unsigned stream_idx,
 435                             const struct wim_lookup_table *table)
 436 {
 437         wimlib_assert(!inode->i_resolved);
 438         wimlib_assert(stream_idx <= inode->i_num_ads);
 439         if (!table)
 440                 return NULL;
 441         if (stream_idx == 0)
 442                 return lookup_resource(table, inode->i_hash);
 443         else
 444                 return lookup_resource(table,
 445                                          inode->i_ads_entries[
 446                                                 stream_idx - 1].hash);
 447 }
 448
 449 extern struct wim_lookup_table_entry *
 450 inode_stream_lte(const struct wim_inode *inode, unsigned stream_idx,
 451                  const struct wim_lookup_table *table);
 452
 453 static inline const u8 *
 454 inode_stream_hash_unresolved(const struct wim_inode *inode, unsigned stream_idx)
 455 {
 456         wimlib_assert(!inode->i_resolved);
 457         wimlib_assert(stream_idx <= inode->i_num_ads);
 458         if (stream_idx == 0)
 459                 return inode->i_hash;
 460         else
 461                 return inode->i_ads_entries[stream_idx - 1].hash;
 462 }
 463
 464
 465 static inline const u8 *
 466 inode_stream_hash_resolved(const struct wim_inode *inode, unsigned stream_idx)
 467 {
 468         struct wim_lookup_table_entry *lte;
 469         lte = inode_stream_lte_resolved(inode, stream_idx);
 470         if (lte)
 471                 return lte->hash;
 472         else
 473                 return zero_hash;
 474 }
 475
 476 /*
 477  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
 478  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
 479  * alternate data stream.
 480  *
 481  * This works for both resolved and un-resolved dentries.
 482  */
 483 static inline const u8 *
 484 inode_stream_hash(const struct wim_inode *inode, unsigned stream_idx)
 485 {
 486         if (inode->i_resolved)
 487                 return inode_stream_hash_resolved(inode, stream_idx);
 488         else
 489                 return inode_stream_hash_unresolved(inode, stream_idx);
 490 }
 491
 492 static inline u16
 493 inode_stream_name_nbytes(const struct wim_inode *inode, unsigned stream_idx)
 494 {
 495         wimlib_assert(stream_idx <= inode->i_num_ads);
 496         if (stream_idx == 0)
 497                 return 0;
 498         else
 499                 return inode->i_ads_entries[stream_idx - 1].stream_name_nbytes;
 500 }
 501
 502 extern struct wim_lookup_table_entry *
 503 inode_unnamed_stream_resolved(const struct wim_inode *inode, u16 *stream_idx_ret);
 504
 505 extern struct wim_lookup_table_entry *
 506 inode_unnamed_lte_resolved(const struct wim_inode *inode);
 507
 508 extern struct wim_lookup_table_entry *
 509 inode_unnamed_lte_unresolved(const struct wim_inode *inode,
 510                              const struct wim_lookup_table *table);
 511
 512 extern struct wim_lookup_table_entry *
 513 inode_unnamed_lte(const struct wim_inode *inode, const struct wim_lookup_table *table);
 514
 515 extern const u8 *
 516 inode_unnamed_stream_hash(const struct wim_inode *inode);
 517
 518 static inline void
 519 lookup_table_insert_unhashed(struct wim_lookup_table *table,
 520                              struct wim_lookup_table_entry *lte,
 521                              struct wim_inode *back_inode,
 522                              u32 back_stream_id)
 523 {
 524         lte->unhashed = 1;
 525         lte->back_inode = back_inode;
 526         lte->back_stream_id = back_stream_id;
 527         list_add_tail(&lte->unhashed_list, table->unhashed_streams);
 528 }
 529
 530 extern int
 531 hash_unhashed_stream(struct wim_lookup_table_entry *lte,
 532                      struct wim_lookup_table *lookup_table,
 533                      struct wim_lookup_table_entry **lte_ret);
 534
 535 extern struct wim_lookup_table_entry **
 536 retrieve_lte_pointer(struct wim_lookup_table_entry *lte);
 537
 538 #endif /* _WIMLIB_LOOKUP_TABLE_H */