blob: 310ea2f0e0bfd27d6eacd91ffe0f695a0ca89322 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/cifs/cifsproto.h
3 *
Steve French5815449d2006-02-14 01:36:20 +00004 * Copyright (c) International Business Machines Corp., 2002,2006
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * 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;
26
27/*
28 *****************************************************************
29 * All Prototypes
30 *****************************************************************
31 */
32
33extern struct smb_hdr *cifs_buf_get(void);
34extern void cifs_buf_release(void *);
35extern struct smb_hdr *cifs_small_buf_get(void);
36extern void cifs_small_buf_release(void *);
37extern int smb_send(struct socket *, struct smb_hdr *,
38 unsigned int /* length */ , struct sockaddr *);
39extern unsigned int _GetXid(void);
40extern void _FreeXid(unsigned int);
41#define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
42#define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
Steve French7f573562005-08-30 11:32:14 -070043extern char *build_path_from_dentry(struct dentry *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
45extern void renew_parental_timestamps(struct dentry *direntry);
46extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
47 struct smb_hdr * /* input */ ,
48 struct smb_hdr * /* out */ ,
49 int * /* bytes returned */ , const int long_op);
Steve Frenchd6e04ae2005-06-13 13:24:43 -050050extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
Steve French84afc292005-12-02 13:32:45 -080051 struct kvec *, int /* nvec to send */,
Steve Frenchec637e32005-12-12 20:53:18 -080052 int * /* type of buf returned */ , const int long_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070053extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
54extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
Steve Frenchd7c8c942006-03-03 10:43:49 +000055extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056extern int is_size_safe_to_change(struct cifsInodeInfo *);
Steve French6148a742005-10-05 12:23:19 -070057extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058extern unsigned int smbCalcSize(struct smb_hdr *ptr);
Steve French70ca7342005-09-22 16:32:06 -070059extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060extern int decode_negTokenInit(unsigned char *security_blob, int length,
61 enum securityEnum *secType);
62extern int cifs_inet_pton(int, char * source, void *dst);
63extern int map_smb_to_linux_error(struct smb_hdr *smb);
64extern void header_assemble(struct smb_hdr *, char /* command */ ,
Steve French1982c342005-08-17 12:38:22 -070065 const struct cifsTconInfo *, int /* length of
66 fixed section (word count) in two byte units */);
Steve French5815449d2006-02-14 01:36:20 +000067#ifdef CONFIG_CIFS_EXPERIMENTAL
68extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
69 struct cifsSesInfo *ses,
Steve French12b3b8f2006-02-09 21:12:47 +000070 void ** request_buf);
Steve French5815449d2006-02-14 01:36:20 +000071extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
72 const int stage, int * pNTLMv2_flg,
73 const struct nls_table *nls_cp);
74#endif
Steve French1982c342005-08-17 12:38:22 -070075extern __u16 GetNextMid(struct TCP_Server_Info *server);
Steve French737b7582005-04-28 22:41:06 -070076extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16,
77 struct cifsTconInfo *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078extern void DeleteOplockQEntry(struct oplock_q_entry *);
79extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
80extern u64 cifs_UnixTimeToNT(struct timespec);
81extern int cifs_get_inode_info(struct inode **pinode,
82 const unsigned char *search_path,
83 FILE_ALL_INFO * pfile_info,
84 struct super_block *sb, int xid);
85extern int cifs_get_inode_info_unix(struct inode **pinode,
86 const unsigned char *search_path,
87 struct super_block *sb,int xid);
88
89extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
90 const char *);
91extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
92void cifs_proc_init(void);
93void cifs_proc_clean(void);
94
95extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
96 struct nls_table * nls_info);
97extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
98
99extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
100 const char *tree, struct cifsTconInfo *tcon,
101 const struct nls_table *);
102
103extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
Steve Frenchec637e32005-12-12 20:53:18 -0800104 const char *searchName, const struct nls_table *nls_codepage,
105 __u16 *searchHandle, struct cifs_search_info * psrch_inf,
106 int map, const char dirsep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
Steve Frenchec637e32005-12-12 20:53:18 -0800109 __u16 searchHandle, struct cifs_search_info * psrch_inf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
112 const __u16 search_handle);
113
114extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
115 const unsigned char *searchName,
116 FILE_ALL_INFO * findData,
Steve French737b7582005-04-28 22:41:06 -0700117 const struct nls_table *nls_codepage, int remap);
Steve French6b8edfe2005-08-23 20:26:03 -0700118extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
119 const unsigned char *searchName,
120 FILE_ALL_INFO * findData,
121 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
123extern int CIFSSMBUnixQPathInfo(const int xid,
124 struct cifsTconInfo *tcon,
125 const unsigned char *searchName,
126 FILE_UNIX_BASIC_INFO * pFindData,
Steve French737b7582005-04-28 22:41:06 -0700127 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
130 const unsigned char *searchName,
131 unsigned char **targetUNCs,
132 unsigned int *number_of_UNC_in_array,
Steve French737b7582005-04-28 22:41:06 -0700133 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
136 const char *old_path,
Steve French737b7582005-04-28 22:41:06 -0700137 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
Steve French737b7582005-04-28 22:41:06 -0700139 const char *old_path,
140 const struct nls_table *nls_codepage,
141 unsigned int *pnum_referrals,
142 unsigned char ** preferrals,
143 int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700145 struct kstatfs *FSData);
Steve French20962432005-09-21 22:05:57 -0700146extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
147 struct kstatfs *FSData);
Steve French45abc6e2005-06-23 13:42:03 -0500148extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
Jeremy Allisonac670552005-06-22 17:26:35 -0700149 __u64 cap);
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151extern int CIFSSMBQFSAttributeInfo(const int xid,
Steve French737b7582005-04-28 22:41:06 -0700152 struct cifsTconInfo *tcon);
153extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
154extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700156 struct kstatfs *FSData);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
159 const char *fileName, const FILE_BASIC_INFO * data,
Steve French737b7582005-04-28 22:41:06 -0700160 const struct nls_table *nls_codepage,
161 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
163 const FILE_BASIC_INFO * data, __u16 fid);
164#if 0
165extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
166 char *fileName, __u16 dos_attributes,
167 const struct nls_table *nls_codepage);
168#endif /* possibly unneeded function */
169extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700170 const char *fileName, __u64 size,
171 int setAllocationSizeFlag,
172 const struct nls_table *nls_codepage,
173 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700175 __u64 size, __u16 fileHandle,__u32 opener_pid,
176 int AllocSizeFlag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
178 char *full_path, __u64 mode, __u64 uid,
Steve French737b7582005-04-28 22:41:06 -0700179 __u64 gid, dev_t dev,
180 const struct nls_table *nls_codepage,
181 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
184 const char *newName,
Steve French737b7582005-04-28 22:41:06 -0700185 const struct nls_table *nls_codepage,
186 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700188 const char *name, const struct nls_table *nls_codepage,
189 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
191extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
192 const char *name,
Steve French737b7582005-04-28 22:41:06 -0700193 const struct nls_table *nls_codepage,
194 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
196 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700197 const struct nls_table *nls_codepage,
198 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
Steve French737b7582005-04-28 22:41:06 -0700200 int netfid, char * target_name,
201 const struct nls_table *nls_codepage,
202 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203extern int CIFSCreateHardLink(const int xid,
204 struct cifsTconInfo *tcon,
205 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700206 const struct nls_table *nls_codepage,
207 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208extern int CIFSUnixCreateHardLink(const int xid,
209 struct cifsTconInfo *tcon,
210 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700211 const struct nls_table *nls_codepage,
212 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213extern int CIFSUnixCreateSymLink(const int xid,
214 struct cifsTconInfo *tcon,
215 const char *fromName, const char *toName,
216 const struct nls_table *nls_codepage);
217extern int CIFSSMBUnixQuerySymLink(const int xid,
218 struct cifsTconInfo *tcon,
219 const unsigned char *searchName,
220 char *syminfo, const int buflen,
221 const struct nls_table *nls_codepage);
222extern int CIFSSMBQueryReparseLinkInfo(const int xid,
223 struct cifsTconInfo *tcon,
224 const unsigned char *searchName,
225 char *symlinkinfo, const int buflen, __u16 fid,
226 const struct nls_table *nls_codepage);
227
228extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
229 const char *fileName, const int disposition,
230 const int access_flags, const int omode,
231 __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
Steve French737b7582005-04-28 22:41:06 -0700232 const struct nls_table *nls_codepage, int remap);
Steve Frencha9d02ad2005-08-24 23:06:05 -0700233extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
234 const char *fileName, const int disposition,
235 const int access_flags, const int omode,
236 __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
237 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
239 const int smb_file_id);
240
241extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
Steve Frenchec637e32005-12-12 20:53:18 -0800242 const int netfid, unsigned int count,
243 const __u64 lseek, unsigned int *nbytes, char **buf,
244 int * return_buf_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
246 const int netfid, const unsigned int count,
247 const __u64 lseek, unsigned int *nbytes,
248 const char *buf, const char __user *ubuf,
249 const int long_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
251 const int netfid, const unsigned int count,
252 const __u64 offset, unsigned int *nbytes,
Steve French3e844692005-10-03 13:37:24 -0700253 struct kvec *iov, const int nvec, const int long_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
255 const unsigned char *searchName, __u64 * inode_number,
Steve French737b7582005-04-28 22:41:06 -0700256 const struct nls_table *nls_codepage,
257 int remap_special_chars);
Steve Frenchb1a45692005-05-17 16:07:23 -0500258extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
Steve French6a0b4822005-04-28 22:41:05 -0700259 const struct nls_table * codepage);
Steve French737b7582005-04-28 22:41:06 -0700260extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
261 const struct nls_table * cp, int mapChars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
264 const __u16 netfid, const __u64 len,
265 const __u64 offset, const __u32 numUnlock,
266 const __u32 numLock, const __u8 lockType,
267 const int waitFlag);
Steve French08547b02006-02-28 22:39:25 +0000268extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
269 const __u16 smb_file_id, const int get_flag,
Steve Frenchfc94cdb2006-05-30 18:03:32 +0000270 const __u64 len, struct file_lock *,
Steve French08547b02006-02-28 22:39:25 +0000271 const __u16 lock_type, const int waitFlag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
273extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
274
275extern struct cifsSesInfo *sesInfoAlloc(void);
276extern void sesInfoFree(struct cifsSesInfo *);
277extern struct cifsTconInfo *tconInfoAlloc(void);
278extern void tconInfoFree(struct cifsTconInfo *);
279
280extern int cifs_reconnect(struct TCP_Server_Info *server);
281
Steve Frenchad009ac2005-04-28 22:41:05 -0700282extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
Steve French84afc292005-12-02 13:32:45 -0800283extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
284 __u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
286 __u32 expected_sequence_number);
287extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
288extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *, struct nls_table *);
289extern void CalcNTLMv2_response(const struct cifsSesInfo *,char * );
290extern int CIFSSMBCopy(int xid,
291 struct cifsTconInfo *source_tcon,
292 const char *fromName,
293 const __u16 target_tid,
294 const char *toName, const int flags,
Steve French737b7582005-04-28 22:41:06 -0700295 const struct nls_table *nls_codepage,
296 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700298 const int notify_subdirs,const __u16 netfid,
Steve French167a2512005-08-24 20:03:11 -0700299 __u32 filter, struct file * file, int multishot,
300 const struct nls_table *nls_codepage);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
302 const unsigned char *searchName, char * EAData,
Steve French737b7582005-04-28 22:41:06 -0700303 size_t bufsize, const struct nls_table *nls_codepage,
304 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
306 const unsigned char * searchName,const unsigned char * ea_name,
307 unsigned char * ea_value, size_t buf_size,
Steve French737b7582005-04-28 22:41:06 -0700308 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
310 const char *fileName, const char * ea_name,
311 const void * ea_value, const __u16 ea_value_len,
Steve French737b7582005-04-28 22:41:06 -0700312 const struct nls_table *nls_codepage, int remap_special_chars);
Steve French0a4b92c2006-01-12 15:44:21 -0800313extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
314 __u16 fid, char *acl_inf, const int buflen,
315 const int acl_type /* ACCESS vs. DEFAULT */);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
317 const unsigned char *searchName,
318 char *acl_inf, const int buflen,const int acl_type,
Steve French737b7582005-04-28 22:41:06 -0700319 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
321 const unsigned char *fileName,
322 const char *local_acl, const int buflen, const int acl_type,
Steve French737b7582005-04-28 22:41:06 -0700323 const struct nls_table *nls_codepage, int remap_special_chars);
Steve Frenchf654bac2005-04-28 22:41:04 -0700324extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
325 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326#endif /* _CIFSPROTO_H */