1 /* $NetBSD: krpc_subr.c,v 1.12.4.1 1996/06/07 00:52:26 cgd Exp $ */
2 /* $FreeBSD: src/sys/nfs/krpc_subr.c,v 1.13.2.1 2000/11/20 21:17:14 tegge Exp $ */
5 * Copyright (c) 1995 Gordon Ross, Adam Glass
6 * Copyright (c) 1992 Regents of the University of California.
9 * This software was developed by the Computer Systems Engineering group
10 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
11 * contributed to Berkeley.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the University of
24 * California, Lawrence Berkeley Laboratory and its contributors.
25 * 4. Neither the name of the University nor the names of its contributors
26 * may be used to endorse or promote products derived from this software
27 * without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
30 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
34 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
35 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
38 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 * @(#) Header: rpc.c,v 1.12 93/09/28 08:31:56 leres Exp (LBL)
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/malloc.h>
50 #include <sys/socket.h>
51 #include <sys/socketvar.h>
55 #include <netinet/in.h>
57 #include <nfs/rpcv2.h>
59 #include <nfs/xdr_subs.h>
62 * Kernel support for Sun RPC
64 * Used currently for bootstrapping in nfs diskless configurations.
72 u_int32_t authtype; /* auth type */
73 u_int32_t authlen; /* auth length */
78 int32_t ua_hostname; /* null */
81 int32_t ua_gidlist; /* null */
85 u_int32_t rp_xid; /* request transaction id */
86 int32_t rp_direction; /* call direction (0) */
87 u_int32_t rp_rpcvers; /* rpc version (2) */
88 u_int32_t rp_prog; /* program */
89 u_int32_t rp_vers; /* version */
90 u_int32_t rp_proc; /* procedure */
91 struct auth_info rpc_auth;
92 struct auth_unix rpc_unix;
93 struct auth_info rpc_verf;
97 u_int32_t rp_xid; /* request transaction id */
98 int32_t rp_direction; /* call direction (1) */
99 int32_t rp_astatus; /* accept status (0: accepted) */
103 struct auth_info rok_auth;
104 u_int32_t rok_status;
108 #define rp_errno rp_u.rpu_errno
109 #define rp_auth rp_u.rpu_rok.rok_auth
110 #define rp_status rp_u.rpu_rok.rok_status
112 #define MIN_REPLY_HDR 16 /* xid, dir, astat, errno */
115 * What is the longest we will wait before re-sending a request?
116 * Note this is also the frequency of "RPC timeout" messages.
117 * The re-send loop count sup linearly to this maximum, so the
118 * first complaint will happen after (1+2+3+4+5)=15 seconds.
120 #define MAX_RESEND_DELAY 5 /* seconds */
123 * Call portmap to lookup a port number for a particular rpc program
124 * Returns non-zero error on failure.
127 krpc_portmap(sin, prog, vers, portp, procp)
128 struct sockaddr_in *sin; /* server address */
129 u_int prog, vers; /* host order */
130 u_int16_t *portp; /* network order */
134 u_int32_t prog; /* call program */
135 u_int32_t vers; /* call version */
136 u_int32_t proto; /* call protocol */
137 u_int32_t port; /* call port (unused) */
146 /* The portmapper port is fixed. */
147 if (prog == PMAPPROG) {
148 *portp = htons(PMAPPORT);
152 m = m_get(M_WAIT, MT_DATA);
155 sdata = mtod(m, struct sdata *);
156 m->m_len = sizeof(*sdata);
158 /* Do the RPC to get it. */
159 sdata->prog = txdr_unsigned(prog);
160 sdata->vers = txdr_unsigned(vers);
161 sdata->proto = txdr_unsigned(IPPROTO_UDP);
164 sin->sin_port = htons(PMAPPORT);
165 error = krpc_call(sin, PMAPPROG, PMAPVERS,
166 PMAPPROC_GETPORT, &m, NULL, procp);
170 if (m->m_len < sizeof(*rdata)) {
171 m = m_pullup(m, sizeof(*rdata));
175 rdata = mtod(m, struct rdata *);
176 *portp = rdata->port;
183 * Do a remote procedure call (RPC) and wait for its reply.
184 * If from_p is non-null, then we are doing broadcast, and
185 * the address from whence the response came is saved there.
188 krpc_call(sa, prog, vers, func, data, from_p, procp)
189 struct sockaddr_in *sa;
190 u_int prog, vers, func;
191 struct mbuf **data; /* input/output */
192 struct sockaddr **from_p; /* output */
196 struct sockaddr_in *sin, ssin;
197 struct sockaddr *from;
198 struct mbuf *m, *nam, *mhead;
199 struct rpc_call *call;
200 struct rpc_reply *reply;
204 int error, rcvflg, timo, secs, len;
205 static u_int32_t xid = ~0xFF;
210 * Validate address family.
211 * Sorry, this is INET specific...
213 if (sa->sin_family != AF_INET)
214 return (EAFNOSUPPORT);
216 /* Free at end if not null. */
221 * Create socket and set its recieve timeout.
223 if ((error = socreate(AF_INET, &so, SOCK_DGRAM, 0, procp)))
228 bzero(&sopt, sizeof sopt);
229 sopt.sopt_level = SOL_SOCKET;
230 sopt.sopt_name = SO_RCVTIMEO;
232 sopt.sopt_valsize = sizeof tv;
234 if ((error = sosetopt(so, &sopt)) != 0)
238 * Enable broadcast if necessary.
242 sopt.sopt_name = SO_BROADCAST;
244 sopt.sopt_valsize = sizeof on;
245 if ((error = sosetopt(so, &sopt)) != 0)
250 * Bind the local endpoint to a reserved port,
251 * because some NFS servers refuse requests from
252 * non-reserved (non-privileged) ports.
255 bzero(sin, sizeof *sin);
256 sin->sin_len = sizeof(*sin);
257 sin->sin_family = AF_INET;
258 sin->sin_addr.s_addr = INADDR_ANY;
259 tport = IPPORT_RESERVED;
262 sin->sin_port = htons(tport);
263 error = sobind(so, (struct sockaddr *)sin, procp);
264 } while (error == EADDRINUSE &&
265 tport > IPPORT_RESERVED / 2);
267 printf("bind failed\n");
272 * Setup socket address for the server.
276 * Prepend RPC message header.
278 mhead = m_gethdr(M_WAIT, MT_DATA);
279 mhead->m_next = *data;
280 call = mtod(mhead, struct rpc_call *);
281 mhead->m_len = sizeof(*call);
282 bzero((caddr_t)call, sizeof(*call));
285 call->rp_xid = txdr_unsigned(xid);
286 /* call->rp_direction = 0; */
287 call->rp_rpcvers = txdr_unsigned(2);
288 call->rp_prog = txdr_unsigned(prog);
289 call->rp_vers = txdr_unsigned(vers);
290 call->rp_proc = txdr_unsigned(func);
291 /* rpc_auth part (auth_unix as root) */
292 call->rpc_auth.authtype = txdr_unsigned(RPCAUTH_UNIX);
293 call->rpc_auth.authlen = txdr_unsigned(sizeof(struct auth_unix));
294 /* rpc_verf part (auth_null) */
295 call->rpc_verf.authtype = 0;
296 call->rpc_verf.authlen = 0;
299 * Setup packet header
307 mhead->m_pkthdr.len = len;
308 mhead->m_pkthdr.rcvif = NULL;
311 * Send it, repeatedly, until a reply is received,
312 * but delay each re-send by an increasing amount.
313 * If the delay hits the maximum, start complaining.
317 /* Send RPC request (or re-send). */
318 m = m_copym(mhead, 0, M_COPYALL, M_WAIT);
323 error = sosend(so, (struct sockaddr *)sa, NULL, m,
326 printf("krpc_call: sosend: %d\n", error);
331 /* Determine new timeout. */
332 if (timo < MAX_RESEND_DELAY)
335 saddr = ntohl(sa->sin_addr.s_addr);
336 printf("RPC timeout for server %d.%d.%d.%d\n",
344 * Wait for up to timo seconds for a reply.
345 * The socket receive timeout was set to 1 second.
350 FREE(from, M_SONAME);
357 bzero(&auio,sizeof(auio));
358 auio.uio_resid = len = 1<<16;
360 error = soreceive(so, &from, &auio, &m, NULL, &rcvflg);
361 if (error == EWOULDBLOCK) {
367 len -= auio.uio_resid;
369 /* Does the reply contain at least a header? */
370 if (len < MIN_REPLY_HDR)
372 if (m->m_len < MIN_REPLY_HDR)
374 reply = mtod(m, struct rpc_reply *);
376 /* Is it the right reply? */
377 if (reply->rp_direction != txdr_unsigned(RPC_REPLY))
380 if (reply->rp_xid != txdr_unsigned(xid))
383 /* Was RPC accepted? (authorization OK) */
384 if (reply->rp_astatus != 0) {
385 error = fxdr_unsigned(u_int32_t, reply->rp_errno);
386 printf("rpc denied, error=%d\n", error);
390 /* Did the call succeed? */
391 if (reply->rp_status != 0) {
392 error = fxdr_unsigned(u_int32_t, reply->rp_status);
393 if (error == RPC_PROGMISMATCH) {
397 printf("rpc denied, status=%d\n", error);
401 goto gotreply; /* break two levels */
404 } /* forever send/receive */
412 * Get RPC reply header into first mbuf,
413 * get its length, then strip it off.
415 len = sizeof(*reply);
416 if (m->m_len < len) {
417 m = m_pullup(m, len);
423 reply = mtod(m, struct rpc_reply *);
424 if (reply->rp_auth.authtype != 0) {
425 len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen);
426 len = (len + 3) & ~3; /* XXX? */
438 if (mhead) m_freem(mhead);
439 if (from) free(from, M_SONAME);
445 * eXternal Data Representation routines.
446 * (but with non-standard args...)
450 * String representation for RPC.
453 u_int32_t len; /* length without null or padding */
454 char data[4]; /* data (longer, of course) */
455 /* data is padded to a long-word boundary */
459 xdr_string_encode(str, len)
464 struct xdr_string *xs;
465 int dlen; /* padded string length */
466 int mlen; /* message length */
468 dlen = (len + 3) & ~3;
471 if (mlen > MCLBYTES) /* If too big, we just can't do it. */
474 m = m_get(M_WAIT, MT_DATA);
477 if ((m->m_flags & M_EXT) == 0) {
478 (void) m_free(m); /* There can be only one. */
482 xs = mtod(m, struct xdr_string *);
484 xs->len = txdr_unsigned(len);
485 bcopy(str, xs->data, len);