nfs4_dispatch.c revision 3f720b33ddd72eec6da368eaaa751ed3acbca723
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * CDDL HEADER START
3e14f97f673e8a630f076077de35afdd43dc1587Roger A. Faulkner * The contents of this file are subject to the terms of the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Common Development and Distribution License, Version 1.0 only
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * (the "License"). You may not use this file except in compliance
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin * with the License.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * See the License for the specific language governing permissions
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * and limitations under the License.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * When distributing Covered Code, include this CDDL HEADER in each
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If applicable, add the following below this CDDL HEADER, with the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * fields enclosed by brackets "[]" replaced with your own identifying
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * information: Portions Copyright [yyyy] [name of copyright owner]
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * CDDL HEADER END
3e14f97f673e8a630f076077de35afdd43dc1587Roger A. Faulkner * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Use is subject to license terms.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin#pragma ident "%Z%%M% %I% %E% SMI"
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * This is the duplicate request cache for NFSv4
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * How long the entry can remain in the cache
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * once it has been sent to the client and not
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * used in a reply (in seconds)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * The default size of the duplicate request cache
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * The number of buckets we'd like to hash the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * replies into.. do not change this on the fly.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Initialize a duplicate request cache.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinrfs4_init_drc(uint32_t drc_size, uint32_t drc_hash_size, unsigned ttl)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin drc->dr_buckets = kmem_alloc(sizeof (list_t)*drc_hash_size, KM_SLEEP);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin list_create(&drc->dr_buckets[bki], sizeof (rfs4_dupreq_t),
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Destroy a duplicate request cache.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* iterate over the dr_cache and free the enties */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin for (drp = list_head(&(drc->dr_cache)); drp != NULL; drp = drp_next) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * rfs4_dr_chstate:
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Change the state of a rfs4_dupreq. If it's not in transition
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * to the FREE state, update the time used and return. If we
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * are moving to the FREE state then we need to clean up the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * compound results and move the entry to the end of the list.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Remove entry from the bucket and
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * dr_cache list, free compound results.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * rfs4_alloc_dr:
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Pick an entry off the tail -- Use if it is
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * marked NFS4_DUP_FREE, or is an entry in the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * NFS4_DUP_REPLAY state that has timed-out...
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Otherwise malloc a new one if we have not reached
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * our maximum cache limit.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * The list should be in time order, so no need
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * to traverse backwards looking for a timed out
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * entry, NFS4_DUP_FREE's are place on the tail.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* NOTREACHED */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* this entry has timedout so grab it. */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Didn't find something to recycle have
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * we hit the cache limit ?
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* nope, so let's malloc a new one */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * rfs4_find_dr:
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Search for an entry in the duplicate request cache by
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * calculating the hash index based on the XID, and examining
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * the entries in the hash bucket. If we find a match stamp the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * time_used and return. If the entry does not match it could be
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * ready to be freed. Once we have searched the bucket and we
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * have not exhausted the maximum limit for the cache we will
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * allocate a new entry.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinrfs4_find_dr(struct svc_req *req, rfs4_drc_t *drc, rfs4_dupreq_t **dup)
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Get the XID, calculate the bucket and search to
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * see if we need to replay from the cache.
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin * Search the bucket for a matching xid and address.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Found a match so REPLAY the Reply
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * This entry must be in transition, so return
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * the 'pending' status.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Not a match, but maybe this entry is ready
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * to be reused.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Place at the head of the list, init the state
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * to NEW and clear the time used field.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin drp->dr_time_used.tv_sec = drp->dr_time_used.tv_nsec = 0;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If needed, resize the address buffer
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (drp->dr_addr.maxlen < req->rq_xprt->xp_rtaddr.len) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin drp->dr_addr.buf = kmem_alloc(drp->dr_addr.maxlen, KM_NOSLEEP);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If the malloc fails, mark the entry
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * as free and put on the tail.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Copy the address.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Insert at the head of the bucket and
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * the drc lists..
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * This function handles the duplicate request cache,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * NULL_PROC and COMPOUND procedure calls for NFSv4;
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Passed into this function are:-
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * disp A pointer to our dispatch table entry
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * req The request to process
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * xprt The server transport handle
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * ap A pointer to the arguments
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * When appropriate this function is responsible for inserting
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * the reply into the duplicate cache or replaying an existing
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * cached reply.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * dr_stat reflects the state of the duplicate request that
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * has been inserted into or retrieved from the cache
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * drp is the duplicate request entry
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chinrfs4_dispatch(struct rpcdisp *disp, struct svc_req *req,
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Short circuit the RPC_NULL proc.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (1);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (0);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* Only NFSv4 Compounds from this point onward */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Figure out the disposition of the whole COMPOUND
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin * and record it's IDEMPOTENTCY.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If NON-IDEMPOTENT then we need to figure out if this
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * request can be replied from the duplicate cache.
7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin * If this is a new request then we need to insert the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * reply into the duplicate cache.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* look for a replay from the cache or allocate */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (1);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* NOTREACHED */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * reply has previously been inserted into the
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * duplicate cache, however the reply has
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * not yet been sent via svc_sendreply()
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (1);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* NOTREACHED */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* NON-IDEMPOTENT proc call */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * dr_res must be initialized before calling
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * rfs4_dr_chstate (it frees the reply).
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * mark this entry as FREE and plop
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * on the end of the cache list
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (1);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* replay from the cache */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin /* IDEMPOTENT proc call */
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin return (1);
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * Send out the replayed reply or the 'real' one.
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin if (!svc_sendreply(xprt, xdr_COMPOUND4res_srv, (char *)rbp)) {
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * If this reply was just inserted into the duplicate cache
da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin * mark it as available for replay