1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright 2017 Nexenta Systems, Inc. All rights reserved. 24 */ 25 26 /* 27 * Structures and type definitions for the SMB module. 28 */ 29 30 #ifndef _SMBSRV_SMB_KTYPES_H 31 #define _SMBSRV_SMB_KTYPES_H 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 #include <sys/note.h> 38 #include <sys/systm.h> 39 #include <sys/param.h> 40 #include <sys/types.h> 41 #include <sys/synch.h> 42 #include <sys/taskq.h> 43 #include <sys/socket.h> 44 #include <sys/acl.h> 45 #include <sys/sdt.h> 46 #include <sys/stat.h> 47 #include <sys/vnode.h> 48 #include <sys/cred.h> 49 #include <netinet/in.h> 50 #include <sys/ksocket.h> 51 #include <sys/fem.h> 52 #include <smbsrv/smb.h> 53 #include <smbsrv/smb2.h> 54 #include <smbsrv/smbinfo.h> 55 #include <smbsrv/mbuf.h> 56 #include <smbsrv/smb_sid.h> 57 #include <smbsrv/smb_xdr.h> 58 #include <smbsrv/netbios.h> 59 #include <smbsrv/smb_vops.h> 60 #include <smbsrv/smb_kstat.h> 61 62 struct __door_handle; /* <sys/door.h> */ 63 struct edirent; /* <sys/extdirent.h> */ 64 65 struct smb_disp_entry; 66 struct smb_request; 67 struct smb_server; 68 struct smb_event; 69 struct smb_export; 70 71 /* 72 * Accumulated time and queue length statistics. 73 * 74 * Accumulated time statistics are kept as a running sum of "active" time. 75 * Queue length statistics are kept as a running sum of the product of queue 76 * length and elapsed time at that length -- i.e., a Riemann sum for queue 77 * length integrated against time. (You can also think of the active time as a 78 * Riemann sum, for the boolean function (queue_length > 0) integrated against 79 * time, or you can think of it as the Lebesgue measure of the set on which 80 * queue_length > 0.) 81 * 82 * ^ 83 * | _________ 84 * 8 | i4 | 85 * | | | 86 * Queue 6 | | 87 * Length | _________ | | 88 * 4 | i2 |_______| | 89 * | | i3 | 90 * 2_______| | 91 * | i1 | 92 * |_______________________________| 93 * Time-> t1 t2 t3 t4 94 * 95 * At each change of state (entry or exit from the queue), we add the elapsed 96 * time (since the previous state change) to the active time if the queue length 97 * was non-zero during that interval; and we add the product of the elapsed time 98 * times the queue length to the running length*time sum. 99 * 100 * This method is generalizable to measuring residency in any defined system: 101 * instead of queue lengths, think of "outstanding RPC calls to server X". 102 * 103 * A large number of I/O subsystems have at least two basic "lists" of 104 * transactions they manage: one for transactions that have been accepted for 105 * processing but for which processing has yet to begin, and one for 106 * transactions which are actively being processed (but not done). For this 107 * reason, two cumulative time statistics are defined here: wait (pre-service) 108 * time, and run (service) time. 109 * 110 * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime(). 111 * 112 * The units of cumulative busy time are accumulated nanoseconds. The units of 113 * cumulative length*time products are elapsed time times queue length. 114 * 115 * Updates to the fields below are performed implicitly by calls to 116 * these functions: 117 * 118 * smb_srqueue_init() 119 * smb_srqueue_destroy() 120 * smb_srqueue_waitq_enter() 121 * smb_srqueue_runq_exit() 122 * smb_srqueue_waitq_to_runq() 123 * smb_srqueue_update() 124 * 125 * These fields should never be updated by any other means. 126 */ 127 typedef struct smb_srqueue { 128 kmutex_t srq_mutex; 129 hrtime_t srq_wlastupdate; 130 hrtime_t srq_wtime; 131 hrtime_t srq_wlentime; 132 hrtime_t srq_rlastupdate; 133 hrtime_t srq_rtime; 134 hrtime_t srq_rlentime; 135 uint32_t srq_wcnt; 136 uint32_t srq_rcnt; 137 } smb_srqueue_t; 138 139 /* 140 * The fields with the prefix 'ly_a' contain the statistics collected since the 141 * server was last started ('a' for 'aggregated'). The fields with the prefix 142 * 'ly_d' contain the statistics collected since the last snapshot ('d' for 143 * 'delta'). 144 */ 145 typedef struct smb_latency { 146 kmutex_t ly_mutex; 147 uint64_t ly_a_nreq; 148 hrtime_t ly_a_sum; 149 hrtime_t ly_a_mean; 150 hrtime_t ly_a_stddev; 151 uint64_t ly_d_nreq; 152 hrtime_t ly_d_sum; 153 hrtime_t ly_d_mean; 154 hrtime_t ly_d_stddev; 155 } smb_latency_t; 156 157 typedef struct smb_disp_stats { 158 volatile uint64_t sdt_txb; 159 volatile uint64_t sdt_rxb; 160 smb_latency_t sdt_lat; 161 } smb_disp_stats_t; 162 163 int smb_noop(void *, size_t, int); 164 165 #define SMB_AUDIT_STACK_DEPTH 16 166 #define SMB_AUDIT_BUF_MAX_REC 16 167 #define SMB_AUDIT_NODE 0x00000001 168 169 /* 170 * Maximum number of records returned in SMBsearch, SMBfind 171 * and SMBfindunique response. Value set to 10 for compatibility 172 * with Windows. 173 */ 174 #define SMB_MAX_SEARCH 10 175 176 #define SMB_SEARCH_ATTRIBUTES \ 177 (FILE_ATTRIBUTE_HIDDEN | \ 178 FILE_ATTRIBUTE_SYSTEM | \ 179 FILE_ATTRIBUTE_DIRECTORY) 180 181 #define SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN) 182 #define SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM) 183 #define SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY) 184 #define SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES) 185 186 typedef struct { 187 uint32_t anr_refcnt; 188 int anr_depth; 189 pc_t anr_stack[SMB_AUDIT_STACK_DEPTH]; 190 } smb_audit_record_node_t; 191 192 typedef struct { 193 int anb_index; 194 int anb_max_index; 195 smb_audit_record_node_t anb_records[SMB_AUDIT_BUF_MAX_REC]; 196 } smb_audit_buf_node_t; 197 198 /* 199 * Thread State Machine 200 * -------------------- 201 * 202 * T5 T0 203 * smb_thread_destroy() <-------+ +------- smb_thread_init() 204 * | | 205 * | v 206 * +-----------------------------+ 207 * | SMB_THREAD_STATE_EXITED |<---+ 208 * +-----------------------------+ | 209 * | T1 | 210 * v | 211 * +-----------------------------+ | 212 * | SMB_THREAD_STATE_STARTING | | 213 * +-----------------------------+ | 214 * | T2 | T4 215 * v | 216 * +-----------------------------+ | 217 * | SMB_THREAD_STATE_RUNNING | | 218 * +-----------------------------+ | 219 * | T3 | 220 * v | 221 * +-----------------------------+ | 222 * | SMB_THREAD_STATE_EXITING |----+ 223 * +-----------------------------+ 224 * 225 * Transition T0 226 * 227 * This transition is executed in smb_thread_init(). 228 * 229 * Transition T1 230 * 231 * This transition is executed in smb_thread_start(). 232 * 233 * Transition T2 234 * 235 * This transition is executed by the thread itself when it starts running. 236 * 237 * Transition T3 238 * 239 * This transition is executed by the thread itself in 240 * smb_thread_entry_point() just before calling thread_exit(). 241 * 242 * 243 * Transition T4 244 * 245 * This transition is executed in smb_thread_stop(). 246 * 247 * Transition T5 248 * 249 * This transition is executed in smb_thread_destroy(). 250 */ 251 typedef enum smb_thread_state { 252 SMB_THREAD_STATE_STARTING = 0, 253 SMB_THREAD_STATE_RUNNING, 254 SMB_THREAD_STATE_EXITING, 255 SMB_THREAD_STATE_EXITED, 256 SMB_THREAD_STATE_FAILED 257 } smb_thread_state_t; 258 259 struct _smb_thread; 260 261 typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg); 262 263 #define SMB_THREAD_MAGIC 0x534D4254 /* SMBT */ 264 265 typedef struct _smb_thread { 266 uint32_t sth_magic; 267 char sth_name[32]; 268 smb_thread_state_t sth_state; 269 kthread_t *sth_th; 270 kt_did_t sth_did; 271 smb_thread_ep_t sth_ep; 272 void *sth_ep_arg; 273 pri_t sth_pri; 274 boolean_t sth_kill; 275 kmutex_t sth_mtx; 276 kcondvar_t sth_cv; 277 } smb_thread_t; 278 279 /* 280 * Pool of IDs 281 * ----------- 282 * 283 * A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap. 284 * A bit set to '1' indicates that that particular value has been allocated. 285 * The allocation process is done shifting a bit through the whole bitmap. 286 * The current position of that index bit is kept in the smb_idpool_t 287 * structure and represented by a byte index (0 to buffer size minus 1) and 288 * a bit index (0 to 7). 289 * 290 * The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs 291 * out of IDs its current size is doubled until it reaches its maximum size 292 * (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which 293 * means that a pool can have a maximum number of 65534 IDs available. 294 */ 295 #define SMB_IDPOOL_MAGIC 0x4944504C /* IDPL */ 296 #define SMB_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 297 #define SMB_IDPOOL_MAX_SIZE 64 * 1024 298 299 typedef struct smb_idpool { 300 uint32_t id_magic; 301 kmutex_t id_mutex; 302 uint8_t *id_pool; 303 uint32_t id_size; 304 uint32_t id_maxsize; 305 uint8_t id_bit; 306 uint8_t id_bit_idx; 307 uint32_t id_idx; 308 uint32_t id_idx_msk; 309 uint32_t id_free_counter; 310 uint32_t id_max_free_counter; 311 } smb_idpool_t; 312 313 /* 314 * Maximum size of a Transport Data Unit when CAP_LARGE_READX and 315 * CAP_LARGE_WRITEX are not set. CAP_LARGE_READX/CAP_LARGE_WRITEX 316 * allow the payload to exceed the negotiated buffer size. 317 * 4 --> NBT/TCP Transport Header. 318 * 32 --> SMB Header 319 * 1 --> Word Count byte 320 * 510 --> Maximum Number of bytes of the Word Table (2 * 255) 321 * 2 --> Byte count of the data 322 * 65535 --> Maximum size of the data 323 * ----- 324 * 66084 325 */ 326 #define SMB_REQ_MAX_SIZE 66560 /* 65KB */ 327 #define SMB_XPRT_MAX_SIZE (SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ) 328 329 #define SMB_TXREQ_MAGIC 0X54524251 /* 'TREQ' */ 330 typedef struct { 331 list_node_t tr_lnd; 332 uint32_t tr_magic; 333 int tr_len; 334 uint8_t tr_buf[SMB_XPRT_MAX_SIZE]; 335 } smb_txreq_t; 336 337 #define SMB_TXLST_MAGIC 0X544C5354 /* 'TLST' */ 338 typedef struct { 339 uint32_t tl_magic; 340 kmutex_t tl_mutex; 341 kcondvar_t tl_wait_cv; 342 boolean_t tl_active; 343 } smb_txlst_t; 344 345 /* 346 * Maximum buffer size for NT is 37KB. If all clients are Windows 2000, this 347 * can be changed to 64KB. 37KB must be used with a mix of NT/Windows 2000 348 * clients because NT loses directory entries when values greater than 37KB are 349 * used. 350 * 351 * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to 352 * account for the NBT header. 353 */ 354 #define NBT_MAXBUF 8 355 #define SMB_NT_MAXBUF (37 * 1024) 356 357 #define OUTBUFSIZE (65 * 1024) 358 #define SMBHEADERSIZE 32 359 #define SMBND_HASH_MASK (0xFF) 360 #define MAX_IOVEC 512 361 #define MAX_READREF (8 * 1024) 362 363 #define SMB_WORKER_MIN 4 364 #define SMB_WORKER_DEFAULT 64 365 #define SMB_WORKER_MAX 1024 366 367 /* 368 * Destructor object used in the locked-list delete queue. 369 */ 370 #define SMB_DTOR_MAGIC 0x44544F52 /* DTOR */ 371 #define SMB_DTOR_VALID(d) \ 372 ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC)) 373 374 typedef void (*smb_dtorproc_t)(void *); 375 376 typedef struct smb_dtor { 377 list_node_t dt_lnd; 378 uint32_t dt_magic; 379 void *dt_object; 380 smb_dtorproc_t dt_proc; 381 } smb_dtor_t; 382 383 typedef struct smb_llist { 384 krwlock_t ll_lock; 385 list_t ll_list; 386 uint32_t ll_count; 387 uint64_t ll_wrop; 388 kmutex_t ll_mutex; 389 list_t ll_deleteq; 390 uint32_t ll_deleteq_count; 391 boolean_t ll_flushing; 392 } smb_llist_t; 393 394 typedef struct smb_bucket { 395 smb_llist_t b_list; 396 uint32_t b_max_seen; 397 } smb_bucket_t; 398 399 typedef struct smb_hash { 400 uint32_t rshift; 401 uint32_t num_buckets; 402 smb_bucket_t *buckets; 403 } smb_hash_t; 404 405 typedef struct smb_slist { 406 kmutex_t sl_mutex; 407 kcondvar_t sl_cv; 408 list_t sl_list; 409 uint32_t sl_count; 410 boolean_t sl_waiting; 411 } smb_slist_t; 412 413 /* 414 * smb_avl_t State Machine 415 * -------------------- 416 * 417 * +-----------------------------+ 418 * | SMB_AVL_STATE_START | 419 * +-----------------------------+ 420 * | T0 421 * v 422 * +-----------------------------+ 423 * | SMB_AVL_STATE_READY | 424 * +-----------------------------+ 425 * | T1 426 * v 427 * +-----------------------------+ 428 * | SMB_AVL_STATE_DESTROYING | 429 * +-----------------------------+ 430 * 431 * Transition T0 432 * 433 * This transition is executed in smb_avl_create(). 434 * 435 * Transition T1 436 * 437 * This transition is executed in smb_avl_destroy(). 438 * 439 */ 440 typedef enum { 441 SMB_AVL_STATE_START = 0, 442 SMB_AVL_STATE_READY, 443 SMB_AVL_STATE_DESTROYING 444 } smb_avl_state_t; 445 446 typedef struct smb_avl_nops { 447 int (*avln_cmp) (const void *, const void *); 448 void (*avln_hold)(const void *); 449 boolean_t (*avln_rele)(const void *); 450 void (*avln_destroy)(void *); 451 } smb_avl_nops_t; 452 453 typedef struct smb_avl_cursor { 454 void *avlc_next; 455 uint32_t avlc_sequence; 456 } smb_avl_cursor_t; 457 458 typedef struct smb_avl { 459 krwlock_t avl_lock; 460 avl_tree_t avl_tree; 461 kmutex_t avl_mutex; 462 kcondvar_t avl_cv; 463 smb_avl_state_t avl_state; 464 uint32_t avl_refcnt; 465 uint32_t avl_sequence; 466 const smb_avl_nops_t *avl_nops; 467 } smb_avl_t; 468 469 typedef struct { 470 kcondvar_t rwx_cv; 471 kmutex_t rwx_mutex; 472 krwlock_t rwx_lock; 473 boolean_t rwx_waiting; 474 } smb_rwx_t; 475 476 typedef struct smb_export { 477 kmutex_t e_mutex; 478 boolean_t e_ready; 479 smb_llist_t e_vfs_list; 480 smb_avl_t e_share_avl; 481 smb_slist_t e_unexport_list; 482 smb_thread_t e_unexport_thread; 483 } smb_export_t; 484 485 /* 486 * NOTIFY CHANGE, a.k.a. File Change Notification (FCN) 487 */ 488 489 /* 490 * These FCN filter mask values are not from MS-FSCC, but 491 * must not overlap with any FILE_NOTIFY_VALID_MASK values. 492 */ 493 #define FILE_NOTIFY_CHANGE_EV_SUBDIR 0x00010000 494 #define FILE_NOTIFY_CHANGE_EV_DELETE 0x00020000 495 #define FILE_NOTIFY_CHANGE_EV_CLOSED 0x00040000 496 #define FILE_NOTIFY_CHANGE_EV_OVERFLOW 0x00080000 497 498 /* 499 * Note: These FCN action values are not from MS-FSCC, but must 500 * follow in sequence from FILE_ACTION_MODIFIED_STREAM. 501 * 502 * FILE_ACTION_SUBDIR_CHANGED is used internally for 503 * "watch tree" support, posted to all parents of a 504 * directory that had one of the changes above. 505 * 506 * FILE_ACTION_DELETE_PENDING is used internally to tell 507 * notify change requests when the "delete-on-close" flag 508 * has been set on the directory being watched. 509 * 510 * FILE_ACTION_HANDLE_CLOSED is used to wakeup notify change 511 * requests when the watched directory handle is closed. 512 */ 513 #define FILE_ACTION_SUBDIR_CHANGED 0x00000009 514 #define FILE_ACTION_DELETE_PENDING 0x0000000a 515 #define FILE_ACTION_HANDLE_CLOSED 0x0000000b 516 517 /* 518 * Sub-struct within smb_ofile_t 519 */ 520 typedef struct smb_notify { 521 list_t nc_waiters; /* Waiting SRs */ 522 mbuf_chain_t nc_buffer; 523 uint32_t nc_filter; 524 uint32_t nc_events; 525 int nc_last_off; 526 boolean_t nc_subscribed; 527 } smb_notify_t; 528 529 /* 530 * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly 531 * over TCP, which is also known as direct hosted NetBIOS-less SMB 532 * or SMB-over-TCP. 533 * 534 * NBT messages have a 4-byte header that defines the message type 535 * (8-bits), a 7-bit flags field and a 17-bit length. 536 * 537 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 538 * | TYPE | FLAGS |E| LENGTH | 539 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 540 * 541 * 8-bit type Defined in RFC 1002 542 * 7-bit flags Bits 0-6 reserved (must be 0) 543 * Bit 7: Length extension bit (E) 544 * 17-bit length Includes bit 7 of the flags byte 545 * 546 * 547 * SMB-over-TCP is defined to use a modified version of the NBT header 548 * containing an 8-bit message type and 24-bit message length. 549 * 550 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 551 * | TYPE | LENGTH | 552 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 553 * 554 * 8-bit type Must be 0 555 * 24-bit length 556 * 557 * The following structure is used to represent a generic, in-memory 558 * SMB transport header; it is not intended to map directly to either 559 * of the over-the-wire formats. 560 */ 561 typedef struct { 562 uint8_t xh_type; 563 uint32_t xh_length; 564 } smb_xprt_t; 565 566 int MBC_LENGTH(struct mbuf_chain *); 567 int MBC_MAXBYTES(struct mbuf_chain *); 568 void MBC_SETUP(struct mbuf_chain *, uint32_t); 569 void MBC_INIT(struct mbuf_chain *, uint32_t); 570 void MBC_FLUSH(struct mbuf_chain *); 571 void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *); 572 void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *); 573 void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN); 574 int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC, 575 int OFF, int LEN); 576 577 #define MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes) 578 579 /* 580 * Per smb_node oplock state 581 */ 582 typedef struct smb_oplock { 583 kmutex_t ol_mutex; 584 boolean_t ol_fem; /* fem monitor installed? */ 585 struct smb_ofile *excl_open; 586 uint32_t ol_state; 587 int32_t cnt_II; 588 int32_t cnt_R; 589 int32_t cnt_RH; 590 int32_t cnt_RHBQ; 591 int32_t waiters; 592 kcondvar_t WaitingOpenCV; 593 } smb_oplock_t; 594 595 /* 596 * Per smb_ofile oplock state 597 */ 598 typedef struct smb_oplock_grant { 599 /* smb protocol-level state */ 600 uint32_t og_state; /* latest sent to client */ 601 uint32_t og_breaking; /* BREAK_TO... flags */ 602 uint16_t og_dialect; /* how to send breaks */ 603 /* File-system level state */ 604 uint8_t onlist_II; 605 uint8_t onlist_R; 606 uint8_t onlist_RH; 607 uint8_t onlist_RHBQ; 608 uint8_t BreakingToRead; 609 } smb_oplock_grant_t; 610 611 #define SMB_LEASE_KEY_SZ 16 612 613 typedef struct smb_lease { 614 list_node_t ls_lnd; /* sv_lease_ht */ 615 kmutex_t ls_mutex; 616 smb_llist_t *ls_bucket; 617 struct smb_node *ls_node; 618 /* 619 * With a lease, just one ofile has the oplock. 620 * This (used only for comparison) identifies which. 621 */ 622 void *ls_oplock_ofile; 623 uint32_t ls_refcnt; 624 uint32_t ls_state; 625 uint32_t ls_breaking; /* BREAK_TO... flags */ 626 uint16_t ls_epoch; 627 uint16_t ls_version; 628 uint8_t ls_key[SMB_LEASE_KEY_SZ]; 629 uint8_t ls_clnt[SMB_LEASE_KEY_SZ]; 630 } smb_lease_t; 631 632 #define SMB_VFS_MAGIC 0x534D4256 /* 'SMBV' */ 633 634 typedef struct smb_vfs { 635 list_node_t sv_lnd; 636 uint32_t sv_magic; 637 uint32_t sv_refcnt; 638 vfs_t *sv_vfsp; 639 vnode_t *sv_rootvp; 640 } smb_vfs_t; 641 642 #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 643 #define SMB_NODE_VALID(p) ASSERT((p)->n_magic == SMB_NODE_MAGIC) 644 645 typedef enum { 646 SMB_NODE_STATE_AVAILABLE = 0, 647 SMB_NODE_STATE_DESTROYING 648 } smb_node_state_t; 649 650 /* 651 * waiting_event # of clients requesting FCN 652 * n_timestamps cached timestamps 653 * n_allocsz cached file allocation size 654 * n_dnode directory node 655 * n_unode unnamed stream node 656 * delete_on_close_cred credentials for delayed delete 657 */ 658 typedef struct smb_node { 659 list_node_t n_lnd; 660 uint32_t n_magic; 661 krwlock_t n_lock; 662 kmutex_t n_mutex; 663 smb_node_state_t n_state; 664 uint32_t n_refcnt; 665 uint32_t n_hashkey; 666 smb_llist_t *n_hash_bucket; 667 uint32_t n_open_count; 668 uint32_t n_opening_count; 669 smb_llist_t n_ofile_list; 670 /* If entering both, go in order n_lock_list, n_wlock_list */ 671 smb_llist_t n_lock_list; /* active locks */ 672 smb_llist_t n_wlock_list; /* waiting locks */ 673 volatile int flags; 674 u_offset_t n_allocsz; 675 uint32_t n_fcn_count; 676 smb_oplock_t n_oplock; 677 struct smb_node *n_dnode; 678 struct smb_node *n_unode; 679 cred_t *delete_on_close_cred; 680 uint32_t n_delete_on_close_flags; 681 char od_name[MAXNAMELEN]; 682 vnode_t *vp; 683 smb_audit_buf_node_t *n_audit_buf; 684 } smb_node_t; 685 686 #define NODE_FLAGS_REPARSE 0x00001000 687 #define NODE_FLAGS_DFSLINK 0x00002000 688 #define NODE_FLAGS_VFSROOT 0x00004000 689 #define NODE_FLAGS_SYSTEM 0x00008000 690 #define NODE_FLAGS_WRITE_THROUGH 0x00100000 691 #define NODE_XATTR_DIR 0x01000000 692 #define NODE_FLAGS_DELETE_COMMITTED 0x20000000 693 #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 694 #define NODE_FLAGS_EXECUTABLE 0x80000000 695 696 #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 697 #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 698 699 /* Maximum buffer size for encryption key */ 700 #define SMB_ENCRYPT_KEY_MAXLEN 32 701 702 #define SMB_SHARE_MAGIC 0x4B534852 /* KSHR */ 703 704 typedef struct smb_kshare { 705 uint32_t shr_magic; 706 char *shr_name; 707 char *shr_path; 708 char *shr_cmnt; 709 char *shr_container; 710 char *shr_oemname; 711 uint32_t shr_flags; 712 uint32_t shr_type; 713 uint32_t shr_refcnt; 714 uint32_t shr_autocnt; 715 uid_t shr_uid; 716 gid_t shr_gid; 717 char *shr_access_none; 718 char *shr_access_ro; 719 char *shr_access_rw; 720 avl_node_t shr_link; 721 kmutex_t shr_mutex; 722 } smb_kshare_t; 723 724 725 typedef struct smb_arg_negotiate { 726 char *ni_name; 727 int ni_dialect; 728 int ni_index; 729 uint32_t ni_capabilities; 730 uint16_t ni_maxmpxcount; 731 int16_t ni_tzcorrection; 732 uint8_t ni_keylen; 733 uint8_t ni_key[SMB_ENCRYPT_KEY_MAXLEN]; 734 timestruc_t ni_servertime; 735 } smb_arg_negotiate_t; 736 737 typedef enum { 738 SMB_SSNSETUP_PRE_NTLM012 = 1, 739 SMB_SSNSETUP_NTLM012_NOEXT, 740 SMB_SSNSETUP_NTLM012_EXTSEC 741 } smb_ssnsetup_type_t; 742 743 typedef struct smb_arg_sessionsetup { 744 smb_ssnsetup_type_t ssi_type; 745 char *ssi_user; 746 char *ssi_domain; 747 /* LM password hash, f.k.a. case-insensitive p/w */ 748 uint16_t ssi_lmpwlen; 749 uint8_t *ssi_lmpwd; 750 /* NT password hash, f.k.a. case-sensitive p/w */ 751 uint16_t ssi_ntpwlen; 752 uint8_t *ssi_ntpwd; 753 /* Incoming security blob */ 754 uint16_t ssi_iseclen; 755 uint8_t *ssi_isecblob; 756 /* Incoming security blob */ 757 uint16_t ssi_oseclen; 758 uint8_t *ssi_osecblob; 759 /* parameters */ 760 uint16_t ssi_maxbufsize; 761 uint16_t ssi_maxmpxcount; 762 uint32_t ssi_capabilities; 763 int ssi_native_os; 764 int ssi_native_lm; 765 } smb_arg_sessionsetup_t; 766 767 typedef struct tcon { 768 char *name; 769 char *path; 770 char *service; 771 int pwdlen; 772 char *password; 773 uint16_t flags; 774 uint16_t optional_support; 775 smb_kshare_t *si; 776 } smb_arg_tcon_t; 777 778 /* 779 * Based on section 2.6.1.2 (Connection Management) of the June 13, 780 * 1996 CIFS spec, a server may terminate the transport connection 781 * due to inactivity. The client software is expected to be able to 782 * automatically reconnect to the server if this happens. Like much 783 * of the useful background information, this section appears to 784 * have been dropped from later revisions of the document. 785 * 786 * Each session has an activity timestamp that's updated whenever a 787 * request is dispatched. If the session is idle, i.e. receives no 788 * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 789 * closed. 790 * 791 * Each session has an I/O semaphore to serialize communication with 792 * the client. For example, after receiving a raw-read request, the 793 * server is not allowed to send an oplock break to the client until 794 * after it has sent the raw-read data. 795 */ 796 #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 797 798 /* SMB1 signing */ 799 struct smb_sign { 800 unsigned int flags; 801 uint32_t seqnum; 802 uint_t mackey_len; 803 uint8_t *mackey; 804 }; 805 806 /* 807 * SMB2 signing 808 */ 809 struct smb_key { 810 uint_t len; 811 uint8_t key[SMB2_SESSION_KEY_LEN]; 812 }; 813 814 #define SMB_SIGNING_ENABLED 1 815 #define SMB_SIGNING_CHECK 2 816 817 /* 818 * Locking notes: 819 * If you hold the mutex/lock on an object, don't flush the deleteq 820 * of the objects directly below it in the logical hierarchy 821 * (i.e. via smb_llist_exit()). I.e. don't drop s_tree_list when 822 * you hold u_mutex, because deleted trees need u_mutex to 823 * lower the refcnt. 824 * 825 * Note that this also applies to u_mutex and t_ofile_list. 826 */ 827 828 /* 829 * The "session" object. 830 * 831 * Note that the smb_session_t object here corresponds to what MS-SMB2 832 * calls a "connection". Adding to the confusion, what MS calls a 833 * "session" corresponds to our smb_user_t (below). 834 */ 835 836 /* 837 * Session State Machine 838 * --------------------- 839 * 840 * 841 * +-----------------------------+ +----------------------------+ 842 * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_SHUTDOWN | 843 * +-----------------------------+ +----------------------------+ 844 * | ^ 845 * | |T6 846 * | +------------------------------+ 847 * | | SMB_SESSION_STATE_TERMINATED | 848 * T0| +------------------------------+ 849 * +--------------------+ ^ 850 * v |T4 |T5 851 * +-------------------------------+ | +--------------------------------+ 852 * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 853 * +-------------------------------+ +--------------------------------+ 854 * T1| ^ 855 * +----------+ |T3 856 * v | 857 * +------------------------------+ 858 * | SMB_SESSION_STATE_NEGOTIATED | 859 * +------------------------------+ 860 * 861 * 862 * Transition T0 863 * 864 * 865 * 866 * Transition T1 867 * 868 * 869 * 870 * Transition T2 871 * 872 * 873 * 874 * Transition T3 875 * 876 * 877 * 878 * Transition T4 879 * 880 * 881 * 882 * Transition T5 883 * 884 * 885 * 886 * Transition T6 887 * 888 * 889 * 890 */ 891 #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 892 #define SMB_SESSION_VALID(p) \ 893 ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC)) 894 895 #define SMB_CHALLENGE_SZ 8 896 897 typedef enum { 898 SMB_SESSION_STATE_INITIALIZED = 0, 899 SMB_SESSION_STATE_DISCONNECTED, 900 SMB_SESSION_STATE_CONNECTED, 901 SMB_SESSION_STATE_ESTABLISHED, 902 SMB_SESSION_STATE_NEGOTIATED, 903 SMB_SESSION_STATE_TERMINATED, 904 SMB_SESSION_STATE_SHUTDOWN, 905 SMB_SESSION_STATE_SENTINEL 906 } smb_session_state_t; 907 908 /* Bits in s_flags below */ 909 #define SMB_SSN_AAPL_CCEXT 1 /* Saw "AAPL" create ctx. ext. */ 910 #define SMB_SSN_AAPL_READDIR 2 /* Wants MacOS ext. readdir */ 911 912 typedef struct smb_session { 913 list_node_t s_lnd; 914 uint32_t s_magic; 915 smb_rwx_t s_lock; 916 uint64_t s_kid; 917 smb_session_state_t s_state; 918 uint32_t s_flags; 919 taskqid_t s_receiver_tqid; 920 kthread_t *s_thread; 921 kt_did_t s_ktdid; 922 int (*newrq_func)(struct smb_request *); 923 struct smb_server *s_server; 924 smb_kmod_cfg_t s_cfg; 925 int32_t s_gmtoff; 926 uint32_t keep_alive; 927 uint64_t opentime; 928 uint16_t s_local_port; 929 uint16_t s_remote_port; 930 smb_inaddr_t ipaddr; 931 smb_inaddr_t local_ipaddr; 932 int dialect; 933 int native_os; 934 int native_lm; 935 936 kmutex_t s_credits_mutex; 937 uint16_t s_cur_credits; 938 uint16_t s_max_credits; 939 940 uint32_t capabilities; 941 942 struct smb_sign signing; /* SMB1 */ 943 void *sign_mech; /* mechanism info */ 944 945 /* SMB2/SMB3 signing support */ 946 int (*sign_calc)(struct smb_request *, 947 struct mbuf_chain *, uint8_t *); 948 void (*sign_fini)(struct smb_session *); 949 950 ksocket_t sock; 951 952 smb_slist_t s_req_list; 953 smb_llist_t s_xa_list; 954 smb_llist_t s_user_list; 955 smb_llist_t s_tree_list; 956 smb_idpool_t s_uid_pool; 957 smb_idpool_t s_tid_pool; 958 smb_txlst_t s_txlst; 959 960 volatile uint32_t s_tree_cnt; 961 volatile uint32_t s_file_cnt; 962 volatile uint32_t s_dir_cnt; 963 964 uint16_t secmode; 965 uint32_t sesskey; 966 uint32_t challenge_len; 967 unsigned char challenge_key[SMB_CHALLENGE_SZ]; 968 int64_t activity_timestamp; 969 970 /* 971 * Maximum negotiated buffer sizes between SMB client and server 972 * in SMB_SESSION_SETUP_ANDX 973 */ 974 int cmd_max_bytes; 975 int reply_max_bytes; 976 uint16_t smb_msg_size; 977 uint16_t smb_max_mpx; 978 smb_srqueue_t *s_srqueue; 979 uint64_t start_time; 980 unsigned char MAC_key[44]; 981 char ip_addr_str[INET6_ADDRSTRLEN]; 982 uint8_t clnt_uuid[16]; 983 char workstation[SMB_PI_MAX_HOST]; 984 } smb_session_t; 985 986 /* 987 * The "user" object. 988 * 989 * Note that smb_user_t object here corresponds to what MS-SMB2 calls 990 * a "session". (Our smb_session_t is something else -- see above). 991 */ 992 993 #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 994 #define SMB_USER_VALID(u) \ 995 ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC)) 996 997 #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 998 #define SMB_USER_FLAG_ANON SMB_ATF_ANON 999 #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 1000 #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 1001 #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 1002 1003 #define SMB_USER_IS_ADMIN(U) (((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0) 1004 #define SMB_USER_IS_GUEST(U) (((U)->u_flags & SMB_USER_FLAG_GUEST) != 0) 1005 1006 #define SMB_USER_PRIV_TAKE_OWNERSHIP 0x00000001 1007 #define SMB_USER_PRIV_BACKUP 0x00000002 1008 #define SMB_USER_PRIV_RESTORE 0x00000004 1009 #define SMB_USER_PRIV_SECURITY 0x00000008 1010 1011 /* 1012 * See the long "User State Machine" comment in smb_user.c 1013 */ 1014 typedef enum { 1015 SMB_USER_STATE_LOGGING_ON = 0, 1016 SMB_USER_STATE_LOGGED_ON, 1017 SMB_USER_STATE_LOGGING_OFF, 1018 SMB_USER_STATE_LOGGED_OFF, 1019 SMB_USER_STATE_SENTINEL 1020 } smb_user_state_t; 1021 1022 typedef enum { 1023 SMB2_DH_PRESERVE_NONE = 0, 1024 SMB2_DH_PRESERVE_SOME, 1025 SMB2_DH_PRESERVE_ALL 1026 } smb_preserve_type_t; 1027 1028 typedef struct smb_user { 1029 list_node_t u_lnd; 1030 uint32_t u_magic; 1031 kmutex_t u_mutex; 1032 smb_user_state_t u_state; 1033 1034 struct smb_server *u_server; 1035 smb_session_t *u_session; 1036 ksocket_t u_authsock; 1037 timeout_id_t u_auth_tmo; 1038 uint16_t u_name_len; 1039 char *u_name; 1040 uint16_t u_domain_len; 1041 char *u_domain; 1042 time_t u_logon_time; 1043 cred_t *u_cred; 1044 cred_t *u_privcred; 1045 1046 uint64_t u_ssnid; /* unique server-wide */ 1047 uint32_t u_refcnt; 1048 uint32_t u_flags; 1049 smb_preserve_type_t preserve_opens; 1050 uint32_t u_privileges; 1051 uint16_t u_uid; /* unique per-session */ 1052 uint32_t u_audit_sid; 1053 1054 uint32_t u_sign_flags; 1055 struct smb_key u_sign_key; /* SMB2 signing */ 1056 } smb_user_t; 1057 1058 #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 1059 #define SMB_TREE_VALID(p) \ 1060 ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC)) 1061 1062 #define SMB_TYPENAMELEN _ST_FSTYPSZ 1063 #define SMB_VOLNAMELEN 32 1064 1065 #define SMB_TREE_READONLY 0x00000001 1066 #define SMB_TREE_SUPPORTS_ACLS 0x00000002 1067 #define SMB_TREE_STREAMS 0x00000004 1068 #define SMB_TREE_CASEINSENSITIVE 0x00000008 1069 #define SMB_TREE_NO_CASESENSITIVE 0x00000010 1070 #define SMB_TREE_NO_EXPORT 0x00000020 1071 #define SMB_TREE_OPLOCKS 0x00000040 1072 #define SMB_TREE_SHORTNAMES 0x00000080 1073 #define SMB_TREE_XVATTR 0x00000100 1074 #define SMB_TREE_DIRENTFLAGS 0x00000200 1075 #define SMB_TREE_ACLONCREATE 0x00000400 1076 #define SMB_TREE_ACEMASKONACCESS 0x00000800 1077 #define SMB_TREE_NFS_MOUNTED 0x00001000 1078 #define SMB_TREE_UNICODE_ON_DISK 0x00002000 1079 #define SMB_TREE_CATIA 0x00004000 1080 #define SMB_TREE_ABE 0x00008000 1081 #define SMB_TREE_QUOTA 0x00010000 1082 #define SMB_TREE_DFSROOT 0x00020000 1083 #define SMB_TREE_SPARSE 0x00040000 1084 #define SMB_TREE_TRAVERSE_MOUNTS 0x00080000 1085 #define SMB_TREE_FORCE_L2_OPLOCK 0x00100000 1086 /* Note: SMB_TREE_... in the mdb module too. */ 1087 1088 /* 1089 * See the long "Tree State Machine" comment in smb_tree.c 1090 */ 1091 typedef enum { 1092 SMB_TREE_STATE_CONNECTED = 0, 1093 SMB_TREE_STATE_DISCONNECTING, 1094 SMB_TREE_STATE_DISCONNECTED, 1095 SMB_TREE_STATE_SENTINEL 1096 } smb_tree_state_t; 1097 1098 typedef struct smb_tree { 1099 list_node_t t_lnd; 1100 uint32_t t_magic; 1101 kmutex_t t_mutex; 1102 smb_tree_state_t t_state; 1103 1104 struct smb_server *t_server; 1105 smb_session_t *t_session; 1106 /* 1107 * user whose uid was in the tree connect message 1108 * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID) 1109 */ 1110 smb_user_t *t_owner; 1111 smb_node_t *t_snode; 1112 1113 smb_llist_t t_ofile_list; 1114 smb_idpool_t t_fid_pool; 1115 1116 smb_llist_t t_odir_list; 1117 smb_idpool_t t_odid_pool; 1118 1119 uint32_t t_refcnt; 1120 uint32_t t_flags; 1121 int32_t t_res_type; 1122 uint16_t t_tid; 1123 uint16_t t_umask; 1124 char t_sharename[MAXNAMELEN]; 1125 char t_resource[MAXPATHLEN]; 1126 char t_typename[SMB_TYPENAMELEN]; 1127 char t_volume[SMB_VOLNAMELEN]; 1128 acl_type_t t_acltype; 1129 uint32_t t_access; 1130 uint32_t t_execflags; 1131 time_t t_connect_time; 1132 volatile uint32_t t_open_files; 1133 } smb_tree_t; 1134 1135 #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 1136 #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 1137 1138 #define SMB_TREE_IS_READONLY(sr) \ 1139 ((sr) != NULL && (sr)->tid_tree != NULL && \ 1140 !((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS)) 1141 1142 #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 1143 (((sr) && (sr)->tid_tree) ? \ 1144 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 1145 1146 #define SMB_TREE_HAS_ACCESS(sr, acemask) \ 1147 ((sr) == NULL ? ACE_ALL_PERMS : ( \ 1148 (((sr) && (sr)->tid_tree) ? \ 1149 (((sr)->tid_tree->t_access) & (acemask)) : 0))) 1150 1151 #define SMB_TREE_SUPPORTS_CATIA(sr) \ 1152 (((sr) && (sr)->tid_tree) ? \ 1153 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0) 1154 1155 #define SMB_TREE_SUPPORTS_ABE(sr) \ 1156 (((sr) && (sr)->tid_tree) ? \ 1157 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0) 1158 1159 #define SMB_TREE_IS_DFSROOT(sr) \ 1160 (((sr) && (sr)->tid_tree) ? \ 1161 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0) 1162 1163 #define SMB_TREE_SUPPORTS_SHORTNAMES(sr) \ 1164 (((sr) && (sr)->tid_tree) ? \ 1165 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0) 1166 1167 /* 1168 * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same 1169 * file system as the tree's root filesystem, or if mount point traversal 1170 * should be allowed. Note that this is also called in some cases with 1171 * sr=NULL, where it is expected to evaluate to TRUE. 1172 */ 1173 1174 #define SMB_TREE_CONTAINS_NODE(sr, node) \ 1175 ((sr) == NULL || (sr)->tid_tree == NULL || \ 1176 SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) || \ 1177 smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS)) 1178 1179 /* 1180 * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 1181 * readonly when the caller has a path rather than an ofile. 1182 */ 1183 #define SMB_PATHFILE_IS_READONLY(sr, node) \ 1184 (SMB_TREE_IS_READONLY((sr)) || \ 1185 smb_node_file_is_readonly((node))) 1186 1187 #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 1188 #define SMB_ODIR_VALID(p) \ 1189 ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC)) 1190 1191 #define SMB_ODIR_BUFSIZE (8 * 1024) 1192 1193 #define SMB_ODIR_FLAG_WILDCARDS 0x0001 1194 #define SMB_ODIR_FLAG_IGNORE_CASE 0x0002 1195 #define SMB_ODIR_FLAG_XATTR 0x0004 1196 #define SMB_ODIR_FLAG_EDIRENT 0x0008 1197 #define SMB_ODIR_FLAG_CATIA 0x0010 1198 #define SMB_ODIR_FLAG_ABE 0x0020 1199 #define SMB_ODIR_FLAG_SHORTNAMES 0x0040 1200 1201 typedef enum { 1202 SMB_ODIR_STATE_OPEN = 0, 1203 SMB_ODIR_STATE_IN_USE, 1204 SMB_ODIR_STATE_CLOSING, 1205 SMB_ODIR_STATE_CLOSED, 1206 SMB_ODIR_STATE_SENTINEL 1207 } smb_odir_state_t; 1208 1209 typedef enum { 1210 SMB_ODIR_RESUME_CONT, 1211 SMB_ODIR_RESUME_IDX, 1212 SMB_ODIR_RESUME_COOKIE, 1213 SMB_ODIR_RESUME_FNAME 1214 } smb_odir_resume_type_t; 1215 1216 typedef struct smb_odir_resume { 1217 smb_odir_resume_type_t or_type; 1218 int or_idx; 1219 uint32_t or_cookie; 1220 char *or_fname; 1221 } smb_odir_resume_t; 1222 1223 /* 1224 * Flags used when opening an odir 1225 */ 1226 #define SMB_ODIR_OPENF_BACKUP_INTENT 0x01 1227 1228 typedef struct smb_odir { 1229 list_node_t d_lnd; 1230 uint32_t d_magic; 1231 kmutex_t d_mutex; 1232 smb_odir_state_t d_state; 1233 smb_session_t *d_session; 1234 smb_user_t *d_user; 1235 smb_tree_t *d_tree; 1236 smb_node_t *d_dnode; 1237 cred_t *d_cred; 1238 uint32_t d_opened_by_pid; 1239 uint16_t d_odid; 1240 uint16_t d_sattr; 1241 uint32_t d_refcnt; 1242 uint32_t d_flags; 1243 boolean_t d_eof; 1244 int d_bufsize; 1245 uint64_t d_offset; 1246 union { 1247 char *u_bufptr; 1248 struct edirent *u_edp; 1249 struct dirent64 *u_dp; 1250 } d_u; 1251 uint32_t d_last_cookie; 1252 uint32_t d_cookies[SMB_MAX_SEARCH]; 1253 char d_pattern[MAXNAMELEN]; 1254 char d_buf[SMB_ODIR_BUFSIZE]; 1255 char d_last_name[MAXNAMELEN]; 1256 } smb_odir_t; 1257 #define d_bufptr d_u.u_bufptr 1258 #define d_edp d_u.u_edp 1259 #define d_dp d_u.u_dp 1260 1261 typedef struct smb_odirent { 1262 char od_name[MAXNAMELEN]; /* on disk name */ 1263 ino64_t od_ino; 1264 uint32_t od_eflags; 1265 } smb_odirent_t; 1266 1267 #define SMB_OPIPE_MAGIC 0x50495045 /* 'PIPE' */ 1268 #define SMB_OPIPE_VALID(p) \ 1269 ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC) 1270 #define SMB_OPIPE_MAXNAME 32 1271 1272 /* 1273 * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 1274 * at the interface between SMB and NDR RPC. 1275 */ 1276 typedef struct smb_opipe { 1277 uint32_t p_magic; 1278 kmutex_t p_mutex; 1279 kcondvar_t p_cv; 1280 struct smb_ofile *p_ofile; 1281 struct smb_server *p_server; 1282 uint32_t p_refcnt; 1283 ksocket_t p_socket; 1284 /* This is the "flat" name, without path prefix */ 1285 char p_name[SMB_OPIPE_MAXNAME]; 1286 } smb_opipe_t; 1287 1288 /* 1289 * The of_ftype of an open file should contain the SMB_FTYPE value 1290 * returned when the file/pipe was opened. The following 1291 * assumptions are currently made: 1292 * 1293 * File Type Node PipeInfo 1294 * --------- -------- -------- 1295 * SMB_FTYPE_DISK Valid Null 1296 * SMB_FTYPE_BYTE_PIPE Undefined Undefined 1297 * SMB_FTYPE_MESG_PIPE Null Valid 1298 * SMB_FTYPE_PRINTER Undefined Undefined 1299 * SMB_FTYPE_UNKNOWN Undefined Undefined 1300 */ 1301 1302 /* 1303 * Some flags for ofile structure 1304 * 1305 * SMB_OFLAGS_SET_DELETE_ON_CLOSE 1306 * Set this flag when the corresponding open operation whose 1307 * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 1308 * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 1309 * will be set for the file node upon close. 1310 */ 1311 1312 /* SMB_OFLAGS_READONLY 0x0001 (obsolete) */ 1313 #define SMB_OFLAGS_EXECONLY 0x0002 1314 #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 1315 #define SMB_OFLAGS_LLF_POS_VALID 0x0008 1316 1317 #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 1318 #define SMB_OFILE_VALID(p) \ 1319 ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC)) 1320 1321 /* 1322 * This is the size of the per-handle "Lock Sequence" array. 1323 * See LockSequenceIndex in [MS-SMB2] 2.2.26, and smb2_lock.c 1324 */ 1325 #define SMB_OFILE_LSEQ_MAX 64 1326 1327 /* {arg_open,ofile}->dh_vers values */ 1328 typedef enum { 1329 SMB2_NOT_DURABLE = 0, 1330 SMB2_DURABLE_V1, 1331 SMB2_DURABLE_V2, 1332 SMB2_RESILIENT, 1333 } smb_dh_vers_t; 1334 1335 /* 1336 * See the long "Ofile State Machine" comment in smb_ofile.c 1337 */ 1338 typedef enum { 1339 SMB_OFILE_STATE_ALLOC = 0, 1340 SMB_OFILE_STATE_OPEN, 1341 SMB_OFILE_STATE_SAVE_DH, 1342 SMB_OFILE_STATE_SAVING, 1343 SMB_OFILE_STATE_CLOSING, 1344 SMB_OFILE_STATE_CLOSED, 1345 SMB_OFILE_STATE_ORPHANED, 1346 SMB_OFILE_STATE_RECONNECT, 1347 SMB_OFILE_STATE_EXPIRED, 1348 SMB_OFILE_STATE_SENTINEL 1349 } smb_ofile_state_t; 1350 1351 typedef struct smb_ofile { 1352 list_node_t f_tree_lnd; /* t_ofile_list */ 1353 list_node_t f_node_lnd; /* n_ofile_list */ 1354 list_node_t f_dh_lnd; /* sv_persistid_ht */ 1355 uint32_t f_magic; 1356 kmutex_t f_mutex; 1357 smb_ofile_state_t f_state; 1358 1359 struct smb_server *f_server; 1360 smb_session_t *f_session; 1361 smb_user_t *f_user; 1362 smb_tree_t *f_tree; 1363 smb_node_t *f_node; 1364 smb_odir_t *f_odir; 1365 smb_opipe_t *f_pipe; 1366 1367 kcondvar_t f_cv; 1368 /* 1369 * Note: f_persistid == 0 means this ofile has no persistid 1370 * (same interpretation at the protocol level). IFF non-zero, 1371 * this ofile is linked in the sv_persistid_ht hash table. 1372 */ 1373 uint64_t f_persistid; 1374 uint32_t f_uniqid; 1375 uint32_t f_refcnt; 1376 uint64_t f_seek_pos; 1377 uint32_t f_flags; 1378 uint32_t f_granted_access; 1379 uint32_t f_share_access; 1380 uint32_t f_create_options; 1381 uint32_t f_opened_by_pid; 1382 uint16_t f_fid; 1383 uint16_t f_ftype; 1384 uint64_t f_llf_pos; 1385 int f_mode; 1386 cred_t *f_cr; 1387 pid_t f_pid; 1388 smb_attr_t f_pending_attr; 1389 boolean_t f_written; 1390 smb_oplock_grant_t f_oplock; 1391 uint8_t TargetOplockKey[SMB_LEASE_KEY_SZ]; 1392 uint8_t ParentOplockKey[SMB_LEASE_KEY_SZ]; 1393 struct smb_lease *f_lease; 1394 1395 smb_notify_t f_notify; 1396 1397 smb_dh_vers_t dh_vers; 1398 hrtime_t dh_timeout_offset; /* time offset for timeout */ 1399 hrtime_t dh_expire_time; /* time the handle expires */ 1400 boolean_t dh_persist; 1401 uint8_t dh_create_guid[16]; 1402 char f_quota_resume[SMB_SID_STRSZ]; 1403 uint8_t f_lock_seq[SMB_OFILE_LSEQ_MAX]; 1404 } smb_ofile_t; 1405 1406 typedef struct smb_fileinfo { 1407 char fi_name[MAXNAMELEN]; 1408 char fi_shortname[SMB_SHORTNAMELEN]; 1409 uint32_t fi_cookie; /* Dir offset (of next entry) */ 1410 uint32_t fi_dosattr; /* DOS attributes */ 1411 uint64_t fi_nodeid; /* file system node id */ 1412 uint64_t fi_size; /* file size in bytes */ 1413 uint64_t fi_alloc_size; /* allocation size in bytes */ 1414 timestruc_t fi_atime; /* last access */ 1415 timestruc_t fi_mtime; /* last modification */ 1416 timestruc_t fi_ctime; /* last status change */ 1417 timestruc_t fi_crtime; /* file creation */ 1418 } smb_fileinfo_t; 1419 1420 typedef struct smb_streaminfo { 1421 uint64_t si_size; 1422 uint64_t si_alloc_size; 1423 char si_name[MAXPATHLEN]; 1424 } smb_streaminfo_t; 1425 1426 #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1427 1428 typedef struct smb_lock { 1429 list_node_t l_lnd; 1430 uint32_t l_magic; 1431 kmutex_t l_mutex; 1432 kcondvar_t l_cv; 1433 1434 smb_ofile_t *l_file; 1435 1436 struct smb_lock *l_blocked_by; /* Debug info only */ 1437 1438 uint32_t l_conflicts; 1439 uint32_t l_flags; 1440 uint32_t l_pid; 1441 uint32_t l_type; 1442 uint64_t l_start; 1443 uint64_t l_length; 1444 clock_t l_end_time; 1445 } smb_lock_t; 1446 1447 #define SMB_LOCK_FLAG_INDEFINITE 0x0004 1448 #define SMB_LOCK_FLAG_CLOSED 0x0008 1449 #define SMB_LOCK_FLAG_CANCELLED 0x0010 1450 1451 #define SMB_LOCK_TYPE_READWRITE 101 1452 #define SMB_LOCK_TYPE_READONLY 102 1453 1454 typedef struct vardata_block { 1455 uint8_t vdb_tag; 1456 uint32_t vdb_len; 1457 struct uio vdb_uio; 1458 struct iovec vdb_iovec[MAX_IOVEC]; 1459 } smb_vdb_t; 1460 1461 #define SMB_WRMODE_WRITE_THRU 0x0001 1462 #define SMB_WRMODE_IS_STABLE(M) ((M) & SMB_WRMODE_WRITE_THRU) 1463 1464 #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1465 1466 typedef struct smb_rw_param { 1467 uint32_t rw_magic; 1468 smb_vdb_t rw_vdb; 1469 uint64_t rw_offset; 1470 uint32_t rw_last_write; 1471 uint16_t rw_mode; 1472 uint32_t rw_count; /* bytes in this request */ 1473 uint16_t rw_mincnt; 1474 uint32_t rw_total; /* total bytes (write-raw) */ 1475 uint16_t rw_dsoff; /* SMB data offset */ 1476 uint8_t rw_andx; /* SMB secondary andx command */ 1477 } smb_rw_param_t; 1478 1479 typedef struct smb_pathname { 1480 char *pn_path; 1481 char *pn_pname; 1482 char *pn_fname; 1483 char *pn_sname; 1484 char *pn_stype; 1485 } smb_pathname_t; 1486 1487 /* 1488 * fs_query_info 1489 */ 1490 typedef struct smb_fqi { 1491 smb_pathname_t fq_path; 1492 uint16_t fq_sattr; 1493 smb_node_t *fq_dnode; 1494 smb_node_t *fq_fnode; 1495 smb_attr_t fq_fattr; 1496 char fq_last_comp[MAXNAMELEN]; 1497 } smb_fqi_t; 1498 1499 typedef struct dirop { 1500 smb_fqi_t fqi; 1501 smb_fqi_t dst_fqi; 1502 uint16_t info_level; 1503 uint16_t flags; 1504 } smb_arg_dirop_t; 1505 1506 typedef struct smb_queryinfo { 1507 smb_node_t *qi_node; /* NULL for pipes */ 1508 uint8_t qi_InfoType; 1509 uint8_t qi_InfoClass; 1510 uint8_t qi_delete_on_close; 1511 uint8_t qi_isdir; 1512 uint32_t qi_AddlInfo; 1513 uint32_t qi_Flags; 1514 mbuf_chain_t in_data; 1515 smb_attr_t qi_attr; 1516 uint32_t qi_namelen; 1517 char qi_shortname[SMB_SHORTNAMELEN]; 1518 char qi_name[MAXPATHLEN]; 1519 } smb_queryinfo_t; 1520 1521 typedef struct smb_setinfo { 1522 smb_node_t *si_node; 1523 mbuf_chain_t si_data; 1524 smb_attr_t si_attr; 1525 } smb_setinfo_t; 1526 1527 /* 1528 * smb_fssize_t 1529 * volume_units and volume avail are the total allocated and 1530 * available units on the volume. 1531 * caller_units and caller_avail are the allocated and available 1532 * units on the volume for the user associated with the calling 1533 * thread. 1534 */ 1535 typedef struct smb_fssize { 1536 uint64_t fs_volume_units; 1537 uint64_t fs_volume_avail; 1538 uint64_t fs_caller_units; 1539 uint64_t fs_caller_avail; 1540 uint32_t fs_sectors_per_unit; 1541 uint32_t fs_bytes_per_sector; 1542 } smb_fssize_t; 1543 1544 /* 1545 * SMB FsCtl operations (SMB2 Ioctl, and some SMB1 trans calls) 1546 */ 1547 typedef struct { 1548 uint32_t CtlCode; 1549 uint32_t InputCount; 1550 uint32_t OutputCount; 1551 uint32_t MaxOutputResp; 1552 mbuf_chain_t *in_mbc; 1553 mbuf_chain_t *out_mbc; 1554 } smb_fsctl_t; 1555 1556 typedef struct { 1557 uint64_t persistent; 1558 uint64_t temporal; 1559 } smb2fid_t; 1560 1561 typedef struct { 1562 uint32_t status; 1563 uint16_t errcls; 1564 uint16_t errcode; 1565 } smb_error_t; 1566 1567 typedef struct open_param { 1568 smb_fqi_t fqi; 1569 uint16_t omode; 1570 uint16_t ofun; 1571 uint32_t nt_flags; 1572 uint32_t timeo; 1573 uint32_t dattr; 1574 timestruc_t crtime; 1575 timestruc_t mtime; 1576 timestruc_t timewarp; 1577 /* 1578 * Careful: dsize is the desired (allocation) size before the 1579 * common open function, and the actual size afterwards. 1580 */ 1581 uint64_t dsize; /* alloc size, actual size */ 1582 uint32_t desired_access; 1583 uint32_t maximum_access; 1584 uint32_t share_access; 1585 uint32_t create_options; 1586 uint32_t create_disposition; 1587 boolean_t create_timewarp; 1588 boolean_t created_readonly; 1589 uint32_t ftype; 1590 uint32_t devstate; 1591 uint32_t action_taken; 1592 uint64_t fileid; 1593 uint32_t rootdirfid; 1594 fsid_t op_fsid; 1595 smb_ofile_t *dir; 1596 smb_opipe_t *pipe; /* for smb_opipe_open */ 1597 struct smb_sd *sd; /* for NTTransactCreate */ 1598 void *create_ctx; 1599 1600 uint8_t op_oplock_level; /* requested/granted level */ 1601 uint32_t op_oplock_state; /* internal type+level */ 1602 uint32_t lease_state; /* SMB2_LEASE_... */ 1603 uint32_t lease_flags; 1604 uint16_t lease_epoch; 1605 uint16_t lease_version; /* 1 or 2 */ 1606 uint8_t lease_key[SMB_LEASE_KEY_SZ]; /* from client */ 1607 uint8_t parent_lease_key[SMB_LEASE_KEY_SZ]; /* for V2 */ 1608 1609 smb_dh_vers_t dh_vers; 1610 smb2fid_t dh_fileid; /* for durable reconnect */ 1611 uint8_t create_guid[16]; 1612 uint32_t dh_v2_flags; 1613 uint32_t dh_timeout; 1614 } smb_arg_open_t; 1615 1616 typedef struct smb_arg_lock { 1617 void *lvec; 1618 uint32_t lcnt; 1619 uint32_t lseq; 1620 } smb_arg_lock_t; 1621 1622 typedef struct smb_arg_olbrk { 1623 uint32_t NewLevel; 1624 boolean_t AckRequired; 1625 } smb_arg_olbrk_t; 1626 1627 /* 1628 * SMB Request State Machine 1629 * ------------------------- 1630 * 1631 * T4 +------+ T0 1632 * +--------------------------->| FREE |---------------------------+ 1633 * | +------+ | 1634 * +-----------+ | 1635 * | COMPLETED | | 1636 * +-----------+ 1637 * ^ | 1638 * | T15 +-----------+ v 1639 * +------------+ T6 | | +--------------+ 1640 * | CLEANED_UP |<-----------------| CANCELLED | | INITIALIZING | 1641 * +------------+ | | +--------------+ 1642 * | ^ +-----------+ | 1643 * | | ^ ^ ^ ^ | 1644 * | | +-------------+ | | | | 1645 * | | T3 | | | | T13 | T1 1646 * | +-------------------------+ | | +----------------------+ | 1647 * +----------------------------+ | | | | | 1648 * T16 | | | | +-----------+ | | 1649 * | \/ | | T5 | | v 1650 * +-----------------+ | T12 +--------+ | T2 +-----------+ 1651 * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1652 * +-----------------+ | +--------+ | +-----------+ 1653 * ^ | | ^ | | 1654 * | | T8 | | | T7 | 1655 * | T10 T9 | +----------+ | +-------+ | T11 1656 * | | | +-------+ | | 1657 * | | | T14 | | | 1658 * | | v | v | 1659 * +----------------------+ +--------------+ 1660 * | WAITING_EVENT | | WAITING_LOCK | 1661 * +----------------------+ +--------------+ 1662 * 1663 * 1664 * 1665 * 1666 * 1667 * Transition T0 1668 * 1669 * This transition occurs when the request is allocated and is still under the 1670 * control of the session thread. 1671 * 1672 * Transition T1 1673 * 1674 * This transition occurs when the session thread dispatches a task to treat the 1675 * request. 1676 * 1677 * Transition T2 1678 * 1679 * 1680 * 1681 * Transition T3 1682 * 1683 * A request completes and smbsr_cleanup is called to release resources 1684 * associated with the request (but not the smb_request_t itself). This 1685 * includes references on smb_ofile_t, smb_node_t, and other structures. 1686 * CLEANED_UP state exists to detect if we attempt to cleanup a request 1687 * multiple times and to allow us to detect that we are accessing a 1688 * request that has already been cleaned up. 1689 * 1690 * Transition T4 1691 * 1692 * 1693 * 1694 * Transition T5 1695 * 1696 * 1697 * 1698 * Transition T6 1699 * 1700 * 1701 * 1702 * Transition T7 1703 * 1704 * 1705 * 1706 * Transition T8 1707 * 1708 * 1709 * 1710 * Transition T9 1711 * 1712 * 1713 * 1714 * Transition T10 1715 * 1716 * 1717 * 1718 * Transition T11 1719 * 1720 * 1721 * 1722 * Transition T12 1723 * 1724 * 1725 * 1726 * Transition T13 1727 * 1728 * 1729 * 1730 * Transition T14 1731 * 1732 * 1733 * 1734 * Transition T15 1735 * 1736 * Request processing is completed (control returns from smb_dispatch) 1737 * 1738 * Transition T16 1739 * 1740 * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1741 * sections remain to be processed. 1742 * 1743 */ 1744 1745 #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 1746 #define SMB_REQ_VALID(p) ASSERT((p)->sr_magic == SMB_REQ_MAGIC) 1747 1748 typedef enum smb_req_state { 1749 SMB_REQ_STATE_FREE = 0, 1750 SMB_REQ_STATE_INITIALIZING, 1751 SMB_REQ_STATE_SUBMITTED, 1752 SMB_REQ_STATE_ACTIVE, 1753 SMB_REQ_STATE_WAITING_AUTH, 1754 SMB_REQ_STATE_WAITING_FCN1, 1755 SMB_REQ_STATE_WAITING_FCN2, 1756 SMB_REQ_STATE_WAITING_LOCK, 1757 SMB_REQ_STATE_WAITING_PIPE, 1758 SMB_REQ_STATE_COMPLETED, 1759 SMB_REQ_STATE_CANCEL_PENDING, 1760 SMB_REQ_STATE_CANCELLED, 1761 SMB_REQ_STATE_CLEANED_UP, 1762 SMB_REQ_STATE_SENTINEL 1763 } smb_req_state_t; 1764 1765 typedef struct smb_request { 1766 list_node_t sr_session_lnd; 1767 uint32_t sr_magic; 1768 kmutex_t sr_mutex; 1769 smb_req_state_t sr_state; 1770 struct smb_server *sr_server; 1771 pid_t *sr_pid; 1772 int32_t sr_gmtoff; 1773 smb_session_t *session; 1774 smb_kmod_cfg_t *sr_cfg; 1775 void (*cancel_method)(struct smb_request *); 1776 void *cancel_arg2; 1777 1778 /* Queue used by smb_request_append_postwork. */ 1779 struct smb_request *sr_postwork; 1780 1781 list_node_t sr_waiters; /* smb_notify.c */ 1782 1783 /* Info from session service header */ 1784 uint32_t sr_req_length; /* Excluding NBT header */ 1785 1786 /* Request buffer excluding NBT header */ 1787 void *sr_request_buf; 1788 1789 struct mbuf_chain command; 1790 struct mbuf_chain reply; 1791 struct mbuf_chain raw_data; 1792 list_t sr_storage; 1793 struct smb_xa *r_xa; 1794 int andx_prev_wct; 1795 int cur_reply_offset; 1796 int orig_request_hdr; 1797 unsigned int reply_seqnum; /* reply sequence number */ 1798 unsigned char first_smb_com; /* command code */ 1799 unsigned char smb_com; /* command code */ 1800 1801 uint8_t smb_rcls; /* error code class */ 1802 uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1803 uint16_t smb_err; /* error code */ 1804 smb_error_t smb_error; 1805 1806 uint8_t smb_flg; /* flags */ 1807 uint16_t smb_flg2; /* flags */ 1808 unsigned char smb_sig[8]; /* signiture */ 1809 uint16_t smb_tid; /* tree id # */ 1810 uint32_t smb_pid; /* caller's process id # */ 1811 uint16_t smb_uid; /* local (smb1) user id # */ 1812 uint16_t smb_mid; /* mutiplex id # */ 1813 unsigned char smb_wct; /* count of parameter words */ 1814 uint16_t smb_bcc; /* data byte count */ 1815 1816 /* 1817 * Beginning offsets (in the mbuf chain) for the 1818 * command and reply headers, and the next reply. 1819 */ 1820 uint32_t smb2_cmd_hdr; 1821 uint32_t smb2_reply_hdr; 1822 uint32_t smb2_next_reply; 1823 1824 /* 1825 * SMB2 header fields. [MS-SMB2 2.2.1.2] 1826 * XXX: Later do a union w smb1 members 1827 */ 1828 uint16_t smb2_credit_charge; 1829 uint16_t smb2_chan_seq; /* cmd only */ 1830 uint32_t smb2_status; 1831 uint16_t smb2_cmd_code; 1832 uint16_t smb2_credit_request; 1833 uint16_t smb2_credit_response; 1834 uint16_t smb2_total_credits; /* in compound */ 1835 uint32_t smb2_hdr_flags; 1836 uint32_t smb2_next_command; 1837 uint64_t smb2_messageid; 1838 uint64_t smb2_first_msgid; 1839 /* uint32_t smb2_pid; use smb_pid */ 1840 /* uint32_t smb2_tid; use smb_tid */ 1841 uint64_t smb2_ssnid; /* See u_ssnid */ 1842 uint8_t smb2_sig[16]; /* signature */ 1843 1844 boolean_t smb2_async; 1845 uint64_t smb2_async_id; 1846 /* Parameters */ 1847 struct mbuf_chain smb_vwv; /* variable width value */ 1848 1849 /* Data */ 1850 struct mbuf_chain smb_data; 1851 1852 uint16_t smb_fid; /* not in hdr, but common */ 1853 1854 unsigned char andx_com; 1855 uint16_t andx_off; 1856 1857 struct smb_tree *tid_tree; 1858 struct smb_ofile *fid_ofile; 1859 smb_user_t *uid_user; 1860 1861 cred_t *user_cr; 1862 kthread_t *sr_worker; 1863 hrtime_t sr_time_submitted; 1864 hrtime_t sr_time_active; 1865 hrtime_t sr_time_start; 1866 int32_t sr_txb; 1867 uint32_t sr_seqnum; 1868 1869 union { 1870 smb_arg_negotiate_t *negprot; 1871 smb_arg_sessionsetup_t *ssetup; 1872 smb_arg_tcon_t tcon; 1873 smb_arg_dirop_t dirop; 1874 smb_arg_open_t open; 1875 smb_arg_lock_t lock; 1876 smb_arg_olbrk_t olbrk; /* for async oplock break */ 1877 smb_rw_param_t *rw; 1878 int32_t timestamp; 1879 } arg; 1880 } smb_request_t; 1881 1882 #define sr_ssetup arg.ssetup 1883 #define sr_negprot arg.negprot 1884 #define sr_tcon arg.tcon 1885 #define sr_dirop arg.dirop 1886 #define sr_open arg.open 1887 #define sr_rw arg.rw 1888 #define sr_timestamp arg.timestamp 1889 1890 #define SMB_READ_PROTOCOL(hdr) \ 1891 LE_IN32(((smb_hdr_t *)(hdr))->protocol) 1892 1893 #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1894 (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1895 1896 #define SMB_READ_COMMAND(hdr) \ 1897 (((smb_hdr_t *)(hdr))->command) 1898 1899 #define SMB_IS_NT_CANCEL(rd_sr) \ 1900 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL) 1901 1902 #define SMB_IS_SESSION_SETUP_ANDX(rd_sr) \ 1903 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \ 1904 SMB_COM_SESSION_SETUP_ANDX) 1905 1906 #define SMB_IS_NT_NEGOTIATE(rd_sr) \ 1907 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE) 1908 1909 #define SMB_IS_TREE_CONNECT_ANDX(rd_sr) \ 1910 (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX) 1911 1912 #define SMB_XA_FLAG_OPEN 0x0001 1913 #define SMB_XA_FLAG_CLOSE 0x0002 1914 #define SMB_XA_FLAG_COMPLETE 0x0004 1915 #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1916 1917 #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1918 1919 typedef struct smb_xa { 1920 list_node_t xa_lnd; 1921 uint32_t xa_magic; 1922 kmutex_t xa_mutex; 1923 1924 uint32_t xa_refcnt; 1925 uint32_t xa_flags; 1926 1927 struct smb_session *xa_session; 1928 1929 unsigned char smb_com; /* which TRANS type */ 1930 unsigned char smb_flg; /* flags */ 1931 uint16_t smb_flg2; /* flags */ 1932 uint16_t smb_tid; /* tree id number */ 1933 uint32_t smb_pid; /* caller's process id */ 1934 uint16_t smb_uid; /* user id number */ 1935 uint32_t smb_func; /* NT_TRANS function */ 1936 1937 uint16_t xa_smb_mid; /* mutiplex id number */ 1938 uint16_t xa_smb_fid; /* TRANS2 secondary */ 1939 1940 unsigned int reply_seqnum; /* reply sequence number */ 1941 1942 uint32_t smb_tpscnt; /* total parameter bytes being sent */ 1943 uint32_t smb_tdscnt; /* total data bytes being sent */ 1944 uint32_t smb_mprcnt; /* max parameter bytes to return */ 1945 uint32_t smb_mdrcnt; /* max data bytes to return */ 1946 uint32_t smb_msrcnt; /* max setup words to return */ 1947 uint32_t smb_flags; /* additional information: */ 1948 /* bit 0 - if set, disconnect TID in smb_tid */ 1949 /* bit 1 - if set, transaction is one way */ 1950 /* (no final response) */ 1951 int32_t smb_timeout; /* number of milliseconds to await completion */ 1952 uint32_t smb_suwcnt; /* set up word count */ 1953 1954 char *xa_pipe_name; 1955 1956 /* 1957 * These are the param and data count received so far, 1958 * used to decide if the whole trans is here yet. 1959 */ 1960 int req_disp_param; 1961 int req_disp_data; 1962 1963 struct mbuf_chain req_setup_mb; 1964 struct mbuf_chain req_param_mb; 1965 struct mbuf_chain req_data_mb; 1966 1967 struct mbuf_chain rep_setup_mb; 1968 struct mbuf_chain rep_param_mb; 1969 struct mbuf_chain rep_data_mb; 1970 } smb_xa_t; 1971 1972 1973 #define SDDF_NO_FLAGS 0 1974 #define SDDF_SUPPRESS_TID 0x0001 1975 #define SDDF_SUPPRESS_UID 0x0002 1976 1977 /* 1978 * SMB dispatch return codes. 1979 */ 1980 typedef enum { 1981 SDRC_SUCCESS = 0, 1982 SDRC_ERROR, 1983 SDRC_DROP_VC, 1984 SDRC_NO_REPLY, 1985 SDRC_SR_KEPT, 1986 SDRC_NOT_IMPLEMENTED 1987 } smb_sdrc_t; 1988 1989 #define VAR_BCC ((short)-1) 1990 1991 #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 1992 #define SMB_SERVER_VALID(s) \ 1993 ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC)) 1994 1995 #define SMB_LISTENER_MAGIC 0x4C53544E /* 'LSTN' */ 1996 #define SMB_LISTENER_VALID(ld) \ 1997 ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC)) 1998 1999 typedef struct { 2000 uint32_t ld_magic; 2001 struct smb_server *ld_sv; 2002 smb_thread_t ld_thread; 2003 ksocket_t ld_so; 2004 in_port_t ld_port; 2005 int ld_family; 2006 struct sockaddr_in ld_sin; 2007 struct sockaddr_in6 ld_sin6; 2008 } smb_listener_daemon_t; 2009 2010 #define SMB_SSETUP_CMD "authentication" 2011 #define SMB_TCON_CMD "share mapping" 2012 #define SMB_OPIPE_CMD "pipe open" 2013 #define SMB_THRESHOLD_REPORT_THROTTLE 50 2014 typedef struct smb_cmd_threshold { 2015 char *ct_cmd; 2016 kmutex_t ct_mutex; 2017 volatile uint32_t ct_active_cnt; 2018 volatile uint32_t ct_blocked_cnt; 2019 uint32_t ct_threshold; 2020 uint32_t ct_timeout; /* milliseconds */ 2021 kcondvar_t ct_cond; 2022 } smb_cmd_threshold_t; 2023 2024 typedef struct { 2025 kstat_named_t ls_files; 2026 kstat_named_t ls_trees; 2027 kstat_named_t ls_users; 2028 } smb_server_legacy_kstat_t; 2029 2030 typedef enum smb_server_state { 2031 SMB_SERVER_STATE_CREATED = 0, 2032 SMB_SERVER_STATE_CONFIGURED, 2033 SMB_SERVER_STATE_RUNNING, 2034 SMB_SERVER_STATE_STOPPING, 2035 SMB_SERVER_STATE_DELETING, 2036 SMB_SERVER_STATE_SENTINEL 2037 } smb_server_state_t; 2038 2039 typedef struct { 2040 /* protected by sv_mutex */ 2041 kcondvar_t sp_cv; 2042 uint32_t sp_cnt; 2043 smb_llist_t sp_list; 2044 smb_llist_t sp_fidlist; 2045 } smb_spool_t; 2046 2047 #define SMB_SERVER_STATE_VALID(S) \ 2048 ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \ 2049 ((S) == SMB_SERVER_STATE_CONFIGURED) || \ 2050 ((S) == SMB_SERVER_STATE_RUNNING) || \ 2051 ((S) == SMB_SERVER_STATE_STOPPING) || \ 2052 ((S) == SMB_SERVER_STATE_DELETING)) 2053 2054 typedef struct smb_server { 2055 list_node_t sv_lnd; 2056 uint32_t sv_magic; 2057 kcondvar_t sv_cv; 2058 kmutex_t sv_mutex; 2059 smb_server_state_t sv_state; 2060 uint32_t sv_refcnt; 2061 pid_t sv_pid; 2062 zoneid_t sv_zid; 2063 smb_listener_daemon_t sv_nbt_daemon; 2064 smb_listener_daemon_t sv_tcp_daemon; 2065 krwlock_t sv_cfg_lock; 2066 smb_kmod_cfg_t sv_cfg; 2067 smb_session_t *sv_session; 2068 smb_llist_t sv_session_list; 2069 smb_hash_t *sv_persistid_ht; 2070 smb_hash_t *sv_lease_ht; 2071 2072 struct smb_export sv_export; 2073 struct __door_handle *sv_lmshrd; 2074 2075 /* Internal door for up-calls to smbd */ 2076 struct __door_handle *sv_kdoor_hd; 2077 int sv_kdoor_id; /* init -1 */ 2078 uint64_t sv_kdoor_ncall; 2079 kmutex_t sv_kdoor_mutex; 2080 kcondvar_t sv_kdoor_cv; 2081 2082 int32_t si_gmtoff; 2083 2084 smb_thread_t si_thread_timers; 2085 2086 taskq_t *sv_worker_pool; 2087 taskq_t *sv_receiver_pool; 2088 2089 smb_node_t *si_root_smb_node; 2090 smb_llist_t sv_opipe_list; 2091 smb_llist_t sv_event_list; 2092 2093 /* Statistics */ 2094 hrtime_t sv_start_time; 2095 kstat_t *sv_ksp; 2096 volatile uint32_t sv_nbt_sess; 2097 volatile uint32_t sv_tcp_sess; 2098 volatile uint32_t sv_users; 2099 volatile uint32_t sv_trees; 2100 volatile uint32_t sv_files; 2101 volatile uint32_t sv_pipes; 2102 volatile uint64_t sv_txb; 2103 volatile uint64_t sv_rxb; 2104 volatile uint64_t sv_nreq; 2105 smb_srqueue_t sv_srqueue; 2106 smb_spool_t sp_info; 2107 smb_cmd_threshold_t sv_ssetup_ct; 2108 smb_cmd_threshold_t sv_tcon_ct; 2109 smb_cmd_threshold_t sv_opipe_ct; 2110 kstat_t *sv_legacy_ksp; 2111 kmutex_t sv_legacy_ksmtx; 2112 smb_disp_stats_t *sv_disp_stats1; 2113 smb_disp_stats_t *sv_disp_stats2; 2114 } smb_server_t; 2115 2116 #define SMB_EVENT_MAGIC 0x45564E54 /* EVNT */ 2117 #define SMB_EVENT_TIMEOUT 45 /* seconds */ 2118 #define SMB_EVENT_VALID(e) \ 2119 ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC)) 2120 typedef struct smb_event { 2121 list_node_t se_lnd; 2122 uint32_t se_magic; 2123 kmutex_t se_mutex; 2124 kcondvar_t se_cv; 2125 smb_server_t *se_server; 2126 uint32_t se_txid; 2127 boolean_t se_notified; 2128 int se_waittime; 2129 int se_timeout; 2130 int se_errno; 2131 } smb_event_t; 2132 2133 typedef struct smb_kspooldoc { 2134 list_node_t sd_lnd; 2135 uint32_t sd_magic; 2136 smb_inaddr_t sd_ipaddr; 2137 uint32_t sd_spool_num; 2138 uint16_t sd_fid; 2139 char sd_username[MAXNAMELEN]; 2140 char sd_path[MAXPATHLEN]; 2141 } smb_kspooldoc_t; 2142 2143 typedef struct smb_spoolfid { 2144 list_node_t sf_lnd; 2145 uint32_t sf_magic; 2146 uint16_t sf_fid; 2147 } smb_spoolfid_t; 2148 2149 #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 2150 #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 2151 #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 2152 #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 2153 2154 #define SMB_IS_STREAM(node) ((node)->n_unode) 2155 2156 typedef struct smb_tsd { 2157 void (*proc)(); 2158 void *arg; 2159 char name[100]; 2160 } smb_tsd_t; 2161 2162 typedef struct smb_disp_entry { 2163 char sdt_name[KSTAT_STRLEN]; 2164 smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 2165 smb_sdrc_t (*sdt_function)(smb_request_t *); 2166 void (*sdt_post_op)(smb_request_t *); 2167 uint8_t sdt_com; 2168 char sdt_dialect; 2169 uint8_t sdt_flags; 2170 } smb_disp_entry_t; 2171 2172 typedef struct smb_xlate { 2173 int code; 2174 char *str; 2175 } smb_xlate_t; 2176 2177 /* 2178 * This structure is a helper for building RAP NetShareEnum response 2179 * 2180 * es_posix_uid UID of the user requesting the shares list which 2181 * is used to detect if the user has any autohome 2182 * es_bufsize size of the response buffer 2183 * es_buf pointer to the response buffer 2184 * es_ntotal total number of shares exported by server which 2185 * their OEM names is less then 13 chars 2186 * es_nsent number of shares that can fit in the specified buffer 2187 * es_datasize actual data size (share's data) which was encoded 2188 * in the response buffer 2189 */ 2190 typedef struct smb_enumshare_info { 2191 uid_t es_posix_uid; 2192 uint16_t es_bufsize; 2193 char *es_buf; 2194 uint16_t es_ntotal; 2195 uint16_t es_nsent; 2196 uint16_t es_datasize; 2197 } smb_enumshare_info_t; 2198 2199 #ifdef __cplusplus 2200 } 2201 #endif 2202 2203 #endif /* _SMBSRV_SMB_KTYPES_H */ 2204