blob: ffb9b3675736334182e29b2b6e337f29efd8c5a7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/**
2 * inode.c - NTFS kernel inode handling. Part of the Linux-NTFS project.
3 *
Anton Altaparmakov83311912007-01-18 09:42:48 +00004 * Copyright (c) 2001-2007 Anton Altaparmakov
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * This program/include file is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as published
8 * by the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program/include file is distributed in the hope that it will be
12 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program (in the main directory of the Linux-NTFS
18 * distribution in the file COPYING); if not, write to the Free Software
19 * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/buffer_head.h>
Anton Altaparmakova778f212006-03-23 16:18:23 +000023#include <linux/fs.h>
24#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/mount.h>
Anton Altaparmakova0646a12006-03-23 15:53:03 +000026#include <linux/mutex.h>
Anton Altaparmakova778f212006-03-23 16:18:23 +000027#include <linux/pagemap.h>
28#include <linux/quotaops.h>
29#include <linux/slab.h>
Robert P. J. Day02d53412009-06-16 15:33:35 -070030#include <linux/log2.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -070031#include <linux/aio.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33#include "aops.h"
Anton Altaparmakova0646a12006-03-23 15:53:03 +000034#include "attrib.h"
Anton Altaparmakova778f212006-03-23 16:18:23 +000035#include "bitmap.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include "dir.h"
37#include "debug.h"
38#include "inode.h"
Anton Altaparmakovdd072332005-10-04 15:39:02 +010039#include "lcnalloc.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include "malloc.h"
41#include "mft.h"
42#include "time.h"
43#include "ntfs.h"
44
45/**
46 * ntfs_test_inode - compare two (possibly fake) inodes for equality
47 * @vi: vfs inode which to test
48 * @na: ntfs attribute which is being tested with
49 *
50 * Compare the ntfs attribute embedded in the ntfs specific part of the vfs
51 * inode @vi for equality with the ntfs attribute @na.
52 *
53 * If searching for the normal file/directory inode, set @na->type to AT_UNUSED.
54 * @na->name and @na->name_len are then ignored.
55 *
56 * Return 1 if the attributes match and 0 if not.
57 *
Al Viro5a3cd99282013-11-06 09:54:52 -050058 * NOTE: This function runs with the inode_hash_lock spin lock held so it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * allowed to sleep.
60 */
61int ntfs_test_inode(struct inode *vi, ntfs_attr *na)
62{
63 ntfs_inode *ni;
64
65 if (vi->i_ino != na->mft_no)
66 return 0;
67 ni = NTFS_I(vi);
68 /* If !NInoAttr(ni), @vi is a normal file or directory inode. */
69 if (likely(!NInoAttr(ni))) {
70 /* If not looking for a normal inode this is a mismatch. */
71 if (unlikely(na->type != AT_UNUSED))
72 return 0;
73 } else {
74 /* A fake inode describing an attribute. */
75 if (ni->type != na->type)
76 return 0;
77 if (ni->name_len != na->name_len)
78 return 0;
79 if (na->name_len && memcmp(ni->name, na->name,
80 na->name_len * sizeof(ntfschar)))
81 return 0;
82 }
83 /* Match! */
84 return 1;
85}
86
87/**
88 * ntfs_init_locked_inode - initialize an inode
89 * @vi: vfs inode to initialize
90 * @na: ntfs attribute which to initialize @vi to
91 *
92 * Initialize the vfs inode @vi with the values from the ntfs attribute @na in
93 * order to enable ntfs_test_inode() to do its work.
94 *
95 * If initializing the normal file/directory inode, set @na->type to AT_UNUSED.
96 * In that case, @na->name and @na->name_len should be set to NULL and 0,
97 * respectively. Although that is not strictly necessary as
Anton Altaparmakov83311912007-01-18 09:42:48 +000098 * ntfs_read_locked_inode() will fill them in later.
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 *
100 * Return 0 on success and -errno on error.
101 *
Dave Chinner67a23c42011-03-22 22:23:42 +1100102 * NOTE: This function runs with the inode->i_lock spin lock held so it is not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * allowed to sleep. (Hence the GFP_ATOMIC allocation.)
104 */
105static int ntfs_init_locked_inode(struct inode *vi, ntfs_attr *na)
106{
107 ntfs_inode *ni = NTFS_I(vi);
108
109 vi->i_ino = na->mft_no;
110
111 ni->type = na->type;
112 if (na->type == AT_INDEX_ALLOCATION)
113 NInoSetMstProtected(ni);
114
115 ni->name = na->name;
116 ni->name_len = na->name_len;
117
118 /* If initializing a normal inode, we are done. */
119 if (likely(na->type == AT_UNUSED)) {
120 BUG_ON(na->name);
121 BUG_ON(na->name_len);
122 return 0;
123 }
124
125 /* It is a fake inode. */
126 NInoSetAttr(ni);
127
128 /*
129 * We have I30 global constant as an optimization as it is the name
130 * in >99.9% of named attributes! The other <0.1% incur a GFP_ATOMIC
131 * allocation but that is ok. And most attributes are unnamed anyway,
132 * thus the fraction of named attributes with name != I30 is actually
133 * absolutely tiny.
134 */
135 if (na->name_len && na->name != I30) {
136 unsigned int i;
137
138 BUG_ON(!na->name);
139 i = na->name_len * sizeof(ntfschar);
Panagiotis Issarisf52720c2006-09-27 01:49:39 -0700140 ni->name = kmalloc(i + sizeof(ntfschar), GFP_ATOMIC);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 if (!ni->name)
142 return -ENOMEM;
143 memcpy(ni->name, na->name, i);
Andrew Morton1fc799e2007-05-31 00:40:49 -0700144 ni->name[na->name_len] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 }
146 return 0;
147}
148
149typedef int (*set_t)(struct inode *, void *);
150static int ntfs_read_locked_inode(struct inode *vi);
151static int ntfs_read_locked_attr_inode(struct inode *base_vi, struct inode *vi);
152static int ntfs_read_locked_index_inode(struct inode *base_vi,
153 struct inode *vi);
154
155/**
156 * ntfs_iget - obtain a struct inode corresponding to a specific normal inode
157 * @sb: super block of mounted volume
158 * @mft_no: mft record number / inode number to obtain
159 *
160 * Obtain the struct inode corresponding to a specific normal inode (i.e. a
161 * file or directory).
162 *
163 * If the inode is in the cache, it is just returned with an increased
164 * reference count. Otherwise, a new struct inode is allocated and initialized,
165 * and finally ntfs_read_locked_inode() is called to read in the inode and
166 * fill in the remainder of the inode structure.
167 *
168 * Return the struct inode on success. Check the return value with IS_ERR() and
169 * if true, the function failed and the error code is obtained from PTR_ERR().
170 */
171struct inode *ntfs_iget(struct super_block *sb, unsigned long mft_no)
172{
173 struct inode *vi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 int err;
Anton Altaparmakov83311912007-01-18 09:42:48 +0000175 ntfs_attr na;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 na.mft_no = mft_no;
178 na.type = AT_UNUSED;
179 na.name = NULL;
180 na.name_len = 0;
181
182 vi = iget5_locked(sb, mft_no, (test_t)ntfs_test_inode,
183 (set_t)ntfs_init_locked_inode, &na);
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000184 if (unlikely(!vi))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 return ERR_PTR(-ENOMEM);
186
187 err = 0;
188
189 /* If this is a freshly allocated inode, need to read it now. */
190 if (vi->i_state & I_NEW) {
191 err = ntfs_read_locked_inode(vi);
192 unlock_new_inode(vi);
193 }
194 /*
195 * There is no point in keeping bad inodes around if the failure was
196 * due to ENOMEM. We want to be able to retry again later.
197 */
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000198 if (unlikely(err == -ENOMEM)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 iput(vi);
200 vi = ERR_PTR(err);
201 }
202 return vi;
203}
204
205/**
206 * ntfs_attr_iget - obtain a struct inode corresponding to an attribute
207 * @base_vi: vfs base inode containing the attribute
208 * @type: attribute type
209 * @name: Unicode name of the attribute (NULL if unnamed)
210 * @name_len: length of @name in Unicode characters (0 if unnamed)
211 *
212 * Obtain the (fake) struct inode corresponding to the attribute specified by
213 * @type, @name, and @name_len, which is present in the base mft record
214 * specified by the vfs inode @base_vi.
215 *
216 * If the attribute inode is in the cache, it is just returned with an
217 * increased reference count. Otherwise, a new struct inode is allocated and
218 * initialized, and finally ntfs_read_locked_attr_inode() is called to read the
219 * attribute and fill in the inode structure.
220 *
221 * Note, for index allocation attributes, you need to use ntfs_index_iget()
222 * instead of ntfs_attr_iget() as working with indices is a lot more complex.
223 *
224 * Return the struct inode of the attribute inode on success. Check the return
225 * value with IS_ERR() and if true, the function failed and the error code is
226 * obtained from PTR_ERR().
227 */
228struct inode *ntfs_attr_iget(struct inode *base_vi, ATTR_TYPE type,
229 ntfschar *name, u32 name_len)
230{
231 struct inode *vi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 int err;
Anton Altaparmakov83311912007-01-18 09:42:48 +0000233 ntfs_attr na;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 /* Make sure no one calls ntfs_attr_iget() for indices. */
236 BUG_ON(type == AT_INDEX_ALLOCATION);
237
238 na.mft_no = base_vi->i_ino;
239 na.type = type;
240 na.name = name;
241 na.name_len = name_len;
242
243 vi = iget5_locked(base_vi->i_sb, na.mft_no, (test_t)ntfs_test_inode,
244 (set_t)ntfs_init_locked_inode, &na);
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000245 if (unlikely(!vi))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 return ERR_PTR(-ENOMEM);
247
248 err = 0;
249
250 /* If this is a freshly allocated inode, need to read it now. */
251 if (vi->i_state & I_NEW) {
252 err = ntfs_read_locked_attr_inode(base_vi, vi);
253 unlock_new_inode(vi);
254 }
255 /*
256 * There is no point in keeping bad attribute inodes around. This also
257 * simplifies things in that we never need to check for bad attribute
258 * inodes elsewhere.
259 */
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000260 if (unlikely(err)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 iput(vi);
262 vi = ERR_PTR(err);
263 }
264 return vi;
265}
266
267/**
268 * ntfs_index_iget - obtain a struct inode corresponding to an index
269 * @base_vi: vfs base inode containing the index related attributes
270 * @name: Unicode name of the index
271 * @name_len: length of @name in Unicode characters
272 *
273 * Obtain the (fake) struct inode corresponding to the index specified by @name
274 * and @name_len, which is present in the base mft record specified by the vfs
275 * inode @base_vi.
276 *
277 * If the index inode is in the cache, it is just returned with an increased
278 * reference count. Otherwise, a new struct inode is allocated and
279 * initialized, and finally ntfs_read_locked_index_inode() is called to read
280 * the index related attributes and fill in the inode structure.
281 *
282 * Return the struct inode of the index inode on success. Check the return
283 * value with IS_ERR() and if true, the function failed and the error code is
284 * obtained from PTR_ERR().
285 */
286struct inode *ntfs_index_iget(struct inode *base_vi, ntfschar *name,
287 u32 name_len)
288{
289 struct inode *vi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 int err;
Anton Altaparmakov83311912007-01-18 09:42:48 +0000291 ntfs_attr na;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
293 na.mft_no = base_vi->i_ino;
294 na.type = AT_INDEX_ALLOCATION;
295 na.name = name;
296 na.name_len = name_len;
297
298 vi = iget5_locked(base_vi->i_sb, na.mft_no, (test_t)ntfs_test_inode,
299 (set_t)ntfs_init_locked_inode, &na);
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000300 if (unlikely(!vi))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 return ERR_PTR(-ENOMEM);
302
303 err = 0;
304
305 /* If this is a freshly allocated inode, need to read it now. */
306 if (vi->i_state & I_NEW) {
307 err = ntfs_read_locked_index_inode(base_vi, vi);
308 unlock_new_inode(vi);
309 }
310 /*
311 * There is no point in keeping bad index inodes around. This also
312 * simplifies things in that we never need to check for bad index
313 * inodes elsewhere.
314 */
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000315 if (unlikely(err)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 iput(vi);
317 vi = ERR_PTR(err);
318 }
319 return vi;
320}
321
322struct inode *ntfs_alloc_big_inode(struct super_block *sb)
323{
324 ntfs_inode *ni;
325
326 ntfs_debug("Entering.");
Christoph Lametere6b4f8d2006-12-06 20:33:14 -0800327 ni = kmem_cache_alloc(ntfs_big_inode_cache, GFP_NOFS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 if (likely(ni != NULL)) {
329 ni->state = 0;
330 return VFS_I(ni);
331 }
332 ntfs_error(sb, "Allocation of NTFS big inode structure failed.");
333 return NULL;
334}
335
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100336static void ntfs_i_callback(struct rcu_head *head)
337{
338 struct inode *inode = container_of(head, struct inode, i_rcu);
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100339 kmem_cache_free(ntfs_big_inode_cache, NTFS_I(inode));
340}
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342void ntfs_destroy_big_inode(struct inode *inode)
343{
344 ntfs_inode *ni = NTFS_I(inode);
345
346 ntfs_debug("Entering.");
347 BUG_ON(ni->page);
348 if (!atomic_dec_and_test(&ni->count))
349 BUG();
Nick Pigginfa0d7e3d2011-01-07 17:49:49 +1100350 call_rcu(&inode->i_rcu, ntfs_i_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
353static inline ntfs_inode *ntfs_alloc_extent_inode(void)
354{
355 ntfs_inode *ni;
356
357 ntfs_debug("Entering.");
Christoph Lametere6b4f8d2006-12-06 20:33:14 -0800358 ni = kmem_cache_alloc(ntfs_inode_cache, GFP_NOFS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 if (likely(ni != NULL)) {
360 ni->state = 0;
361 return ni;
362 }
363 ntfs_error(NULL, "Allocation of NTFS inode structure failed.");
364 return NULL;
365}
366
367static void ntfs_destroy_extent_inode(ntfs_inode *ni)
368{
369 ntfs_debug("Entering.");
370 BUG_ON(ni->page);
371 if (!atomic_dec_and_test(&ni->count))
372 BUG();
373 kmem_cache_free(ntfs_inode_cache, ni);
374}
375
Ingo Molnar59345372006-07-03 00:25:18 -0700376/*
377 * The attribute runlist lock has separate locking rules from the
378 * normal runlist lock, so split the two lock-classes:
379 */
380static struct lock_class_key attr_list_rl_lock_class;
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382/**
383 * __ntfs_init_inode - initialize ntfs specific part of an inode
384 * @sb: super block of mounted volume
385 * @ni: freshly allocated ntfs inode which to initialize
386 *
387 * Initialize an ntfs inode to defaults.
388 *
389 * NOTE: ni->mft_no, ni->state, ni->type, ni->name, and ni->name_len are left
390 * untouched. Make sure to initialize them elsewhere.
391 *
392 * Return zero on success and -ENOMEM on error.
393 */
394void __ntfs_init_inode(struct super_block *sb, ntfs_inode *ni)
395{
396 ntfs_debug("Entering.");
Anton Altaparmakov36763672004-11-18 13:46:45 +0000397 rwlock_init(&ni->size_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 ni->initialized_size = ni->allocated_size = 0;
399 ni->seq_no = 0;
400 atomic_set(&ni->count, 1);
401 ni->vol = NTFS_SB(sb);
402 ntfs_init_runlist(&ni->runlist);
Ingo Molnar4e5e5292006-03-23 16:57:48 +0000403 mutex_init(&ni->mrec_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 ni->page = NULL;
405 ni->page_ofs = 0;
406 ni->attr_list_size = 0;
407 ni->attr_list = NULL;
408 ntfs_init_runlist(&ni->attr_list_rl);
Ingo Molnar59345372006-07-03 00:25:18 -0700409 lockdep_set_class(&ni->attr_list_rl.lock,
410 &attr_list_rl_lock_class);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 ni->itype.index.block_size = 0;
412 ni->itype.index.vcn_size = 0;
413 ni->itype.index.collation_rule = 0;
414 ni->itype.index.block_size_bits = 0;
415 ni->itype.index.vcn_size_bits = 0;
Ingo Molnar4e5e5292006-03-23 16:57:48 +0000416 mutex_init(&ni->extent_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 ni->nr_extents = 0;
418 ni->ext.base_ntfs_ino = NULL;
419}
420
Ingo Molnar59345372006-07-03 00:25:18 -0700421/*
422 * Extent inodes get MFT-mapped in a nested way, while the base inode
423 * is still mapped. Teach this nesting to the lock validator by creating
424 * a separate class for nested inode's mrec_lock's:
425 */
426static struct lock_class_key extent_inode_mrec_lock_key;
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428inline ntfs_inode *ntfs_new_extent_inode(struct super_block *sb,
429 unsigned long mft_no)
430{
431 ntfs_inode *ni = ntfs_alloc_extent_inode();
432
433 ntfs_debug("Entering.");
434 if (likely(ni != NULL)) {
435 __ntfs_init_inode(sb, ni);
Ingo Molnar59345372006-07-03 00:25:18 -0700436 lockdep_set_class(&ni->mrec_lock, &extent_inode_mrec_lock_key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 ni->mft_no = mft_no;
438 ni->type = AT_UNUSED;
439 ni->name = NULL;
440 ni->name_len = 0;
441 }
442 return ni;
443}
444
445/**
446 * ntfs_is_extended_system_file - check if a file is in the $Extend directory
447 * @ctx: initialized attribute search context
448 *
449 * Search all file name attributes in the inode described by the attribute
450 * search context @ctx and check if any of the names are in the $Extend system
451 * directory.
452 *
453 * Return values:
454 * 1: file is in $Extend directory
455 * 0: file is not in $Extend directory
456 * -errno: failed to determine if the file is in the $Extend directory
457 */
458static int ntfs_is_extended_system_file(ntfs_attr_search_ctx *ctx)
459{
460 int nr_links, err;
461
462 /* Restart search. */
463 ntfs_attr_reinit_search_ctx(ctx);
464
465 /* Get number of hard links. */
466 nr_links = le16_to_cpu(ctx->mrec->link_count);
467
468 /* Loop through all hard links. */
469 while (!(err = ntfs_attr_lookup(AT_FILE_NAME, NULL, 0, 0, 0, NULL, 0,
470 ctx))) {
471 FILE_NAME_ATTR *file_name_attr;
472 ATTR_RECORD *attr = ctx->attr;
473 u8 *p, *p2;
474
475 nr_links--;
476 /*
477 * Maximum sanity checking as we are called on an inode that
478 * we suspect might be corrupt.
479 */
480 p = (u8*)attr + le32_to_cpu(attr->length);
481 if (p < (u8*)ctx->mrec || (u8*)p > (u8*)ctx->mrec +
482 le32_to_cpu(ctx->mrec->bytes_in_use)) {
483err_corrupt_attr:
484 ntfs_error(ctx->ntfs_ino->vol->sb, "Corrupt file name "
485 "attribute. You should run chkdsk.");
486 return -EIO;
487 }
488 if (attr->non_resident) {
489 ntfs_error(ctx->ntfs_ino->vol->sb, "Non-resident file "
490 "name. You should run chkdsk.");
491 return -EIO;
492 }
493 if (attr->flags) {
494 ntfs_error(ctx->ntfs_ino->vol->sb, "File name with "
495 "invalid flags. You should run "
496 "chkdsk.");
497 return -EIO;
498 }
499 if (!(attr->data.resident.flags & RESIDENT_ATTR_IS_INDEXED)) {
500 ntfs_error(ctx->ntfs_ino->vol->sb, "Unindexed file "
501 "name. You should run chkdsk.");
502 return -EIO;
503 }
504 file_name_attr = (FILE_NAME_ATTR*)((u8*)attr +
505 le16_to_cpu(attr->data.resident.value_offset));
506 p2 = (u8*)attr + le32_to_cpu(attr->data.resident.value_length);
507 if (p2 < (u8*)attr || p2 > p)
508 goto err_corrupt_attr;
509 /* This attribute is ok, but is it in the $Extend directory? */
510 if (MREF_LE(file_name_attr->parent_directory) == FILE_Extend)
511 return 1; /* YES, it's an extended system file. */
512 }
513 if (unlikely(err != -ENOENT))
514 return err;
515 if (unlikely(nr_links)) {
516 ntfs_error(ctx->ntfs_ino->vol->sb, "Inode hard link count "
517 "doesn't match number of name attributes. You "
518 "should run chkdsk.");
519 return -EIO;
520 }
521 return 0; /* NO, it is not an extended system file. */
522}
523
524/**
525 * ntfs_read_locked_inode - read an inode from its device
526 * @vi: inode to read
527 *
528 * ntfs_read_locked_inode() is called from ntfs_iget() to read the inode
529 * described by @vi into memory from the device.
530 *
531 * The only fields in @vi that we need to/can look at when the function is
532 * called are i_sb, pointing to the mounted device's super block, and i_ino,
533 * the number of the inode to load.
534 *
535 * ntfs_read_locked_inode() maps, pins and locks the mft record number i_ino
536 * for reading and sets up the necessary @vi fields as well as initializing
537 * the ntfs inode.
538 *
539 * Q: What locks are held when the function is called?
Christoph Hellwigeaff8072009-12-17 14:25:01 +0100540 * A: i_state has I_NEW set, hence the inode is locked, also
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 * i_count is set to 1, so it is not going to go away
542 * i_flags is set to 0 and we have no business touching it. Only an ioctl()
543 * is allowed to write to them. We should of course be honouring them but
544 * we need to do that using the IS_* macros defined in include/linux/fs.h.
545 * In any case ntfs_read_locked_inode() has nothing to do with i_flags.
546 *
547 * Return 0 on success and -errno on error. In the error case, the inode will
548 * have had make_bad_inode() executed on it.
549 */
550static int ntfs_read_locked_inode(struct inode *vi)
551{
552 ntfs_volume *vol = NTFS_SB(vi->i_sb);
553 ntfs_inode *ni;
Anton Altaparmakov83311912007-01-18 09:42:48 +0000554 struct inode *bvi;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 MFT_RECORD *m;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000556 ATTR_RECORD *a;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 STANDARD_INFORMATION *si;
558 ntfs_attr_search_ctx *ctx;
559 int err = 0;
560
561 ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
562
563 /* Setup the generic vfs inode parts now. */
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 /*
566 * This is for checking whether an inode has changed w.r.t. a file so
567 * that the file can be updated if necessary (compare with f_version).
568 */
569 vi->i_version = 1;
570
571 vi->i_uid = vol->uid;
572 vi->i_gid = vol->gid;
573 vi->i_mode = 0;
574
575 /*
576 * Initialize the ntfs specific part of @vi special casing
577 * FILE_MFT which we need to do at mount time.
578 */
579 if (vi->i_ino != FILE_MFT)
580 ntfs_init_big_inode(vi);
581 ni = NTFS_I(vi);
582
583 m = map_mft_record(ni);
584 if (IS_ERR(m)) {
585 err = PTR_ERR(m);
586 goto err_out;
587 }
588 ctx = ntfs_attr_get_search_ctx(ni, m);
589 if (!ctx) {
590 err = -ENOMEM;
591 goto unm_err_out;
592 }
593
594 if (!(m->flags & MFT_RECORD_IN_USE)) {
595 ntfs_error(vi->i_sb, "Inode is not in use!");
596 goto unm_err_out;
597 }
598 if (m->base_mft_record) {
599 ntfs_error(vi->i_sb, "Inode is an extent inode!");
600 goto unm_err_out;
601 }
602
603 /* Transfer information from mft record into vfs and ntfs inodes. */
604 vi->i_generation = ni->seq_no = le16_to_cpu(m->sequence_number);
605
606 /*
607 * FIXME: Keep in mind that link_count is two for files which have both
608 * a long file name and a short file name as separate entries, so if
609 * we are hiding short file names this will be too high. Either we need
610 * to account for the short file names by subtracting them or we need
611 * to make sure we delete files even though i_nlink is not zero which
612 * might be tricky due to vfs interactions. Need to think about this
613 * some more when implementing the unlink command.
614 */
Miklos Szeredibfe86842011-10-28 14:13:29 +0200615 set_nlink(vi, le16_to_cpu(m->link_count));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 /*
617 * FIXME: Reparse points can have the directory bit set even though
618 * they would be S_IFLNK. Need to deal with this further below when we
619 * implement reparse points / symbolic links but it will do for now.
620 * Also if not a directory, it could be something else, rather than
621 * a regular file. But again, will do for now.
622 */
623 /* Everyone gets all permissions. */
624 vi->i_mode |= S_IRWXUGO;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300625 /* If read-only, no one gets write permissions. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 if (IS_RDONLY(vi))
627 vi->i_mode &= ~S_IWUGO;
628 if (m->flags & MFT_RECORD_IS_DIRECTORY) {
629 vi->i_mode |= S_IFDIR;
630 /*
631 * Apply the directory permissions mask set in the mount
632 * options.
633 */
634 vi->i_mode &= ~vol->dmask;
635 /* Things break without this kludge! */
636 if (vi->i_nlink > 1)
Miklos Szeredibfe86842011-10-28 14:13:29 +0200637 set_nlink(vi, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 } else {
639 vi->i_mode |= S_IFREG;
640 /* Apply the file permissions mask set in the mount options. */
641 vi->i_mode &= ~vol->fmask;
642 }
643 /*
644 * Find the standard information attribute in the mft record. At this
645 * stage we haven't setup the attribute list stuff yet, so this could
646 * in fact fail if the standard information is in an extent record, but
647 * I don't think this actually ever happens.
648 */
649 err = ntfs_attr_lookup(AT_STANDARD_INFORMATION, NULL, 0, 0, 0, NULL, 0,
650 ctx);
651 if (unlikely(err)) {
652 if (err == -ENOENT) {
653 /*
654 * TODO: We should be performing a hot fix here (if the
655 * recover mount option is set) by creating a new
656 * attribute.
657 */
658 ntfs_error(vi->i_sb, "$STANDARD_INFORMATION attribute "
659 "is missing.");
660 }
661 goto unm_err_out;
662 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000663 a = ctx->attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 /* Get the standard information attribute value. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000665 si = (STANDARD_INFORMATION*)((u8*)a +
666 le16_to_cpu(a->data.resident.value_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 /* Transfer information from the standard information into vi. */
669 /*
670 * Note: The i_?times do not quite map perfectly onto the NTFS times,
671 * but they are close enough, and in the end it doesn't really matter
672 * that much...
673 */
674 /*
675 * mtime is the last change of the data within the file. Not changed
676 * when only metadata is changed, e.g. a rename doesn't affect mtime.
677 */
678 vi->i_mtime = ntfs2utc(si->last_data_change_time);
679 /*
680 * ctime is the last change of the metadata of the file. This obviously
681 * always changes, when mtime is changed. ctime can be changed on its
682 * own, mtime is then not changed, e.g. when a file is renamed.
683 */
684 vi->i_ctime = ntfs2utc(si->last_mft_change_time);
685 /*
686 * Last access to the data within the file. Not changed during a rename
687 * for example but changed whenever the file is written to.
688 */
689 vi->i_atime = ntfs2utc(si->last_access_time);
690
691 /* Find the attribute list attribute if present. */
692 ntfs_attr_reinit_search_ctx(ctx);
693 err = ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, 0, 0, NULL, 0, ctx);
694 if (err) {
695 if (unlikely(err != -ENOENT)) {
696 ntfs_error(vi->i_sb, "Failed to lookup attribute list "
697 "attribute.");
698 goto unm_err_out;
699 }
700 } else /* if (!err) */ {
701 if (vi->i_ino == FILE_MFT)
702 goto skip_attr_list_load;
703 ntfs_debug("Attribute list found in inode 0x%lx.", vi->i_ino);
704 NInoSetAttrList(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000705 a = ctx->attr;
Anton Altaparmakov3672b632006-02-24 09:55:07 +0000706 if (a->flags & ATTR_COMPRESSION_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 ntfs_error(vi->i_sb, "Attribute list attribute is "
Anton Altaparmakov3672b632006-02-24 09:55:07 +0000708 "compressed.");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 goto unm_err_out;
710 }
Anton Altaparmakov3672b632006-02-24 09:55:07 +0000711 if (a->flags & ATTR_IS_ENCRYPTED ||
712 a->flags & ATTR_IS_SPARSE) {
713 if (a->non_resident) {
714 ntfs_error(vi->i_sb, "Non-resident attribute "
715 "list attribute is encrypted/"
716 "sparse.");
717 goto unm_err_out;
718 }
719 ntfs_warning(vi->i_sb, "Resident attribute list "
720 "attribute in inode 0x%lx is marked "
721 "encrypted/sparse which is not true. "
722 "However, Windows allows this and "
723 "chkdsk does not detect or correct it "
724 "so we will just ignore the invalid "
725 "flags and pretend they are not set.",
726 vi->i_ino);
727 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 /* Now allocate memory for the attribute list. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000729 ni->attr_list_size = (u32)ntfs_attr_size(a);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 ni->attr_list = ntfs_malloc_nofs(ni->attr_list_size);
731 if (!ni->attr_list) {
732 ntfs_error(vi->i_sb, "Not enough memory to allocate "
733 "buffer for attribute list.");
734 err = -ENOMEM;
735 goto unm_err_out;
736 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000737 if (a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 NInoSetAttrListNonResident(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000739 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 ntfs_error(vi->i_sb, "Attribute list has non "
741 "zero lowest_vcn.");
742 goto unm_err_out;
743 }
744 /*
745 * Setup the runlist. No need for locking as we have
746 * exclusive access to the inode at this time.
747 */
748 ni->attr_list_rl.rl = ntfs_mapping_pairs_decompress(vol,
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000749 a, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 if (IS_ERR(ni->attr_list_rl.rl)) {
751 err = PTR_ERR(ni->attr_list_rl.rl);
752 ni->attr_list_rl.rl = NULL;
753 ntfs_error(vi->i_sb, "Mapping pairs "
754 "decompression failed.");
755 goto unm_err_out;
756 }
757 /* Now load the attribute list. */
758 if ((err = load_attribute_list(vol, &ni->attr_list_rl,
759 ni->attr_list, ni->attr_list_size,
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000760 sle64_to_cpu(a->data.non_resident.
761 initialized_size)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 ntfs_error(vi->i_sb, "Failed to load "
763 "attribute list attribute.");
764 goto unm_err_out;
765 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000766 } else /* if (!a->non_resident) */ {
767 if ((u8*)a + le16_to_cpu(a->data.resident.value_offset)
768 + le32_to_cpu(
769 a->data.resident.value_length) >
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 (u8*)ctx->mrec + vol->mft_record_size) {
771 ntfs_error(vi->i_sb, "Corrupt attribute list "
772 "in inode.");
773 goto unm_err_out;
774 }
775 /* Now copy the attribute list. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000776 memcpy(ni->attr_list, (u8*)a + le16_to_cpu(
777 a->data.resident.value_offset),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 le32_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000779 a->data.resident.value_length));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
781 }
782skip_attr_list_load:
783 /*
784 * If an attribute list is present we now have the attribute list value
785 * in ntfs_ino->attr_list and it is ntfs_ino->attr_list_size bytes.
786 */
787 if (S_ISDIR(vi->i_mode)) {
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +0000788 loff_t bvi_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 ntfs_inode *bni;
790 INDEX_ROOT *ir;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000791 u8 *ir_end, *index_end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793 /* It is a directory, find index root attribute. */
794 ntfs_attr_reinit_search_ctx(ctx);
795 err = ntfs_attr_lookup(AT_INDEX_ROOT, I30, 4, CASE_SENSITIVE,
796 0, NULL, 0, ctx);
797 if (unlikely(err)) {
798 if (err == -ENOENT) {
799 // FIXME: File is corrupt! Hot-fix with empty
800 // index root attribute if recovery option is
801 // set.
802 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute "
803 "is missing.");
804 }
805 goto unm_err_out;
806 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000807 a = ctx->attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 /* Set up the state. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000809 if (unlikely(a->non_resident)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 ntfs_error(vol->sb, "$INDEX_ROOT attribute is not "
811 "resident.");
812 goto unm_err_out;
813 }
814 /* Ensure the attribute name is placed before the value. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000815 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
816 le16_to_cpu(a->data.resident.value_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 ntfs_error(vol->sb, "$INDEX_ROOT attribute name is "
818 "placed after the attribute value.");
819 goto unm_err_out;
820 }
821 /*
822 * Compressed/encrypted index root just means that the newly
823 * created files in that directory should be created compressed/
824 * encrypted. However index root cannot be both compressed and
825 * encrypted.
826 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000827 if (a->flags & ATTR_COMPRESSION_MASK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 NInoSetCompressed(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000829 if (a->flags & ATTR_IS_ENCRYPTED) {
830 if (a->flags & ATTR_COMPRESSION_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 ntfs_error(vi->i_sb, "Found encrypted and "
832 "compressed attribute.");
833 goto unm_err_out;
834 }
835 NInoSetEncrypted(ni);
836 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000837 if (a->flags & ATTR_IS_SPARSE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 NInoSetSparse(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000839 ir = (INDEX_ROOT*)((u8*)a +
840 le16_to_cpu(a->data.resident.value_offset));
841 ir_end = (u8*)ir + le32_to_cpu(a->data.resident.value_length);
842 if (ir_end > (u8*)ctx->mrec + vol->mft_record_size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is "
844 "corrupt.");
845 goto unm_err_out;
846 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000847 index_end = (u8*)&ir->index +
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 le32_to_cpu(ir->index.index_length);
849 if (index_end > ir_end) {
850 ntfs_error(vi->i_sb, "Directory index is corrupt.");
851 goto unm_err_out;
852 }
853 if (ir->type != AT_FILE_NAME) {
854 ntfs_error(vi->i_sb, "Indexed attribute is not "
855 "$FILE_NAME.");
856 goto unm_err_out;
857 }
858 if (ir->collation_rule != COLLATION_FILE_NAME) {
859 ntfs_error(vi->i_sb, "Index collation rule is not "
860 "COLLATION_FILE_NAME.");
861 goto unm_err_out;
862 }
863 ni->itype.index.collation_rule = ir->collation_rule;
864 ni->itype.index.block_size = le32_to_cpu(ir->index_block_size);
865 if (ni->itype.index.block_size &
866 (ni->itype.index.block_size - 1)) {
867 ntfs_error(vi->i_sb, "Index block size (%u) is not a "
868 "power of two.",
869 ni->itype.index.block_size);
870 goto unm_err_out;
871 }
872 if (ni->itype.index.block_size > PAGE_CACHE_SIZE) {
873 ntfs_error(vi->i_sb, "Index block size (%u) > "
874 "PAGE_CACHE_SIZE (%ld) is not "
875 "supported. Sorry.",
876 ni->itype.index.block_size,
877 PAGE_CACHE_SIZE);
878 err = -EOPNOTSUPP;
879 goto unm_err_out;
880 }
881 if (ni->itype.index.block_size < NTFS_BLOCK_SIZE) {
882 ntfs_error(vi->i_sb, "Index block size (%u) < "
883 "NTFS_BLOCK_SIZE (%i) is not "
884 "supported. Sorry.",
885 ni->itype.index.block_size,
886 NTFS_BLOCK_SIZE);
887 err = -EOPNOTSUPP;
888 goto unm_err_out;
889 }
890 ni->itype.index.block_size_bits =
891 ffs(ni->itype.index.block_size) - 1;
892 /* Determine the size of a vcn in the directory index. */
893 if (vol->cluster_size <= ni->itype.index.block_size) {
894 ni->itype.index.vcn_size = vol->cluster_size;
895 ni->itype.index.vcn_size_bits = vol->cluster_size_bits;
896 } else {
897 ni->itype.index.vcn_size = vol->sector_size;
898 ni->itype.index.vcn_size_bits = vol->sector_size_bits;
899 }
900
901 /* Setup the index allocation attribute, even if not present. */
902 NInoSetMstProtected(ni);
903 ni->type = AT_INDEX_ALLOCATION;
904 ni->name = I30;
905 ni->name_len = 4;
906
907 if (!(ir->index.flags & LARGE_INDEX)) {
908 /* No index allocation. */
909 vi->i_size = ni->initialized_size =
910 ni->allocated_size = 0;
911 /* We are done with the mft record, so we release it. */
912 ntfs_attr_put_search_ctx(ctx);
913 unmap_mft_record(ni);
914 m = NULL;
915 ctx = NULL;
916 goto skip_large_dir_stuff;
917 } /* LARGE_INDEX: Index allocation present. Setup state. */
918 NInoSetIndexAllocPresent(ni);
919 /* Find index allocation attribute. */
920 ntfs_attr_reinit_search_ctx(ctx);
921 err = ntfs_attr_lookup(AT_INDEX_ALLOCATION, I30, 4,
922 CASE_SENSITIVE, 0, NULL, 0, ctx);
923 if (unlikely(err)) {
924 if (err == -ENOENT)
925 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION "
926 "attribute is not present but "
927 "$INDEX_ROOT indicated it is.");
928 else
929 ntfs_error(vi->i_sb, "Failed to lookup "
930 "$INDEX_ALLOCATION "
931 "attribute.");
932 goto unm_err_out;
933 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000934 a = ctx->attr;
935 if (!a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
937 "is resident.");
938 goto unm_err_out;
939 }
940 /*
941 * Ensure the attribute name is placed before the mapping pairs
942 * array.
943 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000944 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
945 le16_to_cpu(
946 a->data.non_resident.mapping_pairs_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 ntfs_error(vol->sb, "$INDEX_ALLOCATION attribute name "
948 "is placed after the mapping pairs "
949 "array.");
950 goto unm_err_out;
951 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000952 if (a->flags & ATTR_IS_ENCRYPTED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
954 "is encrypted.");
955 goto unm_err_out;
956 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000957 if (a->flags & ATTR_IS_SPARSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
959 "is sparse.");
960 goto unm_err_out;
961 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000962 if (a->flags & ATTR_COMPRESSION_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
964 "is compressed.");
965 goto unm_err_out;
966 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000967 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 ntfs_error(vi->i_sb, "First extent of "
969 "$INDEX_ALLOCATION attribute has non "
970 "zero lowest_vcn.");
971 goto unm_err_out;
972 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000973 vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 ni->initialized_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000975 a->data.non_resident.initialized_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 ni->allocated_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +0000977 a->data.non_resident.allocated_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 /*
979 * We are done with the mft record, so we release it. Otherwise
980 * we would deadlock in ntfs_attr_iget().
981 */
982 ntfs_attr_put_search_ctx(ctx);
983 unmap_mft_record(ni);
984 m = NULL;
985 ctx = NULL;
986 /* Get the index bitmap attribute inode. */
987 bvi = ntfs_attr_iget(vi, AT_BITMAP, I30, 4);
988 if (IS_ERR(bvi)) {
989 ntfs_error(vi->i_sb, "Failed to get bitmap attribute.");
990 err = PTR_ERR(bvi);
991 goto unm_err_out;
992 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 bni = NTFS_I(bvi);
994 if (NInoCompressed(bni) || NInoEncrypted(bni) ||
995 NInoSparse(bni)) {
996 ntfs_error(vi->i_sb, "$BITMAP attribute is compressed "
997 "and/or encrypted and/or sparse.");
Anton Altaparmakov83311912007-01-18 09:42:48 +0000998 goto iput_unm_err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 }
1000 /* Consistency check bitmap size vs. index allocation size. */
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +00001001 bvi_size = i_size_read(bvi);
1002 if ((bvi_size << 3) < (vi->i_size >>
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 ni->itype.index.block_size_bits)) {
1004 ntfs_error(vi->i_sb, "Index bitmap too small (0x%llx) "
1005 "for index allocation (0x%llx).",
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +00001006 bvi_size << 3, vi->i_size);
Anton Altaparmakov83311912007-01-18 09:42:48 +00001007 goto iput_unm_err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 }
Anton Altaparmakov83311912007-01-18 09:42:48 +00001009 /* No longer need the bitmap attribute inode. */
1010 iput(bvi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011skip_large_dir_stuff:
1012 /* Setup the operations for this inode. */
1013 vi->i_op = &ntfs_dir_inode_ops;
1014 vi->i_fop = &ntfs_dir_ops;
1015 } else {
1016 /* It is a file. */
1017 ntfs_attr_reinit_search_ctx(ctx);
1018
1019 /* Setup the data attribute, even if not present. */
1020 ni->type = AT_DATA;
1021 ni->name = NULL;
1022 ni->name_len = 0;
1023
1024 /* Find first extent of the unnamed data attribute. */
1025 err = ntfs_attr_lookup(AT_DATA, NULL, 0, 0, 0, NULL, 0, ctx);
1026 if (unlikely(err)) {
1027 vi->i_size = ni->initialized_size =
1028 ni->allocated_size = 0;
1029 if (err != -ENOENT) {
1030 ntfs_error(vi->i_sb, "Failed to lookup $DATA "
1031 "attribute.");
1032 goto unm_err_out;
1033 }
1034 /*
1035 * FILE_Secure does not have an unnamed $DATA
1036 * attribute, so we special case it here.
1037 */
1038 if (vi->i_ino == FILE_Secure)
1039 goto no_data_attr_special_case;
1040 /*
1041 * Most if not all the system files in the $Extend
1042 * system directory do not have unnamed data
1043 * attributes so we need to check if the parent
1044 * directory of the file is FILE_Extend and if it is
1045 * ignore this error. To do this we need to get the
1046 * name of this inode from the mft record as the name
1047 * contains the back reference to the parent directory.
1048 */
1049 if (ntfs_is_extended_system_file(ctx) > 0)
1050 goto no_data_attr_special_case;
1051 // FIXME: File is corrupt! Hot-fix with empty data
1052 // attribute if recovery option is set.
1053 ntfs_error(vi->i_sb, "$DATA attribute is missing.");
1054 goto unm_err_out;
1055 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001056 a = ctx->attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 /* Setup the state. */
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001058 if (a->flags & (ATTR_COMPRESSION_MASK | ATTR_IS_SPARSE)) {
1059 if (a->flags & ATTR_COMPRESSION_MASK) {
1060 NInoSetCompressed(ni);
1061 if (vol->cluster_size > 4096) {
1062 ntfs_error(vi->i_sb, "Found "
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001063 "compressed data but "
1064 "compression is "
1065 "disabled due to "
1066 "cluster size (%i) > "
1067 "4kiB.",
1068 vol->cluster_size);
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001069 goto unm_err_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 }
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001071 if ((a->flags & ATTR_COMPRESSION_MASK)
1072 != ATTR_IS_COMPRESSED) {
1073 ntfs_error(vi->i_sb, "Found unknown "
1074 "compression method "
1075 "or corrupt file.");
1076 goto unm_err_out;
1077 }
1078 }
1079 if (a->flags & ATTR_IS_SPARSE)
1080 NInoSetSparse(ni);
1081 }
1082 if (a->flags & ATTR_IS_ENCRYPTED) {
1083 if (NInoCompressed(ni)) {
1084 ntfs_error(vi->i_sb, "Found encrypted and "
1085 "compressed data.");
1086 goto unm_err_out;
1087 }
1088 NInoSetEncrypted(ni);
1089 }
1090 if (a->non_resident) {
1091 NInoSetNonResident(ni);
1092 if (NInoCompressed(ni) || NInoSparse(ni)) {
Anton Altaparmakova0646a12006-03-23 15:53:03 +00001093 if (NInoCompressed(ni) && a->data.non_resident.
1094 compression_unit != 4) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095 ntfs_error(vi->i_sb, "Found "
Anton Altaparmakova0646a12006-03-23 15:53:03 +00001096 "non-standard "
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001097 "compression unit (%u "
1098 "instead of 4). "
1099 "Cannot handle this.",
1100 a->data.non_resident.
1101 compression_unit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 err = -EOPNOTSUPP;
1103 goto unm_err_out;
1104 }
Anton Altaparmakova0646a12006-03-23 15:53:03 +00001105 if (a->data.non_resident.compression_unit) {
1106 ni->itype.compressed.block_size = 1U <<
1107 (a->data.non_resident.
1108 compression_unit +
1109 vol->cluster_size_bits);
1110 ni->itype.compressed.block_size_bits =
1111 ffs(ni->itype.
1112 compressed.
1113 block_size) - 1;
1114 ni->itype.compressed.block_clusters =
1115 1U << a->data.
1116 non_resident.
1117 compression_unit;
1118 } else {
1119 ni->itype.compressed.block_size = 0;
1120 ni->itype.compressed.block_size_bits =
1121 0;
1122 ni->itype.compressed.block_clusters =
1123 0;
1124 }
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001125 ni->itype.compressed.size = sle64_to_cpu(
1126 a->data.non_resident.
1127 compressed_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001129 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 ntfs_error(vi->i_sb, "First extent of $DATA "
1131 "attribute has non zero "
1132 "lowest_vcn.");
1133 goto unm_err_out;
1134 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 vi->i_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001136 a->data.non_resident.data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 ni->initialized_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001138 a->data.non_resident.initialized_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139 ni->allocated_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001140 a->data.non_resident.allocated_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 } else { /* Resident attribute. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001142 vi->i_size = ni->initialized_size = le32_to_cpu(
1143 a->data.resident.value_length);
1144 ni->allocated_size = le32_to_cpu(a->length) -
1145 le16_to_cpu(
1146 a->data.resident.value_offset);
1147 if (vi->i_size > ni->allocated_size) {
1148 ntfs_error(vi->i_sb, "Resident data attribute "
1149 "is corrupt (size exceeds "
1150 "allocation).");
1151 goto unm_err_out;
1152 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153 }
1154no_data_attr_special_case:
1155 /* We are done with the mft record, so we release it. */
1156 ntfs_attr_put_search_ctx(ctx);
1157 unmap_mft_record(ni);
1158 m = NULL;
1159 ctx = NULL;
1160 /* Setup the operations for this inode. */
1161 vi->i_op = &ntfs_file_inode_ops;
1162 vi->i_fop = &ntfs_file_ops;
1163 }
1164 if (NInoMstProtected(ni))
1165 vi->i_mapping->a_ops = &ntfs_mst_aops;
1166 else
1167 vi->i_mapping->a_ops = &ntfs_aops;
1168 /*
1169 * The number of 512-byte blocks used on disk (for stat). This is in so
1170 * far inaccurate as it doesn't account for any named streams or other
1171 * special non-resident attributes, but that is how Windows works, too,
1172 * so we are at least consistent with Windows, if not entirely
1173 * consistent with the Linux Way. Doing it the Linux Way would cause a
1174 * significant slowdown as it would involve iterating over all
1175 * attributes in the mft record and adding the allocated/compressed
1176 * sizes of all non-resident attributes present to give us the Linux
1177 * correct size that should go into i_blocks (after division by 512).
1178 */
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001179 if (S_ISREG(vi->i_mode) && (NInoCompressed(ni) || NInoSparse(ni)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 vi->i_blocks = ni->itype.compressed.size >> 9;
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001181 else
1182 vi->i_blocks = ni->allocated_size >> 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 ntfs_debug("Done.");
1184 return 0;
Anton Altaparmakov83311912007-01-18 09:42:48 +00001185iput_unm_err_out:
1186 iput(bvi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187unm_err_out:
1188 if (!err)
1189 err = -EIO;
1190 if (ctx)
1191 ntfs_attr_put_search_ctx(ctx);
1192 if (m)
1193 unmap_mft_record(ni);
1194err_out:
1195 ntfs_error(vol->sb, "Failed with error code %i. Marking corrupt "
1196 "inode 0x%lx as bad. Run chkdsk.", err, vi->i_ino);
1197 make_bad_inode(vi);
1198 if (err != -EOPNOTSUPP && err != -ENOMEM)
1199 NVolSetErrors(vol);
1200 return err;
1201}
1202
1203/**
1204 * ntfs_read_locked_attr_inode - read an attribute inode from its base inode
1205 * @base_vi: base inode
1206 * @vi: attribute inode to read
1207 *
1208 * ntfs_read_locked_attr_inode() is called from ntfs_attr_iget() to read the
1209 * attribute inode described by @vi into memory from the base mft record
1210 * described by @base_ni.
1211 *
1212 * ntfs_read_locked_attr_inode() maps, pins and locks the base inode for
1213 * reading and looks up the attribute described by @vi before setting up the
1214 * necessary fields in @vi as well as initializing the ntfs inode.
1215 *
1216 * Q: What locks are held when the function is called?
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001217 * A: i_state has I_NEW set, hence the inode is locked, also
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 * i_count is set to 1, so it is not going to go away
1219 *
1220 * Return 0 on success and -errno on error. In the error case, the inode will
1221 * have had make_bad_inode() executed on it.
Anton Altaparmakovf6098cf2005-09-19 09:41:39 +01001222 *
1223 * Note this cannot be called for AT_INDEX_ALLOCATION.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 */
1225static int ntfs_read_locked_attr_inode(struct inode *base_vi, struct inode *vi)
1226{
1227 ntfs_volume *vol = NTFS_SB(vi->i_sb);
1228 ntfs_inode *ni, *base_ni;
1229 MFT_RECORD *m;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001230 ATTR_RECORD *a;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 ntfs_attr_search_ctx *ctx;
1232 int err = 0;
1233
1234 ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
1235
1236 ntfs_init_big_inode(vi);
1237
1238 ni = NTFS_I(vi);
1239 base_ni = NTFS_I(base_vi);
1240
1241 /* Just mirror the values from the base inode. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 vi->i_version = base_vi->i_version;
1243 vi->i_uid = base_vi->i_uid;
1244 vi->i_gid = base_vi->i_gid;
Miklos Szeredibfe86842011-10-28 14:13:29 +02001245 set_nlink(vi, base_vi->i_nlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 vi->i_mtime = base_vi->i_mtime;
1247 vi->i_ctime = base_vi->i_ctime;
1248 vi->i_atime = base_vi->i_atime;
1249 vi->i_generation = ni->seq_no = base_ni->seq_no;
1250
1251 /* Set inode type to zero but preserve permissions. */
1252 vi->i_mode = base_vi->i_mode & ~S_IFMT;
1253
1254 m = map_mft_record(base_ni);
1255 if (IS_ERR(m)) {
1256 err = PTR_ERR(m);
1257 goto err_out;
1258 }
1259 ctx = ntfs_attr_get_search_ctx(base_ni, m);
1260 if (!ctx) {
1261 err = -ENOMEM;
1262 goto unm_err_out;
1263 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 /* Find the attribute. */
1265 err = ntfs_attr_lookup(ni->type, ni->name, ni->name_len,
1266 CASE_SENSITIVE, 0, NULL, 0, ctx);
1267 if (unlikely(err))
1268 goto unm_err_out;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001269 a = ctx->attr;
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001270 if (a->flags & (ATTR_COMPRESSION_MASK | ATTR_IS_SPARSE)) {
1271 if (a->flags & ATTR_COMPRESSION_MASK) {
1272 NInoSetCompressed(ni);
1273 if ((ni->type != AT_DATA) || (ni->type == AT_DATA &&
1274 ni->name_len)) {
1275 ntfs_error(vi->i_sb, "Found compressed "
1276 "non-data or named data "
1277 "attribute. Please report "
1278 "you saw this message to "
1279 "linux-ntfs-dev@lists."
1280 "sourceforge.net");
1281 goto unm_err_out;
1282 }
1283 if (vol->cluster_size > 4096) {
1284 ntfs_error(vi->i_sb, "Found compressed "
1285 "attribute but compression is "
1286 "disabled due to cluster size "
1287 "(%i) > 4kiB.",
1288 vol->cluster_size);
1289 goto unm_err_out;
1290 }
1291 if ((a->flags & ATTR_COMPRESSION_MASK) !=
1292 ATTR_IS_COMPRESSED) {
1293 ntfs_error(vi->i_sb, "Found unknown "
1294 "compression method.");
1295 goto unm_err_out;
1296 }
1297 }
1298 /*
Anton Altaparmakovf6098cf2005-09-19 09:41:39 +01001299 * The compressed/sparse flag set in an index root just means
1300 * to compress all files.
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001301 */
1302 if (NInoMstProtected(ni) && ni->type != AT_INDEX_ROOT) {
1303 ntfs_error(vi->i_sb, "Found mst protected attribute "
1304 "but the attribute is %s. Please "
1305 "report you saw this message to "
1306 "linux-ntfs-dev@lists.sourceforge.net",
1307 NInoCompressed(ni) ? "compressed" :
1308 "sparse");
1309 goto unm_err_out;
1310 }
1311 if (a->flags & ATTR_IS_SPARSE)
1312 NInoSetSparse(ni);
1313 }
1314 if (a->flags & ATTR_IS_ENCRYPTED) {
1315 if (NInoCompressed(ni)) {
1316 ntfs_error(vi->i_sb, "Found encrypted and compressed "
1317 "data.");
1318 goto unm_err_out;
1319 }
1320 /*
1321 * The encryption flag set in an index root just means to
1322 * encrypt all files.
1323 */
1324 if (NInoMstProtected(ni) && ni->type != AT_INDEX_ROOT) {
1325 ntfs_error(vi->i_sb, "Found mst protected attribute "
1326 "but the attribute is encrypted. "
1327 "Please report you saw this message "
1328 "to linux-ntfs-dev@lists.sourceforge."
1329 "net");
1330 goto unm_err_out;
1331 }
1332 if (ni->type != AT_DATA) {
1333 ntfs_error(vi->i_sb, "Found encrypted non-data "
1334 "attribute.");
1335 goto unm_err_out;
1336 }
1337 NInoSetEncrypted(ni);
1338 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001339 if (!a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 /* Ensure the attribute name is placed before the value. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001341 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1342 le16_to_cpu(a->data.resident.value_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 ntfs_error(vol->sb, "Attribute name is placed after "
1344 "the attribute value.");
1345 goto unm_err_out;
1346 }
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001347 if (NInoMstProtected(ni)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 ntfs_error(vi->i_sb, "Found mst protected attribute "
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001349 "but the attribute is resident. "
1350 "Please report you saw this message to "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 "linux-ntfs-dev@lists.sourceforge.net");
1352 goto unm_err_out;
1353 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001354 vi->i_size = ni->initialized_size = le32_to_cpu(
1355 a->data.resident.value_length);
1356 ni->allocated_size = le32_to_cpu(a->length) -
1357 le16_to_cpu(a->data.resident.value_offset);
1358 if (vi->i_size > ni->allocated_size) {
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001359 ntfs_error(vi->i_sb, "Resident attribute is corrupt "
1360 "(size exceeds allocation).");
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001361 goto unm_err_out;
1362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 } else {
1364 NInoSetNonResident(ni);
1365 /*
1366 * Ensure the attribute name is placed before the mapping pairs
1367 * array.
1368 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001369 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1370 le16_to_cpu(
1371 a->data.non_resident.mapping_pairs_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 ntfs_error(vol->sb, "Attribute name is placed after "
1373 "the mapping pairs array.");
1374 goto unm_err_out;
1375 }
Anton Altaparmakovf6098cf2005-09-19 09:41:39 +01001376 if (NInoCompressed(ni) || NInoSparse(ni)) {
Anton Altaparmakova0646a12006-03-23 15:53:03 +00001377 if (NInoCompressed(ni) && a->data.non_resident.
1378 compression_unit != 4) {
1379 ntfs_error(vi->i_sb, "Found non-standard "
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 "compression unit (%u instead "
1381 "of 4). Cannot handle this.",
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001382 a->data.non_resident.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 compression_unit);
1384 err = -EOPNOTSUPP;
1385 goto unm_err_out;
1386 }
Anton Altaparmakova0646a12006-03-23 15:53:03 +00001387 if (a->data.non_resident.compression_unit) {
1388 ni->itype.compressed.block_size = 1U <<
1389 (a->data.non_resident.
1390 compression_unit +
1391 vol->cluster_size_bits);
1392 ni->itype.compressed.block_size_bits =
1393 ffs(ni->itype.compressed.
1394 block_size) - 1;
1395 ni->itype.compressed.block_clusters = 1U <<
1396 a->data.non_resident.
1397 compression_unit;
1398 } else {
1399 ni->itype.compressed.block_size = 0;
1400 ni->itype.compressed.block_size_bits = 0;
1401 ni->itype.compressed.block_clusters = 0;
1402 }
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001403 ni->itype.compressed.size = sle64_to_cpu(
1404 a->data.non_resident.compressed_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001406 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 ntfs_error(vi->i_sb, "First extent of attribute has "
1408 "non-zero lowest_vcn.");
1409 goto unm_err_out;
1410 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001411 vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 ni->initialized_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001413 a->data.non_resident.initialized_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 ni->allocated_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001415 a->data.non_resident.allocated_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 if (NInoMstProtected(ni))
1418 vi->i_mapping->a_ops = &ntfs_mst_aops;
1419 else
1420 vi->i_mapping->a_ops = &ntfs_aops;
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001421 if ((NInoCompressed(ni) || NInoSparse(ni)) && ni->type != AT_INDEX_ROOT)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 vi->i_blocks = ni->itype.compressed.size >> 9;
Anton Altaparmakov9451f852005-03-03 14:43:43 +00001423 else
1424 vi->i_blocks = ni->allocated_size >> 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 /*
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001426 * Make sure the base inode does not go away and attach it to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 * attribute inode.
1428 */
1429 igrab(base_vi);
1430 ni->ext.base_ntfs_ino = base_ni;
1431 ni->nr_extents = -1;
1432
1433 ntfs_attr_put_search_ctx(ctx);
1434 unmap_mft_record(base_ni);
1435
1436 ntfs_debug("Done.");
1437 return 0;
1438
1439unm_err_out:
1440 if (!err)
1441 err = -EIO;
1442 if (ctx)
1443 ntfs_attr_put_search_ctx(ctx);
1444 unmap_mft_record(base_ni);
1445err_out:
1446 ntfs_error(vol->sb, "Failed with error code %i while reading attribute "
1447 "inode (mft_no 0x%lx, type 0x%x, name_len %i). "
1448 "Marking corrupt inode and base inode 0x%lx as bad. "
1449 "Run chkdsk.", err, vi->i_ino, ni->type, ni->name_len,
1450 base_vi->i_ino);
1451 make_bad_inode(vi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 if (err != -ENOMEM)
1453 NVolSetErrors(vol);
1454 return err;
1455}
1456
1457/**
1458 * ntfs_read_locked_index_inode - read an index inode from its base inode
1459 * @base_vi: base inode
1460 * @vi: index inode to read
1461 *
1462 * ntfs_read_locked_index_inode() is called from ntfs_index_iget() to read the
1463 * index inode described by @vi into memory from the base mft record described
1464 * by @base_ni.
1465 *
1466 * ntfs_read_locked_index_inode() maps, pins and locks the base inode for
1467 * reading and looks up the attributes relating to the index described by @vi
1468 * before setting up the necessary fields in @vi as well as initializing the
1469 * ntfs inode.
1470 *
1471 * Note, index inodes are essentially attribute inodes (NInoAttr() is true)
1472 * with the attribute type set to AT_INDEX_ALLOCATION. Apart from that, they
1473 * are setup like directory inodes since directories are a special case of
1474 * indices ao they need to be treated in much the same way. Most importantly,
1475 * for small indices the index allocation attribute might not actually exist.
1476 * However, the index root attribute always exists but this does not need to
1477 * have an inode associated with it and this is why we define a new inode type
1478 * index. Also, like for directories, we need to have an attribute inode for
1479 * the bitmap attribute corresponding to the index allocation attribute and we
1480 * can store this in the appropriate field of the inode, just like we do for
1481 * normal directory inodes.
1482 *
1483 * Q: What locks are held when the function is called?
Christoph Hellwigeaff8072009-12-17 14:25:01 +01001484 * A: i_state has I_NEW set, hence the inode is locked, also
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 * i_count is set to 1, so it is not going to go away
1486 *
1487 * Return 0 on success and -errno on error. In the error case, the inode will
1488 * have had make_bad_inode() executed on it.
1489 */
1490static int ntfs_read_locked_index_inode(struct inode *base_vi, struct inode *vi)
1491{
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +00001492 loff_t bvi_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493 ntfs_volume *vol = NTFS_SB(vi->i_sb);
1494 ntfs_inode *ni, *base_ni, *bni;
1495 struct inode *bvi;
1496 MFT_RECORD *m;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001497 ATTR_RECORD *a;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 ntfs_attr_search_ctx *ctx;
1499 INDEX_ROOT *ir;
1500 u8 *ir_end, *index_end;
1501 int err = 0;
1502
1503 ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
1504 ntfs_init_big_inode(vi);
1505 ni = NTFS_I(vi);
1506 base_ni = NTFS_I(base_vi);
1507 /* Just mirror the values from the base inode. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 vi->i_version = base_vi->i_version;
1509 vi->i_uid = base_vi->i_uid;
1510 vi->i_gid = base_vi->i_gid;
Miklos Szeredibfe86842011-10-28 14:13:29 +02001511 set_nlink(vi, base_vi->i_nlink);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 vi->i_mtime = base_vi->i_mtime;
1513 vi->i_ctime = base_vi->i_ctime;
1514 vi->i_atime = base_vi->i_atime;
1515 vi->i_generation = ni->seq_no = base_ni->seq_no;
1516 /* Set inode type to zero but preserve permissions. */
1517 vi->i_mode = base_vi->i_mode & ~S_IFMT;
1518 /* Map the mft record for the base inode. */
1519 m = map_mft_record(base_ni);
1520 if (IS_ERR(m)) {
1521 err = PTR_ERR(m);
1522 goto err_out;
1523 }
1524 ctx = ntfs_attr_get_search_ctx(base_ni, m);
1525 if (!ctx) {
1526 err = -ENOMEM;
1527 goto unm_err_out;
1528 }
1529 /* Find the index root attribute. */
1530 err = ntfs_attr_lookup(AT_INDEX_ROOT, ni->name, ni->name_len,
1531 CASE_SENSITIVE, 0, NULL, 0, ctx);
1532 if (unlikely(err)) {
1533 if (err == -ENOENT)
1534 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is "
1535 "missing.");
1536 goto unm_err_out;
1537 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001538 a = ctx->attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 /* Set up the state. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001540 if (unlikely(a->non_resident)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 ntfs_error(vol->sb, "$INDEX_ROOT attribute is not resident.");
1542 goto unm_err_out;
1543 }
1544 /* Ensure the attribute name is placed before the value. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001545 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1546 le16_to_cpu(a->data.resident.value_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 ntfs_error(vol->sb, "$INDEX_ROOT attribute name is placed "
1548 "after the attribute value.");
1549 goto unm_err_out;
1550 }
Anton Altaparmakov67bb1032005-09-08 21:19:45 +01001551 /*
1552 * Compressed/encrypted/sparse index root is not allowed, except for
1553 * directories of course but those are not dealt with here.
1554 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001555 if (a->flags & (ATTR_COMPRESSION_MASK | ATTR_IS_ENCRYPTED |
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 ATTR_IS_SPARSE)) {
1557 ntfs_error(vi->i_sb, "Found compressed/encrypted/sparse index "
1558 "root attribute.");
1559 goto unm_err_out;
1560 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001561 ir = (INDEX_ROOT*)((u8*)a + le16_to_cpu(a->data.resident.value_offset));
1562 ir_end = (u8*)ir + le32_to_cpu(a->data.resident.value_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563 if (ir_end > (u8*)ctx->mrec + vol->mft_record_size) {
1564 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is corrupt.");
1565 goto unm_err_out;
1566 }
1567 index_end = (u8*)&ir->index + le32_to_cpu(ir->index.index_length);
1568 if (index_end > ir_end) {
1569 ntfs_error(vi->i_sb, "Index is corrupt.");
1570 goto unm_err_out;
1571 }
1572 if (ir->type) {
1573 ntfs_error(vi->i_sb, "Index type is not 0 (type is 0x%x).",
1574 le32_to_cpu(ir->type));
1575 goto unm_err_out;
1576 }
1577 ni->itype.index.collation_rule = ir->collation_rule;
1578 ntfs_debug("Index collation rule is 0x%x.",
1579 le32_to_cpu(ir->collation_rule));
1580 ni->itype.index.block_size = le32_to_cpu(ir->index_block_size);
Robert P. J. Day02d53412009-06-16 15:33:35 -07001581 if (!is_power_of_2(ni->itype.index.block_size)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 ntfs_error(vi->i_sb, "Index block size (%u) is not a power of "
1583 "two.", ni->itype.index.block_size);
1584 goto unm_err_out;
1585 }
1586 if (ni->itype.index.block_size > PAGE_CACHE_SIZE) {
1587 ntfs_error(vi->i_sb, "Index block size (%u) > PAGE_CACHE_SIZE "
1588 "(%ld) is not supported. Sorry.",
1589 ni->itype.index.block_size, PAGE_CACHE_SIZE);
1590 err = -EOPNOTSUPP;
1591 goto unm_err_out;
1592 }
1593 if (ni->itype.index.block_size < NTFS_BLOCK_SIZE) {
1594 ntfs_error(vi->i_sb, "Index block size (%u) < NTFS_BLOCK_SIZE "
1595 "(%i) is not supported. Sorry.",
1596 ni->itype.index.block_size, NTFS_BLOCK_SIZE);
1597 err = -EOPNOTSUPP;
1598 goto unm_err_out;
1599 }
1600 ni->itype.index.block_size_bits = ffs(ni->itype.index.block_size) - 1;
1601 /* Determine the size of a vcn in the index. */
1602 if (vol->cluster_size <= ni->itype.index.block_size) {
1603 ni->itype.index.vcn_size = vol->cluster_size;
1604 ni->itype.index.vcn_size_bits = vol->cluster_size_bits;
1605 } else {
1606 ni->itype.index.vcn_size = vol->sector_size;
1607 ni->itype.index.vcn_size_bits = vol->sector_size_bits;
1608 }
1609 /* Check for presence of index allocation attribute. */
1610 if (!(ir->index.flags & LARGE_INDEX)) {
1611 /* No index allocation. */
1612 vi->i_size = ni->initialized_size = ni->allocated_size = 0;
1613 /* We are done with the mft record, so we release it. */
1614 ntfs_attr_put_search_ctx(ctx);
1615 unmap_mft_record(base_ni);
1616 m = NULL;
1617 ctx = NULL;
1618 goto skip_large_index_stuff;
1619 } /* LARGE_INDEX: Index allocation present. Setup state. */
1620 NInoSetIndexAllocPresent(ni);
1621 /* Find index allocation attribute. */
1622 ntfs_attr_reinit_search_ctx(ctx);
1623 err = ntfs_attr_lookup(AT_INDEX_ALLOCATION, ni->name, ni->name_len,
1624 CASE_SENSITIVE, 0, NULL, 0, ctx);
1625 if (unlikely(err)) {
1626 if (err == -ENOENT)
1627 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1628 "not present but $INDEX_ROOT "
1629 "indicated it is.");
1630 else
1631 ntfs_error(vi->i_sb, "Failed to lookup "
1632 "$INDEX_ALLOCATION attribute.");
1633 goto unm_err_out;
1634 }
Anton Altaparmakova778f212006-03-23 16:18:23 +00001635 a = ctx->attr;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001636 if (!a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1638 "resident.");
1639 goto unm_err_out;
1640 }
1641 /*
1642 * Ensure the attribute name is placed before the mapping pairs array.
1643 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001644 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1645 le16_to_cpu(
1646 a->data.non_resident.mapping_pairs_offset)))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 ntfs_error(vol->sb, "$INDEX_ALLOCATION attribute name is "
1648 "placed after the mapping pairs array.");
1649 goto unm_err_out;
1650 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001651 if (a->flags & ATTR_IS_ENCRYPTED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1653 "encrypted.");
1654 goto unm_err_out;
1655 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001656 if (a->flags & ATTR_IS_SPARSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is sparse.");
1658 goto unm_err_out;
1659 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001660 if (a->flags & ATTR_COMPRESSION_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1662 "compressed.");
1663 goto unm_err_out;
1664 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001665 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 ntfs_error(vi->i_sb, "First extent of $INDEX_ALLOCATION "
1667 "attribute has non zero lowest_vcn.");
1668 goto unm_err_out;
1669 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001670 vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 ni->initialized_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001672 a->data.non_resident.initialized_size);
1673 ni->allocated_size = sle64_to_cpu(a->data.non_resident.allocated_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 /*
1675 * We are done with the mft record, so we release it. Otherwise
1676 * we would deadlock in ntfs_attr_iget().
1677 */
1678 ntfs_attr_put_search_ctx(ctx);
1679 unmap_mft_record(base_ni);
1680 m = NULL;
1681 ctx = NULL;
1682 /* Get the index bitmap attribute inode. */
1683 bvi = ntfs_attr_iget(base_vi, AT_BITMAP, ni->name, ni->name_len);
1684 if (IS_ERR(bvi)) {
1685 ntfs_error(vi->i_sb, "Failed to get bitmap attribute.");
1686 err = PTR_ERR(bvi);
1687 goto unm_err_out;
1688 }
1689 bni = NTFS_I(bvi);
1690 if (NInoCompressed(bni) || NInoEncrypted(bni) ||
1691 NInoSparse(bni)) {
1692 ntfs_error(vi->i_sb, "$BITMAP attribute is compressed and/or "
1693 "encrypted and/or sparse.");
1694 goto iput_unm_err_out;
1695 }
1696 /* Consistency check bitmap size vs. index allocation size. */
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +00001697 bvi_size = i_size_read(bvi);
1698 if ((bvi_size << 3) < (vi->i_size >> ni->itype.index.block_size_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 ntfs_error(vi->i_sb, "Index bitmap too small (0x%llx) for "
Anton Altaparmakovf50f3ac2004-11-19 22:16:00 +00001700 "index allocation (0x%llx).", bvi_size << 3,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 vi->i_size);
1702 goto iput_unm_err_out;
1703 }
Anton Altaparmakov83311912007-01-18 09:42:48 +00001704 iput(bvi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705skip_large_index_stuff:
1706 /* Setup the operations for this index inode. */
1707 vi->i_op = NULL;
1708 vi->i_fop = NULL;
1709 vi->i_mapping->a_ops = &ntfs_mst_aops;
1710 vi->i_blocks = ni->allocated_size >> 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 /*
1712 * Make sure the base inode doesn't go away and attach it to the
1713 * index inode.
1714 */
1715 igrab(base_vi);
1716 ni->ext.base_ntfs_ino = base_ni;
1717 ni->nr_extents = -1;
1718
1719 ntfs_debug("Done.");
1720 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721iput_unm_err_out:
1722 iput(bvi);
1723unm_err_out:
1724 if (!err)
1725 err = -EIO;
1726 if (ctx)
1727 ntfs_attr_put_search_ctx(ctx);
1728 if (m)
1729 unmap_mft_record(base_ni);
1730err_out:
1731 ntfs_error(vi->i_sb, "Failed with error code %i while reading index "
1732 "inode (mft_no 0x%lx, name_len %i.", err, vi->i_ino,
1733 ni->name_len);
1734 make_bad_inode(vi);
1735 if (err != -EOPNOTSUPP && err != -ENOMEM)
1736 NVolSetErrors(vol);
1737 return err;
1738}
1739
Ingo Molnar59345372006-07-03 00:25:18 -07001740/*
1741 * The MFT inode has special locking, so teach the lock validator
1742 * about this by splitting off the locking rules of the MFT from
1743 * the locking rules of other inodes. The MFT inode can never be
1744 * accessed from the VFS side (or even internally), only by the
1745 * map_mft functions.
1746 */
1747static struct lock_class_key mft_ni_runlist_lock_key, mft_ni_mrec_lock_key;
1748
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749/**
1750 * ntfs_read_inode_mount - special read_inode for mount time use only
1751 * @vi: inode to read
1752 *
1753 * Read inode FILE_MFT at mount time, only called with super_block lock
1754 * held from within the read_super() code path.
1755 *
1756 * This function exists because when it is called the page cache for $MFT/$DATA
1757 * is not initialized and hence we cannot get at the contents of mft records
1758 * by calling map_mft_record*().
1759 *
1760 * Further it needs to cope with the circular references problem, i.e. cannot
1761 * load any attributes other than $ATTRIBUTE_LIST until $DATA is loaded, because
1762 * we do not know where the other extent mft records are yet and again, because
1763 * we cannot call map_mft_record*() yet. Obviously this applies only when an
1764 * attribute list is actually present in $MFT inode.
1765 *
1766 * We solve these problems by starting with the $DATA attribute before anything
1767 * else and iterating using ntfs_attr_lookup($DATA) over all extents. As each
1768 * extent is found, we ntfs_mapping_pairs_decompress() including the implied
1769 * ntfs_runlists_merge(). Each step of the iteration necessarily provides
1770 * sufficient information for the next step to complete.
1771 *
1772 * This should work but there are two possible pit falls (see inline comments
1773 * below), but only time will tell if they are real pits or just smoke...
1774 */
1775int ntfs_read_inode_mount(struct inode *vi)
1776{
1777 VCN next_vcn, last_vcn, highest_vcn;
1778 s64 block;
1779 struct super_block *sb = vi->i_sb;
1780 ntfs_volume *vol = NTFS_SB(sb);
1781 struct buffer_head *bh;
1782 ntfs_inode *ni;
1783 MFT_RECORD *m = NULL;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001784 ATTR_RECORD *a;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 ntfs_attr_search_ctx *ctx;
1786 unsigned int i, nr_blocks;
1787 int err;
1788
1789 ntfs_debug("Entering.");
1790
1791 /* Initialize the ntfs specific part of @vi. */
1792 ntfs_init_big_inode(vi);
1793
1794 ni = NTFS_I(vi);
1795
1796 /* Setup the data attribute. It is special as it is mst protected. */
1797 NInoSetNonResident(ni);
1798 NInoSetMstProtected(ni);
Anton Altaparmakovc002f422005-02-03 12:02:56 +00001799 NInoSetSparseDisabled(ni);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 ni->type = AT_DATA;
1801 ni->name = NULL;
1802 ni->name_len = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 /*
1804 * This sets up our little cheat allowing us to reuse the async read io
1805 * completion handler for directories.
1806 */
1807 ni->itype.index.block_size = vol->mft_record_size;
1808 ni->itype.index.block_size_bits = vol->mft_record_size_bits;
1809
1810 /* Very important! Needed to be able to call map_mft_record*(). */
1811 vol->mft_ino = vi;
1812
1813 /* Allocate enough memory to read the first mft record. */
1814 if (vol->mft_record_size > 64 * 1024) {
1815 ntfs_error(sb, "Unsupported mft record size %i (max 64kiB).",
1816 vol->mft_record_size);
1817 goto err_out;
1818 }
1819 i = vol->mft_record_size;
1820 if (i < sb->s_blocksize)
1821 i = sb->s_blocksize;
1822 m = (MFT_RECORD*)ntfs_malloc_nofs(i);
1823 if (!m) {
1824 ntfs_error(sb, "Failed to allocate buffer for $MFT record 0.");
1825 goto err_out;
1826 }
1827
1828 /* Determine the first block of the $MFT/$DATA attribute. */
1829 block = vol->mft_lcn << vol->cluster_size_bits >>
1830 sb->s_blocksize_bits;
1831 nr_blocks = vol->mft_record_size >> sb->s_blocksize_bits;
1832 if (!nr_blocks)
1833 nr_blocks = 1;
1834
1835 /* Load $MFT/$DATA's first mft record. */
1836 for (i = 0; i < nr_blocks; i++) {
1837 bh = sb_bread(sb, block++);
1838 if (!bh) {
1839 ntfs_error(sb, "Device read failed.");
1840 goto err_out;
1841 }
1842 memcpy((char*)m + (i << sb->s_blocksize_bits), bh->b_data,
1843 sb->s_blocksize);
1844 brelse(bh);
1845 }
1846
1847 /* Apply the mst fixups. */
1848 if (post_read_mst_fixup((NTFS_RECORD*)m, vol->mft_record_size)) {
1849 /* FIXME: Try to use the $MFTMirr now. */
1850 ntfs_error(sb, "MST fixup failed. $MFT is corrupt.");
1851 goto err_out;
1852 }
1853
1854 /* Need this to sanity check attribute list references to $MFT. */
1855 vi->i_generation = ni->seq_no = le16_to_cpu(m->sequence_number);
1856
1857 /* Provides readpage() and sync_page() for map_mft_record(). */
1858 vi->i_mapping->a_ops = &ntfs_mst_aops;
1859
1860 ctx = ntfs_attr_get_search_ctx(ni, m);
1861 if (!ctx) {
1862 err = -ENOMEM;
1863 goto err_out;
1864 }
1865
1866 /* Find the attribute list attribute if present. */
1867 err = ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, 0, 0, NULL, 0, ctx);
1868 if (err) {
1869 if (unlikely(err != -ENOENT)) {
1870 ntfs_error(sb, "Failed to lookup attribute list "
1871 "attribute. You should run chkdsk.");
1872 goto put_err_out;
1873 }
1874 } else /* if (!err) */ {
1875 ATTR_LIST_ENTRY *al_entry, *next_al_entry;
1876 u8 *al_end;
Anton Altaparmakov3672b632006-02-24 09:55:07 +00001877 static const char *es = " Not allowed. $MFT is corrupt. "
1878 "You should run chkdsk.";
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
1880 ntfs_debug("Attribute list attribute found in $MFT.");
1881 NInoSetAttrList(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001882 a = ctx->attr;
Anton Altaparmakov3672b632006-02-24 09:55:07 +00001883 if (a->flags & ATTR_COMPRESSION_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884 ntfs_error(sb, "Attribute list attribute is "
Anton Altaparmakov3672b632006-02-24 09:55:07 +00001885 "compressed.%s", es);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 goto put_err_out;
1887 }
Anton Altaparmakov3672b632006-02-24 09:55:07 +00001888 if (a->flags & ATTR_IS_ENCRYPTED ||
1889 a->flags & ATTR_IS_SPARSE) {
1890 if (a->non_resident) {
1891 ntfs_error(sb, "Non-resident attribute list "
1892 "attribute is encrypted/"
1893 "sparse.%s", es);
1894 goto put_err_out;
1895 }
1896 ntfs_warning(sb, "Resident attribute list attribute "
1897 "in $MFT system file is marked "
1898 "encrypted/sparse which is not true. "
1899 "However, Windows allows this and "
1900 "chkdsk does not detect or correct it "
1901 "so we will just ignore the invalid "
1902 "flags and pretend they are not set.");
1903 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 /* Now allocate memory for the attribute list. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001905 ni->attr_list_size = (u32)ntfs_attr_size(a);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 ni->attr_list = ntfs_malloc_nofs(ni->attr_list_size);
1907 if (!ni->attr_list) {
1908 ntfs_error(sb, "Not enough memory to allocate buffer "
1909 "for attribute list.");
1910 goto put_err_out;
1911 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001912 if (a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 NInoSetAttrListNonResident(ni);
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001914 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 ntfs_error(sb, "Attribute list has non zero "
1916 "lowest_vcn. $MFT is corrupt. "
1917 "You should run chkdsk.");
1918 goto put_err_out;
1919 }
1920 /* Setup the runlist. */
1921 ni->attr_list_rl.rl = ntfs_mapping_pairs_decompress(vol,
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001922 a, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 if (IS_ERR(ni->attr_list_rl.rl)) {
1924 err = PTR_ERR(ni->attr_list_rl.rl);
1925 ni->attr_list_rl.rl = NULL;
1926 ntfs_error(sb, "Mapping pairs decompression "
1927 "failed with error code %i.",
1928 -err);
1929 goto put_err_out;
1930 }
1931 /* Now load the attribute list. */
1932 if ((err = load_attribute_list(vol, &ni->attr_list_rl,
1933 ni->attr_list, ni->attr_list_size,
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001934 sle64_to_cpu(a->data.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 non_resident.initialized_size)))) {
1936 ntfs_error(sb, "Failed to load attribute list "
1937 "attribute with error code %i.",
1938 -err);
1939 goto put_err_out;
1940 }
1941 } else /* if (!ctx.attr->non_resident) */ {
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001942 if ((u8*)a + le16_to_cpu(
1943 a->data.resident.value_offset) +
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 le32_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001945 a->data.resident.value_length) >
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 (u8*)ctx->mrec + vol->mft_record_size) {
1947 ntfs_error(sb, "Corrupt attribute list "
1948 "attribute.");
1949 goto put_err_out;
1950 }
1951 /* Now copy the attribute list. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001952 memcpy(ni->attr_list, (u8*)a + le16_to_cpu(
1953 a->data.resident.value_offset),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 le32_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00001955 a->data.resident.value_length));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 }
1957 /* The attribute list is now setup in memory. */
1958 /*
1959 * FIXME: I don't know if this case is actually possible.
1960 * According to logic it is not possible but I have seen too
1961 * many weird things in MS software to rely on logic... Thus we
1962 * perform a manual search and make sure the first $MFT/$DATA
1963 * extent is in the base inode. If it is not we abort with an
1964 * error and if we ever see a report of this error we will need
1965 * to do some magic in order to have the necessary mft record
1966 * loaded and in the right place in the page cache. But
1967 * hopefully logic will prevail and this never happens...
1968 */
1969 al_entry = (ATTR_LIST_ENTRY*)ni->attr_list;
1970 al_end = (u8*)al_entry + ni->attr_list_size;
1971 for (;; al_entry = next_al_entry) {
1972 /* Out of bounds check. */
1973 if ((u8*)al_entry < ni->attr_list ||
1974 (u8*)al_entry > al_end)
1975 goto em_put_err_out;
1976 /* Catch the end of the attribute list. */
1977 if ((u8*)al_entry == al_end)
1978 goto em_put_err_out;
1979 if (!al_entry->length)
1980 goto em_put_err_out;
1981 if ((u8*)al_entry + 6 > al_end || (u8*)al_entry +
1982 le16_to_cpu(al_entry->length) > al_end)
1983 goto em_put_err_out;
1984 next_al_entry = (ATTR_LIST_ENTRY*)((u8*)al_entry +
1985 le16_to_cpu(al_entry->length));
Harvey Harrison63cd88542009-03-31 15:23:52 -07001986 if (le32_to_cpu(al_entry->type) > le32_to_cpu(AT_DATA))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 goto em_put_err_out;
1988 if (AT_DATA != al_entry->type)
1989 continue;
1990 /* We want an unnamed attribute. */
1991 if (al_entry->name_length)
1992 goto em_put_err_out;
1993 /* Want the first entry, i.e. lowest_vcn == 0. */
1994 if (al_entry->lowest_vcn)
1995 goto em_put_err_out;
1996 /* First entry has to be in the base mft record. */
1997 if (MREF_LE(al_entry->mft_reference) != vi->i_ino) {
1998 /* MFT references do not match, logic fails. */
1999 ntfs_error(sb, "BUG: The first $DATA extent "
2000 "of $MFT is not in the base "
2001 "mft record. Please report "
2002 "you saw this message to "
2003 "linux-ntfs-dev@lists."
2004 "sourceforge.net");
2005 goto put_err_out;
2006 } else {
2007 /* Sequence numbers must match. */
2008 if (MSEQNO_LE(al_entry->mft_reference) !=
2009 ni->seq_no)
2010 goto em_put_err_out;
2011 /* Got it. All is ok. We can stop now. */
2012 break;
2013 }
2014 }
2015 }
2016
2017 ntfs_attr_reinit_search_ctx(ctx);
2018
2019 /* Now load all attribute extents. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002020 a = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 next_vcn = last_vcn = highest_vcn = 0;
2022 while (!(err = ntfs_attr_lookup(AT_DATA, NULL, 0, 0, next_vcn, NULL, 0,
2023 ctx))) {
2024 runlist_element *nrl;
2025
2026 /* Cache the current attribute. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002027 a = ctx->attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 /* $MFT must be non-resident. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002029 if (!a->non_resident) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 ntfs_error(sb, "$MFT must be non-resident but a "
2031 "resident extent was found. $MFT is "
2032 "corrupt. Run chkdsk.");
2033 goto put_err_out;
2034 }
2035 /* $MFT must be uncompressed and unencrypted. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002036 if (a->flags & ATTR_COMPRESSION_MASK ||
2037 a->flags & ATTR_IS_ENCRYPTED ||
2038 a->flags & ATTR_IS_SPARSE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039 ntfs_error(sb, "$MFT must be uncompressed, "
2040 "non-sparse, and unencrypted but a "
2041 "compressed/sparse/encrypted extent "
2042 "was found. $MFT is corrupt. Run "
2043 "chkdsk.");
2044 goto put_err_out;
2045 }
2046 /*
2047 * Decompress the mapping pairs array of this extent and merge
2048 * the result into the existing runlist. No need for locking
2049 * as we have exclusive access to the inode at this time and we
2050 * are a mount in progress task, too.
2051 */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002052 nrl = ntfs_mapping_pairs_decompress(vol, a, ni->runlist.rl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053 if (IS_ERR(nrl)) {
2054 ntfs_error(sb, "ntfs_mapping_pairs_decompress() "
2055 "failed with error code %ld. $MFT is "
2056 "corrupt.", PTR_ERR(nrl));
2057 goto put_err_out;
2058 }
2059 ni->runlist.rl = nrl;
2060
2061 /* Are we in the first extent? */
2062 if (!next_vcn) {
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002063 if (a->data.non_resident.lowest_vcn) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 ntfs_error(sb, "First extent of $DATA "
2065 "attribute has non zero "
2066 "lowest_vcn. $MFT is corrupt. "
2067 "You should run chkdsk.");
2068 goto put_err_out;
2069 }
2070 /* Get the last vcn in the $DATA attribute. */
2071 last_vcn = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002072 a->data.non_resident.allocated_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 >> vol->cluster_size_bits;
2074 /* Fill in the inode size. */
2075 vi->i_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002076 a->data.non_resident.data_size);
2077 ni->initialized_size = sle64_to_cpu(
2078 a->data.non_resident.initialized_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 ni->allocated_size = sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002080 a->data.non_resident.allocated_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 /*
2082 * Verify the number of mft records does not exceed
2083 * 2^32 - 1.
2084 */
2085 if ((vi->i_size >> vol->mft_record_size_bits) >=
2086 (1ULL << 32)) {
2087 ntfs_error(sb, "$MFT is too big! Aborting.");
2088 goto put_err_out;
2089 }
2090 /*
2091 * We have got the first extent of the runlist for
2092 * $MFT which means it is now relatively safe to call
2093 * the normal ntfs_read_inode() function.
2094 * Complete reading the inode, this will actually
2095 * re-read the mft record for $MFT, this time entering
2096 * it into the page cache with which we complete the
2097 * kick start of the volume. It should be safe to do
2098 * this now as the first extent of $MFT/$DATA is
2099 * already known and we would hope that we don't need
2100 * further extents in order to find the other
2101 * attributes belonging to $MFT. Only time will tell if
2102 * this is really the case. If not we will have to play
2103 * magic at this point, possibly duplicating a lot of
2104 * ntfs_read_inode() at this point. We will need to
2105 * ensure we do enough of its work to be able to call
2106 * ntfs_read_inode() on extents of $MFT/$DATA. But lets
2107 * hope this never happens...
2108 */
2109 ntfs_read_locked_inode(vi);
2110 if (is_bad_inode(vi)) {
2111 ntfs_error(sb, "ntfs_read_inode() of $MFT "
2112 "failed. BUG or corrupt $MFT. "
2113 "Run chkdsk and if no errors "
2114 "are found, please report you "
2115 "saw this message to "
2116 "linux-ntfs-dev@lists."
2117 "sourceforge.net");
2118 ntfs_attr_put_search_ctx(ctx);
2119 /* Revert to the safe super operations. */
2120 ntfs_free(m);
2121 return -1;
2122 }
2123 /*
2124 * Re-initialize some specifics about $MFT's inode as
2125 * ntfs_read_inode() will have set up the default ones.
2126 */
2127 /* Set uid and gid to root. */
Eric W. Biedermanb29f7752012-02-07 16:29:36 -08002128 vi->i_uid = GLOBAL_ROOT_UID;
2129 vi->i_gid = GLOBAL_ROOT_GID;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 /* Regular file. No access for anyone. */
2131 vi->i_mode = S_IFREG;
2132 /* No VFS initiated operations allowed for $MFT. */
2133 vi->i_op = &ntfs_empty_inode_ops;
2134 vi->i_fop = &ntfs_empty_file_ops;
2135 }
2136
2137 /* Get the lowest vcn for the next extent. */
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002138 highest_vcn = sle64_to_cpu(a->data.non_resident.highest_vcn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 next_vcn = highest_vcn + 1;
2140
2141 /* Only one extent or error, which we catch below. */
2142 if (next_vcn <= 0)
2143 break;
2144
2145 /* Avoid endless loops due to corruption. */
2146 if (next_vcn < sle64_to_cpu(
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002147 a->data.non_resident.lowest_vcn)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 ntfs_error(sb, "$MFT has corrupt attribute list "
2149 "attribute. Run chkdsk.");
2150 goto put_err_out;
2151 }
2152 }
2153 if (err != -ENOENT) {
2154 ntfs_error(sb, "Failed to lookup $MFT/$DATA attribute extent. "
2155 "$MFT is corrupt. Run chkdsk.");
2156 goto put_err_out;
2157 }
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002158 if (!a) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002159 ntfs_error(sb, "$MFT/$DATA attribute not found. $MFT is "
2160 "corrupt. Run chkdsk.");
2161 goto put_err_out;
2162 }
2163 if (highest_vcn && highest_vcn != last_vcn - 1) {
2164 ntfs_error(sb, "Failed to load the complete runlist for "
2165 "$MFT/$DATA. Driver bug or corrupt $MFT. "
2166 "Run chkdsk.");
2167 ntfs_debug("highest_vcn = 0x%llx, last_vcn - 1 = 0x%llx",
2168 (unsigned long long)highest_vcn,
2169 (unsigned long long)last_vcn - 1);
2170 goto put_err_out;
2171 }
2172 ntfs_attr_put_search_ctx(ctx);
2173 ntfs_debug("Done.");
2174 ntfs_free(m);
Ingo Molnar59345372006-07-03 00:25:18 -07002175
2176 /*
2177 * Split the locking rules of the MFT inode from the
2178 * locking rules of other inodes:
2179 */
2180 lockdep_set_class(&ni->runlist.lock, &mft_ni_runlist_lock_key);
2181 lockdep_set_class(&ni->mrec_lock, &mft_ni_mrec_lock_key);
2182
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 return 0;
2184
2185em_put_err_out:
2186 ntfs_error(sb, "Couldn't find first extent of $DATA attribute in "
2187 "attribute list. $MFT is corrupt. Run chkdsk.");
2188put_err_out:
2189 ntfs_attr_put_search_ctx(ctx);
2190err_out:
2191 ntfs_error(sb, "Failed. Marking inode as bad.");
2192 make_bad_inode(vi);
2193 ntfs_free(m);
2194 return -1;
2195}
2196
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197static void __ntfs_clear_inode(ntfs_inode *ni)
2198{
2199 /* Free all alocated memory. */
2200 down_write(&ni->runlist.lock);
2201 if (ni->runlist.rl) {
2202 ntfs_free(ni->runlist.rl);
2203 ni->runlist.rl = NULL;
2204 }
2205 up_write(&ni->runlist.lock);
2206
2207 if (ni->attr_list) {
2208 ntfs_free(ni->attr_list);
2209 ni->attr_list = NULL;
2210 }
2211
2212 down_write(&ni->attr_list_rl.lock);
2213 if (ni->attr_list_rl.rl) {
2214 ntfs_free(ni->attr_list_rl.rl);
2215 ni->attr_list_rl.rl = NULL;
2216 }
2217 up_write(&ni->attr_list_rl.lock);
2218
2219 if (ni->name_len && ni->name != I30) {
2220 /* Catch bugs... */
2221 BUG_ON(!ni->name);
2222 kfree(ni->name);
2223 }
2224}
2225
2226void ntfs_clear_extent_inode(ntfs_inode *ni)
2227{
2228 ntfs_debug("Entering for inode 0x%lx.", ni->mft_no);
2229
2230 BUG_ON(NInoAttr(ni));
2231 BUG_ON(ni->nr_extents != -1);
2232
2233#ifdef NTFS_RW
2234 if (NInoDirty(ni)) {
2235 if (!is_bad_inode(VFS_I(ni->ext.base_ntfs_ino)))
2236 ntfs_error(ni->vol->sb, "Clearing dirty extent inode! "
2237 "Losing data! This is a BUG!!!");
2238 // FIXME: Do something!!!
2239 }
2240#endif /* NTFS_RW */
2241
2242 __ntfs_clear_inode(ni);
2243
2244 /* Bye, bye... */
2245 ntfs_destroy_extent_inode(ni);
2246}
2247
2248/**
Al Virob57922d2010-06-07 14:34:48 -04002249 * ntfs_evict_big_inode - clean up the ntfs specific part of an inode
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 * @vi: vfs inode pending annihilation
2251 *
2252 * When the VFS is going to remove an inode from memory, ntfs_clear_big_inode()
2253 * is called, which deallocates all memory belonging to the NTFS specific part
2254 * of the inode and returns.
2255 *
2256 * If the MFT record is dirty, we commit it before doing anything else.
2257 */
Al Virob57922d2010-06-07 14:34:48 -04002258void ntfs_evict_big_inode(struct inode *vi)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259{
2260 ntfs_inode *ni = NTFS_I(vi);
2261
Al Virob57922d2010-06-07 14:34:48 -04002262 truncate_inode_pages(&vi->i_data, 0);
Jan Karadbd57682012-05-03 14:48:02 +02002263 clear_inode(vi);
Al Virob57922d2010-06-07 14:34:48 -04002264
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265#ifdef NTFS_RW
2266 if (NInoDirty(ni)) {
Richard Knutssonc49c3112006-09-30 23:27:12 -07002267 bool was_bad = (is_bad_inode(vi));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268
2269 /* Committing the inode also commits all extent inodes. */
2270 ntfs_commit_inode(vi);
2271
2272 if (!was_bad && (is_bad_inode(vi) || NInoDirty(ni))) {
2273 ntfs_error(vi->i_sb, "Failed to commit dirty inode "
2274 "0x%lx. Losing data!", vi->i_ino);
2275 // FIXME: Do something!!!
2276 }
2277 }
2278#endif /* NTFS_RW */
2279
2280 /* No need to lock at this stage as no one else has a reference. */
2281 if (ni->nr_extents > 0) {
2282 int i;
2283
2284 for (i = 0; i < ni->nr_extents; i++)
2285 ntfs_clear_extent_inode(ni->ext.extent_ntfs_inos[i]);
2286 kfree(ni->ext.extent_ntfs_inos);
2287 }
2288
2289 __ntfs_clear_inode(ni);
2290
2291 if (NInoAttr(ni)) {
2292 /* Release the base inode if we are holding it. */
2293 if (ni->nr_extents == -1) {
2294 iput(VFS_I(ni->ext.base_ntfs_ino));
2295 ni->nr_extents = 0;
2296 ni->ext.base_ntfs_ino = NULL;
2297 }
2298 }
2299 return;
2300}
2301
2302/**
2303 * ntfs_show_options - show mount options in /proc/mounts
2304 * @sf: seq_file in which to write our mount options
Al Viro34c80b12011-12-08 21:32:45 -05002305 * @root: root of the mounted tree whose mount options to display
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 *
2307 * Called by the VFS once for each mounted ntfs volume when someone reads
2308 * /proc/mounts in order to display the NTFS specific mount options of each
Al Viro34c80b12011-12-08 21:32:45 -05002309 * mount. The mount options of fs specified by @root are written to the seq file
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 * @sf and success is returned.
2311 */
Al Viro34c80b12011-12-08 21:32:45 -05002312int ntfs_show_options(struct seq_file *sf, struct dentry *root)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313{
Al Viro34c80b12011-12-08 21:32:45 -05002314 ntfs_volume *vol = NTFS_SB(root->d_sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 int i;
2316
Eric W. Biedermanb29f7752012-02-07 16:29:36 -08002317 seq_printf(sf, ",uid=%i", from_kuid_munged(&init_user_ns, vol->uid));
2318 seq_printf(sf, ",gid=%i", from_kgid_munged(&init_user_ns, vol->gid));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 if (vol->fmask == vol->dmask)
2320 seq_printf(sf, ",umask=0%o", vol->fmask);
2321 else {
2322 seq_printf(sf, ",fmask=0%o", vol->fmask);
2323 seq_printf(sf, ",dmask=0%o", vol->dmask);
2324 }
2325 seq_printf(sf, ",nls=%s", vol->nls_map->charset);
2326 if (NVolCaseSensitive(vol))
2327 seq_printf(sf, ",case_sensitive");
2328 if (NVolShowSystemFiles(vol))
2329 seq_printf(sf, ",show_sys_files");
Anton Altaparmakovc002f422005-02-03 12:02:56 +00002330 if (!NVolSparseEnabled(vol))
2331 seq_printf(sf, ",disable_sparse");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 for (i = 0; on_errors_arr[i].val; i++) {
2333 if (on_errors_arr[i].val & vol->on_errors)
2334 seq_printf(sf, ",errors=%s", on_errors_arr[i].str);
2335 }
2336 seq_printf(sf, ",mft_zone_multiplier=%i", vol->mft_zone_multiplier);
2337 return 0;
2338}
2339
2340#ifdef NTFS_RW
2341
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002342static const char *es = " Leaving inconsistent metadata. Unmount and run "
2343 "chkdsk.";
2344
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345/**
2346 * ntfs_truncate - called when the i_size of an ntfs inode is changed
2347 * @vi: inode for which the i_size was changed
2348 *
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002349 * We only support i_size changes for normal files at present, i.e. not
2350 * compressed and not encrypted. This is enforced in ntfs_setattr(), see
2351 * below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 *
2353 * The kernel guarantees that @vi is a regular file (S_ISREG() is true) and
2354 * that the change is allowed.
2355 *
2356 * This implies for us that @vi is a file inode rather than a directory, index,
2357 * or attribute inode as well as that @vi is a base inode.
2358 *
2359 * Returns 0 on success or -errno on error.
2360 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002361 * Called with ->i_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 */
2363int ntfs_truncate(struct inode *vi)
2364{
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002365 s64 new_size, old_size, nr_freed, new_alloc_size, old_alloc_size;
2366 VCN highest_vcn;
2367 unsigned long flags;
2368 ntfs_inode *base_ni, *ni = NTFS_I(vi);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369 ntfs_volume *vol = ni->vol;
2370 ntfs_attr_search_ctx *ctx;
2371 MFT_RECORD *m;
Anton Altaparmakov5ae9fcf2005-03-02 17:03:24 +00002372 ATTR_RECORD *a;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373 const char *te = " Leaving file length out of sync with i_size.";
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002374 int err, mp_size, size_change, alloc_change;
2375 u32 attr_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376
2377 ntfs_debug("Entering for inode 0x%lx.", vi->i_ino);
2378 BUG_ON(NInoAttr(ni));
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002379 BUG_ON(S_ISDIR(vi->i_mode));
2380 BUG_ON(NInoMstProtected(ni));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 BUG_ON(ni->nr_extents < 0);
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002382retry_truncate:
2383 /*
2384 * Lock the runlist for writing and map the mft record to ensure it is
2385 * safe to mess with the attribute runlist and sizes.
2386 */
2387 down_write(&ni->runlist.lock);
2388 if (!NInoAttr(ni))
2389 base_ni = ni;
2390 else
2391 base_ni = ni->ext.base_ntfs_ino;
2392 m = map_mft_record(base_ni);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 if (IS_ERR(m)) {
2394 err = PTR_ERR(m);
2395 ntfs_error(vi->i_sb, "Failed to map mft record for inode 0x%lx "
2396 "(error code %d).%s", vi->i_ino, err, te);
2397 ctx = NULL;
2398 m = NULL;
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002399 goto old_bad_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 }
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002401 ctx = ntfs_attr_get_search_ctx(base_ni, m);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 if (unlikely(!ctx)) {
2403 ntfs_error(vi->i_sb, "Failed to allocate a search context for "
2404 "inode 0x%lx (not enough memory).%s",
2405 vi->i_ino, te);
2406 err = -ENOMEM;
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002407 goto old_bad_out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408 }
2409 err = ntfs_attr_lookup(ni->type, ni->name, ni->name_len,
2410 CASE_SENSITIVE, 0, NULL, 0, ctx);
2411 if (unlikely(err)) {
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002412 if (err == -ENOENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413 ntfs_error(vi->i_sb, "Open attribute is missing from "
2414 "mft record. Inode 0x%lx is corrupt. "
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002415 "Run chkdsk.%s", vi->i_ino, te);
2416 err = -EIO;
2417 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07002418 ntfs_error(vi->i_sb, "Failed to lookup attribute in "
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002419 "inode 0x%lx (error code %d).%s",
2420 vi->i_ino, err, te);
2421 goto old_bad_out;
2422 }
2423 m = ctx->mrec;
2424 a = ctx->attr;
2425 /*
2426 * The i_size of the vfs inode is the new size for the attribute value.
2427 */
2428 new_size = i_size_read(vi);
2429 /* The current size of the attribute value is the old size. */
2430 old_size = ntfs_attr_size(a);
2431 /* Calculate the new allocated size. */
2432 if (NInoNonResident(ni))
2433 new_alloc_size = (new_size + vol->cluster_size - 1) &
2434 ~(s64)vol->cluster_size_mask;
2435 else
2436 new_alloc_size = (new_size + 7) & ~7;
2437 /* The current allocated size is the old allocated size. */
2438 read_lock_irqsave(&ni->size_lock, flags);
2439 old_alloc_size = ni->allocated_size;
2440 read_unlock_irqrestore(&ni->size_lock, flags);
2441 /*
2442 * The change in the file size. This will be 0 if no change, >0 if the
2443 * size is growing, and <0 if the size is shrinking.
2444 */
2445 size_change = -1;
2446 if (new_size - old_size >= 0) {
2447 size_change = 1;
2448 if (new_size == old_size)
2449 size_change = 0;
2450 }
2451 /* As above for the allocated size. */
2452 alloc_change = -1;
2453 if (new_alloc_size - old_alloc_size >= 0) {
2454 alloc_change = 1;
2455 if (new_alloc_size == old_alloc_size)
2456 alloc_change = 0;
2457 }
2458 /*
2459 * If neither the size nor the allocation are being changed there is
2460 * nothing to do.
2461 */
2462 if (!size_change && !alloc_change)
2463 goto unm_done;
2464 /* If the size is changing, check if new size is allowed in $AttrDef. */
2465 if (size_change) {
2466 err = ntfs_attr_size_bounds_check(vol, ni->type, new_size);
2467 if (unlikely(err)) {
2468 if (err == -ERANGE) {
2469 ntfs_error(vol->sb, "Truncate would cause the "
2470 "inode 0x%lx to %simum size "
2471 "for its attribute type "
2472 "(0x%x). Aborting truncate.",
2473 vi->i_ino,
2474 new_size > old_size ? "exceed "
2475 "the max" : "go under the min",
2476 le32_to_cpu(ni->type));
2477 err = -EFBIG;
2478 } else {
2479 ntfs_error(vol->sb, "Inode 0x%lx has unknown "
2480 "attribute type 0x%x. "
2481 "Aborting truncate.",
2482 vi->i_ino,
2483 le32_to_cpu(ni->type));
2484 err = -EIO;
2485 }
2486 /* Reset the vfs inode size to the old size. */
2487 i_size_write(vi, old_size);
2488 goto err_out;
2489 }
2490 }
2491 if (NInoCompressed(ni) || NInoEncrypted(ni)) {
2492 ntfs_warning(vi->i_sb, "Changes in inode size are not "
2493 "supported yet for %s files, ignoring.",
2494 NInoCompressed(ni) ? "compressed" :
2495 "encrypted");
2496 err = -EOPNOTSUPP;
2497 goto bad_out;
2498 }
2499 if (a->non_resident)
2500 goto do_non_resident_truncate;
2501 BUG_ON(NInoNonResident(ni));
2502 /* Resize the attribute record to best fit the new attribute size. */
2503 if (new_size < vol->mft_record_size &&
2504 !ntfs_resident_attr_value_resize(m, a, new_size)) {
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002505 /* The resize succeeded! */
2506 flush_dcache_mft_record_page(ctx->ntfs_ino);
2507 mark_mft_record_dirty(ctx->ntfs_ino);
2508 write_lock_irqsave(&ni->size_lock, flags);
2509 /* Update the sizes in the ntfs inode and all is done. */
2510 ni->allocated_size = le32_to_cpu(a->length) -
2511 le16_to_cpu(a->data.resident.value_offset);
2512 /*
2513 * Note ntfs_resident_attr_value_resize() has already done any
2514 * necessary data clearing in the attribute record. When the
2515 * file is being shrunk vmtruncate() will already have cleared
2516 * the top part of the last partial page, i.e. since this is
2517 * the resident case this is the page with index 0. However,
2518 * when the file is being expanded, the page cache page data
2519 * between the old data_size, i.e. old_size, and the new_size
2520 * has not been zeroed. Fortunately, we do not need to zero it
2521 * either since on one hand it will either already be zero due
2522 * to both readpage and writepage clearing partial page data
2523 * beyond i_size in which case there is nothing to do or in the
2524 * case of the file being mmap()ped at the same time, POSIX
2525 * specifies that the behaviour is unspecified thus we do not
2526 * have to do anything. This means that in our implementation
2527 * in the rare case that the file is mmap()ped and a write
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002528 * occurred into the mmap()ped region just beyond the file size
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002529 * and writepage has not yet been called to write out the page
2530 * (which would clear the area beyond the file size) and we now
2531 * extend the file size to incorporate this dirty region
2532 * outside the file size, a write of the page would result in
2533 * this data being written to disk instead of being cleared.
2534 * Given both POSIX and the Linux mmap(2) man page specify that
2535 * this corner case is undefined, we choose to leave it like
2536 * that as this is much simpler for us as we cannot lock the
2537 * relevant page now since we are holding too many ntfs locks
2538 * which would result in a lock reversal deadlock.
2539 */
2540 ni->initialized_size = new_size;
2541 write_unlock_irqrestore(&ni->size_lock, flags);
2542 goto unm_done;
2543 }
2544 /* If the above resize failed, this must be an attribute extension. */
2545 BUG_ON(size_change < 0);
2546 /*
2547 * We have to drop all the locks so we can call
2548 * ntfs_attr_make_non_resident(). This could be optimised by try-
2549 * locking the first page cache page and only if that fails dropping
2550 * the locks, locking the page, and redoing all the locking and
2551 * lookups. While this would be a huge optimisation, it is not worth
2552 * it as this is definitely a slow code path as it only ever can happen
2553 * once for any given file.
2554 */
2555 ntfs_attr_put_search_ctx(ctx);
2556 unmap_mft_record(base_ni);
2557 up_write(&ni->runlist.lock);
2558 /*
2559 * Not enough space in the mft record, try to make the attribute
2560 * non-resident and if successful restart the truncation process.
2561 */
2562 err = ntfs_attr_make_non_resident(ni, old_size);
2563 if (likely(!err))
2564 goto retry_truncate;
2565 /*
2566 * Could not make non-resident. If this is due to this not being
2567 * permitted for this attribute type or there not being enough space,
2568 * try to make other attributes non-resident. Otherwise fail.
2569 */
2570 if (unlikely(err != -EPERM && err != -ENOSPC)) {
2571 ntfs_error(vol->sb, "Cannot truncate inode 0x%lx, attribute "
2572 "type 0x%x, because the conversion from "
2573 "resident to non-resident attribute failed "
2574 "with error code %i.", vi->i_ino,
2575 (unsigned)le32_to_cpu(ni->type), err);
2576 if (err != -ENOMEM)
2577 err = -EIO;
2578 goto conv_err_out;
2579 }
2580 /* TODO: Not implemented from here, abort. */
2581 if (err == -ENOSPC)
2582 ntfs_error(vol->sb, "Not enough space in the mft record/on "
2583 "disk for the non-resident attribute value. "
2584 "This case is not implemented yet.");
2585 else /* if (err == -EPERM) */
2586 ntfs_error(vol->sb, "This attribute type may not be "
2587 "non-resident. This case is not implemented "
2588 "yet.");
2589 err = -EOPNOTSUPP;
2590 goto conv_err_out;
2591#if 0
2592 // TODO: Attempt to make other attributes non-resident.
2593 if (!err)
2594 goto do_resident_extend;
2595 /*
2596 * Both the attribute list attribute and the standard information
2597 * attribute must remain in the base inode. Thus, if this is one of
2598 * these attributes, we have to try to move other attributes out into
2599 * extent mft records instead.
2600 */
2601 if (ni->type == AT_ATTRIBUTE_LIST ||
2602 ni->type == AT_STANDARD_INFORMATION) {
2603 // TODO: Attempt to move other attributes into extent mft
2604 // records.
2605 err = -EOPNOTSUPP;
2606 if (!err)
2607 goto do_resident_extend;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 goto err_out;
2609 }
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002610 // TODO: Attempt to move this attribute to an extent mft record, but
2611 // only if it is not already the only attribute in an mft record in
2612 // which case there would be nothing to gain.
2613 err = -EOPNOTSUPP;
2614 if (!err)
2615 goto do_resident_extend;
2616 /* There is nothing we can do to make enough space. )-: */
2617 goto err_out;
2618#endif
2619do_non_resident_truncate:
2620 BUG_ON(!NInoNonResident(ni));
2621 if (alloc_change < 0) {
2622 highest_vcn = sle64_to_cpu(a->data.non_resident.highest_vcn);
2623 if (highest_vcn > 0 &&
2624 old_alloc_size >> vol->cluster_size_bits >
2625 highest_vcn + 1) {
2626 /*
2627 * This attribute has multiple extents. Not yet
2628 * supported.
2629 */
2630 ntfs_error(vol->sb, "Cannot truncate inode 0x%lx, "
2631 "attribute type 0x%x, because the "
2632 "attribute is highly fragmented (it "
2633 "consists of multiple extents) and "
2634 "this case is not implemented yet.",
2635 vi->i_ino,
2636 (unsigned)le32_to_cpu(ni->type));
2637 err = -EOPNOTSUPP;
2638 goto bad_out;
2639 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640 }
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002641 /*
2642 * If the size is shrinking, need to reduce the initialized_size and
2643 * the data_size before reducing the allocation.
2644 */
2645 if (size_change < 0) {
2646 /*
2647 * Make the valid size smaller (i_size is already up-to-date).
2648 */
2649 write_lock_irqsave(&ni->size_lock, flags);
2650 if (new_size < ni->initialized_size) {
2651 ni->initialized_size = new_size;
2652 a->data.non_resident.initialized_size =
2653 cpu_to_sle64(new_size);
2654 }
2655 a->data.non_resident.data_size = cpu_to_sle64(new_size);
2656 write_unlock_irqrestore(&ni->size_lock, flags);
2657 flush_dcache_mft_record_page(ctx->ntfs_ino);
2658 mark_mft_record_dirty(ctx->ntfs_ino);
2659 /* If the allocated size is not changing, we are done. */
2660 if (!alloc_change)
2661 goto unm_done;
2662 /*
2663 * If the size is shrinking it makes no sense for the
2664 * allocation to be growing.
2665 */
2666 BUG_ON(alloc_change > 0);
2667 } else /* if (size_change >= 0) */ {
2668 /*
2669 * The file size is growing or staying the same but the
2670 * allocation can be shrinking, growing or staying the same.
2671 */
2672 if (alloc_change > 0) {
2673 /*
2674 * We need to extend the allocation and possibly update
2675 * the data size. If we are updating the data size,
2676 * since we are not touching the initialized_size we do
2677 * not need to worry about the actual data on disk.
2678 * And as far as the page cache is concerned, there
2679 * will be no pages beyond the old data size and any
2680 * partial region in the last page between the old and
2681 * new data size (or the end of the page if the new
2682 * data size is outside the page) does not need to be
2683 * modified as explained above for the resident
2684 * attribute truncate case. To do this, we simply drop
2685 * the locks we hold and leave all the work to our
2686 * friendly helper ntfs_attr_extend_allocation().
2687 */
2688 ntfs_attr_put_search_ctx(ctx);
2689 unmap_mft_record(base_ni);
2690 up_write(&ni->runlist.lock);
2691 err = ntfs_attr_extend_allocation(ni, new_size,
2692 size_change > 0 ? new_size : -1, -1);
2693 /*
2694 * ntfs_attr_extend_allocation() will have done error
2695 * output already.
2696 */
2697 goto done;
2698 }
2699 if (!alloc_change)
2700 goto alloc_done;
2701 }
2702 /* alloc_change < 0 */
2703 /* Free the clusters. */
2704 nr_freed = ntfs_cluster_free(ni, new_alloc_size >>
2705 vol->cluster_size_bits, -1, ctx);
2706 m = ctx->mrec;
2707 a = ctx->attr;
2708 if (unlikely(nr_freed < 0)) {
2709 ntfs_error(vol->sb, "Failed to release cluster(s) (error code "
2710 "%lli). Unmount and run chkdsk to recover "
2711 "the lost cluster(s).", (long long)nr_freed);
2712 NVolSetErrors(vol);
2713 nr_freed = 0;
2714 }
2715 /* Truncate the runlist. */
2716 err = ntfs_rl_truncate_nolock(vol, &ni->runlist,
2717 new_alloc_size >> vol->cluster_size_bits);
2718 /*
2719 * If the runlist truncation failed and/or the search context is no
2720 * longer valid, we cannot resize the attribute record or build the
2721 * mapping pairs array thus we mark the inode bad so that no access to
2722 * the freed clusters can happen.
2723 */
2724 if (unlikely(err || IS_ERR(m))) {
2725 ntfs_error(vol->sb, "Failed to %s (error code %li).%s",
2726 IS_ERR(m) ?
2727 "restore attribute search context" :
2728 "truncate attribute runlist",
2729 IS_ERR(m) ? PTR_ERR(m) : err, es);
2730 err = -EIO;
2731 goto bad_out;
2732 }
2733 /* Get the size for the shrunk mapping pairs array for the runlist. */
2734 mp_size = ntfs_get_size_for_mapping_pairs(vol, ni->runlist.rl, 0, -1);
2735 if (unlikely(mp_size <= 0)) {
2736 ntfs_error(vol->sb, "Cannot shrink allocation of inode 0x%lx, "
2737 "attribute type 0x%x, because determining the "
2738 "size for the mapping pairs failed with error "
2739 "code %i.%s", vi->i_ino,
2740 (unsigned)le32_to_cpu(ni->type), mp_size, es);
2741 err = -EIO;
2742 goto bad_out;
2743 }
2744 /*
2745 * Shrink the attribute record for the new mapping pairs array. Note,
2746 * this cannot fail since we are making the attribute smaller thus by
2747 * definition there is enough space to do so.
2748 */
2749 attr_len = le32_to_cpu(a->length);
2750 err = ntfs_attr_record_resize(m, a, mp_size +
2751 le16_to_cpu(a->data.non_resident.mapping_pairs_offset));
2752 BUG_ON(err);
2753 /*
2754 * Generate the mapping pairs array directly into the attribute record.
2755 */
2756 err = ntfs_mapping_pairs_build(vol, (u8*)a +
2757 le16_to_cpu(a->data.non_resident.mapping_pairs_offset),
2758 mp_size, ni->runlist.rl, 0, -1, NULL);
2759 if (unlikely(err)) {
2760 ntfs_error(vol->sb, "Cannot shrink allocation of inode 0x%lx, "
2761 "attribute type 0x%x, because building the "
2762 "mapping pairs failed with error code %i.%s",
2763 vi->i_ino, (unsigned)le32_to_cpu(ni->type),
2764 err, es);
2765 err = -EIO;
2766 goto bad_out;
2767 }
2768 /* Update the allocated/compressed size as well as the highest vcn. */
2769 a->data.non_resident.highest_vcn = cpu_to_sle64((new_alloc_size >>
2770 vol->cluster_size_bits) - 1);
2771 write_lock_irqsave(&ni->size_lock, flags);
2772 ni->allocated_size = new_alloc_size;
2773 a->data.non_resident.allocated_size = cpu_to_sle64(new_alloc_size);
2774 if (NInoSparse(ni) || NInoCompressed(ni)) {
2775 if (nr_freed) {
2776 ni->itype.compressed.size -= nr_freed <<
2777 vol->cluster_size_bits;
2778 BUG_ON(ni->itype.compressed.size < 0);
2779 a->data.non_resident.compressed_size = cpu_to_sle64(
2780 ni->itype.compressed.size);
2781 vi->i_blocks = ni->itype.compressed.size >> 9;
2782 }
2783 } else
2784 vi->i_blocks = new_alloc_size >> 9;
2785 write_unlock_irqrestore(&ni->size_lock, flags);
2786 /*
2787 * We have shrunk the allocation. If this is a shrinking truncate we
2788 * have already dealt with the initialized_size and the data_size above
2789 * and we are done. If the truncate is only changing the allocation
2790 * and not the data_size, we are also done. If this is an extending
2791 * truncate, need to extend the data_size now which is ensured by the
2792 * fact that @size_change is positive.
2793 */
2794alloc_done:
2795 /*
2796 * If the size is growing, need to update it now. If it is shrinking,
2797 * we have already updated it above (before the allocation change).
2798 */
2799 if (size_change > 0)
2800 a->data.non_resident.data_size = cpu_to_sle64(new_size);
2801 /* Ensure the modified mft record is written out. */
2802 flush_dcache_mft_record_page(ctx->ntfs_ino);
2803 mark_mft_record_dirty(ctx->ntfs_ino);
2804unm_done:
2805 ntfs_attr_put_search_ctx(ctx);
2806 unmap_mft_record(base_ni);
2807 up_write(&ni->runlist.lock);
2808done:
2809 /* Update the mtime and ctime on the base inode. */
Christoph Hellwig870f4812006-01-09 20:52:01 -08002810 /* normally ->truncate shouldn't update ctime or mtime,
2811 * but ntfs did before so it got a copy & paste version
2812 * of file_update_time. one day someone should fix this
2813 * for real.
2814 */
2815 if (!IS_NOCMTIME(VFS_I(base_ni)) && !IS_RDONLY(VFS_I(base_ni))) {
2816 struct timespec now = current_fs_time(VFS_I(base_ni)->i_sb);
2817 int sync_it = 0;
2818
2819 if (!timespec_equal(&VFS_I(base_ni)->i_mtime, &now) ||
2820 !timespec_equal(&VFS_I(base_ni)->i_ctime, &now))
2821 sync_it = 1;
2822 VFS_I(base_ni)->i_mtime = now;
2823 VFS_I(base_ni)->i_ctime = now;
2824
2825 if (sync_it)
2826 mark_inode_dirty_sync(VFS_I(base_ni));
2827 }
2828
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002829 if (likely(!err)) {
2830 NInoClearTruncateFailed(ni);
2831 ntfs_debug("Done.");
2832 }
2833 return err;
2834old_bad_out:
2835 old_size = -1;
2836bad_out:
Anton Altaparmakova778f212006-03-23 16:18:23 +00002837 if (err != -ENOMEM && err != -EOPNOTSUPP)
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002838 NVolSetErrors(vol);
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002839 if (err != -EOPNOTSUPP)
2840 NInoSetTruncateFailed(ni);
2841 else if (old_size >= 0)
2842 i_size_write(vi, old_size);
2843err_out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002844 if (ctx)
2845 ntfs_attr_put_search_ctx(ctx);
2846 if (m)
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002847 unmap_mft_record(base_ni);
2848 up_write(&ni->runlist.lock);
2849out:
2850 ntfs_debug("Failed. Returning error code %i.", err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002851 return err;
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002852conv_err_out:
Anton Altaparmakova778f212006-03-23 16:18:23 +00002853 if (err != -ENOMEM && err != -EOPNOTSUPP)
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002854 NVolSetErrors(vol);
Anton Altaparmakovdd072332005-10-04 15:39:02 +01002855 if (err != -EOPNOTSUPP)
2856 NInoSetTruncateFailed(ni);
2857 else
2858 i_size_write(vi, old_size);
2859 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860}
2861
2862/**
2863 * ntfs_truncate_vfs - wrapper for ntfs_truncate() that has no return value
2864 * @vi: inode for which the i_size was changed
2865 *
2866 * Wrapper for ntfs_truncate() that has no return value.
2867 *
2868 * See ntfs_truncate() description above for details.
2869 */
Marco Stornelli9014da72012-12-15 11:58:36 +01002870#ifdef NTFS_RW
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871void ntfs_truncate_vfs(struct inode *vi) {
2872 ntfs_truncate(vi);
2873}
Marco Stornelli9014da72012-12-15 11:58:36 +01002874#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875
2876/**
2877 * ntfs_setattr - called from notify_change() when an attribute is being changed
2878 * @dentry: dentry whose attributes to change
2879 * @attr: structure describing the attributes and the changes
2880 *
2881 * We have to trap VFS attempts to truncate the file described by @dentry as
2882 * soon as possible, because we do not implement changes in i_size yet. So we
2883 * abort all i_size changes here.
2884 *
2885 * We also abort all changes of user, group, and mode as we do not implement
2886 * the NTFS ACLs yet.
2887 *
Christoph Hellwigbd5fe6c2011-06-24 14:29:43 -04002888 * Called with ->i_mutex held.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002889 */
2890int ntfs_setattr(struct dentry *dentry, struct iattr *attr)
2891{
2892 struct inode *vi = dentry->d_inode;
2893 int err;
2894 unsigned int ia_valid = attr->ia_valid;
2895
2896 err = inode_change_ok(vi, attr);
2897 if (err)
Anton Altaparmakove9438252005-10-04 16:01:06 +01002898 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002899 /* We do not support NTFS ACLs yet. */
2900 if (ia_valid & (ATTR_UID | ATTR_GID | ATTR_MODE)) {
2901 ntfs_warning(vi->i_sb, "Changes in user/group/mode are not "
2902 "supported yet, ignoring.");
2903 err = -EOPNOTSUPP;
2904 goto out;
2905 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 if (ia_valid & ATTR_SIZE) {
2907 if (attr->ia_size != i_size_read(vi)) {
Anton Altaparmakove9438252005-10-04 16:01:06 +01002908 ntfs_inode *ni = NTFS_I(vi);
2909 /*
2910 * FIXME: For now we do not support resizing of
2911 * compressed or encrypted files yet.
2912 */
2913 if (NInoCompressed(ni) || NInoEncrypted(ni)) {
2914 ntfs_warning(vi->i_sb, "Changes in inode size "
2915 "are not supported yet for "
2916 "%s files, ignoring.",
2917 NInoCompressed(ni) ?
2918 "compressed" : "encrypted");
2919 err = -EOPNOTSUPP;
Marco Stornelli9014da72012-12-15 11:58:36 +01002920 } else {
2921 truncate_setsize(vi, attr->ia_size);
2922 ntfs_truncate_vfs(vi);
2923 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924 if (err || ia_valid == ATTR_SIZE)
2925 goto out;
2926 } else {
2927 /*
2928 * We skipped the truncate but must still update
2929 * timestamps.
2930 */
Anton Altaparmakov1c7d4692005-09-08 21:15:09 +01002931 ia_valid |= ATTR_MTIME | ATTR_CTIME;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932 }
2933 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 if (ia_valid & ATTR_ATIME)
Anton Altaparmakov1c7d4692005-09-08 21:15:09 +01002935 vi->i_atime = timespec_trunc(attr->ia_atime,
2936 vi->i_sb->s_time_gran);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 if (ia_valid & ATTR_MTIME)
Anton Altaparmakov1c7d4692005-09-08 21:15:09 +01002938 vi->i_mtime = timespec_trunc(attr->ia_mtime,
2939 vi->i_sb->s_time_gran);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940 if (ia_valid & ATTR_CTIME)
Anton Altaparmakov1c7d4692005-09-08 21:15:09 +01002941 vi->i_ctime = timespec_trunc(attr->ia_ctime,
2942 vi->i_sb->s_time_gran);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943 mark_inode_dirty(vi);
2944out:
2945 return err;
2946}
2947
2948/**
2949 * ntfs_write_inode - write out a dirty inode
2950 * @vi: inode to write out
2951 * @sync: if true, write out synchronously
2952 *
2953 * Write out a dirty inode to disk including any extent inodes if present.
2954 *
2955 * If @sync is true, commit the inode to disk and wait for io completion. This
2956 * is done using write_mft_record().
2957 *
2958 * If @sync is false, just schedule the write to happen but do not wait for i/o
2959 * completion. In 2.6 kernels, scheduling usually happens just by virtue of
2960 * marking the page (and in this case mft record) dirty but we do not implement
2961 * this yet as write_mft_record() largely ignores the @sync parameter and
2962 * always performs synchronous writes.
2963 *
2964 * Return 0 on success and -errno on error.
2965 */
Christoph Hellwiga9185b42010-03-05 09:21:37 +01002966int __ntfs_write_inode(struct inode *vi, int sync)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967{
2968 sle64 nt;
2969 ntfs_inode *ni = NTFS_I(vi);
2970 ntfs_attr_search_ctx *ctx;
2971 MFT_RECORD *m;
2972 STANDARD_INFORMATION *si;
2973 int err = 0;
Richard Knutssonc49c3112006-09-30 23:27:12 -07002974 bool modified = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975
2976 ntfs_debug("Entering for %sinode 0x%lx.", NInoAttr(ni) ? "attr " : "",
2977 vi->i_ino);
2978 /*
2979 * Dirty attribute inodes are written via their real inodes so just
2980 * clean them here. Access time updates are taken care off when the
2981 * real inode is written.
2982 */
2983 if (NInoAttr(ni)) {
2984 NInoClearDirty(ni);
2985 ntfs_debug("Done.");
2986 return 0;
2987 }
2988 /* Map, pin, and lock the mft record belonging to the inode. */
2989 m = map_mft_record(ni);
2990 if (IS_ERR(m)) {
2991 err = PTR_ERR(m);
2992 goto err_out;
2993 }
2994 /* Update the access times in the standard information attribute. */
2995 ctx = ntfs_attr_get_search_ctx(ni, m);
2996 if (unlikely(!ctx)) {
2997 err = -ENOMEM;
2998 goto unm_err_out;
2999 }
3000 err = ntfs_attr_lookup(AT_STANDARD_INFORMATION, NULL, 0,
3001 CASE_SENSITIVE, 0, NULL, 0, ctx);
3002 if (unlikely(err)) {
3003 ntfs_attr_put_search_ctx(ctx);
3004 goto unm_err_out;
3005 }
3006 si = (STANDARD_INFORMATION*)((u8*)ctx->attr +
3007 le16_to_cpu(ctx->attr->data.resident.value_offset));
3008 /* Update the access times if they have changed. */
3009 nt = utc2ntfs(vi->i_mtime);
3010 if (si->last_data_change_time != nt) {
3011 ntfs_debug("Updating mtime for inode 0x%lx: old = 0x%llx, "
Randy Dunlap89075472005-03-03 11:19:53 +00003012 "new = 0x%llx", vi->i_ino, (long long)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 sle64_to_cpu(si->last_data_change_time),
Randy Dunlap89075472005-03-03 11:19:53 +00003014 (long long)sle64_to_cpu(nt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015 si->last_data_change_time = nt;
Richard Knutssonc49c3112006-09-30 23:27:12 -07003016 modified = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 }
3018 nt = utc2ntfs(vi->i_ctime);
3019 if (si->last_mft_change_time != nt) {
3020 ntfs_debug("Updating ctime for inode 0x%lx: old = 0x%llx, "
Randy Dunlap89075472005-03-03 11:19:53 +00003021 "new = 0x%llx", vi->i_ino, (long long)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022 sle64_to_cpu(si->last_mft_change_time),
Randy Dunlap89075472005-03-03 11:19:53 +00003023 (long long)sle64_to_cpu(nt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024 si->last_mft_change_time = nt;
Richard Knutssonc49c3112006-09-30 23:27:12 -07003025 modified = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026 }
3027 nt = utc2ntfs(vi->i_atime);
3028 if (si->last_access_time != nt) {
3029 ntfs_debug("Updating atime for inode 0x%lx: old = 0x%llx, "
3030 "new = 0x%llx", vi->i_ino,
Randy Dunlap89075472005-03-03 11:19:53 +00003031 (long long)sle64_to_cpu(si->last_access_time),
3032 (long long)sle64_to_cpu(nt));
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 si->last_access_time = nt;
Richard Knutssonc49c3112006-09-30 23:27:12 -07003034 modified = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035 }
3036 /*
3037 * If we just modified the standard information attribute we need to
3038 * mark the mft record it is in dirty. We do this manually so that
3039 * mark_inode_dirty() is not called which would redirty the inode and
3040 * hence result in an infinite loop of trying to write the inode.
3041 * There is no need to mark the base inode nor the base mft record
3042 * dirty, since we are going to write this mft record below in any case
3043 * and the base mft record may actually not have been modified so it
3044 * might not need to be written out.
3045 * NOTE: It is not a problem when the inode for $MFT itself is being
3046 * written out as mark_ntfs_record_dirty() will only set I_DIRTY_PAGES
3047 * on the $MFT inode and hence ntfs_write_inode() will not be
3048 * re-invoked because of it which in turn is ok since the dirtied mft
3049 * record will be cleaned and written out to disk below, i.e. before
3050 * this function returns.
3051 */
Anton Altaparmakov20fdcf12006-03-23 16:21:02 +00003052 if (modified) {
3053 flush_dcache_mft_record_page(ctx->ntfs_ino);
Ingo Molnar4e5e5292006-03-23 16:57:48 +00003054 if (!NInoTestSetDirty(ctx->ntfs_ino))
Anton Altaparmakov20fdcf12006-03-23 16:21:02 +00003055 mark_ntfs_record_dirty(ctx->ntfs_ino->page,
3056 ctx->ntfs_ino->page_ofs);
3057 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003058 ntfs_attr_put_search_ctx(ctx);
3059 /* Now the access times are updated, write the base mft record. */
3060 if (NInoDirty(ni))
3061 err = write_mft_record(ni, m, sync);
3062 /* Write all attached extent mft records. */
Ingo Molnar4e5e5292006-03-23 16:57:48 +00003063 mutex_lock(&ni->extent_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 if (ni->nr_extents > 0) {
3065 ntfs_inode **extent_nis = ni->ext.extent_ntfs_inos;
3066 int i;
3067
3068 ntfs_debug("Writing %i extent inodes.", ni->nr_extents);
3069 for (i = 0; i < ni->nr_extents; i++) {
3070 ntfs_inode *tni = extent_nis[i];
3071
3072 if (NInoDirty(tni)) {
3073 MFT_RECORD *tm = map_mft_record(tni);
3074 int ret;
3075
3076 if (IS_ERR(tm)) {
3077 if (!err || err == -ENOMEM)
3078 err = PTR_ERR(tm);
3079 continue;
3080 }
3081 ret = write_mft_record(tni, tm, sync);
3082 unmap_mft_record(tni);
3083 if (unlikely(ret)) {
3084 if (!err || err == -ENOMEM)
3085 err = ret;
3086 }
3087 }
3088 }
3089 }
Ingo Molnar4e5e5292006-03-23 16:57:48 +00003090 mutex_unlock(&ni->extent_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003091 unmap_mft_record(ni);
3092 if (unlikely(err))
3093 goto err_out;
3094 ntfs_debug("Done.");
3095 return 0;
3096unm_err_out:
3097 unmap_mft_record(ni);
3098err_out:
3099 if (err == -ENOMEM) {
3100 ntfs_warning(vi->i_sb, "Not enough memory to write inode. "
3101 "Marking the inode dirty again, so the VFS "
3102 "retries later.");
3103 mark_inode_dirty(vi);
3104 } else {
Anton Altaparmakova778f212006-03-23 16:18:23 +00003105 ntfs_error(vi->i_sb, "Failed (error %i): Run chkdsk.", -err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003106 NVolSetErrors(ni->vol);
3107 }
3108 return err;
3109}
3110
3111#endif /* NTFS_RW */