/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation 
 * 
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 * 
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** ThreadX Component                                                     */
/**                                                                       */
/**   Block Pool                                                          */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define TX_SOURCE_CODE


/* Include necessary system files.  */

#include "tx_api.h"
#include "tx_block_pool.h"


#ifndef TX_INLINE_INITIALIZATION

/* Locate block pool component data in this file.  */

/* Define the head pointer of the created block pool list.  */

TX_BLOCK_POOL *  _tx_block_pool_created_ptr;


/* Define the variable that holds the number of created block pools. */

ULONG            _tx_block_pool_created_count;


#ifdef TX_BLOCK_POOL_ENABLE_PERFORMANCE_INFO

/* Define the total number of block allocates.  */

ULONG            _tx_block_pool_performance_allocate_count;


/* Define the total number of block releases.  */

ULONG            _tx_block_pool_performance_release_count;


/* Define the total number of block pool suspensions.  */

ULONG            _tx_block_pool_performance_suspension_count;


/* Define the total number of block pool timeouts.  */

ULONG            _tx_block_pool_performance_timeout_count;

#endif


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _tx_block pool_initialize                           PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    William E. Lamie, Microsoft Corporation                             */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function initializes the various control data structures for   */
/*    the block pool component.                                           */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    _tx_initialize_high_level         High level initialization         */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  05-19-2020     William E. Lamie         Initial Version 6.0           */
/*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
/*                                            opt out of function when    */
/*                                            TX_INLINE_INITIALIZATION is */
/*                                            defined,                    */
/*                                            resulting in version 6.1    */
/*                                                                        */
/**************************************************************************/
VOID  _tx_block_pool_initialize(VOID)
{

#ifndef TX_DISABLE_REDUNDANT_CLEARING

    /* Initialize the head pointer of the created block pools list and the
       number of block pools created.  */
    _tx_block_pool_created_ptr =        TX_NULL;
    _tx_block_pool_created_count =      TX_EMPTY;

#ifdef TX_BLOCK_POOL_ENABLE_PERFORMANCE_INFO

    /* Initialize block pool performance counters.  */
    _tx_block_pool_performance_allocate_count =    ((ULONG) 0);
    _tx_block_pool_performance_release_count =     ((ULONG) 0);
    _tx_block_pool_performance_suspension_count =  ((ULONG) 0);
    _tx_block_pool_performance_timeout_count =     ((ULONG) 0);
#endif
#endif
}
#endif