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