xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_kproto.h (revision 2654012f83cec5dc15b61dfe3e4a4915f186e7a6)
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 #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/cred.h>
42 #include <smbsrv/smb_vops.h>
43 #include <smbsrv/smb_xdr.h>
44 #include <smbsrv/smb_token.h>
45 #include <smbsrv/smb_ktypes.h>
46 #include <smbsrv/smb_ioctl.h>
47 
48 extern	int smb_maxbufsize;
49 extern	int smb_flush_required;
50 extern	int smb_dirsymlink_enable;
51 extern	int smb_announce_quota;
52 extern	clock_t	smb_oplock_timeout;
53 extern	int smb_sign_debug;
54 
55 #define	smb_gmt2local(_sr_, _gmt_)	((_gmt_) - (_sr_)->sr_gmtoff)
56 #define	smb_local2gmt(_sr_, _local_)	((_local_) + (_sr_)->sr_gmtoff)
57 
58 int		fd_dealloc(int);
59 
60 off_t		lseek(int fildes, off_t offset, int whence);
61 
62 int		arpioctl(int cmd, void *data);
63 /* Why? uint32_t	inet_addr(char *str); */
64 int		microtime(timestruc_t *tvp);
65 int		clock_get_uptime(void);
66 
67 /*
68  * SMB request handers called from the dispatcher.
69  */
70 #define	SMB_SDT_OPS(NAME)	\
71 	smb_pre_##NAME,		\
72 	smb_com_##NAME,		\
73 	smb_post_##NAME
74 
75 #define	SMB_COM_DECL(NAME)				\
76 	smb_sdrc_t smb_pre_##NAME(smb_request_t *);	\
77 	smb_sdrc_t smb_com_##NAME(smb_request_t *);	\
78 	void smb_post_##NAME(smb_request_t *)
79 
80 SMB_COM_DECL(check_directory);
81 SMB_COM_DECL(close);
82 SMB_COM_DECL(close_and_tree_disconnect);
83 SMB_COM_DECL(close_print_file);
84 SMB_COM_DECL(create);
85 SMB_COM_DECL(create_directory);
86 SMB_COM_DECL(create_new);
87 SMB_COM_DECL(create_temporary);
88 SMB_COM_DECL(delete);
89 SMB_COM_DECL(delete_directory);
90 SMB_COM_DECL(echo);
91 SMB_COM_DECL(find);
92 SMB_COM_DECL(find_close);
93 SMB_COM_DECL(find_close2);
94 SMB_COM_DECL(find_unique);
95 SMB_COM_DECL(flush);
96 SMB_COM_DECL(get_print_queue);
97 SMB_COM_DECL(invalid);
98 SMB_COM_DECL(ioctl);
99 SMB_COM_DECL(lock_and_read);
100 SMB_COM_DECL(lock_byte_range);
101 SMB_COM_DECL(locking_andx);
102 SMB_COM_DECL(logoff_andx);
103 SMB_COM_DECL(negotiate);
104 SMB_COM_DECL(nt_cancel);
105 SMB_COM_DECL(nt_create_andx);
106 SMB_COM_DECL(nt_transact);
107 SMB_COM_DECL(nt_transact_secondary);
108 SMB_COM_DECL(open);
109 SMB_COM_DECL(open_andx);
110 SMB_COM_DECL(open_print_file);
111 SMB_COM_DECL(process_exit);
112 SMB_COM_DECL(query_information);
113 SMB_COM_DECL(query_information2);
114 SMB_COM_DECL(query_information_disk);
115 SMB_COM_DECL(read);
116 SMB_COM_DECL(read_andx);
117 SMB_COM_DECL(read_raw);
118 SMB_COM_DECL(rename);
119 SMB_COM_DECL(search);
120 SMB_COM_DECL(seek);
121 SMB_COM_DECL(session_setup_andx);
122 SMB_COM_DECL(set_information);
123 SMB_COM_DECL(set_information2);
124 SMB_COM_DECL(transaction);
125 SMB_COM_DECL(transaction2);
126 SMB_COM_DECL(transaction2_secondary);
127 SMB_COM_DECL(transaction_secondary);
128 SMB_COM_DECL(tree_connect);
129 SMB_COM_DECL(tree_connect_andx);
130 SMB_COM_DECL(tree_disconnect);
131 SMB_COM_DECL(unlock_byte_range);
132 SMB_COM_DECL(write);
133 SMB_COM_DECL(write_and_close);
134 SMB_COM_DECL(write_and_unlock);
135 SMB_COM_DECL(write_andx);
136 SMB_COM_DECL(write_print_file);
137 SMB_COM_DECL(write_raw);
138 
139 #define	SMB_NT_TRANSACT_DECL(NAME)				\
140 	smb_sdrc_t smb_pre_##NAME(smb_request_t *, smb_xa_t *);	\
141 	smb_sdrc_t smb_##NAME(smb_request_t *, smb_xa_t *);	\
142 	void smb_post_##NAME(smb_request_t *, smb_xa_t *)
143 
144 SMB_NT_TRANSACT_DECL(nt_transact_create);
145 
146 int smb_notify_init(void);
147 void smb_notify_fini(void);
148 
149 smb_sdrc_t smb_nt_transact_notify_change(struct smb_request *, struct smb_xa *);
150 smb_sdrc_t smb_nt_transact_query_security_info(struct smb_request *,
151     struct smb_xa *);
152 smb_sdrc_t smb_nt_transact_set_security_info(struct smb_request *,
153     struct smb_xa *);
154 smb_sdrc_t smb_nt_transact_ioctl(struct smb_request *, struct smb_xa *);
155 
156 smb_sdrc_t smb_com_trans2_create_directory(struct smb_request *,
157     struct smb_xa *);
158 smb_sdrc_t smb_com_trans2_find_first2(struct smb_request *, struct smb_xa *);
159 smb_sdrc_t smb_com_trans2_find_next2(struct smb_request *, struct smb_xa *);
160 smb_sdrc_t smb_com_trans2_query_fs_information(struct smb_request *,
161     struct smb_xa *);
162 smb_sdrc_t smb_com_trans2_query_path_information(struct smb_request *,
163     struct smb_xa *);
164 smb_sdrc_t smb_com_trans2_query_file_information(struct smb_request *,
165     struct smb_xa *);
166 smb_sdrc_t smb_com_trans2_set_path_information(struct smb_request *,
167     struct smb_xa *);
168 smb_sdrc_t smb_com_trans2_set_file_information(struct smb_request *,
169     struct smb_xa *);
170 
171 /*
172  * Logging functions
173  */
174 void smb_log_flush(void);
175 void smb_correct_keep_alive_values(uint32_t new_keep_alive);
176 void smb_close_all_connections(void);
177 int smb_set_file_size(smb_request_t *, smb_node_t *);
178 int smb_session_send(smb_session_t *, uint8_t type, struct mbuf_chain *);
179 int smb_session_xprt_gethdr(smb_session_t *, smb_xprt_t *);
180 
181 int smb_net_id(uint32_t);
182 
183 void smb_process_file_notify_change_queue(struct smb_ofile *of);
184 
185 DWORD smb_oplock_acquire(struct smb_request *, struct smb_ofile *,
186     struct open_param *);
187 void smb_oplock_break(struct smb_node *);
188 void smb_oplock_release(struct smb_node *, boolean_t);
189 boolean_t smb_oplock_conflict(struct smb_node *, struct smb_session *,
190     struct open_param *);
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 	((sess1)->ipaddr == (sess2)->ipaddr) &&			\
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 
238 void smbsr_cleanup(struct smb_request *sr);
239 
240 int smbsr_connect_tree(struct smb_request *);
241 
242 int smb_common_create_directory(struct smb_request *);
243 
244 int		smb_convert_unicode_wildcards(char *);
245 int	smb_ascii_or_unicode_strlen(struct smb_request *, char *);
246 int	smb_ascii_or_unicode_strlen_null(struct smb_request *, char *);
247 int	smb_ascii_or_unicode_null_len(struct smb_request *);
248 
249 int	smb_search(struct smb_request *);
250 void smb_rdir_close(struct smb_request *);
251 int	smb_rdir_open(struct smb_request *, char *, unsigned short);
252 int smb_rdir_next(smb_request_t *sr, smb_node_t **rnode,
253     smb_odir_context_t *pc);
254 
255 uint32_t smb_common_open(smb_request_t *);
256 DWORD smb_validate_object_name(char *path, unsigned int ftype);
257 
258 uint32_t smb_omode_to_amask(uint32_t desired_access);
259 
260 void	sshow_distribution_info(char *);
261 
262 void	smb_dispatch_request(struct smb_request *);
263 void	smbsr_disconnect_file(smb_request_t *);
264 void	smbsr_disconnect_dir(smb_request_t *);
265 int	smbsr_encode_empty_result(struct smb_request *);
266 
267 int	smbsr_decode_vwv(struct smb_request *sr, char *fmt, ...);
268 int	smbsr_decode_data(struct smb_request *sr, char *fmt, ...);
269 int	smbsr_encode_result(struct smb_request *, int, int, char *, ...);
270 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
271 void	smbsr_send_reply(struct smb_request *);
272 
273 void	smbsr_map_errno(int, smb_error_t *);
274 void	smbsr_set_error(smb_request_t *, smb_error_t *);
275 void	smbsr_errno(struct smb_request *, int);
276 void	smbsr_warn(struct smb_request *, DWORD, uint16_t, uint16_t);
277 void	smbsr_error(struct smb_request *, DWORD, uint16_t, uint16_t);
278 
279 int	clock_get_milli_uptime(void);
280 int32_t	smb_dos_to_ux_time(int16_t, int16_t);
281 int32_t	smb_ux_to_dos_time(int32_t, int16_t *, int16_t *);
282 
283 int	smb_mbc_vencodef(mbuf_chain_t *, char *, va_list);
284 int	smb_mbc_vdecodef(mbuf_chain_t *, char *, va_list);
285 int	smb_mbc_decodef(mbuf_chain_t *, char *, ...);
286 int	smb_mbc_encodef(mbuf_chain_t *, char *, ...);
287 int	smb_mbc_peek(mbuf_chain_t *, int, char *, ...);
288 int	smb_mbc_poke(mbuf_chain_t *, int, char *, ...);
289 
290 void	smbsr_encode_header(struct smb_request *sr, int wct,
291 		    int bcc, char *fmt, ...);
292 
293 int	smb_xlate_dialect_str_to_cd(char *);
294 char	*smb_xlate_com_cd_to_str(int);
295 char	*smb_xlate_dialect_cd_to_str(int);
296 
297 void	smb_od_destruct(struct smb_session *, struct smb_odir *);
298 int	smbd_fs_query(struct smb_request *, struct smb_fqi *, int);
299 int smb_component_match(struct smb_request *sr, ino64_t fileid,
300     struct smb_odir *od, smb_odir_context_t *pc);
301 
302 int smb_lock_range_access(struct smb_request *, struct smb_node *,
303     uint64_t, uint64_t, boolean_t);
304 
305 uint32_t smb_decode_sd(struct smb_xa *, smb_sd_t *);
306 
307 /*
308  * Socket functions
309  */
310 struct sonode *smb_socreate(int domain, int type, int protocol);
311 void smb_soshutdown(struct sonode *so);
312 void smb_sodestroy(struct sonode *so);
313 int smb_sorecv(struct sonode *so, void *msg, size_t len);
314 int smb_iov_sorecv(struct sonode *so, iovec_t *iop, int iovlen,
315     size_t total_len);
316 int smb_net_init(void);
317 void smb_net_fini(void);
318 void smb_net_txl_constructor(smb_txlst_t *);
319 void smb_net_txl_destructor(smb_txlst_t *);
320 smb_txreq_t *smb_net_txr_alloc(void);
321 void smb_net_txr_free(smb_txreq_t *);
322 int smb_net_txr_send(struct sonode *, smb_txlst_t *, smb_txreq_t *);
323 
324 /*
325  * SMB RPC interface
326  */
327 int smb_opipe_open(smb_request_t *);
328 void smb_opipe_close(smb_ofile_t *);
329 smb_sdrc_t smb_opipe_transact(smb_request_t *, struct uio *);
330 int smb_opipe_read(smb_request_t *, struct uio *);
331 int smb_opipe_write(smb_request_t *, struct uio *);
332 
333 void smb_opipe_door_init(void);
334 void smb_opipe_door_fini(void);
335 int smb_opipe_door_open(int);
336 void smb_opipe_door_close(void);
337 void smb_user_context_init(smb_user_t *, smb_opipe_context_t *);
338 void smb_user_list_free(smb_dr_ulist_t *);
339 
340 /*
341  * SMB server functions (file smb_server.c)
342  */
343 int smb_server_svc_init(void);
344 int smb_server_svc_fini(void);
345 int smb_server_create(void);
346 int smb_server_delete(void);
347 int smb_server_configure(smb_kmod_cfg_t *cfg);
348 int smb_server_start(struct smb_io_start *);
349 int smb_server_nbt_listen(int);
350 int smb_server_tcp_listen(int);
351 int smb_server_nbt_receive(void);
352 int smb_server_tcp_receive(void);
353 uint32_t smb_server_get_user_count(void);
354 uint32_t smb_server_get_session_count(void);
355 int smb_server_dr_ulist_get(int, smb_dr_ulist_t *, int);
356 int smb_server_share_export(char *);
357 int smb_server_share_unexport(char *, char *);
358 int smb_server_set_gmtoff(int32_t goff);
359 
360 void smb_server_reconnection_check(smb_server_t *, smb_session_t *);
361 void smb_server_get_cfg(smb_server_t *, smb_kmod_cfg_t *);
362 
363 /*
364  * SMB node functions (file smb_node.c)
365  */
366 int smb_node_init(void);
367 void smb_node_fini(void);
368 struct smb_node *smb_node_lookup(struct smb_request *sr, struct open_param *op,
369     cred_t *cr, vnode_t *vp, char *od_name, smb_node_t *dir_snode,
370     smb_node_t *unnamed_node, smb_attr_t *attr);
371 struct smb_node *smb_stream_node_lookup(struct smb_request *sr, cred_t *cr,
372     smb_node_t *fnode, vnode_t *xattrdirvp, vnode_t *vp, char *stream_name,
373     smb_attr_t *ret_attr);
374 void smb_node_ref(smb_node_t *node);
375 void smb_node_release(smb_node_t *node);
376 int smb_node_assert(smb_node_t *node, const char *file, int line);
377 int smb_node_rename(smb_node_t *from_dir_snode, smb_node_t *ret_snode,
378     smb_node_t *to_dir_snode, char *to_name);
379 int smb_node_root_init(vnode_t *, smb_server_t *, smb_node_t **);
380 void smb_node_add_lock(smb_node_t *node, smb_lock_t *lock);
381 void smb_node_destroy_lock(smb_node_t *node, smb_lock_t *lock);
382 void smb_node_destroy_lock_by_ofile(smb_node_t *node, smb_ofile_t *file);
383 void smb_node_start_crit(smb_node_t *node, krw_t mode);
384 void smb_node_end_crit(smb_node_t *node);
385 int smb_node_in_crit(smb_node_t *node);
386 
387 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
388     uint32_t, uint32_t);
389 DWORD smb_node_rename_check(smb_node_t *);
390 DWORD smb_node_delete_check(smb_node_t *);
391 
392 u_offset_t smb_node_get_size(smb_node_t *, smb_attr_t *);
393 void smb_node_set_time(struct smb_node *node, timestruc_t *crtime,
394     timestruc_t *mtime, timestruc_t *atime,
395     timestruc_t *ctime, unsigned int what);
396 timestruc_t *smb_node_get_crtime(struct smb_node *node);
397 timestruc_t *smb_node_get_atime(struct smb_node *node);
398 timestruc_t *smb_node_get_ctime(struct smb_node *node);
399 timestruc_t *smb_node_get_mtime(struct smb_node *node);
400 void smb_node_set_dosattr(struct smb_node *, uint32_t);
401 uint32_t smb_node_get_dosattr(struct smb_node *node);
402 int smb_node_set_delete_on_close(smb_node_t *, cred_t *);
403 void smb_node_reset_delete_on_close(smb_node_t *);
404 
405 
406 
407 /*
408  * Pathname functions
409  */
410 
411 int smb_pathname_reduce(struct smb_request *, cred_t *,
412     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
413 
414 int smb_pathname(struct smb_request *, char *, int, smb_node_t *,
415     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
416 
417 /*
418  * smb_vfs functions
419  */
420 
421 boolean_t smb_vfs_hold(smb_server_t *, vfs_t *);
422 void smb_vfs_rele(smb_server_t *, vfs_t *);
423 void smb_vfs_rele_all(smb_server_t *);
424 boolean_t smb_vfs_cmp(vfs_t *, vfs_t *);
425 boolean_t smb_vfs_is_readonly(vfs_t *);
426 
427 
428 /*
429  * String manipulation function
430  */
431 char *smb_kstrdup(const char *s, size_t n);
432 
433 int smb_sync_fsattr(struct smb_request *sr, cred_t *cr,
434     struct smb_node *node);
435 
436 DWORD	smb_validate_dirname(char *path);
437 
438 
439 void smb_encode_stream_info(struct smb_request *sr, struct smb_xa *xa,
440     smb_node_t *snode, smb_attr_t *attr);
441 
442 /* NOTIFY CHANGE */
443 void smb_process_session_notify_change_queue(smb_session_t *, smb_tree_t *);
444 void smb_process_node_notify_change_queue(struct smb_node *);
445 void smb_reply_specific_cancel_request(struct smb_request *);
446 
447 void smb_fem_fcn_install(smb_node_t *);
448 void smb_fem_fcn_uninstall(smb_node_t *);
449 
450 /* FEM */
451 
452 int smb_fem_init(void);
453 void smb_fem_fini(void);
454 
455 int smb_try_grow(struct smb_request *sr, int64_t new_size);
456 
457 /* functions from smb_memory_manager.c */
458 
459 void	*smbsr_malloc(smb_malloc_list *, size_t);
460 void	*smbsr_realloc(void *, size_t);
461 void	smbsr_free_malloc_list(smb_malloc_list *);
462 
463 unsigned short smb_worker_getnum();
464 void smb_preset_delete_on_close(struct smb_ofile *file);
465 void smb_commit_delete_on_close(struct smb_ofile *file);
466 
467 int smb_stream_parse_name(char *name, char *u_stream_name,
468     char *stream_name);
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(smb_attr_t *, char *, unsigned short);
485 
486 void smb_request_cancel(smb_request_t *sr);
487 
488 /*
489  * session functions (file smb_session.c)
490  */
491 smb_session_t *smb_session_create(struct sonode *, uint16_t, smb_server_t *);
492 int smb_session_daemon(smb_session_list_t *);
493 void smb_session_reconnection_check(smb_session_list_t *, smb_session_t *);
494 void smb_session_timers(smb_session_list_t *);
495 void smb_session_delete(smb_session_t *session);
496 void smb_session_cancel(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 
509 void smb_session_correct_keep_alive_values(smb_session_list_t *, uint32_t);
510 smb_request_t *smb_request_alloc(smb_session_t *, int);
511 void smb_request_free(smb_request_t *);
512 
513 
514 /*
515  * ofile functions (file smb_ofile.c)
516  */
517 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *, uint16_t);
518 smb_ofile_t *smb_ofile_open(smb_tree_t *, smb_node_t *, uint16_t,
519     struct open_param *, uint16_t, uint32_t, smb_error_t *);
520 void smb_ofile_close(smb_ofile_t *, uint32_t);
521 uint32_t smb_ofile_access(smb_ofile_t *, cred_t *, uint32_t);
522 int smb_ofile_seek(smb_ofile_t *, ushort_t, int32_t, uint32_t *);
523 void smb_ofile_release(smb_ofile_t *);
524 void smb_ofile_close_all(smb_tree_t *);
525 void smb_ofile_close_all_by_pid(smb_tree_t *, uint16_t);
526 void smb_ofile_set_flags(smb_ofile_t *, uint32_t);
527 void smb_ofile_close_timestamp_update(smb_ofile_t *, uint32_t);
528 boolean_t smb_ofile_is_open(smb_ofile_t *);
529 uint32_t smb_ofile_open_check(smb_ofile_t *, cred_t *,
530     uint32_t, uint32_t);
531 uint32_t smb_ofile_rename_check(smb_ofile_t *);
532 uint32_t smb_ofile_delete_check(smb_ofile_t *);
533 
534 
535 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
536 
537 /*
538  * odir functions (file smb_odir.c)
539  */
540 smb_odir_t *smb_odir_open(smb_tree_t *tree, smb_node_t *node, char *pattern,
541     uint16_t pid, unsigned short sattr);
542 void smb_odir_close(smb_odir_t *od);
543 void smb_odir_close_all(smb_tree_t *tree);
544 void smb_odir_close_all_by_pid(smb_tree_t *tree, uint16_t pid);
545 void smb_odir_release(smb_odir_t *od);
546 smb_odir_t *smb_odir_lookup_by_sid(smb_tree_t *tree, uint16_t sid);
547 
548 /*
549  * SMB user functions (file smb_user.c)
550  */
551 int smb_user_init(void);
552 void smb_user_fini(void);
553 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
554     char *, char *, uint32_t, uint32_t, uint32_t);
555 smb_user_t *smb_user_dup(smb_user_t *);
556 void smb_user_logoff(smb_user_t *);
557 void smb_user_logoff_all(smb_session_t *);
558 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, cred_t **, uint16_t);
559 smb_user_t *smb_user_lookup_by_name(smb_session_t *, char *, char *);
560 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *);
561 smb_tree_t *smb_user_lookup_tree(smb_user_t *, uint16_t);
562 smb_tree_t *smb_user_lookup_share(smb_user_t *, const char *, smb_tree_t *);
563 smb_tree_t *smb_user_lookup_volume(smb_user_t *, const char *, smb_tree_t *);
564 boolean_t smb_user_is_admin(smb_user_t *);
565 void smb_user_close_pid(smb_user_t *, uint16_t);
566 void smb_user_disconnect_trees(smb_user_t *user);
567 void smb_user_disconnect_share(smb_user_t *, const char *);
568 void smb_user_release(smb_user_t *);
569 
570 /*
571  * SMB tree functions (file smb_tree.c)
572  */
573 smb_tree_t *smb_tree_connect(smb_request_t *);
574 void smb_tree_disconnect(smb_tree_t *);
575 void smb_tree_close_pid(smb_tree_t *, uint16_t);
576 boolean_t smb_tree_has_feature(smb_tree_t *, uint_t);
577 boolean_t smb_tree_hold(smb_tree_t *);
578 void smb_tree_release(smb_tree_t *);
579 
580 void smb_dr_ulist_free(smb_dr_ulist_t *ulist);
581 
582 /*
583  * SMB user's credential functions
584  */
585 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
586 void smb_cred_rele(cred_t *cr);
587 int smb_cred_is_member(cred_t *cr, smb_sid_t *sid);
588 
589 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
590     uint32_t total_parameter_count, uint32_t total_data_count,
591     uint32_t max_parameter_count, uint32_t max_data_count,
592     uint32_t max_setup_count, uint32_t setup_word_count);
593 void smb_xa_delete(smb_xa_t *xa);
594 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
595 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
596 int smb_xa_open(smb_xa_t *xa);
597 void smb_xa_close(smb_xa_t *xa);
598 int smb_xa_complete(smb_xa_t *xa);
599 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
600 
601 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
602 struct mbuf *smb_mbuf_allocate(struct uio *uio);
603 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
604 
605 void smb_check_status(void);
606 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
607 
608 void smb_reconnection_check(struct smb_session *session);
609 
610 uint32_t nt_to_unix_time(uint64_t nt_time, timestruc_t *unix_time);
611 uint64_t unix_to_nt_time(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 *, char *, char *, boolean_t);
625 boolean_t smb_is_dot_or_dotdot(const char *);
626 int token2buf(smb_token_t *token, char *buf);
627 
628 /*
629  * Pool ID function prototypes
630  */
631 int	smb_idpool_constructor(smb_idpool_t *pool);
632 void	smb_idpool_destructor(smb_idpool_t  *pool);
633 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
634 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
635 
636 /*
637  * SMB thread function prototypes
638  */
639 void	smb_session_worker(void *arg);
640 
641 /*
642  * SMB locked list function prototypes
643  */
644 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
645 void	smb_llist_destructor(smb_llist_t *);
646 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
647 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
648 void	smb_llist_remove(smb_llist_t *ll, void *obj);
649 int	smb_llist_upgrade(smb_llist_t *ll);
650 uint32_t smb_llist_get_count(smb_llist_t *ll);
651 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
652 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
653 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
654 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
655 int	smb_account_connected(smb_user_t *user);
656 
657 /*
658  * SMB Synchronized list function prototypes
659  */
660 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
661 void	smb_slist_destructor(smb_slist_t *);
662 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
663 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
664 void	smb_slist_remove(smb_slist_t *sl, void *obj);
665 void	smb_slist_wait_for_empty(smb_slist_t *sl);
666 void	smb_slist_exit(smb_slist_t *sl);
667 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
668 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
669 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
670 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
671 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
672 
673 void    smb_rwx_init(smb_rwx_t *rwx);
674 void    smb_rwx_destroy(smb_rwx_t *rwx);
675 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
676 void    smb_rwx_rwexit(smb_rwx_t *rwx);
677 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
678 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
679 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
680 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
681 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
682 
683 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
684     smb_thread_aw_t, void *);
685 void	smb_thread_destroy(smb_thread_t *);
686 int	smb_thread_start(smb_thread_t *);
687 void	smb_thread_stop(smb_thread_t *);
688 void    smb_thread_signal(smb_thread_t *);
689 boolean_t smb_thread_continue(smb_thread_t *);
690 boolean_t smb_thread_continue_nowait(smb_thread_t *);
691 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
692 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
693 
694 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
695 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
696 
697 void    smb_audit_buf_node_create(smb_node_t *node);
698 void    smb_audit_buf_node_destroy(smb_node_t *node);
699 #define	smb_audit_node(_n_)					\
700 	if ((_n_)->n_audit_buf) {				\
701 		smb_audit_record_node_t	*anr;			\
702 								\
703 		anr = (_n_)->n_audit_buf->anb_records;		\
704 		anr += (_n_)->n_audit_buf->anb_index;		\
705 		(_n_)->n_audit_buf->anb_index++;		\
706 		(_n_)->n_audit_buf->anb_index &=		\
707 		    (_n_)->n_audit_buf->anb_max_index;		\
708 		anr->anr_refcnt = node->n_refcnt;		\
709 		anr->anr_depth = getpcstack(anr->anr_stack,	\
710 		    SMB_AUDIT_STACK_DEPTH);			\
711 	}
712 
713 /* 100's of ns between 1/1/1970 and 1/1/1601 */
714 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
715 
716 void smb_sd_init(smb_sd_t *, uint8_t);
717 void smb_sd_term(smb_sd_t *);
718 uint32_t smb_sd_get_secinfo(smb_sd_t *);
719 uint32_t smb_sd_len(smb_sd_t *, uint32_t);
720 uint32_t smb_sd_tofs(smb_sd_t *, smb_fssd_t *);
721 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
722 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
723 
724 void smb_fssd_init(smb_fssd_t *, uint32_t, uint32_t);
725 void smb_fssd_term(smb_fssd_t *);
726 
727 void smb_acl_sort(smb_acl_t *);
728 void smb_acl_free(smb_acl_t *);
729 smb_acl_t *smb_acl_alloc(uint8_t, uint16_t, uint16_t);
730 smb_acl_t *smb_acl_from_zfs(acl_t *, uid_t, gid_t);
731 uint32_t smb_acl_to_zfs(smb_acl_t *, uint32_t, int, acl_t **);
732 uint16_t smb_acl_len(smb_acl_t *);
733 boolean_t smb_acl_isvalid(smb_acl_t *, int);
734 
735 void smb_fsacl_free(acl_t *);
736 acl_t *smb_fsacl_alloc(int, int);
737 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
738 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
739 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
740 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
741 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
742 
743 boolean_t smb_ace_is_generic(int);
744 boolean_t smb_ace_is_access(int);
745 boolean_t smb_ace_is_audit(int);
746 
747 #ifdef	__cplusplus
748 }
749 #endif
750 
751 #endif /* _SMB_KPROTO_H_ */
752