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.
55 #include <sys/socket.h>
58 #include <rpc/pmap_clnt.h>
60 #define MCALL_MSG_SIZE 24
67 static int writetcp();
69 static enum clnt_stat
clnttcp_call();
70 static void clnttcp_abort();
71 static void clnttcp_geterr();
72 static bool_t
clnttcp_freeres();
73 static bool_t
clnttcp_control();
74 static void clnttcp_destroy();
76 static struct clnt_ops tcp_ops
= {
88 struct timeval ct_wait
;
89 bool_t ct_waitset
; /* wait set by clnt_control? */
90 struct sockaddr_in ct_addr
;
91 struct rpc_err ct_error
;
92 char ct_mcall
[MCALL_MSG_SIZE
]; /* marshalled callmsg */
93 u_int ct_mpos
; /* pos after marshal */
98 * Create a client handle for a tcp/ip connection.
99 * If *sockp<0, *sockp is set to a newly created TCP socket and it is
100 * connected to raddr. If *sockp non-negative then
101 * raddr is ignored. The rpc/tcp package does buffering
102 * similar to stdio, so the client must pick send and receive buffer sizes,];
103 * 0 => use the default.
104 * If raddr->sin_port is 0, then a binder on the remote machine is
105 * consulted for the right port number.
106 * NB: *sockp is copied into a private area.
107 * NB: It is the clients responsibility to close *sockp.
108 * NB: The rpch->cl_auth is set null authentication. Caller may wish to set this
109 * something more useful.
112 clnttcp_create(raddr
, prog
, vers
, sockp
, sendsz
, recvsz
)
113 struct sockaddr_in
*raddr
;
121 register struct ct_data
*ct
;
123 struct rpc_msg call_msg
;
125 h
= (CLIENT
*)mem_alloc(sizeof(*h
));
127 (void)fprintf(stderr
, "clnttcp_create: out of memory\n");
128 rpc_createerr
.cf_stat
= RPC_SYSTEMERROR
;
129 rpc_createerr
.cf_error
.re_errno
= errno
;
132 ct
= (struct ct_data
*)mem_alloc(sizeof(*ct
));
134 (void)fprintf(stderr
, "clnttcp_create: out of memory\n");
135 rpc_createerr
.cf_stat
= RPC_SYSTEMERROR
;
136 rpc_createerr
.cf_error
.re_errno
= errno
;
141 * If no port number given ask the pmap for one
143 if (raddr
->sin_port
== 0) {
145 if ((port
= pmap_getport(raddr
, prog
, vers
, IPPROTO_TCP
)) == 0) {
146 mem_free((caddr_t
)ct
, sizeof(struct ct_data
));
147 mem_free((caddr_t
)h
, sizeof(CLIENT
));
148 return ((CLIENT
*)NULL
);
150 raddr
->sin_port
= htons(port
);
154 * If no socket given, open one
157 *sockp
= socket(AF_INET
, SOCK_STREAM
, IPPROTO_TCP
);
158 (void)bindresvport(*sockp
, (struct sockaddr_in
*)0);
160 || (connect(*sockp
, (struct sockaddr
*)raddr
,
161 sizeof(*raddr
)) < 0)) {
162 rpc_createerr
.cf_stat
= RPC_SYSTEMERROR
;
163 rpc_createerr
.cf_error
.re_errno
= errno
;
168 ct
->ct_closeit
= TRUE
;
170 ct
->ct_closeit
= FALSE
;
174 * Set up private data struct
176 ct
->ct_sock
= *sockp
;
177 ct
->ct_wait
.tv_usec
= 0;
178 ct
->ct_waitset
= FALSE
;
179 ct
->ct_addr
= *raddr
;
182 * Initialize call message
184 (void)gettimeofday(&now
, (struct timezone
*)0);
185 call_msg
.rm_xid
= getpid() ^ now
.tv_sec
^ now
.tv_usec
;
186 call_msg
.rm_direction
= CALL
;
187 call_msg
.rm_call
.cb_rpcvers
= RPC_MSG_VERSION
;
188 call_msg
.rm_call
.cb_prog
= prog
;
189 call_msg
.rm_call
.cb_vers
= vers
;
192 * pre-serialize the staic part of the call msg and stash it away
194 xdrmem_create(&(ct
->ct_xdrs
), ct
->ct_mcall
, MCALL_MSG_SIZE
,
196 if (! xdr_callhdr(&(ct
->ct_xdrs
), &call_msg
)) {
197 if (ct
->ct_closeit
) {
202 ct
->ct_mpos
= XDR_GETPOS(&(ct
->ct_xdrs
));
203 XDR_DESTROY(&(ct
->ct_xdrs
));
206 * Create a client handle which uses xdrrec for serialization
207 * and authnone for authentication.
209 xdrrec_create(&(ct
->ct_xdrs
), sendsz
, recvsz
,
210 (caddr_t
)ct
, readtcp
, writetcp
);
211 h
->cl_ops
= &tcp_ops
;
212 h
->cl_private
= (caddr_t
) ct
;
213 h
->cl_auth
= authnone_create();
218 * Something goofed, free stuff and barf
220 mem_free((caddr_t
)ct
, sizeof(struct ct_data
));
221 mem_free((caddr_t
)h
, sizeof(CLIENT
));
222 return ((CLIENT
*)NULL
);
225 static enum clnt_stat
226 clnttcp_call(h
, proc
, xdr_args
, args_ptr
, xdr_results
, results_ptr
, timeout
)
231 xdrproc_t xdr_results
;
233 struct timeval timeout
;
235 register struct ct_data
*ct
= (struct ct_data
*) h
->cl_private
;
236 register XDR
*xdrs
= &(ct
->ct_xdrs
);
237 struct rpc_msg reply_msg
;
239 u_int32_t
*msg_x_id
= (u_int32_t
*)(ct
->ct_mcall
); /* yuk */
240 register bool_t shipnow
;
243 if (!ct
->ct_waitset
) {
244 ct
->ct_wait
= timeout
;
248 (xdr_results
== (xdrproc_t
)0 && timeout
.tv_sec
== 0
249 && timeout
.tv_usec
== 0) ? FALSE
: TRUE
;
252 xdrs
->x_op
= XDR_ENCODE
;
253 ct
->ct_error
.re_status
= RPC_SUCCESS
;
254 x_id
= ntohl(--(*msg_x_id
));
255 if ((! XDR_PUTBYTES(xdrs
, ct
->ct_mcall
, ct
->ct_mpos
)) ||
256 (! XDR_PUTLONG(xdrs
, (long *)&proc
)) ||
257 (! AUTH_MARSHALL(h
->cl_auth
, xdrs
)) ||
258 (! (*xdr_args
)(xdrs
, args_ptr
))) {
259 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
260 ct
->ct_error
.re_status
= RPC_CANTENCODEARGS
;
261 (void)xdrrec_endofrecord(xdrs
, TRUE
);
262 return (ct
->ct_error
.re_status
);
264 if (! xdrrec_endofrecord(xdrs
, shipnow
))
265 return (ct
->ct_error
.re_status
= RPC_CANTSEND
);
267 return (RPC_SUCCESS
);
269 * Hack to provide rpc-based message passing
271 if (timeout
.tv_sec
== 0 && timeout
.tv_usec
== 0) {
272 return(ct
->ct_error
.re_status
= RPC_TIMEDOUT
);
277 * Keep receiving until we get a valid transaction id
279 xdrs
->x_op
= XDR_DECODE
;
281 reply_msg
.acpted_rply
.ar_verf
= _null_auth
;
282 reply_msg
.acpted_rply
.ar_results
.where
= NULL
;
283 reply_msg
.acpted_rply
.ar_results
.proc
= xdr_void
;
284 if (! xdrrec_skiprecord(xdrs
))
285 return (ct
->ct_error
.re_status
);
286 /* now decode and validate the response header */
287 if (! xdr_replymsg(xdrs
, &reply_msg
)) {
288 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
290 return (ct
->ct_error
.re_status
);
292 if (reply_msg
.rm_xid
== x_id
)
299 _seterr_reply(&reply_msg
, &(ct
->ct_error
));
300 if (ct
->ct_error
.re_status
== RPC_SUCCESS
) {
301 if (! AUTH_VALIDATE(h
->cl_auth
, &reply_msg
.acpted_rply
.ar_verf
)) {
302 ct
->ct_error
.re_status
= RPC_AUTHERROR
;
303 ct
->ct_error
.re_why
= AUTH_INVALIDRESP
;
304 } else if (! (*xdr_results
)(xdrs
, results_ptr
)) {
305 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
306 ct
->ct_error
.re_status
= RPC_CANTDECODERES
;
308 /* free verifier ... */
309 if (reply_msg
.acpted_rply
.ar_verf
.oa_base
!= NULL
) {
310 xdrs
->x_op
= XDR_FREE
;
311 (void)xdr_opaque_auth(xdrs
, &(reply_msg
.acpted_rply
.ar_verf
));
313 } /* end successful completion */
315 /* maybe our credentials need to be refreshed ... */
316 if (refreshes
-- && AUTH_REFRESH(h
->cl_auth
))
318 } /* end of unsuccessful completion */
319 return (ct
->ct_error
.re_status
);
323 clnttcp_geterr(h
, errp
)
325 struct rpc_err
*errp
;
327 register struct ct_data
*ct
=
328 (struct ct_data
*) h
->cl_private
;
330 *errp
= ct
->ct_error
;
334 clnttcp_freeres(cl
, xdr_res
, res_ptr
)
339 register struct ct_data
*ct
= (struct ct_data
*)cl
->cl_private
;
340 register XDR
*xdrs
= &(ct
->ct_xdrs
);
342 xdrs
->x_op
= XDR_FREE
;
343 return ((*xdr_res
)(xdrs
, res_ptr
));
352 clnttcp_control(cl
, request
, info
)
357 register struct ct_data
*ct
= (struct ct_data
*)cl
->cl_private
;
361 ct
->ct_wait
= *(struct timeval
*)info
;
362 ct
->ct_waitset
= TRUE
;
365 *(struct timeval
*)info
= ct
->ct_wait
;
367 case CLGET_SERVER_ADDR
:
368 *(struct sockaddr_in
*)info
= ct
->ct_addr
;
381 register struct ct_data
*ct
=
382 (struct ct_data
*) h
->cl_private
;
384 if (ct
->ct_closeit
) {
385 (void)close(ct
->ct_sock
);
387 XDR_DESTROY(&(ct
->ct_xdrs
));
388 mem_free((caddr_t
)ct
, sizeof(struct ct_data
));
389 mem_free((caddr_t
)h
, sizeof(CLIENT
));
393 * Interface between xdr serializer and tcp connection.
394 * Behaves like the system calls, read & write, but keeps some error state
395 * around for the rpc level.
398 readtcp(ct
, buf
, len
)
399 register struct ct_data
*ct
;
410 FD_SET(ct
->ct_sock
, &mask
);
412 register int mask
= 1 << (ct
->ct_sock
);
418 #endif /* def FD_SETSIZE */
421 switch (select(_rpc_dtablesize(), &readfds
, (int*)NULL
, (int*)NULL
,
424 ct
->ct_error
.re_status
= RPC_TIMEDOUT
;
430 ct
->ct_error
.re_status
= RPC_CANTRECV
;
431 ct
->ct_error
.re_errno
= errno
;
436 switch (len
= read(ct
->ct_sock
, buf
, len
)) {
440 ct
->ct_error
.re_errno
= ECONNRESET
;
441 ct
->ct_error
.re_status
= RPC_CANTRECV
;
442 len
= -1; /* it's really an error */
446 ct
->ct_error
.re_errno
= errno
;
447 ct
->ct_error
.re_status
= RPC_CANTRECV
;
454 writetcp(ct
, buf
, len
)
461 for (cnt
= len
; cnt
> 0; cnt
-= i
, buf
+= i
) {
462 if ((i
= write(ct
->ct_sock
, buf
, cnt
)) == -1) {
463 ct
->ct_error
.re_errno
= errno
;
464 ct
->ct_error
.re_status
= RPC_CANTSEND
;