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