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