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
45 #define xdr_callhdr __xdr_callhdr
46 #define xdr_replymsg __xdr_replymsg
47 #define xdr_opaque_auth __xdr_opaque_auth
48 #define pmap_getport __pmap_getport
49 #define _seterr_reply __seterr_reply
50 #define setsockopt __setsockopt
51 #define bindresvport __bindresvport
62 #include <sys/socket.h>
63 #include <sys/ioctl.h>
66 #include <rpc/pmap_clnt.h>
77 extern u_long _create_xid (void) attribute_hidden;
80 * UDP bases client side rpc operations
82 static enum clnt_stat clntudp_call (CLIENT *, u_long, xdrproc_t, caddr_t,
83 xdrproc_t, caddr_t, struct timeval);
84 static void clntudp_abort (void);
85 static void clntudp_geterr (CLIENT *, struct rpc_err *);
86 static bool_t clntudp_freeres (CLIENT *, xdrproc_t, caddr_t);
87 static bool_t clntudp_control (CLIENT *, int, char *);
88 static void clntudp_destroy (CLIENT *);
90 static struct clnt_ops udp_ops =
101 * Private data kept per client handle
107 struct sockaddr_in cu_raddr;
109 struct timeval cu_wait;
110 struct timeval cu_total;
111 struct rpc_err cu_error;
121 * Create a UDP based client handle.
122 * If *sockp<0, *sockp is set to a newly created UPD socket.
123 * If raddr->sin_port is 0 a binder on the remote machine
124 * is consulted for the correct port number.
125 * NB: It is the clients responsibility to close *sockp.
126 * NB: The rpch->cl_auth is initialized to null authentication.
127 * Caller may wish to set this something more useful.
129 * wait is the amount of time used between retransmitting a call if
130 * no response has been heard; retransmission occurs until the actual
131 * rpc call times out.
133 * sendsz and recvsz are the maximum allowable packet sizes that can be
136 CLIENT attribute_hidden *
137 __clntudp_bufcreate (struct sockaddr_in *raddr, u_long program, u_long version,
138 struct timeval wait, int *sockp, u_int sendsz,
142 struct cu_data *cu = NULL;
143 struct rpc_msg call_msg;
145 cl = (CLIENT *) mem_alloc (sizeof (CLIENT));
146 sendsz = ((sendsz + 3) / 4) * 4;
147 recvsz = ((recvsz + 3) / 4) * 4;
148 cu = (struct cu_data *) mem_alloc (sizeof (*cu) + sendsz + recvsz);
149 if (cl == NULL || cu == NULL)
151 struct rpc_createerr *ce = &get_rpc_createerr ();
153 if (_IO_fwide (stderr, 0) > 0)
154 (void) __fwprintf (stderr, L"%s",
155 _("clntudp_create: out of memory\n"));
158 (void) fputs (_("clntudp_create: out of memory\n"), stderr);
159 ce->cf_stat = RPC_SYSTEMERROR;
160 ce->cf_error.re_errno = ENOMEM;
163 cu->cu_outbuf = &cu->cu_inbuf[recvsz];
165 if (raddr->sin_port == 0)
169 pmap_getport (raddr, program, version, IPPROTO_UDP)) == 0)
173 raddr->sin_port = htons (port);
175 cl->cl_ops = &udp_ops;
176 cl->cl_private = (caddr_t) cu;
177 cu->cu_raddr = *raddr;
178 cu->cu_rlen = sizeof (cu->cu_raddr);
180 cu->cu_total.tv_sec = -1;
181 cu->cu_total.tv_usec = -1;
182 cu->cu_sendsz = sendsz;
183 cu->cu_recvsz = recvsz;
184 call_msg.rm_xid = _create_xid ();
185 call_msg.rm_direction = CALL;
186 call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
187 call_msg.rm_call.cb_prog = program;
188 call_msg.rm_call.cb_vers = version;
189 xdrmem_create (&(cu->cu_outxdrs), cu->cu_outbuf,
191 if (!xdr_callhdr (&(cu->cu_outxdrs), &call_msg))
195 cu->cu_xdrpos = XDR_GETPOS (&(cu->cu_outxdrs));
200 *sockp = socket (AF_INET, SOCK_DGRAM, IPPROTO_UDP);
203 struct rpc_createerr *ce = &get_rpc_createerr ();
204 ce->cf_stat = RPC_SYSTEMERROR;
205 ce->cf_error.re_errno = errno;
208 /* attempt to bind to prov port */
209 (void) bindresvport (*sockp, (struct sockaddr_in *) 0);
210 /* the sockets rpc controls are non-blocking */
211 (void) __ioctl (*sockp, FIONBIO, (char *) &dontblock);
215 setsockopt(*sockp, SOL_IP, IP_RECVERR, &on, sizeof(on));
218 cu->cu_closeit = TRUE;
222 cu->cu_closeit = FALSE;
224 cu->cu_sock = *sockp;
225 cl->cl_auth = authnone_create ();
229 mem_free ((caddr_t) cu, sizeof (*cu) + sendsz + recvsz);
231 mem_free ((caddr_t) cl, sizeof (CLIENT));
232 return (CLIENT *) NULL;
234 strong_alias(__clntudp_bufcreate,clntudp_bufcreate)
236 CLIENT attribute_hidden *
237 __clntudp_create (struct sockaddr_in *raddr, u_long program, u_long version, struct timeval wait, int *sockp)
240 return __clntudp_bufcreate (raddr, program, version, wait, sockp,
241 UDPMSGSIZE, UDPMSGSIZE);
243 strong_alias(__clntudp_create,clntudp_create)
246 is_network_up (int sock)
249 char buf[UDPMSGSIZE];
250 struct ifreq ifreq, *ifr;
253 ifc.ifc_len = sizeof (buf);
255 if (__ioctl(sock, SIOCGIFCONF, (char *) &ifc) == 0)
258 for (n = ifc.ifc_len / sizeof (struct ifreq); n > 0; n--, ifr++)
261 if (__ioctl (sock, SIOCGIFFLAGS, (char *) &ifreq) < 0)
264 if ((ifreq.ifr_flags & IFF_UP)
265 && ifr->ifr_addr.sa_family == AF_INET)
272 static enum clnt_stat
273 clntudp_call (cl, proc, xargs, argsp, xresults, resultsp, utimeout)
274 CLIENT *cl; /* client handle */
275 u_long proc; /* procedure number */
276 xdrproc_t xargs; /* xdr routine for args */
277 caddr_t argsp; /* pointer to args */
278 xdrproc_t xresults; /* xdr routine for results */
279 caddr_t resultsp; /* pointer to results */
280 struct timeval utimeout; /* seconds to wait before giving up */
282 struct cu_data *cu = (struct cu_data *) cl->cl_private;
288 int milliseconds = (cu->cu_wait.tv_sec * 1000) +
289 (cu->cu_wait.tv_usec / 1000);
290 struct sockaddr_in from;
291 struct rpc_msg reply_msg;
293 struct timeval time_waited;
295 int nrefreshes = 2; /* number of times to refresh cred */
296 struct timeval timeout;
297 int anyup; /* any network interface up */
299 if (cu->cu_total.tv_usec == -1)
301 timeout = utimeout; /* use supplied timeout */
305 timeout = cu->cu_total; /* use default timeout */
308 time_waited.tv_sec = 0;
309 time_waited.tv_usec = 0;
311 xdrs = &(cu->cu_outxdrs);
314 xdrs->x_op = XDR_ENCODE;
315 XDR_SETPOS (xdrs, cu->cu_xdrpos);
317 * the transaction is the first thing in the out buffer
319 (*(uint32_t *) (cu->cu_outbuf))++;
320 if ((!XDR_PUTLONG (xdrs, (long *) &proc)) ||
321 (!AUTH_MARSHALL (cl->cl_auth, xdrs)) ||
322 (!(*xargs) (xdrs, argsp)))
323 return (cu->cu_error.re_status = RPC_CANTENCODEARGS);
324 outlen = (int) XDR_GETPOS (xdrs);
327 if (sendto (cu->cu_sock, cu->cu_outbuf, outlen, 0,
328 (struct sockaddr *) &(cu->cu_raddr), cu->cu_rlen)
331 cu->cu_error.re_errno = errno;
332 return (cu->cu_error.re_status = RPC_CANTSEND);
336 * Hack to provide rpc-based message passing
338 if (timeout.tv_sec == 0 && timeout.tv_usec == 0)
340 return (cu->cu_error.re_status = RPC_TIMEDOUT);
344 * sub-optimal code appears here because we have
345 * some clock time to spare while the packets are in flight.
346 * (We assume that this is actually only executed once.)
348 reply_msg.acpted_rply.ar_verf = _null_auth;
349 reply_msg.acpted_rply.ar_results.where = resultsp;
350 reply_msg.acpted_rply.ar_results.proc = xresults;
356 switch (poll (&fd, 1, milliseconds))
362 anyup = is_network_up (cu->cu_sock);
364 return (cu->cu_error.re_status = RPC_CANTRECV);
367 time_waited.tv_sec += cu->cu_wait.tv_sec;
368 time_waited.tv_usec += cu->cu_wait.tv_usec;
369 while (time_waited.tv_usec >= 1000000)
371 time_waited.tv_sec++;
372 time_waited.tv_usec -= 1000000;
374 if ((time_waited.tv_sec < timeout.tv_sec) ||
375 ((time_waited.tv_sec == timeout.tv_sec) &&
376 (time_waited.tv_usec < timeout.tv_usec)))
378 return (cu->cu_error.re_status = RPC_TIMEDOUT);
381 * buggy in other cases because time_waited is not being
387 cu->cu_error.re_errno = errno;
388 return (cu->cu_error.re_status = RPC_CANTRECV);
391 if (fd.revents & POLLERR)
394 struct cmsghdr *cmsg;
395 struct sock_extended_err *e;
396 struct sockaddr_in err_addr;
398 char *cbuf = (char *) alloca (outlen + 256);
401 iov.iov_base = cbuf + 256;
402 iov.iov_len = outlen;
403 msg.msg_name = (void *) &err_addr;
404 msg.msg_namelen = sizeof (err_addr);
408 msg.msg_control = cbuf;
409 msg.msg_controllen = 256;
410 ret = recvmsg (cu->cu_sock, &msg, MSG_ERRQUEUE);
412 && __memcmp (cbuf + 256, cu->cu_outbuf, ret) == 0
413 && (msg.msg_flags & MSG_ERRQUEUE)
414 && ((msg.msg_namelen == 0
416 || (msg.msg_namelen == sizeof (err_addr)
417 && err_addr.sin_family == AF_INET
418 && __memcmp (&err_addr.sin_addr, &cu->cu_raddr.sin_addr,
419 sizeof (err_addr.sin_addr)) == 0
420 && err_addr.sin_port == cu->cu_raddr.sin_port)))
421 for (cmsg = CMSG_FIRSTHDR (&msg); cmsg;
422 cmsg = CMSG_NXTHDR (&msg, cmsg))
423 if (cmsg->cmsg_level == SOL_IP && cmsg->cmsg_type == IP_RECVERR)
425 e = (struct sock_extended_err *) CMSG_DATA(cmsg);
426 cu->cu_error.re_errno = e->ee_errno;
427 return (cu->cu_error.re_status = RPC_CANTRECV);
433 fromlen = sizeof (struct sockaddr);
434 inlen = recvfrom (cu->cu_sock, cu->cu_inbuf,
435 (int) cu->cu_recvsz, 0,
436 (struct sockaddr *) &from, &fromlen);
438 while (inlen < 0 && errno == EINTR);
441 if (errno == EWOULDBLOCK)
443 cu->cu_error.re_errno = errno;
444 return (cu->cu_error.re_status = RPC_CANTRECV);
449 /* see if reply transaction id matches sent id.
450 Don't do this if we only wait for a replay */
452 && (*((u_int32_t *) (cu->cu_inbuf))
453 != *((u_int32_t *) (cu->cu_outbuf))))
455 /* we now assume we have the proper reply */
460 * now decode and validate the response
462 xdrmem_create (&reply_xdrs, cu->cu_inbuf, (u_int) inlen, XDR_DECODE);
463 ok = xdr_replymsg (&reply_xdrs, &reply_msg);
464 /* XDR_DESTROY(&reply_xdrs); save a few cycles on noop destroy */
467 _seterr_reply (&reply_msg, &(cu->cu_error));
468 if (cu->cu_error.re_status == RPC_SUCCESS)
470 if (!AUTH_VALIDATE (cl->cl_auth,
471 &reply_msg.acpted_rply.ar_verf))
473 cu->cu_error.re_status = RPC_AUTHERROR;
474 cu->cu_error.re_why = AUTH_INVALIDRESP;
476 if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)
478 xdrs->x_op = XDR_FREE;
479 (void) xdr_opaque_auth (xdrs,
480 &(reply_msg.acpted_rply.ar_verf));
482 } /* end successful completion */
485 /* maybe our credentials need to be refreshed ... */
486 if (nrefreshes > 0 && AUTH_REFRESH (cl->cl_auth))
491 } /* end of unsuccessful completion */
492 } /* end of valid reply message */
495 cu->cu_error.re_status = RPC_CANTDECODERES;
497 return cu->cu_error.re_status;
501 clntudp_geterr (CLIENT *cl, struct rpc_err *errp)
503 struct cu_data *cu = (struct cu_data *) cl->cl_private;
505 *errp = cu->cu_error;
510 clntudp_freeres (CLIENT *cl, xdrproc_t xdr_res, caddr_t res_ptr)
512 struct cu_data *cu = (struct cu_data *) cl->cl_private;
513 XDR *xdrs = &(cu->cu_outxdrs);
515 xdrs->x_op = XDR_FREE;
516 return (*xdr_res) (xdrs, res_ptr);
525 clntudp_control (CLIENT *cl, int request, char *info)
527 struct cu_data *cu = (struct cu_data *) cl->cl_private;
532 cu->cu_closeit = TRUE;
534 case CLSET_FD_NCLOSE:
535 cu->cu_closeit = FALSE;
538 cu->cu_total = *(struct timeval *) info;
541 *(struct timeval *) info = cu->cu_total;
543 case CLSET_RETRY_TIMEOUT:
544 cu->cu_wait = *(struct timeval *) info;
546 case CLGET_RETRY_TIMEOUT:
547 *(struct timeval *) info = cu->cu_wait;
549 case CLGET_SERVER_ADDR:
550 *(struct sockaddr_in *) info = cu->cu_raddr;
553 *(int *)info = cu->cu_sock;
557 * use the knowledge that xid is the
558 * first element in the call structure *.
559 * This will get the xid of the PREVIOUS call
561 *(u_long *)info = ntohl(*(u_long *)cu->cu_outbuf);
564 /* This will set the xid of the NEXT call */
565 *(u_long *)cu->cu_outbuf = htonl(*(u_long *)info - 1);
566 /* decrement by 1 as clntudp_call() increments once */
569 * This RELIES on the information that, in the call body,
570 * the version number field is the fifth field from the
571 * begining of the RPC header. MUST be changed if the
572 * call_struct is changed
574 *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +
575 4 * BYTES_PER_XDR_UNIT));
578 *(u_long *)(cu->cu_outbuf + 4 * BYTES_PER_XDR_UNIT)
579 = htonl(*(u_long *)info);
583 * This RELIES on the information that, in the call body,
584 * the program number field is the field from the
585 * begining of the RPC header. MUST be changed if the
586 * call_struct is changed
588 *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +
589 3 * BYTES_PER_XDR_UNIT));
592 *(u_long *)(cu->cu_outbuf + 3 * BYTES_PER_XDR_UNIT)
593 = htonl(*(u_long *)info);
595 /* The following are only possible with TI-RPC */
598 case CLSET_PUSH_TIMOD:
599 case CLSET_POP_TIMOD:
607 clntudp_destroy (CLIENT *cl)
609 struct cu_data *cu = (struct cu_data *) cl->cl_private;
613 (void) __close (cu->cu_sock);
615 XDR_DESTROY (&(cu->cu_outxdrs));
616 mem_free ((caddr_t) cu, (sizeof (*cu) + cu->cu_sendsz + cu->cu_recvsz));
617 mem_free ((caddr_t) cl, sizeof (CLIENT));