krpc_subr.c revision 201044
1/* $NetBSD: krpc_subr.c,v 1.12.4.1 1996/06/07 00:52:26 cgd Exp $ */ 2 3/*- 4 * Copyright (c) 1995 Gordon Ross, Adam Glass 5 * Copyright (c) 1992 Regents of the University of California. 6 * All rights reserved. 7 * 8 * This software was developed by the Computer Systems Engineering group 9 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and 10 * contributed to Berkeley. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Lawrence Berkeley Laboratory and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * partially based on: 41 * libnetboot/rpc.c 42 * @(#) Header: rpc.c,v 1.12 93/09/28 08:31:56 leres Exp (LBL) 43 */ 44 45#include <sys/cdefs.h> 46__FBSDID("$FreeBSD: head/sys/nfsclient/krpc_subr.c 201044 2009-12-27 10:10:38Z bz $"); 47 48#include <sys/param.h> 49#include <sys/systm.h> 50#include <sys/jail.h> 51#include <sys/malloc.h> 52#include <sys/mbuf.h> 53#include <sys/proc.h> 54#include <sys/socket.h> 55#include <sys/socketvar.h> 56#include <sys/uio.h> 57 58#include <net/if.h> 59#include <net/vnet.h> 60 61#include <netinet/in.h> 62 63#include <rpc/types.h> 64#include <rpc/auth.h> 65#include <rpc/rpc_msg.h> 66#include <nfsclient/krpc.h> 67#include <nfs/xdr_subs.h> 68 69/* 70 * Kernel support for Sun RPC 71 * 72 * Used currently for bootstrapping in nfs diskless configurations. 73 */ 74 75/* 76 * Generic RPC headers 77 */ 78 79struct auth_info { 80 u_int32_t authtype; /* auth type */ 81 u_int32_t authlen; /* auth length */ 82}; 83 84struct auth_unix { 85 int32_t ua_time; 86 int32_t ua_hostname; /* null */ 87 int32_t ua_uid; 88 int32_t ua_gid; 89 int32_t ua_gidlist; /* null */ 90}; 91 92struct krpc_call { 93 u_int32_t rp_xid; /* request transaction id */ 94 int32_t rp_direction; /* call direction (0) */ 95 u_int32_t rp_rpcvers; /* rpc version (2) */ 96 u_int32_t rp_prog; /* program */ 97 u_int32_t rp_vers; /* version */ 98 u_int32_t rp_proc; /* procedure */ 99 struct auth_info rpc_auth; 100 struct auth_unix rpc_unix; 101 struct auth_info rpc_verf; 102}; 103 104struct krpc_reply { 105 u_int32_t rp_xid; /* request transaction id */ 106 int32_t rp_direction; /* call direction (1) */ 107 int32_t rp_astatus; /* accept status (0: accepted) */ 108 union { 109 u_int32_t rpu_errno; 110 struct { 111 struct auth_info rok_auth; 112 u_int32_t rok_status; 113 } rpu_rok; 114 } rp_u; 115}; 116#define rp_errno rp_u.rpu_errno 117#define rp_auth rp_u.rpu_rok.rok_auth 118#define rp_status rp_u.rpu_rok.rok_status 119 120#define MIN_REPLY_HDR 16 /* xid, dir, astat, errno */ 121 122/* 123 * What is the longest we will wait before re-sending a request? 124 * Note this is also the frequency of "RPC timeout" messages. 125 * The re-send loop count sup linearly to this maximum, so the 126 * first complaint will happen after (1+2+3+4+5)=15 seconds. 127 */ 128#define MAX_RESEND_DELAY 5 /* seconds */ 129 130/* 131 * Call portmap to lookup a port number for a particular rpc program 132 * Returns non-zero error on failure. 133 */ 134int 135krpc_portmap(struct sockaddr_in *sin, u_int prog, u_int vers, u_int16_t *portp, 136 struct thread *td) 137{ 138 struct sdata { 139 u_int32_t prog; /* call program */ 140 u_int32_t vers; /* call version */ 141 u_int32_t proto; /* call protocol */ 142 u_int32_t port; /* call port (unused) */ 143 } *sdata; 144 struct rdata { 145 u_int16_t pad; 146 u_int16_t port; 147 } *rdata; 148 struct mbuf *m; 149 int error; 150 151 /* The portmapper port is fixed. */ 152 if (prog == PMAPPROG) { 153 *portp = htons(PMAPPORT); 154 return 0; 155 } 156 157 m = m_get(M_WAIT, MT_DATA); 158 sdata = mtod(m, struct sdata *); 159 m->m_len = sizeof(*sdata); 160 161 /* Do the RPC to get it. */ 162 sdata->prog = txdr_unsigned(prog); 163 sdata->vers = txdr_unsigned(vers); 164 sdata->proto = txdr_unsigned(IPPROTO_UDP); 165 sdata->port = 0; 166 167 sin->sin_port = htons(PMAPPORT); 168 error = krpc_call(sin, PMAPPROG, PMAPVERS, 169 PMAPPROC_GETPORT, &m, NULL, td); 170 if (error) 171 return error; 172 173 if (m->m_len < sizeof(*rdata)) { 174 m = m_pullup(m, sizeof(*rdata)); 175 if (m == NULL) 176 return ENOBUFS; 177 } 178 rdata = mtod(m, struct rdata *); 179 *portp = rdata->port; 180 181 m_freem(m); 182 return 0; 183} 184 185/* 186 * Do a remote procedure call (RPC) and wait for its reply. 187 * If from_p is non-null, then we are doing broadcast, and 188 * the address from whence the response came is saved there. 189 */ 190int 191krpc_call(struct sockaddr_in *sa, u_int prog, u_int vers, u_int func, 192 struct mbuf **data, struct sockaddr **from_p, struct thread *td) 193{ 194 struct socket *so; 195 struct sockaddr_in *sin, ssin; 196 struct sockaddr *from; 197 struct mbuf *m, *nam, *mhead; 198 struct krpc_call *call; 199 struct krpc_reply *reply; 200 struct sockopt sopt; 201 struct timeval tv; 202 struct uio auio; 203 int error, rcvflg, timo, secs, len; 204 static u_int32_t xid = ~0xFF; 205 u_int16_t tport; 206 u_int32_t saddr; 207 208 /* 209 * Validate address family. 210 * Sorry, this is INET specific... 211 */ 212 if (sa->sin_family != AF_INET) 213 return (EAFNOSUPPORT); 214 215 /* Free at end if not null. */ 216 nam = mhead = NULL; 217 from = NULL; 218 219 CURVNET_SET(TD_TO_VNET(td)); 220 221 /* 222 * Create socket and set its recieve timeout. 223 */ 224 if ((error = socreate(AF_INET, &so, SOCK_DGRAM, 0, td->td_ucred, td))) 225 goto out; 226 227 tv.tv_sec = 1; 228 tv.tv_usec = 0; 229 bzero(&sopt, sizeof sopt); 230 sopt.sopt_dir = SOPT_SET; 231 sopt.sopt_level = SOL_SOCKET; 232 sopt.sopt_name = SO_RCVTIMEO; 233 sopt.sopt_val = &tv; 234 sopt.sopt_valsize = sizeof tv; 235 236 if ((error = sosetopt(so, &sopt)) != 0) 237 goto out; 238 239 /* 240 * Enable broadcast if necessary. 241 */ 242 if (from_p) { 243 int on = 1; 244 sopt.sopt_name = SO_BROADCAST; 245 sopt.sopt_val = &on; 246 sopt.sopt_valsize = sizeof on; 247 if ((error = sosetopt(so, &sopt)) != 0) 248 goto out; 249 } 250 251 /* 252 * Bind the local endpoint to a reserved port, 253 * because some NFS servers refuse requests from 254 * non-reserved (non-privileged) ports. 255 */ 256 sin = &ssin; 257 bzero(sin, sizeof *sin); 258 sin->sin_len = sizeof(*sin); 259 sin->sin_family = AF_INET; 260 sin->sin_addr.s_addr = INADDR_ANY; 261 tport = IPPORT_RESERVED; 262 do { 263 tport--; 264 sin->sin_port = htons(tport); 265 error = sobind(so, (struct sockaddr *)sin, td); 266 } while (error == EADDRINUSE && 267 tport > IPPORT_RESERVED / 2); 268 if (error) { 269 printf("bind failed\n"); 270 goto out; 271 } 272 273 /* 274 * Setup socket address for the server. 275 */ 276 277 /* 278 * Prepend RPC message header. 279 */ 280 mhead = m_gethdr(M_WAIT, MT_DATA); 281 mhead->m_next = *data; 282 call = mtod(mhead, struct krpc_call *); 283 mhead->m_len = sizeof(*call); 284 bzero((caddr_t)call, sizeof(*call)); 285 /* rpc_call part */ 286 xid++; 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(AUTH_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; 299 300 /* 301 * Setup packet header 302 */ 303 m_fixhdr(mhead); 304 mhead->m_pkthdr.rcvif = NULL; 305 306 /* 307 * Send it, repeatedly, until a reply is received, 308 * but delay each re-send by an increasing amount. 309 * If the delay hits the maximum, start complaining. 310 */ 311 timo = 0; 312 for (;;) { 313 /* Send RPC request (or re-send). */ 314 m = m_copym(mhead, 0, M_COPYALL, M_WAIT); 315 error = sosend(so, (struct sockaddr *)sa, NULL, m, 316 NULL, 0, td); 317 if (error) { 318 printf("krpc_call: sosend: %d\n", error); 319 goto out; 320 } 321 m = NULL; 322 323 /* Determine new timeout. */ 324 if (timo < MAX_RESEND_DELAY) 325 timo++; 326 else { 327 saddr = ntohl(sa->sin_addr.s_addr); 328 printf("RPC timeout for server %d.%d.%d.%d\n", 329 (saddr >> 24) & 255, 330 (saddr >> 16) & 255, 331 (saddr >> 8) & 255, 332 saddr & 255); 333 } 334 335 /* 336 * Wait for up to timo seconds for a reply. 337 * The socket receive timeout was set to 1 second. 338 */ 339 secs = timo; 340 while (secs > 0) { 341 if (from) { 342 free(from, M_SONAME); 343 from = NULL; 344 } 345 if (m) { 346 m_freem(m); 347 m = NULL; 348 } 349 bzero(&auio, sizeof(auio)); 350 auio.uio_resid = len = 1<<16; 351 rcvflg = 0; 352 error = soreceive(so, &from, &auio, &m, NULL, &rcvflg); 353 if (error == EWOULDBLOCK) { 354 secs--; 355 continue; 356 } 357 if (error) 358 goto out; 359 len -= auio.uio_resid; 360 361 /* Does the reply contain at least a header? */ 362 if (len < MIN_REPLY_HDR) 363 continue; 364 if (m->m_len < MIN_REPLY_HDR) 365 continue; 366 reply = mtod(m, struct krpc_reply *); 367 368 /* Is it the right reply? */ 369 if (reply->rp_direction != txdr_unsigned(REPLY)) 370 continue; 371 372 if (reply->rp_xid != txdr_unsigned(xid)) 373 continue; 374 375 /* Was RPC accepted? (authorization OK) */ 376 if (reply->rp_astatus != 0) { 377 error = fxdr_unsigned(u_int32_t, reply->rp_errno); 378 printf("rpc denied, error=%d\n", error); 379 continue; 380 } 381 382 /* Did the call succeed? */ 383 if (reply->rp_status != 0) { 384 error = fxdr_unsigned(u_int32_t, reply->rp_status); 385 if (error == PROG_MISMATCH) { 386 error = EBADRPC; 387 goto out; 388 } 389 printf("rpc denied, status=%d\n", error); 390 continue; 391 } 392 393 goto gotreply; /* break two levels */ 394 395 } /* while secs */ 396 } /* forever send/receive */ 397 398 error = ETIMEDOUT; 399 goto out; 400 401 gotreply: 402 403 /* 404 * Get RPC reply header into first mbuf, 405 * get its length, then strip it off. 406 */ 407 len = sizeof(*reply); 408 if (m->m_len < len) { 409 m = m_pullup(m, len); 410 if (m == NULL) { 411 error = ENOBUFS; 412 goto out; 413 } 414 } 415 reply = mtod(m, struct krpc_reply *); 416 if (reply->rp_auth.authtype != 0) { 417 len += fxdr_unsigned(u_int32_t, reply->rp_auth.authlen); 418 len = (len + 3) & ~3; /* XXX? */ 419 } 420 m_adj(m, len); 421 422 /* result */ 423 *data = m; 424 if (from_p) { 425 *from_p = from; 426 from = NULL; 427 } 428 429 out: 430 if (mhead) m_freem(mhead); 431 if (from) free(from, M_SONAME); 432 soclose(so); 433 CURVNET_RESTORE(); 434 return error; 435} 436 437/* 438 * eXternal Data Representation routines. 439 * (but with non-standard args...) 440 */ 441 442/* 443 * String representation for RPC. 444 */ 445struct xdr_string { 446 u_int32_t len; /* length without null or padding */ 447 char data[4]; /* data (longer, of course) */ 448 /* data is padded to a long-word boundary */ 449}; 450 451struct mbuf * 452xdr_string_encode(char *str, int len) 453{ 454 struct mbuf *m; 455 struct xdr_string *xs; 456 int dlen; /* padded string length */ 457 int mlen; /* message length */ 458 459 dlen = (len + 3) & ~3; 460 mlen = dlen + 4; 461 462 if (mlen > MCLBYTES) /* If too big, we just can't do it. */ 463 return (NULL); 464 465 m = m_get(M_WAIT, MT_DATA); 466 if (mlen > MLEN) 467 MCLGET(m, M_WAIT); 468 xs = mtod(m, struct xdr_string *); 469 m->m_len = mlen; 470 xs->len = txdr_unsigned(len); 471 bcopy(str, xs->data, len); 472 return (m); 473} 474