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 #define LOOKUP_FLAG_FOLLOW_SYMLINKS     0x00000004
  14
  15
  16 /* A lookup table that is used to translate the hash codes of dentries into the
  17  * offsets and sizes of uncompressed or compressed file resources.  It is
  18  * implemented as a hash table. */
  19 struct lookup_table {
  20         struct hlist_head *array;
  21         u64 num_entries;
  22         u64 capacity;
  23 };
  24
  25 struct wimlib_fd;
  26
  27 /*
  28  * An entry in the lookup table in the WIM file.
  29  *
  30  * It is used to find data streams for files in the WIM.
  31  *
  32  * The lookup_table_entry for a given dentry in the WIM is found using the SHA1
  33  * message digest field.
  34  */
  35 struct lookup_table_entry {
  36
  37         /* List of lookup table entries in this hash bucket */
  38         struct hlist_node hash_list;
  39
  40         /* @resource_entry is read from the lookup table in the WIM
  41          * file; it says where to find the file resource in the WIM
  42          * file, and whether it is compressed or not. */
  43         struct resource_entry resource_entry;
  44
  45         /* Currently ignored; set to 1 in new lookup table entries. */
  46         u16 part_number;
  47
  48         /* If %true, this lookup table entry corresponds to a symbolic link
  49          * reparse buffer.  @symlink_reparse_data_buf will give the target of
  50          * the symbolic link. */
  51         enum {
  52                 RESOURCE_NONEXISTENT = 0,
  53                 RESOURCE_IN_WIM,
  54                 RESOURCE_IN_FILE_ON_DISK,
  55                 RESOURCE_IN_STAGING_FILE,
  56                 RESOURCE_IN_ATTACHED_BUFFER,
  57         } resource_location;
  58
  59         /* Number of times this lookup table entry is referenced by dentries. */
  60         u32 refcnt;
  61
  62         union {
  63                 /* SHA1 hash of the file resource pointed to by this lookup
  64                  * table entry */
  65                 u8  hash[SHA1_HASH_SIZE];
  66
  67                 /* First 4 or 8 bytes of the SHA1 hash, used for inserting the
  68                  * entry into the hash table.  Since the SHA1 hashes can be
  69                  * considered random, we don't really need the full 20 byte hash
  70                  * just to insert the entry in a hash table. */
  71                 size_t hash_short;
  72         };
  73
  74         /* If @file_on_disk != NULL, the file resource indicated by this lookup
  75          * table entry is not in the WIM file, but rather a file on disk; this
  76          * occurs for files that are added to the WIM.  In that case,
  77          * file_on_disk is the name of the file in the outside filesystem.
  78          * It will not be compressed, and its size will be given by
  79          * resource_entry.size and resource_entry.original_size. */
  80         union {
  81                 WIMStruct *wim;
  82                 char *file_on_disk;
  83                 char *staging_file_name;
  84                 u8 *attached_buffer;
  85                 struct lookup_table_entry *next_lte_in_swm;
  86         };
  87         FILE *file_on_disk_fp;
  88 #ifdef WITH_FUSE
  89         /* File descriptors table for this data stream */
  90         u16 num_opened_fds;
  91         u16 num_allocated_fds;
  92         struct wimlib_fd **fds;
  93 #endif
  94
  95         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
  96          * whenever the file resource pointed to by this lookup table entry
  97          * needs to be written.  Naturally, the file resource only need to be
  98          * written when out_refcnt is 0.  Incrementing it further is needed to
  99          * find the correct reference count to write to the lookup table in the
 100          * output file, which may be less than the regular refcnt if not all
 101          * images in the WIM file are written.
 102          *
 103          * output_resource_entry is the struct resource_entry for the position of the
 104          * file resource when written to the output file. */
 105         u32 out_refcnt;
 106         struct resource_entry output_resource_entry;
 107
 108         /* Circular linked list of streams that share the same lookup table
 109          * entry
 110          *
 111          * This list of streams may include streams from different hard link
 112          * sets that happen to be the same.  */
 113         struct list_head lte_group_list;
 114
 115         /* List of lookup table entries that correspond to streams that have
 116          * been extracted to the staging directory when modifying a read-write
 117          * mounted WIM. */
 118         struct list_head staging_list;
 119 };
 120
 121 static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
 122 {
 123         return lte->resource_entry.original_size;
 124 }
 125
 126 static inline int
 127 wim_resource_compression_type(const struct lookup_table_entry *lte)
 128 {
 129         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
 130             || !lte->wim)
 131                 return WIM_COMPRESSION_TYPE_NONE;
 132         return wimlib_get_compression_type(lte->wim);
 133 }
 134
 135
 136 extern struct lookup_table *new_lookup_table(size_t capacity);
 137
 138 extern void lookup_table_insert(struct lookup_table *table,
 139                                 struct lookup_table_entry *lte);
 140
 141 /* Unlinks a lookup table entry from the table; does not free it. */
 142 static inline void lookup_table_unlink(struct lookup_table *table,
 143                                        struct lookup_table_entry *lte)
 144 {
 145         hlist_del(&lte->hash_list);
 146         table->num_entries--;
 147 }
 148
 149
 150 extern struct lookup_table_entry *
 151 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
 152
 153 extern struct lookup_table_entry *
 154 lte_decrement_refcnt(struct lookup_table_entry *lte,
 155                      struct lookup_table *table);
 156
 157
 158 extern struct lookup_table_entry *new_lookup_table_entry();
 159
 160 extern int for_lookup_table_entry(struct lookup_table *table,
 161                                   int (*visitor)(struct lookup_table_entry *, void *),
 162                                   void *arg);
 163
 164 extern struct lookup_table_entry *
 165 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
 166
 167 extern int lookup_resource(WIMStruct *w, const char *path,
 168                            int lookup_flags, struct dentry **dentry_ret,
 169                            struct lookup_table_entry **lte_ret,
 170                            unsigned *stream_idx_ret);
 171
 172 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
 173
 174 extern void print_lookup_table_entry(struct lookup_table_entry *entry);
 175
 176 extern int read_lookup_table(WIMStruct *w);
 177
 178 extern void free_lookup_table(struct lookup_table *table);
 179
 180 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
 181
 182 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
 183
 184 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
 185
 186 /* Writes the lookup table to the output file. */
 187 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
 188 {
 189         return for_lookup_table_entry(table, write_lookup_table_entry, out);
 190 }
 191
 192 /* Unlinks and frees an entry from a lookup table. */
 193 static inline void lookup_table_remove(struct lookup_table *table,
 194                                        struct lookup_table_entry *lte)
 195 {
 196         lookup_table_unlink(table, lte);
 197         free_lookup_table_entry(lte);
 198 }
 199
 200 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
 201 {
 202         return &w->image_metadata[
 203                         w->current_image - 1].metadata_lte->resource_entry;
 204 }
 205
 206 static inline struct lookup_table_entry *
 207 dentry_stream_lte_resolved(const struct dentry *dentry, unsigned stream_idx)
 208 {
 209         wimlib_assert(dentry->resolved);
 210         wimlib_assert(stream_idx <= dentry->num_ads);
 211         if (stream_idx == 0)
 212                 return dentry->lte;
 213         else
 214                 return dentry->ads_entries[stream_idx - 1].lte;
 215 }
 216
 217 static inline struct lookup_table_entry *
 218 dentry_stream_lte_unresolved(const struct dentry *dentry, unsigned stream_idx,
 219                              const struct lookup_table *table)
 220 {
 221         wimlib_assert(!dentry->resolved);
 222         wimlib_assert(stream_idx <= dentry->num_ads);
 223         if (!table)
 224                 return NULL;
 225         if (stream_idx == 0)
 226                 return __lookup_resource(table, dentry->hash);
 227         else
 228                 return __lookup_resource(table,
 229                                          dentry->ads_entries[
 230                                                 stream_idx - 1].hash);
 231 }
 232 /*
 233  * Returns the lookup table entry for stream @stream_idx of the dentry, where
 234  * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
 235  * corresponds to an alternate data stream.
 236  *
 237  * This works for both resolved and un-resolved dentries.
 238  */
 239 static inline struct lookup_table_entry *
 240 dentry_stream_lte(const struct dentry *dentry, unsigned stream_idx,
 241                   const struct lookup_table *table)
 242 {
 243         if (dentry->resolved)
 244                 return dentry_stream_lte_resolved(dentry, stream_idx);
 245         else
 246                 return dentry_stream_lte_unresolved(dentry, stream_idx, table);
 247 }
 248
 249
 250 static inline const u8 *dentry_stream_hash_unresolved(const struct dentry *dentry,
 251                                                       unsigned stream_idx)
 252 {
 253         wimlib_assert(!dentry->resolved);
 254         wimlib_assert(stream_idx <= dentry->num_ads);
 255         if (stream_idx == 0)
 256                 return dentry->hash;
 257         else
 258                 return dentry->ads_entries[stream_idx - 1].hash;
 259 }
 260
 261 static inline const u8 *dentry_stream_hash_resolved(const struct dentry *dentry,
 262                                                     unsigned stream_idx)
 263 {
 264         struct lookup_table_entry *lte;
 265         lte = dentry_stream_lte_resolved(dentry, stream_idx);
 266         if (lte)
 267                 return lte->hash;
 268         else
 269                 return NULL;
 270 }
 271
 272 /*
 273  * Returns the hash for stream @stream_idx of the dentry, where stream_idx = 0
 274  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
 275  * alternate data stream.
 276  *
 277  * This works for both resolved and un-resolved dentries.
 278  */
 279 static inline const u8 *dentry_stream_hash(const struct dentry *dentry,
 280                                            unsigned stream_idx)
 281 {
 282         if (dentry->resolved)
 283                 return dentry_stream_hash_resolved(dentry, stream_idx);
 284         else
 285                 return dentry_stream_hash_unresolved(dentry, stream_idx);
 286 }
 287
 288 static inline struct lookup_table_entry *
 289 dentry_first_lte_resolved(const struct dentry *dentry)
 290 {
 291         struct lookup_table_entry *lte;
 292         wimlib_assert(dentry->resolved);
 293
 294         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 295                 lte = dentry_stream_lte_resolved(dentry, i);
 296                 if (lte)
 297                         return lte;
 298         }
 299         return NULL;
 300 }
 301
 302 static inline struct lookup_table_entry *
 303 dentry_first_lte_unresolved(const struct dentry *dentry,
 304                             const struct lookup_table *table)
 305 {
 306         struct lookup_table_entry *lte;
 307         wimlib_assert(!dentry->resolved);
 308
 309         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 310                 lte = dentry_stream_lte_unresolved(dentry, i, table);
 311                 if (lte)
 312                         return lte;
 313         }
 314         return NULL;
 315 }
 316
 317 extern struct lookup_table_entry *
 318 dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table);
 319
 320 #endif