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