xref: /freebsd/sys/fs/nfsserver/nfs_fha_new.c (revision 983afe3373c427a080f06dccec820b20891be186)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2008 Isilon Inc http://www.isilon.com/
5  * Copyright (c) 2013 Spectra Logic Corporation
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include <fs/nfs/nfsport.h>
33 
34 #include <rpc/rpc.h>
35 #include <nfs/nfs_fha.h>
36 #include <fs/nfs/xdr_subs.h>
37 #include <fs/nfs/nfs.h>
38 #include <fs/nfs/nfsproto.h>
39 #include <fs/nfs/nfsm_subs.h>
40 #include <fs/nfsserver/nfs_fha_new.h>
41 
42 static void fhanew_init(void *foo);
43 static void fhanew_uninit(void *foo);
44 rpcproc_t fhanew_get_procnum(rpcproc_t procnum);
45 int fhanew_realign(struct mbuf **mb, int malloc_flags);
46 int fhanew_get_fh(uint64_t *fh, int v3, struct mbuf **md, caddr_t *dpos);
47 int fhanew_is_read(rpcproc_t procnum);
48 int fhanew_is_write(rpcproc_t procnum);
49 int fhanew_get_offset(struct mbuf **md, caddr_t *dpos, int v3,
50 		      struct fha_info *info);
51 int fhanew_no_offset(rpcproc_t procnum);
52 void fhanew_set_locktype(rpcproc_t procnum, struct fha_info *info);
53 static int fhenew_stats_sysctl(SYSCTL_HANDLER_ARGS);
54 
55 static struct fha_params fhanew_softc;
56 
57 SYSCTL_DECL(_vfs_nfsd);
58 
59 extern int newnfs_nfsv3_procid[];
60 extern SVCPOOL	*nfsrvd_pool;
61 
62 SYSINIT(nfs_fhanew, SI_SUB_ROOT_CONF, SI_ORDER_ANY, fhanew_init, NULL);
63 SYSUNINIT(nfs_fhanew, SI_SUB_ROOT_CONF, SI_ORDER_ANY, fhanew_uninit, NULL);
64 
65 static void
66 fhanew_init(void *foo)
67 {
68 	struct fha_params *softc;
69 
70 	softc = &fhanew_softc;
71 
72 	bzero(softc, sizeof(*softc));
73 
74 	/*
75 	 * Setup the callbacks for this FHA personality.
76 	 */
77 	softc->callbacks.get_procnum = fhanew_get_procnum;
78 	softc->callbacks.realign = fhanew_realign;
79 	softc->callbacks.get_fh = fhanew_get_fh;
80 	softc->callbacks.is_read = fhanew_is_read;
81 	softc->callbacks.is_write = fhanew_is_write;
82 	softc->callbacks.get_offset = fhanew_get_offset;
83 	softc->callbacks.no_offset = fhanew_no_offset;
84 	softc->callbacks.set_locktype = fhanew_set_locktype;
85 	softc->callbacks.fhe_stats_sysctl = fhenew_stats_sysctl;
86 
87 	snprintf(softc->server_name, sizeof(softc->server_name),
88 	    FHANEW_SERVER_NAME);
89 
90 	softc->pool = &nfsrvd_pool;
91 
92 	/*
93 	 * Initialize the sysctl context list for the fha module.
94 	 */
95 	sysctl_ctx_init(&softc->sysctl_ctx);
96 	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
97 	    SYSCTL_STATIC_CHILDREN(_vfs_nfsd), OID_AUTO, "fha", CTLFLAG_RD,
98 	    0, "NFS File Handle Affinity (FHA)");
99 	if (softc->sysctl_tree == NULL) {
100 		printf("%s: unable to allocate sysctl tree\n", __func__);
101 		return;
102 	}
103 
104 	fha_init(softc);
105 }
106 
107 static void
108 fhanew_uninit(void *foo)
109 {
110 	struct fha_params *softc;
111 
112 	softc = &fhanew_softc;
113 
114 	fha_uninit(softc);
115 }
116 
117 rpcproc_t
118 fhanew_get_procnum(rpcproc_t procnum)
119 {
120 	if (procnum > NFSV2PROC_STATFS)
121 		return (-1);
122 
123 	return (newnfs_nfsv3_procid[procnum]);
124 }
125 
126 int
127 fhanew_realign(struct mbuf **mb, int malloc_flags)
128 {
129 	return (newnfs_realign(mb, malloc_flags));
130 }
131 
132 int
133 fhanew_get_fh(uint64_t *fh, int v3, struct mbuf **md, caddr_t *dpos)
134 {
135 	struct nfsrv_descript lnd, *nd;
136 	uint32_t *tl;
137 	uint8_t *buf;
138 	uint64_t t;
139 	int error, len, i;
140 
141 	error = 0;
142 	len = 0;
143 	nd = &lnd;
144 
145 	nd->nd_md = *md;
146 	nd->nd_dpos = *dpos;
147 
148 	if (v3) {
149 		NFSM_DISSECT_NONBLOCK(tl, uint32_t *, NFSX_UNSIGNED);
150 		if ((len = fxdr_unsigned(int, *tl)) <= 0 || len > NFSX_FHMAX) {
151 			error = EBADRPC;
152 			goto nfsmout;
153 		}
154 	} else {
155 		len = NFSX_V2FH;
156 	}
157 
158 	t = 0;
159 	if (len != 0) {
160 		NFSM_DISSECT_NONBLOCK(buf, uint8_t *, len);
161 		for (i = 0; i < len; i++)
162 			t ^= ((uint64_t)buf[i] << (i & 7) * 8);
163 	}
164 	*fh = t;
165 
166 nfsmout:
167 	*md = nd->nd_md;
168 	*dpos = nd->nd_dpos;
169 
170 	return (error);
171 }
172 
173 int
174 fhanew_is_read(rpcproc_t procnum)
175 {
176 	if (procnum == NFSPROC_READ)
177 		return (1);
178 	else
179 		return (0);
180 }
181 
182 int
183 fhanew_is_write(rpcproc_t procnum)
184 {
185 	if (procnum == NFSPROC_WRITE)
186 		return (1);
187 	else
188 		return (0);
189 }
190 
191 int
192 fhanew_get_offset(struct mbuf **md, caddr_t *dpos, int v3,
193 		  struct fha_info *info)
194 {
195 	struct nfsrv_descript lnd, *nd;
196 	uint32_t *tl;
197 	int error;
198 
199 	error = 0;
200 
201 	nd = &lnd;
202 	nd->nd_md = *md;
203 	nd->nd_dpos = *dpos;
204 
205 	if (v3) {
206 		NFSM_DISSECT_NONBLOCK(tl, uint32_t *, 2 * NFSX_UNSIGNED);
207 		info->offset = fxdr_hyper(tl);
208 	} else {
209 		NFSM_DISSECT_NONBLOCK(tl, uint32_t *, NFSX_UNSIGNED);
210 		info->offset = fxdr_unsigned(uint32_t, *tl);
211 	}
212 
213 nfsmout:
214 	*md = nd->nd_md;
215 	*dpos = nd->nd_dpos;
216 
217 	return (error);
218 }
219 
220 int
221 fhanew_no_offset(rpcproc_t procnum)
222 {
223 	if (procnum == NFSPROC_FSSTAT ||
224 	    procnum == NFSPROC_FSINFO ||
225 	    procnum == NFSPROC_PATHCONF ||
226 	    procnum == NFSPROC_NOOP ||
227 	    procnum == NFSPROC_NULL)
228 		return (1);
229 	else
230 		return (0);
231 }
232 
233 void
234 fhanew_set_locktype(rpcproc_t procnum, struct fha_info *info)
235 {
236 	switch (procnum) {
237 	case NFSPROC_NULL:
238 	case NFSPROC_GETATTR:
239 	case NFSPROC_LOOKUP:
240 	case NFSPROC_ACCESS:
241 	case NFSPROC_READLINK:
242 	case NFSPROC_READ:
243 	case NFSPROC_READDIR:
244 	case NFSPROC_READDIRPLUS:
245 	case NFSPROC_WRITE:
246 		info->locktype = LK_SHARED;
247 		break;
248 	case NFSPROC_SETATTR:
249 	case NFSPROC_CREATE:
250 	case NFSPROC_MKDIR:
251 	case NFSPROC_SYMLINK:
252 	case NFSPROC_MKNOD:
253 	case NFSPROC_REMOVE:
254 	case NFSPROC_RMDIR:
255 	case NFSPROC_RENAME:
256 	case NFSPROC_LINK:
257 	case NFSPROC_FSSTAT:
258 	case NFSPROC_FSINFO:
259 	case NFSPROC_PATHCONF:
260 	case NFSPROC_COMMIT:
261 	case NFSPROC_NOOP:
262 		info->locktype = LK_EXCLUSIVE;
263 		break;
264 	}
265 }
266 
267 static int
268 fhenew_stats_sysctl(SYSCTL_HANDLER_ARGS)
269 {
270 	return (fhe_stats_sysctl(oidp, arg1, arg2, req, &fhanew_softc));
271 }
272 
273 
274 SVCTHREAD *
275 fhanew_assign(SVCTHREAD *this_thread, struct svc_req *req)
276 {
277 	return (fha_assign(this_thread, req, &fhanew_softc));
278 }
279