wimlib.net Git - wimlib/blob - src/join.c

   1 /*
   2  * join.c
   3  *
   4  * Join split WIMs (sometimes named as .swm files) together into one WIM.
   5  */
   6
   7 /*
   8  * Copyright (C) 2012 Eric Biggers
   9  *
  10  * This file is part of wimlib, a library for working with WIM files.
  11  *
  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)
  15  * any later version.
  16  *
  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
  20  * details.
  21  *
  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/.
  24  */
  25
  26 #include "wimlib_internal.h"
  27 #include "lookup_table.h"
  28 #include "xml.h"
  29 #include <stdlib.h>
  30
  31 static int copy_lte_to_table(struct lookup_table_entry *lte, void *table)
  32 {
  33         struct lookup_table_entry *copy;
  34         copy = MALLOC(sizeof(struct lookup_table_entry));
  35         if (!copy)
  36                 return WIMLIB_ERR_NOMEM;
  37         memcpy(copy, lte, sizeof(struct lookup_table_entry));
  38         INIT_LIST_HEAD(&copy->lte_group_list);
  39         lookup_table_insert(table, copy);
  40         return 0;
  41 }
  42
  43 static int lookup_table_join(struct lookup_table *table,
  44                              struct lookup_table *new)
  45 {
  46         return for_lookup_table_entry(new, copy_lte_to_table, table);
  47 }
  48
  49
  50 static int cmp_swms_by_part_number(const void *swm1, const void *swm2)
  51 {
  52         u16 partno_1 = (*(WIMStruct**)swm1)->hdr.part_number;
  53         u16 partno_2 = (*(WIMStruct**)swm2)->hdr.part_number;
  54         return (int)partno_1 - (int)partno_2;
  55 }
  56
  57 int verify_swm_set(WIMStruct *w, WIMStruct **additional_swms,
  58                    unsigned num_additional_swms)
  59 {
  60         unsigned total_parts = w->hdr.total_parts;
  61         int ctype;
  62         const u8 *guid;
  63
  64         if (total_parts != num_additional_swms + 1) {
  65                 ERROR("`%s' says there are %u parts in the spanned set, "
  66                       "but %s%u part%s provided",
  67                       w->filename, w->hdr.total_parts,
  68                       (num_additional_swms + 1 < w->hdr.total_parts) ? "only " : "",
  69                       num_additional_swms + 1,
  70                       (num_additional_swms) ? "s were" : " was");
  71                 return WIMLIB_ERR_SPLIT_INVALID;
  72         }
  73         if (w->hdr.part_number != 1) {
  74                 ERROR("WIM `%s' is not the first part of the split WIM.",
  75                       w->filename);
  76                 return WIMLIB_ERR_SPLIT_INVALID;
  77         }
  78         for (unsigned i = 0; i < num_additional_swms; i++) {
  79                 if (additional_swms[i]->hdr.total_parts != total_parts) {
  80                         ERROR("WIM `%s' says there are %u parts in the spanned set, "
  81                               "but %u parts were provided",
  82                               additional_swms[i]->filename,
  83                               additional_swms[i]->hdr.total_parts,
  84                               total_parts);
  85                         return WIMLIB_ERR_SPLIT_INVALID;
  86                 }
  87         }
  88
  89         /* keep track of ctype and guid just to make sure they are the same for
  90          * all the WIMs. */
  91         ctype = wimlib_get_compression_type(w);
  92         guid = w->hdr.guid;
  93
  94         WIMStruct *parts_to_swms[num_additional_swms];
  95         ZERO_ARRAY(parts_to_swms);
  96         for (unsigned i = 0; i < num_additional_swms; i++) {
  97
  98                 WIMStruct *swm = additional_swms[i];
  99
 100                 if (wimlib_get_compression_type(swm) != ctype) {
 101                         ERROR("The split WIMs do not all have the same "
 102                               "compression type");
 103                         return WIMLIB_ERR_SPLIT_INVALID;
 104                 }
 105                 if (memcmp(guid, swm->hdr.guid, WIM_GID_LEN) != 0) {
 106                         ERROR("The split WIMs do not all have the same "
 107                               "GUID");
 108                         return WIMLIB_ERR_SPLIT_INVALID;
 109                 }
 110                 if (swm->hdr.part_number == 1) {
 111                         ERROR("WIMs `%s' and `%s' both are marked as the "
 112                               "first WIM in the spanned set",
 113                               w->filename, swm->filename);
 114                         return WIMLIB_ERR_SPLIT_INVALID;
 115                 }
 116                 if (swm->hdr.part_number == 0 ||
 117                     swm->hdr.part_number > total_parts)
 118                 {
 119                         ERROR("WIM `%s' says it is part %u in the spanned set, "
 120                               "but the part number must be in the range "
 121                               "[1, %u]",
 122                               swm->filename, swm->hdr.part_number, total_parts);
 123                         return WIMLIB_ERR_SPLIT_INVALID;
 124                 }
 125                 if (parts_to_swms[swm->hdr.part_number - 2])
 126                 {
 127                         ERROR("`%s' and `%s' are both marked as part %u of %u "
 128                               "in the spanned set",
 129                               parts_to_swms[swm->hdr.part_number - 2]->filename,
 130                               swm->filename,
 131                               swm->hdr.part_number,
 132                               total_parts);
 133                         return WIMLIB_ERR_SPLIT_INVALID;
 134                 } else {
 135                         parts_to_swms[swm->hdr.part_number - 2] = swm;
 136                 }
 137         }
 138         return 0;
 139 }
 140
 141 /*
 142  * Joins lookup tables from the parts of a split WIM.
 143  *
 144  * @w specifies the first part, while @additional_swms and @num_additional_swms
 145  * specify an array of points to the WIMStruct's for additional split WIM parts.
 146  *
 147  * On success, 0 is returned on a pointer to the joined lookup table is returned
 148  * in @table_ret.
 149  *
 150  * The reason we join the lookup tables is so:
 151  *      - We only have to search one lookup table to find the location of a
 152  *      resource in the entire split WIM.
 153  *      - Each lookup table entry will have a pointer to its split WIM part (and
 154  *      a part number field, although we don't really use it).
 155  */
 156 int new_joined_lookup_table(WIMStruct *w,
 157                             WIMStruct **additional_swms,
 158                             unsigned num_additional_swms,
 159                             struct lookup_table **table_ret)
 160 {
 161         struct lookup_table *table;
 162         int ret;
 163         unsigned i;
 164
 165
 166         table = new_lookup_table(9001);
 167         if (!table)
 168                 return WIMLIB_ERR_NOMEM;
 169         ret = lookup_table_join(table, w->lookup_table);
 170         if (ret != 0)
 171                 goto out_free_table;
 172         for (i = 0; i < num_additional_swms; i++) {
 173                 ret = lookup_table_join(table, additional_swms[i]->lookup_table);
 174                 if (ret != 0)
 175                         goto out_free_table;
 176         }
 177         *table_ret = table;
 178         return 0;
 179 out_free_table:
 180         free_lookup_table(table);
 181         return ret;
 182 }
 183
 184
 185 static int join_wims(WIMStruct **swms, uint num_swms, WIMStruct *joined_wim,
 186                      int write_flags)
 187 {
 188         uint i;
 189         int ret;
 190         FILE *out_fp = joined_wim->out_fp;
 191         u64 total_bytes = wim_info_get_total_bytes(swms[0]->wim_info);
 192
 193         swms[0]->write_metadata = false;
 194         for (i = 0; i < num_swms; i++) {
 195                 if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS) {
 196                         off_t cur_offset = ftello(out_fp);
 197                         printf("Writing resources from part %u of %u "
 198                                "(%"PRIu64" of %"PRIu64" bytes, %.0f%% done)\n",
 199                                i + 1, num_swms, cur_offset, total_bytes,
 200                                (double)cur_offset / total_bytes * 100.0);
 201                 }
 202                 swms[i]->fp = fopen(swms[i]->filename, "rb");
 203                 if (!swms[i]->fp) {
 204                         ERROR_WITH_ERRNO("Failed to reopen `%s'",
 205                                          swms[i]->filename);
 206                         return WIMLIB_ERR_OPEN;
 207                 }
 208                 swms[i]->out_fp = out_fp;
 209                 swms[i]->hdr.part_number = 1;
 210                 ret = for_lookup_table_entry(swms[i]->lookup_table,
 211                                              copy_resource, swms[i]);
 212                 if (ret != 0)
 213                         return ret;
 214                 if (i != 0) {
 215                         fclose(swms[i]->fp);
 216                         swms[i]->fp = NULL;
 217                 }
 218         }
 219         swms[0]->write_metadata = true;
 220         if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS)
 221                 printf("Writing %d metadata resources\n",
 222                         swms[0]->hdr.image_count);
 223
 224         for (i = 0; i < swms[0]->hdr.image_count; i++) {
 225                 ret = copy_resource(swms[0]->image_metadata[i].metadata_lte,
 226                                     swms[0]);
 227                 if (ret != 0)
 228                         return ret;
 229         }
 230
 231         off_t lookup_table_offset = ftello(out_fp);
 232
 233         if (write_flags & WIMLIB_WRITE_FLAG_SHOW_PROGRESS)
 234                 printf("Writing lookup tables, XML data, and header\n");
 235         /* Now write the lookup table for the joined wim.  Since the lookup
 236          * table has no header, we can just concatenate the lookup tables of all
 237          * the SWM parts. */
 238         for (i = 0; i < num_swms; i++) {
 239                 ret = write_lookup_table(swms[i]->lookup_table, out_fp);
 240                 if (ret != 0)
 241                         return ret;
 242         }
 243         off_t xml_data_offset = ftello(out_fp);
 244
 245         if (lookup_table_offset == -1 || xml_data_offset == -1) {
 246                 ERROR_WITH_ERRNO("Failed to get file offset");
 247                 return WIMLIB_ERR_WRITE;
 248         }
 249         swms[0]->hdr.lookup_table_res_entry.offset = lookup_table_offset;
 250         swms[0]->hdr.lookup_table_res_entry.size =
 251                                         xml_data_offset - lookup_table_offset;
 252
 253
 254         /* finish_write is called on the first swm, not the joined_wim, because
 255          * the first swm is the one that has the image metadata and XML data
 256          * attached to it.  */
 257         swms[0]->hdr.flags &= ~WIM_HDR_FLAG_SPANNED;
 258         swms[0]->hdr.total_parts = 1;
 259         return finish_write(swms[0], WIM_ALL_IMAGES, write_flags, 0);
 260 }
 261
 262
 263 WIMLIBAPI int wimlib_join(const char **swm_names, unsigned num_swms,
 264                           const char *output_path, int flags)
 265 {
 266         int i;
 267         int ret;
 268         int part_idx;
 269         int write_flags = 0;
 270         WIMStruct *joined_wim = NULL;
 271         WIMStruct *swms[num_swms];
 272
 273         int ctype;
 274         u8 *guid;
 275
 276         if (num_swms < 1)
 277                 return WIMLIB_ERR_INVALID_PARAM;
 278
 279         ZERO_ARRAY(swms);
 280
 281         for (i = 0; i < num_swms; i++) {
 282                 ret = wimlib_open_wim(swm_names[i],
 283                                       flags | WIMLIB_OPEN_FLAG_SPLIT_OK, &swms[i]);
 284                 if (ret != 0)
 285                         goto out;
 286
 287                 /* don't open all the parts at the same time, in case there are
 288                  * a lot of them */
 289                 fclose(swms[i]->fp);
 290                 swms[i]->fp = NULL;
 291         }
 292
 293         qsort(swms, num_swms, sizeof(swms[0]), cmp_swms_by_part_number);
 294
 295         ret = verify_swm_set(swms[0], &swms[1], num_swms - 1);
 296         if (ret != 0)
 297                 goto out;
 298
 299         joined_wim = new_wim_struct();
 300         if (!joined_wim) {
 301                 ret = WIMLIB_ERR_NOMEM;
 302                 goto out;
 303         }
 304
 305         if (flags & WIMLIB_OPEN_FLAG_CHECK_INTEGRITY)
 306                 write_flags |= WIMLIB_WRITE_FLAG_CHECK_INTEGRITY;
 307         if (flags & WIMLIB_OPEN_FLAG_SHOW_PROGRESS)
 308                 write_flags |= WIMLIB_WRITE_FLAG_SHOW_PROGRESS;
 309
 310         ret = begin_write(joined_wim, output_path, write_flags);
 311         if (ret != 0)
 312                 goto out;
 313         ret = join_wims(swms, num_swms, joined_wim, write_flags);
 314 out:
 315         for (i = 0; i < num_swms; i++) {
 316                 /* out_fp is the same in all the swms and joined_wim; only close
 317                  * it one time, when freeing joined_wim. */
 318                 if (swms[i]) {
 319                         swms[i]->out_fp = NULL;
 320                         wimlib_free(swms[i]);
 321                 }
 322         }
 323         wimlib_free(joined_wim);
 324         return ret;
 325 }