libc/inet/rpc/clnt_tcp.c

   1 /* @(#)clnt_tcp.c       2.2 88/08/01 4.0 RPCSRC */
   2 /*
   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.
   9  *
  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.
  13  *
  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.
  17  *
  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.
  21  *
  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.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30 #if 0
  31 static char sccsid[] = "@(#)clnt_tcp.c 1.37 87/10/05 Copyr 1984 Sun Micro";
  32 #endif
  33
  34 /*
  35  * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
  36  *
  37  * Copyright (C) 1984, Sun Microsystems, Inc.
  38  *
  39  * TCP based RPC supports 'batched calls'.
  40  * A sequence of calls may be batched-up in a send buffer.  The rpc call
  41  * return immediately to the client even though the call was not necessarily
  42  * sent.  The batching occurs if the results' xdr routine is NULL (0) AND
  43  * the rpc timeout value is zero (see clnt.h, rpc).
  44  *
  45  * Clients should NOT casually batch calls that in fact return results; that is,
  46  * the server side should be aware that a call is batched and not produce any
  47  * return message.  Batched calls that produce many result messages can
  48  * deadlock (netlock) the client and the server....
  49  *
  50  * Now go hang yourself.
  51  */
  52
  53 #define authnone_create __authnone_create
  54 #define xdrrec_create __xdrrec_create
  55 #define xdrrec_endofrecord __xdrrec_endofrecord
  56 #define xdrrec_skiprecord __xdrrec_skiprecord
  57 #define xdr_callhdr __xdr_callhdr
  58 #define xdr_replymsg __xdr_replymsg
  59 #define xdr_opaque_auth __xdr_opaque_auth
  60 #define xdrmem_create __xdrmem_create
  61 #define pmap_getport __pmap_getport
  62 #define _seterr_reply __seterr_reply
  63 #define connect __connect
  64 #define bindresvport __bindresvport
  65 #define poll __poll
  66
  67 #define __FORCE_GLIBC
  68 #include <features.h>
  69
  70 #include <netdb.h>
  71 #include <errno.h>
  72 #include <stdio.h>
  73 #include <unistd.h>
  74 #include <rpc/rpc.h>
  75 #include <sys/poll.h>
  76 #include <sys/socket.h>
  77 #include <rpc/pmap_clnt.h>
  78 #ifdef USE_IN_LIBIO
  79 # include <wchar.h>
  80 #endif
  81
  82 extern u_long _create_xid (void) attribute_hidden;
  83
  84 #define MCALL_MSG_SIZE 24
  85
  86 struct ct_data
  87   {
  88     int ct_sock;
  89     bool_t ct_closeit;
  90     struct timeval ct_wait;
  91     bool_t ct_waitset;          /* wait set by clnt_control? */
  92     struct sockaddr_in ct_addr;
  93     struct rpc_err ct_error;
  94     char ct_mcall[MCALL_MSG_SIZE];      /* marshalled callmsg */
  95     u_int ct_mpos;              /* pos after marshal */
  96     XDR ct_xdrs;
  97   };
  98
  99 static int readtcp (char *, char *, int);
 100 static int writetcp (char *, char *, int);
 101
 102 static enum clnt_stat clnttcp_call (CLIENT *, u_long, xdrproc_t, caddr_t,
 103                                     xdrproc_t, caddr_t, struct timeval);
 104 static void clnttcp_abort (void);
 105 static void clnttcp_geterr (CLIENT *, struct rpc_err *);
 106 static bool_t clnttcp_freeres (CLIENT *, xdrproc_t, caddr_t);
 107 static bool_t clnttcp_control (CLIENT *, int, char *);
 108 static void clnttcp_destroy (CLIENT *);
 109
 110 static struct clnt_ops tcp_ops =
 111 {
 112   clnttcp_call,
 113   clnttcp_abort,
 114   clnttcp_geterr,
 115   clnttcp_freeres,
 116   clnttcp_destroy,
 117   clnttcp_control
 118 };
 119
 120 /*
 121  * Create a client handle for a tcp/ip connection.
 122  * If *sockp<0, *sockp is set to a newly created TCP socket and it is
 123  * connected to raddr.  If *sockp non-negative then
 124  * raddr is ignored.  The rpc/tcp package does buffering
 125  * similar to stdio, so the client must pick send and receive buffer sizes,];
 126  * 0 => use the default.
 127  * If raddr->sin_port is 0, then a binder on the remote machine is
 128  * consulted for the right port number.
 129  * NB: *sockp is copied into a private area.
 130  * NB: It is the clients responsibility to close *sockp.
 131  * NB: The rpch->cl_auth is set null authentication.  Caller may wish to set this
 132  * something more useful.
 133  */
 134 CLIENT attribute_hidden *
 135 __clnttcp_create (struct sockaddr_in *raddr, u_long prog, u_long vers,
 136                 int *sockp, u_int sendsz, u_int recvsz)
 137 {
 138   CLIENT *h;
 139   struct ct_data *ct;
 140   struct rpc_msg call_msg;
 141
 142   h = (CLIENT *) mem_alloc (sizeof (*h));
 143   ct = (struct ct_data *) mem_alloc (sizeof (*ct));
 144   if (h == NULL || ct == NULL)
 145     {
 146       struct rpc_createerr *ce = &get_rpc_createerr ();
 147 #ifdef USE_IN_LIBIO
 148       if (_IO_fwide (stderr, 0) > 0)
 149         (void) __fwprintf (stderr, L"%s",
 150                            _("clnttcp_create: out of memory\n"));
 151       else
 152 #endif
 153         (void) fputs (_("clnttcp_create: out of memory\n"), stderr);
 154       ce->cf_stat = RPC_SYSTEMERROR;
 155       ce->cf_error.re_errno = ENOMEM;
 156       goto fooy;
 157     }
 158
 159   /*
 160    * If no port number given ask the pmap for one
 161    */
 162   if (raddr->sin_port == 0)
 163     {
 164       u_short port;
 165       if ((port = pmap_getport (raddr, prog, vers, IPPROTO_TCP)) == 0)
 166         {
 167           mem_free ((caddr_t) ct, sizeof (struct ct_data));
 168           mem_free ((caddr_t) h, sizeof (CLIENT));
 169           return ((CLIENT *) NULL);
 170         }
 171       raddr->sin_port = htons (port);
 172     }
 173
 174   /*
 175    * If no socket given, open one
 176    */
 177   if (*sockp < 0)
 178     {
 179       *sockp = __socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
 180       (void) bindresvport (*sockp, (struct sockaddr_in *) 0);
 181       if ((*sockp < 0)
 182           || (connect (*sockp, (struct sockaddr *) raddr,
 183                          sizeof (*raddr)) < 0))
 184         {
 185           struct rpc_createerr *ce = &get_rpc_createerr ();
 186           ce->cf_stat = RPC_SYSTEMERROR;
 187           ce->cf_error.re_errno = errno;
 188           if (*sockp >= 0)
 189             (void) __close (*sockp);
 190           goto fooy;
 191         }
 192       ct->ct_closeit = TRUE;
 193     }
 194   else
 195     {
 196       ct->ct_closeit = FALSE;
 197     }
 198
 199   /*
 200    * Set up private data struct
 201    */
 202   ct->ct_sock = *sockp;
 203   ct->ct_wait.tv_usec = 0;
 204   ct->ct_waitset = FALSE;
 205   ct->ct_addr = *raddr;
 206
 207   /*
 208    * Initialize call message
 209    */
 210   call_msg.rm_xid = _create_xid ();
 211   call_msg.rm_direction = CALL;
 212   call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
 213   call_msg.rm_call.cb_prog = prog;
 214   call_msg.rm_call.cb_vers = vers;
 215
 216   /*
 217    * pre-serialize the static part of the call msg and stash it away
 218    */
 219   xdrmem_create (&(ct->ct_xdrs), ct->ct_mcall, MCALL_MSG_SIZE,
 220                  XDR_ENCODE);
 221   if (!xdr_callhdr (&(ct->ct_xdrs), &call_msg))
 222     {
 223       if (ct->ct_closeit)
 224         {
 225           (void) __close (*sockp);
 226         }
 227       goto fooy;
 228     }
 229   ct->ct_mpos = XDR_GETPOS (&(ct->ct_xdrs));
 230   XDR_DESTROY (&(ct->ct_xdrs));
 231
 232   /*
 233    * Create a client handle which uses xdrrec for serialization
 234    * and authnone for authentication.
 235    */
 236   xdrrec_create (&(ct->ct_xdrs), sendsz, recvsz,
 237                  (caddr_t) ct, readtcp, writetcp);
 238   h->cl_ops = &tcp_ops;
 239   h->cl_private = (caddr_t) ct;
 240   h->cl_auth = authnone_create ();
 241   return h;
 242
 243 fooy:
 244   /*
 245    * Something goofed, free stuff and barf
 246    */
 247   mem_free ((caddr_t) ct, sizeof (struct ct_data));
 248   mem_free ((caddr_t) h, sizeof (CLIENT));
 249   return ((CLIENT *) NULL);
 250 }
 251 strong_alias(__clnttcp_create,clnttcp_create)
 252
 253 static enum clnt_stat
 254 clnttcp_call (h, proc, xdr_args, args_ptr, xdr_results, results_ptr, timeout)
 255      CLIENT *h;
 256      u_long proc;
 257      xdrproc_t xdr_args;
 258      caddr_t args_ptr;
 259      xdrproc_t xdr_results;
 260      caddr_t results_ptr;
 261      struct timeval timeout;
 262 {
 263   struct ct_data *ct = (struct ct_data *) h->cl_private;
 264   XDR *xdrs = &(ct->ct_xdrs);
 265   struct rpc_msg reply_msg;
 266   u_long x_id;
 267   u_int32_t *msg_x_id = (u_int32_t *) (ct->ct_mcall);   /* yuk */
 268   bool_t shipnow;
 269   int refreshes = 2;
 270
 271   if (!ct->ct_waitset)
 272     {
 273       ct->ct_wait = timeout;
 274     }
 275
 276   shipnow =
 277     (xdr_results == (xdrproc_t) 0 && ct->ct_wait.tv_sec == 0
 278      && ct->ct_wait.tv_usec == 0) ? FALSE : TRUE;
 279
 280 call_again:
 281   xdrs->x_op = XDR_ENCODE;
 282   ct->ct_error.re_status = RPC_SUCCESS;
 283   x_id = ntohl (--(*msg_x_id));
 284   if ((!XDR_PUTBYTES (xdrs, ct->ct_mcall, ct->ct_mpos)) ||
 285       (!XDR_PUTLONG (xdrs, (long *) &proc)) ||
 286       (!AUTH_MARSHALL (h->cl_auth, xdrs)) ||
 287       (!(*xdr_args) (xdrs, args_ptr)))
 288     {
 289       if (ct->ct_error.re_status == RPC_SUCCESS)
 290         ct->ct_error.re_status = RPC_CANTENCODEARGS;
 291       (void) xdrrec_endofrecord (xdrs, TRUE);
 292       return (ct->ct_error.re_status);
 293     }
 294   if (!xdrrec_endofrecord (xdrs, shipnow))
 295     return ct->ct_error.re_status = RPC_CANTSEND;
 296   if (!shipnow)
 297     return RPC_SUCCESS;
 298   /*
 299    * Hack to provide rpc-based message passing
 300    */
 301   if (ct->ct_wait.tv_sec == 0 && ct->ct_wait.tv_usec == 0)
 302     {
 303       return ct->ct_error.re_status = RPC_TIMEDOUT;
 304     }
 305
 306
 307   /*
 308    * Keep receiving until we get a valid transaction id
 309    */
 310   xdrs->x_op = XDR_DECODE;
 311   while (TRUE)
 312     {
 313       reply_msg.acpted_rply.ar_verf = _null_auth;
 314       reply_msg.acpted_rply.ar_results.where = NULL;
 315       reply_msg.acpted_rply.ar_results.proc = (xdrproc_t)xdr_void;
 316       if (!xdrrec_skiprecord (xdrs))
 317         return (ct->ct_error.re_status);
 318       /* now decode and validate the response header */
 319       if (!xdr_replymsg (xdrs, &reply_msg))
 320         {
 321           if (ct->ct_error.re_status == RPC_SUCCESS)
 322             continue;
 323           return ct->ct_error.re_status;
 324         }
 325       if ((u_int32_t) reply_msg.rm_xid == (u_int32_t) x_id)
 326         break;
 327     }
 328
 329   /*
 330    * process header
 331    */
 332   _seterr_reply (&reply_msg, &(ct->ct_error));
 333   if (ct->ct_error.re_status == RPC_SUCCESS)
 334     {
 335       if (!AUTH_VALIDATE (h->cl_auth, &reply_msg.acpted_rply.ar_verf))
 336         {
 337           ct->ct_error.re_status = RPC_AUTHERROR;
 338           ct->ct_error.re_why = AUTH_INVALIDRESP;
 339         }
 340       else if (!(*xdr_results) (xdrs, results_ptr))
 341         {
 342           if (ct->ct_error.re_status == RPC_SUCCESS)
 343             ct->ct_error.re_status = RPC_CANTDECODERES;
 344         }
 345       /* free verifier ... */
 346       if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)
 347         {
 348           xdrs->x_op = XDR_FREE;
 349           (void) xdr_opaque_auth (xdrs, &(reply_msg.acpted_rply.ar_verf));
 350         }
 351     }                           /* end successful completion */
 352   else
 353     {
 354       /* maybe our credentials need to be refreshed ... */
 355       if (refreshes-- && AUTH_REFRESH (h->cl_auth))
 356         goto call_again;
 357     }                           /* end of unsuccessful completion */
 358   return ct->ct_error.re_status;
 359 }
 360
 361 static void
 362 clnttcp_geterr (h, errp)
 363      CLIENT *h;
 364      struct rpc_err *errp;
 365 {
 366   struct ct_data *ct =
 367   (struct ct_data *) h->cl_private;
 368
 369   *errp = ct->ct_error;
 370 }
 371
 372 static bool_t
 373 clnttcp_freeres (cl, xdr_res, res_ptr)
 374      CLIENT *cl;
 375      xdrproc_t xdr_res;
 376      caddr_t res_ptr;
 377 {
 378   struct ct_data *ct = (struct ct_data *) cl->cl_private;
 379   XDR *xdrs = &(ct->ct_xdrs);
 380
 381   xdrs->x_op = XDR_FREE;
 382   return (*xdr_res) (xdrs, res_ptr);
 383 }
 384
 385 static void
 386 clnttcp_abort ()
 387 {
 388 }
 389
 390 static bool_t
 391 clnttcp_control (CLIENT *cl, int request, char *info)
 392 {
 393   struct ct_data *ct = (struct ct_data *) cl->cl_private;
 394
 395
 396   switch (request)
 397     {
 398     case CLSET_FD_CLOSE:
 399       ct->ct_closeit = TRUE;
 400       break;
 401     case CLSET_FD_NCLOSE:
 402       ct->ct_closeit = FALSE;
 403       break;
 404     case CLSET_TIMEOUT:
 405       ct->ct_wait = *(struct timeval *) info;
 406       ct->ct_waitset = TRUE;
 407       break;
 408     case CLGET_TIMEOUT:
 409       *(struct timeval *) info = ct->ct_wait;
 410       break;
 411     case CLGET_SERVER_ADDR:
 412       *(struct sockaddr_in *) info = ct->ct_addr;
 413       break;
 414     case CLGET_FD:
 415       *(int *)info = ct->ct_sock;
 416       break;
 417     case CLGET_XID:
 418       /*
 419        * use the knowledge that xid is the
 420        * first element in the call structure *.
 421        * This will get the xid of the PREVIOUS call
 422        */
 423       *(u_long *)info = ntohl (*(u_long *)ct->ct_mcall);
 424       break;
 425     case CLSET_XID:
 426       /* This will set the xid of the NEXT call */
 427       *(u_long *)ct->ct_mcall =  htonl (*(u_long *)info - 1);
 428       /* decrement by 1 as clnttcp_call() increments once */
 429     case CLGET_VERS:
 430       /*
 431        * This RELIES on the information that, in the call body,
 432        * the version number field is the fifth field from the
 433        * begining of the RPC header. MUST be changed if the
 434        * call_struct is changed
 435        */
 436       *(u_long *)info = ntohl (*(u_long *)(ct->ct_mcall +
 437                                            4 * BYTES_PER_XDR_UNIT));
 438       break;
 439     case CLSET_VERS:
 440       *(u_long *)(ct->ct_mcall + 4 * BYTES_PER_XDR_UNIT)
 441         = htonl (*(u_long *)info);
 442       break;
 443     case CLGET_PROG:
 444       /*
 445        * This RELIES on the information that, in the call body,
 446        * the program number field is the  field from the
 447        * begining of the RPC header. MUST be changed if the
 448        * call_struct is changed
 449        */
 450       *(u_long *)info = ntohl(*(u_long *)(ct->ct_mcall +
 451                                           3 * BYTES_PER_XDR_UNIT));
 452       break;
 453     case CLSET_PROG:
 454       *(u_long *)(ct->ct_mcall + 3 * BYTES_PER_XDR_UNIT)
 455         = htonl(*(u_long *)info);
 456       break;
 457     /* The following are only possible with TI-RPC */
 458     case CLGET_RETRY_TIMEOUT:
 459     case CLSET_RETRY_TIMEOUT:
 460     case CLGET_SVC_ADDR:
 461     case CLSET_SVC_ADDR:
 462     case CLSET_PUSH_TIMOD:
 463     case CLSET_POP_TIMOD:
 464     default:
 465       return FALSE;
 466     }
 467   return TRUE;
 468 }
 469
 470
 471 static void
 472 clnttcp_destroy (CLIENT *h)
 473 {
 474   struct ct_data *ct =
 475   (struct ct_data *) h->cl_private;
 476
 477   if (ct->ct_closeit)
 478     {
 479       (void) __close (ct->ct_sock);
 480     }
 481   XDR_DESTROY (&(ct->ct_xdrs));
 482   mem_free ((caddr_t) ct, sizeof (struct ct_data));
 483   mem_free ((caddr_t) h, sizeof (CLIENT));
 484 }
 485
 486 /*
 487  * Interface between xdr serializer and tcp connection.
 488  * Behaves like the system calls, read & write, but keeps some error state
 489  * around for the rpc level.
 490  */
 491 static int
 492 readtcp (char *ctptr, char *buf, int len)
 493 {
 494   struct ct_data *ct = (struct ct_data *)ctptr;
 495   struct pollfd fd;
 496   int milliseconds = (ct->ct_wait.tv_sec * 1000) +
 497     (ct->ct_wait.tv_usec / 1000);
 498
 499   if (len == 0)
 500     return 0;
 501
 502   fd.fd = ct->ct_sock;
 503   fd.events = POLLIN;
 504   while (TRUE)
 505     {
 506       switch (poll(&fd, 1, milliseconds))
 507         {
 508         case 0:
 509           ct->ct_error.re_status = RPC_TIMEDOUT;
 510           return -1;
 511
 512         case -1:
 513           if (errno == EINTR)
 514             continue;
 515           ct->ct_error.re_status = RPC_CANTRECV;
 516           ct->ct_error.re_errno = errno;
 517           return -1;
 518         }
 519       break;
 520     }
 521   switch (len = __read (ct->ct_sock, buf, len))
 522     {
 523
 524     case 0:
 525       /* premature eof */
 526       ct->ct_error.re_errno = ECONNRESET;
 527       ct->ct_error.re_status = RPC_CANTRECV;
 528       len = -1;                 /* it's really an error */
 529       break;
 530
 531     case -1:
 532       ct->ct_error.re_errno = errno;
 533       ct->ct_error.re_status = RPC_CANTRECV;
 534       break;
 535     }
 536   return len;
 537 }
 538
 539 static int
 540 writetcp (char *ctptr, char *buf, int len)
 541 {
 542   int i, cnt;
 543   struct ct_data *ct = (struct ct_data*)ctptr;
 544
 545   for (cnt = len; cnt > 0; cnt -= i, buf += i)
 546     {
 547       if ((i = __write (ct->ct_sock, buf, cnt)) == -1)
 548         {
 549           ct->ct_error.re_errno = errno;
 550           ct->ct_error.re_status = RPC_CANTSEND;
 551           return -1;
 552         }
 553     }
 554   return len;
 555 }