2 * ntfs.h - Defines for NTFS Linux kernel driver. Part of the Linux-NTFS
5 * Copyright (c) 2001-2004 Anton Altaparmakov
6 * Copyright (C) 2002 Richard Russon
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.
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.
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
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/compiler.h>
31 #include <linux/buffer_head.h>
32 #include <linux/nls.h>
33 #include <linux/pagemap.h>
34 #include <linux/smp.h>
35 #include <asm/atomic.h>
48 NTFS_BLOCK_SIZE = 512,
49 NTFS_BLOCK_SIZE_BITS = 9,
50 NTFS_SB_MAGIC = 0x5346544e, /* 'NTFS' */
51 NTFS_MAX_NAME_LEN = 255,
54 /* Global variables. */
56 /* Slab caches (from super.c). */
57 extern kmem_cache_t *ntfs_name_cache;
58 extern kmem_cache_t *ntfs_inode_cache;
59 extern kmem_cache_t *ntfs_big_inode_cache;
60 extern kmem_cache_t *ntfs_attr_ctx_cache;
62 /* The various operations structs defined throughout the driver files. */
63 extern struct super_operations ntfs_sops;
64 extern struct address_space_operations ntfs_aops;
65 extern struct address_space_operations ntfs_mft_aops;
67 extern struct file_operations ntfs_file_ops;
68 extern struct inode_operations ntfs_file_inode_ops;
70 extern struct file_operations ntfs_dir_ops;
71 extern struct inode_operations ntfs_dir_inode_ops;
73 extern struct file_operations ntfs_empty_file_ops;
74 extern struct inode_operations ntfs_empty_inode_ops;
77 * NTFS_SB - return the ntfs volume given a vfs super block
78 * @sb: VFS super block
80 * NTFS_SB() returns the ntfs volume associated with the VFS super block @sb.
82 static inline ntfs_volume *NTFS_SB(struct super_block *sb)
88 * ntfs_unmap_page - release a page that was mapped using ntfs_map_page()
89 * @page: the page to release
91 * Unpin, unmap and release a page that was obtained from ntfs_map_page().
93 static inline void ntfs_unmap_page(struct page *page)
96 page_cache_release(page);
100 * ntfs_map_page - map a page into accessible memory, reading it if necessary
101 * @mapping: address space for which to obtain the page
102 * @index: index into the page cache for @mapping of the page to map
104 * Read a page from the page cache of the address space @mapping at position
105 * @index, where @index is in units of PAGE_CACHE_SIZE, and not in bytes.
107 * If the page is not in memory it is loaded from disk first using the readpage
108 * method defined in the address space operations of @mapping and the page is
109 * added to the page cache of @mapping in the process.
111 * If the page is in high memory it is mapped into memory directly addressible
114 * Finally the page count is incremented, thus pinning the page into place.
116 * The above means that page_address(page) can be used on all pages obtained
117 * with ntfs_map_page() to get the kernel virtual address of the page.
119 * When finished with the page, the caller has to call ntfs_unmap_page() to
120 * unpin, unmap and release the page.
122 * Note this does not grant exclusive access. If such is desired, the caller
123 * must provide it independently of the ntfs_{un}map_page() calls by using
124 * a {rw_}semaphore or other means of serialization. A spin lock cannot be
125 * used as ntfs_map_page() can block.
127 * The unlocked and uptodate page is returned on success or an encoded error
128 * on failure. Caller has to test for error using the IS_ERR() macro on the
129 * return value. If that evaluates to TRUE, the negative error code can be
130 * obtained using PTR_ERR() on the return value of ntfs_map_page().
132 static inline struct page *ntfs_map_page(struct address_space *mapping,
135 struct page *page = read_cache_page(mapping, index,
136 (filler_t*)mapping->a_ops->readpage, NULL);
139 wait_on_page_locked(page);
141 if (PageUptodate(page) && !PageError(page))
143 ntfs_unmap_page(page);
144 return ERR_PTR(-EIO);
149 /* Declarations of functions and global variables. */
151 /* From fs/ntfs/compress.c */
152 extern int ntfs_read_compressed_block(struct page *page);
154 /* From fs/ntfs/super.c */
155 #define default_upcase_len 0x10000
156 extern wchar_t *default_upcase;
157 extern unsigned long ntfs_nr_upcase_users;
158 extern unsigned long ntfs_nr_mounts;
159 extern struct semaphore ntfs_lock;
165 extern const option_t on_errors_arr[];
167 /* From fs/ntfs/compress.c */
168 extern int allocate_compression_buffers(void);
169 extern void free_compression_buffers(void);
171 /* From fs/ntfs/mst.c */
172 extern int post_read_mst_fixup(NTFS_RECORD *b, const u32 size);
173 extern int pre_write_mst_fixup(NTFS_RECORD *b, const u32 size);
174 extern void post_write_mst_fixup(NTFS_RECORD *b);
176 /* From fs/ntfs/unistr.c */
177 extern BOOL ntfs_are_names_equal(const ntfschar *s1, size_t s1_len,
178 const ntfschar *s2, size_t s2_len,
179 const IGNORE_CASE_BOOL ic,
180 const ntfschar *upcase, const u32 upcase_size);
181 extern int ntfs_collate_names(const ntfschar *name1, const u32 name1_len,
182 const ntfschar *name2, const u32 name2_len,
183 const int err_val, const IGNORE_CASE_BOOL ic,
184 const ntfschar *upcase, const u32 upcase_len);
185 extern int ntfs_ucsncmp(const ntfschar *s1, const ntfschar *s2, size_t n);
186 extern int ntfs_ucsncasecmp(const ntfschar *s1, const ntfschar *s2, size_t n,
187 const ntfschar *upcase, const u32 upcase_size);
188 extern void ntfs_upcase_name(ntfschar *name, u32 name_len,
189 const ntfschar *upcase, const u32 upcase_len);
190 extern void ntfs_file_upcase_value(FILE_NAME_ATTR *file_name_attr,
191 const ntfschar *upcase, const u32 upcase_len);
192 extern int ntfs_file_compare_values(FILE_NAME_ATTR *file_name_attr1,
193 FILE_NAME_ATTR *file_name_attr2,
194 const int err_val, const IGNORE_CASE_BOOL ic,
195 const ntfschar *upcase, const u32 upcase_len);
196 extern int ntfs_nlstoucs(const ntfs_volume *vol, const char *ins,
197 const int ins_len, ntfschar **outs);
198 extern int ntfs_ucstonls(const ntfs_volume *vol, const ntfschar *ins,
199 const int ins_len, unsigned char **outs, int outs_len);
201 /* From fs/ntfs/upcase.c */
202 extern ntfschar *generate_default_upcase(void);
204 #endif /* _LINUX_NTFS_H */