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/.
36 #include <ntfs-3g/attrib.h>
37 #include <ntfs-3g/reparse.h>
38 #include <ntfs-3g/security.h>
40 #include "wimlib/assert.h"
41 #include "wimlib/apply.h"
42 #include "wimlib/blob_table.h"
43 #include "wimlib/dentry.h"
44 #include "wimlib/encoding.h"
45 #include "wimlib/error.h"
46 #include "wimlib/metadata.h"
47 #include "wimlib/ntfs_3g.h"
48 #include "wimlib/reparse.h"
49 #include "wimlib/security.h"
50 #include "wimlib/security_descriptor.h"
53 ntfs_3g_get_supported_features(const char *target,
54 struct wim_features *supported_features)
56 supported_features->archive_files = 1;
57 supported_features->hidden_files = 1;
58 supported_features->system_files = 1;
59 supported_features->compressed_files = 1;
60 supported_features->not_context_indexed_files = 1;
61 supported_features->named_data_streams = 1;
62 supported_features->hard_links = 1;
63 supported_features->reparse_points = 1;
64 supported_features->security_descriptors = 1;
65 supported_features->short_names = 1;
66 supported_features->timestamps = 1;
67 supported_features->case_sensitive_filenames = 1;
71 struct ntfs_3g_apply_ctx {
72 /* Extract flags, the pointer to the WIMStruct, etc. */
73 struct apply_ctx common;
75 /* Pointer to the open NTFS volume */
78 ntfs_attr *open_attrs[MAX_OPEN_FILES];
79 unsigned num_open_attrs;
80 ntfs_inode *open_inodes[MAX_OPEN_FILES];
81 unsigned num_open_inodes;
83 struct reparse_buffer_disk rpbuf;
86 /* Offset in the blob currently being read */
89 unsigned num_reparse_inodes;
90 ntfs_inode *ntfs_reparse_inodes[MAX_OPEN_FILES];
91 struct wim_inode *wim_reparse_inodes[MAX_OPEN_FILES];
95 sid_size(const wimlib_SID *sid)
97 return offsetof(wimlib_SID, sub_authority) +
98 sizeof(le32) * sid->sub_authority_count;
102 * sd_fixup - Fix up a Windows NT security descriptor for libntfs-3g.
104 * libntfs-3g validates security descriptors before setting them, but old
105 * versions contain bugs causing it to reject unusual but valid security
108 * - Versions before 2013.1.13 reject security descriptors ending with an empty
109 * SACL (System Access Control List). This bug can be worked around either by
110 * moving the empty SACL earlier in the security descriptor or by removing the
111 * SACL entirely. The latter work-around is valid because an empty SACL is
112 * equivalent to a "null", or non-existent, SACL.
113 * - Versions up to and including 2013.1.13 reject security descriptors ending
114 * with an empty DACL (Discretionary Access Control List). This is very
115 * similar to the SACL bug and should be fixed in the next release after
116 * 2013.1.13. However, removing the DACL is not a valid workaround because
117 * this changes the meaning of the security descriptor--- an empty DACL allows
118 * no 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) the original descriptor is returned.
125 sd_fixup(const u8 *_desc, size_t *size_p)
127 u32 owner_offset, group_offset, dacl_offset;
128 #if !defined(HAVE_NTFS_MNT_RDONLY)
131 bool owner_valid, group_valid;
132 size_t size = *size_p;
133 const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc =
134 (const wimlib_SECURITY_DESCRIPTOR_RELATIVE*)_desc;
135 wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
136 const wimlib_SID *owner, *group, *sid;
138 /* Don't attempt to fix clearly invalid security descriptors. */
139 if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
142 if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
143 dacl_offset = le32_to_cpu(desc->dacl_offset);
147 #if !defined(HAVE_NTFS_MNT_RDONLY)
148 if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
149 sacl_offset = le32_to_cpu(desc->sacl_offset);
154 /* Check if the security descriptor will be affected by one of the bugs.
155 * If not, do nothing and return.
157 * Note: HAVE_NTFS_MNT_RDONLY is defined if libntfs-3g is
158 * version 2013.1.13 or later. */
160 #if !defined(HAVE_NTFS_MNT_RDONLY)
161 (sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
163 (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
166 owner_offset = le32_to_cpu(desc->owner_offset);
167 group_offset = le32_to_cpu(desc->group_offset);
168 owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
169 group = (const wimlib_SID*)((const u8*)desc + group_offset);
171 /* We'll try to move the owner or group SID to the end of the security
172 * descriptor to avoid the bug. This is only possible if at least one
174 owner_valid = (owner_offset != 0) &&
175 (owner_offset % 4 == 0) &&
176 (owner_offset <= size - sizeof(SID)) &&
177 (owner_offset + sid_size(owner) <= size) &&
178 (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
179 group_valid = (group_offset != 0) &&
180 (group_offset % 4 == 0) &&
181 (group_offset <= size - sizeof(SID)) &&
182 (group_offset + sid_size(group) <= size) &&
183 (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
186 } else if (group_valid) {
192 desc_new = MALLOC(size + sid_size(sid));
196 memcpy(desc_new, desc, size);
198 desc_new->owner_offset = cpu_to_le32(size);
199 else if (group_valid)
200 desc_new->group_offset = cpu_to_le32(size);
201 memcpy((u8*)desc_new + size, sid, sid_size(sid));
202 *size_p = size + sid_size(sid);
203 return (u8*)desc_new;
206 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
209 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
211 struct SECURITY_CONTEXT sec_ctx;
215 memset(&sec_ctx, 0, sizeof(sec_ctx));
216 sec_ctx.vol = ni->vol;
218 desc_fixed = sd_fixup(desc, &desc_size);
220 if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc_fixed, desc_size, 0))
221 ret = WIMLIB_ERR_SET_SECURITY;
223 if (desc_fixed != desc)
230 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
233 inode->i_creation_time,
234 inode->i_last_write_time,
235 inode->i_last_access_time,
238 if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
239 return WIMLIB_ERR_SET_TIMESTAMPS;
243 /* Restore the timestamps on the NTFS inode corresponding to @inode. */
245 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
250 ni = ntfs_inode_open(vol, inode->i_mft_no);
254 res = ntfs_3g_set_timestamps(ni, inode);
256 if (ntfs_inode_close(ni) || res)
262 ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
263 dentry_full_path(inode_first_extraction_dentry(inode)));
264 return WIMLIB_ERR_SET_TIMESTAMPS;
267 /* Restore the DOS name of the @dentry.
268 * This closes both @ni and @dir_ni.
269 * If either is NULL, then they are opened temporarily. */
271 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
272 struct wim_dentry *dentry, ntfs_volume *vol)
275 const char *dos_name;
276 size_t dos_name_nbytes;
278 /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
279 * And it takes in a multibyte string, even though it translates it to
280 * UTF-16LE internally... which is annoying because we currently have
281 * the UTF-16LE string but not the multibyte string. */
283 ret = utf16le_get_tstr(dentry->d_short_name, dentry->d_short_name_nbytes,
284 &dos_name, &dos_name_nbytes);
289 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
291 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
293 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
294 dos_name, dos_name_nbytes, 0);
300 utf16le_put_tstr(dos_name);
302 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
303 "volume", dentry_full_path(dentry));
304 ret = WIMLIB_ERR_SET_SHORT_NAME;
308 /* Unlike most other NTFS-3g functions, ntfs_set_ntfs_dos_name()
309 * changes the directory's last modification timestamp...
311 return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
314 /* ntfs_inode_close() can take a NULL argument, but it's probably best
315 * not to rely on this behavior. */
317 ntfs_inode_close(ni);
319 ntfs_inode_close(dir_ni);
324 ntfs_3g_restore_reparse_point(ntfs_inode *ni, const struct wim_inode *inode,
325 unsigned blob_size, struct ntfs_3g_apply_ctx *ctx)
327 complete_reparse_point(&ctx->rpbuf, inode, blob_size);
329 if (ntfs_set_ntfs_reparse_data(ni, (const char *)&ctx->rpbuf,
330 REPARSE_DATA_OFFSET + blob_size, 0))
332 ERROR_WITH_ERRNO("Failed to set reparse data on \"%s\"",
334 inode_first_extraction_dentry(inode)));
335 return WIMLIB_ERR_SET_REPARSE_DATA;
343 * Create empty attributes (named data streams and potentially a reparse point)
344 * for the specified file, if there are any.
346 * Since these won't have blob descriptors, they won't show up in the call to
347 * extract_blob_list(). Hence the need for the special case.
350 ntfs_3g_create_empty_attributes(ntfs_inode *ni,
351 const struct wim_inode *inode,
352 struct ntfs_3g_apply_ctx *ctx)
355 for (unsigned i = 0; i < inode->i_num_streams; i++) {
357 const struct wim_inode_stream *strm = &inode->i_streams[i];
360 if (stream_blob_resolved(strm) != NULL)
363 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT) {
364 ret = ntfs_3g_restore_reparse_point(ni, inode, 0, ctx);
367 } else if (stream_is_named_data_stream(strm)) {
368 if (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
369 utf16le_len_chars(strm->stream_name),
372 ERROR_WITH_ERRNO("Failed to create named data "
375 inode_first_extraction_dentry(inode)));
376 return WIMLIB_ERR_NTFS_3G;
383 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
386 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
387 const struct ntfs_3g_apply_ctx *ctx)
390 const struct wim_security_data *sd;
391 struct wim_dentry *one_dentry;
394 extract_flags = ctx->common.extract_flags;
395 sd = wim_get_current_security_data(ctx->common.wim);
396 one_dentry = inode_first_extraction_dentry(inode);
399 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
400 u32 attrib = inode->i_attributes;
402 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
403 FILE_ATTRIBUTE_ENCRYPTED);
405 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
408 ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
410 dentry_full_path(one_dentry));
411 return WIMLIB_ERR_SET_ATTRIBUTES;
415 /* Security descriptor */
416 if (inode_has_security_descriptor(inode)
417 && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
422 desc = sd->descriptors[inode->i_security_id];
423 desc_size = sd->sizes[inode->i_security_id];
425 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
427 if (wimlib_print_errors) {
428 ERROR_WITH_ERRNO("Failed to set security descriptor "
429 "on \"%s\" in NTFS volume",
430 dentry_full_path(one_dentry));
431 fprintf(wimlib_error_file,
432 "The security descriptor is: ");
433 print_byte_field(desc, desc_size, wimlib_error_file);
434 fprintf(wimlib_error_file, "\n");
441 ret = ntfs_3g_set_timestamps(ni, inode);
443 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
445 dentry_full_path(one_dentry));
451 /* Recursively creates all the subdirectories of @dir, which has been created as
452 * the NTFS inode @dir_ni. */
454 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
455 struct ntfs_3g_apply_ctx *ctx)
457 struct wim_dentry *child;
459 for_dentry_child(child, dir) {
463 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
465 if (!will_extract_dentry(child))
468 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
469 child->d_extraction_name_nchars, S_IFDIR);
471 ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
472 dentry_full_path(child));
473 return WIMLIB_ERR_NTFS_3G;
476 child->d_inode->i_mft_no = ni->mft_no;
478 ret = report_file_created(&ctx->common);
480 ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
482 ret = ntfs_3g_create_empty_attributes(ni, child->d_inode, ctx);
484 ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
486 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
487 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
488 dentry_full_path(child));
489 ret = WIMLIB_ERR_NTFS_3G;
497 /* For each WIM dentry in the @root tree that represents a directory, create the
498 * corresponding directory in the NTFS volume @ctx->vol. */
500 ntfs_3g_create_directories(struct wim_dentry *root,
501 struct list_head *dentry_list,
502 struct ntfs_3g_apply_ctx *ctx)
506 struct wim_dentry *dentry;
508 /* Create the directories using POSIX names. */
510 root_ni = ntfs_inode_open(ctx->vol, FILE_root);
512 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
513 return WIMLIB_ERR_NTFS_3G;
516 root->d_inode->i_mft_no = FILE_root;
518 ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
520 if (ntfs_inode_close(root_ni) && !ret) {
521 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
522 ret = WIMLIB_ERR_NTFS_3G;
527 /* Set the DOS name of any directory that has one. */
528 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
529 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
531 if (!dentry_has_short_name(dentry))
533 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry, ctx->vol);
536 ret = report_file_created(&ctx->common);
543 /* When creating an inode that will have a short (DOS) name, we create it using
544 * the long name associated with the short name. This ensures that the short
545 * name gets associated with the correct long name. */
546 static struct wim_dentry *
547 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
549 struct wim_dentry *dentry;
551 inode_for_each_extraction_alias(dentry, inode)
552 if (dentry_has_short_name(dentry))
554 return inode_first_extraction_dentry(inode);
558 * Add a hard link for the NTFS inode @ni at the location corresponding to the
559 * WIM dentry @dentry.
561 * The parent directory must have already been created on the NTFS volume.
563 * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
566 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
571 /* Open the inode of the parent directory. */
572 dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
576 /* Create the link. */
577 res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
578 dentry->d_extraction_name_nchars);
580 /* Close the parent directory. */
581 if (ntfs_inode_close(dir_ni) || res)
587 ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
588 dentry_full_path(dentry));
589 return WIMLIB_ERR_NTFS_3G;
593 ntfs_3g_create_nondirectory(struct wim_inode *inode,
594 struct ntfs_3g_apply_ctx *ctx)
596 struct wim_dentry *first_dentry;
599 struct wim_dentry *dentry;
602 first_dentry = ntfs_3g_first_extraction_alias(inode);
604 /* Create first link. */
606 dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
608 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
609 dentry_full_path(first_dentry->d_parent));
610 return WIMLIB_ERR_NTFS_3G;
613 ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
614 first_dentry->d_extraction_name_nchars, S_IFREG);
617 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
618 dentry_full_path(first_dentry));
619 ntfs_inode_close(dir_ni);
620 return WIMLIB_ERR_NTFS_3G;
623 inode->i_mft_no = ni->mft_no;
625 /* Set short name if present. */
626 if (dentry_has_short_name(first_dentry)) {
628 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
630 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'. */
635 /* Reopen the inode. */
636 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
638 ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
640 dentry_full_path(first_dentry));
641 return WIMLIB_ERR_NTFS_3G;
644 /* Close the directory in which the first link was created. */
645 if (ntfs_inode_close(dir_ni)) {
646 ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
647 dentry_full_path(first_dentry->d_parent));
648 ret = WIMLIB_ERR_NTFS_3G;
653 /* Create additional links if present. */
654 inode_for_each_extraction_alias(dentry, inode) {
655 if (dentry != first_dentry) {
656 ret = ntfs_3g_add_link(ni, dentry);
663 ret = ntfs_3g_set_metadata(ni, inode, ctx);
667 ret = ntfs_3g_create_empty_attributes(ni, inode, ctx);
670 /* Close the inode. */
671 if (ntfs_inode_close(ni) && !ret) {
672 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
673 dentry_full_path(first_dentry));
674 ret = WIMLIB_ERR_NTFS_3G;
679 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
680 * create the corresponding nondirectory file in the NTFS volume.
682 * Directories must have already been created. */
684 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
685 struct ntfs_3g_apply_ctx *ctx)
687 struct wim_dentry *dentry;
688 struct wim_inode *inode;
691 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
692 inode = dentry->d_inode;
693 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
695 if (dentry == inode_first_extraction_dentry(inode)) {
696 ret = ntfs_3g_create_nondirectory(inode, ctx);
700 ret = report_file_created(&ctx->common);
708 ntfs_3g_begin_extract_blob_instance(struct blob_descriptor *blob,
710 struct wim_inode *inode,
711 const struct wim_inode_stream *strm,
712 struct ntfs_3g_apply_ctx *ctx)
714 struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
715 size_t stream_name_nchars;
718 if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
720 if (blob->size > REPARSE_DATA_MAX_SIZE) {
721 ERROR("Reparse data of \"%s\" has size "
722 "%"PRIu64" bytes (exceeds %u bytes)",
723 dentry_full_path(one_dentry),
724 blob->size, REPARSE_DATA_MAX_SIZE);
725 return WIMLIB_ERR_INVALID_REPARSE_DATA;
727 ctx->reparse_ptr = ctx->rpbuf.rpdata;
728 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
729 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
730 ctx->num_reparse_inodes++;
734 /* It's a data stream (may be unnamed or named). */
735 wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
737 stream_name_nchars = utf16le_len_chars(strm->stream_name);
739 if (stream_name_nchars &&
740 (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
741 stream_name_nchars, NULL, 0)))
743 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
744 dentry_full_path(one_dentry));
745 return WIMLIB_ERR_NTFS_3G;
748 /* This should be ensured by extract_blob_list() */
749 wimlib_assert(ctx->num_open_attrs < MAX_OPEN_FILES);
751 attr = ntfs_attr_open(ni, AT_DATA, strm->stream_name,
754 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
755 dentry_full_path(one_dentry));
756 return WIMLIB_ERR_NTFS_3G;
758 ctx->open_attrs[ctx->num_open_attrs++] = attr;
759 ntfs_attr_truncate_solid(attr, blob->size);
764 ntfs_3g_cleanup_blob_extract(struct ntfs_3g_apply_ctx *ctx)
768 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
769 if (ntfs_attr_pclose(ctx->open_attrs[i]))
771 ntfs_attr_close(ctx->open_attrs[i]);
774 ctx->num_open_attrs = 0;
776 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
777 if (ntfs_inode_close(ctx->open_inodes[i]))
780 ctx->num_open_inodes = 0;
783 ctx->reparse_ptr = NULL;
784 ctx->num_reparse_inodes = 0;
789 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
793 /* If the same blob is being extracted to multiple streams of the same
794 * inode, then we must only open the inode once. */
795 if (unlikely(inode->i_num_streams > 1)) {
796 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
797 if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
798 ni = ctx->open_inodes[i];
804 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
806 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
808 inode_first_extraction_dentry(inode)));
813 ctx->open_inodes[ctx->num_open_inodes++] = ni;
818 ntfs_3g_begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
820 struct ntfs_3g_apply_ctx *ctx = _ctx;
821 const struct blob_extraction_target *targets = blob_extraction_targets(blob);
825 for (u32 i = 0; i < blob->out_refcnt; i++) {
826 ret = WIMLIB_ERR_NTFS_3G;
827 ni = ntfs_3g_open_inode(targets[i].inode, ctx);
831 ret = ntfs_3g_begin_extract_blob_instance(blob, ni,
833 targets[i].stream, ctx);
841 ntfs_3g_cleanup_blob_extract(ctx);
847 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
849 struct ntfs_3g_apply_ctx *ctx = _ctx;
852 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
853 res = ntfs_attr_pwrite(ctx->open_attrs[i],
854 ctx->offset, size, chunk);
856 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
857 return WIMLIB_ERR_NTFS_3G;
860 if (ctx->reparse_ptr)
861 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
867 ntfs_3g_end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
869 struct ntfs_3g_apply_ctx *ctx = _ctx;
877 for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
878 ret = ntfs_3g_restore_reparse_point(ctx->ntfs_reparse_inodes[i],
879 ctx->wim_reparse_inodes[i],
886 if (ntfs_3g_cleanup_blob_extract(ctx) && !ret) {
887 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
888 ret = WIMLIB_ERR_NTFS_3G;
894 ntfs_3g_count_dentries(const struct list_head *dentry_list)
896 const struct wim_dentry *dentry;
899 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
901 if ((dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) &&
902 dentry_has_short_name(dentry))
912 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
914 struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
916 struct wim_dentry *root;
919 /* For NTFS-3g extraction mode we require that the dentries to extract
920 * form a single tree. */
921 root = list_first_entry(dentry_list, struct wim_dentry,
922 d_extraction_list_node);
924 /* Mount the NTFS volume. */
925 vol = ntfs_mount(ctx->common.target, 0);
927 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3g",
929 return WIMLIB_ERR_NTFS_3G;
933 /* Create all inodes and aliases, including short names, and set
934 * metadata (attributes, security descriptors, and timestamps). */
936 ret = start_file_structure_phase(&ctx->common,
937 ntfs_3g_count_dentries(dentry_list));
941 ret = ntfs_3g_create_directories(root, dentry_list, ctx);
945 ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
949 ret = end_file_structure_phase(&ctx->common);
954 struct read_blob_callbacks cbs = {
955 .begin_blob = ntfs_3g_begin_extract_blob,
956 .consume_chunk = ntfs_3g_extract_chunk,
957 .end_blob = ntfs_3g_end_extract_blob,
960 ret = extract_blob_list(&ctx->common, &cbs);
962 /* We do not need a final pass to set timestamps because libntfs-3g does
963 * not update timestamps automatically (exception:
964 * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere). */
967 if (ntfs_umount(ctx->vol, FALSE) && !ret) {
968 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3g",
970 ret = WIMLIB_ERR_NTFS_3G;
975 const struct apply_operations ntfs_3g_apply_ops = {
977 .get_supported_features = ntfs_3g_get_supported_features,
978 .extract = ntfs_3g_extract,
979 .context_size = sizeof(struct ntfs_3g_apply_ctx),
980 .single_tree_only = true,
984 libntfs3g_global_init(void)
986 ntfs_set_char_encoding(setlocale(LC_ALL, ""));