xref: /titanic_41/usr/src/uts/common/smbsrv/smb_kproto.h (revision 9b214d32697277d03ed2e5d98c4a7bfef16dcf4d)
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_announce_quota;
53 extern	int smb_oplock_timeout;
54 extern	int smb_sign_debug;
55 extern	uint_t smb_audit_flags;
56 
57 #define	smb_gmt2local(_sr_, _gmt_)	((_gmt_) - (_sr_)->sr_gmtoff)
58 #define	smb_local2gmt(_sr_, _local_)	((_local_) + (_sr_)->sr_gmtoff)
59 
60 int		fd_dealloc(int);
61 
62 off_t		lseek(int fildes, off_t offset, int whence);
63 
64 int		arpioctl(int cmd, void *data);
65 /* Why? uint32_t	inet_addr(char *str); */
66 int		microtime(timestruc_t *tvp);
67 int		clock_get_uptime(void);
68 
69 /*
70  * SMB request handers called from the dispatcher.
71  */
72 #define	SMB_SDT_OPS(NAME)	\
73 	smb_pre_##NAME,		\
74 	smb_com_##NAME,		\
75 	smb_post_##NAME
76 
77 #define	SMB_COM_DECL(NAME)				\
78 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
79 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
80 	void smb_post_##NAME(smb_request_t *)
81 
82 SMB_COM_DECL(check_directory);
83 SMB_COM_DECL(close);
84 SMB_COM_DECL(close_and_tree_disconnect);
85 SMB_COM_DECL(close_print_file);
86 SMB_COM_DECL(create);
87 SMB_COM_DECL(create_directory);
88 SMB_COM_DECL(create_new);
89 SMB_COM_DECL(create_temporary);
90 SMB_COM_DECL(delete);
91 SMB_COM_DECL(delete_directory);
92 SMB_COM_DECL(echo);
93 SMB_COM_DECL(find);
94 SMB_COM_DECL(find_close);
95 SMB_COM_DECL(find_close2);
96 SMB_COM_DECL(find_unique);
97 SMB_COM_DECL(flush);
98 SMB_COM_DECL(get_print_queue);
99 SMB_COM_DECL(invalid);
100 SMB_COM_DECL(ioctl);
101 SMB_COM_DECL(lock_and_read);
102 SMB_COM_DECL(lock_byte_range);
103 SMB_COM_DECL(locking_andx);
104 SMB_COM_DECL(logoff_andx);
105 SMB_COM_DECL(negotiate);
106 SMB_COM_DECL(nt_cancel);
107 SMB_COM_DECL(nt_create_andx);
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(struct smb_request *, struct smb_xa *);
152 smb_sdrc_t smb_nt_transact_query_security_info(struct smb_request *,
153     struct smb_xa *);
154 smb_sdrc_t smb_nt_transact_set_security_info(struct smb_request *,
155     struct smb_xa *);
156 smb_sdrc_t smb_nt_transact_ioctl(struct smb_request *, struct smb_xa *);
157 
158 smb_sdrc_t smb_com_trans2_open2(smb_request_t *, smb_xa_t *);
159 smb_sdrc_t smb_com_trans2_create_directory(struct smb_request *,
160     struct smb_xa *);
161 smb_sdrc_t smb_com_trans2_find_first2(struct smb_request *, struct smb_xa *);
162 smb_sdrc_t smb_com_trans2_find_next2(struct smb_request *, struct smb_xa *);
163 smb_sdrc_t smb_com_trans2_query_fs_information(struct smb_request *,
164     struct smb_xa *);
165 smb_sdrc_t smb_com_trans2_query_path_information(struct smb_request *,
166     struct smb_xa *);
167 smb_sdrc_t smb_com_trans2_query_file_information(struct smb_request *,
168     struct smb_xa *);
169 smb_sdrc_t smb_com_trans2_set_path_information(struct smb_request *,
170     struct smb_xa *);
171 smb_sdrc_t smb_com_trans2_set_file_information(struct smb_request *,
172     struct smb_xa *);
173 
174 /*
175  * Logging functions
176  */
177 void smb_log_flush(void);
178 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
179 void smb_close_all_connections(void);
180 int smb_set_file_size(smb_request_t *, smb_node_t *);
181 
182 int smb_net_id(uint32_t);
183 
184 void smb_process_file_notify_change_queue(struct smb_ofile *of);
185 
186 void smb_oplock_acquire(smb_node_t *, smb_ofile_t *, open_param_t	*);
187 boolean_t smb_oplock_break(smb_node_t *, smb_session_t *, boolean_t);
188 void smb_oplock_release(smb_node_t *, smb_ofile_t *);
189 boolean_t smb_oplock_conflict(smb_node_t *, smb_session_t *, open_param_t *);
190 boolean_t smb_oplock_broadcast(smb_node_t *);
191 
192 /*
193  * macros used in oplock processing
194  *
195  * SMB_ATTR_ONLY_OPEN: Checks to see if this is
196  * an attribute-only open with no contravening
197  * dispositions.  Such an open cannot effect an
198  * oplock break.  However, a contravening disposition
199  * of FILE_SUPERSEDE or FILE_OVERWRITE can allow
200  * an oplock break.
201  */
202 
203 #define	SMB_ATTR_ONLY_OPEN(op)					\
204 	((op) && (op)->desired_access &&			\
205 	(((op)->desired_access & ~(FILE_READ_ATTRIBUTES |	\
206 	FILE_WRITE_ATTRIBUTES | SYNCHRONIZE)) == 0) &&		\
207 	((op)->create_disposition != FILE_SUPERSEDE) &&		\
208 	((op)->create_disposition != FILE_OVERWRITE))		\
209 
210 uint32_t smb_unlock_range(struct smb_request *, struct smb_node *,
211     uint64_t, uint64_t);
212 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
213     uint32_t locktype);
214 void smb_lock_range_error(smb_request_t *, uint32_t);
215 
216 DWORD smb_range_check(smb_request_t *, smb_node_t *, uint64_t, uint64_t,
217     boolean_t);
218 
219 int smb_mangle_name(ino64_t, char *, char *, char *, int);
220 int smb_unmangle_name(smb_node_t *, char *, char *, int);
221 int smb_maybe_mangled_name(char *);
222 int smb_maybe_mangled_path(const char *, size_t);
223 int smb_needs_mangle(char *, char **);
224 boolean_t smb_is_invalid_filename(const char *);
225 
226 void smbsr_cleanup(struct smb_request *sr);
227 
228 int smbsr_connect_tree(struct smb_request *);
229 
230 int smb_common_create_directory(struct smb_request *);
231 
232 int	smb_convert_wildcards(char *);
233 int	smb_ascii_or_unicode_strlen(struct smb_request *, char *);
234 int	smb_ascii_or_unicode_strlen_null(struct smb_request *, char *);
235 int	smb_ascii_or_unicode_null_len(struct smb_request *);
236 
237 int	smb_search(struct smb_request *);
238 
239 uint32_t smb_common_open(smb_request_t *);
240 
241 void smb_pathname_setup(smb_request_t *, smb_pathname_t *);
242 uint32_t smb_validate_dirname(char *path);
243 uint32_t smb_validate_object_name(smb_pathname_t *pn);
244 boolean_t smb_is_stream_name(char *);
245 uint32_t smb_validate_stream_name(smb_pathname_t *pn);
246 void	smb_stream_parse_name(char *, char *, char *);
247 
248 
249 uint32_t smb_omode_to_amask(uint32_t desired_access);
250 
251 void	sshow_distribution_info(char *);
252 
253 boolean_t smb_dispatch_request(smb_request_t *);
254 void	smbsr_disconnect_file(smb_request_t *);
255 void	smbsr_disconnect_dir(smb_request_t *);
256 int	smbsr_encode_empty_result(struct smb_request *);
257 void	smbsr_lookup_file(smb_request_t *);
258 
259 int	smbsr_decode_vwv(struct smb_request *sr, char *fmt, ...);
260 int	smbsr_decode_data(struct smb_request *sr, char *fmt, ...);
261 int	smbsr_encode_result(struct smb_request *, int, int, char *, ...);
262 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
263 void	smbsr_send_reply(struct smb_request *);
264 
265 void	smbsr_map_errno(int, smb_error_t *);
266 void	smbsr_set_error(smb_request_t *, smb_error_t *);
267 void	smbsr_errno(struct smb_request *, int);
268 void	smbsr_warn(struct smb_request *, DWORD, uint16_t, uint16_t);
269 void	smbsr_error(struct smb_request *, DWORD, uint16_t, uint16_t);
270 
271 int	clock_get_milli_uptime(void);
272 int32_t	smb_dos_to_ux_time(int16_t, int16_t);
273 int32_t	smb_ux_to_dos_time(int32_t, int16_t *, int16_t *);
274 
275 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
276 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
277 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
278 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
279 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
280 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
281 
282 void	smbsr_encode_header(struct smb_request *sr, int wct,
283 		    int bcc, char *fmt, ...);
284 
285 int	smb_xlate_dialect_str_to_cd(char *);
286 char	*smb_xlate_com_cd_to_str(int);
287 char	*smb_xlate_dialect_cd_to_str(int);
288 
289 int	smbd_fs_query(smb_request_t *, smb_fqi_t *, int);
290 
291 int smb_lock_range_access(struct smb_request *, struct smb_node *,
292     uint64_t, uint64_t, boolean_t);
293 
294 uint32_t smb_decode_sd(struct smb_xa *, smb_sd_t *);
295 
296 /*
297  * Socket functions
298  */
299 ksocket_t smb_socreate(int domain, int type, int protocol);
300 void smb_soshutdown(ksocket_t so);
301 void smb_sodestroy(ksocket_t so);
302 int smb_sorecv(ksocket_t so, void *msg, size_t len);
303 int smb_net_init(void);
304 void smb_net_fini(void);
305 void smb_net_txl_constructor(smb_txlst_t *);
306 void smb_net_txl_destructor(smb_txlst_t *);
307 smb_txreq_t *smb_net_txr_alloc(void);
308 void smb_net_txr_free(smb_txreq_t *);
309 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
310 
311 /*
312  * SMB RPC interface
313  */
314 int smb_opipe_open(smb_request_t *);
315 void smb_opipe_close(smb_ofile_t *);
316 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
317 int smb_opipe_read(smb_request_t *, struct uio *);
318 int smb_opipe_write(smb_request_t *, struct uio *);
319 
320 void smb_opipe_door_init(void);
321 void smb_opipe_door_fini(void);
322 int smb_opipe_door_open(int);
323 void smb_opipe_door_close(void);
324 void smb_user_context_init(smb_user_t *, smb_opipe_context_t *);
325 void smb_user_list_free(smb_dr_ulist_t *);
326 
327 /*
328  * SMB server functions (file smb_server.c)
329  */
330 int smb_server_svc_init(void);
331 int smb_server_svc_fini(void);
332 int smb_server_create(void);
333 int smb_server_delete(void);
334 int smb_server_configure(smb_kmod_cfg_t *cfg);
335 int smb_server_start(struct smb_io_start *);
336 int smb_server_nbt_listen(int);
337 int smb_server_tcp_listen(int);
338 int smb_server_nbt_receive(void);
339 int smb_server_tcp_receive(void);
340 uint32_t smb_server_get_user_count(void);
341 uint32_t smb_server_get_session_count(void);
342 int smb_server_dr_ulist_get(int, smb_dr_ulist_t *, int);
343 int smb_server_share_export(char *);
344 int smb_server_share_unexport(char *, char *);
345 int smb_server_set_gmtoff(int32_t goff);
346 
347 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
348 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
349 
350 /*
351  * SMB node functions (file smb_node.c)
352  */
353 int smb_node_init(void);
354 void smb_node_fini(void);
355 struct smb_node *smb_node_lookup(struct smb_request *sr, struct open_param *op,
356     cred_t *cr, vnode_t *vp, char *od_name, smb_node_t *dir_snode,
357     smb_node_t *unnamed_node, smb_attr_t *attr);
358 struct smb_node *smb_stream_node_lookup(struct smb_request *sr, cred_t *cr,
359     smb_node_t *fnode, vnode_t *xattrdirvp, vnode_t *vp, char *stream_name,
360     smb_attr_t *ret_attr);
361 void smb_node_ref(smb_node_t *node);
362 void smb_node_release(smb_node_t *node);
363 int smb_node_assert(smb_node_t *node, const char *file, int line);
364 void smb_node_rename(smb_node_t *from_dir_snode, smb_node_t *ret_snode,
365     smb_node_t *to_dir_snode, char *to_name);
366 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
367 void smb_node_add_lock(smb_node_t *node, smb_lock_t *lock);
368 void smb_node_destroy_lock(smb_node_t *node, smb_lock_t *lock);
369 void smb_node_destroy_lock_by_ofile(smb_node_t *node, smb_ofile_t *file);
370 void smb_node_start_crit(smb_node_t *, krw_t);
371 void smb_node_end_crit(smb_node_t *);
372 int smb_node_in_crit(smb_node_t *);
373 void smb_node_rdlock(smb_node_t *);
374 void smb_node_wrlock(smb_node_t *);
375 void smb_node_unlock(smb_node_t *);
376 uint32_t smb_node_get_ofile_count(smb_node_t *);
377 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
378 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
379 void smb_node_inc_open_ofiles(smb_node_t *);
380 void smb_node_dec_open_ofiles(smb_node_t *);
381 
382 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
383     uint32_t, uint32_t);
384 DWORD smb_node_rename_check(smb_node_t *);
385 DWORD smb_node_delete_check(smb_node_t *);
386 
387 u_offset_t smb_node_get_size(smb_node_t *, smb_attr_t *);
388 void smb_node_set_time(struct smb_node *node, timestruc_t *crtime,
389     timestruc_t *mtime, timestruc_t *atime,
390     timestruc_t *ctime, unsigned int what);
391 timestruc_t *smb_node_get_crtime(struct smb_node *node);
392 timestruc_t *smb_node_get_atime(struct smb_node *node);
393 timestruc_t *smb_node_get_ctime(struct smb_node *node);
394 timestruc_t *smb_node_get_mtime(struct smb_node *node);
395 void smb_node_set_dosattr(struct smb_node *, uint32_t);
396 uint32_t smb_node_get_dosattr(struct smb_node *node);
397 int smb_node_set_delete_on_close(smb_node_t *, cred_t *, uint32_t);
398 void smb_node_reset_delete_on_close(smb_node_t *);
399 
400 /*
401  * Pathname functions
402  */
403 
404 int smb_pathname_reduce(struct smb_request *, cred_t *,
405     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
406 
407 int smb_pathname(struct smb_request *, char *, int, smb_node_t *,
408     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
409 
410 /*
411  * smb_vfs functions
412  */
413 
414 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
415 void smb_vfs_rele(smb_server_t *, vfs_t *);
416 void smb_vfs_rele_all(smb_server_t *);
417 boolean_t smb_vfs_cmp(vfs_t *, vfs_t *);
418 boolean_t smb_vfs_is_readonly(vfs_t *);
419 
420 
421 /*
422  * String manipulation function
423  */
424 char *smb_kstrdup(const char *s, size_t n);
425 
426 int smb_sync_fsattr(struct smb_request *sr, cred_t *cr,
427     struct smb_node *node);
428 
429 
430 void smb_encode_stream_info(struct smb_request *sr, struct smb_xa *xa,
431     smb_node_t *snode, smb_attr_t *attr);
432 
433 /* NOTIFY CHANGE */
434 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
435 void smb_process_node_notify_change_queue(struct smb_node *);
436 void smb_reply_specific_cancel_request(struct smb_request *);
437 
438 void smb_fem_fcn_install(smb_node_t *);
439 void smb_fem_fcn_uninstall(smb_node_t *);
440 
441 /* FEM */
442 
443 int smb_fem_init(void);
444 void smb_fem_fini(void);
445 
446 int smb_try_grow(struct smb_request *sr, int64_t new_size);
447 
448 /* functions from smb_memory_manager.c */
449 
450 void	*smbsr_malloc(smb_malloc_list *, size_t);
451 void	*smbsr_realloc(void *, size_t);
452 void	smbsr_free_malloc_list(smb_malloc_list *);
453 
454 unsigned short smb_worker_getnum();
455 
456 DWORD smb_trans2_set_information(struct smb_request *sr,
457     smb_trans2_setinfo_t *info,
458     smb_error_t *smberr);
459 
460 /* SMB signing routines smb_signing.c */
461 void smb_sign_init(struct smb_request *req,
462 	smb_session_key_t *session_key, char *resp, int resp_len);
463 
464 int smb_sign_check_request(struct smb_request *req);
465 
466 int smb_sign_check_secondary(struct smb_request *req, unsigned int seqnum);
467 
468 void smb_sign_reply(struct smb_request *req, struct mbuf_chain *reply);
469 
470 boolean_t smb_sattr_check(uint16_t, uint16_t);
471 
472 void smb_request_cancel(smb_request_t *);
473 void smb_request_wait(smb_request_t *);
474 
475 /*
476  * session functions (file smb_session.c)
477  */
478 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
479 int smb_session_daemon(smb_session_list_t *);
480 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
481 void smb_session_timers(smb_session_list_t *);
482 void smb_session_delete(smb_session_t *session);
483 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
484     smb_request_t *);
485 void smb_session_config(smb_session_t *session);
486 void smb_session_disconnect_share(smb_session_list_t *, char *);
487 void smb_session_list_constructor(smb_session_list_t *);
488 void smb_session_list_destructor(smb_session_list_t *);
489 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
490 void smb_session_list_delete_tail(smb_session_list_t *);
491 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
492 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
493 void smb_session_list_signal(smb_session_list_t *);
494 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
495 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
496 void smb_session_oplock_break(smb_session_t *, smb_ofile_t *);
497 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
498 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
499 boolean_t smb_session_oplocks_enable(smb_session_t *);
500 
501 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
502 
503 smb_request_t *smb_request_alloc(smb_session_t *, int);
504 void smb_request_free(smb_request_t *);
505 
506 /*
507  * ofile functions (file smb_ofile.c)
508  */
509 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
510 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
511     struct open_param *, uint16_t, uint32_t, smb_error_t *);
512 void smb_ofile_close(smb_ofile_t *, uint32_t);
513 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
514 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
515 void smb_ofile_release(smb_ofile_t *);
516 void smb_ofile_close_all(smb_tree_t *);
517 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
518 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
519 void smb_ofile_close_timestamp_update(smb_ofile_t *, uint32_t);
520 boolean_t smb_ofile_is_open(smb_ofile_t *);
521 uint32_t smb_ofile_open_check(smb_ofile_t *, cred_t *,
522     uint32_t, uint32_t);
523 uint32_t smb_ofile_rename_check(smb_ofile_t *);
524 uint32_t smb_ofile_delete_check(smb_ofile_t *);
525 cred_t *smb_ofile_getcred(smb_ofile_t *);
526 void smb_ofile_set_oplock_granted(smb_ofile_t *);
527 void smb_ofile_set_delete_on_close(smb_ofile_t *);
528 
529 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
530 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
531 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
532 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
533 
534 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
535 
536 /*
537  * odir functions (file smb_odir.c)
538  */
539 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t, uint32_t);
540 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
541 void smb_odir_close(smb_odir_t *);
542 boolean_t smb_odir_hold(smb_odir_t *);
543 void smb_odir_release(smb_odir_t *);
544 
545 int smb_odir_read(smb_request_t *, smb_odir_t *,
546     smb_odirent_t *, boolean_t *);
547 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
548     smb_fileinfo_t *, boolean_t *);
549 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
550     smb_streaminfo_t *, boolean_t *);
551 
552 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
553 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
554 
555 /*
556  * SMB user functions (file smb_user.c)
557  */
558 int smb_user_init(void);
559 void smb_user_fini(void);
560 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
561     char *, char *, uint32_t, uint32_t, uint32_t);
562 smb_user_t *smb_user_dup(smb_user_t *);
563 void smb_user_logoff(smb_user_t *);
564 void smb_user_logoff_all(smb_session_t *);
565 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, uint16_t);
566 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *);
567 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
568 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
569 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
570 boolean_t smb_user_is_admin(smb_user_t *);
571 void smb_user_close_pid(smb_user_t *, uint16_t);
572 void smb_user_disconnect_trees(smb_user_t *user);
573 void smb_user_disconnect_share(smb_user_t *, const char *);
574 void smb_user_release(smb_user_t *);
575 cred_t *smb_user_getcred(smb_user_t *);
576 cred_t *smb_user_getprivcred(smb_user_t *);
577 
578 /*
579  * SMB tree functions (file smb_tree.c)
580  */
581 smb_tree_t *smb_tree_connect(smb_request_t *);
582 void smb_tree_disconnect(smb_tree_t *);
583 void smb_tree_close_pid(smb_tree_t *, uint16_t);
584 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
585 boolean_t smb_tree_hold(smb_tree_t *);
586 void smb_tree_release(smb_tree_t *);
587 void smb_dr_ulist_free(smb_dr_ulist_t *ulist);
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(struct smb_session *session);
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 void smb_sd_init(smb_sd_t *, uint8_t);
711 void smb_sd_term(smb_sd_t *);
712 uint32_t smb_sd_get_secinfo(smb_sd_t *);
713 uint32_t smb_sd_len(smb_sd_t *, uint32_t);
714 uint32_t smb_sd_tofs(smb_sd_t *, smb_fssd_t *);
715 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
716 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
717 
718 void smb_fssd_init(smb_fssd_t *, uint32_t, uint32_t);
719 void smb_fssd_term(smb_fssd_t *);
720 
721 void smb_acl_sort(smb_acl_t *);
722 void smb_acl_free(smb_acl_t *);
723 smb_acl_t *smb_acl_alloc(uint8_t, uint16_t, uint16_t);
724 smb_acl_t *smb_acl_from_zfs(acl_t *, uid_t, gid_t);
725 uint32_t smb_acl_to_zfs(smb_acl_t *, uint32_t, int, acl_t **);
726 uint16_t smb_acl_len(smb_acl_t *);
727 boolean_t smb_acl_isvalid(smb_acl_t *, int);
728 
729 void smb_fsacl_free(acl_t *);
730 acl_t *smb_fsacl_alloc(int, int);
731 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
732 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
733 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
734 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
735 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
736 
737 boolean_t smb_ace_is_generic(int);
738 boolean_t smb_ace_is_access(int);
739 boolean_t smb_ace_is_audit(int);
740 
741 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
742 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
743     char *, smb_node_t **, smb_node_t **);
744 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
745 
746 void smb_panic(char *, const char *, int);
747 #pragma	does_not_return(smb_panic)
748 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
749 
750 #ifdef	__cplusplus
751 }
752 #endif
753 
754 #endif /* _SMB_KPROTO_H_ */
755