klmmod.c revision bbaa8b60dd95d714741fc474adad3cf710ef4efd
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * This file and its contents are supplied under the terms of the
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Common Development and Distribution License ("CDDL"), version 1.0.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * You may only use this file in accordance with the terms of version
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * 1.0 of the CDDL.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * A full copy of the text of the CDDL should have accompanied this
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * source. A copy is of the CDDL is also available via the Internet
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Copyright (c) 2012 by Delphix. All rights reserved.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NFS Lock Manager, server-side and common.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * This file contains all the external entry points of klmmod.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Basically, this is the "glue" to the BSD nlm code.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Cluster node ID. Zero unless we're part of a cluster.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Set by lm_set_nlmid_flk. Pass to lm_set_nlm_status.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * We're not yet doing "clustered" NLM stuff.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Call-back hook for clusters: Set lock manager status.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * If this hook is set, call this instead of the ususal
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * flk_set_lockmgr_status(FLK_LOCKMGR_UP / DOWN);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchininvoid (*lm_set_nlm_status)(int nlm_id, flk_nlm_status_t) = NULL;
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Call-back hook for clusters: Delete all locks held by sysid.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Call from code that drops all client locks (for which we're
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * the server) i.e. after the SM tells us a client has crashed.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Init/fini per-zone stuff for klm
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin/* ARGSUSED */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin sizeof (struct nlm_host),
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin g->nlm_hosts_hash = mod_hash_create_idhash("nlm_host_by_sysid",
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin mutex_init(&g->lock, NULL, MUTEX_DEFAULT, NULL);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin cv_init(&g->nlm_gc_sched_cv, NULL, CV_DEFAULT, NULL);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin cv_init(&g->nlm_gc_finish_cv, NULL, CV_DEFAULT, NULL);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin mutex_init(&g->clean_lock, NULL, MUTEX_DEFAULT, NULL);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin/* ARGSUSED */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin kmem_free(g, sizeof (*g));
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * ****************************************************************
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * module init, fini, info
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin zone_key_create(&nlm_zone_key, lm_zone_init, NULL, lm_zone_fini);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Per-zone lockmgr data. See: os/flock.c */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin zone_key_create(&flock_zone_key, flk_zone_init, NULL, flk_zone_fini);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * mod_install failed! undo above, reverse order
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Don't unload. */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * ****************************************************************
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Stubs listed in modstubs.s
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * klm system calls. Start service on some endpoint.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by nfssys() LM_SVC, from lockd.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Get our "globals" */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Check version of lockd calling.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin "(given 0x%x, expected 0x%x)\n",
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Build knetconfig, checking arg values.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Also come up with the "netid" string.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * (With some knowledge of /etc/netconfig)
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Override what we set above. */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Setup service on the passed transport.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NB: must releasef(fp) after this.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Don't try to start while still shutting down,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * or lots of things will fail...
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * There is no separate "initialize" sub-call for nfssys,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * and we want to do some one-time work when the first
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * binding comes in from lockd.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Save the options. */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* See nfs_sys.c (not yet per-zone) */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * If KLM is not started and the very first endpoint lockd
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * tries to add is not a loopback device, report an error.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Check if caller has the same PID lockd does */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * klm system calls. Kill the lock manager.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by nfssys() KILL_LOCKMGR,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * liblm:lm_shutdown() <- unused?
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin /* Get our "globals" */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Cleanup remote locks on FS un-export.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: called from nfs_export.c:unexport()
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * right before the share is going to
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * be unexported.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * See:cpr_suspend, cpr_resume
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Before suspend, get current state from "statd" on
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * all remote systems for which we have locks.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * After resume, check with those systems again,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * and either reclaim locks, or do SIGLOST.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Add the nlm_id bits to the sysid (by ref).
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin *new_sysid |= (lm_global_nlmid << BITS_IN_SYSID);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * It seems that closed source klmmod used
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * this function to release knetconfig stored
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * in mntinfo structure (see mntinfo's mi_klmconfig
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * We store knetconfigs differently, thus we don't
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * need this function.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by NFS4 delegation code to check if there are any
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NFSv2/v3 locks for the file, so it should not delegate.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: called from NFSv4 code
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * (see nfs4_srv_deleg.c:rfs4_bgrant_delegation())
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Find or create a "sysid" for given knc+addr.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * name is optional. Sets nc_changed if the
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * found knc_proto is different from passed.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Increments the reference count.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called internally, and in nfs4_find_sysid()
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchininlm_get_sysid(struct knetconfig *knc, struct netbuf *addr,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin hostp = nlm_host_findcreate(g, name, netid, addr);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Release a reference on a "sysid".
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin nlm_host_release(g, (struct nlm_host *)sysid);
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Alloc/free a sysid_t (a unique number between
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * LM_SYSID and LM_SYSID_MAX).
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Used by NFSv4 rfs4_op_lockt and smbsrv/smb_fsop_frlock,
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * both to represent non-local locks outside of klm.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: called from NFSv4 and SMBFS to allocate unique
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin/* Access private member lms->sysid */
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by nfs_frlock to check lock constraints.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Return non-zero if the lock request is "safe", i.e.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * the range is not mapped, not MANDLOCK, etc.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: callde from NFSv3/NFSv2 frlock() functions to
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * determine whether it's safe to add new lock.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchininlm_safelock(vnode_t *vp, const struct flock64 *fl, cred_t *cr)
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by nfs_lockcompletion to check whether it's "safe"
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * to map the file (and cache it's data). Walks the list of
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * file locks looking for any that are not "whole file".
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: called from nfs_client.c:nfs_lockcompletion()
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Called by nfs_map() for the MANDLOCK case.
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Return non-zero if the file has any locks with a
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * blocked request (sleep).
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * NOTE: called from NFSv3/NFSv2 map() functions in
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * order to determine whether it's safe to add new
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * ****************************************************************
bbaa8b60dd95d714741fc474adad3cf710ef4efdDan Kruchinin * Stuff needed by klmops?