blob: ea239dea571e1f0a02374079ca0e918bf072cb01 [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);
50extern int checkSMBhdr(struct smb_hdr *smb, __u16 mid);
51extern int checkSMB(struct smb_hdr *smb, __u16 mid, int length);
52extern int is_valid_oplock_break(struct smb_hdr *smb);
53extern int is_size_safe_to_change(struct cifsInodeInfo *);
54extern unsigned int smbCalcSize(struct smb_hdr *ptr);
55extern int decode_negTokenInit(unsigned char *security_blob, int length,
56 enum securityEnum *secType);
57extern int cifs_inet_pton(int, char * source, void *dst);
58extern int map_smb_to_linux_error(struct smb_hdr *smb);
59extern void header_assemble(struct smb_hdr *, char /* command */ ,
Steve French737b7582005-04-28 22:41:06 -070060 const struct cifsTconInfo *, int /* specifies length
61 of fixed section (word count) in two byte units */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 );
Steve French737b7582005-04-28 22:41:06 -070063extern struct oplock_q_entry * AllocOplockQEntry(struct inode *, u16,
64 struct cifsTconInfo *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065extern void DeleteOplockQEntry(struct oplock_q_entry *);
66extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
67extern u64 cifs_UnixTimeToNT(struct timespec);
68extern int cifs_get_inode_info(struct inode **pinode,
69 const unsigned char *search_path,
70 FILE_ALL_INFO * pfile_info,
71 struct super_block *sb, int xid);
72extern int cifs_get_inode_info_unix(struct inode **pinode,
73 const unsigned char *search_path,
74 struct super_block *sb,int xid);
75
76extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
77 const char *);
78extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
79void cifs_proc_init(void);
80void cifs_proc_clean(void);
81
82extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
83 struct nls_table * nls_info);
84extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
85
86extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
87 const char *tree, struct cifsTconInfo *tcon,
88 const struct nls_table *);
89
90extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
91 const char *searchName, const struct nls_table *nls_codepage,
Steve French737b7582005-04-28 22:41:06 -070092 __u16 *searchHandle, struct cifs_search_info * psrch_inf, int map);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
95 __u16 searchHandle, struct cifs_search_info * psrch_inf);
96
97extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
98 const __u16 search_handle);
99
100extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
101 const unsigned char *searchName,
102 FILE_ALL_INFO * findData,
Steve French737b7582005-04-28 22:41:06 -0700103 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105extern int CIFSSMBUnixQPathInfo(const int xid,
106 struct cifsTconInfo *tcon,
107 const unsigned char *searchName,
108 FILE_UNIX_BASIC_INFO * pFindData,
Steve French737b7582005-04-28 22:41:06 -0700109 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
112 const unsigned char *searchName,
113 unsigned char **targetUNCs,
114 unsigned int *number_of_UNC_in_array,
Steve French737b7582005-04-28 22:41:06 -0700115 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
118 const char *old_path,
Steve French737b7582005-04-28 22:41:06 -0700119 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
Steve French737b7582005-04-28 22:41:06 -0700121 const char *old_path,
122 const struct nls_table *nls_codepage,
123 unsigned int *pnum_referrals,
124 unsigned char ** preferrals,
125 int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700127 struct kstatfs *FSData);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128extern int CIFSSMBQFSAttributeInfo(const int xid,
Steve French737b7582005-04-28 22:41:06 -0700129 struct cifsTconInfo *tcon);
130extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
131extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700133 struct kstatfs *FSData);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
136 const char *fileName, const FILE_BASIC_INFO * data,
Steve French737b7582005-04-28 22:41:06 -0700137 const struct nls_table *nls_codepage,
138 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
140 const FILE_BASIC_INFO * data, __u16 fid);
141#if 0
142extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
143 char *fileName, __u16 dos_attributes,
144 const struct nls_table *nls_codepage);
145#endif /* possibly unneeded function */
146extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700147 const char *fileName, __u64 size,
148 int setAllocationSizeFlag,
149 const struct nls_table *nls_codepage,
150 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700152 __u64 size, __u16 fileHandle,__u32 opener_pid,
153 int AllocSizeFlag);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
155 char *full_path, __u64 mode, __u64 uid,
Steve French737b7582005-04-28 22:41:06 -0700156 __u64 gid, dev_t dev,
157 const struct nls_table *nls_codepage,
158 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
161 const char *newName,
Steve French737b7582005-04-28 22:41:06 -0700162 const struct nls_table *nls_codepage,
163 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700165 const char *name, const struct nls_table *nls_codepage,
166 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
169 const char *name,
Steve French737b7582005-04-28 22:41:06 -0700170 const struct nls_table *nls_codepage,
171 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
173 const char *fromName, const char *toName,
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 CIFSSMBRenameOpenFile(const int xid,struct cifsTconInfo *pTcon,
Steve French737b7582005-04-28 22:41:06 -0700177 int netfid, char * target_name,
178 const struct nls_table *nls_codepage,
179 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180extern int CIFSCreateHardLink(const int xid,
181 struct cifsTconInfo *tcon,
182 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700183 const struct nls_table *nls_codepage,
184 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185extern int CIFSUnixCreateHardLink(const int xid,
186 struct cifsTconInfo *tcon,
187 const char *fromName, const char *toName,
Steve French737b7582005-04-28 22:41:06 -0700188 const struct nls_table *nls_codepage,
189 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190extern int CIFSUnixCreateSymLink(const int xid,
191 struct cifsTconInfo *tcon,
192 const char *fromName, const char *toName,
193 const struct nls_table *nls_codepage);
194extern int CIFSSMBUnixQuerySymLink(const int xid,
195 struct cifsTconInfo *tcon,
196 const unsigned char *searchName,
197 char *syminfo, const int buflen,
198 const struct nls_table *nls_codepage);
199extern int CIFSSMBQueryReparseLinkInfo(const int xid,
200 struct cifsTconInfo *tcon,
201 const unsigned char *searchName,
202 char *symlinkinfo, const int buflen, __u16 fid,
203 const struct nls_table *nls_codepage);
204
205extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
206 const char *fileName, const int disposition,
207 const int access_flags, const int omode,
208 __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
Steve French737b7582005-04-28 22:41:06 -0700209 const struct nls_table *nls_codepage, int remap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
211 const int smb_file_id);
212
213extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
214 const int netfid, unsigned int count,
215 const __u64 lseek, unsigned int *nbytes, char **buf);
216extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
217 const int netfid, const unsigned int count,
218 const __u64 lseek, unsigned int *nbytes,
219 const char *buf, const char __user *ubuf,
220 const int long_op);
221#ifdef CONFIG_CIFS_EXPERIMENTAL
222extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
223 const int netfid, const unsigned int count,
224 const __u64 offset, unsigned int *nbytes,
225 const char __user *buf,const int long_op);
226extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
227 const unsigned char *searchName, __u64 * inode_number,
Steve French737b7582005-04-28 22:41:06 -0700228 const struct nls_table *nls_codepage,
229 int remap_special_chars);
230#endif /* CONFIG_CIFS_EXPERIMENTAL */
Steve Frenchb1a45692005-05-17 16:07:23 -0500231extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
Steve French6a0b4822005-04-28 22:41:05 -0700232 const struct nls_table * codepage);
Steve French737b7582005-04-28 22:41:06 -0700233extern int cifsConvertToUCS(__le16 * target, const char *source, int maxlen,
234 const struct nls_table * cp, int mapChars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
237 const __u16 netfid, const __u64 len,
238 const __u64 offset, const __u32 numUnlock,
239 const __u32 numLock, const __u8 lockType,
240 const int waitFlag);
241
242extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
243extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
244
245extern struct cifsSesInfo *sesInfoAlloc(void);
246extern void sesInfoFree(struct cifsSesInfo *);
247extern struct cifsTconInfo *tconInfoAlloc(void);
248extern void tconInfoFree(struct cifsTconInfo *);
249
250extern int cifs_reconnect(struct TCP_Server_Info *server);
251
Steve Frenchad009ac2005-04-28 22:41:05 -0700252extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *,__u32 *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253extern int cifs_verify_signature(struct smb_hdr *, const char * mac_key,
254 __u32 expected_sequence_number);
255extern int cifs_calculate_mac_key(char * key,const char * rn,const char * pass);
256extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *, struct nls_table *);
257extern void CalcNTLMv2_response(const struct cifsSesInfo *,char * );
258extern int CIFSSMBCopy(int xid,
259 struct cifsTconInfo *source_tcon,
260 const char *fromName,
261 const __u16 target_tid,
262 const char *toName, const int flags,
Steve French737b7582005-04-28 22:41:06 -0700263 const struct nls_table *nls_codepage,
264 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
Steve French737b7582005-04-28 22:41:06 -0700266 const int notify_subdirs,const __u16 netfid,
267 __u32 filter, const struct nls_table *nls_codepage);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
269 const unsigned char *searchName, char * EAData,
Steve French737b7582005-04-28 22:41:06 -0700270 size_t bufsize, const struct nls_table *nls_codepage,
271 int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272extern ssize_t CIFSSMBQueryEA(const int xid,struct cifsTconInfo * tcon,
273 const unsigned char * searchName,const unsigned char * ea_name,
274 unsigned char * ea_value, size_t buf_size,
Steve French737b7582005-04-28 22:41:06 -0700275 const struct nls_table *nls_codepage, int remap_special_chars);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
277 const char *fileName, const char * ea_name,
278 const void * ea_value, const __u16 ea_value_len,
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 CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
281 const unsigned char *searchName,
282 char *acl_inf, const int buflen,const int acl_type,
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 CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
285 const unsigned char *fileName,
286 const char *local_acl, 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);
Steve Frenchf654bac2005-04-28 22:41:04 -0700288extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
289 const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290#endif /* _CIFSPROTO_H */