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