xref: /titanic_41/usr/src/uts/common/smbsrv/smb_kproto.h (revision 1e49577a7fcde812700ded04431b49d67cc57d6d)
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  */
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 smb_sdrc_t smb_nt_transact_query_quota(smb_request_t *, smb_xa_t *);
173 smb_sdrc_t smb_nt_transact_set_quota(smb_request_t *, smb_xa_t *);
174 
175 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *);
176 smb_sdrc_t smb_com_trans2_create_directory(smb_request_t *, smb_xa_t *);
177 smb_sdrc_t smb_com_trans2_find_first2(smb_request_t *, smb_xa_t *);
178 smb_sdrc_t smb_com_trans2_find_next2(smb_request_t *, smb_xa_t *);
179 smb_sdrc_t smb_com_trans2_query_fs_information(smb_request_t *, smb_xa_t *);
180 smb_sdrc_t smb_com_trans2_set_fs_information(smb_request_t *, smb_xa_t *);
181 smb_sdrc_t smb_com_trans2_query_path_information(smb_request_t *, smb_xa_t *);
182 smb_sdrc_t smb_com_trans2_query_file_information(smb_request_t *, smb_xa_t *);
183 smb_sdrc_t smb_com_trans2_set_path_information(smb_request_t *, smb_xa_t *);
184 smb_sdrc_t smb_com_trans2_set_file_information(smb_request_t *, smb_xa_t *);
185 smb_sdrc_t smb_com_trans2_get_dfs_referral(smb_request_t *, smb_xa_t *);
186 int smb_trans2_rename(smb_request_t *, smb_node_t *, char *, int);
187 
188 uint32_t smb_quota_query_user_quota(smb_request_t *, uid_t, smb_quota_t *);
189 
190 /*
191  * Logging functions
192  */
193 void smb_log_flush(void);
194 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
195 void smb_close_all_connections(void);
196 
197 int smb_net_id(uint32_t);
198 
199 void smb_process_file_notify_change_queue(smb_ofile_t *of);
200 
201 void smb_oplock_acquire(smb_node_t *, smb_ofile_t *, smb_arg_open_t *);
202 boolean_t smb_oplock_break(smb_node_t *, smb_session_t *, boolean_t);
203 void smb_oplock_release(smb_node_t *, smb_ofile_t *);
204 boolean_t smb_oplock_conflict(smb_node_t *, smb_session_t *, smb_arg_open_t *);
205 boolean_t smb_oplock_broadcast(smb_node_t *);
206 
207 /*
208  * macros used in oplock processing
209  *
210  * SMB_ATTR_ONLY_OPEN: Checks to see if this is
211  * an attribute-only open with no contravening
212  * dispositions.  Such an open cannot effect an
213  * oplock break.  However, a contravening disposition
214  * of FILE_SUPERSEDE or FILE_OVERWRITE can allow
215  * an oplock break.
216  */
217 
218 #define	SMB_ATTR_ONLY_OPEN(op)					\
219 	((op) && (op)->desired_access &&			\
220 	(((op)->desired_access & ~(FILE_READ_ATTRIBUTES |	\
221 	FILE_WRITE_ATTRIBUTES | SYNCHRONIZE)) == 0) &&		\
222 	((op)->create_disposition != FILE_SUPERSEDE) &&		\
223 	((op)->create_disposition != FILE_OVERWRITE))		\
224 
225 uint32_t smb_lock_get_lock_count(smb_node_t *, smb_ofile_t *);
226 uint32_t smb_unlock_range(smb_request_t *, smb_node_t *,
227     uint64_t, uint64_t);
228 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
229     uint32_t locktype);
230 void smb_lock_range_error(smb_request_t *, uint32_t);
231 
232 DWORD smb_range_check(smb_request_t *, smb_node_t *, uint64_t, uint64_t,
233     boolean_t);
234 
235 void smb_mangle(const char *, ino64_t, char *, size_t);
236 int smb_unmangle(smb_node_t *, char *, char *, int, uint32_t);
237 boolean_t smb_needs_mangled(const char *);
238 boolean_t smb_maybe_mangled(char *);
239 boolean_t smb_is_invalid_filename(const char *);
240 boolean_t smb_match_name(ino64_t, char *, char *);
241 
242 void smbsr_cleanup(smb_request_t *sr);
243 
244 int smbsr_connect_tree(smb_request_t *);
245 
246 int smb_common_create_directory(smb_request_t *);
247 
248 void	smb_convert_wildcards(char *);
249 boolean_t smb_contains_wildcards(const char *);
250 int	smb_ascii_or_unicode_strlen(smb_request_t *, char *);
251 int	smb_ascii_or_unicode_strlen_null(smb_request_t *, char *);
252 int	smb_ascii_or_unicode_null_len(smb_request_t *);
253 
254 int	smb_search(smb_request_t *);
255 
256 uint32_t smb_common_create(smb_request_t *);
257 uint32_t smb_common_open(smb_request_t *);
258 int smb_common_write(smb_request_t *, smb_rw_param_t *);
259 
260 void smb_pathname_init(smb_request_t *, smb_pathname_t *, char *);
261 boolean_t smb_pathname_validate(smb_request_t *, smb_pathname_t *);
262 boolean_t smb_validate_dirname(smb_request_t *, smb_pathname_t *);
263 boolean_t smb_validate_object_name(smb_request_t *, smb_pathname_t *);
264 boolean_t smb_validate_stream_name(smb_request_t *, smb_pathname_t *);
265 boolean_t smb_is_stream_name(char *);
266 void smb_stream_parse_name(char *, char *, char *);
267 
268 
269 uint32_t smb_omode_to_amask(uint32_t desired_access);
270 
271 void	sshow_distribution_info(char *);
272 
273 void	smb_dispatch_stats_init(smb_kstat_req_t *);
274 void	smb_dispatch_stats_fini(void);
275 void	smb_dispatch_stats_update(smb_kstat_req_t *, int, int);
276 
277 boolean_t smb_dispatch_request(smb_request_t *);
278 int	smbsr_encode_empty_result(smb_request_t *);
279 void	smbsr_lookup_file(smb_request_t *);
280 void	smbsr_release_file(smb_request_t *);
281 
282 int	smbsr_decode_vwv(smb_request_t *sr, char *fmt, ...);
283 int	smbsr_decode_data(smb_request_t *sr, char *fmt, ...);
284 boolean_t smbsr_decode_data_avail(smb_request_t *);
285 int	smbsr_encode_result(smb_request_t *, int, int, char *, ...);
286 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
287 void	smbsr_send_reply(smb_request_t *);
288 
289 void	smbsr_map_errno(int, smb_error_t *);
290 void	smbsr_set_error(smb_request_t *, smb_error_t *);
291 void	smbsr_errno(smb_request_t *, int);
292 void	smbsr_status(smb_request_t *, DWORD, uint16_t, uint16_t);
293 #define	smbsr_error(SR, ST, CL, CO) \
294 	smbsr_status(SR, ST, CL, CO)
295 #define	smbsr_warn(SR, ST, CL, CO) \
296 	smbsr_status(SR, ST, CL, CO)
297 
298 int	clock_get_milli_uptime(void);
299 
300 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
301 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
302 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
303 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
304 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
305 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
306 
307 void	smbsr_encode_header(smb_request_t *sr, int wct,
308 		    int bcc, char *fmt, ...);
309 
310 int smb_lock_range_access(smb_request_t *, smb_node_t *,
311     uint64_t, uint64_t, boolean_t);
312 
313 void smb_encode_sid(smb_xa_t *, smb_sid_t *);
314 smb_sid_t *smb_decode_sid(smb_xa_t *, uint32_t);
315 uint32_t smb_decode_sd(smb_xa_t *, smb_sd_t *);
316 
317 uint32_t smb_pad_align(uint32_t, uint32_t);
318 
319 /*
320  * Socket functions
321  */
322 ksocket_t smb_socreate(int domain, int type, int protocol);
323 void smb_soshutdown(ksocket_t so);
324 void smb_sodestroy(ksocket_t so);
325 int smb_sorecv(ksocket_t so, void *msg, size_t len);
326 int smb_net_init(void);
327 void smb_net_fini(void);
328 void smb_net_txl_constructor(smb_txlst_t *);
329 void smb_net_txl_destructor(smb_txlst_t *);
330 smb_txreq_t *smb_net_txr_alloc(void);
331 void smb_net_txr_free(smb_txreq_t *);
332 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
333 
334 /*
335  * SMB RPC interface
336  */
337 smb_opipe_t *smb_opipe_alloc(smb_server_t *);
338 void smb_opipe_dealloc(smb_opipe_t *);
339 int smb_opipe_open(smb_request_t *);
340 void smb_opipe_close(smb_ofile_t *);
341 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
342 int smb_opipe_read(smb_request_t *, struct uio *);
343 int smb_opipe_write(smb_request_t *, struct uio *);
344 
345 void smb_opipe_door_init(void);
346 void smb_opipe_door_fini(void);
347 int smb_opipe_door_open(int);
348 void smb_opipe_door_close(void);
349 
350 void smb_kdoor_init(void);
351 void smb_kdoor_fini(void);
352 int smb_kdoor_open(int);
353 void smb_kdoor_close(void);
354 int smb_kdoor_upcall(uint32_t, void *, xdrproc_t, void *, xdrproc_t);
355 
356 /*
357  * SMB server functions (file smb_server.c)
358  */
359 int smb_server_svc_init(void);
360 int smb_server_svc_fini(void);
361 int smb_server_create(void);
362 int smb_server_delete(void);
363 int smb_server_configure(smb_ioc_cfg_t *);
364 int smb_server_start(smb_ioc_start_t *);
365 int smb_server_stop(void);
366 boolean_t smb_server_is_stopping(void);
367 int smb_server_cancel_event(uint32_t);
368 int smb_server_notify_event(smb_ioc_event_t *);
369 int smb_server_nbt_listen(smb_ioc_listen_t *);
370 int smb_server_tcp_listen(smb_ioc_listen_t *);
371 int smb_server_nbt_receive(void);
372 int smb_server_tcp_receive(void);
373 uint32_t smb_server_get_session_count(void);
374 int smb_server_set_gmtoff(smb_ioc_gmt_t *);
375 int smb_server_numopen(smb_ioc_opennum_t *);
376 int smb_server_enum(smb_ioc_svcenum_t *);
377 int smb_server_session_close(smb_ioc_session_t *);
378 int smb_server_file_close(smb_ioc_fileid_t *);
379 int smb_server_sharevp(const char *, vnode_t **);
380 int smb_server_unshare(const char *);
381 
382 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
383 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
384 
385 void smb_server_inc_nbt_sess(smb_server_t *);
386 void smb_server_dec_nbt_sess(smb_server_t *);
387 void smb_server_inc_tcp_sess(smb_server_t *);
388 void smb_server_dec_tcp_sess(smb_server_t *);
389 void smb_server_inc_users(smb_server_t *);
390 void smb_server_dec_users(smb_server_t *);
391 void smb_server_inc_trees(smb_server_t *);
392 void smb_server_dec_trees(smb_server_t *);
393 void smb_server_inc_files(smb_server_t *);
394 void smb_server_dec_files(smb_server_t *);
395 void smb_server_inc_pipes(smb_server_t *);
396 void smb_server_dec_pipes(smb_server_t *);
397 void smb_server_add_rxb(smb_server_t *, int64_t);
398 void smb_server_add_txb(smb_server_t *, int64_t);
399 void smb_server_inc_req(smb_server_t *);
400 
401 smb_event_t *smb_event_create(void);
402 void smb_event_destroy(smb_event_t *);
403 uint32_t smb_event_txid(smb_event_t *);
404 int smb_event_wait(smb_event_t *);
405 
406 /*
407  * SMB node functions (file smb_node.c)
408  */
409 int smb_node_init(void);
410 void smb_node_fini(void);
411 smb_node_t *smb_node_lookup(smb_request_t *, smb_arg_open_t *,
412     cred_t *, vnode_t *, char *, smb_node_t *, smb_node_t *);
413 smb_node_t *smb_stream_node_lookup(smb_request_t *, cred_t *,
414     smb_node_t *, vnode_t *, vnode_t *, char *);
415 
416 void smb_node_ref(smb_node_t *);
417 void smb_node_release(smb_node_t *);
418 void smb_node_rename(smb_node_t *, smb_node_t *, smb_node_t *, char *);
419 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
420 void smb_node_add_lock(smb_node_t *, smb_lock_t *);
421 void smb_node_destroy_lock(smb_node_t *, smb_lock_t *);
422 void smb_node_destroy_lock_by_ofile(smb_node_t *, smb_ofile_t *);
423 void smb_node_start_crit(smb_node_t *, krw_t);
424 void smb_node_end_crit(smb_node_t *);
425 int smb_node_in_crit(smb_node_t *);
426 void smb_node_rdlock(smb_node_t *);
427 void smb_node_wrlock(smb_node_t *);
428 void smb_node_unlock(smb_node_t *);
429 uint32_t smb_node_get_ofile_count(smb_node_t *);
430 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
431 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
432 void smb_node_inc_open_ofiles(smb_node_t *);
433 void smb_node_dec_open_ofiles(smb_node_t *);
434 boolean_t smb_node_is_file(smb_node_t *);
435 boolean_t smb_node_is_dir(smb_node_t *);
436 boolean_t smb_node_is_symlink(smb_node_t *);
437 boolean_t smb_node_is_dfslink(smb_node_t *);
438 boolean_t smb_node_is_reparse(smb_node_t *);
439 boolean_t smb_node_is_vfsroot(smb_node_t *);
440 boolean_t smb_node_is_system(smb_node_t *);
441 
442 uint32_t smb_node_open_check(smb_node_t *, uint32_t, uint32_t);
443 DWORD smb_node_rename_check(smb_node_t *);
444 DWORD smb_node_delete_check(smb_node_t *);
445 void smb_node_notify_change(smb_node_t *);
446 void smb_node_notify_parents(smb_node_t *);
447 int smb_node_getattr(smb_request_t *, smb_node_t *, smb_attr_t *);
448 int smb_node_setattr(smb_request_t *, smb_node_t *, cred_t *,
449     smb_ofile_t *, smb_attr_t *);
450 int smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t);
451 void smb_node_reset_delete_on_close(smb_node_t *);
452 boolean_t smb_node_file_is_readonly(smb_node_t *);
453 int smb_node_getpath(smb_node_t *, vnode_t *, char *, uint32_t);
454 int smb_node_getmntpath(smb_node_t *, char *, uint32_t);
455 int smb_node_getshrpath(smb_node_t *, smb_tree_t *, char *, uint32_t);
456 
457 /*
458  * Pathname functions
459  */
460 
461 int smb_pathname_reduce(smb_request_t *, cred_t *,
462     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
463 
464 int smb_pathname(smb_request_t *, char *, int, smb_node_t *,
465     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
466 
467 /*
468  * smb_vfs functions
469  */
470 
471 int smb_vfs_hold(smb_export_t *, vfs_t *);
472 void smb_vfs_rele(smb_export_t *, vfs_t *);
473 void smb_vfs_rele_all(smb_export_t *);
474 
475 /* NOTIFY CHANGE */
476 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
477 void smb_process_node_notify_change_queue(smb_node_t *);
478 void smb_reply_specific_cancel_request(smb_request_t *);
479 
480 void smb_fem_fcn_install(smb_node_t *);
481 void smb_fem_fcn_uninstall(smb_node_t *);
482 
483 /* FEM */
484 
485 int smb_fem_init(void);
486 void smb_fem_fini(void);
487 
488 int smb_try_grow(smb_request_t *sr, int64_t new_size);
489 
490 unsigned short smb_worker_getnum();
491 
492 /* SMB signing routines smb_signing.c */
493 void smb_sign_init(smb_request_t *, smb_session_key_t *, char *, int);
494 int smb_sign_check_request(smb_request_t *);
495 int smb_sign_check_secondary(smb_request_t *, unsigned int);
496 void smb_sign_reply(smb_request_t *, mbuf_chain_t *);
497 
498 boolean_t smb_sattr_check(uint16_t, uint16_t);
499 
500 void smb_request_cancel(smb_request_t *);
501 void smb_request_wait(smb_request_t *);
502 
503 /*
504  * session functions (file smb_session.c)
505  */
506 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
507 int smb_session_daemon(smb_session_list_t *);
508 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
509 void smb_session_timers(smb_session_list_t *);
510 void smb_session_delete(smb_session_t *session);
511 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
512     smb_request_t *);
513 void smb_session_config(smb_session_t *session);
514 void smb_session_disconnect_from_share(smb_session_list_t *, char *);
515 void smb_session_list_constructor(smb_session_list_t *);
516 void smb_session_list_destructor(smb_session_list_t *);
517 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
518 void smb_session_list_delete_tail(smb_session_list_t *);
519 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
520 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
521 void smb_session_list_signal(smb_session_list_t *);
522 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
523 smb_user_t *smb_session_lookup_uid(smb_session_t *, uint16_t);
524 void smb_session_post_user(smb_session_t *, smb_user_t *);
525 void smb_session_disconnect_share(smb_session_t *, const char *);
526 void smb_session_getclient(smb_session_t *, char *, size_t);
527 boolean_t smb_session_isclient(smb_session_t *, const char *);
528 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
529 void smb_session_oplock_break(smb_session_t *, smb_ofile_t *);
530 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
531 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
532 boolean_t smb_session_oplocks_enable(smb_session_t *);
533 
534 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
535 
536 smb_request_t *smb_request_alloc(smb_session_t *, int);
537 void smb_request_free(smb_request_t *);
538 
539 /*
540  * ofile functions (file smb_ofile.c)
541  */
542 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
543 smb_ofile_t *smb_ofile_lookup_by_uniqid(smb_tree_t *, uint32_t);
544 boolean_t smb_ofile_disallow_fclose(smb_ofile_t *);
545 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
546     smb_arg_open_t *, uint16_t, uint32_t, smb_error_t *);
547 void smb_ofile_close(smb_ofile_t *, uint32_t);
548 void smb_ofile_delete(void *);
549 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
550 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
551 boolean_t smb_ofile_hold(smb_ofile_t *);
552 void smb_ofile_release(smb_ofile_t *);
553 void smb_ofile_close_all(smb_tree_t *);
554 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
555 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
556 boolean_t smb_ofile_is_open(smb_ofile_t *);
557 int smb_ofile_enum(smb_ofile_t *, smb_svcenum_t *);
558 uint32_t smb_ofile_open_check(smb_ofile_t *, uint32_t, uint32_t);
559 uint32_t smb_ofile_rename_check(smb_ofile_t *);
560 uint32_t smb_ofile_delete_check(smb_ofile_t *);
561 cred_t *smb_ofile_getcred(smb_ofile_t *);
562 void smb_ofile_set_oplock_granted(smb_ofile_t *);
563 void smb_ofile_set_delete_on_close(smb_ofile_t *);
564 void smb_ofile_set_write_time_pending(smb_ofile_t *);
565 boolean_t smb_ofile_write_time_pending(smb_ofile_t *);
566 void smb_ofile_set_explicit_times(smb_ofile_t *, uint32_t);
567 uint32_t smb_ofile_explicit_times(smb_ofile_t *);
568 void smb_delayed_write_timer(smb_llist_t *);
569 void smb_ofile_set_quota_resume(smb_ofile_t *, char *);
570 void smb_ofile_get_quota_resume(smb_ofile_t *, char *, int);
571 
572 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
573 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
574 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
575 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
576 
577 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
578 
579 /*
580  * odir functions (file smb_odir.c)
581  */
582 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t, uint32_t);
583 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
584 void smb_odir_close(smb_odir_t *);
585 boolean_t smb_odir_hold(smb_odir_t *);
586 void smb_odir_release(smb_odir_t *);
587 void smb_odir_delete(void *);
588 
589 int smb_odir_read(smb_request_t *, smb_odir_t *,
590     smb_odirent_t *, boolean_t *);
591 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
592     smb_fileinfo_t *, boolean_t *);
593 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
594     smb_streaminfo_t *, boolean_t *);
595 
596 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
597 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
598 
599 /*
600  * SMB user functions (file smb_user.c)
601  */
602 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
603     char *, char *, uint32_t, uint32_t, uint32_t);
604 smb_user_t *smb_user_dup(smb_user_t *);
605 void smb_user_logoff(smb_user_t *);
606 void smb_user_delete(void *);
607 void smb_user_post_tree(smb_user_t *, smb_tree_t *);
608 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
609 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
610 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
611 boolean_t smb_user_is_admin(smb_user_t *);
612 boolean_t smb_user_namecmp(smb_user_t *, const char *);
613 int smb_user_enum(smb_user_t *, smb_svcenum_t *);
614 void smb_user_close_pid(smb_user_t *, uint16_t);
615 void smb_user_disconnect_trees(smb_user_t *user);
616 void smb_user_disconnect_share(smb_user_t *, const char *);
617 int smb_user_fclose(smb_user_t *, uint32_t);
618 boolean_t smb_user_hold(smb_user_t *);
619 void smb_user_release(smb_user_t *);
620 cred_t *smb_user_getcred(smb_user_t *);
621 cred_t *smb_user_getprivcred(smb_user_t *);
622 void smb_user_netinfo_init(smb_user_t *, smb_netuserinfo_t *);
623 void smb_user_netinfo_fini(smb_netuserinfo_t *);
624 int smb_user_netinfo_encode(smb_user_t *, uint8_t *, size_t, uint32_t *);
625 smb_token_t *smb_get_token(smb_logon_t *);
626 
627 /*
628  * SMB tree functions (file smb_tree.c)
629  */
630 smb_tree_t *smb_tree_connect(smb_request_t *);
631 void smb_tree_disconnect(smb_tree_t *, boolean_t);
632 void smb_tree_dealloc(void *);
633 void smb_tree_post_ofile(smb_tree_t *, smb_ofile_t *);
634 void smb_tree_post_odir(smb_tree_t *, smb_odir_t *);
635 void smb_tree_close_pid(smb_tree_t *, uint16_t);
636 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
637 int smb_tree_enum(smb_tree_t *, smb_svcenum_t *);
638 int smb_tree_fclose(smb_tree_t *, uint32_t);
639 boolean_t smb_tree_hold(smb_tree_t *);
640 void smb_tree_release(smb_tree_t *);
641 smb_odir_t *smb_tree_lookup_odir(smb_tree_t *, uint16_t);
642 boolean_t smb_tree_is_connected(smb_tree_t *);
643 #define	SMB_TREE_GET_TID(tree)		((tree)->t_tid)
644 
645 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
646     uint32_t total_parameter_count, uint32_t total_data_count,
647     uint32_t max_parameter_count, uint32_t max_data_count,
648     uint32_t max_setup_count, uint32_t setup_word_count);
649 void smb_xa_delete(smb_xa_t *xa);
650 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
651 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
652 int smb_xa_open(smb_xa_t *xa);
653 void smb_xa_close(smb_xa_t *xa);
654 int smb_xa_complete(smb_xa_t *xa);
655 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
656 
657 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
658 struct mbuf *smb_mbuf_allocate(struct uio *uio);
659 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
660 
661 void smb_check_status(void);
662 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
663 
664 void smb_reconnection_check(smb_session_t *);
665 
666 int32_t smb_time_gmt_to_local(smb_request_t *, int32_t);
667 int32_t smb_time_local_to_gmt(smb_request_t *, int32_t);
668 int32_t	smb_time_dos_to_unix(int16_t, int16_t);
669 void smb_time_unix_to_dos(int32_t, int16_t *, int16_t *);
670 void smb_time_nt_to_unix(uint64_t nt_time, timestruc_t *unix_time);
671 uint64_t smb_time_unix_to_nt(timestruc_t *);
672 
673 int netbios_name_isvalid(char *in, char *out);
674 
675 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
676 
677 /*
678  * Pool ID function prototypes
679  */
680 int	smb_idpool_constructor(smb_idpool_t *pool);
681 void	smb_idpool_destructor(smb_idpool_t  *pool);
682 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
683 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
684 
685 /*
686  * SMB thread function prototypes
687  */
688 void	smb_session_worker(void *arg);
689 
690 /*
691  * SMB locked list function prototypes
692  */
693 void	smb_llist_init(void);
694 void	smb_llist_fini(void);
695 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
696 void	smb_llist_destructor(smb_llist_t *);
697 void	smb_llist_exit(smb_llist_t *);
698 void	smb_llist_post(smb_llist_t *, void *, smb_dtorproc_t);
699 void	smb_llist_flush(smb_llist_t *);
700 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
701 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
702 void	smb_llist_remove(smb_llist_t *ll, void *obj);
703 int	smb_llist_upgrade(smb_llist_t *ll);
704 uint32_t smb_llist_get_count(smb_llist_t *ll);
705 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
706 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
707 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
708 int	smb_account_connected(smb_user_t *user);
709 
710 /*
711  * SMB Synchronized list function prototypes
712  */
713 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
714 void	smb_slist_destructor(smb_slist_t *);
715 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
716 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
717 void	smb_slist_remove(smb_slist_t *sl, void *obj);
718 void	smb_slist_wait_for_empty(smb_slist_t *sl);
719 void	smb_slist_exit(smb_slist_t *sl);
720 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
721 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
722 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
723 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
724 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
725 
726 void    smb_rwx_init(smb_rwx_t *rwx);
727 void    smb_rwx_destroy(smb_rwx_t *rwx);
728 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
729 void    smb_rwx_rwexit(smb_rwx_t *rwx);
730 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
731 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
732 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
733 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
734 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
735 
736 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
737     smb_thread_aw_t, void *);
738 void	smb_thread_destroy(smb_thread_t *);
739 int	smb_thread_start(smb_thread_t *);
740 void	smb_thread_stop(smb_thread_t *);
741 void    smb_thread_signal(smb_thread_t *);
742 boolean_t smb_thread_continue(smb_thread_t *);
743 boolean_t smb_thread_continue_nowait(smb_thread_t *);
744 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
745 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
746 
747 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
748 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
749 
750 /* 100's of ns between 1/1/1970 and 1/1/1601 */
751 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
752 
753 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
754 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
755 
756 acl_t *smb_fsacl_inherit(acl_t *, int, int, cred_t *);
757 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
758 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
759 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
760 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
761 
762 boolean_t smb_ace_is_generic(int);
763 boolean_t smb_ace_is_access(int);
764 boolean_t smb_ace_is_audit(int);
765 
766 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
767 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
768     char *, smb_node_t **, smb_node_t **);
769 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
770 
771 void smb_panic(char *, const char *, int);
772 #pragma	does_not_return(smb_panic)
773 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
774 
775 void smb_latency_init(smb_latency_t *);
776 void smb_latency_destroy(smb_latency_t *);
777 void smb_latency_add_sample(smb_latency_t *, hrtime_t);
778 void smb_srqueue_init(smb_srqueue_t *);
779 void smb_srqueue_destroy(smb_srqueue_t *);
780 void smb_srqueue_waitq_enter(smb_srqueue_t *);
781 void smb_srqueue_runq_exit(smb_srqueue_t *);
782 void smb_srqueue_waitq_to_runq(smb_srqueue_t *);
783 void smb_srqueue_update(smb_srqueue_t *, smb_kstat_utilization_t *);
784 
785 void *smb_mem_alloc(size_t);
786 void *smb_mem_zalloc(size_t);
787 void *smb_mem_realloc(void *, size_t);
788 void *smb_mem_rezalloc(void *, size_t);
789 void smb_mem_free(void *);
790 void smb_mem_zfree(void *);
791 char *smb_mem_strdup(const char *);
792 void smb_srm_init(smb_request_t *);
793 void smb_srm_fini(smb_request_t *);
794 void *smb_srm_alloc(smb_request_t *, size_t);
795 void *smb_srm_zalloc(smb_request_t *, size_t);
796 void *smb_srm_realloc(smb_request_t *, void *, size_t);
797 void *smb_srm_rezalloc(smb_request_t *, void *, size_t);
798 char *smb_srm_strdup(smb_request_t *, const char *);
799 
800 void smb_export_start(void);
801 void smb_export_stop(void);
802 
803 door_handle_t smb_kshare_door_init(int);
804 void smb_kshare_door_fini(door_handle_t);
805 int smb_kshare_upcall(door_handle_t, void *, boolean_t);
806 
807 int smb_kshare_init(void);
808 void smb_kshare_fini(void);
809 int smb_kshare_export_list(smb_ioc_share_t *);
810 int smb_kshare_unexport_list(smb_ioc_share_t *);
811 void smb_kshare_enum(smb_enumshare_info_t *);
812 smb_kshare_t *smb_kshare_lookup(const char *);
813 void smb_kshare_release(smb_kshare_t *);
814 int smb_kshare_exec(smb_shr_execinfo_t *);
815 uint32_t smb_kshare_hostaccess(smb_kshare_t *, smb_inaddr_t *);
816 
817 
818 void smb_avl_create(smb_avl_t *, size_t, size_t, smb_avl_nops_t *);
819 void smb_avl_destroy(smb_avl_t *);
820 int smb_avl_add(smb_avl_t *, void *);
821 void smb_avl_remove(smb_avl_t *, void *);
822 void *smb_avl_lookup(smb_avl_t *, void *);
823 void smb_avl_release(smb_avl_t *, void *);
824 void smb_avl_iterinit(smb_avl_t *, smb_avl_cursor_t *);
825 void *smb_avl_iterate(smb_avl_t *, smb_avl_cursor_t *);
826 
827 #ifdef	__cplusplus
828 }
829 #endif
830 
831 #endif /* _SMB_KPROTO_H_ */
832