e0c2c6c81bc0871c037826c40c3fe60086dc8d08
[linux-3.10.git] / fs / ntfs / attrib.h
1 /*
2  * attrib.h - Defines for attribute handling in NTFS Linux kernel driver.
3  *            Part of the Linux-NTFS project.
4  *
5  * Copyright (c) 2001-2004 Anton Altaparmakov
6  * Copyright (c) 2002 Richard Russon
7  *
8  * This program/include file is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as published
10  * by the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program/include file is distributed in the hope that it will be
14  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
15  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program (in the main directory of the Linux-NTFS
20  * distribution in the file COPYING); if not, write to the Free Software
21  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  */
23
24 #ifndef _LINUX_NTFS_ATTRIB_H
25 #define _LINUX_NTFS_ATTRIB_H
26
27 #include "endian.h"
28 #include "types.h"
29 #include "layout.h"
30 #include "inode.h"
31 #include "runlist.h"
32 #include "volume.h"
33
34 /**
35  * ntfs_attr_search_ctx - used in attribute search functions
36  * @mrec:       buffer containing mft record to search
37  * @attr:       attribute record in @mrec where to begin/continue search
38  * @is_first:   if true ntfs_attr_lookup() begins search with @attr, else after
39  *
40  * Structure must be initialized to zero before the first call to one of the
41  * attribute search functions. Initialize @mrec to point to the mft record to
42  * search, and @attr to point to the first attribute within @mrec (not necessary
43  * if calling the _first() functions), and set @is_first to TRUE (not necessary
44  * if calling the _first() functions).
45  *
46  * If @is_first is TRUE, the search begins with @attr. If @is_first is FALSE,
47  * the search begins after @attr. This is so that, after the first call to one
48  * of the search attribute functions, we can call the function again, without
49  * any modification of the search context, to automagically get the next
50  * matching attribute.
51  */
52 typedef struct {
53         MFT_RECORD *mrec;
54         ATTR_RECORD *attr;
55         BOOL is_first;
56         ntfs_inode *ntfs_ino;
57         ATTR_LIST_ENTRY *al_entry;
58         ntfs_inode *base_ntfs_ino;
59         MFT_RECORD *base_mrec;
60         ATTR_RECORD *base_attr;
61 } ntfs_attr_search_ctx;
62
63 extern int ntfs_map_runlist(ntfs_inode *ni, VCN vcn);
64
65 extern runlist_element *ntfs_find_vcn(ntfs_inode *ni, const VCN vcn,
66                 const BOOL need_write);
67
68 int ntfs_attr_lookup(const ATTR_TYPE type, const ntfschar *name,
69                 const u32 name_len, const IGNORE_CASE_BOOL ic,
70                 const VCN lowest_vcn, const u8 *val, const u32 val_len,
71                 ntfs_attr_search_ctx *ctx);
72
73 extern int load_attribute_list(ntfs_volume *vol, runlist *rl, u8 *al_start,
74                 const s64 size, const s64 initialized_size);
75
76 static inline s64 ntfs_attr_size(const ATTR_RECORD *a)
77 {
78         if (!a->non_resident)
79                 return (s64)le32_to_cpu(a->data.resident.value_length);
80         return sle64_to_cpu(a->data.non_resident.data_size);
81 }
82
83 extern void ntfs_attr_reinit_search_ctx(ntfs_attr_search_ctx *ctx);
84 extern ntfs_attr_search_ctx *ntfs_attr_get_search_ctx(ntfs_inode *ni,
85                 MFT_RECORD *mrec);
86 extern void ntfs_attr_put_search_ctx(ntfs_attr_search_ctx *ctx);
87
88 extern int ntfs_attr_size_bounds_check(const ntfs_volume *vol,
89                 const ATTR_TYPE type, const s64 size);
90 extern int ntfs_attr_can_be_non_resident(const ntfs_volume *vol,
91                 const ATTR_TYPE type);
92 extern int ntfs_attr_can_be_resident(const ntfs_volume *vol,
93                 const ATTR_TYPE type);
94
95 extern int ntfs_attr_record_resize(MFT_RECORD *m, ATTR_RECORD *a, u32 new_size);
96
97 extern int ntfs_attr_set(ntfs_inode *ni, const s64 ofs, const s64 cnt,
98                 const u8 val);
99
100 #endif /* _LINUX_NTFS_ATTRIB_H */