4 * Join split WIMs (sometimes named as .swm files) together into one WIM.
8 * Copyright (C) 2012 Eric Biggers
10 * This file is part of wimlib, a library for working with WIM files.
12 * wimlib is free software; you can redistribute it and/or modify it under the
13 * terms of the GNU General Public License as published by the Free
14 * Software Foundation; either version 3 of the License, or (at your option)
17 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19 * A PARTICULAR PURPOSE. See the GNU General Public License for more
22 * You should have received a copy of the GNU General Public License
23 * along with wimlib; if not, see http://www.gnu.org/licenses/.
26 #include "wimlib_internal.h"
27 #include "lookup_table.h"
31 static int copy_lte_to_table(struct lookup_table_entry *lte, void *table)
33 struct lookup_table_entry *copy;
34 copy = new_lookup_table_entry();
36 return WIMLIB_ERR_NOMEM;
37 memcpy(copy, lte, sizeof(struct lookup_table_entry));
38 lookup_table_insert(table, copy);
42 static int lookup_table_join(struct lookup_table *table,
43 struct lookup_table *new)
45 return for_lookup_table_entry(new, copy_lte_to_table, table);
49 static int cmp_swms_by_part_number(const void *swm1, const void *swm2)
51 u16 partno_1 = (*(WIMStruct**)swm1)->hdr.part_number;
52 u16 partno_2 = (*(WIMStruct**)swm2)->hdr.part_number;
53 return (int)partno_1 - (int)partno_2;
56 int verify_swm_set(WIMStruct *w, WIMStruct **additional_swms,
57 unsigned num_additional_swms)
59 unsigned total_parts = w->hdr.total_parts;
63 if (total_parts != num_additional_swms + 1) {
64 ERROR("`%s' says there are %u parts in the spanned set, "
65 "but %s%u part%s provided",
66 w->filename, w->hdr.total_parts,
67 (num_additional_swms + 1 < w->hdr.total_parts) ? "only " : "",
68 num_additional_swms + 1,
69 (num_additional_swms) ? "s were" : " was");
70 return WIMLIB_ERR_SPLIT_INVALID;
72 if (w->hdr.part_number != 1) {
73 ERROR("WIM `%s' is not the first part of the split WIM.",
75 return WIMLIB_ERR_SPLIT_INVALID;
77 for (unsigned i = 0; i < num_additional_swms; i++) {
78 if (additional_swms[i]->hdr.total_parts != total_parts) {
79 ERROR("WIM `%s' says there are %u parts in the spanned set, "
80 "but %u parts were provided",
81 additional_swms[i]->filename,
82 additional_swms[i]->hdr.total_parts,
84 return WIMLIB_ERR_SPLIT_INVALID;
88 /* keep track of ctype and guid just to make sure they are the same for
90 ctype = wimlib_get_compression_type(w);
93 WIMStruct *parts_to_swms[num_additional_swms];
94 ZERO_ARRAY(parts_to_swms);
95 for (unsigned i = 0; i < num_additional_swms; i++) {
97 WIMStruct *swm = additional_swms[i];
99 if (wimlib_get_compression_type(swm) != ctype) {
100 ERROR("The split WIMs do not all have the same "
102 return WIMLIB_ERR_SPLIT_INVALID;
104 if (memcmp(guid, swm->hdr.guid, WIM_GID_LEN) != 0) {
105 ERROR("The split WIMs do not all have the same "
107 return WIMLIB_ERR_SPLIT_INVALID;
109 if (swm->hdr.part_number == 1) {
110 ERROR("WIMs `%s' and `%s' both are marked as the "
111 "first WIM in the spanned set",
112 w->filename, swm->filename);
113 return WIMLIB_ERR_SPLIT_INVALID;
115 if (swm->hdr.part_number == 0 ||
116 swm->hdr.part_number > total_parts)
118 ERROR("WIM `%s' says it is part %u in the spanned set, "
119 "but the part number must be in the range "
121 swm->filename, swm->hdr.part_number, total_parts);
122 return WIMLIB_ERR_SPLIT_INVALID;
124 if (parts_to_swms[swm->hdr.part_number - 2])
126 ERROR("`%s' and `%s' are both marked as part %u of %u "
127 "in the spanned set",
128 parts_to_swms[swm->hdr.part_number - 2]->filename,
130 swm->hdr.part_number,
132 return WIMLIB_ERR_SPLIT_INVALID;
134 parts_to_swms[swm->hdr.part_number - 2] = swm;
140 int new_joined_lookup_table(WIMStruct *w,
141 WIMStruct **additional_swms,
142 unsigned num_additional_swms,
143 struct lookup_table **table_ret)
145 struct lookup_table *table;
150 table = new_lookup_table(9001);
152 return WIMLIB_ERR_NOMEM;
153 ret = lookup_table_join(table, w->lookup_table);
156 for (i = 0; i < num_additional_swms; i++) {
157 ret = lookup_table_join(table, additional_swms[i]->lookup_table);
164 free_lookup_table(table);
169 static int join_wims(WIMStruct **swms, uint num_swms, WIMStruct *joined_wim,
174 FILE *out_fp = joined_wim->out_fp;
175 u64 total_bytes = wim_info_get_total_bytes(swms[0]->wim_info);
177 swms[0]->write_metadata = false;
178 for (i = 0; i < num_swms; i++) {
179 if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) {
180 off_t cur_offset = ftello(out_fp);
181 printf("Writing resources from part %u of %u "
182 "(%"PRIu64" of %"PRIu64" bytes, %.0f%% done)\n",
183 i + 1, num_swms, cur_offset, total_bytes,
184 (double)cur_offset / total_bytes * 100.0);
186 swms[i]->fp = fopen(swms[i]->filename, "rb");
188 ERROR_WITH_ERRNO("Failed to reopen `%s'",
190 return WIMLIB_ERR_OPEN;
192 swms[i]->out_fp = out_fp;
193 swms[i]->hdr.part_number = 1;
194 ret = for_lookup_table_entry(swms[i]->lookup_table,
195 copy_resource, swms[i]);
203 swms[0]->write_metadata = true;
204 if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS)
205 printf("Writing %d metadata resources\n",
206 swms[0]->hdr.image_count);
208 for (i = 0; i < swms[0]->hdr.image_count; i++) {
209 ret = copy_resource(swms[0]->image_metadata[i].metadata_lte,
215 off_t lookup_table_offset = ftello(out_fp);
217 if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS)
218 printf("Writing lookup tables, XML data, and header\n");
219 /* Now write the lookup table for the joined wim. Since the lookup
220 * table has no header, we can just concatenate the lookup tables of all
222 for (i = 0; i < num_swms; i++) {
223 ret = write_lookup_table(swms[i]->lookup_table, out_fp);
227 off_t xml_data_offset = ftello(out_fp);
229 if (lookup_table_offset == -1 || xml_data_offset == -1) {
230 ERROR_WITH_ERRNO("Failed to get file offset");
231 return WIMLIB_ERR_WRITE;
233 swms[0]->hdr.lookup_table_res_entry.offset = lookup_table_offset;
234 swms[0]->hdr.lookup_table_res_entry.size =
235 xml_data_offset - lookup_table_offset;
238 /* finish_write is called on the first swm, not the joined_wim, because
239 * the first swm is the one that has the image metadata and XML data
241 swms[0]->hdr.flags &= ~WIM_HDR_FLAG_SPANNED;
242 swms[0]->hdr.total_parts = 1;
243 return finish_write(swms[0], WIM_ALL_IMAGES, write_flags, 0);
247 WIMLIBAPI int wimlib_join(const char **swm_names, unsigned num_swms,
248 const char *output_path, int flags)
254 WIMStruct *joined_wim = NULL;
255 WIMStruct *swms[num_swms];
261 return WIMLIB_ERR_INVALID_PARAM;
265 for (i = 0; i < num_swms; i++) {
266 ret = wimlib_open_wim(swm_names[i],
267 flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &swms[i]);
271 /* don't open all the parts at the same time, in case there are
277 qsort(swms, num_swms, sizeof(swms[0]), cmp_swms_by_part_number);
279 ret = verify_swm_set(swms[0], &swms[1], num_swms - 1);
283 joined_wim = new_wim_struct();
285 ret = WIMLIB_ERR_NOMEM;
289 if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY)
290 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
291 if (flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS)
292 write_flags |= WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
294 ret = begin_write(joined_wim, output_path, write_flags);
297 ret = join_wims(swms, num_swms, joined_wim, write_flags);
299 for (i = 0; i < num_swms; i++) {
300 /* out_fp is the same in all the swms and joined_wim; only close
301 * it one time, when freeing joined_wim. */
303 swms[i]->out_fp = NULL;
304 wimlib_free(swms[i]);
307 wimlib_free(joined_wim);