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 Eric Biggers
15 * This file is part of wimlib, a library for working with WIM files.
17 * wimlib is free software; you can redistribute it and/or modify it under the
18 * terms of the GNU General Public License as published by the Free
19 * Software Foundation; either version 3 of the License, or (at your option)
22 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
23 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
24 * A PARTICULAR PURPOSE. See the GNU General Public License for more
27 * You should have received a copy of the GNU General Public License
28 * along with wimlib; if not, see http://www.gnu.org/licenses/.
38 #include <ntfs-3g/attrib.h>
39 #include <ntfs-3g/reparse.h>
40 #include <ntfs-3g/security.h>
42 #include "wimlib/assert.h"
43 #include "wimlib/apply.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->encrypted_directories = 1;
62 supported_features->not_context_indexed_files = 1;
63 supported_features->named_data_streams = 1;
64 supported_features->hard_links = 1;
65 supported_features->reparse_points = 1;
66 supported_features->security_descriptors = 1;
67 supported_features->short_names = 1;
68 supported_features->timestamps = 1;
69 supported_features->case_sensitive_filenames = 1;
73 struct ntfs_3g_apply_ctx {
74 /* Extract flags, the pointer to the WIMStruct, etc. */
75 struct apply_ctx common;
77 /* Pointer to the open NTFS volume */
80 ntfs_attr *open_attrs[MAX_OPEN_STREAMS];
81 unsigned num_open_attrs;
82 ntfs_inode *open_inodes[MAX_OPEN_STREAMS];
83 unsigned num_open_inodes;
85 struct reparse_buffer_disk rpbuf;
88 /* Offset in the stream currently being read */
91 unsigned num_reparse_inodes;
92 ntfs_inode *ntfs_reparse_inodes[MAX_OPEN_STREAMS];
93 struct wim_inode *wim_reparse_inodes[MAX_OPEN_STREAMS];
97 sid_size(const wimlib_SID *sid)
99 return offsetof(wimlib_SID, sub_authority) +
100 sizeof(le32) * sid->sub_authority_count;
104 * sd_fixup - Fix up a Windows NT security descriptor for libntfs-3g.
106 * libntfs-3g validates security descriptors before setting them, but old
107 * versions contain bugs causing it to reject unusual but valid security
110 * - Versions before 2013.1.13 reject security descriptors ending with an empty
111 * SACL (System Access Control List). This bug can be worked around either by
112 * moving the empty SACL earlier in the security descriptor or by removing the
113 * SACL entirely. The latter work-around is valid because an empty SACL is
114 * equivalent to a "null", or non-existent, SACL.
115 * - Versions up to and including 2013.1.13 reject security descriptors ending
116 * with an empty DACL (Discretionary Access Control List). This is very
117 * similar to the SACL bug and should be fixed in the next release after
118 * 2013.1.13. However, removing the DACL is not a valid workaround because
119 * this changes the meaning of the security descriptor--- an empty DACL allows
120 * no access, whereas a "null" DACL allows all access.
122 * If the security descriptor was fixed, this function returns an allocated
123 * buffer containing the fixed security descriptor, and its size is updated.
124 * Otherwise (or if no memory is available) the original descriptor is returned.
127 sd_fixup(const u8 *_desc, size_t *size_p)
129 u32 owner_offset, group_offset, dacl_offset, sacl_offset;
130 bool owner_valid, group_valid;
131 size_t size = *size_p;
132 const wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc =
133 (const wimlib_SECURITY_DESCRIPTOR_RELATIVE*)_desc;
134 wimlib_SECURITY_DESCRIPTOR_RELATIVE *desc_new;
135 const wimlib_SID *owner, *group, *sid;
137 /* Don't attempt to fix clearly invalid security descriptors. */
138 if (size < sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE))
141 if (le16_to_cpu(desc->control) & wimlib_SE_DACL_PRESENT)
142 dacl_offset = le32_to_cpu(desc->dacl_offset);
146 if (le16_to_cpu(desc->control) & wimlib_SE_SACL_PRESENT)
147 sacl_offset = le32_to_cpu(desc->sacl_offset);
151 /* Check if the security descriptor will be affected by one of the bugs.
152 * If not, do nothing and return.
154 * Note: HAVE_NTFS_MNT_RDONLY is defined if libntfs-3g is
155 * version 2013.1.13 or later. */
157 #if !defined(HAVE_NTFS_MNT_RDONLY)
158 (sacl_offset != 0 && sacl_offset == size - sizeof(wimlib_ACL)) ||
160 (dacl_offset != 0 && dacl_offset == size - sizeof(wimlib_ACL))))
163 owner_offset = le32_to_cpu(desc->owner_offset);
164 group_offset = le32_to_cpu(desc->group_offset);
165 owner = (const wimlib_SID*)((const u8*)desc + owner_offset);
166 group = (const wimlib_SID*)((const u8*)desc + group_offset);
168 /* We'll try to move the owner or group SID to the end of the security
169 * descriptor to avoid the bug. This is only possible if at least one
171 owner_valid = (owner_offset != 0) &&
172 (owner_offset % 4 == 0) &&
173 (owner_offset <= size - sizeof(SID)) &&
174 (owner_offset + sid_size(owner) <= size) &&
175 (owner_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
176 group_valid = (group_offset != 0) &&
177 (group_offset % 4 == 0) &&
178 (group_offset <= size - sizeof(SID)) &&
179 (group_offset + sid_size(group) <= size) &&
180 (group_offset >= sizeof(wimlib_SECURITY_DESCRIPTOR_RELATIVE));
183 } else if (group_valid) {
189 desc_new = MALLOC(size + sid_size(sid));
193 memcpy(desc_new, desc, size);
195 desc_new->owner_offset = cpu_to_le32(size);
196 else if (group_valid)
197 desc_new->group_offset = cpu_to_le32(size);
198 memcpy((u8*)desc_new + size, sid, sid_size(sid));
199 *size_p = size + sid_size(sid);
200 return (u8*)desc_new;
203 /* Set the security descriptor @desc of size @desc_size on the NTFS inode @ni.
206 ntfs_3g_set_security_descriptor(ntfs_inode *ni, const void *desc, size_t desc_size)
208 struct SECURITY_CONTEXT sec_ctx;
212 memset(&sec_ctx, 0, sizeof(sec_ctx));
213 sec_ctx.vol = ni->vol;
215 desc_fixed = sd_fixup(desc, &desc_size);
217 if (ntfs_set_ntfs_acl(&sec_ctx, ni, desc_fixed, desc_size, 0))
218 ret = WIMLIB_ERR_SET_SECURITY;
220 if (desc_fixed != desc)
227 ntfs_3g_set_timestamps(ntfs_inode *ni, const struct wim_inode *inode)
230 inode->i_creation_time,
231 inode->i_last_write_time,
232 inode->i_last_access_time,
235 if (ntfs_inode_set_times(ni, (const char *)times, sizeof(times), 0))
236 return WIMLIB_ERR_SET_TIMESTAMPS;
240 /* Restore the timestamps on the NTFS inode corresponding to @inode. */
242 ntfs_3g_restore_timestamps(ntfs_volume *vol, const struct wim_inode *inode)
247 ni = ntfs_inode_open(vol, inode->i_mft_no);
251 res = ntfs_3g_set_timestamps(ni, inode);
253 if (ntfs_inode_close(ni) || res)
259 ERROR_WITH_ERRNO("Failed to update timestamps of \"%s\" in NTFS volume",
260 dentry_full_path(inode_first_extraction_dentry(inode)));
261 return WIMLIB_ERR_SET_TIMESTAMPS;
264 /* Restore the DOS name of the @dentry.
265 * This closes both @ni and @dir_ni.
266 * If either is NULL, then they are opened temporarily. */
268 ntfs_3g_restore_dos_name(ntfs_inode *ni, ntfs_inode *dir_ni,
269 struct wim_dentry *dentry, ntfs_volume *vol)
272 const char *dos_name;
273 size_t dos_name_nbytes;
275 /* Note: ntfs_set_ntfs_dos_name() closes both inodes (even if it fails).
276 * And it takes in a multibyte string, even though it translates it to
277 * UTF-16LE internally... which is annoying because we currently have
278 * the UTF-16LE string but not the multibyte string. */
280 ret = utf16le_get_tstr(dentry->short_name, dentry->short_name_nbytes,
281 &dos_name, &dos_name_nbytes);
286 dir_ni = ntfs_inode_open(vol, dentry->d_parent->d_inode->i_mft_no);
288 ni = ntfs_inode_open(vol, dentry->d_inode->i_mft_no);
290 ret = ntfs_set_ntfs_dos_name(ni, dir_ni,
291 dos_name, dos_name_nbytes, 0);
297 utf16le_put_tstr(dos_name);
299 ERROR_WITH_ERRNO("Failed to set DOS name of \"%s\" in NTFS "
300 "volume", dentry_full_path(dentry));
301 ret = WIMLIB_ERR_SET_SHORT_NAME;
305 /* Unlike most other NTFS-3g functions, ntfs_set_ntfs_dos_name()
306 * changes the directory's last modification timestamp...
308 return ntfs_3g_restore_timestamps(vol, dentry->d_parent->d_inode);
311 /* ntfs_inode_close() can take a NULL argument, but it's probably best
312 * not to rely on this behavior. */
314 ntfs_inode_close(ni);
316 ntfs_inode_close(dir_ni);
320 /* Create empty named data streams.
322 * Since these won't have 'struct wim_lookup_table_entry's, they won't show up
323 * in the call to extract_stream_list(). Hence the need for the special case.
326 ntfs_3g_create_any_empty_ads(ntfs_inode *ni, const struct wim_inode *inode,
327 const struct ntfs_3g_apply_ctx *ctx)
329 for (u16 i = 0; i < inode->i_num_ads; i++) {
330 const struct wim_ads_entry *entry;
332 entry = &inode->i_ads_entries[i];
335 if (!entry->stream_name_nbytes)
342 if (ntfs_attr_add(ni, AT_DATA, entry->stream_name,
343 entry->stream_name_nbytes /
347 ERROR_WITH_ERRNO("Failed to create named data stream "
348 "of \"%s\"", dentry_full_path(
349 inode_first_extraction_dentry(inode)));
350 return WIMLIB_ERR_NTFS_3G;
356 /* Set attributes, security descriptor, and timestamps on the NTFS inode @ni.
359 ntfs_3g_set_metadata(ntfs_inode *ni, const struct wim_inode *inode,
360 const struct ntfs_3g_apply_ctx *ctx)
363 const struct wim_security_data *sd;
364 struct wim_dentry *one_dentry;
367 extract_flags = ctx->common.extract_flags;
368 sd = wim_get_current_security_data(ctx->common.wim);
369 one_dentry = inode_first_extraction_dentry(inode);
372 if (!(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES)) {
373 u32 attrib = inode->i_attributes;
375 attrib &= ~(FILE_ATTRIBUTE_SPARSE_FILE |
376 FILE_ATTRIBUTE_ENCRYPTED);
378 if (ntfs_set_ntfs_attrib(ni, (const char *)&attrib,
381 ERROR_WITH_ERRNO("Failed to set attributes on \"%s\" "
383 dentry_full_path(one_dentry));
384 return WIMLIB_ERR_SET_ATTRIBUTES;
388 /* Security descriptor */
389 if ((inode->i_security_id >= 0)
390 && !(extract_flags & WIMLIB_EXTRACT_FLAG_NO_ACLS))
395 desc = sd->descriptors[inode->i_security_id];
396 desc_size = sd->sizes[inode->i_security_id];
398 ret = ntfs_3g_set_security_descriptor(ni, desc, desc_size);
400 if (wimlib_print_errors) {
401 ERROR_WITH_ERRNO("Failed to set security descriptor "
402 "on \"%s\" in NTFS volume",
403 dentry_full_path(one_dentry));
404 fprintf(stderr, "The security descriptor is: ");
405 print_byte_field(desc, desc_size, stderr);
406 fprintf(stderr, "\n");
413 ret = ntfs_3g_set_timestamps(ni, inode);
415 ERROR_WITH_ERRNO("Failed to set timestamps on \"%s\" "
417 dentry_full_path(one_dentry));
423 /* Recursively creates all the subdirectories of @dir, which has been created as
424 * the NTFS inode @dir_ni. */
426 ntfs_3g_create_dirs_recursive(ntfs_inode *dir_ni, struct wim_dentry *dir,
427 const struct ntfs_3g_apply_ctx *ctx)
429 struct wim_dentry *child;
431 for_dentry_child(child, dir) {
435 if (!(child->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
437 if (!will_extract_dentry(child))
440 ni = ntfs_create(dir_ni, 0, child->d_extraction_name,
441 child->d_extraction_name_nchars, S_IFDIR);
443 ERROR_WITH_ERRNO("Error creating \"%s\" in NTFS volume",
444 dentry_full_path(child));
445 return WIMLIB_ERR_NTFS_3G;
448 child->d_inode->i_mft_no = ni->mft_no;
450 ret = ntfs_3g_set_metadata(ni, child->d_inode, ctx);
452 ret = ntfs_3g_create_any_empty_ads(ni, child->d_inode, ctx);
454 ret = ntfs_3g_create_dirs_recursive(ni, child, ctx);
456 if (ntfs_inode_close_in_dir(ni, dir_ni) && !ret) {
457 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
458 dentry_full_path(child));
459 ret = WIMLIB_ERR_NTFS_3G;
467 /* For each WIM dentry in the @root tree that represents a directory, create the
468 * corresponding directory in the NTFS volume @ctx->vol. */
470 ntfs_3g_create_directories(struct wim_dentry *root,
471 struct list_head *dentry_list,
472 const struct ntfs_3g_apply_ctx *ctx)
476 struct wim_dentry *dentry;
478 /* Create the directories using POSIX names. */
480 root_ni = ntfs_inode_open(ctx->vol, FILE_root);
482 ERROR_WITH_ERRNO("Can't open root of NTFS volume");
483 return WIMLIB_ERR_NTFS_3G;
486 root->d_inode->i_mft_no = FILE_root;
488 ret = ntfs_3g_create_dirs_recursive(root_ni, root, ctx);
490 if (ntfs_inode_close(root_ni) && !ret) {
491 ERROR_WITH_ERRNO("Error closing root of NTFS volume");
492 ret = WIMLIB_ERR_NTFS_3G;
497 /* Set the DOS name of any directory that has one. */
498 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
499 if (!(dentry->d_inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY))
501 if (!dentry_has_short_name(dentry))
503 ret = ntfs_3g_restore_dos_name(NULL, NULL, dentry, ctx->vol);
510 /* When creating an inode that will have a short (DOS) name, we create it using
511 * the long name associated with the short name. This ensures that the short
512 * name gets associated with the correct long name. */
513 static struct wim_dentry *
514 ntfs_3g_first_extraction_alias(struct wim_inode *inode)
516 struct list_head *next = inode->i_extraction_aliases.next;
517 struct wim_dentry *dentry;
520 dentry = list_entry(next, struct wim_dentry,
521 d_extraction_alias_node);
522 if (dentry_has_short_name(dentry))
525 } while (next != &inode->i_extraction_aliases);
530 * Add a hard link for the NTFS inode @ni at the location corresponding to the
531 * WIM dentry @dentry.
533 * The parent directory must have already been created on the NTFS volume.
535 * Returns 0 on success; returns WIMLIB_ERR_NTFS_3G and sets errno on failure.
538 ntfs_3g_add_link(ntfs_inode *ni, struct wim_dentry *dentry)
543 /* Open the inode of the parent directory. */
544 dir_ni = ntfs_inode_open(ni->vol, dentry->d_parent->d_inode->i_mft_no);
548 /* Create the link. */
549 res = ntfs_link(ni, dir_ni, dentry->d_extraction_name,
550 dentry->d_extraction_name_nchars);
552 /* Close the parent directory. */
553 if (ntfs_inode_close(dir_ni) || res)
559 ERROR_WITH_ERRNO("Can't create link \"%s\" in NTFS volume",
560 dentry_full_path(dentry));
561 return WIMLIB_ERR_NTFS_3G;
565 ntfs_3g_create_nondirectory(struct wim_inode *inode,
566 const struct ntfs_3g_apply_ctx *ctx)
568 struct wim_dentry *first_dentry;
571 struct list_head *next;
572 struct wim_dentry *dentry;
575 first_dentry = ntfs_3g_first_extraction_alias(inode);
577 /* Create first link. */
579 dir_ni = ntfs_inode_open(ctx->vol, first_dentry->d_parent->d_inode->i_mft_no);
581 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
582 dentry_full_path(first_dentry->d_parent));
583 return WIMLIB_ERR_NTFS_3G;
586 ni = ntfs_create(dir_ni, 0, first_dentry->d_extraction_name,
587 first_dentry->d_extraction_name_nchars, S_IFREG);
590 ERROR_WITH_ERRNO("Can't create \"%s\" in NTFS volume",
591 dentry_full_path(first_dentry));
592 ntfs_inode_close(dir_ni);
593 return WIMLIB_ERR_NTFS_3G;
596 inode->i_mft_no = ni->mft_no;
598 /* Set short name if present. */
599 if (dentry_has_short_name(first_dentry)) {
601 ret = ntfs_3g_restore_dos_name(ni, dir_ni, first_dentry, ctx->vol);
603 /* ntfs_3g_restore_dos_name() closed both 'ni' and 'dir_ni'. */
608 /* Reopen the inode. */
609 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
611 ERROR_WITH_ERRNO("Failed to reopen \"%s\" "
613 dentry_full_path(first_dentry));
614 return WIMLIB_ERR_NTFS_3G;
617 /* Close the directory in which the first link was created. */
618 if (ntfs_inode_close(dir_ni)) {
619 ERROR_WITH_ERRNO("Failed to close \"%s\" in NTFS volume",
620 dentry_full_path(first_dentry->d_parent));
621 ret = WIMLIB_ERR_NTFS_3G;
626 /* Create additional links if present. */
627 next = inode->i_extraction_aliases.next;
629 dentry = list_entry(next, struct wim_dentry,
630 d_extraction_alias_node);
631 if (dentry != first_dentry) {
632 ret = ntfs_3g_add_link(ni, dentry);
637 } while (next != &inode->i_extraction_aliases);
640 ret = ntfs_3g_set_metadata(ni, inode, ctx);
644 ret = ntfs_3g_create_any_empty_ads(ni, inode, ctx);
647 /* Close the inode. */
648 if (ntfs_inode_close(ni) && !ret) {
649 ERROR_WITH_ERRNO("Error closing \"%s\" in NTFS volume",
650 dentry_full_path(first_dentry));
651 ret = WIMLIB_ERR_NTFS_3G;
656 /* For each WIM dentry in the @dentry_list that represents a nondirectory file,
657 * create the corresponding nondirectory file in the NTFS volume.
659 * Directories must have already been created. */
661 ntfs_3g_create_nondirectories(struct list_head *dentry_list,
662 const struct ntfs_3g_apply_ctx *ctx)
664 struct wim_dentry *dentry;
665 struct wim_inode *inode;
668 list_for_each_entry(dentry, dentry_list, d_extraction_list_node) {
669 inode = dentry->d_inode;
670 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY)
672 if (dentry != inode_first_extraction_dentry(inode))
674 ret = ntfs_3g_create_nondirectory(inode, ctx);
682 ntfs_3g_begin_extract_stream_to_attr(struct wim_lookup_table_entry *stream,
684 struct wim_inode *inode,
685 ntfschar *stream_name,
686 struct ntfs_3g_apply_ctx *ctx)
688 struct wim_dentry *one_dentry = inode_first_extraction_dentry(inode);
689 size_t stream_name_nchars = 0;
693 for (const ntfschar *p = stream_name; *p; p++)
694 stream_name_nchars++;
696 if (stream_name_nchars == 0)
697 stream_name = AT_UNNAMED;
698 if ((inode->i_attributes & FILE_ATTRIBUTE_REPARSE_POINT)
699 && (stream_name_nchars == 0))
701 if (stream->size > REPARSE_DATA_MAX_SIZE) {
702 ERROR("Reparse data of \"%s\" has size "
703 "%"PRIu64" bytes (exceeds %u bytes)",
704 dentry_full_path(one_dentry),
705 stream->size, REPARSE_DATA_MAX_SIZE);
706 return WIMLIB_ERR_INVALID_REPARSE_DATA;
708 ctx->reparse_ptr = ctx->rpbuf.rpdata;
709 ctx->rpbuf.rpdatalen = cpu_to_le16(stream->size);
710 ctx->rpbuf.rpreserved = cpu_to_le16(0);
711 ctx->ntfs_reparse_inodes[ctx->num_reparse_inodes] = ni;
712 ctx->wim_reparse_inodes[ctx->num_reparse_inodes] = inode;
713 ctx->num_reparse_inodes++;
717 if (stream_name_nchars &&
718 (ntfs_attr_add(ni, AT_DATA, stream_name,
719 stream_name_nchars, NULL, 0)))
721 ERROR_WITH_ERRNO("Failed to create named data stream of \"%s\"",
722 dentry_full_path(one_dentry));
723 return WIMLIB_ERR_NTFS_3G;
726 /* This should be ensured by extract_stream_list() */
727 wimlib_assert(ctx->num_open_attrs < MAX_OPEN_STREAMS);
729 attr = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_nchars);
731 ERROR_WITH_ERRNO("Failed to open data stream of \"%s\"",
732 dentry_full_path(one_dentry));
733 return WIMLIB_ERR_NTFS_3G;
735 ctx->open_attrs[ctx->num_open_attrs++] = attr;
736 ntfs_attr_truncate_solid(attr, stream->size);
741 ntfs_3g_cleanup_stream_extract(struct ntfs_3g_apply_ctx *ctx)
745 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
746 if (ntfs_attr_pclose(ctx->open_attrs[i]))
748 ntfs_attr_close(ctx->open_attrs[i]);
751 ctx->num_open_attrs = 0;
753 for (unsigned i = 0; i < ctx->num_open_inodes; i++) {
754 if (ntfs_inode_close(ctx->open_inodes[i]))
757 ctx->num_open_inodes = 0;
760 ctx->reparse_ptr = NULL;
761 ctx->num_reparse_inodes = 0;
766 ntfs_3g_open_inode(struct wim_inode *inode, struct ntfs_3g_apply_ctx *ctx)
768 ntfs_inode *ni = NULL;
770 if (inode->i_visited) {
771 for (u32 i = 0; i < ctx->num_open_inodes; i++) {
772 if (ctx->open_inodes[i]->mft_no == inode->i_mft_no) {
773 ni = ctx->open_inodes[i];
779 ni = ntfs_inode_open(ctx->vol, inode->i_mft_no);
780 ctx->open_inodes[ctx->num_open_inodes++] = ni;
781 inode->i_visited = 1;
785 ERROR_WITH_ERRNO("Can't open \"%s\" in NTFS volume",
787 inode_first_extraction_dentry(inode)));
794 ntfs_3g_begin_extract_stream(struct wim_lookup_table_entry *stream,
795 u32 flags, void *_ctx)
797 struct ntfs_3g_apply_ctx *ctx = _ctx;
798 const struct stream_owner *owners = stream_owners(stream);
801 for (u32 i = 0; i < stream->out_refcnt; i++) {
802 struct wim_inode *inode = owners[i].inode;
803 ntfschar *stream_name = (ntfschar *)owners[i].stream_name;
806 ret = WIMLIB_ERR_NTFS_3G;
807 ni = ntfs_3g_open_inode(inode, ctx);
811 ret = ntfs_3g_begin_extract_stream_to_attr(stream, ni, inode,
820 ntfs_3g_cleanup_stream_extract(ctx);
822 for (u32 i = 0; i < stream->out_refcnt; i++)
823 owners[i].inode->i_visited = 0;
828 ntfs_3g_extract_chunk(const void *chunk, size_t size, void *_ctx)
830 struct ntfs_3g_apply_ctx *ctx = _ctx;
833 for (unsigned i = 0; i < ctx->num_open_attrs; i++) {
834 res = ntfs_attr_pwrite(ctx->open_attrs[i],
835 ctx->offset, size, chunk);
837 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
838 return WIMLIB_ERR_NTFS_3G;
841 if (ctx->reparse_ptr)
842 ctx->reparse_ptr = mempcpy(ctx->reparse_ptr, chunk, size);
848 ntfs_3g_end_extract_stream(struct wim_lookup_table_entry *stream,
849 int status, void *_ctx)
851 struct ntfs_3g_apply_ctx *ctx = _ctx;
859 for (u32 i = 0; i < ctx->num_reparse_inodes; i++) {
860 struct wim_inode *inode = ctx->wim_reparse_inodes[i];
862 ctx->rpbuf.rptag = cpu_to_le32(inode->i_reparse_tag);
864 if (ntfs_set_ntfs_reparse_data(ctx->ntfs_reparse_inodes[i],
865 (const char *)&ctx->rpbuf,
866 stream->size + REPARSE_DATA_OFFSET,
869 ERROR_WITH_ERRNO("Failed to set reparse "
872 inode_first_extraction_dentry(inode)));
873 ret = WIMLIB_ERR_NTFS_3G;
879 if (ntfs_3g_cleanup_stream_extract(ctx) && !ret) {
880 ERROR_WITH_ERRNO("Error writing data to NTFS volume");
881 ret = WIMLIB_ERR_NTFS_3G;
887 ntfs_3g_extract(struct list_head *dentry_list, struct apply_ctx *_ctx)
889 struct ntfs_3g_apply_ctx *ctx = (struct ntfs_3g_apply_ctx *)_ctx;
891 struct wim_dentry *root;
894 /* For NTFS-3g extraction mode we require that the dentries to extract
895 * form a single tree. */
896 root = list_first_entry(dentry_list, struct wim_dentry,
897 d_extraction_list_node);
899 /* Mount the NTFS volume. */
900 vol = ntfs_mount(ctx->common.target, 0);
902 ERROR_WITH_ERRNO("Failed to mount \"%s\" with NTFS-3g",
904 return WIMLIB_ERR_NTFS_3G;
908 /* Create all inodes and aliases, including short names, and set
909 * metadata (attributes, security descriptors, and timestamps). */
911 ret = ntfs_3g_create_directories(root, dentry_list, ctx);
915 ret = ntfs_3g_create_nondirectories(dentry_list, ctx);
919 /* Extract streams. */
920 struct read_stream_list_callbacks cbs = {
921 .begin_stream = ntfs_3g_begin_extract_stream,
922 .begin_stream_ctx = ctx,
923 .consume_chunk = ntfs_3g_extract_chunk,
924 .consume_chunk_ctx = ctx,
925 .end_stream = ntfs_3g_end_extract_stream,
926 .end_stream_ctx = ctx,
928 ret = extract_stream_list(&ctx->common, &cbs);
930 /* We do not need a final pass to set timestamps because libntfs-3g does
931 * not update timestamps automatically (exception:
932 * ntfs_set_ntfs_dos_name() does, but we handle this elsewhere). */
935 if (ntfs_umount(ctx->vol, FALSE) && !ret) {
936 ERROR_WITH_ERRNO("Failed to unmount \"%s\" with NTFS-3g",
938 ret = WIMLIB_ERR_NTFS_3G;
943 const struct apply_operations ntfs_3g_apply_ops = {
945 .get_supported_features = ntfs_3g_get_supported_features,
946 .extract = ntfs_3g_extract,
947 .context_size = sizeof(struct ntfs_3g_apply_ctx),
948 .single_tree_only = true,
952 libntfs3g_global_init(void)
954 ntfs_set_char_encoding(setlocale(LC_ALL, ""));