xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_kproto.h (revision d5e8e65e99a4ed37bbb4a0deff5a670d982f91c1)
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/smbvar.h>
48 
49 /*
50  * Definitions that should be elsewhere...
51  */
52 struct mbuf	*m_free(struct mbuf *);
53 void		m_freem(struct mbuf *);
54 
55 int		fd_dealloc(int);
56 
57 off_t		lseek(int fildes, off_t offset, int whence);
58 
59 int		arpioctl(int cmd, void *data);
60 /* Why? uint32_t	inet_addr(char *str); */
61 int		microtime(timestruc_t *tvp);
62 int		clock_get_uptime(void);
63 
64 /*
65  * SMB Service init/shutdown functions
66  */
67 int smb_service_init(void);
68 void smb_service_fini(void);
69 int smb_service_open(struct smb_info *si);
70 void smb_service_close(struct smb_info *si);
71 int smb_service_connect(struct smb_info *si);
72 void smb_service_disconnect(struct smb_info *si);
73 int smb_service_start_threads(struct smb_info *si);
74 void smb_service_stop_threads(struct smb_info *si);
75 
76 /*
77  * SMB request handers called from the dispatcher.
78  */
79 smb_sdrc_t smb_com_cancel_forward(struct smb_request *);
80 smb_sdrc_t smb_com_check_directory(struct smb_request *);
81 smb_sdrc_t smb_com_close(struct smb_request *);
82 smb_sdrc_t smb_com_close_and_tree_disconnect(struct smb_request *);
83 smb_sdrc_t smb_com_close_print_file(struct smb_request *);
84 smb_sdrc_t smb_com_copy(struct smb_request *);
85 smb_sdrc_t smb_com_create(struct smb_request *);
86 smb_sdrc_t smb_com_create_directory(struct smb_request *);
87 smb_sdrc_t smb_com_create_new(struct smb_request *);
88 smb_sdrc_t smb_com_create_temporary(struct smb_request *);
89 smb_sdrc_t smb_com_delete(struct smb_request *);
90 smb_sdrc_t smb_com_delete_directory(struct smb_request *);
91 smb_sdrc_t smb_com_echo(struct smb_request *);
92 smb_sdrc_t smb_com_find(struct smb_request *);
93 smb_sdrc_t smb_com_find_close(struct smb_request *);
94 smb_sdrc_t smb_com_find_close2(struct smb_request *);
95 smb_sdrc_t smb_com_find_notify_close(struct smb_request *);
96 smb_sdrc_t smb_com_find_unique(struct smb_request *);
97 smb_sdrc_t smb_com_flush(struct smb_request *);
98 smb_sdrc_t smb_com_forward_user_name(struct smb_request *);
99 smb_sdrc_t smb_com_get_machine_name(struct smb_request *);
100 smb_sdrc_t smb_com_get_print_queue(struct smb_request *);
101 smb_sdrc_t smb_com_invalid_command(struct smb_request *);
102 smb_sdrc_t smb_com_ioctl(struct smb_request *);
103 smb_sdrc_t smb_com_ioctl_secondary(struct smb_request *);
104 smb_sdrc_t smb_com_lock_and_read(struct smb_request *);
105 smb_sdrc_t smb_com_lock_byte_range(struct smb_request *);
106 smb_sdrc_t smb_com_locking_andx(struct smb_request *);
107 smb_sdrc_t smb_com_logoff_andx(struct smb_request *);
108 smb_sdrc_t smb_com_move(struct smb_request *);
109 smb_sdrc_t smb_com_negotiate(struct smb_request *);
110 smb_sdrc_t smb_com_nt_cancel(struct smb_request *);
111 smb_sdrc_t smb_com_nt_create_andx(struct smb_request *);
112 smb_sdrc_t smb_com_nt_transact(struct smb_request *);
113 smb_sdrc_t smb_com_nt_transact_secondary(struct smb_request *);
114 smb_sdrc_t smb_com_open(struct smb_request *);
115 smb_sdrc_t smb_com_open_andx(struct smb_request *);
116 smb_sdrc_t smb_com_open_print_file(struct smb_request *);
117 smb_sdrc_t smb_com_process_exit(struct smb_request *);
118 smb_sdrc_t smb_com_query_information(struct smb_request *);
119 smb_sdrc_t smb_com_query_information2(struct smb_request *);
120 smb_sdrc_t smb_com_query_information_disk(struct smb_request *);
121 smb_sdrc_t smb_com_read(struct smb_request *);
122 smb_sdrc_t smb_com_read_andx(struct smb_request *);
123 smb_sdrc_t smb_com_read_mpx(struct smb_request *);
124 smb_sdrc_t smb_com_read_mpx_secondary(struct smb_request *);
125 smb_sdrc_t smb_com_read_raw(struct smb_request *);
126 smb_sdrc_t smb_com_rename(struct smb_request *);
127 smb_sdrc_t smb_com_search(struct smb_request *);
128 smb_sdrc_t smb_com_seek(struct smb_request *);
129 smb_sdrc_t smb_com_send_broadcast_message(struct smb_request *);
130 smb_sdrc_t smb_com_send_end_mb_message(struct smb_request *);
131 smb_sdrc_t smb_com_send_single_message(struct smb_request *);
132 smb_sdrc_t smb_com_send_start_mb_message(struct smb_request *);
133 smb_sdrc_t smb_com_send_text_mb_message(struct smb_request *);
134 smb_sdrc_t smb_com_session_setup_andx(struct smb_request *);
135 smb_sdrc_t smb_com_set_information(struct smb_request *);
136 smb_sdrc_t smb_com_set_information2(struct smb_request *);
137 smb_sdrc_t smb_com_transaction(struct smb_request *);
138 smb_sdrc_t smb_com_transaction2(struct smb_request *);
139 smb_sdrc_t smb_com_transaction2_secondary(struct smb_request *);
140 smb_sdrc_t smb_com_transaction_secondary(struct smb_request *);
141 smb_sdrc_t smb_com_tree_connect(struct smb_request *);
142 smb_sdrc_t smb_com_tree_connect_andx(struct smb_request *);
143 smb_sdrc_t smb_com_tree_disconnect(struct smb_request *);
144 smb_sdrc_t smb_com_unlock_byte_range(struct smb_request *);
145 smb_sdrc_t smb_com_write(struct smb_request *);
146 smb_sdrc_t smb_com_write_and_close(struct smb_request *);
147 smb_sdrc_t smb_com_write_and_unlock(struct smb_request *);
148 smb_sdrc_t smb_com_write_andx(struct smb_request *);
149 smb_sdrc_t smb_com_write_complete(struct smb_request *);
150 smb_sdrc_t smb_com_write_mpx(struct smb_request *);
151 smb_sdrc_t smb_com_write_mpx_secondary(struct smb_request *);
152 smb_sdrc_t smb_com_write_print_file(struct smb_request *);
153 smb_sdrc_t smb_com_write_raw(struct smb_request *);
154 
155 smb_sdrc_t smb_nt_transact_create(struct smb_request *, struct smb_xa *);
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 uint32_t smb_gmt_to_local_time(uint32_t);
190 uint32_t smb_local_time_to_gmt(uint32_t);
191 
192 void smb_process_file_notify_change_queue(struct smb_ofile *of);
193 
194 void smb_oplock_init(void);
195 
196 DWORD smb_acquire_oplock(struct smb_request *sr,
197     struct smb_ofile *file,
198     unsigned int level_requested,
199     unsigned int *level_granted);
200 
201 DWORD smb_break_oplock(struct smb_request *sr, struct smb_node *node);
202 void smb_release_oplock(struct smb_ofile *file, int reason);
203 
204 uint32_t smb_unlock_range(struct smb_request *, struct smb_node *,
205     uint64_t, uint64_t);
206 uint32_t smb_lock_range(struct smb_request *, struct smb_ofile *,
207     uint64_t, uint64_t, uint32_t, uint32_t);
208 void smb_lock_range_error(smb_request_t *, uint32_t);
209 
210 DWORD smb_range_check(smb_request_t *, cred_t *, smb_node_t *,
211     uint64_t, uint64_t, boolean_t);
212 
213 int smb_mangle_name(ino64_t fileid, char *name, char *shortname,
214     char *name83, int force);
215 int smb_unmangle_name(struct smb_request *sr, cred_t *cred,
216     smb_node_t *dir_node, char *name, char *real_name, int realname_size,
217     char *shortname, char *name83, int od);
218 int smb_maybe_mangled_name(char *name);
219 int smb_maybe_mangled_path(const char *path, size_t pathlen);
220 int smb_needs_mangle(char *name, char **dot_pos);
221 
222 void smb_set_stability(int mode);
223 void smb_commit_required(int state);
224 
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_unicode_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 void smb_rdir_close(struct smb_request *);
239 int	smb_rdir_open(struct smb_request *, char *, unsigned short);
240 int smb_rdir_next(smb_request_t *sr, smb_node_t **rnode,
241     smb_odir_context_t *pc);
242 
243 uint32_t smb_common_open(smb_request_t *);
244 DWORD smb_validate_object_name(char *path, unsigned int ftype);
245 
246 uint32_t smb_omode_to_amask(uint32_t desired_access);
247 
248 void	sshow_distribution_info(char *);
249 
250 void	smb_dispatch_request(struct smb_request *);
251 void	smbsr_disconnect_file(smb_request_t *);
252 void	smbsr_disconnect_dir(smb_request_t *);
253 int	smbsr_encode_empty_result(struct smb_request *);
254 
255 int	smbsr_decode_vwv(struct smb_request *sr, char *fmt, ...);
256 int	smbsr_decode_data(struct smb_request *sr, char *fmt, ...);
257 int	smbsr_encode_result(struct smb_request *, int, int, char *, ...);
258 smb_xa_t *smbsr_lookup_xa(smb_request_t *sr);
259 void	smbsr_send_reply(struct smb_request *);
260 
261 void	smbsr_map_errno(int, smb_error_t *);
262 void	smbsr_set_error(smb_request_t *, smb_error_t *);
263 void	smbsr_errno(struct smb_request *, int);
264 void	smbsr_warn(struct smb_request *, DWORD, uint16_t, uint16_t);
265 void	smbsr_error(struct smb_request *, DWORD, uint16_t, uint16_t);
266 
267 int	smb_mbc_encode(struct mbuf_chain *mbc, char *fmt, va_list ap);
268 int	smb_mbc_decode(struct mbuf_chain *mbc, char *fmt, va_list ap);
269 
270 int	clock_get_milli_uptime(void);
271 int	dosfs_dos_to_ux_time(int, int);
272 int	dosfs_ux_to_dos_time(int, short int *, short int *);
273 
274 int	smb_decode_mbc(struct  mbuf_chain *mbc, char *fmt, ...);
275 int	smb_decode_buf(unsigned char *buf, int n_buf, char *fmt, ...);
276 int	smb_encode_mbc(struct mbuf_chain *mbc, char *fmt, ...);
277 int	smb_encode_buf(unsigned char *buf, int n_buf, char *fmt, ...);
278 int	smb_peek_mbc(struct mbuf_chain *buf, int offset, char *fmt, ...);
279 int	smb_poke_mbc(struct mbuf_chain *buf, int offset, char *fmt, ...);
280 
281 void	smbsr_encode_header(struct smb_request *sr, int wct,
282 		    int bcc, char *fmt, ...);
283 
284 int	smb_xlate_dialect_str_to_cd(char *);
285 char	*smb_xlate_com_cd_to_str(int);
286 char	*smb_xlate_dialect_cd_to_str(int);
287 
288 void	smb_od_destruct(struct smb_session *, struct smb_odir *);
289 int	smbd_fs_query(struct smb_request *, struct smb_fqi *, int);
290 int smb_component_match(struct smb_request *sr, ino64_t fileid,
291     struct smb_odir *od, smb_odir_context_t *pc);
292 
293 int smb_lock_range_access(struct smb_request *, struct smb_node *,
294     uint64_t, uint64_t, boolean_t);
295 
296 uint32_t smb_decode_sd(struct smb_xa *, smb_sd_t *);
297 
298 /*
299  * Socket functions
300  */
301 struct sonode *smb_socreate(int domain, int type, int protocol);
302 void smb_soshutdown(struct sonode *so);
303 void smb_sodestroy(struct sonode *so);
304 int smb_sorecv(struct sonode *so, void *msg, size_t len);
305 int smb_iov_sorecv(struct sonode *so, iovec_t *iop, int iovlen,
306     size_t total_len);
307 void smb_net_txl_constructor(smb_txlst_t *);
308 void smb_net_txl_destructor(smb_txlst_t *);
309 smb_txbuf_t *smb_net_txb_alloc(void);
310 void smb_net_txb_free(smb_txbuf_t *);
311 int smb_net_txb_send(struct sonode *, smb_txlst_t *, smb_txbuf_t *);
312 
313 /*
314  * SMB RPC interface
315  */
316 int smb_rpc_open(struct smb_request *);
317 void smb_rpc_close(struct smb_ofile *);
318 smb_sdrc_t smb_rpc_transact(struct smb_request *, struct uio *);
319 int smb_rpc_read(struct smb_request *, struct uio *);
320 int smb_rpc_write(struct smb_request *, struct uio *);
321 
322 /*
323  * SMB node functions (file smb_node.c)
324  */
325 struct smb_node *smb_node_lookup(struct smb_request *sr, struct open_param *op,
326     cred_t *cr, vnode_t *vp, char *od_name, smb_node_t *dir_snode,
327     smb_node_t *unnamed_node, smb_attr_t *attr);
328 struct smb_node *smb_stream_node_lookup(struct smb_request *sr, cred_t *cr,
329     smb_node_t *fnode, vnode_t *xattrdirvp, vnode_t *vp, char *stream_name,
330     smb_attr_t *ret_attr);
331 void smb_node_ref(smb_node_t *node);
332 void smb_node_release(smb_node_t *node);
333 int smb_node_assert(smb_node_t *node, const char *file, int line);
334 int smb_node_rename(smb_node_t *from_dir_snode, smb_node_t *ret_snode,
335     smb_node_t *to_dir_snode, char *to_name);
336 int smb_node_root_init();
337 void smb_node_root_fini();
338 void smb_node_add_lock(smb_node_t *node, smb_lock_t *lock);
339 void smb_node_destroy_lock(smb_node_t *node, smb_lock_t *lock);
340 void smb_node_destroy_lock_by_ofile(smb_node_t *node, smb_ofile_t *file);
341 void smb_node_start_crit(smb_node_t *node, krw_t mode);
342 void smb_node_end_crit(smb_node_t *node);
343 int smb_node_in_crit(smb_node_t *node);
344 
345 uint32_t smb_node_open_check(smb_node_t *, cred_t *,
346     uint32_t, uint32_t);
347 uint32_t smb_node_share_check(smb_node_t *, cred_t *,
348     uint32_t, uint32_t, smb_ofile_t *);
349 DWORD smb_node_rename_check(smb_node_t *);
350 DWORD smb_node_delete_check(smb_node_t *);
351 
352 uint64_t smb_node_get_size(smb_node_t *node, smb_attr_t *attr);
353 void smb_node_set_time(struct smb_node *node, timestruc_t *crtime,
354     timestruc_t *mtime, timestruc_t *atime,
355     timestruc_t *ctime, unsigned int what);
356 timestruc_t *smb_node_get_crtime(struct smb_node *node);
357 timestruc_t *smb_node_get_atime(struct smb_node *node);
358 timestruc_t *smb_node_get_ctime(struct smb_node *node);
359 timestruc_t *smb_node_get_mtime(struct smb_node *node);
360 void smb_node_set_dosattr(struct smb_node *, uint32_t);
361 uint32_t smb_node_get_dosattr(struct smb_node *node);
362 int smb_node_set_delete_on_close(smb_node_t *, cred_t *);
363 void smb_node_reset_delete_on_close(smb_node_t *);
364 
365 
366 
367 /*
368  * Pathname functions
369  */
370 
371 int smb_pathname_reduce(struct smb_request *, cred_t *,
372     const char *, smb_node_t *, smb_node_t *, smb_node_t **, char *);
373 
374 int smb_pathname(struct smb_request *, char *, int, smb_node_t *,
375     smb_node_t *, smb_node_t **, smb_node_t **, cred_t *);
376 
377 /*
378  * Share functions
379  */
380 
381 int smb_share_export(char *);
382 int smb_share_unexport(char *, char *);
383 
384 /*
385  * smb_vfs functions
386  */
387 
388 boolean_t smb_vfs_hold(vfs_t *);
389 void smb_vfs_rele(vfs_t *);
390 void smb_vfs_rele_all(void);
391 
392 /*
393  * String manipulation function
394  */
395 char *smb_kstrdup(const char *s, size_t n);
396 
397 int smb_sync_fsattr(struct smb_request *sr, cred_t *cr,
398     struct smb_node *node);
399 
400 DWORD	smb_validate_dirname(char *path);
401 
402 
403 void smb_encode_stream_info(struct smb_request *sr, struct smb_xa *xa,
404     smb_node_t *snode, smb_attr_t *attr);
405 
406 /* NOTIFY CHANGE */
407 void smb_process_session_notify_change_queue(struct smb_session *session);
408 void smb_process_node_notify_change_queue(struct smb_node *node);
409 void smb_reply_specific_cancel_request(struct smb_request *sr);
410 
411 void smb_fem_fcn_install(smb_node_t *node);
412 void smb_fem_fcn_uninstall(smb_node_t *node);
413 
414 /* FEM */
415 
416 int smb_fem_init();
417 void smb_fem_shutdown();
418 
419 int smb_try_grow(struct smb_request *sr, int64_t new_size);
420 
421 /* functions from smb_memory_manager.c */
422 
423 void	*smbsr_malloc(smb_malloc_list *, size_t);
424 void	*smbsr_realloc(void *, size_t);
425 void	smbsr_free_malloc_list(smb_malloc_list *);
426 
427 void smbsr_rq_notify(smb_request_t *sr,
428     smb_session_t *session, smb_tree_t *tree);
429 
430 unsigned short smb_worker_getnum();
431 int smb_common_close(struct smb_request *sr, uint32_t last_wtime);
432 void smb_preset_delete_on_close(struct smb_ofile *file);
433 void smb_commit_delete_on_close(struct smb_ofile *file);
434 
435 int smb_stream_parse_name(char *name, char *u_stream_name,
436     char *stream_name);
437 
438 uint32_t smb_get_gmtoff(void);
439 void smb_set_gmtoff(uint32_t);
440 
441 DWORD smb_trans2_set_information(struct smb_request *sr,
442     smb_trans2_setinfo_t *info,
443     smb_error_t *smberr);
444 
445 /* SMB signing routines smb_signing.c */
446 void smb_sign_init(struct smb_request *req,
447 	smb_session_key_t *session_key, char *resp, int resp_len);
448 
449 int smb_sign_check_request(struct smb_request *req);
450 
451 int smb_sign_check_secondary(struct smb_request *req, unsigned int seqnum);
452 
453 void smb_sign_reply(struct smb_request *req, struct mbuf_chain *reply);
454 
455 uint32_t smb_mode_to_dos_attributes(smb_attr_t *ap);
456 int smb_sattr_check(smb_attr_t *ap, char *name, unsigned short sattr);
457 
458 smb_request_t *smb_request_alloc(struct smb_session *session,
459     int request_length);
460 void smb_request_cancel(smb_request_t *sr);
461 void smb_request_free(smb_request_t *sr);
462 
463 smb_session_t *smb_session_create(struct sonode *new_so, uint16_t port);
464 void smb_session_delete(smb_session_t *session);
465 void smb_session_cancel(smb_session_t *session);
466 void smb_session_cancel_requests(smb_session_t *session);
467 void smb_session_config(smb_session_t *session);
468 void smb_session_reject(smb_session_t *session, char *reason);
469 void smb_session_disconnect_share(char *);
470 void smb_session_disconnect_volume(fs_desc_t *);
471 
472 
473 /*
474  * ofile functions (file smb_ofile.c)
475  */
476 smb_ofile_t *smb_ofile_lookup_by_fid(smb_tree_t *tree, uint16_t fid);
477 smb_ofile_t *smb_ofile_open(smb_tree_t *tree, smb_node_t *node, uint16_t pid,
478     uint32_t access_granted, uint32_t create_options, uint32_t share_access,
479     uint16_t ftype, char *pipe_name, uint32_t rpc_fid, uint32_t uniqid,
480     smb_error_t *err);
481 int smb_ofile_close(smb_ofile_t *ofile, uint32_t last_wtime);
482 uint32_t smb_ofile_access(smb_ofile_t *ofile, cred_t *cr, uint32_t access);
483 int smb_ofile_seek(smb_ofile_t *of, ushort_t mode, int32_t off,
484     uint32_t *retoff);
485 void smb_ofile_release(smb_ofile_t *ofile);
486 void smb_ofile_close_all(smb_tree_t *tree);
487 void smb_ofile_close_all_by_pid(smb_tree_t *tree, uint16_t pid);
488 void smb_ofile_set_flags(smb_ofile_t *of, uint32_t flags);
489 void smb_ofile_close_timestamp_update(smb_ofile_t *of, uint32_t last_wtime);
490 boolean_t smb_ofile_is_open(smb_ofile_t *of);
491 #define	smb_ofile_granted_access(_of_)	((_of_)->f_granted_access)
492 
493 /*
494  * odir functions (file smb_odir.c)
495  */
496 smb_odir_t *smb_odir_open(smb_tree_t *tree, smb_node_t *node, char *pattern,
497     uint16_t pid, unsigned short sattr);
498 void smb_odir_close(smb_odir_t *od);
499 void smb_odir_close_all(smb_tree_t *tree);
500 void smb_odir_close_all_by_pid(smb_tree_t *tree, uint16_t pid);
501 void smb_odir_release(smb_odir_t *od);
502 smb_odir_t *smb_odir_lookup_by_sid(smb_tree_t *tree, uint16_t sid);
503 
504 /*
505  * SMB user functions (file smb_user.c)
506  */
507 smb_user_t *smb_user_login(smb_session_t *, cred_t *,
508     char *, char *, uint32_t, uint32_t, uint32_t);
509 smb_user_t *smb_user_dup(smb_user_t *);
510 void smb_user_logoff(smb_user_t *user);
511 void smb_user_logoff_all(smb_session_t *session);
512 smb_user_t *smb_user_lookup_by_uid(smb_session_t *, cred_t **, uint16_t);
513 smb_user_t *smb_user_lookup_by_name(smb_session_t *, char *, char *);
514 smb_user_t *smb_user_lookup_by_state(smb_session_t *, smb_user_t *user);
515 void smb_user_disconnect_share(smb_user_t *user, char *sharename);
516 void smb_user_disconnect_volume(smb_user_t *user, fs_desc_t *fsd);
517 void smb_user_release(smb_user_t *user);
518 
519 /*
520  * SMB tree functions (file smb_tree.c)
521  */
522 smb_tree_t *smb_tree_connect(smb_user_t *user, uint16_t access_flags,
523     char *sharename, char *resource, int32_t rt_share,
524     smb_node_t *snode, fsvol_attr_t *vol_attr);
525 void smb_tree_disconnect(smb_tree_t *tree);
526 void smb_tree_disconnect_all(smb_user_t *user);
527 void smb_tree_close_all_by_pid(smb_user_t *user, uint16_t pid);
528 smb_tree_t *smb_tree_lookup_by_tid(smb_user_t *user, uint16_t tid);
529 smb_tree_t *smb_tree_lookup_by_name(smb_user_t *, char *, smb_tree_t *);
530 smb_tree_t *smb_tree_lookup_by_fsd(smb_user_t *, fs_desc_t *, smb_tree_t *);
531 void smb_tree_release(smb_tree_t *tree);
532 
533 uint32_t smb_user_get_num(void);
534 void smb_dr_user_free(smb_dr_user_ctx_t *uinfo);
535 void smb_dr_ulist_free(smb_dr_ulist_t *ulist);
536 int smb_dr_ulist_get(int offset, smb_dr_ulist_t *dr_ulist);
537 
538 /*
539  * SMB user's credential functions
540  */
541 cred_t *smb_cred_create(smb_token_t *, uint32_t *);
542 void smb_cred_rele(cred_t *cr);
543 int smb_cred_is_member(cred_t *cr, nt_sid_t *sid);
544 
545 smb_xa_t *smb_xa_create(smb_session_t *session, smb_request_t *sr,
546     uint32_t total_parameter_count, uint32_t total_data_count,
547     uint32_t max_parameter_count, uint32_t max_data_count,
548     uint32_t max_setup_count, uint32_t setup_word_count);
549 void smb_xa_delete(smb_xa_t *xa);
550 smb_xa_t *smb_xa_hold(smb_xa_t *xa);
551 void smb_xa_rele(smb_session_t *session, smb_xa_t *xa);
552 int smb_xa_open(smb_xa_t *xa);
553 void smb_xa_close(smb_xa_t *xa);
554 int smb_xa_complete(smb_xa_t *xa);
555 smb_xa_t *smb_xa_find(smb_session_t *session, uint16_t pid, uint16_t mid);
556 
557 struct mbuf *smb_mbuf_get(uchar_t *buf, int nbytes);
558 struct mbuf *smb_mbuf_allocate(struct uio *uio);
559 void smb_mbuf_trim(struct mbuf *mhead, int nbytes);
560 
561 void smb_check_status(void);
562 int smb_handle_write_raw(smb_session_t *session, smb_request_t *sr);
563 
564 void smb_winpipe_init(void);
565 void smb_winpipe_fini(void);
566 int smb_winpipe_open(int door_id);
567 void smb_winpipe_close(void);
568 int smb_winpipe_call(smb_request_t *, mlsvc_pipe_t *, mlsvc_stream_t *,
569     uint16_t, uint32_t *, boolean_t *);
570 
571 void smb_reconnection_check(struct smb_session *session);
572 
573 uint32_t nt_to_unix_time(uint64_t nt_time, timestruc_t *unix_time);
574 uint64_t unix_to_nt_time(timestruc_t *);
575 
576 int netbios_name_isvalid(char *in, char *out);
577 
578 size_t
579 unicodestooems(char *oemstring, const mts_wchar_t *unicodestring,
580     size_t nbytes, unsigned int cpid);
581 
582 size_t oemstounicodes(mts_wchar_t *unicodestring, const char *oemstring,
583     size_t nwchars, unsigned int cpid);
584 
585 int uioxfer(struct uio *src_uio, struct uio *dst_uio, int n);
586 
587 int smb_match_name(ino64_t fileid, char *name, char *shortname,
588     char *name83, char *pattern, int ignore_case);
589 int is_dot_or_dotdot(char *name);
590 int token2buf(smb_token_t *token, char *buf);
591 
592 /*
593  * Pool ID function prototypes
594  */
595 int	smb_idpool_constructor(smb_idpool_t *pool);
596 void	smb_idpool_destructor(smb_idpool_t  *pool);
597 int	smb_idpool_alloc(smb_idpool_t *pool, uint16_t *id);
598 void	smb_idpool_free(smb_idpool_t *pool, uint16_t id);
599 
600 /*
601  * SMB thread function prototypes
602  */
603 void	smb_session_worker(void *arg);
604 
605 /*
606  * SMB locked list function prototypes
607  */
608 void	smb_llist_constructor(smb_llist_t *, size_t, size_t);
609 void	smb_llist_destructor(smb_llist_t *);
610 void	smb_llist_insert_head(smb_llist_t *ll, void *obj);
611 void	smb_llist_insert_tail(smb_llist_t *ll, void *obj);
612 void	smb_llist_remove(smb_llist_t *ll, void *obj);
613 int	smb_llist_upgrade(smb_llist_t *ll);
614 uint32_t smb_llist_get_count(smb_llist_t *ll);
615 #define	smb_llist_enter(ll, mode)	rw_enter(&(ll)->ll_lock, mode)
616 #define	smb_llist_exit(ll)		rw_exit(&(ll)->ll_lock)
617 #define	smb_llist_head(ll)		list_head(&(ll)->ll_list)
618 #define	smb_llist_next(ll, obj)		list_next(&(ll)->ll_list, obj)
619 int	smb_account_connected(smb_user_t *user);
620 
621 /*
622  * SMB Synchronized list function prototypes
623  */
624 void	smb_slist_constructor(smb_slist_t *, size_t, size_t);
625 void	smb_slist_destructor(smb_slist_t *);
626 void	smb_slist_insert_head(smb_slist_t *sl, void *obj);
627 void	smb_slist_insert_tail(smb_slist_t *sl, void *obj);
628 void	smb_slist_remove(smb_slist_t *sl, void *obj);
629 void	smb_slist_wait_for_empty(smb_slist_t *sl);
630 void	smb_slist_exit(smb_slist_t *sl);
631 uint32_t smb_slist_move_tail(list_t *lst, smb_slist_t *sl);
632 void    smb_slist_obj_move(smb_slist_t *dst, smb_slist_t *src, void *obj);
633 #define	smb_slist_enter(sl)		mutex_enter(&(sl)->sl_mutex)
634 #define	smb_slist_head(sl)		list_head(&(sl)->sl_list)
635 #define	smb_slist_next(sl, obj)		list_next(&(sl)->sl_list, obj)
636 
637 void    smb_rwx_init(smb_rwx_t *rwx);
638 void    smb_rwx_destroy(smb_rwx_t *rwx);
639 #define	smb_rwx_rwenter(rwx, mode)	rw_enter(&(rwx)->rwx_lock, mode)
640 void    smb_rwx_rwexit(smb_rwx_t *rwx);
641 int	smb_rwx_rwwait(smb_rwx_t *rwx, clock_t timeout);
642 #define	smb_rwx_xenter(rwx)		mutex_enter(&(rwx)->rwx_mutex)
643 #define	smb_rwx_xexit(rwx)		mutex_exit(&(rwx)->rwx_mutex)
644 krw_t   smb_rwx_rwupgrade(smb_rwx_t *rwx);
645 void    smb_rwx_rwdowngrade(smb_rwx_t *rwx, krw_t mode);
646 
647 void	smb_thread_init(smb_thread_t *, char *, smb_thread_ep_t, void *,
648     smb_thread_aw_t, void *);
649 void	smb_thread_destroy(smb_thread_t *);
650 int	smb_thread_start(smb_thread_t *);
651 void	smb_thread_stop(smb_thread_t *);
652 void    smb_thread_signal(smb_thread_t *);
653 boolean_t smb_thread_continue(smb_thread_t *);
654 boolean_t smb_thread_continue_nowait(smb_thread_t *);
655 boolean_t smb_thread_continue_timedwait(smb_thread_t *, int /* seconds */);
656 void smb_thread_set_awaken(smb_thread_t *, smb_thread_aw_t, void *);
657 
658 uint32_t smb_denymode_to_sharemode(uint32_t desired_access, char *fname);
659 uint32_t smb_ofun_to_crdisposition(uint16_t ofun);
660 
661 void    smb_audit_buf_node_create(smb_node_t *node);
662 void    smb_audit_buf_node_destroy(smb_node_t *node);
663 #define	smb_audit_node(_n_)					\
664 	if ((_n_)->n_audit_buf) {				\
665 		smb_audit_record_node_t	*anr;			\
666 								\
667 		anr = (_n_)->n_audit_buf->anb_records;		\
668 		anr += (_n_)->n_audit_buf->anb_index;		\
669 		(_n_)->n_audit_buf->anb_index++;		\
670 		(_n_)->n_audit_buf->anb_index &=		\
671 		    (_n_)->n_audit_buf->anb_max_index;		\
672 		anr->anr_refcnt = node->n_refcnt;		\
673 		anr->anr_depth = getpcstack(anr->anr_stack,	\
674 		    SMB_AUDIT_STACK_DEPTH);			\
675 	}
676 
677 /* 100's of ns between 1/1/1970 and 1/1/1601 */
678 #define	NT_TIME_BIAS	(134774LL * 24LL * 60LL * 60LL * 10000000LL)
679 
680 void smb_sd_init(smb_sd_t *, uint8_t);
681 void smb_sd_term(smb_sd_t *);
682 uint32_t smb_sd_get_secinfo(smb_sd_t *);
683 uint32_t smb_sd_len(smb_sd_t *, uint32_t);
684 uint32_t smb_sd_tofs(smb_sd_t *, smb_fssd_t *);
685 uint32_t smb_sd_read(smb_request_t *, smb_sd_t *, uint32_t);
686 uint32_t smb_sd_write(smb_request_t *, smb_sd_t *, uint32_t);
687 
688 void smb_fssd_init(smb_fssd_t *, uint32_t, uint32_t);
689 void smb_fssd_term(smb_fssd_t *);
690 
691 void smb_acl_sort(smb_acl_t *);
692 void smb_acl_free(smb_acl_t *);
693 smb_acl_t *smb_acl_alloc(uint8_t, uint16_t, uint16_t);
694 smb_acl_t *smb_acl_from_zfs(acl_t *, uid_t, gid_t);
695 uint32_t smb_acl_to_zfs(smb_acl_t *, uint32_t, int, acl_t **);
696 uint16_t smb_acl_len(smb_acl_t *);
697 boolean_t smb_acl_isvalid(smb_acl_t *, int);
698 
699 void smb_fsacl_free(acl_t *);
700 acl_t *smb_fsacl_alloc(int, int);
701 acl_t *smb_fsacl_inherit(acl_t *, int, int, uid_t);
702 acl_t *smb_fsacl_merge(acl_t *, acl_t *);
703 void smb_fsacl_split(acl_t *, acl_t **, acl_t **, int);
704 acl_t *smb_fsacl_from_vsa(vsecattr_t *, acl_type_t);
705 int smb_fsacl_to_vsa(acl_t *, vsecattr_t *, int *);
706 
707 boolean_t smb_ace_is_generic(int);
708 boolean_t smb_ace_is_access(int);
709 boolean_t smb_ace_is_audit(int);
710 
711 #ifdef	__cplusplus
712 }
713 #endif
714 
715 #endif /* _SMB_KPROTO_H_ */
716