Subversion Repositories or1k

/* @(#)clnt_udp.c       2.2 88/08/01 4.0 RPCSRC */

/*

 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for

 * unrestricted use provided that this legend is included on all tape

 * media and as a part of the software program in whole or part.  Users

 * may copy or modify Sun RPC without charge, but are not authorized

 * to license or distribute it to anyone else except as part of a product or

 * program developed by the user.

 *

 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE

 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR

 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.

 *

 * Sun RPC is provided with no support and without any obligation on the

 * part of Sun Microsystems, Inc. to assist in its use, correction,

 * modification or enhancement.

 *

 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE

 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC

 * OR ANY PART THEREOF.

 *

 * In no event will Sun Microsystems, Inc. be liable for any lost revenue

 * or profits or other special, indirect and consequential damages, even if

 * Sun has been advised of the possibility of such damages.

 *

 * Sun Microsystems, Inc.

 * 2550 Garcia Avenue

 * Mountain View, California  94043

 */

#if 0

static char sccsid[] = "@(#)clnt_udp.c 1.39 87/08/11 Copyr 1984 Sun Micro";

#endif

/*

 * clnt_udp.c, Implements a UDP/IP based, client side RPC.

 *

 * Copyright (C) 1984, Sun Microsystems, Inc.

 */

#define __FORCE_GLIBC

#include <features.h>

#include <stdio.h>

#include <unistd.h>

#include <rpc/rpc.h>

#include <rpc/xdr.h>

#include <rpc/clnt.h>

#include <sys/poll.h>

#include <sys/socket.h>

#include <sys/ioctl.h>

#include <netdb.h>

#include <errno.h>

#include <rpc/pmap_clnt.h>

#include <net/if.h>

#ifdef USE_IN_LIBIO

# include <wchar.h>

#endif

#ifdef IP_RECVERR

#include "errqueue.h"

#include <sys/uio.h>

#endif

extern bool_t xdr_opaque_auth (XDR *, struct opaque_auth *);

extern u_long _create_xid (void);

/*

 * UDP bases client side rpc operations

 */

static enum clnt_stat clntudp_call (CLIENT *, u_long, xdrproc_t, caddr_t,

                                    xdrproc_t, caddr_t, struct timeval);

static void clntudp_abort (void);

static void clntudp_geterr (CLIENT *, struct rpc_err *);

static bool_t clntudp_freeres (CLIENT *, xdrproc_t, caddr_t);

static bool_t clntudp_control (CLIENT *, int, char *);

static void clntudp_destroy (CLIENT *);

static struct clnt_ops udp_ops =

{

  clntudp_call,

  clntudp_abort,

  clntudp_geterr,

  clntudp_freeres,

  clntudp_destroy,

  clntudp_control

};

/*

 * Private data kept per client handle

 */

struct cu_data

  {

    int cu_sock;

    bool_t cu_closeit;

    struct sockaddr_in cu_raddr;

    int cu_rlen;

    struct timeval cu_wait;

    struct timeval cu_total;

    struct rpc_err cu_error;

    XDR cu_outxdrs;

    u_int cu_xdrpos;

    u_int cu_sendsz;

    char *cu_outbuf;

    u_int cu_recvsz;

    char cu_inbuf[1];

  };

/*

 * Create a UDP based client handle.

 * If *sockp<0, *sockp is set to a newly created UPD socket.

 * If raddr->sin_port is 0 a binder on the remote machine

 * is consulted for the correct port number.

 * NB: It is the clients responsibility to close *sockp.

 * NB: The rpch->cl_auth is initialized to null authentication.

 *     Caller may wish to set this something more useful.

 *

 * wait is the amount of time used between retransmitting a call if

 * no response has been heard; retransmission occurs until the actual

 * rpc call times out.

 *

 * sendsz and recvsz are the maximum allowable packet sizes that can be

 * sent and received.

 */

CLIENT *

clntudp_bufcreate (struct sockaddr_in *raddr, u_long program, u_long version,

                   struct timeval wait, int *sockp, u_int sendsz,

                   u_int recvsz)

{

  CLIENT *cl;

  struct cu_data *cu = NULL;

  struct rpc_msg call_msg;

  cl = (CLIENT *) mem_alloc (sizeof (CLIENT));

  sendsz = ((sendsz + 3) / 4) * 4;

  recvsz = ((recvsz + 3) / 4) * 4;

  cu = (struct cu_data *) mem_alloc (sizeof (*cu) + sendsz + recvsz);

  if (cl == NULL || cu == NULL)

    {

      struct rpc_createerr *ce = &get_rpc_createerr ();

#ifdef USE_IN_LIBIO

      if (_IO_fwide (stderr, 0) > 0)

        (void) __fwprintf (stderr, L"%s",

                           _("clntudp_create: out of memory\n"));

      else

#endif

        (void) fputs (_("clntudp_create: out of memory\n"), stderr);

      ce->cf_stat = RPC_SYSTEMERROR;

      ce->cf_error.re_errno = ENOMEM;

      goto fooy;

    }

  cu->cu_outbuf = &cu->cu_inbuf[recvsz];

  if (raddr->sin_port == 0)

    {

      u_short port;

      if ((port =

           pmap_getport (raddr, program, version, IPPROTO_UDP)) == 0)

        {

          goto fooy;

        }

      raddr->sin_port = htons (port);

    }

  cl->cl_ops = &udp_ops;

  cl->cl_private = (caddr_t) cu;

  cu->cu_raddr = *raddr;

  cu->cu_rlen = sizeof (cu->cu_raddr);

  cu->cu_wait = wait;

  cu->cu_total.tv_sec = -1;

  cu->cu_total.tv_usec = -1;

  cu->cu_sendsz = sendsz;

  cu->cu_recvsz = recvsz;

  call_msg.rm_xid = _create_xid ();

  call_msg.rm_direction = CALL;

  call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;

  call_msg.rm_call.cb_prog = program;

  call_msg.rm_call.cb_vers = version;

  xdrmem_create (&(cu->cu_outxdrs), cu->cu_outbuf,

                 sendsz, XDR_ENCODE);

  if (!xdr_callhdr (&(cu->cu_outxdrs), &call_msg))

    {

      goto fooy;

    }

  cu->cu_xdrpos = XDR_GETPOS (&(cu->cu_outxdrs));

  if (*sockp < 0)

    {

      int dontblock = 1;

      *sockp = socket (AF_INET, SOCK_DGRAM, IPPROTO_UDP);

      if (*sockp < 0)

        {

          struct rpc_createerr *ce = &get_rpc_createerr ();

          ce->cf_stat = RPC_SYSTEMERROR;

          ce->cf_error.re_errno = errno;

          goto fooy;

        }

      /* attempt to bind to prov port */

      (void) bindresvport (*sockp, (struct sockaddr_in *) 0);

      /* the sockets rpc controls are non-blocking */

      (void) ioctl (*sockp, FIONBIO, (char *) &dontblock);

#ifdef IP_RECVERR

      {

        int on = 1;

        setsockopt(*sockp, SOL_IP, IP_RECVERR, &on, sizeof(on));

      }

#endif

      cu->cu_closeit = TRUE;

    }

  else

    {

      cu->cu_closeit = FALSE;

    }

  cu->cu_sock = *sockp;

  cl->cl_auth = authnone_create ();

  return cl;

fooy:

  if (cu)

    mem_free ((caddr_t) cu, sizeof (*cu) + sendsz + recvsz);

  if (cl)

    mem_free ((caddr_t) cl, sizeof (CLIENT));

  return (CLIENT *) NULL;

}

CLIENT *

clntudp_create (raddr, program, version, wait, sockp)

     struct sockaddr_in *raddr;

     u_long program;

     u_long version;

     struct timeval wait;

     int *sockp;

{

  return clntudp_bufcreate (raddr, program, version, wait, sockp,

                            UDPMSGSIZE, UDPMSGSIZE);

}

static int

is_network_up (int sock)

{

  struct ifconf ifc;

  char buf[UDPMSGSIZE];

  struct ifreq ifreq, *ifr;

  int n;

  ifc.ifc_len = sizeof (buf);

  ifc.ifc_buf = buf;

  if (ioctl(sock, SIOCGIFCONF, (char *) &ifc) == 0)

    {

      ifr = ifc.ifc_req;

      for (n = ifc.ifc_len / sizeof (struct ifreq); n > 0; n--, ifr++)

        {

          ifreq = *ifr;

          if (ioctl (sock, SIOCGIFFLAGS, (char *) &ifreq) < 0)

            break;

          if ((ifreq.ifr_flags & IFF_UP)

              && ifr->ifr_addr.sa_family == AF_INET)

            return 1;

        }

    }

  return 0;

}

static enum clnt_stat

clntudp_call (cl, proc, xargs, argsp, xresults, resultsp, utimeout)

     CLIENT *cl;        /* client handle */

     u_long proc;               /* procedure number */

     xdrproc_t xargs;           /* xdr routine for args */

     caddr_t argsp;             /* pointer to args */

     xdrproc_t xresults;        /* xdr routine for results */

     caddr_t resultsp;          /* pointer to results */

     struct timeval utimeout;   /* seconds to wait before giving up */

{

  struct cu_data *cu = (struct cu_data *) cl->cl_private;

  XDR *xdrs;

  int outlen = 0;

  int inlen;

  socklen_t fromlen;

  struct pollfd fd;

  int milliseconds = (cu->cu_wait.tv_sec * 1000) +

    (cu->cu_wait.tv_usec / 1000);

  struct sockaddr_in from;

  struct rpc_msg reply_msg;

  XDR reply_xdrs;

  struct timeval time_waited;

  bool_t ok;

  int nrefreshes = 2;           /* number of times to refresh cred */

  struct timeval timeout;

  int anyup;                    /* any network interface up */

  if (cu->cu_total.tv_usec == -1)

    {

      timeout = utimeout;       /* use supplied timeout */

    }

  else

    {

      timeout = cu->cu_total;   /* use default timeout */

    }

  time_waited.tv_sec = 0;

  time_waited.tv_usec = 0;

call_again:

  xdrs = &(cu->cu_outxdrs);

  if (xargs == NULL)

    goto get_reply;

  xdrs->x_op = XDR_ENCODE;

  XDR_SETPOS (xdrs, cu->cu_xdrpos);

  /*

   * the transaction is the first thing in the out buffer

   */

  (*(uint32_t *) (cu->cu_outbuf))++;

  if ((!XDR_PUTLONG (xdrs, (long *) &proc)) ||

      (!AUTH_MARSHALL (cl->cl_auth, xdrs)) ||

      (!(*xargs) (xdrs, argsp)))

    return (cu->cu_error.re_status = RPC_CANTENCODEARGS);

  outlen = (int) XDR_GETPOS (xdrs);

send_again:

  if (sendto (cu->cu_sock, cu->cu_outbuf, outlen, 0,

              (struct sockaddr *) &(cu->cu_raddr), cu->cu_rlen)

      != outlen)

    {

      cu->cu_error.re_errno = errno;

      return (cu->cu_error.re_status = RPC_CANTSEND);

    }

  /*

   * Hack to provide rpc-based message passing

   */

  if (timeout.tv_sec == 0 && timeout.tv_usec == 0)

    {

      return (cu->cu_error.re_status = RPC_TIMEDOUT);

    }

 get_reply:

  /*

   * sub-optimal code appears here because we have

   * some clock time to spare while the packets are in flight.

   * (We assume that this is actually only executed once.)

   */

  reply_msg.acpted_rply.ar_verf = _null_auth;

  reply_msg.acpted_rply.ar_results.where = resultsp;

  reply_msg.acpted_rply.ar_results.proc = xresults;

  fd.fd = cu->cu_sock;

  fd.events = POLLIN;

  anyup = 0;

  for (;;)

    {

      switch (poll (&fd, 1, milliseconds))

        {

        case 0:

          if (anyup == 0)

            {

              anyup = is_network_up (cu->cu_sock);

              if (!anyup)

                return (cu->cu_error.re_status = RPC_CANTRECV);

            }

          time_waited.tv_sec += cu->cu_wait.tv_sec;

          time_waited.tv_usec += cu->cu_wait.tv_usec;

          while (time_waited.tv_usec >= 1000000)

            {

              time_waited.tv_sec++;

              time_waited.tv_usec -= 1000000;

            }

          if ((time_waited.tv_sec < timeout.tv_sec) ||

              ((time_waited.tv_sec == timeout.tv_sec) &&

               (time_waited.tv_usec < timeout.tv_usec)))

            goto send_again;

          return (cu->cu_error.re_status = RPC_TIMEDOUT);

          /*

           * buggy in other cases because time_waited is not being

           * updated.

           */

        case -1:

          if (errno == EINTR)

            continue;

          cu->cu_error.re_errno = errno;

          return (cu->cu_error.re_status = RPC_CANTRECV);

        }

#ifdef IP_RECVERR

      if (fd.revents & POLLERR)

        {

          struct msghdr msg;

          struct cmsghdr *cmsg;

          struct sock_extended_err *e;

          struct sockaddr_in err_addr;

          struct iovec iov;

          char *cbuf = (char *) alloca (outlen + 256);

          int ret;

          iov.iov_base = cbuf + 256;

          iov.iov_len = outlen;

          msg.msg_name = (void *) &err_addr;

          msg.msg_namelen = sizeof (err_addr);

          msg.msg_iov = &iov;

          msg.msg_iovlen = 1;

          msg.msg_flags = 0;

          msg.msg_control = cbuf;

          msg.msg_controllen = 256;

          ret = recvmsg (cu->cu_sock, &msg, MSG_ERRQUEUE);

          if (ret >= 0

              && memcmp (cbuf + 256, cu->cu_outbuf, ret) == 0

              && (msg.msg_flags & MSG_ERRQUEUE)

              && ((msg.msg_namelen == 0

                   && ret >= 12)

                  || (msg.msg_namelen == sizeof (err_addr)

                      && err_addr.sin_family == AF_INET

                      && memcmp (&err_addr.sin_addr, &cu->cu_raddr.sin_addr,

                                 sizeof (err_addr.sin_addr)) == 0

                      && err_addr.sin_port == cu->cu_raddr.sin_port)))

            for (cmsg = CMSG_FIRSTHDR (&msg); cmsg;

                 cmsg = CMSG_NXTHDR (&msg, cmsg))

              if (cmsg->cmsg_level == SOL_IP && cmsg->cmsg_type == IP_RECVERR)

                {

                  e = (struct sock_extended_err *) CMSG_DATA(cmsg);

                  cu->cu_error.re_errno = e->ee_errno;

                  return (cu->cu_error.re_status = RPC_CANTRECV);

                }

        }

#endif

      do

        {

          fromlen = sizeof (struct sockaddr);

          inlen = recvfrom (cu->cu_sock, cu->cu_inbuf,

                            (int) cu->cu_recvsz, 0,

                            (struct sockaddr *) &from, &fromlen);

        }

      while (inlen < 0 && errno == EINTR);

      if (inlen < 0)

        {

          if (errno == EWOULDBLOCK)

            continue;

          cu->cu_error.re_errno = errno;

          return (cu->cu_error.re_status = RPC_CANTRECV);

        }

      if (inlen < 4)

        continue;

      /* see if reply transaction id matches sent id.

        Don't do this if we only wait for a replay */

      if (xargs != NULL

          && (*((u_int32_t *) (cu->cu_inbuf))

              != *((u_int32_t *) (cu->cu_outbuf))))

        continue;

      /* we now assume we have the proper reply */

      break;

    }

  /*

   * now decode and validate the response

   */

  xdrmem_create (&reply_xdrs, cu->cu_inbuf, (u_int) inlen, XDR_DECODE);

  ok = xdr_replymsg (&reply_xdrs, &reply_msg);

  /* XDR_DESTROY(&reply_xdrs);  save a few cycles on noop destroy */

  if (ok)

    {

      _seterr_reply (&reply_msg, &(cu->cu_error));

      if (cu->cu_error.re_status == RPC_SUCCESS)

        {

          if (!AUTH_VALIDATE (cl->cl_auth,

                              &reply_msg.acpted_rply.ar_verf))

            {

              cu->cu_error.re_status = RPC_AUTHERROR;

              cu->cu_error.re_why = AUTH_INVALIDRESP;

            }

          if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)

            {

              xdrs->x_op = XDR_FREE;

              (void) xdr_opaque_auth (xdrs,

                                      &(reply_msg.acpted_rply.ar_verf));

            }

        }                       /* end successful completion */

      else

        {

          /* maybe our credentials need to be refreshed ... */

          if (nrefreshes > 0 && AUTH_REFRESH (cl->cl_auth))

            {

              nrefreshes--;

              goto call_again;

            }

        }                       /* end of unsuccessful completion */

    }                           /* end of valid reply message */

  else

    {

      cu->cu_error.re_status = RPC_CANTDECODERES;

    }

  return cu->cu_error.re_status;

}

static void

clntudp_geterr (CLIENT *cl, struct rpc_err *errp)

{

  struct cu_data *cu = (struct cu_data *) cl->cl_private;

  *errp = cu->cu_error;

}

static bool_t

clntudp_freeres (CLIENT *cl, xdrproc_t xdr_res, caddr_t res_ptr)

{

  struct cu_data *cu = (struct cu_data *) cl->cl_private;

  XDR *xdrs = &(cu->cu_outxdrs);

  xdrs->x_op = XDR_FREE;

  return (*xdr_res) (xdrs, res_ptr);

}

static void

clntudp_abort (void)

{

}

static bool_t

clntudp_control (CLIENT *cl, int request, char *info)

{

  struct cu_data *cu = (struct cu_data *) cl->cl_private;

  switch (request)

    {

    case CLSET_FD_CLOSE:

      cu->cu_closeit = TRUE;

      break;

    case CLSET_FD_NCLOSE:

      cu->cu_closeit = FALSE;

      break;

    case CLSET_TIMEOUT:

      cu->cu_total = *(struct timeval *) info;

      break;

    case CLGET_TIMEOUT:

      *(struct timeval *) info = cu->cu_total;

      break;

    case CLSET_RETRY_TIMEOUT:

      cu->cu_wait = *(struct timeval *) info;

      break;

    case CLGET_RETRY_TIMEOUT:

      *(struct timeval *) info = cu->cu_wait;

      break;

    case CLGET_SERVER_ADDR:

      *(struct sockaddr_in *) info = cu->cu_raddr;

      break;

    case CLGET_FD:

      *(int *)info = cu->cu_sock;

      break;

    case CLGET_XID:

      /*

       * use the knowledge that xid is the

       * first element in the call structure *.

       * This will get the xid of the PREVIOUS call

       */

      *(u_long *)info = ntohl(*(u_long *)cu->cu_outbuf);

      break;

    case CLSET_XID:

      /* This will set the xid of the NEXT call */

      *(u_long *)cu->cu_outbuf =  htonl(*(u_long *)info - 1);

      /* decrement by 1 as clntudp_call() increments once */

    case CLGET_VERS:

      /*

       * This RELIES on the information that, in the call body,

       * the version number field is the fifth field from the

       * begining of the RPC header. MUST be changed if the

       * call_struct is changed

       */

      *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +

                                          4 * BYTES_PER_XDR_UNIT));

      break;

    case CLSET_VERS:

      *(u_long *)(cu->cu_outbuf + 4 * BYTES_PER_XDR_UNIT)

        = htonl(*(u_long *)info);

      break;

    case CLGET_PROG:

      /*

       * This RELIES on the information that, in the call body,

       * the program number field is the  field from the

       * begining of the RPC header. MUST be changed if the

       * call_struct is changed

       */

      *(u_long *)info = ntohl(*(u_long *)(cu->cu_outbuf +

                                          3 * BYTES_PER_XDR_UNIT));

      break;

    case CLSET_PROG:

      *(u_long *)(cu->cu_outbuf + 3 * BYTES_PER_XDR_UNIT)

        = htonl(*(u_long *)info);

      break;

    /* The following are only possible with TI-RPC */

    case CLGET_SVC_ADDR:

    case CLSET_SVC_ADDR:

    case CLSET_PUSH_TIMOD:

    case CLSET_POP_TIMOD:

    default:

      return FALSE;

    }

  return TRUE;

}

static void

clntudp_destroy (CLIENT *cl)

{

  struct cu_data *cu = (struct cu_data *) cl->cl_private;

  if (cu->cu_closeit)

    {

      (void) close (cu->cu_sock);

    }

  XDR_DESTROY (&(cu->cu_outxdrs));

  mem_free ((caddr_t) cu, (sizeof (*cu) + cu->cu_sendsz + cu->cu_recvsz));

  mem_free ((caddr_t) cl, sizeof (CLIENT));

}