97d06ec76969d022359ddef792f201e432bc68ed
[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
14 /* Not yet used */
15 //#define LOOKUP_FLAG_FOLLOW_SYMLINKS   0x00000004
16
17
18 /* A lookup table that is used to translate the hash codes of dentries into the
19  * offsets and sizes of uncompressed or compressed file resources.  It is
20  * implemented as a hash table. */
21 struct lookup_table {
22         struct hlist_head *array;
23         u64 num_entries;
24         u64 capacity;
25 };
26
27 struct wimlib_fd;
28
29 #ifdef WITH_NTFS_3G
30 struct ntfs_location {
31         char *path_utf8;
32         char *stream_name_utf16;
33         u16 stream_name_utf16_num_chars;
34         struct _ntfs_volume **ntfs_vol_p;
35         bool is_reparse_point;
36 };
37 #endif
38
39 /* An enumerated type that identifies where the stream corresponding to this
40  * lookup table entry is actually located.
41  *
42  * If we open a WIM and read its lookup table, the location is set to
43  * RESOURCE_IN_WIM since all the streams will initially be located in the WIM.
44  * However, to deal with problems such as image capture and image mount, we
45  * allow the actual location of the stream to be somewhere else, such as an
46  * external file.
47  */
48 enum resource_location {
49         /* The lookup table entry does not correspond to a stream (this state
50          * should exist only temporarily) */
51         RESOURCE_NONEXISTENT = 0,
52
53         /* The stream resource is located in a WIM file.  The WIMStruct for the
54          * WIM file will be pointed to by the @wim member. */
55         RESOURCE_IN_WIM,
56
57         /* The stream resource is located in an external file.  The name of the
58          * file will be provided by @file_on_disk member.  In addition, if
59          * @file_on_disk_fp is not NULL, it will be an open FILE * to the file.
60          * */
61         RESOURCE_IN_FILE_ON_DISK,
62
63         /* The stream resource is located in an external file in the staging
64          * directory for a read-write mount.  */
65         RESOURCE_IN_STAGING_FILE,
66
67         /* The stream resource is directly attached in an in-memory buffer
68          * pointed to by @attached_buffer. */
69         RESOURCE_IN_ATTACHED_BUFFER,
70
71         /* The stream resource is located in an NTFS volume.  It is identified
72          * by volume, filename, data stream name, and by whether it is a reparse
73          * point or not. @ntfs_loc points to a structure containing this
74          * information. */
75         RESOURCE_IN_NTFS_VOLUME,
76 };
77
78 /*
79  * An entry in the lookup table in the WIM file.
80  *
81  * It is used to find data streams for files in the WIM.
82  *
83  * Metadata resources and reparse point data buffers will also have lookup table
84  * entries associated with the data.
85  *
86  * The lookup_table_entry for a given dentry or alternate stream entry in the
87  * WIM is found using the SHA1 message digest field.
88  */
89 struct lookup_table_entry {
90
91         /* List of lookup table entries in this hash bucket */
92         struct hlist_node hash_list;
93
94         /* Location and size of the stream in the WIM, whether it is compressed
95          * or not, and whether it's a metadata resource or not.  This is an
96          * on-disk field. */
97         struct resource_entry resource_entry;
98
99         /* Specifies which part of the split WIM the resource is located in.
100          * This is on on-disk field.
101          *
102          * In stand-alone WIMs, this must be 1.
103          *
104          * In split WIMs, every split WIM part has its own lookup table, and in
105          * read_lookup_table() it's currently expected that the part number of
106          * each lookup table entry in a split WIM part's lookup table is the
107          * same as the part number of that split WIM part.  So this makes this
108          * field redundant since we store a pointer to the corresponding
109          * WIMStruct in the lookup table entry anyway.
110          */
111         u16 part_number;
112
113         /* See enum resource_location above */
114         u16 resource_location;
115
116         /* (On-disk field)
117          * Number of times this lookup table entry is referenced by dentries.
118          * Unfortunately, this field is not always set correctly in Microsoft's
119          * WIMs, so we have no choice but to fix it if more references to the
120          * lookup table entry are found than stated here. */
121         u32 refcnt;
122
123         union {
124                 /* (On-disk field) SHA1 message digest of the stream referenced
125                  * by this lookup table entry */
126                 u8  hash[SHA1_HASH_SIZE];
127
128                 /* First 4 or 8 bytes of the SHA1 message digest, used for
129                  * inserting the entry into the hash table.  Since the SHA1
130                  * message digest can be considered random, we don't really need
131                  * the full 20 byte hash just to insert the entry in a hash
132                  * table. */
133                 size_t hash_short;
134         };
135
136         #ifdef WITH_FUSE
137         u16 num_opened_fds;
138         #endif
139
140         /* Pointers to somewhere where the stream is actually located.  See the
141          * comments for the @resource_location field above. */
142         union {
143                 WIMStruct *wim;
144                 char *file_on_disk;
145                 char *staging_file_name;
146                 u8 *attached_buffer;
147         #ifdef WITH_NTFS_3G
148                 struct ntfs_location *ntfs_loc;
149         #endif
150         };
151         union {
152                 /* @file_on_disk_fp and @attr are both used to cache file/stream
153                  * handles so we don't have re-open them on every read */
154
155                 /* Valid iff resource_location == RESOURCE_IN_FILE_ON_DISK */
156                 FILE *file_on_disk_fp;
157         #ifdef WITH_NTFS_3G
158                 /* Valid iff resource_location == RESOURCE_IN_NTFS_VOLUME */
159                 struct _ntfs_attr *attr;
160         #endif
161
162                 /* Pointer to inode that contains the opened file descriptors to
163                  * this stream (valid iff resource_location ==
164                  * RESOURCE_IN_STAGING_FILE) */
165                 struct inode *lte_inode;
166         };
167
168         /* When a WIM file is written, out_refcnt starts at 0 and is incremented
169          * whenever the file resource pointed to by this lookup table entry
170          * needs to be written.  The file resource only need to be written when
171          * out_refcnt is nonzero, since otherwise it is not referenced by any
172          * dentries. */
173         u32 out_refcnt;
174
175         u32 real_refcnt;
176
177         union {
178                 /* When a WIM file is written, @output_resource_entry is filled
179                  * in with the resource entry for the output WIM.  This will not
180                  * necessarily be the same as the @resource_entry since: - The
181                  * stream may have a different offset in the new WIM - The
182                  * stream may have a different compressed size in the new WIM if
183                  * the compression type changed
184                  */
185                 struct resource_entry output_resource_entry;
186
187                 struct list_head msg_list;
188                 struct list_head dentry_list;
189         };
190
191         union {
192                 /* This field is used for the special hardlink or symlink image
193                  * extraction mode.   In these mode, all identical files are linked
194                  * together, and @extracted_file will be set to the filename of the
195                  * first extracted file containing this stream.  */
196                 char *extracted_file;
197
198                 /* List of lookup table entries that correspond to streams that have
199                  * been extracted to the staging directory when modifying a read-write
200                  * mounted WIM. */
201                 struct list_head staging_list;
202         };
203 };
204
205 static inline u64 wim_resource_size(const struct lookup_table_entry *lte)
206 {
207         return lte->resource_entry.original_size;
208 }
209
210 static inline u64 wim_resource_chunks(const struct lookup_table_entry *lte)
211 {
212         return (wim_resource_size(lte) + WIM_CHUNK_SIZE - 1) / WIM_CHUNK_SIZE;
213 }
214
215 static inline u64
216 wim_resource_compressed_size(const struct lookup_table_entry *lte)
217 {
218         return lte->resource_entry.size;
219 }
220
221 /*
222  * XXX Probably should store the compression type directly in the lookup table
223  * entry
224  */
225 static inline int
226 wim_resource_compression_type(const struct lookup_table_entry *lte)
227 {
228         if (!(lte->resource_entry.flags & WIM_RESHDR_FLAG_COMPRESSED)
229             || lte->resource_location != RESOURCE_IN_WIM)
230                 return WIM_COMPRESSION_TYPE_NONE;
231         return wimlib_get_compression_type(lte->wim);
232 }
233
234
235 extern struct lookup_table *new_lookup_table(size_t capacity);
236
237 extern void lookup_table_insert(struct lookup_table *table,
238                                 struct lookup_table_entry *lte);
239
240 /* Unlinks a lookup table entry from the table; does not free it. */
241 static inline void lookup_table_unlink(struct lookup_table *table,
242                                        struct lookup_table_entry *lte)
243 {
244         hlist_del(&lte->hash_list);
245         table->num_entries--;
246 }
247
248 extern struct lookup_table_entry *new_lookup_table_entry();
249
250 extern struct lookup_table_entry *
251 clone_lookup_table_entry(const struct lookup_table_entry *lte);
252
253 extern int for_lookup_table_entry(struct lookup_table *table,
254                                   int (*visitor)(struct lookup_table_entry *, void *),
255                                   void *arg);
256
257 extern struct lookup_table_entry *
258 __lookup_resource(const struct lookup_table *table, const u8 hash[]);
259
260 extern int lookup_resource(WIMStruct *w, const char *path,
261                            int lookup_flags, struct dentry **dentry_ret,
262                            struct lookup_table_entry **lte_ret,
263                            u16 *stream_idx_ret);
264
265 extern void lte_decrement_refcnt(struct lookup_table_entry *lte,
266                                  struct lookup_table *table);
267 #ifdef WITH_FUSE
268 extern void lte_decrement_num_opened_fds(struct lookup_table_entry *lte);
269 #endif
270
271 extern int lte_zero_out_refcnt(struct lookup_table_entry *entry, void *ignore);
272 extern int lte_zero_real_refcnt(struct lookup_table_entry *entry, void *ignore);
273 extern int lte_zero_extracted_file(struct lookup_table_entry *lte, void *ignore);
274 extern int lte_free_extracted_file(struct lookup_table_entry *lte, void *ignore);
275
276 extern void print_lookup_table_entry(const struct lookup_table_entry *entry);
277
278 extern int read_lookup_table(WIMStruct *w);
279
280 extern void free_lookup_table(struct lookup_table *table);
281
282 extern int write_lookup_table_entry(struct lookup_table_entry *lte, void *__out);
283
284 extern void free_lookup_table_entry(struct lookup_table_entry *lte);
285
286 extern int dentry_resolve_ltes(struct dentry *dentry, void *__table);
287 extern int dentry_unresolve_ltes(struct dentry *dentry, void *ignore);
288
289 int write_lookup_table(struct lookup_table *table, FILE *out,
290                        struct resource_entry *out_res_entry);
291
292 static inline struct resource_entry* wim_metadata_resource_entry(WIMStruct *w)
293 {
294         return &w->image_metadata[
295                         w->current_image - 1].metadata_lte->resource_entry;
296 }
297
298 static inline struct lookup_table_entry *
299 inode_stream_lte_resolved(const struct inode *inode, unsigned stream_idx)
300 {
301         wimlib_assert(inode->resolved);
302         wimlib_assert(stream_idx <= inode->num_ads);
303         if (stream_idx == 0)
304                 return inode->lte;
305         else
306                 return inode->ads_entries[stream_idx - 1].lte;
307 }
308
309 static inline struct lookup_table_entry *
310 inode_stream_lte_unresolved(const struct inode *inode, unsigned stream_idx,
311                             const struct lookup_table *table)
312 {
313         wimlib_assert(!inode->resolved);
314         wimlib_assert(stream_idx <= inode->num_ads);
315         if (!table)
316                 return NULL;
317         if (stream_idx == 0)
318                 return __lookup_resource(table, inode->hash);
319         else
320                 return __lookup_resource(table,
321                                          inode->ads_entries[
322                                                 stream_idx - 1].hash);
323 }
324 /*
325  * Returns the lookup table entry for stream @stream_idx of the inode, where
326  * stream_idx = 0 means the default un-named file stream, and stream_idx >= 1
327  * corresponds to an alternate data stream.
328  *
329  * This works for both resolved and un-resolved dentries.
330  */
331 static inline struct lookup_table_entry *
332 inode_stream_lte(const struct inode *inode, unsigned stream_idx,
333                  const struct lookup_table *table)
334 {
335         if (inode->resolved)
336                 return inode_stream_lte_resolved(inode, stream_idx);
337         else
338                 return inode_stream_lte_unresolved(inode, stream_idx, table);
339 }
340
341
342 static inline const u8 *inode_stream_hash_unresolved(const struct inode *inode,
343                                                      unsigned stream_idx)
344 {
345         wimlib_assert(!inode->resolved);
346         wimlib_assert(stream_idx <= inode->num_ads);
347         if (stream_idx == 0)
348                 return inode->hash;
349         else
350                 return inode->ads_entries[stream_idx - 1].hash;
351 }
352
353
354 static inline const u8 *inode_stream_hash_resolved(const struct inode *inode,
355                                                    unsigned stream_idx)
356 {
357         struct lookup_table_entry *lte;
358         lte = inode_stream_lte_resolved(inode, stream_idx);
359         if (lte)
360                 return lte->hash;
361         else
362                 return zero_hash;
363 }
364
365 /*
366  * Returns the hash for stream @stream_idx of the inode, where stream_idx = 0
367  * means the default un-named file stream, and stream_idx >= 1 corresponds to an
368  * alternate data stream.
369  *
370  * This works for both resolved and un-resolved dentries.
371  */
372 static inline const u8 *inode_stream_hash(const struct inode *inode,
373                                           unsigned stream_idx)
374 {
375         if (inode->resolved)
376                 return inode_stream_hash_resolved(inode, stream_idx);
377         else
378                 return inode_stream_hash_unresolved(inode, stream_idx);
379 }
380
381 static inline u16 inode_stream_name_len(const struct inode *inode,
382                                         unsigned stream_idx)
383 {
384         wimlib_assert(stream_idx <= inode->num_ads);
385         if (stream_idx == 0)
386                 return 0;
387         else
388                 return inode->ads_entries[stream_idx - 1].stream_name_len;
389 }
390
391 static inline struct lookup_table_entry *
392 inode_unnamed_lte_resolved(const struct inode *inode)
393 {
394         wimlib_assert(inode->resolved);
395         for (unsigned i = 0; i <= inode->num_ads; i++)
396                 if (inode_stream_name_len(inode, i) == 0 &&
397                      !is_zero_hash(inode_stream_hash_resolved(inode, i)))
398                         return inode_stream_lte_resolved(inode, i);
399         return NULL;
400 }
401
402 static inline struct lookup_table_entry *
403 inode_unnamed_lte_unresolved(const struct inode *inode,
404                              const struct lookup_table *table)
405 {
406         wimlib_assert(!inode->resolved);
407         for (unsigned i = 0; i <= inode->num_ads; i++)
408                 if (inode_stream_name_len(inode, i) == 0 &&
409                      !is_zero_hash(inode_stream_hash_unresolved(inode, i)))
410                         return inode_stream_lte_unresolved(inode, i, table);
411         return NULL;
412 }
413
414 extern struct lookup_table_entry *
415 inode_unnamed_lte(const struct inode *inode,
416                   const struct lookup_table *table);
417
418
419 #endif