1 /* @(#)clnt_udp.c 2.2 88/08/01 4.0 RPCSRC */
3 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4 * unrestricted use provided that this legend is included on all tape
5 * media and as a part of the software program in whole or part. Users
6 * may copy or modify Sun RPC without charge, but are not authorized
7 * to license or distribute it to anyone else except as part of a product or
8 * program developed by the user.
10 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14 * Sun RPC is provided with no support and without any obligation on the
15 * part of Sun Microsystems, Inc. to assist in its use, correction,
16 * modification or enhancement.
18 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20 * OR ANY PART THEREOF.
22 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23 * or profits or other special, indirect and consequential damages, even if
24 * Sun has been advised of the possibility of such damages.
26 * Sun Microsystems, Inc.
28 * Mountain View, California 94043
31 static char sccsid[] = "@(#)clnt_udp.c 1.39 87/08/11 Copyr 1984 Sun Micro";
35 * clnt_udp.c, Implements a UDP/IP based, client side RPC.
37 * Copyright (C) 1984, Sun Microsystems, Inc.
40 /* CMSG_NXTHDR is using it */
41 #define __cmsg_nxthdr __cmsg_nxthdr_internal
43 #define authnone_create __authnone_create
44 #define xdrmem_create __xdrmem_create
46 #define pmap_getport __pmap_getport
57 #include <sys/socket.h>
58 #include <sys/ioctl.h>
61 #include <rpc/pmap_clnt.h>
72 extern bool_t xdr_opaque_auth (XDR *, struct opaque_auth *);
73 extern u_long _create_xid (void) attribute_hidden;
76 * UDP bases client side rpc operations
78 static enum clnt_stat clntudp_call (CLIENT *, u_long, xdrproc_t, caddr_t,
79 xdrproc_t, caddr_t, struct timeval);
80 static void clntudp_abort (void);
81 static void clntudp_geterr (CLIENT *, struct rpc_err *);
82 static bool_t clntudp_freeres (CLIENT *, xdrproc_t, caddr_t);
83 static bool_t clntudp_control (CLIENT *, int, char *);
84 static void clntudp_destroy (CLIENT *);
86 static struct clnt_ops udp_ops =
97 * Private data kept per client handle
103 struct sockaddr_in cu_raddr;
105 struct timeval cu_wait;
106 struct timeval cu_total;
107 struct rpc_err cu_error;
117 * Create a UDP based client handle.
118 * If *sockp<0, *sockp is set to a newly created UPD socket.
119 * If raddr->sin_port is 0 a binder on the remote machine
120 * is consulted for the correct port number.
121 * NB: It is the clients responsibility to close *sockp.
122 * NB: The rpch->cl_auth is initialized to null authentication.
123 * Caller may wish to set this something more useful.
125 * wait is the amount of time used between retransmitting a call if
126 * no response has been heard; retransmission occurs until the actual
127 * rpc call times out.
129 * sendsz and recvsz are the maximum allowable packet sizes that can be
132 CLIENT attribute_hidden *
133 __clntudp_bufcreate (struct sockaddr_in *raddr, u_long program, u_long version,
134 struct timeval wait, int *sockp, u_int sendsz,
138 struct cu_data *cu = NULL;
139 struct rpc_msg call_msg;
141 cl = (CLIENT *) mem_alloc (sizeof (CLIENT));
142 sendsz = ((sendsz + 3) / 4) * 4;
143 recvsz = ((recvsz + 3) / 4) * 4;
144 cu = (struct cu_data *) mem_alloc (sizeof (*cu) + sendsz + recvsz);
145 if (cl == NULL || cu == NULL)
147 struct rpc_createerr *ce = &get_rpc_createerr ();
149 if (_IO_fwide (stderr, 0) > 0)
150 (void) __fwprintf (stderr, L"%s",
151 _("clntudp_create: out of memory\n"));
154 (void) fputs (_("clntudp_create: out of memory\n"), stderr);
155 ce->cf_stat = RPC_SYSTEMERROR;
156 ce->cf_error.re_errno = ENOMEM;
159 cu->cu_outbuf = &cu->cu_inbuf[recvsz];
161 if (raddr->sin_port == 0)
165 pmap_getport (raddr, program, version, IPPROTO_UDP)) == 0)
169 raddr->sin_port = htons (port);
171 cl->cl_ops = &udp_ops;
172 cl->cl_private = (caddr_t) cu;
173 cu->cu_raddr = *raddr;
174 cu->cu_rlen = sizeof (cu->cu_raddr);
176 cu->cu_total.tv_sec = -1;
177 cu->cu_total.tv_usec = -1;
178 cu->cu_sendsz = sendsz;
179 cu->cu_recvsz = recvsz;
180 call_msg.rm_xid = _create_xid ();
181 call_msg.rm_direction = CALL;
182 call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
183 call_msg.rm_call.cb_prog = program;
184 call_msg.rm_call.cb_vers = version;
185 xdrmem_create (&(cu->cu_outxdrs), cu->cu_outbuf,
187 if (!xdr_callhdr (&(cu->cu_outxdrs), &call_msg))
191 cu->cu_xdrpos = XDR_GETPOS (&(cu->cu_outxdrs));
196 *sockp = socket (AF_INET, SOCK_DGRAM, IPPROTO_UDP);
199 struct rpc_createerr *ce = &get_rpc_createerr ();
200 ce->cf_stat = RPC_SYSTEMERROR;
201 ce->cf_error.re_errno = errno;
204 /* attempt to bind to prov port */
205 (void) bindresvport (*sockp, (struct sockaddr_in *) 0);
206 /* the sockets rpc controls are non-blocking */
207 (void) ioctl (*sockp, FIONBIO, (char *) &dontblock);
211 setsockopt(*sockp, SOL_IP, IP_RECVERR, &on, sizeof(on));
214 cu->cu_closeit = TRUE;
218 cu->cu_closeit = FALSE;
220 cu->cu_sock = *sockp;
221 cl->cl_auth = authnone_create ();
225 mem_free ((caddr_t) cu, sizeof (*cu) + sendsz + recvsz);
227 mem_free ((caddr_t) cl, sizeof (CLIENT));
228 return (CLIENT *) NULL;
230 strong_alias(__clntudp_bufcreate,clntudp_bufcreate)
232 CLIENT attribute_hidden *
233 __clntudp_create (struct sockaddr_in *raddr, u_long program, u_long version, struct timeval wait, int *sockp)
236 return __clntudp_bufcreate (raddr, program, version, wait, sockp,
237 UDPMSGSIZE, UDPMSGSIZE);
239 strong_alias(__clntudp_create,clntudp_create)
242 is_network_up (int sock)
245 char buf[UDPMSGSIZE];
246 struct ifreq ifreq, *ifr;
249 ifc.ifc_len = sizeof (buf);
251 if (ioctl(sock, SIOCGIFCONF, (char *) &ifc) == 0)
254 for (n = ifc.ifc_len / sizeof (struct ifreq); n > 0; n--, ifr++)
257 if (ioctl (sock, SIOCGIFFLAGS, (char *) &ifreq) < 0)
260 if ((ifreq.ifr_flags & IFF_UP)
261 && ifr->ifr_addr.sa_family == AF_INET)
268 static enum clnt_stat
269 clntudp_call (cl, proc, xargs, argsp, xresults, resultsp, utimeout)
270 CLIENT *cl; /* client handle */
271 u_long proc; /* procedure number */
272 xdrproc_t xargs; /* xdr routine for args */
273 caddr_t argsp; /* pointer to args */
274 xdrproc_t xresults; /* xdr routine for results */
275 caddr_t resultsp; /* pointer to results */
276 struct timeval utimeout; /* seconds to wait before giving up */
278 struct cu_data *cu = (struct cu_data *) cl->cl_private;
284 int milliseconds = (cu->cu_wait.tv_sec * 1000) +
285 (cu->cu_wait.tv_usec / 1000);
286 struct sockaddr_in from;
287 struct rpc_msg reply_msg;
289 struct timeval time_waited;
291 int nrefreshes = 2; /* number of times to refresh cred */
292 struct timeval timeout;
293 int anyup; /* any network interface up */
295 if (cu->cu_total.tv_usec == -1)
297 timeout = utimeout; /* use supplied timeout */
301 timeout = cu->cu_total; /* use default timeout */
304 time_waited.tv_sec = 0;
305 time_waited.tv_usec = 0;
307 xdrs = &(cu->cu_outxdrs);
310 xdrs->x_op = XDR_ENCODE;
311 XDR_SETPOS (xdrs, cu->cu_xdrpos);
313 * the transaction is the first thing in the out buffer
315 (*(uint32_t *) (cu->cu_outbuf))++;
316 if ((!XDR_PUTLONG (xdrs, (long *) &proc)) ||
317 (!AUTH_MARSHALL (cl->cl_auth, xdrs)) ||
318 (!(*xargs) (xdrs, argsp)))
319 return (cu->cu_error.re_status = RPC_CANTENCODEARGS);
320 outlen = (int) XDR_GETPOS (xdrs);
323 if (sendto (cu->cu_sock, cu->cu_outbuf, outlen, 0,
324 (struct sockaddr *) &(cu->cu_raddr), cu->cu_rlen)
327 cu->cu_error.re_errno = errno;
328 return (cu->cu_error.re_status = RPC_CANTSEND);
332 * Hack to provide rpc-based message passing
334 if (timeout.tv_sec == 0 && timeout.tv_usec == 0)
336 return (cu->cu_error.re_status = RPC_TIMEDOUT);
340 * sub-optimal code appears here because we have
341 * some clock time to spare while the packets are in flight.
342 * (We assume that this is actually only executed once.)
344 reply_msg.acpted_rply.ar_verf = _null_auth;
345 reply_msg.acpted_rply.ar_results.where = resultsp;
346 reply_msg.acpted_rply.ar_results.proc = xresults;
352 switch (poll (&fd, 1, milliseconds))
358 anyup = is_network_up (cu->cu_sock);
360 return (cu->cu_error.re_status = RPC_CANTRECV);
363 time_waited.tv_sec += cu->cu_wait.tv_sec;
364 time_waited.tv_usec += cu->cu_wait.tv_usec;
365 while (time_waited.tv_usec >= 1000000)
367 time_waited.tv_sec++;
368 time_waited.tv_usec -= 1000000;
370 if ((time_waited.tv_sec < timeout.tv_sec) ||
371 ((time_waited.tv_sec == timeout.tv_sec) &&
372 (time_waited.tv_usec < timeout.tv_usec)))
374 return (cu->cu_error.re_status = RPC_TIMEDOUT);
377 * buggy in other cases because time_waited is not being
383 cu->cu_error.re_errno = errno;
384 return (cu->cu_error.re_status = RPC_CANTRECV);
387 if (fd.revents & POLLERR)
390 struct cmsghdr *cmsg;
391 struct sock_extended_err *e;
392 struct sockaddr_in err_addr;
394 char *cbuf = (char *) alloca (outlen + 256);
397 iov.iov_base = cbuf + 256;
398 iov.iov_len = outlen;
399 msg.msg_name = (void *) &err_addr;
400 msg.msg_namelen = sizeof (err_addr);
404 msg.msg_control = cbuf;
405 msg.msg_controllen = 256;
406 ret = recvmsg (cu->cu_sock, &msg, MSG_ERRQUEUE);
408 && __memcmp (cbuf + 256, cu->cu_outbuf, ret) == 0
409 && (msg.msg_flags & MSG_ERRQUEUE)
410 && ((msg.msg_namelen == 0
412 || (msg.msg_namelen == sizeof (err_addr)
413 && err_addr.sin_family == AF_INET
414 && __memcmp (&err_addr.sin_addr, &cu->cu_raddr.sin_addr,
415 sizeof (err_addr.sin_addr)) == 0
416 && err_addr.sin_port == cu->cu_raddr.sin_port)))
417 for (cmsg = CMSG_FIRSTHDR (&msg); cmsg;
418 cmsg = CMSG_NXTHDR (&msg, cmsg))
419 if (cmsg->cmsg_level == SOL_IP && cmsg->cmsg_type == IP_RECVERR)
421 e = (struct sock_extended_err *) CMSG_DATA(cmsg);
422 cu->cu_error.re_errno = e->ee_errno;
423 return (cu->cu_error.re_status = RPC_CANTRECV);
429 fromlen = sizeof (struct sockaddr);
430 inlen = recvfrom (cu->cu_sock, cu->cu_inbuf,
431 (int) cu->cu_recvsz, 0,
432 (struct sockaddr *) &from, &fromlen);
434 while (inlen < 0 && errno == EINTR);
437 if (errno == EWOULDBLOCK)
439 cu->cu_error.re_errno = errno;
440 return (cu->cu_error.re_status = RPC_CANTRECV);
445 /* see if reply transaction id matches sent id.
446 Don't do this if we only wait for a replay */
448 && (*((u_int32_t *) (cu->cu_inbuf))
449 != *((u_int32_t *) (cu->cu_outbuf))))
451 /* we now assume we have the proper reply */
456 * now decode and validate the response
458 xdrmem_create (&reply_xdrs, cu->cu_inbuf, (u_int) inlen, XDR_DECODE);
459 ok = xdr_replymsg (&reply_xdrs, &reply_msg);
460 /* XDR_DESTROY(&reply_xdrs); save a few cycles on noop destroy */
463 _seterr_reply (&reply_msg, &(cu->cu_error));
464 if (cu->cu_error.re_status == RPC_SUCCESS)
466 if (!AUTH_VALIDATE (cl->cl_auth,
467 &reply_msg.acpted_rply.ar_verf))
469 cu->cu_error.re_status = RPC_AUTHERROR;
470 cu->cu_error.re_why = AUTH_INVALIDRESP;
472 if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)
474 xdrs->x_op = XDR_FREE;
475 (void) xdr_opaque_auth (xdrs,
476 &(reply_msg.acpted_rply.ar_verf));
478 } /* end successful completion */
481 /* maybe our credentials need to be refreshed ... */
482 if (nrefreshes > 0 && AUTH_REFRESH (cl->cl_auth))
487 } /* end of unsuccessful completion */
488 } /* end of valid reply message */
491 cu->cu_error.re_status = RPC_CANTDECODERES;
493 return cu->cu_error.re_status;
497 clntudp_geterr (CLIENT *cl, struct rpc_err *errp)
499 struct cu_data *cu = (struct cu_data *) cl->cl_private;
501 *errp = cu->cu_error;
506 clntudp_freeres (CLIENT *cl, xdrproc_t xdr_res, caddr_t res_ptr)
508 struct cu_data *cu = (struct cu_data *) cl->cl_private;
509 XDR *xdrs = &(cu->cu_outxdrs);
511 xdrs->x_op = XDR_FREE;
512 return (*xdr_res) (xdrs, res_ptr);
521 clntudp_control (CLIENT *cl, int request, char *info)
523 struct cu_data *cu = (struct cu_data *) cl->cl_private;
528 cu->cu_closeit = TRUE;
530 case CLSET_FD_NCLOSE:
531 cu->cu_closeit = FALSE;
534 cu->cu_total = *(struct timeval *) info;
537 *(struct timeval *) info = cu->cu_total;
539 case CLSET_RETRY_TIMEOUT:
540 cu->cu_wait = *(struct timeval *) info;
542 case CLGET_RETRY_TIMEOUT:
543 *(struct timeval *) info = cu->cu_wait;
545 case CLGET_SERVER_ADDR:
546 *(struct sockaddr_in *) info = cu->cu_raddr;
549 *(int *)info = cu->cu_sock;
553 * use the knowledge that xid is the
554 * first element in the call structure *.
555 * This will get the xid of the PREVIOUS call
557 *(u_long *)info = ntohl(*(u_long *)cu->cu_outbuf);
560 /* This will set the xid of the NEXT call */
561 *(u_long *)cu->cu_outbuf = htonl(*(u_long *)info - 1);
562 /* decrement by 1 as clntudp_call() increments once */
565 * This RELIES on the information that, in the call body,
566 * the version number field is the fifth field from the
567 * begining of the RPC header. MUST be changed if the
568 * call_struct is changed
570 *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +
571 4 * BYTES_PER_XDR_UNIT));
574 *(u_long *)(cu->cu_outbuf + 4 * BYTES_PER_XDR_UNIT)
575 = htonl(*(u_long *)info);
579 * This RELIES on the information that, in the call body,
580 * the program number field is the field from the
581 * begining of the RPC header. MUST be changed if the
582 * call_struct is changed
584 *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +
585 3 * BYTES_PER_XDR_UNIT));
588 *(u_long *)(cu->cu_outbuf + 3 * BYTES_PER_XDR_UNIT)
589 = htonl(*(u_long *)info);
591 /* The following are only possible with TI-RPC */
594 case CLSET_PUSH_TIMOD:
595 case CLSET_POP_TIMOD:
603 clntudp_destroy (CLIENT *cl)
605 struct cu_data *cu = (struct cu_data *) cl->cl_private;
609 (void) __close (cu->cu_sock);
611 XDR_DESTROY (&(cu->cu_outxdrs));
612 mem_free ((caddr_t) cu, (sizeof (*cu) + cu->cu_sendsz + cu->cu_recvsz));
613 mem_free ((caddr_t) cl, sizeof (CLIENT));