#include <string.h>
#include <sys/types.h> /* uid_t, gid_t */
-#ifdef WITH_FUSE
-# include <pthread.h>
-#endif
-
struct wim_lookup_table;
struct wim_lookup_table_entry;
struct wimfs_fd;
* case sensitive long name. */
struct rb_node rb_node;
-#ifdef __WIN32__
/* Node for the parent's red-black tree of child dentries, sorted by
* case insensitive long name. */
struct rb_node rb_node_case_insensitive;
/* List of dentries in a directory that have different case sensitive
* long names but share the same case insensitive long name */
struct list_head case_insensitive_conflict_list;
-#endif
/* Length of UTF-16LE encoded short filename, in bytes, not including
* the terminating zero wide-character. */
* including the terminating null character. */
u32 full_path_nbytes;
- /* For extraction operations, a subtree of dentries will have this flag
- * set so we can keep track of which dentries still need to be
- * extracted. Otherwise this will always be 0. */
- u8 needs_extraction : 1;
+ /* For extraction operations, this flag will be set on dentries in the
+ * tree being extracted. Otherwise this will always be 0. */
+ u8 in_extraction_tree : 1;
/* For extraction operations, this flag will be set when a dentry in the
* tree being extracted is not being extracted for some reason (file
- * type not supported by target filesystem or contains invalid
- * characters). Otherwise this will always be 0. */
- u8 not_extracted : 1;
+ * type not supported by target filesystem, contains invalid characters,
+ * or not in one of the multiple sub-trees being extracted). Otherwise
+ * this will always be 0. */
+ u8 extraction_skipped : 1;
+
+ /* During extraction extractions, this flag will be set after the
+ * "skeleton" of the dentry has been extracted. */
+ u8 skeleton_extracted : 1;
/* When capturing from a NTFS volume using NTFS-3g, this flag is set on
* dentries that were created from a filename in the WIN32 or WIN32+DOS
* names. */
u8 dos_name_invalid : 1;
+ u8 tmp_flag : 1;
+
+ u8 was_hardlinked : 1;
+
/* Temporary list field used to make lists of dentries in a few places.
* */
struct list_head tmp_list;
* alias file_name. */
tchar *extraction_name;
size_t extraction_name_nchars;
-
- /* (Extraction only) List head for building a list of dentries that
- * contain a certain stream. */
- struct list_head extraction_stream_list;
};
#define rbnode_dentry(node) container_of(node, struct wim_dentry, rb_node)
/*
* WIM inode.
*
- * As mentioned above, in the WIM file that is no on-disk analogue of a real
- * inode, as most of these fields are duplicated in the dentries.
+ * As mentioned in the comment above `struct wim_dentry', in the WIM file that
+ * is no on-disk analogue of a real inode, as most of these fields are
+ * duplicated in the dentries. Instead, a `struct wim_inode' is something we
+ * create ourselves to simplify the handling of hard links.
*/
struct wim_inode {
- /* Timestamps for the inode. The timestamps are the number of
- * 100-nanosecond intervals that have elapsed since 12:00 A.M., January
- * 1st, 1601, UTC. This is the same format used in NTFS inodes. */
- u64 i_creation_time;
- u64 i_last_access_time;
- u64 i_last_write_time;
+ /* If i_resolved == 0:
+ * SHA1 message digest of the contents of the unnamed-data stream
+ * of this inode.
+ *
+ * If i_resolved == 1:
+ * Pointer to the lookup table entry for the unnamed data stream
+ * of this inode, or NULL.
+ *
+ * i_hash corresponds to the 'unnamed_stream_hash' field of the `struct
+ * wim_dentry_on_disk' and the additional caveats documented about that
+ * field apply here (for example, the quirks regarding all-zero hashes).
+ */
+ union {
+ u8 i_hash[SHA1_HASH_SIZE];
+ struct wim_lookup_table_entry *i_lte;
+ };
- /* The file attributes associated with this inode. This is a bitwise OR
- * of the FILE_ATTRIBUTE_* flags. */
+ /* Corresponds to the 'attributes' field of `struct wim_dentry_on_disk';
+ * bitwise OR of the FILE_ATTRIBUTE_* flags that give the attributes of
+ * this inode. */
u32 i_attributes;
- /* The index of the security descriptor in the WIM image's table of
- * security descriptors that contains this file's security information.
- * If -1, no security information exists for this file. */
- int32_t i_security_id;
+ /* Root of a red-black tree storing the child dentries of this inode, if
+ * any. Keyed by wim_dentry->file_name, case sensitively. */
+ struct rb_root i_children;
- /* %true iff the inode's lookup table entries has been resolved (i.e.
- * the @lte field is valid, but the @hash field is not valid)
- *
- * (This is not an on-disk field.) */
+ /* Root of a red-black tree storing the children of this inode, if any.
+ * Keyed by wim_dentry->file_name, case insensitively. */
+ struct rb_root i_children_case_insensitive;
+
+ /* List of dentries that are aliases for this inode. There will be
+ * i_nlink dentries in this list. */
+ struct list_head i_dentry;
+
+ /* Field to place this inode into a list. */
+ union {
+ /* Hash list node- used in hardlink.c when the inodes are placed
+ * into a hash table keyed by inode number and optionally device
+ * number, in order to detect dentries that are aliases for the
+ * same inode. */
+ struct hlist_node i_hlist;
+
+ /* Normal list node- used to connect all the inodes of a WIM image
+ * into a single linked list referenced from the
+ * `struct wim_image_metadata' for that image. */
+ struct list_head i_list;
+ };
+
+ /* Number of dentries that are aliases for this inode. */
+ u32 i_nlink;
+
+ /* Number of alternate data streams (ADS) associated with this inode */
+ u16 i_num_ads;
+
+ /* Flag that indicates whether this inode's streams have been
+ * "resolved". By default, the inode starts as "unresolved", meaning
+ * that the i_hash field, along with the hash field of any associated
+ * wim_ads_entry's, are valid and should be used as keys in the WIM
+ * lookup table to find the associated `struct wim_lookup_table_entry'.
+ * But if the inode has been resolved, then each of these fields is
+ * replaced with a pointer directly to the appropriate `struct
+ * wim_lookup_table_entry', or NULL if the stream is empty. */
u8 i_resolved : 1;
+ /* Flag used to mark this inode as visited; this is used when visiting
+ * all the inodes in a dentry tree exactly once. It will be 0 by
+ * default and must be cleared following the tree traversal, even in
+ * error paths. */
u8 i_visited : 1;
- /* Used only in NTFS-mode extraction */
+ /* Set if the DOS name of an inode has already been extracted. */
u8 i_dos_name_extracted : 1;
- /* Set to 0 if reparse point fixups have been done. Otherwise set to 1.
- *
- * Note: this actually may reflect the SYMBOLIC_LINK_RELATIVE flag. */
- u16 i_not_rpfixed;
+ /* 1 iff all ADS entries of this inode are named or if this inode
+ * has no ADS entries */
+ u8 i_canonical_streams : 1;
- /* Number of alternate data streams associated with this inode */
- u16 i_num_ads;
+ /* Pointer to a malloc()ed array of i_num_ads alternate data stream
+ * entries for this inode. */
+ struct wim_ads_entry *i_ads_entries;
- /* Unused/unknown fields that we just read into memory so we can
- * re-write them unchanged. */
- u32 i_rp_unknown_1;
- u16 i_rp_unknown_2;
+ /* Creation time, last access time, and last write time for this inode, in
+ * 100-nanosecond intervals since 12:00 a.m UTC January 1, 1601. They
+ * should correspond to the times gotten by calling GetFileTime() on
+ * Windows. */
+ u64 i_creation_time;
+ u64 i_last_access_time;
+ u64 i_last_write_time;
- /* If i_resolved == 0:
- * SHA1 message digest of the contents of the unnamed-data stream
- * of this inode, or all zeroes if this inode has no unnamed data
- * stream, or optionally all zeroes if this inode has an empty
- * unnamed data stream.
- *
- * If i_resolved == 1:
- * Pointer to the lookup table entry for the unnamed data stream
- * of this inode, or NULL if this inode has no unnamed data stream,
- * or optionally all zeroes if this inode has an empty unnamed data
- * stream.
- */
- union {
- u8 i_hash[SHA1_HASH_SIZE];
- struct wim_lookup_table_entry *i_lte;
- };
+ /* Corresponds to 'security_id' in `struct wim_dentry_on_disk': The
+ * index of this inode's security descriptor in the WIM image's table of
+ * security descriptors, or -1. Note: in verify_inode(), called
+ * whenever a WIM image is loaded, out-of-bounds indices are set to -1,
+ * so the extraction code does not need to do bounds checks. */
+ int32_t i_security_id;
/* Identity of a reparse point. See
* http://msdn.microsoft.com/en-us/library/windows/desktop/aa365503(v=vs.85).aspx
* for what a reparse point is. */
u32 i_reparse_tag;
- /* Number of dentries that reference this inode */
- u32 i_nlink;
+ /* Unused/unknown fields that we just read into memory so we can
+ * re-write them unchanged. */
+ u32 i_rp_unknown_1;
+ u16 i_rp_unknown_2;
- /* Alternate data stream entries. */
- struct wim_ads_entry *i_ads_entries;
+ /* Corresponds to not_rpfixed in `struct wim_dentry_on_disk': Set to 0
+ * if reparse point fixups have been done. Otherwise set to 1. Note:
+ * this actually may reflect the SYMBOLIC_LINK_RELATIVE flag.
+ */
+ u16 i_not_rpfixed;
- /* Inode number */
+ /* Inode number; corresponds to hard_link_group_id in the `struct
+ * wim_dentry_on_disk'. */
u64 i_ino;
- /* Device number, used only during image capture */
- u64 i_devno;
-
- /* List of dentries that reference this inode (there should be i_nlink
- * of them) */
- struct list_head i_dentry;
-
union {
- struct hlist_node i_hlist;
- struct list_head i_list;
- };
-
- tchar *i_extracted_file;
-
- /* Root of a red-black tree storing the children of this inode (if
- * non-empty, implies the inode is a directory, although that is also
- * noted in the @attributes field.) */
- struct rb_root i_children;
+ /* Device number, used only during image capture, so we can
+ * identify hard linked files by the combination of inode number
+ * and device number (rather than just inode number, which could
+ * be ambigious if the captured tree spans a mountpoint). Set
+ * to 0 otherwise. */
+ u64 i_devno;
+
+ struct {
+
+ /* Used only during image extraction: pointer to the first path
+ * (malloc()ed buffer) at which this inode has been extracted.
+ * Freed and set to NULL after the extraction is done (either
+ * success or failure). */
+ tchar *i_extracted_file;
+
+ /** Used only during image extraction: "cookie" that
+ * identifies this extracted file (inode), for example
+ * an inode number. Only used if supported by the
+ * extraction mode. */
+ u64 extract_cookie;
+ };
-#ifdef __WIN32__
- struct rb_root i_children_case_insensitive;
+#ifdef WITH_FUSE
+ /* Used only during image mount: Table of file descriptors that
+ * have been opened to this inode. The table is automatically
+ * freed when the last file descriptor is closed. */
+ struct wimfs_fd **i_fds;
#endif
-
- /* Next alternate data stream ID to be assigned */
- u32 i_next_stream_id;
+ };
#ifdef WITH_FUSE
- /* wimfs file descriptors table for the inode */
u16 i_num_opened_fds;
u16 i_num_allocated_fds;
- struct wimfs_fd **i_fds;
- /* This mutex protects the inode's file descriptors table during
- * read-only mounts. Read-write mounts are still restricted to 1
- * thread. */
- pthread_mutex_t i_mutex;
#endif
+
+ /* Next alternate data stream ID to be assigned */
+ u32 i_next_stream_id;
};
#define inode_for_each_dentry(dentry, inode) \
}
extern u64
-dentry_correct_total_length(const struct wim_dentry *dentry);
+dentry_out_total_length(const struct wim_dentry *dentry);
extern int
for_dentry_in_tree(struct wim_dentry *root,
int (*visitor)(struct wim_dentry *, void *),
void *arg);
-static inline int
+extern int
for_dentry_child(const struct wim_dentry *dentry,
int (*visitor)(struct wim_dentry *, void *),
- void *arg)
-{
- return for_dentry_in_rbtree(dentry->d_inode->i_children.rb_node,
- visitor,
- arg);
-}
+ void *arg);
extern int
for_dentry_in_tree_depth(struct wim_dentry *root,
extern int
set_dentry_name(struct wim_dentry *dentry, const tchar *new_name);
-extern struct wim_dentry *
-get_dentry(struct WIMStruct *w, const tchar *path);
-extern struct wim_inode *
-wim_pathname_to_inode(struct WIMStruct *w, const tchar *path);
+/* Note: the NTFS-3g headers define CASE_SENSITIVE, hence the WIMLIB prefix. */
+typedef enum {
+ /* Use either case-sensitive or case-insensitive search, depending on
+ * the variable @default_ignore_case. */
+ WIMLIB_CASE_PLATFORM_DEFAULT = 0,
+
+ /* Use case-sensitive search. */
+ WIMLIB_CASE_SENSITIVE = 1,
+
+ /* Use case-insensitive search. */
+ WIMLIB_CASE_INSENSITIVE = 2,
+} CASE_SENSITIVITY_TYPE;
+
+extern bool default_ignore_case;
+
+extern struct wim_dentry *
+get_dentry(struct WIMStruct *wim, const tchar *path,
+ CASE_SENSITIVITY_TYPE case_type);
extern struct wim_dentry *
get_dentry_child_with_name(const struct wim_dentry *dentry,
- const tchar *name);
+ const tchar *name,
+ CASE_SENSITIVITY_TYPE case_type);
extern struct wim_dentry *
get_dentry_child_with_utf16le_name(const struct wim_dentry *dentry,
const utf16lechar *name,
- size_t name_nbytes);
+ size_t name_nbytes,
+ CASE_SENSITIVITY_TYPE case_type);
extern struct wim_dentry *
-get_parent_dentry(struct WIMStruct *w, const tchar *path);
+get_parent_dentry(struct WIMStruct *wim, const tchar *path,
+ CASE_SENSITIVITY_TYPE case_type);
extern int
print_dentry(struct wim_dentry *dentry, void *lookup_table);
extern int
new_dentry_with_timeless_inode(const tchar *name, struct wim_dentry **dentry_ret);
+extern void
+dentry_tree_clear_inode_visited(struct wim_dentry *root);
+
extern int
new_filler_directory(const tchar *name, struct wim_dentry **dentry_ret);
dentry_add_child(struct wim_dentry * restrict parent,
struct wim_dentry * restrict child);
+extern int
+rename_wim_path(WIMStruct *wim, const tchar *from, const tchar *to,
+ CASE_SENSITIVITY_TYPE case_type);
+
extern struct wim_ads_entry *
inode_get_ads_entry(struct wim_inode *inode, const tchar *stream_name,
u16 *idx_ret);
const void *value, size_t size,
struct wim_lookup_table *lookup_table);
+bool
+inode_has_named_stream(const struct wim_inode *inode);
+
extern int
inode_set_unnamed_stream(struct wim_inode *inode, const void *data, size_t len,
struct wim_lookup_table *lookup_table);
#define WIMLIB_UNIX_DATA_TAG_UTF16LE "$\0$\0_\0_\0w\0i\0m\0l\0i\0b\0_\0U\0N\0I\0X\0_\0d\0a\0t\0a\0"
#define WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES (sizeof(WIMLIB_UNIX_DATA_TAG_UTF16LE) - 1)
+static inline bool
+ads_entry_is_unix_data(const struct wim_ads_entry *entry)
+{
+ return (entry->stream_name_nbytes ==
+ WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES) &&
+ !memcmp(entry->stream_name, WIMLIB_UNIX_DATA_TAG_UTF16LE,
+ WIMLIB_UNIX_DATA_TAG_UTF16LE_NBYTES);
+}
+
+static inline bool
+ads_entry_is_named_stream(const struct wim_ads_entry *entry)
+{
+ return entry->stream_name_nbytes != 0 && !ads_entry_is_unix_data(entry);
+}
+
+#ifndef __WIN32__
/* Format for special alternate data stream entries to store UNIX data for files
* and directories (see: WIMLIB_ADD_FLAG_UNIX_DATA) */
struct wimlib_unix_data {
u16 mode;
} _packed_attribute;
-#ifndef __WIN32__
-
#define NO_UNIX_DATA (-1)
#define BAD_UNIX_DATA (-2)
extern int
extern int
inode_set_unix_data(struct wim_inode *inode, uid_t uid, gid_t gid, mode_t mode,
struct wim_lookup_table *lookup_table, int which);
-#endif
+#endif /* !__WIN32__ */
+
+extern bool
+inode_has_unix_data(const struct wim_inode *inode);
extern int
-read_dentry(const u8 *metadata_resource, u64 metadata_resource_len,
- u64 offset, struct wim_dentry *dentry);
+read_dentry(const u8 * restrict metadata_resource,
+ u64 metadata_resource_len, u64 offset,
+ struct wim_dentry * restrict dentry);
extern int
-read_dentry_tree(const u8 metadata_resource[], u64 metadata_resource_len,
- struct wim_dentry *dentry);
+read_dentry_tree(const u8 * restrict metadata_resource,
+ u64 metadata_resource_len,
+ struct wim_dentry * restrict dentry);
extern u8 *
-write_dentry_tree(const struct wim_dentry *tree, u8 *p);
+write_dentry_tree(const struct wim_dentry * restrict tree,
+ u8 * restrict p);
static inline bool
dentry_is_root(const struct wim_dentry *dentry)
static inline bool
inode_is_directory(const struct wim_inode *inode)
{
- return (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
- && !(inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT);
+ return (inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+ FILE_ATTRIBUTE_REPARSE_POINT))
+ == FILE_ATTRIBUTE_DIRECTORY;
+}
+
+static inline bool
+inode_is_encrypted_directory(const struct wim_inode *inode)
+{
+ return ((inode->i_attributes & (FILE_ATTRIBUTE_DIRECTORY |
+ FILE_ATTRIBUTE_ENCRYPTED))
+ == (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_ENCRYPTED));
}
static inline bool
inode->i_reparse_tag == WIM_IO_REPARSE_TAG_MOUNT_POINT);
}
-static inline bool
-inode_is_regular_file(const struct wim_inode *inode)
-{
- return !inode_is_directory(inode) && !inode_is_symlink(inode);
-}
-
-static inline bool
-dentry_is_regular_file(const struct wim_dentry *dentry)
-{
- return inode_is_regular_file(dentry->d_inode);
-}
-
static inline bool
inode_has_children(const struct wim_inode *inode)
{
extern int
dentry_tree_fix_inodes(struct wim_dentry *root, struct list_head *inode_list);
-int
+extern int
verify_inode(struct wim_inode *inode, const struct wim_security_data *sd);
-#endif
+#endif /* _WIMLIB_DENTRY_H */