4 * Apply a WIM image directly to an NTFS volume using libntfs-3g. Restore as
5 * much information as possible, including security data, file attributes, DOS
6 * names, and alternate data streams.
8 * Note: because NTFS-3g offers inode-based interfaces, we actually don't need
9 * to deal with paths at all! (Other than for error messages.)
13 * Copyright (C) 2012, 2013, 2014, 2015 Eric Biggers
15 * This file is free software; you can redistribute it and/or modify it under
16 * the terms of the GNU Lesser General Public License as published by the Free
17 * Software Foundation; either version 3 of the License, or (at your option) any
20 * This file is distributed in the hope that it will be useful, but WITHOUT
21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
25 * You should have received a copy of the GNU Lesser General Public License
26 * along with this file; if not, see http://www.gnu.org/licenses/.
37 #include <ntfs-3g/attrib.h>
38 #include <ntfs-3g/reparse.h>
39 #include <ntfs-3g/security.h>
41 #include "wimlib/assert.h"
42 #include "wimlib/apply.h"
43 #include "wimlib/blob_table.h"
44 #include "wimlib/dentry.h"
45 #include "wimlib/encoding.h"
46 #include "wimlib/error.h"
47 #include "wimlib/metadata.h"
48 #include "wimlib/ntfs_3g.h"
49 #include "wimlib/reparse.h"
50 #include "wimlib/security.h"
51 #include "wimlib/security_descriptor.h"
54 ntfs_3g_get_supported_features(const char *target,
55 struct wim_features *supported_features)
57 supported_features->archive_files = 1;
58 supported_features->hidden_files = 1;
59 supported_features->system_files = 1;
60 supported_features->compressed_files = 1;
61 supported_features->not_context_indexed_files = 1;
62 supported_features->named_data_streams = 1;
63 supported_features->hard_links = 1;
64 supported_features->reparse_points = 1;
65 supported_features->security_descriptors = 1;
66 supported_features->short_names = 1;
67 supported_features->timestamps = 1;
68 supported_features->case_sensitive_filenames = 1;
72 struct ntfs_3g_apply_ctx {
73 /* Extract flags, the pointer to the WIMStruct, etc. */
74 struct apply_ctx common;
76 /* Pointer to the open NTFS volume */
79 ntfs_attr *open_attrs[MAX_OPEN_FILES];
80 unsigned num_open_attrs;
81 ntfs_inode *open_inodes[MAX_OPEN_FILES];
82 unsigned num_open_inodes;
84 struct reparse_buffer_disk rpbuf;
87 /* Offset in the blob currently being read */
90 unsigned num_reparse_inodes;
91 ntfs_inode *ntfs_reparse_inodes[MAX_OPEN_FILES];
92 struct wim_inode *wim_reparse_inodes[MAX_OPEN_FILES];
96 sid_size(const wimlib_SID *sid)
98 return offsetof(wimlib_SID, sub_authority) +
99 sizeof(le32) * sid->sub_authority_count;
103 * sd_fixup - Fix up a Windows NT security descriptor for libntfs-3g.
105 * libntfs-3g validates security descriptors before setting them, but old
106 * versions contain bugs causing it to reject unusual but valid security
109 * - Versions before 2013.1.13 reject security descriptors ending with an empty
110 * SACL (System Access Control List). This bug can be worked around either by
111 * moving the empty SACL earlier in the security descriptor or by removing the
112 * SACL entirely. The latter work-around is valid because an empty SACL is
113 * equivalent to a "null", or non-existent, SACL.
114 * - Versions before 2014.2.15 reject security descriptors ending with an empty
115 * DACL (Discretionary Access Control List). This is very similar to the SACL
116 * bug. However, removing the DACL is not a valid workaround because this
117 * changes the meaning of the security descriptor--- an empty DACL allows no
118 * access, whereas a "null" DACL allows all access.
120 * If the security descriptor was fixed, this function returns an allocated
121 * buffer containing the fixed security descriptor, and its size is updated.
122 * Otherwise (or if no memory is available) NULL is returned.
125 sd_fixup(const void *_desc, size_t *size_p)
127 u32 owner_offset, group_offset, dacl_offset, sacl_offset;
128 bool owner_valid, group_valid;
129 size_t size = *size_p;
130 const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc = _desc;
131 wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
132 const wimlib_SID *owner, *group, *sid;
134 /* Don't attempt to fix clearly invalid security descriptors. */
135 if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
138 if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
139 dacl_offset = le32_to_cpu(desc->dacl_offset);
143 if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
144 sacl_offset = le32_to_cpu(desc->sacl_offset);
148 /* Check if the security descriptor will be affected by one of the bugs.
149 * If not, do nothing and return. */
150 if (!((sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
151 (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
154 owner_offset = le32_to_cpu(desc->owner_offset);
155 group_offset = le32_to_cpu(desc->group_offset);
156 owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
157 group = (const wimlib_SID*)((const u8*)desc + group_offset);
159 /* We'll try to move the owner or group SID to the end of the security
160 * descriptor to avoid the bug. This is only possible if at least one
162 owner_valid = (owner_offset != 0) &&
163 (owner_offset % 4 == 0) &&
164 (owner_offset <= size - sizeof(SID)) &&
165 (owner_offset + sid_size(owner) <= size) &&
166 (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
167 group_valid = (group_offset != 0) &&
168 (group_offset % 4 == 0) &&
169 (group_offset <= size - sizeof(SID)) &&
170 (group_offset + sid_size(group) <= size) &&
171 (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
174 } else if (group_valid) {
180 desc_new = MALLOC(size + sid_size(sid));
184 memcpy(desc_new, desc, size);
186 desc_new->owner_offset = cpu_to_le32(size);
187 else if (group_valid)
188 desc_new->group_offset = cpu_to_le32(size);
189 memcpy((u8*)desc_new + size, sid, sid_size(sid));
190 *size_p = size + sid_size(sid);
194 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
197 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
199 struct SECURITY_CONTEXT sec_ctx;
200 void *desc_fixed = NULL;
203 memset(&sec_ctx, 0, sizeof(sec_ctx));
204 sec_ctx.vol = ni->vol;
207 if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc, desc_size, 0)) {
208 if (desc_fixed == NULL) {
209 desc_fixed = sd_fixup(desc, &desc_size);
210 if (desc_fixed != NULL) {
215 ret = WIMLIB_ERR_SET_SECURITY;
223 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
226 inode->i_creation_time,
227 inode->i_last_write_time,
228 inode->i_last_access_time,
231 if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
232 return WIMLIB_ERR_SET_TIMESTAMPS;
236 /* Restore the timestamps on the NTFS inode corresponding to @inode. */
238 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
243 ni = ntfs_inode_open(vol, inode->i_mft_no);
247 res = ntfs_3g_set_timestamps(ni, inode);
249 if (ntfs_inode_close(ni) || res)
255 ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
256 dentry_full_path(inode_first_extraction_dentry(inode)));
257 return WIMLIB_ERR_SET_TIMESTAMPS;
260 /* Restore the DOS name of the @dentry.
261 * This closes both @ni and @dir_ni.
262 * If either is NULL, then they are opened temporarily. */
264 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
265 struct wim_dentry *dentry, ntfs_volume *vol)
268 const char *dos_name;
269 size_t dos_name_nbytes;
271 /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
272 * And it takes in a multibyte string, even though it translates it to
273 * UTF-16LE internally... which is annoying because we currently have
274 * the UTF-16LE string but not the multibyte string. */
276 ret = utf16le_get_tstr(dentry->d_short_name, dentry->d_short_name_nbytes,
277 &dos_name, &dos_name_nbytes);
282 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
284 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
286 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
287 dos_name, dos_name_nbytes, 0);
293 utf16le_put_tstr(dos_name);
295 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
296 "volume", dentry_full_path(dentry));
297 ret = WIMLIB_ERR_SET_SHORT_NAME;
301 /* Unlike most other NTFS-3g functions, ntfs_set_ntfs_dos_name()
302 * changes the directory's last modification timestamp...
304 return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
307 /* ntfs_inode_close() can take a NULL argument, but it's probably best
308 * not to rely on this behavior. */
310 ntfs_inode_close(ni);
312 ntfs_inode_close(dir_ni);
317 ntfs_3g_restore_reparse_point(ntfs_inode *ni, const struct wim_inode *inode,
318 unsigned blob_size, struct ntfs_3g_apply_ctx *ctx)
320 complete_reparse_point(&ctx->rpbuf, inode, blob_size);
322 if (ntfs_set_ntfs_reparse_data(ni, (const char *)&ctx->rpbuf,
323 REPARSE_DATA_OFFSET + blob_size, 0))
325 ERROR_WITH_ERRNO("Failed to set reparse data on \"%s\"",
327 inode_first_extraction_dentry(inode)));
328 return WIMLIB_ERR_SET_REPARSE_DATA;
335 ntfs_3g_has_empty_attributes(const struct wim_inode *inode)
337 for (unsigned i = 0; i < inode->i_num_streams; i++) {
338 const struct wim_inode_stream *strm = &inode->i_streams[i];
340 if (stream_blob_resolved(strm) == NULL &&
341 (strm->stream_type == STREAM_TYPE_REPARSE_POINT ||
342 stream_is_named_data_stream(strm)))
349 * Create empty attributes (named data streams and potentially a reparse point)
350 * for the specified file, if there are any.
352 * Since these won't have blob descriptors, they won't show up in the call to
353 * extract_blob_list(). Hence the need for the special case.
355 * Keep this in sync with ntfs_3g_has_empty_attributes()!
358 ntfs_3g_create_empty_attributes(ntfs_inode *ni,
359 const struct wim_inode *inode,
360 struct ntfs_3g_apply_ctx *ctx)
362 for (unsigned i = 0; i < inode->i_num_streams; i++) {
364 const struct wim_inode_stream *strm = &inode->i_streams[i];
367 if (stream_blob_resolved(strm) != NULL)
370 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT) {
371 ret = ntfs_3g_restore_reparse_point(ni, inode, 0, ctx);
374 } else if (stream_is_named_data_stream(strm)) {
375 if (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
376 utf16le_len_chars(strm->stream_name),
379 ERROR_WITH_ERRNO("Failed to create named data "
382 inode_first_extraction_dentry(inode)));
383 return WIMLIB_ERR_NTFS_3G;
390 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
393 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
394 const struct ntfs_3g_apply_ctx *ctx)
397 const struct wim_security_data *sd;
398 struct wim_dentry *one_dentry;
401 extract_flags = ctx->common.extract_flags;
402 sd = wim_get_current_security_data(ctx->common.wim);
403 one_dentry = inode_first_extraction_dentry(inode);
406 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
407 u32 attrib = inode->i_attributes;
409 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
410 FILE_ATTRIBUTE_ENCRYPTED);
412 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
415 ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
417 dentry_full_path(one_dentry));
418 return WIMLIB_ERR_SET_ATTRIBUTES;
422 /* Security descriptor */
423 if (inode_has_security_descriptor(inode)
424 && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
429 desc = sd->descriptors[inode->i_security_id];
430 desc_size = sd->sizes[inode->i_security_id];
432 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
436 ERROR_WITH_ERRNO("Failed to set security descriptor on "
437 "\"%s\" in NTFS volume",
438 dentry_full_path(one_dentry));
439 if (err == EINVAL && wimlib_print_errors) {
440 fprintf(wimlib_error_file,
441 "The security descriptor is: ");
442 print_byte_field(desc, desc_size, wimlib_error_file);
443 fprintf(wimlib_error_file, "\n");
444 fprintf(wimlib_error_file,
445 "\nThis error occurred because libntfs-3g thinks "
446 "the security descriptor is invalid. If you "
447 "are extracting a Windows 10 image, this may be "
448 "caused by a known bug in libntfs-3g. See: "
449 "http://wimlib.net/forums/viewtopic.php?f=1&t=4 "
450 "for more information.\n\n");
457 ret = ntfs_3g_set_timestamps(ni, inode);
459 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
461 dentry_full_path(one_dentry));
467 /* Recursively creates all the subdirectories of @dir, which has been created as
468 * the NTFS inode @dir_ni. */
470 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
471 struct ntfs_3g_apply_ctx *ctx)
473 struct wim_dentry *child;
475 for_dentry_child(child, dir) {
479 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
481 if (!will_extract_dentry(child))
484 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
485 child->d_extraction_name_nchars, S_IFDIR);
487 ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
488 dentry_full_path(child));
489 return WIMLIB_ERR_NTFS_3G;
492 child->d_inode->i_mft_no = ni->mft_no;
494 ret = report_file_created(&ctx->common);
496 ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
498 ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
500 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
501 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
502 dentry_full_path(child));
503 ret = WIMLIB_ERR_NTFS_3G;
511 /* For each WIM dentry in the @root tree that represents a directory, create the
512 * corresponding directory in the NTFS volume @ctx->vol. */
514 ntfs_3g_create_directories(struct wim_dentry *root,
515 struct list_head *dentry_list,
516 struct ntfs_3g_apply_ctx *ctx)
520 struct wim_dentry *dentry;
522 /* Create the directories using POSIX names. */
524 root_ni = ntfs_inode_open(ctx->vol, FILE_root);
526 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
527 return WIMLIB_ERR_NTFS_3G;
530 root->d_inode->i_mft_no = FILE_root;
532 ret = ntfs_3g_set_metadata(root_ni, root->d_inode, ctx);
534 ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
536 if (ntfs_inode_close(root_ni) && !ret) {
537 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
538 ret = WIMLIB_ERR_NTFS_3G;
543 /* Set the DOS name of any directory that has one. In addition, create
544 * empty attributes for directories that have them. Note that creating
545 * an empty reparse point attribute must happen *after* setting the
546 * DOS name in order to work around a case where
547 * ntfs_set_ntfs_dos_name() fails with EOPNOTSUPP. */
548 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
549 const struct wim_inode *inode = dentry->d_inode;
551 if (!(inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
553 if (dentry_has_short_name(dentry)) {
554 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry,
558 ret = report_file_created(&ctx->common);
562 if (ntfs_3g_has_empty_attributes(inode)) {
565 ret = WIMLIB_ERR_NTFS_3G;
566 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
568 ret = ntfs_3g_create_empty_attributes(ni, inode,
570 if (ntfs_inode_close(ni) && !ret)
571 ret = WIMLIB_ERR_NTFS_3G;
574 ERROR_WITH_ERRNO("Failed to create empty "
575 "attributes of directory "
576 "\"%s\" in NTFS volume",
577 dentry_full_path(dentry));
585 /* When creating an inode that will have a short (DOS) name, we create it using
586 * the long name associated with the short name. This ensures that the short
587 * name gets associated with the correct long name. */
588 static struct wim_dentry *
589 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
591 struct wim_dentry *dentry;
593 inode_for_each_extraction_alias(dentry, inode)
594 if (dentry_has_short_name(dentry))
596 return inode_first_extraction_dentry(inode);
600 * Add a hard link for the NTFS inode @ni at the location corresponding to the
601 * WIM dentry @dentry.
603 * The parent directory must have already been created on the NTFS volume.
605 * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
608 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
613 /* Open the inode of the parent directory. */
614 dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
618 /* Create the link. */
619 res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
620 dentry->d_extraction_name_nchars);
622 /* Close the parent directory. */
623 if (ntfs_inode_close(dir_ni) || res)
629 ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
630 dentry_full_path(dentry));
631 return WIMLIB_ERR_NTFS_3G;
635 ntfs_3g_create_nondirectory(struct wim_inode *inode,
636 struct ntfs_3g_apply_ctx *ctx)
638 struct wim_dentry *first_dentry;
641 struct wim_dentry *dentry;
644 first_dentry = ntfs_3g_first_extraction_alias(inode);
646 /* Create first link. */
648 dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
650 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
651 dentry_full_path(first_dentry->d_parent));
652 return WIMLIB_ERR_NTFS_3G;
655 ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
656 first_dentry->d_extraction_name_nchars, S_IFREG);
659 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
660 dentry_full_path(first_dentry));
661 ntfs_inode_close(dir_ni);
662 return WIMLIB_ERR_NTFS_3G;
665 inode->i_mft_no = ni->mft_no;
667 /* Set short name if present. */
668 if (dentry_has_short_name(first_dentry)) {
670 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
672 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'. */
677 /* Reopen the inode. */
678 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
680 ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
682 dentry_full_path(first_dentry));
683 return WIMLIB_ERR_NTFS_3G;
686 /* Close the directory in which the first link was created. */
687 if (ntfs_inode_close(dir_ni)) {
688 ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
689 dentry_full_path(first_dentry->d_parent));
690 ret = WIMLIB_ERR_NTFS_3G;
695 /* Create additional links if present. */
696 inode_for_each_extraction_alias(dentry, inode) {
697 if (dentry != first_dentry) {
698 ret = ntfs_3g_add_link(ni, dentry);
705 ret = ntfs_3g_set_metadata(ni, inode, ctx);
709 ret = ntfs_3g_create_empty_attributes(ni, inode, ctx);
712 /* Close the inode. */
713 if (ntfs_inode_close(ni) && !ret) {
714 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
715 dentry_full_path(first_dentry));
716 ret = WIMLIB_ERR_NTFS_3G;
721 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
722 * create the corresponding nondirectory file in the NTFS volume.
724 * Directories must have already been created. */
726 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
727 struct ntfs_3g_apply_ctx *ctx)
729 struct wim_dentry *dentry;
730 struct wim_inode *inode;
733 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
734 inode = dentry->d_inode;
735 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
737 if (dentry == inode_first_extraction_dentry(inode)) {
738 ret = ntfs_3g_create_nondirectory(inode, ctx);
742 ret = report_file_created(&ctx->common);
750 ntfs_3g_begin_extract_blob_instance(struct blob_descriptor *blob,
752 struct wim_inode *inode,
753 const struct wim_inode_stream *strm,
754 struct ntfs_3g_apply_ctx *ctx)
756 struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
757 ntfschar *stream_name;
758 size_t stream_name_nchars;
761 if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
763 if (blob->size > REPARSE_DATA_MAX_SIZE) {
764 ERROR("Reparse data of \"%s\" has size "
765 "%"PRIu64" bytes (exceeds %u bytes)",
766 dentry_full_path(one_dentry),
767 blob->size, REPARSE_DATA_MAX_SIZE);
768 return WIMLIB_ERR_INVALID_REPARSE_DATA;
770 ctx->reparse_ptr = ctx->rpbuf.rpdata;
771 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
772 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
773 ctx->num_reparse_inodes++;
777 /* It's a data stream (may be unnamed or named). */
778 wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
780 if (unlikely(stream_is_named(strm))) {
781 stream_name = strm->stream_name;
782 stream_name_nchars = utf16le_len_chars(stream_name);
784 if (ntfs_attr_add(ni, AT_DATA, stream_name,
785 stream_name_nchars, NULL, 0))
787 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
788 dentry_full_path(one_dentry));
789 return WIMLIB_ERR_NTFS_3G;
792 /* Don't pass an empty string other than AT_UNNAMED to
793 * ntfs_attr_open() --- it violates assumptions made by
795 stream_name = AT_UNNAMED;
796 stream_name_nchars = 0;
799 /* This should be ensured by extract_blob_list() */
800 wimlib_assert(ctx->num_open_attrs < MAX_OPEN_FILES);
802 attr = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_nchars);
804 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
805 dentry_full_path(one_dentry));
806 return WIMLIB_ERR_NTFS_3G;
808 ctx->open_attrs[ctx->num_open_attrs++] = attr;
809 ntfs_attr_truncate_solid(attr, blob->size);
814 ntfs_3g_cleanup_blob_extract(struct ntfs_3g_apply_ctx *ctx)
818 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
819 if (ntfs_attr_pclose(ctx->open_attrs[i]))
821 ntfs_attr_close(ctx->open_attrs[i]);
824 ctx->num_open_attrs = 0;
826 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
827 if (ntfs_inode_close(ctx->open_inodes[i]))
830 ctx->num_open_inodes = 0;
833 ctx->reparse_ptr = NULL;
834 ctx->num_reparse_inodes = 0;
839 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
843 /* If the same blob is being extracted to multiple streams of the same
844 * inode, then we must only open the inode once. */
845 if (unlikely(inode->i_num_streams > 1)) {
846 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
847 if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
848 return ctx->open_inodes[i];
853 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
855 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
857 inode_first_extraction_dentry(inode)));
861 ctx->open_inodes[ctx->num_open_inodes++] = ni;
866 ntfs_3g_begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
868 struct ntfs_3g_apply_ctx *ctx = _ctx;
869 const struct blob_extraction_target *targets = blob_extraction_targets(blob);
873 for (u32 i = 0; i < blob->out_refcnt; i++) {
874 ret = WIMLIB_ERR_NTFS_3G;
875 ni = ntfs_3g_open_inode(targets[i].inode, ctx);
879 ret = ntfs_3g_begin_extract_blob_instance(blob, ni,
881 targets[i].stream, ctx);
889 ntfs_3g_cleanup_blob_extract(ctx);
894 /* Note: contrary to its documentation, ntfs_attr_pwrite() can return a short
895 * count in non-error cases --- specifically, when writing to a compressed
896 * attribute and the requested count exceeds the size of an NTFS "compression
897 * block". Therefore, we must continue calling ntfs_attr_pwrite() until all
898 * bytes have been written or a real error has occurred. */
900 ntfs_3g_full_pwrite(ntfs_attr *na, u64 offset, size_t size, const u8 *data)
903 s64 res = ntfs_attr_pwrite(na, offset, size, data);
904 if (unlikely(res <= 0))
906 wimlib_assert(res <= size);
915 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
917 struct ntfs_3g_apply_ctx *ctx = _ctx;
919 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
920 if (!ntfs_3g_full_pwrite(ctx->open_attrs[i],
921 ctx->offset, size, chunk))
923 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
924 return WIMLIB_ERR_NTFS_3G;
927 if (ctx->reparse_ptr)
928 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
934 ntfs_3g_end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
936 struct ntfs_3g_apply_ctx *ctx = _ctx;
944 for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
945 ret = ntfs_3g_restore_reparse_point(ctx->ntfs_reparse_inodes[i],
946 ctx->wim_reparse_inodes[i],
953 if (ntfs_3g_cleanup_blob_extract(ctx) && !ret) {
954 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
955 ret = WIMLIB_ERR_NTFS_3G;
961 ntfs_3g_count_dentries(const struct list_head *dentry_list)
963 const struct wim_dentry *dentry;
966 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
968 if ((dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) &&
969 dentry_has_short_name(dentry))
979 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
981 struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
983 struct wim_dentry *root;
986 /* For NTFS-3g extraction mode we require that the dentries to extract
987 * form a single tree. */
988 root = list_first_entry(dentry_list, struct wim_dentry,
989 d_extraction_list_node);
991 /* Mount the NTFS volume. */
992 vol = ntfs_mount(ctx->common.target, 0);
994 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3g",
996 return WIMLIB_ERR_NTFS_3G;
1000 /* Create all inodes and aliases, including short names, and set
1001 * metadata (attributes, security descriptors, and timestamps). */
1003 ret = start_file_structure_phase(&ctx->common,
1004 ntfs_3g_count_dentries(dentry_list));
1008 ret = ntfs_3g_create_directories(root, dentry_list, ctx);
1012 ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
1016 ret = end_file_structure_phase(&ctx->common);
1020 /* Extract blobs. */
1021 struct read_blob_callbacks cbs = {
1022 .begin_blob = ntfs_3g_begin_extract_blob,
1023 .consume_chunk = ntfs_3g_extract_chunk,
1024 .end_blob = ntfs_3g_end_extract_blob,
1027 ret = extract_blob_list(&ctx->common, &cbs);
1029 /* We do not need a final pass to set timestamps because libntfs-3g does
1030 * not update timestamps automatically (exception:
1031 * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere). */
1034 if (ntfs_umount(ctx->vol, FALSE) && !ret) {
1035 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3g",
1036 ctx->common.target);
1037 ret = WIMLIB_ERR_NTFS_3G;
1042 const struct apply_operations ntfs_3g_apply_ops = {
1044 .get_supported_features = ntfs_3g_get_supported_features,
1045 .extract = ntfs_3g_extract,
1046 .context_size = sizeof(struct ntfs_3g_apply_ctx),
1047 .single_tree_only = true,
1051 libntfs3g_global_init(void)
1053 ntfs_set_char_encoding(setlocale(LC_ALL, ""));