blob: b43ac9230eabf6d450d76ff24d801e472f798ede [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/cifs/cifsproto.h
3 *
4 * Copyright (c) International Business Machines Corp., 2002,2005
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;
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));}
43extern char *build_path_from_dentry(struct dentry *);
44extern 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 *,
51 struct smb_hdr * /* input */ , int hdr_len,
52 const char * /* SMB data to send */ , int data_len,
53 int * /* bytes returned */ , const int long_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
55extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
56extern int is_valid_oplock_break(struct smb_hdr *smb);
57extern int is_size_safe_to_change(struct cifsInodeInfo *);
58extern unsigned int smbCalcSize(struct smb_hdr *ptr);
59extern int decode_negTokenInit(unsigned char *security_blob, int length,
60 enum securityEnum *secType);
61extern int cifs_inet_pton(int, char * source, void *dst);
62extern int map_smb_to_linux_error(struct smb_hdr *smb);
63extern void header_assemble(struct smb_hdr *, char /* command */ ,
Steve French737b7582005-04-28 22:41:06 -070064 const struct cifsTconInfo *, int /* specifies length
65 of fixed section (word count) in two byte units */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 );
Steve French737b7582005-04-28 22:41:06 -070067extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16,
68 struct cifsTconInfo *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069extern void DeleteOplockQEntry(struct oplock_q_entry *);
70extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
71extern u64 cifs_UnixTimeToNT(struct timespec);
72extern int cifs_get_inode_info(struct inode **pinode,
73 const unsigned char *search_path,
74 FILE_ALL_INFO * pfile_info,
75 struct super_block *sb, int xid);
76extern int cifs_get_inode_info_unix(struct inode **pinode,
77 const unsigned char *search_path,
78 struct super_block *sb,int xid);
79
80extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
81 const char *);
82extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
83void cifs_proc_init(void);
84void cifs_proc_clean(void);
85
86extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
87 struct nls_table * nls_info);
88extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
89
90extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
91 const char *tree, struct cifsTconInfo *tcon,
92 const struct nls_table *);
93
94extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
95 const char *searchName, const struct nls_table *nls_codepage,
Steve French737b7582005-04-28 22:41:06 -070096 __u16 *searchHandle, struct cifs_search_info * psrch_inf, int map);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
98extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
99 __u16 searchHandle, struct cifs_search_info * psrch_inf);
100
101extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
102 const __u16 search_handle);
103
104extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
105 const unsigned char *searchName,
106 FILE_ALL_INFO * findData,
Steve French737b7582005-04-28 22:41:06 -0700107 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109extern int CIFSSMBUnixQPathInfo(const int xid,
110 struct cifsTconInfo *tcon,
111 const unsigned char *searchName,
112 FILE_UNIX_BASIC_INFO * pFindData,
Steve French737b7582005-04-28 22:41:06 -0700113 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114
115extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
116 const unsigned char *searchName,
117 unsigned char **targetUNCs,
118 unsigned int *number_of_UNC_in_array,
Steve French737b7582005-04-28 22:41:06 -0700119 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
122 const char *old_path,
Steve French737b7582005-04-28 22:41:06 -0700123 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
Steve French737b7582005-04-28 22:41:06 -0700125 const char *old_path,
126 const struct nls_table *nls_codepage,
127 unsigned int *pnum_referrals,
128 unsigned char ** preferrals,
129 int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700131 struct kstatfs *FSData);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132extern int CIFSSMBQFSAttributeInfo(const int xid,
Steve French737b7582005-04-28 22:41:06 -0700133 struct cifsTconInfo *tcon);
134extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
135extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700137 struct kstatfs *FSData);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
140 const char *fileName, const FILE_BASIC_INFO * data,
Steve French737b7582005-04-28 22:41:06 -0700141 const struct nls_table *nls_codepage,
142 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
144 const FILE_BASIC_INFO * data, __u16 fid);
145#if 0
146extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
147 char *fileName, __u16 dos_attributes,
148 const struct nls_table *nls_codepage);
149#endif /* possibly unneeded function */
150extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700151 const char *fileName, __u64 size,
152 int setAllocationSizeFlag,
153 const struct nls_table *nls_codepage,
154 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700156 __u64 size, __u16 fileHandle,__u32 opener_pid,
157 int AllocSizeFlag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
159 char *full_path, __u64 mode, __u64 uid,
Steve French737b7582005-04-28 22:41:06 -0700160 __u64 gid, dev_t dev,
161 const struct nls_table *nls_codepage,
162 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
165 const char *newName,
Steve French737b7582005-04-28 22:41:06 -0700166 const struct nls_table *nls_codepage,
167 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700169 const char *name, const struct nls_table *nls_codepage,
170 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
172extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
173 const char *name,
Steve French737b7582005-04-28 22:41:06 -0700174 const struct nls_table *nls_codepage,
175 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
177 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700178 const struct nls_table *nls_codepage,
179 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180extern int CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
Steve French737b7582005-04-28 22:41:06 -0700181 int netfid, char * target_name,
182 const struct nls_table *nls_codepage,
183 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184extern int CIFSCreateHardLink(const int xid,
185 struct cifsTconInfo *tcon,
186 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700187 const struct nls_table *nls_codepage,
188 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189extern int CIFSUnixCreateHardLink(const int xid,
190 struct cifsTconInfo *tcon,
191 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700192 const struct nls_table *nls_codepage,
193 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194extern int CIFSUnixCreateSymLink(const int xid,
195 struct cifsTconInfo *tcon,
196 const char *fromName, const char *toName,
197 const struct nls_table *nls_codepage);
198extern int CIFSSMBUnixQuerySymLink(const int xid,
199 struct cifsTconInfo *tcon,
200 const unsigned char *searchName,
201 char *syminfo, const int buflen,
202 const struct nls_table *nls_codepage);
203extern int CIFSSMBQueryReparseLinkInfo(const int xid,
204 struct cifsTconInfo *tcon,
205 const unsigned char *searchName,
206 char *symlinkinfo, const int buflen, __u16 fid,
207 const struct nls_table *nls_codepage);
208
209extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
210 const char *fileName, const int disposition,
211 const int access_flags, const int omode,
212 __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
Steve French737b7582005-04-28 22:41:06 -0700213 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
215 const int smb_file_id);
216
217extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
218 const int netfid, unsigned int count,
219 const __u64 lseek, unsigned int *nbytes, char **buf);
220extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
221 const int netfid, const unsigned int count,
222 const __u64 lseek, unsigned int *nbytes,
223 const char *buf, const char __user *ubuf,
224 const int long_op);
225#ifdef CONFIG_CIFS_EXPERIMENTAL
226extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
227 const int netfid, const unsigned int count,
228 const __u64 offset, unsigned int *nbytes,
Steve Frenchd6e04ae2005-06-13 13:24:43 -0500229 const char *buf,const int long_op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
231 const unsigned char *searchName, __u64 * inode_number,
Steve French737b7582005-04-28 22:41:06 -0700232 const struct nls_table *nls_codepage,
233 int remap_special_chars);
234#endif /* CONFIG_CIFS_EXPERIMENTAL */
Steve Frenchb1a45692005-05-17 16:07:23 -0500235extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
Steve French6a0b4822005-04-28 22:41:05 -0700236 const struct nls_table * codepage);
Steve French737b7582005-04-28 22:41:06 -0700237extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
238 const struct nls_table * cp, int mapChars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
240extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
241 const __u16 netfid, const __u64 len,
242 const __u64 offset, const __u32 numUnlock,
243 const __u32 numLock, const __u8 lockType,
244 const int waitFlag);
245
246extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
247extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
248
249extern struct cifsSesInfo *sesInfoAlloc(void);
250extern void sesInfoFree(struct cifsSesInfo *);
251extern struct cifsTconInfo *tconInfoAlloc(void);
252extern void tconInfoFree(struct cifsTconInfo *);
253
254extern int cifs_reconnect(struct TCP_Server_Info *server);
255
Steve Frenchad009ac2005-04-28 22:41:05 -0700256extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
258 __u32 expected_sequence_number);
259extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
260extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *, struct nls_table *);
261extern void CalcNTLMv2_response(const struct cifsSesInfo *,char * );
262extern int CIFSSMBCopy(int xid,
263 struct cifsTconInfo *source_tcon,
264 const char *fromName,
265 const __u16 target_tid,
266 const char *toName, const int flags,
Steve French737b7582005-04-28 22:41:06 -0700267 const struct nls_table *nls_codepage,
268 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700270 const int notify_subdirs,const __u16 netfid,
271 __u32 filter, const struct nls_table *nls_codepage);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
273 const unsigned char *searchName, char * EAData,
Steve French737b7582005-04-28 22:41:06 -0700274 size_t bufsize, const struct nls_table *nls_codepage,
275 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
277 const unsigned char * searchName,const unsigned char * ea_name,
278 unsigned char * ea_value, size_t buf_size,
Steve French737b7582005-04-28 22:41:06 -0700279 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
281 const char *fileName, const char * ea_name,
282 const void * ea_value, const __u16 ea_value_len,
Steve French737b7582005-04-28 22:41:06 -0700283 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
285 const unsigned char *searchName,
286 char *acl_inf, const int buflen,const int acl_type,
Steve French737b7582005-04-28 22:41:06 -0700287 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
289 const unsigned char *fileName,
290 const char *local_acl, const int buflen, const int acl_type,
Steve French737b7582005-04-28 22:41:06 -0700291 const struct nls_table *nls_codepage, int remap_special_chars);
Steve Frenchf654bac2005-04-28 22:41:04 -0700292extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
293 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294#endif /* _CIFSPROTO_H */