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