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 hlist_head *array;
  20         u64 num_entries;
  21         u64 capacity;
  22 };
  23
  24 struct wimlib_fd;
  25
  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         bool is_symlink;
  52
  53         /* Number of times this lookup table entry is referenced by dentries. */
  54         u32 refcnt;
  55
  56         union {
  57                 /* SHA1 hash of the file resource pointed to by this lookup
  58                  * table entry */
  59                 u8  hash[WIM_HASH_SIZE];
  60
  61                 /* First 4 or 8 bytes of the SHA1 hash, used for inserting the
  62                  * entry into the hash table.  Since the SHA1 hashes can be
  63                  * considered random, we don't really need the full 20 byte hash
  64                  * just to insert the entry in a hash table. */
  65                 size_t hash_short;
  66         };
  67
  68         /* If @file_on_disk != NULL, the file resource indicated by this lookup
  69          * table entry is not in the WIM file, but rather a file on disk; this
  70          * occurs for files that are added to the WIM.  In that case,
  71          * file_on_disk is the name of the file in the outside filesystem.
  72          * It will not be compressed, and its size will be given by
  73          * resource_entry.size and resource_entry.original_size. */
  74         union {
  75                 char *file_on_disk;
  76                 char *staging_file_name;
  77                 void *symlink_buf;
  78                 struct lookup_table_entry *next_lte_in_swm;
  79         };
  80
  81         union {
  82                 struct { /* Used for wimlib_export. */
  83
  84                         /* If (other_wim_fp != NULL), the file resource indicated
  85                          * by this lookup table entry is in a different WIM
  86                          * file, and other_wim_fp is the FILE* for it. */
  87                         FILE *other_wim_fp;
  88
  89                         /* Compression type used in other WIM. */
  90                         int   other_wim_ctype;
  91                 };
  92
  93                 struct { /* Used for wimlib_mount */
  94
  95                         /* File descriptors table for this data stream */
  96                         struct wimlib_fd **fds;
  97                         u16 num_allocated_fds;
  98                         u16 num_opened_fds;
  99                 };
 100         };
 101
 102         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
 103          * whenever the file resource pointed to by this lookup table entry
 104          * needs to be written.  Naturally, the file resource only need to be
 105          * written when out_refcnt is 0.  Incrementing it further is needed to
 106          * find the correct reference count to write to the lookup table in the
 107          * output file, which may be less than the regular refcnt if not all
 108          * images in the WIM file are written.
 109          *
 110          * output_resource_entry is the struct resource_entry for the position of the
 111          * file resource when written to the output file. */
 112         u32 out_refcnt;
 113         struct resource_entry output_resource_entry;
 114
 115         /* Circular linked list of streams that share the same lookup table
 116          * entry
 117          *
 118          * This list of streams may include streams from different hard link
 119          * sets that happen to be the same.  */
 120         struct list_head lte_group_list;
 121
 122         /* List of lookup table entries that correspond to streams that have
 123          * been extracted to the staging directory when modifying a read-write
 124          * mounted WIM. */
 125         struct list_head staging_list;
 126 };
 127
 128 extern struct lookup_table *new_lookup_table(size_t capacity);
 129
 130 extern void lookup_table_insert(struct lookup_table *table,
 131                                 struct lookup_table_entry *lte);
 132
 133 /* Unlinks a lookup table entry from the table; does not free it. */
 134 static inline void lookup_table_unlink(struct lookup_table *table,
 135                                        struct lookup_table_entry *lte)
 136 {
 137         hlist_del(&lte->hash_list);
 138         table->num_entries--;
 139 }
 140
 141 extern struct lookup_table_entry *
 142 lookup_table_decrement_refcnt(struct lookup_table* table, const u8 hash[]);
 143
 144 extern struct lookup_table_entry *
 145 lte_decrement_refcnt(struct lookup_table_entry *lte,
 146                      struct lookup_table *table);
 147
 148
 149 extern struct lookup_table_entry *new_lookup_table_entry();
 150
 151 extern int for_lookup_table_entry(struct lookup_table *table,
 152                                   int (*visitor)(struct lookup_table_entry *, void *),
 153                                   void *arg);
 154
 155 extern struct lookup_table_entry *
 156 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
 157
 158 extern int lookup_resource(WIMStruct *w, const char *path,
 159                            int lookup_flags, struct dentry **dentry_ret,
 160                            struct lookup_table_entry **lte_ret,
 161                            unsigned *stream_idx_ret);
 162
 163 extern int zero_out_refcnts(struct lookup_table_entry *entry, void *ignore);
 164
 165 extern int print_lookup_table_entry(struct lookup_table_entry *entry, void *ignore);
 166
 167 extern int read_lookup_table(FILE *fp, u64 offset, u64 size,
 168                              struct lookup_table **table_ret);
 169
 170 extern void free_lookup_table(struct lookup_table *table);
 171
 172 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
 173
 174 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
 175
 176 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
 177
 178 /* Writes the lookup table to the output file. */
 179 static inline int write_lookup_table(struct lookup_table *table, FILE *out)
 180 {
 181         return for_lookup_table_entry(table, write_lookup_table_entry, out);
 182 }
 183
 184 /* Unlinks and frees an entry from a lookup table. */
 185 static inline void lookup_table_remove(struct lookup_table *table,
 186                                        struct lookup_table_entry *lte)
 187 {
 188         lookup_table_unlink(table, lte);
 189         free_lookup_table_entry(lte);
 190 }
 191
 192 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
 193 {
 194         return &w->image_metadata[
 195                         w->current_image - 1].metadata_lte->resource_entry;
 196 }
 197
 198 #endif