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