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 $ */
3 /* $DragonFly: src/sys/vfs/nfs/krpc_subr.c,v 1.6 2004/06/02 14:43:04 eirikn Exp $ */
6 * Copyright (c) 1995 Gordon Ross, Adam Glass
7 * Copyright (c) 1992 Regents of the University of California.
10 * This software was developed by the Computer Systems Engineering group
11 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
12 * contributed to Berkeley.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. All advertising materials mentioning features or use of this software
23 * must display the following acknowledgement:
24 * This product includes software developed by the University of
25 * California, Lawrence Berkeley Laboratory and its contributors.
26 * 4. Neither the name of the University nor the names of its contributors
27 * may be used to endorse or promote products derived from this software
28 * without specific prior written permission.
30 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44 * @(#) Header: rpc.c,v 1.12 93/09/28 08:31:56 leres Exp (LBL)
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/malloc.h>
51 #include <sys/socket.h>
52 #include <sys/socketvar.h>
56 #include <netinet/in.h>
63 * Kernel support for Sun RPC
65 * Used currently for bootstrapping in nfs diskless configurations.
73 u_int32_t authtype; /* auth type */
74 u_int32_t authlen; /* auth length */
79 int32_t ua_hostname; /* null */
82 int32_t ua_gidlist; /* null */
86 u_int32_t rp_xid; /* request transaction id */
87 int32_t rp_direction; /* call direction (0) */
88 u_int32_t rp_rpcvers; /* rpc version (2) */
89 u_int32_t rp_prog; /* program */
90 u_int32_t rp_vers; /* version */
91 u_int32_t rp_proc; /* procedure */
92 struct auth_info rpc_auth;
93 struct auth_unix rpc_unix;
94 struct auth_info rpc_verf;
98 u_int32_t rp_xid; /* request transaction id */
99 int32_t rp_direction; /* call direction (1) */
100 int32_t rp_astatus; /* accept status (0: accepted) */
104 struct auth_info rok_auth;
105 u_int32_t rok_status;
109 #define rp_errno rp_u.rpu_errno
110 #define rp_auth rp_u.rpu_rok.rok_auth
111 #define rp_status rp_u.rpu_rok.rok_status
113 #define MIN_REPLY_HDR 16 /* xid, dir, astat, errno */
116 * What is the longest we will wait before re-sending a request?
117 * Note this is also the frequency of "RPC timeout" messages.
118 * The re-send loop count sup linearly to this maximum, so the
119 * first complaint will happen after (1+2+3+4+5)=15 seconds.
121 #define MAX_RESEND_DELAY 5 /* seconds */
124 * Call portmap to lookup a port number for a particular rpc program
125 * Returns non-zero error on failure.
128 krpc_portmap(struct sockaddr_in *sin, /* server address */
129 u_int prog, u_int 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(MB_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, td);
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(struct sockaddr_in *sa, u_int prog, u_int vers, u_int func,
189 struct mbuf **data, /* input/output */
190 struct sockaddr **from_p, /* output */
194 struct sockaddr_in *sin, ssin;
195 struct sockaddr *from;
196 struct mbuf *m, *nam, *mhead;
197 struct rpc_call *call;
198 struct rpc_reply *reply;
202 int error, rcvflg, timo, secs, len;
203 static u_int32_t xid = ~0xFF;
208 * Validate address family.
209 * Sorry, this is INET specific...
211 if (sa->sin_family != AF_INET)
212 return (EAFNOSUPPORT);
214 /* Free at end if not null. */
219 * Create socket and set its recieve timeout.
221 if ((error = socreate(AF_INET, &so, SOCK_DGRAM, 0, td)))
226 bzero(&sopt, sizeof sopt);
227 sopt.sopt_level = SOL_SOCKET;
228 sopt.sopt_name = SO_RCVTIMEO;
230 sopt.sopt_valsize = sizeof tv;
232 if ((error = sosetopt(so, &sopt)) != 0)
236 * Enable broadcast if necessary.
240 sopt.sopt_name = SO_BROADCAST;
242 sopt.sopt_valsize = sizeof on;
243 if ((error = sosetopt(so, &sopt)) != 0)
248 * Bind the local endpoint to a reserved port,
249 * because some NFS servers refuse requests from
250 * non-reserved (non-privileged) ports.
253 bzero(sin, sizeof *sin);
254 sin->sin_len = sizeof(*sin);
255 sin->sin_family = AF_INET;
256 sin->sin_addr.s_addr = INADDR_ANY;
257 tport = IPPORT_RESERVED;
260 sin->sin_port = htons(tport);
261 error = sobind(so, (struct sockaddr *)sin, td);
262 } while (error == EADDRINUSE &&
263 tport > IPPORT_RESERVED / 2);
265 printf("bind failed\n");
270 * Setup socket address for the server.
274 * Prepend RPC message header.
276 mhead = m_gethdr(MB_WAIT, MT_DATA);
277 mhead->m_next = *data;
278 call = mtod(mhead, struct rpc_call *);
279 mhead->m_len = sizeof(*call);
280 bzero((caddr_t)call, sizeof(*call));
283 call->rp_xid = txdr_unsigned(xid);
284 /* call->rp_direction = 0; */
285 call->rp_rpcvers = txdr_unsigned(2);
286 call->rp_prog = txdr_unsigned(prog);
287 call->rp_vers = txdr_unsigned(vers);
288 call->rp_proc = txdr_unsigned(func);
289 /* rpc_auth part (auth_unix as root) */
290 call->rpc_auth.authtype = txdr_unsigned(RPCAUTH_UNIX);
291 call->rpc_auth.authlen = txdr_unsigned(sizeof(struct auth_unix));
292 /* rpc_verf part (auth_null) */
293 call->rpc_verf.authtype = 0;
294 call->rpc_verf.authlen = 0;
297 * Setup packet header
305 mhead->m_pkthdr.len = len;
306 mhead->m_pkthdr.rcvif = NULL;
309 * Send it, repeatedly, until a reply is received,
310 * but delay each re-send by an increasing amount.
311 * If the delay hits the maximum, start complaining.
315 /* Send RPC request (or re-send). */
316 m = m_copym(mhead, 0, M_COPYALL, MB_WAIT);
321 error = sosend(so, (struct sockaddr *)sa, NULL, m,
324 printf("krpc_call: sosend: %d\n", error);
329 /* Determine new timeout. */
330 if (timo < MAX_RESEND_DELAY)
333 saddr = ntohl(sa->sin_addr.s_addr);
334 printf("RPC timeout for server %d.%d.%d.%d\n",
342 * Wait for up to timo seconds for a reply.
343 * The socket receive timeout was set to 1 second.
348 FREE(from, M_SONAME);
355 bzero(&auio,sizeof(auio));
356 auio.uio_resid = len = 1<<16;
358 error = soreceive(so, &from, &auio, &m, NULL, &rcvflg);
359 if (error == EWOULDBLOCK) {
365 len -= auio.uio_resid;
367 /* Does the reply contain at least a header? */
368 if (len < MIN_REPLY_HDR)
370 if (m->m_len < MIN_REPLY_HDR)
372 reply = mtod(m, struct rpc_reply *);
374 /* Is it the right reply? */
375 if (reply->rp_direction != txdr_unsigned(RPC_REPLY))
378 if (reply->rp_xid != txdr_unsigned(xid))
381 /* Was RPC accepted? (authorization OK) */
382 if (reply->rp_astatus != 0) {
383 error = fxdr_unsigned(u_int32_t, reply->rp_errno);
384 printf("rpc denied, error=%d\n", error);
388 /* Did the call succeed? */
389 if (reply->rp_status != 0) {
390 error = fxdr_unsigned(u_int32_t, reply->rp_status);
391 if (error == RPC_PROGMISMATCH) {
395 printf("rpc denied, status=%d\n", error);
399 goto gotreply; /* break two levels */
402 } /* forever send/receive */
410 * Get RPC reply header into first mbuf,
411 * get its length, then strip it off.
413 len = sizeof(*reply);
414 if (m->m_len < len) {
415 m = m_pullup(m, len);
421 reply = mtod(m, struct rpc_reply *);
422 if (reply->rp_auth.authtype != 0) {
423 len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen);
424 len = (len + 3) & ~3; /* XXX? */
436 if (mhead) m_freem(mhead);
437 if (from) free(from, M_SONAME);
443 * eXternal Data Representation routines.
444 * (but with non-standard args...)
448 * String representation for RPC.
451 u_int32_t len; /* length without null or padding */
452 char data[4]; /* data (longer, of course) */
453 /* data is padded to a long-word boundary */
457 xdr_string_encode(char *str, int len)
460 struct xdr_string *xs;
461 int dlen; /* padded string length */
462 int mlen; /* message length */
464 dlen = (len + 3) & ~3;
467 if (mlen > MCLBYTES) /* If too big, we just can't do it. */
470 m = m_get(MB_WAIT, MT_DATA);
473 if ((m->m_flags & M_EXT) == 0) {
474 (void) m_free(m); /* There can be only one. */
478 xs = mtod(m, struct xdr_string *);
480 xs->len = txdr_unsigned(len);
481 bcopy(str, xs->data, len);