clnt_vc.c revision 177685
1177633Sdfr/*	$NetBSD: clnt_vc.c,v 1.4 2000/07/14 08:40:42 fvdl Exp $	*/
2177633Sdfr
3177633Sdfr/*
4177633Sdfr * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5177633Sdfr * unrestricted use provided that this legend is included on all tape
6177633Sdfr * media and as a part of the software program in whole or part.  Users
7177633Sdfr * may copy or modify Sun RPC without charge, but are not authorized
8177633Sdfr * to license or distribute it to anyone else except as part of a product or
9177633Sdfr * program developed by the user.
10177633Sdfr *
11177633Sdfr * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12177633Sdfr * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
13177633Sdfr * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14177633Sdfr *
15177633Sdfr * Sun RPC is provided with no support and without any obligation on the
16177633Sdfr * part of Sun Microsystems, Inc. to assist in its use, correction,
17177633Sdfr * modification or enhancement.
18177633Sdfr *
19177633Sdfr * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20177633Sdfr * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21177633Sdfr * OR ANY PART THEREOF.
22177633Sdfr *
23177633Sdfr * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24177633Sdfr * or profits or other special, indirect and consequential damages, even if
25177633Sdfr * Sun has been advised of the possibility of such damages.
26177633Sdfr *
27177633Sdfr * Sun Microsystems, Inc.
28177633Sdfr * 2550 Garcia Avenue
29177633Sdfr * Mountain View, California  94043
30177633Sdfr */
31177633Sdfr
32177633Sdfr#if defined(LIBC_SCCS) && !defined(lint)
33177633Sdfrstatic char *sccsid2 = "@(#)clnt_tcp.c 1.37 87/10/05 Copyr 1984 Sun Micro";
34177633Sdfrstatic char *sccsid = "@(#)clnt_tcp.c	2.2 88/08/01 4.0 RPCSRC";
35177633Sdfrstatic char sccsid3[] = "@(#)clnt_vc.c 1.19 89/03/16 Copyr 1988 Sun Micro";
36177633Sdfr#endif
37177633Sdfr#include <sys/cdefs.h>
38177633Sdfr__FBSDID("$FreeBSD: head/sys/rpc/clnt_vc.c 177685 2008-03-28 09:50:32Z dfr $");
39177633Sdfr
40177633Sdfr/*
41177633Sdfr * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
42177633Sdfr *
43177633Sdfr * Copyright (C) 1984, Sun Microsystems, Inc.
44177633Sdfr *
45177633Sdfr * TCP based RPC supports 'batched calls'.
46177633Sdfr * A sequence of calls may be batched-up in a send buffer.  The rpc call
47177633Sdfr * return immediately to the client even though the call was not necessarily
48177633Sdfr * sent.  The batching occurs if the results' xdr routine is NULL (0) AND
49177633Sdfr * the rpc timeout value is zero (see clnt.h, rpc).
50177633Sdfr *
51177633Sdfr * Clients should NOT casually batch calls that in fact return results; that is,
52177633Sdfr * the server side should be aware that a call is batched and not produce any
53177633Sdfr * return message.  Batched calls that produce many result messages can
54177633Sdfr * deadlock (netlock) the client and the server....
55177633Sdfr *
56177633Sdfr * Now go hang yourself.
57177633Sdfr */
58177633Sdfr
59177633Sdfr#include <sys/param.h>
60177633Sdfr#include <sys/systm.h>
61177633Sdfr#include <sys/lock.h>
62177633Sdfr#include <sys/malloc.h>
63177633Sdfr#include <sys/mbuf.h>
64177633Sdfr#include <sys/mutex.h>
65177633Sdfr#include <sys/pcpu.h>
66177633Sdfr#include <sys/proc.h>
67177633Sdfr#include <sys/socket.h>
68177633Sdfr#include <sys/socketvar.h>
69177633Sdfr#include <sys/syslog.h>
70177633Sdfr#include <sys/time.h>
71177633Sdfr#include <sys/uio.h>
72177633Sdfr
73177633Sdfr#include <rpc/rpc.h>
74177685Sdfr#include <rpc/rpc_com.h>
75177633Sdfr
76177633Sdfr#define MCALL_MSG_SIZE 24
77177633Sdfr
78177633Sdfrstruct cmessage {
79177633Sdfr        struct cmsghdr cmsg;
80177633Sdfr        struct cmsgcred cmcred;
81177633Sdfr};
82177633Sdfr
83177633Sdfrstatic enum clnt_stat clnt_vc_call(CLIENT *, rpcproc_t, xdrproc_t, void *,
84177633Sdfr    xdrproc_t, void *, struct timeval);
85177633Sdfrstatic void clnt_vc_geterr(CLIENT *, struct rpc_err *);
86177633Sdfrstatic bool_t clnt_vc_freeres(CLIENT *, xdrproc_t, void *);
87177633Sdfrstatic void clnt_vc_abort(CLIENT *);
88177633Sdfrstatic bool_t clnt_vc_control(CLIENT *, u_int, void *);
89177633Sdfrstatic void clnt_vc_destroy(CLIENT *);
90177633Sdfrstatic bool_t time_not_ok(struct timeval *);
91177633Sdfrstatic void clnt_vc_soupcall(struct socket *so, void *arg, int waitflag);
92177633Sdfr
93177633Sdfrstatic struct clnt_ops clnt_vc_ops = {
94177633Sdfr	.cl_call =	clnt_vc_call,
95177633Sdfr	.cl_abort =	clnt_vc_abort,
96177633Sdfr	.cl_geterr =	clnt_vc_geterr,
97177633Sdfr	.cl_freeres =	clnt_vc_freeres,
98177633Sdfr	.cl_destroy =	clnt_vc_destroy,
99177633Sdfr	.cl_control =	clnt_vc_control
100177633Sdfr};
101177633Sdfr
102177633Sdfr/*
103177633Sdfr * A pending RPC request which awaits a reply.
104177633Sdfr */
105177633Sdfrstruct ct_request {
106177633Sdfr	TAILQ_ENTRY(ct_request) cr_link;
107177633Sdfr	uint32_t		cr_xid;		/* XID of request */
108177633Sdfr	struct mbuf		*cr_mrep;	/* reply received by upcall */
109177633Sdfr	int			cr_error;	/* any error from upcall */
110177633Sdfr};
111177633Sdfr
112177633SdfrTAILQ_HEAD(ct_request_list, ct_request);
113177633Sdfr
114177633Sdfrstruct ct_data {
115177633Sdfr	struct mtx	ct_lock;
116177633Sdfr	struct socket	*ct_socket;	/* connection socket */
117177633Sdfr	bool_t		ct_closeit;	/* close it on destroy */
118177633Sdfr	struct timeval	ct_wait;	/* wait interval in milliseconds */
119177633Sdfr	struct sockaddr_storage	ct_addr; /* remote addr */
120177633Sdfr	struct rpc_err	ct_error;
121177633Sdfr	uint32_t	ct_xid;
122177633Sdfr	char		ct_mcallc[MCALL_MSG_SIZE]; /* marshalled callmsg */
123177633Sdfr	size_t		ct_mpos;	/* pos after marshal */
124177633Sdfr	const char	*ct_waitchan;
125177633Sdfr	int		ct_waitflag;
126177633Sdfr	struct mbuf	*ct_record;	/* current reply record */
127177633Sdfr	size_t		ct_record_resid; /* how much left of reply to read */
128177633Sdfr	bool_t		ct_record_eor;	 /* true if reading last fragment */
129177633Sdfr	struct ct_request_list ct_pending;
130177633Sdfr};
131177633Sdfr
132177633Sdfrstatic const char clnt_vc_errstr[] = "%s : %s";
133177633Sdfrstatic const char clnt_vc_str[] = "clnt_vc_create";
134177633Sdfrstatic const char clnt_read_vc_str[] = "read_vc";
135177633Sdfrstatic const char __no_mem_str[] = "out of memory";
136177633Sdfr
137177633Sdfr/*
138177633Sdfr * Create a client handle for a connection.
139177633Sdfr * Default options are set, which the user can change using clnt_control()'s.
140177633Sdfr * The rpc/vc package does buffering similar to stdio, so the client
141177633Sdfr * must pick send and receive buffer sizes, 0 => use the default.
142177633Sdfr * NB: fd is copied into a private area.
143177633Sdfr * NB: The rpch->cl_auth is set null authentication. Caller may wish to
144177633Sdfr * set this something more useful.
145177633Sdfr *
146177633Sdfr * fd should be an open socket
147177633Sdfr */
148177633SdfrCLIENT *
149177633Sdfrclnt_vc_create(
150177633Sdfr	struct socket *so,		/* open file descriptor */
151177633Sdfr	struct sockaddr *raddr,		/* servers address */
152177633Sdfr	const rpcprog_t prog,		/* program number */
153177633Sdfr	const rpcvers_t vers,		/* version number */
154177633Sdfr	size_t sendsz,			/* buffer recv size */
155177633Sdfr	size_t recvsz)			/* buffer send size */
156177633Sdfr{
157177633Sdfr	CLIENT *cl;			/* client handle */
158177633Sdfr	struct ct_data *ct = NULL;	/* client handle */
159177633Sdfr	struct timeval now;
160177633Sdfr	struct rpc_msg call_msg;
161177633Sdfr	static uint32_t disrupt;
162177633Sdfr	struct __rpc_sockinfo si;
163177633Sdfr	XDR xdrs;
164177633Sdfr	int error;
165177633Sdfr
166177633Sdfr	if (disrupt == 0)
167177633Sdfr		disrupt = (uint32_t)(long)raddr;
168177633Sdfr
169177633Sdfr	cl = (CLIENT *)mem_alloc(sizeof (*cl));
170177633Sdfr	ct = (struct ct_data *)mem_alloc(sizeof (*ct));
171177633Sdfr
172177633Sdfr	mtx_init(&ct->ct_lock, "ct->ct_lock", NULL, MTX_DEF);
173177633Sdfr
174177633Sdfr	if ((so->so_state & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) {
175177633Sdfr		error = soconnect(so, raddr, curthread);
176177633Sdfr		if (error) {
177177633Sdfr			rpc_createerr.cf_stat = RPC_SYSTEMERROR;
178177633Sdfr			rpc_createerr.cf_error.re_errno = error;
179177633Sdfr			goto err;
180177633Sdfr		}
181177633Sdfr	}
182177633Sdfr
183177633Sdfr	if (!__rpc_socket2sockinfo(so, &si))
184177633Sdfr		goto err;
185177633Sdfr
186177633Sdfr	ct->ct_closeit = FALSE;
187177633Sdfr
188177633Sdfr	/*
189177633Sdfr	 * Set up private data struct
190177633Sdfr	 */
191177633Sdfr	ct->ct_socket = so;
192177633Sdfr	ct->ct_wait.tv_sec = -1;
193177633Sdfr	ct->ct_wait.tv_usec = -1;
194177633Sdfr	memcpy(&ct->ct_addr, raddr, raddr->sa_len);
195177633Sdfr
196177633Sdfr	/*
197177633Sdfr	 * Initialize call message
198177633Sdfr	 */
199177633Sdfr	getmicrotime(&now);
200177633Sdfr	ct->ct_xid = ((uint32_t)++disrupt) ^ __RPC_GETXID(&now);
201177633Sdfr	call_msg.rm_xid = ct->ct_xid;
202177633Sdfr	call_msg.rm_direction = CALL;
203177633Sdfr	call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
204177633Sdfr	call_msg.rm_call.cb_prog = (uint32_t)prog;
205177633Sdfr	call_msg.rm_call.cb_vers = (uint32_t)vers;
206177633Sdfr
207177633Sdfr	/*
208177633Sdfr	 * pre-serialize the static part of the call msg and stash it away
209177633Sdfr	 */
210177633Sdfr	xdrmem_create(&xdrs, ct->ct_mcallc, MCALL_MSG_SIZE,
211177633Sdfr	    XDR_ENCODE);
212177633Sdfr	if (! xdr_callhdr(&xdrs, &call_msg)) {
213177633Sdfr		if (ct->ct_closeit) {
214177633Sdfr			soclose(ct->ct_socket);
215177633Sdfr		}
216177633Sdfr		goto err;
217177633Sdfr	}
218177633Sdfr	ct->ct_mpos = XDR_GETPOS(&xdrs);
219177633Sdfr	XDR_DESTROY(&xdrs);
220177633Sdfr	ct->ct_waitchan = "rpcrecv";
221177633Sdfr	ct->ct_waitflag = 0;
222177633Sdfr
223177633Sdfr	/*
224177633Sdfr	 * Create a client handle which uses xdrrec for serialization
225177633Sdfr	 * and authnone for authentication.
226177633Sdfr	 */
227177633Sdfr	cl->cl_ops = &clnt_vc_ops;
228177633Sdfr	cl->cl_private = ct;
229177633Sdfr	cl->cl_auth = authnone_create();
230177633Sdfr	sendsz = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsz);
231177633Sdfr	recvsz = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsz);
232177633Sdfr
233177633Sdfr	SOCKBUF_LOCK(&ct->ct_socket->so_rcv);
234177633Sdfr	ct->ct_socket->so_upcallarg = ct;
235177633Sdfr	ct->ct_socket->so_upcall = clnt_vc_soupcall;
236177633Sdfr	ct->ct_socket->so_rcv.sb_flags |= SB_UPCALL;
237177633Sdfr	SOCKBUF_UNLOCK(&ct->ct_socket->so_rcv);
238177633Sdfr
239177633Sdfr	ct->ct_record = NULL;
240177633Sdfr	ct->ct_record_resid = 0;
241177633Sdfr	TAILQ_INIT(&ct->ct_pending);
242177633Sdfr	return (cl);
243177633Sdfr
244177633Sdfrerr:
245177633Sdfr	if (cl) {
246177633Sdfr		if (ct) {
247177633Sdfr			mem_free(ct, sizeof (struct ct_data));
248177633Sdfr		}
249177633Sdfr		if (cl)
250177633Sdfr			mem_free(cl, sizeof (CLIENT));
251177633Sdfr	}
252177633Sdfr	return ((CLIENT *)NULL);
253177633Sdfr}
254177633Sdfr
255177633Sdfrstatic enum clnt_stat
256177633Sdfrclnt_vc_call(
257177633Sdfr	CLIENT *cl,
258177633Sdfr	rpcproc_t proc,
259177633Sdfr	xdrproc_t xdr_args,
260177633Sdfr	void *args_ptr,
261177633Sdfr	xdrproc_t xdr_results,
262177633Sdfr	void *results_ptr,
263177633Sdfr	struct timeval utimeout)
264177633Sdfr{
265177633Sdfr	struct ct_data *ct = (struct ct_data *) cl->cl_private;
266177633Sdfr	XDR xdrs;
267177633Sdfr	struct rpc_msg reply_msg;
268177633Sdfr	bool_t ok;
269177633Sdfr	int nrefreshes = 2;		/* number of times to refresh cred */
270177633Sdfr	struct timeval timeout;
271177633Sdfr	uint32_t xid;
272177633Sdfr	struct mbuf *mreq = NULL;
273177633Sdfr	struct ct_request cr;
274177633Sdfr	int error;
275177633Sdfr
276177633Sdfr	mtx_lock(&ct->ct_lock);
277177633Sdfr
278177633Sdfr	cr.cr_mrep = NULL;
279177633Sdfr	cr.cr_error = 0;
280177633Sdfr
281177633Sdfr	if (ct->ct_wait.tv_usec == -1) {
282177633Sdfr		timeout = utimeout;	/* use supplied timeout */
283177633Sdfr	} else {
284177633Sdfr		timeout = ct->ct_wait;	/* use default timeout */
285177633Sdfr	}
286177633Sdfr
287177633Sdfrcall_again:
288177633Sdfr	mtx_assert(&ct->ct_lock, MA_OWNED);
289177633Sdfr
290177633Sdfr	ct->ct_xid++;
291177633Sdfr	xid = ct->ct_xid;
292177633Sdfr
293177633Sdfr	mtx_unlock(&ct->ct_lock);
294177633Sdfr
295177633Sdfr	/*
296177633Sdfr	 * Leave space to pre-pend the record mark.
297177633Sdfr	 */
298177633Sdfr	MGETHDR(mreq, M_WAIT, MT_DATA);
299177633Sdfr	MCLGET(mreq, M_WAIT);
300177633Sdfr	mreq->m_len = 0;
301177633Sdfr	mreq->m_data += sizeof(uint32_t);
302177633Sdfr	m_append(mreq, ct->ct_mpos, ct->ct_mcallc);
303177633Sdfr
304177633Sdfr	/*
305177633Sdfr	 * The XID is the first thing in the request.
306177633Sdfr	 */
307177633Sdfr	*mtod(mreq, uint32_t *) = htonl(xid);
308177633Sdfr
309177633Sdfr	xdrmbuf_create(&xdrs, mreq, XDR_ENCODE);
310177633Sdfr
311177633Sdfr	ct->ct_error.re_status = RPC_SUCCESS;
312177633Sdfr
313177633Sdfr	if ((! XDR_PUTINT32(&xdrs, &proc)) ||
314177633Sdfr	    (! AUTH_MARSHALL(cl->cl_auth, &xdrs)) ||
315177633Sdfr	    (! (*xdr_args)(&xdrs, args_ptr))) {
316177633Sdfr		if (ct->ct_error.re_status == RPC_SUCCESS)
317177633Sdfr			ct->ct_error.re_status = RPC_CANTENCODEARGS;
318177633Sdfr		m_freem(mreq);
319177633Sdfr		return (ct->ct_error.re_status);
320177633Sdfr	}
321177633Sdfr	m_fixhdr(mreq);
322177633Sdfr
323177633Sdfr	/*
324177633Sdfr	 * Prepend a record marker containing the packet length.
325177633Sdfr	 */
326177633Sdfr	M_PREPEND(mreq, sizeof(uint32_t), M_WAIT);
327177633Sdfr	*mtod(mreq, uint32_t *) =
328177633Sdfr		htonl(0x80000000 | (mreq->m_pkthdr.len - sizeof(uint32_t)));
329177633Sdfr
330177633Sdfr	cr.cr_xid = xid;
331177633Sdfr	mtx_lock(&ct->ct_lock);
332177633Sdfr	TAILQ_INSERT_TAIL(&ct->ct_pending, &cr, cr_link);
333177633Sdfr	mtx_unlock(&ct->ct_lock);
334177633Sdfr
335177633Sdfr	/*
336177633Sdfr	 * sosend consumes mreq.
337177633Sdfr	 */
338177633Sdfr	error = sosend(ct->ct_socket, NULL, NULL, mreq, NULL, 0, curthread);
339177633Sdfr	mreq = NULL;
340177633Sdfr
341177633Sdfr	reply_msg.acpted_rply.ar_verf = _null_auth;
342177633Sdfr	reply_msg.acpted_rply.ar_results.where = results_ptr;
343177633Sdfr	reply_msg.acpted_rply.ar_results.proc = xdr_results;
344177633Sdfr
345177633Sdfr	mtx_lock(&ct->ct_lock);
346177633Sdfr
347177633Sdfr	if (error) {
348177633Sdfr		TAILQ_REMOVE(&ct->ct_pending, &cr, cr_link);
349177633Sdfr
350177633Sdfr		ct->ct_error.re_errno = error;
351177633Sdfr		ct->ct_error.re_status = RPC_CANTSEND;
352177633Sdfr		goto out;
353177633Sdfr	}
354177633Sdfr
355177633Sdfr	/*
356177633Sdfr	 * Check to see if we got an upcall while waiting for the
357177633Sdfr	 * lock. In both these cases, the request has been removed
358177633Sdfr	 * from ct->ct_pending.
359177633Sdfr	 */
360177633Sdfr	if (cr.cr_error) {
361177633Sdfr		ct->ct_error.re_errno = cr.cr_error;
362177633Sdfr		ct->ct_error.re_status = RPC_CANTRECV;
363177633Sdfr		goto out;
364177633Sdfr	}
365177633Sdfr	if (cr.cr_mrep) {
366177633Sdfr		goto got_reply;
367177633Sdfr	}
368177633Sdfr
369177633Sdfr	/*
370177633Sdfr	 * Hack to provide rpc-based message passing
371177633Sdfr	 */
372177633Sdfr	if (timeout.tv_sec == 0 && timeout.tv_usec == 0) {
373177633Sdfr		if (cr.cr_xid)
374177633Sdfr			TAILQ_REMOVE(&ct->ct_pending, &cr, cr_link);
375177633Sdfr		ct->ct_error.re_status = RPC_TIMEDOUT;
376177633Sdfr		goto out;
377177633Sdfr	}
378177633Sdfr
379177633Sdfr	error = msleep(&cr, &ct->ct_lock, ct->ct_waitflag, ct->ct_waitchan,
380177633Sdfr	    tvtohz(&timeout));
381177633Sdfr
382177633Sdfr	if (error) {
383177633Sdfr		/*
384177633Sdfr		 * The sleep returned an error so our request is still
385177633Sdfr		 * on the list. Turn the error code into an
386177633Sdfr		 * appropriate client status.
387177633Sdfr		 */
388177633Sdfr		if (cr.cr_xid)
389177633Sdfr			TAILQ_REMOVE(&ct->ct_pending, &cr, cr_link);
390177633Sdfr		ct->ct_error.re_errno = error;
391177633Sdfr		switch (error) {
392177633Sdfr		case EINTR:
393177633Sdfr			ct->ct_error.re_status = RPC_INTR;
394177633Sdfr			break;
395177633Sdfr		case EWOULDBLOCK:
396177633Sdfr			ct->ct_error.re_status = RPC_TIMEDOUT;
397177633Sdfr			break;
398177633Sdfr		default:
399177633Sdfr			ct->ct_error.re_status = RPC_CANTRECV;
400177633Sdfr		}
401177633Sdfr		goto out;
402177633Sdfr	} else {
403177633Sdfr		/*
404177633Sdfr		 * We were woken up by the upcall.  If the
405177633Sdfr		 * upcall had a receive error, report that,
406177633Sdfr		 * otherwise we have a reply.
407177633Sdfr		 */
408177633Sdfr		if (cr.cr_error) {
409177633Sdfr			ct->ct_error.re_errno = cr.cr_error;
410177633Sdfr			ct->ct_error.re_status = RPC_CANTRECV;
411177633Sdfr			goto out;
412177633Sdfr		}
413177633Sdfr	}
414177633Sdfr
415177633Sdfrgot_reply:
416177633Sdfr	/*
417177633Sdfr	 * Now decode and validate the response. We need to drop the
418177633Sdfr	 * lock since xdr_replymsg may end up sleeping in malloc.
419177633Sdfr	 */
420177633Sdfr	mtx_unlock(&ct->ct_lock);
421177633Sdfr
422177633Sdfr	xdrmbuf_create(&xdrs, cr.cr_mrep, XDR_DECODE);
423177633Sdfr	ok = xdr_replymsg(&xdrs, &reply_msg);
424177633Sdfr	XDR_DESTROY(&xdrs);
425177633Sdfr	cr.cr_mrep = NULL;
426177633Sdfr
427177633Sdfr	mtx_lock(&ct->ct_lock);
428177633Sdfr
429177633Sdfr	if (ok) {
430177633Sdfr		if ((reply_msg.rm_reply.rp_stat == MSG_ACCEPTED) &&
431177633Sdfr			(reply_msg.acpted_rply.ar_stat == SUCCESS))
432177633Sdfr			ct->ct_error.re_status = RPC_SUCCESS;
433177633Sdfr		else
434177633Sdfr			_seterr_reply(&reply_msg, &(ct->ct_error));
435177633Sdfr
436177633Sdfr		if (ct->ct_error.re_status == RPC_SUCCESS) {
437177633Sdfr			if (! AUTH_VALIDATE(cl->cl_auth,
438177633Sdfr					    &reply_msg.acpted_rply.ar_verf)) {
439177633Sdfr				ct->ct_error.re_status = RPC_AUTHERROR;
440177633Sdfr				ct->ct_error.re_why = AUTH_INVALIDRESP;
441177633Sdfr			}
442177633Sdfr			if (reply_msg.acpted_rply.ar_verf.oa_base != NULL) {
443177633Sdfr				xdrs.x_op = XDR_FREE;
444177633Sdfr				(void) xdr_opaque_auth(&xdrs,
445177633Sdfr					&(reply_msg.acpted_rply.ar_verf));
446177633Sdfr			}
447177633Sdfr		}		/* end successful completion */
448177633Sdfr		/*
449177633Sdfr		 * If unsuccesful AND error is an authentication error
450177633Sdfr		 * then refresh credentials and try again, else break
451177633Sdfr		 */
452177633Sdfr		else if (ct->ct_error.re_status == RPC_AUTHERROR)
453177633Sdfr			/* maybe our credentials need to be refreshed ... */
454177633Sdfr			if (nrefreshes > 0 &&
455177633Sdfr			    AUTH_REFRESH(cl->cl_auth, &reply_msg)) {
456177633Sdfr				nrefreshes--;
457177633Sdfr				goto call_again;
458177633Sdfr			}
459177633Sdfr		/* end of unsuccessful completion */
460177633Sdfr	}	/* end of valid reply message */
461177633Sdfr	else {
462177633Sdfr		ct->ct_error.re_status = RPC_CANTDECODERES;
463177633Sdfr	}
464177633Sdfrout:
465177633Sdfr	mtx_assert(&ct->ct_lock, MA_OWNED);
466177633Sdfr
467177633Sdfr	if (mreq)
468177633Sdfr		m_freem(mreq);
469177633Sdfr	if (cr.cr_mrep)
470177633Sdfr		m_freem(cr.cr_mrep);
471177633Sdfr
472177633Sdfr	mtx_unlock(&ct->ct_lock);
473177633Sdfr	return (ct->ct_error.re_status);
474177633Sdfr}
475177633Sdfr
476177633Sdfrstatic void
477177633Sdfrclnt_vc_geterr(CLIENT *cl, struct rpc_err *errp)
478177633Sdfr{
479177633Sdfr	struct ct_data *ct = (struct ct_data *) cl->cl_private;
480177633Sdfr
481177633Sdfr	*errp = ct->ct_error;
482177633Sdfr}
483177633Sdfr
484177633Sdfrstatic bool_t
485177633Sdfrclnt_vc_freeres(CLIENT *cl, xdrproc_t xdr_res, void *res_ptr)
486177633Sdfr{
487177633Sdfr	XDR xdrs;
488177633Sdfr	bool_t dummy;
489177633Sdfr
490177633Sdfr	xdrs.x_op = XDR_FREE;
491177633Sdfr	dummy = (*xdr_res)(&xdrs, res_ptr);
492177633Sdfr
493177633Sdfr	return (dummy);
494177633Sdfr}
495177633Sdfr
496177633Sdfr/*ARGSUSED*/
497177633Sdfrstatic void
498177633Sdfrclnt_vc_abort(CLIENT *cl)
499177633Sdfr{
500177633Sdfr}
501177633Sdfr
502177633Sdfrstatic bool_t
503177633Sdfrclnt_vc_control(CLIENT *cl, u_int request, void *info)
504177633Sdfr{
505177633Sdfr	struct ct_data *ct = (struct ct_data *)cl->cl_private;
506177633Sdfr	void *infop = info;
507177633Sdfr
508177633Sdfr	mtx_lock(&ct->ct_lock);
509177633Sdfr
510177633Sdfr	switch (request) {
511177633Sdfr	case CLSET_FD_CLOSE:
512177633Sdfr		ct->ct_closeit = TRUE;
513177633Sdfr		mtx_unlock(&ct->ct_lock);
514177633Sdfr		return (TRUE);
515177633Sdfr	case CLSET_FD_NCLOSE:
516177633Sdfr		ct->ct_closeit = FALSE;
517177633Sdfr		mtx_unlock(&ct->ct_lock);
518177633Sdfr		return (TRUE);
519177633Sdfr	default:
520177633Sdfr		break;
521177633Sdfr	}
522177633Sdfr
523177633Sdfr	/* for other requests which use info */
524177633Sdfr	if (info == NULL) {
525177633Sdfr		mtx_unlock(&ct->ct_lock);
526177633Sdfr		return (FALSE);
527177633Sdfr	}
528177633Sdfr	switch (request) {
529177633Sdfr	case CLSET_TIMEOUT:
530177633Sdfr		if (time_not_ok((struct timeval *)info)) {
531177633Sdfr			mtx_unlock(&ct->ct_lock);
532177633Sdfr			return (FALSE);
533177633Sdfr		}
534177633Sdfr		ct->ct_wait = *(struct timeval *)infop;
535177633Sdfr		break;
536177633Sdfr	case CLGET_TIMEOUT:
537177633Sdfr		*(struct timeval *)infop = ct->ct_wait;
538177633Sdfr		break;
539177633Sdfr	case CLGET_SERVER_ADDR:
540177633Sdfr		(void) memcpy(info, &ct->ct_addr, (size_t)ct->ct_addr.ss_len);
541177633Sdfr		break;
542177633Sdfr	case CLGET_SVC_ADDR:
543177633Sdfr		/*
544177633Sdfr		 * Slightly different semantics to userland - we use
545177633Sdfr		 * sockaddr instead of netbuf.
546177633Sdfr		 */
547177633Sdfr		memcpy(info, &ct->ct_addr, ct->ct_addr.ss_len);
548177633Sdfr		break;
549177633Sdfr	case CLSET_SVC_ADDR:		/* set to new address */
550177633Sdfr		mtx_unlock(&ct->ct_lock);
551177633Sdfr		return (FALSE);
552177633Sdfr	case CLGET_XID:
553177633Sdfr		*(uint32_t *)info = ct->ct_xid;
554177633Sdfr		break;
555177633Sdfr	case CLSET_XID:
556177633Sdfr		/* This will set the xid of the NEXT call */
557177633Sdfr		/* decrement by 1 as clnt_vc_call() increments once */
558177633Sdfr		ct->ct_xid = *(uint32_t *)info - 1;
559177633Sdfr		break;
560177633Sdfr	case CLGET_VERS:
561177633Sdfr		/*
562177633Sdfr		 * This RELIES on the information that, in the call body,
563177633Sdfr		 * the version number field is the fifth field from the
564177633Sdfr		 * begining of the RPC header. MUST be changed if the
565177633Sdfr		 * call_struct is changed
566177633Sdfr		 */
567177633Sdfr		*(uint32_t *)info =
568177633Sdfr		    ntohl(*(uint32_t *)(void *)(ct->ct_mcallc +
569177633Sdfr		    4 * BYTES_PER_XDR_UNIT));
570177633Sdfr		break;
571177633Sdfr
572177633Sdfr	case CLSET_VERS:
573177633Sdfr		*(uint32_t *)(void *)(ct->ct_mcallc +
574177633Sdfr		    4 * BYTES_PER_XDR_UNIT) =
575177633Sdfr		    htonl(*(uint32_t *)info);
576177633Sdfr		break;
577177633Sdfr
578177633Sdfr	case CLGET_PROG:
579177633Sdfr		/*
580177633Sdfr		 * This RELIES on the information that, in the call body,
581177633Sdfr		 * the program number field is the fourth field from the
582177633Sdfr		 * begining of the RPC header. MUST be changed if the
583177633Sdfr		 * call_struct is changed
584177633Sdfr		 */
585177633Sdfr		*(uint32_t *)info =
586177633Sdfr		    ntohl(*(uint32_t *)(void *)(ct->ct_mcallc +
587177633Sdfr		    3 * BYTES_PER_XDR_UNIT));
588177633Sdfr		break;
589177633Sdfr
590177633Sdfr	case CLSET_PROG:
591177633Sdfr		*(uint32_t *)(void *)(ct->ct_mcallc +
592177633Sdfr		    3 * BYTES_PER_XDR_UNIT) =
593177633Sdfr		    htonl(*(uint32_t *)info);
594177633Sdfr		break;
595177633Sdfr
596177633Sdfr	case CLSET_WAITCHAN:
597177633Sdfr		ct->ct_waitchan = *(const char **)info;
598177633Sdfr		break;
599177633Sdfr
600177633Sdfr	case CLGET_WAITCHAN:
601177633Sdfr		*(const char **) info = ct->ct_waitchan;
602177633Sdfr		break;
603177633Sdfr
604177633Sdfr	case CLSET_INTERRUPTIBLE:
605177633Sdfr		if (*(int *) info)
606177633Sdfr			ct->ct_waitflag = PCATCH;
607177633Sdfr		else
608177633Sdfr			ct->ct_waitflag = 0;
609177633Sdfr		break;
610177633Sdfr
611177633Sdfr	case CLGET_INTERRUPTIBLE:
612177633Sdfr		if (ct->ct_waitflag)
613177633Sdfr			*(int *) info = TRUE;
614177633Sdfr		else
615177633Sdfr			*(int *) info = FALSE;
616177633Sdfr		break;
617177633Sdfr
618177633Sdfr	default:
619177633Sdfr		mtx_unlock(&ct->ct_lock);
620177633Sdfr		return (FALSE);
621177633Sdfr	}
622177633Sdfr
623177633Sdfr	mtx_unlock(&ct->ct_lock);
624177633Sdfr	return (TRUE);
625177633Sdfr}
626177633Sdfr
627177633Sdfrstatic void
628177633Sdfrclnt_vc_destroy(CLIENT *cl)
629177633Sdfr{
630177633Sdfr	struct ct_data *ct = (struct ct_data *) cl->cl_private;
631177633Sdfr	struct socket *so = NULL;
632177633Sdfr
633177633Sdfr	mtx_lock(&ct->ct_lock);
634177633Sdfr
635177633Sdfr	if (ct->ct_socket) {
636177633Sdfr		SOCKBUF_LOCK(&ct->ct_socket->so_rcv);
637177633Sdfr		ct->ct_socket->so_upcallarg = NULL;
638177633Sdfr		ct->ct_socket->so_upcall = NULL;
639177633Sdfr		ct->ct_socket->so_rcv.sb_flags &= ~SB_UPCALL;
640177633Sdfr		SOCKBUF_UNLOCK(&ct->ct_socket->so_rcv);
641177633Sdfr
642177633Sdfr		KASSERT(!TAILQ_FIRST(&ct->ct_pending),
643177633Sdfr		    ("Destroying RPC client with pending RPC requests"));
644177633Sdfr
645177633Sdfr		if (ct->ct_closeit) {
646177633Sdfr			so = ct->ct_socket;
647177633Sdfr		}
648177633Sdfr	}
649177633Sdfr
650177633Sdfr	mtx_unlock(&ct->ct_lock);
651177633Sdfr
652177633Sdfr	mtx_destroy(&ct->ct_lock);
653177633Sdfr	if (so) {
654177633Sdfr		soshutdown(so, SHUT_WR);
655177633Sdfr		soclose(so);
656177633Sdfr	}
657177633Sdfr	mem_free(ct, sizeof(struct ct_data));
658177633Sdfr	mem_free(cl, sizeof(CLIENT));
659177633Sdfr}
660177633Sdfr
661177633Sdfr/*
662177633Sdfr * Make sure that the time is not garbage.   -1 value is disallowed.
663177633Sdfr * Note this is different from time_not_ok in clnt_dg.c
664177633Sdfr */
665177633Sdfrstatic bool_t
666177633Sdfrtime_not_ok(struct timeval *t)
667177633Sdfr{
668177633Sdfr	return (t->tv_sec <= -1 || t->tv_sec > 100000000 ||
669177633Sdfr		t->tv_usec <= -1 || t->tv_usec > 1000000);
670177633Sdfr}
671177633Sdfr
672177633Sdfrvoid
673177633Sdfrclnt_vc_soupcall(struct socket *so, void *arg, int waitflag)
674177633Sdfr{
675177633Sdfr	struct ct_data *ct = (struct ct_data *) arg;
676177633Sdfr	struct uio uio;
677177633Sdfr	struct mbuf *m;
678177633Sdfr	struct ct_request *cr;
679177633Sdfr	int error, rcvflag, foundreq;
680177633Sdfr	uint32_t xid, header;
681177633Sdfr
682177633Sdfr	uio.uio_td = curthread;
683177633Sdfr	do {
684177633Sdfr		/*
685177633Sdfr		 * If ct_record_resid is zero, we are waiting for a
686177633Sdfr		 * record mark.
687177633Sdfr		 */
688177633Sdfr		if (ct->ct_record_resid == 0) {
689177633Sdfr			bool_t do_read;
690177633Sdfr
691177633Sdfr			/*
692177633Sdfr			 * Make sure there is either a whole record
693177633Sdfr			 * mark in the buffer or there is some other
694177633Sdfr			 * error condition
695177633Sdfr			 */
696177633Sdfr			do_read = FALSE;
697177633Sdfr			SOCKBUF_LOCK(&so->so_rcv);
698177633Sdfr			if (so->so_rcv.sb_cc >= sizeof(uint32_t)
699177633Sdfr			    || (so->so_rcv.sb_state & SBS_CANTRCVMORE)
700177633Sdfr			    || so->so_error)
701177633Sdfr				do_read = TRUE;
702177633Sdfr			SOCKBUF_UNLOCK(&so->so_rcv);
703177633Sdfr
704177633Sdfr			if (!do_read)
705177633Sdfr				return;
706177633Sdfr
707177633Sdfr			uio.uio_resid = sizeof(uint32_t);
708177633Sdfr			m = NULL;
709177633Sdfr			rcvflag = MSG_DONTWAIT | MSG_SOCALLBCK;
710177633Sdfr			error = soreceive(so, NULL, &uio, &m, NULL, &rcvflag);
711177633Sdfr
712177633Sdfr			if (error == EWOULDBLOCK)
713177633Sdfr				break;
714177633Sdfr
715177633Sdfr			/*
716177633Sdfr			 * If there was an error, wake up all pending
717177633Sdfr			 * requests.
718177633Sdfr			 */
719177633Sdfr			if (error || uio.uio_resid > 0) {
720177633Sdfr			wakeup_all:
721177633Sdfr				mtx_lock(&ct->ct_lock);
722177633Sdfr				if (!error) {
723177633Sdfr					/*
724177633Sdfr					 * We must have got EOF trying
725177633Sdfr					 * to read from the stream.
726177633Sdfr					 */
727177633Sdfr					error = ECONNRESET;
728177633Sdfr				}
729177633Sdfr				ct->ct_error.re_status = RPC_CANTRECV;
730177633Sdfr				ct->ct_error.re_errno = error;
731177633Sdfr				TAILQ_FOREACH(cr, &ct->ct_pending, cr_link) {
732177633Sdfr					cr->cr_error = error;
733177633Sdfr					wakeup(cr);
734177633Sdfr				}
735177633Sdfr				TAILQ_INIT(&ct->ct_pending);
736177633Sdfr				mtx_unlock(&ct->ct_lock);
737177633Sdfr				break;
738177633Sdfr			}
739177633Sdfr			memcpy(&header, mtod(m, uint32_t *), sizeof(uint32_t));
740177633Sdfr			header = ntohl(header);
741177633Sdfr			ct->ct_record = NULL;
742177633Sdfr			ct->ct_record_resid = header & 0x7fffffff;
743177633Sdfr			ct->ct_record_eor = ((header & 0x80000000) != 0);
744177633Sdfr			m_freem(m);
745177633Sdfr		} else {
746177633Sdfr			/*
747177633Sdfr			 * We have the record mark. Read as much as
748177633Sdfr			 * the socket has buffered up to the end of
749177633Sdfr			 * this record.
750177633Sdfr			 */
751177633Sdfr			uio.uio_resid = ct->ct_record_resid;
752177633Sdfr			m = NULL;
753177633Sdfr			rcvflag = MSG_DONTWAIT | MSG_SOCALLBCK;
754177633Sdfr			error = soreceive(so, NULL, &uio, &m, NULL, &rcvflag);
755177633Sdfr
756177633Sdfr			if (error == EWOULDBLOCK)
757177633Sdfr				break;
758177633Sdfr
759177633Sdfr			if (error || uio.uio_resid == ct->ct_record_resid)
760177633Sdfr				goto wakeup_all;
761177633Sdfr
762177633Sdfr			/*
763177633Sdfr			 * If we have part of the record already,
764177633Sdfr			 * chain this bit onto the end.
765177633Sdfr			 */
766177633Sdfr			if (ct->ct_record)
767177633Sdfr				m_last(ct->ct_record)->m_next = m;
768177633Sdfr			else
769177633Sdfr				ct->ct_record = m;
770177633Sdfr
771177633Sdfr			ct->ct_record_resid = uio.uio_resid;
772177633Sdfr
773177633Sdfr			/*
774177633Sdfr			 * If we have the entire record, see if we can
775177633Sdfr			 * match it to a request.
776177633Sdfr			 */
777177633Sdfr			if (ct->ct_record_resid == 0
778177633Sdfr			    && ct->ct_record_eor) {
779177633Sdfr				/*
780177633Sdfr				 * The XID is in the first uint32_t of
781177633Sdfr				 * the reply.
782177633Sdfr				 */
783177633Sdfr				ct->ct_record =
784177633Sdfr					m_pullup(ct->ct_record, sizeof(xid));
785177633Sdfr				if (!ct->ct_record)
786177633Sdfr					break;
787177633Sdfr				memcpy(&xid,
788177633Sdfr				    mtod(ct->ct_record, uint32_t *),
789177633Sdfr				    sizeof(uint32_t));
790177633Sdfr				xid = ntohl(xid);
791177633Sdfr
792177633Sdfr				mtx_lock(&ct->ct_lock);
793177633Sdfr				foundreq = 0;
794177633Sdfr				TAILQ_FOREACH(cr, &ct->ct_pending, cr_link) {
795177633Sdfr					if (cr->cr_xid == xid) {
796177633Sdfr						/*
797177633Sdfr						 * This one
798177633Sdfr						 * matches. We snip it
799177633Sdfr						 * out of the pending
800177633Sdfr						 * list and leave the
801177633Sdfr						 * reply mbuf in
802177633Sdfr						 * cr->cr_mrep. Set
803177633Sdfr						 * the XID to zero so
804177633Sdfr						 * that clnt_vc_call
805177633Sdfr						 * can know not to
806177633Sdfr						 * repeat the
807177633Sdfr						 * TAILQ_REMOVE.
808177633Sdfr						 */
809177633Sdfr						TAILQ_REMOVE(&ct->ct_pending,
810177633Sdfr						    cr, cr_link);
811177633Sdfr						cr->cr_xid = 0;
812177633Sdfr						cr->cr_mrep = ct->ct_record;
813177633Sdfr						cr->cr_error = 0;
814177633Sdfr						foundreq = 1;
815177633Sdfr						wakeup(cr);
816177633Sdfr						break;
817177633Sdfr					}
818177633Sdfr				}
819177633Sdfr				mtx_unlock(&ct->ct_lock);
820177633Sdfr
821177633Sdfr				if (!foundreq)
822177633Sdfr					m_freem(ct->ct_record);
823177633Sdfr				ct->ct_record = NULL;
824177633Sdfr			}
825177633Sdfr		}
826177633Sdfr	} while (m);
827177633Sdfr}
828