6 * Copyright (C) 2012, 2013 Eric Biggers
8 * This file is free software; you can redistribute it and/or modify it under
9 * the terms of the GNU Lesser General Public License as published by the Free
10 * Software Foundation; either version 3 of the License, or (at your option) any
13 * This file is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this file; if not, see http://www.gnu.org/licenses/.
27 #include "wimlib/dentry.h"
28 #include "wimlib/error.h"
29 #include "wimlib/inode.h"
30 #include "wimlib/lookup_table.h"
31 #include "wimlib/metadata.h"
32 #include "wimlib/xml.h"
36 inode_export_streams(struct wim_inode *inode,
37 struct wim_lookup_table *src_lookup_table,
38 struct wim_lookup_table *dest_lookup_table,
43 struct wim_lookup_table_entry *src_lte, *dest_lte;
45 inode_unresolve_streams(inode);
46 for (i = 0; i <= inode->i_num_ads; i++) {
48 /* Retrieve SHA1 message digest of stream to export. */
49 hash = inode_stream_hash(inode, i);
50 if (is_zero_hash(hash)) /* Empty stream? */
53 /* Search for the stream (via SHA1 message digest) in the
55 dest_lte = lookup_stream(dest_lookup_table, hash);
57 /* Stream not yet present in destination WIM. Search
58 * for it in the source WIM, then export it into the
60 src_lte = lookup_stream(src_lookup_table, hash);
62 return stream_not_found_error(inode, hash);
66 lookup_table_unlink(src_lookup_table, src_lte);
68 dest_lte = clone_lookup_table_entry(src_lte);
70 return WIMLIB_ERR_NOMEM;
73 dest_lte->out_refcnt = 0;
74 lookup_table_insert(dest_lookup_table, dest_lte);
77 /* Stream is present in destination WIM (either pre-existing,
78 * already exported, or just exported above). Increment its
79 * reference count appropriately. Note: we use 'refcnt' for
80 * the raw reference count, but 'out_refcnt' for references
81 * arising just from the export operation; this is used to roll
82 * back a failed export if needed. */
83 dest_lte->refcnt += inode->i_nlink;
84 dest_lte->out_refcnt += inode->i_nlink;
90 lte_unexport(struct wim_lookup_table_entry *lte, void *_lookup_table)
92 struct wim_lookup_table *lookup_table = _lookup_table;
94 if (lte->out_refcnt) {
95 lte->refcnt -= lte->out_refcnt;
96 if (lte->refcnt == 0) {
97 lookup_table_unlink(lookup_table, lte);
98 free_lookup_table_entry(lte);
104 /* API function documented in wimlib.h */
106 wimlib_export_image(WIMStruct *src_wim,
109 const tchar *dest_name,
110 const tchar *dest_description,
117 u32 orig_dest_boot_idx;
118 u32 orig_dest_image_count;
120 /* Check for sane parameters. */
121 if (export_flags & ~(WIMLIB_EXPORT_FLAG_BOOT |
122 WIMLIB_EXPORT_FLAG_NO_NAMES |
123 WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS |
124 WIMLIB_EXPORT_FLAG_GIFT |
125 WIMLIB_EXPORT_FLAG_WIMBOOT))
126 return WIMLIB_ERR_INVALID_PARAM;
128 if (src_wim == NULL || dest_wim == NULL)
129 return WIMLIB_ERR_INVALID_PARAM;
131 if (!wim_has_metadata(dest_wim))
132 return WIMLIB_ERR_METADATA_NOT_FOUND;
134 if (src_image == WIMLIB_ALL_IMAGES) {
135 /* Multi-image export. */
136 if ((!(export_flags & WIMLIB_EXPORT_FLAG_NO_NAMES) &&
138 (!(export_flags & WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS) &&
141 ERROR("Image name or image description was "
142 "specified, but we are exporting "
144 return WIMLIB_ERR_INVALID_PARAM;
147 end_image = src_wim->hdr.image_count;
149 start_image = src_image;
150 end_image = src_image;
153 /* Stream checksums must be known before proceeding. */
154 ret = wim_checksum_unhashed_streams(src_wim);
157 ret = wim_checksum_unhashed_streams(dest_wim);
161 /* Zero 'out_refcnt' in all lookup table entries in the destination WIM;
162 * this tracks the number of references found from the source WIM
164 for_lookup_table_entry(dest_wim->lookup_table, lte_zero_out_refcnt,
167 /* Save the original count of images in the destination WIM and the boot
168 * index (used if rollback necessary). */
169 orig_dest_image_count = dest_wim->hdr.image_count;
170 orig_dest_boot_idx = dest_wim->hdr.boot_idx;
172 /* Export each requested image. */
173 for (image = start_image; image <= end_image; image++) {
174 const tchar *next_dest_name, *next_dest_description;
175 struct wim_image_metadata *src_imd;
176 struct wim_inode *inode;
178 DEBUG("Exporting image %d from \"%"TS"\"",
179 image, src_wim->filename);
181 /* Determine destination image name and description. */
183 if (export_flags & WIMLIB_EXPORT_FLAG_NO_NAMES) {
184 next_dest_name = T("");
185 } else if (dest_name) {
186 next_dest_name = dest_name;
188 next_dest_name = wimlib_get_image_name(src_wim,
192 DEBUG("Using name \"%"TS"\"", next_dest_name);
194 if (export_flags & WIMLIB_EXPORT_FLAG_NO_DESCRIPTIONS) {
195 next_dest_description = T("");
196 } else if (dest_description) {
197 next_dest_description = dest_description;
199 next_dest_description = wimlib_get_image_description(
203 DEBUG("Using description \"%"TS"\"", next_dest_description);
205 /* Check for name conflict. */
206 if (wimlib_image_name_in_use(dest_wim, next_dest_name)) {
207 ERROR("There is already an image named \"%"TS"\" "
208 "in the destination WIM", next_dest_name);
209 ret = WIMLIB_ERR_IMAGE_NAME_COLLISION;
213 /* Load metadata for source image into memory. */
214 ret = select_wim_image(src_wim, image);
218 src_imd = wim_get_current_image_metadata(src_wim);
220 /* Iterate through inodes in the source image and export their
221 * streams into the destination WIM. */
222 image_for_each_inode(inode, src_imd) {
223 ret = inode_export_streams(inode,
224 src_wim->lookup_table,
225 dest_wim->lookup_table,
226 export_flags & WIMLIB_EXPORT_FLAG_GIFT);
231 /* Export XML information into the destination WIM. */
232 ret = xml_export_image(src_wim->wim_info, image,
233 &dest_wim->wim_info, next_dest_name,
234 next_dest_description);
238 /* Reference the source image metadata from the destination WIM.
240 ret = append_image_metadata(dest_wim, src_imd);
245 /* Lock the metadata into memory. XXX: need better solution for
247 src_imd->modified = 1;
249 /* Set boot index in destination WIM. */
250 if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
251 (src_image != WIMLIB_ALL_IMAGES ||
252 image == src_wim->hdr.boot_idx))
254 DEBUG("Marking destination image %u as bootable.",
255 dest_wim->hdr.image_count);
256 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
259 /* Possibly set WIMBoot flag */
260 if (export_flags & WIMLIB_EXPORT_FLAG_WIMBOOT) {
261 wim_info_set_wimboot(dest_wim->wim_info,
262 dest_wim->hdr.image_count,
267 /* Set the reparse point fixup flag on the destination WIM if the flag
268 * is set on the source WIM. */
269 if (src_wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
270 dest_wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
272 if (export_flags & WIMLIB_EXPORT_FLAG_GIFT) {
273 free_lookup_table(src_wim->lookup_table);
274 src_wim->lookup_table = NULL;
276 DEBUG("Export operation successful.");
280 while ((image = wim_info_get_num_images(dest_wim->wim_info))
281 > orig_dest_image_count)
283 xml_delete_image(&dest_wim->wim_info, image);
285 while (dest_wim->hdr.image_count > orig_dest_image_count)
287 put_image_metadata(dest_wim->image_metadata[
288 --dest_wim->hdr.image_count], NULL);
290 for_lookup_table_entry(dest_wim->lookup_table, lte_unexport,
291 dest_wim->lookup_table);
292 dest_wim->hdr.boot_idx = orig_dest_boot_idx;