scripts: kernel-doc whitespace cleanup
[pv_ops_mirror.git] / fs / ncpfs / ncplib_kernel.h
blob2441d1ab57dc57abe66ba24126b3b9221b1692bc
1 /*
2 * ncplib_kernel.h
4 * Copyright (C) 1995, 1996 by Volker Lendecke
5 * Modified for big endian by J.F. Chadima and David S. Miller
6 * Modified 1997 Peter Waltenberg, Bill Hawes, David Woodhouse for 2.1 dcache
7 * Modified 1998, 1999 Wolfram Pienkoss for NLS
8 * Modified 1999 Wolfram Pienkoss for directory caching
12 #ifndef _NCPLIB_H
13 #define _NCPLIB_H
16 #include <linux/fs.h>
17 #include <linux/types.h>
18 #include <linux/errno.h>
19 #include <linux/slab.h>
20 #include <linux/stat.h>
21 #include <linux/fcntl.h>
22 #include <linux/pagemap.h>
24 #include <asm/uaccess.h>
25 #include <asm/byteorder.h>
26 #include <asm/unaligned.h>
27 #include <asm/string.h>
29 #ifdef CONFIG_NCPFS_NLS
30 #include <linux/nls.h>
31 #else
32 #include <linux/ctype.h>
33 #endif /* CONFIG_NCPFS_NLS */
35 #include <linux/ncp_fs.h>
37 #define NCP_MIN_SYMLINK_SIZE 8
38 #define NCP_MAX_SYMLINK_SIZE 512
40 #define NCP_BLOCK_SHIFT 9
41 #define NCP_BLOCK_SIZE (1 << (NCP_BLOCK_SHIFT))
43 int ncp_negotiate_buffersize(struct ncp_server *, int, int *);
44 int ncp_negotiate_size_and_options(struct ncp_server *server, int size,
45 int options, int *ret_size, int *ret_options);
47 int ncp_get_volume_info_with_number(struct ncp_server* server, int n,
48 struct ncp_volume_info *target);
50 int ncp_get_directory_info(struct ncp_server* server, __u8 dirhandle,
51 struct ncp_volume_info* target);
53 int ncp_close_file(struct ncp_server *, const char *);
54 static inline int ncp_read_bounce_size(__u32 size) {
55 return sizeof(struct ncp_reply_header) + 2 + 2 + size + 8;
57 int ncp_read_bounce(struct ncp_server *, const char *, __u32, __u16,
58 char __user *, int *, void* bounce, __u32 bouncelen);
59 int ncp_read_kernel(struct ncp_server *, const char *, __u32, __u16,
60 char *, int *);
61 int ncp_write_kernel(struct ncp_server *, const char *, __u32, __u16,
62 const char *, int *);
64 static inline void ncp_inode_close(struct inode *inode) {
65 atomic_dec(&NCP_FINFO(inode)->opened);
68 void ncp_extract_file_info(void* src, struct nw_info_struct* target);
69 int ncp_obtain_info(struct ncp_server *server, struct inode *, char *,
70 struct nw_info_struct *target);
71 int ncp_obtain_nfs_info(struct ncp_server *server, struct nw_info_struct *target);
72 int ncp_get_volume_root(struct ncp_server *server, const char *volname,
73 __u32 *volume, __le32 *dirent, __le32 *dosdirent);
74 int ncp_lookup_volume(struct ncp_server *, const char *, struct nw_info_struct *);
75 int ncp_modify_file_or_subdir_dos_info(struct ncp_server *, struct inode *,
76 __le32, const struct nw_modify_dos_info *info);
77 int ncp_modify_file_or_subdir_dos_info_path(struct ncp_server *, struct inode *,
78 const char* path, __le32, const struct nw_modify_dos_info *info);
79 int ncp_modify_nfs_info(struct ncp_server *, __u8 volnum, __le32 dirent,
80 __u32 mode, __u32 rdev);
82 int ncp_del_file_or_subdir2(struct ncp_server *, struct dentry*);
83 int ncp_del_file_or_subdir(struct ncp_server *, struct inode *, char *);
84 int ncp_open_create_file_or_subdir(struct ncp_server *, struct inode *, char *,
85 int, __le32, __le16, struct ncp_entry_info *);
87 int ncp_initialize_search(struct ncp_server *, struct inode *,
88 struct nw_search_sequence *target);
89 int ncp_search_for_fileset(struct ncp_server *server,
90 struct nw_search_sequence *seq,
91 int* more, int* cnt,
92 char* buffer, size_t bufsize,
93 char** rbuf, size_t* rsize);
95 int ncp_ren_or_mov_file_or_subdir(struct ncp_server *server,
96 struct inode *, char *, struct inode *, char *);
99 int
100 ncp_LogPhysicalRecord(struct ncp_server *server,
101 const char *file_id, __u8 locktype,
102 __u32 offset, __u32 length, __u16 timeout);
104 #ifdef CONFIG_NCPFS_IOCTL_LOCKING
106 ncp_ClearPhysicalRecord(struct ncp_server *server,
107 const char *file_id,
108 __u32 offset, __u32 length);
109 #endif /* CONFIG_NCPFS_IOCTL_LOCKING */
112 ncp_mount_subdir(struct ncp_server *, __u8, __u8, __le32,
113 __u32* volume, __le32* dirent, __le32* dosdirent);
114 int ncp_dirhandle_alloc(struct ncp_server *, __u8 vol, __le32 dirent, __u8 *dirhandle);
115 int ncp_dirhandle_free(struct ncp_server *, __u8 dirhandle);
117 int ncp_create_new(struct inode *dir, struct dentry *dentry,
118 int mode, dev_t rdev, __le32 attributes);
120 static inline int ncp_is_nfs_extras(struct ncp_server* server, unsigned int volnum) {
121 #ifdef CONFIG_NCPFS_NFS_NS
122 return (server->m.flags & NCP_MOUNT_NFS_EXTRAS) &&
123 (server->name_space[volnum] == NW_NS_NFS);
124 #else
125 return 0;
126 #endif
129 #ifdef CONFIG_NCPFS_NLS
131 int ncp__io2vol(struct ncp_server *, unsigned char *, unsigned int *,
132 const unsigned char *, unsigned int, int);
133 int ncp__vol2io(struct ncp_server *, unsigned char *, unsigned int *,
134 const unsigned char *, unsigned int, int);
136 #define NCP_ESC ':'
137 #define NCP_IO_TABLE(dentry) (NCP_SERVER((dentry)->d_inode)->nls_io)
138 #define ncp_tolower(t, c) nls_tolower(t, c)
139 #define ncp_toupper(t, c) nls_toupper(t, c)
140 #define ncp_strnicmp(t, s1, s2, len) \
141 nls_strnicmp(t, s1, s2, len)
142 #define ncp_io2vol(S,m,i,n,k,U) ncp__io2vol(S,m,i,n,k,U)
143 #define ncp_vol2io(S,m,i,n,k,U) ncp__vol2io(S,m,i,n,k,U)
145 #else
147 int ncp__io2vol(unsigned char *, unsigned int *,
148 const unsigned char *, unsigned int, int);
149 int ncp__vol2io(unsigned char *, unsigned int *,
150 const unsigned char *, unsigned int, int);
152 #define NCP_IO_TABLE(dentry) NULL
153 #define ncp_tolower(t, c) tolower(c)
154 #define ncp_toupper(t, c) toupper(c)
155 #define ncp_io2vol(S,m,i,n,k,U) ncp__io2vol(m,i,n,k,U)
156 #define ncp_vol2io(S,m,i,n,k,U) ncp__vol2io(m,i,n,k,U)
159 static inline int ncp_strnicmp(struct nls_table *t, const unsigned char *s1,
160 const unsigned char *s2, int len)
162 while (len--) {
163 if (tolower(*s1++) != tolower(*s2++))
164 return 1;
167 return 0;
170 #endif /* CONFIG_NCPFS_NLS */
172 #define NCP_GET_AGE(dentry) (jiffies - (dentry)->d_time)
173 #define NCP_MAX_AGE(server) ((server)->dentry_ttl)
174 #define NCP_TEST_AGE(server,dentry) (NCP_GET_AGE(dentry) < NCP_MAX_AGE(server))
176 static inline void
177 ncp_age_dentry(struct ncp_server* server, struct dentry* dentry)
179 dentry->d_time = jiffies - server->dentry_ttl;
182 static inline void
183 ncp_new_dentry(struct dentry* dentry)
185 dentry->d_time = jiffies;
188 static inline void
189 ncp_renew_dentries(struct dentry *parent)
191 struct ncp_server *server = NCP_SERVER(parent->d_inode);
192 struct list_head *next;
193 struct dentry *dentry;
195 spin_lock(&dcache_lock);
196 next = parent->d_subdirs.next;
197 while (next != &parent->d_subdirs) {
198 dentry = list_entry(next, struct dentry, d_u.d_child);
200 if (dentry->d_fsdata == NULL)
201 ncp_age_dentry(server, dentry);
202 else
203 ncp_new_dentry(dentry);
205 next = next->next;
207 spin_unlock(&dcache_lock);
210 static inline void
211 ncp_invalidate_dircache_entries(struct dentry *parent)
213 struct ncp_server *server = NCP_SERVER(parent->d_inode);
214 struct list_head *next;
215 struct dentry *dentry;
217 spin_lock(&dcache_lock);
218 next = parent->d_subdirs.next;
219 while (next != &parent->d_subdirs) {
220 dentry = list_entry(next, struct dentry, d_u.d_child);
221 dentry->d_fsdata = NULL;
222 ncp_age_dentry(server, dentry);
223 next = next->next;
225 spin_unlock(&dcache_lock);
228 struct ncp_cache_head {
229 time_t mtime;
230 unsigned long time; /* cache age */
231 unsigned long end; /* last valid fpos in cache */
232 int eof;
235 #define NCP_DIRCACHE_SIZE ((int)(PAGE_CACHE_SIZE/sizeof(struct dentry *)))
236 union ncp_dir_cache {
237 struct ncp_cache_head head;
238 struct dentry *dentry[NCP_DIRCACHE_SIZE];
241 #define NCP_FIRSTCACHE_SIZE ((int)((NCP_DIRCACHE_SIZE * \
242 sizeof(struct dentry *) - sizeof(struct ncp_cache_head)) / \
243 sizeof(struct dentry *)))
245 #define NCP_DIRCACHE_START (NCP_DIRCACHE_SIZE - NCP_FIRSTCACHE_SIZE)
247 struct ncp_cache_control {
248 struct ncp_cache_head head;
249 struct page *page;
250 union ncp_dir_cache *cache;
251 unsigned long fpos, ofs;
252 int filled, valid, idx;
255 #endif /* _NCPLIB_H */