]> nv-tegra.nvidia Code Review - linux-3.10.git/blob - fs/ntfs/inode.c
NTFS: Correct sparse file handling. The compressed values need to be
[linux-3.10.git] / fs / ntfs / inode.c
1 /**
2  * inode.c - NTFS kernel inode handling. Part of the Linux-NTFS project.
3  *
4  * Copyright (c) 2001-2005 Anton Altaparmakov
5  *
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
22 #include <linux/pagemap.h>
23 #include <linux/buffer_head.h>
24 #include <linux/smp_lock.h>
25 #include <linux/quotaops.h>
26 #include <linux/mount.h>
27
28 #include "aops.h"
29 #include "dir.h"
30 #include "debug.h"
31 #include "inode.h"
32 #include "attrib.h"
33 #include "malloc.h"
34 #include "mft.h"
35 #include "time.h"
36 #include "ntfs.h"
37
38 /**
39  * ntfs_test_inode - compare two (possibly fake) inodes for equality
40  * @vi:         vfs inode which to test
41  * @na:         ntfs attribute which is being tested with
42  *
43  * Compare the ntfs attribute embedded in the ntfs specific part of the vfs
44  * inode @vi for equality with the ntfs attribute @na.
45  *
46  * If searching for the normal file/directory inode, set @na->type to AT_UNUSED.
47  * @na->name and @na->name_len are then ignored.
48  *
49  * Return 1 if the attributes match and 0 if not.
50  *
51  * NOTE: This function runs with the inode_lock spin lock held so it is not
52  * allowed to sleep.
53  */
54 int ntfs_test_inode(struct inode *vi, ntfs_attr *na)
55 {
56         ntfs_inode *ni;
57
58         if (vi->i_ino != na->mft_no)
59                 return 0;
60         ni = NTFS_I(vi);
61         /* If !NInoAttr(ni), @vi is a normal file or directory inode. */
62         if (likely(!NInoAttr(ni))) {
63                 /* If not looking for a normal inode this is a mismatch. */
64                 if (unlikely(na->type != AT_UNUSED))
65                         return 0;
66         } else {
67                 /* A fake inode describing an attribute. */
68                 if (ni->type != na->type)
69                         return 0;
70                 if (ni->name_len != na->name_len)
71                         return 0;
72                 if (na->name_len && memcmp(ni->name, na->name,
73                                 na->name_len * sizeof(ntfschar)))
74                         return 0;
75         }
76         /* Match! */
77         return 1;
78 }
79
80 /**
81  * ntfs_init_locked_inode - initialize an inode
82  * @vi:         vfs inode to initialize
83  * @na:         ntfs attribute which to initialize @vi to
84  *
85  * Initialize the vfs inode @vi with the values from the ntfs attribute @na in
86  * order to enable ntfs_test_inode() to do its work.
87  *
88  * If initializing the normal file/directory inode, set @na->type to AT_UNUSED.
89  * In that case, @na->name and @na->name_len should be set to NULL and 0,
90  * respectively. Although that is not strictly necessary as
91  * ntfs_read_inode_locked() will fill them in later.
92  *
93  * Return 0 on success and -errno on error.
94  *
95  * NOTE: This function runs with the inode_lock spin lock held so it is not
96  * allowed to sleep. (Hence the GFP_ATOMIC allocation.)
97  */
98 static int ntfs_init_locked_inode(struct inode *vi, ntfs_attr *na)
99 {
100         ntfs_inode *ni = NTFS_I(vi);
101
102         vi->i_ino = na->mft_no;
103
104         ni->type = na->type;
105         if (na->type == AT_INDEX_ALLOCATION)
106                 NInoSetMstProtected(ni);
107
108         ni->name = na->name;
109         ni->name_len = na->name_len;
110
111         /* If initializing a normal inode, we are done. */
112         if (likely(na->type == AT_UNUSED)) {
113                 BUG_ON(na->name);
114                 BUG_ON(na->name_len);
115                 return 0;
116         }
117
118         /* It is a fake inode. */
119         NInoSetAttr(ni);
120
121         /*
122          * We have I30 global constant as an optimization as it is the name
123          * in >99.9% of named attributes! The other <0.1% incur a GFP_ATOMIC
124          * allocation but that is ok. And most attributes are unnamed anyway,
125          * thus the fraction of named attributes with name != I30 is actually
126          * absolutely tiny.
127          */
128         if (na->name_len && na->name != I30) {
129                 unsigned int i;
130
131                 BUG_ON(!na->name);
132                 i = na->name_len * sizeof(ntfschar);
133                 ni->name = (ntfschar*)kmalloc(i + sizeof(ntfschar), GFP_ATOMIC);
134                 if (!ni->name)
135                         return -ENOMEM;
136                 memcpy(ni->name, na->name, i);
137                 ni->name[i] = 0;
138         }
139         return 0;
140 }
141
142 typedef int (*set_t)(struct inode *, void *);
143 static int ntfs_read_locked_inode(struct inode *vi);
144 static int ntfs_read_locked_attr_inode(struct inode *base_vi, struct inode *vi);
145 static int ntfs_read_locked_index_inode(struct inode *base_vi,
146                 struct inode *vi);
147
148 /**
149  * ntfs_iget - obtain a struct inode corresponding to a specific normal inode
150  * @sb:         super block of mounted volume
151  * @mft_no:     mft record number / inode number to obtain
152  *
153  * Obtain the struct inode corresponding to a specific normal inode (i.e. a
154  * file or directory).
155  *
156  * If the inode is in the cache, it is just returned with an increased
157  * reference count. Otherwise, a new struct inode is allocated and initialized,
158  * and finally ntfs_read_locked_inode() is called to read in the inode and
159  * fill in the remainder of the inode structure.
160  *
161  * Return the struct inode on success. Check the return value with IS_ERR() and
162  * if true, the function failed and the error code is obtained from PTR_ERR().
163  */
164 struct inode *ntfs_iget(struct super_block *sb, unsigned long mft_no)
165 {
166         struct inode *vi;
167         ntfs_attr na;
168         int err;
169
170         na.mft_no = mft_no;
171         na.type = AT_UNUSED;
172         na.name = NULL;
173         na.name_len = 0;
174
175         vi = iget5_locked(sb, mft_no, (test_t)ntfs_test_inode,
176                         (set_t)ntfs_init_locked_inode, &na);
177         if (unlikely(!vi))
178                 return ERR_PTR(-ENOMEM);
179
180         err = 0;
181
182         /* If this is a freshly allocated inode, need to read it now. */
183         if (vi->i_state & I_NEW) {
184                 err = ntfs_read_locked_inode(vi);
185                 unlock_new_inode(vi);
186         }
187         /*
188          * There is no point in keeping bad inodes around if the failure was
189          * due to ENOMEM. We want to be able to retry again later.
190          */
191         if (unlikely(err == -ENOMEM)) {
192                 iput(vi);
193                 vi = ERR_PTR(err);
194         }
195         return vi;
196 }
197
198 /**
199  * ntfs_attr_iget - obtain a struct inode corresponding to an attribute
200  * @base_vi:    vfs base inode containing the attribute
201  * @type:       attribute type
202  * @name:       Unicode name of the attribute (NULL if unnamed)
203  * @name_len:   length of @name in Unicode characters (0 if unnamed)
204  *
205  * Obtain the (fake) struct inode corresponding to the attribute specified by
206  * @type, @name, and @name_len, which is present in the base mft record
207  * specified by the vfs inode @base_vi.
208  *
209  * If the attribute inode is in the cache, it is just returned with an
210  * increased reference count. Otherwise, a new struct inode is allocated and
211  * initialized, and finally ntfs_read_locked_attr_inode() is called to read the
212  * attribute and fill in the inode structure.
213  *
214  * Note, for index allocation attributes, you need to use ntfs_index_iget()
215  * instead of ntfs_attr_iget() as working with indices is a lot more complex.
216  *
217  * Return the struct inode of the attribute inode on success. Check the return
218  * value with IS_ERR() and if true, the function failed and the error code is
219  * obtained from PTR_ERR().
220  */
221 struct inode *ntfs_attr_iget(struct inode *base_vi, ATTR_TYPE type,
222                 ntfschar *name, u32 name_len)
223 {
224         struct inode *vi;
225         ntfs_attr na;
226         int err;
227
228         /* Make sure no one calls ntfs_attr_iget() for indices. */
229         BUG_ON(type == AT_INDEX_ALLOCATION);
230
231         na.mft_no = base_vi->i_ino;
232         na.type = type;
233         na.name = name;
234         na.name_len = name_len;
235
236         vi = iget5_locked(base_vi->i_sb, na.mft_no, (test_t)ntfs_test_inode,
237                         (set_t)ntfs_init_locked_inode, &na);
238         if (unlikely(!vi))
239                 return ERR_PTR(-ENOMEM);
240
241         err = 0;
242
243         /* If this is a freshly allocated inode, need to read it now. */
244         if (vi->i_state & I_NEW) {
245                 err = ntfs_read_locked_attr_inode(base_vi, vi);
246                 unlock_new_inode(vi);
247         }
248         /*
249          * There is no point in keeping bad attribute inodes around. This also
250          * simplifies things in that we never need to check for bad attribute
251          * inodes elsewhere.
252          */
253         if (unlikely(err)) {
254                 iput(vi);
255                 vi = ERR_PTR(err);
256         }
257         return vi;
258 }
259
260 /**
261  * ntfs_index_iget - obtain a struct inode corresponding to an index
262  * @base_vi:    vfs base inode containing the index related attributes
263  * @name:       Unicode name of the index
264  * @name_len:   length of @name in Unicode characters
265  *
266  * Obtain the (fake) struct inode corresponding to the index specified by @name
267  * and @name_len, which is present in the base mft record specified by the vfs
268  * inode @base_vi.
269  *
270  * If the index inode is in the cache, it is just returned with an increased
271  * reference count.  Otherwise, a new struct inode is allocated and
272  * initialized, and finally ntfs_read_locked_index_inode() is called to read
273  * the index related attributes and fill in the inode structure.
274  *
275  * Return the struct inode of the index inode on success. Check the return
276  * value with IS_ERR() and if true, the function failed and the error code is
277  * obtained from PTR_ERR().
278  */
279 struct inode *ntfs_index_iget(struct inode *base_vi, ntfschar *name,
280                 u32 name_len)
281 {
282         struct inode *vi;
283         ntfs_attr na;
284         int err;
285
286         na.mft_no = base_vi->i_ino;
287         na.type = AT_INDEX_ALLOCATION;
288         na.name = name;
289         na.name_len = name_len;
290
291         vi = iget5_locked(base_vi->i_sb, na.mft_no, (test_t)ntfs_test_inode,
292                         (set_t)ntfs_init_locked_inode, &na);
293         if (unlikely(!vi))
294                 return ERR_PTR(-ENOMEM);
295
296         err = 0;
297
298         /* If this is a freshly allocated inode, need to read it now. */
299         if (vi->i_state & I_NEW) {
300                 err = ntfs_read_locked_index_inode(base_vi, vi);
301                 unlock_new_inode(vi);
302         }
303         /*
304          * There is no point in keeping bad index inodes around.  This also
305          * simplifies things in that we never need to check for bad index
306          * inodes elsewhere.
307          */
308         if (unlikely(err)) {
309                 iput(vi);
310                 vi = ERR_PTR(err);
311         }
312         return vi;
313 }
314
315 struct inode *ntfs_alloc_big_inode(struct super_block *sb)
316 {
317         ntfs_inode *ni;
318
319         ntfs_debug("Entering.");
320         ni = (ntfs_inode *)kmem_cache_alloc(ntfs_big_inode_cache,
321                         SLAB_NOFS);
322         if (likely(ni != NULL)) {
323                 ni->state = 0;
324                 return VFS_I(ni);
325         }
326         ntfs_error(sb, "Allocation of NTFS big inode structure failed.");
327         return NULL;
328 }
329
330 void ntfs_destroy_big_inode(struct inode *inode)
331 {
332         ntfs_inode *ni = NTFS_I(inode);
333
334         ntfs_debug("Entering.");
335         BUG_ON(ni->page);
336         if (!atomic_dec_and_test(&ni->count))
337                 BUG();
338         kmem_cache_free(ntfs_big_inode_cache, NTFS_I(inode));
339 }
340
341 static inline ntfs_inode *ntfs_alloc_extent_inode(void)
342 {
343         ntfs_inode *ni;
344
345         ntfs_debug("Entering.");
346         ni = (ntfs_inode *)kmem_cache_alloc(ntfs_inode_cache, SLAB_NOFS);
347         if (likely(ni != NULL)) {
348                 ni->state = 0;
349                 return ni;
350         }
351         ntfs_error(NULL, "Allocation of NTFS inode structure failed.");
352         return NULL;
353 }
354
355 static void ntfs_destroy_extent_inode(ntfs_inode *ni)
356 {
357         ntfs_debug("Entering.");
358         BUG_ON(ni->page);
359         if (!atomic_dec_and_test(&ni->count))
360                 BUG();
361         kmem_cache_free(ntfs_inode_cache, ni);
362 }
363
364 /**
365  * __ntfs_init_inode - initialize ntfs specific part of an inode
366  * @sb:         super block of mounted volume
367  * @ni:         freshly allocated ntfs inode which to initialize
368  *
369  * Initialize an ntfs inode to defaults.
370  *
371  * NOTE: ni->mft_no, ni->state, ni->type, ni->name, and ni->name_len are left
372  * untouched. Make sure to initialize them elsewhere.
373  *
374  * Return zero on success and -ENOMEM on error.
375  */
376 void __ntfs_init_inode(struct super_block *sb, ntfs_inode *ni)
377 {
378         ntfs_debug("Entering.");
379         rwlock_init(&ni->size_lock);
380         ni->initialized_size = ni->allocated_size = 0;
381         ni->seq_no = 0;
382         atomic_set(&ni->count, 1);
383         ni->vol = NTFS_SB(sb);
384         ntfs_init_runlist(&ni->runlist);
385         init_MUTEX(&ni->mrec_lock);
386         ni->page = NULL;
387         ni->page_ofs = 0;
388         ni->attr_list_size = 0;
389         ni->attr_list = NULL;
390         ntfs_init_runlist(&ni->attr_list_rl);
391         ni->itype.index.bmp_ino = NULL;
392         ni->itype.index.block_size = 0;
393         ni->itype.index.vcn_size = 0;
394         ni->itype.index.collation_rule = 0;
395         ni->itype.index.block_size_bits = 0;
396         ni->itype.index.vcn_size_bits = 0;
397         init_MUTEX(&ni->extent_lock);
398         ni->nr_extents = 0;
399         ni->ext.base_ntfs_ino = NULL;
400 }
401
402 inline ntfs_inode *ntfs_new_extent_inode(struct super_block *sb,
403                 unsigned long mft_no)
404 {
405         ntfs_inode *ni = ntfs_alloc_extent_inode();
406
407         ntfs_debug("Entering.");
408         if (likely(ni != NULL)) {
409                 __ntfs_init_inode(sb, ni);
410                 ni->mft_no = mft_no;
411                 ni->type = AT_UNUSED;
412                 ni->name = NULL;
413                 ni->name_len = 0;
414         }
415         return ni;
416 }
417
418 /**
419  * ntfs_is_extended_system_file - check if a file is in the $Extend directory
420  * @ctx:        initialized attribute search context
421  *
422  * Search all file name attributes in the inode described by the attribute
423  * search context @ctx and check if any of the names are in the $Extend system
424  * directory.
425  *
426  * Return values:
427  *         1: file is in $Extend directory
428  *         0: file is not in $Extend directory
429  *    -errno: failed to determine if the file is in the $Extend directory
430  */
431 static int ntfs_is_extended_system_file(ntfs_attr_search_ctx *ctx)
432 {
433         int nr_links, err;
434
435         /* Restart search. */
436         ntfs_attr_reinit_search_ctx(ctx);
437
438         /* Get number of hard links. */
439         nr_links = le16_to_cpu(ctx->mrec->link_count);
440
441         /* Loop through all hard links. */
442         while (!(err = ntfs_attr_lookup(AT_FILE_NAME, NULL, 0, 0, 0, NULL, 0,
443                         ctx))) {
444                 FILE_NAME_ATTR *file_name_attr;
445                 ATTR_RECORD *attr = ctx->attr;
446                 u8 *p, *p2;
447
448                 nr_links--;
449                 /*
450                  * Maximum sanity checking as we are called on an inode that
451                  * we suspect might be corrupt.
452                  */
453                 p = (u8*)attr + le32_to_cpu(attr->length);
454                 if (p < (u8*)ctx->mrec || (u8*)p > (u8*)ctx->mrec +
455                                 le32_to_cpu(ctx->mrec->bytes_in_use)) {
456 err_corrupt_attr:
457                         ntfs_error(ctx->ntfs_ino->vol->sb, "Corrupt file name "
458                                         "attribute. You should run chkdsk.");
459                         return -EIO;
460                 }
461                 if (attr->non_resident) {
462                         ntfs_error(ctx->ntfs_ino->vol->sb, "Non-resident file "
463                                         "name. You should run chkdsk.");
464                         return -EIO;
465                 }
466                 if (attr->flags) {
467                         ntfs_error(ctx->ntfs_ino->vol->sb, "File name with "
468                                         "invalid flags. You should run "
469                                         "chkdsk.");
470                         return -EIO;
471                 }
472                 if (!(attr->data.resident.flags & RESIDENT_ATTR_IS_INDEXED)) {
473                         ntfs_error(ctx->ntfs_ino->vol->sb, "Unindexed file "
474                                         "name. You should run chkdsk.");
475                         return -EIO;
476                 }
477                 file_name_attr = (FILE_NAME_ATTR*)((u8*)attr +
478                                 le16_to_cpu(attr->data.resident.value_offset));
479                 p2 = (u8*)attr + le32_to_cpu(attr->data.resident.value_length);
480                 if (p2 < (u8*)attr || p2 > p)
481                         goto err_corrupt_attr;
482                 /* This attribute is ok, but is it in the $Extend directory? */
483                 if (MREF_LE(file_name_attr->parent_directory) == FILE_Extend)
484                         return 1;       /* YES, it's an extended system file. */
485         }
486         if (unlikely(err != -ENOENT))
487                 return err;
488         if (unlikely(nr_links)) {
489                 ntfs_error(ctx->ntfs_ino->vol->sb, "Inode hard link count "
490                                 "doesn't match number of name attributes. You "
491                                 "should run chkdsk.");
492                 return -EIO;
493         }
494         return 0;       /* NO, it is not an extended system file. */
495 }
496
497 /**
498  * ntfs_read_locked_inode - read an inode from its device
499  * @vi:         inode to read
500  *
501  * ntfs_read_locked_inode() is called from ntfs_iget() to read the inode
502  * described by @vi into memory from the device.
503  *
504  * The only fields in @vi that we need to/can look at when the function is
505  * called are i_sb, pointing to the mounted device's super block, and i_ino,
506  * the number of the inode to load.
507  *
508  * ntfs_read_locked_inode() maps, pins and locks the mft record number i_ino
509  * for reading and sets up the necessary @vi fields as well as initializing
510  * the ntfs inode.
511  *
512  * Q: What locks are held when the function is called?
513  * A: i_state has I_LOCK set, hence the inode is locked, also
514  *    i_count is set to 1, so it is not going to go away
515  *    i_flags is set to 0 and we have no business touching it.  Only an ioctl()
516  *    is allowed to write to them. We should of course be honouring them but
517  *    we need to do that using the IS_* macros defined in include/linux/fs.h.
518  *    In any case ntfs_read_locked_inode() has nothing to do with i_flags.
519  *
520  * Return 0 on success and -errno on error.  In the error case, the inode will
521  * have had make_bad_inode() executed on it.
522  */
523 static int ntfs_read_locked_inode(struct inode *vi)
524 {
525         ntfs_volume *vol = NTFS_SB(vi->i_sb);
526         ntfs_inode *ni;
527         MFT_RECORD *m;
528         ATTR_RECORD *a;
529         STANDARD_INFORMATION *si;
530         ntfs_attr_search_ctx *ctx;
531         int err = 0;
532
533         ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
534
535         /* Setup the generic vfs inode parts now. */
536
537         /* This is the optimal IO size (for stat), not the fs block size. */
538         vi->i_blksize = PAGE_CACHE_SIZE;
539         /*
540          * This is for checking whether an inode has changed w.r.t. a file so
541          * that the file can be updated if necessary (compare with f_version).
542          */
543         vi->i_version = 1;
544
545         vi->i_uid = vol->uid;
546         vi->i_gid = vol->gid;
547         vi->i_mode = 0;
548
549         /*
550          * Initialize the ntfs specific part of @vi special casing
551          * FILE_MFT which we need to do at mount time.
552          */
553         if (vi->i_ino != FILE_MFT)
554                 ntfs_init_big_inode(vi);
555         ni = NTFS_I(vi);
556
557         m = map_mft_record(ni);
558         if (IS_ERR(m)) {
559                 err = PTR_ERR(m);
560                 goto err_out;
561         }
562         ctx = ntfs_attr_get_search_ctx(ni, m);
563         if (!ctx) {
564                 err = -ENOMEM;
565                 goto unm_err_out;
566         }
567
568         if (!(m->flags & MFT_RECORD_IN_USE)) {
569                 ntfs_error(vi->i_sb, "Inode is not in use!");
570                 goto unm_err_out;
571         }
572         if (m->base_mft_record) {
573                 ntfs_error(vi->i_sb, "Inode is an extent inode!");
574                 goto unm_err_out;
575         }
576
577         /* Transfer information from mft record into vfs and ntfs inodes. */
578         vi->i_generation = ni->seq_no = le16_to_cpu(m->sequence_number);
579
580         /*
581          * FIXME: Keep in mind that link_count is two for files which have both
582          * a long file name and a short file name as separate entries, so if
583          * we are hiding short file names this will be too high. Either we need
584          * to account for the short file names by subtracting them or we need
585          * to make sure we delete files even though i_nlink is not zero which
586          * might be tricky due to vfs interactions. Need to think about this
587          * some more when implementing the unlink command.
588          */
589         vi->i_nlink = le16_to_cpu(m->link_count);
590         /*
591          * FIXME: Reparse points can have the directory bit set even though
592          * they would be S_IFLNK. Need to deal with this further below when we
593          * implement reparse points / symbolic links but it will do for now.
594          * Also if not a directory, it could be something else, rather than
595          * a regular file. But again, will do for now.
596          */
597         /* Everyone gets all permissions. */
598         vi->i_mode |= S_IRWXUGO;
599         /* If read-only, noone gets write permissions. */
600         if (IS_RDONLY(vi))
601                 vi->i_mode &= ~S_IWUGO;
602         if (m->flags & MFT_RECORD_IS_DIRECTORY) {
603                 vi->i_mode |= S_IFDIR;
604                 /*
605                  * Apply the directory permissions mask set in the mount
606                  * options.
607                  */
608                 vi->i_mode &= ~vol->dmask;
609                 /* Things break without this kludge! */
610                 if (vi->i_nlink > 1)
611                         vi->i_nlink = 1;
612         } else {
613                 vi->i_mode |= S_IFREG;
614                 /* Apply the file permissions mask set in the mount options. */
615                 vi->i_mode &= ~vol->fmask;
616         }
617         /*
618          * Find the standard information attribute in the mft record. At this
619          * stage we haven't setup the attribute list stuff yet, so this could
620          * in fact fail if the standard information is in an extent record, but
621          * I don't think this actually ever happens.
622          */
623         err = ntfs_attr_lookup(AT_STANDARD_INFORMATION, NULL, 0, 0, 0, NULL, 0,
624                         ctx);
625         if (unlikely(err)) {
626                 if (err == -ENOENT) {
627                         /*
628                          * TODO: We should be performing a hot fix here (if the
629                          * recover mount option is set) by creating a new
630                          * attribute.
631                          */
632                         ntfs_error(vi->i_sb, "$STANDARD_INFORMATION attribute "
633                                         "is missing.");
634                 }
635                 goto unm_err_out;
636         }
637         a = ctx->attr;
638         /* Get the standard information attribute value. */
639         si = (STANDARD_INFORMATION*)((u8*)a +
640                         le16_to_cpu(a->data.resident.value_offset));
641
642         /* Transfer information from the standard information into vi. */
643         /*
644          * Note: The i_?times do not quite map perfectly onto the NTFS times,
645          * but they are close enough, and in the end it doesn't really matter
646          * that much...
647          */
648         /*
649          * mtime is the last change of the data within the file. Not changed
650          * when only metadata is changed, e.g. a rename doesn't affect mtime.
651          */
652         vi->i_mtime = ntfs2utc(si->last_data_change_time);
653         /*
654          * ctime is the last change of the metadata of the file. This obviously
655          * always changes, when mtime is changed. ctime can be changed on its
656          * own, mtime is then not changed, e.g. when a file is renamed.
657          */
658         vi->i_ctime = ntfs2utc(si->last_mft_change_time);
659         /*
660          * Last access to the data within the file. Not changed during a rename
661          * for example but changed whenever the file is written to.
662          */
663         vi->i_atime = ntfs2utc(si->last_access_time);
664
665         /* Find the attribute list attribute if present. */
666         ntfs_attr_reinit_search_ctx(ctx);
667         err = ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, 0, 0, NULL, 0, ctx);
668         if (err) {
669                 if (unlikely(err != -ENOENT)) {
670                         ntfs_error(vi->i_sb, "Failed to lookup attribute list "
671                                         "attribute.");
672                         goto unm_err_out;
673                 }
674         } else /* if (!err) */ {
675                 if (vi->i_ino == FILE_MFT)
676                         goto skip_attr_list_load;
677                 ntfs_debug("Attribute list found in inode 0x%lx.", vi->i_ino);
678                 NInoSetAttrList(ni);
679                 a = ctx->attr;
680                 if (a->flags & ATTR_IS_ENCRYPTED ||
681                                 a->flags & ATTR_COMPRESSION_MASK ||
682                                 a->flags & ATTR_IS_SPARSE) {
683                         ntfs_error(vi->i_sb, "Attribute list attribute is "
684                                         "compressed/encrypted/sparse.");
685                         goto unm_err_out;
686                 }
687                 /* Now allocate memory for the attribute list. */
688                 ni->attr_list_size = (u32)ntfs_attr_size(a);
689                 ni->attr_list = ntfs_malloc_nofs(ni->attr_list_size);
690                 if (!ni->attr_list) {
691                         ntfs_error(vi->i_sb, "Not enough memory to allocate "
692                                         "buffer for attribute list.");
693                         err = -ENOMEM;
694                         goto unm_err_out;
695                 }
696                 if (a->non_resident) {
697                         NInoSetAttrListNonResident(ni);
698                         if (a->data.non_resident.lowest_vcn) {
699                                 ntfs_error(vi->i_sb, "Attribute list has non "
700                                                 "zero lowest_vcn.");
701                                 goto unm_err_out;
702                         }
703                         /*
704                          * Setup the runlist. No need for locking as we have
705                          * exclusive access to the inode at this time.
706                          */
707                         ni->attr_list_rl.rl = ntfs_mapping_pairs_decompress(vol,
708                                         a, NULL);
709                         if (IS_ERR(ni->attr_list_rl.rl)) {
710                                 err = PTR_ERR(ni->attr_list_rl.rl);
711                                 ni->attr_list_rl.rl = NULL;
712                                 ntfs_error(vi->i_sb, "Mapping pairs "
713                                                 "decompression failed.");
714                                 goto unm_err_out;
715                         }
716                         /* Now load the attribute list. */
717                         if ((err = load_attribute_list(vol, &ni->attr_list_rl,
718                                         ni->attr_list, ni->attr_list_size,
719                                         sle64_to_cpu(a->data.non_resident.
720                                         initialized_size)))) {
721                                 ntfs_error(vi->i_sb, "Failed to load "
722                                                 "attribute list attribute.");
723                                 goto unm_err_out;
724                         }
725                 } else /* if (!a->non_resident) */ {
726                         if ((u8*)a + le16_to_cpu(a->data.resident.value_offset)
727                                         + le32_to_cpu(
728                                         a->data.resident.value_length) >
729                                         (u8*)ctx->mrec + vol->mft_record_size) {
730                                 ntfs_error(vi->i_sb, "Corrupt attribute list "
731                                                 "in inode.");
732                                 goto unm_err_out;
733                         }
734                         /* Now copy the attribute list. */
735                         memcpy(ni->attr_list, (u8*)a + le16_to_cpu(
736                                         a->data.resident.value_offset),
737                                         le32_to_cpu(
738                                         a->data.resident.value_length));
739                 }
740         }
741 skip_attr_list_load:
742         /*
743          * If an attribute list is present we now have the attribute list value
744          * in ntfs_ino->attr_list and it is ntfs_ino->attr_list_size bytes.
745          */
746         if (S_ISDIR(vi->i_mode)) {
747                 loff_t bvi_size;
748                 struct inode *bvi;
749                 ntfs_inode *bni;
750                 INDEX_ROOT *ir;
751                 u8 *ir_end, *index_end;
752
753                 /* It is a directory, find index root attribute. */
754                 ntfs_attr_reinit_search_ctx(ctx);
755                 err = ntfs_attr_lookup(AT_INDEX_ROOT, I30, 4, CASE_SENSITIVE,
756                                 0, NULL, 0, ctx);
757                 if (unlikely(err)) {
758                         if (err == -ENOENT) {
759                                 // FIXME: File is corrupt! Hot-fix with empty
760                                 // index root attribute if recovery option is
761                                 // set.
762                                 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute "
763                                                 "is missing.");
764                         }
765                         goto unm_err_out;
766                 }
767                 a = ctx->attr;
768                 /* Set up the state. */
769                 if (unlikely(a->non_resident)) {
770                         ntfs_error(vol->sb, "$INDEX_ROOT attribute is not "
771                                         "resident.");
772                         goto unm_err_out;
773                 }
774                 /* Ensure the attribute name is placed before the value. */
775                 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
776                                 le16_to_cpu(a->data.resident.value_offset)))) {
777                         ntfs_error(vol->sb, "$INDEX_ROOT attribute name is "
778                                         "placed after the attribute value.");
779                         goto unm_err_out;
780                 }
781                 /*
782                  * Compressed/encrypted index root just means that the newly
783                  * created files in that directory should be created compressed/
784                  * encrypted. However index root cannot be both compressed and
785                  * encrypted.
786                  */
787                 if (a->flags & ATTR_COMPRESSION_MASK)
788                         NInoSetCompressed(ni);
789                 if (a->flags & ATTR_IS_ENCRYPTED) {
790                         if (a->flags & ATTR_COMPRESSION_MASK) {
791                                 ntfs_error(vi->i_sb, "Found encrypted and "
792                                                 "compressed attribute.");
793                                 goto unm_err_out;
794                         }
795                         NInoSetEncrypted(ni);
796                 }
797                 if (a->flags & ATTR_IS_SPARSE)
798                         NInoSetSparse(ni);
799                 ir = (INDEX_ROOT*)((u8*)a +
800                                 le16_to_cpu(a->data.resident.value_offset));
801                 ir_end = (u8*)ir + le32_to_cpu(a->data.resident.value_length);
802                 if (ir_end > (u8*)ctx->mrec + vol->mft_record_size) {
803                         ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is "
804                                         "corrupt.");
805                         goto unm_err_out;
806                 }
807                 index_end = (u8*)&ir->index +
808                                 le32_to_cpu(ir->index.index_length);
809                 if (index_end > ir_end) {
810                         ntfs_error(vi->i_sb, "Directory index is corrupt.");
811                         goto unm_err_out;
812                 }
813                 if (ir->type != AT_FILE_NAME) {
814                         ntfs_error(vi->i_sb, "Indexed attribute is not "
815                                         "$FILE_NAME.");
816                         goto unm_err_out;
817                 }
818                 if (ir->collation_rule != COLLATION_FILE_NAME) {
819                         ntfs_error(vi->i_sb, "Index collation rule is not "
820                                         "COLLATION_FILE_NAME.");
821                         goto unm_err_out;
822                 }
823                 ni->itype.index.collation_rule = ir->collation_rule;
824                 ni->itype.index.block_size = le32_to_cpu(ir->index_block_size);
825                 if (ni->itype.index.block_size &
826                                 (ni->itype.index.block_size - 1)) {
827                         ntfs_error(vi->i_sb, "Index block size (%u) is not a "
828                                         "power of two.",
829                                         ni->itype.index.block_size);
830                         goto unm_err_out;
831                 }
832                 if (ni->itype.index.block_size > PAGE_CACHE_SIZE) {
833                         ntfs_error(vi->i_sb, "Index block size (%u) > "
834                                         "PAGE_CACHE_SIZE (%ld) is not "
835                                         "supported.  Sorry.",
836                                         ni->itype.index.block_size,
837                                         PAGE_CACHE_SIZE);
838                         err = -EOPNOTSUPP;
839                         goto unm_err_out;
840                 }
841                 if (ni->itype.index.block_size < NTFS_BLOCK_SIZE) {
842                         ntfs_error(vi->i_sb, "Index block size (%u) < "
843                                         "NTFS_BLOCK_SIZE (%i) is not "
844                                         "supported.  Sorry.",
845                                         ni->itype.index.block_size,
846                                         NTFS_BLOCK_SIZE);
847                         err = -EOPNOTSUPP;
848                         goto unm_err_out;
849                 }
850                 ni->itype.index.block_size_bits =
851                                 ffs(ni->itype.index.block_size) - 1;
852                 /* Determine the size of a vcn in the directory index. */
853                 if (vol->cluster_size <= ni->itype.index.block_size) {
854                         ni->itype.index.vcn_size = vol->cluster_size;
855                         ni->itype.index.vcn_size_bits = vol->cluster_size_bits;
856                 } else {
857                         ni->itype.index.vcn_size = vol->sector_size;
858                         ni->itype.index.vcn_size_bits = vol->sector_size_bits;
859                 }
860
861                 /* Setup the index allocation attribute, even if not present. */
862                 NInoSetMstProtected(ni);
863                 ni->type = AT_INDEX_ALLOCATION;
864                 ni->name = I30;
865                 ni->name_len = 4;
866
867                 if (!(ir->index.flags & LARGE_INDEX)) {
868                         /* No index allocation. */
869                         vi->i_size = ni->initialized_size =
870                                         ni->allocated_size = 0;
871                         /* We are done with the mft record, so we release it. */
872                         ntfs_attr_put_search_ctx(ctx);
873                         unmap_mft_record(ni);
874                         m = NULL;
875                         ctx = NULL;
876                         goto skip_large_dir_stuff;
877                 } /* LARGE_INDEX: Index allocation present. Setup state. */
878                 NInoSetIndexAllocPresent(ni);
879                 /* Find index allocation attribute. */
880                 ntfs_attr_reinit_search_ctx(ctx);
881                 err = ntfs_attr_lookup(AT_INDEX_ALLOCATION, I30, 4,
882                                 CASE_SENSITIVE, 0, NULL, 0, ctx);
883                 if (unlikely(err)) {
884                         if (err == -ENOENT)
885                                 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION "
886                                                 "attribute is not present but "
887                                                 "$INDEX_ROOT indicated it is.");
888                         else
889                                 ntfs_error(vi->i_sb, "Failed to lookup "
890                                                 "$INDEX_ALLOCATION "
891                                                 "attribute.");
892                         goto unm_err_out;
893                 }
894                 a = ctx->attr;
895                 if (!a->non_resident) {
896                         ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
897                                         "is resident.");
898                         goto unm_err_out;
899                 }
900                 /*
901                  * Ensure the attribute name is placed before the mapping pairs
902                  * array.
903                  */
904                 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
905                                 le16_to_cpu(
906                                 a->data.non_resident.mapping_pairs_offset)))) {
907                         ntfs_error(vol->sb, "$INDEX_ALLOCATION attribute name "
908                                         "is placed after the mapping pairs "
909                                         "array.");
910                         goto unm_err_out;
911                 }
912                 if (a->flags & ATTR_IS_ENCRYPTED) {
913                         ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
914                                         "is encrypted.");
915                         goto unm_err_out;
916                 }
917                 if (a->flags & ATTR_IS_SPARSE) {
918                         ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
919                                         "is sparse.");
920                         goto unm_err_out;
921                 }
922                 if (a->flags & ATTR_COMPRESSION_MASK) {
923                         ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute "
924                                         "is compressed.");
925                         goto unm_err_out;
926                 }
927                 if (a->data.non_resident.lowest_vcn) {
928                         ntfs_error(vi->i_sb, "First extent of "
929                                         "$INDEX_ALLOCATION attribute has non "
930                                         "zero lowest_vcn.");
931                         goto unm_err_out;
932                 }
933                 vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
934                 ni->initialized_size = sle64_to_cpu(
935                                 a->data.non_resident.initialized_size);
936                 ni->allocated_size = sle64_to_cpu(
937                                 a->data.non_resident.allocated_size);
938                 /*
939                  * We are done with the mft record, so we release it. Otherwise
940                  * we would deadlock in ntfs_attr_iget().
941                  */
942                 ntfs_attr_put_search_ctx(ctx);
943                 unmap_mft_record(ni);
944                 m = NULL;
945                 ctx = NULL;
946                 /* Get the index bitmap attribute inode. */
947                 bvi = ntfs_attr_iget(vi, AT_BITMAP, I30, 4);
948                 if (IS_ERR(bvi)) {
949                         ntfs_error(vi->i_sb, "Failed to get bitmap attribute.");
950                         err = PTR_ERR(bvi);
951                         goto unm_err_out;
952                 }
953                 ni->itype.index.bmp_ino = bvi;
954                 bni = NTFS_I(bvi);
955                 if (NInoCompressed(bni) || NInoEncrypted(bni) ||
956                                 NInoSparse(bni)) {
957                         ntfs_error(vi->i_sb, "$BITMAP attribute is compressed "
958                                         "and/or encrypted and/or sparse.");
959                         goto unm_err_out;
960                 }
961                 /* Consistency check bitmap size vs. index allocation size. */
962                 bvi_size = i_size_read(bvi);
963                 if ((bvi_size << 3) < (vi->i_size >>
964                                 ni->itype.index.block_size_bits)) {
965                         ntfs_error(vi->i_sb, "Index bitmap too small (0x%llx) "
966                                         "for index allocation (0x%llx).",
967                                         bvi_size << 3, vi->i_size);
968                         goto unm_err_out;
969                 }
970 skip_large_dir_stuff:
971                 /* Setup the operations for this inode. */
972                 vi->i_op = &ntfs_dir_inode_ops;
973                 vi->i_fop = &ntfs_dir_ops;
974         } else {
975                 /* It is a file. */
976                 ntfs_attr_reinit_search_ctx(ctx);
977
978                 /* Setup the data attribute, even if not present. */
979                 ni->type = AT_DATA;
980                 ni->name = NULL;
981                 ni->name_len = 0;
982
983                 /* Find first extent of the unnamed data attribute. */
984                 err = ntfs_attr_lookup(AT_DATA, NULL, 0, 0, 0, NULL, 0, ctx);
985                 if (unlikely(err)) {
986                         vi->i_size = ni->initialized_size =
987                                         ni->allocated_size = 0;
988                         if (err != -ENOENT) {
989                                 ntfs_error(vi->i_sb, "Failed to lookup $DATA "
990                                                 "attribute.");
991                                 goto unm_err_out;
992                         }
993                         /*
994                          * FILE_Secure does not have an unnamed $DATA
995                          * attribute, so we special case it here.
996                          */
997                         if (vi->i_ino == FILE_Secure)
998                                 goto no_data_attr_special_case;
999                         /*
1000                          * Most if not all the system files in the $Extend
1001                          * system directory do not have unnamed data
1002                          * attributes so we need to check if the parent
1003                          * directory of the file is FILE_Extend and if it is
1004                          * ignore this error. To do this we need to get the
1005                          * name of this inode from the mft record as the name
1006                          * contains the back reference to the parent directory.
1007                          */
1008                         if (ntfs_is_extended_system_file(ctx) > 0)
1009                                 goto no_data_attr_special_case;
1010                         // FIXME: File is corrupt! Hot-fix with empty data
1011                         // attribute if recovery option is set.
1012                         ntfs_error(vi->i_sb, "$DATA attribute is missing.");
1013                         goto unm_err_out;
1014                 }
1015                 a = ctx->attr;
1016                 /* Setup the state. */
1017                 if (a->non_resident) {
1018                         NInoSetNonResident(ni);
1019                         if (a->flags & (ATTR_COMPRESSION_MASK |
1020                                         ATTR_IS_SPARSE)) {
1021                                 if (a->flags & ATTR_COMPRESSION_MASK) {
1022                                         NInoSetCompressed(ni);
1023                                         if (vol->cluster_size > 4096) {
1024                                                 ntfs_error(vi->i_sb, "Found "
1025                                                         "compressed data but "
1026                                                         "compression is "
1027                                                         "disabled due to "
1028                                                         "cluster size (%i) > "
1029                                                         "4kiB.",
1030                                                         vol->cluster_size);
1031                                                 goto unm_err_out;
1032                                         }
1033                                         if ((a->flags & ATTR_COMPRESSION_MASK)
1034                                                         != ATTR_IS_COMPRESSED) {
1035                                                 ntfs_error(vi->i_sb, "Found "
1036                                                         "unknown compression "
1037                                                         "method or corrupt "
1038                                                         "file.");
1039                                                 goto unm_err_out;
1040                                         }
1041                                 }
1042                                 if (a->flags & ATTR_IS_SPARSE)
1043                                         NInoSetSparse(ni);
1044                                 if (a->data.non_resident.compression_unit !=
1045                                                 4) {
1046                                         ntfs_error(vi->i_sb, "Found "
1047                                                 "nonstandard compression unit "
1048                                                 "(%u instead of 4).  Cannot "
1049                                                 "handle this.",
1050                                                 a->data.non_resident.
1051                                                 compression_unit);
1052                                         err = -EOPNOTSUPP;
1053                                         goto unm_err_out;
1054                                 }
1055                                 ni->itype.compressed.block_clusters = 1U <<
1056                                                 a->data.non_resident.
1057                                                 compression_unit;
1058                                 ni->itype.compressed.block_size = 1U << (
1059                                                 a->data.non_resident.
1060                                                 compression_unit +
1061                                                 vol->cluster_size_bits);
1062                                 ni->itype.compressed.block_size_bits = ffs(
1063                                                 ni->itype.compressed.
1064                                                 block_size) - 1;
1065                                 ni->itype.compressed.size = sle64_to_cpu(
1066                                                 a->data.non_resident.
1067                                                 compressed_size);
1068                         }
1069                         if (a->flags & ATTR_IS_ENCRYPTED) {
1070                                 if (a->flags & ATTR_COMPRESSION_MASK) {
1071                                         ntfs_error(vi->i_sb, "Found encrypted "
1072                                                         "and compressed data.");
1073                                         goto unm_err_out;
1074                                 }
1075                                 NInoSetEncrypted(ni);
1076                         }
1077                         if (a->data.non_resident.lowest_vcn) {
1078                                 ntfs_error(vi->i_sb, "First extent of $DATA "
1079                                                 "attribute has non zero "
1080                                                 "lowest_vcn.");
1081                                 goto unm_err_out;
1082                         }
1083                         vi->i_size = sle64_to_cpu(
1084                                         a->data.non_resident.data_size);
1085                         ni->initialized_size = sle64_to_cpu(
1086                                         a->data.non_resident.initialized_size);
1087                         ni->allocated_size = sle64_to_cpu(
1088                                         a->data.non_resident.allocated_size);
1089                 } else { /* Resident attribute. */
1090                         vi->i_size = ni->initialized_size = le32_to_cpu(
1091                                         a->data.resident.value_length);
1092                         ni->allocated_size = le32_to_cpu(a->length) -
1093                                         le16_to_cpu(
1094                                         a->data.resident.value_offset);
1095                         if (vi->i_size > ni->allocated_size) {
1096                                 ntfs_error(vi->i_sb, "Resident data attribute "
1097                                                 "is corrupt (size exceeds "
1098                                                 "allocation).");
1099                                 goto unm_err_out;
1100                         }
1101                 }
1102 no_data_attr_special_case:
1103                 /* We are done with the mft record, so we release it. */
1104                 ntfs_attr_put_search_ctx(ctx);
1105                 unmap_mft_record(ni);
1106                 m = NULL;
1107                 ctx = NULL;
1108                 /* Setup the operations for this inode. */
1109                 vi->i_op = &ntfs_file_inode_ops;
1110                 vi->i_fop = &ntfs_file_ops;
1111         }
1112         if (NInoMstProtected(ni))
1113                 vi->i_mapping->a_ops = &ntfs_mst_aops;
1114         else
1115                 vi->i_mapping->a_ops = &ntfs_aops;
1116         /*
1117          * The number of 512-byte blocks used on disk (for stat). This is in so
1118          * far inaccurate as it doesn't account for any named streams or other
1119          * special non-resident attributes, but that is how Windows works, too,
1120          * so we are at least consistent with Windows, if not entirely
1121          * consistent with the Linux Way. Doing it the Linux Way would cause a
1122          * significant slowdown as it would involve iterating over all
1123          * attributes in the mft record and adding the allocated/compressed
1124          * sizes of all non-resident attributes present to give us the Linux
1125          * correct size that should go into i_blocks (after division by 512).
1126          */
1127         if (S_ISREG(vi->i_mode) && (NInoCompressed(ni) || NInoSparse(ni)))
1128                 vi->i_blocks = ni->itype.compressed.size >> 9;
1129         else
1130                 vi->i_blocks = ni->allocated_size >> 9;
1131         ntfs_debug("Done.");
1132         return 0;
1133
1134 unm_err_out:
1135         if (!err)
1136                 err = -EIO;
1137         if (ctx)
1138                 ntfs_attr_put_search_ctx(ctx);
1139         if (m)
1140                 unmap_mft_record(ni);
1141 err_out:
1142         ntfs_error(vol->sb, "Failed with error code %i.  Marking corrupt "
1143                         "inode 0x%lx as bad.  Run chkdsk.", err, vi->i_ino);
1144         make_bad_inode(vi);
1145         if (err != -EOPNOTSUPP && err != -ENOMEM)
1146                 NVolSetErrors(vol);
1147         return err;
1148 }
1149
1150 /**
1151  * ntfs_read_locked_attr_inode - read an attribute inode from its base inode
1152  * @base_vi:    base inode
1153  * @vi:         attribute inode to read
1154  *
1155  * ntfs_read_locked_attr_inode() is called from ntfs_attr_iget() to read the
1156  * attribute inode described by @vi into memory from the base mft record
1157  * described by @base_ni.
1158  *
1159  * ntfs_read_locked_attr_inode() maps, pins and locks the base inode for
1160  * reading and looks up the attribute described by @vi before setting up the
1161  * necessary fields in @vi as well as initializing the ntfs inode.
1162  *
1163  * Q: What locks are held when the function is called?
1164  * A: i_state has I_LOCK set, hence the inode is locked, also
1165  *    i_count is set to 1, so it is not going to go away
1166  *
1167  * Return 0 on success and -errno on error.  In the error case, the inode will
1168  * have had make_bad_inode() executed on it.
1169  */
1170 static int ntfs_read_locked_attr_inode(struct inode *base_vi, struct inode *vi)
1171 {
1172         ntfs_volume *vol = NTFS_SB(vi->i_sb);
1173         ntfs_inode *ni, *base_ni;
1174         MFT_RECORD *m;
1175         ATTR_RECORD *a;
1176         ntfs_attr_search_ctx *ctx;
1177         int err = 0;
1178
1179         ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
1180
1181         ntfs_init_big_inode(vi);
1182
1183         ni      = NTFS_I(vi);
1184         base_ni = NTFS_I(base_vi);
1185
1186         /* Just mirror the values from the base inode. */
1187         vi->i_blksize   = base_vi->i_blksize;
1188         vi->i_version   = base_vi->i_version;
1189         vi->i_uid       = base_vi->i_uid;
1190         vi->i_gid       = base_vi->i_gid;
1191         vi->i_nlink     = base_vi->i_nlink;
1192         vi->i_mtime     = base_vi->i_mtime;
1193         vi->i_ctime     = base_vi->i_ctime;
1194         vi->i_atime     = base_vi->i_atime;
1195         vi->i_generation = ni->seq_no = base_ni->seq_no;
1196
1197         /* Set inode type to zero but preserve permissions. */
1198         vi->i_mode      = base_vi->i_mode & ~S_IFMT;
1199
1200         m = map_mft_record(base_ni);
1201         if (IS_ERR(m)) {
1202                 err = PTR_ERR(m);
1203                 goto err_out;
1204         }
1205         ctx = ntfs_attr_get_search_ctx(base_ni, m);
1206         if (!ctx) {
1207                 err = -ENOMEM;
1208                 goto unm_err_out;
1209         }
1210         /* Find the attribute. */
1211         err = ntfs_attr_lookup(ni->type, ni->name, ni->name_len,
1212                         CASE_SENSITIVE, 0, NULL, 0, ctx);
1213         if (unlikely(err))
1214                 goto unm_err_out;
1215         a = ctx->attr;
1216         if (!a->non_resident) {
1217                 /* Ensure the attribute name is placed before the value. */
1218                 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1219                                 le16_to_cpu(a->data.resident.value_offset)))) {
1220                         ntfs_error(vol->sb, "Attribute name is placed after "
1221                                         "the attribute value.");
1222                         goto unm_err_out;
1223                 }
1224                 if (NInoMstProtected(ni) || a->flags) {
1225                         ntfs_error(vi->i_sb, "Found mst protected attribute "
1226                                         "or attribute with non-zero flags but "
1227                                         "the attribute is resident.  Please "
1228                                         "report you saw this message to "
1229                                         "linux-ntfs-dev@lists.sourceforge.net");
1230                         goto unm_err_out;
1231                 }
1232                 vi->i_size = ni->initialized_size = le32_to_cpu(
1233                                 a->data.resident.value_length);
1234                 ni->allocated_size = le32_to_cpu(a->length) -
1235                                 le16_to_cpu(a->data.resident.value_offset);
1236                 if (vi->i_size > ni->allocated_size) {
1237                         ntfs_error(vi->i_sb, "Resident attribute is corrupt "
1238                                         "(size exceeds allocation).");
1239                         goto unm_err_out;
1240                 }
1241         } else {
1242                 NInoSetNonResident(ni);
1243                 /*
1244                  * Ensure the attribute name is placed before the mapping pairs
1245                  * array.
1246                  */
1247                 if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1248                                 le16_to_cpu(
1249                                 a->data.non_resident.mapping_pairs_offset)))) {
1250                         ntfs_error(vol->sb, "Attribute name is placed after "
1251                                         "the mapping pairs array.");
1252                         goto unm_err_out;
1253                 }
1254                 if (a->flags & (ATTR_COMPRESSION_MASK | ATTR_IS_SPARSE)) {
1255                         if (a->flags & ATTR_COMPRESSION_MASK) {
1256                                 NInoSetCompressed(ni);
1257                                 if ((ni->type != AT_DATA) || (ni->type ==
1258                                                 AT_DATA && ni->name_len)) {
1259                                         ntfs_error(vi->i_sb, "Found compressed "
1260                                                         "non-data or named "
1261                                                         "data attribute.  "
1262                                                         "Please report you "
1263                                                         "saw this message to "
1264                                                         "linux-ntfs-dev@lists."
1265                                                         "sourceforge.net");
1266                                         goto unm_err_out;
1267                                 }
1268                                 if (vol->cluster_size > 4096) {
1269                                         ntfs_error(vi->i_sb, "Found compressed "
1270                                                         "attribute but "
1271                                                         "compression is "
1272                                                         "disabled due to "
1273                                                         "cluster size (%i) > "
1274                                                         "4kiB.",
1275                                                         vol->cluster_size);
1276                                         goto unm_err_out;
1277                                 }
1278                                 if ((a->flags & ATTR_COMPRESSION_MASK) !=
1279                                                 ATTR_IS_COMPRESSED) {
1280                                         ntfs_error(vi->i_sb, "Found unknown "
1281                                                         "compression method.");
1282                                         goto unm_err_out;
1283                                 }
1284                         }
1285                         if (NInoMstProtected(ni)) {
1286                                 ntfs_error(vi->i_sb, "Found mst protected "
1287                                                 "attribute but the attribute "
1288                                                 "is %s.  Please report you "
1289                                                 "saw this message to "
1290                                                 "linux-ntfs-dev@lists."
1291                                                 "sourceforge.net",
1292                                                 NInoCompressed(ni) ?
1293                                                 "compressed" : "sparse");
1294                                 goto unm_err_out;
1295                         }
1296                         if (a->flags & ATTR_IS_SPARSE)
1297                                 NInoSetSparse(ni);
1298                         if (a->data.non_resident.compression_unit != 4) {
1299                                 ntfs_error(vi->i_sb, "Found nonstandard "
1300                                                 "compression unit (%u instead "
1301                                                 "of 4).  Cannot handle this.",
1302                                                 a->data.non_resident.
1303                                                 compression_unit);
1304                                 err = -EOPNOTSUPP;
1305                                 goto unm_err_out;
1306                         }
1307                         ni->itype.compressed.block_clusters = 1U <<
1308                                         a->data.non_resident.compression_unit;
1309                         ni->itype.compressed.block_size = 1U << (
1310                                         a->data.non_resident.compression_unit +
1311                                         vol->cluster_size_bits);
1312                         ni->itype.compressed.block_size_bits = ffs(
1313                                         ni->itype.compressed.block_size) - 1;
1314                         ni->itype.compressed.size = sle64_to_cpu(
1315                                         a->data.non_resident.compressed_size);
1316                 }
1317                 if (a->flags & ATTR_IS_ENCRYPTED) {
1318                         if (a->flags & ATTR_COMPRESSION_MASK) {
1319                                 ntfs_error(vi->i_sb, "Found encrypted and "
1320                                                 "compressed data.");
1321                                 goto unm_err_out;
1322                         }
1323                         if (NInoMstProtected(ni)) {
1324                                 ntfs_error(vi->i_sb, "Found mst protected "
1325                                                 "attribute but the attribute "
1326                                                 "is encrypted.  Please report "
1327                                                 "you saw this message to "
1328                                                 "linux-ntfs-dev@lists."
1329                                                 "sourceforge.net");
1330                                 goto unm_err_out;
1331                         }
1332                         NInoSetEncrypted(ni);
1333                 }
1334                 if (a->data.non_resident.lowest_vcn) {
1335                         ntfs_error(vi->i_sb, "First extent of attribute has "
1336                                         "non-zero lowest_vcn.");
1337                         goto unm_err_out;
1338                 }
1339                 vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
1340                 ni->initialized_size = sle64_to_cpu(
1341                                 a->data.non_resident.initialized_size);
1342                 ni->allocated_size = sle64_to_cpu(
1343                                 a->data.non_resident.allocated_size);
1344         }
1345         /* Setup the operations for this attribute inode. */
1346         vi->i_op = NULL;
1347         vi->i_fop = NULL;
1348         if (NInoMstProtected(ni))
1349                 vi->i_mapping->a_ops = &ntfs_mst_aops;
1350         else
1351                 vi->i_mapping->a_ops = &ntfs_aops;
1352         if (NInoCompressed(ni) || NInoSparse(ni))
1353                 vi->i_blocks = ni->itype.compressed.size >> 9;
1354         else
1355                 vi->i_blocks = ni->allocated_size >> 9;
1356         /*
1357          * Make sure the base inode doesn't go away and attach it to the
1358          * attribute inode.
1359          */
1360         igrab(base_vi);
1361         ni->ext.base_ntfs_ino = base_ni;
1362         ni->nr_extents = -1;
1363
1364         ntfs_attr_put_search_ctx(ctx);
1365         unmap_mft_record(base_ni);
1366
1367         ntfs_debug("Done.");
1368         return 0;
1369
1370 unm_err_out:
1371         if (!err)
1372                 err = -EIO;
1373         if (ctx)
1374                 ntfs_attr_put_search_ctx(ctx);
1375         unmap_mft_record(base_ni);
1376 err_out:
1377         ntfs_error(vol->sb, "Failed with error code %i while reading attribute "
1378                         "inode (mft_no 0x%lx, type 0x%x, name_len %i).  "
1379                         "Marking corrupt inode and base inode 0x%lx as bad.  "
1380                         "Run chkdsk.", err, vi->i_ino, ni->type, ni->name_len,
1381                         base_vi->i_ino);
1382         make_bad_inode(vi);
1383         make_bad_inode(base_vi);
1384         if (err != -ENOMEM)
1385                 NVolSetErrors(vol);
1386         return err;
1387 }
1388
1389 /**
1390  * ntfs_read_locked_index_inode - read an index inode from its base inode
1391  * @base_vi:    base inode
1392  * @vi:         index inode to read
1393  *
1394  * ntfs_read_locked_index_inode() is called from ntfs_index_iget() to read the
1395  * index inode described by @vi into memory from the base mft record described
1396  * by @base_ni.
1397  *
1398  * ntfs_read_locked_index_inode() maps, pins and locks the base inode for
1399  * reading and looks up the attributes relating to the index described by @vi
1400  * before setting up the necessary fields in @vi as well as initializing the
1401  * ntfs inode.
1402  *
1403  * Note, index inodes are essentially attribute inodes (NInoAttr() is true)
1404  * with the attribute type set to AT_INDEX_ALLOCATION.  Apart from that, they
1405  * are setup like directory inodes since directories are a special case of
1406  * indices ao they need to be treated in much the same way.  Most importantly,
1407  * for small indices the index allocation attribute might not actually exist.
1408  * However, the index root attribute always exists but this does not need to
1409  * have an inode associated with it and this is why we define a new inode type
1410  * index.  Also, like for directories, we need to have an attribute inode for
1411  * the bitmap attribute corresponding to the index allocation attribute and we
1412  * can store this in the appropriate field of the inode, just like we do for
1413  * normal directory inodes.
1414  *
1415  * Q: What locks are held when the function is called?
1416  * A: i_state has I_LOCK set, hence the inode is locked, also
1417  *    i_count is set to 1, so it is not going to go away
1418  *
1419  * Return 0 on success and -errno on error.  In the error case, the inode will
1420  * have had make_bad_inode() executed on it.
1421  */
1422 static int ntfs_read_locked_index_inode(struct inode *base_vi, struct inode *vi)
1423 {
1424         loff_t bvi_size;
1425         ntfs_volume *vol = NTFS_SB(vi->i_sb);
1426         ntfs_inode *ni, *base_ni, *bni;
1427         struct inode *bvi;
1428         MFT_RECORD *m;
1429         ATTR_RECORD *a;
1430         ntfs_attr_search_ctx *ctx;
1431         INDEX_ROOT *ir;
1432         u8 *ir_end, *index_end;
1433         int err = 0;
1434
1435         ntfs_debug("Entering for i_ino 0x%lx.", vi->i_ino);
1436         ntfs_init_big_inode(vi);
1437         ni      = NTFS_I(vi);
1438         base_ni = NTFS_I(base_vi);
1439         /* Just mirror the values from the base inode. */
1440         vi->i_blksize   = base_vi->i_blksize;
1441         vi->i_version   = base_vi->i_version;
1442         vi->i_uid       = base_vi->i_uid;
1443         vi->i_gid       = base_vi->i_gid;
1444         vi->i_nlink     = base_vi->i_nlink;
1445         vi->i_mtime     = base_vi->i_mtime;
1446         vi->i_ctime     = base_vi->i_ctime;
1447         vi->i_atime     = base_vi->i_atime;
1448         vi->i_generation = ni->seq_no = base_ni->seq_no;
1449         /* Set inode type to zero but preserve permissions. */
1450         vi->i_mode      = base_vi->i_mode & ~S_IFMT;
1451         /* Map the mft record for the base inode. */
1452         m = map_mft_record(base_ni);
1453         if (IS_ERR(m)) {
1454                 err = PTR_ERR(m);
1455                 goto err_out;
1456         }
1457         ctx = ntfs_attr_get_search_ctx(base_ni, m);
1458         if (!ctx) {
1459                 err = -ENOMEM;
1460                 goto unm_err_out;
1461         }
1462         /* Find the index root attribute. */
1463         err = ntfs_attr_lookup(AT_INDEX_ROOT, ni->name, ni->name_len,
1464                         CASE_SENSITIVE, 0, NULL, 0, ctx);
1465         if (unlikely(err)) {
1466                 if (err == -ENOENT)
1467                         ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is "
1468                                         "missing.");
1469                 goto unm_err_out;
1470         }
1471         a = ctx->attr;
1472         /* Set up the state. */
1473         if (unlikely(a->non_resident)) {
1474                 ntfs_error(vol->sb, "$INDEX_ROOT attribute is not resident.");
1475                 goto unm_err_out;
1476         }
1477         /* Ensure the attribute name is placed before the value. */
1478         if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1479                         le16_to_cpu(a->data.resident.value_offset)))) {
1480                 ntfs_error(vol->sb, "$INDEX_ROOT attribute name is placed "
1481                                 "after the attribute value.");
1482                 goto unm_err_out;
1483         }
1484         /* Compressed/encrypted/sparse index root is not allowed. */
1485         if (a->flags & (ATTR_COMPRESSION_MASK | ATTR_IS_ENCRYPTED |
1486                         ATTR_IS_SPARSE)) {
1487                 ntfs_error(vi->i_sb, "Found compressed/encrypted/sparse index "
1488                                 "root attribute.");
1489                 goto unm_err_out;
1490         }
1491         ir = (INDEX_ROOT*)((u8*)a + le16_to_cpu(a->data.resident.value_offset));
1492         ir_end = (u8*)ir + le32_to_cpu(a->data.resident.value_length);
1493         if (ir_end > (u8*)ctx->mrec + vol->mft_record_size) {
1494                 ntfs_error(vi->i_sb, "$INDEX_ROOT attribute is corrupt.");
1495                 goto unm_err_out;
1496         }
1497         index_end = (u8*)&ir->index + le32_to_cpu(ir->index.index_length);
1498         if (index_end > ir_end) {
1499                 ntfs_error(vi->i_sb, "Index is corrupt.");
1500                 goto unm_err_out;
1501         }
1502         if (ir->type) {
1503                 ntfs_error(vi->i_sb, "Index type is not 0 (type is 0x%x).",
1504                                 le32_to_cpu(ir->type));
1505                 goto unm_err_out;
1506         }
1507         ni->itype.index.collation_rule = ir->collation_rule;
1508         ntfs_debug("Index collation rule is 0x%x.",
1509                         le32_to_cpu(ir->collation_rule));
1510         ni->itype.index.block_size = le32_to_cpu(ir->index_block_size);
1511         if (ni->itype.index.block_size & (ni->itype.index.block_size - 1)) {
1512                 ntfs_error(vi->i_sb, "Index block size (%u) is not a power of "
1513                                 "two.", ni->itype.index.block_size);
1514                 goto unm_err_out;
1515         }
1516         if (ni->itype.index.block_size > PAGE_CACHE_SIZE) {
1517                 ntfs_error(vi->i_sb, "Index block size (%u) > PAGE_CACHE_SIZE "
1518                                 "(%ld) is not supported.  Sorry.",
1519                                 ni->itype.index.block_size, PAGE_CACHE_SIZE);
1520                 err = -EOPNOTSUPP;
1521                 goto unm_err_out;
1522         }
1523         if (ni->itype.index.block_size < NTFS_BLOCK_SIZE) {
1524                 ntfs_error(vi->i_sb, "Index block size (%u) < NTFS_BLOCK_SIZE "
1525                                 "(%i) is not supported.  Sorry.",
1526                                 ni->itype.index.block_size, NTFS_BLOCK_SIZE);
1527                 err = -EOPNOTSUPP;
1528                 goto unm_err_out;
1529         }
1530         ni->itype.index.block_size_bits = ffs(ni->itype.index.block_size) - 1;
1531         /* Determine the size of a vcn in the index. */
1532         if (vol->cluster_size <= ni->itype.index.block_size) {
1533                 ni->itype.index.vcn_size = vol->cluster_size;
1534                 ni->itype.index.vcn_size_bits = vol->cluster_size_bits;
1535         } else {
1536                 ni->itype.index.vcn_size = vol->sector_size;
1537                 ni->itype.index.vcn_size_bits = vol->sector_size_bits;
1538         }
1539         /* Check for presence of index allocation attribute. */
1540         if (!(ir->index.flags & LARGE_INDEX)) {
1541                 /* No index allocation. */
1542                 vi->i_size = ni->initialized_size = ni->allocated_size = 0;
1543                 /* We are done with the mft record, so we release it. */
1544                 ntfs_attr_put_search_ctx(ctx);
1545                 unmap_mft_record(base_ni);
1546                 m = NULL;
1547                 ctx = NULL;
1548                 goto skip_large_index_stuff;
1549         } /* LARGE_INDEX:  Index allocation present.  Setup state. */
1550         NInoSetIndexAllocPresent(ni);
1551         /* Find index allocation attribute. */
1552         ntfs_attr_reinit_search_ctx(ctx);
1553         err = ntfs_attr_lookup(AT_INDEX_ALLOCATION, ni->name, ni->name_len,
1554                         CASE_SENSITIVE, 0, NULL, 0, ctx);
1555         if (unlikely(err)) {
1556                 if (err == -ENOENT)
1557                         ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1558                                         "not present but $INDEX_ROOT "
1559                                         "indicated it is.");
1560                 else
1561                         ntfs_error(vi->i_sb, "Failed to lookup "
1562                                         "$INDEX_ALLOCATION attribute.");
1563                 goto unm_err_out;
1564         }
1565         if (!a->non_resident) {
1566                 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1567                                 "resident.");
1568                 goto unm_err_out;
1569         }
1570         /*
1571          * Ensure the attribute name is placed before the mapping pairs array.
1572          */
1573         if (unlikely(a->name_length && (le16_to_cpu(a->name_offset) >=
1574                         le16_to_cpu(
1575                         a->data.non_resident.mapping_pairs_offset)))) {
1576                 ntfs_error(vol->sb, "$INDEX_ALLOCATION attribute name is "
1577                                 "placed after the mapping pairs array.");
1578                 goto unm_err_out;
1579         }
1580         if (a->flags & ATTR_IS_ENCRYPTED) {
1581                 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1582                                 "encrypted.");
1583                 goto unm_err_out;
1584         }
1585         if (a->flags & ATTR_IS_SPARSE) {
1586                 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is sparse.");
1587                 goto unm_err_out;
1588         }
1589         if (a->flags & ATTR_COMPRESSION_MASK) {
1590                 ntfs_error(vi->i_sb, "$INDEX_ALLOCATION attribute is "
1591                                 "compressed.");
1592                 goto unm_err_out;
1593         }
1594         if (a->data.non_resident.lowest_vcn) {
1595                 ntfs_error(vi->i_sb, "First extent of $INDEX_ALLOCATION "
1596                                 "attribute has non zero lowest_vcn.");
1597                 goto unm_err_out;
1598         }
1599         vi->i_size = sle64_to_cpu(a->data.non_resident.data_size);
1600         ni->initialized_size = sle64_to_cpu(
1601                         a->data.non_resident.initialized_size);
1602         ni->allocated_size = sle64_to_cpu(a->data.non_resident.allocated_size);
1603         /*
1604          * We are done with the mft record, so we release it.  Otherwise
1605          * we would deadlock in ntfs_attr_iget().
1606          */
1607         ntfs_attr_put_search_ctx(ctx);
1608         unmap_mft_record(base_ni);
1609         m = NULL;
1610         ctx = NULL;
1611         /* Get the index bitmap attribute inode. */
1612         bvi = ntfs_attr_iget(base_vi, AT_BITMAP, ni->name, ni->name_len);
1613         if (IS_ERR(bvi)) {
1614                 ntfs_error(vi->i_sb, "Failed to get bitmap attribute.");
1615                 err = PTR_ERR(bvi);
1616                 goto unm_err_out;
1617         }
1618         bni = NTFS_I(bvi);
1619         if (NInoCompressed(bni) || NInoEncrypted(bni) ||
1620                         NInoSparse(bni)) {
1621                 ntfs_error(vi->i_sb, "$BITMAP attribute is compressed and/or "
1622                                 "encrypted and/or sparse.");
1623                 goto iput_unm_err_out;
1624         }
1625         /* Consistency check bitmap size vs. index allocation size. */
1626         bvi_size = i_size_read(bvi);
1627         if ((bvi_size << 3) < (vi->i_size >> ni->itype.index.block_size_bits)) {
1628                 ntfs_error(vi->i_sb, "Index bitmap too small (0x%llx) for "
1629                                 "index allocation (0x%llx).", bvi_size << 3,
1630                                 vi->i_size);
1631                 goto iput_unm_err_out;
1632         }
1633         ni->itype.index.bmp_ino = bvi;
1634 skip_large_index_stuff:
1635         /* Setup the operations for this index inode. */
1636         vi->i_op = NULL;
1637         vi->i_fop = NULL;
1638         vi->i_mapping->a_ops = &ntfs_mst_aops;
1639         vi->i_blocks = ni->allocated_size >> 9;
1640         /*
1641          * Make sure the base inode doesn't go away and attach it to the
1642          * index inode.
1643          */
1644         igrab(base_vi);
1645         ni->ext.base_ntfs_ino = base_ni;
1646         ni->nr_extents = -1;
1647
1648         ntfs_debug("Done.");
1649         return 0;
1650
1651 iput_unm_err_out:
1652         iput(bvi);
1653 unm_err_out:
1654         if (!err)
1655                 err = -EIO;
1656         if (ctx)
1657                 ntfs_attr_put_search_ctx(ctx);
1658         if (m)
1659                 unmap_mft_record(base_ni);
1660 err_out:
1661         ntfs_error(vi->i_sb, "Failed with error code %i while reading index "
1662                         "inode (mft_no 0x%lx, name_len %i.", err, vi->i_ino,
1663                         ni->name_len);
1664         make_bad_inode(vi);
1665         if (err != -EOPNOTSUPP && err != -ENOMEM)
1666                 NVolSetErrors(vol);
1667         return err;
1668 }
1669
1670 /**
1671  * ntfs_read_inode_mount - special read_inode for mount time use only
1672  * @vi:         inode to read
1673  *
1674  * Read inode FILE_MFT at mount time, only called with super_block lock
1675  * held from within the read_super() code path.
1676  *
1677  * This function exists because when it is called the page cache for $MFT/$DATA
1678  * is not initialized and hence we cannot get at the contents of mft records
1679  * by calling map_mft_record*().
1680  *
1681  * Further it needs to cope with the circular references problem, i.e. cannot
1682  * load any attributes other than $ATTRIBUTE_LIST until $DATA is loaded, because
1683  * we do not know where the other extent mft records are yet and again, because
1684  * we cannot call map_mft_record*() yet.  Obviously this applies only when an
1685  * attribute list is actually present in $MFT inode.
1686  *
1687  * We solve these problems by starting with the $DATA attribute before anything
1688  * else and iterating using ntfs_attr_lookup($DATA) over all extents.  As each
1689  * extent is found, we ntfs_mapping_pairs_decompress() including the implied
1690  * ntfs_runlists_merge().  Each step of the iteration necessarily provides
1691  * sufficient information for the next step to complete.
1692  *
1693  * This should work but there are two possible pit falls (see inline comments
1694  * below), but only time will tell if they are real pits or just smoke...
1695  */
1696 int ntfs_read_inode_mount(struct inode *vi)
1697 {
1698         VCN next_vcn, last_vcn, highest_vcn;
1699         s64 block;
1700         struct super_block *sb = vi->i_sb;
1701         ntfs_volume *vol = NTFS_SB(sb);
1702         struct buffer_head *bh;
1703         ntfs_inode *ni;
1704         MFT_RECORD *m = NULL;
1705         ATTR_RECORD *a;
1706         ntfs_attr_search_ctx *ctx;
1707         unsigned int i, nr_blocks;
1708         int err;
1709
1710         ntfs_debug("Entering.");
1711
1712         /* Initialize the ntfs specific part of @vi. */
1713         ntfs_init_big_inode(vi);
1714
1715         ni = NTFS_I(vi);
1716
1717         /* Setup the data attribute. It is special as it is mst protected. */
1718         NInoSetNonResident(ni);
1719         NInoSetMstProtected(ni);
1720         NInoSetSparseDisabled(ni);
1721         ni->type = AT_DATA;
1722         ni->name = NULL;
1723         ni->name_len = 0;
1724         /*
1725          * This sets up our little cheat allowing us to reuse the async read io
1726          * completion handler for directories.
1727          */
1728         ni->itype.index.block_size = vol->mft_record_size;
1729         ni->itype.index.block_size_bits = vol->mft_record_size_bits;
1730
1731         /* Very important! Needed to be able to call map_mft_record*(). */
1732         vol->mft_ino = vi;
1733
1734         /* Allocate enough memory to read the first mft record. */
1735         if (vol->mft_record_size > 64 * 1024) {
1736                 ntfs_error(sb, "Unsupported mft record size %i (max 64kiB).",
1737                                 vol->mft_record_size);
1738                 goto err_out;
1739         }
1740         i = vol->mft_record_size;
1741         if (i < sb->s_blocksize)
1742                 i = sb->s_blocksize;
1743         m = (MFT_RECORD*)ntfs_malloc_nofs(i);
1744         if (!m) {
1745                 ntfs_error(sb, "Failed to allocate buffer for $MFT record 0.");
1746                 goto err_out;
1747         }
1748
1749         /* Determine the first block of the $MFT/$DATA attribute. */
1750         block = vol->mft_lcn << vol->cluster_size_bits >>
1751                         sb->s_blocksize_bits;
1752         nr_blocks = vol->mft_record_size >> sb->s_blocksize_bits;
1753         if (!nr_blocks)
1754                 nr_blocks = 1;
1755
1756         /* Load $MFT/$DATA's first mft record. */
1757         for (i = 0; i < nr_blocks; i++) {
1758                 bh = sb_bread(sb, block++);
1759                 if (!bh) {
1760                         ntfs_error(sb, "Device read failed.");
1761                         goto err_out;
1762                 }
1763                 memcpy((char*)m + (i << sb->s_blocksize_bits), bh->b_data,
1764                                 sb->s_blocksize);
1765                 brelse(bh);
1766         }
1767
1768         /* Apply the mst fixups. */
1769         if (post_read_mst_fixup((NTFS_RECORD*)m, vol->mft_record_size)) {
1770                 /* FIXME: Try to use the $MFTMirr now. */
1771                 ntfs_error(sb, "MST fixup failed. $MFT is corrupt.");
1772                 goto err_out;
1773         }
1774
1775         /* Need this to sanity check attribute list references to $MFT. */
1776         vi->i_generation = ni->seq_no = le16_to_cpu(m->sequence_number);
1777
1778         /* Provides readpage() and sync_page() for map_mft_record(). */
1779         vi->i_mapping->a_ops = &ntfs_mst_aops;
1780
1781         ctx = ntfs_attr_get_search_ctx(ni, m);
1782         if (!ctx) {
1783                 err = -ENOMEM;
1784                 goto err_out;
1785         }
1786
1787         /* Find the attribute list attribute if present. */
1788         err = ntfs_attr_lookup(AT_ATTRIBUTE_LIST, NULL, 0, 0, 0, NULL, 0, ctx);
1789         if (err) {
1790                 if (unlikely(err != -ENOENT)) {
1791                         ntfs_error(sb, "Failed to lookup attribute list "
1792                                         "attribute. You should run chkdsk.");
1793                         goto put_err_out;
1794                 }
1795         } else /* if (!err) */ {
1796                 ATTR_LIST_ENTRY *al_entry, *next_al_entry;
1797                 u8 *al_end;
1798
1799                 ntfs_debug("Attribute list attribute found in $MFT.");
1800                 NInoSetAttrList(ni);
1801                 a = ctx->attr;
1802                 if (a->flags & ATTR_IS_ENCRYPTED ||
1803                                 a->flags & ATTR_COMPRESSION_MASK ||
1804                                 a->flags & ATTR_IS_SPARSE) {
1805                         ntfs_error(sb, "Attribute list attribute is "
1806                                         "compressed/encrypted/sparse. Not "
1807                                         "allowed. $MFT is corrupt. You should "
1808                                         "run chkdsk.");
1809                         goto put_err_out;
1810                 }
1811                 /* Now allocate memory for the attribute list. */
1812                 ni->attr_list_size = (u32)ntfs_attr_size(a);
1813                 ni->attr_list = ntfs_malloc_nofs(ni->attr_list_size);
1814                 if (!ni->attr_list) {
1815                         ntfs_error(sb, "Not enough memory to allocate buffer "
1816                                         "for attribute list.");
1817                         goto put_err_out;
1818                 }
1819                 if (a->non_resident) {
1820                         NInoSetAttrListNonResident(ni);
1821                         if (a->data.non_resident.lowest_vcn) {
1822                                 ntfs_error(sb, "Attribute list has non zero "
1823                                                 "lowest_vcn. $MFT is corrupt. "
1824                                                 "You should run chkdsk.");
1825                                 goto put_err_out;
1826                         }
1827                         /* Setup the runlist. */
1828                         ni->attr_list_rl.rl = ntfs_mapping_pairs_decompress(vol,
1829                                         a, NULL);
1830                         if (IS_ERR(ni->attr_list_rl.rl)) {
1831                                 err = PTR_ERR(ni->attr_list_rl.rl);
1832                                 ni->attr_list_rl.rl = NULL;
1833                                 ntfs_error(sb, "Mapping pairs decompression "
1834                                                 "failed with error code %i.",
1835                                                 -err);
1836                                 goto put_err_out;
1837                         }
1838                         /* Now load the attribute list. */
1839                         if ((err = load_attribute_list(vol, &ni->attr_list_rl,
1840                                         ni->attr_list, ni->attr_list_size,
1841                                         sle64_to_cpu(a->data.
1842                                         non_resident.initialized_size)))) {
1843                                 ntfs_error(sb, "Failed to load attribute list "
1844                                                 "attribute with error code %i.",
1845                                                 -err);
1846                                 goto put_err_out;
1847                         }
1848                 } else /* if (!ctx.attr->non_resident) */ {
1849                         if ((u8*)a + le16_to_cpu(
1850                                         a->data.resident.value_offset) +
1851                                         le32_to_cpu(
1852                                         a->data.resident.value_length) >
1853                                         (u8*)ctx->mrec + vol->mft_record_size) {
1854                                 ntfs_error(sb, "Corrupt attribute list "
1855                                                 "attribute.");
1856                                 goto put_err_out;
1857                         }
1858                         /* Now copy the attribute list. */
1859                         memcpy(ni->attr_list, (u8*)a + le16_to_cpu(
1860                                         a->data.resident.value_offset),
1861                                         le32_to_cpu(
1862                                         a->data.resident.value_length));
1863                 }
1864                 /* The attribute list is now setup in memory. */
1865                 /*
1866                  * FIXME: I don't know if this case is actually possible.
1867                  * According to logic it is not possible but I have seen too
1868                  * many weird things in MS software to rely on logic... Thus we
1869                  * perform a manual search and make sure the first $MFT/$DATA
1870                  * extent is in the base inode. If it is not we abort with an
1871                  * error and if we ever see a report of this error we will need
1872                  * to do some magic in order to have the necessary mft record
1873                  * loaded and in the right place in the page cache. But
1874                  * hopefully logic will prevail and this never happens...
1875                  */
1876                 al_entry = (ATTR_LIST_ENTRY*)ni->attr_list;
1877                 al_end = (u8*)al_entry + ni->attr_list_size;
1878                 for (;; al_entry = next_al_entry) {
1879                         /* Out of bounds check. */
1880                         if ((u8*)al_entry < ni->attr_list ||
1881                                         (u8*)al_entry > al_end)
1882                                 goto em_put_err_out;
1883                         /* Catch the end of the attribute list. */
1884                         if ((u8*)al_entry == al_end)
1885                                 goto em_put_err_out;
1886                         if (!al_entry->length)
1887                                 goto em_put_err_out;
1888                         if ((u8*)al_entry + 6 > al_end || (u8*)al_entry +
1889                                         le16_to_cpu(al_entry->length) > al_end)
1890                                 goto em_put_err_out;
1891                         next_al_entry = (ATTR_LIST_ENTRY*)((u8*)al_entry +
1892                                         le16_to_cpu(al_entry->length));
1893                         if (le32_to_cpu(al_entry->type) >
1894                                         const_le32_to_cpu(AT_DATA))
1895                                 goto em_put_err_out;
1896                         if (AT_DATA != al_entry->type)
1897                                 continue;
1898                         /* We want an unnamed attribute. */
1899                         if (al_entry->name_length)
1900                                 goto em_put_err_out;
1901                         /* Want the first entry, i.e. lowest_vcn == 0. */
1902                         if (al_entry->lowest_vcn)
1903                                 goto em_put_err_out;
1904                         /* First entry has to be in the base mft record. */
1905                         if (MREF_LE(al_entry->mft_reference) != vi->i_ino) {
1906                                 /* MFT references do not match, logic fails. */
1907                                 ntfs_error(sb, "BUG: The first $DATA extent "
1908                                                 "of $MFT is not in the base "
1909                                                 "mft record. Please report "
1910                                                 "you saw this message to "
1911                                                 "linux-ntfs-dev@lists."
1912                                                 "sourceforge.net");
1913                                 goto put_err_out;
1914                         } else {
1915                                 /* Sequence numbers must match. */
1916                                 if (MSEQNO_LE(al_entry->mft_reference) !=
1917                                                 ni->seq_no)
1918                                         goto em_put_err_out;
1919                                 /* Got it. All is ok. We can stop now. */
1920                                 break;
1921                         }
1922                 }
1923         }
1924
1925         ntfs_attr_reinit_search_ctx(ctx);
1926
1927         /* Now load all attribute extents. */
1928         a = NULL;
1929         next_vcn = last_vcn = highest_vcn = 0;
1930         while (!(err = ntfs_attr_lookup(AT_DATA, NULL, 0, 0, next_vcn, NULL, 0,
1931                         ctx))) {
1932                 runlist_element *nrl;
1933
1934                 /* Cache the current attribute. */
1935                 a = ctx->attr;
1936                 /* $MFT must be non-resident. */
1937                 if (!a->non_resident) {
1938                         ntfs_error(sb, "$MFT must be non-resident but a "
1939                                         "resident extent was found. $MFT is "
1940                                         "corrupt. Run chkdsk.");
1941                         goto put_err_out;
1942                 }
1943                 /* $MFT must be uncompressed and unencrypted. */
1944                 if (a->flags & ATTR_COMPRESSION_MASK ||
1945                                 a->flags & ATTR_IS_ENCRYPTED ||
1946                                 a->flags & ATTR_IS_SPARSE) {
1947                         ntfs_error(sb, "$MFT must be uncompressed, "
1948                                         "non-sparse, and unencrypted but a "
1949                                         "compressed/sparse/encrypted extent "
1950                                         "was found. $MFT is corrupt. Run "
1951                                         "chkdsk.");
1952                         goto put_err_out;
1953                 }
1954                 /*
1955                  * Decompress the mapping pairs array of this extent and merge
1956                  * the result into the existing runlist. No need for locking
1957                  * as we have exclusive access to the inode at this time and we
1958                  * are a mount in progress task, too.
1959                  */
1960                 nrl = ntfs_mapping_pairs_decompress(vol, a, ni->runlist.rl);
1961                 if (IS_ERR(nrl)) {
1962                         ntfs_error(sb, "ntfs_mapping_pairs_decompress() "
1963                                         "failed with error code %ld.  $MFT is "
1964                                         "corrupt.", PTR_ERR(nrl));
1965                         goto put_err_out;
1966                 }
1967                 ni->runlist.rl = nrl;
1968
1969                 /* Are we in the first extent? */
1970                 if (!next_vcn) {
1971                         if (a->data.non_resident.lowest_vcn) {
1972                                 ntfs_error(sb, "First extent of $DATA "
1973                                                 "attribute has non zero "
1974                                                 "lowest_vcn. $MFT is corrupt. "
1975                                                 "You should run chkdsk.");
1976                                 goto put_err_out;
1977                         }
1978                         /* Get the last vcn in the $DATA attribute. */
1979                         last_vcn = sle64_to_cpu(
1980                                         a->data.non_resident.allocated_size)
1981                                         >> vol->cluster_size_bits;
1982                         /* Fill in the inode size. */
1983                         vi->i_size = sle64_to_cpu(
1984                                         a->data.non_resident.data_size);
1985                         ni->initialized_size = sle64_to_cpu(
1986                                         a->data.non_resident.initialized_size);
1987                         ni->allocated_size = sle64_to_cpu(
1988                                         a->data.non_resident.allocated_size);
1989                         /*
1990                          * Verify the number of mft records does not exceed
1991                          * 2^32 - 1.
1992                          */
1993                         if ((vi->i_size >> vol->mft_record_size_bits) >=
1994                                         (1ULL << 32)) {
1995                                 ntfs_error(sb, "$MFT is too big! Aborting.");
1996                                 goto put_err_out;
1997                         }
1998                         /*
1999                          * We have got the first extent of the runlist for
2000                          * $MFT which means it is now relatively safe to call
2001                          * the normal ntfs_read_inode() function.
2002                          * Complete reading the inode, this will actually
2003                          * re-read the mft record for $MFT, this time entering
2004                          * it into the page cache with which we complete the
2005                          * kick start of the volume. It should be safe to do
2006                          * this now as the first extent of $MFT/$DATA is
2007                          * already known and we would hope that we don't need
2008                          * further extents in order to find the other
2009                          * attributes belonging to $MFT. Only time will tell if
2010                          * this is really the case. If not we will have to play
2011                          * magic at this point, possibly duplicating a lot of
2012                          * ntfs_read_inode() at this point. We will need to
2013                          * ensure we do enough of its work to be able to call
2014                          * ntfs_read_inode() on extents of $MFT/$DATA. But lets
2015                          * hope this never happens...
2016                          */
2017                         ntfs_read_locked_inode(vi);
2018                         if (is_bad_inode(vi)) {
2019                                 ntfs_error(sb, "ntfs_read_inode() of $MFT "
2020                                                 "failed. BUG or corrupt $MFT. "
2021                                                 "Run chkdsk and if no errors "
2022                                                 "are found, please report you "
2023                                                 "saw this message to "
2024                                                 "linux-ntfs-dev@lists."
2025                                                 "sourceforge.net");
2026                                 ntfs_attr_put_search_ctx(ctx);
2027                                 /* Revert to the safe super operations. */
2028                                 ntfs_free(m);
2029                                 return -1;
2030                         }
2031                         /*
2032                          * Re-initialize some specifics about $MFT's inode as
2033                          * ntfs_read_inode() will have set up the default ones.
2034                          */
2035                         /* Set uid and gid to root. */
2036                         vi->i_uid = vi->i_gid = 0;
2037                         /* Regular file. No access for anyone. */
2038                         vi->i_mode = S_IFREG;
2039                         /* No VFS initiated operations allowed for $MFT. */
2040                         vi->i_op = &ntfs_empty_inode_ops;
2041                         vi->i_fop = &ntfs_empty_file_ops;
2042                 }
2043
2044                 /* Get the lowest vcn for the next extent. */
2045                 highest_vcn = sle64_to_cpu(a->data.non_resident.highest_vcn);
2046                 next_vcn = highest_vcn + 1;
2047
2048                 /* Only one extent or error, which we catch below. */
2049                 if (next_vcn <= 0)
2050                         break;
2051
2052                 /* Avoid endless loops due to corruption. */
2053                 if (next_vcn < sle64_to_cpu(
2054                                 a->data.non_resident.lowest_vcn)) {
2055                         ntfs_error(sb, "$MFT has corrupt attribute list "
2056                                         "attribute. Run chkdsk.");
2057                         goto put_err_out;
2058                 }
2059         }
2060         if (err != -ENOENT) {
2061                 ntfs_error(sb, "Failed to lookup $MFT/$DATA attribute extent. "
2062                                 "$MFT is corrupt. Run chkdsk.");
2063                 goto put_err_out;
2064         }
2065         if (!a) {
2066                 ntfs_error(sb, "$MFT/$DATA attribute not found. $MFT is "
2067                                 "corrupt. Run chkdsk.");
2068                 goto put_err_out;
2069         }
2070         if (highest_vcn && highest_vcn != last_vcn - 1) {
2071                 ntfs_error(sb, "Failed to load the complete runlist for "
2072                                 "$MFT/$DATA. Driver bug or corrupt $MFT. "
2073                                 "Run chkdsk.");
2074                 ntfs_debug("highest_vcn = 0x%llx, last_vcn - 1 = 0x%llx",
2075                                 (unsigned long long)highest_vcn,
2076                                 (unsigned long long)last_vcn - 1);
2077                 goto put_err_out;
2078         }
2079         ntfs_attr_put_search_ctx(ctx);
2080         ntfs_debug("Done.");
2081         ntfs_free(m);
2082         return 0;
2083
2084 em_put_err_out:
2085         ntfs_error(sb, "Couldn't find first extent of $DATA attribute in "
2086                         "attribute list. $MFT is corrupt. Run chkdsk.");
2087 put_err_out:
2088         ntfs_attr_put_search_ctx(ctx);
2089 err_out:
2090         ntfs_error(sb, "Failed. Marking inode as bad.");
2091         make_bad_inode(vi);
2092         ntfs_free(m);
2093         return -1;
2094 }
2095
2096 /**
2097  * ntfs_put_inode - handler for when the inode reference count is decremented
2098  * @vi:         vfs inode
2099  *
2100  * The VFS calls ntfs_put_inode() every time the inode reference count (i_count)
2101  * is about to be decremented (but before the decrement itself.
2102  *
2103  * If the inode @vi is a directory with two references, one of which is being
2104  * dropped, we need to put the attribute inode for the directory index bitmap,
2105  * if it is present, otherwise the directory inode would remain pinned for
2106  * ever.
2107  */
2108 void ntfs_put_inode(struct inode *vi)
2109 {
2110         if (S_ISDIR(vi->i_mode) && atomic_read(&vi->i_count) == 2) {
2111                 ntfs_inode *ni = NTFS_I(vi);
2112                 if (NInoIndexAllocPresent(ni)) {
2113                         struct inode *bvi = NULL;
2114                         down(&vi->i_sem);
2115                         if (atomic_read(&vi->i_count) == 2) {
2116                                 bvi = ni->itype.index.bmp_ino;
2117                                 if (bvi)
2118                                         ni->itype.index.bmp_ino = NULL;
2119                         }
2120                         up(&vi->i_sem);
2121                         if (bvi)
2122                                 iput(bvi);
2123                 }
2124         }
2125 }
2126
2127 static void __ntfs_clear_inode(ntfs_inode *ni)
2128 {
2129         /* Free all alocated memory. */
2130         down_write(&ni->runlist.lock);
2131         if (ni->runlist.rl) {
2132                 ntfs_free(ni->runlist.rl);
2133                 ni->runlist.rl = NULL;
2134         }
2135         up_write(&ni->runlist.lock);
2136
2137         if (ni->attr_list) {
2138                 ntfs_free(ni->attr_list);
2139                 ni->attr_list = NULL;
2140         }
2141
2142         down_write(&ni->attr_list_rl.lock);
2143         if (ni->attr_list_rl.rl) {
2144                 ntfs_free(ni->attr_list_rl.rl);
2145                 ni->attr_list_rl.rl = NULL;
2146         }
2147         up_write(&ni->attr_list_rl.lock);
2148
2149         if (ni->name_len && ni->name != I30) {
2150                 /* Catch bugs... */
2151                 BUG_ON(!ni->name);
2152                 kfree(ni->name);
2153         }
2154 }
2155
2156 void ntfs_clear_extent_inode(ntfs_inode *ni)
2157 {
2158         ntfs_debug("Entering for inode 0x%lx.", ni->mft_no);
2159
2160         BUG_ON(NInoAttr(ni));
2161         BUG_ON(ni->nr_extents != -1);
2162
2163 #ifdef NTFS_RW
2164         if (NInoDirty(ni)) {
2165                 if (!is_bad_inode(VFS_I(ni->ext.base_ntfs_ino)))
2166                         ntfs_error(ni->vol->sb, "Clearing dirty extent inode!  "
2167                                         "Losing data!  This is a BUG!!!");
2168                 // FIXME:  Do something!!!
2169         }
2170 #endif /* NTFS_RW */
2171
2172         __ntfs_clear_inode(ni);
2173
2174         /* Bye, bye... */
2175         ntfs_destroy_extent_inode(ni);
2176 }
2177
2178 /**
2179  * ntfs_clear_big_inode - clean up the ntfs specific part of an inode
2180  * @vi:         vfs inode pending annihilation
2181  *
2182  * When the VFS is going to remove an inode from memory, ntfs_clear_big_inode()
2183  * is called, which deallocates all memory belonging to the NTFS specific part
2184  * of the inode and returns.
2185  *
2186  * If the MFT record is dirty, we commit it before doing anything else.
2187  */
2188 void ntfs_clear_big_inode(struct inode *vi)
2189 {
2190         ntfs_inode *ni = NTFS_I(vi);
2191
2192         /*
2193          * If the inode @vi is an index inode we need to put the attribute
2194          * inode for the index bitmap, if it is present, otherwise the index
2195          * inode would disappear and the attribute inode for the index bitmap
2196          * would no longer be referenced from anywhere and thus it would remain
2197          * pinned for ever.
2198          */
2199         if (NInoAttr(ni) && (ni->type == AT_INDEX_ALLOCATION) &&
2200                         NInoIndexAllocPresent(ni) && ni->itype.index.bmp_ino) {
2201                 iput(ni->itype.index.bmp_ino);
2202                 ni->itype.index.bmp_ino = NULL;
2203         }
2204 #ifdef NTFS_RW
2205         if (NInoDirty(ni)) {
2206                 BOOL was_bad = (is_bad_inode(vi));
2207
2208                 /* Committing the inode also commits all extent inodes. */
2209                 ntfs_commit_inode(vi);
2210
2211                 if (!was_bad && (is_bad_inode(vi) || NInoDirty(ni))) {
2212                         ntfs_error(vi->i_sb, "Failed to commit dirty inode "
2213                                         "0x%lx.  Losing data!", vi->i_ino);
2214                         // FIXME:  Do something!!!
2215                 }
2216         }
2217 #endif /* NTFS_RW */
2218
2219         /* No need to lock at this stage as no one else has a reference. */
2220         if (ni->nr_extents > 0) {
2221                 int i;
2222
2223                 for (i = 0; i < ni->nr_extents; i++)
2224                         ntfs_clear_extent_inode(ni->ext.extent_ntfs_inos[i]);
2225                 kfree(ni->ext.extent_ntfs_inos);
2226         }
2227
2228         __ntfs_clear_inode(ni);
2229
2230         if (NInoAttr(ni)) {
2231                 /* Release the base inode if we are holding it. */
2232                 if (ni->nr_extents == -1) {
2233                         iput(VFS_I(ni->ext.base_ntfs_ino));
2234                         ni->nr_extents = 0;
2235                         ni->ext.base_ntfs_ino = NULL;
2236                 }
2237         }
2238         return;
2239 }
2240
2241 /**
2242  * ntfs_show_options - show mount options in /proc/mounts
2243  * @sf:         seq_file in which to write our mount options
2244  * @mnt:        vfs mount whose mount options to display
2245  *
2246  * Called by the VFS once for each mounted ntfs volume when someone reads
2247  * /proc/mounts in order to display the NTFS specific mount options of each
2248  * mount. The mount options of the vfs mount @mnt are written to the seq file
2249  * @sf and success is returned.
2250  */
2251 int ntfs_show_options(struct seq_file *sf, struct vfsmount *mnt)
2252 {
2253         ntfs_volume *vol = NTFS_SB(mnt->mnt_sb);
2254         int i;
2255
2256         seq_printf(sf, ",uid=%i", vol->uid);
2257         seq_printf(sf, ",gid=%i", vol->gid);
2258         if (vol->fmask == vol->dmask)
2259                 seq_printf(sf, ",umask=0%o", vol->fmask);
2260         else {
2261                 seq_printf(sf, ",fmask=0%o", vol->fmask);
2262                 seq_printf(sf, ",dmask=0%o", vol->dmask);
2263         }
2264         seq_printf(sf, ",nls=%s", vol->nls_map->charset);
2265         if (NVolCaseSensitive(vol))
2266                 seq_printf(sf, ",case_sensitive");
2267         if (NVolShowSystemFiles(vol))
2268                 seq_printf(sf, ",show_sys_files");
2269         if (!NVolSparseEnabled(vol))
2270                 seq_printf(sf, ",disable_sparse");
2271         for (i = 0; on_errors_arr[i].val; i++) {
2272                 if (on_errors_arr[i].val & vol->on_errors)
2273                         seq_printf(sf, ",errors=%s", on_errors_arr[i].str);
2274         }
2275         seq_printf(sf, ",mft_zone_multiplier=%i", vol->mft_zone_multiplier);
2276         return 0;
2277 }
2278
2279 #ifdef NTFS_RW
2280
2281 /**
2282  * ntfs_truncate - called when the i_size of an ntfs inode is changed
2283  * @vi:         inode for which the i_size was changed
2284  *
2285  * We do not support i_size changes yet.
2286  *
2287  * The kernel guarantees that @vi is a regular file (S_ISREG() is true) and
2288  * that the change is allowed.
2289  *
2290  * This implies for us that @vi is a file inode rather than a directory, index,
2291  * or attribute inode as well as that @vi is a base inode.
2292  *
2293  * Returns 0 on success or -errno on error.
2294  *
2295  * Called with ->i_sem held.  In all but one case ->i_alloc_sem is held for
2296  * writing.  The only case where ->i_alloc_sem is not held is
2297  * mm/filemap.c::generic_file_buffered_write() where vmtruncate() is called
2298  * with the current i_size as the offset which means that it is a noop as far
2299  * as ntfs_truncate() is concerned.
2300  */
2301 int ntfs_truncate(struct inode *vi)
2302 {
2303         ntfs_inode *ni = NTFS_I(vi);
2304         ntfs_volume *vol = ni->vol;
2305         ntfs_attr_search_ctx *ctx;
2306         MFT_RECORD *m;
2307         ATTR_RECORD *a;
2308         const char *te = "  Leaving file length out of sync with i_size.";
2309         int err;
2310
2311         ntfs_debug("Entering for inode 0x%lx.", vi->i_ino);
2312         BUG_ON(NInoAttr(ni));
2313         BUG_ON(ni->nr_extents < 0);
2314         m = map_mft_record(ni);
2315         if (IS_ERR(m)) {
2316                 err = PTR_ERR(m);
2317                 ntfs_error(vi->i_sb, "Failed to map mft record for inode 0x%lx "
2318                                 "(error code %d).%s", vi->i_ino, err, te);
2319                 ctx = NULL;
2320                 m = NULL;
2321                 goto err_out;
2322         }
2323         ctx = ntfs_attr_get_search_ctx(ni, m);
2324         if (unlikely(!ctx)) {
2325                 ntfs_error(vi->i_sb, "Failed to allocate a search context for "
2326                                 "inode 0x%lx (not enough memory).%s",
2327                                 vi->i_ino, te);
2328                 err = -ENOMEM;
2329                 goto err_out;
2330         }
2331         err = ntfs_attr_lookup(ni->type, ni->name, ni->name_len,
2332                         CASE_SENSITIVE, 0, NULL, 0, ctx);
2333         if (unlikely(err)) {
2334                 if (err == -ENOENT)
2335                         ntfs_error(vi->i_sb, "Open attribute is missing from "
2336                                         "mft record.  Inode 0x%lx is corrupt.  "
2337                                         "Run chkdsk.", vi->i_ino);
2338                 else
2339                         ntfs_error(vi->i_sb, "Failed to lookup attribute in "
2340                                         "inode 0x%lx (error code %d).",
2341                                         vi->i_ino, err);
2342                 goto err_out;
2343         }
2344         a = ctx->attr;
2345         /* If the size has not changed there is nothing to do. */
2346         if (ntfs_attr_size(a) == i_size_read(vi))
2347                 goto done;
2348         // TODO: Implement the truncate...
2349         ntfs_error(vi->i_sb, "Inode size has changed but this is not "
2350                         "implemented yet.  Resetting inode size to old value. "
2351                         " This is most likely a bug in the ntfs driver!");
2352         i_size_write(vi, ntfs_attr_size(a)); 
2353 done:
2354         ntfs_attr_put_search_ctx(ctx);
2355         unmap_mft_record(ni);
2356         NInoClearTruncateFailed(ni);
2357         ntfs_debug("Done.");
2358         return 0;
2359 err_out:
2360         if (err != -ENOMEM) {
2361                 NVolSetErrors(vol);
2362                 make_bad_inode(vi);
2363         }
2364         if (ctx)
2365                 ntfs_attr_put_search_ctx(ctx);
2366         if (m)
2367                 unmap_mft_record(ni);
2368         NInoSetTruncateFailed(ni);
2369         return err;
2370 }
2371
2372 /**
2373  * ntfs_truncate_vfs - wrapper for ntfs_truncate() that has no return value
2374  * @vi:         inode for which the i_size was changed
2375  *
2376  * Wrapper for ntfs_truncate() that has no return value.
2377  *
2378  * See ntfs_truncate() description above for details.
2379  */
2380 void ntfs_truncate_vfs(struct inode *vi) {
2381         ntfs_truncate(vi);
2382 }
2383
2384 /**
2385  * ntfs_setattr - called from notify_change() when an attribute is being changed
2386  * @dentry:     dentry whose attributes to change
2387  * @attr:       structure describing the attributes and the changes
2388  *
2389  * We have to trap VFS attempts to truncate the file described by @dentry as
2390  * soon as possible, because we do not implement changes in i_size yet.  So we
2391  * abort all i_size changes here.
2392  *
2393  * We also abort all changes of user, group, and mode as we do not implement
2394  * the NTFS ACLs yet.
2395  *
2396  * Called with ->i_sem held.  For the ATTR_SIZE (i.e. ->truncate) case, also
2397  * called with ->i_alloc_sem held for writing.
2398  *
2399  * Basically this is a copy of generic notify_change() and inode_setattr()
2400  * functionality, except we intercept and abort changes in i_size.
2401  */
2402 int ntfs_setattr(struct dentry *dentry, struct iattr *attr)
2403 {
2404         struct inode *vi = dentry->d_inode;
2405         int err;
2406         unsigned int ia_valid = attr->ia_valid;
2407
2408         err = inode_change_ok(vi, attr);
2409         if (err)
2410                 return err;
2411
2412         /* We do not support NTFS ACLs yet. */
2413         if (ia_valid & (ATTR_UID | ATTR_GID | ATTR_MODE)) {
2414                 ntfs_warning(vi->i_sb, "Changes in user/group/mode are not "
2415                                 "supported yet, ignoring.");
2416                 err = -EOPNOTSUPP;
2417                 goto out;
2418         }
2419
2420         if (ia_valid & ATTR_SIZE) {
2421                 if (attr->ia_size != i_size_read(vi)) {
2422                         ntfs_warning(vi->i_sb, "Changes in inode size are not "
2423                                         "supported yet, ignoring.");
2424                         err = -EOPNOTSUPP;
2425                         // TODO: Implement...
2426                         // err = vmtruncate(vi, attr->ia_size);
2427                         if (err || ia_valid == ATTR_SIZE)
2428                                 goto out;
2429                 } else {
2430                         /*
2431                          * We skipped the truncate but must still update
2432                          * timestamps.
2433                          */
2434                         ia_valid |= ATTR_MTIME|ATTR_CTIME;
2435                 }
2436         }
2437
2438         if (ia_valid & ATTR_ATIME)
2439                 vi->i_atime = attr->ia_atime;
2440         if (ia_valid & ATTR_MTIME)
2441                 vi->i_mtime = attr->ia_mtime;
2442         if (ia_valid & ATTR_CTIME)
2443                 vi->i_ctime = attr->ia_ctime;
2444         mark_inode_dirty(vi);
2445 out:
2446         return err;
2447 }
2448
2449 /**
2450  * ntfs_write_inode - write out a dirty inode
2451  * @vi:         inode to write out
2452  * @sync:       if true, write out synchronously
2453  *
2454  * Write out a dirty inode to disk including any extent inodes if present.
2455  *
2456  * If @sync is true, commit the inode to disk and wait for io completion.  This
2457  * is done using write_mft_record().
2458  *
2459  * If @sync is false, just schedule the write to happen but do not wait for i/o
2460  * completion.  In 2.6 kernels, scheduling usually happens just by virtue of
2461  * marking the page (and in this case mft record) dirty but we do not implement
2462  * this yet as write_mft_record() largely ignores the @sync parameter and
2463  * always performs synchronous writes.
2464  *
2465  * Return 0 on success and -errno on error.
2466  */
2467 int ntfs_write_inode(struct inode *vi, int sync)
2468 {
2469         sle64 nt;
2470         ntfs_inode *ni = NTFS_I(vi);
2471         ntfs_attr_search_ctx *ctx;
2472         MFT_RECORD *m;
2473         STANDARD_INFORMATION *si;
2474         int err = 0;
2475         BOOL modified = FALSE;
2476
2477         ntfs_debug("Entering for %sinode 0x%lx.", NInoAttr(ni) ? "attr " : "",
2478                         vi->i_ino);
2479         /*
2480          * Dirty attribute inodes are written via their real inodes so just
2481          * clean them here.  Access time updates are taken care off when the
2482          * real inode is written.
2483          */
2484         if (NInoAttr(ni)) {
2485                 NInoClearDirty(ni);
2486                 ntfs_debug("Done.");
2487                 return 0;
2488         }
2489         /* Map, pin, and lock the mft record belonging to the inode. */
2490         m = map_mft_record(ni);
2491         if (IS_ERR(m)) {
2492                 err = PTR_ERR(m);
2493                 goto err_out;
2494         }
2495         /* Update the access times in the standard information attribute. */
2496         ctx = ntfs_attr_get_search_ctx(ni, m);
2497         if (unlikely(!ctx)) {
2498                 err = -ENOMEM;
2499                 goto unm_err_out;
2500         }
2501         err = ntfs_attr_lookup(AT_STANDARD_INFORMATION, NULL, 0,
2502                         CASE_SENSITIVE, 0, NULL, 0, ctx);
2503         if (unlikely(err)) {
2504                 ntfs_attr_put_search_ctx(ctx);
2505                 goto unm_err_out;
2506         }
2507         si = (STANDARD_INFORMATION*)((u8*)ctx->attr +
2508                         le16_to_cpu(ctx->attr->data.resident.value_offset));
2509         /* Update the access times if they have changed. */
2510         nt = utc2ntfs(vi->i_mtime);
2511         if (si->last_data_change_time != nt) {
2512                 ntfs_debug("Updating mtime for inode 0x%lx: old = 0x%llx, "
2513                                 "new = 0x%llx", vi->i_ino, (long long)
2514                                 sle64_to_cpu(si->last_data_change_time),
2515                                 (long long)sle64_to_cpu(nt));
2516                 si->last_data_change_time = nt;
2517                 modified = TRUE;
2518         }
2519         nt = utc2ntfs(vi->i_ctime);
2520         if (si->last_mft_change_time != nt) {
2521                 ntfs_debug("Updating ctime for inode 0x%lx: old = 0x%llx, "
2522                                 "new = 0x%llx", vi->i_ino, (long long)
2523                                 sle64_to_cpu(si->last_mft_change_time),
2524                                 (long long)sle64_to_cpu(nt));
2525                 si->last_mft_change_time = nt;
2526                 modified = TRUE;
2527         }
2528         nt = utc2ntfs(vi->i_atime);
2529         if (si->last_access_time != nt) {
2530                 ntfs_debug("Updating atime for inode 0x%lx: old = 0x%llx, "
2531                                 "new = 0x%llx", vi->i_ino,
2532                                 (long long)sle64_to_cpu(si->last_access_time),
2533                                 (long long)sle64_to_cpu(nt));
2534                 si->last_access_time = nt;
2535                 modified = TRUE;
2536         }
2537         /*
2538          * If we just modified the standard information attribute we need to
2539          * mark the mft record it is in dirty.  We do this manually so that
2540          * mark_inode_dirty() is not called which would redirty the inode and
2541          * hence result in an infinite loop of trying to write the inode.
2542          * There is no need to mark the base inode nor the base mft record
2543          * dirty, since we are going to write this mft record below in any case
2544          * and the base mft record may actually not have been modified so it
2545          * might not need to be written out.
2546          * NOTE: It is not a problem when the inode for $MFT itself is being
2547          * written out as mark_ntfs_record_dirty() will only set I_DIRTY_PAGES
2548          * on the $MFT inode and hence ntfs_write_inode() will not be
2549          * re-invoked because of it which in turn is ok since the dirtied mft
2550          * record will be cleaned and written out to disk below, i.e. before
2551          * this function returns.
2552          */
2553         if (modified && !NInoTestSetDirty(ctx->ntfs_ino))
2554                 mark_ntfs_record_dirty(ctx->ntfs_ino->page,
2555                                 ctx->ntfs_ino->page_ofs);
2556         ntfs_attr_put_search_ctx(ctx);
2557         /* Now the access times are updated, write the base mft record. */
2558         if (NInoDirty(ni))
2559                 err = write_mft_record(ni, m, sync);
2560         /* Write all attached extent mft records. */
2561         down(&ni->extent_lock);
2562         if (ni->nr_extents > 0) {
2563                 ntfs_inode **extent_nis = ni->ext.extent_ntfs_inos;
2564                 int i;
2565
2566                 ntfs_debug("Writing %i extent inodes.", ni->nr_extents);
2567                 for (i = 0; i < ni->nr_extents; i++) {
2568                         ntfs_inode *tni = extent_nis[i];
2569
2570                         if (NInoDirty(tni)) {
2571                                 MFT_RECORD *tm = map_mft_record(tni);
2572                                 int ret;
2573
2574                                 if (IS_ERR(tm)) {
2575                                         if (!err || err == -ENOMEM)
2576                                                 err = PTR_ERR(tm);
2577                                         continue;
2578                                 }
2579                                 ret = write_mft_record(tni, tm, sync);
2580                                 unmap_mft_record(tni);
2581                                 if (unlikely(ret)) {
2582                                         if (!err || err == -ENOMEM)
2583                                                 err = ret;
2584                                 }
2585                         }
2586                 }
2587         }
2588         up(&ni->extent_lock);
2589         unmap_mft_record(ni);
2590         if (unlikely(err))
2591                 goto err_out;
2592         ntfs_debug("Done.");
2593         return 0;
2594 unm_err_out:
2595         unmap_mft_record(ni);
2596 err_out:
2597         if (err == -ENOMEM) {
2598                 ntfs_warning(vi->i_sb, "Not enough memory to write inode.  "
2599                                 "Marking the inode dirty again, so the VFS "
2600                                 "retries later.");
2601                 mark_inode_dirty(vi);
2602         } else {
2603                 ntfs_error(vi->i_sb, "Failed (error code %i):  Marking inode "
2604                                 "as bad.  You should run chkdsk.", -err);
2605                 make_bad_inode(vi);
2606                 NVolSetErrors(ni->vol);
2607         }
2608         return err;
2609 }
2610
2611 #endif /* NTFS_RW */