/** * @file IxOsalBufferMgt.c * * @brief Default buffer pool management and buffer management *        Implementation. * * Design Notes: * * @par * IXP400 SW Release version 2.0 *  * -- Copyright Notice -- *  * @par * Copyright 2001-2005, Intel Corporation. * All rights reserved. *  * @par * 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. * 3. Neither the name of the Intel Corporation nor the names of its contributors *    may be used to endorse or promote products derived from this software *    without specific prior written permission. *  * @par * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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. *  * @par * -- End of Copyright Notice -- *//* * OS may choose to use default bufferMgt by defining * IX_OSAL_USE_DEFAULT_BUFFER_MGT in IxOsalOsBufferMgt.h   */#include "IxOsal.h"#define IX_OSAL_BUFFER_FREE_PROTECTION  /* Define this to enable Illegal MBuf Freed Protection*//* * The implementation is only used when the following * is defined. */#ifdef IX_OSAL_USE_DEFAULT_BUFFER_MGT#define IX_OSAL_MBUF_SYS_SIGNATURE				(0x8BADF00D)#define IX_OSAL_MBUF_SYS_SIGNATURE_MASK				(0xEFFFFFFF)#define IX_OSAL_MBUF_USED_FLAG					(0x10000000)#define IX_OSAL_MBUF_SYS_SIGNATURE_INIT(bufPtr)        		IX_OSAL_MBUF_SIGNATURE (bufPtr) = (UINT32)IX_OSAL_MBUF_SYS_SIGNATURE/* *  This implementation is protect, the buffer pool management's  ixOsalMBufFree *  against an invalid MBUF pointer argument that already has been freed earlier *  or in other words resides in the free pool of MBUFs. This added feature, *  checks the MBUF "USED" FLAG. The Flag tells if the MBUF is still not freed *  back to the Buffer Pool.*  Disable this feature for performance reasons by undef *  IX_OSAL_BUFFER_FREE_PROTECTION macro.*/#ifdef IX_OSAL_BUFFER_FREE_PROTECTION  /*IX_OSAL_BUFFER_FREE_PROTECTION With Buffer Free protection*/#define IX_OSAL_MBUF_GET_SYS_SIGNATURE(bufPtr)		(IX_OSAL_MBUF_SIGNATURE (bufPtr)&(IX_OSAL_MBUF_SYS_SIGNATURE_MASK) )#define IX_OSAL_MBUF_SET_SYS_SIGNATURE(bufPtr)    do {																											\																									IX_OSAL_MBUF_SIGNATURE (bufPtr)&(~IX_OSAL_MBUF_SYS_SIGNATURE_MASK);\														    									IX_OSAL_MBUF_SIGNATURE (bufPtr)|=IX_OSAL_MBUF_SYS_SIGNATURE;			\																									}while(0)#define IX_OSAL_MBUF_SET_USED_FLAG(bufPtr)   IX_OSAL_MBUF_SIGNATURE (bufPtr)|=IX_OSAL_MBUF_USED_FLAG#define IX_OSAL_MBUF_CLEAR_USED_FLAG(bufPtr) IX_OSAL_MBUF_SIGNATURE (bufPtr)&=~IX_OSAL_MBUF_USED_FLAG#define IX_OSAL_MBUF_ISSET_USED_FLAG(bufPtr) (IX_OSAL_MBUF_SIGNATURE (bufPtr)&IX_OSAL_MBUF_USED_FLAG)#else#define IX_OSAL_MBUF_GET_SYS_SIGNATURE(bufPtr)	 IX_OSAL_MBUF_SIGNATURE (bufPtr)#define IX_OSAL_MBUF_SET_SYS_SIGNATURE(bufPtr)   IX_OSAL_MBUF_SIGNATURE (bufPtr) = IX_OSAL_MBUF_SYS_SIGNATURE#endif /*IX_OSAL_BUFFER_FREE_PROTECTION With Buffer Free protection*//* * Variable declarations global to this file only.  Externs are followed by * static variables. *//*  * A unit of 32, used to provide bit-shift for pool * management. Needs some work if users want more than 32 pools. */#define IX_OSAL_BUFF_FREE_BITS 32PRIVATE UINT32 ixOsalBuffFreePools[IX_OSAL_MBUF_MAX_POOLS /    IX_OSAL_BUFF_FREE_BITS];PUBLIC IX_OSAL_MBUF_POOL ixOsalBuffPools[IX_OSAL_MBUF_MAX_POOLS];static int ixOsalBuffPoolsInUse = 0;#ifdef IX_OSAL_BUFFER_ALLOC_SEPARATELYPRIVATE IX_OSAL_MBUF *ixOsalBuffPoolMbufInit (UINT32 mbufSizeAligned,                      UINT32 dataSizeAligned,                      IX_OSAL_MBUF_POOL *poolPtr);#endifPRIVATE IX_OSAL_MBUF_POOL * ixOsalPoolAlloc (void);                      /* * Function definition: ixOsalPoolAlloc *//****************************/PRIVATE IX_OSAL_MBUF_POOL *ixOsalPoolAlloc (void){    register unsigned int i = 0;    /*     * Scan for the first free buffer. Free buffers are indicated by 0     * on the corrsponding bit in ixOsalBuffFreePools.      */    if (ixOsalBuffPoolsInUse >= IX_OSAL_MBUF_MAX_POOLS)    {        /*         * Fail to grab a ptr this time          */        return NULL;    }    while (ixOsalBuffFreePools[i / IX_OSAL_BUFF_FREE_BITS] &        (1 << (i % IX_OSAL_BUFF_FREE_BITS)))        i++;    /*     * Free buffer found. Mark it as busy and initialize.      */    ixOsalBuffFreePools[i / IX_OSAL_BUFF_FREE_BITS] |=        (1 << (i % IX_OSAL_BUFF_FREE_BITS));    memset (&ixOsalBuffPools[i], 0, sizeof (IX_OSAL_MBUF_POOL));    ixOsalBuffPools[i].poolIdx = i;    ixOsalBuffPoolsInUse++;    return &ixOsalBuffPools[i];}#ifdef IX_OSAL_BUFFER_ALLOC_SEPARATELYPRIVATE IX_OSAL_MBUF *ixOsalBuffPoolMbufInit (UINT32 mbufSizeAligned,                      UINT32 dataSizeAligned,                      IX_OSAL_MBUF_POOL *poolPtr){    UINT8 *dataPtr;    IX_OSAL_MBUF *realMbufPtr;    /* Allocate cache-aligned memory for mbuf header */    realMbufPtr = (IX_OSAL_MBUF *) IX_OSAL_CACHE_DMA_MALLOC (mbufSizeAligned);    IX_OSAL_ASSERT (realMbufPtr != NULL);    memset (realMbufPtr, 0, mbufSizeAligned);    /* Allocate cache-aligned memory for mbuf data */    dataPtr = (UINT8 *) IX_OSAL_CACHE_DMA_MALLOC (dataSizeAligned);    IX_OSAL_ASSERT (dataPtr != NULL);    memset (dataPtr, 0, dataSizeAligned);    /* Fill in mbuf header fields */    IX_OSAL_MBUF_MDATA (realMbufPtr) = dataPtr;    IX_OSAL_MBUF_ALLOCATED_BUFF_DATA (realMbufPtr) = (UINT32)dataPtr;    IX_OSAL_MBUF_MLEN (realMbufPtr) = dataSizeAligned;    IX_OSAL_MBUF_ALLOCATED_BUFF_LEN (realMbufPtr) = dataSizeAligned;    IX_OSAL_MBUF_NET_POOL (realMbufPtr) = (IX_OSAL_MBUF_POOL *) poolPtr;    IX_OSAL_MBUF_SYS_SIGNATURE_INIT(realMbufPtr);    /* update some statistical information */    poolPtr->mbufMemSize += mbufSizeAligned;    poolPtr->dataMemSize += dataSizeAligned;    return realMbufPtr;}#endif /* #ifdef IX_OSAL_BUFFER_ALLOC_SEPARATELY *//* * Function definition: ixOsalBuffPoolInit */PUBLIC IX_OSAL_MBUF_POOL *ixOsalPoolInit (UINT32 count, UINT32 size, const char *name){    /* These variables are only used if UX_OSAL_BUFFER_ALLOC_SEPERATELY     * is defined .     */#ifdef IX_OSAL_BUFFER_ALLOC_SEPARATELY    UINT32 i, mbufSizeAligned, dataSizeAligned;    IX_OSAL_MBUF *currentMbufPtr = NULL;#else    void *poolBufPtr;    void *poolDataPtr;    int mbufMemSize;    int dataMemSize;#endif    IX_OSAL_MBUF_POOL *poolPtr = NULL;        if (count <= 0)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalPoolInit(): " "count = 0 \n", 0, 0, 0, 0, 0, 0);        return NULL;            }    if (name == NULL)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalPoolInit(): " "NULL name \n", 0, 0, 0, 0, 0, 0);        return NULL;            }        if (strlen (name) > IX_OSAL_MBUF_POOL_NAME_LEN)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalPoolInit(): "            "ERROR - name length should be no greater than %d  \n",            IX_OSAL_MBUF_POOL_NAME_LEN, 0, 0, 0, 0, 0);        return NULL;    }/* OS can choose whether to allocate all buffers all together (if it  * can handle a huge single alloc request), or to allocate buffers  * separately by the defining IX_OSAL_BUFFER_ALLOC_SEPARATELY. */#ifdef IX_OSAL_BUFFER_ALLOC_SEPARATELY    /* Get a pool Ptr */    poolPtr = ixOsalPoolAlloc ();    if (poolPtr == NULL)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalPoolInit(): " "Fail to Get PoolPtr \n", 0, 0, 0, 0, 0, 0);            return NULL;    }    mbufSizeAligned = IX_OSAL_MBUF_POOL_SIZE_ALIGN (sizeof (IX_OSAL_MBUF));    dataSizeAligned = IX_OSAL_MBUF_POOL_SIZE_ALIGN(size);    poolPtr->nextFreeBuf = NULL;        poolPtr->mbufMemPtr = NULL;        poolPtr->dataMemPtr = NULL;    poolPtr->bufDataSize = dataSizeAligned;    poolPtr->totalBufsInPool = count;    poolPtr->poolAllocType = IX_OSAL_MBUF_POOL_TYPE_SYS_ALLOC;    strcpy (poolPtr->name, name);    for (i = 0; i < count; i++)    {	    /* create an mbuf */	    currentMbufPtr = ixOsalBuffPoolMbufInit (mbufSizeAligned,					         dataSizeAligned,					         poolPtr);#ifdef IX_OSAL_BUFFER_FREE_PROTECTION 		/* Set the Buffer USED Flag. If not, ixOsalMBufFree will fail.   ixOsalMbufFree used here is in a special case whereby, it's    used to add MBUF to the Pool. By specification, ixOsalMbufFree    deallocates an allocated MBUF from Pool.*/ 			               IX_OSAL_MBUF_SET_USED_FLAG(currentMbufPtr);#endif                             	    /* Add it to the pool */	    ixOsalMbufFree (currentMbufPtr);	    /* flush the pool information to RAM */	    IX_OSAL_CACHE_FLUSH (currentMbufPtr, mbufSizeAligned);    }        /*     * update the number of free buffers in the pool      */    poolPtr->freeBufsInPool = count;#else /* Otherwise allocate buffers in a continuous block fashion */        poolBufPtr = IX_OSAL_MBUF_POOL_MBUF_AREA_ALLOC (count, mbufMemSize);    IX_OSAL_ASSERT (poolBufPtr != NULL);    poolDataPtr =        IX_OSAL_MBUF_POOL_DATA_AREA_ALLOC (count, size, dataMemSize);    IX_OSAL_ASSERT (poolDataPtr != NULL);    poolPtr = ixOsalNoAllocPoolInit (poolBufPtr, poolDataPtr,        count, size, name);    if (poolPtr == NULL)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalPoolInit(): " "Fail to get pool ptr \n", 0, 0, 0, 0, 0, 0);        return NULL;    }    poolPtr->poolAllocType = IX_OSAL_MBUF_POOL_TYPE_SYS_ALLOC;#endif /* IX_OSAL_BUFFER_ALLOC_SEPARATELY */    return poolPtr;}PUBLIC IX_OSAL_MBUF_POOL *ixOsalNoAllocPoolInit (void *poolBufPtr,    void *poolDataPtr, UINT32 count, UINT32 size, const char *name){    UINT32 i,  mbufSizeAligned, sizeAligned;    IX_OSAL_MBUF *currentMbufPtr = NULL;    IX_OSAL_MBUF *nextMbufPtr = NULL;    IX_OSAL_MBUF_POOL *poolPtr = NULL;    /*     * check parameters      */    if (poolBufPtr == NULL)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalNoAllocPoolInit(): "            "ERROR - NULL poolBufPtr \n", 0, 0, 0, 0, 0, 0);        return NULL;    }    if (count <= 0)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalNoAllocPoolInit(): "            "ERROR - count must > 0   \n", 0, 0, 0, 0, 0, 0);        return NULL;    }    if (name == NULL)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalNoAllocPoolInit(): "            "ERROR - NULL name ptr  \n", 0, 0, 0, 0, 0, 0);        return NULL;    }    if (strlen (name) > IX_OSAL_MBUF_POOL_NAME_LEN)    {        ixOsalLog (IX_OSAL_LOG_LVL_ERROR,            IX_OSAL_LOG_DEV_STDOUT,            "ixOsalNoAllocPoolInit(): "            "ERROR - name length should be no greater than %d  \n",            IX_OSAL_MBUF_POOL_NAME_LEN, 0, 0, 0, 0, 0);        return NULL;    }    poolPtr = ixOsalPoolAlloc ();    if (poolPtr == NULL)    {        return NULL;    }    /*     * Adjust sizes to ensure alignment on cache line boundaries      */    mbufSizeAligned =        IX_OSAL_MBUF_POOL_SIZE_ALIGN (sizeof (IX_OSAL_MBUF));    /*     * clear the mbuf memory area      */    memset (poolBufPtr, 0, mbufSizeAligned * count);    if (poolDataPtr != NULL)    {        /*         * Adjust sizes to ensure alignment on cache line boundaries          */        sizeAligned = IX_OSAL_MBUF_POOL_SIZE_ALIGN (size);        /*