clnt_rc.c revision 177633
1/*-
2 * Copyright (c) 2008 Isilon Inc http://www.isilon.com/
3 * Authors: Doug Rabson <dfr@rabson.org>
4 * Developed with Red Inc: Alfred Perlstein <alfred@freebsd.org>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: head/sys/rpc/clnt_rc.c 177633 2008-03-26 15:23:12Z dfr $");
30
31#include <sys/param.h>
32#include <sys/systm.h>
33#include <sys/lock.h>
34#include <sys/malloc.h>
35#include <sys/mbuf.h>
36#include <sys/mutex.h>
37#include <sys/pcpu.h>
38#include <sys/proc.h>
39#include <sys/socket.h>
40#include <sys/socketvar.h>
41#include <sys/time.h>
42#include <sys/uio.h>
43
44#include <rpc/rpc.h>
45#include "rpc_com.h"
46
47static enum clnt_stat clnt_reconnect_call(CLIENT *, rpcproc_t,
48    xdrproc_t, void *, xdrproc_t, void *, struct timeval);
49static void clnt_reconnect_geterr(CLIENT *, struct rpc_err *);
50static bool_t clnt_reconnect_freeres(CLIENT *, xdrproc_t, void *);
51static void clnt_reconnect_abort(CLIENT *);
52static bool_t clnt_reconnect_control(CLIENT *, u_int, void *);
53static void clnt_reconnect_destroy(CLIENT *);
54
55static struct clnt_ops clnt_reconnect_ops = {
56	.cl_call =	clnt_reconnect_call,
57	.cl_abort =	clnt_reconnect_abort,
58	.cl_geterr =	clnt_reconnect_geterr,
59	.cl_freeres =	clnt_reconnect_freeres,
60	.cl_destroy =	clnt_reconnect_destroy,
61	.cl_control =	clnt_reconnect_control
62};
63
64struct rc_data {
65	struct sockaddr_storage	rc_addr; /* server address */
66	struct netconfig*	rc_nconf; /* network type */
67	rpcprog_t		rc_prog;  /* program number */
68	rpcvers_t		rc_vers;  /* version number */
69	size_t			rc_sendsz;
70	size_t			rc_recvsz;
71	struct timeval		rc_timeout;
72	struct timeval		rc_retry;
73	const char		*rc_waitchan;
74	int			rc_intr;
75	CLIENT*			rc_client; /* underlying RPC client */
76};
77
78CLIENT *
79clnt_reconnect_create(
80	struct netconfig *nconf,	/* network type */
81	struct sockaddr *svcaddr,	/* servers address */
82	rpcprog_t program,		/* program number */
83	rpcvers_t version,		/* version number */
84	size_t sendsz,			/* buffer recv size */
85	size_t recvsz)			/* buffer send size */
86{
87	CLIENT *cl = NULL;		/* client handle */
88	struct rc_data *rc = NULL;	/* private data */
89
90	if (svcaddr == NULL) {
91		rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
92		return (NULL);
93	}
94
95	cl = mem_alloc(sizeof (CLIENT));
96	rc = mem_alloc(sizeof (*rc));
97	(void) memcpy(&rc->rc_addr, svcaddr, (size_t)svcaddr->sa_len);
98	rc->rc_nconf = nconf;
99	rc->rc_prog = program;
100	rc->rc_vers = version;
101	rc->rc_sendsz = sendsz;
102	rc->rc_recvsz = recvsz;
103	rc->rc_timeout.tv_sec = -1;
104	rc->rc_timeout.tv_usec = -1;
105	rc->rc_retry.tv_sec = 15;
106	rc->rc_retry.tv_usec = 0;
107	rc->rc_waitchan = "rpcrecv";
108	rc->rc_intr = 0;
109	rc->rc_client = NULL;
110
111	cl->cl_ops = &clnt_reconnect_ops;
112	cl->cl_private = (caddr_t)(void *)rc;
113	cl->cl_auth = authnone_create();
114	cl->cl_tp = NULL;
115	cl->cl_netid = NULL;
116	return (cl);
117}
118
119static enum clnt_stat
120clnt_reconnect_connect(CLIENT *cl)
121{
122	struct rc_data *rc = (struct rc_data *)cl->cl_private;
123	struct socket *so;
124	int one = 1;
125
126	so = __rpc_nconf2socket(rc->rc_nconf);
127	if (!so) {
128		rpc_createerr.cf_stat = RPC_TLIERROR;
129		rpc_createerr.cf_error.re_errno = 0;
130		return (RPC_TLIERROR);
131	}
132
133	if (rc->rc_nconf->nc_semantics == NC_TPI_CLTS)
134		rc->rc_client = clnt_dg_create(so,
135		    (struct sockaddr *) &rc->rc_addr, rc->rc_prog, rc->rc_vers,
136		    rc->rc_sendsz, rc->rc_recvsz);
137	else
138		rc->rc_client = clnt_vc_create(so,
139		    (struct sockaddr *) &rc->rc_addr, rc->rc_prog, rc->rc_vers,
140		    rc->rc_sendsz, rc->rc_recvsz);
141
142	CLNT_CONTROL(rc->rc_client, CLSET_FD_CLOSE, 0);
143	CLNT_CONTROL(rc->rc_client, CLSET_CONNECT, &one);
144	CLNT_CONTROL(rc->rc_client, CLSET_TIMEOUT, &rc->rc_timeout);
145	CLNT_CONTROL(rc->rc_client, CLSET_RETRY_TIMEOUT, &rc->rc_retry);
146	CLNT_CONTROL(rc->rc_client, CLSET_WAITCHAN, &rc->rc_waitchan);
147	CLNT_CONTROL(rc->rc_client, CLSET_INTERRUPTIBLE, &rc->rc_intr);
148
149	return (RPC_SUCCESS);
150}
151
152static enum clnt_stat
153clnt_reconnect_call(
154	CLIENT	*cl,			/* client handle */
155	rpcproc_t	proc,		/* procedure number */
156	xdrproc_t	xargs,		/* xdr routine for args */
157	void		*argsp,		/* pointer to args */
158	xdrproc_t	xresults,	/* xdr routine for results */
159	void		*resultsp,	/* pointer to results */
160	struct timeval	utimeout)	/* seconds to wait before giving up */
161{
162	struct rc_data *rc = (struct rc_data *)cl->cl_private;
163	enum clnt_stat stat;
164
165	do {
166		if (!rc->rc_client)
167			clnt_reconnect_connect(cl);
168
169		stat = CLNT_CALL(rc->rc_client, proc, xargs, argsp,
170		    xresults, resultsp, utimeout);
171
172		if (stat == RPC_TIMEDOUT) {
173			/*
174			 * Check for async send misfeature for NLM
175			 * protocol.
176			 */
177			if ((rc->rc_timeout.tv_sec == 0
178				&& rc->rc_timeout.tv_usec == 0)
179			    || (rc->rc_timeout.tv_sec == -1
180				&& utimeout.tv_sec == 0
181				&& utimeout.tv_usec == 0))
182				break;
183		}
184
185		if (stat == RPC_INTR)
186			break;
187
188		if (stat != RPC_SUCCESS) {
189			CLNT_DESTROY(rc->rc_client);
190			rc->rc_client = NULL;
191		}
192	} while (stat != RPC_SUCCESS);
193
194	return (stat);
195}
196
197static void
198clnt_reconnect_geterr(CLIENT *cl, struct rpc_err *errp)
199{
200	struct rc_data *rc = (struct rc_data *)cl->cl_private;
201
202	if (rc->rc_client)
203		CLNT_GETERR(rc->rc_client, errp);
204	else
205		memset(errp, 0, sizeof(*errp));
206}
207
208static bool_t
209clnt_reconnect_freeres(CLIENT *cl, xdrproc_t xdr_res, void *res_ptr)
210{
211	struct rc_data *rc = (struct rc_data *)cl->cl_private;
212
213	return (CLNT_FREERES(rc->rc_client, xdr_res, res_ptr));
214}
215
216/*ARGSUSED*/
217static void
218clnt_reconnect_abort(CLIENT *h)
219{
220}
221
222static bool_t
223clnt_reconnect_control(CLIENT *cl, u_int request, void *info)
224{
225	struct rc_data *rc = (struct rc_data *)cl->cl_private;
226
227	if (info == NULL) {
228		return (FALSE);
229	}
230	switch (request) {
231	case CLSET_TIMEOUT:
232		rc->rc_timeout = *(struct timeval *)info;
233		if (rc->rc_client)
234			CLNT_CONTROL(rc->rc_client, request, info);
235		break;
236
237	case CLGET_TIMEOUT:
238		*(struct timeval *)info = rc->rc_timeout;
239		break;
240
241	case CLSET_RETRY_TIMEOUT:
242		rc->rc_retry = *(struct timeval *)info;
243		if (rc->rc_client)
244			CLNT_CONTROL(rc->rc_client, request, info);
245		break;
246
247	case CLGET_RETRY_TIMEOUT:
248		*(struct timeval *)info = rc->rc_retry;
249		break;
250
251	case CLGET_VERS:
252		*(uint32_t *)info = rc->rc_vers;
253		break;
254
255	case CLSET_VERS:
256		rc->rc_vers = *(uint32_t *) info;
257		if (rc->rc_client)
258			CLNT_CONTROL(rc->rc_client, CLSET_VERS, info);
259		break;
260
261	case CLGET_PROG:
262		*(uint32_t *)info = rc->rc_prog;
263		break;
264
265	case CLSET_PROG:
266		rc->rc_prog = *(uint32_t *) info;
267		if (rc->rc_client)
268			CLNT_CONTROL(rc->rc_client, request, info);
269		break;
270
271	case CLSET_WAITCHAN:
272		rc->rc_waitchan = *(const char **)info;
273		if (rc->rc_client)
274			CLNT_CONTROL(rc->rc_client, request, info);
275		break;
276
277	case CLGET_WAITCHAN:
278		*(const char **) info = rc->rc_waitchan;
279		break;
280
281	case CLSET_INTERRUPTIBLE:
282		rc->rc_intr = *(int *) info;
283		if (rc->rc_client)
284			CLNT_CONTROL(rc->rc_client, request, info);
285		break;
286
287	case CLGET_INTERRUPTIBLE:
288		*(int *) info = rc->rc_intr;
289		break;
290
291	default:
292		return (FALSE);
293	}
294
295	return (TRUE);
296}
297
298static void
299clnt_reconnect_destroy(CLIENT *cl)
300{
301	struct rc_data *rc = (struct rc_data *)cl->cl_private;
302
303	if (rc->rc_client)
304		CLNT_DESTROY(rc->rc_client);
305	mem_free(rc, sizeof(*rc));
306	mem_free(cl, sizeof (CLIENT));
307}
308