]> wimlib.net Git - wimlib/blob - include/wimlib/capture.h
8d79542f1a4073eff0f3d71ccaeb0c9615957283
[wimlib] / include / wimlib / capture.h
1 #ifndef _WIMLIB_CAPTURE_H
2 #define _WIMLIB_CAPTURE_H
3
4 #include "wimlib.h"
5 #include "wimlib/inode_table.h"
6 #include "wimlib/list.h"
7 #include "wimlib/security.h"
8 #include "wimlib/textfile.h"
9 #include "wimlib/util.h"
10
11 struct wim_lookup_table;
12 struct wim_dentry;
13 struct wim_inode;
14
15 struct capture_config {
16         struct string_set exclusion_pats;
17         struct string_set exclusion_exception_pats;
18         void *buf;
19 };
20
21 /* Common parameters to implementations of building an in-memory dentry tree
22  * from an on-disk directory structure. */
23 struct add_image_params {
24         /* Pointer to the lookup table of the WIM.  */
25         struct wim_lookup_table *lookup_table;
26
27         /* List of streams that have been added so far, but without their SHA1
28          * message digests being calculated (as a shortcut).  */
29         struct list_head *unhashed_streams;
30
31         /* Hash table of inodes that have been captured for this tree so far. */
32         struct wim_inode_table *inode_table;
33
34         /* The set of security descriptors that have been captured for this
35          * image so far. */
36         struct wim_sd_set *sd_set;
37
38         /* Pointer to the capture configuration.  */
39         struct capture_config *config;
40
41         /* Flags that affect the capture operation (WIMLIB_ADD_FLAG_*) */
42         int add_flags;
43
44         /* Extra argument; set to point to a pointer to the ntfs_volume for
45          * libntfs-3g capture.  */
46         void *extra_arg;
47
48
49         /* If non-NULL, the user-supplied progress function. */
50         wimlib_progress_func_t progress_func;
51
52         /* Progress data.  */
53         union wimlib_progress_info progress;
54
55         /* Can be used by the capture implementation.  */
56         u64 capture_root_ino;
57         u64 capture_root_dev;
58         size_t capture_root_nchars;
59 };
60
61
62 /* capture_common.c */
63
64 extern void
65 do_capture_progress(struct add_image_params *params, int status,
66                     const struct wim_inode *inode);
67
68 extern int
69 mangle_pat(tchar *pat, const tchar *path, unsigned long line_no);
70
71 extern int
72 do_read_capture_config_file(const tchar *config_file, const void *buf,
73                             size_t bufsize, struct capture_config *config);
74
75 extern void
76 destroy_capture_config(struct capture_config *config);
77
78 extern bool
79 match_pattern_list(const tchar *path, size_t path_nchars,
80                    const struct string_set *list);
81
82 extern bool
83 exclude_path(const tchar *path, size_t path_len,
84              const struct capture_config *config);
85
86 typedef int (*capture_tree_t)(struct wim_dentry **, const tchar *,
87                               struct add_image_params *);
88
89 #ifdef WITH_NTFS_3G
90 /* ntfs-3g_capture.c */
91 extern int
92 build_dentry_tree_ntfs(struct wim_dentry **root_p,
93                        const tchar *device,
94                        struct add_image_params *params);
95 #endif
96
97 #ifdef __WIN32__
98 /* win32_capture.c */
99 extern int
100 win32_build_dentry_tree(struct wim_dentry **root_ret,
101                         const tchar *root_disk_path,
102                         struct add_image_params *params);
103 #define platform_default_capture_tree win32_build_dentry_tree
104 #else
105 /* unix_capture.c */
106 extern int
107 unix_build_dentry_tree(struct wim_dentry **root_ret,
108                        const tchar *root_disk_path,
109                        struct add_image_params *params);
110 #define platform_default_capture_tree unix_build_dentry_tree
111 #endif
112
113 #define WIMLIB_ADD_FLAG_ROOT    0x80000000
114
115 #endif /* _WIMLIB_CAPTURE_H */