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 before 2014.2.15 reject security descriptors ending with an empty
114 * DACL (Discretionary Access Control List). This is very similar to the SACL
115 * bug. However, removing the DACL is not a valid workaround because this
116 * changes the meaning of the security descriptor--- an empty DACL allows no
117 * access, whereas a "null" DACL allows all access.
119 * If the security descriptor was fixed, this function returns an allocated
120 * buffer containing the fixed security descriptor, and its size is updated.
121 * Otherwise (or if no memory is available) NULL is returned.
124 sd_fixup(const void *_desc, size_t *size_p)
126 u32 owner_offset, group_offset, dacl_offset, sacl_offset;
127 bool owner_valid, group_valid;
128 size_t size = *size_p;
129 const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc = _desc;
130 wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
131 const wimlib_SID *owner, *group, *sid;
133 /* Don't attempt to fix clearly invalid security descriptors. */
134 if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
137 if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
138 dacl_offset = le32_to_cpu(desc->dacl_offset);
142 if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
143 sacl_offset = le32_to_cpu(desc->sacl_offset);
147 /* Check if the security descriptor will be affected by one of the bugs.
148 * If not, do nothing and return. */
149 if (!((sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
150 (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
153 owner_offset = le32_to_cpu(desc->owner_offset);
154 group_offset = le32_to_cpu(desc->group_offset);
155 owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
156 group = (const wimlib_SID*)((const u8*)desc + group_offset);
158 /* We'll try to move the owner or group SID to the end of the security
159 * descriptor to avoid the bug. This is only possible if at least one
161 owner_valid = (owner_offset != 0) &&
162 (owner_offset % 4 == 0) &&
163 (owner_offset <= size - sizeof(SID)) &&
164 (owner_offset + sid_size(owner) <= size) &&
165 (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
166 group_valid = (group_offset != 0) &&
167 (group_offset % 4 == 0) &&
168 (group_offset <= size - sizeof(SID)) &&
169 (group_offset + sid_size(group) <= size) &&
170 (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
173 } else if (group_valid) {
179 desc_new = MALLOC(size + sid_size(sid));
183 memcpy(desc_new, desc, size);
185 desc_new->owner_offset = cpu_to_le32(size);
186 else if (group_valid)
187 desc_new->group_offset = cpu_to_le32(size);
188 memcpy((u8*)desc_new + size, sid, sid_size(sid));
189 *size_p = size + sid_size(sid);
193 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
196 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
198 struct SECURITY_CONTEXT sec_ctx;
199 void *desc_fixed = NULL;
202 memset(&sec_ctx, 0, sizeof(sec_ctx));
203 sec_ctx.vol = ni->vol;
206 if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc, desc_size, 0)) {
207 if (desc_fixed == NULL) {
208 desc_fixed = sd_fixup(desc, &desc_size);
209 if (desc_fixed != NULL) {
214 ret = WIMLIB_ERR_SET_SECURITY;
222 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
225 inode->i_creation_time,
226 inode->i_last_write_time,
227 inode->i_last_access_time,
230 if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
231 return WIMLIB_ERR_SET_TIMESTAMPS;
235 /* Restore the timestamps on the NTFS inode corresponding to @inode. */
237 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
242 ni = ntfs_inode_open(vol, inode->i_mft_no);
246 res = ntfs_3g_set_timestamps(ni, inode);
248 if (ntfs_inode_close(ni) || res)
254 ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
255 dentry_full_path(inode_first_extraction_dentry(inode)));
256 return WIMLIB_ERR_SET_TIMESTAMPS;
259 /* Restore the DOS name of the @dentry.
260 * This closes both @ni and @dir_ni.
261 * If either is NULL, then they are opened temporarily. */
263 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
264 struct wim_dentry *dentry, ntfs_volume *vol)
267 const char *dos_name;
268 size_t dos_name_nbytes;
270 /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
271 * And it takes in a multibyte string, even though it translates it to
272 * UTF-16LE internally... which is annoying because we currently have
273 * the UTF-16LE string but not the multibyte string. */
275 ret = utf16le_get_tstr(dentry->d_short_name, dentry->d_short_name_nbytes,
276 &dos_name, &dos_name_nbytes);
281 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
283 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
285 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
286 dos_name, dos_name_nbytes, 0);
292 utf16le_put_tstr(dos_name);
294 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
295 "volume", dentry_full_path(dentry));
296 ret = WIMLIB_ERR_SET_SHORT_NAME;
300 /* Unlike most other NTFS-3g functions, ntfs_set_ntfs_dos_name()
301 * changes the directory's last modification timestamp...
303 return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
306 /* ntfs_inode_close() can take a NULL argument, but it's probably best
307 * not to rely on this behavior. */
309 ntfs_inode_close(ni);
311 ntfs_inode_close(dir_ni);
316 ntfs_3g_restore_reparse_point(ntfs_inode *ni, const struct wim_inode *inode,
317 unsigned blob_size, struct ntfs_3g_apply_ctx *ctx)
319 complete_reparse_point(&ctx->rpbuf, inode, blob_size);
321 if (ntfs_set_ntfs_reparse_data(ni, (const char *)&ctx->rpbuf,
322 REPARSE_DATA_OFFSET + blob_size, 0))
324 ERROR_WITH_ERRNO("Failed to set reparse data on \"%s\"",
326 inode_first_extraction_dentry(inode)));
327 return WIMLIB_ERR_SET_REPARSE_DATA;
335 * Create empty attributes (named data streams and potentially a reparse point)
336 * for the specified file, if there are any.
338 * Since these won't have blob descriptors, they won't show up in the call to
339 * extract_blob_list(). Hence the need for the special case.
342 ntfs_3g_create_empty_attributes(ntfs_inode *ni,
343 const struct wim_inode *inode,
344 struct ntfs_3g_apply_ctx *ctx)
347 for (unsigned i = 0; i < inode->i_num_streams; i++) {
349 const struct wim_inode_stream *strm = &inode->i_streams[i];
352 if (stream_blob_resolved(strm) != NULL)
355 if (strm->stream_type == STREAM_TYPE_REPARSE_POINT) {
356 ret = ntfs_3g_restore_reparse_point(ni, inode, 0, ctx);
359 } else if (stream_is_named_data_stream(strm)) {
360 if (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
361 utf16le_len_chars(strm->stream_name),
364 ERROR_WITH_ERRNO("Failed to create named data "
367 inode_first_extraction_dentry(inode)));
368 return WIMLIB_ERR_NTFS_3G;
375 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
378 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
379 const struct ntfs_3g_apply_ctx *ctx)
382 const struct wim_security_data *sd;
383 struct wim_dentry *one_dentry;
386 extract_flags = ctx->common.extract_flags;
387 sd = wim_get_current_security_data(ctx->common.wim);
388 one_dentry = inode_first_extraction_dentry(inode);
391 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
392 u32 attrib = inode->i_attributes;
394 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
395 FILE_ATTRIBUTE_ENCRYPTED);
397 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
400 ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
402 dentry_full_path(one_dentry));
403 return WIMLIB_ERR_SET_ATTRIBUTES;
407 /* Security descriptor */
408 if (inode_has_security_descriptor(inode)
409 && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
414 desc = sd->descriptors[inode->i_security_id];
415 desc_size = sd->sizes[inode->i_security_id];
417 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
419 if (wimlib_print_errors) {
420 ERROR_WITH_ERRNO("Failed to set security descriptor "
421 "on \"%s\" in NTFS volume",
422 dentry_full_path(one_dentry));
423 fprintf(wimlib_error_file,
424 "The security descriptor is: ");
425 print_byte_field(desc, desc_size, wimlib_error_file);
426 fprintf(wimlib_error_file, "\n");
433 ret = ntfs_3g_set_timestamps(ni, inode);
435 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
437 dentry_full_path(one_dentry));
443 /* Recursively creates all the subdirectories of @dir, which has been created as
444 * the NTFS inode @dir_ni. */
446 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
447 struct ntfs_3g_apply_ctx *ctx)
449 struct wim_dentry *child;
451 for_dentry_child(child, dir) {
455 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
457 if (!will_extract_dentry(child))
460 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
461 child->d_extraction_name_nchars, S_IFDIR);
463 ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
464 dentry_full_path(child));
465 return WIMLIB_ERR_NTFS_3G;
468 child->d_inode->i_mft_no = ni->mft_no;
470 ret = report_file_created(&ctx->common);
472 ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
474 ret = ntfs_3g_create_empty_attributes(ni, child->d_inode, ctx);
476 ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
478 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
479 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
480 dentry_full_path(child));
481 ret = WIMLIB_ERR_NTFS_3G;
489 /* For each WIM dentry in the @root tree that represents a directory, create the
490 * corresponding directory in the NTFS volume @ctx->vol. */
492 ntfs_3g_create_directories(struct wim_dentry *root,
493 struct list_head *dentry_list,
494 struct ntfs_3g_apply_ctx *ctx)
498 struct wim_dentry *dentry;
500 /* Create the directories using POSIX names. */
502 root_ni = ntfs_inode_open(ctx->vol, FILE_root);
504 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
505 return WIMLIB_ERR_NTFS_3G;
508 root->d_inode->i_mft_no = FILE_root;
510 ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
512 if (ntfs_inode_close(root_ni) && !ret) {
513 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
514 ret = WIMLIB_ERR_NTFS_3G;
519 /* Set the DOS name of any directory that has one. */
520 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
521 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
523 if (!dentry_has_short_name(dentry))
525 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry, ctx->vol);
528 ret = report_file_created(&ctx->common);
535 /* When creating an inode that will have a short (DOS) name, we create it using
536 * the long name associated with the short name. This ensures that the short
537 * name gets associated with the correct long name. */
538 static struct wim_dentry *
539 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
541 struct wim_dentry *dentry;
543 inode_for_each_extraction_alias(dentry, inode)
544 if (dentry_has_short_name(dentry))
546 return inode_first_extraction_dentry(inode);
550 * Add a hard link for the NTFS inode @ni at the location corresponding to the
551 * WIM dentry @dentry.
553 * The parent directory must have already been created on the NTFS volume.
555 * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
558 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
563 /* Open the inode of the parent directory. */
564 dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
568 /* Create the link. */
569 res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
570 dentry->d_extraction_name_nchars);
572 /* Close the parent directory. */
573 if (ntfs_inode_close(dir_ni) || res)
579 ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
580 dentry_full_path(dentry));
581 return WIMLIB_ERR_NTFS_3G;
585 ntfs_3g_create_nondirectory(struct wim_inode *inode,
586 struct ntfs_3g_apply_ctx *ctx)
588 struct wim_dentry *first_dentry;
591 struct wim_dentry *dentry;
594 first_dentry = ntfs_3g_first_extraction_alias(inode);
596 /* Create first link. */
598 dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
600 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
601 dentry_full_path(first_dentry->d_parent));
602 return WIMLIB_ERR_NTFS_3G;
605 ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
606 first_dentry->d_extraction_name_nchars, S_IFREG);
609 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
610 dentry_full_path(first_dentry));
611 ntfs_inode_close(dir_ni);
612 return WIMLIB_ERR_NTFS_3G;
615 inode->i_mft_no = ni->mft_no;
617 /* Set short name if present. */
618 if (dentry_has_short_name(first_dentry)) {
620 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
622 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'. */
627 /* Reopen the inode. */
628 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
630 ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
632 dentry_full_path(first_dentry));
633 return WIMLIB_ERR_NTFS_3G;
636 /* Close the directory in which the first link was created. */
637 if (ntfs_inode_close(dir_ni)) {
638 ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
639 dentry_full_path(first_dentry->d_parent));
640 ret = WIMLIB_ERR_NTFS_3G;
645 /* Create additional links if present. */
646 inode_for_each_extraction_alias(dentry, inode) {
647 if (dentry != first_dentry) {
648 ret = ntfs_3g_add_link(ni, dentry);
655 ret = ntfs_3g_set_metadata(ni, inode, ctx);
659 ret = ntfs_3g_create_empty_attributes(ni, inode, ctx);
662 /* Close the inode. */
663 if (ntfs_inode_close(ni) && !ret) {
664 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
665 dentry_full_path(first_dentry));
666 ret = WIMLIB_ERR_NTFS_3G;
671 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
672 * create the corresponding nondirectory file in the NTFS volume.
674 * Directories must have already been created. */
676 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
677 struct ntfs_3g_apply_ctx *ctx)
679 struct wim_dentry *dentry;
680 struct wim_inode *inode;
683 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
684 inode = dentry->d_inode;
685 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
687 if (dentry == inode_first_extraction_dentry(inode)) {
688 ret = ntfs_3g_create_nondirectory(inode, ctx);
692 ret = report_file_created(&ctx->common);
700 ntfs_3g_begin_extract_blob_instance(struct blob_descriptor *blob,
702 struct wim_inode *inode,
703 const struct wim_inode_stream *strm,
704 struct ntfs_3g_apply_ctx *ctx)
706 struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
707 size_t stream_name_nchars;
710 if (unlikely(strm->stream_type == STREAM_TYPE_REPARSE_POINT)) {
712 if (blob->size > REPARSE_DATA_MAX_SIZE) {
713 ERROR("Reparse data of \"%s\" has size "
714 "%"PRIu64" bytes (exceeds %u bytes)",
715 dentry_full_path(one_dentry),
716 blob->size, REPARSE_DATA_MAX_SIZE);
717 return WIMLIB_ERR_INVALID_REPARSE_DATA;
719 ctx->reparse_ptr = ctx->rpbuf.rpdata;
720 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
721 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
722 ctx->num_reparse_inodes++;
726 /* It's a data stream (may be unnamed or named). */
727 wimlib_assert(strm->stream_type == STREAM_TYPE_DATA);
729 stream_name_nchars = utf16le_len_chars(strm->stream_name);
731 if (stream_name_nchars &&
732 (ntfs_attr_add(ni, AT_DATA, strm->stream_name,
733 stream_name_nchars, NULL, 0)))
735 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
736 dentry_full_path(one_dentry));
737 return WIMLIB_ERR_NTFS_3G;
740 /* This should be ensured by extract_blob_list() */
741 wimlib_assert(ctx->num_open_attrs < MAX_OPEN_FILES);
743 attr = ntfs_attr_open(ni, AT_DATA, strm->stream_name,
746 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
747 dentry_full_path(one_dentry));
748 return WIMLIB_ERR_NTFS_3G;
750 ctx->open_attrs[ctx->num_open_attrs++] = attr;
751 ntfs_attr_truncate_solid(attr, blob->size);
756 ntfs_3g_cleanup_blob_extract(struct ntfs_3g_apply_ctx *ctx)
760 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
761 if (ntfs_attr_pclose(ctx->open_attrs[i]))
763 ntfs_attr_close(ctx->open_attrs[i]);
766 ctx->num_open_attrs = 0;
768 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
769 if (ntfs_inode_close(ctx->open_inodes[i]))
772 ctx->num_open_inodes = 0;
775 ctx->reparse_ptr = NULL;
776 ctx->num_reparse_inodes = 0;
781 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
785 /* If the same blob is being extracted to multiple streams of the same
786 * inode, then we must only open the inode once. */
787 if (unlikely(inode->i_num_streams > 1)) {
788 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
789 if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
790 return ctx->open_inodes[i];
795 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
797 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
799 inode_first_extraction_dentry(inode)));
803 ctx->open_inodes[ctx->num_open_inodes++] = ni;
808 ntfs_3g_begin_extract_blob(struct blob_descriptor *blob, void *_ctx)
810 struct ntfs_3g_apply_ctx *ctx = _ctx;
811 const struct blob_extraction_target *targets = blob_extraction_targets(blob);
815 for (u32 i = 0; i < blob->out_refcnt; i++) {
816 ret = WIMLIB_ERR_NTFS_3G;
817 ni = ntfs_3g_open_inode(targets[i].inode, ctx);
821 ret = ntfs_3g_begin_extract_blob_instance(blob, ni,
823 targets[i].stream, ctx);
831 ntfs_3g_cleanup_blob_extract(ctx);
837 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
839 struct ntfs_3g_apply_ctx *ctx = _ctx;
842 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
843 res = ntfs_attr_pwrite(ctx->open_attrs[i],
844 ctx->offset, size, chunk);
846 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
847 return WIMLIB_ERR_NTFS_3G;
850 if (ctx->reparse_ptr)
851 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
857 ntfs_3g_end_extract_blob(struct blob_descriptor *blob, int status, void *_ctx)
859 struct ntfs_3g_apply_ctx *ctx = _ctx;
867 for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
868 ret = ntfs_3g_restore_reparse_point(ctx->ntfs_reparse_inodes[i],
869 ctx->wim_reparse_inodes[i],
876 if (ntfs_3g_cleanup_blob_extract(ctx) && !ret) {
877 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
878 ret = WIMLIB_ERR_NTFS_3G;
884 ntfs_3g_count_dentries(const struct list_head *dentry_list)
886 const struct wim_dentry *dentry;
889 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
891 if ((dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) &&
892 dentry_has_short_name(dentry))
902 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
904 struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
906 struct wim_dentry *root;
909 /* For NTFS-3g extraction mode we require that the dentries to extract
910 * form a single tree. */
911 root = list_first_entry(dentry_list, struct wim_dentry,
912 d_extraction_list_node);
914 /* Mount the NTFS volume. */
915 vol = ntfs_mount(ctx->common.target, 0);
917 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3g",
919 return WIMLIB_ERR_NTFS_3G;
923 /* Create all inodes and aliases, including short names, and set
924 * metadata (attributes, security descriptors, and timestamps). */
926 ret = start_file_structure_phase(&ctx->common,
927 ntfs_3g_count_dentries(dentry_list));
931 ret = ntfs_3g_create_directories(root, dentry_list, ctx);
935 ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
939 ret = end_file_structure_phase(&ctx->common);
944 struct read_blob_callbacks cbs = {
945 .begin_blob = ntfs_3g_begin_extract_blob,
946 .consume_chunk = ntfs_3g_extract_chunk,
947 .end_blob = ntfs_3g_end_extract_blob,
950 ret = extract_blob_list(&ctx->common, &cbs);
952 /* We do not need a final pass to set timestamps because libntfs-3g does
953 * not update timestamps automatically (exception:
954 * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere). */
957 if (ntfs_umount(ctx->vol, FALSE) && !ret) {
958 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3g",
960 ret = WIMLIB_ERR_NTFS_3G;
965 const struct apply_operations ntfs_3g_apply_ops = {
967 .get_supported_features = ntfs_3g_get_supported_features,
968 .extract = ntfs_3g_extract,
969 .context_size = sizeof(struct ntfs_3g_apply_ctx),
970 .single_tree_only = true,
974 libntfs3g_global_init(void)
976 ntfs_set_char_encoding(setlocale(LC_ALL, ""));