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