Home | History | Annotate | Download | only in smbsrv
      1 /*
      2  * CDDL HEADER START
      3  *
      4  * The contents of this file are subject to the terms of the
      5  * Common Development and Distribution License (the "License").
      6  * You may not use this file except in compliance with the License.
      7  *
      8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9  * or http://www.opensolaris.org/os/licensing.
     10  * See the License for the specific language governing permissions
     11  * and limitations under the License.
     12  *
     13  * When distributing Covered Code, include this CDDL HEADER in each
     14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15  * If applicable, add the following below this CDDL HEADER, with the
     16  * fields enclosed by brackets "[]" replaced with your own identifying
     17  * information: Portions Copyright [yyyy] [name of copyright owner]
     18  *
     19  * CDDL HEADER END
     20  */
     21 /*
     22  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
     23  * Use is subject to license terms.
     24  */
     25 
     26 /*
     27  * Function prototypes for the SMB module.
     28  */
     29 
     30 #ifndef _SMB_KPROTO_H_
     31 #define	_SMB_KPROTO_H_
     32 
     33 #ifdef	__cplusplus
     34 extern "C" {
     35 #endif
     36 
     37 #include <sys/types.h>
     38 #include <sys/param.h>
     39 #include <sys/systm.h>
     40 #include <sys/socket.h>
     41 #include <sys/strsubr.h>
     42 #include <sys/socketvar.h>
     43 #include <sys/ksocket.h>
     44 #include <sys/cred.h>
     45 #include <sys/sunddi.h>
     46 #include <smbsrv/smb.h>
     47 #include <smbsrv/string.h>
     48 #include <smbsrv/smb_vops.h>
     49 #include <smbsrv/smb_xdr.h>
     50 #include <smbsrv/smb_token.h>
     51 #include <smbsrv/smb_ktypes.h>
     52 #include <smbsrv/smb_ioctl.h>
     53 
     54 extern	int smb_maxbufsize;
     55 extern	int smb_flush_required;
     56 extern	int smb_dirsymlink_enable;
     57 extern	int smb_oplock_timeout;
     58 extern	int smb_sign_debug;
     59 extern	uint_t smb_audit_flags;
     60 
     61 int		fd_dealloc(int);
     62 
     63 off_t		lseek(int fildes, off_t offset, int whence);
     64 
     65 int		arpioctl(int cmd, void *data);
     66 int		microtime(timestruc_t *tvp);
     67 int		clock_get_uptime(void);
     68 
     69 /*
     70  * SMB request handers called from the dispatcher.  Each SMB request
     71  * is handled in three phases: pre, com (command) and post.
     72  *
     73  * The pre-handler is primarily to set things up for the DTrace start
     74  * probe.  Typically, the SMB request is unmarshalled so that request
     75  * specific context can be traced.  This is also a useful place to
     76  * allocate memory that will be used throughout the processing of the
     77  * command.
     78  *
     79  * The com-handler performs the requested operation: request validation,
     80  * bulk (write) incoming data decode, implementation of the appropriate
     81  * algorithm and transmission of a response (as appropriate).
     82  *
     83  * The post-handler is always called, regardless of success or failure
     84  * of the pre or com functions, to trigger the DTrace done probe and
     85  * deallocate memory allocated in the pre-handler.
     86  */
     87 #define	SMB_SDT_OPS(NAME)	\
     88 	smb_pre_##NAME,		\
     89 	smb_com_##NAME,		\
     90 	smb_post_##NAME
     91 
     92 #define	SMB_COM_DECL(NAME)				\
     93 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
     94 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
     95 	void smb_post_##NAME(smb_request_t *)
     96 
     97 SMB_COM_DECL(check_directory);
     98 SMB_COM_DECL(close);
     99 SMB_COM_DECL(close_and_tree_disconnect);
    100 SMB_COM_DECL(close_print_file);
    101 SMB_COM_DECL(create);
    102 SMB_COM_DECL(create_directory);
    103 SMB_COM_DECL(create_new);
    104 SMB_COM_DECL(create_temporary);
    105 SMB_COM_DECL(delete);
    106 SMB_COM_DECL(delete_directory);
    107 SMB_COM_DECL(echo);
    108 SMB_COM_DECL(find);
    109 SMB_COM_DECL(find_close);
    110 SMB_COM_DECL(find_close2);
    111 SMB_COM_DECL(find_unique);
    112 SMB_COM_DECL(flush);
    113 SMB_COM_DECL(get_print_queue);
    114 SMB_COM_DECL(invalid);
    115 SMB_COM_DECL(ioctl);
    116 SMB_COM_DECL(lock_and_read);
    117 SMB_COM_DECL(lock_byte_range);
    118 SMB_COM_DECL(locking_andx);
    119 SMB_COM_DECL(logoff_andx);
    120 SMB_COM_DECL(negotiate);
    121 SMB_COM_DECL(nt_cancel);
    122 SMB_COM_DECL(nt_create_andx);
    123 SMB_COM_DECL(nt_rename);
    124 SMB_COM_DECL(nt_transact);
    125 SMB_COM_DECL(nt_transact_secondary);
    126 SMB_COM_DECL(open);
    127 SMB_COM_DECL(open_andx);
    128 SMB_COM_DECL(open_print_file);
    129 SMB_COM_DECL(process_exit);
    130 SMB_COM_DECL(query_information);
    131 SMB_COM_DECL(query_information2);
    132 SMB_COM_DECL(query_information_disk);
    133 SMB_COM_DECL(read);
    134 SMB_COM_DECL(read_andx);
    135 SMB_COM_DECL(read_raw);
    136 SMB_COM_DECL(rename);
    137 SMB_COM_DECL(search);
    138 SMB_COM_DECL(seek);
    139 SMB_COM_DECL(session_setup_andx);
    140 SMB_COM_DECL(set_information);
    141 SMB_COM_DECL(set_information2);
    142 SMB_COM_DECL(transaction);
    143 SMB_COM_DECL(transaction2);
    144 SMB_COM_DECL(transaction2_secondary);
    145 SMB_COM_DECL(transaction_secondary);
    146 SMB_COM_DECL(tree_connect);
    147 SMB_COM_DECL(tree_connect_andx);
    148 SMB_COM_DECL(tree_disconnect);
    149 SMB_COM_DECL(unlock_byte_range);
    150 SMB_COM_DECL(write);
    151 SMB_COM_DECL(write_and_close);
    152 SMB_COM_DECL(write_and_unlock);
    153 SMB_COM_DECL(write_andx);
    154 SMB_COM_DECL(write_print_file);
    155 SMB_COM_DECL(write_raw);
    156 
    157 #define	SMB_NT_TRANSACT_DECL(NAME)				\
    158 	smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *);	\
    159 	smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *);	\
    160 	void smb_post_##NAME(smb_request_t *, smb_xa_t *)
    161 
    162 SMB_NT_TRANSACT_DECL(nt_transact_create);
    163 
    164 int smb_notify_init(void);
    165 void smb_notify_fini(void);
    166 
    167 smb_sdrc_t smb_nt_transact_notify_change(smb_request_t *, smb_xa_t *);
    168 smb_sdrc_t smb_nt_transact_query_security_info(smb_request_t *, smb_xa_t *);
    169 smb_sdrc_t smb_nt_transact_set_security_info(smb_request_t *, smb_xa_t *);
    170 smb_sdrc_t smb_nt_transact_ioctl(smb_request_t *, smb_xa_t *);
    171 smb_sdrc_t smb_nt_transact_rename(smb_request_t *, smb_xa_t *);
    172 
    173 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *);
    174 smb_sdrc_t smb_com_trans2_create_directory(smb_request_t *, smb_xa_t *);
    175 smb_sdrc_t smb_com_trans2_find_first2(smb_request_t *, smb_xa_t *);
    176 smb_sdrc_t smb_com_trans2_find_next2(smb_request_t *, smb_xa_t *);
    177 smb_sdrc_t smb_com_trans2_query_fs_information(smb_request_t *, smb_xa_t *);
    178 smb_sdrc_t smb_com_trans2_query_path_information(smb_request_t *, smb_xa_t *);
    179 smb_sdrc_t smb_com_trans2_query_file_information(smb_request_t *, smb_xa_t *);
    180 smb_sdrc_t smb_com_trans2_set_path_information(smb_request_t *, smb_xa_t *);
    181 smb_sdrc_t smb_com_trans2_set_file_information(smb_request_t *, smb_xa_t *);
    182 int smb_trans2_rename(smb_request_t *, smb_node_t *, char *, int);
    183 
    184 /*
    185  * Logging functions
    186  */
    187 void smb_log_flush(void);
    188 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
    189 void smb_close_all_connections(void);
    190 
    191 int smb_net_id(uint32_t);
    192 
    193 void smb_process_file_notify_change_queue(smb_ofile_t *of);
    194 
    195 void smb_oplock_acquire(smb_node_t *, smb_ofile_t *, open_param_t	*);
    196 boolean_t smb_oplock_break(smb_node_t *, smb_session_t *, boolean_t);
    197 void smb_oplock_release(smb_node_t *, smb_ofile_t *);
    198 boolean_t smb_oplock_conflict(smb_node_t *, smb_session_t *, open_param_t *);
    199 boolean_t smb_oplock_broadcast(smb_node_t *);
    200 
    201 /*
    202  * macros used in oplock processing
    203  *
    204  * SMB_ATTR_ONLY_OPEN: Checks to see if this is
    205  * an attribute-only open with no contravening
    206  * dispositions.  Such an open cannot effect an
    207  * oplock break.  However, a contravening disposition
    208  * of FILE_SUPERSEDE or FILE_OVERWRITE can allow
    209  * an oplock break.
    210  */
    211 
    212 #define	SMB_ATTR_ONLY_OPEN(op)					\
    213 	((op) && (op)->desired_access &&			\
    214 	(((op)->desired_access & ~(FILE_READ_ATTRIBUTES |	\
    215 	FILE_WRITE_ATTRIBUTES | SYNCHRONIZE)) == 0) &&		\
    216 	((op)->create_disposition != FILE_SUPERSEDE) &&		\
    217 	((op)->create_disposition != FILE_OVERWRITE))		\
    218 
    219 uint32_t smb_lock_get_lock_count(smb_node_t *);
    220 uint32_t smb_unlock_range(smb_request_t *, smb_node_t *,
    221     uint64_t, uint64_t);
    222 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
    223     uint32_t locktype);
    224 void smb_lock_range_error(smb_request_t *, uint32_t);
    225 
    226 DWORD smb_range_check(smb_request_t *, smb_node_t *, uint64_t, uint64_t,
    227     boolean_t);
    228 
    229 int smb_mangle_name(ino64_t, char *, char *, char *, int);
    230 int smb_unmangle_name(smb_node_t *, char *, char *, int, uint32_t);
    231 int smb_maybe_mangled_name(char *);
    232 int smb_maybe_mangled_path(const char *, size_t);
    233 int smb_needs_mangle(char *, char **);
    234 boolean_t smb_is_invalid_filename(const char *);
    235 
    236 void smbsr_cleanup(smb_request_t *sr);
    237 
    238 int smbsr_connect_tree(smb_request_t *);
    239 
    240 int smb_common_create_directory(smb_request_t *);
    241 
    242 void	smb_convert_wildcards(char *);
    243 boolean_t smb_contains_wildcards(const char *);
    244 int	smb_ascii_or_unicode_strlen(smb_request_t *, char *);
    245 int	smb_ascii_or_unicode_strlen_null(smb_request_t *, char *);
    246 int	smb_ascii_or_unicode_null_len(smb_request_t *);
    247 
    248 int	smb_search(smb_request_t *);
    249 
    250 uint32_t smb_common_create(smb_request_t *);
    251 uint32_t smb_common_open(smb_request_t *);
    252 int smb_common_write(smb_request_t *, smb_rw_param_t *);
    253 
    254 void smb_pathname_init(smb_request_t *, smb_pathname_t *, char *);
    255 boolean_t smb_pathname_validate(smb_request_t *, smb_pathname_t *);
    256 boolean_t smb_validate_dirname(smb_request_t *, smb_pathname_t *);
    257 boolean_t smb_validate_object_name(smb_request_t *, smb_pathname_t *);
    258 boolean_t smb_validate_stream_name(smb_request_t *, smb_pathname_t *);
    259 boolean_t smb_is_stream_name(char *);
    260 void smb_stream_parse_name(char *, char *, char *);
    261 
    262 
    263 uint32_t smb_omode_to_amask(uint32_t desired_access);
    264 
    265 void	sshow_distribution_info(char *);
    266 
    267 boolean_t smb_dispatch_request(smb_request_t *);
    268 int	smbsr_encode_empty_result(smb_request_t *);
    269 void	smbsr_lookup_file(smb_request_t *);
    270 void	smbsr_release_file(smb_request_t *);
    271 
    272 int	smbsr_decode_vwv(smb_request_t *sr, char *fmt, ...);
    273 int	smbsr_decode_data(smb_request_t *sr, char *fmt, ...);
    274 int	smbsr_encode_result(smb_request_t *, int, int, char *, ...);
    275 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
    276 void	smbsr_send_reply(smb_request_t *);
    277 
    278 void	smbsr_map_errno(int, smb_error_t *);
    279 void	smbsr_set_error(smb_request_t *, smb_error_t *);
    280 void	smbsr_errno(smb_request_t *, int);
    281 void	smbsr_warn(smb_request_t *, DWORD, uint16_t, uint16_t);
    282 void	smbsr_error(smb_request_t *, DWORD, uint16_t, uint16_t);
    283 
    284 int	clock_get_milli_uptime(void);
    285 
    286 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
    287 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
    288 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
    289 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
    290 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
    291 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
    292 
    293 void	smbsr_encode_header(smb_request_t *sr, int wct,
    294 		    int bcc, char *fmt, ...);
    295 
    296 int	smb_xlate_dialect_str_to_cd(char *);
    297 char	*smb_xlate_com_cd_to_str(int);
    298 char	*smb_xlate_dialect_cd_to_str(int);
    299 
    300 int smb_lock_range_access(smb_request_t *, smb_node_t *,
    301     uint64_t, uint64_t, boolean_t);
    302 
    303 void smb_encode_sid(smb_xa_t *, smb_sid_t *);
    304 uint32_t smb_decode_sd(smb_xa_t *, smb_sd_t *);
    305 
    306 /*
    307  * Socket functions
    308  */
    309 ksocket_t smb_socreate(int domain, int type, int protocol);
    310 void smb_soshutdown(ksocket_t so);
    311 void smb_sodestroy(ksocket_t so);
    312 int smb_sorecv(ksocket_t so, void *msg, size_t len);
    313 int smb_net_init(void);
    314 void smb_net_fini(void);
    315 void smb_net_txl_constructor(smb_txlst_t *);
    316 void smb_net_txl_destructor(smb_txlst_t *);
    317 smb_txreq_t *smb_net_txr_alloc(void);
    318 void smb_net_txr_free(smb_txreq_t *);
    319 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
    320 
    321 /*
    322  * SMB RPC interface
    323  */
    324 int smb_opipe_open(smb_request_t *);
    325 void smb_opipe_close(smb_ofile_t *);
    326 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
    327 int smb_opipe_read(smb_request_t *, struct uio *);
    328 int smb_opipe_write(smb_request_t *, struct uio *);
    329 
    330 void smb_opipe_door_init(void);
    331 void smb_opipe_door_fini(void);
    332 int smb_opipe_door_open(int);
    333 void smb_opipe_door_close(void);
    334 
    335 /*
    336  * SMB server functions (file smb_server.c)
    337  */
    338 int smb_server_svc_init(void);
    339 int smb_server_svc_fini(void);
    340 int smb_server_create(void);
    341 int smb_server_delete(void);
    342 int smb_server_configure(smb_ioc_cfg_t *);
    343 int smb_server_start(smb_ioc_start_t *);
    344 int smb_server_nbt_listen(smb_ioc_listen_t *);
    345 int smb_server_tcp_listen(smb_ioc_listen_t *);
    346 int smb_server_nbt_receive(void);
    347 int smb_server_tcp_receive(void);
    348 uint32_t smb_server_get_session_count(void);
    349 int smb_server_share_export(smb_ioc_share_t *);
    350 int smb_server_share_unexport(smb_ioc_share_t *);
    351 int smb_server_set_gmtoff(smb_ioc_gmt_t *);
    352 int smb_server_numopen(smb_ioc_opennum_t *);
    353 int smb_server_enum(smb_ioc_svcenum_t *);
    354 int smb_server_session_close(smb_ioc_session_t *);
    355 int smb_server_file_close(smb_ioc_fileid_t *);
    356 
    357 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
    358 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
    359 
    360 
    361 /*
    362  * SMB node functions (file smb_node.c)
    363  */
    364 int smb_node_init(void);
    365 void smb_node_fini(void);
    366 smb_node_t *smb_node_lookup(smb_request_t *, open_param_t *,
    367     cred_t *, vnode_t *, char *, smb_node_t *, smb_node_t *);
    368 smb_node_t *smb_stream_node_lookup(smb_request_t *, cred_t *,
    369     smb_node_t *, vnode_t *, vnode_t *, char *);
    370 
    371 void smb_node_ref(smb_node_t *);
    372 void smb_node_release(smb_node_t *);
    373 void smb_node_rename(smb_node_t *, smb_node_t *, smb_node_t *, char *);
    374 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
    375 void smb_node_add_lock(smb_node_t *, smb_lock_t *);
    376 void smb_node_destroy_lock(smb_node_t *, smb_lock_t *);
    377 void smb_node_destroy_lock_by_ofile(smb_node_t *, smb_ofile_t *);
    378 void smb_node_start_crit(smb_node_t *, krw_t);
    379 void smb_node_end_crit(smb_node_t *);
    380 int smb_node_in_crit(smb_node_t *);
    381 void smb_node_rdlock(smb_node_t *);
    382 void smb_node_wrlock(smb_node_t *);
    383 void smb_node_unlock(smb_node_t *);
    384 uint32_t smb_node_get_ofile_count(smb_node_t *);
    385 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
    386 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
    387 void smb_node_inc_open_ofiles(smb_node_t *);
    388 void smb_node_dec_open_ofiles(smb_node_t *);
    389 boolean_t smb_node_is_dir(smb_node_t *);
    390 boolean_t smb_node_is_link(smb_node_t *);
    391 
    392 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
    393     uint32_t, uint32_t);
    394 DWORD smb_node_rename_check(smb_node_t *);
    395 DWORD smb_node_delete_check(smb_node_t *);
    396 void smb_node_notify_change(smb_node_t *);
    397 
    398 int smb_node_getattr(smb_request_t *, smb_node_t *, smb_attr_t *);
    399 int smb_node_setattr(smb_request_t *, smb_node_t *, cred_t *,
    400     smb_ofile_t *, smb_attr_t *);
    401 
    402 int smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t);
    403 void smb_node_reset_delete_on_close(smb_node_t *);
    404 
    405 boolean_t smb_node_file_is_readonly(smb_node_t *);
    406 
    407 /*
    408  * Pathname functions
    409  */
    410 
    411 int smb_pathname_reduce(smb_request_t *, cred_t *,
    412     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
    413 
    414 int smb_pathname(smb_request_t *, char *, int, smb_node_t *,
    415     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
    416 
    417 /*
    418  * smb_vfs functions
    419  */
    420 
    421 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
    422 void smb_vfs_rele(smb_server_t *, vfs_t *);
    423 void smb_vfs_rele_all(smb_server_t *);
    424 boolean_t smb_vfs_cmp(vfs_t *, vfs_t *);
    425 boolean_t smb_vfs_is_readonly(vfs_t *);
    426 
    427 /* NOTIFY CHANGE */
    428 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
    429 void smb_process_node_notify_change_queue(smb_node_t *);
    430 void smb_reply_specific_cancel_request(smb_request_t *);
    431 
    432 void smb_fem_fcn_install(smb_node_t *);
    433 void smb_fem_fcn_uninstall(smb_node_t *);
    434 
    435 /* FEM */
    436 
    437 int smb_fem_init(void);
    438 void smb_fem_fini(void);
    439 
    440 int smb_try_grow(smb_request_t *sr, int64_t new_size);
    441 
    442 void smb_srm_init(smb_request_t *sr);
    443 void smb_srm_fini(smb_request_t *sr);
    444 void *smb_srm_alloc(smb_request_t *, size_t);
    445 void *smb_srm_realloc(smb_request_t *, void *, size_t);
    446 
    447 unsigned short smb_worker_getnum();
    448 
    449 /* SMB signing routines smb_signing.c */
    450 void smb_sign_init(smb_request_t *, smb_session_key_t *, char *, int);
    451 int smb_sign_check_request(smb_request_t *);
    452 int smb_sign_check_secondary(smb_request_t *, unsigned int);
    453 void smb_sign_reply(smb_request_t *, mbuf_chain_t *);
    454 
    455 boolean_t smb_sattr_check(uint16_t, uint16_t);
    456 
    457 void smb_request_cancel(smb_request_t *);
    458 void smb_request_wait(smb_request_t *);
    459 
    460 /*
    461  * session functions (file smb_session.c)
    462  */
    463 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
    464 int smb_session_daemon(smb_session_list_t *);
    465 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
    466 void smb_session_timers(smb_session_list_t *);
    467 void smb_session_delete(smb_session_t *session);
    468 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
    469     smb_request_t *);
    470 void smb_session_config(smb_session_t *session);
    471 void smb_session_disconnect_share(smb_session_list_t *, char *);
    472 void smb_session_list_constructor(smb_session_list_t *);
    473 void smb_session_list_destructor(smb_session_list_t *);
    474 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
    475 void smb_session_list_delete_tail(smb_session_list_t *);
    476 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
    477 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
    478 void smb_session_list_signal(smb_session_list_t *);
    479 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
    480 void smb_session_getclient(smb_session_t *, char *, size_t);
    481 boolean_t smb_session_isclient(smb_session_t *, const char *);
    482 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
    483 void smb_session_oplock_break(smb_session_t *, smb_ofile_t *);
    484 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
    485 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
    486 boolean_t smb_session_oplocks_enable(smb_session_t *);
    487 
    488 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
    489 
    490 smb_request_t *smb_request_alloc(smb_session_t *, int);
    491 void smb_request_free(smb_request_t *);
    492 
    493 /*
    494  * ofile functions (file smb_ofile.c)
    495  */
    496 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
    497 smb_ofile_t *smb_ofile_lookup_by_uniqid(smb_tree_t *, uint32_t);
    498 boolean_t smb_ofile_disallow_fclose(smb_ofile_t *);
    499 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
    500     open_param_t *, uint16_t, uint32_t, smb_error_t *);
    501 void smb_ofile_close(smb_ofile_t *, uint32_t);
    502 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
    503 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
    504 boolean_t smb_ofile_hold(smb_ofile_t *);
    505 void smb_ofile_release(smb_ofile_t *);
    506 void smb_ofile_close_all(smb_tree_t *);
    507 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
    508 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
    509 boolean_t smb_ofile_is_open(smb_ofile_t *);
    510 int smb_ofile_enum(smb_ofile_t *, smb_svcenum_t *);
    511 uint32_t smb_ofile_open_check(smb_ofile_t *, cred_t *, uint32_t, uint32_t);
    512 uint32_t smb_ofile_rename_check(smb_ofile_t *);
    513 uint32_t smb_ofile_delete_check(smb_ofile_t *);
    514 cred_t *smb_ofile_getcred(smb_ofile_t *);
    515 void smb_ofile_set_oplock_granted(smb_ofile_t *);
    516 void smb_ofile_set_delete_on_close(smb_ofile_t *);
    517 
    518 void smb_ofile_set_write_time_pending(smb_ofile_t *);
    519 boolean_t smb_ofile_write_time_pending(smb_ofile_t *);
    520 void smb_ofile_set_explicit_times(smb_ofile_t *, uint32_t);
    521 uint32_t smb_ofile_explicit_times(smb_ofile_t *);
    522 void smb_delayed_write_timer(smb_llist_t *);
    523 
    524 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
    525 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
    526 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
    527 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
    528 
    529 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
    530 
    531 /*
    532  * odir functions (file smb_odir.c)
    533  */
    534 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t, uint32_t);
    535 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
    536 void smb_odir_close(smb_odir_t *);
    537 boolean_t smb_odir_hold(smb_odir_t *);
    538 void smb_odir_release(smb_odir_t *);
    539 
    540 int smb_odir_read(smb_request_t *, smb_odir_t *,
    541     smb_odirent_t *, boolean_t *);
    542 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
    543     smb_fileinfo_t *, boolean_t *);
    544 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
    545     smb_streaminfo_t *, boolean_t *);
    546 
    547 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
    548 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
    549 
    550 /*
    551  * SMB user functions (file smb_user.c)
    552  */
    553 int smb_user_init(void);
    554 void smb_user_fini(void);
    555 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
    556     char *, char *, uint32_t, uint32_t, uint32_t);
    557 smb_user_t *smb_user_dup(smb_user_t *);
    558 void smb_user_logoff(smb_user_t *);
    559 void smb_user_logoff_all(smb_session_t *);
    560 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, uint16_t);
    561 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *);
    562 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
    563 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
    564 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
    565 boolean_t smb_user_is_admin(smb_user_t *);
    566 boolean_t smb_user_namecmp(smb_user_t *, const char *);
    567 int smb_user_enum(smb_user_t *, smb_svcenum_t *);
    568 void smb_user_close_pid(smb_user_t *, uint16_t);
    569 void smb_user_disconnect_trees(smb_user_t *user);
    570 void smb_user_disconnect_share(smb_user_t *, const char *);
    571 int smb_user_fclose(smb_user_t *, uint32_t);
    572 boolean_t smb_user_hold(smb_user_t *);
    573 void smb_user_release(smb_user_t *);
    574 cred_t *smb_user_getcred(smb_user_t *);
    575 cred_t *smb_user_getprivcred(smb_user_t *);
    576 void smb_user_netinfo_init(smb_user_t *, smb_netuserinfo_t *);
    577 void smb_user_netinfo_fini(smb_netuserinfo_t *);
    578 int smb_user_netinfo_encode(smb_user_t *, uint8_t *, size_t, uint32_t *);
    579 
    580 /*
    581  * SMB tree functions (file smb_tree.c)
    582  */
    583 smb_tree_t *smb_tree_connect(smb_request_t *);
    584 void smb_tree_disconnect(smb_tree_t *, boolean_t);
    585 void smb_tree_close_pid(smb_tree_t *, uint16_t);
    586 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
    587 int smb_tree_enum(smb_tree_t *, smb_svcenum_t *);
    588 int smb_tree_fclose(smb_tree_t *, uint32_t);
    589 boolean_t smb_tree_hold(smb_tree_t *);
    590 void smb_tree_release(smb_tree_t *);
    591 smb_odir_t *smb_tree_lookup_odir(smb_tree_t *, uint16_t);
    592 boolean_t smb_tree_is_connected(smb_tree_t *);
    593 #define	SMB_TREE_GET_TID(tree)		((tree)->t_tid)
    594 
    595 /*
    596  * SMB user's credential functions
    597  */
    598 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
    599 void smb_cred_rele(cred_t *cr);
    600 int smb_cred_is_member(cred_t *cr, smb_sid_t *sid);
    601 cred_t *smb_cred_create_privs(cred_t *, uint32_t);
    602 
    603 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
    604     uint32_t total_parameter_count, uint32_t total_data_count,
    605     uint32_t max_parameter_count, uint32_t max_data_count,
    606     uint32_t max_setup_count, uint32_t setup_word_count);
    607 void smb_xa_delete(smb_xa_t *xa);
    608 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
    609 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
    610 int smb_xa_open(smb_xa_t *xa);
    611 void smb_xa_close(smb_xa_t *xa);
    612 int smb_xa_complete(smb_xa_t *xa);
    613 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
    614 
    615 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
    616 struct mbuf *smb_mbuf_allocate(struct uio *uio);
    617 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
    618 
    619 void smb_check_status(void);
    620 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
    621 
    622 void smb_reconnection_check(smb_session_t *);
    623 
    624 int32_t smb_time_gmt_to_local(smb_request_t *, int32_t);
    625 int32_t smb_time_local_to_gmt(smb_request_t *, int32_t);
    626 int32_t	smb_time_dos_to_unix(int16_t, int16_t);
    627 void smb_time_unix_to_dos(int32_t, int16_t *, int16_t *);
    628 void smb_time_nt_to_unix(uint64_t nt_time, timestruc_t *unix_time);
    629 uint64_t smb_time_unix_to_nt(timestruc_t *);
    630 
    631 int netbios_name_isvalid(char *in, char *out);
    632 
    633 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
    634 
    635 int smb_match_name(ino64_t, char *, char *, boolean_t);
    636 int token2buf(smb_token_t *token, char *buf);
    637 
    638 /*
    639  * Pool ID function prototypes
    640  */
    641 int	smb_idpool_constructor(smb_idpool_t *pool);
    642 void	smb_idpool_destructor(smb_idpool_t  *pool);
    643 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
    644 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
    645 
    646 /*
    647  * SMB thread function prototypes
    648  */
    649 void	smb_session_worker(void *arg);
    650 
    651 /*
    652  * SMB locked list function prototypes
    653  */
    654 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
    655 void	smb_llist_destructor(smb_llist_t *);
    656 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
    657 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
    658 void	smb_llist_remove(smb_llist_t *ll, void *obj);
    659 int	smb_llist_upgrade(smb_llist_t *ll);
    660 uint32_t smb_llist_get_count(smb_llist_t *ll);
    661 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
    662 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
    663 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
    664 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
    665 int	smb_account_connected(smb_user_t *user);
    666 
    667 /*
    668  * SMB Synchronized list function prototypes
    669  */
    670 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
    671 void	smb_slist_destructor(smb_slist_t *);
    672 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
    673 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
    674 void	smb_slist_remove(smb_slist_t *sl, void *obj);
    675 void	smb_slist_wait_for_empty(smb_slist_t *sl);
    676 void	smb_slist_exit(smb_slist_t *sl);
    677 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
    678 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
    679 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
    680 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
    681 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
    682 
    683 void    smb_rwx_init(smb_rwx_t *rwx);
    684 void    smb_rwx_destroy(smb_rwx_t *rwx);
    685 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
    686 void    smb_rwx_rwexit(smb_rwx_t *rwx);
    687 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
    688 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
    689 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
    690 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
    691 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
    692 
    693 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
    694     smb_thread_aw_t, void *);
    695 void	smb_thread_destroy(smb_thread_t *);
    696 int	smb_thread_start(smb_thread_t *);
    697 void	smb_thread_stop(smb_thread_t *);
    698 void    smb_thread_signal(smb_thread_t *);
    699 boolean_t smb_thread_continue(smb_thread_t *);
    700 boolean_t smb_thread_continue_nowait(smb_thread_t *);
    701 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
    702 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
    703 
    704 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
    705 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
    706 
    707 /* 100's of ns between 1/1/1970 and 1/1/1601 */
    708 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
    709 
    710 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
    711 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
    712 
    713 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
    714 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
    715 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
    716 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
    717 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
    718 
    719 boolean_t smb_ace_is_generic(int);
    720 boolean_t smb_ace_is_access(int);
    721 boolean_t smb_ace_is_audit(int);
    722 
    723 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
    724 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
    725     char *, smb_node_t **, smb_node_t **);
    726 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
    727 
    728 void smb_panic(char *, const char *, int);
    729 #pragma	does_not_return(smb_panic)
    730 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
    731 
    732 #ifdef	__cplusplus
    733 }
    734 #endif
    735 
    736 #endif /* _SMB_KPROTO_H_ */
    737