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.12 2007/04/22 01:13:17 dillon 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>
54 #include <sys/fcntl.h>
57 #include <netinet/in.h>
64 * Kernel support for Sun RPC
66 * Used currently for bootstrapping in nfs diskless configurations.
74 u_int32_t authtype; /* auth type */
75 u_int32_t authlen; /* auth length */
80 int32_t ua_hostname; /* null */
83 int32_t ua_gidlist; /* null */
87 u_int32_t rp_xid; /* request transaction id */
88 int32_t rp_direction; /* call direction (0) */
89 u_int32_t rp_rpcvers; /* rpc version (2) */
90 u_int32_t rp_prog; /* program */
91 u_int32_t rp_vers; /* version */
92 u_int32_t rp_proc; /* procedure */
93 struct auth_info rpc_auth;
94 struct auth_unix rpc_unix;
95 struct auth_info rpc_verf;
99 u_int32_t rp_xid; /* request transaction id */
100 int32_t rp_direction; /* call direction (1) */
101 int32_t rp_astatus; /* accept status (0: accepted) */
105 struct auth_info rok_auth;
106 u_int32_t rok_status;
110 #define rp_errno rp_u.rpu_errno
111 #define rp_auth rp_u.rpu_rok.rok_auth
112 #define rp_status rp_u.rpu_rok.rok_status
114 #define MIN_REPLY_HDR 16 /* xid, dir, astat, errno */
117 * What is the longest we will wait before re-sending a request?
118 * Note this is also the frequency of "RPC timeout" messages.
119 * The re-send loop count sup linearly to this maximum, so the
120 * first complaint will happen after (1+2+3+4+5)=15 seconds.
122 #define MAX_RESEND_DELAY 5 /* seconds */
125 * Call portmap to lookup a port number for a particular rpc program
126 * Returns non-zero error on failure.
129 krpc_portmap(struct sockaddr_in *sin, /* server address */
130 u_int prog, u_int vers, /* host order */
131 u_int16_t *portp, /* network order */
135 u_int32_t prog; /* call program */
136 u_int32_t vers; /* call version */
137 u_int32_t proto; /* call protocol */
138 u_int32_t port; /* call port (unused) */
147 /* The portmapper port is fixed. */
148 if (prog == PMAPPROG) {
149 *portp = htons(PMAPPORT);
153 m = m_get(MB_WAIT, MT_DATA);
156 sdata = mtod(m, struct sdata *);
157 m->m_len = sizeof(*sdata);
159 /* Do the RPC to get it. */
160 sdata->prog = txdr_unsigned(prog);
161 sdata->vers = txdr_unsigned(vers);
162 sdata->proto = txdr_unsigned(IPPROTO_UDP);
165 sin->sin_port = htons(PMAPPORT);
166 error = krpc_call(sin, PMAPPROG, PMAPVERS,
167 PMAPPROC_GETPORT, &m, NULL, td);
171 if (m->m_len < sizeof(*rdata)) {
172 m = m_pullup(m, sizeof(*rdata));
176 rdata = mtod(m, struct rdata *);
177 *portp = rdata->port;
184 * Do a remote procedure call (RPC) and wait for its reply.
185 * If from_p is non-null, then we are doing broadcast, and
186 * the address from whence the response came is saved there.
189 krpc_call(struct sockaddr_in *sa, u_int prog, u_int vers, u_int func,
190 struct mbuf **data, /* input/output */
191 struct sockaddr **from_p, /* output */
195 struct sockaddr_in *sin, ssin;
196 struct sockaddr *from;
197 struct mbuf *m, *nam, *mhead;
198 struct rpc_call *call;
199 struct rpc_reply *reply;
203 int error, rcvflg, timo, secs, len;
204 static u_int32_t static_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, td)))
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, td);
264 } while (error == EADDRINUSE &&
265 tport > IPPORT_RESERVED / 2);
267 kprintf("bind failed\n");
272 * Setup socket address for the server.
276 * Prepend RPC message header.
278 mhead = m_gethdr(MB_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 xid = atomic_fetchadd_int(&static_xid, 1);
287 call->rp_xid = txdr_unsigned(xid);
288 /* call->rp_direction = 0; */
289 call->rp_rpcvers = txdr_unsigned(2);
290 call->rp_prog = txdr_unsigned(prog);
291 call->rp_vers = txdr_unsigned(vers);
292 call->rp_proc = txdr_unsigned(func);
293 /* rpc_auth part (auth_unix as root) */
294 call->rpc_auth.authtype = txdr_unsigned(RPCAUTH_UNIX);
295 call->rpc_auth.authlen = txdr_unsigned(sizeof(struct auth_unix));
296 /* rpc_verf part (auth_null) */
297 call->rpc_verf.authtype = 0;
298 call->rpc_verf.authlen = 0;
301 * Setup packet header
309 mhead->m_pkthdr.len = len;
310 mhead->m_pkthdr.rcvif = NULL;
313 * Send it, repeatedly, until a reply is received,
314 * but delay each re-send by an increasing amount.
315 * If the delay hits the maximum, start complaining.
319 /* Send RPC request (or re-send). */
320 m = m_copym(mhead, 0, M_COPYALL, MB_WAIT);
325 error = sosend(so, (struct sockaddr *)sa, NULL, m,
328 kprintf("krpc_call: sosend: %d\n", error);
333 /* Determine new timeout. */
334 if (timo < MAX_RESEND_DELAY)
337 saddr = ntohl(sa->sin_addr.s_addr);
338 kprintf("RPC timeout for server %d.%d.%d.%d\n",
346 * Wait for up to timo seconds for a reply.
347 * The socket receive timeout was set to 1 second.
352 FREE(from, M_SONAME);
362 error = soreceive(so, &from, NULL, &sio, NULL, &rcvflg);
363 if (error == EWOULDBLOCK) {
372 /* Does the reply contain at least a header? */
373 if (len < MIN_REPLY_HDR)
375 if (m->m_len < MIN_REPLY_HDR)
377 reply = mtod(m, struct rpc_reply *);
379 /* Is it the right reply? */
380 if (reply->rp_direction != txdr_unsigned(RPC_REPLY))
383 if (reply->rp_xid != txdr_unsigned(xid))
386 /* Was RPC accepted? (authorization OK) */
387 if (reply->rp_astatus != 0) {
388 error = fxdr_unsigned(u_int32_t, reply->rp_errno);
389 kprintf("rpc denied, error=%d\n", error);
393 /* Did the call succeed? */
394 if (reply->rp_status != 0) {
395 error = fxdr_unsigned(u_int32_t, reply->rp_status);
396 if (error == RPC_PROGMISMATCH) {
400 kprintf("rpc denied, status=%d\n", error);
404 goto gotreply; /* break two levels */
407 } /* forever send/receive */
415 * Get RPC reply header into first mbuf,
416 * get its length, then strip it off.
418 len = sizeof(*reply);
419 if (m->m_len < len) {
420 m = m_pullup(m, len);
426 reply = mtod(m, struct rpc_reply *);
427 if (reply->rp_auth.authtype != 0) {
428 len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen);
429 len = (len + 3) & ~3; /* XXX? */
441 if (mhead) m_freem(mhead);
442 if (from) kfree(from, M_SONAME);
443 soclose(so, FNONBLOCK);
448 * eXternal Data Representation routines.
449 * (but with non-standard args...)
453 * String representation for RPC.
456 u_int32_t len; /* length without null or padding */
457 char data[4]; /* data (longer, of course) */
458 /* data is padded to a long-word boundary */
462 xdr_string_encode(char *str, int len)
465 struct xdr_string *xs;
466 int dlen; /* padded string length */
467 int mlen; /* message length */
469 dlen = (len + 3) & ~3;
472 if (mlen > MCLBYTES) /* If too big, we just can't do it. */
475 m = m_getl(mlen, MB_WAIT, MT_DATA, 0, NULL);
476 xs = mtod(m, struct xdr_string *);
478 xs->len = txdr_unsigned(len);
479 bcopy(str, xs->data, len);