cifsproto.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. /*
  2. * fs/cifs/cifsproto.h
  3. *
  4. * Copyright (c) International Business Machines Corp., 2002,2007
  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. struct statfs;
  25. struct smb_vol;
  26. /*
  27. *****************************************************************
  28. * All Prototypes
  29. *****************************************************************
  30. */
  31. extern struct smb_hdr *cifs_buf_get(void);
  32. extern void cifs_buf_release(void *);
  33. extern struct smb_hdr *cifs_small_buf_get(void);
  34. extern void cifs_small_buf_release(void *);
  35. extern int smb_send(struct socket *, struct smb_hdr *,
  36. unsigned int /* length */ , struct sockaddr *);
  37. extern unsigned int _GetXid(void);
  38. extern void _FreeXid(unsigned int);
  39. #define GetXid() (int)_GetXid(); cFYI(1,("CIFS VFS: in %s as Xid: %d with uid: %d",__FUNCTION__, xid,current->fsuid));
  40. #define FreeXid(curr_xid) {_FreeXid(curr_xid); cFYI(1,("CIFS VFS: leaving %s (xid = %d) rc = %d",__FUNCTION__,curr_xid,(int)rc));}
  41. extern char *build_path_from_dentry(struct dentry *);
  42. extern char *build_wildcard_path_from_dentry(struct dentry *direntry);
  43. /* extern void renew_parental_timestamps(struct dentry *direntry);*/
  44. extern int SendReceive(const unsigned int /* xid */ , struct cifsSesInfo *,
  45. struct smb_hdr * /* input */ ,
  46. struct smb_hdr * /* out */ ,
  47. int * /* bytes returned */ , const int long_op);
  48. extern int SendReceive2(const unsigned int /* xid */ , struct cifsSesInfo *,
  49. struct kvec *, int /* nvec to send */,
  50. int * /* type of buf returned */ , const int long_op,
  51. const int logError /* whether to log status code*/ );
  52. extern int SendReceiveBlockingLock(const unsigned int /* xid */ ,
  53. struct cifsTconInfo *,
  54. struct smb_hdr * /* input */ ,
  55. struct smb_hdr * /* out */ ,
  56. int * /* bytes returned */);
  57. extern int checkSMB(struct smb_hdr *smb, __u16 mid, unsigned int length);
  58. extern int is_valid_oplock_break(struct smb_hdr *smb, struct TCP_Server_Info *);
  59. extern int is_size_safe_to_change(struct cifsInodeInfo *, __u64 eof);
  60. extern struct cifsFileInfo *find_writable_file(struct cifsInodeInfo *);
  61. #ifdef CONFIG_CIFS_EXPERIMENTAL
  62. extern struct cifsFileInfo *find_readable_file(struct cifsInodeInfo *);
  63. #endif
  64. extern unsigned int smbCalcSize(struct smb_hdr *ptr);
  65. extern unsigned int smbCalcSize_LE(struct smb_hdr *ptr);
  66. extern int decode_negTokenInit(unsigned char *security_blob, int length,
  67. enum securityEnum *secType);
  68. extern int cifs_inet_pton(int, char *source, void *dst);
  69. extern int map_smb_to_linux_error(struct smb_hdr *smb, int logErr);
  70. extern void header_assemble(struct smb_hdr *, char /* command */ ,
  71. const struct cifsTconInfo *, int /* length of
  72. fixed section (word count) in two byte units */);
  73. extern int small_smb_init_no_tc(const int smb_cmd, const int wct,
  74. struct cifsSesInfo *ses,
  75. void **request_buf);
  76. extern int CIFS_SessSetup(unsigned int xid, struct cifsSesInfo *ses,
  77. const int stage,
  78. const struct nls_table *nls_cp);
  79. extern __u16 GetNextMid(struct TCP_Server_Info *server);
  80. extern struct oplock_q_entry *AllocOplockQEntry(struct inode *, u16,
  81. struct cifsTconInfo *);
  82. extern void DeleteOplockQEntry(struct oplock_q_entry *);
  83. extern struct timespec cifs_NTtimeToUnix(u64 /* utc nanoseconds since 1601 */ );
  84. extern u64 cifs_UnixTimeToNT(struct timespec);
  85. extern __le64 cnvrtDosCifsTm(__u16 date, __u16 time);
  86. extern struct timespec cnvrtDosUnixTm(__u16 date, __u16 time);
  87. extern int cifs_get_inode_info(struct inode **pinode,
  88. const unsigned char *search_path,
  89. FILE_ALL_INFO * pfile_info,
  90. struct super_block *sb, int xid);
  91. extern int cifs_get_inode_info_unix(struct inode **pinode,
  92. const unsigned char *search_path,
  93. struct super_block *sb, int xid);
  94. extern void acl_to_uid_mode(struct inode *inode, const char *search_path);
  95. extern int cifs_mount(struct super_block *, struct cifs_sb_info *, char *,
  96. const char *);
  97. extern int cifs_umount(struct super_block *, struct cifs_sb_info *);
  98. void cifs_proc_init(void);
  99. void cifs_proc_clean(void);
  100. extern int cifs_setup_session(unsigned int xid, struct cifsSesInfo *pSesInfo,
  101. struct nls_table *nls_info);
  102. extern int CIFSSMBNegotiate(unsigned int xid, struct cifsSesInfo *ses);
  103. extern int CIFSTCon(unsigned int xid, struct cifsSesInfo *ses,
  104. const char *tree, struct cifsTconInfo *tcon,
  105. const struct nls_table *);
  106. extern int CIFSFindFirst(const int xid, struct cifsTconInfo *tcon,
  107. const char *searchName, const struct nls_table *nls_codepage,
  108. __u16 *searchHandle, struct cifs_search_info *psrch_inf,
  109. int map, const char dirsep);
  110. extern int CIFSFindNext(const int xid, struct cifsTconInfo *tcon,
  111. __u16 searchHandle, struct cifs_search_info *psrch_inf);
  112. extern int CIFSFindClose(const int, struct cifsTconInfo *tcon,
  113. const __u16 search_handle);
  114. extern int CIFSSMBQPathInfo(const int xid, struct cifsTconInfo *tcon,
  115. const unsigned char *searchName,
  116. FILE_ALL_INFO * findData,
  117. int legacy /* whether to use old info level */,
  118. const struct nls_table *nls_codepage, int remap);
  119. extern int SMBQueryInformation(const int xid, struct cifsTconInfo *tcon,
  120. const unsigned char *searchName,
  121. FILE_ALL_INFO *findData,
  122. const struct nls_table *nls_codepage, int remap);
  123. extern int CIFSSMBUnixQPathInfo(const int xid,
  124. struct cifsTconInfo *tcon,
  125. const unsigned char *searchName,
  126. FILE_UNIX_BASIC_INFO * pFindData,
  127. const struct nls_table *nls_codepage, int remap);
  128. extern int CIFSGetDFSRefer(const int xid, struct cifsSesInfo *ses,
  129. const unsigned char *searchName,
  130. unsigned char **targetUNCs,
  131. unsigned int *number_of_UNC_in_array,
  132. const struct nls_table *nls_codepage, int remap);
  133. extern int connect_to_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
  134. const char *old_path,
  135. const struct nls_table *nls_codepage, int remap);
  136. extern int get_dfs_path(int xid, struct cifsSesInfo *pSesInfo,
  137. const char *old_path,
  138. const struct nls_table *nls_codepage,
  139. unsigned int *pnum_referrals,
  140. unsigned char **preferrals,
  141. int remap);
  142. extern void reset_cifs_unix_caps(int xid, struct cifsTconInfo *tcon,
  143. struct super_block *sb, struct smb_vol *vol);
  144. extern int CIFSSMBQFSInfo(const int xid, struct cifsTconInfo *tcon,
  145. struct kstatfs *FSData);
  146. extern int SMBOldQFSInfo(const int xid, struct cifsTconInfo *tcon,
  147. struct kstatfs *FSData);
  148. extern int CIFSSMBSetFSUnixInfo(const int xid, struct cifsTconInfo *tcon,
  149. __u64 cap);
  150. extern int CIFSSMBQFSAttributeInfo(const int xid,
  151. struct cifsTconInfo *tcon);
  152. extern int CIFSSMBQFSDeviceInfo(const int xid, struct cifsTconInfo *tcon);
  153. extern int CIFSSMBQFSUnixInfo(const int xid, struct cifsTconInfo *tcon);
  154. extern int CIFSSMBQFSPosixInfo(const int xid, struct cifsTconInfo *tcon,
  155. struct kstatfs *FSData);
  156. extern int CIFSSMBSetTimes(const int xid, struct cifsTconInfo *tcon,
  157. const char *fileName, const FILE_BASIC_INFO * data,
  158. const struct nls_table *nls_codepage,
  159. int remap_special_chars);
  160. extern int CIFSSMBSetFileTimes(const int xid, struct cifsTconInfo *tcon,
  161. const FILE_BASIC_INFO * data, __u16 fid);
  162. #if 0
  163. extern int CIFSSMBSetAttrLegacy(int xid, struct cifsTconInfo *tcon,
  164. char *fileName, __u16 dos_attributes,
  165. const struct nls_table *nls_codepage);
  166. #endif /* possibly unneeded function */
  167. extern int CIFSSMBSetEOF(const int xid, struct cifsTconInfo *tcon,
  168. const char *fileName, __u64 size,
  169. int setAllocationSizeFlag,
  170. const struct nls_table *nls_codepage,
  171. int remap_special_chars);
  172. extern int CIFSSMBSetFileSize(const int xid, struct cifsTconInfo *tcon,
  173. __u64 size, __u16 fileHandle, __u32 opener_pid,
  174. int AllocSizeFlag);
  175. extern int CIFSSMBUnixSetPerms(const int xid, struct cifsTconInfo *pTcon,
  176. char *full_path, __u64 mode, __u64 uid,
  177. __u64 gid, dev_t dev,
  178. const struct nls_table *nls_codepage,
  179. int remap_special_chars);
  180. extern int CIFSSMBMkDir(const int xid, struct cifsTconInfo *tcon,
  181. const char *newName,
  182. const struct nls_table *nls_codepage,
  183. int remap_special_chars);
  184. extern int CIFSSMBRmDir(const int xid, struct cifsTconInfo *tcon,
  185. const char *name, const struct nls_table *nls_codepage,
  186. int remap_special_chars);
  187. extern int CIFSPOSIXDelFile(const int xid, struct cifsTconInfo *tcon,
  188. const char *name, __u16 type,
  189. const struct nls_table *nls_codepage,
  190. int remap_special_chars);
  191. extern int CIFSSMBDelFile(const int xid, struct cifsTconInfo *tcon,
  192. const char *name,
  193. const struct nls_table *nls_codepage,
  194. int remap_special_chars);
  195. extern int CIFSSMBRename(const int xid, struct cifsTconInfo *tcon,
  196. const char *fromName, const char *toName,
  197. const struct nls_table *nls_codepage,
  198. int remap_special_chars);
  199. extern int CIFSSMBRenameOpenFile(const int xid, struct cifsTconInfo *pTcon,
  200. int netfid, char *target_name,
  201. const struct nls_table *nls_codepage,
  202. int remap_special_chars);
  203. extern int CIFSCreateHardLink(const int xid,
  204. struct cifsTconInfo *tcon,
  205. const char *fromName, const char *toName,
  206. const struct nls_table *nls_codepage,
  207. int remap_special_chars);
  208. extern int CIFSUnixCreateHardLink(const int xid,
  209. struct cifsTconInfo *tcon,
  210. const char *fromName, const char *toName,
  211. const struct nls_table *nls_codepage,
  212. int remap_special_chars);
  213. extern int CIFSUnixCreateSymLink(const int xid,
  214. struct cifsTconInfo *tcon,
  215. const char *fromName, const char *toName,
  216. const struct nls_table *nls_codepage);
  217. extern 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);
  222. extern 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. extern int CIFSSMBOpen(const int xid, struct cifsTconInfo *tcon,
  228. const char *fileName, const int disposition,
  229. const int access_flags, const int omode,
  230. __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
  231. const struct nls_table *nls_codepage, int remap);
  232. extern int SMBLegacyOpen(const int xid, struct cifsTconInfo *tcon,
  233. const char *fileName, const int disposition,
  234. const int access_flags, const int omode,
  235. __u16 * netfid, int *pOplock, FILE_ALL_INFO *,
  236. const struct nls_table *nls_codepage, int remap);
  237. extern int CIFSPOSIXCreate(const int xid, struct cifsTconInfo *tcon,
  238. u32 posix_flags, __u64 mode, __u16 * netfid,
  239. FILE_UNIX_BASIC_INFO *pRetData,
  240. __u32 *pOplock, const char *name,
  241. const struct nls_table *nls_codepage, int remap);
  242. extern int CIFSSMBClose(const int xid, struct cifsTconInfo *tcon,
  243. const int smb_file_id);
  244. extern int CIFSSMBRead(const int xid, struct cifsTconInfo *tcon,
  245. const int netfid, unsigned int count,
  246. const __u64 lseek, unsigned int *nbytes, char **buf,
  247. int *return_buf_type);
  248. extern int CIFSSMBWrite(const int xid, struct cifsTconInfo *tcon,
  249. const int netfid, const unsigned int count,
  250. const __u64 lseek, unsigned int *nbytes,
  251. const char *buf, const char __user *ubuf,
  252. const int long_op);
  253. extern int CIFSSMBWrite2(const int xid, struct cifsTconInfo *tcon,
  254. const int netfid, const unsigned int count,
  255. const __u64 offset, unsigned int *nbytes,
  256. struct kvec *iov, const int nvec, const int long_op);
  257. extern int CIFSGetSrvInodeNumber(const int xid, struct cifsTconInfo *tcon,
  258. const unsigned char *searchName, __u64 * inode_number,
  259. const struct nls_table *nls_codepage,
  260. int remap_special_chars);
  261. extern int cifs_convertUCSpath(char *target, const __le16 *source, int maxlen,
  262. const struct nls_table *codepage);
  263. extern int cifsConvertToUCS(__le16 *target, const char *source, int maxlen,
  264. const struct nls_table *cp, int mapChars);
  265. extern int CIFSSMBLock(const int xid, struct cifsTconInfo *tcon,
  266. const __u16 netfid, const __u64 len,
  267. const __u64 offset, const __u32 numUnlock,
  268. const __u32 numLock, const __u8 lockType,
  269. const int waitFlag);
  270. extern int CIFSSMBPosixLock(const int xid, struct cifsTconInfo *tcon,
  271. const __u16 smb_file_id, const int get_flag,
  272. const __u64 len, struct file_lock *,
  273. const __u16 lock_type, const int waitFlag);
  274. extern int CIFSSMBTDis(const int xid, struct cifsTconInfo *tcon);
  275. extern int CIFSSMBLogoff(const int xid, struct cifsSesInfo *ses);
  276. extern struct cifsSesInfo *sesInfoAlloc(void);
  277. extern void sesInfoFree(struct cifsSesInfo *);
  278. extern struct cifsTconInfo *tconInfoAlloc(void);
  279. extern void tconInfoFree(struct cifsTconInfo *);
  280. extern int cifs_sign_smb(struct smb_hdr *, struct TCP_Server_Info *, __u32 *);
  281. extern int cifs_sign_smb2(struct kvec *iov, int n_vec, struct TCP_Server_Info *,
  282. __u32 *);
  283. extern int cifs_verify_signature(struct smb_hdr *,
  284. const struct mac_key *mac_key,
  285. __u32 expected_sequence_number);
  286. extern int cifs_calculate_mac_key(struct mac_key *key, const char *rn,
  287. const char *pass);
  288. extern int CalcNTLMv2_partial_mac_key(struct cifsSesInfo *,
  289. const struct nls_table *);
  290. extern void CalcNTLMv2_response(const struct cifsSesInfo *, char *);
  291. extern void setup_ntlmv2_rsp(struct cifsSesInfo *, char *,
  292. const struct nls_table *);
  293. #ifdef CONFIG_CIFS_WEAK_PW_HASH
  294. extern void calc_lanman_hash(struct cifsSesInfo *ses, char *lnm_session_key);
  295. #endif /* CIFS_WEAK_PW_HASH */
  296. extern int CIFSSMBCopy(int xid,
  297. struct cifsTconInfo *source_tcon,
  298. const char *fromName,
  299. const __u16 target_tid,
  300. const char *toName, const int flags,
  301. const struct nls_table *nls_codepage,
  302. int remap_special_chars);
  303. extern int CIFSSMBNotify(const int xid, struct cifsTconInfo *tcon,
  304. const int notify_subdirs, const __u16 netfid,
  305. __u32 filter, struct file *file, int multishot,
  306. const struct nls_table *nls_codepage);
  307. extern ssize_t CIFSSMBQAllEAs(const int xid, struct cifsTconInfo *tcon,
  308. const unsigned char *searchName, char *EAData,
  309. size_t bufsize, const struct nls_table *nls_codepage,
  310. int remap_special_chars);
  311. extern ssize_t CIFSSMBQueryEA(const int xid, struct cifsTconInfo *tcon,
  312. const unsigned char *searchName, const unsigned char *ea_name,
  313. unsigned char *ea_value, size_t buf_size,
  314. const struct nls_table *nls_codepage, int remap_special_chars);
  315. extern int CIFSSMBSetEA(const int xid, struct cifsTconInfo *tcon,
  316. const char *fileName, const char *ea_name,
  317. const void *ea_value, const __u16 ea_value_len,
  318. const struct nls_table *nls_codepage, int remap_special_chars);
  319. extern int CIFSSMBGetCIFSACL(const int xid, struct cifsTconInfo *tcon,
  320. __u16 fid, struct cifs_ntsd **acl_inf, __u32 *buflen);
  321. extern int CIFSSMBGetPosixACL(const int xid, struct cifsTconInfo *tcon,
  322. const unsigned char *searchName,
  323. char *acl_inf, const int buflen, const int acl_type,
  324. const struct nls_table *nls_codepage, int remap_special_chars);
  325. extern int CIFSSMBSetPosixACL(const int xid, struct cifsTconInfo *tcon,
  326. const unsigned char *fileName,
  327. const char *local_acl, const int buflen, const int acl_type,
  328. const struct nls_table *nls_codepage, int remap_special_chars);
  329. extern int CIFSGetExtAttr(const int xid, struct cifsTconInfo *tcon,
  330. const int netfid, __u64 * pExtAttrBits, __u64 *pMask);
  331. #endif /* _CIFSPROTO_H */