Fix various typos
[wimlib] / src / integrity.c
index 7502b6d..0054c40 100644 (file)
@@ -9,20 +9,18 @@
 /*
  * Copyright (C) 2012, 2013 Eric Biggers
  *
- * This file is part of wimlib, a library for working with WIM files.
- *
- * wimlib is free software; you can redistribute it and/or modify it under the
- * terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 3 of the License, or (at your option)
- * any later version.
- *
- * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
- * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
- * A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * This file is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * This file is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  * details.
  *
- * You should have received a copy of the GNU General Public License
- * along with wimlib; if not, see http://www.gnu.org/licenses/.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this file; if not, see http://www.gnu.org/licenses/.
  */
 
 #ifdef HAVE_CONFIG_H
 #include "wimlib/error.h"
 #include "wimlib/file_io.h"
 #include "wimlib/integrity.h"
+#include "wimlib/progress.h"
 #include "wimlib/resource.h"
 #include "wimlib/sha1.h"
 #include "wimlib/wim.h"
+#include "wimlib/write.h"
 
 /* Size, in bytes, of each SHA1-summed chunk, when wimlib writes integrity
  * information. */
 #define INTEGRITY_CHUNK_SIZE 10485760
 
-/* Only use a different chunk size for compatiblity with an existing integrity
+/* Only use a different chunk size for compatibility with an existing integrity
  * table if the chunk size is between these two numbers. */
 #define INTEGRITY_MIN_CHUNK_SIZE 4096
 #define INTEGRITY_MAX_CHUNK_SIZE 134217728
@@ -87,9 +87,8 @@ calculate_chunk_sha1(struct filedes *in_fd, size_t this_chunk_size,
  * read_integrity_table: -  Reads the integrity table from a WIM file.
  *
  * @wim:
- *     WIMStruct for the WIM file; @wim->hdr.integrity specifies the location
- *     of the integrity table.  The integrity table must exist (i.e.
- *     res_entry->offset must not be 0).  @wim->in_fd is expected to be a
+ *     WIMStruct for the WIM file; @wim->hdr.integrity_table_reshdr specifies
+ *     the location of the integrity table.  @wim->in_fd is expected to be a
  *     seekable file descriptor to the WIM file opened for reading.
  *
  * @num_checked_bytes:
@@ -106,7 +105,7 @@ calculate_chunk_sha1(struct filedes *in_fd, size_t this_chunk_size,
  *     WIMLIB_ERR_READ
  *     WIMLIB_ERR_UNEXPECTED_END_OF_FILE
  */
-static int
+int
 read_integrity_table(WIMStruct *wim, u64 num_checked_bytes,
                     struct integrity_table **table_ret)
 {
@@ -114,14 +113,10 @@ read_integrity_table(WIMStruct *wim, u64 num_checked_bytes,
        struct integrity_table *table;
        int ret;
 
-       if (wim->hdr.integrity.size < 8)
+       if (wim->hdr.integrity_table_reshdr.uncompressed_size < 8)
                goto invalid;
 
-       DEBUG("Reading integrity table (offset %"PRIu64", "
-             "original_size %"PRIu64")",
-             wim->hdr.integrity.offset, wim->hdr.integrity.original_size);
-
-       ret = res_entry_to_data(&wim->hdr.integrity, wim, &buf);
+       ret = wim_reshdr_to_data(&wim->hdr.integrity_table_reshdr, wim, &buf);
        if (ret)
                return ret;
        table = buf;
@@ -130,11 +125,7 @@ read_integrity_table(WIMStruct *wim, u64 num_checked_bytes,
        table->num_entries = le32_to_cpu(table->num_entries);
        table->chunk_size  = le32_to_cpu(table->chunk_size);
 
-       DEBUG("table->size = %u, table->num_entries = %u, "
-             "table->chunk_size = %u",
-             table->size, table->num_entries, table->chunk_size);
-
-       if (table->size != wim->hdr.integrity.original_size ||
+       if (table->size != wim->hdr.integrity_table_reshdr.uncompressed_size ||
            table->size != (u64)table->num_entries * SHA1_HASH_SIZE + 12 ||
            table->chunk_size == 0 ||
            table->num_entries != DIV_ROUND_UP(num_checked_bytes, table->chunk_size))
@@ -147,7 +138,6 @@ read_integrity_table(WIMStruct *wim, u64 num_checked_bytes,
        return 0;
 
 invalid:
-       ERROR("Integrity table is invalid");
        return WIMLIB_ERR_INVALID_INTEGRITY_TABLE;
 }
 
@@ -172,10 +162,6 @@ invalid:
  *     If @old_table is non-NULL, the byte after the last byte that was checked
  *     in the old table.  Must be less than or equal to new_check_end.
  *
- * @progress_func:
- *     If non-NULL, a progress function that will be called after every
- *     calculated chunk.
- *
  * @integrity_table_ret:
  *     On success, a pointer to the calculated integrity table is written into
  *     this location.
@@ -191,8 +177,9 @@ calculate_integrity_table(struct filedes *in_fd,
                          off_t new_check_end,
                          const struct integrity_table *old_table,
                          off_t old_check_end,
-                         wimlib_progress_func_t progress_func,
-                         struct integrity_table **integrity_table_ret)
+                         struct integrity_table **integrity_table_ret,
+                         wimlib_progress_func_t progfunc,
+                         void *progctx)
 {
        int ret;
        size_t chunk_size = INTEGRITY_CHUNK_SIZE;
@@ -230,16 +217,17 @@ calculate_integrity_table(struct filedes *in_fd,
        u64 offset = WIM_HEADER_DISK_SIZE;
        union wimlib_progress_info progress;
 
-       if (progress_func) {
-               progress.integrity.total_bytes      = new_check_bytes;
-               progress.integrity.total_chunks     = new_num_chunks;
-               progress.integrity.completed_chunks = 0;
-               progress.integrity.completed_bytes  = 0;
-               progress.integrity.chunk_size       = chunk_size;
-               progress.integrity.filename         = NULL;
-               progress_func(WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
-                             &progress);
-       }
+       progress.integrity.total_bytes      = new_check_bytes;
+       progress.integrity.total_chunks     = new_num_chunks;
+       progress.integrity.completed_chunks = 0;
+       progress.integrity.completed_bytes  = 0;
+       progress.integrity.chunk_size       = chunk_size;
+       progress.integrity.filename         = NULL;
+
+       ret = call_progress(progfunc, WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
+                           &progress, progctx);
+       if (ret)
+               goto out_free_new_table;
 
        for (u32 i = 0; i < new_num_chunks; i++) {
                size_t this_chunk_size;
@@ -258,21 +246,24 @@ calculate_integrity_table(struct filedes *in_fd,
                        /* Calculate the SHA1 message digest of this chunk */
                        ret = calculate_chunk_sha1(in_fd, this_chunk_size,
                                                   offset, new_table->sha1sums[i]);
-                       if (ret) {
-                               FREE(new_table);
-                               return ret;
-                       }
+                       if (ret)
+                               goto out_free_new_table;
                }
                offset += this_chunk_size;
-               if (progress_func) {
-                       progress.integrity.completed_chunks++;
-                       progress.integrity.completed_bytes += this_chunk_size;
-                       progress_func(WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
-                                     &progress);
-               }
+
+               progress.integrity.completed_chunks++;
+               progress.integrity.completed_bytes += this_chunk_size;
+               ret = call_progress(progfunc, WIMLIB_PROGRESS_MSG_CALC_INTEGRITY,
+                                   &progress, progctx);
+               if (ret)
+                       goto out_free_new_table;
        }
        *integrity_table_ret = new_table;
        return 0;
+
+out_free_new_table:
+       FREE(new_table);
+       return ret;
 }
 
 /*
@@ -282,79 +273,45 @@ calculate_integrity_table(struct filedes *in_fd,
  * chunks of the file).
  *
  * This function can optionally re-use entries from an older integrity table.
- * To do this, make @integrity_res_entry point to the resource entry for the
- * older table (note: this is an input-output parameter), and set
- * @old_lookup_table_end to the offset of the byte directly following the last
- * byte checked by the old table.  If the old integrity table is invalid or
- * cannot be read, a warning is printed and the integrity information is
- * re-calculated.
+ * To do this, specify old_blob_table_end and old_table.
+ *
+ * On success, @wim->out_hdr.integrity_table_reshdr will be filled in with
+ * information about the integrity table that was written.
  *
  * @wim:
  *     WIMStruct for the WIM file.  @wim->out_fd must be a seekable descriptor
  *     to the new WIM file, opened read-write, positioned at the location at
- *     which the integrity table is to be written.  Furthermore,
- *     @wim->hdr.integrity is expected to be a resource entry which will be set
- *     to the integrity table information on success.  In addition, if
- *     @old_lookup_table_end != 0, @wim->hdr.integrity must initially contain
- *     information about the old integrity table, and @wim->in_fd must be a
- *     seekable descriptor to the original WIM file opened for reading.
+ *     which the integrity table is to be written.
  *
- * @new_lookup_table_end:
- *     The offset of the byte directly following the lookup table in the WIM
+ * @new_blob_table_end:
+ *     The offset of the byte directly following the blob table in the WIM
  *     being written.
  *
- * @old_lookup_table_end:
- *     If nonzero, the offset of the byte directly following the old lookup
- *     table in the WIM.
- *
- * @progress_func
- *     If non-NULL, a progress function that will be called after every
- *     calculated chunk.
+ * @old_blob_table_end:
+ *     If nonzero, the offset of the byte directly following the old blob table
+ *     in the WIM.
  *
- * Return values:
- *     WIMLIB_ERR_SUCCESS (0)
- *     WIMLIB_ERR_INVALID_INTEGRITY_TABLE
- *     WIMLIB_ERR_NOMEM
- *     WIMLIB_ERR_READ
- *     WIMLIB_ERR_UNEXPECTED_END_OF_FILE
- *     WIMLIB_ERR_WRITE
+ * @old_table
+ *     Pointer to the old integrity table read into memory, or NULL if not
+ *     specified.
  */
 int
 write_integrity_table(WIMStruct *wim,
-                     off_t new_lookup_table_end,
-                     off_t old_lookup_table_end,
-                     wimlib_progress_func_t progress_func)
+                     off_t new_blob_table_end,
+                     off_t old_blob_table_end,
+                     struct integrity_table *old_table)
 {
-       struct integrity_table *old_table;
        struct integrity_table *new_table;
        int ret;
-       off_t cur_offset;
        u32 new_table_size;
 
-       wimlib_assert(old_lookup_table_end <= new_lookup_table_end);
-
-       cur_offset = wim->out_fd.offset;
-
-       if (wim->hdr.integrity.offset == 0 || old_lookup_table_end == 0) {
-               old_table = NULL;
-       } else {
-               ret = read_integrity_table(wim,
-                                          old_lookup_table_end - WIM_HEADER_DISK_SIZE,
-                                          &old_table);
-               if (ret == WIMLIB_ERR_INVALID_INTEGRITY_TABLE) {
-                       WARNING("Old integrity table is invalid! "
-                               "Ignoring it");
-               } else if (ret != 0) {
-                       WARNING("Can't read old integrity table! "
-                               "Ignoring it");
-               }
-       }
+       wimlib_assert(old_blob_table_end <= new_blob_table_end);
 
-       ret = calculate_integrity_table(&wim->out_fd, new_lookup_table_end,
-                                       old_table, old_lookup_table_end,
-                                       progress_func, &new_table);
+       ret = calculate_integrity_table(&wim->out_fd, new_blob_table_end,
+                                       old_table, old_blob_table_end,
+                                       &new_table, wim->progfunc, wim->progctx);
        if (ret)
-               goto out_free_old_table;
+               return ret;
 
        new_table_size = new_table->size;
 
@@ -364,15 +321,14 @@ write_integrity_table(WIMStruct *wim,
 
        ret = write_wim_resource_from_buffer(new_table,
                                             new_table_size,
-                                            0,
+                                            false,
                                             &wim->out_fd,
                                             WIMLIB_COMPRESSION_TYPE_NONE,
-                                            &wim->hdr.integrity,
+                                            0,
+                                            &wim->out_hdr.integrity_table_reshdr,
                                             NULL,
                                             0);
        FREE(new_table);
-out_free_old_table:
-       FREE(old_table);
        return ret;
 }
 
@@ -389,11 +345,7 @@ out_free_old_table:
  *
  * @bytes_to_check:
  *     Number of bytes in the WIM that need to be checked (offset of end of the
- *     lookup table minus offset of end of the header).
- *
- * @progress_func
- *     If non-NULL, a progress function that will be called after every
- *     verified chunk.
+ *     blob table minus offset of end of the header).
  *
  * Returns:
  *     > 0 (WIMLIB_ERR_READ, WIMLIB_ERR_UNEXPECTED_END_OF_FILE) on error
@@ -405,23 +357,25 @@ static int
 verify_integrity(struct filedes *in_fd, const tchar *filename,
                 const struct integrity_table *table,
                 u64 bytes_to_check,
-                wimlib_progress_func_t progress_func)
+                wimlib_progress_func_t progfunc, void *progctx)
 {
        int ret;
        u64 offset = WIM_HEADER_DISK_SIZE;
        u8 sha1_md[SHA1_HASH_SIZE];
        union wimlib_progress_info progress;
 
-       if (progress_func) {
-               progress.integrity.total_bytes      = bytes_to_check;
-               progress.integrity.total_chunks     = table->num_entries;
-               progress.integrity.completed_chunks = 0;
-               progress.integrity.completed_bytes  = 0;
-               progress.integrity.chunk_size       = table->chunk_size;
-               progress.integrity.filename         = filename;
-               progress_func(WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
-                             &progress);
-       }
+       progress.integrity.total_bytes      = bytes_to_check;
+       progress.integrity.total_chunks     = table->num_entries;
+       progress.integrity.completed_chunks = 0;
+       progress.integrity.completed_bytes  = 0;
+       progress.integrity.chunk_size       = table->chunk_size;
+       progress.integrity.filename         = filename;
+
+       ret = call_progress(progfunc, WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
+                           &progress, progctx);
+       if (ret)
+               return ret;
+
        for (u32 i = 0; i < table->num_entries; i++) {
                size_t this_chunk_size;
                if (i == table->num_entries - 1)
@@ -438,12 +392,13 @@ verify_integrity(struct filedes *in_fd, const tchar *filename,
                        return WIM_INTEGRITY_NOT_OK;
 
                offset += this_chunk_size;
-               if (progress_func) {
-                       progress.integrity.completed_chunks++;
-                       progress.integrity.completed_bytes += this_chunk_size;
-                       progress_func(WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
-                                     &progress);
-               }
+               progress.integrity.completed_chunks++;
+               progress.integrity.completed_bytes += this_chunk_size;
+
+               ret = call_progress(progfunc, WIMLIB_PROGRESS_MSG_VERIFY_INTEGRITY,
+                                   &progress, progctx);
+               if (ret)
+                       return ret;
        }
        return WIM_INTEGRITY_OK;
 }
@@ -459,10 +414,6 @@ verify_integrity(struct filedes *in_fd, const tchar *filename,
  * @wim:
  *     The WIM, opened for reading.
  *
- * @progress_func
- *     If non-NULL, a progress function that will be called after every
- *     verified chunk.
- *
  * Returns:
  *     > 0 (WIMLIB_ERR_INVALID_INTEGRITY_TABLE, WIMLIB_ERR_READ,
  *          WIMLIB_ERR_UNEXPECTED_END_OF_FILE) on error
@@ -473,33 +424,31 @@ verify_integrity(struct filedes *in_fd, const tchar *filename,
  *     information.
  */
 int
-check_wim_integrity(WIMStruct *wim, wimlib_progress_func_t progress_func)
+check_wim_integrity(WIMStruct *wim)
 {
        int ret;
        u64 bytes_to_check;
        struct integrity_table *table;
-       u64 end_lookup_table_offset;
+       u64 end_blob_table_offset;
 
-       if (wim->hdr.integrity.offset == 0) {
-               DEBUG("No integrity information.");
+       if (!wim_has_integrity_table(wim))
                return WIM_INTEGRITY_NONEXISTENT;
-       }
 
-       end_lookup_table_offset = wim->hdr.lookup_table_res_entry.offset +
-                                 wim->hdr.lookup_table_res_entry.size;
+       end_blob_table_offset = wim->hdr.blob_table_reshdr.offset_in_wim +
+                               wim->hdr.blob_table_reshdr.size_in_wim;
 
-       if (end_lookup_table_offset < WIM_HEADER_DISK_SIZE) {
-               ERROR("WIM lookup table ends before WIM header ends!");
+       if (end_blob_table_offset < WIM_HEADER_DISK_SIZE) {
+               ERROR("WIM blob table ends before WIM header ends!");
                return WIMLIB_ERR_INVALID_INTEGRITY_TABLE;
        }
 
-       bytes_to_check = end_lookup_table_offset - WIM_HEADER_DISK_SIZE;
+       bytes_to_check = end_blob_table_offset - WIM_HEADER_DISK_SIZE;
 
        ret = read_integrity_table(wim, bytes_to_check, &table);
        if (ret)
                return ret;
        ret = verify_integrity(&wim->in_fd, wim->filename, table,
-                              bytes_to_check, progress_func);
+                              bytes_to_check, wim->progfunc, wim->progctx);
        FREE(table);
        return ret;
 }