2 * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
4 * Copyright (c) 2010, Oracle America, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
16 * * Neither the name of the "Oracle America, Inc." nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * TCP based RPC supports 'batched calls'.
34 * A sequence of calls may be batched-up in a send buffer. The rpc call
35 * return immediately to the client even though the call was not necessarily
36 * sent. The batching occurs if the results' xdr routine is NULL (0) AND
37 * the rpc timeout value is zero (see clnt.h, rpc).
39 * Clients should NOT casually batch calls that in fact return results; that is,
40 * the server side should be aware that a call is batched and not produce any
41 * return message. Batched calls that produce many result messages can
42 * deadlock (netlock) the client and the server....
44 * Now go hang yourself.
54 #include <sys/socket.h>
55 #include <rpc/pmap_clnt.h>
58 extern u_long _create_xid (void);
60 #define MCALL_MSG_SIZE 24
66 struct timeval ct_wait;
67 bool_t ct_waitset; /* wait set by clnt_control? */
68 struct sockaddr_in ct_addr;
69 struct rpc_err ct_error;
70 char ct_mcall[MCALL_MSG_SIZE]; /* marshalled callmsg */
71 u_int ct_mpos; /* pos after marshal */
75 static int readtcp (char *, char *, int);
76 static int writetcp (char *, char *, int);
78 static enum clnt_stat clnttcp_call (CLIENT *, u_long, xdrproc_t, caddr_t,
79 xdrproc_t, caddr_t, struct timeval);
80 static void clnttcp_abort (void);
81 static void clnttcp_geterr (CLIENT *, struct rpc_err *);
82 static bool_t clnttcp_freeres (CLIENT *, xdrproc_t, caddr_t);
83 static bool_t clnttcp_control (CLIENT *, int, char *);
84 static void clnttcp_destroy (CLIENT *);
86 static const struct clnt_ops tcp_ops =
97 * Create a client handle for a tcp/ip connection.
98 * If *sockp<0, *sockp is set to a newly created TCP socket and it is
99 * connected to raddr. If *sockp non-negative then
100 * raddr is ignored. The rpc/tcp package does buffering
101 * similar to stdio, so the client must pick send and receive buffer sizes,];
102 * 0 => use the default.
103 * If raddr->sin_port is 0, then a binder on the remote machine is
104 * consulted for the right port number.
105 * NB: *sockp is copied into a private area.
106 * NB: It is the clients responsibility to close *sockp.
107 * NB: The rpch->cl_auth is set null authentication. Caller may wish to set this
108 * something more useful.
111 clnttcp_create (struct sockaddr_in *raddr, u_long prog, u_long vers,
112 int *sockp, u_int sendsz, u_int recvsz)
116 struct rpc_msg call_msg;
118 h = (CLIENT *) mem_alloc (sizeof (*h));
119 ct = (struct ct_data *) mem_alloc (sizeof (*ct));
120 if (h == NULL || ct == NULL)
122 struct rpc_createerr *ce = &get_rpc_createerr ();
123 (void) __fxprintf (NULL, "%s: %s", __func__, _("out of memory\n"));
124 ce->cf_stat = RPC_SYSTEMERROR;
125 ce->cf_error.re_errno = ENOMEM;
130 * If no port number given ask the pmap for one
132 if (raddr->sin_port == 0)
135 if ((port = pmap_getport (raddr, prog, vers, IPPROTO_TCP)) == 0)
137 mem_free ((caddr_t) ct, sizeof (struct ct_data));
138 mem_free ((caddr_t) h, sizeof (CLIENT));
139 return ((CLIENT *) NULL);
141 raddr->sin_port = htons (port);
145 * If no socket given, open one
149 *sockp = __socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
150 (void) bindresvport (*sockp, (struct sockaddr_in *) 0);
152 || (__connect (*sockp, (struct sockaddr *) raddr,
153 sizeof (*raddr)) < 0))
155 struct rpc_createerr *ce = &get_rpc_createerr ();
156 ce->cf_stat = RPC_SYSTEMERROR;
157 ce->cf_error.re_errno = errno;
159 (void) __close (*sockp);
162 ct->ct_closeit = TRUE;
166 ct->ct_closeit = FALSE;
170 * Set up private data struct
172 ct->ct_sock = *sockp;
173 ct->ct_wait.tv_usec = 0;
174 ct->ct_waitset = FALSE;
175 ct->ct_addr = *raddr;
178 * Initialize call message
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 = prog;
184 call_msg.rm_call.cb_vers = vers;
187 * pre-serialize the static part of the call msg and stash it away
189 xdrmem_create (&(ct->ct_xdrs), ct->ct_mcall, MCALL_MSG_SIZE, XDR_ENCODE);
190 if (!xdr_callhdr (&(ct->ct_xdrs), &call_msg))
194 (void) __close (*sockp);
198 ct->ct_mpos = XDR_GETPOS (&(ct->ct_xdrs));
199 XDR_DESTROY (&(ct->ct_xdrs));
202 * Create a client handle which uses xdrrec for serialization
203 * and authnone for authentication.
205 xdrrec_create (&(ct->ct_xdrs), sendsz, recvsz,
206 (caddr_t) ct, readtcp, writetcp);
207 h->cl_ops = (struct clnt_ops *) &tcp_ops;
208 h->cl_private = (caddr_t) ct;
209 h->cl_auth = authnone_create ();
214 * Something goofed, free stuff and barf
216 mem_free ((caddr_t) ct, sizeof (struct ct_data));
217 mem_free ((caddr_t) h, sizeof (CLIENT));
218 return ((CLIENT *) NULL);
220 #ifdef EXPORT_RPC_SYMBOLS
221 libc_hidden_def (clnttcp_create)
223 libc_hidden_nolink (clnttcp_create, GLIBC_2_0)
226 static enum clnt_stat
227 clnttcp_call (h, proc, xdr_args, args_ptr, xdr_results, results_ptr, timeout)
232 xdrproc_t xdr_results;
234 struct timeval timeout;
236 struct ct_data *ct = (struct ct_data *) h->cl_private;
237 XDR *xdrs = &(ct->ct_xdrs);
238 struct rpc_msg reply_msg;
240 u_int32_t *msg_x_id = (u_int32_t *) (ct->ct_mcall); /* yuk */
246 ct->ct_wait = timeout;
250 (xdr_results == (xdrproc_t) 0 && ct->ct_wait.tv_sec == 0
251 && ct->ct_wait.tv_usec == 0) ? FALSE : TRUE;
254 xdrs->x_op = XDR_ENCODE;
255 ct->ct_error.re_status = RPC_SUCCESS;
256 x_id = ntohl (--(*msg_x_id));
257 if ((!XDR_PUTBYTES (xdrs, ct->ct_mcall, ct->ct_mpos)) ||
258 (!XDR_PUTLONG (xdrs, (long *) &proc)) ||
259 (!AUTH_MARSHALL (h->cl_auth, xdrs)) ||
260 (!(*xdr_args) (xdrs, args_ptr)))
262 if (ct->ct_error.re_status == RPC_SUCCESS)
263 ct->ct_error.re_status = RPC_CANTENCODEARGS;
264 (void) xdrrec_endofrecord (xdrs, TRUE);
265 return (ct->ct_error.re_status);
267 if (!xdrrec_endofrecord (xdrs, shipnow))
268 return ct->ct_error.re_status = RPC_CANTSEND;
272 * Hack to provide rpc-based message passing
274 if (ct->ct_wait.tv_sec == 0 && ct->ct_wait.tv_usec == 0)
276 return ct->ct_error.re_status = RPC_TIMEDOUT;
281 * Keep receiving until we get a valid transaction id
283 xdrs->x_op = XDR_DECODE;
286 reply_msg.acpted_rply.ar_verf = _null_auth;
287 reply_msg.acpted_rply.ar_results.where = NULL;
288 reply_msg.acpted_rply.ar_results.proc = (xdrproc_t)xdr_void;
289 if (!xdrrec_skiprecord (xdrs))
290 return (ct->ct_error.re_status);
291 /* now decode and validate the response header */
292 if (!xdr_replymsg (xdrs, &reply_msg))
294 if (ct->ct_error.re_status == RPC_SUCCESS)
296 return ct->ct_error.re_status;
298 if ((u_int32_t) reply_msg.rm_xid == (u_int32_t) x_id)
305 _seterr_reply (&reply_msg, &(ct->ct_error));
306 if (ct->ct_error.re_status == RPC_SUCCESS)
308 if (!AUTH_VALIDATE (h->cl_auth, &reply_msg.acpted_rply.ar_verf))
310 ct->ct_error.re_status = RPC_AUTHERROR;
311 ct->ct_error.re_why = AUTH_INVALIDRESP;
313 else if (!(*xdr_results) (xdrs, results_ptr))
315 if (ct->ct_error.re_status == RPC_SUCCESS)
316 ct->ct_error.re_status = RPC_CANTDECODERES;
318 /* free verifier ... */
319 if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)
321 xdrs->x_op = XDR_FREE;
322 (void) xdr_opaque_auth (xdrs, &(reply_msg.acpted_rply.ar_verf));
324 } /* end successful completion */
327 /* maybe our credentials need to be refreshed ... */
328 if (refreshes-- && AUTH_REFRESH (h->cl_auth))
330 } /* end of unsuccessful completion */
331 return ct->ct_error.re_status;
335 clnttcp_geterr (h, errp)
337 struct rpc_err *errp;
340 (struct ct_data *) h->cl_private;
342 *errp = ct->ct_error;
346 clnttcp_freeres (cl, xdr_res, res_ptr)
351 struct ct_data *ct = (struct ct_data *) cl->cl_private;
352 XDR *xdrs = &(ct->ct_xdrs);
354 xdrs->x_op = XDR_FREE;
355 return (*xdr_res) (xdrs, res_ptr);
364 clnttcp_control (CLIENT *cl, int request, char *info)
366 struct ct_data *ct = (struct ct_data *) cl->cl_private;
372 ct->ct_closeit = TRUE;
374 case CLSET_FD_NCLOSE:
375 ct->ct_closeit = FALSE;
378 ct->ct_wait = *(struct timeval *) info;
379 ct->ct_waitset = TRUE;
382 *(struct timeval *) info = ct->ct_wait;
384 case CLGET_SERVER_ADDR:
385 *(struct sockaddr_in *) info = ct->ct_addr;
388 *(int *)info = ct->ct_sock;
392 * use the knowledge that xid is the
393 * first element in the call structure *.
394 * This will get the xid of the PREVIOUS call
396 *(u_long *)info = ntohl (*(u_long *)ct->ct_mcall);
399 /* This will set the xid of the NEXT call */
400 *(u_long *)ct->ct_mcall = htonl (*(u_long *)info - 1);
401 /* decrement by 1 as clnttcp_call() increments once */
405 * This RELIES on the information that, in the call body,
406 * the version number field is the fifth field from the
407 * begining of the RPC header. MUST be changed if the
408 * call_struct is changed
410 *(u_long *)info = ntohl (*(u_long *)(ct->ct_mcall +
411 4 * BYTES_PER_XDR_UNIT));
414 *(u_long *)(ct->ct_mcall + 4 * BYTES_PER_XDR_UNIT)
415 = htonl (*(u_long *)info);
419 * This RELIES on the information that, in the call body,
420 * the program number field is the field from the
421 * begining of the RPC header. MUST be changed if the
422 * call_struct is changed
424 *(u_long *)info = ntohl(*(u_long *)(ct->ct_mcall +
425 3 * BYTES_PER_XDR_UNIT));
428 *(u_long *)(ct->ct_mcall + 3 * BYTES_PER_XDR_UNIT)
429 = htonl(*(u_long *)info);
431 /* The following are only possible with TI-RPC */
432 case CLGET_RETRY_TIMEOUT:
433 case CLSET_RETRY_TIMEOUT:
436 case CLSET_PUSH_TIMOD:
437 case CLSET_POP_TIMOD:
446 clnttcp_destroy (CLIENT *h)
449 (struct ct_data *) h->cl_private;
453 (void) __close (ct->ct_sock);
455 XDR_DESTROY (&(ct->ct_xdrs));
456 mem_free ((caddr_t) ct, sizeof (struct ct_data));
457 mem_free ((caddr_t) h, sizeof (CLIENT));
461 * Interface between xdr serializer and tcp connection.
462 * Behaves like the system calls, read & write, but keeps some error state
463 * around for the rpc level.
466 readtcp (char *ctptr, char *buf, int len)
468 struct ct_data *ct = (struct ct_data *)ctptr;
470 int milliseconds = (ct->ct_wait.tv_sec * 1000) +
471 (ct->ct_wait.tv_usec / 1000);
480 switch (__poll(&fd, 1, milliseconds))
483 ct->ct_error.re_status = RPC_TIMEDOUT;
489 ct->ct_error.re_status = RPC_CANTRECV;
490 ct->ct_error.re_errno = errno;
495 switch (len = __read (ct->ct_sock, buf, len))
500 ct->ct_error.re_errno = ECONNRESET;
501 ct->ct_error.re_status = RPC_CANTRECV;
502 len = -1; /* it's really an error */
506 ct->ct_error.re_errno = errno;
507 ct->ct_error.re_status = RPC_CANTRECV;
514 writetcp (char *ctptr, char *buf, int len)
517 struct ct_data *ct = (struct ct_data*)ctptr;
519 for (cnt = len; cnt > 0; cnt -= i, buf += i)
521 if ((i = __write (ct->ct_sock, buf, cnt)) == -1)
523 ct->ct_error.re_errno = errno;
524 ct->ct_error.re_status = RPC_CANTSEND;