xref: /freebsd/sys/fs/nfs/nfsm_subs.h (revision 6829dae12bb055451fa467da4589c43bd03b1e64)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $FreeBSD$
35  */
36 
37 #ifndef _NFS_NFSM_SUBS_H_
38 #define	_NFS_NFSM_SUBS_H_
39 
40 
41 /*
42  * These macros do strange and peculiar things to mbuf chains for
43  * the assistance of the nfs code. To attempt to use them for any
44  * other purpose will be dangerous. (they make weird assumptions)
45  */
46 
47 #ifndef APPLE
48 /*
49  * First define what the actual subs. return
50  */
51 #define	NFSM_DATAP(m, s)	(m)->m_data += (s)
52 
53 /*
54  * Now for the macros that do the simple stuff and call the functions
55  * for the hard stuff.
56  * They use fields in struct nfsrv_descript to handle the mbuf queues.
57  * Replace most of the macro with an inline function, to minimize
58  * the machine code. The inline functions in lower case can be called
59  * directly, bypassing the macro.
60  */
61 static __inline void *
62 nfsm_build(struct nfsrv_descript *nd, int siz)
63 {
64 	void *retp;
65 	struct mbuf *mb2;
66 
67 	if (siz > M_TRAILINGSPACE(nd->nd_mb)) {
68 		NFSMCLGET(mb2, M_NOWAIT);
69 		if (siz > MLEN)
70 			panic("build > MLEN");
71 		mbuf_setlen(mb2, 0);
72 		nd->nd_bpos = NFSMTOD(mb2, caddr_t);
73 		nd->nd_mb->m_next = mb2;
74 		nd->nd_mb = mb2;
75 	}
76 	retp = (void *)(nd->nd_bpos);
77 	nd->nd_mb->m_len += siz;
78 	nd->nd_bpos += siz;
79 	return (retp);
80 }
81 
82 #define	NFSM_BUILD(a, c, s)	((a) = (c)nfsm_build(nd, (s)))
83 
84 static __inline void *
85 nfsm_dissect(struct nfsrv_descript *nd, int siz)
86 {
87 	int tt1;
88 	void *retp;
89 
90 	tt1 = NFSMTOD(nd->nd_md, caddr_t) + nd->nd_md->m_len - nd->nd_dpos;
91 	if (tt1 >= siz) {
92 		retp = (void *)nd->nd_dpos;
93 		nd->nd_dpos += siz;
94 	} else {
95 		retp = nfsm_dissct(nd, siz, M_WAITOK);
96 	}
97 	return (retp);
98 }
99 
100 static __inline void *
101 nfsm_dissect_nonblock(struct nfsrv_descript *nd, int siz)
102 {
103 	int tt1;
104 	void *retp;
105 
106 	tt1 = NFSMTOD(nd->nd_md, caddr_t) + nd->nd_md->m_len - nd->nd_dpos;
107 	if (tt1 >= siz) {
108 		retp = (void *)nd->nd_dpos;
109 		nd->nd_dpos += siz;
110 	} else {
111 		retp = nfsm_dissct(nd, siz, M_NOWAIT);
112 	}
113 	return (retp);
114 }
115 
116 #define	NFSM_DISSECT(a, c, s) 						\
117 	do {								\
118 		(a) = (c)nfsm_dissect(nd, (s));	 			\
119 		if ((a) == NULL) { 					\
120 			error = EBADRPC; 				\
121 			goto nfsmout; 					\
122 		}							\
123 	} while (0)
124 
125 #define	NFSM_DISSECT_NONBLOCK(a, c, s) 					\
126 	do {								\
127 		(a) = (c)nfsm_dissect_nonblock(nd, (s));		\
128 		if ((a) == NULL) { 					\
129 			error = EBADRPC; 				\
130 			goto nfsmout; 					\
131 		}							\
132 	} while (0)
133 #endif	/* !APPLE */
134 
135 #define	NFSM_STRSIZ(s, m)  						\
136 	do {								\
137 		tl = (u_int32_t *)nfsm_dissect(nd, NFSX_UNSIGNED);	\
138 		if (!tl || ((s) = fxdr_unsigned(int32_t, *tl)) > (m)) { \
139 			error = EBADRPC; 				\
140 			goto nfsmout; 					\
141 		}							\
142 	} while (0)
143 
144 #define	NFSM_RNDUP(a)	(((a)+3)&(~0x3))
145 
146 #endif	/* _NFS_NFSM_SUBS_H_ */
147