*/
/*
- * Copyright (C) 2012, 2013, 2014 Eric Biggers
+ * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
*
- * This file is part of wimlib, a library for working with WIM files.
+ * 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.
*
- * 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 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
#ifdef WITH_NTFS_3G
#include <errno.h>
-#include <stdlib.h>
-
-#ifdef HAVE_ALLOCA_H
-# include <alloca.h>
-#endif
#include <ntfs-3g/attrib.h>
#include <ntfs-3g/reparse.h>
#include <ntfs-3g/security.h>
#include <ntfs-3g/volume.h>
+#include "wimlib/alloca.h"
+#include "wimlib/assert.h"
+#include "wimlib/blob_table.h"
#include "wimlib/capture.h"
#include "wimlib/dentry.h"
#include "wimlib/encoding.h"
#include "wimlib/endianness.h"
#include "wimlib/error.h"
-#include "wimlib/lookup_table.h"
#include "wimlib/ntfs_3g.h"
#include "wimlib/paths.h"
+#include "wimlib/reparse.h"
#include "wimlib/security.h"
-static inline ntfschar *
-attr_record_name(ATTR_RECORD *ar)
+static inline const ntfschar *
+attr_record_name(const ATTR_RECORD *record)
{
- return (ntfschar*)((u8*)ar + le16_to_cpu(ar->name_offset));
+ return (const ntfschar *)
+ ((const u8 *)record + le16_to_cpu(record->name_offset));
}
static ntfs_attr *
-open_ntfs_attr(ntfs_inode *ni, struct ntfs_location *loc)
+open_ntfs_attr(ntfs_inode *ni, const struct ntfs_location *loc)
{
ntfs_attr *na;
na = ntfs_attr_open(ni,
- loc->is_reparse_point ? AT_REPARSE_POINT : AT_DATA,
- loc->stream_name,
- loc->stream_name_nchars);
+ (ATTR_TYPES)loc->attr_type,
+ loc->attr_name,
+ loc->attr_name_nchars);
if (!na) {
- ERROR_WITH_ERRNO("Failed to open attribute of \"%"TS"\" in "
- "NTFS volume", loc->path);
+ ERROR_WITH_ERRNO("Failed to open attribute of NTFS inode %"PRIu64,
+ loc->mft_no);
}
return na;
}
int
-read_ntfs_file_prefix(const struct wim_lookup_table_entry *lte, u64 size,
- consume_data_callback_t cb, void *cb_ctx)
+read_ntfs_attribute_prefix(const struct blob_descriptor *blob, u64 size,
+ consume_data_callback_t cb, void *cb_ctx)
{
- struct ntfs_location *loc = lte->ntfs_loc;
+ const struct ntfs_location *loc = blob->ntfs_loc;
ntfs_volume *vol = loc->ntfs_vol;
ntfs_inode *ni;
ntfs_attr *na;
int ret;
u8 buf[BUFFER_SIZE];
- ni = ntfs_pathname_to_inode(vol, NULL, loc->path);
+ ni = ntfs_inode_open(vol, loc->mft_no);
if (!ni) {
- ERROR_WITH_ERRNO("Can't find NTFS inode for \"%"TS"\"", loc->path);
+ ERROR_WITH_ERRNO("Failed to open NTFS inode %"PRIu64,
+ loc->mft_no);
ret = WIMLIB_ERR_NTFS_3G;
goto out;
}
goto out_close_ntfs_inode;
}
- pos = (loc->is_reparse_point) ? 8 : 0;
+ pos = (loc->attr_type == AT_REPARSE_POINT) ? REPARSE_DATA_OFFSET : 0;
bytes_remaining = size;
while (bytes_remaining) {
s64 to_read = min(bytes_remaining, sizeof(buf));
if (ntfs_attr_pread(na, pos, to_read, buf) != to_read) {
- ERROR_WITH_ERRNO("Error reading \"%"TS"\"", loc->path);
+ ERROR_WITH_ERRNO("Error reading data from NTFS inode "
+ "%"PRIu64, loc->mft_no);
ret = WIMLIB_ERR_NTFS_3G;
goto out_close_ntfs_attr;
}
}
-/* Load the streams from a file or reparse point in the NTFS volume */
static int
-capture_ntfs_streams(struct wim_inode *inode,
- ntfs_inode *ni,
- char *path,
- size_t path_len,
- struct list_head *unhashed_streams,
- ntfs_volume *vol,
- ATTR_TYPES type)
+attr_type_to_wimlib_stream_type(ATTR_TYPES type)
+{
+ switch (type) {
+ case AT_DATA:
+ return STREAM_TYPE_DATA;
+ case AT_REPARSE_POINT:
+ return STREAM_TYPE_REPARSE_POINT;
+ default:
+ wimlib_assert(0);
+ return STREAM_TYPE_UNKNOWN;
+ }
+}
+
+/* When sorting blobs located in NTFS volumes for sequential reading, we sort
+ * first by starting LCN of the attribute if available, otherwise no sort order
+ * is defined. This usually results in better sequential access to the volume.
+ */
+static int
+set_attr_sort_key(ntfs_inode *ni, struct ntfs_location *loc)
+{
+ ntfs_attr *na;
+ runlist_element *rl;
+
+ na = open_ntfs_attr(ni, loc);
+ if (!na)
+ return WIMLIB_ERR_NTFS_3G;
+
+ rl = ntfs_attr_find_vcn(na, 0);
+ if (rl && rl->lcn != LCN_HOLE)
+ loc->sort_key = rl->lcn;
+ else
+ loc->sort_key = 0;
+
+ ntfs_attr_close(na);
+ return 0;
+}
+
+/* Save information about an NTFS attribute (stream) to a WIM inode. */
+static int
+scan_ntfs_attr(struct wim_inode *inode,
+ ntfs_inode *ni,
+ const char *path,
+ size_t path_len,
+ struct list_head *unhashed_blobs,
+ ntfs_volume *vol,
+ ATTR_TYPES type,
+ const ATTR_RECORD *record)
+{
+ const u64 data_size = ntfs_get_attribute_value_length(record);
+ const size_t name_nchars = record->name_length;
+ struct blob_descriptor *blob = NULL;
+ utf16lechar *stream_name = NULL;
+ struct wim_inode_stream *strm;
+ int ret;
+
+ if (unlikely(name_nchars)) {
+ /* Named stream */
+ stream_name = utf16le_dupz(attr_record_name(record),
+ name_nchars * sizeof(ntfschar));
+ if (!stream_name) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_cleanup;
+ }
+ }
+
+ /* If the stream is non-empty, set up a blob descriptor for it. */
+ if (data_size != 0) {
+ blob = new_blob_descriptor();
+ if (unlikely(!blob)) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_cleanup;
+ }
+
+ blob->ntfs_loc = CALLOC(1, sizeof(struct ntfs_location));
+ if (unlikely(!blob->ntfs_loc)) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_cleanup;
+ }
+
+ blob->blob_location = BLOB_IN_NTFS_VOLUME;
+ blob->size = data_size;
+ blob->ntfs_loc->ntfs_vol = vol;
+ blob->ntfs_loc->attr_type = type;
+ blob->ntfs_loc->mft_no = ni->mft_no;
+
+ if (unlikely(name_nchars)) {
+ blob->ntfs_loc->attr_name = utf16le_dup(stream_name);
+ if (!blob->ntfs_loc->attr_name) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_cleanup;
+ }
+ blob->ntfs_loc->attr_name_nchars = name_nchars;
+ }
+
+ ret = set_attr_sort_key(ni, blob->ntfs_loc);
+ if (ret)
+ goto out_cleanup;
+
+ if (unlikely(type == AT_REPARSE_POINT)) {
+ if (blob->size < REPARSE_DATA_OFFSET) {
+ ERROR("Reparse data of \"%s\" "
+ "is invalid (only %"PRIu64" bytes)!",
+ path, data_size);
+ ret = WIMLIB_ERR_INVALID_REPARSE_DATA;
+ goto out_cleanup;
+ }
+ blob->size -= REPARSE_DATA_OFFSET;
+ ret = read_reparse_tag(ni, blob->ntfs_loc,
+ &inode->i_reparse_tag);
+ if (ret)
+ goto out_cleanup;
+ }
+ }
+
+ strm = inode_add_stream(inode,
+ attr_type_to_wimlib_stream_type(type),
+ stream_name ? stream_name : NO_STREAM_NAME,
+ blob);
+ if (unlikely(!strm)) {
+ ret = WIMLIB_ERR_NOMEM;
+ goto out_cleanup;
+ }
+ prepare_unhashed_blob(blob, inode, strm->stream_id, unhashed_blobs);
+ blob = NULL;
+ ret = 0;
+out_cleanup:
+ free_blob_descriptor(blob);
+ FREE(stream_name);
+ return ret;
+}
+
+/* Scan attributes of the specified type from a file in the NTFS volume */
+static int
+scan_ntfs_attrs_with_type(struct wim_inode *inode,
+ ntfs_inode *ni,
+ char *path,
+ size_t path_len,
+ struct list_head *unhashed_blobs,
+ ntfs_volume *vol,
+ ATTR_TYPES type)
{
ntfs_attr_search_ctx *actx;
- struct ntfs_location *ntfs_loc;
int ret;
- struct wim_lookup_table_entry *lte;
- DEBUG("Capturing NTFS data streams from `%s'", path);
+ DEBUG("Scanning NTFS attributes from \"%s\"", path);
- /* Get context to search the streams of the NTFS file. */
actx = ntfs_attr_get_search_ctx(ni, NULL);
if (!actx) {
- ERROR_WITH_ERRNO("Cannot get NTFS attribute search "
+ ERROR_WITH_ERRNO("Failed to get NTFS attribute search "
"context for \"%s\"", path);
return WIMLIB_ERR_NTFS_3G;
}
- /* Capture each data stream or reparse data stream. */
while (!ntfs_attr_lookup(type, NULL, 0,
CASE_SENSITIVE, 0, NULL, 0, actx))
{
- u64 data_size = ntfs_get_attribute_value_length(actx->attr);
- u64 name_length = actx->attr->name_length;
- u32 stream_id;
-
- if (data_size == 0) {
- /* Empty stream. No lookup table entry is needed. */
- lte = NULL;
- ntfs_loc = NULL;
- } else {
- ntfs_loc = CALLOC(1, sizeof(*ntfs_loc));
- if (!ntfs_loc) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_put_actx;
- }
- ntfs_loc->ntfs_vol = vol;
- ntfs_loc->path = memdup(path, path_len + 1);
- if (!ntfs_loc->path) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_ntfs_loc;
- }
- if (name_length) {
- ntfs_loc->stream_name = memdup(attr_record_name(actx->attr),
- name_length * 2);
- if (!ntfs_loc->stream_name) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_ntfs_loc;
- }
- ntfs_loc->stream_name_nchars = name_length;
- }
-
- lte = new_lookup_table_entry();
- if (!lte) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_ntfs_loc;
- }
- lte->resource_location = RESOURCE_IN_NTFS_VOLUME;
- lte->ntfs_loc = ntfs_loc;
- ntfs_loc = NULL;
- if (type == AT_REPARSE_POINT) {
- if (data_size < 8) {
- ERROR("Invalid reparse data on \"%s\" "
- "(only %u bytes)!", path, (unsigned)data_size);
- ret = WIMLIB_ERR_NTFS_3G;
- goto out_free_lte;
- }
- lte->ntfs_loc->is_reparse_point = true;
- lte->size = data_size - 8;
- ret = read_reparse_tag(ni, lte->ntfs_loc,
- &inode->i_reparse_tag);
- if (ret)
- goto out_free_lte;
- } else {
- lte->ntfs_loc->is_reparse_point = false;
- lte->size = data_size;
- }
- }
- if (name_length == 0) {
- /* Unnamed data stream. Put the reference to it in the
- * dentry's inode. */
- if (inode->i_lte) {
- if (lte) {
- if (!(inode->i_attributes &
- FILE_ATTRIBUTE_REPARSE_POINT))
- {
- WARNING("Found two un-named "
- "data streams for \"%s\" "
- "(sizes = %"PRIu64", "
- "%"PRIu64")",
- path,
- inode->i_lte->size,
- lte->size);
- }
- free_lookup_table_entry(lte);
- continue;
- }
- } else {
- stream_id = 0;
- inode->i_lte = lte;
- }
- } else {
- /* Named data stream. Put the reference to it in the
- * alternate data stream entries */
- struct wim_ads_entry *new_ads_entry;
-
- new_ads_entry = inode_add_ads_utf16le(inode,
- attr_record_name(actx->attr),
- name_length * 2);
- if (!new_ads_entry) {
- ret = WIMLIB_ERR_NOMEM;
- goto out_free_lte;
- }
- wimlib_assert(new_ads_entry->stream_name_nbytes == name_length * 2);
- stream_id = new_ads_entry->stream_id;
- new_ads_entry->lte = lte;
- }
- if (lte) {
- add_unhashed_stream(lte, inode,
- stream_id, unhashed_streams);
- }
+ ret = scan_ntfs_attr(inode,
+ ni,
+ path,
+ path_len,
+ unhashed_blobs,
+ vol,
+ type,
+ actx->attr);
+ if (ret)
+ goto out_put_actx;
}
- if (errno == ENOENT) {
- ret = 0;
- } else {
+ if (errno != ENOENT) {
ERROR_WITH_ERRNO("Error listing NTFS attributes of \"%s\"", path);
ret = WIMLIB_ERR_NTFS_3G;
+ goto out_put_actx;
}
- goto out_put_actx;
-out_free_lte:
- free_lookup_table_entry(lte);
-out_free_ntfs_loc:
- if (ntfs_loc) {
- FREE(ntfs_loc->path);
- FREE(ntfs_loc->stream_name);
- FREE(ntfs_loc);
- }
+ ret = 0;
out_put_actx:
ntfs_attr_put_search_ctx(actx);
- if (ret == 0)
- DEBUG("Successfully captured NTFS streams from \"%s\"", path);
- else
- ERROR("Failed to capture NTFS streams from \"%s\"", path);
return ret;
}
DEBUG("DOS name_len = %zu", name_nbytes);
new_node = MALLOC(sizeof(struct dos_name_node));
if (!new_node)
- return -1;
+ return WIMLIB_ERR_NOMEM;
/* DOS names are supposed to be 12 characters max (that's 24 bytes,
* assuming 2-byte ntfs characters) */
ERROR("NTFS inode %"PRIu64" has multiple DOS names",
le64_to_cpu(ntfs_ino));
FREE(new_node);
- return -1;
+ return WIMLIB_ERR_NOMEM;
}
DEBUG("Inserted DOS name for inode %"PRIu64, le64_to_cpu(ntfs_ino));
return 0;
if (dentry->is_win32_name) {
node = lookup_dos_name(map, dentry->d_inode->i_ino);
if (node) {
- dentry->short_name = utf16le_dupz((const utf16lechar *)node->dos_name,
+ dentry->short_name = utf16le_dupz(node->dos_name,
node->name_nbytes);
if (!dentry->short_name)
return WIMLIB_ERR_NOMEM;
size_t path_len;
struct dos_name_map *dos_name_map;
ntfs_volume *vol;
- struct add_image_params *params;
+ struct capture_params *params;
+ int ret;
};
static int
size_t path_len,
int name_type,
ntfs_volume *ntfs_vol,
- struct add_image_params *params);
+ struct capture_params *params);
static int
wim_ntfs_capture_filldir(void *dirent, const ntfschar *name,
FREE(mbs_name);
out:
ctx->path[ctx->path_len] = '\0';
+ ctx->ret = ret;
return ret;
}
-/* Recursively build a WIM dentry tree corresponding to an NTFS volume.
- * At the same time, update the WIM lookup table with lookup table entries for
- * the NTFS streams, and build an array of security descriptors.
- */
+/* Recursive scan routine for NTFS volumes */
static int
build_dentry_tree_ntfs_recursive(struct wim_dentry **root_ret,
ntfs_inode *ni,
size_t path_len,
int name_type,
ntfs_volume *vol,
- struct add_image_params *params)
+ struct capture_params *params)
{
- le32 attributes;
+ u32 attributes;
int ret;
struct wim_dentry *root = NULL;
struct wim_inode *inode = NULL;
- if (should_exclude_path(path, path_len, params->config)) {
- /* Exclude a file or directory tree based on the capture
- * configuration file. */
- ret = 0;
+ ret = try_exclude(path, path_len, params);
+ if (ret < 0) /* Excluded? */
goto out_progress;
- }
+ if (ret > 0) /* Error? */
+ goto out;
/* Get file attributes */
ret = ntfs_get_ntfs_attrib(ni, (char*)&attributes, sizeof(attributes));
goto out;
}
- if ((attributes & (FILE_ATTRIBUTE_DIRECTORY |
- FILE_ATTRIBUTE_ENCRYPTED)) == FILE_ATTRIBUTE_ENCRYPTED)
- {
+ if (attributes & FILE_ATTRIBUTE_ENCRYPTED) {
if (params->add_flags & WIMLIB_ADD_FLAG_NO_UNSUPPORTED_EXCLUDE)
{
- ERROR("Can't archive unsupported encrypted file \"%s\"", path);
+ ERROR("Can't archive \"%s\" because NTFS-3g capture mode "
+ "does not support encrypted files and directories", path);
ret = WIMLIB_ERR_UNSUPPORTED_FILE;
goto out;
}
if (inode->i_nlink > 1) {
/* Shared inode; nothing more to do */
- ret = 0;
goto out_progress;
}
inode->i_creation_time = le64_to_cpu(ni->creation_time);
inode->i_last_write_time = le64_to_cpu(ni->last_data_change_time);
inode->i_last_access_time = le64_to_cpu(ni->last_access_time);
- inode->i_attributes = le32_to_cpu(attributes);
- inode->i_resolved = 1;
-
- /* Capture streams. */
+ inode->i_attributes = attributes;
- if (attributes & FILE_ATTR_REPARSE_POINT) {
- /* Capture reparse data stream. */
- ret = capture_ntfs_streams(inode, ni, path, path_len,
- params->unhashed_streams,
- vol, AT_REPARSE_POINT);
+ if (attributes & FILE_ATTRIBUTE_REPARSE_POINT) {
+ /* Scan the reparse point stream. */
+ ret = scan_ntfs_attrs_with_type(inode, ni, path, path_len,
+ params->unhashed_blobs,
+ vol, AT_REPARSE_POINT);
if (ret)
goto out;
}
- /* Capture data streams.
- *
- * Directories should not have an unnamed data stream, but they may have
- * named data streams.
+ /* Scan the data streams.
*
- * Reparse points may have an unnamed data stream (which will be ignored
- * in favor of the reparse data stream), and they also may have named
- * data streams.
- *
- * Regular files can have an unnamed data stream as well as named data
+ * Note: directories should not have an unnamed data stream, but they
+ * may have named data streams. Nondirectories (including reparse
+ * points) can have an unnamed data stream as well as named data
* streams. */
- ret = capture_ntfs_streams(inode, ni, path, path_len,
- params->unhashed_streams, vol, AT_DATA);
+ ret = scan_ntfs_attrs_with_type(inode, ni, path, path_len,
+ params->unhashed_blobs, vol, AT_DATA);
if (ret)
goto out;
- if (ni->mrec->flags & MFT_RECORD_IS_DIRECTORY) {
+ if (inode_is_directory(inode)) {
/* Recurse to directory children */
s64 pos = 0;
.dos_name_map = &dos_name_map,
.vol = vol,
.params = params,
+ .ret = 0,
};
ret = ntfs_readdir(ni, &pos, &ctx, wim_ntfs_capture_filldir);
if (ret) {
- ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
- ret = WIMLIB_ERR_NTFS_3G;
+ if (ctx.ret) {
+ /* wimlib error */
+ ret = ctx.ret;
+ } else {
+ /* error from ntfs_readdir() itself */
+ ERROR_WITH_ERRNO("Error reading directory \"%s\"", path);
+ ret = WIMLIB_ERR_NTFS_3G;
+ }
} else {
struct wim_dentry *child;
else
ret = do_capture_progress(params, WIMLIB_SCAN_DENTRY_OK, inode);
out:
- if (ret == 0)
- *root_ret = root;
- else
- free_dentry_tree(root, params->lookup_table);
+ if (unlikely(ret)) {
+ free_dentry_tree(root, params->blob_table);
+ root = NULL;
+ ret = report_capture_error(params, ret, path);
+ }
+ *root_ret = root;
return ret;
}
int
build_dentry_tree_ntfs(struct wim_dentry **root_p,
const char *device,
- struct add_image_params *params)
+ struct capture_params *params)
{
ntfs_volume *vol;
ntfs_inode *root_ni;
if (do_ntfs_umount(vol)) {
ERROR_WITH_ERRNO("Failed to unmount NTFS volume `%s'",
device);
- if (ret == 0)
- ret = WIMLIB_ERR_NTFS_3G;
}
} else {
/* We need to leave the NTFS volume mounted so that we can read
git://wimlib.net / wimlib / blobdiff