xref: /titanic_52/usr/src/uts/common/smbsrv/smb_kproto.h (revision 2c2961f8403049d948b9f3e6c35d6488b6b7e1aa)
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 *, uint64_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_exit(smb_node_t *);
191 
192 /*
193  * macros used in oplock processing
194  *
195  * SMB_SAME_SESSION: Checks for equivalence
196  * of session.  If an existing oplock is
197  * from the same IP address/session as the current
198  * request, the oplock is not broken.
199  *
200  * SMB_ATTR_ONLY_OPEN: Checks to see if this is
201  * an attribute-only open with no contravening
202  * dispositions.  Such an open cannot effect an
203  * oplock break.  However, a contravening disposition
204  * of FILE_SUPERSEDE or FILE_OVERWRITE can allow
205  * an oplock break.
206  */
207 
208 #define	SMB_SAME_SESSION(sess1, sess2)				\
209 	((sess1) && (sess2) &&					\
210 	(smb_inet_equal(&sess1->ipaddr, &sess2->ipaddr, 0)) &&	\
211 	((sess1)->s_kid == (sess2)->s_kid))			\
212 
213 #define	SMB_ATTR_ONLY_OPEN(op)					\
214 	((op) && (op)->desired_access &&			\
215 	(((op)->desired_access & ~(FILE_READ_ATTRIBUTES |	\
216 	FILE_WRITE_ATTRIBUTES | SYNCHRONIZE)) == 0) &&		\
217 	((op)->create_disposition != FILE_SUPERSEDE) &&		\
218 	((op)->create_disposition != FILE_OVERWRITE))		\
219 
220 uint32_t smb_unlock_range(struct smb_request *, struct smb_node *,
221     uint64_t, uint64_t);
222 uint32_t smb_lock_range(smb_request_t *, uint64_t, uint64_t, uint32_t,
223     uint32_t locktype);
224 void smb_lock_range_error(smb_request_t *, uint32_t);
225 
226 DWORD smb_range_check(smb_request_t *, smb_node_t *, uint64_t, uint64_t,
227     boolean_t);
228 
229 int smb_mangle_name(ino64_t fileid, char *name, char *shortname,
230     char *name83, int force);
231 int smb_unmangle_name(struct smb_request *sr, cred_t *cred,
232     smb_node_t *dir_node, char *name, char *real_name, int realname_size,
233     char *shortname, char *name83, int od);
234 int smb_maybe_mangled_name(char *name);
235 int smb_maybe_mangled_path(const char *path, size_t pathlen);
236 int smb_needs_mangle(char *name, char **dot_pos);
237 boolean_t smb_is_invalid_filename(const char *);
238 
239 void smbsr_cleanup(struct smb_request *sr);
240 
241 int smbsr_connect_tree(struct smb_request *);
242 
243 int smb_common_create_directory(struct smb_request *);
244 
245 int		smb_convert_unicode_wildcards(char *);
246 int	smb_ascii_or_unicode_strlen(struct smb_request *, char *);
247 int	smb_ascii_or_unicode_strlen_null(struct smb_request *, char *);
248 int	smb_ascii_or_unicode_null_len(struct smb_request *);
249 
250 int	smb_search(struct smb_request *);
251 
252 uint32_t smb_common_open(smb_request_t *);
253 DWORD smb_validate_object_name(char *path, unsigned int ftype);
254 
255 uint32_t smb_omode_to_amask(uint32_t desired_access);
256 
257 void	sshow_distribution_info(char *);
258 
259 boolean_t smb_dispatch_request(smb_request_t *);
260 void	smbsr_disconnect_file(smb_request_t *);
261 void	smbsr_disconnect_dir(smb_request_t *);
262 int	smbsr_encode_empty_result(struct smb_request *);
263 void	smbsr_lookup_file(smb_request_t *);
264 
265 int	smbsr_decode_vwv(struct smb_request *sr, char *fmt, ...);
266 int	smbsr_decode_data(struct smb_request *sr, char *fmt, ...);
267 int	smbsr_encode_result(struct smb_request *, int, int, char *, ...);
268 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
269 void	smbsr_send_reply(struct smb_request *);
270 
271 void	smbsr_map_errno(int, smb_error_t *);
272 void	smbsr_set_error(smb_request_t *, smb_error_t *);
273 void	smbsr_errno(struct smb_request *, int);
274 void	smbsr_warn(struct smb_request *, DWORD, uint16_t, uint16_t);
275 void	smbsr_error(struct smb_request *, DWORD, uint16_t, uint16_t);
276 
277 int	clock_get_milli_uptime(void);
278 int32_t	smb_dos_to_ux_time(int16_t, int16_t);
279 int32_t	smb_ux_to_dos_time(int32_t, int16_t *, int16_t *);
280 
281 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
282 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
283 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
284 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
285 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
286 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
287 
288 void	smbsr_encode_header(struct smb_request *sr, int wct,
289 		    int bcc, char *fmt, ...);
290 
291 int	smb_xlate_dialect_str_to_cd(char *);
292 char	*smb_xlate_com_cd_to_str(int);
293 char	*smb_xlate_dialect_cd_to_str(int);
294 
295 int	smbd_fs_query(smb_request_t *, smb_fqi_t *, int);
296 
297 int smb_lock_range_access(struct smb_request *, struct smb_node *,
298     uint64_t, uint64_t, boolean_t);
299 
300 uint32_t smb_decode_sd(struct smb_xa *, smb_sd_t *);
301 
302 /*
303  * Socket functions
304  */
305 ksocket_t smb_socreate(int domain, int type, int protocol);
306 void smb_soshutdown(ksocket_t so);
307 void smb_sodestroy(ksocket_t so);
308 int smb_sorecv(ksocket_t so, void *msg, size_t len);
309 int smb_net_init(void);
310 void smb_net_fini(void);
311 void smb_net_txl_constructor(smb_txlst_t *);
312 void smb_net_txl_destructor(smb_txlst_t *);
313 smb_txreq_t *smb_net_txr_alloc(void);
314 void smb_net_txr_free(smb_txreq_t *);
315 int smb_net_txr_send(ksocket_t, smb_txlst_t *, smb_txreq_t *);
316 
317 /*
318  * SMB RPC interface
319  */
320 int smb_opipe_open(smb_request_t *);
321 void smb_opipe_close(smb_ofile_t *);
322 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
323 int smb_opipe_read(smb_request_t *, struct uio *);
324 int smb_opipe_write(smb_request_t *, struct uio *);
325 
326 void smb_opipe_door_init(void);
327 void smb_opipe_door_fini(void);
328 int smb_opipe_door_open(int);
329 void smb_opipe_door_close(void);
330 void smb_user_context_init(smb_user_t *, smb_opipe_context_t *);
331 void smb_user_list_free(smb_dr_ulist_t *);
332 
333 /*
334  * SMB server functions (file smb_server.c)
335  */
336 int smb_server_svc_init(void);
337 int smb_server_svc_fini(void);
338 int smb_server_create(void);
339 int smb_server_delete(void);
340 int smb_server_configure(smb_kmod_cfg_t *cfg);
341 int smb_server_start(struct smb_io_start *);
342 int smb_server_nbt_listen(int);
343 int smb_server_tcp_listen(int);
344 int smb_server_nbt_receive(void);
345 int smb_server_tcp_receive(void);
346 uint32_t smb_server_get_user_count(void);
347 uint32_t smb_server_get_session_count(void);
348 int smb_server_dr_ulist_get(int, smb_dr_ulist_t *, int);
349 int smb_server_share_export(char *);
350 int smb_server_share_unexport(char *, char *);
351 int smb_server_set_gmtoff(int32_t goff);
352 
353 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
354 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
355 
356 /*
357  * SMB node functions (file smb_node.c)
358  */
359 int smb_node_init(void);
360 void smb_node_fini(void);
361 struct smb_node *smb_node_lookup(struct smb_request *sr, struct open_param *op,
362     cred_t *cr, vnode_t *vp, char *od_name, smb_node_t *dir_snode,
363     smb_node_t *unnamed_node, smb_attr_t *attr);
364 struct smb_node *smb_stream_node_lookup(struct smb_request *sr, cred_t *cr,
365     smb_node_t *fnode, vnode_t *xattrdirvp, vnode_t *vp, char *stream_name,
366     smb_attr_t *ret_attr);
367 void smb_node_ref(smb_node_t *node);
368 void smb_node_release(smb_node_t *node);
369 int smb_node_assert(smb_node_t *node, const char *file, int line);
370 void smb_node_rename(smb_node_t *from_dir_snode, smb_node_t *ret_snode,
371     smb_node_t *to_dir_snode, char *to_name);
372 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
373 void smb_node_add_lock(smb_node_t *node, smb_lock_t *lock);
374 void smb_node_destroy_lock(smb_node_t *node, smb_lock_t *lock);
375 void smb_node_destroy_lock_by_ofile(smb_node_t *node, smb_ofile_t *file);
376 void smb_node_start_crit(smb_node_t *, krw_t);
377 void smb_node_end_crit(smb_node_t *);
378 int smb_node_in_crit(smb_node_t *);
379 void smb_node_rdlock(smb_node_t *);
380 void smb_node_wrlock(smb_node_t *);
381 void smb_node_unlock(smb_node_t *);
382 uint32_t smb_node_get_ofile_count(smb_node_t *);
383 void smb_node_add_ofile(smb_node_t *, smb_ofile_t *);
384 void smb_node_rem_ofile(smb_node_t *, smb_ofile_t *);
385 void smb_node_inc_open_ofiles(smb_node_t *);
386 void smb_node_dec_open_ofiles(smb_node_t *);
387 
388 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
389     uint32_t, uint32_t);
390 DWORD smb_node_rename_check(smb_node_t *);
391 DWORD smb_node_delete_check(smb_node_t *);
392 
393 u_offset_t smb_node_get_size(smb_node_t *, smb_attr_t *);
394 void smb_node_set_time(struct smb_node *node, timestruc_t *crtime,
395     timestruc_t *mtime, timestruc_t *atime,
396     timestruc_t *ctime, unsigned int what);
397 timestruc_t *smb_node_get_crtime(struct smb_node *node);
398 timestruc_t *smb_node_get_atime(struct smb_node *node);
399 timestruc_t *smb_node_get_ctime(struct smb_node *node);
400 timestruc_t *smb_node_get_mtime(struct smb_node *node);
401 void smb_node_set_dosattr(struct smb_node *, uint32_t);
402 uint32_t smb_node_get_dosattr(struct smb_node *node);
403 int smb_node_set_delete_on_close(smb_node_t *, cred_t *);
404 void smb_node_reset_delete_on_close(smb_node_t *);
405 
406 /*
407  * Pathname functions
408  */
409 
410 int smb_pathname_reduce(struct smb_request *, cred_t *,
411     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
412 
413 int smb_pathname(struct smb_request *, char *, int, smb_node_t *,
414     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
415 
416 /*
417  * smb_vfs functions
418  */
419 
420 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
421 void smb_vfs_rele(smb_server_t *, vfs_t *);
422 void smb_vfs_rele_all(smb_server_t *);
423 boolean_t smb_vfs_cmp(vfs_t *, vfs_t *);
424 boolean_t smb_vfs_is_readonly(vfs_t *);
425 
426 
427 /*
428  * String manipulation function
429  */
430 char *smb_kstrdup(const char *s, size_t n);
431 
432 int smb_sync_fsattr(struct smb_request *sr, cred_t *cr,
433     struct smb_node *node);
434 
435 DWORD	smb_validate_dirname(char *path);
436 
437 
438 void smb_encode_stream_info(struct smb_request *sr, struct smb_xa *xa,
439     smb_node_t *snode, smb_attr_t *attr);
440 
441 /* NOTIFY CHANGE */
442 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
443 void smb_process_node_notify_change_queue(struct smb_node *);
444 void smb_reply_specific_cancel_request(struct smb_request *);
445 
446 void smb_fem_fcn_install(smb_node_t *);
447 void smb_fem_fcn_uninstall(smb_node_t *);
448 
449 /* FEM */
450 
451 int smb_fem_init(void);
452 void smb_fem_fini(void);
453 
454 int smb_try_grow(struct smb_request *sr, int64_t new_size);
455 
456 /* functions from smb_memory_manager.c */
457 
458 void	*smbsr_malloc(smb_malloc_list *, size_t);
459 void	*smbsr_realloc(void *, size_t);
460 void	smbsr_free_malloc_list(smb_malloc_list *);
461 
462 unsigned short smb_worker_getnum();
463 void smb_preset_delete_on_close(struct smb_ofile *file);
464 void smb_commit_delete_on_close(struct smb_ofile *file);
465 
466 boolean_t smb_is_stream_name(char *);
467 uint32_t smb_validate_stream_name(char *);
468 int smb_stream_parse_name(char *, char *, char *);
469 
470 DWORD smb_trans2_set_information(struct smb_request *sr,
471     smb_trans2_setinfo_t *info,
472     smb_error_t *smberr);
473 
474 /* SMB signing routines smb_signing.c */
475 void smb_sign_init(struct smb_request *req,
476 	smb_session_key_t *session_key, char *resp, int resp_len);
477 
478 int smb_sign_check_request(struct smb_request *req);
479 
480 int smb_sign_check_secondary(struct smb_request *req, unsigned int seqnum);
481 
482 void smb_sign_reply(struct smb_request *req, struct mbuf_chain *reply);
483 
484 boolean_t smb_sattr_check(uint16_t, uint16_t);
485 
486 void smb_request_cancel(smb_request_t *);
487 void smb_request_wait(smb_request_t *);
488 
489 /*
490  * session functions (file smb_session.c)
491  */
492 smb_session_t *smb_session_create(ksocket_t, uint16_t, smb_server_t *, int);
493 int smb_session_daemon(smb_session_list_t *);
494 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
495 void smb_session_timers(smb_session_list_t *);
496 void smb_session_delete(smb_session_t *session);
497 void smb_session_cancel_requests(smb_session_t *, smb_tree_t *,
498     smb_request_t *);
499 void smb_session_config(smb_session_t *session);
500 void smb_session_disconnect_share(smb_session_list_t *, char *);
501 void smb_session_list_constructor(smb_session_list_t *);
502 void smb_session_list_destructor(smb_session_list_t *);
503 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
504 void smb_session_list_delete_tail(smb_session_list_t *);
505 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
506 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
507 void smb_session_list_signal(smb_session_list_t *);
508 smb_user_t *smb_session_dup_user(smb_session_t *, char *, char *);
509 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
510 void smb_session_oplock_break(smb_session_t *, smb_ofile_t *);
511 void smb_session_oplock_released(smb_session_t *);
512 void smb_session_oplock_break_timedout(smb_session_t *);
513 int smb_session_send(smb_session_t *, uint8_t type, mbuf_chain_t *);
514 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
515 boolean_t smb_session_oplocks_enable(smb_session_t *);
516 
517 #define	SMB_SESSION_GET_ID(s)	((s)->s_kid)
518 
519 smb_request_t *smb_request_alloc(smb_session_t *, int);
520 void smb_request_free(smb_request_t *);
521 
522 /*
523  * ofile functions (file smb_ofile.c)
524  */
525 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
526 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
527     struct open_param *, uint16_t, uint32_t, smb_error_t *);
528 void smb_ofile_close(smb_ofile_t *, uint32_t);
529 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
530 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
531 void smb_ofile_release(smb_ofile_t *);
532 void smb_ofile_close_all(smb_tree_t *);
533 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
534 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
535 void smb_ofile_close_timestamp_update(smb_ofile_t *, uint32_t);
536 boolean_t smb_ofile_is_open(smb_ofile_t *);
537 uint32_t smb_ofile_open_check(smb_ofile_t *, cred_t *,
538     uint32_t, uint32_t);
539 uint32_t smb_ofile_rename_check(smb_ofile_t *);
540 uint32_t smb_ofile_delete_check(smb_ofile_t *);
541 cred_t *smb_ofile_getcred(smb_ofile_t *);
542 void smb_ofile_set_oplock_granted(smb_ofile_t *);
543 
544 #define	SMB_OFILE_GET_SESSION(of)	((of)->f_session)
545 #define	SMB_OFILE_GET_TREE(of)		((of)->f_tree)
546 #define	SMB_OFILE_GET_FID(of)		((of)->f_fid)
547 #define	SMB_OFILE_GET_NODE(of)		((of)->f_node)
548 
549 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
550 
551 /*
552  * odir functions (file smb_odir.c)
553  */
554 uint16_t smb_odir_open(smb_request_t *, char *, uint16_t);
555 uint16_t smb_odir_openat(smb_request_t *, smb_node_t *);
556 void smb_odir_close(smb_odir_t *);
557 boolean_t smb_odir_hold(smb_odir_t *);
558 void smb_odir_release(smb_odir_t *);
559 
560 int smb_odir_read(smb_request_t *, smb_odir_t *,
561     smb_odirent_t *, boolean_t *);
562 int smb_odir_read_fileinfo(smb_request_t *, smb_odir_t *,
563     smb_fileinfo_t *, boolean_t *);
564 int smb_odir_read_streaminfo(smb_request_t *, smb_odir_t *,
565     smb_streaminfo_t *, boolean_t *);
566 
567 void smb_odir_save_cookie(smb_odir_t *, int, uint32_t cookie);
568 void smb_odir_resume_at(smb_odir_t *, smb_odir_resume_t *);
569 
570 /*
571  * SMB user functions (file smb_user.c)
572  */
573 int smb_user_init(void);
574 void smb_user_fini(void);
575 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
576     char *, char *, uint32_t, uint32_t, uint32_t);
577 smb_user_t *smb_user_dup(smb_user_t *);
578 void smb_user_logoff(smb_user_t *);
579 void smb_user_logoff_all(smb_session_t *);
580 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, uint16_t);
581 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *);
582 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
583 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
584 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
585 boolean_t smb_user_is_admin(smb_user_t *);
586 void smb_user_close_pid(smb_user_t *, uint16_t);
587 void smb_user_disconnect_trees(smb_user_t *user);
588 void smb_user_disconnect_share(smb_user_t *, const char *);
589 void smb_user_release(smb_user_t *);
590 cred_t *smb_user_getcred(smb_user_t *);
591 cred_t *smb_user_getprivcred(smb_user_t *);
592 
593 /*
594  * SMB tree functions (file smb_tree.c)
595  */
596 smb_tree_t *smb_tree_connect(smb_request_t *);
597 void smb_tree_disconnect(smb_tree_t *);
598 void smb_tree_close_pid(smb_tree_t *, uint16_t);
599 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
600 boolean_t smb_tree_hold(smb_tree_t *);
601 void smb_tree_release(smb_tree_t *);
602 void smb_dr_ulist_free(smb_dr_ulist_t *ulist);
603 smb_odir_t *smb_tree_lookup_odir(smb_tree_t *, uint16_t);
604 #define	SMB_TREE_GET_TID(tree)		((tree)->t_tid)
605 
606 /*
607  * SMB user's credential functions
608  */
609 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
610 void smb_cred_rele(cred_t *cr);
611 int smb_cred_is_member(cred_t *cr, smb_sid_t *sid);
612 cred_t *smb_cred_create_privs(cred_t *, uint32_t);
613 
614 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
615     uint32_t total_parameter_count, uint32_t total_data_count,
616     uint32_t max_parameter_count, uint32_t max_data_count,
617     uint32_t max_setup_count, uint32_t setup_word_count);
618 void smb_xa_delete(smb_xa_t *xa);
619 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
620 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
621 int smb_xa_open(smb_xa_t *xa);
622 void smb_xa_close(smb_xa_t *xa);
623 int smb_xa_complete(smb_xa_t *xa);
624 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
625 
626 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
627 struct mbuf *smb_mbuf_allocate(struct uio *uio);
628 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
629 
630 void smb_check_status(void);
631 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
632 
633 void smb_reconnection_check(struct smb_session *session);
634 
635 uint32_t nt_to_unix_time(uint64_t nt_time, timestruc_t *unix_time);
636 uint64_t unix_to_nt_time(timestruc_t *);
637 
638 int netbios_name_isvalid(char *in, char *out);
639 
640 size_t
641 unicodestooems(char *oemstring, const mts_wchar_t *unicodestring,
642     size_t nbytes, unsigned int cpid);
643 
644 size_t oemstounicodes(mts_wchar_t *unicodestring, const char *oemstring,
645     size_t nwchars, unsigned int cpid);
646 
647 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
648 
649 int smb_match_name(ino64_t, char *, char *, boolean_t);
650 int token2buf(smb_token_t *token, char *buf);
651 
652 /*
653  * Pool ID function prototypes
654  */
655 int	smb_idpool_constructor(smb_idpool_t *pool);
656 void	smb_idpool_destructor(smb_idpool_t  *pool);
657 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
658 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
659 
660 /*
661  * SMB thread function prototypes
662  */
663 void	smb_session_worker(void *arg);
664 
665 /*
666  * SMB locked list function prototypes
667  */
668 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
669 void	smb_llist_destructor(smb_llist_t *);
670 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
671 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
672 void	smb_llist_remove(smb_llist_t *ll, void *obj);
673 int	smb_llist_upgrade(smb_llist_t *ll);
674 uint32_t smb_llist_get_count(smb_llist_t *ll);
675 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
676 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
677 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
678 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
679 int	smb_account_connected(smb_user_t *user);
680 
681 /*
682  * SMB Synchronized list function prototypes
683  */
684 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
685 void	smb_slist_destructor(smb_slist_t *);
686 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
687 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
688 void	smb_slist_remove(smb_slist_t *sl, void *obj);
689 void	smb_slist_wait_for_empty(smb_slist_t *sl);
690 void	smb_slist_exit(smb_slist_t *sl);
691 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
692 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
693 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
694 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
695 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
696 
697 void    smb_rwx_init(smb_rwx_t *rwx);
698 void    smb_rwx_destroy(smb_rwx_t *rwx);
699 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
700 void    smb_rwx_rwexit(smb_rwx_t *rwx);
701 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
702 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
703 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
704 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
705 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
706 
707 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
708     smb_thread_aw_t, void *);
709 void	smb_thread_destroy(smb_thread_t *);
710 int	smb_thread_start(smb_thread_t *);
711 void	smb_thread_stop(smb_thread_t *);
712 void    smb_thread_signal(smb_thread_t *);
713 boolean_t smb_thread_continue(smb_thread_t *);
714 boolean_t smb_thread_continue_nowait(smb_thread_t *);
715 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
716 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
717 
718 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
719 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
720 
721 /* 100's of ns between 1/1/1970 and 1/1/1601 */
722 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
723 
724 void smb_sd_init(smb_sd_t *, uint8_t);
725 void smb_sd_term(smb_sd_t *);
726 uint32_t smb_sd_get_secinfo(smb_sd_t *);
727 uint32_t smb_sd_len(smb_sd_t *, uint32_t);
728 uint32_t smb_sd_tofs(smb_sd_t *, smb_fssd_t *);
729 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
730 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
731 
732 void smb_fssd_init(smb_fssd_t *, uint32_t, uint32_t);
733 void smb_fssd_term(smb_fssd_t *);
734 
735 void smb_acl_sort(smb_acl_t *);
736 void smb_acl_free(smb_acl_t *);
737 smb_acl_t *smb_acl_alloc(uint8_t, uint16_t, uint16_t);
738 smb_acl_t *smb_acl_from_zfs(acl_t *, uid_t, gid_t);
739 uint32_t smb_acl_to_zfs(smb_acl_t *, uint32_t, int, acl_t **);
740 uint16_t smb_acl_len(smb_acl_t *);
741 boolean_t smb_acl_isvalid(smb_acl_t *, int);
742 
743 void smb_fsacl_free(acl_t *);
744 acl_t *smb_fsacl_alloc(int, int);
745 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
746 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
747 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
748 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
749 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
750 
751 boolean_t smb_ace_is_generic(int);
752 boolean_t smb_ace_is_access(int);
753 boolean_t smb_ace_is_audit(int);
754 
755 uint32_t smb_vss_ioctl_enumerate_snaps(smb_request_t *, smb_xa_t *);
756 int smb_vss_lookup_nodes(smb_request_t *, smb_node_t *, smb_node_t *,
757     char *, smb_node_t **, smb_node_t **);
758 vnode_t *smb_lookuppathvptovp(smb_request_t *, char *, vnode_t *, vnode_t *);
759 
760 void smb_panic(char *, const char *, int);
761 #pragma	does_not_return(smb_panic)
762 #define	SMB_PANIC()	smb_panic(__FILE__, __func__, __LINE__)
763 
764 #ifdef	__cplusplus
765 }
766 #endif
767 
768 #endif /* _SMB_KPROTO_H_ */
769