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