1/*
2 *   fs/cifs/cifsproto.h
3 *
4 *   Copyright (c) International Business Machines  Corp., 2002,2007
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
25struct statfs;
26struct smb_vol;
27
28/*
29 *****************************************************************
30 * All Prototypes
31 *****************************************************************
32 */
33
34extern struct smb_hdr *cifs_buf_get(void);
35extern void cifs_buf_release(void *);
36extern struct smb_hdr *cifs_small_buf_get(void);
37extern void cifs_small_buf_release(void *);
38extern int smb_send(struct socket *, struct smb_hdr *,
39			unsigned int /* length */ , struct sockaddr *);
40extern unsigned int _GetXid(void);
41extern void _FreeXid(unsigned int);
42#define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
43#define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
44extern char *build_path_from_dentry(struct dentry *);
45extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
46/* extern void renew_parental_timestamps(struct dentry *direntry);*/
47extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
48			struct smb_hdr * /* input */ ,
49			struct smb_hdr * /* out */ ,
50			int * /* bytes returned */ , const int long_op);
51extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
52			struct kvec *, int /* nvec to send */,
53			int * /* type of buf returned */ , const int long_op);
54extern int SendReceiveBlockingLock(const unsigned int /* xid */ ,
55					struct cifsTconInfo *,
56				struct smb_hdr * /* input */ ,
57				struct smb_hdr * /* out */ ,
58				int * /* bytes returned */);
59extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
60extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
61extern int is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
62extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
63extern unsigned int smbCalcSize(struct smb_hdr *ptr);
64extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
65extern int decode_negTokenInit(unsigned char *security_blob, int length,
66			enum securityEnum *secType);
67extern int cifs_inet_pton(int, char * source, void *dst);
68extern int map_smb_to_linux_error(struct smb_hdr *smb);
69extern void header_assemble(struct smb_hdr *, char /* command */ ,
70			    const struct cifsTconInfo *, int /* length of
71			    fixed section (word count) in two byte units */);
72extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
73				struct cifsSesInfo *ses,
74				void ** request_buf);
75extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
76			     const int stage,
77			     const struct nls_table *nls_cp);
78extern __u16 GetNextMid(struct TCP_Server_Info *server);
79extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16,
80						 struct cifsTconInfo *);
81extern void DeleteOplockQEntry(struct oplock_q_entry *);
82extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
83extern u64 cifs_UnixTimeToNT(struct timespec);
84extern __le64 cnvrtDosCifsTm(__u16 date, __u16 time);
85extern struct timespec cnvrtDosUnixTm(__u16 date, __u16 time);
86
87extern int cifs_get_inode_info(struct inode **pinode,
88			const unsigned char *search_path,
89			FILE_ALL_INFO * pfile_info,
90			struct super_block *sb, int xid);
91extern int cifs_get_inode_info_unix(struct inode **pinode,
92			const unsigned char *search_path,
93			struct super_block *sb,int xid);
94
95extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
96			const char *);
97extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
98void cifs_proc_init(void);
99void cifs_proc_clean(void);
100
101extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
102			struct nls_table * nls_info);
103extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
104
105extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
106			const char *tree, struct cifsTconInfo *tcon,
107			const struct nls_table *);
108
109extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
110		const char *searchName, const struct nls_table *nls_codepage,
111		__u16 *searchHandle, struct cifs_search_info * psrch_inf,
112		int map, const char dirsep);
113
114extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
115		__u16 searchHandle, struct cifs_search_info * psrch_inf);
116
117extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
118			const __u16 search_handle);
119
120extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
121			const unsigned char *searchName,
122			FILE_ALL_INFO * findData,
123			int legacy /* whether to use old info level */,
124			const struct nls_table *nls_codepage, int remap);
125extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
126                        const unsigned char *searchName,
127                        FILE_ALL_INFO * findData,
128                        const struct nls_table *nls_codepage, int remap);
129
130extern int CIFSSMBUnixQPathInfo(const int xid,
131			struct cifsTconInfo *tcon,
132			const unsigned char *searchName,
133			FILE_UNIX_BASIC_INFO * pFindData,
134			const struct nls_table *nls_codepage, int remap);
135
136extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
137			const unsigned char *searchName,
138			unsigned char **targetUNCs,
139			unsigned int *number_of_UNC_in_array,
140			const struct nls_table *nls_codepage, int remap);
141
142extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
143			const char *old_path,
144			const struct nls_table *nls_codepage, int remap);
145extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
146			const char *old_path,
147			const struct nls_table *nls_codepage,
148			unsigned int *pnum_referrals,
149			unsigned char ** preferrals,
150			int remap);
151extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
152				 struct super_block * sb, struct smb_vol * vol);
153extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
154			struct kstatfs *FSData);
155extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
156			struct kstatfs *FSData);
157extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
158			__u64 cap);
159
160extern int CIFSSMBQFSAttributeInfo(const int xid,
161			struct cifsTconInfo *tcon);
162extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
163extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
164extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
165			struct kstatfs *FSData);
166
167extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
168			const char *fileName, const FILE_BASIC_INFO * data,
169			const struct nls_table *nls_codepage,
170			int remap_special_chars);
171extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
172			const FILE_BASIC_INFO * data, __u16 fid);
173extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
174			const char *fileName, __u64 size,
175			int setAllocationSizeFlag,
176			const struct nls_table *nls_codepage,
177			int remap_special_chars);
178extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
179			 __u64 size, __u16 fileHandle,__u32 opener_pid,
180			int AllocSizeFlag);
181extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
182			char *full_path, __u64 mode, __u64 uid,
183			__u64 gid, dev_t dev,
184			const struct nls_table *nls_codepage,
185			int remap_special_chars);
186
187extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
188			const char *newName,
189			const struct nls_table *nls_codepage,
190			int remap_special_chars);
191extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
192			const char *name, const struct nls_table *nls_codepage,
193			int remap_special_chars);
194
195extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
196			const char *name,
197			const struct nls_table *nls_codepage,
198			int remap_special_chars);
199extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
200			const char *fromName, const char *toName,
201			const struct nls_table *nls_codepage,
202			int remap_special_chars);
203extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
204			int netfid, char * target_name,
205			const struct nls_table *nls_codepage,
206			int remap_special_chars);
207extern int CIFSCreateHardLink(const int xid,
208			struct cifsTconInfo *tcon,
209			const char *fromName, const char *toName,
210			const struct nls_table *nls_codepage,
211			int remap_special_chars);
212extern int CIFSUnixCreateHardLink(const int xid,
213			struct cifsTconInfo *tcon,
214			const char *fromName, const char *toName,
215			const struct nls_table *nls_codepage,
216			int remap_special_chars);
217extern int CIFSUnixCreateSymLink(const int xid,
218			struct cifsTconInfo *tcon,
219			const char *fromName, const char *toName,
220			const struct nls_table *nls_codepage);
221extern int CIFSSMBUnixQuerySymLink(const int xid,
222			struct cifsTconInfo *tcon,
223			const unsigned char *searchName,
224			char *syminfo, const int buflen,
225			const struct nls_table *nls_codepage);
226extern int CIFSSMBQueryReparseLinkInfo(const int xid,
227			struct cifsTconInfo *tcon,
228			const unsigned char *searchName,
229			char *symlinkinfo, const int buflen, __u16 fid,
230			const struct nls_table *nls_codepage);
231
232extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
233			const char *fileName, const int disposition,
234			const int access_flags, const int omode,
235			__u16 * netfid, int *pOplock, FILE_ALL_INFO *,
236			const struct nls_table *nls_codepage, int remap);
237extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
238			const char *fileName, const int disposition,
239			const int access_flags, const int omode,
240			__u16 * netfid, int *pOplock, FILE_ALL_INFO *,
241			const struct nls_table *nls_codepage, int remap);
242extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
243			u32 posix_flags, __u64 mode, __u16 * netfid,
244			FILE_UNIX_BASIC_INFO *pRetData,
245			__u32 *pOplock, const char *name,
246			const struct nls_table *nls_codepage, int remap);
247extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
248			const int smb_file_id);
249
250extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
251                        const int netfid, unsigned int count,
252                        const __u64 lseek, unsigned int *nbytes, char **buf,
253			int * return_buf_type);
254extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
255			const int netfid, const unsigned int count,
256			const __u64 lseek, unsigned int *nbytes,
257			const char *buf, const char __user *ubuf,
258			const int long_op);
259extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
260			const int netfid, const unsigned int count,
261			const __u64 offset, unsigned int *nbytes,
262			struct kvec *iov, const int nvec, const int long_op);
263extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
264			const unsigned char *searchName, __u64 * inode_number,
265			const struct nls_table *nls_codepage,
266			int remap_special_chars);
267extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
268			const struct nls_table * codepage);
269extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
270			const struct nls_table * cp, int mapChars);
271
272extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
273			const __u16 netfid, const __u64 len,
274			const __u64 offset, const __u32 numUnlock,
275			const __u32 numLock, const __u8 lockType,
276			const int waitFlag);
277extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
278			const __u16 smb_file_id, const int get_flag,
279			const __u64 len, struct file_lock *,
280			const __u16 lock_type, const int waitFlag);
281extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
282extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
283
284extern struct cifsSesInfo *sesInfoAlloc(void);
285extern void sesInfoFree(struct cifsSesInfo *);
286extern struct cifsTconInfo *tconInfoAlloc(void);
287extern void tconInfoFree(struct cifsTconInfo *);
288
289extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
290extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
291			  __u32 *);
292extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
293	__u32 expected_sequence_number);
294extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
295extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
296			const struct nls_table *);
297extern void CalcNTLMv2_response(const struct cifsSesInfo *, char * );
298extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
299			     const struct nls_table *);
300#ifdef CONFIG_CIFS_WEAK_PW_HASH
301extern void calc_lanman_hash(struct cifsSesInfo * ses, char * lnm_session_key);
302#endif /* CIFS_WEAK_PW_HASH */
303extern int CIFSSMBCopy(int xid,
304			struct cifsTconInfo *source_tcon,
305			const char *fromName,
306			const __u16 target_tid,
307			const char *toName, const int flags,
308			const struct nls_table *nls_codepage,
309			int remap_special_chars);
310extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
311			const int notify_subdirs,const __u16 netfid,
312			__u32 filter, struct file * file, int multishot,
313			const struct nls_table *nls_codepage);
314extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
315			const unsigned char *searchName, char * EAData,
316			size_t bufsize, const struct nls_table *nls_codepage,
317			int remap_special_chars);
318extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
319		const unsigned char * searchName,const unsigned char * ea_name,
320		unsigned char * ea_value, size_t buf_size,
321		const struct nls_table *nls_codepage, int remap_special_chars);
322extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
323		const char *fileName, const char * ea_name,
324		const void * ea_value, const __u16 ea_value_len,
325		const struct nls_table *nls_codepage, int remap_special_chars);
326extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
327			__u16 fid, char *acl_inf, const int buflen,
328			const int acl_type /* ACCESS vs. DEFAULT */);
329extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
330		const unsigned char *searchName,
331		char *acl_inf, const int buflen,const int acl_type,
332		const struct nls_table *nls_codepage, int remap_special_chars);
333extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
334		const unsigned char *fileName,
335		const char *local_acl, const int buflen, const int acl_type,
336		const struct nls_table *nls_codepage, int remap_special_chars);
337extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
338                const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
339#endif			/* _CIFSPROTO_H */
340