Add the new kernel-mode NFS Lock Manager. To use it instead of the

user-mode lock manager, build a kernel with the NFSLOCKD option and
add '-k' to 'rpc_lockd_flags' in rc.conf.

Highlights include:

* Thread-safe kernel RPC client - many threads can use the same RPC
  client handle safely with replies being de-multiplexed at the socket
  upcall (typically driven directly by the NIC interrupt) and handed
  off to whichever thread matches the reply. For UDP sockets, many RPC
  clients can share the same socket. This allows the use of a single
  privileged UDP port number to talk to an arbitrary number of remote
  hosts.

* Single-threaded kernel RPC server. Adding support for multi-threaded
  server would be relatively straightforward and would follow
  approximately the Solaris KPI. A single thread should be sufficient
  for the NLM since it should rarely block in normal operation.

* Kernel mode NLM server supporting cancel requests and granted
  callbacks. I've tested the NLM server reasonably extensively - it
  passes both my own tests and the NFS Connectathon locking tests
  running on Solaris, Mac OS X and Ubuntu Linux.

* Userland NLM client supported. While the NLM server doesn't have
  support for the local NFS client's locking needs, it does have to
  field async replies and granted callbacks from remote NLMs that the
  local client has contacted. We relay these replies to the userland
  rpc.lockd over a local domain RPC socket.

* Robust deadlock detection for the local lock manager. In particular
  it will detect deadlocks caused by a lock request that covers more
  than one blocking request. As required by the NLM protocol, all
  deadlock detection happens synchronously - a user is guaranteed that
  if a lock request isn't rejected immediately, the lock will
  eventually be granted. The old system allowed for a 'deferred
  deadlock' condition where a blocked lock request could wake up and
  find that some other deadlock-causing lock owner had beaten them to
  the lock.

* Since both local and remote locks are managed by the same kernel
  locking code, local and remote processes can safely use file locks
  for mutual exclusion. Local processes have no fairness advantage
  compared to remote processes when contending to lock a region that
  has just been unlocked - the local lock manager enforces a strict
  first-come first-served model for both local and remote lockers.

Sponsored by:	Isilon Systems
PR:		95247 107555 115524 116679
MFC after:	2 weeks

1 files changed, 307 insertions, 0 deletions

diff --git a/sys/rpc/clnt_rc.c b/sys/rpc/clnt_rc.c
new file mode 100644
index 0000000..e767410
--- /dev/null
+++ b/sys/rpc/clnt_rc.c
@@ -0,0 +1,307 @@
+/*-
+ * Copyright (c) 2008 Isilon Inc http://www.isilon.com/
+ * Authors: Doug Rabson <dfr@rabson.org>
+ * Developed with Red Inc: Alfred Perlstein <alfred@freebsd.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <sys/param.h>
+#include <sys/systm.h>
+#include <sys/lock.h>
+#include <sys/malloc.h>
+#include <sys/mbuf.h>
+#include <sys/mutex.h>
+#include <sys/pcpu.h>
+#include <sys/proc.h>
+#include <sys/socket.h>
+#include <sys/socketvar.h>
+#include <sys/time.h>
+#include <sys/uio.h>
+
+#include <rpc/rpc.h>
+#include "rpc_com.h"
+
+static enum clnt_stat clnt_reconnect_call(CLIENT *, rpcproc_t,
+    xdrproc_t, void *, xdrproc_t, void *, struct timeval);
+static void clnt_reconnect_geterr(CLIENT *, struct rpc_err *);
+static bool_t clnt_reconnect_freeres(CLIENT *, xdrproc_t, void *);
+static void clnt_reconnect_abort(CLIENT *);
+static bool_t clnt_reconnect_control(CLIENT *, u_int, void *);
+static void clnt_reconnect_destroy(CLIENT *);
+
+static struct clnt_ops clnt_reconnect_ops = {
+	.cl_call =	clnt_reconnect_call,
+	.cl_abort =	clnt_reconnect_abort,
+	.cl_geterr =	clnt_reconnect_geterr,
+	.cl_freeres =	clnt_reconnect_freeres,
+	.cl_destroy =	clnt_reconnect_destroy,
+	.cl_control =	clnt_reconnect_control
+};
+
+struct rc_data {
+	struct sockaddr_storage	rc_addr; /* server address */
+	struct netconfig*	rc_nconf; /* network type */
+	rpcprog_t		rc_prog;  /* program number */
+	rpcvers_t		rc_vers;  /* version number */
+	size_t			rc_sendsz;
+	size_t			rc_recvsz;
+	struct timeval		rc_timeout;
+	struct timeval		rc_retry;
+	const char		*rc_waitchan;
+	int			rc_intr;
+	CLIENT*			rc_client; /* underlying RPC client */
+};
+
+CLIENT *
+clnt_reconnect_create(
+	struct netconfig *nconf,	/* network type */
+	struct sockaddr *svcaddr,	/* servers address */
+	rpcprog_t program,		/* program number */
+	rpcvers_t version,		/* version number */
+	size_t sendsz,			/* buffer recv size */
+	size_t recvsz)			/* buffer send size */
+{
+	CLIENT *cl = NULL;		/* client handle */
+	struct rc_data *rc = NULL;	/* private data */
+
+	if (svcaddr == NULL) {
+		rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
+		return (NULL);
+	}
+
+	cl = mem_alloc(sizeof (CLIENT));
+	rc = mem_alloc(sizeof (*rc));
+	(void) memcpy(&rc->rc_addr, svcaddr, (size_t)svcaddr->sa_len);
+	rc->rc_nconf = nconf;
+	rc->rc_prog = program;
+	rc->rc_vers = version;
+	rc->rc_sendsz = sendsz;
+	rc->rc_recvsz = recvsz;
+	rc->rc_timeout.tv_sec = -1;
+	rc->rc_timeout.tv_usec = -1;
+	rc->rc_retry.tv_sec = 15;
+	rc->rc_retry.tv_usec = 0;
+	rc->rc_waitchan = "rpcrecv";
+	rc->rc_intr = 0;
+	rc->rc_client = NULL;
+
+	cl->cl_ops = &clnt_reconnect_ops;
+	cl->cl_private = (caddr_t)(void *)rc;
+	cl->cl_auth = authnone_create();
+	cl->cl_tp = NULL;
+	cl->cl_netid = NULL;
+	return (cl);
+}
+
+static enum clnt_stat
+clnt_reconnect_connect(CLIENT *cl)
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+	struct socket *so;
+	int one = 1;
+
+	so = __rpc_nconf2socket(rc->rc_nconf);
+	if (!so) {
+		rpc_createerr.cf_stat = RPC_TLIERROR;
+		rpc_createerr.cf_error.re_errno = 0;
+		return (RPC_TLIERROR);
+	}
+
+	if (rc->rc_nconf->nc_semantics == NC_TPI_CLTS)
+		rc->rc_client = clnt_dg_create(so,
+		    (struct sockaddr *) &rc->rc_addr, rc->rc_prog, rc->rc_vers,
+		    rc->rc_sendsz, rc->rc_recvsz);
+	else
+		rc->rc_client = clnt_vc_create(so,
+		    (struct sockaddr *) &rc->rc_addr, rc->rc_prog, rc->rc_vers,
+		    rc->rc_sendsz, rc->rc_recvsz);
+
+	CLNT_CONTROL(rc->rc_client, CLSET_FD_CLOSE, 0);
+	CLNT_CONTROL(rc->rc_client, CLSET_CONNECT, &one);
+	CLNT_CONTROL(rc->rc_client, CLSET_TIMEOUT, &rc->rc_timeout);
+	CLNT_CONTROL(rc->rc_client, CLSET_RETRY_TIMEOUT, &rc->rc_retry);
+	CLNT_CONTROL(rc->rc_client, CLSET_WAITCHAN, &rc->rc_waitchan);
+	CLNT_CONTROL(rc->rc_client, CLSET_INTERRUPTIBLE, &rc->rc_intr);
+
+	return (RPC_SUCCESS);
+}
+
+static enum clnt_stat
+clnt_reconnect_call(
+	CLIENT	*cl,			/* client handle */
+	rpcproc_t	proc,		/* procedure number */
+	xdrproc_t	xargs,		/* xdr routine for args */
+	void		*argsp,		/* pointer to args */
+	xdrproc_t	xresults,	/* xdr routine for results */
+	void		*resultsp,	/* pointer to results */
+	struct timeval	utimeout)	/* seconds to wait before giving up */
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+	enum clnt_stat stat;
+
+	do {
+		if (!rc->rc_client)
+			clnt_reconnect_connect(cl);
+
+		stat = CLNT_CALL(rc->rc_client, proc, xargs, argsp,
+		    xresults, resultsp, utimeout);
+
+		if (stat == RPC_TIMEDOUT) {
+			/*
+			 * Check for async send misfeature for NLM
+			 * protocol.
+			 */
+			if ((rc->rc_timeout.tv_sec == 0
+				&& rc->rc_timeout.tv_usec == 0)
+			    || (rc->rc_timeout.tv_sec == -1
+				&& utimeout.tv_sec == 0
+				&& utimeout.tv_usec == 0))
+				break;
+		}
+
+		if (stat == RPC_INTR)
+			break;
+
+		if (stat != RPC_SUCCESS) {
+			CLNT_DESTROY(rc->rc_client);
+			rc->rc_client = NULL;
+		}
+	} while (stat != RPC_SUCCESS);
+
+	return (stat);
+}
+
+static void
+clnt_reconnect_geterr(CLIENT *cl, struct rpc_err *errp)
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+
+	if (rc->rc_client)
+		CLNT_GETERR(rc->rc_client, errp);
+	else
+		memset(errp, 0, sizeof(*errp));
+}
+
+static bool_t
+clnt_reconnect_freeres(CLIENT *cl, xdrproc_t xdr_res, void *res_ptr)
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+
+	return (CLNT_FREERES(rc->rc_client, xdr_res, res_ptr));
+}
+
+/*ARGSUSED*/
+static void
+clnt_reconnect_abort(CLIENT *h)
+{
+}
+
+static bool_t
+clnt_reconnect_control(CLIENT *cl, u_int request, void *info)
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+
+	if (info == NULL) {
+		return (FALSE);
+	}
+	switch (request) {
+	case CLSET_TIMEOUT:
+		rc->rc_timeout = *(struct timeval *)info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, request, info);
+		break;
+
+	case CLGET_TIMEOUT:
+		*(struct timeval *)info = rc->rc_timeout;
+		break;
+
+	case CLSET_RETRY_TIMEOUT:
+		rc->rc_retry = *(struct timeval *)info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, request, info);
+		break;
+
+	case CLGET_RETRY_TIMEOUT:
+		*(struct timeval *)info = rc->rc_retry;
+		break;
+
+	case CLGET_VERS:
+		*(uint32_t *)info = rc->rc_vers;
+		break;
+
+	case CLSET_VERS:
+		rc->rc_vers = *(uint32_t *) info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, CLSET_VERS, info);
+		break;
+
+	case CLGET_PROG:
+		*(uint32_t *)info = rc->rc_prog;
+		break;
+
+	case CLSET_PROG:
+		rc->rc_prog = *(uint32_t *) info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, request, info);
+		break;
+
+	case CLSET_WAITCHAN:
+		rc->rc_waitchan = *(const char **)info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, request, info);
+		break;
+
+	case CLGET_WAITCHAN:
+		*(const char **) info = rc->rc_waitchan;
+		break;
+
+	case CLSET_INTERRUPTIBLE:
+		rc->rc_intr = *(int *) info;
+		if (rc->rc_client)
+			CLNT_CONTROL(rc->rc_client, request, info);
+		break;
+
+	case CLGET_INTERRUPTIBLE:
+		*(int *) info = rc->rc_intr;
+		break;
+
+	default:
+		return (FALSE);
+	}
+
+	return (TRUE);
+}
+
+static void
+clnt_reconnect_destroy(CLIENT *cl)
+{
+	struct rc_data *rc = (struct rc_data *)cl->cl_private;
+
+	if (rc->rc_client)
+		CLNT_DESTROY(rc->rc_client);
+	mem_free(rc, sizeof(*rc));
+	mem_free(cl, sizeof (CLIENT));
+}