vio_util.c revision 6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * CDDL HEADER START
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * The contents of this file are subject to the terms of the
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Common Development and Distribution License (the "License").
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * You may not use this file except in compliance with the License.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * See the License for the specific language governing permissions
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * and limitations under the License.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * When distributing Covered Code, include this CDDL HEADER in each
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * If applicable, add the following below this CDDL HEADER, with the
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * fields enclosed by brackets "[]" replaced with your own identifying
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * information: Portions Copyright [yyyy] [name of copyright owner]
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * CDDL HEADER END
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Use is subject to license terms.
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANGstatic int vio_pool_cleanup_retries = 10; /* Max retries to free pool */
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANGstatic int vio_pool_cleanup_delay = 10000; /* 10ms */
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Create a pool of mblks from which future vio_allocb() requests
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * will be serviced.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * NOTE: num_mblks has to non-zero and a power-of-2
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * 0 on success
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * EINVAL if num_mblks is zero or not a power of 2.
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * ENOSPC if the pool could not be created due to alloc failures.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayanvio_create_mblks(uint64_t num_mblks, size_t mblk_size, vio_mblk_pool_t **poolp)
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan vmplp->quemask = num_mblks - 1; /* expects quelen is power-of-2 */
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan vmplp->basep = kmem_zalloc(num_mblks * sizeof (vio_mblk_t), KM_SLEEP);
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan vmplp->datap = kmem_zalloc(num_mblks * mblk_size, KM_SLEEP);
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan /* create a queue of pointers to free vio_mblk_t's */
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan for (i = 0, datap = vmplp->datap; i < num_mblks; i++) {
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan vmp->mp = desballoc(vmp->datap, mblk_size, BPRI_MED,
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG /* reset tail */
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * vio_destroy_mblks() frees mblks that have been
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * allocated so far and then destroys the pool.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan /* put this vmp on the free stack */
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan return (0);
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Destroy the pool of mblks. This can only succeed when
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * all allocated mblks have been returned to the pool.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * It is up to the caller to ensure that no further mblks are
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * requested from the pool after destroy has been invoked.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Returns 0 on success, EINVAL if handle is invalid, or
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * EBUSY if not all mblks reclaimed yet.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * We can only destroy the pool once all the mblks have
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * been reclaimed.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan /* some mblks still in use */
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG } while (++pool_cleanup_retries < vio_pool_cleanup_retries);
3af08d828975d7e2581b6829e0eecff14d87a483lm * Set pool flag to tell vio_freeb() which is invoked from freeb(),
3af08d828975d7e2581b6829e0eecff14d87a483lm * that it is being called in the context of vio_destroy_mblks().
3af08d828975d7e2581b6829e0eecff14d87a483lm * This results in freeing only mblk_t and dblk_t structures for
3af08d828975d7e2581b6829e0eecff14d87a483lm * each mp. The associated data buffers are freed below as one big
3af08d828975d7e2581b6829e0eecff14d87a483lm * chunk through kmem_free(vmplp->datap).
3af08d828975d7e2581b6829e0eecff14d87a483lm for (i = 0; i < num_mblks; i++) {
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * It is possible that mblks have been allocated only upto
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * a certain index and the entire quelen has not been
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * initialized. This might happen due to desballoc() failure
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * while creating the pool. The below check handles this
6f09f0fef8e4582cfa771d87fe2a1f777bfb5cf0WENTAO YANG * condition.
3af08d828975d7e2581b6829e0eecff14d87a483lm kmem_free(vmplp->basep, num_mblks * sizeof (vio_mblk_t));
3af08d828975d7e2581b6829e0eecff14d87a483lm kmem_free(vmplp->quep, num_mblks * sizeof (vio_mblk_t *));
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan return (0);
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Allocate a mblk from the free pool if one is available.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Otherwise returns NULL.
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan /* we have free mblks */
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * Return a mblk to the free pool. Invoked when the upper IP
d10e4ef2fabf16c3237c6d6592496df3eac6a1efnarayan * layers do freemsg() etc on the mblk they were passed.
3af08d828975d7e2581b6829e0eecff14d87a483lm * This flag indicates that freeb() is being called from
3af08d828975d7e2581b6829e0eecff14d87a483lm * vio_destroy_mblks().
3af08d828975d7e2581b6829e0eecff14d87a483lm * We don't need to alloc a new mblk_t/dblk_t pair for
3af08d828975d7e2581b6829e0eecff14d87a483lm * this data buffer, return from here and the data buffer
3af08d828975d7e2581b6829e0eecff14d87a483lm * itself will be freed in vio_destroy_mblks().
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Create a multiple pools of mblks from which future vio_allocb()
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * or vio_multipool_allocb() requests will be serviced.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Arguments:
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * vmultip -- A pointer to vio_multi_pool_t structure.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * num_pools -- Number of the pools.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * ... -- Variable arguments consisting a list of buffer sizes for
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * each pool and list of number of buffers for each pool.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * NOTE: The restrictions of vio_create_mblks() apply to this interface also.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Returns 0 on success or an error returned by vio_create_mblks().
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuramvio_init_multipools(vio_multi_pool_t *vmultip, int num_pools, ...)
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Allocate memory for all of the following in one allocation.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * bufsz_tbl -- sizeof (uint32_t) * num_pools
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * nbuf_tbl -- sizeof (uint32_t) * num_pools
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * vmpp -- sizeof (vio_mblk_pool_t *) * numpools
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram /* initialize the array first */
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram for (i = 0; i < num_pools; i++) {
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram for (i = 0; i < num_pools; i++) {
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram /* We expect to free the pools without failure here */
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram return (0);
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Destroy the multiple pools of mblks. This can only succeed when
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * all allocated mblks have been returned to the pool.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * If a pool of mblks couldn't be destroyed, then the failed vio_mblk_pool_t
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * pointers are returned via th fvmp list. Its the caller's
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * responsibility to check this list and free them later at an appropriate
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * time with vio_destroy_mblks().
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Arguments:
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * vmultip -- A pointer to vio_multi_pool_t structure.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * fvmp -- A list in which the pools that couldn't be destroyed are
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * returned.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuramvio_destroy_multipools(vio_multi_pool_t *vmultip, vio_mblk_pool_t **fvmp)
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * if we cannot reclaim all mblks, then
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * return the pool in the failed vmp
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * list(fvmp).
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * Allocate an mblk from one of the free pools, but tries the pool that
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram * best fits size requested first.
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuramvio_multipool_allocb(vio_multi_pool_t *vmultip, size_t size)
844e62a3ec8c8ff5175bb35d1c38446e060730f6raghuram /* Try allocating any size that fits */
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * -----------------------------------------------------------------------------
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * LDoms versioning functions
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * Future work: the version negotiating code in the various VIO drivers
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * could be made common and placed here.
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * Description:
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * This function checks to see if the supplied version tuple (major,minor)
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * is supported by the version 'ver', negotiated during the handshake
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * between the client and the server (ver).
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * Assumption:
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * This function assumes that backward compatability is not broken in
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * newer minor versions of the protocol (e.g. v1.5 & v1.1 support v1.0)
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * Return Value:
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * B_TRUE - The (major,minor) version is supported
17cadca83cc82e37ff517ea2783eb4bfcc07b950lm * B_FALSE - not supported