4 * Apply a WIM image to a NTFS volume. Restore as much information as possible,
5 * including security data, file attributes, DOS names, and alternate data
10 * Copyright (C) 2012 Eric Biggers
12 * This file is part of wimlib, a library for working with WIM files.
14 * wimlib is free software; you can redistribute it and/or modify it under the
15 * terms of the GNU General Public License as published by the Free
16 * Software Foundation; either version 3 of the License, or (at your option)
19 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
20 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
21 * A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with wimlib; if not, see http://www.gnu.org/licenses/.
31 #include <ntfs-3g/endians.h>
32 #include <ntfs-3g/types.h>
34 #include "wimlib_internal.h"
35 #include "buffer_io.h"
37 #include "lookup_table.h"
39 #include <ntfs-3g/attrib.h>
40 #include <ntfs-3g/security.h> /* security.h before xattrs.h */
41 #include <ntfs-3g/reparse.h>
42 #include <ntfs-3g/xattrs.h>
45 static int extract_wim_chunk_to_ntfs_attr(const u8 *buf, size_t len,
46 u64 offset, void *arg)
49 if (ntfs_attr_pwrite(na, offset, len, buf) == len) {
52 ERROR_WITH_ERRNO("Error extracting WIM resource to NTFS attribute");
53 return WIMLIB_ERR_WRITE;
58 * Extracts a WIM resource to a NTFS attribute.
61 extract_wim_resource_to_ntfs_attr(const struct wim_lookup_table_entry *lte,
64 return extract_wim_resource(lte, wim_resource_size(lte),
65 extract_wim_chunk_to_ntfs_attr, na);
68 /* Writes the data streams of a WIM inode to the data attributes of a NTFS
71 * @ni: The NTFS inode to which the streams are to be extracted.
73 * @dentry: The WIM dentry being extracted. The @d_inode member points to the
74 * corresponding WIM inode that contains the streams being extracted.
75 * The WIM dentry itself is only needed to provide a file path for
76 * better error messages.
78 * @progress_info: Progress information for the image application. The number
79 * of extracted bytes will be incremented by the uncompressed
80 * size of each stream extracted.
82 * Returns 0 on success, nonzero on failure.
84 static int write_ntfs_data_streams(ntfs_inode *ni, const struct wim_dentry *dentry,
85 union wimlib_progress_info *progress_info)
88 unsigned stream_idx = 0;
89 ntfschar *stream_name = AT_UNNAMED;
90 u32 stream_name_len = 0;
91 const struct wim_inode *inode = dentry->d_inode;
92 struct wim_lookup_table_entry *lte;
94 DEBUG("Writing %u NTFS data stream%s for `%s'",
96 (inode->i_num_ads == 0 ? "" : "s"),
97 dentry->full_path_utf8);
101 if (stream_name_len) {
102 /* Create an empty named stream. */
103 ret = ntfs_attr_add(ni, AT_DATA, stream_name,
104 stream_name_len, NULL, 0);
106 ERROR_WITH_ERRNO("Failed to create name data "
107 "stream for extracted file "
109 dentry->full_path_utf8);
110 ret = WIMLIB_ERR_NTFS_3G;
116 /* If there's no lookup table entry, it's an empty stream.
117 * Otherwise, open the attribute and extract the data. */
121 na = ntfs_attr_open(ni, AT_DATA, stream_name, stream_name_len);
123 ERROR_WITH_ERRNO("Failed to open a data stream of "
124 "extracted file `%s'",
125 dentry->full_path_utf8);
126 ret = WIMLIB_ERR_NTFS_3G;
130 /* The WIM lookup table entry provides the stream
131 * length, so the NTFS attribute should be resized to
132 * this length before starting to extract the data. */
133 ret = ntfs_attr_truncate_solid(na, wim_resource_size(lte));
139 /* Actually extract the stream */
140 ret = extract_wim_resource_to_ntfs_attr(lte, na);
142 /* Close the attribute */
147 /* Record the number of bytes of uncompressed data that
148 * have been extracted. */
149 progress_info->extract.completed_bytes += wim_resource_size(lte);
151 if (stream_idx == inode->i_num_ads) /* Has the last stream been extracted? */
154 /* Get the name and lookup table entry for the next stream. */
155 stream_name = (ntfschar*)inode->i_ads_entries[stream_idx].stream_name;
156 stream_name_len = inode->i_ads_entries[stream_idx].stream_name_len / 2;
157 lte = inode->i_ads_entries[stream_idx].lte;
163 /* Open the NTFS inode that corresponds to the parent of a WIM dentry. Returns
164 * the opened inode, or NULL on failure. */
165 static ntfs_inode *dentry_open_parent_ni(const struct wim_dentry *dentry,
169 const char *dir_name;
173 p = dentry->full_path_utf8 + dentry->full_path_utf8_len;
180 dir_name = dentry->full_path_utf8;
181 dir_ni = ntfs_pathname_to_inode(vol, NULL, dir_name);
183 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
191 * Makes a NTFS hard link.
193 * The hard link is named @from_dentry->file_name and is located under the
194 * directory specified by @dir_ni, and it is made to point to the previously
195 * extracted file located at @inode->i_extracted_file.
197 * Or, in other words, this adds a new name @from_dentry->full_path_utf8 to an
198 * existing NTFS inode which already has a name @inode->i_extracted_file.
200 * The new name is made in the POSIX namespace (this is the behavior of
201 * ntfs_link()). I am assuming this is an acceptable behavior; however, it's
202 * possible that the original name was actually in the Win32 namespace. Note
203 * that the WIM format does not provide enough information to distinguish Win32
204 * names from POSIX names in all cases.
206 * Return 0 on success, nonzero on failure.
208 static int apply_ntfs_hardlink(const struct wim_dentry *from_dentry,
209 const struct wim_inode *inode,
210 ntfs_inode **dir_ni_p)
219 ret = ntfs_inode_close(dir_ni);
222 ERROR_WITH_ERRNO("Error closing directory");
223 return WIMLIB_ERR_NTFS_3G;
226 DEBUG("Extracting NTFS hard link `%s' => `%s'",
227 from_dentry->full_path_utf8, inode->i_extracted_file);
229 to_ni = ntfs_pathname_to_inode(vol, NULL, inode->i_extracted_file);
231 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
232 inode->i_extracted_file);
233 return WIMLIB_ERR_NTFS_3G;
236 dir_ni = dentry_open_parent_ni(from_dentry, vol);
238 ntfs_inode_close(to_ni);
239 return WIMLIB_ERR_NTFS_3G;
242 ret = ntfs_link(to_ni, dir_ni,
243 (ntfschar*)from_dentry->file_name,
244 from_dentry->file_name_len / 2);
245 ret |= ntfs_inode_close(dir_ni);
246 ret |= ntfs_inode_close(to_ni);
248 ERROR_WITH_ERRNO("Could not create hard link `%s' => `%s' (ret=%d)",
249 from_dentry->full_path_utf8,
250 inode->i_extracted_file,
252 ret = WIMLIB_ERR_NTFS_3G;
257 /* Transfers file attributes and possibly a security descriptor from a WIM inode
260 * @ni: The NTFS inode to apply the metadata to.
261 * @dir_ni: The NTFS inode for a directory containing @ni.
262 * @dentry: The WIM dentry whose inode contains the metadata to apply.
263 * @w: The WIMStruct for the WIM, through which the table of security
264 * descriptors can be accessed.
266 * Returns 0 on success, nonzero on failure.
269 apply_file_attributes_and_security_data(ntfs_inode *ni,
271 const struct wim_dentry *dentry,
275 struct SECURITY_CONTEXT ctx;
277 const struct wim_inode *inode;
279 inode = dentry->d_inode;
281 DEBUG("Setting NTFS file attributes on `%s' to %#"PRIx32,
282 dentry->full_path_utf8, inode->i_attributes);
284 attributes_le32 = cpu_to_le32(inode->i_attributes);
285 memset(&ctx, 0, sizeof(ctx));
287 ret = ntfs_xattr_system_setxattr(&ctx, XATTR_NTFS_ATTRIB,
289 (const char*)&attributes_le32,
292 ERROR("Failed to set NTFS file attributes on `%s'",
293 dentry->full_path_utf8);
294 return WIMLIB_ERR_NTFS_3G;
296 if (inode->i_security_id != -1) {
298 const struct wim_security_data *sd;
300 sd = wim_const_security_data(w);
301 wimlib_assert(inode->i_security_id < sd->num_entries);
302 desc = (const char *)sd->descriptors[inode->i_security_id];
303 DEBUG("Applying security descriptor %d to `%s'",
304 inode->i_security_id, dentry->full_path_utf8);
306 ret = ntfs_xattr_system_setxattr(&ctx, XATTR_NTFS_ACL,
308 sd->sizes[inode->i_security_id], 0);
311 ERROR_WITH_ERRNO("Failed to set security data on `%s'",
312 dentry->full_path_utf8);
313 return WIMLIB_ERR_NTFS_3G;
320 * Transfers the reparse data from a WIM inode (which must represent a reparse
321 * point) to a NTFS inode.
323 static int apply_reparse_data(ntfs_inode *ni, const struct wim_dentry *dentry,
324 union wimlib_progress_info *progress_info)
326 struct wim_lookup_table_entry *lte;
329 lte = inode_unnamed_lte_resolved(dentry->d_inode);
331 DEBUG("Applying reparse data to `%s'", dentry->full_path_utf8);
334 ERROR("Could not find reparse data for `%s'",
335 dentry->full_path_utf8);
336 return WIMLIB_ERR_INVALID_DENTRY;
339 if (wim_resource_size(lte) >= 0xffff) {
340 ERROR("Reparse data of `%s' is too long (%"PRIu64" bytes)",
341 dentry->full_path_utf8, wim_resource_size(lte));
342 return WIMLIB_ERR_INVALID_DENTRY;
345 u8 reparse_data_buf[8 + wim_resource_size(lte)];
346 u8 *p = reparse_data_buf;
347 p = put_u32(p, dentry->d_inode->i_reparse_tag); /* ReparseTag */
348 p = put_u16(p, wim_resource_size(lte)); /* ReparseDataLength */
349 p = put_u16(p, 0); /* Reserved */
351 ret = read_full_wim_resource(lte, p, 0);
355 ret = ntfs_set_ntfs_reparse_data(ni, (char*)reparse_data_buf,
356 wim_resource_size(lte) + 8, 0);
358 ERROR_WITH_ERRNO("Failed to set NTFS reparse data on `%s'",
359 dentry->full_path_utf8);
360 return WIMLIB_ERR_NTFS_3G;
362 progress_info->extract.completed_bytes += wim_resource_size(lte);
367 * Applies a WIM dentry to a NTFS filesystem.
369 * @dentry: The WIM dentry to apply
370 * @dir_ni: The NTFS inode for the parent directory
372 * @return: 0 on success; nonzero on failure.
374 static int do_apply_dentry_ntfs(struct wim_dentry *dentry, ntfs_inode *dir_ni,
375 struct apply_args *args)
379 ntfs_inode *ni = NULL;
380 struct wim_inode *inode = dentry->d_inode;
381 dentry->is_extracted = 1;
383 if (inode->i_attributes & FILE_ATTRIBUTE_DIRECTORY) {
387 if (inode->i_nlink > 1) {
388 /* Inode has multiple dentries referencing it. */
389 if (inode->i_extracted_file) {
390 /* Already extracted another dentry in the hard
391 * link group. Make a hard link instead of
392 * extracting the file data. */
393 ret = apply_ntfs_hardlink(dentry, inode,
395 goto out_close_dir_ni;
397 /* None of the dentries of this inode have been
398 * extracted yet, so go ahead and extract the
400 FREE(inode->i_extracted_file);
401 inode->i_extracted_file = STRDUP(dentry->full_path_utf8);
402 if (!inode->i_extracted_file) {
403 ret = WIMLIB_ERR_NOMEM;
404 goto out_close_dir_ni;
410 /* Create a NTFS directory or file.
412 * Note: For symbolic links that are not directory junctions, S_IFREG is
413 * passed here, since the reparse data and file attributes are set
415 ni = ntfs_create(dir_ni, 0, (ntfschar*)dentry->file_name,
416 dentry->file_name_len / 2, type);
419 ERROR_WITH_ERRNO("Could not create NTFS inode for `%s'",
420 dentry->full_path_utf8);
421 ret = WIMLIB_ERR_NTFS_3G;
422 goto out_close_dir_ni;
425 /* Write the data streams, unless this is a directory or reparse point
427 if (!(inode->i_attributes & (FILE_ATTRIBUTE_REPARSE_POINT |
428 FILE_ATTRIBUTE_DIRECTORY))) {
429 ret = write_ntfs_data_streams(ni, dentry, &args->progress);
431 goto out_close_dir_ni;
435 ret = apply_file_attributes_and_security_data(ni, dir_ni, dentry,
438 goto out_close_dir_ni;
440 if (inode->i_attributes & FILE_ATTR_REPARSE_POINT) {
441 ret = apply_reparse_data(ni, dentry, &args->progress);
443 goto out_close_dir_ni;
446 /* Set DOS (short) name if given */
447 if (dentry->short_name_len != 0) {
448 char *short_name_utf8;
449 size_t short_name_utf8_len;
450 ret = utf16_to_utf8(dentry->short_name,
451 dentry->short_name_len,
453 &short_name_utf8_len);
455 goto out_close_dir_ni;
457 DEBUG("Setting short (DOS) name of `%s' to %s",
458 dentry->full_path_utf8, short_name_utf8);
460 ret = ntfs_set_ntfs_dos_name(ni, dir_ni, short_name_utf8,
461 short_name_utf8_len, 0);
462 FREE(short_name_utf8);
464 ERROR_WITH_ERRNO("Could not set DOS (short) name for `%s'",
465 dentry->full_path_utf8);
466 ret = WIMLIB_ERR_NTFS_3G;
468 /* inodes have been closed by ntfs_set_ntfs_dos_name(). */
474 if (ntfs_inode_close_in_dir(ni, dir_ni)) {
476 ret = WIMLIB_ERR_NTFS_3G;
477 ERROR_WITH_ERRNO("Failed to close inode for `%s'",
478 dentry->full_path_utf8);
481 if (ntfs_inode_close(dir_ni)) {
483 ret = WIMLIB_ERR_NTFS_3G;
484 ERROR_WITH_ERRNO("Failed to close inode of directory "
485 "containing `%s'", dentry->full_path_utf8);
492 static int apply_root_dentry_ntfs(const struct wim_dentry *dentry,
493 ntfs_volume *vol, const WIMStruct *w)
498 ni = ntfs_pathname_to_inode(vol, NULL, "/");
500 ERROR_WITH_ERRNO("Could not find root NTFS inode");
501 return WIMLIB_ERR_NTFS_3G;
503 ret = apply_file_attributes_and_security_data(ni, ni, dentry, w);
504 if (ntfs_inode_close(ni) != 0) {
505 ERROR_WITH_ERRNO("Failed to close NTFS inode for root "
507 ret = WIMLIB_ERR_NTFS_3G;
512 /* Applies a WIM dentry to the NTFS volume */
513 int apply_dentry_ntfs(struct wim_dentry *dentry, void *arg)
515 struct apply_args *args = arg;
516 ntfs_volume *vol = args->vol;
517 WIMStruct *w = args->w;
518 struct wim_dentry *orig_dentry;
519 struct wim_dentry *other;
522 /* Treat the root dentry specially. */
523 if (dentry_is_root(dentry))
524 return apply_root_dentry_ntfs(dentry, vol, w);
526 /* NTFS filename namespaces need careful consideration. A name for a
527 * NTFS file may be in either the POSIX, Win32, DOS, or Win32+DOS
528 * namespaces. A NTFS file (a.k.a. inode) may have multiple names in
529 * multiple directories (i.e. hard links); however, a NTFS file can have
530 * at most 1 DOS name total. Furthermore, a Win32 name is always
531 * associated with a DOS name (either as a Win32+DOS name, or a Win32
532 * name and a DOS name separately), which implies that a NTFS file can
533 * have at most 1 Win32 name.
535 * A WIM dentry just contains a "long name", which wimlib makes sure is
536 * non-empty, and a "short name", which may be empty. So, wimlib must
537 * map these to the correct NTFS names. wimlib collects all WIM
538 * dentries that map to the same NTFS inode and factors out the common
539 * information into a 'struct wim_inode', so this should make the
540 * mapping a little more obvious. As a NTFS file can have at most 1 DOS
541 * name, a WIM inode cannot have more than 1 dentry with a non-empty
542 * short name, and this is checked in the verify_inode() function in
543 * verify.c. Furthermore, a WIM dentry, if any, that has a DOS name
544 * must have a long name that corresponds to a Win32 name or Win32+DOS
547 * WIM dentries that have a long name but no associated short name are
548 * assumed to be in the POSIX namespace.
550 * So, given a WIM inode that is to map to a NTFS inode, we must apply
551 * the Win32 and DOS or Win32+DOS names, if they exist, then any
552 * additional (POSIX) names. A caveat when actually doing this: as
553 * confirmed by the libntfs-3g authors, ntfs_set_ntfs_dos_name() is only
554 * guaranteed to associate a DOS name with the appropriate long name if
555 * it's called when that long name is the only one in existence for that
556 * file. So, this implies that the correct ordering of function calls
557 * to extract a NTFS file are:
559 * if (file has a DOS name) {
560 * - Call ntfs_create() to create long name associated with
561 * the DOS name (this initially creates a POSIX name)
562 * - Call ntfs_set_ntfs_dos_name() to associate a DOS name
563 * with the long name just created. This either changes
564 * the POSIX name to Win32+DOS, or changes the POSIX name
565 * to Win32 and creates a separate DOS name.
567 * - Call ntfs_create() to create the first link to the
568 * file in the POSIX namespace
570 * - Call ntfs_link() to create the other names of the file, in the
575 if (!dentry->d_inode->i_dos_name_extracted &&
576 dentry->short_name_len == 0)
578 inode_for_each_dentry(other, dentry->d_inode) {
579 if (other->short_name_len != 0) {
580 orig_dentry = dentry;
586 dentry->d_inode->i_dos_name_extracted = 1;
587 ntfs_inode *dir_ni = dentry_open_parent_ni(dentry, vol);
589 ret = do_apply_dentry_ntfs(dentry, dir_ni, arg);
590 if (ret == 0 && orig_dentry != NULL) {
591 dentry = orig_dentry;
595 ret = WIMLIB_ERR_NTFS_3G;
600 /* Transfers the 100-nanosecond precision timestamps from a WIM dentry to a NTFS
602 int apply_dentry_timestamps_ntfs(struct wim_dentry *dentry, void *arg)
604 struct apply_args *args = arg;
605 ntfs_volume *vol = args->vol;
611 DEBUG("Setting timestamps on `%s'", dentry->full_path_utf8);
613 ni = ntfs_pathname_to_inode(vol, NULL, dentry->full_path_utf8);
615 ERROR_WITH_ERRNO("Could not find NTFS inode for `%s'",
616 dentry->full_path_utf8);
617 return WIMLIB_ERR_NTFS_3G;
621 p = put_u64(p, dentry->d_inode->i_creation_time);
622 p = put_u64(p, dentry->d_inode->i_last_write_time);
623 p = put_u64(p, dentry->d_inode->i_last_access_time);
624 ret = ntfs_inode_set_times(ni, (const char*)buf, 3 * sizeof(u64), 0);
626 ERROR_WITH_ERRNO("Failed to set NTFS timestamps on `%s'",
627 dentry->full_path_utf8);
628 ret = WIMLIB_ERR_NTFS_3G;
631 if (ntfs_inode_close(ni) != 0) {
633 ret = WIMLIB_ERR_NTFS_3G;
634 ERROR_WITH_ERRNO("Failed to close NTFS inode for `%s'",
635 dentry->full_path_utf8);