cifsproto.h 16.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3
/*
 *   fs/cifs/cifsproto.h
 *
S
Steve French 已提交
4
 *   Copyright (c) International Business Machines  Corp., 2002,2008
L
Linus Torvalds 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *   Author(s): Steve French (sfrench@us.ibm.com)
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published
 *   by the Free Software Foundation; either version 2.1 of the License, or
 *   (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
 *   the GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this library; if not, write to the Free Software
S
Steve French 已提交
19
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
L
Linus Torvalds 已提交
20 21 22 23 24 25
 */
#ifndef _CIFSPROTO_H
#define _CIFSPROTO_H
#include <linux/nls.h>

struct statfs;
26
struct smb_vol;
L
Linus Torvalds 已提交
27 28 29 30 31 32 33 34 35 36 37

/*
 *****************************************************************
 * All Prototypes
 *****************************************************************
 */

extern struct smb_hdr *cifs_buf_get(void);
extern void cifs_buf_release(void *);
extern struct smb_hdr *cifs_small_buf_get(void);
extern void cifs_small_buf_release(void *);
38 39
extern int smb_send(struct TCP_Server_Info *, struct smb_hdr *,
			unsigned int /* length */);
L
Linus Torvalds 已提交
40 41
extern unsigned int _GetXid(void);
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);
L
Linus Torvalds 已提交
46
extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
47 48 49
extern char *cifs_compose_mount_options(const char *sb_mountdata,
		const char *fullpath, const struct dfs_info3_param *ref,
		char **devname);
50
/* extern void renew_parental_timestamps(struct dentry *direntry);*/
L
Linus Torvalds 已提交
51 52 53 54
extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
			struct smb_hdr * /* input */ ,
			struct smb_hdr * /* out */ ,
			int * /* bytes returned */ , const int long_op);
55 56
extern int SendReceiveNoRsp(const unsigned int xid, struct cifsSesInfo *ses,
			struct smb_hdr *in_buf, int flags);
57
extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
S
Steve French 已提交
58
			struct kvec *, int /* nvec to send */,
59
			int * /* type of buf returned */ , const int flags);
S
Steve French 已提交
60 61 62 63 64
extern int SendReceiveBlockingLock(const unsigned int xid,
			struct cifsTconInfo *ptcon,
			struct smb_hdr *in_buf ,
			struct smb_hdr *out_buf,
			int *bytes_returned);
65
extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
66 67 68
extern bool is_valid_oplock_break(struct smb_hdr *smb,
				  struct TCP_Server_Info *);
extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
69
extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
S
Steve French 已提交
70 71 72
#ifdef CONFIG_CIFS_EXPERIMENTAL
extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
#endif
L
Linus Torvalds 已提交
73
extern unsigned int smbCalcSize(struct smb_hdr *ptr);
74
extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
L
Linus Torvalds 已提交
75 76
extern int decode_negTokenInit(unsigned char *security_blob, int length,
			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);
L
Linus Torvalds 已提交
79
extern void header_assemble(struct smb_hdr *, char /* command */ ,
80 81
			    const struct cifsTconInfo *, int /* length of
			    fixed section (word count) in two byte units */);
82 83
extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
				struct cifsSesInfo *ses,
84
				void **request_buf);
85
extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
S
Steve French 已提交
86
			     const int stage,
87
			     const struct nls_table *nls_cp);
88
extern __u16 GetNextMid(struct TCP_Server_Info *server);
89
extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
90
						 struct cifsTconInfo *);
L
Linus Torvalds 已提交
91
extern void DeleteOplockQEntry(struct oplock_q_entry *);
92
extern void DeleteTconOplockQEntries(struct cifsTconInfo *);
93
extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
L
Linus Torvalds 已提交
94
extern u64 cifs_UnixTimeToNT(struct timespec);
95 96
extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
				      int offset);
97

98 99 100
extern int cifs_posix_open(char *full_path, struct inode **pinode,
			   struct super_block *sb, int mode, int oflags,
			   int *poplock, __u16 *pnetfid, int xid);
101 102 103 104 105 106 107
extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
				     FILE_UNIX_BASIC_INFO *info,
				     struct cifs_sb_info *cifs_sb);
extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
extern struct inode *cifs_iget(struct super_block *sb,
			       struct cifs_fattr *fattr);

L
Linus Torvalds 已提交
108
extern int cifs_get_inode_info(struct inode **pinode,
S
Steve French 已提交
109
			const unsigned char *search_path,
110
			FILE_ALL_INFO *pfile_info,
111
			struct super_block *sb, int xid, const __u16 *pfid);
L
Linus Torvalds 已提交
112 113
extern int cifs_get_inode_info_unix(struct inode **pinode,
			const unsigned char *search_path,
S
Steve French 已提交
114
			struct super_block *sb, int xid);
115 116 117
extern void cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
			      struct cifs_fattr *fattr, struct inode *inode,
			      const char *path, const __u16 *pfid);
118
extern int mode_to_acl(struct inode *inode, const char *path, __u64);
119

L
Linus Torvalds 已提交
120 121 122
extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
			const char *);
extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
123
extern void cifs_dfs_release_automount_timer(void);
L
Linus Torvalds 已提交
124 125 126
void cifs_proc_init(void);
void cifs_proc_clean(void);

S
Steve French 已提交
127 128
extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
			struct nls_table *nls_info);
L
Linus Torvalds 已提交
129 130 131 132 133 134 135
extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);

extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
			const char *tree, struct cifsTconInfo *tcon,
			const struct nls_table *);

extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
136
		const char *searchName, const struct nls_table *nls_codepage,
S
Steve French 已提交
137
		__u16 *searchHandle, struct cifs_search_info *psrch_inf,
138
		int map, const char dirsep);
L
Linus Torvalds 已提交
139 140

extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
141
		__u16 searchHandle, struct cifs_search_info *psrch_inf);
L
Linus Torvalds 已提交
142 143 144 145 146 147

extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
			const __u16 search_handle);

extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
			const unsigned char *searchName,
148
			FILE_ALL_INFO *findData,
149
			int legacy /* whether to use old info level */,
150
			const struct nls_table *nls_codepage, int remap);
151
extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
152 153 154
			const unsigned char *searchName,
			FILE_ALL_INFO *findData,
			const struct nls_table *nls_codepage, int remap);
L
Linus Torvalds 已提交
155 156 157 158

extern int CIFSSMBUnixQPathInfo(const int xid,
			struct cifsTconInfo *tcon,
			const unsigned char *searchName,
159
			FILE_UNIX_BASIC_INFO *pFindData,
160
			const struct nls_table *nls_codepage, int remap);
L
Linus Torvalds 已提交
161 162 163

extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
			const unsigned char *searchName,
S
Steve French 已提交
164 165
			struct dfs_info3_param **target_nodes,
			unsigned int *number_of_nodes_in_array,
166
			const struct nls_table *nls_codepage, int remap);
L
Linus Torvalds 已提交
167 168

extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
S
Steve French 已提交
169
			const char *old_path,
170
			const struct nls_table *nls_codepage,
S
Steve French 已提交
171
			unsigned int *pnum_referrals,
S
Steve French 已提交
172
			struct dfs_info3_param **preferrals,
173
			int remap);
174
extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
175
				 struct super_block *sb, struct smb_vol *vol);
L
Linus Torvalds 已提交
176
extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
177
			struct kstatfs *FSData);
178 179
extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
			struct kstatfs *FSData);
180
extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
181 182
			__u64 cap);

L
Linus Torvalds 已提交
183
extern int CIFSSMBQFSAttributeInfo(const int xid,
184 185 186
			struct cifsTconInfo *tcon);
extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
L
Linus Torvalds 已提交
187
extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
188
			struct kstatfs *FSData);
L
Linus Torvalds 已提交
189

190
extern int CIFSSMBSetPathInfo(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
191
			const char *fileName, const FILE_BASIC_INFO *data,
192 193
			const struct nls_table *nls_codepage,
			int remap_special_chars);
194 195 196
extern int CIFSSMBSetFileInfo(const int xid, struct cifsTconInfo *tcon,
			const FILE_BASIC_INFO *data, __u16 fid,
			__u32 pid_of_opener);
197 198
extern int CIFSSMBSetFileDisposition(const int xid, struct cifsTconInfo *tcon,
			bool delete_file, __u16 fid, __u32 pid_of_opener);
L
Linus Torvalds 已提交
199 200 201 202 203 204
#if 0
extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
			char *fileName, __u16 dos_attributes,
			const struct nls_table *nls_codepage);
#endif /* possibly unneeded function */
extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
205
			const char *fileName, __u64 size,
206
			bool setAllocationSizeFlag,
207 208
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
209
extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
210
			 __u64 size, __u16 fileHandle, __u32 opener_pid,
211
			bool AllocSizeFlag);
212 213 214 215 216 217 218 219 220 221 222

struct cifs_unix_set_info_args {
	__u64	ctime;
	__u64	atime;
	__u64	mtime;
	__u64	mode;
	__u64	uid;
	__u64	gid;
	dev_t	device;
};

223 224 225 226
extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifsTconInfo *tcon,
				  const struct cifs_unix_set_info_args *args,
				  u16 fid, u32 pid_of_opener);

227
extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifsTconInfo *pTcon,
228 229
			char *fileName,
			const struct cifs_unix_set_info_args *args,
230 231
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
232 233 234

extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
			const char *newName,
235 236
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
237
extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
238 239
			const char *name, const struct nls_table *nls_codepage,
			int remap_special_chars);
240 241 242 243
extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
			const char *name, __u16 type,
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
244 245
extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
			const char *name,
246 247
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
248 249
extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
			const char *fromName, const char *toName,
250 251
			const struct nls_table *nls_codepage,
			int remap_special_chars);
S
Steve French 已提交
252
extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
253
			int netfid, const char *target_name,
254 255
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
256 257 258
extern int CIFSCreateHardLink(const int xid,
			struct cifsTconInfo *tcon,
			const char *fromName, const char *toName,
259 260
			const struct nls_table *nls_codepage,
			int remap_special_chars);
L
Linus Torvalds 已提交
261 262 263
extern int CIFSUnixCreateHardLink(const int xid,
			struct cifsTconInfo *tcon,
			const char *fromName, const char *toName,
S
Steve French 已提交
264
			const struct nls_table *nls_codepage,
265
			int remap_special_chars);
L
Linus Torvalds 已提交
266 267 268 269 270 271
extern int CIFSUnixCreateSymLink(const int xid,
			struct cifsTconInfo *tcon,
			const char *fromName, const char *toName,
			const struct nls_table *nls_codepage);
extern int CIFSSMBUnixQuerySymLink(const int xid,
			struct cifsTconInfo *tcon,
272
			const unsigned char *searchName, char **syminfo,
L
Linus Torvalds 已提交
273
			const struct nls_table *nls_codepage);
S
Steve French 已提交
274
extern int CIFSSMBQueryReparseLinkInfo(const int xid,
L
Linus Torvalds 已提交
275 276 277 278 279 280 281 282
			struct cifsTconInfo *tcon,
			const unsigned char *searchName,
			char *symlinkinfo, const int buflen, __u16 fid,
			const struct nls_table *nls_codepage);

extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
			const char *fileName, const int disposition,
			const int access_flags, const int omode,
S
Steve French 已提交
283
			__u16 *netfid, int *pOplock, FILE_ALL_INFO *,
284
			const struct nls_table *nls_codepage, int remap);
285 286 287
extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
			const char *fileName, const int disposition,
			const int access_flags, const int omode,
S
Steve French 已提交
288
			__u16 *netfid, int *pOplock, FILE_ALL_INFO *,
289
			const struct nls_table *nls_codepage, int remap);
S
Steve French 已提交
290
extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
291
			u32 posix_flags, __u64 mode, __u16 *netfid,
292 293
			FILE_UNIX_BASIC_INFO *pRetData,
			__u32 *pOplock, const char *name,
S
Steve French 已提交
294
			const struct nls_table *nls_codepage, int remap);
L
Linus Torvalds 已提交
295 296 297
extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
			const int smb_file_id);

298 299 300
extern int CIFSSMBFlush(const int xid, struct cifsTconInfo *tcon,
			const int smb_file_id);

L
Linus Torvalds 已提交
301
extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
302 303 304
			const int netfid, unsigned int count,
			const __u64 lseek, unsigned int *nbytes, char **buf,
			int *return_buf_type);
L
Linus Torvalds 已提交
305 306 307
extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
			const int netfid, const unsigned int count,
			const __u64 lseek, unsigned int *nbytes,
S
Steve French 已提交
308
			const char *buf, const char __user *ubuf,
L
Linus Torvalds 已提交
309 310 311
			const int long_op);
extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
			const int netfid, const unsigned int count,
S
Steve French 已提交
312
			const __u64 offset, unsigned int *nbytes,
313
			struct kvec *iov, const int nvec, const int long_op);
L
Linus Torvalds 已提交
314
extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
315
			const unsigned char *searchName, __u64 *inode_number,
S
Steve French 已提交
316
			const struct nls_table *nls_codepage,
317
			int remap_special_chars);
S
Steve French 已提交
318 319
extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
			const struct nls_table *cp, int mapChars);
L
Linus Torvalds 已提交
320 321 322 323 324

extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
			const __u16 netfid, const __u64 len,
			const __u64 offset, const __u32 numUnlock,
			const __u32 numLock, const __u8 lockType,
325
			const bool waitFlag);
326 327
extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
			const __u16 smb_file_id, const int get_flag,
S
Steve French 已提交
328
			const __u64 len, struct file_lock *,
329
			const __u16 lock_type, const bool waitFlag);
L
Linus Torvalds 已提交
330 331 332 333 334 335 336 337
extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);

extern struct cifsSesInfo *sesInfoAlloc(void);
extern void sesInfoFree(struct cifsSesInfo *);
extern struct cifsTconInfo *tconInfoAlloc(void);
extern void tconInfoFree(struct cifsTconInfo *);

S
Steve French 已提交
338
extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
339 340
extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
			  __u32 *);
341 342 343 344 345
extern int cifs_verify_signature(struct smb_hdr *,
				 const struct mac_key *mac_key,
				__u32 expected_sequence_number);
extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
				 const char *pass);
S
Steve French 已提交
346
extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
S
Steve French 已提交
347
			const struct nls_table *);
348
extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
S
Steve French 已提交
349
extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
S
Steve French 已提交
350
			     const struct nls_table *);
351
#ifdef CONFIG_CIFS_WEAK_PW_HASH
352 353
extern void calc_lanman_hash(const char *password, const char *cryptkey,
				bool encrypt, char *lnm_session_key);
354
#endif /* CIFS_WEAK_PW_HASH */
L
Linus Torvalds 已提交
355 356 357 358 359
extern int CIFSSMBCopy(int xid,
			struct cifsTconInfo *source_tcon,
			const char *fromName,
			const __u16 target_tid,
			const char *toName, const int flags,
360
			const struct nls_table *nls_codepage,
361
			int remap_special_chars);
362
extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
363 364
			const int notify_subdirs, const __u16 netfid,
			__u32 filter, struct file *file, int multishot,
365
			const struct nls_table *nls_codepage);
L
Linus Torvalds 已提交
366
extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
367
			const unsigned char *searchName, char *EAData,
368 369
			size_t bufsize, const struct nls_table *nls_codepage,
			int remap_special_chars);
S
Steve French 已提交
370
extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
371
		const unsigned char *searchName, const unsigned char *ea_name,
S
Steve French 已提交
372
		unsigned char *ea_value, size_t buf_size,
373
		const struct nls_table *nls_codepage, int remap_special_chars);
S
Steve French 已提交
374 375 376
extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
		const char *fileName, const char *ea_name,
		const void *ea_value, const __u16 ea_value_len,
377
		const struct nls_table *nls_codepage, int remap_special_chars);
378
extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
379
			__u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
380 381
extern int CIFSSMBSetCIFSACL(const int, struct cifsTconInfo *, __u16,
			struct cifs_ntsd *, __u32);
L
Linus Torvalds 已提交
382 383
extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
		const unsigned char *searchName,
S
Steve French 已提交
384
		char *acl_inf, const int buflen, const int acl_type,
385
		const struct nls_table *nls_codepage, int remap_special_chars);
L
Linus Torvalds 已提交
386 387 388
extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
		const unsigned char *fileName,
		const char *local_acl, const int buflen, const int acl_type,
389
		const struct nls_table *nls_codepage, int remap_special_chars);
390
extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
S
Steve French 已提交
391
			const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
L
Linus Torvalds 已提交
392
#endif			/* _CIFSPROTO_H */