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