1 /* @(#)clnt_tcp.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
30 #if !defined(lint) && defined(SCCSIDS)
31 static char sccsid
[] = "@(#)clnt_tcp.c 1.37 87/10/05 Copyr 1984 Sun Micro";
35 * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
37 * Copyright (C) 1984, Sun Microsystems, Inc.
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).
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....
50 * Now go hang yourself.
60 #include <sys/socket.h>
61 #include <rpc/pmap_clnt.h>
66 extern u_long
_create_xid (void);
68 #define MCALL_MSG_SIZE 24
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 */
83 static int readtcp (char *, char *, int);
84 static int writetcp (char *, char *, int);
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
*);
94 static struct clnt_ops tcp_ops
=
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.
119 clnttcp_create (struct sockaddr_in
*raddr
, u_long prog
, u_long vers
,
120 int *sockp
, u_int sendsz
, u_int recvsz
)
124 struct rpc_msg call_msg
;
126 h
= (CLIENT
*) mem_alloc (sizeof (*h
));
127 ct
= (struct ct_data
*) mem_alloc (sizeof (*ct
));
128 if (h
== NULL
|| ct
== NULL
)
130 struct rpc_createerr
*ce
= &get_rpc_createerr ();
132 if (_IO_fwide (stderr
, 0) > 0)
133 (void) __fwprintf (stderr
, L
"%s",
134 _("clnttcp_create: out of memory\n"));
137 (void) fputs (_("clnttcp_create: out of memory\n"), stderr
);
138 ce
->cf_stat
= RPC_SYSTEMERROR
;
139 ce
->cf_error
.re_errno
= ENOMEM
;
144 * If no port number given ask the pmap for one
146 if (raddr
->sin_port
== 0)
149 if ((port
= pmap_getport (raddr
, prog
, vers
, IPPROTO_TCP
)) == 0)
151 mem_free ((caddr_t
) ct
, sizeof (struct ct_data
));
152 mem_free ((caddr_t
) h
, sizeof (CLIENT
));
153 return ((CLIENT
*) NULL
);
155 raddr
->sin_port
= htons (port
);
159 * If no socket given, open one
163 *sockp
= __socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
);
164 (void) bindresvport (*sockp
, (struct sockaddr_in
*) 0);
166 || (__connect (*sockp
, (struct sockaddr
*) raddr
,
167 sizeof (*raddr
)) < 0))
169 struct rpc_createerr
*ce
= &get_rpc_createerr ();
170 ce
->cf_stat
= RPC_SYSTEMERROR
;
171 ce
->cf_error
.re_errno
= errno
;
173 (void) __close (*sockp
);
176 ct
->ct_closeit
= TRUE
;
180 ct
->ct_closeit
= FALSE
;
184 * Set up private data struct
186 ct
->ct_sock
= *sockp
;
187 ct
->ct_wait
.tv_usec
= 0;
188 ct
->ct_waitset
= FALSE
;
189 ct
->ct_addr
= *raddr
;
192 * Initialize call message
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
;
201 * pre-serialize the static part of the call msg and stash it away
203 xdrmem_create (&(ct
->ct_xdrs
), ct
->ct_mcall
, MCALL_MSG_SIZE
,
205 if (!xdr_callhdr (&(ct
->ct_xdrs
), &call_msg
))
209 (void) __close (*sockp
);
213 ct
->ct_mpos
= XDR_GETPOS (&(ct
->ct_xdrs
));
214 XDR_DESTROY (&(ct
->ct_xdrs
));
217 * Create a client handle which uses xdrrec for serialization
218 * and authnone for authentication.
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 ();
229 * Something goofed, free stuff and barf
231 mem_free ((caddr_t
) ct
, sizeof (struct ct_data
));
232 mem_free ((caddr_t
) h
, sizeof (CLIENT
));
233 return ((CLIENT
*) NULL
);
236 static enum clnt_stat
237 clnttcp_call (h
, proc
, xdr_args
, args_ptr
, xdr_results
, results_ptr
, timeout
)
242 xdrproc_t xdr_results
;
244 struct timeval timeout
;
246 struct ct_data
*ct
= (struct ct_data
*) h
->cl_private
;
247 XDR
*xdrs
= &(ct
->ct_xdrs
);
248 struct rpc_msg reply_msg
;
250 u_int32_t
*msg_x_id
= (u_int32_t
*) (ct
->ct_mcall
); /* yuk */
256 ct
->ct_wait
= timeout
;
260 (xdr_results
== (xdrproc_t
) 0 && ct
->ct_wait
.tv_sec
== 0
261 && ct
->ct_wait
.tv_usec
== 0) ? FALSE
: TRUE
;
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
)))
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
);
277 if (!xdrrec_endofrecord (xdrs
, shipnow
))
278 return ct
->ct_error
.re_status
= RPC_CANTSEND
;
282 * Hack to provide rpc-based message passing
284 if (ct
->ct_wait
.tv_sec
== 0 && ct
->ct_wait
.tv_usec
== 0)
286 return ct
->ct_error
.re_status
= RPC_TIMEDOUT
;
291 * Keep receiving until we get a valid transaction id
293 xdrs
->x_op
= XDR_DECODE
;
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
))
304 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
306 return ct
->ct_error
.re_status
;
308 if ((u_int32_t
) reply_msg
.rm_xid
== (u_int32_t
) x_id
)
315 _seterr_reply (&reply_msg
, &(ct
->ct_error
));
316 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
318 if (!AUTH_VALIDATE (h
->cl_auth
, &reply_msg
.acpted_rply
.ar_verf
))
320 ct
->ct_error
.re_status
= RPC_AUTHERROR
;
321 ct
->ct_error
.re_why
= AUTH_INVALIDRESP
;
323 else if (!(*xdr_results
) (xdrs
, results_ptr
))
325 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
326 ct
->ct_error
.re_status
= RPC_CANTDECODERES
;
328 /* free verifier ... */
329 if (reply_msg
.acpted_rply
.ar_verf
.oa_base
!= NULL
)
331 xdrs
->x_op
= XDR_FREE
;
332 (void) xdr_opaque_auth (xdrs
, &(reply_msg
.acpted_rply
.ar_verf
));
334 } /* end successful completion */
337 /* maybe our credentials need to be refreshed ... */
338 if (refreshes
-- && AUTH_REFRESH (h
->cl_auth
))
340 } /* end of unsuccessful completion */
341 return ct
->ct_error
.re_status
;
345 clnttcp_geterr (h
, errp
)
347 struct rpc_err
*errp
;
350 (struct ct_data
*) h
->cl_private
;
352 *errp
= ct
->ct_error
;
356 clnttcp_freeres (cl
, xdr_res
, res_ptr
)
361 struct ct_data
*ct
= (struct ct_data
*) cl
->cl_private
;
362 XDR
*xdrs
= &(ct
->ct_xdrs
);
364 xdrs
->x_op
= XDR_FREE
;
365 return (*xdr_res
) (xdrs
, res_ptr
);
374 clnttcp_control (CLIENT
*cl
, int request
, char *info
)
376 struct ct_data
*ct
= (struct ct_data
*) cl
->cl_private
;
382 ct
->ct_closeit
= TRUE
;
384 case CLSET_FD_NCLOSE
:
385 ct
->ct_closeit
= FALSE
;
388 ct
->ct_wait
= *(struct timeval
*) info
;
389 ct
->ct_waitset
= TRUE
;
392 *(struct timeval
*) info
= ct
->ct_wait
;
394 case CLGET_SERVER_ADDR
:
395 *(struct sockaddr_in
*) info
= ct
->ct_addr
;
398 *(int *)info
= ct
->ct_sock
;
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
406 *(u_long
*)info
= ntohl (*(u_long
*)ct
->ct_mcall
);
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 */
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
419 *(u_long
*)info
= ntohl (*(u_long
*)(ct
->ct_mcall
+
420 4 * BYTES_PER_XDR_UNIT
));
423 *(u_long
*)(ct
->ct_mcall
+ 4 * BYTES_PER_XDR_UNIT
)
424 = htonl (*(u_long
*)info
);
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
433 *(u_long
*)info
= ntohl(*(u_long
*)(ct
->ct_mcall
+
434 3 * BYTES_PER_XDR_UNIT
));
437 *(u_long
*)(ct
->ct_mcall
+ 3 * BYTES_PER_XDR_UNIT
)
438 = htonl(*(u_long
*)info
);
440 /* The following are only possible with TI-RPC */
441 case CLGET_RETRY_TIMEOUT
:
442 case CLSET_RETRY_TIMEOUT
:
445 case CLSET_PUSH_TIMOD
:
446 case CLSET_POP_TIMOD
:
455 clnttcp_destroy (CLIENT
*h
)
458 (struct ct_data
*) h
->cl_private
;
462 (void) __close (ct
->ct_sock
);
464 XDR_DESTROY (&(ct
->ct_xdrs
));
465 mem_free ((caddr_t
) ct
, sizeof (struct ct_data
));
466 mem_free ((caddr_t
) h
, sizeof (CLIENT
));
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.
475 readtcp (char *ctptr
, char *buf
, int len
)
477 struct ct_data
*ct
= (struct ct_data
*)ctptr
;
479 int milliseconds
= (ct
->ct_wait
.tv_sec
* 1000) +
480 (ct
->ct_wait
.tv_usec
/ 1000);
489 switch (__poll(&fd
, 1, milliseconds
))
492 ct
->ct_error
.re_status
= RPC_TIMEDOUT
;
498 ct
->ct_error
.re_status
= RPC_CANTRECV
;
499 ct
->ct_error
.re_errno
= errno
;
504 switch (len
= __read (ct
->ct_sock
, buf
, len
))
509 ct
->ct_error
.re_errno
= ECONNRESET
;
510 ct
->ct_error
.re_status
= RPC_CANTRECV
;
511 len
= -1; /* it's really an error */
515 ct
->ct_error
.re_errno
= errno
;
516 ct
->ct_error
.re_status
= RPC_CANTRECV
;
523 writetcp (char *ctptr
, char *buf
, int len
)
526 struct ct_data
*ct
= (struct ct_data
*)ctptr
;
528 for (cnt
= len
; cnt
> 0; cnt
-= i
, buf
+= i
)
530 if ((i
= __write (ct
->ct_sock
, buf
, cnt
)) == -1)
532 ct
->ct_error
.re_errno
= errno
;
533 ct
->ct_error
.re_status
= RPC_CANTSEND
;