1 /* SPDX-License-Identifier: LGPL-2.1 */ 2 /* 3 * 4 * Copyright (C) International Business Machines Corp., 2002,2008 5 * Author(s): Steve French (sfrench@us.ibm.com) 6 * Jeremy Allison (jra@samba.org) 7 * 8 */ 9 #ifndef _CIFS_GLOB_H 10 #define _CIFS_GLOB_H 11 12 #include <linux/in.h> 13 #include <linux/in6.h> 14 #include <linux/inet.h> 15 #include <linux/slab.h> 16 #include <linux/scatterlist.h> 17 #include <linux/mm.h> 18 #include <linux/mempool.h> 19 #include <linux/workqueue.h> 20 #include <linux/utsname.h> 21 #include <linux/sched/mm.h> 22 #include <linux/netfs.h> 23 #include "cifs_fs_sb.h" 24 #include "cifsacl.h" 25 #include <crypto/internal/hash.h> 26 #include <uapi/linux/cifs/cifs_mount.h> 27 #include "../common/smb2pdu.h" 28 #include "smb2pdu.h" 29 #include <linux/filelock.h> 30 31 #define SMB_PATH_MAX 260 32 #define CIFS_PORT 445 33 #define RFC1001_PORT 139 34 35 /* 36 * The sizes of various internal tables and strings 37 */ 38 #define MAX_UID_INFO 16 39 #define MAX_SES_INFO 2 40 #define MAX_TCON_INFO 4 41 42 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1) 43 44 #define CIFS_MIN_RCV_POOL 4 45 46 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */ 47 /* 48 * default attribute cache timeout (jiffies) 49 */ 50 #define CIFS_DEF_ACTIMEO (1 * HZ) 51 52 /* 53 * max sleep time before retry to server 54 */ 55 #define CIFS_MAX_SLEEP 2000 56 57 /* 58 * max attribute cache timeout (jiffies) - 2^30 59 */ 60 #define CIFS_MAX_ACTIMEO (1 << 30) 61 62 /* 63 * Max persistent and resilient handle timeout (milliseconds). 64 * Windows durable max was 960000 (16 minutes) 65 */ 66 #define SMB3_MAX_HANDLE_TIMEOUT 960000 67 68 /* 69 * MAX_REQ is the maximum number of requests that WE will send 70 * on one socket concurrently. 71 */ 72 #define CIFS_MAX_REQ 32767 73 74 #define RFC1001_NAME_LEN 15 75 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1) 76 77 /* maximum length of ip addr as a string (including ipv6 and sctp) */ 78 #define SERVER_NAME_LENGTH 80 79 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1) 80 81 /* echo interval in seconds */ 82 #define SMB_ECHO_INTERVAL_MIN 1 83 #define SMB_ECHO_INTERVAL_MAX 600 84 #define SMB_ECHO_INTERVAL_DEFAULT 60 85 86 /* smb multichannel query server interfaces interval in seconds */ 87 #define SMB_INTERFACE_POLL_INTERVAL 600 88 89 /* maximum number of PDUs in one compound */ 90 #define MAX_COMPOUND 7 91 92 /* 93 * Default number of credits to keep available for SMB3. 94 * This value is chosen somewhat arbitrarily. The Windows client 95 * defaults to 128 credits, the Windows server allows clients up to 96 * 512 credits (or 8K for later versions), and the NetApp server 97 * does not limit clients at all. Choose a high enough default value 98 * such that the client shouldn't limit performance, but allow mount 99 * to override (until you approach 64K, where we limit credits to 65000 100 * to reduce possibility of seeing more server credit overflow bugs. 101 */ 102 #define SMB2_MAX_CREDITS_AVAILABLE 32000 103 104 #include "cifspdu.h" 105 106 #ifndef XATTR_DOS_ATTRIB 107 #define XATTR_DOS_ATTRIB "user.DOSATTRIB" 108 #endif 109 110 #define CIFS_MAX_WORKSTATION_LEN (__NEW_UTS_LEN + 1) /* reasonable max for client */ 111 112 #define CIFS_DFS_ROOT_SES(ses) ((ses)->dfs_root_ses ?: (ses)) 113 114 /* 115 * CIFS vfs client Status information (based on what we know.) 116 */ 117 118 /* associated with each connection */ 119 enum statusEnum { 120 CifsNew = 0, 121 CifsGood, 122 CifsExiting, 123 CifsNeedReconnect, 124 CifsNeedNegotiate, 125 CifsInNegotiate, 126 }; 127 128 /* associated with each smb session */ 129 enum ses_status_enum { 130 SES_NEW = 0, 131 SES_GOOD, 132 SES_EXITING, 133 SES_NEED_RECON, 134 SES_IN_SETUP 135 }; 136 137 /* associated with each tree connection to the server */ 138 enum tid_status_enum { 139 TID_NEW = 0, 140 TID_GOOD, 141 TID_EXITING, 142 TID_NEED_RECON, 143 TID_NEED_TCON, 144 TID_IN_TCON, 145 TID_NEED_FILES_INVALIDATE, /* currently unused */ 146 TID_IN_FILES_INVALIDATE 147 }; 148 149 enum securityEnum { 150 Unspecified = 0, /* not specified */ 151 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */ 152 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */ 153 Kerberos, /* Kerberos via SPNEGO */ 154 IAKerb, /* Kerberos proxy */ 155 }; 156 157 enum upcall_target_enum { 158 UPTARGET_UNSPECIFIED, /* not specified, defaults to app */ 159 UPTARGET_MOUNT, /* upcall to the mount namespace */ 160 UPTARGET_APP, /* upcall to the application namespace which did the mount */ 161 }; 162 163 enum cifs_reparse_type { 164 CIFS_REPARSE_TYPE_NONE, 165 CIFS_REPARSE_TYPE_NFS, 166 CIFS_REPARSE_TYPE_WSL, 167 CIFS_REPARSE_TYPE_DEFAULT = CIFS_REPARSE_TYPE_NFS, 168 }; 169 170 static inline const char *cifs_reparse_type_str(enum cifs_reparse_type type) 171 { 172 switch (type) { 173 case CIFS_REPARSE_TYPE_NONE: 174 return "none"; 175 case CIFS_REPARSE_TYPE_NFS: 176 return "nfs"; 177 case CIFS_REPARSE_TYPE_WSL: 178 return "wsl"; 179 default: 180 return "unknown"; 181 } 182 } 183 184 enum cifs_symlink_type { 185 CIFS_SYMLINK_TYPE_DEFAULT, 186 CIFS_SYMLINK_TYPE_NONE, 187 CIFS_SYMLINK_TYPE_NATIVE, 188 CIFS_SYMLINK_TYPE_UNIX, 189 CIFS_SYMLINK_TYPE_MFSYMLINKS, 190 CIFS_SYMLINK_TYPE_SFU, 191 CIFS_SYMLINK_TYPE_NFS, 192 CIFS_SYMLINK_TYPE_WSL, 193 }; 194 195 static inline const char *cifs_symlink_type_str(enum cifs_symlink_type type) 196 { 197 switch (type) { 198 case CIFS_SYMLINK_TYPE_NONE: 199 return "none"; 200 case CIFS_SYMLINK_TYPE_NATIVE: 201 return "native"; 202 case CIFS_SYMLINK_TYPE_UNIX: 203 return "unix"; 204 case CIFS_SYMLINK_TYPE_MFSYMLINKS: 205 return "mfsymlinks"; 206 case CIFS_SYMLINK_TYPE_SFU: 207 return "sfu"; 208 case CIFS_SYMLINK_TYPE_NFS: 209 return "nfs"; 210 case CIFS_SYMLINK_TYPE_WSL: 211 return "wsl"; 212 default: 213 return "unknown"; 214 } 215 } 216 217 struct session_key { 218 unsigned int len; 219 char *response; 220 }; 221 222 /* crypto hashing related structure/fields, not specific to a sec mech */ 223 struct cifs_secmech { 224 struct shash_desc *md5; /* md5 hash function, for CIFS/SMB1 signatures */ 225 struct shash_desc *hmacsha256; /* hmac-sha256 hash function, for SMB2 signatures */ 226 struct shash_desc *sha512; /* sha512 hash function, for SMB3.1.1 preauth hash */ 227 struct shash_desc *aes_cmac; /* block-cipher based MAC function, for SMB3 signatures */ 228 229 struct crypto_aead *enc; /* smb3 encryption AEAD TFM (AES-CCM and AES-GCM) */ 230 struct crypto_aead *dec; /* smb3 decryption AEAD TFM (AES-CCM and AES-GCM) */ 231 }; 232 233 /* per smb session structure/fields */ 234 struct ntlmssp_auth { 235 bool sesskey_per_smbsess; /* whether session key is per smb session */ 236 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */ 237 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */ 238 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */ 239 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */ 240 }; 241 242 struct cifs_cred { 243 int uid; 244 int gid; 245 int mode; 246 int cecount; 247 struct smb_sid osid; 248 struct smb_sid gsid; 249 struct cifs_ntace *ntaces; 250 struct smb_ace *aces; 251 }; 252 253 struct cifs_open_info_data { 254 bool adjust_tz; 255 bool reparse_point; 256 bool contains_posix_file_info; 257 struct { 258 /* ioctl response buffer */ 259 struct { 260 int buftype; 261 struct kvec iov; 262 } io; 263 __u32 tag; 264 struct reparse_data_buffer *buf; 265 } reparse; 266 struct { 267 __u8 eas[SMB2_WSL_MAX_QUERY_EA_RESP_SIZE]; 268 unsigned int eas_len; 269 } wsl; 270 char *symlink_target; 271 struct smb_sid posix_owner; 272 struct smb_sid posix_group; 273 union { 274 struct smb2_file_all_info fi; 275 struct smb311_posix_qinfo posix_fi; 276 }; 277 }; 278 279 /* 280 ***************************************************************** 281 * Except the CIFS PDUs themselves all the 282 * globally interesting structs should go here 283 ***************************************************************** 284 */ 285 286 /* 287 * A smb_rqst represents a complete request to be issued to a server. It's 288 * formed by a kvec array, followed by an array of pages. Page data is assumed 289 * to start at the beginning of the first page. 290 */ 291 struct smb_rqst { 292 struct kvec *rq_iov; /* array of kvecs */ 293 unsigned int rq_nvec; /* number of kvecs in array */ 294 struct iov_iter rq_iter; /* Data iterator */ 295 struct folio_queue *rq_buffer; /* Buffer for encryption */ 296 }; 297 298 struct mid_q_entry; 299 struct TCP_Server_Info; 300 struct cifsFileInfo; 301 struct cifs_ses; 302 struct cifs_tcon; 303 struct dfs_info3_param; 304 struct cifs_fattr; 305 struct smb3_fs_context; 306 struct cifs_fid; 307 struct cifs_io_subrequest; 308 struct cifs_io_parms; 309 struct cifs_search_info; 310 struct cifsInodeInfo; 311 struct cifs_open_parms; 312 struct cifs_credits; 313 314 struct smb_version_operations { 315 int (*send_cancel)(struct TCP_Server_Info *, struct smb_rqst *, 316 struct mid_q_entry *); 317 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *); 318 /* setup request: allocate mid, sign message */ 319 struct mid_q_entry *(*setup_request)(struct cifs_ses *, 320 struct TCP_Server_Info *, 321 struct smb_rqst *); 322 /* setup async request: allocate mid, sign message */ 323 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *, 324 struct smb_rqst *); 325 /* check response: verify signature, map error */ 326 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *, 327 bool); 328 void (*add_credits)(struct TCP_Server_Info *server, 329 struct cifs_credits *credits, 330 const int optype); 331 void (*set_credits)(struct TCP_Server_Info *, const int); 332 int * (*get_credits_field)(struct TCP_Server_Info *, const int); 333 unsigned int (*get_credits)(struct mid_q_entry *); 334 __u64 (*get_next_mid)(struct TCP_Server_Info *); 335 void (*revert_current_mid)(struct TCP_Server_Info *server, 336 const unsigned int val); 337 /* data offset from read response message */ 338 unsigned int (*read_data_offset)(char *); 339 /* 340 * Data length from read response message 341 * When in_remaining is true, the returned data length is in 342 * message field DataRemaining for out-of-band data read (e.g through 343 * Memory Registration RDMA write in SMBD). 344 * Otherwise, the returned data length is in message field DataLength. 345 */ 346 unsigned int (*read_data_length)(char *, bool in_remaining); 347 /* map smb to linux error */ 348 int (*map_error)(char *, bool); 349 /* find mid corresponding to the response message */ 350 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *); 351 void (*dump_detail)(void *buf, struct TCP_Server_Info *ptcp_info); 352 void (*clear_stats)(struct cifs_tcon *); 353 void (*print_stats)(struct seq_file *m, struct cifs_tcon *); 354 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *); 355 /* verify the message */ 356 int (*check_message)(char *, unsigned int, struct TCP_Server_Info *); 357 bool (*is_oplock_break)(char *, struct TCP_Server_Info *); 358 int (*handle_cancelled_mid)(struct mid_q_entry *, struct TCP_Server_Info *); 359 void (*downgrade_oplock)(struct TCP_Server_Info *server, 360 struct cifsInodeInfo *cinode, __u32 oplock, 361 __u16 epoch, bool *purge_cache); 362 /* process transaction2 response */ 363 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *, 364 char *, int); 365 /* check if we need to negotiate */ 366 bool (*need_neg)(struct TCP_Server_Info *); 367 /* negotiate to the server */ 368 int (*negotiate)(const unsigned int xid, 369 struct cifs_ses *ses, 370 struct TCP_Server_Info *server); 371 /* set negotiated write size */ 372 unsigned int (*negotiate_wsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx); 373 /* set negotiated read size */ 374 unsigned int (*negotiate_rsize)(struct cifs_tcon *tcon, struct smb3_fs_context *ctx); 375 /* setup smb sessionn */ 376 int (*sess_setup)(const unsigned int, struct cifs_ses *, 377 struct TCP_Server_Info *server, 378 const struct nls_table *); 379 /* close smb session */ 380 int (*logoff)(const unsigned int, struct cifs_ses *); 381 /* connect to a server share */ 382 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *, 383 struct cifs_tcon *, const struct nls_table *); 384 /* close tree connection */ 385 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *); 386 /* get DFS referrals */ 387 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *, 388 const char *, struct dfs_info3_param **, 389 unsigned int *, const struct nls_table *, int); 390 /* informational QFS call */ 391 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *, 392 struct cifs_sb_info *); 393 /* query for server interfaces */ 394 int (*query_server_interfaces)(const unsigned int, struct cifs_tcon *, 395 bool); 396 /* check if a path is accessible or not */ 397 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *, 398 struct cifs_sb_info *, const char *); 399 /* query path data from the server */ 400 int (*query_path_info)(const unsigned int xid, 401 struct cifs_tcon *tcon, 402 struct cifs_sb_info *cifs_sb, 403 const char *full_path, 404 struct cifs_open_info_data *data); 405 /* query file data from the server */ 406 int (*query_file_info)(const unsigned int xid, struct cifs_tcon *tcon, 407 struct cifsFileInfo *cfile, struct cifs_open_info_data *data); 408 /* query reparse point to determine which type of special file */ 409 int (*query_reparse_point)(const unsigned int xid, 410 struct cifs_tcon *tcon, 411 struct cifs_sb_info *cifs_sb, 412 const char *full_path, 413 u32 *tag, struct kvec *rsp, 414 int *rsp_buftype); 415 /* get server index number */ 416 int (*get_srv_inum)(const unsigned int xid, struct cifs_tcon *tcon, 417 struct cifs_sb_info *cifs_sb, const char *full_path, u64 *uniqueid, 418 struct cifs_open_info_data *data); 419 /* set size by path */ 420 int (*set_path_size)(const unsigned int, struct cifs_tcon *, 421 const char *, __u64, struct cifs_sb_info *, bool, 422 struct dentry *); 423 /* set size by file handle */ 424 int (*set_file_size)(const unsigned int, struct cifs_tcon *, 425 struct cifsFileInfo *, __u64, bool); 426 /* set attributes */ 427 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *, 428 const unsigned int); 429 int (*set_compression)(const unsigned int, struct cifs_tcon *, 430 struct cifsFileInfo *); 431 /* check if we can send an echo or nor */ 432 bool (*can_echo)(struct TCP_Server_Info *); 433 /* send echo request */ 434 int (*echo)(struct TCP_Server_Info *); 435 /* create directory */ 436 int (*posix_mkdir)(const unsigned int xid, struct inode *inode, 437 umode_t mode, struct cifs_tcon *tcon, 438 const char *full_path, 439 struct cifs_sb_info *cifs_sb); 440 int (*mkdir)(const unsigned int xid, struct inode *inode, umode_t mode, 441 struct cifs_tcon *tcon, const char *name, 442 struct cifs_sb_info *sb); 443 /* set info on created directory */ 444 void (*mkdir_setinfo)(struct inode *, const char *, 445 struct cifs_sb_info *, struct cifs_tcon *, 446 const unsigned int); 447 /* remove directory */ 448 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *, 449 struct cifs_sb_info *); 450 /* unlink file */ 451 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *, 452 struct cifs_sb_info *, struct dentry *); 453 /* open, rename and delete file */ 454 int (*rename_pending_delete)(const char *, struct dentry *, 455 const unsigned int); 456 /* send rename request */ 457 int (*rename)(const unsigned int xid, 458 struct cifs_tcon *tcon, 459 struct dentry *source_dentry, 460 const char *from_name, const char *to_name, 461 struct cifs_sb_info *cifs_sb); 462 /* send create hardlink request */ 463 int (*create_hardlink)(const unsigned int xid, 464 struct cifs_tcon *tcon, 465 struct dentry *source_dentry, 466 const char *from_name, const char *to_name, 467 struct cifs_sb_info *cifs_sb); 468 /* query symlink target */ 469 int (*query_symlink)(const unsigned int xid, 470 struct cifs_tcon *tcon, 471 struct cifs_sb_info *cifs_sb, 472 const char *full_path, 473 char **target_path); 474 /* open a file for non-posix mounts */ 475 int (*open)(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock, 476 void *buf); 477 /* set fid protocol-specific info */ 478 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32); 479 /* close a file */ 480 int (*close)(const unsigned int, struct cifs_tcon *, 481 struct cifs_fid *); 482 /* close a file, returning file attributes and timestamps */ 483 int (*close_getattr)(const unsigned int xid, struct cifs_tcon *tcon, 484 struct cifsFileInfo *pfile_info); 485 /* send a flush request to the server */ 486 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *); 487 /* async read from the server */ 488 int (*async_readv)(struct cifs_io_subrequest *); 489 /* async write to the server */ 490 void (*async_writev)(struct cifs_io_subrequest *); 491 /* sync read from the server */ 492 int (*sync_read)(const unsigned int, struct cifs_fid *, 493 struct cifs_io_parms *, unsigned int *, char **, 494 int *); 495 /* sync write to the server */ 496 int (*sync_write)(const unsigned int, struct cifs_fid *, 497 struct cifs_io_parms *, unsigned int *, struct kvec *, 498 unsigned long); 499 /* open dir, start readdir */ 500 int (*query_dir_first)(const unsigned int, struct cifs_tcon *, 501 const char *, struct cifs_sb_info *, 502 struct cifs_fid *, __u16, 503 struct cifs_search_info *); 504 /* continue readdir */ 505 int (*query_dir_next)(const unsigned int, struct cifs_tcon *, 506 struct cifs_fid *, 507 __u16, struct cifs_search_info *srch_inf); 508 /* close dir */ 509 int (*close_dir)(const unsigned int, struct cifs_tcon *, 510 struct cifs_fid *); 511 /* calculate a size of SMB message */ 512 unsigned int (*calc_smb_size)(void *buf); 513 /* check for STATUS_PENDING and process the response if yes */ 514 bool (*is_status_pending)(char *buf, struct TCP_Server_Info *server); 515 /* check for STATUS_NETWORK_SESSION_EXPIRED */ 516 bool (*is_session_expired)(char *); 517 /* send oplock break response */ 518 int (*oplock_response)(struct cifs_tcon *tcon, __u64 persistent_fid, __u64 volatile_fid, 519 __u16 net_fid, struct cifsInodeInfo *cifs_inode); 520 /* query remote filesystem */ 521 int (*queryfs)(const unsigned int, struct cifs_tcon *, 522 const char *, struct cifs_sb_info *, struct kstatfs *); 523 /* send mandatory brlock to the server */ 524 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64, 525 __u64, __u32, int, int, bool); 526 /* unlock range of mandatory locks */ 527 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *, 528 const unsigned int); 529 /* push brlocks from the cache to the server */ 530 int (*push_mand_locks)(struct cifsFileInfo *); 531 /* get lease key of the inode */ 532 void (*get_lease_key)(struct inode *, struct cifs_fid *); 533 /* set lease key of the inode */ 534 void (*set_lease_key)(struct inode *, struct cifs_fid *); 535 /* generate new lease key */ 536 void (*new_lease_key)(struct cifs_fid *); 537 int (*generate_signingkey)(struct cifs_ses *ses, 538 struct TCP_Server_Info *server); 539 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *, 540 bool allocate_crypto); 541 int (*set_integrity)(const unsigned int, struct cifs_tcon *tcon, 542 struct cifsFileInfo *src_file); 543 int (*enum_snapshots)(const unsigned int xid, struct cifs_tcon *tcon, 544 struct cifsFileInfo *src_file, void __user *); 545 int (*notify)(const unsigned int xid, struct file *pfile, 546 void __user *pbuf, bool return_changes); 547 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *, 548 struct cifs_sb_info *, const unsigned char *, 549 char *, unsigned int *); 550 int (*create_mf_symlink)(unsigned int, struct cifs_tcon *, 551 struct cifs_sb_info *, const unsigned char *, 552 char *, unsigned int *); 553 /* if we can do cache read operations */ 554 bool (*is_read_op)(__u32); 555 /* set oplock level for the inode */ 556 void (*set_oplock_level)(struct cifsInodeInfo *cinode, __u32 oplock, __u16 epoch, 557 bool *purge_cache); 558 /* create lease context buffer for CREATE request */ 559 char * (*create_lease_buf)(u8 *lease_key, u8 oplock, u8 *parent_lease_key, __le32 le_flags); 560 /* parse lease context buffer and return oplock/epoch info */ 561 __u8 (*parse_lease_buf)(void *buf, __u16 *epoch, char *lkey); 562 ssize_t (*copychunk_range)(const unsigned int, 563 struct cifsFileInfo *src_file, 564 struct cifsFileInfo *target_file, 565 u64 src_off, u64 len, u64 dest_off); 566 int (*duplicate_extents)(const unsigned int, struct cifsFileInfo *src, 567 struct cifsFileInfo *target_file, u64 src_off, u64 len, 568 u64 dest_off); 569 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *); 570 ssize_t (*query_all_EAs)(const unsigned int, struct cifs_tcon *, 571 const unsigned char *, const unsigned char *, char *, 572 size_t, struct cifs_sb_info *); 573 int (*set_EA)(const unsigned int, struct cifs_tcon *, const char *, 574 const char *, const void *, const __u16, 575 const struct nls_table *, struct cifs_sb_info *); 576 struct smb_ntsd * (*get_acl)(struct cifs_sb_info *cifssb, struct inode *ino, 577 const char *patch, u32 *plen, u32 info); 578 struct smb_ntsd * (*get_acl_by_fid)(struct cifs_sb_info *cifssmb, 579 const struct cifs_fid *pfid, u32 *plen, u32 info); 580 int (*set_acl)(struct smb_ntsd *pntsd, __u32 len, struct inode *ino, const char *path, 581 int flag); 582 /* writepages retry size */ 583 unsigned int (*wp_retry_size)(struct inode *); 584 /* get mtu credits */ 585 int (*wait_mtu_credits)(struct TCP_Server_Info *, size_t, 586 size_t *, struct cifs_credits *); 587 /* adjust previously taken mtu credits to request size */ 588 int (*adjust_credits)(struct TCP_Server_Info *server, 589 struct cifs_io_subrequest *subreq, 590 unsigned int /*enum smb3_rw_credits_trace*/ trace); 591 /* check if we need to issue closedir */ 592 bool (*dir_needs_close)(struct cifsFileInfo *); 593 long (*fallocate)(struct file *, struct cifs_tcon *, int, loff_t, 594 loff_t); 595 /* init transform (compress/encrypt) request */ 596 int (*init_transform_rq)(struct TCP_Server_Info *, int num_rqst, 597 struct smb_rqst *, struct smb_rqst *); 598 int (*is_transform_hdr)(void *buf); 599 int (*receive_transform)(struct TCP_Server_Info *, 600 struct mid_q_entry **, char **, int *); 601 enum securityEnum (*select_sectype)(struct TCP_Server_Info *, 602 enum securityEnum); 603 int (*next_header)(struct TCP_Server_Info *server, char *buf, 604 unsigned int *noff); 605 /* ioctl passthrough for query_info */ 606 int (*ioctl_query_info)(const unsigned int xid, 607 struct cifs_tcon *tcon, 608 struct cifs_sb_info *cifs_sb, 609 __le16 *path, int is_dir, 610 unsigned long p); 611 /* make unix special files (block, char, fifo, socket) */ 612 int (*make_node)(unsigned int xid, 613 struct inode *inode, 614 struct dentry *dentry, 615 struct cifs_tcon *tcon, 616 const char *full_path, 617 umode_t mode, 618 dev_t device_number); 619 /* version specific fiemap implementation */ 620 int (*fiemap)(struct cifs_tcon *tcon, struct cifsFileInfo *, 621 struct fiemap_extent_info *, u64, u64); 622 /* version specific llseek implementation */ 623 loff_t (*llseek)(struct file *, struct cifs_tcon *, loff_t, int); 624 /* Check for STATUS_IO_TIMEOUT */ 625 bool (*is_status_io_timeout)(char *buf); 626 /* Check for STATUS_NETWORK_NAME_DELETED */ 627 bool (*is_network_name_deleted)(char *buf, struct TCP_Server_Info *srv); 628 struct reparse_data_buffer * (*get_reparse_point_buffer)(const struct kvec *rsp_iov, 629 u32 *plen); 630 int (*create_reparse_symlink)(const unsigned int xid, 631 struct inode *inode, 632 struct dentry *dentry, 633 struct cifs_tcon *tcon, 634 const char *full_path, 635 const char *symname); 636 }; 637 638 struct smb_version_values { 639 char *version_string; 640 __u16 protocol_id; 641 __u32 req_capabilities; 642 __u32 large_lock_type; 643 __u32 exclusive_lock_type; 644 __u32 shared_lock_type; 645 __u32 unlock_lock_type; 646 size_t header_preamble_size; 647 size_t header_size; 648 size_t max_header_size; 649 size_t read_rsp_size; 650 __le16 lock_cmd; 651 unsigned int cap_unix; 652 unsigned int cap_nt_find; 653 unsigned int cap_large_files; 654 unsigned int cap_unicode; 655 __u16 signing_enabled; 656 __u16 signing_required; 657 size_t create_lease_size; 658 }; 659 660 #define HEADER_SIZE(server) (server->vals->header_size) 661 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size) 662 #define HEADER_PREAMBLE_SIZE(server) (server->vals->header_preamble_size) 663 #define MID_HEADER_SIZE(server) (HEADER_SIZE(server) - 1 - HEADER_PREAMBLE_SIZE(server)) 664 665 /** 666 * CIFS superblock mount flags (mnt_cifs_flags) to consider when 667 * trying to reuse existing superblock for a new mount 668 */ 669 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \ 670 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \ 671 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \ 672 CIFS_MOUNT_MAP_SFM_CHR | \ 673 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \ 674 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \ 675 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \ 676 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \ 677 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \ 678 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \ 679 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID | \ 680 CIFS_MOUNT_UID_FROM_ACL | CIFS_MOUNT_NO_HANDLE_CACHE | \ 681 CIFS_MOUNT_NO_DFS | CIFS_MOUNT_MODE_FROM_SID | \ 682 CIFS_MOUNT_RO_CACHE | CIFS_MOUNT_RW_CACHE) 683 684 /** 685 * Generic VFS superblock mount flags (s_flags) to consider when 686 * trying to reuse existing superblock for a new mount 687 */ 688 #define CIFS_MS_MASK (SB_RDONLY | SB_MANDLOCK | SB_NOEXEC | SB_NOSUID | \ 689 SB_NODEV | SB_SYNCHRONOUS) 690 691 struct cifs_mnt_data { 692 struct cifs_sb_info *cifs_sb; 693 struct smb3_fs_context *ctx; 694 int flags; 695 }; 696 697 static inline unsigned int 698 get_rfc1002_length(void *buf) 699 { 700 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff; 701 } 702 703 static inline void 704 inc_rfc1001_len(void *buf, int count) 705 { 706 be32_add_cpu((__be32 *)buf, count); 707 } 708 709 struct TCP_Server_Info { 710 struct list_head tcp_ses_list; 711 struct list_head smb_ses_list; 712 spinlock_t srv_lock; /* protect anything here that is not protected */ 713 __u64 conn_id; /* connection identifier (useful for debugging) */ 714 int srv_count; /* reference counter */ 715 int rfc1001_sessinit; /* whether to estasblish netbios session */ 716 bool with_rfc1001; /* if netbios session is used */ 717 /* 15 character server name + 0x20 16th byte indicating type = srv */ 718 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; 719 struct smb_version_operations *ops; 720 struct smb_version_values *vals; 721 /* updates to tcpStatus protected by cifs_tcp_ses_lock */ 722 enum statusEnum tcpStatus; /* what we think the status is */ 723 char *hostname; /* hostname portion of UNC string */ 724 struct socket *ssocket; 725 struct sockaddr_storage dstaddr; 726 struct sockaddr_storage srcaddr; /* locally bind to this IP */ 727 #ifdef CONFIG_NET_NS 728 struct net *net; 729 #endif 730 wait_queue_head_t response_q; 731 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/ 732 spinlock_t mid_lock; /* protect mid queue and it's entries */ 733 struct list_head pending_mid_q; 734 bool noblocksnd; /* use blocking sendmsg */ 735 bool noautotune; /* do not autotune send buf sizes */ 736 bool nosharesock; 737 bool tcp_nodelay; 738 bool terminate; 739 unsigned int credits; /* send no more requests at once */ 740 unsigned int max_credits; /* can override large 32000 default at mnt */ 741 unsigned int in_flight; /* number of requests on the wire to server */ 742 unsigned int max_in_flight; /* max number of requests that were on wire */ 743 spinlock_t req_lock; /* protect the two values above */ 744 struct mutex _srv_mutex; 745 unsigned int nofs_flag; 746 struct task_struct *tsk; 747 char server_GUID[16]; 748 __u16 sec_mode; 749 bool sign; /* is signing enabled on this connection? */ 750 bool ignore_signature:1; /* skip validation of signatures in SMB2/3 rsp */ 751 bool session_estab; /* mark when very first sess is established */ 752 int echo_credits; /* echo reserved slots */ 753 int oplock_credits; /* oplock break reserved slots */ 754 bool echoes:1; /* enable echoes */ 755 __u8 client_guid[SMB2_CLIENT_GUID_SIZE]; /* Client GUID */ 756 u16 dialect; /* dialect index that server chose */ 757 bool oplocks:1; /* enable oplocks */ 758 unsigned int maxReq; /* Clients should submit no more */ 759 /* than maxReq distinct unanswered SMBs to the server when using */ 760 /* multiplexed reads or writes (for SMB1/CIFS only, not SMB2/SMB3) */ 761 unsigned int maxBuf; /* maxBuf specifies the maximum */ 762 /* message size the server can send or receive for non-raw SMBs */ 763 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */ 764 /* when socket is setup (and during reconnect) before NegProt sent */ 765 unsigned int max_rw; /* maxRw specifies the maximum */ 766 /* message size the server can send or receive for */ 767 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */ 768 unsigned int capabilities; /* selective disabling of caps by smb sess */ 769 int timeAdj; /* Adjust for difference in server time zone in sec */ 770 __u64 CurrentMid; /* multiplex id - rotating counter, protected by GlobalMid_Lock */ 771 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */ 772 /* 16th byte of RFC1001 workstation name is always null */ 773 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; 774 __u32 sequence_number; /* for signing, protected by srv_mutex */ 775 __u32 reconnect_instance; /* incremented on each reconnect */ 776 __le32 session_key_id; /* retrieved from negotiate response and send in session setup request */ 777 struct session_key session_key; 778 unsigned long lstrp; /* when we got last response from this server */ 779 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */ 780 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */ 781 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */ 782 char negflavor; /* NEGOTIATE response flavor */ 783 /* extended security flavors that server supports */ 784 bool sec_ntlmssp; /* supports NTLMSSP */ 785 bool sec_kerberosu2u; /* supports U2U Kerberos */ 786 bool sec_kerberos; /* supports plain Kerberos */ 787 bool sec_mskerberos; /* supports legacy MS Kerberos */ 788 bool sec_iakerb; /* supports pass-through auth for Kerberos (krb5 proxy) */ 789 bool large_buf; /* is current buffer large? */ 790 /* use SMBD connection instead of socket */ 791 bool rdma; 792 /* point to the SMBD connection if RDMA is used instead of socket */ 793 struct smbd_connection *smbd_conn; 794 struct delayed_work echo; /* echo ping workqueue job */ 795 char *smallbuf; /* pointer to current "small" buffer */ 796 char *bigbuf; /* pointer to current "big" buffer */ 797 /* Total size of this PDU. Only valid from cifs_demultiplex_thread */ 798 unsigned int pdu_size; 799 unsigned int total_read; /* total amount of data read in this pass */ 800 atomic_t in_send; /* requests trying to send */ 801 atomic_t num_waiters; /* blocked waiting to get in sendrecv */ 802 #ifdef CONFIG_CIFS_STATS2 803 atomic_t num_cmds[NUMBER_OF_SMB2_COMMANDS]; /* total requests by cmd */ 804 atomic_t smb2slowcmd[NUMBER_OF_SMB2_COMMANDS]; /* count resps > 1 sec */ 805 __u64 time_per_cmd[NUMBER_OF_SMB2_COMMANDS]; /* total time per cmd */ 806 __u32 slowest_cmd[NUMBER_OF_SMB2_COMMANDS]; 807 __u32 fastest_cmd[NUMBER_OF_SMB2_COMMANDS]; 808 #endif /* STATS2 */ 809 unsigned int max_read; 810 unsigned int max_write; 811 unsigned int min_offload; 812 unsigned int retrans; 813 struct { 814 bool requested; /* "compress" mount option set*/ 815 bool enabled; /* actually negotiated with server */ 816 __le16 alg; /* preferred alg negotiated with server */ 817 } compression; 818 __u16 signing_algorithm; 819 __le16 cipher_type; 820 /* save initial negprot hash */ 821 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE]; 822 bool signing_negotiated; /* true if valid signing context rcvd from server */ 823 bool posix_ext_supported; 824 struct delayed_work reconnect; /* reconnect workqueue job */ 825 struct mutex reconnect_mutex; /* prevent simultaneous reconnects */ 826 unsigned long echo_interval; 827 828 /* 829 * Number of targets available for reconnect. The more targets 830 * the more tasks have to wait to let the demultiplex thread 831 * reconnect. 832 */ 833 int nr_targets; 834 bool noblockcnt; /* use non-blocking connect() */ 835 836 /* 837 * If this is a session channel, 838 * primary_server holds the ref-counted 839 * pointer to primary channel connection for the session. 840 */ 841 #define SERVER_IS_CHAN(server) (!!(server)->primary_server) 842 struct TCP_Server_Info *primary_server; 843 __u16 channel_sequence_num; /* incremented on primary channel on each chan reconnect */ 844 845 #ifdef CONFIG_CIFS_SWN_UPCALL 846 bool use_swn_dstaddr; 847 struct sockaddr_storage swn_dstaddr; 848 #endif 849 /* 850 * Canonical DFS referral path used in cifs_reconnect() for failover as 851 * well as in DFS cache refresher. 852 * 853 * format: \\HOST\SHARE[\OPTIONAL PATH] 854 */ 855 char *leaf_fullpath; 856 bool dfs_conn:1; 857 char dns_dom[CIFS_MAX_DOMAINNAME_LEN + 1]; 858 }; 859 860 static inline bool is_smb1(struct TCP_Server_Info *server) 861 { 862 return HEADER_PREAMBLE_SIZE(server) != 0; 863 } 864 865 static inline void cifs_server_lock(struct TCP_Server_Info *server) 866 { 867 unsigned int nofs_flag = memalloc_nofs_save(); 868 869 mutex_lock(&server->_srv_mutex); 870 server->nofs_flag = nofs_flag; 871 } 872 873 static inline void cifs_server_unlock(struct TCP_Server_Info *server) 874 { 875 unsigned int nofs_flag = server->nofs_flag; 876 877 mutex_unlock(&server->_srv_mutex); 878 memalloc_nofs_restore(nofs_flag); 879 } 880 881 struct cifs_credits { 882 unsigned int value; 883 unsigned int instance; 884 unsigned int in_flight_check; 885 unsigned int rreq_debug_id; 886 unsigned int rreq_debug_index; 887 }; 888 889 static inline unsigned int 890 in_flight(struct TCP_Server_Info *server) 891 { 892 unsigned int num; 893 894 spin_lock(&server->req_lock); 895 num = server->in_flight; 896 spin_unlock(&server->req_lock); 897 return num; 898 } 899 900 static inline bool 901 has_credits(struct TCP_Server_Info *server, int *credits, int num_credits) 902 { 903 int num; 904 905 spin_lock(&server->req_lock); 906 num = *credits; 907 spin_unlock(&server->req_lock); 908 return num >= num_credits; 909 } 910 911 static inline void 912 add_credits(struct TCP_Server_Info *server, struct cifs_credits *credits, 913 const int optype) 914 { 915 server->ops->add_credits(server, credits, optype); 916 } 917 918 static inline void 919 add_credits_and_wake_if(struct TCP_Server_Info *server, 920 struct cifs_credits *credits, const int optype) 921 { 922 if (credits->value) { 923 server->ops->add_credits(server, credits, optype); 924 wake_up(&server->request_q); 925 credits->value = 0; 926 } 927 } 928 929 static inline void 930 set_credits(struct TCP_Server_Info *server, const int val) 931 { 932 server->ops->set_credits(server, val); 933 } 934 935 static inline int 936 adjust_credits(struct TCP_Server_Info *server, struct cifs_io_subrequest *subreq, 937 unsigned int /* enum smb3_rw_credits_trace */ trace) 938 { 939 return server->ops->adjust_credits ? 940 server->ops->adjust_credits(server, subreq, trace) : 0; 941 } 942 943 static inline __le64 944 get_next_mid64(struct TCP_Server_Info *server) 945 { 946 return cpu_to_le64(server->ops->get_next_mid(server)); 947 } 948 949 static inline __le16 950 get_next_mid(struct TCP_Server_Info *server) 951 { 952 __u16 mid = server->ops->get_next_mid(server); 953 /* 954 * The value in the SMB header should be little endian for easy 955 * on-the-wire decoding. 956 */ 957 return cpu_to_le16(mid); 958 } 959 960 static inline void 961 revert_current_mid(struct TCP_Server_Info *server, const unsigned int val) 962 { 963 if (server->ops->revert_current_mid) 964 server->ops->revert_current_mid(server, val); 965 } 966 967 static inline void 968 revert_current_mid_from_hdr(struct TCP_Server_Info *server, 969 const struct smb2_hdr *shdr) 970 { 971 unsigned int num = le16_to_cpu(shdr->CreditCharge); 972 973 return revert_current_mid(server, num > 0 ? num : 1); 974 } 975 976 static inline __u16 977 get_mid(const struct smb_hdr *smb) 978 { 979 return le16_to_cpu(smb->Mid); 980 } 981 982 static inline bool 983 compare_mid(__u16 mid, const struct smb_hdr *smb) 984 { 985 return mid == le16_to_cpu(smb->Mid); 986 } 987 988 /* 989 * When the server supports very large reads and writes via POSIX extensions, 990 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not 991 * including the RFC1001 length. 992 * 993 * Note that this might make for "interesting" allocation problems during 994 * writeback however as we have to allocate an array of pointers for the 995 * pages. A 16M write means ~32kb page array with PAGE_SIZE == 4096. 996 * 997 * For reads, there is a similar problem as we need to allocate an array 998 * of kvecs to handle the receive, though that should only need to be done 999 * once. 1000 */ 1001 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4) 1002 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4) 1003 1004 /* 1005 * When the server doesn't allow large posix writes, only allow a rsize/wsize 1006 * of 2^17-1 minus the size of the call header. That allows for a read or 1007 * write up to the maximum size described by RFC1002. 1008 */ 1009 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4) 1010 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4) 1011 1012 #define CIFS_DEFAULT_IOSIZE (1024 * 1024) 1013 1014 /* 1015 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to 1016 * those values when posix extensions aren't in force. In actuality here, we 1017 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem 1018 * to be ok with the extra byte even though Windows doesn't send writes that 1019 * are that large. 1020 * 1021 * Citation: 1022 * 1023 * https://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx 1024 */ 1025 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024) 1026 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536) 1027 1028 /* 1029 * Macros to allow the TCP_Server_Info->net field and related code to drop out 1030 * when CONFIG_NET_NS isn't set. 1031 */ 1032 1033 #ifdef CONFIG_NET_NS 1034 1035 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) 1036 { 1037 return srv->net; 1038 } 1039 1040 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) 1041 { 1042 srv->net = net; 1043 } 1044 1045 #else 1046 1047 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) 1048 { 1049 return &init_net; 1050 } 1051 1052 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) 1053 { 1054 } 1055 1056 #endif 1057 1058 struct cifs_server_iface { 1059 struct list_head iface_head; 1060 struct kref refcount; 1061 size_t speed; 1062 size_t weight_fulfilled; 1063 unsigned int num_channels; 1064 unsigned int rdma_capable : 1; 1065 unsigned int rss_capable : 1; 1066 unsigned int is_active : 1; /* unset if non existent */ 1067 struct sockaddr_storage sockaddr; 1068 }; 1069 1070 /* release iface when last ref is dropped */ 1071 static inline void 1072 release_iface(struct kref *ref) 1073 { 1074 struct cifs_server_iface *iface = container_of(ref, 1075 struct cifs_server_iface, 1076 refcount); 1077 kfree(iface); 1078 } 1079 1080 struct cifs_chan { 1081 unsigned int in_reconnect : 1; /* if session setup in progress for this channel */ 1082 struct TCP_Server_Info *server; 1083 struct cifs_server_iface *iface; /* interface in use */ 1084 __u8 signkey[SMB3_SIGN_KEY_SIZE]; 1085 }; 1086 1087 #define CIFS_SES_FLAG_SCALE_CHANNELS (0x1) 1088 1089 /* 1090 * Session structure. One of these for each uid session with a particular host 1091 */ 1092 struct cifs_ses { 1093 struct list_head smb_ses_list; 1094 struct list_head rlist; /* reconnect list */ 1095 struct list_head tcon_list; 1096 struct list_head dlist; /* dfs list */ 1097 struct cifs_tcon *tcon_ipc; 1098 spinlock_t ses_lock; /* protect anything here that is not protected */ 1099 struct mutex session_mutex; 1100 struct TCP_Server_Info *server; /* pointer to server info */ 1101 int ses_count; /* reference counter */ 1102 enum ses_status_enum ses_status; /* updates protected by cifs_tcp_ses_lock */ 1103 unsigned int overrideSecFlg; /* if non-zero override global sec flags */ 1104 char *serverOS; /* name of operating system underlying server */ 1105 char *serverNOS; /* name of network operating system of server */ 1106 char *serverDomain; /* security realm of server */ 1107 __u64 Suid; /* remote smb uid */ 1108 kuid_t linux_uid; /* overriding owner of files on the mount */ 1109 kuid_t cred_uid; /* owner of credentials */ 1110 unsigned int capabilities; 1111 char ip_addr[INET6_ADDRSTRLEN + 1]; /* Max ipv6 (or v4) addr string len */ 1112 char *user_name; /* must not be null except during init of sess 1113 and after mount option parsing we fill it */ 1114 char *domainName; 1115 char *password; 1116 char *password2; /* When key rotation used, new password may be set before it expires */ 1117 char workstation_name[CIFS_MAX_WORKSTATION_LEN]; 1118 struct session_key auth_key; 1119 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */ 1120 enum securityEnum sectype; /* what security flavor was specified? */ 1121 enum upcall_target_enum upcall_target; /* what upcall target was specified? */ 1122 bool sign; /* is signing required? */ 1123 bool domainAuto:1; 1124 bool expired_pwd; /* track if access denied or expired pwd so can know if need to update */ 1125 int unicode; 1126 unsigned int flags; 1127 __u16 session_flags; 1128 __u8 smb3signingkey[SMB3_SIGN_KEY_SIZE]; 1129 __u8 smb3encryptionkey[SMB3_ENC_DEC_KEY_SIZE]; 1130 __u8 smb3decryptionkey[SMB3_ENC_DEC_KEY_SIZE]; 1131 __u8 preauth_sha_hash[SMB2_PREAUTH_HASH_SIZE]; 1132 1133 /* 1134 * Network interfaces available on the server this session is 1135 * connected to. 1136 * 1137 * Other channels can be opened by connecting and binding this 1138 * session to interfaces from this list. 1139 * 1140 * iface_lock should be taken when accessing any of these fields 1141 */ 1142 spinlock_t iface_lock; 1143 /* ========= begin: protected by iface_lock ======== */ 1144 struct list_head iface_list; 1145 size_t iface_count; 1146 unsigned long iface_last_update; /* jiffies */ 1147 /* ========= end: protected by iface_lock ======== */ 1148 1149 spinlock_t chan_lock; 1150 /* ========= begin: protected by chan_lock ======== */ 1151 #define CIFS_MAX_CHANNELS 16 1152 #define CIFS_INVAL_CHAN_INDEX (-1) 1153 #define CIFS_ALL_CHANNELS_SET(ses) \ 1154 ((1UL << (ses)->chan_count) - 1) 1155 #define CIFS_ALL_CHANS_GOOD(ses) \ 1156 (!(ses)->chans_need_reconnect) 1157 #define CIFS_ALL_CHANS_NEED_RECONNECT(ses) \ 1158 ((ses)->chans_need_reconnect == CIFS_ALL_CHANNELS_SET(ses)) 1159 #define CIFS_SET_ALL_CHANS_NEED_RECONNECT(ses) \ 1160 ((ses)->chans_need_reconnect = CIFS_ALL_CHANNELS_SET(ses)) 1161 #define CIFS_CHAN_NEEDS_RECONNECT(ses, index) \ 1162 test_bit((index), &(ses)->chans_need_reconnect) 1163 #define CIFS_CHAN_IN_RECONNECT(ses, index) \ 1164 ((ses)->chans[(index)].in_reconnect) 1165 1166 struct cifs_chan chans[CIFS_MAX_CHANNELS]; 1167 size_t chan_count; 1168 size_t chan_max; 1169 atomic_t chan_seq; /* round robin state */ 1170 1171 /* 1172 * chans_need_reconnect is a bitmap indicating which of the channels 1173 * under this smb session needs to be reconnected. 1174 * If not multichannel session, only one bit will be used. 1175 * 1176 * We will ask for sess and tcon reconnection only if all the 1177 * channels are marked for needing reconnection. This will 1178 * enable the sessions on top to continue to live till any 1179 * of the channels below are active. 1180 */ 1181 unsigned long chans_need_reconnect; 1182 /* ========= end: protected by chan_lock ======== */ 1183 struct cifs_ses *dfs_root_ses; 1184 struct nls_table *local_nls; 1185 char *dns_dom; /* FQDN of the domain */ 1186 }; 1187 1188 static inline bool 1189 cap_unix(struct cifs_ses *ses) 1190 { 1191 return ses->server->vals->cap_unix & ses->capabilities; 1192 } 1193 1194 /* 1195 * common struct for holding inode info when searching for or updating an 1196 * inode with new info 1197 */ 1198 1199 #define CIFS_FATTR_JUNCTION 0x1 1200 #define CIFS_FATTR_DELETE_PENDING 0x2 1201 #define CIFS_FATTR_NEED_REVAL 0x4 1202 #define CIFS_FATTR_INO_COLLISION 0x8 1203 #define CIFS_FATTR_UNKNOWN_NLINK 0x10 1204 #define CIFS_FATTR_FAKE_ROOT_INO 0x20 1205 1206 struct cifs_fattr { 1207 u32 cf_flags; 1208 u32 cf_cifsattrs; 1209 u64 cf_uniqueid; 1210 u64 cf_eof; 1211 u64 cf_bytes; 1212 u64 cf_createtime; 1213 kuid_t cf_uid; 1214 kgid_t cf_gid; 1215 umode_t cf_mode; 1216 dev_t cf_rdev; 1217 unsigned int cf_nlink; 1218 unsigned int cf_dtype; 1219 struct timespec64 cf_atime; 1220 struct timespec64 cf_mtime; 1221 struct timespec64 cf_ctime; 1222 u32 cf_cifstag; 1223 char *cf_symlink_target; 1224 }; 1225 1226 /* 1227 * there is one of these for each connection to a resource on a particular 1228 * session 1229 */ 1230 struct cifs_tcon { 1231 struct list_head tcon_list; 1232 int debug_id; /* Debugging for tracing */ 1233 int tc_count; 1234 struct list_head rlist; /* reconnect list */ 1235 spinlock_t tc_lock; /* protect anything here that is not protected */ 1236 atomic_t num_local_opens; /* num of all opens including disconnected */ 1237 atomic_t num_remote_opens; /* num of all network opens on server */ 1238 struct list_head openFileList; 1239 spinlock_t open_file_lock; /* protects list above */ 1240 struct cifs_ses *ses; /* pointer to session associated with */ 1241 char tree_name[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */ 1242 char *nativeFileSystem; 1243 char *password; /* for share-level security */ 1244 __u32 tid; /* The 4 byte tree id */ 1245 __u16 Flags; /* optional support bits */ 1246 enum tid_status_enum status; 1247 atomic_t num_smbs_sent; 1248 union { 1249 struct { 1250 atomic_t num_writes; 1251 atomic_t num_reads; 1252 atomic_t num_flushes; 1253 atomic_t num_oplock_brks; 1254 atomic_t num_opens; 1255 atomic_t num_closes; 1256 atomic_t num_deletes; 1257 atomic_t num_mkdirs; 1258 atomic_t num_posixopens; 1259 atomic_t num_posixmkdirs; 1260 atomic_t num_rmdirs; 1261 atomic_t num_renames; 1262 atomic_t num_t2renames; 1263 atomic_t num_ffirst; 1264 atomic_t num_fnext; 1265 atomic_t num_fclose; 1266 atomic_t num_hardlinks; 1267 atomic_t num_symlinks; 1268 atomic_t num_locks; 1269 atomic_t num_acl_get; 1270 atomic_t num_acl_set; 1271 } cifs_stats; 1272 struct { 1273 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS]; 1274 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS]; 1275 } smb2_stats; 1276 } stats; 1277 __u64 bytes_read; 1278 __u64 bytes_written; 1279 spinlock_t stat_lock; /* protects the two fields above */ 1280 time64_t stats_from_time; 1281 FILE_SYSTEM_DEVICE_INFO fsDevInfo; 1282 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */ 1283 FILE_SYSTEM_UNIX_INFO fsUnixInfo; 1284 bool ipc:1; /* set if connection to IPC$ share (always also pipe) */ 1285 bool pipe:1; /* set if connection to pipe share */ 1286 bool print:1; /* set if connection to printer share */ 1287 bool retry:1; 1288 bool nocase:1; 1289 bool nohandlecache:1; /* if strange server resource prob can turn off */ 1290 bool nodelete:1; 1291 bool seal:1; /* transport encryption for this mounted share */ 1292 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol 1293 for this mount even if server would support */ 1294 bool posix_extensions; /* if true SMB3.11 posix extensions enabled */ 1295 bool local_lease:1; /* check leases (only) on local system not remote */ 1296 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */ 1297 bool broken_sparse_sup; /* if server or share does not support sparse */ 1298 bool need_reconnect:1; /* connection reset, tid now invalid */ 1299 bool need_reopen_files:1; /* need to reopen tcon file handles */ 1300 bool use_resilient:1; /* use resilient instead of durable handles */ 1301 bool use_persistent:1; /* use persistent instead of durable handles */ 1302 bool no_lease:1; /* Do not request leases on files or directories */ 1303 bool use_witness:1; /* use witness protocol */ 1304 __le32 capabilities; 1305 __u32 share_flags; 1306 __u32 maximal_access; 1307 __u32 vol_serial_number; 1308 __le64 vol_create_time; 1309 __u64 snapshot_time; /* for timewarp tokens - timestamp of snapshot */ 1310 __u32 handle_timeout; /* persistent and durable handle timeout in ms */ 1311 __u32 ss_flags; /* sector size flags */ 1312 __u32 perf_sector_size; /* best sector size for perf */ 1313 __u32 max_chunks; 1314 __u32 max_bytes_chunk; 1315 __u32 max_bytes_copy; 1316 __u32 max_cached_dirs; 1317 #ifdef CONFIG_CIFS_FSCACHE 1318 u64 resource_id; /* server resource id */ 1319 bool fscache_acquired; /* T if we've tried acquiring a cookie */ 1320 struct fscache_volume *fscache; /* cookie for share */ 1321 struct mutex fscache_lock; /* Prevent regetting a cookie */ 1322 #endif 1323 struct list_head pending_opens; /* list of incomplete opens */ 1324 struct cached_fids *cfids; 1325 struct list_head cifs_sb_list; 1326 spinlock_t sb_list_lock; 1327 #ifdef CONFIG_CIFS_DFS_UPCALL 1328 struct delayed_work dfs_cache_work; 1329 struct list_head dfs_ses_list; 1330 #endif 1331 struct delayed_work query_interfaces; /* query interfaces workqueue job */ 1332 char *origin_fullpath; /* canonical copy of smb3_fs_context::source */ 1333 }; 1334 1335 /* 1336 * This is a refcounted and timestamped container for a tcon pointer. The 1337 * container holds a tcon reference. It is considered safe to free one of 1338 * these when the tl_count goes to 0. The tl_time is the time of the last 1339 * "get" on the container. 1340 */ 1341 struct tcon_link { 1342 struct rb_node tl_rbnode; 1343 kuid_t tl_uid; 1344 unsigned long tl_flags; 1345 #define TCON_LINK_MASTER 0 1346 #define TCON_LINK_PENDING 1 1347 #define TCON_LINK_IN_TREE 2 1348 unsigned long tl_time; 1349 atomic_t tl_count; 1350 struct cifs_tcon *tl_tcon; 1351 }; 1352 1353 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb); 1354 extern void smb3_free_compound_rqst(int num_rqst, struct smb_rqst *rqst); 1355 1356 static inline struct cifs_tcon * 1357 tlink_tcon(struct tcon_link *tlink) 1358 { 1359 return tlink->tl_tcon; 1360 } 1361 1362 static inline struct tcon_link * 1363 cifs_sb_master_tlink(struct cifs_sb_info *cifs_sb) 1364 { 1365 return cifs_sb->master_tlink; 1366 } 1367 1368 extern void cifs_put_tlink(struct tcon_link *tlink); 1369 1370 static inline struct tcon_link * 1371 cifs_get_tlink(struct tcon_link *tlink) 1372 { 1373 if (tlink && !IS_ERR(tlink)) 1374 atomic_inc(&tlink->tl_count); 1375 return tlink; 1376 } 1377 1378 /* This function is always expected to succeed */ 1379 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb); 1380 1381 #define CIFS_OPLOCK_NO_CHANGE 0xfe 1382 1383 struct cifs_pending_open { 1384 struct list_head olist; 1385 struct tcon_link *tlink; 1386 __u8 lease_key[16]; 1387 __u32 oplock; 1388 }; 1389 1390 struct cifs_deferred_close { 1391 struct list_head dlist; 1392 struct tcon_link *tlink; 1393 __u16 netfid; 1394 __u64 persistent_fid; 1395 __u64 volatile_fid; 1396 }; 1397 1398 /* 1399 * This info hangs off the cifsFileInfo structure, pointed to by llist. 1400 * This is used to track byte stream locks on the file 1401 */ 1402 struct cifsLockInfo { 1403 struct list_head llist; /* pointer to next cifsLockInfo */ 1404 struct list_head blist; /* pointer to locks blocked on this */ 1405 wait_queue_head_t block_q; 1406 __u64 offset; 1407 __u64 length; 1408 __u32 pid; 1409 __u16 type; 1410 __u16 flags; 1411 }; 1412 1413 /* 1414 * One of these for each open instance of a file 1415 */ 1416 struct cifs_search_info { 1417 loff_t index_of_last_entry; 1418 __u16 entries_in_buffer; 1419 __u16 info_level; 1420 __u32 resume_key; 1421 char *ntwrk_buf_start; 1422 char *srch_entries_start; 1423 char *last_entry; 1424 const char *presume_name; 1425 unsigned int resume_name_len; 1426 bool endOfSearch:1; 1427 bool emptyDir:1; 1428 bool unicode:1; 1429 bool smallBuf:1; /* so we know which buf_release function to call */ 1430 }; 1431 1432 #define ACL_NO_MODE ((umode_t)(-1)) 1433 struct cifs_open_parms { 1434 struct cifs_tcon *tcon; 1435 struct cifs_sb_info *cifs_sb; 1436 int disposition; 1437 int desired_access; 1438 int create_options; 1439 const char *path; 1440 struct cifs_fid *fid; 1441 umode_t mode; 1442 bool reconnect:1; 1443 bool replay:1; /* indicates that this open is for a replay */ 1444 struct kvec *ea_cctx; 1445 __le32 lease_flags; 1446 }; 1447 1448 struct cifs_fid { 1449 __u16 netfid; 1450 __u64 persistent_fid; /* persist file id for smb2 */ 1451 __u64 volatile_fid; /* volatile file id for smb2 */ 1452 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */ 1453 __u8 parent_lease_key[SMB2_LEASE_KEY_SIZE]; 1454 __u8 create_guid[16]; 1455 __u32 access; 1456 struct cifs_pending_open *pending_open; 1457 __u16 epoch; 1458 #ifdef CONFIG_CIFS_DEBUG2 1459 __u64 mid; 1460 #endif /* CIFS_DEBUG2 */ 1461 bool purge_cache; 1462 }; 1463 1464 struct cifs_fid_locks { 1465 struct list_head llist; 1466 struct cifsFileInfo *cfile; /* fid that owns locks */ 1467 struct list_head locks; /* locks held by fid above */ 1468 }; 1469 1470 struct cifsFileInfo { 1471 /* following two lists are protected by tcon->open_file_lock */ 1472 struct list_head tlist; /* pointer to next fid owned by tcon */ 1473 struct list_head flist; /* next fid (file instance) for this inode */ 1474 /* lock list below protected by cifsi->lock_sem */ 1475 struct cifs_fid_locks *llist; /* brlocks held by this fid */ 1476 kuid_t uid; /* allows finding which FileInfo structure */ 1477 __u32 pid; /* process id who opened file */ 1478 struct cifs_fid fid; /* file id from remote */ 1479 struct list_head rlist; /* reconnect list */ 1480 /* BB add lock scope info here if needed */ 1481 /* lock scope id (0 if none) */ 1482 struct dentry *dentry; 1483 struct tcon_link *tlink; 1484 unsigned int f_flags; 1485 bool invalidHandle:1; /* file closed via session abend */ 1486 bool swapfile:1; 1487 bool oplock_break_cancelled:1; 1488 bool status_file_deleted:1; /* file has been deleted */ 1489 bool offload:1; /* offload final part of _put to a wq */ 1490 __u16 oplock_epoch; /* epoch from the lease break */ 1491 __u32 oplock_level; /* oplock/lease level from the lease break */ 1492 int count; 1493 spinlock_t file_info_lock; /* protects four flag/count fields above */ 1494 struct mutex fh_mutex; /* prevents reopen race after dead ses*/ 1495 struct cifs_search_info srch_inf; 1496 struct work_struct oplock_break; /* work for oplock breaks */ 1497 struct work_struct put; /* work for the final part of _put */ 1498 struct work_struct serverclose; /* work for serverclose */ 1499 struct delayed_work deferred; 1500 bool deferred_close_scheduled; /* Flag to indicate close is scheduled */ 1501 char *symlink_target; 1502 }; 1503 1504 struct cifs_io_parms { 1505 __u16 netfid; 1506 __u64 persistent_fid; /* persist file id for smb2 */ 1507 __u64 volatile_fid; /* volatile file id for smb2 */ 1508 __u32 pid; 1509 __u64 offset; 1510 unsigned int length; 1511 struct cifs_tcon *tcon; 1512 struct TCP_Server_Info *server; 1513 }; 1514 1515 struct cifs_io_request { 1516 struct netfs_io_request rreq; 1517 struct cifsFileInfo *cfile; 1518 pid_t pid; 1519 }; 1520 1521 /* asynchronous read support */ 1522 struct cifs_io_subrequest { 1523 union { 1524 struct netfs_io_subrequest subreq; 1525 struct netfs_io_request *rreq; 1526 struct cifs_io_request *req; 1527 }; 1528 ssize_t got_bytes; 1529 unsigned int xid; 1530 int result; 1531 bool have_xid; 1532 bool replay; 1533 struct kvec iov[2]; 1534 struct TCP_Server_Info *server; 1535 #ifdef CONFIG_CIFS_SMB_DIRECT 1536 struct smbd_mr *mr; 1537 #endif 1538 struct cifs_credits credits; 1539 }; 1540 1541 /* 1542 * Take a reference on the file private data. Must be called with 1543 * cfile->file_info_lock held. 1544 */ 1545 static inline void 1546 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file) 1547 { 1548 ++cifs_file->count; 1549 } 1550 1551 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file); 1552 void _cifsFileInfo_put(struct cifsFileInfo *cifs_file, bool wait_oplock_hdlr, 1553 bool offload); 1554 void cifsFileInfo_put(struct cifsFileInfo *cifs_file); 1555 1556 #define CIFS_CACHE_READ_FLG 1 1557 #define CIFS_CACHE_HANDLE_FLG 2 1558 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG) 1559 #define CIFS_CACHE_WRITE_FLG 4 1560 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG) 1561 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG) 1562 1563 #define CIFS_CACHE_READ(cinode) ((cinode->oplock & CIFS_CACHE_READ_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RO_CACHE)) 1564 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG) 1565 #define CIFS_CACHE_WRITE(cinode) ((cinode->oplock & CIFS_CACHE_WRITE_FLG) || (CIFS_SB(cinode->netfs.inode.i_sb)->mnt_cifs_flags & CIFS_MOUNT_RW_CACHE)) 1566 1567 /* 1568 * One of these for each file inode 1569 */ 1570 1571 struct cifsInodeInfo { 1572 struct netfs_inode netfs; /* Netfslib context and vfs inode */ 1573 bool can_cache_brlcks; 1574 struct list_head llist; /* locks helb by this inode */ 1575 /* 1576 * NOTE: Some code paths call down_read(lock_sem) twice, so 1577 * we must always use cifs_down_write() instead of down_write() 1578 * for this semaphore to avoid deadlocks. 1579 */ 1580 struct rw_semaphore lock_sem; /* protect the fields above */ 1581 /* BB add in lists for dirty pages i.e. write caching info for oplock */ 1582 struct list_head openFileList; 1583 spinlock_t open_file_lock; /* protects openFileList */ 1584 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */ 1585 unsigned int oplock; /* oplock/lease level we have */ 1586 __u16 epoch; /* used to track lease state changes */ 1587 #define CIFS_INODE_PENDING_OPLOCK_BREAK (0) /* oplock break in progress */ 1588 #define CIFS_INODE_PENDING_WRITERS (1) /* Writes in progress */ 1589 #define CIFS_INODE_FLAG_UNUSED (2) /* Unused flag */ 1590 #define CIFS_INO_DELETE_PENDING (3) /* delete pending on server */ 1591 #define CIFS_INO_INVALID_MAPPING (4) /* pagecache is invalid */ 1592 #define CIFS_INO_LOCK (5) /* lock bit for synchronization */ 1593 #define CIFS_INO_CLOSE_ON_LOCK (7) /* Not to defer the close when lock is set */ 1594 unsigned long flags; 1595 spinlock_t writers_lock; 1596 unsigned int writers; /* Number of writers on this inode */ 1597 unsigned long time; /* jiffies of last update of inode */ 1598 u64 uniqueid; /* server inode number */ 1599 u64 createtime; /* creation time on server */ 1600 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */ 1601 struct list_head deferred_closes; /* list of deferred closes */ 1602 spinlock_t deferred_lock; /* protection on deferred list */ 1603 bool lease_granted; /* Flag to indicate whether lease or oplock is granted. */ 1604 char *symlink_target; 1605 __u32 reparse_tag; 1606 }; 1607 1608 static inline struct cifsInodeInfo * 1609 CIFS_I(struct inode *inode) 1610 { 1611 return container_of(inode, struct cifsInodeInfo, netfs.inode); 1612 } 1613 1614 static inline struct cifs_sb_info * 1615 CIFS_SB(struct super_block *sb) 1616 { 1617 return sb->s_fs_info; 1618 } 1619 1620 static inline struct cifs_sb_info * 1621 CIFS_FILE_SB(struct file *file) 1622 { 1623 return CIFS_SB(file_inode(file)->i_sb); 1624 } 1625 1626 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb) 1627 { 1628 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS) 1629 return '/'; 1630 else 1631 return '\\'; 1632 } 1633 1634 static inline void 1635 convert_delimiter(char *path, char delim) 1636 { 1637 char old_delim, *pos; 1638 1639 if (delim == '/') 1640 old_delim = '\\'; 1641 else 1642 old_delim = '/'; 1643 1644 pos = path; 1645 while ((pos = strchr(pos, old_delim))) 1646 *pos = delim; 1647 } 1648 1649 #define cifs_stats_inc atomic_inc 1650 1651 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon, 1652 unsigned int bytes) 1653 { 1654 if (bytes) { 1655 spin_lock(&tcon->stat_lock); 1656 tcon->bytes_written += bytes; 1657 spin_unlock(&tcon->stat_lock); 1658 } 1659 } 1660 1661 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon, 1662 unsigned int bytes) 1663 { 1664 spin_lock(&tcon->stat_lock); 1665 tcon->bytes_read += bytes; 1666 spin_unlock(&tcon->stat_lock); 1667 } 1668 1669 1670 /* 1671 * This is the prototype for the mid receive function. This function is for 1672 * receiving the rest of the SMB frame, starting with the WordCount (which is 1673 * just after the MID in struct smb_hdr). Note: 1674 * 1675 * - This will be called by cifsd, with no locks held. 1676 * - The mid will still be on the pending_mid_q. 1677 * - mid->resp_buf will point to the current buffer. 1678 * 1679 * Returns zero on a successful receive, or an error. The receive state in 1680 * the TCP_Server_Info will also be updated. 1681 */ 1682 typedef int (mid_receive_t)(struct TCP_Server_Info *server, 1683 struct mid_q_entry *mid); 1684 1685 /* 1686 * This is the prototype for the mid callback function. This is called once the 1687 * mid has been received off of the socket. When creating one, take special 1688 * care to avoid deadlocks. Things to bear in mind: 1689 * 1690 * - it will be called by cifsd, with no locks held 1691 * - the mid will be removed from any lists 1692 */ 1693 typedef void (mid_callback_t)(struct mid_q_entry *mid); 1694 1695 /* 1696 * This is the protopyte for mid handle function. This is called once the mid 1697 * has been recognized after decryption of the message. 1698 */ 1699 typedef int (mid_handle_t)(struct TCP_Server_Info *server, 1700 struct mid_q_entry *mid); 1701 1702 /* one of these for every pending CIFS request to the server */ 1703 struct mid_q_entry { 1704 struct list_head qhead; /* mids waiting on reply from this server */ 1705 struct kref refcount; 1706 struct TCP_Server_Info *server; /* server corresponding to this mid */ 1707 __u64 mid; /* multiplex id */ 1708 __u16 credits; /* number of credits consumed by this mid */ 1709 __u16 credits_received; /* number of credits from the response */ 1710 __u32 pid; /* process id */ 1711 __u32 sequence_number; /* for CIFS signing */ 1712 unsigned long when_alloc; /* when mid was created */ 1713 #ifdef CONFIG_CIFS_STATS2 1714 unsigned long when_sent; /* time when smb send finished */ 1715 unsigned long when_received; /* when demux complete (taken off wire) */ 1716 #endif 1717 mid_receive_t *receive; /* call receive callback */ 1718 mid_callback_t *callback; /* call completion callback */ 1719 mid_handle_t *handle; /* call handle mid callback */ 1720 void *callback_data; /* general purpose pointer for callback */ 1721 struct task_struct *creator; 1722 void *resp_buf; /* pointer to received SMB header */ 1723 unsigned int resp_buf_size; 1724 int mid_state; /* wish this were enum but can not pass to wait_event */ 1725 int mid_rc; /* rc for MID_RC */ 1726 unsigned int mid_flags; 1727 __le16 command; /* smb command code */ 1728 unsigned int optype; /* operation type */ 1729 bool large_buf:1; /* if valid response, is pointer to large buf */ 1730 bool multiRsp:1; /* multiple trans2 responses for one request */ 1731 bool multiEnd:1; /* both received */ 1732 bool decrypted:1; /* decrypted entry */ 1733 }; 1734 1735 struct close_cancelled_open { 1736 struct cifs_fid fid; 1737 struct cifs_tcon *tcon; 1738 struct work_struct work; 1739 __u64 mid; 1740 __u16 cmd; 1741 }; 1742 1743 /* Make code in transport.c a little cleaner by moving 1744 update of optional stats into function below */ 1745 static inline void cifs_in_send_inc(struct TCP_Server_Info *server) 1746 { 1747 atomic_inc(&server->in_send); 1748 } 1749 1750 static inline void cifs_in_send_dec(struct TCP_Server_Info *server) 1751 { 1752 atomic_dec(&server->in_send); 1753 } 1754 1755 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server) 1756 { 1757 atomic_inc(&server->num_waiters); 1758 } 1759 1760 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server) 1761 { 1762 atomic_dec(&server->num_waiters); 1763 } 1764 1765 #ifdef CONFIG_CIFS_STATS2 1766 static inline void cifs_save_when_sent(struct mid_q_entry *mid) 1767 { 1768 mid->when_sent = jiffies; 1769 } 1770 #else 1771 static inline void cifs_save_when_sent(struct mid_q_entry *mid) 1772 { 1773 } 1774 #endif 1775 1776 /* for pending dnotify requests */ 1777 struct dir_notify_req { 1778 struct list_head lhead; 1779 __le16 Pid; 1780 __le16 PidHigh; 1781 __u16 Mid; 1782 __u16 Tid; 1783 __u16 Uid; 1784 __u16 netfid; 1785 __u32 filter; /* CompletionFilter (for multishot) */ 1786 int multishot; 1787 struct file *pfile; 1788 }; 1789 1790 struct dfs_info3_param { 1791 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/ 1792 int path_consumed; 1793 int server_type; 1794 int ref_flag; 1795 char *path_name; 1796 char *node_name; 1797 int ttl; 1798 }; 1799 1800 struct file_list { 1801 struct list_head list; 1802 struct cifsFileInfo *cfile; 1803 }; 1804 1805 struct cifs_mount_ctx { 1806 struct cifs_sb_info *cifs_sb; 1807 struct smb3_fs_context *fs_ctx; 1808 unsigned int xid; 1809 struct TCP_Server_Info *server; 1810 struct cifs_ses *ses; 1811 struct cifs_tcon *tcon; 1812 }; 1813 1814 static inline void __free_dfs_info_param(struct dfs_info3_param *param) 1815 { 1816 kfree(param->path_name); 1817 kfree(param->node_name); 1818 } 1819 1820 static inline void free_dfs_info_param(struct dfs_info3_param *param) 1821 { 1822 if (param) 1823 __free_dfs_info_param(param); 1824 } 1825 1826 static inline void zfree_dfs_info_param(struct dfs_info3_param *param) 1827 { 1828 if (param) { 1829 __free_dfs_info_param(param); 1830 memset(param, 0, sizeof(*param)); 1831 } 1832 } 1833 1834 static inline void free_dfs_info_array(struct dfs_info3_param *param, 1835 int number_of_items) 1836 { 1837 int i; 1838 1839 if ((number_of_items == 0) || (param == NULL)) 1840 return; 1841 for (i = 0; i < number_of_items; i++) { 1842 kfree(param[i].path_name); 1843 kfree(param[i].node_name); 1844 } 1845 kfree(param); 1846 } 1847 1848 static inline bool is_interrupt_error(int error) 1849 { 1850 switch (error) { 1851 case -EINTR: 1852 case -ERESTARTSYS: 1853 case -ERESTARTNOHAND: 1854 case -ERESTARTNOINTR: 1855 return true; 1856 } 1857 return false; 1858 } 1859 1860 static inline bool is_retryable_error(int error) 1861 { 1862 if (is_interrupt_error(error) || error == -EAGAIN) 1863 return true; 1864 return false; 1865 } 1866 1867 static inline bool is_replayable_error(int error) 1868 { 1869 if (error == -EAGAIN || error == -ECONNABORTED) 1870 return true; 1871 return false; 1872 } 1873 1874 1875 /* cifs_get_writable_file() flags */ 1876 #define FIND_WR_ANY 0 1877 #define FIND_WR_FSUID_ONLY 1 1878 #define FIND_WR_WITH_DELETE 2 1879 1880 #define MID_FREE 0 1881 #define MID_REQUEST_ALLOCATED 1 1882 #define MID_REQUEST_SUBMITTED 2 1883 #define MID_RESPONSE_RECEIVED 4 1884 #define MID_RETRY_NEEDED 8 /* session closed while this request out */ 1885 #define MID_RESPONSE_MALFORMED 0x10 1886 #define MID_SHUTDOWN 0x20 1887 #define MID_RESPONSE_READY 0x40 /* ready for other process handle the rsp */ 1888 #define MID_RC 0x80 /* mid_rc contains custom rc */ 1889 1890 /* Flags */ 1891 #define MID_WAIT_CANCELLED 1 /* Cancelled while waiting for response */ 1892 #define MID_DELETED 2 /* Mid has been dequeued/deleted */ 1893 1894 /* Types of response buffer returned from SendReceive2 */ 1895 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */ 1896 #define CIFS_SMALL_BUFFER 1 1897 #define CIFS_LARGE_BUFFER 2 1898 #define CIFS_IOVEC 4 /* array of response buffers */ 1899 1900 /* Type of Request to SendReceive2 */ 1901 #define CIFS_BLOCKING_OP 1 /* operation can block */ 1902 #define CIFS_NON_BLOCKING 2 /* do not block waiting for credits */ 1903 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */ 1904 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */ 1905 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */ 1906 #define CIFS_NO_RSP_BUF 0x040 /* no response buffer required */ 1907 1908 /* Type of request operation */ 1909 #define CIFS_ECHO_OP 0x080 /* echo request */ 1910 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */ 1911 #define CIFS_NEG_OP 0x0200 /* negotiate request */ 1912 #define CIFS_CP_CREATE_CLOSE_OP 0x0400 /* compound create+close request */ 1913 /* Lower bitmask values are reserved by others below. */ 1914 #define CIFS_SESS_OP 0x2000 /* session setup request */ 1915 #define CIFS_OP_MASK 0x2780 /* mask request type */ 1916 1917 #define CIFS_HAS_CREDITS 0x0400 /* already has credits */ 1918 #define CIFS_TRANSFORM_REQ 0x0800 /* transform request before sending */ 1919 #define CIFS_NO_SRV_RSP 0x1000 /* there is no server response */ 1920 #define CIFS_COMPRESS_REQ 0x4000 /* compress request before sending */ 1921 1922 /* Security Flags: indicate type of session setup needed */ 1923 #define CIFSSEC_MAY_SIGN 0x00001 1924 #define CIFSSEC_MAY_NTLMV2 0x00004 1925 #define CIFSSEC_MAY_KRB5 0x00008 1926 #define CIFSSEC_MAY_SEAL 0x00040 1927 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */ 1928 1929 #define CIFSSEC_MUST_SIGN 0x01001 1930 /* note that only one of the following can be set so the 1931 result of setting MUST flags more than once will be to 1932 require use of the stronger protocol */ 1933 #define CIFSSEC_MUST_NTLMV2 0x04004 1934 #define CIFSSEC_MUST_KRB5 0x08008 1935 #ifdef CONFIG_CIFS_UPCALL 1936 #define CIFSSEC_MASK 0xCF0CF /* flags supported if no weak allowed */ 1937 #else 1938 #define CIFSSEC_MASK 0xC70C7 /* flags supported if no weak allowed */ 1939 #endif /* UPCALL */ 1940 #define CIFSSEC_MUST_SEAL 0x40040 1941 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */ 1942 1943 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP | CIFSSEC_MAY_SEAL) 1944 #define CIFSSEC_MAX (CIFSSEC_MAY_SIGN | CIFSSEC_MUST_KRB5 | CIFSSEC_MAY_SEAL) 1945 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP) 1946 /* 1947 ***************************************************************** 1948 * All constants go here 1949 ***************************************************************** 1950 */ 1951 1952 #define UID_HASH (16) 1953 1954 /* 1955 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the 1956 * following to be declared. 1957 */ 1958 1959 /**************************************************************************** 1960 * Here are all the locks (spinlock, mutex, semaphore) in cifs.ko, arranged according 1961 * to the locking order. i.e. if two locks are to be held together, the lock that 1962 * appears higher in this list needs to be taken before the other. 1963 * 1964 * If you hold a lock that is lower in this list, and you need to take a higher lock 1965 * (or if you think that one of the functions that you're calling may need to), first 1966 * drop the lock you hold, pick up the higher lock, then the lower one. This will 1967 * ensure that locks are picked up only in one direction in the below table 1968 * (top to bottom). 1969 * 1970 * Also, if you expect a function to be called with a lock held, explicitly document 1971 * this in the comments on top of your function definition. 1972 * 1973 * And also, try to keep the critical sections (lock hold time) to be as minimal as 1974 * possible. Blocking / calling other functions with a lock held always increase 1975 * the risk of a possible deadlock. 1976 * 1977 * Following this rule will avoid unnecessary deadlocks, which can get really hard to 1978 * debug. Also, any new lock that you introduce, please add to this list in the correct 1979 * order. 1980 * 1981 * Please populate this list whenever you introduce new locks in your changes. Or in 1982 * case I've missed some existing locks. Please ensure that it's added in the list 1983 * based on the locking order expected. 1984 * 1985 * ===================================================================================== 1986 * Lock Protects Initialization fn 1987 * ===================================================================================== 1988 * vol_list_lock 1989 * vol_info->ctx_lock vol_info->ctx 1990 * cifs_sb_info->tlink_tree_lock cifs_sb_info->tlink_tree cifs_setup_cifs_sb 1991 * TCP_Server_Info-> TCP_Server_Info cifs_get_tcp_session 1992 * reconnect_mutex 1993 * TCP_Server_Info->srv_mutex TCP_Server_Info cifs_get_tcp_session 1994 * cifs_ses->session_mutex cifs_ses sesInfoAlloc 1995 * cifs_tcon->open_file_lock cifs_tcon->openFileList tconInfoAlloc 1996 * cifs_tcon->pending_opens 1997 * cifs_tcon->stat_lock cifs_tcon->bytes_read tconInfoAlloc 1998 * cifs_tcon->bytes_written 1999 * cifs_tcp_ses_lock cifs_tcp_ses_list sesInfoAlloc 2000 * GlobalMid_Lock GlobalMaxActiveXid init_cifs 2001 * GlobalCurrentXid 2002 * GlobalTotalActiveXid 2003 * TCP_Server_Info->srv_lock (anything in struct not protected by another lock and can change) 2004 * TCP_Server_Info->mid_lock TCP_Server_Info->pending_mid_q cifs_get_tcp_session 2005 * ->CurrentMid 2006 * (any changes in mid_q_entry fields) 2007 * TCP_Server_Info->req_lock TCP_Server_Info->in_flight cifs_get_tcp_session 2008 * ->credits 2009 * ->echo_credits 2010 * ->oplock_credits 2011 * ->reconnect_instance 2012 * cifs_ses->ses_lock (anything that is not protected by another lock and can change) 2013 * sesInfoAlloc 2014 * cifs_ses->iface_lock cifs_ses->iface_list sesInfoAlloc 2015 * ->iface_count 2016 * ->iface_last_update 2017 * cifs_ses->chan_lock cifs_ses->chans sesInfoAlloc 2018 * ->chans_need_reconnect 2019 * ->chans_in_reconnect 2020 * cifs_tcon->tc_lock (anything that is not protected by another lock and can change) 2021 * tcon_info_alloc 2022 * inode->i_rwsem, taken by fs/netfs/locking.c e.g. should be taken before cifsInodeInfo locks 2023 * cifsInodeInfo->open_file_lock cifsInodeInfo->openFileList cifs_alloc_inode 2024 * cifsInodeInfo->writers_lock cifsInodeInfo->writers cifsInodeInfo_alloc 2025 * cifsInodeInfo->lock_sem cifsInodeInfo->llist cifs_init_once 2026 * ->can_cache_brlcks 2027 * cifsInodeInfo->deferred_lock cifsInodeInfo->deferred_closes cifsInodeInfo_alloc 2028 * cached_fids->cfid_list_lock cifs_tcon->cfids->entries init_cached_dirs 2029 * cached_fid->fid_lock (anything that is not protected by another lock and can change) 2030 * init_cached_dir 2031 * cifsFileInfo->fh_mutex cifsFileInfo cifs_new_fileinfo 2032 * cifsFileInfo->file_info_lock cifsFileInfo->count cifs_new_fileinfo 2033 * ->invalidHandle initiate_cifs_search 2034 * ->oplock_break_cancelled 2035 ****************************************************************************/ 2036 2037 #ifdef DECLARE_GLOBALS_HERE 2038 #define GLOBAL_EXTERN 2039 #else 2040 #define GLOBAL_EXTERN extern 2041 #endif 2042 2043 /* 2044 * the list of TCP_Server_Info structures, ie each of the sockets 2045 * connecting our client to a distinct server (ip address), is 2046 * chained together by cifs_tcp_ses_list. The list of all our SMB 2047 * sessions (and from that the tree connections) can be found 2048 * by iterating over cifs_tcp_ses_list 2049 */ 2050 extern struct list_head cifs_tcp_ses_list; 2051 2052 /* 2053 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per 2054 * tcp session, and the list of tcon's per smb session. It also protects 2055 * the reference counters for the server, smb session, and tcon. 2056 * generally the locks should be taken in order tcp_ses_lock before 2057 * tcon->open_file_lock and that before file->file_info_lock since the 2058 * structure order is cifs_socket-->cifs_ses-->cifs_tcon-->cifs_file 2059 */ 2060 extern spinlock_t cifs_tcp_ses_lock; 2061 2062 /* 2063 * Global transaction id (XID) information 2064 */ 2065 extern unsigned int GlobalCurrentXid; /* protected by GlobalMid_Lock */ 2066 extern unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Lock */ 2067 extern unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Lock */ 2068 extern spinlock_t GlobalMid_Lock; /* protects above & list operations on midQ entries */ 2069 2070 /* 2071 * Global counters, updated atomically 2072 */ 2073 extern atomic_t sesInfoAllocCount; 2074 extern atomic_t tconInfoAllocCount; 2075 extern atomic_t tcpSesNextId; 2076 extern atomic_t tcpSesAllocCount; 2077 extern atomic_t tcpSesReconnectCount; 2078 extern atomic_t tconInfoReconnectCount; 2079 2080 /* Various Debug counters */ 2081 extern atomic_t buf_alloc_count; /* current number allocated */ 2082 extern atomic_t small_buf_alloc_count; 2083 #ifdef CONFIG_CIFS_STATS2 2084 extern atomic_t total_buf_alloc_count; /* total allocated over all time */ 2085 extern atomic_t total_small_buf_alloc_count; 2086 extern unsigned int slow_rsp_threshold; /* number of secs before logging */ 2087 #endif 2088 2089 /* Misc globals */ 2090 extern bool enable_oplocks; /* enable or disable oplocks */ 2091 extern bool lookupCacheEnabled; 2092 extern unsigned int global_secflags; /* if on, session setup sent 2093 with more secure ntlmssp2 challenge/resp */ 2094 extern unsigned int sign_CIFS_PDUs; /* enable smb packet signing */ 2095 extern bool enable_gcm_256; /* allow optional negotiate of strongest signing (aes-gcm-256) */ 2096 extern bool require_gcm_256; /* require use of strongest signing (aes-gcm-256) */ 2097 extern bool enable_negotiate_signing; /* request use of faster (GMAC) signing if available */ 2098 extern bool linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/ 2099 extern unsigned int CIFSMaxBufSize; /* max size not including hdr */ 2100 extern unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */ 2101 extern unsigned int cifs_min_small; /* min size of small buf pool */ 2102 extern unsigned int cifs_max_pending; /* MAX requests at once to server*/ 2103 extern unsigned int dir_cache_timeout; /* max time for directory lease caching of dir */ 2104 extern bool disable_legacy_dialects; /* forbid vers=1.0 and vers=2.0 mounts */ 2105 extern atomic_t mid_count; 2106 2107 void cifs_oplock_break(struct work_struct *work); 2108 void cifs_queue_oplock_break(struct cifsFileInfo *cfile); 2109 void smb2_deferred_work_close(struct work_struct *work); 2110 2111 extern const struct slow_work_ops cifs_oplock_break_ops; 2112 extern struct workqueue_struct *cifsiod_wq; 2113 extern struct workqueue_struct *decrypt_wq; 2114 extern struct workqueue_struct *fileinfo_put_wq; 2115 extern struct workqueue_struct *cifsoplockd_wq; 2116 extern struct workqueue_struct *deferredclose_wq; 2117 extern struct workqueue_struct *serverclose_wq; 2118 extern struct workqueue_struct *cfid_put_wq; 2119 extern __u32 cifs_lock_secret; 2120 2121 extern mempool_t *cifs_sm_req_poolp; 2122 extern mempool_t *cifs_req_poolp; 2123 extern mempool_t *cifs_mid_poolp; 2124 extern mempool_t cifs_io_request_pool; 2125 extern mempool_t cifs_io_subrequest_pool; 2126 2127 /* Operations for different SMB versions */ 2128 #define SMB1_VERSION_STRING "1.0" 2129 #define SMB20_VERSION_STRING "2.0" 2130 #ifdef CONFIG_CIFS_ALLOW_INSECURE_LEGACY 2131 extern struct smb_version_operations smb1_operations; 2132 extern struct smb_version_values smb1_values; 2133 extern struct smb_version_operations smb20_operations; 2134 extern struct smb_version_values smb20_values; 2135 #endif /* CIFS_ALLOW_INSECURE_LEGACY */ 2136 #define SMB21_VERSION_STRING "2.1" 2137 extern struct smb_version_operations smb21_operations; 2138 extern struct smb_version_values smb21_values; 2139 #define SMBDEFAULT_VERSION_STRING "default" 2140 extern struct smb_version_values smbdefault_values; 2141 #define SMB3ANY_VERSION_STRING "3" 2142 extern struct smb_version_values smb3any_values; 2143 #define SMB30_VERSION_STRING "3.0" 2144 extern struct smb_version_operations smb30_operations; 2145 extern struct smb_version_values smb30_values; 2146 #define SMB302_VERSION_STRING "3.02" 2147 #define ALT_SMB302_VERSION_STRING "3.0.2" 2148 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */ 2149 extern struct smb_version_values smb302_values; 2150 #define SMB311_VERSION_STRING "3.1.1" 2151 #define ALT_SMB311_VERSION_STRING "3.11" 2152 extern struct smb_version_operations smb311_operations; 2153 extern struct smb_version_values smb311_values; 2154 2155 static inline char *get_security_type_str(enum securityEnum sectype) 2156 { 2157 switch (sectype) { 2158 case RawNTLMSSP: 2159 return "RawNTLMSSP"; 2160 case Kerberos: 2161 return "Kerberos"; 2162 case NTLMv2: 2163 return "NTLMv2"; 2164 case IAKerb: 2165 return "IAKerb"; 2166 default: 2167 return "Unknown"; 2168 } 2169 } 2170 2171 static inline bool is_smb1_server(struct TCP_Server_Info *server) 2172 { 2173 return strcmp(server->vals->version_string, SMB1_VERSION_STRING) == 0; 2174 } 2175 2176 static inline bool is_tcon_dfs(struct cifs_tcon *tcon) 2177 { 2178 /* 2179 * For SMB1, see MS-CIFS 2.4.55 SMB_COM_TREE_CONNECT_ANDX (0x75) and MS-CIFS 3.3.4.4 DFS 2180 * Subsystem Notifies That a Share Is a DFS Share. 2181 * 2182 * For SMB2+, see MS-SMB2 2.2.10 SMB2 TREE_CONNECT Response and MS-SMB2 3.3.4.14 Server 2183 * Application Updates a Share. 2184 */ 2185 if (!tcon || !tcon->ses || !tcon->ses->server) 2186 return false; 2187 return is_smb1_server(tcon->ses->server) ? tcon->Flags & SMB_SHARE_IS_IN_DFS : 2188 tcon->share_flags & (SHI1005_FLAGS_DFS | SHI1005_FLAGS_DFS_ROOT); 2189 } 2190 2191 static inline bool cifs_is_referral_server(struct cifs_tcon *tcon, 2192 const struct dfs_info3_param *ref) 2193 { 2194 /* 2195 * Check if all targets are capable of handling DFS referrals as per 2196 * MS-DFSC 2.2.4 RESP_GET_DFS_REFERRAL. 2197 */ 2198 return is_tcon_dfs(tcon) || (ref && (ref->flags & DFSREF_REFERRAL_SERVER)); 2199 } 2200 2201 static inline u64 cifs_flock_len(const struct file_lock *fl) 2202 { 2203 return (u64)fl->fl_end - fl->fl_start + 1; 2204 } 2205 2206 static inline size_t ntlmssp_workstation_name_size(const struct cifs_ses *ses) 2207 { 2208 if (WARN_ON_ONCE(!ses || !ses->server)) 2209 return 0; 2210 /* 2211 * Make workstation name no more than 15 chars when using insecure dialects as some legacy 2212 * servers do require it during NTLMSSP. 2213 */ 2214 if (ses->server->dialect <= SMB20_PROT_ID) 2215 return min_t(size_t, sizeof(ses->workstation_name), RFC1001_NAME_LEN_WITH_NULL); 2216 return sizeof(ses->workstation_name); 2217 } 2218 2219 static inline void move_cifs_info_to_smb2(struct smb2_file_all_info *dst, const FILE_ALL_INFO *src) 2220 { 2221 memcpy(dst, src, (size_t)((u8 *)&src->EASize - (u8 *)src)); 2222 dst->IndexNumber = 0; 2223 dst->EASize = src->EASize; 2224 dst->AccessFlags = 0; 2225 dst->CurrentByteOffset = 0; 2226 dst->Mode = 0; 2227 dst->AlignmentRequirement = 0; 2228 dst->FileNameLength = src->FileNameLength; 2229 } 2230 2231 static inline int cifs_get_num_sgs(const struct smb_rqst *rqst, 2232 int num_rqst, 2233 const u8 *sig) 2234 { 2235 unsigned int len, skip; 2236 unsigned int nents = 0; 2237 unsigned long addr; 2238 size_t data_size; 2239 int i, j; 2240 2241 /* 2242 * The first rqst has a transform header where the first 20 bytes are 2243 * not part of the encrypted blob. 2244 */ 2245 skip = 20; 2246 2247 /* Assumes the first rqst has a transform header as the first iov. 2248 * I.e. 2249 * rqst[0].rq_iov[0] is transform header 2250 * rqst[0].rq_iov[1+] data to be encrypted/decrypted 2251 * rqst[1+].rq_iov[0+] data to be encrypted/decrypted 2252 */ 2253 for (i = 0; i < num_rqst; i++) { 2254 data_size = iov_iter_count(&rqst[i].rq_iter); 2255 2256 /* We really don't want a mixture of pinned and unpinned pages 2257 * in the sglist. It's hard to keep track of which is what. 2258 * Instead, we convert to a BVEC-type iterator higher up. 2259 */ 2260 if (data_size && 2261 WARN_ON_ONCE(user_backed_iter(&rqst[i].rq_iter))) 2262 return -EIO; 2263 2264 /* We also don't want to have any extra refs or pins to clean 2265 * up in the sglist. 2266 */ 2267 if (data_size && 2268 WARN_ON_ONCE(iov_iter_extract_will_pin(&rqst[i].rq_iter))) 2269 return -EIO; 2270 2271 for (j = 0; j < rqst[i].rq_nvec; j++) { 2272 struct kvec *iov = &rqst[i].rq_iov[j]; 2273 2274 addr = (unsigned long)iov->iov_base + skip; 2275 if (is_vmalloc_or_module_addr((void *)addr)) { 2276 len = iov->iov_len - skip; 2277 nents += DIV_ROUND_UP(offset_in_page(addr) + len, 2278 PAGE_SIZE); 2279 } else { 2280 nents++; 2281 } 2282 skip = 0; 2283 } 2284 if (data_size) 2285 nents += iov_iter_npages(&rqst[i].rq_iter, INT_MAX); 2286 } 2287 nents += DIV_ROUND_UP(offset_in_page(sig) + SMB2_SIGNATURE_SIZE, PAGE_SIZE); 2288 return nents; 2289 } 2290 2291 /* We can not use the normal sg_set_buf() as we will sometimes pass a 2292 * stack object as buf. 2293 */ 2294 static inline void cifs_sg_set_buf(struct sg_table *sgtable, 2295 const void *buf, 2296 unsigned int buflen) 2297 { 2298 unsigned long addr = (unsigned long)buf; 2299 unsigned int off = offset_in_page(addr); 2300 2301 addr &= PAGE_MASK; 2302 if (is_vmalloc_or_module_addr((void *)addr)) { 2303 do { 2304 unsigned int len = min_t(unsigned int, buflen, PAGE_SIZE - off); 2305 2306 sg_set_page(&sgtable->sgl[sgtable->nents++], 2307 vmalloc_to_page((void *)addr), len, off); 2308 2309 off = 0; 2310 addr += PAGE_SIZE; 2311 buflen -= len; 2312 } while (buflen); 2313 } else { 2314 sg_set_page(&sgtable->sgl[sgtable->nents++], 2315 virt_to_page((void *)addr), buflen, off); 2316 } 2317 } 2318 2319 #define CIFS_OPARMS(_cifs_sb, _tcon, _path, _da, _cd, _co, _mode) \ 2320 ((struct cifs_open_parms) { \ 2321 .tcon = _tcon, \ 2322 .path = _path, \ 2323 .desired_access = (_da), \ 2324 .disposition = (_cd), \ 2325 .create_options = cifs_create_options(_cifs_sb, (_co)), \ 2326 .mode = (_mode), \ 2327 .cifs_sb = _cifs_sb, \ 2328 }) 2329 2330 struct smb2_compound_vars { 2331 struct cifs_open_parms oparms; 2332 struct kvec rsp_iov[MAX_COMPOUND]; 2333 struct smb_rqst rqst[MAX_COMPOUND]; 2334 struct kvec open_iov[SMB2_CREATE_IOV_SIZE]; 2335 struct kvec qi_iov; 2336 struct kvec io_iov[SMB2_IOCTL_IOV_SIZE]; 2337 struct kvec si_iov[SMB2_SET_INFO_IOV_SIZE]; 2338 struct kvec close_iov; 2339 struct smb2_file_rename_info_hdr rename_info; 2340 struct smb2_file_link_info_hdr link_info; 2341 struct kvec ea_iov; 2342 }; 2343 2344 static inline bool cifs_ses_exiting(struct cifs_ses *ses) 2345 { 2346 bool ret; 2347 2348 spin_lock(&ses->ses_lock); 2349 ret = ses->ses_status == SES_EXITING; 2350 spin_unlock(&ses->ses_lock); 2351 return ret; 2352 } 2353 2354 static inline bool cifs_netbios_name(const char *name, size_t namelen) 2355 { 2356 bool ret = false; 2357 size_t i; 2358 2359 if (namelen >= 1 && namelen <= RFC1001_NAME_LEN) { 2360 for (i = 0; i < namelen; i++) { 2361 const unsigned char c = name[i]; 2362 2363 if (c == '\\' || c == '/' || c == ':' || c == '*' || 2364 c == '?' || c == '"' || c == '<' || c == '>' || 2365 c == '|' || c == '.') 2366 return false; 2367 if (!ret && isalpha(c)) 2368 ret = true; 2369 } 2370 } 2371 return ret; 2372 } 2373 2374 #endif /* _CIFS_GLOB_H */ 2375