xref: /titanic_41/usr/src/uts/common/smbsrv/smb_kproto.h (revision 1bc1c72171ee0c5d77203ddffb90219d991bd6e8)
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  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*
27  * Function prototypes for the SMB module.
28  */
29 
30 #ifndef _SMB_KPROTO_H_
31 #define	_SMB_KPROTO_H_
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/socket.h>
41 #include <sys/strsubr.h>
42 #include <sys/socketvar.h>
43 #include <sys/ksocket.h>
44 #include <sys/cred.h>
45 #include <sys/sunddi.h>
46 #include <smbsrv/smb.h>
47 #include <smbsrv/string.h>
48 #include <smbsrv/smb_vops.h>
49 #include <smbsrv/smb_xdr.h>
50 #include <smbsrv/smb_token.h>
51 #include <smbsrv/smb_ktypes.h>
52 #include <smbsrv/smb_ioctl.h>
53 
54 extern	int smb_maxbufsize;
55 extern	int smb_flush_required;
56 extern	int smb_dirsymlink_enable;
57 extern	int smb_oplock_timeout;
58 extern	int smb_sign_debug;
59 extern	uint_t smb_audit_flags;
60 
61 int		fd_dealloc(int);
62 
63 off_t		lseek(int fildes, off_t offset, int whence);
64 
65 int		arpioctl(int cmd, void *data);
66 /* Why? uint32_t	inet_addr(char *str); */
67 int		microtime(timestruc_t *tvp);
68 int		clock_get_uptime(void);
69 
70 /*
71  * SMB request handers called from the dispatcher.
72  */
73 #define	SMB_SDT_OPS(NAME)	\
74 	smb_pre_##NAME,		\
75 	smb_com_##NAME,		\
76 	smb_post_##NAME
77 
78 #define	SMB_COM_DECL(NAME)				\
79 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
80 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
81 	void smb_post_##NAME(smb_request_t *)
82 
83 SMB_COM_DECL(check_directory);
84 SMB_COM_DECL(close);
85 SMB_COM_DECL(close_and_tree_disconnect);
86 SMB_COM_DECL(close_print_file);
87 SMB_COM_DECL(create);
88 SMB_COM_DECL(create_directory);
89 SMB_COM_DECL(create_new);
90 SMB_COM_DECL(create_temporary);
91 SMB_COM_DECL(delete);
92 SMB_COM_DECL(delete_directory);
93 SMB_COM_DECL(echo);
94 SMB_COM_DECL(find);
95 SMB_COM_DECL(find_close);
96 SMB_COM_DECL(find_close2);
97 SMB_COM_DECL(find_unique);
98 SMB_COM_DECL(flush);
99 SMB_COM_DECL(get_print_queue);
100 SMB_COM_DECL(invalid);
101 SMB_COM_DECL(ioctl);
102 SMB_COM_DECL(lock_and_read);
103 SMB_COM_DECL(lock_byte_range);
104 SMB_COM_DECL(locking_andx);
105 SMB_COM_DECL(logoff_andx);
106 SMB_COM_DECL(negotiate);
107 SMB_COM_DECL(nt_cancel);
108 SMB_COM_DECL(nt_create_andx);
109 SMB_COM_DECL(nt_rename);
110 SMB_COM_DECL(nt_transact);
111 SMB_COM_DECL(nt_transact_secondary);
112 SMB_COM_DECL(open);
113 SMB_COM_DECL(open_andx);
114 SMB_COM_DECL(open_print_file);
115 SMB_COM_DECL(process_exit);
116 SMB_COM_DECL(query_information);
117 SMB_COM_DECL(query_information2);
118 SMB_COM_DECL(query_information_disk);
119 SMB_COM_DECL(read);
120 SMB_COM_DECL(read_andx);
121 SMB_COM_DECL(read_raw);
122 SMB_COM_DECL(rename);
123 SMB_COM_DECL(search);
124 SMB_COM_DECL(seek);
125 SMB_COM_DECL(session_setup_andx);
126 SMB_COM_DECL(set_information);
127 SMB_COM_DECL(set_information2);
128 SMB_COM_DECL(transaction);
129 SMB_COM_DECL(transaction2);
130 SMB_COM_DECL(transaction2_secondary);
131 SMB_COM_DECL(transaction_secondary);
132 SMB_COM_DECL(tree_connect);
133 SMB_COM_DECL(tree_connect_andx);
134 SMB_COM_DECL(tree_disconnect);
135 SMB_COM_DECL(unlock_byte_range);
136 SMB_COM_DECL(write);
137 SMB_COM_DECL(write_and_close);
138 SMB_COM_DECL(write_and_unlock);
139 SMB_COM_DECL(write_andx);
140 SMB_COM_DECL(write_print_file);
141 SMB_COM_DECL(write_raw);
142 
143 #define	SMB_NT_TRANSACT_DECL(NAME)				\
144 	smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *);	\
145 	smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *);	\
146 	void smb_post_##NAME(smb_request_t *, smb_xa_t *)
147 
148 SMB_NT_TRANSACT_DECL(nt_transact_create);
149 
150 int smb_notify_init(void);
151 void smb_notify_fini(void);
152 
153 smb_sdrc_t smb_nt_transact_notify_change(smb_request_t *, smb_xa_t *);
154 smb_sdrc_t smb_nt_transact_query_security_info(smb_request_t *, smb_xa_t *);
155 smb_sdrc_t smb_nt_transact_set_security_info(smb_request_t *, smb_xa_t *);
156 smb_sdrc_t smb_nt_transact_ioctl(smb_request_t *, smb_xa_t *);
157 smb_sdrc_t smb_nt_transact_rename(smb_request_t *, smb_xa_t *);
158 
159 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *);
160 smb_sdrc_t smb_com_trans2_create_directory(smb_request_t *, smb_xa_t *);
161 smb_sdrc_t smb_com_trans2_find_first2(smb_request_t *, smb_xa_t *);
162 smb_sdrc_t smb_com_trans2_find_next2(smb_request_t *, smb_xa_t *);
163 smb_sdrc_t smb_com_trans2_query_fs_information(smb_request_t *, smb_xa_t *);
164 smb_sdrc_t smb_com_trans2_query_path_information(smb_request_t *, smb_xa_t *);
165 smb_sdrc_t smb_com_trans2_query_file_information(smb_request_t *, smb_xa_t *);
166 smb_sdrc_t smb_com_trans2_set_path_information(smb_request_t *, smb_xa_t *);
167 smb_sdrc_t smb_com_trans2_set_file_information(smb_request_t *, smb_xa_t *);
168 int smb_trans2_rename(smb_request_t *, smb_node_t *, char *, int);
169 
170 /*
171  * Logging functions
172  */
173 void smb_log_flush(void);
174 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
175 void smb_close_all_connections(void);
176 
177 int smb_net_id(uint32_t);
178 
179 void smb_process_file_notify_change_queue(smb_ofile_t *of);
180 
181 void smb_oplock_acquire(smb_node_t *, smb_ofile_t *, open_param_t	*);
182 boolean_t smb_oplock_break(smb_node_t *, smb_session_t *, boolean_t);
183 void smb_oplock_release(smb_node_t *, smb_ofile_t *);
184 boolean_t smb_oplock_conflict(smb_node_t *, smb_session_t *, open_param_t *);
185 boolean_t smb_oplock_broadcast(smb_node_t *);
186 
187 /*
188  * macros used in oplock processing
189  *
190  * SMB_ATTR_ONLY_OPEN: Checks to see if this is
191  * an attribute-only open with no contravening
192  * dispositions.  Such an open cannot effect an
193  * oplock break.  However, a contravening disposition
194  * of FILE_SUPERSEDE or FILE_OVERWRITE can allow
195  * an oplock break.
196  */
197 
198 #define	SMB_ATTR_ONLY_OPEN(op)					\
199 	((op) && (op)->desired_access &&			\
200 	(((op)->desired_access & ~(FILE_READ_ATTRIBUTES |	\
201 	FILE_WRITE_ATTRIBUTES | SYNCHRONIZE)) == 0) &&		\
202 	((op)->create_disposition != FILE_SUPERSEDE) &&		\
203 	((op)->create_disposition != FILE_OVERWRITE))		\
204 
205 uint32_t smb_lock_get_lock_count(smb_node_t *);
206 uint32_t smb_unlock_range(smb_request_t *, smb_node_t *,
207     uint64_t, uint64_t);
208 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
209     uint32_t locktype);
210 void smb_lock_range_error(smb_request_t *, uint32_t);
211 
212 DWORD smb_range_check(smb_request_t *, smb_node_t *, uint64_t, uint64_t,
213     boolean_t);
214 
215 int smb_mangle_name(ino64_t, char *, char *, char *, int);
216 int smb_unmangle_name(smb_node_t *, char *, char *, int, uint32_t);
217 int smb_maybe_mangled_name(char *);
218 int smb_maybe_mangled_path(const char *, size_t);
219 int smb_needs_mangle(char *, char **);
220 boolean_t smb_is_invalid_filename(const char *);
221 
222 void smbsr_cleanup(smb_request_t *sr);
223 
224 int smbsr_connect_tree(smb_request_t *);
225 
226 int smb_common_create_directory(smb_request_t *);
227 
228 void	smb_convert_wildcards(char *);
229 boolean_t smb_contains_wildcards(const char *);
230 int	smb_ascii_or_unicode_strlen(smb_request_t *, char *);
231 int	smb_ascii_or_unicode_strlen_null(smb_request_t *, char *);
232 int	smb_ascii_or_unicode_null_len(smb_request_t *);
233 
234 int	smb_search(smb_request_t *);
235 
236 uint32_t smb_common_open(smb_request_t *);
237 
238 void smb_pathname_init(smb_request_t *, smb_pathname_t *, char *);
239 boolean_t smb_pathname_validate(smb_request_t *, smb_pathname_t *);
240 boolean_t smb_validate_dirname(smb_request_t *, smb_pathname_t *);
241 boolean_t smb_validate_object_name(smb_request_t *, smb_pathname_t *);
242 boolean_t smb_validate_stream_name(smb_request_t *, smb_pathname_t *);
243 boolean_t smb_is_stream_name(char *);
244 void smb_stream_parse_name(char *, char *, char *);
245 
246 
247 uint32_t smb_omode_to_amask(uint32_t desired_access);
248 
249 void	sshow_distribution_info(char *);
250 
251 boolean_t smb_dispatch_request(smb_request_t *);
252 int	smbsr_encode_empty_result(smb_request_t *);
253 void	smbsr_lookup_file(smb_request_t *);
254 void	smbsr_release_file(smb_request_t *);
255 
256 int	smbsr_decode_vwv(smb_request_t *sr, char *fmt, ...);
257 int	smbsr_decode_data(smb_request_t *sr, char *fmt, ...);
258 int	smbsr_encode_result(smb_request_t *, int, int, char *, ...);
259 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
260 void	smbsr_send_reply(smb_request_t *);
261 
262 void	smbsr_map_errno(int, smb_error_t *);
263 void	smbsr_set_error(smb_request_t *, smb_error_t *);
264 void	smbsr_errno(smb_request_t *, int);
265 void	smbsr_warn(smb_request_t *, DWORD, uint16_t, uint16_t);
266 void	smbsr_error(smb_request_t *, DWORD, uint16_t, uint16_t);
267 
268 int	clock_get_milli_uptime(void);
269 
270 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
271 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
272 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
273 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
274 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
275 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
276 
277 void	smbsr_encode_header(smb_request_t *sr, int wct,
278 		    int bcc, char *fmt, ...);
279 
280 int	smb_xlate_dialect_str_to_cd(char *);
281 char	*smb_xlate_com_cd_to_str(int);
282 char	*smb_xlate_dialect_cd_to_str(int);
283 
284 int smb_lock_range_access(smb_request_t *, smb_node_t *,
285     uint64_t, uint64_t, boolean_t);
286 
287 void smb_encode_sid(smb_xa_t *, smb_sid_t *);
288 uint32_t smb_decode_sd(smb_xa_t *, smb_sd_t *);
289 
290 /*
291  * Socket functions
292  */
293 ksocket_t smb_socreate(int domain, int type, int protocol);
294 void smb_soshutdown(ksocket_t so);
295 void smb_sodestroy(ksocket_t so);
296 int smb_sorecv(ksocket_t so, void *msg, size_t len);
297 int smb_net_init(void);
298 void smb_net_fini(void);
299 void smb_net_txl_constructor(smb_txlst_t *);
300 void smb_net_txl_destructor(smb_txlst_t *);
301 smb_txreq_t *smb_net_txr_alloc(void);
302 void smb_net_txr_free(smb_txreq_t *);
303 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
304 
305 /*
306  * SMB RPC interface
307  */
308 int smb_opipe_open(smb_request_t *);
309 void smb_opipe_close(smb_ofile_t *);
310 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
311 int smb_opipe_read(smb_request_t *, struct uio *);
312 int smb_opipe_write(smb_request_t *, struct uio *);
313 
314 void smb_opipe_door_init(void);
315 void smb_opipe_door_fini(void);
316 int smb_opipe_door_open(int);
317 void smb_opipe_door_close(void);
318 
319 /*
320  * SMB server functions (file smb_server.c)
321  */
322 int smb_server_svc_init(void);
323 int smb_server_svc_fini(void);
324 int smb_server_create(void);
325 int smb_server_delete(void);
326 int smb_server_configure(smb_ioc_cfg_t *);
327 int smb_server_start(smb_ioc_start_t *);
328 int smb_server_nbt_listen(smb_ioc_listen_t *);
329 int smb_server_tcp_listen(smb_ioc_listen_t *);
330 int smb_server_nbt_receive(void);
331 int smb_server_tcp_receive(void);
332 uint32_t smb_server_get_session_count(void);
333 int smb_server_share_export(smb_ioc_share_t *);
334 int smb_server_share_unexport(smb_ioc_share_t *);
335 int smb_server_set_gmtoff(smb_ioc_gmt_t *);
336 int smb_server_numopen(smb_ioc_opennum_t *);
337 int smb_server_enum(smb_ioc_svcenum_t *);
338 int smb_server_session_close(smb_ioc_session_t *);
339 int smb_server_file_close(smb_ioc_fileid_t *);
340 
341 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
342 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
343 
344 
345 /*
346  * SMB node functions (file smb_node.c)
347  */
348 int smb_node_init(void);
349 void smb_node_fini(void);
350 smb_node_t *smb_node_lookup(smb_request_t *, open_param_t *,
351     cred_t *, vnode_t *, char *, smb_node_t *, smb_node_t *);
352 smb_node_t *smb_stream_node_lookup(smb_request_t *, cred_t *,
353     smb_node_t *, vnode_t *, vnode_t *, char *);
354 
355 void smb_node_ref(smb_node_t *);
356 void smb_node_release(smb_node_t *);
357 void smb_node_rename(smb_node_t *, smb_node_t *, smb_node_t *, char *);
358 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
359 void smb_node_add_lock(smb_node_t *, smb_lock_t *);
360 void smb_node_destroy_lock(smb_node_t *, smb_lock_t *);
361 void smb_node_destroy_lock_by_ofile(smb_node_t *, smb_ofile_t *);
362 void smb_node_start_crit(smb_node_t *, krw_t);
363 void smb_node_end_crit(smb_node_t *);
364 int smb_node_in_crit(smb_node_t *);
365 void smb_node_rdlock(smb_node_t *);
366 void smb_node_wrlock(smb_node_t *);
367 void smb_node_unlock(smb_node_t *);
368 uint32_t smb_node_get_ofile_count(smb_node_t *);
369 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
370 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
371 void smb_node_inc_open_ofiles(smb_node_t *);
372 void smb_node_dec_open_ofiles(smb_node_t *);
373 boolean_t smb_node_is_dir(smb_node_t *);
374 boolean_t smb_node_is_link(smb_node_t *);
375 
376 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
377     uint32_t, uint32_t);
378 DWORD smb_node_rename_check(smb_node_t *);
379 DWORD smb_node_delete_check(smb_node_t *);
380 void smb_node_notify_change(smb_node_t *);
381 
382 int smb_node_getattr(smb_request_t *, smb_node_t *, smb_attr_t *);
383 int smb_node_setattr(smb_request_t *, smb_node_t *, cred_t *,
384     smb_ofile_t *, smb_attr_t *);
385 
386 int smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t);
387 void smb_node_reset_delete_on_close(smb_node_t *);
388 
389 boolean_t smb_node_file_is_readonly(smb_node_t *);
390 
391 /*
392  * Pathname functions
393  */
394 
395 int smb_pathname_reduce(smb_request_t *, cred_t *,
396     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
397 
398 int smb_pathname(smb_request_t *, char *, int, smb_node_t *,
399     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
400 
401 /*
402  * smb_vfs functions
403  */
404 
405 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
406 void smb_vfs_rele(smb_server_t *, vfs_t *);
407 void smb_vfs_rele_all(smb_server_t *);
408 boolean_t smb_vfs_cmp(vfs_t *, vfs_t *);
409 boolean_t smb_vfs_is_readonly(vfs_t *);
410 
411 /* NOTIFY CHANGE */
412 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
413 void smb_process_node_notify_change_queue(smb_node_t *);
414 void smb_reply_specific_cancel_request(smb_request_t *);
415 
416 void smb_fem_fcn_install(smb_node_t *);
417 void smb_fem_fcn_uninstall(smb_node_t *);
418 
419 /* FEM */
420 
421 int smb_fem_init(void);
422 void smb_fem_fini(void);
423 
424 int smb_try_grow(smb_request_t *sr, int64_t new_size);
425 
426 void smb_srm_init(smb_request_t *sr);
427 void smb_srm_fini(smb_request_t *sr);
428 void *smb_srm_alloc(smb_request_t *, size_t);
429 void *smb_srm_realloc(smb_request_t *, void *, size_t);
430 
431 unsigned short smb_worker_getnum();
432 
433 /* SMB signing routines smb_signing.c */
434 void smb_sign_init(smb_request_t *, smb_session_key_t *, char *, int);
435 int smb_sign_check_request(smb_request_t *);
436 int smb_sign_check_secondary(smb_request_t *, unsigned int);
437 void smb_sign_reply(smb_request_t *, mbuf_chain_t *);
438 
439 boolean_t smb_sattr_check(uint16_t, uint16_t);
440 
441 void smb_request_cancel(smb_request_t *);
442 void smb_request_wait(smb_request_t *);
443 
444 /*
445  * session functions (file smb_session.c)
446  */
447 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
448 int smb_session_daemon(smb_session_list_t *);
449 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
450 void smb_session_timers(smb_session_list_t *);
451 void smb_session_delete(smb_session_t *session);
452 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
453     smb_request_t *);
454 void smb_session_config(smb_session_t *session);
455 void smb_session_disconnect_share(smb_session_list_t *, char *);
456 void smb_session_list_constructor(smb_session_list_t *);
457 void smb_session_list_destructor(smb_session_list_t *);
458 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
459 void smb_session_list_delete_tail(smb_session_list_t *);
460 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
461 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
462 void smb_session_list_signal(smb_session_list_t *);
463 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
464 void smb_session_getclient(smb_session_t *, char *, size_t);
465 boolean_t smb_session_isclient(smb_session_t *, const char *);
466 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
467 void smb_session_oplock_break(smb_session_t *, smb_ofile_t *);
468 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
469 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
470 boolean_t smb_session_oplocks_enable(smb_session_t *);
471 
472 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
473 
474 smb_request_t *smb_request_alloc(smb_session_t *, int);
475 void smb_request_free(smb_request_t *);
476 
477 /*
478  * ofile functions (file smb_ofile.c)
479  */
480 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
481 smb_ofile_t *smb_ofile_lookup_by_uniqid(smb_tree_t *, uint32_t);
482 boolean_t smb_ofile_disallow_fclose(smb_ofile_t *);
483 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
484     open_param_t *, uint16_t, uint32_t, smb_error_t *);
485 void smb_ofile_close(smb_ofile_t *, uint32_t);
486 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
487 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
488 boolean_t smb_ofile_hold(smb_ofile_t *);
489 void smb_ofile_release(smb_ofile_t *);
490 void smb_ofile_close_all(smb_tree_t *);
491 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
492 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
493 boolean_t smb_ofile_is_open(smb_ofile_t *);
494 int smb_ofile_enum(smb_ofile_t *, smb_svcenum_t *);
495 uint32_t smb_ofile_open_check(smb_ofile_t *, cred_t *, uint32_t, uint32_t);
496 uint32_t smb_ofile_rename_check(smb_ofile_t *);
497 uint32_t smb_ofile_delete_check(smb_ofile_t *);
498 cred_t *smb_ofile_getcred(smb_ofile_t *);
499 void smb_ofile_set_oplock_granted(smb_ofile_t *);
500 void smb_ofile_set_delete_on_close(smb_ofile_t *);
501 
502 void smb_ofile_set_write_time_pending(smb_ofile_t *);
503 boolean_t smb_ofile_write_time_pending(smb_ofile_t *);
504 void smb_ofile_set_explicit_times(smb_ofile_t *, uint32_t);
505 uint32_t smb_ofile_explicit_times(smb_ofile_t *);
506 void smb_delayed_write_timer(smb_llist_t *);
507 
508 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
509 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
510 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
511 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
512 
513 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
514 
515 /*
516  * odir functions (file smb_odir.c)
517  */
518 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t, uint32_t);
519 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
520 void smb_odir_close(smb_odir_t *);
521 boolean_t smb_odir_hold(smb_odir_t *);
522 void smb_odir_release(smb_odir_t *);
523 
524 int smb_odir_read(smb_request_t *, smb_odir_t *,
525     smb_odirent_t *, boolean_t *);
526 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
527     smb_fileinfo_t *, boolean_t *);
528 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
529     smb_streaminfo_t *, boolean_t *);
530 
531 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
532 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
533 
534 /*
535  * SMB user functions (file smb_user.c)
536  */
537 int smb_user_init(void);
538 void smb_user_fini(void);
539 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
540     char *, char *, uint32_t, uint32_t, uint32_t);
541 smb_user_t *smb_user_dup(smb_user_t *);
542 void smb_user_logoff(smb_user_t *);
543 void smb_user_logoff_all(smb_session_t *);
544 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, uint16_t);
545 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *);
546 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
547 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
548 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
549 boolean_t smb_user_is_admin(smb_user_t *);
550 boolean_t smb_user_namecmp(smb_user_t *, const char *);
551 int smb_user_enum(smb_user_t *, smb_svcenum_t *);
552 void smb_user_close_pid(smb_user_t *, uint16_t);
553 void smb_user_disconnect_trees(smb_user_t *user);
554 void smb_user_disconnect_share(smb_user_t *, const char *);
555 int smb_user_fclose(smb_user_t *, uint32_t);
556 boolean_t smb_user_hold(smb_user_t *);
557 void smb_user_release(smb_user_t *);
558 cred_t *smb_user_getcred(smb_user_t *);
559 cred_t *smb_user_getprivcred(smb_user_t *);
560 void smb_user_netinfo_init(smb_user_t *, smb_netuserinfo_t *);
561 void smb_user_netinfo_fini(smb_netuserinfo_t *);
562 int smb_user_netinfo_encode(smb_user_t *, uint8_t *, size_t, uint32_t *);
563 
564 /*
565  * SMB tree functions (file smb_tree.c)
566  */
567 smb_tree_t *smb_tree_connect(smb_request_t *);
568 void smb_tree_disconnect(smb_tree_t *, boolean_t);
569 void smb_tree_close_pid(smb_tree_t *, uint16_t);
570 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
571 int smb_tree_enum(smb_tree_t *, smb_svcenum_t *);
572 int smb_tree_fclose(smb_tree_t *, uint32_t);
573 boolean_t smb_tree_hold(smb_tree_t *);
574 void smb_tree_release(smb_tree_t *);
575 smb_odir_t *smb_tree_lookup_odir(smb_tree_t *, uint16_t);
576 boolean_t smb_tree_is_connected(smb_tree_t *);
577 #define	SMB_TREE_GET_TID(tree)		((tree)->t_tid)
578 
579 /*
580  * SMB user's credential functions
581  */
582 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
583 void smb_cred_rele(cred_t *cr);
584 int smb_cred_is_member(cred_t *cr, smb_sid_t *sid);
585 cred_t *smb_cred_create_privs(cred_t *, uint32_t);
586 
587 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
588     uint32_t total_parameter_count, uint32_t total_data_count,
589     uint32_t max_parameter_count, uint32_t max_data_count,
590     uint32_t max_setup_count, uint32_t setup_word_count);
591 void smb_xa_delete(smb_xa_t *xa);
592 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
593 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
594 int smb_xa_open(smb_xa_t *xa);
595 void smb_xa_close(smb_xa_t *xa);
596 int smb_xa_complete(smb_xa_t *xa);
597 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
598 
599 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
600 struct mbuf *smb_mbuf_allocate(struct uio *uio);
601 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
602 
603 void smb_check_status(void);
604 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
605 
606 void smb_reconnection_check(smb_session_t *);
607 
608 int32_t smb_time_gmt_to_local(smb_request_t *, int32_t);
609 int32_t smb_time_local_to_gmt(smb_request_t *, int32_t);
610 int32_t	smb_time_dos_to_unix(int16_t, int16_t);
611 void smb_time_unix_to_dos(int32_t, int16_t *, int16_t *);
612 void smb_time_nt_to_unix(uint64_t nt_time, timestruc_t *unix_time);
613 uint64_t smb_time_unix_to_nt(timestruc_t *);
614 
615 int netbios_name_isvalid(char *in, char *out);
616 
617 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
618 
619 int smb_match_name(ino64_t, char *, char *, boolean_t);
620 int token2buf(smb_token_t *token, char *buf);
621 
622 /*
623  * Pool ID function prototypes
624  */
625 int	smb_idpool_constructor(smb_idpool_t *pool);
626 void	smb_idpool_destructor(smb_idpool_t  *pool);
627 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
628 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
629 
630 /*
631  * SMB thread function prototypes
632  */
633 void	smb_session_worker(void *arg);
634 
635 /*
636  * SMB locked list function prototypes
637  */
638 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
639 void	smb_llist_destructor(smb_llist_t *);
640 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
641 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
642 void	smb_llist_remove(smb_llist_t *ll, void *obj);
643 int	smb_llist_upgrade(smb_llist_t *ll);
644 uint32_t smb_llist_get_count(smb_llist_t *ll);
645 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
646 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
647 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
648 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
649 int	smb_account_connected(smb_user_t *user);
650 
651 /*
652  * SMB Synchronized list function prototypes
653  */
654 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
655 void	smb_slist_destructor(smb_slist_t *);
656 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
657 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
658 void	smb_slist_remove(smb_slist_t *sl, void *obj);
659 void	smb_slist_wait_for_empty(smb_slist_t *sl);
660 void	smb_slist_exit(smb_slist_t *sl);
661 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
662 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
663 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
664 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
665 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
666 
667 void    smb_rwx_init(smb_rwx_t *rwx);
668 void    smb_rwx_destroy(smb_rwx_t *rwx);
669 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
670 void    smb_rwx_rwexit(smb_rwx_t *rwx);
671 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
672 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
673 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
674 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
675 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
676 
677 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
678     smb_thread_aw_t, void *);
679 void	smb_thread_destroy(smb_thread_t *);
680 int	smb_thread_start(smb_thread_t *);
681 void	smb_thread_stop(smb_thread_t *);
682 void    smb_thread_signal(smb_thread_t *);
683 boolean_t smb_thread_continue(smb_thread_t *);
684 boolean_t smb_thread_continue_nowait(smb_thread_t *);
685 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
686 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
687 
688 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
689 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
690 
691 /* 100's of ns between 1/1/1970 and 1/1/1601 */
692 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
693 
694 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
695 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
696 
697 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
698 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
699 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
700 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
701 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
702 
703 boolean_t smb_ace_is_generic(int);
704 boolean_t smb_ace_is_access(int);
705 boolean_t smb_ace_is_audit(int);
706 
707 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
708 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
709     char *, smb_node_t **, smb_node_t **);
710 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
711 
712 void smb_panic(char *, const char *, int);
713 #pragma	does_not_return(smb_panic)
714 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
715 
716 #ifdef	__cplusplus
717 }
718 #endif
719 
720 #endif /* _SMB_KPROTO_H_ */
721