xref: /titanic_41/usr/src/uts/common/smbsrv/smb_kproto.h (revision a95c812d9d8f3561ba53bcaf3728f8e05fa5bdc9)
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 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2014 Nexenta Systems, Inc.  All rights reserved.
25  */
26 
27 /*
28  * Function prototypes for the SMB module.
29  */
30 
31 #ifndef _SMB_KPROTO_H_
32 #define	_SMB_KPROTO_H_
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 #include <sys/types.h>
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/debug.h>
42 #include <sys/kmem.h>
43 #include <sys/socket.h>
44 #include <sys/ksocket.h>
45 #include <sys/cred.h>
46 #include <sys/nbmlock.h>
47 #include <sys/sunddi.h>
48 #include <sys/atomic.h>
49 #include <smbsrv/smb.h>
50 #include <smbsrv/string.h>
51 #include <smbsrv/smb_vops.h>
52 #include <smbsrv/smb_xdr.h>
53 #include <smbsrv/smb_token.h>
54 #include <smbsrv/smb_ktypes.h>
55 #include <smbsrv/smb_ioctl.h>
56 
57 /*
58  * DTrace SDT probes have different signatures in userland than they do in
59  * kernel.  If they're being used in kernel code, re-define them out of
60  * existence for their counterparts in libfksmbsrv
61  */
62 #ifndef	_KERNEL
63 #undef	DTRACE_SMB_1
64 #define	DTRACE_SMB_1(a, b, c)			((void)c)
65 #undef	DTRACE_SMB_2
66 #define	DTRACE_SMB_2(a, b, c, d, e)		((void)c, (void)e)
67 #undef	DTRACE_PROBE1
68 #define	DTRACE_PROBE1(a, b, c)			((void)c)
69 #undef	DTRACE_PROBE2
70 #define	DTRACE_PROBE2(a, b, c, d, e)		((void)c, (void)e)
71 #undef	DTRACE_PROBE3
72 #define	DTRACE_PROBE3(a, b, c, d, e, f, g)	((void)c, (void)e, (void)g)
73 #endif	/* _KERNEL */
74 
75 extern	int smb_maxbufsize;
76 extern	int smb_flush_required;
77 extern	int smb_dirsymlink_enable;
78 extern	int smb_oplock_levelII;
79 extern	int smb_oplock_timeout;
80 extern	int smb_oplock_min_timeout;
81 extern	int smb_shortnames;
82 extern	int smb_sign_debug;
83 extern	int smb_raw_mode;
84 extern	uint_t smb_audit_flags;
85 extern	int smb_ssetup_threshold;
86 extern	int smb_tcon_threshold;
87 extern	int smb_opipe_threshold;
88 extern	int smb_ssetup_timeout;
89 extern	int smb_tcon_timeout;
90 extern	int smb_opipe_timeout;
91 extern const uint32_t smb_vop_dosattr_settable;
92 
93 /* Thread priorities - see smb_init.c */
94 extern	int smbsrv_base_pri;
95 extern	int smbsrv_listen_pri;
96 extern	int smbsrv_receive_pri;
97 extern	int smbsrv_worker_pri;
98 extern	int smbsrv_notify_pri;
99 extern	int smbsrv_timer_pri;
100 
101 extern	kmem_cache_t		*smb_cache_request;
102 extern	kmem_cache_t		*smb_cache_session;
103 extern	kmem_cache_t		*smb_cache_user;
104 extern	kmem_cache_t		*smb_cache_tree;
105 extern	kmem_cache_t		*smb_cache_ofile;
106 extern	kmem_cache_t		*smb_cache_odir;
107 extern	kmem_cache_t		*smb_cache_opipe;
108 extern	kmem_cache_t		*smb_cache_event;
109 
110 extern	kmem_cache_t		*smb_kshare_cache_vfs;
111 
112 int		fd_dealloc(int);
113 
114 off_t		lseek(int fildes, off_t offset, int whence);
115 
116 int		arpioctl(int cmd, void *data);
117 int		microtime(timestruc_t *tvp);
118 int		clock_get_uptime(void);
119 
120 int smb_server_lookup(smb_server_t **);
121 void smb_server_release(smb_server_t *);
122 
123 /*
124  * SMB request handers called from the dispatcher.  Each SMB request
125  * is handled in three phases: pre, com (command) and post.
126  *
127  * The pre-handler is primarily to set things up for the DTrace start
128  * probe.  Typically, the SMB request is unmarshalled so that request
129  * specific context can be traced.  This is also a useful place to
130  * allocate memory that will be used throughout the processing of the
131  * command.
132  *
133  * The com-handler performs the requested operation: request validation,
134  * bulk (write) incoming data decode, implementation of the appropriate
135  * algorithm and transmission of a response (as appropriate).
136  *
137  * The post-handler is always called, regardless of success or failure
138  * of the pre or com functions, to trigger the DTrace done probe and
139  * deallocate memory allocated in the pre-handler.
140  */
141 #define	SMB_SDT_OPS(NAME)	\
142 	smb_pre_##NAME,		\
143 	smb_com_##NAME,		\
144 	smb_post_##NAME
145 
146 #define	SMB_COM_DECL(NAME)				\
147 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
148 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
149 	void smb_post_##NAME(smb_request_t *)
150 
151 SMB_COM_DECL(check_directory);
152 SMB_COM_DECL(close);
153 SMB_COM_DECL(close_and_tree_disconnect);
154 SMB_COM_DECL(close_print_file);
155 SMB_COM_DECL(create);
156 SMB_COM_DECL(create_directory);
157 SMB_COM_DECL(create_new);
158 SMB_COM_DECL(create_temporary);
159 SMB_COM_DECL(delete);
160 SMB_COM_DECL(delete_directory);
161 SMB_COM_DECL(echo);
162 SMB_COM_DECL(find);
163 SMB_COM_DECL(find_close);
164 SMB_COM_DECL(find_close2);
165 SMB_COM_DECL(find_unique);
166 SMB_COM_DECL(flush);
167 SMB_COM_DECL(get_print_queue);
168 SMB_COM_DECL(invalid);
169 SMB_COM_DECL(ioctl);
170 SMB_COM_DECL(lock_and_read);
171 SMB_COM_DECL(lock_byte_range);
172 SMB_COM_DECL(locking_andx);
173 SMB_COM_DECL(logoff_andx);
174 SMB_COM_DECL(negotiate);
175 SMB_COM_DECL(nt_cancel);
176 SMB_COM_DECL(nt_create_andx);
177 SMB_COM_DECL(nt_rename);
178 SMB_COM_DECL(nt_transact);
179 SMB_COM_DECL(nt_transact_secondary);
180 SMB_COM_DECL(open);
181 SMB_COM_DECL(open_andx);
182 SMB_COM_DECL(open_print_file);
183 SMB_COM_DECL(process_exit);
184 SMB_COM_DECL(query_information);
185 SMB_COM_DECL(query_information2);
186 SMB_COM_DECL(query_information_disk);
187 SMB_COM_DECL(read);
188 SMB_COM_DECL(read_andx);
189 SMB_COM_DECL(read_raw);
190 SMB_COM_DECL(rename);
191 SMB_COM_DECL(search);
192 SMB_COM_DECL(seek);
193 SMB_COM_DECL(session_setup_andx);
194 SMB_COM_DECL(set_information);
195 SMB_COM_DECL(set_information2);
196 SMB_COM_DECL(transaction);
197 SMB_COM_DECL(transaction2);
198 SMB_COM_DECL(transaction2_secondary);
199 SMB_COM_DECL(transaction_secondary);
200 SMB_COM_DECL(tree_connect);
201 SMB_COM_DECL(tree_connect_andx);
202 SMB_COM_DECL(tree_disconnect);
203 SMB_COM_DECL(unlock_byte_range);
204 SMB_COM_DECL(write);
205 SMB_COM_DECL(write_and_close);
206 SMB_COM_DECL(write_and_unlock);
207 SMB_COM_DECL(write_andx);
208 SMB_COM_DECL(write_print_file);
209 SMB_COM_DECL(write_raw);
210 
211 #define	SMB_NT_TRANSACT_DECL(NAME)				\
212 	smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *);	\
213 	smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *);	\
214 	void smb_post_##NAME(smb_request_t *, smb_xa_t *)
215 
216 SMB_NT_TRANSACT_DECL(nt_transact_create);
217 
218 smb_sdrc_t smb_nt_transact_notify_change(smb_request_t *, smb_xa_t *);
219 smb_sdrc_t smb_nt_transact_query_security_info(smb_request_t *, smb_xa_t *);
220 smb_sdrc_t smb_nt_transact_set_security_info(smb_request_t *, smb_xa_t *);
221 smb_sdrc_t smb_nt_transact_ioctl(smb_request_t *, smb_xa_t *);
222 smb_sdrc_t smb_nt_transact_rename(smb_request_t *, smb_xa_t *);
223 smb_sdrc_t smb_nt_transact_query_quota(smb_request_t *, smb_xa_t *);
224 smb_sdrc_t smb_nt_transact_set_quota(smb_request_t *, smb_xa_t *);
225 
226 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *);
227 smb_sdrc_t smb_com_trans2_create_directory(smb_request_t *, smb_xa_t *);
228 smb_sdrc_t smb_com_trans2_find_first2(smb_request_t *, smb_xa_t *);
229 smb_sdrc_t smb_com_trans2_find_next2(smb_request_t *, smb_xa_t *);
230 smb_sdrc_t smb_com_trans2_query_fs_information(smb_request_t *, smb_xa_t *);
231 smb_sdrc_t smb_com_trans2_set_fs_information(smb_request_t *, smb_xa_t *);
232 smb_sdrc_t smb_com_trans2_query_path_information(smb_request_t *, smb_xa_t *);
233 smb_sdrc_t smb_com_trans2_query_file_information(smb_request_t *, smb_xa_t *);
234 smb_sdrc_t smb_com_trans2_set_path_information(smb_request_t *, smb_xa_t *);
235 smb_sdrc_t smb_com_trans2_set_file_information(smb_request_t *, smb_xa_t *);
236 smb_sdrc_t smb_com_trans2_get_dfs_referral(smb_request_t *, smb_xa_t *);
237 int smb_trans2_rename(smb_request_t *, smb_node_t *, char *, int);
238 
239 uint32_t smb_quota_query_user_quota(smb_request_t *, uid_t, smb_quota_t *);
240 
241 /*
242  * Logging functions
243  */
244 void smb_log_flush(void);
245 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
246 void smb_close_all_connections(void);
247 
248 int smb_net_id(uint32_t);
249 
250 /*
251  * oplock functions - node operations
252  */
253 int smb_oplock_init(void);
254 void smb_oplock_fini(void);
255 void smb_oplock_acquire(smb_request_t *sr, smb_node_t *, smb_ofile_t *);
256 void smb_oplock_release(smb_node_t *, smb_ofile_t *);
257 int smb_oplock_break(smb_request_t *, smb_node_t *, uint32_t);
258 void smb_oplock_break_levelII(smb_node_t *);
259 void smb_oplock_ack(smb_node_t *, smb_ofile_t *, uint8_t);
260 void smb_oplock_broadcast(smb_node_t *);
261 
262 /*
263  * range lock functions - node operations
264  */
265 uint32_t smb_lock_get_lock_count(smb_node_t *, smb_ofile_t *);
266 uint32_t smb_unlock_range(smb_request_t *, smb_node_t *,
267     uint64_t, uint64_t);
268 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
269     uint32_t locktype);
270 void smb_lock_range_error(smb_request_t *, uint32_t);
271 DWORD smb_nbl_conflict(smb_node_t *, uint64_t, uint64_t, nbl_op_t);
272 
273 void smb_mangle(const char *, ino64_t, char *, size_t);
274 int smb_unmangle(smb_node_t *, char *, char *, int, uint32_t);
275 boolean_t smb_needs_mangled(const char *);
276 boolean_t smb_maybe_mangled(char *);
277 boolean_t smb_is_reserved_dos_name(const char *);
278 boolean_t smb_is_invalid_filename(const char *);
279 
280 void smbsr_cleanup(smb_request_t *sr);
281 
282 int smbsr_connect_tree(smb_request_t *);
283 
284 int smb_common_create_directory(smb_request_t *);
285 
286 void	smb_convert_wildcards(char *);
287 boolean_t smb_contains_wildcards(const char *);
288 int	smb_ascii_or_unicode_strlen(smb_request_t *, char *);
289 int	smb_ascii_or_unicode_strlen_null(smb_request_t *, char *);
290 int	smb_ascii_or_unicode_null_len(smb_request_t *);
291 
292 int	smb_search(smb_request_t *);
293 
294 uint32_t smb_common_create(smb_request_t *);
295 uint32_t smb_common_open(smb_request_t *);
296 int smb_common_write(smb_request_t *, smb_rw_param_t *);
297 
298 void smb_pathname_init(smb_request_t *, smb_pathname_t *, char *);
299 boolean_t smb_pathname_validate(smb_request_t *, smb_pathname_t *);
300 boolean_t smb_validate_dirname(smb_request_t *, smb_pathname_t *);
301 boolean_t smb_validate_object_name(smb_request_t *, smb_pathname_t *);
302 boolean_t smb_validate_stream_name(smb_request_t *, smb_pathname_t *);
303 boolean_t smb_is_stream_name(char *);
304 void smb_stream_parse_name(char *, char *, char *);
305 
306 
307 uint32_t smb_omode_to_amask(uint32_t desired_access);
308 
309 void	sshow_distribution_info(char *);
310 
311 void	smb_dispatch_stats_init(smb_server_t *);
312 void	smb_dispatch_stats_fini(smb_server_t *);
313 void	smb_dispatch_stats_update(smb_server_t *,
314 		smb_kstat_req_t *, int, int);
315 
316 boolean_t smb_dispatch_request(smb_request_t *);
317 int	smbsr_encode_empty_result(smb_request_t *);
318 void	smbsr_lookup_file(smb_request_t *);
319 void	smbsr_release_file(smb_request_t *);
320 
321 int	smbsr_decode_vwv(smb_request_t *sr, char *fmt, ...);
322 int	smbsr_decode_data(smb_request_t *sr, char *fmt, ...);
323 boolean_t smbsr_decode_data_avail(smb_request_t *);
324 int	smbsr_encode_result(smb_request_t *, int, int, char *, ...);
325 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
326 void	smbsr_send_reply(smb_request_t *);
327 
328 void	smbsr_map_errno(int, smb_error_t *);
329 void	smbsr_set_error(smb_request_t *, smb_error_t *);
330 void	smbsr_errno(smb_request_t *, int);
331 void	smbsr_status(smb_request_t *, DWORD, uint16_t, uint16_t);
332 #define	smbsr_error(SR, ST, CL, CO) \
333 	smbsr_status(SR, ST, CL, CO)
334 #define	smbsr_warn(SR, ST, CL, CO) \
335 	smbsr_status(SR, ST, CL, CO)
336 
337 int	clock_get_milli_uptime(void);
338 
339 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
340 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
341 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
342 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
343 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
344 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
345 int	smb_mbc_put_mem(mbuf_chain_t *, void *, int);
346 int	smb_mbc_copy(mbuf_chain_t *, const mbuf_chain_t *, int, int);
347 
348 void	smbsr_encode_header(smb_request_t *sr, int wct,
349 		    int bcc, char *fmt, ...);
350 
351 int smb_lock_range_access(smb_request_t *, smb_node_t *,
352     uint64_t, uint64_t, boolean_t);
353 
354 void smb_encode_sid(smb_xa_t *, smb_sid_t *);
355 smb_sid_t *smb_decode_sid(smb_xa_t *, uint32_t);
356 uint32_t smb_decode_sd(smb_xa_t *, smb_sd_t *);
357 
358 uint32_t smb_pad_align(uint32_t, uint32_t);
359 
360 /*
361  * Socket functions
362  */
363 ksocket_t smb_socreate(int domain, int type, int protocol);
364 void smb_soshutdown(ksocket_t so);
365 void smb_sodestroy(ksocket_t so);
366 int smb_sorecv(ksocket_t so, void *msg, size_t len);
367 void smb_net_init(void);
368 void smb_net_fini(void);
369 void smb_net_txl_constructor(smb_txlst_t *);
370 void smb_net_txl_destructor(smb_txlst_t *);
371 smb_txreq_t *smb_net_txr_alloc(void);
372 void smb_net_txr_free(smb_txreq_t *);
373 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
374 
375 /*
376  * SMB RPC interface
377  */
378 void smb_opipe_dealloc(smb_opipe_t *);
379 int smb_opipe_open(smb_request_t *, uint32_t);
380 void smb_opipe_close(smb_ofile_t *);
381 int smb_opipe_read(smb_request_t *, struct uio *);
382 int smb_opipe_write(smb_request_t *, struct uio *);
383 int smb_opipe_get_nread(smb_request_t *, int *);
384 
385 void smb_opipe_door_init(smb_server_t *);
386 void smb_opipe_door_fini(smb_server_t *);
387 int smb_opipe_door_open(smb_server_t *, int);
388 void smb_opipe_door_close(smb_server_t *);
389 int smb_opipe_door_call(smb_opipe_t *);
390 void fksmb_opipe_door_open(smb_server_t *, void *);
391 
392 void smb_kdoor_init(smb_server_t *);
393 void smb_kdoor_fini(smb_server_t *);
394 int smb_kdoor_open(smb_server_t *, int);
395 void smb_kdoor_close(smb_server_t *);
396 int smb_kdoor_upcall(smb_server_t *, uint32_t,
397 	void *, xdrproc_t, void *, xdrproc_t);
398 void fksmb_kdoor_open(smb_server_t *, void *);
399 
400 /*
401  * SMB server functions (file smb_server.c)
402  */
403 int smb_server_g_init(void);
404 int smb_server_g_fini(void);
405 int smb_server_create(void);
406 int smb_server_delete(void);
407 int smb_server_configure(smb_ioc_cfg_t *);
408 int smb_server_start(smb_ioc_start_t *);
409 int smb_server_stop(void);
410 boolean_t smb_server_is_stopping(smb_server_t *);
411 void smb_server_cancel_event(smb_server_t *, uint32_t);
412 int smb_server_notify_event(smb_ioc_event_t *);
413 uint32_t smb_server_get_session_count(smb_server_t *);
414 int smb_server_set_gmtoff(smb_ioc_gmt_t *);
415 int smb_server_numopen(smb_ioc_opennum_t *);
416 int smb_server_enum(smb_ioc_svcenum_t *);
417 int smb_server_session_close(smb_ioc_session_t *);
418 int smb_server_file_close(smb_ioc_fileid_t *);
419 int smb_server_sharevp(smb_server_t *, const char *, vnode_t **);
420 int smb_server_unshare(const char *);
421 
422 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
423 
424 int smb_server_spooldoc(smb_ioc_spooldoc_t *);
425 int smb_spool_add_doc(smb_tree_t *, smb_kspooldoc_t *);
426 void smb_spool_add_fid(smb_server_t *, uint16_t);
427 
428 void smb_server_inc_nbt_sess(smb_server_t *);
429 void smb_server_dec_nbt_sess(smb_server_t *);
430 void smb_server_inc_tcp_sess(smb_server_t *);
431 void smb_server_dec_tcp_sess(smb_server_t *);
432 void smb_server_inc_users(smb_server_t *);
433 void smb_server_dec_users(smb_server_t *);
434 void smb_server_inc_trees(smb_server_t *);
435 void smb_server_dec_trees(smb_server_t *);
436 void smb_server_inc_files(smb_server_t *);
437 void smb_server_dec_files(smb_server_t *);
438 void smb_server_inc_pipes(smb_server_t *);
439 void smb_server_dec_pipes(smb_server_t *);
440 void smb_server_add_rxb(smb_server_t *, int64_t);
441 void smb_server_add_txb(smb_server_t *, int64_t);
442 void smb_server_inc_req(smb_server_t *);
443 
444 smb_event_t *smb_event_create(smb_server_t *, int);
445 void smb_event_destroy(smb_event_t *);
446 uint32_t smb_event_txid(smb_event_t *);
447 int smb_event_wait(smb_event_t *);
448 void smb_event_notify(smb_server_t *, uint32_t);
449 
450 /*
451  * SMB node functions (file smb_node.c)
452  */
453 void smb_node_init(void);
454 void smb_node_fini(void);
455 smb_node_t *smb_node_lookup(smb_request_t *, smb_arg_open_t *,
456     cred_t *, vnode_t *, char *, smb_node_t *, smb_node_t *);
457 smb_node_t *smb_stream_node_lookup(smb_request_t *, cred_t *,
458     smb_node_t *, vnode_t *, vnode_t *, char *);
459 
460 void smb_node_ref(smb_node_t *);
461 void smb_node_release(smb_node_t *);
462 void smb_node_rename(smb_node_t *, smb_node_t *, smb_node_t *, char *);
463 int smb_node_root_init(smb_server_t *, smb_node_t **);
464 void smb_node_add_lock(smb_node_t *, smb_lock_t *);
465 void smb_node_destroy_lock(smb_node_t *, smb_lock_t *);
466 void smb_node_destroy_lock_by_ofile(smb_node_t *, smb_ofile_t *);
467 void smb_node_start_crit(smb_node_t *, krw_t);
468 void smb_node_end_crit(smb_node_t *);
469 int smb_node_in_crit(smb_node_t *);
470 void smb_node_rdlock(smb_node_t *);
471 void smb_node_wrlock(smb_node_t *);
472 void smb_node_unlock(smb_node_t *);
473 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
474 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
475 void smb_node_inc_open_ofiles(smb_node_t *);
476 uint32_t smb_node_dec_open_ofiles(smb_node_t *);
477 void smb_node_inc_opening_count(smb_node_t *);
478 void smb_node_dec_opening_count(smb_node_t *);
479 boolean_t smb_node_is_file(smb_node_t *);
480 boolean_t smb_node_is_dir(smb_node_t *);
481 boolean_t smb_node_is_symlink(smb_node_t *);
482 boolean_t smb_node_is_dfslink(smb_node_t *);
483 boolean_t smb_node_is_reparse(smb_node_t *);
484 boolean_t smb_node_is_vfsroot(smb_node_t *);
485 boolean_t smb_node_is_system(smb_node_t *);
486 
487 uint32_t smb_node_open_check(smb_node_t *, uint32_t, uint32_t);
488 DWORD smb_node_rename_check(smb_node_t *);
489 DWORD smb_node_delete_check(smb_node_t *);
490 boolean_t smb_node_share_check(smb_node_t *);
491 
492 void smb_node_fcn_subscribe(smb_node_t *, smb_request_t *);
493 void smb_node_fcn_unsubscribe(smb_node_t *, smb_request_t *);
494 void smb_node_notify_change(smb_node_t *, uint_t, const char *);
495 void smb_node_notify_parents(smb_node_t *);
496 int smb_node_getattr(smb_request_t *, smb_node_t *, cred_t *,
497     smb_ofile_t *, smb_attr_t *);
498 int smb_node_setattr(smb_request_t *, smb_node_t *, cred_t *,
499     smb_ofile_t *, smb_attr_t *);
500 uint32_t smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t);
501 void smb_node_reset_delete_on_close(smb_node_t *);
502 boolean_t smb_node_file_is_readonly(smb_node_t *);
503 int smb_node_getpath(smb_node_t *, vnode_t *, char *, uint32_t);
504 int smb_node_getmntpath(smb_node_t *, char *, uint32_t);
505 int smb_node_getshrpath(smb_node_t *, smb_tree_t *, char *, uint32_t);
506 
507 /*
508  * Pathname functions
509  */
510 
511 int smb_pathname_reduce(smb_request_t *, cred_t *,
512     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
513 
514 int smb_pathname(smb_request_t *, char *, int, smb_node_t *,
515     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
516 
517 /*
518  * smb_vfs functions
519  */
520 
521 int smb_vfs_hold(smb_export_t *, vfs_t *);
522 void smb_vfs_rele(smb_export_t *, vfs_t *);
523 void smb_vfs_rele_all(smb_export_t *);
524 
525 /* NOTIFY CHANGE */
526 
527 void smb_notify_event(smb_node_t *, uint_t, const char *);
528 void smb_notify_file_closed(smb_ofile_t *of);
529 
530 int smb_fem_fcn_install(smb_node_t *);
531 void smb_fem_fcn_uninstall(smb_node_t *);
532 int smb_fem_oplock_install(smb_node_t *);
533 void smb_fem_oplock_uninstall(smb_node_t *);
534 
535 /* FEM */
536 
537 int smb_fem_init(void);
538 void smb_fem_fini(void);
539 
540 int smb_try_grow(smb_request_t *sr, int64_t new_size);
541 
542 unsigned short smb_worker_getnum();
543 
544 /* SMB signing routines smb_signing.c */
545 int smb_sign_begin(smb_request_t *, smb_token_t *);
546 int smb_sign_check_request(smb_request_t *);
547 int smb_sign_check_secondary(smb_request_t *, unsigned int);
548 void smb_sign_reply(smb_request_t *, mbuf_chain_t *);
549 
550 boolean_t smb_sattr_check(uint16_t, uint16_t);
551 
552 void smb_request_cancel(smb_request_t *);
553 void smb_request_wait(smb_request_t *);
554 
555 /*
556  * session functions (file smb_session.c)
557  */
558 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
559 void smb_session_receiver(smb_session_t *);
560 void smb_session_disconnect(smb_session_t *);
561 void smb_session_timers(smb_llist_t *);
562 void smb_session_delete(smb_session_t *session);
563 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
564     smb_request_t *);
565 void smb_session_config(smb_session_t *session);
566 void smb_session_disconnect_from_share(smb_llist_t *, char *);
567 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
568 smb_user_t *smb_session_lookup_uid(smb_session_t *, uint16_t);
569 void smb_session_post_user(smb_session_t *, smb_user_t *);
570 void smb_session_post_tree(smb_session_t *, smb_tree_t *);
571 smb_tree_t *smb_session_lookup_tree(smb_session_t *, uint16_t);
572 smb_tree_t *smb_session_lookup_share(smb_session_t *, const char *,
573     smb_tree_t *);
574 smb_tree_t *smb_session_lookup_volume(smb_session_t *, const char *,
575     smb_tree_t *);
576 void smb_session_close_pid(smb_session_t *, uint16_t);
577 void smb_session_disconnect_owned_trees(smb_session_t *, smb_user_t *);
578 void smb_session_disconnect_trees(smb_session_t *);
579 void smb_session_disconnect_share(smb_session_t *, const char *);
580 void smb_session_getclient(smb_session_t *, char *, size_t);
581 boolean_t smb_session_isclient(smb_session_t *, const char *);
582 void smb_session_correct_keep_alive_values(smb_llist_t *, uint32_t);
583 void smb_session_oplock_break(smb_session_t *, uint16_t, uint16_t, uint8_t);
584 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
585 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
586 boolean_t smb_session_oplocks_enable(smb_session_t *);
587 boolean_t smb_session_levelII_oplocks(smb_session_t *);
588 
589 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
590 
591 smb_request_t *smb_request_alloc(smb_session_t *, int);
592 void smb_request_free(smb_request_t *);
593 
594 /*
595  * ofile functions (file smb_ofile.c)
596  */
597 smb_ofile_t *smb_ofile_lookup_by_fid(smb_request_t *, uint16_t);
598 smb_ofile_t *smb_ofile_lookup_by_uniqid(smb_tree_t *, uint32_t);
599 boolean_t smb_ofile_disallow_fclose(smb_ofile_t *);
600 smb_ofile_t *smb_ofile_open(smb_request_t *, smb_node_t *,
601     smb_arg_open_t *, uint16_t, uint32_t, smb_error_t *);
602 void smb_ofile_close(smb_ofile_t *, int32_t);
603 void smb_ofile_delete(void *);
604 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
605 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
606 boolean_t smb_ofile_hold(smb_ofile_t *);
607 void smb_ofile_release(smb_ofile_t *);
608 void smb_ofile_request_complete(smb_ofile_t *);
609 void smb_ofile_close_all(smb_tree_t *);
610 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
611 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
612 boolean_t smb_ofile_is_open(smb_ofile_t *);
613 int smb_ofile_enum(smb_ofile_t *, smb_svcenum_t *);
614 uint32_t smb_ofile_open_check(smb_ofile_t *, uint32_t, uint32_t);
615 uint32_t smb_ofile_rename_check(smb_ofile_t *);
616 uint32_t smb_ofile_delete_check(smb_ofile_t *);
617 boolean_t smb_ofile_share_check(smb_ofile_t *);
618 cred_t *smb_ofile_getcred(smb_ofile_t *);
619 void smb_ofile_set_delete_on_close(smb_ofile_t *);
620 void smb_delayed_write_timer(smb_llist_t *);
621 void smb_ofile_set_quota_resume(smb_ofile_t *, char *);
622 void smb_ofile_get_quota_resume(smb_ofile_t *, char *, int);
623 
624 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
625 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
626 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
627 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
628 
629 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
630 
631 /*
632  * odir functions (file smb_odir.c)
633  */
634 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t, uint32_t);
635 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
636 void smb_odir_close(smb_odir_t *);
637 boolean_t smb_odir_hold(smb_odir_t *);
638 void smb_odir_release(smb_odir_t *);
639 void smb_odir_delete(void *);
640 
641 int smb_odir_read(smb_request_t *, smb_odir_t *,
642     smb_odirent_t *, boolean_t *);
643 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
644     smb_fileinfo_t *, uint16_t *);
645 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
646     smb_streaminfo_t *, boolean_t *);
647 
648 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
649 void smb_odir_save_fname(smb_odir_t *, uint32_t, const char *);
650 
651 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
652 
653 /*
654  * SMB user functions (file smb_user.c)
655  */
656 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
657     char *, char *, uint32_t, uint32_t, uint32_t);
658 smb_user_t *smb_user_dup(smb_user_t *);
659 void smb_user_logoff(smb_user_t *);
660 void smb_user_delete(void *);
661 boolean_t smb_user_is_admin(smb_user_t *);
662 boolean_t smb_user_namecmp(smb_user_t *, const char *);
663 int smb_user_enum(smb_user_t *, smb_svcenum_t *);
664 boolean_t smb_user_hold(smb_user_t *);
665 void smb_user_hold_internal(smb_user_t *);
666 void smb_user_release(smb_user_t *);
667 cred_t *smb_user_getcred(smb_user_t *);
668 cred_t *smb_user_getprivcred(smb_user_t *);
669 void smb_user_netinfo_init(smb_user_t *, smb_netuserinfo_t *);
670 void smb_user_netinfo_fini(smb_netuserinfo_t *);
671 int smb_user_netinfo_encode(smb_user_t *, uint8_t *, size_t, uint32_t *);
672 smb_token_t *smb_get_token(smb_session_t *, smb_logon_t *);
673 cred_t *smb_cred_create(smb_token_t *);
674 void smb_user_setcred(smb_user_t *, cred_t *, uint32_t);
675 
676 /*
677  * SMB tree functions (file smb_tree.c)
678  */
679 smb_tree_t *smb_tree_connect(smb_request_t *);
680 void smb_tree_disconnect(smb_tree_t *, boolean_t);
681 void smb_tree_dealloc(void *);
682 void smb_tree_post_ofile(smb_tree_t *, smb_ofile_t *);
683 void smb_tree_post_odir(smb_tree_t *, smb_odir_t *);
684 void smb_tree_close_pid(smb_tree_t *, uint16_t);
685 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
686 int smb_tree_enum(smb_tree_t *, smb_svcenum_t *);
687 int smb_tree_fclose(smb_tree_t *, uint32_t);
688 boolean_t smb_tree_hold(smb_tree_t *);
689 void smb_tree_release(smb_tree_t *);
690 smb_odir_t *smb_tree_lookup_odir(smb_request_t *, uint16_t);
691 boolean_t smb_tree_is_connected(smb_tree_t *);
692 #define	SMB_TREE_GET_TID(tree)		((tree)->t_tid)
693 
694 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
695     uint32_t total_parameter_count, uint32_t total_data_count,
696     uint32_t max_parameter_count, uint32_t max_data_count,
697     uint32_t max_setup_count, uint32_t setup_word_count);
698 void smb_xa_delete(smb_xa_t *xa);
699 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
700 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
701 int smb_xa_open(smb_xa_t *xa);
702 void smb_xa_close(smb_xa_t *xa);
703 int smb_xa_complete(smb_xa_t *xa);
704 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
705 
706 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
707 struct mbuf *smb_mbuf_allocate(struct uio *uio);
708 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
709 
710 void smb_check_status(void);
711 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
712 
713 int32_t smb_time_gmt_to_local(smb_request_t *, int32_t);
714 int32_t smb_time_local_to_gmt(smb_request_t *, int32_t);
715 int32_t	smb_time_dos_to_unix(int16_t, int16_t);
716 void smb_time_unix_to_dos(int32_t, int16_t *, int16_t *);
717 void smb_time_nt_to_unix(uint64_t nt_time, timestruc_t *unix_time);
718 uint64_t smb_time_unix_to_nt(timestruc_t *);
719 
720 int netbios_name_isvalid(char *in, char *out);
721 
722 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
723 
724 /*
725  * Pool ID function prototypes
726  */
727 int	smb_idpool_constructor(smb_idpool_t *pool);
728 void	smb_idpool_destructor(smb_idpool_t  *pool);
729 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
730 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
731 
732 /*
733  * SMB thread function prototypes
734  */
735 void	smb_session_worker(void *arg);
736 
737 /*
738  * SMB locked list function prototypes
739  */
740 void	smb_llist_init(void);
741 void	smb_llist_fini(void);
742 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
743 void	smb_llist_destructor(smb_llist_t *);
744 void	smb_llist_exit(smb_llist_t *);
745 void	smb_llist_post(smb_llist_t *, void *, smb_dtorproc_t);
746 void	smb_llist_flush(smb_llist_t *);
747 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
748 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
749 void	smb_llist_remove(smb_llist_t *ll, void *obj);
750 int	smb_llist_upgrade(smb_llist_t *ll);
751 uint32_t smb_llist_get_count(smb_llist_t *ll);
752 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
753 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
754 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
755 int	smb_account_connected(smb_user_t *user);
756 
757 /*
758  * SMB Synchronized list function prototypes
759  */
760 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
761 void	smb_slist_destructor(smb_slist_t *);
762 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
763 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
764 void	smb_slist_remove(smb_slist_t *sl, void *obj);
765 void	smb_slist_wait_for_empty(smb_slist_t *sl);
766 void	smb_slist_exit(smb_slist_t *sl);
767 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
768 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
769 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
770 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
771 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
772 
773 void    smb_rwx_init(smb_rwx_t *rwx);
774 void    smb_rwx_destroy(smb_rwx_t *rwx);
775 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
776 void    smb_rwx_rwexit(smb_rwx_t *rwx);
777 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
778 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
779 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
780 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
781 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
782 
783 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t,
784 		void *, pri_t);
785 void	smb_thread_destroy(smb_thread_t *);
786 int	smb_thread_start(smb_thread_t *);
787 void	smb_thread_stop(smb_thread_t *);
788 void    smb_thread_signal(smb_thread_t *);
789 boolean_t smb_thread_continue(smb_thread_t *);
790 boolean_t smb_thread_continue_nowait(smb_thread_t *);
791 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
792 
793 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
794 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
795 
796 /* 100's of ns between 1/1/1970 and 1/1/1601 */
797 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
798 
799 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
800 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
801 
802 acl_t *smb_fsacl_inherit(acl_t *, int, int, cred_t *);
803 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
804 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
805 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
806 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
807 
808 boolean_t smb_ace_is_generic(int);
809 boolean_t smb_ace_is_access(int);
810 boolean_t smb_ace_is_audit(int);
811 
812 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
813 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
814     char *, smb_node_t **, smb_node_t **);
815 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
816 
817 void smb_panic(char *, const char *, int);
818 #pragma	does_not_return(smb_panic)
819 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
820 
821 void smb_latency_init(smb_latency_t *);
822 void smb_latency_destroy(smb_latency_t *);
823 void smb_latency_add_sample(smb_latency_t *, hrtime_t);
824 void smb_srqueue_init(smb_srqueue_t *);
825 void smb_srqueue_destroy(smb_srqueue_t *);
826 void smb_srqueue_waitq_enter(smb_srqueue_t *);
827 void smb_srqueue_runq_exit(smb_srqueue_t *);
828 void smb_srqueue_waitq_to_runq(smb_srqueue_t *);
829 void smb_srqueue_update(smb_srqueue_t *, smb_kstat_utilization_t *);
830 
831 void *smb_mem_alloc(size_t);
832 void *smb_mem_zalloc(size_t);
833 void *smb_mem_realloc(void *, size_t);
834 void *smb_mem_rezalloc(void *, size_t);
835 void smb_mem_free(void *);
836 void smb_mem_zfree(void *);
837 char *smb_mem_strdup(const char *);
838 void smb_srm_init(smb_request_t *);
839 void smb_srm_fini(smb_request_t *);
840 void *smb_srm_alloc(smb_request_t *, size_t);
841 void *smb_srm_zalloc(smb_request_t *, size_t);
842 void *smb_srm_realloc(smb_request_t *, void *, size_t);
843 void *smb_srm_rezalloc(smb_request_t *, void *, size_t);
844 char *smb_srm_strdup(smb_request_t *, const char *);
845 
846 void smb_export_start(smb_server_t *);
847 void smb_export_stop(smb_server_t *);
848 
849 #ifdef	_KERNEL
850 struct __door_handle;
851 struct __door_handle *smb_kshare_door_init(int);
852 void smb_kshare_door_fini(struct __door_handle *);
853 int smb_kshare_upcall(struct __door_handle *, void *, boolean_t);
854 #endif	/* _KERNEL */
855 
856 void smb_kshare_g_init(void);
857 void smb_kshare_g_fini(void);
858 void smb_kshare_init(smb_server_t *);
859 void smb_kshare_fini(smb_server_t *);
860 int smb_kshare_start(smb_server_t *);
861 void smb_kshare_stop(smb_server_t *);
862 
863 int smb_kshare_export_list(smb_ioc_share_t *);
864 int smb_kshare_unexport_list(smb_ioc_share_t *);
865 int smb_kshare_info(smb_ioc_shareinfo_t *);
866 void smb_kshare_enum(smb_server_t *, smb_enumshare_info_t *);
867 smb_kshare_t *smb_kshare_lookup(smb_server_t *, const char *);
868 void smb_kshare_release(smb_server_t *, smb_kshare_t *);
869 int smb_kshare_exec(smb_server_t *, smb_shr_execinfo_t *);
870 uint32_t smb_kshare_hostaccess(smb_kshare_t *, smb_session_t *);
871 
872 
873 void smb_avl_create(smb_avl_t *, size_t, size_t, const smb_avl_nops_t *);
874 void smb_avl_destroy(smb_avl_t *);
875 int smb_avl_add(smb_avl_t *, void *);
876 void smb_avl_remove(smb_avl_t *, void *);
877 void *smb_avl_lookup(smb_avl_t *, void *);
878 void smb_avl_release(smb_avl_t *, void *);
879 void smb_avl_iterinit(smb_avl_t *, smb_avl_cursor_t *);
880 void *smb_avl_iterate(smb_avl_t *, smb_avl_cursor_t *);
881 
882 void smb_threshold_init(smb_cmd_threshold_t *,
883     char *, uint_t, uint_t);
884 void smb_threshold_fini(smb_cmd_threshold_t *);
885 int smb_threshold_enter(smb_cmd_threshold_t *);
886 void smb_threshold_exit(smb_cmd_threshold_t *);
887 void smb_threshold_wake_all(smb_cmd_threshold_t *);
888 
889 #ifdef	__cplusplus
890 }
891 #endif
892 
893 #endif /* _SMB_KPROTO_H_ */
894