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