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

   1 /*
   2  * export_image.c
   3  */
   4
   5 /*
   6  * Copyright (C) 2012, 2013 Eric Biggers
   7  *
   8  * This file is part of wimlib, a library for working with WIM files.
   9  *
  10  * wimlib is free software; you can redistribute it and/or modify it under the
  11  * terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 3 of the License, or (at your option)
  13  * any later version.
  14  *
  15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
  16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
  22  */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27
  28 #include "wimlib.h"
  29 #include "wimlib/dentry.h"
  30 #include "wimlib/error.h"
  31 #include "wimlib/lookup_table.h"
  32 #include "wimlib/metadata.h"
  33 #include "wimlib/swm.h"
  34 #include "wimlib/xml.h"
  35
  36 static int
  37 inode_allocate_needed_ltes(struct wim_inode *inode,
  38                            struct wim_lookup_table *src_lookup_table,
  39                            struct wim_lookup_table *dest_lookup_table,
  40                            struct list_head *lte_list_head)
  41 {
  42         struct wim_lookup_table_entry *src_lte, *dest_lte;
  43         unsigned i;
  44
  45         inode_unresolve_ltes(inode);
  46         for (i = 0; i <= inode->i_num_ads; i++) {
  47                 src_lte = inode_stream_lte_unresolved(inode, i,
  48                                                       src_lookup_table);
  49                 if (src_lte && src_lte->out_refcnt == 0) {
  50                         src_lte->out_refcnt = 1;
  51                         dest_lte = inode_stream_lte_unresolved(inode, i,
  52                                                                dest_lookup_table);
  53                         if (!dest_lte) {
  54                                 dest_lte = clone_lookup_table_entry(src_lte);
  55                                 if (!dest_lte)
  56                                         return WIMLIB_ERR_NOMEM;
  57                                 list_add_tail(&dest_lte->export_stream_list,
  58                                               lte_list_head);
  59                         }
  60                 }
  61         }
  62         return 0;
  63 }
  64
  65 static void
  66 inode_move_ltes_to_table(struct wim_inode *inode,
  67                          struct wim_lookup_table *src_lookup_table,
  68                          struct wim_lookup_table *dest_lookup_table,
  69                          struct list_head *lte_list_head)
  70 {
  71         struct wim_lookup_table_entry *src_lte, *dest_lte;
  72         unsigned i;
  73
  74         for (i = 0; i <= inode->i_num_ads; i++) {
  75                 src_lte = inode_stream_lte_unresolved(inode, i, src_lookup_table);
  76                 if (src_lte) {
  77                         dest_lte = inode_stream_lte_unresolved(inode, i,
  78                                                                dest_lookup_table);
  79                         if (!dest_lte) {
  80                                 struct list_head *next;
  81
  82                                 wimlib_assert(!list_empty(lte_list_head));
  83                                 next = lte_list_head->next;
  84                                 list_del(next);
  85                                 dest_lte = container_of(next,
  86                                                         struct wim_lookup_table_entry,
  87                                                         export_stream_list);
  88                                 dest_lte->part_number = 1;
  89                                 dest_lte->refcnt = 0;
  90                                 wimlib_assert(hashes_equal(dest_lte->hash, src_lte->hash));
  91                                 lookup_table_insert(dest_lookup_table, dest_lte);
  92                         }
  93                         dest_lte->refcnt += inode->i_nlink;
  94                 }
  95         }
  96 }
  97
  98 /* API function documented in wimlib.h  */
  99 WIMLIBAPI int
 100 wimlib_export_image(WIMStruct *src_wim,
 101                     int src_image,
 102                     WIMStruct *dest_wim,
 103                     const tchar *dest_name,
 104                     const tchar *dest_description,
 105                     int export_flags,
 106                     WIMStruct **additional_swms,
 107                     unsigned num_additional_swms,
 108                     wimlib_progress_func_t progress_func)
 109 {
 110         int ret;
 111         struct wim_image_metadata *src_imd;
 112         struct list_head lte_list_head;
 113         struct wim_inode *inode;
 114
 115         ret = can_modify_wim(dest_wim);
 116         if (ret)
 117                 return ret;
 118
 119         if (src_image == WIMLIB_ALL_IMAGES) {
 120                 if (src_wim->hdr.image_count > 1) {
 121
 122                         /* multi-image export. */
 123
 124                         if ((export_flags & WIMLIB_EXPORT_FLAG_BOOT) &&
 125                               (src_wim->hdr.boot_idx == 0))
 126                         {
 127                                 /* Specifying the boot flag on a multi-image
 128                                  * source WIM makes the boot index default to
 129                                  * the bootable image in the source WIM.  It is
 130                                  * an error if there is no such bootable image.
 131                                  * */
 132                                 ERROR("Cannot specify `boot' flag when "
 133                                       "exporting multiple images from a WIM "
 134                                       "with no bootable images");
 135                                 return WIMLIB_ERR_INVALID_PARAM;
 136                         }
 137                         if (dest_name || dest_description) {
 138                                 ERROR("Image name or image description was "
 139                                       "specified, but we are exporting "
 140                                       "multiple images");
 141                                 return WIMLIB_ERR_INVALID_PARAM;
 142                         }
 143                         for (int i = 1; i <= src_wim->hdr.image_count; i++) {
 144                                 int new_flags = export_flags;
 145
 146                                 if (i != src_wim->hdr.boot_idx)
 147                                         new_flags &= ~WIMLIB_EXPORT_FLAG_BOOT;
 148
 149                                 ret = wimlib_export_image(src_wim, i, dest_wim,
 150                                                           NULL, NULL,
 151                                                           new_flags,
 152                                                           additional_swms,
 153                                                           num_additional_swms,
 154                                                           progress_func);
 155                                 if (ret)
 156                                         return ret;
 157                         }
 158                         return 0;
 159                 } else if (src_wim->hdr.image_count == 1) {
 160                         src_image = 1;
 161                 } else {
 162                         return 0;
 163                 }
 164         }
 165
 166         if (!dest_name) {
 167                 dest_name = wimlib_get_image_name(src_wim, src_image);
 168                 DEBUG("Using name `%"TS"' for source image %d",
 169                       dest_name, src_image);
 170         }
 171
 172         if (!dest_description) {
 173                 dest_description = wimlib_get_image_description(src_wim,
 174                                                                 src_image);
 175                 DEBUG("Using description `%"TS"' for source image %d",
 176                       dest_description, src_image);
 177         }
 178
 179         DEBUG("Exporting image %d from `%"TS"'", src_image, src_wim->filename);
 180
 181         if (wimlib_image_name_in_use(dest_wim, dest_name)) {
 182                 ERROR("There is already an image named `%"TS"' in the "
 183                       "destination WIM", dest_name);
 184                 return WIMLIB_ERR_IMAGE_NAME_COLLISION;
 185         }
 186
 187         ret = verify_swm_set(src_wim, additional_swms, num_additional_swms);
 188         if (ret)
 189                 return ret;
 190
 191         ret = wim_checksum_unhashed_streams(src_wim);
 192         if (ret)
 193                 return ret;
 194         ret = wim_checksum_unhashed_streams(dest_wim);
 195         if (ret)
 196                 return ret;
 197
 198         if (num_additional_swms)
 199                 merge_lookup_tables(src_wim, additional_swms, num_additional_swms);
 200
 201         ret = select_wim_image(src_wim, src_image);
 202         if (ret) {
 203                 ERROR("Could not select image %d from the WIM `%"TS"' "
 204                       "to export it", src_image, src_wim->filename);
 205                 goto out;
 206         }
 207
 208         /* Pre-allocate the new lookup table entries that will be needed.  This
 209          * way, it's not possible to run out of memory part-way through
 210          * modifying the lookup table of the destination WIM. */
 211         for_lookup_table_entry(src_wim->lookup_table, lte_zero_out_refcnt, NULL);
 212         src_imd = wim_get_current_image_metadata(src_wim);
 213         INIT_LIST_HEAD(&lte_list_head);
 214         image_for_each_inode(inode, src_imd) {
 215                 ret = inode_allocate_needed_ltes(inode,
 216                                                  src_wim->lookup_table,
 217                                                  dest_wim->lookup_table,
 218                                                  &lte_list_head);
 219                 if (ret)
 220                         goto out_free_ltes;
 221         }
 222
 223         ret = xml_export_image(src_wim->wim_info, src_image,
 224                                &dest_wim->wim_info, dest_name,
 225                                dest_description);
 226         if (ret)
 227                 goto out_free_ltes;
 228
 229         ret = append_image_metadata(dest_wim, src_imd);
 230         if (ret)
 231                 goto out_xml_delete_image;
 232
 233         /* The `struct image_metadata' is now referenced by both the @src_wim
 234          * and the @dest_wim. */
 235         src_imd->refcnt++;
 236         src_imd->modified = 1;
 237
 238         /* All memory allocations have been taken care of, so it's no longer
 239          * possible for this function to fail.  Go ahead and update the lookup
 240          * table of the destination WIM and the boot index, if needed. */
 241         image_for_each_inode(inode, src_imd) {
 242                 inode_move_ltes_to_table(inode,
 243                                          src_wim->lookup_table,
 244                                          dest_wim->lookup_table,
 245                                          &lte_list_head);
 246         }
 247
 248         if (export_flags & WIMLIB_EXPORT_FLAG_BOOT)
 249                 dest_wim->hdr.boot_idx = dest_wim->hdr.image_count;
 250         if (src_wim->hdr.flags & WIM_HDR_FLAG_RP_FIX)
 251         {
 252                 /* Set the reparse point fixup flag on the destination WIM if
 253                  * the flag is set on the source WIM. */
 254                 dest_wim->hdr.flags |= WIM_HDR_FLAG_RP_FIX;
 255         }
 256         DEBUG("Successfully exported image.");
 257         ret = 0;
 258         goto out;
 259 out_xml_delete_image:
 260         xml_delete_image(&dest_wim->wim_info, dest_wim->hdr.image_count + 1);
 261 out_free_ltes:
 262         {
 263                 struct wim_lookup_table_entry *lte, *tmp;
 264                 list_for_each_entry_safe(lte, tmp, &lte_list_head, export_stream_list)
 265                         free_lookup_table_entry(lte);
 266         }
 267 out:
 268         if (num_additional_swms)
 269                 unmerge_lookup_table(src_wim);
 270         return ret;
 271 }