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