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 <sys/types.h>
   6
   7 /* Size of each lookup table entry in the WIM file. */
   8 #define WIM_LOOKUP_TABLE_ENTRY_DISK_SIZE 50
   9
  10 #define LOOKUP_FLAG_ADS_OK              0x00000001
  11 #define LOOKUP_FLAG_DIRECTORY_OK        0x00000002
  12 #define LOOKUP_FLAG_FOLLOW_SYMLINKS     0x00000004
  13
  14
  15 /* A lookup table that is used to translate the hash codes of dentries into the
  16  * offsets and sizes of uncompressed or compressed file resources.  It is
  17  * implemented as a hash table. */
  18 struct lookup_table {
  19         struct lookup_table_entry **array;
  20         u64 num_entries;
  21         u64 capacity;
  22 };
  23
  24 struct wimlib_fd;
  25
  26
  27 /* An entry in the lookup table in the WIM file. */
  28 struct lookup_table_entry {
  29
  30         /* The next struct lookup_table_entry in the hash bucket.  NULL if this is the
  31          * last one. */
  32         struct lookup_table_entry *next;
  33
  34         /* @resource_entry is read from the lookup table in the WIM
  35          * file; it says where to find the file resource in the WIM
  36          * file, and whether it is compressed or not. */
  37         struct resource_entry resource_entry;
  38
  39         /* Currently ignored; set to 1 in new lookup table entries. */
  40         u16 part_number;
  41
  42         /* If %true, this lookup table entry corresponds to a symbolic link
  43          * reparse buffer.  @symlink_reparse_data_buf will give the target of
  44          * the symbolic link. */
  45         bool is_symlink;
  46
  47         /* Number of times this lookup table entry is referenced by dentries. */
  48         u32 refcnt;
  49
  50         union {
  51                 /* SHA1 hash of the file resource pointed to by this lookup
  52                  * table entry */
  53                 u8  hash[WIM_HASH_SIZE];
  54
  55                 /* First 4 or 8 bytes of the SHA1 hash, used for inserting the
  56                  * entry into the hash table.  Since the SHA1 hashes can be
  57                  * considered random, we don't really need the full 20 byte hash
  58                  * just to insert the entry in a hash table. */
  59                 size_t hash_short;
  60         };
  61
  62         /* If @file_on_disk != NULL, the file resource indicated by this lookup
  63          * table entry is not in the WIM file, but rather a file on disk; this
  64          * occurs for files that are added to the WIM.  In that case,
  65          * file_on_disk is the name of the file in the outside filesystem.
  66          * It will not be compressed, and its size will be given by
  67          * resource_entry.size and resource_entry.original_size. */
  68         union {
  69                 char *file_on_disk;
  70                 char *staging_file_name;
  71                 void *symlink_buf;
  72                 struct lookup_table_entry *next_lte_in_swm;
  73         };
  74
  75         union {
  76                 struct { /* Used for wimlib_export. */
  77
  78                         /* If (other_wim_fp != NULL), the file resource indicated
  79                          * by this lookup table entry is in a different WIM
  80                          * file, and other_wim_fp is the FILE* for it. */
  81                         FILE *other_wim_fp;
  82
  83                         /* Compression type used in other WIM. */
  84                         int   other_wim_ctype;
  85                 };
  86                 struct {
  87                         struct wimlib_fd **fds;
  88                         u16 num_allocated_fds;
  89                         u16 num_opened_fds;
  90                 };
  91         };
  92
  93         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
  94          * whenever the file resource pointed to by this lookup table entry
  95          * needs to be written.  Naturally, the file resource only need to be
  96          * written when out_refcnt is 0.  Incrementing it further is needed to
  97          * find the correct reference count to write to the lookup table in the
  98          * output file, which may be less than the regular refcnt if not all
  99          * images in the WIM file are written.
 100          *
 101          * output_resource_entry is the struct resource_entry for the position of the
 102          * file resource when written to the output file. */
 103         u32 out_refcnt;
 104         union {
 105                 struct resource_entry output_resource_entry;
 106                 struct {
 107                         struct list_head staging_list;
 108                         struct list_head lte_group_list;
 109                 };
 110         };
 111 };
 112
 113 extern struct lookup_table *new_lookup_table(size_t capacity);
 114
 115 extern void lookup_table_insert(struct lookup_table *table,
 116                                 struct lookup_table_entry *lte);
 117
 118 extern void lookup_table_unlink(struct lookup_table *table,
 119                                 struct lookup_table_entry *lte);
 120
 121 extern struct lookup_table_entry *
 122 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
 123
 124 extern struct lookup_table_entry *
 125 lte_decrement_refcnt(struct lookup_table_entry *lte,
 126                      struct lookup_table *table);
 127
 128
 129 extern struct lookup_table_entry *new_lookup_table_entry();
 130
 131 extern int for_lookup_table_entry(struct lookup_table *table,
 132                                   int (*visitor)(struct lookup_table_entry *, void *),
 133                                   void *arg);
 134
 135 extern struct lookup_table_entry *
 136 __lookup_resource(const struct lookup_table *lookup_table, const u8 hash[]);
 137
 138 extern int lookup_resource(WIMStruct *w, const char *path,
 139                            int lookup_flags, struct dentry **dentry_ret,
 140                            struct lookup_table_entry **lte_ret,
 141                            unsigned *stream_idx_ret);
 142
 143 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
 144
 145 extern int print_lookup_table_entry(struct lookup_table_entry *entry, void *ignore);
 146
 147 extern int read_lookup_table(FILE *fp, u64 offset, u64 size,
 148                              struct lookup_table **table_ret);
 149
 150 extern void free_lookup_table(struct lookup_table *table);
 151
 152 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
 153
 154 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
 155
 156 extern void resolve_lookup_table_entries(struct dentry *root,
 157                                          struct lookup_table *table);
 158
 159 /* Writes the lookup table to the output file. */
 160 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
 161 {
 162         return for_lookup_table_entry(table, write_lookup_table_entry, out);
 163 }
 164
 165 /* Unlinks and frees an entry from a lookup table. */
 166 static inline void lookup_table_remove(struct lookup_table *table,
 167                                        struct lookup_table_entry *lte)
 168 {
 169         lookup_table_unlink(table, lte);
 170         free_lookup_table_entry(lte);
 171 }
 172
 173 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
 174 {
 175         return &w->image_metadata[
 176                         w->current_image - 1].metadata_lte->resource_entry;
 177 }
 178
 179 #endif