xref: /titanic_50/usr/src/uts/common/smbsrv/smb_kproto.h (revision dae2dfb7b2bc52128c80617e060a0ba54ca46aba)
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 2008 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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 #include <sys/systm.h>
40 #include <sys/socket.h>
41 #include <sys/strsubr.h>
42 #include <sys/socketvar.h>
43 #include <sys/cred.h>
44 #include <smbsrv/smb_vops.h>
45 #include <smbsrv/smb_xdr.h>
46 #include <smbsrv/smb_token.h>
47 #include <smbsrv/smb_ktypes.h>
48 #include <smbsrv/smb_ioctl.h>
49 
50 extern	int smb_maxbufsize;
51 extern	int smb_flush_required;
52 extern	int smb_dirsymlink_enable;
53 extern	int smb_announce_quota;
54 extern	clock_t	smb_oplock_timeout;
55 
56 #define	smb_gmt2local(_sr_, _gmt_)	((_gmt_) + (_sr_)->sr_gmtoff)
57 #define	smb_local2gmt(_sr_, _local_)	((_local_) - (_sr_)->sr_gmtoff)
58 
59 /*
60  * Definitions that should be elsewhere...
61  */
62 struct mbuf	*m_free(struct mbuf *);
63 void		m_freem(struct mbuf *);
64 
65 int		fd_dealloc(int);
66 
67 off_t		lseek(int fildes, off_t offset, int whence);
68 
69 int		arpioctl(int cmd, void *data);
70 /* Why? uint32_t	inet_addr(char *str); */
71 int		microtime(timestruc_t *tvp);
72 int		clock_get_uptime(void);
73 
74 /*
75  * SMB request handers called from the dispatcher.
76  */
77 #define	SMB_SDT_OPS(NAME)	\
78 	smb_pre_##NAME,		\
79 	smb_com_##NAME,		\
80 	smb_post_##NAME
81 
82 #define	SMB_COM_DECL(NAME)				\
83 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
84 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
85 	void smb_post_##NAME(smb_request_t *)
86 
87 SMB_COM_DECL(check_directory);
88 SMB_COM_DECL(close);
89 SMB_COM_DECL(close_and_tree_disconnect);
90 SMB_COM_DECL(close_print_file);
91 SMB_COM_DECL(create);
92 SMB_COM_DECL(create_directory);
93 SMB_COM_DECL(create_new);
94 SMB_COM_DECL(create_temporary);
95 SMB_COM_DECL(delete);
96 SMB_COM_DECL(delete_directory);
97 SMB_COM_DECL(echo);
98 SMB_COM_DECL(find);
99 SMB_COM_DECL(find_close);
100 SMB_COM_DECL(find_close2);
101 SMB_COM_DECL(find_unique);
102 SMB_COM_DECL(flush);
103 SMB_COM_DECL(get_print_queue);
104 SMB_COM_DECL(invalid);
105 SMB_COM_DECL(ioctl);
106 SMB_COM_DECL(lock_and_read);
107 SMB_COM_DECL(lock_byte_range);
108 SMB_COM_DECL(locking_andx);
109 SMB_COM_DECL(logoff_andx);
110 SMB_COM_DECL(negotiate);
111 SMB_COM_DECL(nt_cancel);
112 SMB_COM_DECL(nt_create_andx);
113 SMB_COM_DECL(nt_transact);
114 SMB_COM_DECL(nt_transact_secondary);
115 SMB_COM_DECL(open);
116 SMB_COM_DECL(open_andx);
117 SMB_COM_DECL(open_print_file);
118 SMB_COM_DECL(process_exit);
119 SMB_COM_DECL(query_information);
120 SMB_COM_DECL(query_information2);
121 SMB_COM_DECL(query_information_disk);
122 SMB_COM_DECL(read);
123 SMB_COM_DECL(read_andx);
124 SMB_COM_DECL(read_raw);
125 SMB_COM_DECL(rename);
126 SMB_COM_DECL(search);
127 SMB_COM_DECL(seek);
128 SMB_COM_DECL(session_setup_andx);
129 SMB_COM_DECL(set_information);
130 SMB_COM_DECL(set_information2);
131 SMB_COM_DECL(transaction);
132 SMB_COM_DECL(transaction2);
133 SMB_COM_DECL(transaction2_secondary);
134 SMB_COM_DECL(transaction_secondary);
135 SMB_COM_DECL(tree_connect);
136 SMB_COM_DECL(tree_connect_andx);
137 SMB_COM_DECL(tree_disconnect);
138 SMB_COM_DECL(unlock_byte_range);
139 SMB_COM_DECL(write);
140 SMB_COM_DECL(write_and_close);
141 SMB_COM_DECL(write_and_unlock);
142 SMB_COM_DECL(write_andx);
143 SMB_COM_DECL(write_print_file);
144 SMB_COM_DECL(write_raw);
145 
146 #define	SMB_NT_TRANSACT_DECL(NAME)				\
147 	smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *);	\
148 	smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *);	\
149 	void smb_post_##NAME(smb_request_t *, smb_xa_t *)
150 
151 SMB_NT_TRANSACT_DECL(nt_transact_create);
152 
153 int smb_notify_init(void);
154 void smb_notify_fini(void);
155 
156 smb_sdrc_t smb_nt_transact_notify_change(struct smb_request *, struct smb_xa *);
157 smb_sdrc_t smb_nt_transact_query_security_info(struct smb_request *,
158     struct smb_xa *);
159 smb_sdrc_t smb_nt_transact_set_security_info(struct smb_request *,
160     struct smb_xa *);
161 smb_sdrc_t smb_nt_transact_ioctl(struct smb_request *, struct smb_xa *);
162 
163 smb_sdrc_t smb_com_trans2_create_directory(struct smb_request *,
164     struct smb_xa *);
165 smb_sdrc_t smb_com_trans2_find_first2(struct smb_request *, struct smb_xa *);
166 smb_sdrc_t smb_com_trans2_find_next2(struct smb_request *, struct smb_xa *);
167 smb_sdrc_t smb_com_trans2_query_fs_information(struct smb_request *,
168     struct smb_xa *);
169 smb_sdrc_t smb_com_trans2_query_path_information(struct smb_request *,
170     struct smb_xa *);
171 smb_sdrc_t smb_com_trans2_query_file_information(struct smb_request *,
172     struct smb_xa *);
173 smb_sdrc_t smb_com_trans2_set_path_information(struct smb_request *,
174     struct smb_xa *);
175 smb_sdrc_t smb_com_trans2_set_file_information(struct smb_request *,
176     struct smb_xa *);
177 
178 /*
179  * Logging functions
180  */
181 void smb_log_flush(void);
182 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
183 void smb_close_all_connections(void);
184 int smb_set_file_size(struct smb_request *sr);
185 int smb_session_send(smb_session_t *, uint8_t type, struct mbuf_chain *);
186 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
187 
188 int smb_net_id(uint32_t);
189 
190 void smb_process_file_notify_change_queue(struct smb_ofile *of);
191 
192 void smb_oplock_init(void);
193 
194 DWORD smb_acquire_oplock(struct smb_request *sr,
195     struct smb_ofile *file,
196     unsigned int level_requested,
197     unsigned int *level_granted);
198 
199 DWORD smb_break_oplock(struct smb_request *sr, struct smb_node *node);
200 void smb_release_oplock(struct smb_ofile *file, int reason);
201 
202 uint32_t smb_unlock_range(struct smb_request *, struct smb_node *,
203     uint64_t, uint64_t);
204 uint32_t smb_lock_range(struct smb_request *, struct smb_ofile *,
205     uint64_t, uint64_t, uint32_t, uint32_t);
206 void smb_lock_range_error(smb_request_t *, uint32_t);
207 
208 DWORD smb_range_check(smb_request_t *, cred_t *, smb_node_t *,
209     uint64_t, uint64_t, boolean_t);
210 
211 int smb_mangle_name(ino64_t fileid, char *name, char *shortname,
212     char *name83, int force);
213 int smb_unmangle_name(struct smb_request *sr, cred_t *cred,
214     smb_node_t *dir_node, char *name, char *real_name, int realname_size,
215     char *shortname, char *name83, int od);
216 int smb_maybe_mangled_name(char *name);
217 int smb_maybe_mangled_path(const char *path, size_t pathlen);
218 int smb_needs_mangle(char *name, char **dot_pos);
219 
220 void smbsr_cleanup(struct smb_request *sr);
221 
222 int smbsr_connect_tree(struct smb_request *);
223 
224 int smb_common_create_directory(struct smb_request *);
225 
226 int		smb_convert_unicode_wildcards(char *);
227 int	smb_ascii_or_unicode_strlen(struct smb_request *, char *);
228 int	smb_ascii_or_unicode_strlen_null(struct smb_request *, char *);
229 int	smb_ascii_or_unicode_null_len(struct smb_request *);
230 
231 int	smb_search(struct smb_request *);
232 void smb_rdir_close(struct smb_request *);
233 int	smb_rdir_open(struct smb_request *, char *, unsigned short);
234 int smb_rdir_next(smb_request_t *sr, smb_node_t **rnode,
235     smb_odir_context_t *pc);
236 
237 uint32_t smb_common_open(smb_request_t *);
238 DWORD smb_validate_object_name(char *path, unsigned int ftype);
239 
240 uint32_t smb_omode_to_amask(uint32_t desired_access);
241 
242 void	sshow_distribution_info(char *);
243 
244 void	smb_dispatch_request(struct smb_request *);
245 void	smbsr_disconnect_file(smb_request_t *);
246 void	smbsr_disconnect_dir(smb_request_t *);
247 int	smbsr_encode_empty_result(struct smb_request *);
248 
249 int	smbsr_decode_vwv(struct smb_request *sr, char *fmt, ...);
250 int	smbsr_decode_data(struct smb_request *sr, char *fmt, ...);
251 int	smbsr_encode_result(struct smb_request *, int, int, char *, ...);
252 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
253 void	smbsr_send_reply(struct smb_request *);
254 
255 void	smbsr_map_errno(int, smb_error_t *);
256 void	smbsr_set_error(smb_request_t *, smb_error_t *);
257 void	smbsr_errno(struct smb_request *, int);
258 void	smbsr_warn(struct smb_request *, DWORD, uint16_t, uint16_t);
259 void	smbsr_error(struct smb_request *, DWORD, uint16_t, uint16_t);
260 
261 int	smb_mbc_encode(struct mbuf_chain *mbc, char *fmt, va_list ap);
262 int	smb_mbc_decode(struct mbuf_chain *mbc, char *fmt, va_list ap);
263 
264 int	clock_get_milli_uptime(void);
265 int	dosfs_dos_to_ux_time(int, int);
266 int	dosfs_ux_to_dos_time(int, short int *, short int *);
267 
268 int	smb_decode_mbc(struct  mbuf_chain *mbc, char *fmt, ...);
269 int	smb_decode_buf(unsigned char *buf, int n_buf, char *fmt, ...);
270 int	smb_encode_mbc(struct mbuf_chain *mbc, char *fmt, ...);
271 int	smb_encode_buf(unsigned char *buf, int n_buf, char *fmt, ...);
272 int	smb_peek_mbc(struct mbuf_chain *buf, int offset, char *fmt, ...);
273 int	smb_poke_mbc(struct mbuf_chain *buf, int offset, char *fmt, ...);
274 
275 void	smbsr_encode_header(struct smb_request *sr, int wct,
276 		    int bcc, char *fmt, ...);
277 
278 int	smb_xlate_dialect_str_to_cd(char *);
279 char	*smb_xlate_com_cd_to_str(int);
280 char	*smb_xlate_dialect_cd_to_str(int);
281 
282 void	smb_od_destruct(struct smb_session *, struct smb_odir *);
283 int	smbd_fs_query(struct smb_request *, struct smb_fqi *, int);
284 int smb_component_match(struct smb_request *sr, ino64_t fileid,
285     struct smb_odir *od, smb_odir_context_t *pc);
286 
287 int smb_lock_range_access(struct smb_request *, struct smb_node *,
288     uint64_t, uint64_t, boolean_t);
289 
290 uint32_t smb_decode_sd(struct smb_xa *, smb_sd_t *);
291 
292 /*
293  * Socket functions
294  */
295 struct sonode *smb_socreate(int domain, int type, int protocol);
296 void smb_soshutdown(struct sonode *so);
297 void smb_sodestroy(struct sonode *so);
298 int smb_sorecv(struct sonode *so, void *msg, size_t len);
299 int smb_iov_sorecv(struct sonode *so, iovec_t *iop, int iovlen,
300     size_t total_len);
301 void smb_net_txl_constructor(smb_txlst_t *);
302 void smb_net_txl_destructor(smb_txlst_t *);
303 smb_txbuf_t *smb_net_txb_alloc(void);
304 void smb_net_txb_free(smb_txbuf_t *);
305 int smb_net_txb_send(struct sonode *, smb_txlst_t *, smb_txbuf_t *);
306 
307 /*
308  * SMB RPC interface
309  */
310 int smb_rpc_open(struct smb_request *);
311 void smb_rpc_close(struct smb_ofile *);
312 smb_sdrc_t smb_rpc_transact(struct smb_request *, struct uio *);
313 int smb_rpc_read(struct smb_request *, struct uio *);
314 int smb_rpc_write(struct smb_request *, struct uio *);
315 
316 /*
317  * SMB server functions (file smb_server.c)
318  */
319 int smb_server_svc_init(void);
320 int smb_server_svc_fini(void);
321 int smb_server_create(void);
322 int smb_server_delete(void);
323 int smb_server_configure(smb_kmod_cfg_t *cfg);
324 int smb_server_start(struct smb_io_start *);
325 int smb_server_nbt_listen(int);
326 int smb_server_tcp_listen(int);
327 int smb_server_nbt_receive(void);
328 int smb_server_tcp_receive(void);
329 uint32_t smb_server_get_user_count(void);
330 uint32_t smb_server_get_session_count(void);
331 void smb_server_disconnect_share(char *);
332 void smb_server_disconnect_volume(fs_desc_t *);
333 int smb_server_dr_ulist_get(int, smb_dr_ulist_t *, int);
334 int smb_server_share_export(char *);
335 int smb_server_share_unexport(char *, char *);
336 int smb_server_set_gmtoff(uint32_t goff);
337 
338 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
339 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
340 
341 /*
342  * SMB node functions (file smb_node.c)
343  */
344 int smb_node_init(void);
345 void smb_node_fini(void);
346 struct smb_node *smb_node_lookup(struct smb_request *sr, struct open_param *op,
347     cred_t *cr, vnode_t *vp, char *od_name, smb_node_t *dir_snode,
348     smb_node_t *unnamed_node, smb_attr_t *attr);
349 struct smb_node *smb_stream_node_lookup(struct smb_request *sr, cred_t *cr,
350     smb_node_t *fnode, vnode_t *xattrdirvp, vnode_t *vp, char *stream_name,
351     smb_attr_t *ret_attr);
352 void smb_node_ref(smb_node_t *node);
353 void smb_node_release(smb_node_t *node);
354 int smb_node_assert(smb_node_t *node, const char *file, int line);
355 int smb_node_rename(smb_node_t *from_dir_snode, smb_node_t *ret_snode,
356     smb_node_t *to_dir_snode, char *to_name);
357 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
358 void smb_node_add_lock(smb_node_t *node, smb_lock_t *lock);
359 void smb_node_destroy_lock(smb_node_t *node, smb_lock_t *lock);
360 void smb_node_destroy_lock_by_ofile(smb_node_t *node, smb_ofile_t *file);
361 void smb_node_start_crit(smb_node_t *node, krw_t mode);
362 void smb_node_end_crit(smb_node_t *node);
363 int smb_node_in_crit(smb_node_t *node);
364 
365 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
366     uint32_t, uint32_t);
367 uint32_t smb_node_share_check(smb_node_t *, cred_t *,
368     uint32_t, uint32_t, smb_ofile_t *);
369 DWORD smb_node_rename_check(smb_node_t *);
370 DWORD smb_node_delete_check(smb_node_t *);
371 
372 uint64_t smb_node_get_size(smb_node_t *node, smb_attr_t *attr);
373 void smb_node_set_time(struct smb_node *node, timestruc_t *crtime,
374     timestruc_t *mtime, timestruc_t *atime,
375     timestruc_t *ctime, unsigned int what);
376 timestruc_t *smb_node_get_crtime(struct smb_node *node);
377 timestruc_t *smb_node_get_atime(struct smb_node *node);
378 timestruc_t *smb_node_get_ctime(struct smb_node *node);
379 timestruc_t *smb_node_get_mtime(struct smb_node *node);
380 void smb_node_set_dosattr(struct smb_node *, uint32_t);
381 uint32_t smb_node_get_dosattr(struct smb_node *node);
382 int smb_node_set_delete_on_close(smb_node_t *, cred_t *);
383 void smb_node_reset_delete_on_close(smb_node_t *);
384 
385 
386 
387 /*
388  * Pathname functions
389  */
390 
391 int smb_pathname_reduce(struct smb_request *, cred_t *,
392     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
393 
394 int smb_pathname(struct smb_request *, char *, int, smb_node_t *,
395     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
396 
397 /*
398  * smb_vfs functions
399  */
400 
401 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
402 void smb_vfs_rele(smb_server_t *, vfs_t *);
403 void smb_vfs_rele_all(smb_server_t *);
404 
405 /*
406  * String manipulation function
407  */
408 char *smb_kstrdup(const char *s, size_t n);
409 
410 int smb_sync_fsattr(struct smb_request *sr, cred_t *cr,
411     struct smb_node *node);
412 
413 DWORD	smb_validate_dirname(char *path);
414 
415 
416 void smb_encode_stream_info(struct smb_request *sr, struct smb_xa *xa,
417     smb_node_t *snode, smb_attr_t *attr);
418 
419 /* NOTIFY CHANGE */
420 void smb_process_session_notify_change_queue(struct smb_session *session);
421 void smb_process_node_notify_change_queue(struct smb_node *node);
422 void smb_reply_specific_cancel_request(struct smb_request *sr);
423 
424 void smb_fem_fcn_install(smb_node_t *node);
425 void smb_fem_fcn_uninstall(smb_node_t *node);
426 
427 /* FEM */
428 
429 int smb_fem_init(void);
430 void smb_fem_fini(void);
431 
432 int smb_try_grow(struct smb_request *sr, int64_t new_size);
433 
434 /* functions from smb_memory_manager.c */
435 
436 void	*smbsr_malloc(smb_malloc_list *, size_t);
437 void	*smbsr_realloc(void *, size_t);
438 void	smbsr_free_malloc_list(smb_malloc_list *);
439 
440 void smbsr_rq_notify(smb_request_t *sr,
441     smb_session_t *session, smb_tree_t *tree);
442 
443 unsigned short smb_worker_getnum();
444 int smb_common_close(struct smb_request *sr, uint32_t last_wtime);
445 void smb_preset_delete_on_close(struct smb_ofile *file);
446 void smb_commit_delete_on_close(struct smb_ofile *file);
447 
448 int smb_stream_parse_name(char *name, char *u_stream_name,
449     char *stream_name);
450 
451 DWORD smb_trans2_set_information(struct smb_request *sr,
452     smb_trans2_setinfo_t *info,
453     smb_error_t *smberr);
454 
455 /* SMB signing routines smb_signing.c */
456 void smb_sign_init(struct smb_request *req,
457 	smb_session_key_t *session_key, char *resp, int resp_len);
458 
459 int smb_sign_check_request(struct smb_request *req);
460 
461 int smb_sign_check_secondary(struct smb_request *req, unsigned int seqnum);
462 
463 void smb_sign_reply(struct smb_request *req, struct mbuf_chain *reply);
464 
465 uint32_t smb_mode_to_dos_attributes(smb_attr_t *ap);
466 int smb_sattr_check(smb_attr_t *ap, char *name, unsigned short sattr);
467 
468 void smb_request_cancel(smb_request_t *sr);
469 
470 /*
471  * session functions (file smb_session.c)
472  */
473 smb_session_t *smb_session_create(struct sonode *, uint16_t, smb_server_t *);
474 int smb_session_daemon(smb_session_list_t *);
475 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
476 void smb_session_timers(smb_session_list_t *);
477 void smb_session_delete(smb_session_t *session);
478 void smb_session_cancel(smb_session_t *session);
479 void smb_session_cancel_requests(smb_session_t *session);
480 void smb_session_config(smb_session_t *session);
481 void smb_session_reject(smb_session_t *session, char *reason);
482 void smb_session_disconnect_share(smb_session_list_t *, char *);
483 void smb_session_disconnect_volume(smb_session_list_t *, fs_desc_t *);
484 void smb_session_list_constructor(smb_session_list_t *);
485 void smb_session_list_destructor(smb_session_list_t *);
486 void smb_session_list_append(smb_session_list_t *, smb_session_t *);
487 void smb_session_list_delete_tail(smb_session_list_t *);
488 smb_session_t *smb_session_list_activate_head(smb_session_list_t *);
489 void smb_session_list_terminate(smb_session_list_t *, smb_session_t *);
490 void smb_session_list_signal(smb_session_list_t *);
491 
492 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
493 smb_request_t *smb_request_alloc(smb_session_t *, int);
494 void smb_request_free(smb_request_t *);
495 
496 
497 /*
498  * ofile functions (file smb_ofile.c)
499  */
500 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *tree, uint16_t fid);
501 smb_ofile_t *smb_ofile_open(smb_tree_t *tree, smb_node_t *node, uint16_t pid,
502     uint32_t access_granted, uint32_t create_options, uint32_t share_access,
503     uint16_t ftype, char *pipe_name, uint32_t rpc_fid, uint32_t uniqid,
504     smb_error_t *err);
505 int smb_ofile_close(smb_ofile_t *ofile, uint32_t last_wtime);
506 uint32_t smb_ofile_access(smb_ofile_t *ofile, cred_t *cr, uint32_t access);
507 int smb_ofile_seek(smb_ofile_t *of, ushort_t mode, int32_t off,
508     uint32_t *retoff);
509 void smb_ofile_release(smb_ofile_t *ofile);
510 void smb_ofile_close_all(smb_tree_t *tree);
511 void smb_ofile_close_all_by_pid(smb_tree_t *tree, uint16_t pid);
512 void smb_ofile_set_flags(smb_ofile_t *of, uint32_t flags);
513 void smb_ofile_close_timestamp_update(smb_ofile_t *of, uint32_t last_wtime);
514 boolean_t smb_ofile_is_open(smb_ofile_t *of);
515 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
516 
517 /*
518  * odir functions (file smb_odir.c)
519  */
520 smb_odir_t *smb_odir_open(smb_tree_t *tree, smb_node_t *node, char *pattern,
521     uint16_t pid, unsigned short sattr);
522 void smb_odir_close(smb_odir_t *od);
523 void smb_odir_close_all(smb_tree_t *tree);
524 void smb_odir_close_all_by_pid(smb_tree_t *tree, uint16_t pid);
525 void smb_odir_release(smb_odir_t *od);
526 smb_odir_t *smb_odir_lookup_by_sid(smb_tree_t *tree, uint16_t sid);
527 
528 /*
529  * SMB user functions (file smb_user.c)
530  */
531 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
532     char *, char *, uint32_t, uint32_t, uint32_t);
533 smb_user_t *smb_user_dup(smb_user_t *);
534 void smb_user_logoff(smb_user_t *user);
535 void smb_user_logoff_all(smb_session_t *session);
536 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, cred_t **, uint16_t);
537 smb_user_t *smb_user_lookup_by_name(smb_session_t *, char *, char *);
538 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *user);
539 void smb_user_disconnect_share(smb_user_t *user, char *sharename);
540 void smb_user_disconnect_volume(smb_user_t *user, fs_desc_t *fsd);
541 void smb_user_release(smb_user_t *user);
542 
543 /*
544  * SMB tree functions (file smb_tree.c)
545  */
546 smb_tree_t *smb_tree_connect(smb_user_t *user, uint16_t access_flags,
547     char *sharename, char *resource, int32_t rt_share,
548     smb_node_t *snode, fsvol_attr_t *vol_attr);
549 void smb_tree_disconnect(smb_tree_t *tree);
550 void smb_tree_disconnect_all(smb_user_t *user);
551 void smb_tree_close_all_by_pid(smb_user_t *user, uint16_t pid);
552 smb_tree_t *smb_tree_lookup_by_tid(smb_user_t *user, uint16_t tid);
553 smb_tree_t *smb_tree_lookup_by_name(smb_user_t *, char *, smb_tree_t *);
554 smb_tree_t *smb_tree_lookup_by_fsd(smb_user_t *, fs_desc_t *, smb_tree_t *);
555 void smb_tree_release(smb_tree_t *tree);
556 
557 void smb_dr_user_free(smb_dr_user_ctx_t *uinfo);
558 void smb_dr_ulist_free(smb_dr_ulist_t *ulist);
559 int smb_dr_user_create(smb_dr_user_ctx_t *, uint64_t, uint16_t, char *, char *,
560     char *, uint32_t, int32_t, time_t, uint32_t);
561 
562 
563 /*
564  * SMB user's credential functions
565  */
566 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
567 void smb_cred_rele(cred_t *cr);
568 int smb_cred_is_member(cred_t *cr, nt_sid_t *sid);
569 
570 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
571     uint32_t total_parameter_count, uint32_t total_data_count,
572     uint32_t max_parameter_count, uint32_t max_data_count,
573     uint32_t max_setup_count, uint32_t setup_word_count);
574 void smb_xa_delete(smb_xa_t *xa);
575 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
576 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
577 int smb_xa_open(smb_xa_t *xa);
578 void smb_xa_close(smb_xa_t *xa);
579 int smb_xa_complete(smb_xa_t *xa);
580 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
581 
582 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
583 struct mbuf *smb_mbuf_allocate(struct uio *uio);
584 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
585 
586 void smb_check_status(void);
587 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
588 
589 void smb_winpipe_init(void);
590 void smb_winpipe_fini(void);
591 int smb_winpipe_open(int door_id);
592 void smb_winpipe_close(void);
593 int smb_winpipe_call(smb_request_t *, mlsvc_pipe_t *, mlsvc_stream_t *,
594     uint16_t, uint32_t *, boolean_t *);
595 
596 void smb_reconnection_check(struct smb_session *session);
597 
598 uint32_t nt_to_unix_time(uint64_t nt_time, timestruc_t *unix_time);
599 uint64_t unix_to_nt_time(timestruc_t *);
600 
601 int netbios_name_isvalid(char *in, char *out);
602 
603 size_t
604 unicodestooems(char *oemstring, const mts_wchar_t *unicodestring,
605     size_t nbytes, unsigned int cpid);
606 
607 size_t oemstounicodes(mts_wchar_t *unicodestring, const char *oemstring,
608     size_t nwchars, unsigned int cpid);
609 
610 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
611 
612 int smb_match_name(ino64_t fileid, char *name, char *shortname,
613     char *name83, char *pattern, int ignore_case);
614 int is_dot_or_dotdot(char *name);
615 int token2buf(smb_token_t *token, char *buf);
616 
617 /*
618  * Pool ID function prototypes
619  */
620 int	smb_idpool_constructor(smb_idpool_t *pool);
621 void	smb_idpool_destructor(smb_idpool_t  *pool);
622 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
623 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
624 
625 /*
626  * SMB thread function prototypes
627  */
628 void	smb_session_worker(void *arg);
629 
630 /*
631  * SMB locked list function prototypes
632  */
633 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
634 void	smb_llist_destructor(smb_llist_t *);
635 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
636 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
637 void	smb_llist_remove(smb_llist_t *ll, void *obj);
638 int	smb_llist_upgrade(smb_llist_t *ll);
639 uint32_t smb_llist_get_count(smb_llist_t *ll);
640 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
641 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
642 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
643 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
644 int	smb_account_connected(smb_user_t *user);
645 
646 /*
647  * SMB Synchronized list function prototypes
648  */
649 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
650 void	smb_slist_destructor(smb_slist_t *);
651 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
652 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
653 void	smb_slist_remove(smb_slist_t *sl, void *obj);
654 void	smb_slist_wait_for_empty(smb_slist_t *sl);
655 void	smb_slist_exit(smb_slist_t *sl);
656 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
657 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
658 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
659 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
660 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
661 
662 void    smb_rwx_init(smb_rwx_t *rwx);
663 void    smb_rwx_destroy(smb_rwx_t *rwx);
664 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
665 void    smb_rwx_rwexit(smb_rwx_t *rwx);
666 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
667 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
668 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
669 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
670 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
671 
672 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
673     smb_thread_aw_t, void *);
674 void	smb_thread_destroy(smb_thread_t *);
675 int	smb_thread_start(smb_thread_t *);
676 void	smb_thread_stop(smb_thread_t *);
677 void    smb_thread_signal(smb_thread_t *);
678 boolean_t smb_thread_continue(smb_thread_t *);
679 boolean_t smb_thread_continue_nowait(smb_thread_t *);
680 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
681 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
682 
683 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
684 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
685 
686 void    smb_audit_buf_node_create(smb_node_t *node);
687 void    smb_audit_buf_node_destroy(smb_node_t *node);
688 #define	smb_audit_node(_n_)					\
689 	if ((_n_)->n_audit_buf) {				\
690 		smb_audit_record_node_t	*anr;			\
691 								\
692 		anr = (_n_)->n_audit_buf->anb_records;		\
693 		anr += (_n_)->n_audit_buf->anb_index;		\
694 		(_n_)->n_audit_buf->anb_index++;		\
695 		(_n_)->n_audit_buf->anb_index &=		\
696 		    (_n_)->n_audit_buf->anb_max_index;		\
697 		anr->anr_refcnt = node->n_refcnt;		\
698 		anr->anr_depth = getpcstack(anr->anr_stack,	\
699 		    SMB_AUDIT_STACK_DEPTH);			\
700 	}
701 
702 /* 100's of ns between 1/1/1970 and 1/1/1601 */
703 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
704 
705 void smb_sd_init(smb_sd_t *, uint8_t);
706 void smb_sd_term(smb_sd_t *);
707 uint32_t smb_sd_get_secinfo(smb_sd_t *);
708 uint32_t smb_sd_len(smb_sd_t *, uint32_t);
709 uint32_t smb_sd_tofs(smb_sd_t *, smb_fssd_t *);
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 void smb_fssd_init(smb_fssd_t *, uint32_t, uint32_t);
714 void smb_fssd_term(smb_fssd_t *);
715 
716 void smb_acl_sort(smb_acl_t *);
717 void smb_acl_free(smb_acl_t *);
718 smb_acl_t *smb_acl_alloc(uint8_t, uint16_t, uint16_t);
719 smb_acl_t *smb_acl_from_zfs(acl_t *, uid_t, gid_t);
720 uint32_t smb_acl_to_zfs(smb_acl_t *, uint32_t, int, acl_t **);
721 uint16_t smb_acl_len(smb_acl_t *);
722 boolean_t smb_acl_isvalid(smb_acl_t *, int);
723 
724 void smb_fsacl_free(acl_t *);
725 acl_t *smb_fsacl_alloc(int, int);
726 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
727 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
728 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
729 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
730 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
731 
732 boolean_t smb_ace_is_generic(int);
733 boolean_t smb_ace_is_access(int);
734 boolean_t smb_ace_is_audit(int);
735 
736 #ifdef	__cplusplus
737 }
738 #endif
739 
740 #endif /* _SMB_KPROTO_H_ */
741