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