1da6c28aaSamw /* 2da6c28aaSamw * CDDL HEADER START 3da6c28aaSamw * 4da6c28aaSamw * The contents of this file are subject to the terms of the 5da6c28aaSamw * Common Development and Distribution License (the "License"). 6da6c28aaSamw * You may not use this file except in compliance with the License. 7da6c28aaSamw * 8da6c28aaSamw * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9da6c28aaSamw * or http://www.opensolaris.org/os/licensing. 10da6c28aaSamw * See the License for the specific language governing permissions 11da6c28aaSamw * and limitations under the License. 12da6c28aaSamw * 13da6c28aaSamw * When distributing Covered Code, include this CDDL HEADER in each 14da6c28aaSamw * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15da6c28aaSamw * If applicable, add the following below this CDDL HEADER, with the 16da6c28aaSamw * fields enclosed by brackets "[]" replaced with your own identifying 17da6c28aaSamw * information: Portions Copyright [yyyy] [name of copyright owner] 18da6c28aaSamw * 19da6c28aaSamw * CDDL HEADER END 20da6c28aaSamw */ 21da6c28aaSamw /* 22148c5f43SAlan Wright * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 23*8d94f651SGordon Ross * Copyright 2018 Nexenta Systems, Inc. All rights reserved. 24da6c28aaSamw */ 25da6c28aaSamw 26da6c28aaSamw /* 27da6c28aaSamw * Structures and type definitions for the SMB module. 28da6c28aaSamw */ 29da6c28aaSamw 30faa1795aSjb #ifndef _SMBSRV_SMB_KTYPES_H 31faa1795aSjb #define _SMBSRV_SMB_KTYPES_H 32da6c28aaSamw 33da6c28aaSamw #ifdef __cplusplus 34da6c28aaSamw extern "C" { 35da6c28aaSamw #endif 36da6c28aaSamw 37faa1795aSjb #include <sys/note.h> 38da6c28aaSamw #include <sys/systm.h> 39da6c28aaSamw #include <sys/param.h> 40da6c28aaSamw #include <sys/types.h> 41da6c28aaSamw #include <sys/synch.h> 42da6c28aaSamw #include <sys/taskq.h> 433db3f65cSamw #include <sys/socket.h> 44da6c28aaSamw #include <sys/acl.h> 45da6c28aaSamw #include <sys/sdt.h> 46c8ec8eeaSjose borrego #include <sys/stat.h> 47da6c28aaSamw #include <sys/vnode.h> 48da6c28aaSamw #include <sys/cred.h> 490f1702c5SYu Xiangning #include <netinet/in.h> 500f1702c5SYu Xiangning #include <sys/ksocket.h> 51faa1795aSjb #include <sys/fem.h> 52da6c28aaSamw #include <smbsrv/smb.h> 53a90cf9f2SGordon Ross #include <smbsrv/smb2.h> 54da6c28aaSamw #include <smbsrv/smbinfo.h> 55da6c28aaSamw #include <smbsrv/mbuf.h> 566537f381Sas #include <smbsrv/smb_sid.h> 573db3f65cSamw #include <smbsrv/smb_xdr.h> 5821b7895dSjb #include <smbsrv/netbios.h> 59da6c28aaSamw #include <smbsrv/smb_vops.h> 60148c5f43SAlan Wright #include <smbsrv/smb_kstat.h> 61da6c28aaSamw 62b819cea2SGordon Ross struct __door_handle; /* <sys/door.h> */ 63b819cea2SGordon Ross struct edirent; /* <sys/extdirent.h> */ 64*8d94f651SGordon Ross struct nvlist; 65b819cea2SGordon Ross 662c2961f8Sjose borrego struct smb_disp_entry; 67faa1795aSjb struct smb_request; 68faa1795aSjb struct smb_server; 699fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_event; 708622ec45SGordon Ross struct smb_export; 71da6c28aaSamw 72148c5f43SAlan Wright /* 73148c5f43SAlan Wright * Accumulated time and queue length statistics. 74148c5f43SAlan Wright * 75148c5f43SAlan Wright * Accumulated time statistics are kept as a running sum of "active" time. 76148c5f43SAlan Wright * Queue length statistics are kept as a running sum of the product of queue 77148c5f43SAlan Wright * length and elapsed time at that length -- i.e., a Riemann sum for queue 78148c5f43SAlan Wright * length integrated against time. (You can also think of the active time as a 79148c5f43SAlan Wright * Riemann sum, for the boolean function (queue_length > 0) integrated against 80148c5f43SAlan Wright * time, or you can think of it as the Lebesgue measure of the set on which 81148c5f43SAlan Wright * queue_length > 0.) 82148c5f43SAlan Wright * 83148c5f43SAlan Wright * ^ 84148c5f43SAlan Wright * | _________ 85148c5f43SAlan Wright * 8 | i4 | 86148c5f43SAlan Wright * | | | 87148c5f43SAlan Wright * Queue 6 | | 88148c5f43SAlan Wright * Length | _________ | | 89148c5f43SAlan Wright * 4 | i2 |_______| | 90148c5f43SAlan Wright * | | i3 | 91148c5f43SAlan Wright * 2_______| | 92148c5f43SAlan Wright * | i1 | 93148c5f43SAlan Wright * |_______________________________| 94148c5f43SAlan Wright * Time-> t1 t2 t3 t4 95148c5f43SAlan Wright * 96148c5f43SAlan Wright * At each change of state (entry or exit from the queue), we add the elapsed 97148c5f43SAlan Wright * time (since the previous state change) to the active time if the queue length 98148c5f43SAlan Wright * was non-zero during that interval; and we add the product of the elapsed time 99148c5f43SAlan Wright * times the queue length to the running length*time sum. 100148c5f43SAlan Wright * 101148c5f43SAlan Wright * This method is generalizable to measuring residency in any defined system: 102148c5f43SAlan Wright * instead of queue lengths, think of "outstanding RPC calls to server X". 103148c5f43SAlan Wright * 104148c5f43SAlan Wright * A large number of I/O subsystems have at least two basic "lists" of 105148c5f43SAlan Wright * transactions they manage: one for transactions that have been accepted for 106148c5f43SAlan Wright * processing but for which processing has yet to begin, and one for 107148c5f43SAlan Wright * transactions which are actively being processed (but not done). For this 108148c5f43SAlan Wright * reason, two cumulative time statistics are defined here: wait (pre-service) 109148c5f43SAlan Wright * time, and run (service) time. 110148c5f43SAlan Wright * 111148c5f43SAlan Wright * All times are 64-bit nanoseconds (hrtime_t), as returned by gethrtime(). 112148c5f43SAlan Wright * 113148c5f43SAlan Wright * The units of cumulative busy time are accumulated nanoseconds. The units of 114148c5f43SAlan Wright * cumulative length*time products are elapsed time times queue length. 115148c5f43SAlan Wright * 116148c5f43SAlan Wright * Updates to the fields below are performed implicitly by calls to 117148c5f43SAlan Wright * these functions: 118148c5f43SAlan Wright * 119148c5f43SAlan Wright * smb_srqueue_init() 120148c5f43SAlan Wright * smb_srqueue_destroy() 121148c5f43SAlan Wright * smb_srqueue_waitq_enter() 122148c5f43SAlan Wright * smb_srqueue_runq_exit() 123148c5f43SAlan Wright * smb_srqueue_waitq_to_runq() 124148c5f43SAlan Wright * smb_srqueue_update() 125148c5f43SAlan Wright * 126148c5f43SAlan Wright * These fields should never be updated by any other means. 127148c5f43SAlan Wright */ 128148c5f43SAlan Wright typedef struct smb_srqueue { 129148c5f43SAlan Wright kmutex_t srq_mutex; 130148c5f43SAlan Wright hrtime_t srq_wlastupdate; 131148c5f43SAlan Wright hrtime_t srq_wtime; 132148c5f43SAlan Wright hrtime_t srq_wlentime; 133148c5f43SAlan Wright hrtime_t srq_rlastupdate; 134148c5f43SAlan Wright hrtime_t srq_rtime; 135148c5f43SAlan Wright hrtime_t srq_rlentime; 136148c5f43SAlan Wright uint32_t srq_wcnt; 137148c5f43SAlan Wright uint32_t srq_rcnt; 138148c5f43SAlan Wright } smb_srqueue_t; 139148c5f43SAlan Wright 140148c5f43SAlan Wright /* 141148c5f43SAlan Wright * The fields with the prefix 'ly_a' contain the statistics collected since the 142148c5f43SAlan Wright * server was last started ('a' for 'aggregated'). The fields with the prefix 143148c5f43SAlan Wright * 'ly_d' contain the statistics collected since the last snapshot ('d' for 144148c5f43SAlan Wright * 'delta'). 145148c5f43SAlan Wright */ 146148c5f43SAlan Wright typedef struct smb_latency { 147148c5f43SAlan Wright kmutex_t ly_mutex; 148148c5f43SAlan Wright uint64_t ly_a_nreq; 149148c5f43SAlan Wright hrtime_t ly_a_sum; 150148c5f43SAlan Wright hrtime_t ly_a_mean; 151148c5f43SAlan Wright hrtime_t ly_a_stddev; 152148c5f43SAlan Wright uint64_t ly_d_nreq; 153148c5f43SAlan Wright hrtime_t ly_d_sum; 154148c5f43SAlan Wright hrtime_t ly_d_mean; 155148c5f43SAlan Wright hrtime_t ly_d_stddev; 156148c5f43SAlan Wright } smb_latency_t; 157148c5f43SAlan Wright 1588622ec45SGordon Ross typedef struct smb_disp_stats { 1598622ec45SGordon Ross volatile uint64_t sdt_txb; 1608622ec45SGordon Ross volatile uint64_t sdt_rxb; 1618622ec45SGordon Ross smb_latency_t sdt_lat; 1628622ec45SGordon Ross } smb_disp_stats_t; 1638622ec45SGordon Ross 164da6c28aaSamw int smb_noop(void *, size_t, int); 165da6c28aaSamw 166da6c28aaSamw #define SMB_AUDIT_STACK_DEPTH 16 167da6c28aaSamw #define SMB_AUDIT_BUF_MAX_REC 16 168da6c28aaSamw #define SMB_AUDIT_NODE 0x00000001 169da6c28aaSamw 170c8ec8eeaSjose borrego /* 171c8ec8eeaSjose borrego * Maximum number of records returned in SMBsearch, SMBfind 172c8ec8eeaSjose borrego * and SMBfindunique response. Value set to 10 for compatibility 173c8ec8eeaSjose borrego * with Windows. 174c8ec8eeaSjose borrego */ 175c8ec8eeaSjose borrego #define SMB_MAX_SEARCH 10 176c8ec8eeaSjose borrego 1777f667e74Sjose borrego #define SMB_SEARCH_ATTRIBUTES \ 1787f667e74Sjose borrego (FILE_ATTRIBUTE_HIDDEN | \ 1797f667e74Sjose borrego FILE_ATTRIBUTE_SYSTEM | \ 1807f667e74Sjose borrego FILE_ATTRIBUTE_DIRECTORY) 1817f667e74Sjose borrego 1822c1b14e5Sjose borrego #define SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN) 1832c1b14e5Sjose borrego #define SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM) 1842c1b14e5Sjose borrego #define SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY) 1857f667e74Sjose borrego #define SMB_SEARCH_ALL(sattr) ((sattr) & SMB_SEARCH_ATTRIBUTES) 1862c1b14e5Sjose borrego 187da6c28aaSamw typedef struct { 188da6c28aaSamw uint32_t anr_refcnt; 189da6c28aaSamw int anr_depth; 190da6c28aaSamw pc_t anr_stack[SMB_AUDIT_STACK_DEPTH]; 191da6c28aaSamw } smb_audit_record_node_t; 192da6c28aaSamw 193da6c28aaSamw typedef struct { 194da6c28aaSamw int anb_index; 195da6c28aaSamw int anb_max_index; 196da6c28aaSamw smb_audit_record_node_t anb_records[SMB_AUDIT_BUF_MAX_REC]; 197da6c28aaSamw } smb_audit_buf_node_t; 198da6c28aaSamw 199da6c28aaSamw /* 200da6c28aaSamw * Thread State Machine 201da6c28aaSamw * -------------------- 202da6c28aaSamw * 203da6c28aaSamw * T5 T0 204da6c28aaSamw * smb_thread_destroy() <-------+ +------- smb_thread_init() 205da6c28aaSamw * | | 206da6c28aaSamw * | v 207da6c28aaSamw * +-----------------------------+ 208da6c28aaSamw * | SMB_THREAD_STATE_EXITED |<---+ 209da6c28aaSamw * +-----------------------------+ | 210da6c28aaSamw * | T1 | 211da6c28aaSamw * v | 212da6c28aaSamw * +-----------------------------+ | 213da6c28aaSamw * | SMB_THREAD_STATE_STARTING | | 214da6c28aaSamw * +-----------------------------+ | 215da6c28aaSamw * | T2 | T4 216da6c28aaSamw * v | 217da6c28aaSamw * +-----------------------------+ | 218da6c28aaSamw * | SMB_THREAD_STATE_RUNNING | | 219da6c28aaSamw * +-----------------------------+ | 220da6c28aaSamw * | T3 | 221da6c28aaSamw * v | 222da6c28aaSamw * +-----------------------------+ | 223da6c28aaSamw * | SMB_THREAD_STATE_EXITING |----+ 224da6c28aaSamw * +-----------------------------+ 225da6c28aaSamw * 226da6c28aaSamw * Transition T0 227da6c28aaSamw * 228da6c28aaSamw * This transition is executed in smb_thread_init(). 229da6c28aaSamw * 230da6c28aaSamw * Transition T1 231da6c28aaSamw * 232da6c28aaSamw * This transition is executed in smb_thread_start(). 233da6c28aaSamw * 234da6c28aaSamw * Transition T2 235da6c28aaSamw * 236da6c28aaSamw * This transition is executed by the thread itself when it starts running. 237da6c28aaSamw * 238da6c28aaSamw * Transition T3 239da6c28aaSamw * 240da6c28aaSamw * This transition is executed by the thread itself in 241da6c28aaSamw * smb_thread_entry_point() just before calling thread_exit(). 242da6c28aaSamw * 243da6c28aaSamw * 244da6c28aaSamw * Transition T4 245da6c28aaSamw * 246da6c28aaSamw * This transition is executed in smb_thread_stop(). 247da6c28aaSamw * 248da6c28aaSamw * Transition T5 249da6c28aaSamw * 250da6c28aaSamw * This transition is executed in smb_thread_destroy(). 251da6c28aaSamw */ 252da6c28aaSamw typedef enum smb_thread_state { 253da6c28aaSamw SMB_THREAD_STATE_STARTING = 0, 254da6c28aaSamw SMB_THREAD_STATE_RUNNING, 255da6c28aaSamw SMB_THREAD_STATE_EXITING, 256b819cea2SGordon Ross SMB_THREAD_STATE_EXITED, 257b819cea2SGordon Ross SMB_THREAD_STATE_FAILED 258da6c28aaSamw } smb_thread_state_t; 259da6c28aaSamw 260da6c28aaSamw struct _smb_thread; 261da6c28aaSamw 262da6c28aaSamw typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg); 263da6c28aaSamw 264da6c28aaSamw #define SMB_THREAD_MAGIC 0x534D4254 /* SMBT */ 265da6c28aaSamw 266da6c28aaSamw typedef struct _smb_thread { 267da6c28aaSamw uint32_t sth_magic; 268a90cf9f2SGordon Ross char sth_name[32]; 269da6c28aaSamw smb_thread_state_t sth_state; 270da6c28aaSamw kthread_t *sth_th; 271da6c28aaSamw kt_did_t sth_did; 272da6c28aaSamw smb_thread_ep_t sth_ep; 273da6c28aaSamw void *sth_ep_arg; 27408344b29SGordon Ross pri_t sth_pri; 275da6c28aaSamw boolean_t sth_kill; 276da6c28aaSamw kmutex_t sth_mtx; 277da6c28aaSamw kcondvar_t sth_cv; 278da6c28aaSamw } smb_thread_t; 279da6c28aaSamw 280da6c28aaSamw /* 281da6c28aaSamw * Pool of IDs 282da6c28aaSamw * ----------- 283da6c28aaSamw * 284da6c28aaSamw * A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap. 285da6c28aaSamw * A bit set to '1' indicates that that particular value has been allocated. 286da6c28aaSamw * The allocation process is done shifting a bit through the whole bitmap. 287da6c28aaSamw * The current position of that index bit is kept in the smb_idpool_t 288da6c28aaSamw * structure and represented by a byte index (0 to buffer size minus 1) and 289da6c28aaSamw * a bit index (0 to 7). 290da6c28aaSamw * 291da6c28aaSamw * The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs 292da6c28aaSamw * out of IDs its current size is doubled until it reaches its maximum size 293da6c28aaSamw * (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which 294da6c28aaSamw * means that a pool can have a maximum number of 65534 IDs available. 295da6c28aaSamw */ 296da6c28aaSamw #define SMB_IDPOOL_MAGIC 0x4944504C /* IDPL */ 297da6c28aaSamw #define SMB_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 298da6c28aaSamw #define SMB_IDPOOL_MAX_SIZE 64 * 1024 299da6c28aaSamw 300da6c28aaSamw typedef struct smb_idpool { 301da6c28aaSamw uint32_t id_magic; 302da6c28aaSamw kmutex_t id_mutex; 303da6c28aaSamw uint8_t *id_pool; 304da6c28aaSamw uint32_t id_size; 30512b65585SGordon Ross uint32_t id_maxsize; 306da6c28aaSamw uint8_t id_bit; 307da6c28aaSamw uint8_t id_bit_idx; 308da6c28aaSamw uint32_t id_idx; 309da6c28aaSamw uint32_t id_idx_msk; 310da6c28aaSamw uint32_t id_free_counter; 311da6c28aaSamw uint32_t id_max_free_counter; 312da6c28aaSamw } smb_idpool_t; 313da6c28aaSamw 314da6c28aaSamw /* 3152c2961f8Sjose borrego * Maximum size of a Transport Data Unit when CAP_LARGE_READX and 3162c2961f8Sjose borrego * CAP_LARGE_WRITEX are not set. CAP_LARGE_READX/CAP_LARGE_WRITEX 3172c2961f8Sjose borrego * allow the payload to exceed the negotiated buffer size. 31821b7895dSjb * 4 --> NBT/TCP Transport Header. 31921b7895dSjb * 32 --> SMB Header 32021b7895dSjb * 1 --> Word Count byte 32121b7895dSjb * 510 --> Maximum Number of bytes of the Word Table (2 * 255) 32221b7895dSjb * 2 --> Byte count of the data 32321b7895dSjb * 65535 --> Maximum size of the data 32421b7895dSjb * ----- 32521b7895dSjb * 66084 326da6c28aaSamw */ 3272c2961f8Sjose borrego #define SMB_REQ_MAX_SIZE 66560 /* 65KB */ 32821b7895dSjb #define SMB_XPRT_MAX_SIZE (SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ) 329da6c28aaSamw 33021b7895dSjb #define SMB_TXREQ_MAGIC 0X54524251 /* 'TREQ' */ 3315cdbe942Sjb typedef struct { 33221b7895dSjb list_node_t tr_lnd; 333a90cf9f2SGordon Ross uint32_t tr_magic; 33421b7895dSjb int tr_len; 33521b7895dSjb uint8_t tr_buf[SMB_XPRT_MAX_SIZE]; 33621b7895dSjb } smb_txreq_t; 3375cdbe942Sjb 3385cdbe942Sjb #define SMB_TXLST_MAGIC 0X544C5354 /* 'TLST' */ 3395cdbe942Sjb typedef struct { 3405cdbe942Sjb uint32_t tl_magic; 3415cdbe942Sjb kmutex_t tl_mutex; 342a90cf9f2SGordon Ross kcondvar_t tl_wait_cv; 3435cdbe942Sjb boolean_t tl_active; 3445cdbe942Sjb } smb_txlst_t; 3455cdbe942Sjb 346da6c28aaSamw /* 347faa1795aSjb * Maximum buffer size for NT is 37KB. If all clients are Windows 2000, this 348faa1795aSjb * can be changed to 64KB. 37KB must be used with a mix of NT/Windows 2000 349faa1795aSjb * clients because NT loses directory entries when values greater than 37KB are 350faa1795aSjb * used. 351faa1795aSjb * 352faa1795aSjb * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to 353faa1795aSjb * account for the NBT header. 354da6c28aaSamw */ 355faa1795aSjb #define NBT_MAXBUF 8 356faa1795aSjb #define SMB_NT_MAXBUF (37 * 1024) 357da6c28aaSamw 358da6c28aaSamw #define OUTBUFSIZE (65 * 1024) 359da6c28aaSamw #define SMBHEADERSIZE 32 360da6c28aaSamw #define SMBND_HASH_MASK (0xFF) 361da6c28aaSamw #define MAX_IOVEC 512 362da6c28aaSamw #define MAX_READREF (8 * 1024) 363da6c28aaSamw 364da6c28aaSamw #define SMB_WORKER_MIN 4 365da6c28aaSamw #define SMB_WORKER_DEFAULT 64 366da6c28aaSamw #define SMB_WORKER_MAX 1024 367da6c28aaSamw 368da6c28aaSamw /* 3699fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * Destructor object used in the locked-list delete queue. 370da6c28aaSamw */ 3719fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_DTOR_MAGIC 0x44544F52 /* DTOR */ 3729fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_DTOR_VALID(d) \ 3739fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((d) != NULL) && ((d)->dt_magic == SMB_DTOR_MAGIC)) 374da6c28aaSamw 3759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef void (*smb_dtorproc_t)(void *); 376da6c28aaSamw 3779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_dtor { 3789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States list_node_t dt_lnd; 379a90cf9f2SGordon Ross uint32_t dt_magic; 3809fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States void *dt_object; 3819fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States smb_dtorproc_t dt_proc; 3829fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_dtor_t; 383da6c28aaSamw 384da6c28aaSamw typedef struct smb_llist { 385da6c28aaSamw krwlock_t ll_lock; 386da6c28aaSamw list_t ll_list; 387da6c28aaSamw uint32_t ll_count; 388da6c28aaSamw uint64_t ll_wrop; 3899fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States kmutex_t ll_mutex; 3909fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States list_t ll_deleteq; 3919fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States uint32_t ll_deleteq_count; 392cb174861Sjoyce mcintosh boolean_t ll_flushing; 393da6c28aaSamw } smb_llist_t; 394da6c28aaSamw 395811599a4SMatt Barden typedef struct smb_bucket { 396811599a4SMatt Barden smb_llist_t b_list; 397811599a4SMatt Barden uint32_t b_max_seen; 398811599a4SMatt Barden } smb_bucket_t; 399811599a4SMatt Barden 400811599a4SMatt Barden typedef struct smb_hash { 401811599a4SMatt Barden uint32_t rshift; 402811599a4SMatt Barden uint32_t num_buckets; 403811599a4SMatt Barden smb_bucket_t *buckets; 404811599a4SMatt Barden } smb_hash_t; 405811599a4SMatt Barden 406da6c28aaSamw typedef struct smb_slist { 407da6c28aaSamw kmutex_t sl_mutex; 408da6c28aaSamw kcondvar_t sl_cv; 409da6c28aaSamw list_t sl_list; 410da6c28aaSamw uint32_t sl_count; 411da6c28aaSamw boolean_t sl_waiting; 412da6c28aaSamw } smb_slist_t; 413da6c28aaSamw 414148c5f43SAlan Wright /* 415148c5f43SAlan Wright * smb_avl_t State Machine 416148c5f43SAlan Wright * -------------------- 417148c5f43SAlan Wright * 418148c5f43SAlan Wright * +-----------------------------+ 419148c5f43SAlan Wright * | SMB_AVL_STATE_START | 420148c5f43SAlan Wright * +-----------------------------+ 421148c5f43SAlan Wright * | T0 422148c5f43SAlan Wright * v 423148c5f43SAlan Wright * +-----------------------------+ 424148c5f43SAlan Wright * | SMB_AVL_STATE_READY | 425148c5f43SAlan Wright * +-----------------------------+ 426148c5f43SAlan Wright * | T1 427148c5f43SAlan Wright * v 428148c5f43SAlan Wright * +-----------------------------+ 429148c5f43SAlan Wright * | SMB_AVL_STATE_DESTROYING | 430148c5f43SAlan Wright * +-----------------------------+ 431148c5f43SAlan Wright * 432148c5f43SAlan Wright * Transition T0 433148c5f43SAlan Wright * 434148c5f43SAlan Wright * This transition is executed in smb_avl_create(). 435148c5f43SAlan Wright * 436148c5f43SAlan Wright * Transition T1 437148c5f43SAlan Wright * 438148c5f43SAlan Wright * This transition is executed in smb_avl_destroy(). 439148c5f43SAlan Wright * 440148c5f43SAlan Wright */ 441148c5f43SAlan Wright typedef enum { 442148c5f43SAlan Wright SMB_AVL_STATE_START = 0, 443148c5f43SAlan Wright SMB_AVL_STATE_READY, 444148c5f43SAlan Wright SMB_AVL_STATE_DESTROYING 445148c5f43SAlan Wright } smb_avl_state_t; 446148c5f43SAlan Wright 447148c5f43SAlan Wright typedef struct smb_avl_nops { 448148c5f43SAlan Wright int (*avln_cmp) (const void *, const void *); 449148c5f43SAlan Wright void (*avln_hold)(const void *); 450148c5f43SAlan Wright boolean_t (*avln_rele)(const void *); 451148c5f43SAlan Wright void (*avln_destroy)(void *); 452148c5f43SAlan Wright } smb_avl_nops_t; 453148c5f43SAlan Wright 454148c5f43SAlan Wright typedef struct smb_avl_cursor { 455148c5f43SAlan Wright void *avlc_next; 456148c5f43SAlan Wright uint32_t avlc_sequence; 457148c5f43SAlan Wright } smb_avl_cursor_t; 458148c5f43SAlan Wright 459148c5f43SAlan Wright typedef struct smb_avl { 460148c5f43SAlan Wright krwlock_t avl_lock; 461148c5f43SAlan Wright avl_tree_t avl_tree; 462148c5f43SAlan Wright kmutex_t avl_mutex; 463148c5f43SAlan Wright kcondvar_t avl_cv; 464148c5f43SAlan Wright smb_avl_state_t avl_state; 465148c5f43SAlan Wright uint32_t avl_refcnt; 466148c5f43SAlan Wright uint32_t avl_sequence; 4678622ec45SGordon Ross const smb_avl_nops_t *avl_nops; 468148c5f43SAlan Wright } smb_avl_t; 469148c5f43SAlan Wright 470da6c28aaSamw typedef struct { 471da6c28aaSamw kcondvar_t rwx_cv; 472da6c28aaSamw kmutex_t rwx_mutex; 473da6c28aaSamw krwlock_t rwx_lock; 474da6c28aaSamw boolean_t rwx_waiting; 475da6c28aaSamw } smb_rwx_t; 476da6c28aaSamw 4778622ec45SGordon Ross typedef struct smb_export { 4788622ec45SGordon Ross kmutex_t e_mutex; 4798622ec45SGordon Ross boolean_t e_ready; 4808622ec45SGordon Ross smb_avl_t e_share_avl; 4818622ec45SGordon Ross smb_slist_t e_unexport_list; 4828622ec45SGordon Ross smb_thread_t e_unexport_thread; 4838622ec45SGordon Ross } smb_export_t; 4848622ec45SGordon Ross 485bfe5e737SGordon Ross /* 486bfe5e737SGordon Ross * NOTIFY CHANGE, a.k.a. File Change Notification (FCN) 487bfe5e737SGordon Ross */ 488bfe5e737SGordon Ross 489bfe5e737SGordon Ross /* 490bfe5e737SGordon Ross * These FCN filter mask values are not from MS-FSCC, but 491bfe5e737SGordon Ross * must not overlap with any FILE_NOTIFY_VALID_MASK values. 492bfe5e737SGordon Ross */ 493bfe5e737SGordon Ross #define FILE_NOTIFY_CHANGE_EV_SUBDIR 0x00010000 494bfe5e737SGordon Ross #define FILE_NOTIFY_CHANGE_EV_DELETE 0x00020000 495bfe5e737SGordon Ross #define FILE_NOTIFY_CHANGE_EV_CLOSED 0x00040000 496bfe5e737SGordon Ross #define FILE_NOTIFY_CHANGE_EV_OVERFLOW 0x00080000 497bfe5e737SGordon Ross 498bfe5e737SGordon Ross /* 499bfe5e737SGordon Ross * Note: These FCN action values are not from MS-FSCC, but must 500bfe5e737SGordon Ross * follow in sequence from FILE_ACTION_MODIFIED_STREAM. 501bfe5e737SGordon Ross * 502bfe5e737SGordon Ross * FILE_ACTION_SUBDIR_CHANGED is used internally for 503bfe5e737SGordon Ross * "watch tree" support, posted to all parents of a 504bfe5e737SGordon Ross * directory that had one of the changes above. 505bfe5e737SGordon Ross * 506bfe5e737SGordon Ross * FILE_ACTION_DELETE_PENDING is used internally to tell 507bfe5e737SGordon Ross * notify change requests when the "delete-on-close" flag 508bfe5e737SGordon Ross * has been set on the directory being watched. 509bfe5e737SGordon Ross * 510bfe5e737SGordon Ross * FILE_ACTION_HANDLE_CLOSED is used to wakeup notify change 511bfe5e737SGordon Ross * requests when the watched directory handle is closed. 512bfe5e737SGordon Ross */ 513bfe5e737SGordon Ross #define FILE_ACTION_SUBDIR_CHANGED 0x00000009 514bfe5e737SGordon Ross #define FILE_ACTION_DELETE_PENDING 0x0000000a 515bfe5e737SGordon Ross #define FILE_ACTION_HANDLE_CLOSED 0x0000000b 516bfe5e737SGordon Ross 517bfe5e737SGordon Ross /* 518bfe5e737SGordon Ross * Sub-struct within smb_ofile_t 519bfe5e737SGordon Ross */ 520bfe5e737SGordon Ross typedef struct smb_notify { 521bfe5e737SGordon Ross list_t nc_waiters; /* Waiting SRs */ 522bfe5e737SGordon Ross mbuf_chain_t nc_buffer; 523bfe5e737SGordon Ross uint32_t nc_filter; 524bfe5e737SGordon Ross uint32_t nc_events; 525bfe5e737SGordon Ross int nc_last_off; 526bfe5e737SGordon Ross boolean_t nc_subscribed; 527bfe5e737SGordon Ross } smb_notify_t; 528da6c28aaSamw 529da6c28aaSamw /* 530da6c28aaSamw * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly 531da6c28aaSamw * over TCP, which is also known as direct hosted NetBIOS-less SMB 532da6c28aaSamw * or SMB-over-TCP. 533da6c28aaSamw * 534da6c28aaSamw * NBT messages have a 4-byte header that defines the message type 535da6c28aaSamw * (8-bits), a 7-bit flags field and a 17-bit length. 536da6c28aaSamw * 537da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 538da6c28aaSamw * | TYPE | FLAGS |E| LENGTH | 539da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 540da6c28aaSamw * 541da6c28aaSamw * 8-bit type Defined in RFC 1002 542da6c28aaSamw * 7-bit flags Bits 0-6 reserved (must be 0) 543da6c28aaSamw * Bit 7: Length extension bit (E) 544da6c28aaSamw * 17-bit length Includes bit 7 of the flags byte 545da6c28aaSamw * 546da6c28aaSamw * 547da6c28aaSamw * SMB-over-TCP is defined to use a modified version of the NBT header 548da6c28aaSamw * containing an 8-bit message type and 24-bit message length. 549da6c28aaSamw * 550da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 551da6c28aaSamw * | TYPE | LENGTH | 552da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 553da6c28aaSamw * 554da6c28aaSamw * 8-bit type Must be 0 555da6c28aaSamw * 24-bit length 556da6c28aaSamw * 557da6c28aaSamw * The following structure is used to represent a generic, in-memory 558da6c28aaSamw * SMB transport header; it is not intended to map directly to either 559da6c28aaSamw * of the over-the-wire formats. 560da6c28aaSamw */ 561da6c28aaSamw typedef struct { 562da6c28aaSamw uint8_t xh_type; 563da6c28aaSamw uint32_t xh_length; 564da6c28aaSamw } smb_xprt_t; 565da6c28aaSamw 566faa1795aSjb int MBC_LENGTH(struct mbuf_chain *); 5673ad684d6Sjb int MBC_MAXBYTES(struct mbuf_chain *); 568faa1795aSjb void MBC_SETUP(struct mbuf_chain *, uint32_t); 569faa1795aSjb void MBC_INIT(struct mbuf_chain *, uint32_t); 570faa1795aSjb void MBC_FLUSH(struct mbuf_chain *); 571faa1795aSjb void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *); 572faa1795aSjb void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *); 573da6c28aaSamw void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN); 574da6c28aaSamw int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC, 575da6c28aaSamw int OFF, int LEN); 576da6c28aaSamw 577da6c28aaSamw #define MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes) 578da6c28aaSamw 579cb174861Sjoyce mcintosh /* 58094047d49SGordon Ross * Per smb_node oplock state 581fc724630SAlan Wright */ 582da6c28aaSamw typedef struct smb_oplock { 583cb174861Sjoyce mcintosh kmutex_t ol_mutex; 584cb174861Sjoyce mcintosh boolean_t ol_fem; /* fem monitor installed? */ 58594047d49SGordon Ross struct smb_ofile *excl_open; 58694047d49SGordon Ross uint32_t ol_state; 58794047d49SGordon Ross int32_t cnt_II; 58894047d49SGordon Ross int32_t cnt_R; 58994047d49SGordon Ross int32_t cnt_RH; 59094047d49SGordon Ross int32_t cnt_RHBQ; 59194047d49SGordon Ross int32_t waiters; 59294047d49SGordon Ross kcondvar_t WaitingOpenCV; 593da6c28aaSamw } smb_oplock_t; 594da6c28aaSamw 59594047d49SGordon Ross /* 59694047d49SGordon Ross * Per smb_ofile oplock state 59794047d49SGordon Ross */ 598cb174861Sjoyce mcintosh typedef struct smb_oplock_grant { 59994047d49SGordon Ross /* smb protocol-level state */ 60094047d49SGordon Ross uint32_t og_state; /* latest sent to client */ 60194047d49SGordon Ross uint32_t og_breaking; /* BREAK_TO... flags */ 60294047d49SGordon Ross uint16_t og_dialect; /* how to send breaks */ 60394047d49SGordon Ross /* File-system level state */ 60494047d49SGordon Ross uint8_t onlist_II; 60594047d49SGordon Ross uint8_t onlist_R; 60694047d49SGordon Ross uint8_t onlist_RH; 60794047d49SGordon Ross uint8_t onlist_RHBQ; 60894047d49SGordon Ross uint8_t BreakingToRead; 609cb174861Sjoyce mcintosh } smb_oplock_grant_t; 610cb174861Sjoyce mcintosh 61194047d49SGordon Ross #define SMB_LEASE_KEY_SZ 16 612cb174861Sjoyce mcintosh 61394047d49SGordon Ross typedef struct smb_lease { 61494047d49SGordon Ross list_node_t ls_lnd; /* sv_lease_ht */ 61594047d49SGordon Ross kmutex_t ls_mutex; 61694047d49SGordon Ross smb_llist_t *ls_bucket; 61794047d49SGordon Ross struct smb_node *ls_node; 61894047d49SGordon Ross /* 61994047d49SGordon Ross * With a lease, just one ofile has the oplock. 62094047d49SGordon Ross * This (used only for comparison) identifies which. 62194047d49SGordon Ross */ 62294047d49SGordon Ross void *ls_oplock_ofile; 62394047d49SGordon Ross uint32_t ls_refcnt; 62494047d49SGordon Ross uint32_t ls_state; 62594047d49SGordon Ross uint32_t ls_breaking; /* BREAK_TO... flags */ 62694047d49SGordon Ross uint16_t ls_epoch; 62794047d49SGordon Ross uint16_t ls_version; 62894047d49SGordon Ross uint8_t ls_key[SMB_LEASE_KEY_SZ]; 62994047d49SGordon Ross uint8_t ls_clnt[SMB_LEASE_KEY_SZ]; 63094047d49SGordon Ross } smb_lease_t; 631cb174861Sjoyce mcintosh 6322c2961f8Sjose borrego #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 6332c2961f8Sjose borrego #define SMB_NODE_VALID(p) ASSERT((p)->n_magic == SMB_NODE_MAGIC) 634da6c28aaSamw 635da6c28aaSamw typedef enum { 636da6c28aaSamw SMB_NODE_STATE_AVAILABLE = 0, 637da6c28aaSamw SMB_NODE_STATE_DESTROYING 638da6c28aaSamw } smb_node_state_t; 639da6c28aaSamw 6409fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States /* 6419fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * waiting_event # of clients requesting FCN 6429fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * n_timestamps cached timestamps 6439fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * n_allocsz cached file allocation size 6449fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * n_dnode directory node 6459fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * n_unode unnamed stream node 6469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States * delete_on_close_cred credentials for delayed delete 6479fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States */ 648da6c28aaSamw typedef struct smb_node { 649a90cf9f2SGordon Ross list_node_t n_lnd; 650da6c28aaSamw uint32_t n_magic; 6512c2961f8Sjose borrego krwlock_t n_lock; 6522c2961f8Sjose borrego kmutex_t n_mutex; 653da6c28aaSamw smb_node_state_t n_state; 654da6c28aaSamw uint32_t n_refcnt; 655da6c28aaSamw uint32_t n_hashkey; 656da6c28aaSamw smb_llist_t *n_hash_bucket; 6572c2961f8Sjose borrego uint32_t n_open_count; 658cb174861Sjoyce mcintosh uint32_t n_opening_count; 659da6c28aaSamw smb_llist_t n_ofile_list; 6600897f7fbSGordon Ross /* If entering both, go in order n_lock_list, n_wlock_list */ 6610897f7fbSGordon Ross smb_llist_t n_lock_list; /* active locks */ 6620897f7fbSGordon Ross smb_llist_t n_wlock_list; /* waiting locks */ 6639fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States volatile int flags; 6649fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States u_offset_t n_allocsz; 665bfe5e737SGordon Ross uint32_t n_fcn_count; 666da6c28aaSamw smb_oplock_t n_oplock; 6679fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_node *n_dnode; 6689fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_node *n_unode; 669da6c28aaSamw cred_t *delete_on_close_cred; 6708b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States uint32_t n_delete_on_close_flags; 671da6c28aaSamw char od_name[MAXNAMELEN]; 672da6c28aaSamw vnode_t *vp; 673da6c28aaSamw smb_audit_buf_node_t *n_audit_buf; 674da6c28aaSamw } smb_node_t; 675da6c28aaSamw 6769fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define NODE_FLAGS_REPARSE 0x00001000 6779fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define NODE_FLAGS_DFSLINK 0x00002000 6789fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define NODE_FLAGS_VFSROOT 0x00004000 6799fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define NODE_FLAGS_SYSTEM 0x00008000 680da6c28aaSamw #define NODE_FLAGS_WRITE_THROUGH 0x00100000 681cbfb650aScp #define NODE_XATTR_DIR 0x01000000 68249d83597SMatt Barden #define NODE_FLAGS_DELETE_COMMITTED 0x20000000 683da6c28aaSamw #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 684da6c28aaSamw #define NODE_FLAGS_EXECUTABLE 0x80000000 685da6c28aaSamw 686c8ec8eeaSjose borrego #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 687c8ec8eeaSjose borrego #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 688c8ec8eeaSjose borrego 689148c5f43SAlan Wright /* Maximum buffer size for encryption key */ 690148c5f43SAlan Wright #define SMB_ENCRYPT_KEY_MAXLEN 32 691148c5f43SAlan Wright 692148c5f43SAlan Wright #define SMB_SHARE_MAGIC 0x4B534852 /* KSHR */ 693148c5f43SAlan Wright 694148c5f43SAlan Wright typedef struct smb_kshare { 695148c5f43SAlan Wright uint32_t shr_magic; 696*8d94f651SGordon Ross avl_node_t shr_link; 697*8d94f651SGordon Ross kmutex_t shr_mutex; 698*8d94f651SGordon Ross kcondvar_t shr_cv; 699148c5f43SAlan Wright char *shr_name; 700148c5f43SAlan Wright char *shr_path; 701148c5f43SAlan Wright char *shr_cmnt; 702148c5f43SAlan Wright char *shr_container; 703148c5f43SAlan Wright char *shr_oemname; 704148c5f43SAlan Wright uint32_t shr_flags; 705148c5f43SAlan Wright uint32_t shr_type; 706148c5f43SAlan Wright uint32_t shr_refcnt; 707148c5f43SAlan Wright uint32_t shr_autocnt; 708148c5f43SAlan Wright uid_t shr_uid; 709148c5f43SAlan Wright gid_t shr_gid; 710148c5f43SAlan Wright char *shr_access_none; 711148c5f43SAlan Wright char *shr_access_ro; 712148c5f43SAlan Wright char *shr_access_rw; 713*8d94f651SGordon Ross smb_node_t *shr_root_node; 714*8d94f651SGordon Ross smb_node_t *shr_ca_dir; 715*8d94f651SGordon Ross void *shr_import_busy; 7161160dcf7SMatt Barden smb_cfg_val_t shr_encrypt; /* Share.EncryptData */ 717148c5f43SAlan Wright } smb_kshare_t; 718148c5f43SAlan Wright 719148c5f43SAlan Wright 720148c5f43SAlan Wright typedef struct smb_arg_negotiate { 721148c5f43SAlan Wright char *ni_name; 722148c5f43SAlan Wright int ni_dialect; 723148c5f43SAlan Wright int ni_index; 724148c5f43SAlan Wright uint32_t ni_capabilities; 725148c5f43SAlan Wright uint16_t ni_maxmpxcount; 726148c5f43SAlan Wright int16_t ni_tzcorrection; 727148c5f43SAlan Wright uint8_t ni_keylen; 728148c5f43SAlan Wright uint8_t ni_key[SMB_ENCRYPT_KEY_MAXLEN]; 729148c5f43SAlan Wright timestruc_t ni_servertime; 730148c5f43SAlan Wright } smb_arg_negotiate_t; 731148c5f43SAlan Wright 73212b65585SGordon Ross typedef enum { 73312b65585SGordon Ross SMB_SSNSETUP_PRE_NTLM012 = 1, 73412b65585SGordon Ross SMB_SSNSETUP_NTLM012_NOEXT, 73512b65585SGordon Ross SMB_SSNSETUP_NTLM012_EXTSEC 73612b65585SGordon Ross } smb_ssnsetup_type_t; 73712b65585SGordon Ross 738148c5f43SAlan Wright typedef struct smb_arg_sessionsetup { 73912b65585SGordon Ross smb_ssnsetup_type_t ssi_type; 740148c5f43SAlan Wright char *ssi_user; 741148c5f43SAlan Wright char *ssi_domain; 74212b65585SGordon Ross /* LM password hash, f.k.a. case-insensitive p/w */ 74312b65585SGordon Ross uint16_t ssi_lmpwlen; 74412b65585SGordon Ross uint8_t *ssi_lmpwd; 74512b65585SGordon Ross /* NT password hash, f.k.a. case-sensitive p/w */ 74612b65585SGordon Ross uint16_t ssi_ntpwlen; 74712b65585SGordon Ross uint8_t *ssi_ntpwd; 74812b65585SGordon Ross /* Incoming security blob */ 74912b65585SGordon Ross uint16_t ssi_iseclen; 75012b65585SGordon Ross uint8_t *ssi_isecblob; 75112b65585SGordon Ross /* Incoming security blob */ 75212b65585SGordon Ross uint16_t ssi_oseclen; 75312b65585SGordon Ross uint8_t *ssi_osecblob; 75412b65585SGordon Ross /* parameters */ 75512b65585SGordon Ross uint16_t ssi_maxbufsize; 756148c5f43SAlan Wright uint16_t ssi_maxmpxcount; 757148c5f43SAlan Wright uint32_t ssi_capabilities; 75812b65585SGordon Ross int ssi_native_os; 75912b65585SGordon Ross int ssi_native_lm; 760148c5f43SAlan Wright } smb_arg_sessionsetup_t; 761148c5f43SAlan Wright 762148c5f43SAlan Wright typedef struct tcon { 763a90cf9f2SGordon Ross char *name; 764148c5f43SAlan Wright char *path; 765148c5f43SAlan Wright char *service; 766148c5f43SAlan Wright int pwdlen; 767148c5f43SAlan Wright char *password; 768148c5f43SAlan Wright uint16_t flags; 769148c5f43SAlan Wright uint16_t optional_support; 770148c5f43SAlan Wright smb_kshare_t *si; 771148c5f43SAlan Wright } smb_arg_tcon_t; 772148c5f43SAlan Wright 773da6c28aaSamw /* 774da6c28aaSamw * Based on section 2.6.1.2 (Connection Management) of the June 13, 775da6c28aaSamw * 1996 CIFS spec, a server may terminate the transport connection 776da6c28aaSamw * due to inactivity. The client software is expected to be able to 777da6c28aaSamw * automatically reconnect to the server if this happens. Like much 778da6c28aaSamw * of the useful background information, this section appears to 779da6c28aaSamw * have been dropped from later revisions of the document. 780da6c28aaSamw * 781da6c28aaSamw * Each session has an activity timestamp that's updated whenever a 782da6c28aaSamw * request is dispatched. If the session is idle, i.e. receives no 783da6c28aaSamw * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 784da6c28aaSamw * closed. 785da6c28aaSamw * 786da6c28aaSamw * Each session has an I/O semaphore to serialize communication with 787da6c28aaSamw * the client. For example, after receiving a raw-read request, the 788da6c28aaSamw * server is not allowed to send an oplock break to the client until 789da6c28aaSamw * after it has sent the raw-read data. 790da6c28aaSamw */ 791da6c28aaSamw #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 792da6c28aaSamw 793a90cf9f2SGordon Ross /* SMB1 signing */ 794da6c28aaSamw struct smb_sign { 795da6c28aaSamw unsigned int flags; 796b819cea2SGordon Ross uint32_t seqnum; 797b819cea2SGordon Ross uint_t mackey_len; 798b819cea2SGordon Ross uint8_t *mackey; 799da6c28aaSamw }; 800da6c28aaSamw 801a90cf9f2SGordon Ross /* 802a90cf9f2SGordon Ross * SMB2 signing 803a90cf9f2SGordon Ross */ 804a90cf9f2SGordon Ross struct smb_key { 805a90cf9f2SGordon Ross uint_t len; 806a90cf9f2SGordon Ross uint8_t key[SMB2_SESSION_KEY_LEN]; 807a90cf9f2SGordon Ross }; 808a90cf9f2SGordon Ross 809da6c28aaSamw #define SMB_SIGNING_ENABLED 1 810da6c28aaSamw #define SMB_SIGNING_CHECK 2 811da6c28aaSamw 812811599a4SMatt Barden /* 813811599a4SMatt Barden * Locking notes: 814811599a4SMatt Barden * If you hold the mutex/lock on an object, don't flush the deleteq 815811599a4SMatt Barden * of the objects directly below it in the logical hierarchy 816811599a4SMatt Barden * (i.e. via smb_llist_exit()). I.e. don't drop s_tree_list when 817811599a4SMatt Barden * you hold u_mutex, because deleted trees need u_mutex to 818811599a4SMatt Barden * lower the refcnt. 819811599a4SMatt Barden * 820811599a4SMatt Barden * Note that this also applies to u_mutex and t_ofile_list. 821811599a4SMatt Barden */ 822811599a4SMatt Barden 823811599a4SMatt Barden /* 824811599a4SMatt Barden * The "session" object. 825811599a4SMatt Barden * 826811599a4SMatt Barden * Note that the smb_session_t object here corresponds to what MS-SMB2 827811599a4SMatt Barden * calls a "connection". Adding to the confusion, what MS calls a 828811599a4SMatt Barden * "session" corresponds to our smb_user_t (below). 829811599a4SMatt Barden */ 830811599a4SMatt Barden 831da6c28aaSamw /* 832da6c28aaSamw * Session State Machine 833da6c28aaSamw * --------------------- 834da6c28aaSamw * 835811599a4SMatt Barden * 836811599a4SMatt Barden * +-----------------------------+ +----------------------------+ 837811599a4SMatt Barden * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_SHUTDOWN | 838811599a4SMatt Barden * +-----------------------------+ +----------------------------+ 839811599a4SMatt Barden * | ^ 840811599a4SMatt Barden * | |T6 841811599a4SMatt Barden * | +------------------------------+ 842811599a4SMatt Barden * | | SMB_SESSION_STATE_TERMINATED | 843811599a4SMatt Barden * T0| +------------------------------+ 844811599a4SMatt Barden * +--------------------+ ^ 845811599a4SMatt Barden * v |T4 |T5 846da6c28aaSamw * +-------------------------------+ | +--------------------------------+ 847da6c28aaSamw * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 848da6c28aaSamw * +-------------------------------+ +--------------------------------+ 849a90cf9f2SGordon Ross * T1| ^ 850a90cf9f2SGordon Ross * +----------+ |T3 851a90cf9f2SGordon Ross * v | 852a90cf9f2SGordon Ross * +------------------------------+ 853a90cf9f2SGordon Ross * | SMB_SESSION_STATE_NEGOTIATED | 854a90cf9f2SGordon Ross * +------------------------------+ 855a90cf9f2SGordon Ross * 856da6c28aaSamw * 857da6c28aaSamw * Transition T0 858da6c28aaSamw * 859da6c28aaSamw * 860da6c28aaSamw * 861da6c28aaSamw * Transition T1 862da6c28aaSamw * 863da6c28aaSamw * 864da6c28aaSamw * 865da6c28aaSamw * Transition T2 866da6c28aaSamw * 867da6c28aaSamw * 868da6c28aaSamw * 869da6c28aaSamw * Transition T3 870da6c28aaSamw * 871da6c28aaSamw * 872da6c28aaSamw * 873da6c28aaSamw * Transition T4 874da6c28aaSamw * 875da6c28aaSamw * 876da6c28aaSamw * 877da6c28aaSamw * Transition T5 878da6c28aaSamw * 879da6c28aaSamw * 880da6c28aaSamw * 881811599a4SMatt Barden * Transition T6 882811599a4SMatt Barden * 883811599a4SMatt Barden * 884811599a4SMatt Barden * 885da6c28aaSamw */ 8862c2961f8Sjose borrego #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 8879fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_SESSION_VALID(p) \ 8889fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((p) != NULL) && ((p)->s_magic == SMB_SESSION_MAGIC)) 889da6c28aaSamw 890f9bc6dadSDmitry.Savitsky@nexenta.com #define SMB_CHALLENGE_SZ 8 891f9bc6dadSDmitry.Savitsky@nexenta.com 892da6c28aaSamw typedef enum { 893faa1795aSjb SMB_SESSION_STATE_INITIALIZED = 0, 894faa1795aSjb SMB_SESSION_STATE_DISCONNECTED, 895da6c28aaSamw SMB_SESSION_STATE_CONNECTED, 896da6c28aaSamw SMB_SESSION_STATE_ESTABLISHED, 897da6c28aaSamw SMB_SESSION_STATE_NEGOTIATED, 8986537f381Sas SMB_SESSION_STATE_TERMINATED, 899811599a4SMatt Barden SMB_SESSION_STATE_SHUTDOWN, 9006537f381Sas SMB_SESSION_STATE_SENTINEL 901da6c28aaSamw } smb_session_state_t; 902da6c28aaSamw 903d082c877SGordon Ross /* Bits in s_flags below */ 904d082c877SGordon Ross #define SMB_SSN_AAPL_CCEXT 1 /* Saw "AAPL" create ctx. ext. */ 905d082c877SGordon Ross #define SMB_SSN_AAPL_READDIR 2 /* Wants MacOS ext. readdir */ 906d082c877SGordon Ross 907faa1795aSjb typedef struct smb_session { 908a90cf9f2SGordon Ross list_node_t s_lnd; 909da6c28aaSamw uint32_t s_magic; 910da6c28aaSamw smb_rwx_t s_lock; 911da6c28aaSamw uint64_t s_kid; 912da6c28aaSamw smb_session_state_t s_state; 913da6c28aaSamw uint32_t s_flags; 9148622ec45SGordon Ross taskqid_t s_receiver_tqid; 915faa1795aSjb kthread_t *s_thread; 916faa1795aSjb kt_did_t s_ktdid; 917a90cf9f2SGordon Ross int (*newrq_func)(struct smb_request *); 918faa1795aSjb struct smb_server *s_server; 919a90cf9f2SGordon Ross smb_kmod_cfg_t s_cfg; 920c8ec8eeaSjose borrego int32_t s_gmtoff; 921da6c28aaSamw uint32_t keep_alive; 922da6c28aaSamw uint64_t opentime; 923da6c28aaSamw uint16_t s_local_port; 924a90cf9f2SGordon Ross uint16_t s_remote_port; 9257f667e74Sjose borrego smb_inaddr_t ipaddr; 9267f667e74Sjose borrego smb_inaddr_t local_ipaddr; 927da6c28aaSamw int dialect; 928da6c28aaSamw int native_os; 929148c5f43SAlan Wright int native_lm; 930148c5f43SAlan Wright 931a90cf9f2SGordon Ross kmutex_t s_credits_mutex; 932a90cf9f2SGordon Ross uint16_t s_cur_credits; 933a90cf9f2SGordon Ross uint16_t s_max_credits; 934a90cf9f2SGordon Ross 935da6c28aaSamw uint32_t capabilities; 9361160dcf7SMatt Barden uint32_t srv_cap; 93712b65585SGordon Ross 93812b65585SGordon Ross struct smb_sign signing; /* SMB1 */ 93912b65585SGordon Ross void *sign_mech; /* mechanism info */ 9401160dcf7SMatt Barden void *enc_mech; 941c51c88bdSMatt Barden 942c51c88bdSMatt Barden /* SMB2/SMB3 signing support */ 943c51c88bdSMatt Barden int (*sign_calc)(struct smb_request *, 944c51c88bdSMatt Barden struct mbuf_chain *, uint8_t *); 945b819cea2SGordon Ross void (*sign_fini)(struct smb_session *); 946da6c28aaSamw 9470f1702c5SYu Xiangning ksocket_t sock; 948da6c28aaSamw 949da6c28aaSamw smb_slist_t s_req_list; 950da6c28aaSamw smb_llist_t s_xa_list; 951da6c28aaSamw smb_llist_t s_user_list; 9523b13a1efSThomas Keiser smb_llist_t s_tree_list; 953da6c28aaSamw smb_idpool_t s_uid_pool; 9543b13a1efSThomas Keiser smb_idpool_t s_tid_pool; 9555cdbe942Sjb smb_txlst_t s_txlst; 956da6c28aaSamw 957da6c28aaSamw volatile uint32_t s_tree_cnt; 958da6c28aaSamw volatile uint32_t s_file_cnt; 959da6c28aaSamw volatile uint32_t s_dir_cnt; 960da6c28aaSamw 9611160dcf7SMatt Barden uint16_t cli_secmode; 9621160dcf7SMatt Barden uint16_t srv_secmode; 963da6c28aaSamw uint32_t sesskey; 964da6c28aaSamw uint32_t challenge_len; 965f9bc6dadSDmitry.Savitsky@nexenta.com unsigned char challenge_key[SMB_CHALLENGE_SZ]; 966da6c28aaSamw int64_t activity_timestamp; 967811599a4SMatt Barden 968da6c28aaSamw /* 969a90cf9f2SGordon Ross * Maximum negotiated buffer sizes between SMB client and server 970da6c28aaSamw * in SMB_SESSION_SETUP_ANDX 971da6c28aaSamw */ 972a90cf9f2SGordon Ross int cmd_max_bytes; 973a90cf9f2SGordon Ross int reply_max_bytes; 974da6c28aaSamw uint16_t smb_msg_size; 97512b65585SGordon Ross uint16_t smb_max_mpx; 976148c5f43SAlan Wright smb_srqueue_t *s_srqueue; 977a90cf9f2SGordon Ross uint64_t start_time; 978a90cf9f2SGordon Ross unsigned char MAC_key[44]; 97949b5df1eSGordon Ross char ip_addr_str[INET6_ADDRSTRLEN]; 980811599a4SMatt Barden uint8_t clnt_uuid[16]; 981*8d94f651SGordon Ross char workstation[SMB_PI_MAX_HOST]; 982faa1795aSjb } smb_session_t; 983da6c28aaSamw 984811599a4SMatt Barden /* 985811599a4SMatt Barden * The "user" object. 986811599a4SMatt Barden * 987811599a4SMatt Barden * Note that smb_user_t object here corresponds to what MS-SMB2 calls 988811599a4SMatt Barden * a "session". (Our smb_session_t is something else -- see above). 989811599a4SMatt Barden */ 990811599a4SMatt Barden 991da6c28aaSamw #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 9929fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_USER_VALID(u) \ 9939fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((u) != NULL) && ((u)->u_magic == SMB_USER_MAGIC)) 994da6c28aaSamw 9951160dcf7SMatt Barden /* These flags are all <= 0x00000010 */ 996da6c28aaSamw #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 997a90cf9f2SGordon Ross #define SMB_USER_FLAG_ANON SMB_ATF_ANON 998da6c28aaSamw #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 999da6c28aaSamw #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 1000da6c28aaSamw #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 1001da6c28aaSamw 1002148c5f43SAlan Wright #define SMB_USER_IS_ADMIN(U) (((U)->u_flags & SMB_USER_FLAG_ADMIN) != 0) 1003148c5f43SAlan Wright #define SMB_USER_IS_GUEST(U) (((U)->u_flags & SMB_USER_FLAG_GUEST) != 0) 1004148c5f43SAlan Wright 1005cc3780e6SGordon Ross /* 1006cc3780e6SGordon Ross * Internal privilege flags derived from smb_privilege.h numbers 1007cc3780e6SGordon Ross * Would rather not include that in this file. 1008cc3780e6SGordon Ross */ 1009cc3780e6SGordon Ross #define SMB_USER_PRIV_SECURITY (1<<8) /* SE_SECURITY_LUID */ 1010cc3780e6SGordon Ross #define SMB_USER_PRIV_TAKE_OWNERSHIP (1<<9) /* SE_TAKE_OWNERSHIP_LUID */ 1011cc3780e6SGordon Ross #define SMB_USER_PRIV_BACKUP (1<<17) /* SE_BACKUP_LUID */ 1012cc3780e6SGordon Ross #define SMB_USER_PRIV_RESTORE (1<<18) /* SE_RESTORE_LUID */ 1013cc3780e6SGordon Ross #define SMB_USER_PRIV_CHANGE_NOTIFY (1<<23) /* SE_CHANGE_NOTIFY_LUID */ 1014da6c28aaSamw 1015811599a4SMatt Barden /* 1016811599a4SMatt Barden * See the long "User State Machine" comment in smb_user.c 1017811599a4SMatt Barden */ 1018da6c28aaSamw typedef enum { 101912b65585SGordon Ross SMB_USER_STATE_LOGGING_ON = 0, 102012b65585SGordon Ross SMB_USER_STATE_LOGGED_ON, 1021da6c28aaSamw SMB_USER_STATE_LOGGING_OFF, 10226537f381Sas SMB_USER_STATE_LOGGED_OFF, 10236537f381Sas SMB_USER_STATE_SENTINEL 1024da6c28aaSamw } smb_user_state_t; 1025da6c28aaSamw 1026811599a4SMatt Barden typedef enum { 1027811599a4SMatt Barden SMB2_DH_PRESERVE_NONE = 0, 1028811599a4SMatt Barden SMB2_DH_PRESERVE_SOME, 1029811599a4SMatt Barden SMB2_DH_PRESERVE_ALL 1030811599a4SMatt Barden } smb_preserve_type_t; 1031811599a4SMatt Barden 1032da6c28aaSamw typedef struct smb_user { 1033da6c28aaSamw list_node_t u_lnd; 1034a90cf9f2SGordon Ross uint32_t u_magic; 1035da6c28aaSamw kmutex_t u_mutex; 1036da6c28aaSamw smb_user_state_t u_state; 1037da6c28aaSamw 1038faa1795aSjb struct smb_server *u_server; 1039da6c28aaSamw smb_session_t *u_session; 104012b65585SGordon Ross ksocket_t u_authsock; 10418f70e16bSGordon Ross timeout_id_t u_auth_tmo; 1042da6c28aaSamw uint16_t u_name_len; 1043da6c28aaSamw char *u_name; 1044da6c28aaSamw uint16_t u_domain_len; 1045da6c28aaSamw char *u_domain; 1046da6c28aaSamw time_t u_logon_time; 1047da6c28aaSamw cred_t *u_cred; 1048b89a8333Snatalie li - Sun Microsystems - Irvine United States cred_t *u_privcred; 1049da6c28aaSamw 1050811599a4SMatt Barden uint64_t u_ssnid; /* unique server-wide */ 1051da6c28aaSamw uint32_t u_refcnt; 1052da6c28aaSamw uint32_t u_flags; 1053811599a4SMatt Barden smb_preserve_type_t preserve_opens; 1054da6c28aaSamw uint32_t u_privileges; 1055811599a4SMatt Barden uint16_t u_uid; /* unique per-session */ 1056da6c28aaSamw uint32_t u_audit_sid; 1057a90cf9f2SGordon Ross 1058a90cf9f2SGordon Ross uint32_t u_sign_flags; 1059a90cf9f2SGordon Ross struct smb_key u_sign_key; /* SMB2 signing */ 10601160dcf7SMatt Barden 10611160dcf7SMatt Barden struct smb_key u_enc_key; 10621160dcf7SMatt Barden struct smb_key u_dec_key; 10631160dcf7SMatt Barden volatile uint64_t u_nonce_cnt; 10641160dcf7SMatt Barden uint8_t u_nonce_fixed[4]; 10651160dcf7SMatt Barden uint64_t u_salt; 10661160dcf7SMatt Barden smb_cfg_val_t u_encrypt; 1067da6c28aaSamw } smb_user_t; 1068da6c28aaSamw 1069c8ec8eeaSjose borrego #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 10709fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_TREE_VALID(p) \ 10719fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT((p != NULL) && ((p)->t_magic == SMB_TREE_MAGIC)) 1072c8ec8eeaSjose borrego 1073c8ec8eeaSjose borrego #define SMB_TYPENAMELEN _ST_FSTYPSZ 1074c8ec8eeaSjose borrego #define SMB_VOLNAMELEN 32 1075c8ec8eeaSjose borrego 1076c8ec8eeaSjose borrego #define SMB_TREE_READONLY 0x00000001 1077c8ec8eeaSjose borrego #define SMB_TREE_SUPPORTS_ACLS 0x00000002 1078c8ec8eeaSjose borrego #define SMB_TREE_STREAMS 0x00000004 1079c8ec8eeaSjose borrego #define SMB_TREE_CASEINSENSITIVE 0x00000008 1080c8ec8eeaSjose borrego #define SMB_TREE_NO_CASESENSITIVE 0x00000010 1081c8ec8eeaSjose borrego #define SMB_TREE_NO_EXPORT 0x00000020 1082cb174861Sjoyce mcintosh #define SMB_TREE_OPLOCKS 0x00000040 1083cb174861Sjoyce mcintosh #define SMB_TREE_SHORTNAMES 0x00000080 1084c8ec8eeaSjose borrego #define SMB_TREE_XVATTR 0x00000100 1085c8ec8eeaSjose borrego #define SMB_TREE_DIRENTFLAGS 0x00000200 1086c8ec8eeaSjose borrego #define SMB_TREE_ACLONCREATE 0x00000400 1087c8ec8eeaSjose borrego #define SMB_TREE_ACEMASKONACCESS 0x00000800 1088c8ec8eeaSjose borrego #define SMB_TREE_NFS_MOUNTED 0x00001000 1089fc724630SAlan Wright #define SMB_TREE_UNICODE_ON_DISK 0x00002000 10908b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_TREE_CATIA 0x00004000 1091e3f2c991SKeyur Desai #define SMB_TREE_ABE 0x00008000 10929fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_TREE_QUOTA 0x00010000 10939fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_TREE_DFSROOT 0x00020000 1094fd9ee8b5Sjoyce mcintosh #define SMB_TREE_SPARSE 0x00040000 10955f1ef25cSAram Hăvărneanu #define SMB_TREE_TRAVERSE_MOUNTS 0x00080000 109694047d49SGordon Ross #define SMB_TREE_FORCE_L2_OPLOCK 0x00100000 1097*8d94f651SGordon Ross #define SMB_TREE_CA 0x00200000 109894047d49SGordon Ross /* Note: SMB_TREE_... in the mdb module too. */ 10992c1b14e5Sjose borrego 1100811599a4SMatt Barden /* 1101811599a4SMatt Barden * See the long "Tree State Machine" comment in smb_tree.c 1102811599a4SMatt Barden */ 1103da6c28aaSamw typedef enum { 1104da6c28aaSamw SMB_TREE_STATE_CONNECTED = 0, 1105da6c28aaSamw SMB_TREE_STATE_DISCONNECTING, 11066537f381Sas SMB_TREE_STATE_DISCONNECTED, 11076537f381Sas SMB_TREE_STATE_SENTINEL 1108da6c28aaSamw } smb_tree_state_t; 1109da6c28aaSamw 1110da6c28aaSamw typedef struct smb_tree { 1111a90cf9f2SGordon Ross list_node_t t_lnd; 1112da6c28aaSamw uint32_t t_magic; 1113da6c28aaSamw kmutex_t t_mutex; 1114da6c28aaSamw smb_tree_state_t t_state; 1115da6c28aaSamw 1116faa1795aSjb struct smb_server *t_server; 1117da6c28aaSamw smb_session_t *t_session; 11183b13a1efSThomas Keiser /* 11193b13a1efSThomas Keiser * user whose uid was in the tree connect message 11203b13a1efSThomas Keiser * ("owner" in MS-CIFS parlance, see section 2.2.1.6 definition of FID) 11213b13a1efSThomas Keiser */ 11223b13a1efSThomas Keiser smb_user_t *t_owner; 1123da6c28aaSamw smb_node_t *t_snode; 1124da6c28aaSamw 1125da6c28aaSamw smb_llist_t t_ofile_list; 1126da6c28aaSamw smb_idpool_t t_fid_pool; 1127da6c28aaSamw 1128da6c28aaSamw smb_llist_t t_odir_list; 11297f667e74Sjose borrego smb_idpool_t t_odid_pool; 1130da6c28aaSamw 1131da6c28aaSamw uint32_t t_refcnt; 1132da6c28aaSamw uint32_t t_flags; 1133da6c28aaSamw int32_t t_res_type; 1134da6c28aaSamw uint16_t t_tid; 1135da6c28aaSamw uint16_t t_umask; 1136da6c28aaSamw char t_sharename[MAXNAMELEN]; 1137da6c28aaSamw char t_resource[MAXPATHLEN]; 1138c8ec8eeaSjose borrego char t_typename[SMB_TYPENAMELEN]; 1139c8ec8eeaSjose borrego char t_volume[SMB_VOLNAMELEN]; 1140da6c28aaSamw acl_type_t t_acltype; 1141743a77edSAlan Wright uint32_t t_access; 1142148c5f43SAlan Wright uint32_t t_execflags; 11431fcced4cSJordan Brown time_t t_connect_time; 11441fcced4cSJordan Brown volatile uint32_t t_open_files; 11451160dcf7SMatt Barden smb_cfg_val_t t_encrypt; /* Share.EncryptData */ 1146da6c28aaSamw } smb_tree_t; 1147da6c28aaSamw 1148c8ec8eeaSjose borrego #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 1149c8ec8eeaSjose borrego #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 1150c8ec8eeaSjose borrego 1151743a77edSAlan Wright #define SMB_TREE_IS_READONLY(sr) \ 1152743a77edSAlan Wright ((sr) != NULL && (sr)->tid_tree != NULL && \ 1153743a77edSAlan Wright !((sr)->tid_tree->t_access & ACE_ALL_WRITE_PERMS)) 1154c8ec8eeaSjose borrego 1155c8ec8eeaSjose borrego #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 1156c8ec8eeaSjose borrego (((sr) && (sr)->tid_tree) ? \ 1157c8ec8eeaSjose borrego smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 1158da6c28aaSamw 1159743a77edSAlan Wright #define SMB_TREE_HAS_ACCESS(sr, acemask) \ 1160743a77edSAlan Wright ((sr) == NULL ? ACE_ALL_PERMS : ( \ 1161743a77edSAlan Wright (((sr) && (sr)->tid_tree) ? \ 1162743a77edSAlan Wright (((sr)->tid_tree->t_access) & (acemask)) : 0))) 1163743a77edSAlan Wright 1164*8d94f651SGordon Ross #define SMB_TREE_SUPPORTS_CATIA(sr) \ 11658b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States (((sr) && (sr)->tid_tree) ? \ 11668b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CATIA) : 0) 11678b2cc8acSafshin salek ardakani - Sun Microsystems - Irvine United States 1168*8d94f651SGordon Ross #define SMB_TREE_SUPPORTS_ABE(sr) \ 1169e3f2c991SKeyur Desai (((sr) && (sr)->tid_tree) ? \ 1170e3f2c991SKeyur Desai smb_tree_has_feature((sr)->tid_tree, SMB_TREE_ABE) : 0) 1171e3f2c991SKeyur Desai 1172*8d94f651SGordon Ross #define SMB_TREE_IS_DFSROOT(sr) \ 11739fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States (((sr) && (sr)->tid_tree) ? \ 11749fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States smb_tree_has_feature((sr)->tid_tree, SMB_TREE_DFSROOT) : 0) 11759fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 1176cb174861Sjoyce mcintosh #define SMB_TREE_SUPPORTS_SHORTNAMES(sr) \ 1177cb174861Sjoyce mcintosh (((sr) && (sr)->tid_tree) ? \ 1178cb174861Sjoyce mcintosh smb_tree_has_feature((sr)->tid_tree, SMB_TREE_SHORTNAMES) : 0) 1179cb174861Sjoyce mcintosh 1180da6c28aaSamw /* 11815f1ef25cSAram Hăvărneanu * SMB_TREE_CONTAINS_NODE is used to check if a node is on the same 11825f1ef25cSAram Hăvărneanu * file system as the tree's root filesystem, or if mount point traversal 11835f1ef25cSAram Hăvărneanu * should be allowed. Note that this is also called in some cases with 11845f1ef25cSAram Hăvărneanu * sr=NULL, where it is expected to evaluate to TRUE. 1185da6c28aaSamw */ 11865f1ef25cSAram Hăvărneanu 1187c8ec8eeaSjose borrego #define SMB_TREE_CONTAINS_NODE(sr, node) \ 11885f1ef25cSAram Hăvărneanu ((sr) == NULL || (sr)->tid_tree == NULL || \ 11895f1ef25cSAram Hăvărneanu SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node) || \ 11905f1ef25cSAram Hăvărneanu smb_tree_has_feature((sr)->tid_tree, SMB_TREE_TRAVERSE_MOUNTS)) 1191da6c28aaSamw 1192c8ec8eeaSjose borrego /* 1193c8ec8eeaSjose borrego * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 11945fd03bc0SGordon Ross * readonly when the caller has a path rather than an ofile. 1195c8ec8eeaSjose borrego */ 11965fd03bc0SGordon Ross #define SMB_PATHFILE_IS_READONLY(sr, node) \ 11975fd03bc0SGordon Ross (SMB_TREE_IS_READONLY((sr)) || \ 11985fd03bc0SGordon Ross smb_node_file_is_readonly((node))) 1199da6c28aaSamw 1200*8d94f651SGordon Ross #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 1201a90cf9f2SGordon Ross #define SMB_ODIR_VALID(p) \ 1202a90cf9f2SGordon Ross ASSERT((p != NULL) && ((p)->d_magic == SMB_ODIR_MAGIC)) 1203a90cf9f2SGordon Ross 1204a90cf9f2SGordon Ross #define SMB_ODIR_BUFSIZE (8 * 1024) 1205a90cf9f2SGordon Ross 1206a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_WILDCARDS 0x0001 1207a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_IGNORE_CASE 0x0002 1208a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_XATTR 0x0004 1209a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_EDIRENT 0x0008 1210a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_CATIA 0x0010 1211a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_ABE 0x0020 1212a90cf9f2SGordon Ross #define SMB_ODIR_FLAG_SHORTNAMES 0x0040 1213a90cf9f2SGordon Ross 1214a90cf9f2SGordon Ross typedef enum { 1215a90cf9f2SGordon Ross SMB_ODIR_STATE_OPEN = 0, 1216a90cf9f2SGordon Ross SMB_ODIR_STATE_IN_USE, 1217a90cf9f2SGordon Ross SMB_ODIR_STATE_CLOSING, 1218a90cf9f2SGordon Ross SMB_ODIR_STATE_CLOSED, 1219a90cf9f2SGordon Ross SMB_ODIR_STATE_SENTINEL 1220a90cf9f2SGordon Ross } smb_odir_state_t; 1221a90cf9f2SGordon Ross 1222a90cf9f2SGordon Ross typedef enum { 1223a90cf9f2SGordon Ross SMB_ODIR_RESUME_CONT, 1224a90cf9f2SGordon Ross SMB_ODIR_RESUME_IDX, 1225a90cf9f2SGordon Ross SMB_ODIR_RESUME_COOKIE, 1226a90cf9f2SGordon Ross SMB_ODIR_RESUME_FNAME 1227a90cf9f2SGordon Ross } smb_odir_resume_type_t; 1228a90cf9f2SGordon Ross 1229a90cf9f2SGordon Ross typedef struct smb_odir_resume { 1230a90cf9f2SGordon Ross smb_odir_resume_type_t or_type; 1231a90cf9f2SGordon Ross int or_idx; 1232a90cf9f2SGordon Ross uint32_t or_cookie; 1233a90cf9f2SGordon Ross char *or_fname; 1234a90cf9f2SGordon Ross } smb_odir_resume_t; 1235a90cf9f2SGordon Ross 1236a90cf9f2SGordon Ross /* 1237a90cf9f2SGordon Ross * Flags used when opening an odir 1238a90cf9f2SGordon Ross */ 1239a90cf9f2SGordon Ross #define SMB_ODIR_OPENF_BACKUP_INTENT 0x01 1240a90cf9f2SGordon Ross 1241a90cf9f2SGordon Ross typedef struct smb_odir { 1242a90cf9f2SGordon Ross list_node_t d_lnd; 1243a90cf9f2SGordon Ross uint32_t d_magic; 1244a90cf9f2SGordon Ross kmutex_t d_mutex; 1245a90cf9f2SGordon Ross smb_odir_state_t d_state; 1246a90cf9f2SGordon Ross smb_session_t *d_session; 1247a90cf9f2SGordon Ross smb_user_t *d_user; 1248a90cf9f2SGordon Ross smb_tree_t *d_tree; 1249a90cf9f2SGordon Ross smb_node_t *d_dnode; 1250a90cf9f2SGordon Ross cred_t *d_cred; 1251a90cf9f2SGordon Ross uint32_t d_opened_by_pid; 1252a90cf9f2SGordon Ross uint16_t d_odid; 1253a90cf9f2SGordon Ross uint16_t d_sattr; 1254a90cf9f2SGordon Ross uint32_t d_refcnt; 1255a90cf9f2SGordon Ross uint32_t d_flags; 1256a90cf9f2SGordon Ross boolean_t d_eof; 1257a90cf9f2SGordon Ross int d_bufsize; 1258a90cf9f2SGordon Ross uint64_t d_offset; 1259a90cf9f2SGordon Ross union { 1260a90cf9f2SGordon Ross char *u_bufptr; 1261a90cf9f2SGordon Ross struct edirent *u_edp; 1262a90cf9f2SGordon Ross struct dirent64 *u_dp; 1263a90cf9f2SGordon Ross } d_u; 1264a90cf9f2SGordon Ross uint32_t d_last_cookie; 1265a90cf9f2SGordon Ross uint32_t d_cookies[SMB_MAX_SEARCH]; 1266a90cf9f2SGordon Ross char d_pattern[MAXNAMELEN]; 1267a90cf9f2SGordon Ross char d_buf[SMB_ODIR_BUFSIZE]; 1268a90cf9f2SGordon Ross char d_last_name[MAXNAMELEN]; 1269a90cf9f2SGordon Ross } smb_odir_t; 1270a90cf9f2SGordon Ross #define d_bufptr d_u.u_bufptr 1271a90cf9f2SGordon Ross #define d_edp d_u.u_edp 1272a90cf9f2SGordon Ross #define d_dp d_u.u_dp 1273a90cf9f2SGordon Ross 1274a90cf9f2SGordon Ross typedef struct smb_odirent { 1275a90cf9f2SGordon Ross char od_name[MAXNAMELEN]; /* on disk name */ 1276a90cf9f2SGordon Ross ino64_t od_ino; 1277a90cf9f2SGordon Ross uint32_t od_eflags; 1278a90cf9f2SGordon Ross } smb_odirent_t; 1279a90cf9f2SGordon Ross 12809fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_OPIPE_MAGIC 0x50495045 /* 'PIPE' */ 12819fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_OPIPE_VALID(p) \ 12829fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((p) != NULL) && (p)->p_magic == SMB_OPIPE_MAGIC) 128368b2bbf2SGordon Ross #define SMB_OPIPE_MAXNAME 32 1284da6c28aaSamw 12853db3f65cSamw /* 12863db3f65cSamw * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 12873db3f65cSamw * at the interface between SMB and NDR RPC. 12883db3f65cSamw */ 12893db3f65cSamw typedef struct smb_opipe { 12909fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States uint32_t p_magic; 12919fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States kmutex_t p_mutex; 12929fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States kcondvar_t p_cv; 129368b2bbf2SGordon Ross struct smb_ofile *p_ofile; 12949fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States struct smb_server *p_server; 129568b2bbf2SGordon Ross uint32_t p_refcnt; 129668b2bbf2SGordon Ross ksocket_t p_socket; 129768b2bbf2SGordon Ross /* This is the "flat" name, without path prefix */ 129868b2bbf2SGordon Ross char p_name[SMB_OPIPE_MAXNAME]; 12993db3f65cSamw } smb_opipe_t; 13003db3f65cSamw 1301da6c28aaSamw /* 1302da6c28aaSamw * The of_ftype of an open file should contain the SMB_FTYPE value 1303bbf6f00cSJordan Brown * returned when the file/pipe was opened. The following 1304da6c28aaSamw * assumptions are currently made: 1305da6c28aaSamw * 1306da6c28aaSamw * File Type Node PipeInfo 1307da6c28aaSamw * --------- -------- -------- 1308da6c28aaSamw * SMB_FTYPE_DISK Valid Null 1309da6c28aaSamw * SMB_FTYPE_BYTE_PIPE Undefined Undefined 1310da6c28aaSamw * SMB_FTYPE_MESG_PIPE Null Valid 1311da6c28aaSamw * SMB_FTYPE_PRINTER Undefined Undefined 1312da6c28aaSamw * SMB_FTYPE_UNKNOWN Undefined Undefined 1313da6c28aaSamw */ 1314da6c28aaSamw 1315da6c28aaSamw /* 1316da6c28aaSamw * Some flags for ofile structure 1317da6c28aaSamw * 1318da6c28aaSamw * SMB_OFLAGS_SET_DELETE_ON_CLOSE 1319da6c28aaSamw * Set this flag when the corresponding open operation whose 1320da6c28aaSamw * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 1321da6c28aaSamw * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 1322da6c28aaSamw * will be set for the file node upon close. 1323da6c28aaSamw */ 1324da6c28aaSamw 13255cb2894aSGordon Ross /* SMB_OFLAGS_READONLY 0x0001 (obsolete) */ 13262c2961f8Sjose borrego #define SMB_OFLAGS_EXECONLY 0x0002 1327da6c28aaSamw #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 1328da6c28aaSamw #define SMB_OFLAGS_LLF_POS_VALID 0x0008 1329da6c28aaSamw 1330*8d94f651SGordon Ross #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 13319fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_OFILE_VALID(p) \ 13329fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT((p != NULL) && ((p)->f_magic == SMB_OFILE_MAGIC)) 1333da6c28aaSamw 13346f58980aSGordon Ross /* 13356f58980aSGordon Ross * This is the size of the per-handle "Lock Sequence" array. 13366f58980aSGordon Ross * See LockSequenceIndex in [MS-SMB2] 2.2.26, and smb2_lock.c 13376f58980aSGordon Ross */ 13386f58980aSGordon Ross #define SMB_OFILE_LSEQ_MAX 64 13396f58980aSGordon Ross 1340811599a4SMatt Barden /* {arg_open,ofile}->dh_vers values */ 1341811599a4SMatt Barden typedef enum { 1342811599a4SMatt Barden SMB2_NOT_DURABLE = 0, 1343811599a4SMatt Barden SMB2_DURABLE_V1, 1344811599a4SMatt Barden SMB2_DURABLE_V2, 1345811599a4SMatt Barden SMB2_RESILIENT, 1346811599a4SMatt Barden } smb_dh_vers_t; 1347811599a4SMatt Barden 1348811599a4SMatt Barden /* 1349811599a4SMatt Barden * See the long "Ofile State Machine" comment in smb_ofile.c 1350811599a4SMatt Barden */ 1351da6c28aaSamw typedef enum { 135294047d49SGordon Ross SMB_OFILE_STATE_ALLOC = 0, 135394047d49SGordon Ross SMB_OFILE_STATE_OPEN, 1354811599a4SMatt Barden SMB_OFILE_STATE_SAVE_DH, 1355811599a4SMatt Barden SMB_OFILE_STATE_SAVING, 1356da6c28aaSamw SMB_OFILE_STATE_CLOSING, 13576537f381Sas SMB_OFILE_STATE_CLOSED, 1358811599a4SMatt Barden SMB_OFILE_STATE_ORPHANED, 1359811599a4SMatt Barden SMB_OFILE_STATE_RECONNECT, 1360811599a4SMatt Barden SMB_OFILE_STATE_EXPIRED, 13616537f381Sas SMB_OFILE_STATE_SENTINEL 1362da6c28aaSamw } smb_ofile_state_t; 1363da6c28aaSamw 1364da6c28aaSamw typedef struct smb_ofile { 1365811599a4SMatt Barden list_node_t f_tree_lnd; /* t_ofile_list */ 1366811599a4SMatt Barden list_node_t f_node_lnd; /* n_ofile_list */ 1367811599a4SMatt Barden list_node_t f_dh_lnd; /* sv_persistid_ht */ 1368da6c28aaSamw uint32_t f_magic; 1369da6c28aaSamw kmutex_t f_mutex; 1370da6c28aaSamw smb_ofile_state_t f_state; 1371da6c28aaSamw 1372faa1795aSjb struct smb_server *f_server; 1373da6c28aaSamw smb_session_t *f_session; 1374da6c28aaSamw smb_user_t *f_user; 1375da6c28aaSamw smb_tree_t *f_tree; 1376da6c28aaSamw smb_node_t *f_node; 1377a90cf9f2SGordon Ross smb_odir_t *f_odir; 13783db3f65cSamw smb_opipe_t *f_pipe; 1379da6c28aaSamw 1380811599a4SMatt Barden kcondvar_t f_cv; 1381811599a4SMatt Barden /* 1382811599a4SMatt Barden * Note: f_persistid == 0 means this ofile has no persistid 1383811599a4SMatt Barden * (same interpretation at the protocol level). IFF non-zero, 1384811599a4SMatt Barden * this ofile is linked in the sv_persistid_ht hash table. 1385811599a4SMatt Barden */ 1386811599a4SMatt Barden uint64_t f_persistid; 1387dc20a302Sas uint32_t f_uniqid; 1388da6c28aaSamw uint32_t f_refcnt; 1389da6c28aaSamw uint64_t f_seek_pos; 1390da6c28aaSamw uint32_t f_flags; 1391da6c28aaSamw uint32_t f_granted_access; 1392da6c28aaSamw uint32_t f_share_access; 1393da6c28aaSamw uint32_t f_create_options; 1394a90cf9f2SGordon Ross uint32_t f_opened_by_pid; 1395da6c28aaSamw uint16_t f_fid; 1396da6c28aaSamw uint16_t f_ftype; 1397da6c28aaSamw uint64_t f_llf_pos; 13988c10a865Sas int f_mode; 1399da6c28aaSamw cred_t *f_cr; 14006537f381Sas pid_t f_pid; 14015fd03bc0SGordon Ross smb_attr_t f_pending_attr; 14025fd03bc0SGordon Ross boolean_t f_written; 140394047d49SGordon Ross smb_oplock_grant_t f_oplock; 140494047d49SGordon Ross uint8_t TargetOplockKey[SMB_LEASE_KEY_SZ]; 140594047d49SGordon Ross uint8_t ParentOplockKey[SMB_LEASE_KEY_SZ]; 140694047d49SGordon Ross struct smb_lease *f_lease; 140794047d49SGordon Ross 1408bfe5e737SGordon Ross smb_notify_t f_notify; 1409811599a4SMatt Barden 1410811599a4SMatt Barden smb_dh_vers_t dh_vers; 1411811599a4SMatt Barden hrtime_t dh_timeout_offset; /* time offset for timeout */ 1412811599a4SMatt Barden hrtime_t dh_expire_time; /* time the handle expires */ 1413811599a4SMatt Barden boolean_t dh_persist; 1414*8d94f651SGordon Ross kmutex_t dh_nvlock; 1415*8d94f651SGordon Ross struct nvlist *dh_nvlist; 1416*8d94f651SGordon Ross smb_node_t *dh_nvfile; 1417*8d94f651SGordon Ross 1418811599a4SMatt Barden uint8_t dh_create_guid[16]; 14196f58980aSGordon Ross char f_quota_resume[SMB_SID_STRSZ]; 14206f58980aSGordon Ross uint8_t f_lock_seq[SMB_OFILE_LSEQ_MAX]; 1421da6c28aaSamw } smb_ofile_t; 1422da6c28aaSamw 14237f667e74Sjose borrego typedef struct smb_fileinfo { 14247f667e74Sjose borrego char fi_name[MAXNAMELEN]; 14257f667e74Sjose borrego char fi_shortname[SMB_SHORTNAMELEN]; 1426bfbce3c1SGordon Ross uint32_t fi_cookie; /* Dir offset (of next entry) */ 14277f667e74Sjose borrego uint32_t fi_dosattr; /* DOS attributes */ 14287f667e74Sjose borrego uint64_t fi_nodeid; /* file system node id */ 14297f667e74Sjose borrego uint64_t fi_size; /* file size in bytes */ 14307f667e74Sjose borrego uint64_t fi_alloc_size; /* allocation size in bytes */ 14317f667e74Sjose borrego timestruc_t fi_atime; /* last access */ 14327f667e74Sjose borrego timestruc_t fi_mtime; /* last modification */ 14337f667e74Sjose borrego timestruc_t fi_ctime; /* last status change */ 14347f667e74Sjose borrego timestruc_t fi_crtime; /* file creation */ 14357f667e74Sjose borrego } smb_fileinfo_t; 14367f667e74Sjose borrego 14377f667e74Sjose borrego typedef struct smb_streaminfo { 14387f667e74Sjose borrego uint64_t si_size; 1439037cac00Sjoyce mcintosh uint64_t si_alloc_size; 14407f667e74Sjose borrego char si_name[MAXPATHLEN]; 14417f667e74Sjose borrego } smb_streaminfo_t; 1442da6c28aaSamw 1443*8d94f651SGordon Ross #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1444da6c28aaSamw 1445da6c28aaSamw typedef struct smb_lock { 1446a90cf9f2SGordon Ross list_node_t l_lnd; 1447da6c28aaSamw uint32_t l_magic; 1448da6c28aaSamw kmutex_t l_mutex; 1449da6c28aaSamw kcondvar_t l_cv; 1450da6c28aaSamw 1451da6c28aaSamw smb_ofile_t *l_file; 1452da6c28aaSamw 1453da6c28aaSamw struct smb_lock *l_blocked_by; /* Debug info only */ 1454da6c28aaSamw 14550897f7fbSGordon Ross uint32_t l_conflicts; 14560897f7fbSGordon Ross uint32_t l_flags; 1457a90cf9f2SGordon Ross uint32_t l_pid; 1458da6c28aaSamw uint32_t l_type; 1459da6c28aaSamw uint64_t l_start; 1460da6c28aaSamw uint64_t l_length; 1461da6c28aaSamw clock_t l_end_time; 1462da6c28aaSamw } smb_lock_t; 1463da6c28aaSamw 1464da6c28aaSamw #define SMB_LOCK_FLAG_INDEFINITE 0x0004 14650897f7fbSGordon Ross #define SMB_LOCK_FLAG_CLOSED 0x0008 14660897f7fbSGordon Ross #define SMB_LOCK_FLAG_CANCELLED 0x0010 1467da6c28aaSamw 1468da6c28aaSamw #define SMB_LOCK_TYPE_READWRITE 101 1469da6c28aaSamw #define SMB_LOCK_TYPE_READONLY 102 1470da6c28aaSamw 1471faa1795aSjb typedef struct vardata_block { 14722c2961f8Sjose borrego uint8_t vdb_tag; 14732c2961f8Sjose borrego uint32_t vdb_len; 1474*8d94f651SGordon Ross struct uio vdb_uio; 14752c2961f8Sjose borrego struct iovec vdb_iovec[MAX_IOVEC]; 1476faa1795aSjb } smb_vdb_t; 1477faa1795aSjb 1478f96bd5c8SAlan Wright #define SMB_WRMODE_WRITE_THRU 0x0001 1479f96bd5c8SAlan Wright #define SMB_WRMODE_IS_STABLE(M) ((M) & SMB_WRMODE_WRITE_THRU) 1480f96bd5c8SAlan Wright 1481faa1795aSjb #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1482faa1795aSjb 1483faa1795aSjb typedef struct smb_rw_param { 1484faa1795aSjb uint32_t rw_magic; 1485faa1795aSjb smb_vdb_t rw_vdb; 1486faa1795aSjb uint64_t rw_offset; 1487faa1795aSjb uint32_t rw_last_write; 1488faa1795aSjb uint16_t rw_mode; 1489f96bd5c8SAlan Wright uint32_t rw_count; /* bytes in this request */ 1490faa1795aSjb uint16_t rw_mincnt; 1491f96bd5c8SAlan Wright uint32_t rw_total; /* total bytes (write-raw) */ 1492faa1795aSjb uint16_t rw_dsoff; /* SMB data offset */ 1493faa1795aSjb uint8_t rw_andx; /* SMB secondary andx command */ 1494faa1795aSjb } smb_rw_param_t; 1495da6c28aaSamw 1496eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_pathname { 1497eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char *pn_path; 1498eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char *pn_pname; 1499eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char *pn_fname; 1500eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char *pn_sname; 1501eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char *pn_stype; 1502eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States } smb_pathname_t; 1503eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States 1504b89a8333Snatalie li - Sun Microsystems - Irvine United States /* 1505b89a8333Snatalie li - Sun Microsystems - Irvine United States * fs_query_info 1506b89a8333Snatalie li - Sun Microsystems - Irvine United States */ 1507b89a8333Snatalie li - Sun Microsystems - Irvine United States typedef struct smb_fqi { 1508eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States smb_pathname_t fq_path; 1509eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States uint16_t fq_sattr; 1510eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States smb_node_t *fq_dnode; 1511eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States smb_node_t *fq_fnode; 1512eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States smb_attr_t fq_fattr; 1513eb1d736bSafshin salek ardakani - Sun Microsystems - Irvine United States char fq_last_comp[MAXNAMELEN]; 1514b89a8333Snatalie li - Sun Microsystems - Irvine United States } smb_fqi_t; 1515da6c28aaSamw 1516148c5f43SAlan Wright typedef struct dirop { 1517148c5f43SAlan Wright smb_fqi_t fqi; 1518148c5f43SAlan Wright smb_fqi_t dst_fqi; 1519148c5f43SAlan Wright uint16_t info_level; 1520148c5f43SAlan Wright uint16_t flags; 1521148c5f43SAlan Wright } smb_arg_dirop_t; 1522148c5f43SAlan Wright 1523a90cf9f2SGordon Ross typedef struct smb_queryinfo { 1524a90cf9f2SGordon Ross smb_node_t *qi_node; /* NULL for pipes */ 1525a90cf9f2SGordon Ross uint8_t qi_InfoType; 1526a90cf9f2SGordon Ross uint8_t qi_InfoClass; 1527a90cf9f2SGordon Ross uint8_t qi_delete_on_close; 1528a90cf9f2SGordon Ross uint8_t qi_isdir; 1529a90cf9f2SGordon Ross uint32_t qi_AddlInfo; 1530a90cf9f2SGordon Ross uint32_t qi_Flags; 1531a90cf9f2SGordon Ross mbuf_chain_t in_data; 1532a90cf9f2SGordon Ross smb_attr_t qi_attr; 1533a90cf9f2SGordon Ross uint32_t qi_namelen; 1534a90cf9f2SGordon Ross char qi_shortname[SMB_SHORTNAMELEN]; 1535a90cf9f2SGordon Ross char qi_name[MAXPATHLEN]; 1536a90cf9f2SGordon Ross } smb_queryinfo_t; 1537a90cf9f2SGordon Ross 1538a90cf9f2SGordon Ross typedef struct smb_setinfo { 1539a90cf9f2SGordon Ross smb_node_t *si_node; 1540a90cf9f2SGordon Ross mbuf_chain_t si_data; 1541a90cf9f2SGordon Ross smb_attr_t si_attr; 1542a90cf9f2SGordon Ross } smb_setinfo_t; 1543a90cf9f2SGordon Ross 1544a90cf9f2SGordon Ross /* 1545a90cf9f2SGordon Ross * smb_fssize_t 1546a90cf9f2SGordon Ross * volume_units and volume avail are the total allocated and 1547a90cf9f2SGordon Ross * available units on the volume. 1548a90cf9f2SGordon Ross * caller_units and caller_avail are the allocated and available 1549a90cf9f2SGordon Ross * units on the volume for the user associated with the calling 1550a90cf9f2SGordon Ross * thread. 1551a90cf9f2SGordon Ross */ 1552a90cf9f2SGordon Ross typedef struct smb_fssize { 1553a90cf9f2SGordon Ross uint64_t fs_volume_units; 1554a90cf9f2SGordon Ross uint64_t fs_volume_avail; 1555a90cf9f2SGordon Ross uint64_t fs_caller_units; 1556a90cf9f2SGordon Ross uint64_t fs_caller_avail; 1557a90cf9f2SGordon Ross uint32_t fs_sectors_per_unit; 1558a90cf9f2SGordon Ross uint32_t fs_bytes_per_sector; 1559a90cf9f2SGordon Ross } smb_fssize_t; 1560a90cf9f2SGordon Ross 1561a90cf9f2SGordon Ross /* 1562a90cf9f2SGordon Ross * SMB FsCtl operations (SMB2 Ioctl, and some SMB1 trans calls) 1563a90cf9f2SGordon Ross */ 1564a90cf9f2SGordon Ross typedef struct { 1565a90cf9f2SGordon Ross uint32_t CtlCode; 1566a90cf9f2SGordon Ross uint32_t InputCount; 1567a90cf9f2SGordon Ross uint32_t OutputCount; 1568a90cf9f2SGordon Ross uint32_t MaxOutputResp; 1569a90cf9f2SGordon Ross mbuf_chain_t *in_mbc; 1570a90cf9f2SGordon Ross mbuf_chain_t *out_mbc; 1571a90cf9f2SGordon Ross } smb_fsctl_t; 1572a90cf9f2SGordon Ross 1573a90cf9f2SGordon Ross typedef struct { 1574a90cf9f2SGordon Ross uint64_t persistent; 1575a90cf9f2SGordon Ross uint64_t temporal; 1576a90cf9f2SGordon Ross } smb2fid_t; 1577a90cf9f2SGordon Ross 15787b59d02dSjb typedef struct { 15797b59d02dSjb uint32_t status; 15807b59d02dSjb uint16_t errcls; 15817b59d02dSjb uint16_t errcode; 15827b59d02dSjb } smb_error_t; 1583da6c28aaSamw 15842c2961f8Sjose borrego typedef struct open_param { 15852c2961f8Sjose borrego smb_fqi_t fqi; 15862c2961f8Sjose borrego uint16_t omode; 15872c2961f8Sjose borrego uint16_t ofun; 15882c2961f8Sjose borrego uint32_t nt_flags; 15892c2961f8Sjose borrego uint32_t timeo; 15902c2961f8Sjose borrego uint32_t dattr; 15912c2961f8Sjose borrego timestruc_t crtime; 15922c2961f8Sjose borrego timestruc_t mtime; 1593a90cf9f2SGordon Ross timestruc_t timewarp; 1594a90cf9f2SGordon Ross /* 1595a90cf9f2SGordon Ross * Careful: dsize is the desired (allocation) size before the 1596a90cf9f2SGordon Ross * common open function, and the actual size afterwards. 1597a90cf9f2SGordon Ross */ 1598a90cf9f2SGordon Ross uint64_t dsize; /* alloc size, actual size */ 15992c2961f8Sjose borrego uint32_t desired_access; 160093bc28dbSGordon Ross uint32_t maximum_access; 16012c2961f8Sjose borrego uint32_t share_access; 16022c2961f8Sjose borrego uint32_t create_options; 16032c2961f8Sjose borrego uint32_t create_disposition; 1604a90cf9f2SGordon Ross boolean_t create_timewarp; 16052c2961f8Sjose borrego boolean_t created_readonly; 16062c2961f8Sjose borrego uint32_t ftype; 16072c2961f8Sjose borrego uint32_t devstate; 16082c2961f8Sjose borrego uint32_t action_taken; 16092c2961f8Sjose borrego uint64_t fileid; 16102c2961f8Sjose borrego uint32_t rootdirfid; 161193bc28dbSGordon Ross fsid_t op_fsid; 1612bbf6f00cSJordan Brown smb_ofile_t *dir; 161368b2bbf2SGordon Ross smb_opipe_t *pipe; /* for smb_opipe_open */ 161468b2bbf2SGordon Ross struct smb_sd *sd; /* for NTTransactCreate */ 161593bc28dbSGordon Ross void *create_ctx; 161694047d49SGordon Ross 1617cb174861Sjoyce mcintosh uint8_t op_oplock_level; /* requested/granted level */ 161894047d49SGordon Ross uint32_t op_oplock_state; /* internal type+level */ 161994047d49SGordon Ross uint32_t lease_state; /* SMB2_LEASE_... */ 162094047d49SGordon Ross uint32_t lease_flags; 162194047d49SGordon Ross uint16_t lease_epoch; 162294047d49SGordon Ross uint16_t lease_version; /* 1 or 2 */ 162394047d49SGordon Ross uint8_t lease_key[SMB_LEASE_KEY_SZ]; /* from client */ 162494047d49SGordon Ross uint8_t parent_lease_key[SMB_LEASE_KEY_SZ]; /* for V2 */ 162594047d49SGordon Ross 1626811599a4SMatt Barden smb_dh_vers_t dh_vers; 1627811599a4SMatt Barden smb2fid_t dh_fileid; /* for durable reconnect */ 1628811599a4SMatt Barden uint8_t create_guid[16]; 1629811599a4SMatt Barden uint32_t dh_v2_flags; 1630811599a4SMatt Barden uint32_t dh_timeout; 1631148c5f43SAlan Wright } smb_arg_open_t; 16322c2961f8Sjose borrego 16330897f7fbSGordon Ross typedef struct smb_arg_lock { 16340897f7fbSGordon Ross void *lvec; 16350897f7fbSGordon Ross uint32_t lcnt; 16360897f7fbSGordon Ross uint32_t lseq; 16370897f7fbSGordon Ross } smb_arg_lock_t; 16380897f7fbSGordon Ross 163994047d49SGordon Ross typedef struct smb_arg_olbrk { 164094047d49SGordon Ross uint32_t NewLevel; 164194047d49SGordon Ross boolean_t AckRequired; 164294047d49SGordon Ross } smb_arg_olbrk_t; 164394047d49SGordon Ross 1644da6c28aaSamw /* 1645da6c28aaSamw * SMB Request State Machine 1646da6c28aaSamw * ------------------------- 1647da6c28aaSamw * 1648da6c28aaSamw * T4 +------+ T0 1649da6c28aaSamw * +--------------------------->| FREE |---------------------------+ 1650da6c28aaSamw * | +------+ | 1651da6c28aaSamw * +-----------+ | 1652da6c28aaSamw * | COMPLETED | | 1653da6c28aaSamw * +-----------+ 1654da6c28aaSamw * ^ | 16555677e049SGordon Ross * | T15 +-----------+ v 16565677e049SGordon Ross * +------------+ T6 | | +--------------+ 16575677e049SGordon Ross * | CLEANED_UP |<-----------------| CANCELLED | | INITIALIZING | 16585677e049SGordon Ross * +------------+ | | +--------------+ 16595677e049SGordon Ross * | ^ +-----------+ | 1660da6c28aaSamw * | | ^ ^ ^ ^ | 1661da6c28aaSamw * | | +-------------+ | | | | 1662da6c28aaSamw * | | T3 | | | | T13 | T1 1663da6c28aaSamw * | +-------------------------+ | | +----------------------+ | 1664da6c28aaSamw * +----------------------------+ | | | | | 1665da6c28aaSamw * T16 | | | | +-----------+ | | 1666da6c28aaSamw * | \/ | | T5 | | v 1667da6c28aaSamw * +-----------------+ | T12 +--------+ | T2 +-----------+ 1668da6c28aaSamw * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1669da6c28aaSamw * +-----------------+ | +--------+ | +-----------+ 1670da6c28aaSamw * ^ | | ^ | | 1671da6c28aaSamw * | | T8 | | | T7 | 1672da6c28aaSamw * | T10 T9 | +----------+ | +-------+ | T11 1673da6c28aaSamw * | | | +-------+ | | 1674da6c28aaSamw * | | | T14 | | | 1675da6c28aaSamw * | | v | v | 1676da6c28aaSamw * +----------------------+ +--------------+ 1677da6c28aaSamw * | WAITING_EVENT | | WAITING_LOCK | 1678da6c28aaSamw * +----------------------+ +--------------+ 1679da6c28aaSamw * 1680da6c28aaSamw * 1681da6c28aaSamw * 1682da6c28aaSamw * 1683da6c28aaSamw * 1684da6c28aaSamw * Transition T0 1685da6c28aaSamw * 1686da6c28aaSamw * This transition occurs when the request is allocated and is still under the 1687da6c28aaSamw * control of the session thread. 1688da6c28aaSamw * 1689da6c28aaSamw * Transition T1 1690da6c28aaSamw * 1691da6c28aaSamw * This transition occurs when the session thread dispatches a task to treat the 1692da6c28aaSamw * request. 1693da6c28aaSamw * 1694da6c28aaSamw * Transition T2 1695da6c28aaSamw * 1696da6c28aaSamw * 1697da6c28aaSamw * 1698da6c28aaSamw * Transition T3 1699da6c28aaSamw * 1700da6c28aaSamw * A request completes and smbsr_cleanup is called to release resources 1701da6c28aaSamw * associated with the request (but not the smb_request_t itself). This 1702da6c28aaSamw * includes references on smb_ofile_t, smb_node_t, and other structures. 1703da6c28aaSamw * CLEANED_UP state exists to detect if we attempt to cleanup a request 1704da6c28aaSamw * multiple times and to allow us to detect that we are accessing a 1705da6c28aaSamw * request that has already been cleaned up. 1706da6c28aaSamw * 1707da6c28aaSamw * Transition T4 1708da6c28aaSamw * 1709da6c28aaSamw * 1710da6c28aaSamw * 1711da6c28aaSamw * Transition T5 1712da6c28aaSamw * 1713da6c28aaSamw * 1714da6c28aaSamw * 1715da6c28aaSamw * Transition T6 1716da6c28aaSamw * 1717da6c28aaSamw * 1718da6c28aaSamw * 1719da6c28aaSamw * Transition T7 1720da6c28aaSamw * 1721da6c28aaSamw * 1722da6c28aaSamw * 1723da6c28aaSamw * Transition T8 1724da6c28aaSamw * 1725da6c28aaSamw * 1726da6c28aaSamw * 1727da6c28aaSamw * Transition T9 1728da6c28aaSamw * 1729da6c28aaSamw * 1730da6c28aaSamw * 1731da6c28aaSamw * Transition T10 1732da6c28aaSamw * 1733da6c28aaSamw * 1734da6c28aaSamw * 1735da6c28aaSamw * Transition T11 1736da6c28aaSamw * 1737da6c28aaSamw * 1738da6c28aaSamw * 1739da6c28aaSamw * Transition T12 1740da6c28aaSamw * 1741da6c28aaSamw * 1742da6c28aaSamw * 1743da6c28aaSamw * Transition T13 1744da6c28aaSamw * 1745da6c28aaSamw * 1746da6c28aaSamw * 1747da6c28aaSamw * Transition T14 1748da6c28aaSamw * 1749da6c28aaSamw * 1750da6c28aaSamw * 1751da6c28aaSamw * Transition T15 1752da6c28aaSamw * 1753da6c28aaSamw * Request processing is completed (control returns from smb_dispatch) 1754da6c28aaSamw * 1755da6c28aaSamw * Transition T16 1756da6c28aaSamw * 1757da6c28aaSamw * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1758da6c28aaSamw * sections remain to be processed. 1759da6c28aaSamw * 1760da6c28aaSamw */ 1761da6c28aaSamw 1762*8d94f651SGordon Ross #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 17632c2961f8Sjose borrego #define SMB_REQ_VALID(p) ASSERT((p)->sr_magic == SMB_REQ_MAGIC) 1764da6c28aaSamw 1765da6c28aaSamw typedef enum smb_req_state { 1766da6c28aaSamw SMB_REQ_STATE_FREE = 0, 1767da6c28aaSamw SMB_REQ_STATE_INITIALIZING, 1768da6c28aaSamw SMB_REQ_STATE_SUBMITTED, 1769da6c28aaSamw SMB_REQ_STATE_ACTIVE, 1770b210fedeSGordon Ross SMB_REQ_STATE_WAITING_AUTH, 1771bfe5e737SGordon Ross SMB_REQ_STATE_WAITING_FCN1, 1772bfe5e737SGordon Ross SMB_REQ_STATE_WAITING_FCN2, 1773bfe5e737SGordon Ross SMB_REQ_STATE_WAITING_LOCK, 1774b210fedeSGordon Ross SMB_REQ_STATE_WAITING_PIPE, 1775da6c28aaSamw SMB_REQ_STATE_COMPLETED, 17765677e049SGordon Ross SMB_REQ_STATE_CANCEL_PENDING, 17775677e049SGordon Ross SMB_REQ_STATE_CANCELLED, 17786537f381Sas SMB_REQ_STATE_CLEANED_UP, 17796537f381Sas SMB_REQ_STATE_SENTINEL 1780da6c28aaSamw } smb_req_state_t; 1781da6c28aaSamw 1782faa1795aSjb typedef struct smb_request { 1783a90cf9f2SGordon Ross list_node_t sr_session_lnd; 1784da6c28aaSamw uint32_t sr_magic; 1785da6c28aaSamw kmutex_t sr_mutex; 1786da6c28aaSamw smb_req_state_t sr_state; 1787faa1795aSjb struct smb_server *sr_server; 17886537f381Sas pid_t *sr_pid; 1789c8ec8eeaSjose borrego int32_t sr_gmtoff; 1790faa1795aSjb smb_session_t *session; 1791faa1795aSjb smb_kmod_cfg_t *sr_cfg; 17925677e049SGordon Ross void (*cancel_method)(struct smb_request *); 17935677e049SGordon Ross void *cancel_arg2; 1794a90cf9f2SGordon Ross 179594047d49SGordon Ross /* Queue used by smb_request_append_postwork. */ 179694047d49SGordon Ross struct smb_request *sr_postwork; 179794047d49SGordon Ross 1798bfe5e737SGordon Ross list_node_t sr_waiters; /* smb_notify.c */ 1799da6c28aaSamw 1800da6c28aaSamw /* Info from session service header */ 1801da6c28aaSamw uint32_t sr_req_length; /* Excluding NBT header */ 1802da6c28aaSamw 1803da6c28aaSamw /* Request buffer excluding NBT header */ 1804da6c28aaSamw void *sr_request_buf; 1805da6c28aaSamw 1806da6c28aaSamw struct mbuf_chain command; 1807da6c28aaSamw struct mbuf_chain reply; 1808da6c28aaSamw struct mbuf_chain raw_data; 1809bbf6f00cSJordan Brown list_t sr_storage; 1810da6c28aaSamw struct smb_xa *r_xa; 1811da6c28aaSamw int andx_prev_wct; 1812*8d94f651SGordon Ross int cur_reply_offset; 1813da6c28aaSamw int orig_request_hdr; 1814da6c28aaSamw unsigned int reply_seqnum; /* reply sequence number */ 1815da6c28aaSamw unsigned char first_smb_com; /* command code */ 1816da6c28aaSamw unsigned char smb_com; /* command code */ 18177b59d02dSjb 18187b59d02dSjb uint8_t smb_rcls; /* error code class */ 18197b59d02dSjb uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1820da6c28aaSamw uint16_t smb_err; /* error code */ 18217b59d02dSjb smb_error_t smb_error; 18227b59d02dSjb 1823da6c28aaSamw uint8_t smb_flg; /* flags */ 1824da6c28aaSamw uint16_t smb_flg2; /* flags */ 1825da6c28aaSamw unsigned char smb_sig[8]; /* signiture */ 1826da6c28aaSamw uint16_t smb_tid; /* tree id # */ 1827a90cf9f2SGordon Ross uint32_t smb_pid; /* caller's process id # */ 1828811599a4SMatt Barden uint16_t smb_uid; /* local (smb1) user id # */ 1829da6c28aaSamw uint16_t smb_mid; /* mutiplex id # */ 1830da6c28aaSamw unsigned char smb_wct; /* count of parameter words */ 1831da6c28aaSamw uint16_t smb_bcc; /* data byte count */ 1832da6c28aaSamw 1833a90cf9f2SGordon Ross /* 1834a90cf9f2SGordon Ross * Beginning offsets (in the mbuf chain) for the 1835a90cf9f2SGordon Ross * command and reply headers, and the next reply. 1836a90cf9f2SGordon Ross */ 1837a90cf9f2SGordon Ross uint32_t smb2_cmd_hdr; 1838a90cf9f2SGordon Ross uint32_t smb2_reply_hdr; 1839a90cf9f2SGordon Ross uint32_t smb2_next_reply; 1840a90cf9f2SGordon Ross 1841a90cf9f2SGordon Ross /* 1842a90cf9f2SGordon Ross * SMB2 header fields. [MS-SMB2 2.2.1.2] 1843a90cf9f2SGordon Ross * XXX: Later do a union w smb1 members 1844a90cf9f2SGordon Ross */ 1845a90cf9f2SGordon Ross uint16_t smb2_credit_charge; 1846a90cf9f2SGordon Ross uint16_t smb2_chan_seq; /* cmd only */ 1847a90cf9f2SGordon Ross uint32_t smb2_status; 1848a90cf9f2SGordon Ross uint16_t smb2_cmd_code; 1849a90cf9f2SGordon Ross uint16_t smb2_credit_request; 1850a90cf9f2SGordon Ross uint16_t smb2_credit_response; 18515677e049SGordon Ross uint16_t smb2_total_credits; /* in compound */ 1852a90cf9f2SGordon Ross uint32_t smb2_hdr_flags; 1853a90cf9f2SGordon Ross uint32_t smb2_next_command; 1854a90cf9f2SGordon Ross uint64_t smb2_messageid; 18555677e049SGordon Ross uint64_t smb2_first_msgid; 1856a90cf9f2SGordon Ross /* uint32_t smb2_pid; use smb_pid */ 1857a90cf9f2SGordon Ross /* uint32_t smb2_tid; use smb_tid */ 1858811599a4SMatt Barden uint64_t smb2_ssnid; /* See u_ssnid */ 1859811599a4SMatt Barden uint8_t smb2_sig[16]; /* signature */ 1860a90cf9f2SGordon Ross 18611160dcf7SMatt Barden /* 18621160dcf7SMatt Barden * SMB3 transform header fields. [MS-SMB2 2.2.41] 18631160dcf7SMatt Barden */ 18641160dcf7SMatt Barden uint64_t smb3_tform_ssnid; 18651160dcf7SMatt Barden smb_user_t *tform_ssn; 18661160dcf7SMatt Barden uint32_t msgsize; 18671160dcf7SMatt Barden uint8_t nonce[16]; 18681160dcf7SMatt Barden 18691160dcf7SMatt Barden boolean_t encrypted; 1870*8d94f651SGordon Ross boolean_t dh_nvl_dirty; 18711160dcf7SMatt Barden 1872148d1a41SMatt Barden boolean_t smb2_async; 1873a90cf9f2SGordon Ross uint64_t smb2_async_id; 1874da6c28aaSamw /* Parameters */ 1875da6c28aaSamw struct mbuf_chain smb_vwv; /* variable width value */ 1876da6c28aaSamw 1877da6c28aaSamw /* Data */ 1878da6c28aaSamw struct mbuf_chain smb_data; 1879da6c28aaSamw 1880da6c28aaSamw uint16_t smb_fid; /* not in hdr, but common */ 1881da6c28aaSamw 1882da6c28aaSamw unsigned char andx_com; 1883da6c28aaSamw uint16_t andx_off; 1884da6c28aaSamw 1885da6c28aaSamw struct smb_tree *tid_tree; 1886da6c28aaSamw struct smb_ofile *fid_ofile; 1887da6c28aaSamw smb_user_t *uid_user; 1888da6c28aaSamw 188968b2bbf2SGordon Ross cred_t *user_cr; 189068b2bbf2SGordon Ross kthread_t *sr_worker; 189168b2bbf2SGordon Ross hrtime_t sr_time_submitted; 189268b2bbf2SGordon Ross hrtime_t sr_time_active; 189368b2bbf2SGordon Ross hrtime_t sr_time_start; 189468b2bbf2SGordon Ross int32_t sr_txb; 189568b2bbf2SGordon Ross uint32_t sr_seqnum; 189668b2bbf2SGordon Ross 1897da6c28aaSamw union { 1898148c5f43SAlan Wright smb_arg_negotiate_t *negprot; 1899148c5f43SAlan Wright smb_arg_sessionsetup_t *ssetup; 1900148c5f43SAlan Wright smb_arg_tcon_t tcon; 1901148c5f43SAlan Wright smb_arg_dirop_t dirop; 1902148c5f43SAlan Wright smb_arg_open_t open; 19030897f7fbSGordon Ross smb_arg_lock_t lock; 190494047d49SGordon Ross smb_arg_olbrk_t olbrk; /* for async oplock break */ 1905148c5f43SAlan Wright smb_rw_param_t *rw; 19065fd03bc0SGordon Ross int32_t timestamp; 190755f0a249SGordon Ross void *other; 1908da6c28aaSamw } arg; 1909faa1795aSjb } smb_request_t; 1910da6c28aaSamw 1911148c5f43SAlan Wright #define sr_ssetup arg.ssetup 1912148c5f43SAlan Wright #define sr_negprot arg.negprot 1913148c5f43SAlan Wright #define sr_tcon arg.tcon 1914148c5f43SAlan Wright #define sr_dirop arg.dirop 1915148c5f43SAlan Wright #define sr_open arg.open 1916148c5f43SAlan Wright #define sr_rw arg.rw 1917148c5f43SAlan Wright #define sr_timestamp arg.timestamp 1918148c5f43SAlan Wright 1919bbf6f00cSJordan Brown #define SMB_READ_PROTOCOL(hdr) \ 1920bbf6f00cSJordan Brown LE_IN32(((smb_hdr_t *)(hdr))->protocol) 1921da6c28aaSamw 1922da6c28aaSamw #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1923da6c28aaSamw (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1924da6c28aaSamw 1925bbf6f00cSJordan Brown #define SMB_READ_COMMAND(hdr) \ 1926bbf6f00cSJordan Brown (((smb_hdr_t *)(hdr))->command) 1927da6c28aaSamw 1928148c5f43SAlan Wright #define SMB_IS_NT_CANCEL(rd_sr) \ 1929148c5f43SAlan Wright (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NT_CANCEL) 1930148c5f43SAlan Wright 1931148c5f43SAlan Wright #define SMB_IS_SESSION_SETUP_ANDX(rd_sr) \ 1932148c5f43SAlan Wright (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == \ 1933148c5f43SAlan Wright SMB_COM_SESSION_SETUP_ANDX) 1934148c5f43SAlan Wright 1935148c5f43SAlan Wright #define SMB_IS_NT_NEGOTIATE(rd_sr) \ 1936148c5f43SAlan Wright (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_NEGOTIATE) 1937148c5f43SAlan Wright 1938148c5f43SAlan Wright #define SMB_IS_TREE_CONNECT_ANDX(rd_sr) \ 1939148c5f43SAlan Wright (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_TREE_CONNECT_ANDX) 1940da6c28aaSamw 1941da6c28aaSamw #define SMB_XA_FLAG_OPEN 0x0001 1942da6c28aaSamw #define SMB_XA_FLAG_CLOSE 0x0002 1943da6c28aaSamw #define SMB_XA_FLAG_COMPLETE 0x0004 1944da6c28aaSamw #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1945da6c28aaSamw 1946da6c28aaSamw #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1947da6c28aaSamw 1948da6c28aaSamw typedef struct smb_xa { 1949a90cf9f2SGordon Ross list_node_t xa_lnd; 1950da6c28aaSamw uint32_t xa_magic; 1951da6c28aaSamw kmutex_t xa_mutex; 1952da6c28aaSamw 1953da6c28aaSamw uint32_t xa_refcnt; 1954da6c28aaSamw uint32_t xa_flags; 1955da6c28aaSamw 1956da6c28aaSamw struct smb_session *xa_session; 1957da6c28aaSamw 1958da6c28aaSamw unsigned char smb_com; /* which TRANS type */ 1959da6c28aaSamw unsigned char smb_flg; /* flags */ 1960da6c28aaSamw uint16_t smb_flg2; /* flags */ 1961da6c28aaSamw uint16_t smb_tid; /* tree id number */ 1962a90cf9f2SGordon Ross uint32_t smb_pid; /* caller's process id */ 1963da6c28aaSamw uint16_t smb_uid; /* user id number */ 1964da6c28aaSamw uint32_t smb_func; /* NT_TRANS function */ 1965da6c28aaSamw 1966da6c28aaSamw uint16_t xa_smb_mid; /* mutiplex id number */ 1967da6c28aaSamw uint16_t xa_smb_fid; /* TRANS2 secondary */ 1968da6c28aaSamw 1969da6c28aaSamw unsigned int reply_seqnum; /* reply sequence number */ 1970da6c28aaSamw 1971da6c28aaSamw uint32_t smb_tpscnt; /* total parameter bytes being sent */ 1972da6c28aaSamw uint32_t smb_tdscnt; /* total data bytes being sent */ 1973da6c28aaSamw uint32_t smb_mprcnt; /* max parameter bytes to return */ 1974da6c28aaSamw uint32_t smb_mdrcnt; /* max data bytes to return */ 1975da6c28aaSamw uint32_t smb_msrcnt; /* max setup words to return */ 1976da6c28aaSamw uint32_t smb_flags; /* additional information: */ 1977da6c28aaSamw /* bit 0 - if set, disconnect TID in smb_tid */ 1978da6c28aaSamw /* bit 1 - if set, transaction is one way */ 1979da6c28aaSamw /* (no final response) */ 1980da6c28aaSamw int32_t smb_timeout; /* number of milliseconds to await completion */ 1981da6c28aaSamw uint32_t smb_suwcnt; /* set up word count */ 1982da6c28aaSamw 1983bbf6f00cSJordan Brown char *xa_pipe_name; 1984da6c28aaSamw 19857f3ef643SGordon Ross /* 19867f3ef643SGordon Ross * These are the param and data count received so far, 19877f3ef643SGordon Ross * used to decide if the whole trans is here yet. 19887f3ef643SGordon Ross */ 1989da6c28aaSamw int req_disp_param; 1990da6c28aaSamw int req_disp_data; 1991da6c28aaSamw 1992da6c28aaSamw struct mbuf_chain req_setup_mb; 1993da6c28aaSamw struct mbuf_chain req_param_mb; 1994da6c28aaSamw struct mbuf_chain req_data_mb; 1995da6c28aaSamw 1996da6c28aaSamw struct mbuf_chain rep_setup_mb; 1997da6c28aaSamw struct mbuf_chain rep_param_mb; 1998da6c28aaSamw struct mbuf_chain rep_data_mb; 1999da6c28aaSamw } smb_xa_t; 2000da6c28aaSamw 2001da6c28aaSamw 2002da6c28aaSamw #define SDDF_NO_FLAGS 0 2003da6c28aaSamw #define SDDF_SUPPRESS_TID 0x0001 2004da6c28aaSamw #define SDDF_SUPPRESS_UID 0x0002 2005da6c28aaSamw 20067b59d02dSjb /* 20077b59d02dSjb * SMB dispatch return codes. 20087b59d02dSjb */ 20097b59d02dSjb typedef enum { 2010faa1795aSjb SDRC_SUCCESS = 0, 2011faa1795aSjb SDRC_ERROR, 20127b59d02dSjb SDRC_DROP_VC, 20137b59d02dSjb SDRC_NO_REPLY, 201459229f98Sjose borrego SDRC_SR_KEPT, 2015faa1795aSjb SDRC_NOT_IMPLEMENTED 20167b59d02dSjb } smb_sdrc_t; 2017da6c28aaSamw 2018da6c28aaSamw #define VAR_BCC ((short)-1) 2019da6c28aaSamw 2020faa1795aSjb #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 20219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_SERVER_VALID(s) \ 20229fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((s) != NULL) && ((s)->sv_magic == SMB_SERVER_MAGIC)) 2023da6c28aaSamw 20244163af6aSjose borrego #define SMB_LISTENER_MAGIC 0x4C53544E /* 'LSTN' */ 20254163af6aSjose borrego #define SMB_LISTENER_VALID(ld) \ 20264163af6aSjose borrego ASSERT(((ld) != NULL) && ((ld)->ld_magic == SMB_LISTENER_MAGIC)) 20274163af6aSjose borrego 2028faa1795aSjb typedef struct { 20294163af6aSjose borrego uint32_t ld_magic; 20304163af6aSjose borrego struct smb_server *ld_sv; 20314163af6aSjose borrego smb_thread_t ld_thread; 20320f1702c5SYu Xiangning ksocket_t ld_so; 20334163af6aSjose borrego in_port_t ld_port; 20344163af6aSjose borrego int ld_family; 2035faa1795aSjb struct sockaddr_in ld_sin; 20367f667e74Sjose borrego struct sockaddr_in6 ld_sin6; 2037faa1795aSjb } smb_listener_daemon_t; 2038faa1795aSjb 2039cb174861Sjoyce mcintosh #define SMB_SSETUP_CMD "authentication" 2040cb174861Sjoyce mcintosh #define SMB_TCON_CMD "share mapping" 2041cb174861Sjoyce mcintosh #define SMB_OPIPE_CMD "pipe open" 2042cb174861Sjoyce mcintosh #define SMB_THRESHOLD_REPORT_THROTTLE 50 2043cb174861Sjoyce mcintosh typedef struct smb_cmd_threshold { 2044cb174861Sjoyce mcintosh char *ct_cmd; 2045cb174861Sjoyce mcintosh kmutex_t ct_mutex; 2046cb174861Sjoyce mcintosh volatile uint32_t ct_active_cnt; 2047cb174861Sjoyce mcintosh volatile uint32_t ct_blocked_cnt; 2048cb174861Sjoyce mcintosh uint32_t ct_threshold; 2049856399cfSGordon Ross uint32_t ct_timeout; /* milliseconds */ 2050856399cfSGordon Ross kcondvar_t ct_cond; 2051cb174861Sjoyce mcintosh } smb_cmd_threshold_t; 2052cb174861Sjoyce mcintosh 2053cb174861Sjoyce mcintosh typedef struct { 2054cb174861Sjoyce mcintosh kstat_named_t ls_files; 2055cb174861Sjoyce mcintosh kstat_named_t ls_trees; 2056cb174861Sjoyce mcintosh kstat_named_t ls_users; 2057cb174861Sjoyce mcintosh } smb_server_legacy_kstat_t; 2058cb174861Sjoyce mcintosh 2059faa1795aSjb typedef enum smb_server_state { 2060faa1795aSjb SMB_SERVER_STATE_CREATED = 0, 2061faa1795aSjb SMB_SERVER_STATE_CONFIGURED, 2062faa1795aSjb SMB_SERVER_STATE_RUNNING, 20639fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States SMB_SERVER_STATE_STOPPING, 20646537f381Sas SMB_SERVER_STATE_DELETING, 20656537f381Sas SMB_SERVER_STATE_SENTINEL 2066faa1795aSjb } smb_server_state_t; 2067faa1795aSjb 2068cb174861Sjoyce mcintosh typedef struct { 206923a9c295SGordon Ross /* protected by sv_mutex */ 2070cb174861Sjoyce mcintosh kcondvar_t sp_cv; 2071*8d94f651SGordon Ross uint32_t sp_cnt; 2072cb174861Sjoyce mcintosh smb_llist_t sp_list; 2073cb174861Sjoyce mcintosh smb_llist_t sp_fidlist; 2074cb174861Sjoyce mcintosh } smb_spool_t; 2075cb174861Sjoyce mcintosh 2076148c5f43SAlan Wright #define SMB_SERVER_STATE_VALID(S) \ 2077148c5f43SAlan Wright ASSERT(((S) == SMB_SERVER_STATE_CREATED) || \ 2078148c5f43SAlan Wright ((S) == SMB_SERVER_STATE_CONFIGURED) || \ 2079148c5f43SAlan Wright ((S) == SMB_SERVER_STATE_RUNNING) || \ 2080148c5f43SAlan Wright ((S) == SMB_SERVER_STATE_STOPPING) || \ 2081148c5f43SAlan Wright ((S) == SMB_SERVER_STATE_DELETING)) 20829fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 2083faa1795aSjb typedef struct smb_server { 2084a90cf9f2SGordon Ross list_node_t sv_lnd; 2085faa1795aSjb uint32_t sv_magic; 2086faa1795aSjb kcondvar_t sv_cv; 2087faa1795aSjb kmutex_t sv_mutex; 2088faa1795aSjb smb_server_state_t sv_state; 2089faa1795aSjb uint32_t sv_refcnt; 20906537f381Sas pid_t sv_pid; 2091faa1795aSjb zoneid_t sv_zid; 2092faa1795aSjb smb_listener_daemon_t sv_nbt_daemon; 2093faa1795aSjb smb_listener_daemon_t sv_tcp_daemon; 2094faa1795aSjb krwlock_t sv_cfg_lock; 2095faa1795aSjb smb_kmod_cfg_t sv_cfg; 2096faa1795aSjb smb_session_t *sv_session; 2097*8d94f651SGordon Ross smb_user_t *sv_rootuser; 2098811599a4SMatt Barden smb_llist_t sv_session_list; 2099811599a4SMatt Barden smb_hash_t *sv_persistid_ht; 210094047d49SGordon Ross smb_hash_t *sv_lease_ht; 2101da6c28aaSamw 2102*8d94f651SGordon Ross smb_export_t sv_export; 2103b819cea2SGordon Ross struct __door_handle *sv_lmshrd; 2104da6c28aaSamw 21058622ec45SGordon Ross /* Internal door for up-calls to smbd */ 2106b819cea2SGordon Ross struct __door_handle *sv_kdoor_hd; 21078622ec45SGordon Ross int sv_kdoor_id; /* init -1 */ 21088622ec45SGordon Ross uint64_t sv_kdoor_ncall; 21098622ec45SGordon Ross kmutex_t sv_kdoor_mutex; 21108622ec45SGordon Ross kcondvar_t sv_kdoor_cv; 21118622ec45SGordon Ross 2112c8ec8eeaSjose borrego int32_t si_gmtoff; 2113da6c28aaSamw 2114da6c28aaSamw smb_thread_t si_thread_timers; 2115da6c28aaSamw 21164163af6aSjose borrego taskq_t *sv_worker_pool; 21174163af6aSjose borrego taskq_t *sv_receiver_pool; 2118da6c28aaSamw 2119da6c28aaSamw smb_node_t *si_root_smb_node; 21209fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States smb_llist_t sv_opipe_list; 21219fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States smb_llist_t sv_event_list; 2122148c5f43SAlan Wright 2123148c5f43SAlan Wright /* Statistics */ 2124148c5f43SAlan Wright hrtime_t sv_start_time; 2125148c5f43SAlan Wright kstat_t *sv_ksp; 2126148c5f43SAlan Wright volatile uint32_t sv_nbt_sess; 2127148c5f43SAlan Wright volatile uint32_t sv_tcp_sess; 2128148c5f43SAlan Wright volatile uint32_t sv_users; 2129148c5f43SAlan Wright volatile uint32_t sv_trees; 2130148c5f43SAlan Wright volatile uint32_t sv_files; 2131148c5f43SAlan Wright volatile uint32_t sv_pipes; 2132148c5f43SAlan Wright volatile uint64_t sv_txb; 2133148c5f43SAlan Wright volatile uint64_t sv_rxb; 2134148c5f43SAlan Wright volatile uint64_t sv_nreq; 2135148c5f43SAlan Wright smb_srqueue_t sv_srqueue; 2136cb174861Sjoyce mcintosh smb_spool_t sp_info; 2137cb174861Sjoyce mcintosh smb_cmd_threshold_t sv_ssetup_ct; 2138cb174861Sjoyce mcintosh smb_cmd_threshold_t sv_tcon_ct; 2139cb174861Sjoyce mcintosh smb_cmd_threshold_t sv_opipe_ct; 2140cb174861Sjoyce mcintosh kstat_t *sv_legacy_ksp; 2141cb174861Sjoyce mcintosh kmutex_t sv_legacy_ksmtx; 2142a90cf9f2SGordon Ross smb_disp_stats_t *sv_disp_stats1; 2143a90cf9f2SGordon Ross smb_disp_stats_t *sv_disp_stats2; 2144faa1795aSjb } smb_server_t; 2145da6c28aaSamw 21469fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_EVENT_MAGIC 0x45564E54 /* EVNT */ 2147cb174861Sjoyce mcintosh #define SMB_EVENT_TIMEOUT 45 /* seconds */ 21489fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States #define SMB_EVENT_VALID(e) \ 21499fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States ASSERT(((e) != NULL) && ((e)->se_magic == SMB_EVENT_MAGIC)) 21509fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States typedef struct smb_event { 21519fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States list_node_t se_lnd; 2152a90cf9f2SGordon Ross uint32_t se_magic; 21539fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States kmutex_t se_mutex; 21549fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States kcondvar_t se_cv; 2155cb174861Sjoyce mcintosh smb_server_t *se_server; 21569fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States uint32_t se_txid; 21579fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States boolean_t se_notified; 21589fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States int se_waittime; 2159cb174861Sjoyce mcintosh int se_timeout; 21609fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States int se_errno; 21619fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States } smb_event_t; 21629fb67ea3Safshin salek ardakani - Sun Microsystems - Irvine United States 2163cb174861Sjoyce mcintosh typedef struct smb_kspooldoc { 2164cb174861Sjoyce mcintosh list_node_t sd_lnd; 2165a90cf9f2SGordon Ross uint32_t sd_magic; 2166cb174861Sjoyce mcintosh smb_inaddr_t sd_ipaddr; 2167cb174861Sjoyce mcintosh uint32_t sd_spool_num; 2168cb174861Sjoyce mcintosh uint16_t sd_fid; 2169cb174861Sjoyce mcintosh char sd_username[MAXNAMELEN]; 2170cb174861Sjoyce mcintosh char sd_path[MAXPATHLEN]; 2171cb174861Sjoyce mcintosh } smb_kspooldoc_t; 2172cb174861Sjoyce mcintosh 2173cb174861Sjoyce mcintosh typedef struct smb_spoolfid { 2174cb174861Sjoyce mcintosh list_node_t sf_lnd; 2175a90cf9f2SGordon Ross uint32_t sf_magic; 2176cb174861Sjoyce mcintosh uint16_t sf_fid; 2177cb174861Sjoyce mcintosh } smb_spoolfid_t; 2178cb174861Sjoyce mcintosh 2179da6c28aaSamw #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 2180da6c28aaSamw #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 2181da6c28aaSamw #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 2182da6c28aaSamw #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 2183da6c28aaSamw 21841fcced4cSJordan Brown #define SMB_IS_STREAM(node) ((node)->n_unode) 2185da6c28aaSamw 2186da6c28aaSamw typedef struct smb_tsd { 2187da6c28aaSamw void (*proc)(); 2188da6c28aaSamw void *arg; 2189da6c28aaSamw char name[100]; 2190da6c28aaSamw } smb_tsd_t; 2191da6c28aaSamw 21922c2961f8Sjose borrego typedef struct smb_disp_entry { 2193148c5f43SAlan Wright char sdt_name[KSTAT_STRLEN]; 2194148c5f43SAlan Wright smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 2195148c5f43SAlan Wright smb_sdrc_t (*sdt_function)(smb_request_t *); 2196148c5f43SAlan Wright void (*sdt_post_op)(smb_request_t *); 2197148c5f43SAlan Wright uint8_t sdt_com; 2198148c5f43SAlan Wright char sdt_dialect; 2199148c5f43SAlan Wright uint8_t sdt_flags; 22002c2961f8Sjose borrego } smb_disp_entry_t; 2201da6c28aaSamw 2202148c5f43SAlan Wright typedef struct smb_xlate { 2203148c5f43SAlan Wright int code; 2204148c5f43SAlan Wright char *str; 2205148c5f43SAlan Wright } smb_xlate_t; 2206148c5f43SAlan Wright 2207148c5f43SAlan Wright /* 2208148c5f43SAlan Wright * This structure is a helper for building RAP NetShareEnum response 2209148c5f43SAlan Wright * 2210148c5f43SAlan Wright * es_posix_uid UID of the user requesting the shares list which 2211148c5f43SAlan Wright * is used to detect if the user has any autohome 2212148c5f43SAlan Wright * es_bufsize size of the response buffer 2213148c5f43SAlan Wright * es_buf pointer to the response buffer 2214148c5f43SAlan Wright * es_ntotal total number of shares exported by server which 2215148c5f43SAlan Wright * their OEM names is less then 13 chars 2216148c5f43SAlan Wright * es_nsent number of shares that can fit in the specified buffer 2217148c5f43SAlan Wright * es_datasize actual data size (share's data) which was encoded 2218148c5f43SAlan Wright * in the response buffer 2219148c5f43SAlan Wright */ 2220148c5f43SAlan Wright typedef struct smb_enumshare_info { 2221148c5f43SAlan Wright uid_t es_posix_uid; 2222148c5f43SAlan Wright uint16_t es_bufsize; 2223148c5f43SAlan Wright char *es_buf; 2224148c5f43SAlan Wright uint16_t es_ntotal; 2225148c5f43SAlan Wright uint16_t es_nsent; 2226148c5f43SAlan Wright uint16_t es_datasize; 2227148c5f43SAlan Wright } smb_enumshare_info_t; 2228148c5f43SAlan Wright 2229da6c28aaSamw #ifdef __cplusplus 2230da6c28aaSamw } 2231da6c28aaSamw #endif 2232da6c28aaSamw 2233faa1795aSjb #endif /* _SMBSRV_SMB_KTYPES_H */ 2234