1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2009 Rick Macklem, University of Guelph
5 * All rights reserved.
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#ifndef _NFS_NFSCLSTATE_H_
30#define _NFS_NFSCLSTATE_H_
31
32/*
33 * Definitions for NFS V4 client state handling.
34 */
35LIST_HEAD(nfsclopenhead, nfsclopen);
36LIST_HEAD(nfscllockownerhead, nfscllockowner);
37SLIST_HEAD(nfscllockownerfhhead, nfscllockownerfh);
38LIST_HEAD(nfscllockhead, nfscllock);
39LIST_HEAD(nfsclhead, nfsclclient);
40LIST_HEAD(nfsclownerhead, nfsclowner);
41TAILQ_HEAD(nfscldeleghead, nfscldeleg);
42LIST_HEAD(nfscldeleghash, nfscldeleg);
43LIST_HEAD(nfsclopenhash, nfsclopen);
44TAILQ_HEAD(nfscllayouthead, nfscllayout);
45LIST_HEAD(nfscllayouthash, nfscllayout);
46LIST_HEAD(nfsclflayouthead, nfsclflayout);
47LIST_HEAD(nfscldevinfohead, nfscldevinfo);
48LIST_HEAD(nfsclrecalllayouthead, nfsclrecalllayout);
49#define NFSCLDELEGHASHSIZE 256
50#define NFSCLDELEGHASH(c, f, l) \
51 (&((c)->nfsc_deleghash[ncl_hash((f), (l)) % NFSCLDELEGHASHSIZE]))
52#define NFSCLOPENHASHSIZE 256
53#define NFSCLOPENHASHFUNC(f, l) (ncl_hash((f), (l)) % NFSCLOPENHASHSIZE)
54#define NFSCLOPENHASH(c, f, l) \
55 (&((c)->nfsc_openhash[NFSCLOPENHASHFUNC((f), (l))]))
56#define NFSCLLAYOUTHASHSIZE 256
57#define NFSCLLAYOUTHASH(c, f, l) \
58 (&((c)->nfsc_layouthash[ncl_hash((f), (l)) % NFSCLLAYOUTHASHSIZE]))
59
60/* Structure for NFSv4.1 session stuff. */
61struct nfsclsession {
62 struct mtx nfsess_mtx;
63 struct nfsslot nfsess_cbslots[NFSV4_CBSLOTS];
64 nfsquad_t nfsess_clientid;
65 SVCXPRT *nfsess_xprt; /* For backchannel callback */
66 uint32_t nfsess_slotseq[64]; /* Max for 64bit nm_slots */
67 uint64_t nfsess_slots;
68 uint64_t nfsess_badslots; /* Slots possibly broken */
69 uint32_t nfsess_sequenceid;
70 uint32_t nfsess_maxcache; /* Max size for cached reply. */
71 uint32_t nfsess_maxreq; /* Max request size. */
72 uint32_t nfsess_maxresp; /* Max reply size. */
73 uint16_t nfsess_foreslots;
74 uint16_t nfsess_backslots;
75 uint8_t nfsess_sessionid[NFSX_V4SESSIONID];
76 uint8_t nfsess_defunct; /* Non-zero for old sessions */
77};
78
79/*
80 * This structure holds the session, clientid and related information
81 * needed for an NFSv4.1 or NFSv4.2 Meta Data Server (MDS) or Data Server (DS).
82 * It is malloc'd to the correct length.
83 */
84struct nfsclds {
85 TAILQ_ENTRY(nfsclds) nfsclds_list;
86 struct nfsclsession nfsclds_sess;
87 struct mtx nfsclds_mtx;
88 struct nfssockreq *nfsclds_sockp;
89 time_t nfsclds_expire;
90 uint16_t nfsclds_flags;
91 uint16_t nfsclds_servownlen;
92 uint8_t nfsclds_verf[NFSX_VERF];
93 uint8_t nfsclds_serverown[0];
94};
95
96/*
97 * Flags for nfsclds_flags.
98 */
99#define NFSCLDS_HASWRITEVERF 0x0001
100#define NFSCLDS_MDS 0x0002
101#define NFSCLDS_DS 0x0004
102#define NFSCLDS_CLOSED 0x0008
103#define NFSCLDS_SAMECONN 0x0010
104#define NFSCLDS_MINORV2 0x0020
105
106struct nfsclclient {
107 LIST_ENTRY(nfsclclient) nfsc_list;
108 struct nfsclownerhead nfsc_owner;
109 struct nfscldeleghead nfsc_deleg;
110 struct nfscldeleghash nfsc_deleghash[NFSCLDELEGHASHSIZE];
111 struct nfsclopenhash nfsc_openhash[NFSCLOPENHASHSIZE];
112 struct nfscllayouthead nfsc_layout;
113 struct nfscllayouthash nfsc_layouthash[NFSCLLAYOUTHASHSIZE];
114 struct nfscldevinfohead nfsc_devinfo;
115 struct nfsv4lock nfsc_lock;
116 struct proc *nfsc_renewthread;
117 struct nfsmount *nfsc_nmp;
118 time_t nfsc_expire;
119 int nfsc_delegcnt;
120 int nfsc_deleghighwater;
121 int nfsc_layoutcnt;
122 int nfsc_layouthighwater;
123 u_int32_t nfsc_clientidrev;
124 u_int32_t nfsc_rev;
125 u_int32_t nfsc_renew;
126 u_int32_t nfsc_cbident;
127 u_int16_t nfsc_flags;
128 u_int16_t nfsc_idlen;
129 u_int8_t nfsc_id[1]; /* Malloc'd to correct length */
130};
131
132/*
133 * Bits for nfsc_flags.
134 */
135#define NFSCLFLAGS_INITED 0x0001
136#define NFSCLFLAGS_HASCLIENTID 0x0002
137#define NFSCLFLAGS_RECOVER 0x0004
138#define NFSCLFLAGS_UMOUNT 0x0008
139#define NFSCLFLAGS_HASTHREAD 0x0010
140#define NFSCLFLAGS_AFINET6 0x0020
141#define NFSCLFLAGS_EXPIREIT 0x0040
142#define NFSCLFLAGS_FIRSTDELEG 0x0080
143#define NFSCLFLAGS_GOTDELEG 0x0100
144#define NFSCLFLAGS_RECVRINPROG 0x0200
145
146struct nfsclowner {
147 LIST_ENTRY(nfsclowner) nfsow_list;
148 struct nfsclopenhead nfsow_open;
149 struct nfsclclient *nfsow_clp;
150 u_int32_t nfsow_seqid;
151 u_int32_t nfsow_defunct;
152 struct nfsv4lock nfsow_rwlock;
153 u_int8_t nfsow_owner[NFSV4CL_LOCKNAMELEN];
154};
155
156/*
157 * MALLOC'd to the correct length to accommodate the file handle.
158 */
159struct nfscldeleg {
160 TAILQ_ENTRY(nfscldeleg) nfsdl_list;
161 LIST_ENTRY(nfscldeleg) nfsdl_hash;
162 struct nfsclownerhead nfsdl_owner; /* locally issued state */
163 struct nfscllockownerhead nfsdl_lock;
164 nfsv4stateid_t nfsdl_stateid;
165 struct acl_entry nfsdl_ace; /* Delegation ace */
166 struct nfsclclient *nfsdl_clp;
167 struct nfsv4lock nfsdl_rwlock; /* for active I/O ops */
168 struct nfscred nfsdl_cred; /* Cred. used for Open */
169 time_t nfsdl_timestamp; /* used for stale cleanup */
170 u_int64_t nfsdl_sizelimit; /* Limit for file growth */
171 u_int64_t nfsdl_size; /* saved copy of file size */
172 u_int64_t nfsdl_change; /* and change attribute */
173 struct timespec nfsdl_modtime; /* local modify time */
174 u_int16_t nfsdl_fhlen;
175 u_int8_t nfsdl_flags;
176 u_int8_t nfsdl_fh[1]; /* must be last */
177};
178
179/*
180 * nfsdl_flags bits.
181 */
182#define NFSCLDL_READ 0x01
183#define NFSCLDL_WRITE 0x02
184#define NFSCLDL_RECALL 0x04
185#define NFSCLDL_NEEDRECLAIM 0x08
186#define NFSCLDL_ZAPPED 0x10
187#define NFSCLDL_MODTIMESET 0x20
188#define NFSCLDL_DELEGRET 0x40
189
190/*
191 * MALLOC'd to the correct length to accommodate the file handle.
192 */
193struct nfsclopen {
194 LIST_ENTRY(nfsclopen) nfso_list;
195 LIST_ENTRY(nfsclopen) nfso_hash;
196 struct nfscllockownerhead nfso_lock;
197 nfsv4stateid_t nfso_stateid;
198 struct nfsclowner *nfso_own;
199 struct nfscred nfso_cred; /* Cred. used for Open */
200 u_int32_t nfso_mode;
201 u_int32_t nfso_opencnt;
202 u_int16_t nfso_fhlen;
203 u_int8_t nfso_posixlock; /* 1 for POSIX type locking */
204 u_int8_t nfso_fh[1]; /* must be last */
205};
206
207/*
208 * Return values for nfscl_open(). NFSCLOPEN_OK must == 0.
209 */
210#define NFSCLOPEN_OK 0
211#define NFSCLOPEN_DOOPEN 1
212#define NFSCLOPEN_DOOPENDOWNGRADE 2
213#define NFSCLOPEN_SETCRED 3
214
215struct nfscllockowner {
216 LIST_ENTRY(nfscllockowner) nfsl_list;
217 struct nfscllockhead nfsl_lock;
218 struct nfsclopen *nfsl_open;
219 NFSPROC_T *nfsl_inprog;
220 nfsv4stateid_t nfsl_stateid;
221 int nfsl_lockflags;
222 u_int32_t nfsl_seqid;
223 struct nfsv4lock nfsl_rwlock;
224 u_int8_t nfsl_owner[NFSV4CL_LOCKNAMELEN];
225 u_int8_t nfsl_openowner[NFSV4CL_LOCKNAMELEN];
226};
227
228/*
229 * Byte range entry for the above lock owner.
230 */
231struct nfscllock {
232 LIST_ENTRY(nfscllock) nfslo_list;
233 u_int64_t nfslo_first;
234 u_int64_t nfslo_end;
235 short nfslo_type;
236};
237
238/* This structure is used to collect a list of lockowners to free up. */
239struct nfscllockownerfh {
240 SLIST_ENTRY(nfscllockownerfh) nfslfh_list;
241 struct nfscllockownerhead nfslfh_lock;
242 int nfslfh_len;
243 uint8_t nfslfh_fh[NFSX_V4FHMAX];
244};
245
246/*
247 * MALLOC'd to the correct length to accommodate the file handle.
248 */
249struct nfscllayout {
250 TAILQ_ENTRY(nfscllayout) nfsly_list;
251 LIST_ENTRY(nfscllayout) nfsly_hash;
252 nfsv4stateid_t nfsly_stateid;
253 struct nfsv4lock nfsly_lock;
254 uint64_t nfsly_filesid[2];
255 uint64_t nfsly_lastbyte;
256 struct nfsclflayouthead nfsly_flayread;
257 struct nfsclflayouthead nfsly_flayrw;
258 struct nfsclrecalllayouthead nfsly_recall;
259 time_t nfsly_timestamp;
260 struct nfsclclient *nfsly_clp;
261 uint16_t nfsly_flags;
262 uint16_t nfsly_fhlen;
263 uint8_t nfsly_fh[1];
264};
265
266/*
267 * Flags for nfsly_flags.
268 */
269#define NFSLY_FILES 0x0001
270#define NFSLY_BLOCK 0x0002
271#define NFSLY_OBJECT 0x0004
272#define NFSLY_RECALL 0x0008
273#define NFSLY_RECALLFILE 0x0010
274#define NFSLY_RECALLFSID 0x0020
275#define NFSLY_RECALLALL 0x0040
276#define NFSLY_RETONCLOSE 0x0080
277#define NFSLY_WRITTEN 0x0100 /* Has been used to write to a DS. */
278#define NFSLY_FLEXFILE 0x0200
279#define NFSLY_RETURNED 0x0400
280
281/*
282 * Flex file layout mirror specific stuff for nfsclflayout.
283 */
284struct nfsffm {
285 nfsv4stateid_t st;
286 struct nfscldevinfo *devp;
287 char dev[NFSX_V4DEVICEID];
288 uint32_t eff;
289 uid_t user;
290 gid_t group;
291 struct nfsfh *fh[NFSDEV_MAXVERS];
292 uint16_t fhcnt;
293};
294
295/*
296 * MALLOC'd to the correct length to accommodate the file handle list for File
297 * layout and the list of mirrors for the Flex File Layout.
298 * These hang off of nfsly_flayread and nfsly_flayrw, sorted in increasing
299 * offset order.
300 * The nfsly_flayread list holds the ones with iomode == NFSLAYOUTIOMODE_READ,
301 * whereas the nfsly_flayrw holds the ones with iomode == NFSLAYOUTIOMODE_RW.
302 */
303struct nfsclflayout {
304 LIST_ENTRY(nfsclflayout) nfsfl_list;
305 uint64_t nfsfl_off;
306 uint64_t nfsfl_end;
307 uint32_t nfsfl_iomode;
308 uint16_t nfsfl_flags;
309 union {
310 struct {
311 uint64_t patoff;
312 uint32_t util;
313 uint32_t stripe1;
314 uint8_t dev[NFSX_V4DEVICEID];
315 uint16_t fhcnt;
316 struct nfscldevinfo *devp;
317 } fl;
318 struct {
319 uint64_t stripeunit;
320 uint32_t fflags;
321 uint32_t statshint;
322 uint16_t mirrorcnt;
323 } ff;
324 } nfsfl_un;
325 union {
326 struct nfsfh *fh[0]; /* FH list for DS File layout */
327 struct nfsffm ffm[0]; /* Mirror list for Flex File */
328 } nfsfl_un2; /* Must be last. Malloc'd to correct array length */
329};
330#define nfsfl_patoff nfsfl_un.fl.patoff
331#define nfsfl_util nfsfl_un.fl.util
332#define nfsfl_stripe1 nfsfl_un.fl.stripe1
333#define nfsfl_dev nfsfl_un.fl.dev
334#define nfsfl_fhcnt nfsfl_un.fl.fhcnt
335#define nfsfl_devp nfsfl_un.fl.devp
336#define nfsfl_stripeunit nfsfl_un.ff.stripeunit
337#define nfsfl_fflags nfsfl_un.ff.fflags
338#define nfsfl_statshint nfsfl_un.ff.statshint
339#define nfsfl_mirrorcnt nfsfl_un.ff.mirrorcnt
340#define nfsfl_fh nfsfl_un2.fh
341#define nfsfl_ffm nfsfl_un2.ffm
342
343/*
344 * Flags for nfsfl_flags.
345 */
346#define NFSFL_RECALL 0x0001 /* File layout has been recalled */
347#define NFSFL_FILE 0x0002 /* File layout */
348#define NFSFL_FLEXFILE 0x0004 /* Flex File layout */
349
350/*
351 * Structure that is used to store a LAYOUTRECALL.
352 */
353struct nfsclrecalllayout {
354 LIST_ENTRY(nfsclrecalllayout) nfsrecly_list;
355 uint64_t nfsrecly_off;
356 uint64_t nfsrecly_len;
357 int nfsrecly_recalltype;
358 uint32_t nfsrecly_iomode;
359 uint32_t nfsrecly_stateseqid;
360 uint32_t nfsrecly_stat;
361 uint32_t nfsrecly_op;
362 char nfsrecly_devid[NFSX_V4DEVICEID];
363};
364
365/*
366 * Stores the NFSv4.1 Device Info. Malloc'd to the correct length to
367 * store the list of network connections and list of indices.
368 * nfsdi_data[] is allocated the following way:
369 * - nfsdi_addrcnt * struct nfsclds
370 * - stripe indices, each stored as one byte, since there can be many
371 * of them. (This implies a limit of 256 on nfsdi_addrcnt, since the
372 * indices select which address.)
373 * For Flex File, the addrcnt is always one and no stripe indices exist.
374 */
375struct nfscldevinfo {
376 LIST_ENTRY(nfscldevinfo) nfsdi_list;
377 uint8_t nfsdi_deviceid[NFSX_V4DEVICEID];
378 struct nfsclclient *nfsdi_clp;
379 uint32_t nfsdi_refcnt;
380 uint32_t nfsdi_layoutrefs;
381 union {
382 struct {
383 uint16_t stripecnt;
384 } fl;
385 struct {
386 int versindex;
387 uint32_t vers;
388 uint32_t minorvers;
389 uint32_t rsize;
390 uint32_t wsize;
391 } ff;
392 } nfsdi_un;
393 uint16_t nfsdi_addrcnt;
394 uint16_t nfsdi_flags;
395 struct nfsclds *nfsdi_data[0];
396};
397#define nfsdi_stripecnt nfsdi_un.fl.stripecnt
398#define nfsdi_versindex nfsdi_un.ff.versindex
399#define nfsdi_vers nfsdi_un.ff.vers
400#define nfsdi_minorvers nfsdi_un.ff.minorvers
401#define nfsdi_rsize nfsdi_un.ff.rsize
402#define nfsdi_wsize nfsdi_un.ff.wsize
403
404/* Flags for nfsdi_flags. */
405#define NFSDI_FILELAYOUT 0x0001
406#define NFSDI_FLEXFILE 0x0002
407#define NFSDI_TIGHTCOUPLED 0X0004
408
409/* These inline functions return values from nfsdi_data[]. */
410/*
411 * Return a pointer to the address at "pos".
412 */
413static __inline struct nfsclds **
414nfsfldi_addr(struct nfscldevinfo *ndi, int pos)
415{
416
417 if (pos >= ndi->nfsdi_addrcnt)
418 return (NULL);
419 return (&ndi->nfsdi_data[pos]);
420}
421
422/*
423 * Return the Nth ("pos") stripe index.
424 */
425static __inline int
426nfsfldi_stripeindex(struct nfscldevinfo *ndi, int pos)
427{
428 uint8_t *valp;
429
430 if (pos >= ndi->nfsdi_stripecnt)
431 return (-1);
432 valp = (uint8_t *)&ndi->nfsdi_data[ndi->nfsdi_addrcnt];
433 valp += pos;
434 return ((int)*valp);
435}
436
437/*
438 * Set the Nth ("pos") stripe index to "val".
439 */
440static __inline void
441nfsfldi_setstripeindex(struct nfscldevinfo *ndi, int pos, uint8_t val)
442{
443 uint8_t *valp;
444
445 if (pos >= ndi->nfsdi_stripecnt)
446 return;
447 valp = (uint8_t *)&ndi->nfsdi_data[ndi->nfsdi_addrcnt];
448 valp += pos;
449 *valp = val;
450}
451
452/*
453 * Macro for incrementing the seqid#.
454 */
455#define NFSCL_INCRSEQID(s, n) do { \
456 if (((n)->nd_flag & ND_INCRSEQID)) \
457 (s)++; \
458 } while (0)
459
460#endif /* _NFS_NFSCLSTATE_H_ */