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 u64
 127 wim_resource_compressed_size(const struct lookup_table_entry *lte)
 128 {
 129         return lte->resource_entry.size;
 130 }
 131
 132 /*
 133  * XXX Probably should store the compression type directly in the lookup table
 134  * entry
 135  */
 136 static inline int
 137 wim_resource_compression_type(const struct lookup_table_entry *lte)
 138 {
 139         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
 140             || lte->resource_location != RESOURCE_IN_WIM)
 141                 return WIM_COMPRESSION_TYPE_NONE;
 142         return wimlib_get_compression_type(lte->wim);
 143 }
 144
 145
 146 extern struct lookup_table *new_lookup_table(size_t capacity);
 147
 148 extern void lookup_table_insert(struct lookup_table *table,
 149                                 struct lookup_table_entry *lte);
 150
 151 /* Unlinks a lookup table entry from the table; does not free it. */
 152 static inline void lookup_table_unlink(struct lookup_table *table,
 153                                        struct lookup_table_entry *lte)
 154 {
 155         hlist_del(&lte->hash_list);
 156         table->num_entries--;
 157 }
 158
 159
 160 extern struct lookup_table_entry *
 161 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
 162
 163 extern struct lookup_table_entry *
 164 lte_decrement_refcnt(struct lookup_table_entry *lte,
 165                      struct lookup_table *table);
 166
 167
 168 extern struct lookup_table_entry *new_lookup_table_entry();
 169
 170 extern int for_lookup_table_entry(struct lookup_table *table,
 171                                   int (*visitor)(struct lookup_table_entry *, void *),
 172                                   void *arg);
 173
 174 extern struct lookup_table_entry *
 175 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
 176
 177 extern int lookup_resource(WIMStruct *w, const char *path,
 178                            int lookup_flags, struct dentry **dentry_ret,
 179                            struct lookup_table_entry **lte_ret,
 180                            unsigned *stream_idx_ret);
 181
 182 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
 183
 184 extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
 185
 186 extern int read_lookup_table(WIMStruct *w);
 187
 188 extern void free_lookup_table(struct lookup_table *table);
 189
 190 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
 191
 192 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
 193
 194 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
 195
 196 /* Writes the lookup table to the output file. */
 197 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
 198 {
 199         return for_lookup_table_entry(table, write_lookup_table_entry, out);
 200 }
 201
 202 /* Unlinks and frees an entry from a lookup table. */
 203 static inline void lookup_table_remove(struct lookup_table *table,
 204                                        struct lookup_table_entry *lte)
 205 {
 206         lookup_table_unlink(table, lte);
 207         free_lookup_table_entry(lte);
 208 }
 209
 210 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
 211 {
 212         return &w->image_metadata[
 213                         w->current_image - 1].metadata_lte->resource_entry;
 214 }
 215
 216 static inline struct lookup_table_entry *
 217 dentry_stream_lte_resolved(const struct dentry *dentry, unsigned stream_idx)
 218 {
 219         wimlib_assert(dentry->resolved);
 220         wimlib_assert(stream_idx <= dentry->num_ads);
 221         if (stream_idx == 0)
 222                 return dentry->lte;
 223         else
 224                 return dentry->ads_entries[stream_idx - 1].lte;
 225 }
 226
 227 static inline struct lookup_table_entry *
 228 dentry_stream_lte_unresolved(const struct dentry *dentry, unsigned stream_idx,
 229                              const struct lookup_table *table)
 230 {
 231         wimlib_assert(!dentry->resolved);
 232         wimlib_assert(stream_idx <= dentry->num_ads);
 233         if (!table)
 234                 return NULL;
 235         if (stream_idx == 0)
 236                 return __lookup_resource(table, dentry->hash);
 237         else
 238                 return __lookup_resource(table,
 239                                          dentry->ads_entries[
 240                                                 stream_idx - 1].hash);
 241 }
 242 /*
 243  * Returns the lookup table entry for stream @stream_idx of the dentry, where
 244  * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
 245  * corresponds to an alternate data stream.
 246  *
 247  * This works for both resolved and un-resolved dentries.
 248  */
 249 static inline struct lookup_table_entry *
 250 dentry_stream_lte(const struct dentry *dentry, unsigned stream_idx,
 251                   const struct lookup_table *table)
 252 {
 253         if (dentry->resolved)
 254                 return dentry_stream_lte_resolved(dentry, stream_idx);
 255         else
 256                 return dentry_stream_lte_unresolved(dentry, stream_idx, table);
 257 }
 258
 259
 260 static inline const u8 *dentry_stream_hash_unresolved(const struct dentry *dentry,
 261                                                       unsigned stream_idx)
 262 {
 263         wimlib_assert(!dentry->resolved);
 264         wimlib_assert(stream_idx <= dentry->num_ads);
 265         if (stream_idx == 0)
 266                 return dentry->hash;
 267         else
 268                 return dentry->ads_entries[stream_idx - 1].hash;
 269 }
 270
 271 static inline const u8 *dentry_stream_hash_resolved(const struct dentry *dentry,
 272                                                     unsigned stream_idx)
 273 {
 274         struct lookup_table_entry *lte;
 275         lte = dentry_stream_lte_resolved(dentry, stream_idx);
 276         if (lte)
 277                 return lte->hash;
 278         else
 279                 return NULL;
 280 }
 281
 282 /*
 283  * Returns the hash for stream @stream_idx of the dentry, where stream_idx = 0
 284  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
 285  * alternate data stream.
 286  *
 287  * This works for both resolved and un-resolved dentries.
 288  */
 289 static inline const u8 *dentry_stream_hash(const struct dentry *dentry,
 290                                            unsigned stream_idx)
 291 {
 292         if (dentry->resolved)
 293                 return dentry_stream_hash_resolved(dentry, stream_idx);
 294         else
 295                 return dentry_stream_hash_unresolved(dentry, stream_idx);
 296 }
 297
 298 static inline struct lookup_table_entry *
 299 dentry_first_lte_resolved(const struct dentry *dentry)
 300 {
 301         struct lookup_table_entry *lte;
 302         wimlib_assert(dentry->resolved);
 303
 304         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 305                 lte = dentry_stream_lte_resolved(dentry, i);
 306                 if (lte)
 307                         return lte;
 308         }
 309         return NULL;
 310 }
 311
 312 static inline struct lookup_table_entry *
 313 dentry_first_lte_unresolved(const struct dentry *dentry,
 314                             const struct lookup_table *table)
 315 {
 316         struct lookup_table_entry *lte;
 317         wimlib_assert(!dentry->resolved);
 318
 319         for (unsigned i = 0; i <= dentry->num_ads; i++) {
 320                 lte = dentry_stream_lte_unresolved(dentry, i, table);
 321                 if (lte)
 322                         return lte;
 323         }
 324         return NULL;
 325 }
 326
 327 extern struct lookup_table_entry *
 328 dentry_first_lte(const struct dentry *dentry, const struct lookup_table *table);
 329
 330 #endif