Loading...
Note: File does not exist in v6.13.7.
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 int init_cifs_idmap(void);
57extern void exit_cifs_idmap(void);
58extern void cifs_destroy_idmaptrees(void);
59extern char *build_path_from_dentry(struct dentry *);
60extern char *cifs_build_path_to_root(struct smb_vol *vol,
61 struct cifs_sb_info *cifs_sb,
62 struct cifs_tcon *tcon);
63extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
64extern char *cifs_compose_mount_options(const char *sb_mountdata,
65 const char *fullpath, const struct dfs_info3_param *ref,
66 char **devname);
67/* extern void renew_parental_timestamps(struct dentry *direntry);*/
68extern struct mid_q_entry *AllocMidQEntry(const struct smb_hdr *smb_buffer,
69 struct TCP_Server_Info *server);
70extern void DeleteMidQEntry(struct mid_q_entry *midEntry);
71extern int cifs_call_async(struct TCP_Server_Info *server, struct kvec *iov,
72 unsigned int nvec, mid_callback_t *callback,
73 void *cbdata, bool ignore_pend);
74extern int SendReceive(const unsigned int /* xid */ , struct cifs_ses *,
75 struct smb_hdr * /* input */ ,
76 struct smb_hdr * /* out */ ,
77 int * /* bytes returned */ , const int long_op);
78extern int SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
79 struct smb_hdr *in_buf, int flags);
80extern int cifs_check_receive(struct mid_q_entry *mid,
81 struct TCP_Server_Info *server, bool log_error);
82extern int SendReceive2(const unsigned int /* xid */ , struct cifs_ses *,
83 struct kvec *, int /* nvec to send */,
84 int * /* type of buf returned */ , const int flags);
85extern int SendReceiveBlockingLock(const unsigned int xid,
86 struct cifs_tcon *ptcon,
87 struct smb_hdr *in_buf ,
88 struct smb_hdr *out_buf,
89 int *bytes_returned);
90extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
91extern bool is_valid_oplock_break(struct smb_hdr *smb,
92 struct TCP_Server_Info *);
93extern bool is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
94extern void cifs_update_eof(struct cifsInodeInfo *cifsi, loff_t offset,
95 unsigned int bytes_written);
96extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *, bool);
97extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *, bool);
98extern unsigned int smbCalcSize(struct smb_hdr *ptr);
99extern int decode_negTokenInit(unsigned char *security_blob, int length,
100 struct TCP_Server_Info *server);
101extern int cifs_convert_address(struct sockaddr *dst, const char *src, int len);
102extern int cifs_set_port(struct sockaddr *addr, const unsigned short int port);
103extern int cifs_fill_sockaddr(struct sockaddr *dst, const char *src, int len,
104 const unsigned short int port);
105extern int map_smb_to_linux_error(struct smb_hdr *smb, bool logErr);
106extern void header_assemble(struct smb_hdr *, char /* command */ ,
107 const struct cifs_tcon *, int /* length of
108 fixed section (word count) in two byte units */);
109extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
110 struct cifs_ses *ses,
111 void **request_buf);
112extern int CIFS_SessSetup(unsigned int xid, struct cifs_ses *ses,
113 const struct nls_table *nls_cp);
114extern __u16 GetNextMid(struct TCP_Server_Info *server);
115extern struct timespec cifs_NTtimeToUnix(__le64 utc_nanoseconds_since_1601);
116extern u64 cifs_UnixTimeToNT(struct timespec);
117extern struct timespec cnvrtDosUnixTm(__le16 le_date, __le16 le_time,
118 int offset);
119extern void cifs_set_oplock_level(struct cifsInodeInfo *cinode, __u32 oplock);
120
121extern struct cifsFileInfo *cifs_new_fileinfo(__u16 fileHandle,
122 struct file *file, struct tcon_link *tlink,
123 __u32 oplock);
124extern int cifs_posix_open(char *full_path, struct inode **pinode,
125 struct super_block *sb,
126 int mode, unsigned int f_flags,
127 __u32 *poplock, __u16 *pnetfid, int xid);
128void cifs_fill_uniqueid(struct super_block *sb, struct cifs_fattr *fattr);
129extern void cifs_unix_basic_to_fattr(struct cifs_fattr *fattr,
130 FILE_UNIX_BASIC_INFO *info,
131 struct cifs_sb_info *cifs_sb);
132extern void cifs_fattr_to_inode(struct inode *inode, struct cifs_fattr *fattr);
133extern struct inode *cifs_iget(struct super_block *sb,
134 struct cifs_fattr *fattr);
135
136extern int cifs_get_file_info(struct file *filp);
137extern int cifs_get_inode_info(struct inode **pinode,
138 const unsigned char *search_path,
139 FILE_ALL_INFO *pfile_info,
140 struct super_block *sb, int xid, const __u16 *pfid);
141extern int cifs_get_file_info_unix(struct file *filp);
142extern int cifs_get_inode_info_unix(struct inode **pinode,
143 const unsigned char *search_path,
144 struct super_block *sb, int xid);
145extern int cifs_acl_to_fattr(struct cifs_sb_info *cifs_sb,
146 struct cifs_fattr *fattr, struct inode *inode,
147 const char *path, const __u16 *pfid);
148extern int mode_to_cifs_acl(struct inode *inode, const char *path, __u64);
149extern struct cifs_ntsd *get_cifs_acl(struct cifs_sb_info *, struct inode *,
150 const char *, u32 *);
151extern int set_cifs_acl(struct cifs_ntsd *, __u32, struct inode *,
152 const char *);
153
154extern void cifs_setup_cifs_sb(struct smb_vol *pvolume_info,
155 struct cifs_sb_info *cifs_sb);
156extern int cifs_match_super(struct super_block *, void *);
157extern void cifs_cleanup_volume_info(struct smb_vol *pvolume_info);
158extern struct smb_vol *cifs_get_volume_info(char *mount_data,
159 const char *devname);
160extern int cifs_mount(struct cifs_sb_info *, struct smb_vol *);
161extern void cifs_umount(struct cifs_sb_info *);
162extern void cifs_dfs_release_automount_timer(void);
163void cifs_proc_init(void);
164void cifs_proc_clean(void);
165
166extern int cifs_negotiate_protocol(unsigned int xid,
167 struct cifs_ses *ses);
168extern int cifs_setup_session(unsigned int xid, struct cifs_ses *ses,
169 struct nls_table *nls_info);
170extern int CIFSSMBNegotiate(unsigned int xid, struct cifs_ses *ses);
171
172extern int CIFSTCon(unsigned int xid, struct cifs_ses *ses,
173 const char *tree, struct cifs_tcon *tcon,
174 const struct nls_table *);
175
176extern int CIFSFindFirst(const int xid, struct cifs_tcon *tcon,
177 const char *searchName, const struct nls_table *nls_codepage,
178 __u16 *searchHandle, struct cifs_search_info *psrch_inf,
179 int map, const char dirsep);
180
181extern int CIFSFindNext(const int xid, struct cifs_tcon *tcon,
182 __u16 searchHandle, struct cifs_search_info *psrch_inf);
183
184extern int CIFSFindClose(const int, struct cifs_tcon *tcon,
185 const __u16 search_handle);
186
187extern int CIFSSMBQFileInfo(const int xid, struct cifs_tcon *tcon,
188 u16 netfid, FILE_ALL_INFO *pFindData);
189extern int CIFSSMBQPathInfo(const int xid, struct cifs_tcon *tcon,
190 const unsigned char *searchName,
191 FILE_ALL_INFO *findData,
192 int legacy /* whether to use old info level */,
193 const struct nls_table *nls_codepage, int remap);
194extern int SMBQueryInformation(const int xid, struct cifs_tcon *tcon,
195 const unsigned char *searchName,
196 FILE_ALL_INFO *findData,
197 const struct nls_table *nls_codepage, int remap);
198
199extern int CIFSSMBUnixQFileInfo(const int xid, struct cifs_tcon *tcon,
200 u16 netfid, FILE_UNIX_BASIC_INFO *pFindData);
201extern int CIFSSMBUnixQPathInfo(const int xid,
202 struct cifs_tcon *tcon,
203 const unsigned char *searchName,
204 FILE_UNIX_BASIC_INFO *pFindData,
205 const struct nls_table *nls_codepage, int remap);
206
207extern int CIFSGetDFSRefer(const int xid, struct cifs_ses *ses,
208 const unsigned char *searchName,
209 struct dfs_info3_param **target_nodes,
210 unsigned int *number_of_nodes_in_array,
211 const struct nls_table *nls_codepage, int remap);
212
213extern int get_dfs_path(int xid, struct cifs_ses *pSesInfo,
214 const char *old_path,
215 const struct nls_table *nls_codepage,
216 unsigned int *pnum_referrals,
217 struct dfs_info3_param **preferrals,
218 int remap);
219extern void reset_cifs_unix_caps(int xid, struct cifs_tcon *tcon,
220 struct cifs_sb_info *cifs_sb,
221 struct smb_vol *vol);
222extern int CIFSSMBQFSInfo(const int xid, struct cifs_tcon *tcon,
223 struct kstatfs *FSData);
224extern int SMBOldQFSInfo(const int xid, struct cifs_tcon *tcon,
225 struct kstatfs *FSData);
226extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifs_tcon *tcon,
227 __u64 cap);
228
229extern int CIFSSMBQFSAttributeInfo(const int xid,
230 struct cifs_tcon *tcon);
231extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifs_tcon *tcon);
232extern int CIFSSMBQFSUnixInfo(const int xid, struct cifs_tcon *tcon);
233extern int CIFSSMBQFSPosixInfo(const int xid, struct cifs_tcon *tcon,
234 struct kstatfs *FSData);
235
236extern int CIFSSMBSetPathInfo(const int xid, struct cifs_tcon *tcon,
237 const char *fileName, const FILE_BASIC_INFO *data,
238 const struct nls_table *nls_codepage,
239 int remap_special_chars);
240extern int CIFSSMBSetFileInfo(const int xid, struct cifs_tcon *tcon,
241 const FILE_BASIC_INFO *data, __u16 fid,
242 __u32 pid_of_opener);
243extern int CIFSSMBSetFileDisposition(const int xid, struct cifs_tcon *tcon,
244 bool delete_file, __u16 fid, __u32 pid_of_opener);
245#if 0
246extern int CIFSSMBSetAttrLegacy(int xid, struct cifs_tcon *tcon,
247 char *fileName, __u16 dos_attributes,
248 const struct nls_table *nls_codepage);
249#endif /* possibly unneeded function */
250extern int CIFSSMBSetEOF(const int xid, struct cifs_tcon *tcon,
251 const char *fileName, __u64 size,
252 bool setAllocationSizeFlag,
253 const struct nls_table *nls_codepage,
254 int remap_special_chars);
255extern int CIFSSMBSetFileSize(const int xid, struct cifs_tcon *tcon,
256 __u64 size, __u16 fileHandle, __u32 opener_pid,
257 bool AllocSizeFlag);
258
259struct cifs_unix_set_info_args {
260 __u64 ctime;
261 __u64 atime;
262 __u64 mtime;
263 __u64 mode;
264 __u64 uid;
265 __u64 gid;
266 dev_t device;
267};
268
269extern int CIFSSMBUnixSetFileInfo(const int xid, struct cifs_tcon *tcon,
270 const struct cifs_unix_set_info_args *args,
271 u16 fid, u32 pid_of_opener);
272
273extern int CIFSSMBUnixSetPathInfo(const int xid, struct cifs_tcon *pTcon,
274 char *fileName,
275 const struct cifs_unix_set_info_args *args,
276 const struct nls_table *nls_codepage,
277 int remap_special_chars);
278
279extern int CIFSSMBMkDir(const int xid, struct cifs_tcon *tcon,
280 const char *newName,
281 const struct nls_table *nls_codepage,
282 int remap_special_chars);
283extern int CIFSSMBRmDir(const int xid, struct cifs_tcon *tcon,
284 const char *name, const struct nls_table *nls_codepage,
285 int remap_special_chars);
286extern int CIFSPOSIXDelFile(const int xid, struct cifs_tcon *tcon,
287 const char *name, __u16 type,
288 const struct nls_table *nls_codepage,
289 int remap_special_chars);
290extern int CIFSSMBDelFile(const int xid, struct cifs_tcon *tcon,
291 const char *name,
292 const struct nls_table *nls_codepage,
293 int remap_special_chars);
294extern int CIFSSMBRename(const int xid, struct cifs_tcon *tcon,
295 const char *fromName, const char *toName,
296 const struct nls_table *nls_codepage,
297 int remap_special_chars);
298extern int CIFSSMBRenameOpenFile(const int xid, struct cifs_tcon *pTcon,
299 int netfid, const char *target_name,
300 const struct nls_table *nls_codepage,
301 int remap_special_chars);
302extern int CIFSCreateHardLink(const int xid,
303 struct cifs_tcon *tcon,
304 const char *fromName, const char *toName,
305 const struct nls_table *nls_codepage,
306 int remap_special_chars);
307extern int CIFSUnixCreateHardLink(const int xid,
308 struct cifs_tcon *tcon,
309 const char *fromName, const char *toName,
310 const struct nls_table *nls_codepage,
311 int remap_special_chars);
312extern int CIFSUnixCreateSymLink(const int xid,
313 struct cifs_tcon *tcon,
314 const char *fromName, const char *toName,
315 const struct nls_table *nls_codepage);
316extern int CIFSSMBUnixQuerySymLink(const int xid,
317 struct cifs_tcon *tcon,
318 const unsigned char *searchName, char **syminfo,
319 const struct nls_table *nls_codepage);
320#ifdef CONFIG_CIFS_SYMLINK_EXPERIMENTAL
321extern int CIFSSMBQueryReparseLinkInfo(const int xid,
322 struct cifs_tcon *tcon,
323 const unsigned char *searchName,
324 char *symlinkinfo, const int buflen, __u16 fid,
325 const struct nls_table *nls_codepage);
326#endif /* temporarily unused until cifs_symlink fixed */
327extern int CIFSSMBOpen(const int xid, struct cifs_tcon *tcon,
328 const char *fileName, const int disposition,
329 const int access_flags, const int omode,
330 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
331 const struct nls_table *nls_codepage, int remap);
332extern int SMBLegacyOpen(const int xid, struct cifs_tcon *tcon,
333 const char *fileName, const int disposition,
334 const int access_flags, const int omode,
335 __u16 *netfid, int *pOplock, FILE_ALL_INFO *,
336 const struct nls_table *nls_codepage, int remap);
337extern int CIFSPOSIXCreate(const int xid, struct cifs_tcon *tcon,
338 u32 posix_flags, __u64 mode, __u16 *netfid,
339 FILE_UNIX_BASIC_INFO *pRetData,
340 __u32 *pOplock, const char *name,
341 const struct nls_table *nls_codepage, int remap);
342extern int CIFSSMBClose(const int xid, struct cifs_tcon *tcon,
343 const int smb_file_id);
344
345extern int CIFSSMBFlush(const int xid, struct cifs_tcon *tcon,
346 const int smb_file_id);
347
348extern int CIFSSMBRead(const int xid, struct cifs_io_parms *io_parms,
349 unsigned int *nbytes, char **buf,
350 int *return_buf_type);
351extern int CIFSSMBWrite(const int xid, struct cifs_io_parms *io_parms,
352 unsigned int *nbytes, const char *buf,
353 const char __user *ubuf, const int long_op);
354extern int CIFSSMBWrite2(const int xid, struct cifs_io_parms *io_parms,
355 unsigned int *nbytes, struct kvec *iov, const int nvec,
356 const int long_op);
357extern int CIFSGetSrvInodeNumber(const int xid, struct cifs_tcon *tcon,
358 const unsigned char *searchName, __u64 *inode_number,
359 const struct nls_table *nls_codepage,
360 int remap_special_chars);
361
362extern int CIFSSMBLock(const int xid, struct cifs_tcon *tcon,
363 const __u16 netfid, const __u64 len,
364 const __u64 offset, const __u32 numUnlock,
365 const __u32 numLock, const __u8 lockType,
366 const bool waitFlag, const __u8 oplock_level);
367extern int CIFSSMBPosixLock(const int xid, struct cifs_tcon *tcon,
368 const __u16 smb_file_id, const int get_flag,
369 const __u64 len, struct file_lock *,
370 const __u16 lock_type, const bool waitFlag);
371extern int CIFSSMBTDis(const int xid, struct cifs_tcon *tcon);
372extern int CIFSSMBEcho(struct TCP_Server_Info *server);
373extern int CIFSSMBLogoff(const int xid, struct cifs_ses *ses);
374
375extern struct cifs_ses *sesInfoAlloc(void);
376extern void sesInfoFree(struct cifs_ses *);
377extern struct cifs_tcon *tconInfoAlloc(void);
378extern void tconInfoFree(struct cifs_tcon *);
379
380extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
381extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
382 __u32 *);
383extern int cifs_verify_signature(struct smb_hdr *,
384 struct TCP_Server_Info *server,
385 __u32 expected_sequence_number);
386extern int SMBNTencrypt(unsigned char *, unsigned char *, unsigned char *);
387extern int setup_ntlm_response(struct cifs_ses *);
388extern int setup_ntlmv2_rsp(struct cifs_ses *, const struct nls_table *);
389extern int cifs_crypto_shash_allocate(struct TCP_Server_Info *);
390extern void cifs_crypto_shash_release(struct TCP_Server_Info *);
391extern int calc_seckey(struct cifs_ses *);
392
393#ifdef CONFIG_CIFS_WEAK_PW_HASH
394extern int calc_lanman_hash(const char *password, const char *cryptkey,
395 bool encrypt, char *lnm_session_key);
396#endif /* CIFS_WEAK_PW_HASH */
397#ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
398extern int CIFSSMBNotify(const int xid, struct cifs_tcon *tcon,
399 const int notify_subdirs, const __u16 netfid,
400 __u32 filter, struct file *file, int multishot,
401 const struct nls_table *nls_codepage);
402#endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
403extern int CIFSSMBCopy(int xid,
404 struct cifs_tcon *source_tcon,
405 const char *fromName,
406 const __u16 target_tid,
407 const char *toName, const int flags,
408 const struct nls_table *nls_codepage,
409 int remap_special_chars);
410extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifs_tcon *tcon,
411 const unsigned char *searchName,
412 const unsigned char *ea_name, char *EAData,
413 size_t bufsize, const struct nls_table *nls_codepage,
414 int remap_special_chars);
415extern int CIFSSMBSetEA(const int xid, struct cifs_tcon *tcon,
416 const char *fileName, const char *ea_name,
417 const void *ea_value, const __u16 ea_value_len,
418 const struct nls_table *nls_codepage, int remap_special_chars);
419extern int CIFSSMBGetCIFSACL(const int xid, struct cifs_tcon *tcon,
420 __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
421extern int CIFSSMBSetCIFSACL(const int, struct cifs_tcon *, __u16,
422 struct cifs_ntsd *, __u32);
423extern int CIFSSMBGetPosixACL(const int xid, struct cifs_tcon *tcon,
424 const unsigned char *searchName,
425 char *acl_inf, const int buflen, const int acl_type,
426 const struct nls_table *nls_codepage, int remap_special_chars);
427extern int CIFSSMBSetPosixACL(const int xid, struct cifs_tcon *tcon,
428 const unsigned char *fileName,
429 const char *local_acl, const int buflen, const int acl_type,
430 const struct nls_table *nls_codepage, int remap_special_chars);
431extern int CIFSGetExtAttr(const int xid, struct cifs_tcon *tcon,
432 const int netfid, __u64 *pExtAttrBits, __u64 *pMask);
433extern void cifs_autodisable_serverino(struct cifs_sb_info *cifs_sb);
434extern bool CIFSCouldBeMFSymlink(const struct cifs_fattr *fattr);
435extern int CIFSCheckMFSymlink(struct cifs_fattr *fattr,
436 const unsigned char *path,
437 struct cifs_sb_info *cifs_sb, int xid);
438extern int mdfour(unsigned char *, unsigned char *, int);
439extern int E_md4hash(const unsigned char *passwd, unsigned char *p16);
440extern int SMBencrypt(unsigned char *passwd, const unsigned char *c8,
441 unsigned char *p24);
442
443/* asynchronous write support */
444struct cifs_writedata {
445 struct kref refcount;
446 enum writeback_sync_modes sync_mode;
447 struct work_struct work;
448 struct cifsFileInfo *cfile;
449 __u64 offset;
450 unsigned int bytes;
451 int result;
452 unsigned int nr_pages;
453 struct page *pages[1];
454};
455
456int cifs_async_writev(struct cifs_writedata *wdata);
457struct cifs_writedata *cifs_writedata_alloc(unsigned int nr_pages);
458void cifs_writedata_release(struct kref *refcount);
459
460#endif /* _CIFSPROTO_H */