xref: /illumos-gate/usr/src/uts/common/smbsrv/smb_fsops.h (revision 8b01ef7edff13741f64ad808a21df17c08f198a8)
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  * Copyright 2013-2021 Tintri by DDN, Inc. All rights reserved.
26  */
27 
28 #ifndef _SMBSRV_SMB_FSOPS_H
29 #define	_SMBSRV_SMB_FSOPS_H
30 
31 /*
32  * This header file contains all the functions for the interface between
33  * the smb layer and the fs layer.
34  */
35 #include <smbsrv/string.h>
36 #include <smbsrv/smbinfo.h>
37 #include <smbsrv/smb_ktypes.h>
38 #include <smbsrv/smb_vops.h>
39 #include <sys/callb.h>
40 #include <sys/flock.h>
41 
42 #ifdef	__cplusplus
43 extern "C" {
44 #endif
45 
46 int smb_fsop_amask_to_omode(uint32_t);
47 
48 int smb_fsop_open(smb_node_t *, int, cred_t *);
49 void smb_fsop_close(smb_node_t *, int, cred_t *);
50 
51 int smb_fsop_oplock_install(smb_node_t *, int);
52 void smb_fsop_oplock_uninstall(smb_node_t *);
53 
54 int smb_fsop_create(smb_request_t *, cred_t *, smb_node_t *,
55     char *, smb_attr_t *, smb_node_t **);
56 
57 int
58 smb_fsop_create_stream(smb_request_t *, cred_t *, smb_node_t *, smb_node_t *,
59     char *, int, smb_attr_t *, smb_node_t **);
60 
61 int smb_fsop_mkdir(smb_request_t *, cred_t *, smb_node_t *,
62     char *, smb_attr_t *, smb_node_t **);
63 
64 int smb_fsop_remove(smb_request_t *sr, cred_t *cr, smb_node_t *,
65     char *, uint32_t);
66 
67 int smb_fsop_rmdir(smb_request_t *, cred_t *, smb_node_t *, char *, uint32_t);
68 
69 int smb_fsop_getattr(smb_request_t *, cred_t *, smb_node_t *, smb_attr_t *);
70 
71 int smb_maybe_mangled_name(char *);
72 
73 int smb_fsop_link(smb_request_t *, cred_t *, smb_node_t *, smb_node_t *,
74     char *);
75 
76 int smb_fsop_rename(smb_request_t *, cred_t *,
77     smb_node_t *, char *, smb_node_t *,	char *);
78 
79 int smb_fsop_setattr(smb_request_t *, cred_t *, smb_node_t *, smb_attr_t *);
80 
81 int smb_fsop_freesp(smb_request_t *sr, cred_t *cr, smb_ofile_t *,
82 		    off64_t, off64_t);
83 
84 int smb_fsop_read(smb_request_t *, cred_t *, smb_node_t *, smb_ofile_t *,
85     uio_t *, int);
86 
87 int smb_fsop_write(smb_request_t *, cred_t *, smb_node_t *, smb_ofile_t *,
88     uio_t *, uint32_t *, int);
89 
90 int smb_fsop_reqzcbuf(smb_node_t *, xuio_t *, int, cred_t *);
91 
92 int smb_fsop_retzcbuf(smb_node_t *, xuio_t *, cred_t *);
93 
94 int smb_fsop_next_alloc_range(cred_t *, smb_node_t *, off64_t *, off64_t *);
95 
96 int smb_fsop_statfs(cred_t *, smb_node_t *, struct statvfs64 *);
97 
98 uint32_t smb_fsop_remove_streams(smb_request_t *, cred_t *, smb_node_t *);
99 
100 int smb_fsop_access(smb_request_t *, cred_t *, smb_node_t *, uint32_t);
101 
102 void smb_fsop_eaccess(smb_request_t *, cred_t *, smb_node_t *, uint32_t *);
103 
104 int smb_fsop_lookup_file(smb_request_t *, cred_t *, int,
105     smb_node_t *, smb_node_t *, char *, char **, smb_node_t **);
106 
107 int smb_fsop_lookup_name(smb_request_t *, cred_t *, int,
108     smb_node_t *, smb_node_t *, char *, smb_node_t **);
109 
110 int smb_fsop_lookup(smb_request_t *, cred_t *, int,
111     smb_node_t *, smb_node_t *, char *, smb_node_t **);
112 
113 int smb_fsop_lookup_stream(smb_request_t *, cred_t *, int, smb_node_t *,
114     smb_node_t *, char *, smb_node_t **);
115 
116 int smb_fsop_commit(smb_request_t *, cred_t *, smb_node_t *);
117 
118 int smb_fsop_aclread(smb_request_t *, cred_t *, smb_node_t *, smb_fssd_t *);
119 int smb_fsop_aclwrite(smb_request_t *, cred_t *, smb_node_t *, smb_fssd_t *);
120 acl_type_t smb_fsop_acltype(smb_node_t *);
121 int smb_fsop_sdread(smb_request_t *, cred_t *, smb_node_t *, smb_fssd_t *);
122 int smb_fsop_sdwrite(smb_request_t *, cred_t *, smb_node_t *, smb_fssd_t *,
123     int);
124 
125 uint32_t smb_fsop_shrlock(cred_t *, smb_node_t *, uint32_t, uint32_t, uint32_t);
126 void smb_fsop_unshrlock(cred_t *, smb_node_t *, uint32_t);
127 int smb_fsop_frlock(smb_node_t *, smb_lock_t *, boolean_t, cred_t *);
128 
129 /*
130  * Lookup-related flags
131  *
132  * SMB_FOLLOW_LINKS	Follow symbolic links.
133  * SMB_IGNORE_CASE	Perform case-insensitive lookup.
134  * SMB_CATIA		Perform CATIA character substitution.
135  * SMB_ABE		Perform Access based enumeration/lookup.
136  * SMB_CASE_SENSITIVE	Don't set SMB_IGNORE_CASE based on tree.
137  */
138 
139 #define	SMB_FOLLOW_LINKS	0x00000001
140 #define	SMB_IGNORE_CASE		0x00000002
141 #define	SMB_CATIA		0x00000004
142 #define	SMB_ABE			0x00000008
143 #define	SMB_CASE_SENSITIVE	0x00000010
144 #define	SMB_EDIRENT		0x00000020
145 
146 /*
147  * Increased MAXPATHLEN for SMB.  Essentially, we want to allow a
148  * share path up to MAXPATHLEN plus a relative path of MAXPATHLEN.
149  */
150 #define	SMB_MAXPATHLEN	(2 * MAXPATHLEN)
151 
152 #ifdef	__cplusplus
153 }
154 #endif
155 
156 #endif /* _SMBSRV_SMB_FSOPS_H */
157