[CIFS] Neaten cERROR and cFYI macros, reduce text space
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / fs / cifs / cifsproto.h
blob32262e15be399a25bbd29bc47c502e9d946459ed
1 /*
2 * fs/cifs/cifsproto.h
4 * Copyright (c) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 * the GNU Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef _CIFSPROTO_H
22 #define _CIFSPROTO_H
23 #include <linux/nls.h>
25 struct statfs;
26 struct smb_vol;
29 *****************************************************************
30 * All Prototypes
31 *****************************************************************
34 extern struct smb_hdr *cifs_buf_get(void);
35 extern void cifs_buf_release(void *);
36 extern struct smb_hdr *cifs_small_buf_get(void);
37 extern void cifs_small_buf_release(void *);
38 extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
39 unsigned int /* length */);
40 extern unsigned int _GetXid(void);
41 extern void _FreeXid(unsigned int);
42 #define GetXid() \
43 ({ \
44 int __xid = (int)_GetXid(); \
45 cFYI(1, "CIFS VFS: in %s as Xid: %d with uid: %d", \
46 __func__, __xid, current_fsuid()); \
47 __xid; \
50 #define FreeXid(curr_xid) \
51 do { \
52 _FreeXid(curr_xid); \
53 cFYI(1, "CIFS VFS: leaving %s (xid = %d) rc = %d", \
54 __func__, curr_xid, (int)rc); \
55 } while (0)
56 extern char *build_path_from_dentry(struct dentry *);
57 extern char *cifs_build_path_to_root(struct cifs_sb_info *cifs_sb);
58 extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
59 extern char *cifs_compose_mount_options(const char *sb_mountdata,
60 const char *fullpath, const struct dfs_info3_param *ref,
61 char **devname);
62 /* extern void renew_parental_timestamps(struct dentry *direntry);*/
63 extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
64 struct smb_hdr * /* input */ ,
65 struct smb_hdr * /* out */ ,
66 int * /* bytes returned */ , const int long_op);
67 extern int SendReceiveNoRsp(const unsigned int xid, struct cifsSesInfo *ses,
68 struct smb_hdr *in_buf, int flags);
69 extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
70 struct kvec *, int /* nvec to send */,
71 int * /* type of buf returned */ , const int flags);
72 extern int SendReceiveBlockingLock(const unsigned int xid,
73 struct cifsTconInfo *ptcon,
74 struct smb_hdr *in_buf ,
75 struct smb_hdr *out_buf,
76 int *bytes_returned);
77 extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
78 extern bool is_valid_oplock_break(struct smb_hdr *smb,
79 struct TCP_Server_Info *);
80 extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
81 extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
82 #ifdef CONFIG_CIFS_EXPERIMENTAL
83 extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
84 #endif
85 extern unsigned int smbCalcSize(struct smb_hdr *ptr);
86 extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
87 extern int decode_negTokenInit(unsigned char *security_blob, int length,
88 enum securityEnum *secType);
89 extern int cifs_convert_address(char *src, void *dst);
90 extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
91 extern void header_assemble(struct smb_hdr *, char /* command */ ,
92 const struct cifsTconInfo *, int /* length of
93 fixed section (word count) in two byte units */);
94 extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
95 struct cifsSesInfo *ses,
96 void **request_buf);
97 extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
98 const int stage,
99 const struct nls_table *nls_cp);
100 extern __u16 GetNextMid(struct TCP_Server_Info *server);
101 extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
102 extern u64 cifs_UnixTimeToNT(struct timespec);
103 extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
104 int offset);
106 extern struct cifsFileInfo *cifs_new_fileinfo(struct inode *newinode,
107 __u16 fileHandle, struct file *file,
108 struct vfsmount *mnt, unsigned int oflags);
109 extern int cifs_posix_open(char *full_path, struct inode **pinode,
110 struct vfsmount *mnt, int mode, int oflags,
111 __u32 *poplock, __u16 *pnetfid, int xid);
112 extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
113 FILE_UNIX_BASIC_INFO *info,
114 struct cifs_sb_info *cifs_sb);
115 extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
116 extern struct inode *cifs_iget(struct super_block *sb,
117 struct cifs_fattr *fattr);
119 extern int cifs_get_file_info(struct file *filp);
120 extern int cifs_get_inode_info(struct inode **pinode,
121 const unsigned char *search_path,
122 FILE_ALL_INFO *pfile_info,
123 struct super_block *sb, int xid, const __u16 *pfid);
124 extern int cifs_get_file_info_unix(struct file *filp);
125 extern int cifs_get_inode_info_unix(struct inode **pinode,
126 const unsigned char *search_path,
127 struct super_block *sb, int xid);
128 extern void cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
129 struct cifs_fattr *fattr, struct inode *inode,
130 const char *path, const __u16 *pfid);
131 extern int mode_to_acl(struct inode *inode, const char *path, __u64);
133 extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
134 const char *);
135 extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
136 extern void cifs_dfs_release_automount_timer(void);
137 void cifs_proc_init(void);
138 void cifs_proc_clean(void);
140 extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
141 struct nls_table *nls_info);
142 extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
144 extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
145 const char *tree, struct cifsTconInfo *tcon,
146 const struct nls_table *);
148 extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
149 const char *searchName, const struct nls_table *nls_codepage,
150 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
151 int map, const char dirsep);
153 extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
154 __u16 searchHandle, struct cifs_search_info *psrch_inf);
156 extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
157 const __u16 search_handle);
159 extern int CIFSSMBQFileInfo(const int xid, struct cifsTconInfo *tcon,
160 u16 netfid, FILE_ALL_INFO *pFindData);
161 extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
162 const unsigned char *searchName,
163 FILE_ALL_INFO *findData,
164 int legacy /* whether to use old info level */,
165 const struct nls_table *nls_codepage, int remap);
166 extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
167 const unsigned char *searchName,
168 FILE_ALL_INFO *findData,
169 const struct nls_table *nls_codepage, int remap);
171 extern int CIFSSMBUnixQFileInfo(const int xid, struct cifsTconInfo *tcon,
172 u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
173 extern int CIFSSMBUnixQPathInfo(const int xid,
174 struct cifsTconInfo *tcon,
175 const unsigned char *searchName,
176 FILE_UNIX_BASIC_INFO *pFindData,
177 const struct nls_table *nls_codepage, int remap);
179 extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
180 const unsigned char *searchName,
181 struct dfs_info3_param **target_nodes,
182 unsigned int *number_of_nodes_in_array,
183 const struct nls_table *nls_codepage, int remap);
185 extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
186 const char *old_path,
187 const struct nls_table *nls_codepage,
188 unsigned int *pnum_referrals,
189 struct dfs_info3_param **preferrals,
190 int remap);
191 extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
192 struct super_block *sb, struct smb_vol *vol);
193 extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
194 struct kstatfs *FSData);
195 extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
196 struct kstatfs *FSData);
197 extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
198 __u64 cap);
200 extern int CIFSSMBQFSAttributeInfo(const int xid,
201 struct cifsTconInfo *tcon);
202 extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
203 extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
204 extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
205 struct kstatfs *FSData);
207 extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
208 const char *fileName, const FILE_BASIC_INFO *data,
209 const struct nls_table *nls_codepage,
210 int remap_special_chars);
211 extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
212 const FILE_BASIC_INFO *data, __u16 fid,
213 __u32 pid_of_opener);
214 extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
215 bool delete_file, __u16 fid, __u32 pid_of_opener);
216 #if 0
217 extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
218 char *fileName, __u16 dos_attributes,
219 const struct nls_table *nls_codepage);
220 #endif /* possibly unneeded function */
221 extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
222 const char *fileName, __u64 size,
223 bool setAllocationSizeFlag,
224 const struct nls_table *nls_codepage,
225 int remap_special_chars);
226 extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
227 __u64 size, __u16 fileHandle, __u32 opener_pid,
228 bool AllocSizeFlag);
230 struct cifs_unix_set_info_args {
231 __u64 ctime;
232 __u64 atime;
233 __u64 mtime;
234 __u64 mode;
235 __u64 uid;
236 __u64 gid;
237 dev_t device;
240 extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifsTconInfo *tcon,
241 const struct cifs_unix_set_info_args *args,
242 u16 fid, u32 pid_of_opener);
244 extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifsTconInfo *pTcon,
245 char *fileName,
246 const struct cifs_unix_set_info_args *args,
247 const struct nls_table *nls_codepage,
248 int remap_special_chars);
250 extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
251 const char *newName,
252 const struct nls_table *nls_codepage,
253 int remap_special_chars);
254 extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
255 const char *name, const struct nls_table *nls_codepage,
256 int remap_special_chars);
257 extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
258 const char *name, __u16 type,
259 const struct nls_table *nls_codepage,
260 int remap_special_chars);
261 extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
262 const char *name,
263 const struct nls_table *nls_codepage,
264 int remap_special_chars);
265 extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
266 const char *fromName, const char *toName,
267 const struct nls_table *nls_codepage,
268 int remap_special_chars);
269 extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
270 int netfid, const char *target_name,
271 const struct nls_table *nls_codepage,
272 int remap_special_chars);
273 extern int CIFSCreateHardLink(const int xid,
274 struct cifsTconInfo *tcon,
275 const char *fromName, const char *toName,
276 const struct nls_table *nls_codepage,
277 int remap_special_chars);
278 extern int CIFSUnixCreateHardLink(const int xid,
279 struct cifsTconInfo *tcon,
280 const char *fromName, const char *toName,
281 const struct nls_table *nls_codepage,
282 int remap_special_chars);
283 extern int CIFSUnixCreateSymLink(const int xid,
284 struct cifsTconInfo *tcon,
285 const char *fromName, const char *toName,
286 const struct nls_table *nls_codepage);
287 extern int CIFSSMBUnixQuerySymLink(const int xid,
288 struct cifsTconInfo *tcon,
289 const unsigned char *searchName, char **syminfo,
290 const struct nls_table *nls_codepage);
291 extern int CIFSSMBQueryReparseLinkInfo(const int xid,
292 struct cifsTconInfo *tcon,
293 const unsigned char *searchName,
294 char *symlinkinfo, const int buflen, __u16 fid,
295 const struct nls_table *nls_codepage);
297 extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
298 const char *fileName, const int disposition,
299 const int access_flags, const int omode,
300 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
301 const struct nls_table *nls_codepage, int remap);
302 extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
303 const char *fileName, const int disposition,
304 const int access_flags, const int omode,
305 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
306 const struct nls_table *nls_codepage, int remap);
307 extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
308 u32 posix_flags, __u64 mode, __u16 *netfid,
309 FILE_UNIX_BASIC_INFO *pRetData,
310 __u32 *pOplock, const char *name,
311 const struct nls_table *nls_codepage, int remap);
312 extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
313 const int smb_file_id);
315 extern int CIFSSMBFlush(const int xid, struct cifsTconInfo *tcon,
316 const int smb_file_id);
318 extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
319 const int netfid, unsigned int count,
320 const __u64 lseek, unsigned int *nbytes, char **buf,
321 int *return_buf_type);
322 extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
323 const int netfid, const unsigned int count,
324 const __u64 lseek, unsigned int *nbytes,
325 const char *buf, const char __user *ubuf,
326 const int long_op);
327 extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
328 const int netfid, const unsigned int count,
329 const __u64 offset, unsigned int *nbytes,
330 struct kvec *iov, const int nvec, const int long_op);
331 extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
332 const unsigned char *searchName, __u64 *inode_number,
333 const struct nls_table *nls_codepage,
334 int remap_special_chars);
335 extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
336 const struct nls_table *cp, int mapChars);
338 extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
339 const __u16 netfid, const __u64 len,
340 const __u64 offset, const __u32 numUnlock,
341 const __u32 numLock, const __u8 lockType,
342 const bool waitFlag);
343 extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
344 const __u16 smb_file_id, const int get_flag,
345 const __u64 len, struct file_lock *,
346 const __u16 lock_type, const bool waitFlag);
347 extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
348 extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
350 extern struct cifsSesInfo *sesInfoAlloc(void);
351 extern void sesInfoFree(struct cifsSesInfo *);
352 extern struct cifsTconInfo *tconInfoAlloc(void);
353 extern void tconInfoFree(struct cifsTconInfo *);
355 extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
356 extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
357 __u32 *);
358 extern int cifs_verify_signature(struct smb_hdr *,
359 const struct mac_key *mac_key,
360 __u32 expected_sequence_number);
361 extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
362 const char *pass);
363 extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
364 const struct nls_table *);
365 extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
366 extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
367 const struct nls_table *);
368 #ifdef CONFIG_CIFS_WEAK_PW_HASH
369 extern void calc_lanman_hash(const char *password, const char *cryptkey,
370 bool encrypt, char *lnm_session_key);
371 #endif /* CIFS_WEAK_PW_HASH */
372 extern int CIFSSMBCopy(int xid,
373 struct cifsTconInfo *source_tcon,
374 const char *fromName,
375 const __u16 target_tid,
376 const char *toName, const int flags,
377 const struct nls_table *nls_codepage,
378 int remap_special_chars);
379 extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
380 const int notify_subdirs, const __u16 netfid,
381 __u32 filter, struct file *file, int multishot,
382 const struct nls_table *nls_codepage);
383 extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
384 const unsigned char *searchName,
385 const unsigned char *ea_name, char *EAData,
386 size_t bufsize, const struct nls_table *nls_codepage,
387 int remap_special_chars);
388 extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
389 const char *fileName, const char *ea_name,
390 const void *ea_value, const __u16 ea_value_len,
391 const struct nls_table *nls_codepage, int remap_special_chars);
392 extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
393 __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
394 extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
395 struct cifs_ntsd *, __u32);
396 extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
397 const unsigned char *searchName,
398 char *acl_inf, const int buflen, const int acl_type,
399 const struct nls_table *nls_codepage, int remap_special_chars);
400 extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
401 const unsigned char *fileName,
402 const char *local_acl, const int buflen, const int acl_type,
403 const struct nls_table *nls_codepage, int remap_special_chars);
404 extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
405 const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
406 extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
407 #endif /* _CIFSPROTO_H */