/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation                                */
/* Copyright (c) 2026 Eclipse ThreadX contributors                         */
/*                                                                         */
/* 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                                            */
/***************************************************************************/

/* This test is designed to test suspension on memory block pools.  */

#include   <stdio.h>
#include   "tx_api.h"
#include   "threadx_test_port.h"

static unsigned long   thread_0_counter =  0;
static TX_THREAD       thread_0;
static unsigned long   thread_1_counter =  0;
static TX_THREAD       thread_1;
static unsigned long   thread_2_counter =  0;
static TX_THREAD       thread_2;

static TX_BLOCK_POOL   pool_0;


/* Define thread prototypes.  */

static void    thread_0_entry(ULONG thread_input);
static void    thread_1_entry(ULONG thread_input);
static void    thread_2_entry(ULONG thread_input);


/* Prototype for test control return.  */
void  test_control_return(UINT status);


/* Define what the initial system looks like.  */

#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void    threadx_block_memory_suspension_application_define(void *first_unused_memory)
#endif
{

UINT    status;
CHAR    *pointer;


    /* Put first available memory address into a character pointer.  */
    pointer =  (CHAR *) first_unused_memory;

    /* Put system definition stuff in here, e.g. thread creates and other assorted
       create information.  */

    status =  tx_thread_create(&thread_0, "thread 0", thread_0_entry, 1,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_AUTO_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Block Memory Suspension Test................................ ERROR #1\n");
        test_control_return(1);
    }

    status =  tx_thread_create(&thread_1, "thread 1", thread_1_entry, 1,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_AUTO_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Block Memory Suspension Test................................ ERROR #2\n");
        test_control_return(1);
    }

    status =  tx_thread_create(&thread_2, "thread 2", thread_2_entry, 2,
            pointer, TEST_STACK_SIZE_PRINTF,
            17, 17, 100, TX_DONT_START);
    pointer = pointer + TEST_STACK_SIZE_PRINTF;

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Block Memory Suspension Test................................ ERROR #3\n");
        test_control_return(1);
    }

    /* Create block pool.  */
    status =  tx_block_pool_create(&pool_0, "pool 0", 100, pointer, TX_TEST_BLOCK_POOL_BYTES(100, 3));
    pointer = pointer + TX_TEST_BLOCK_POOL_BYTES(100, 3);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        printf("Running Block Memory Suspension Test................................ ERROR #4\n");
        test_control_return(1);
    }
}



/* Define the test threads.  */

static void    thread_0_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer_1;
CHAR    *pointer_2;
CHAR    *pointer_3;


    /* Inform user.  */
    printf("Running Block Memory Suspension Test................................ ");

    /* Increment the run counter.  */
    thread_0_counter++;

    /* Allocate all blocks from the pool.  */
    status =  tx_block_allocate(&pool_0, (VOID **) &pointer_1, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Block memory error.  */
        printf("ERROR #5\n");
        test_control_return(1);
    }

    /* Set all the memory of the blocks.  */
    TX_MEMSET(pointer_1, (CHAR) 0xEF, 100);

    status =  tx_block_allocate(&pool_0, (VOID **) &pointer_2, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Block memory error.  */
        printf("ERROR #6\n");
        test_control_return(1);
    }

    /* Set all the memory of the blocks.  */
    TX_MEMSET(pointer_2, (CHAR) 0xEF, 100);

    /* Get the last block.  */
    status = tx_block_allocate(&pool_0, (VOID **) &pointer_3, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Block memory error.  */
        printf("ERROR #6\n");
        test_control_return(1);
    }

    /* Set all the memory of the blocks.  */
    TX_MEMSET(pointer_3, (CHAR) 0xEF, 100);

    /* Let the other thread suspend on the pool.  */
    tx_thread_relinquish();

    /* Now release the block to lift the suspension on the other thread.  */
    status =  tx_block_release(pointer_3);

    /* Check status and run counter.  */
    if ((status != TX_SUCCESS) || (thread_1_counter != 0))
    {

        /* Block memory error.  */
        printf("ERROR #7\n");
        test_control_return(1);
    }

    /* Let the other thread run again.  */
    tx_thread_relinquish();

    /* Check the run counter of the other thread.  */
    if (thread_1_counter != 1)
    {

        /* Block memory error.  */
        printf("ERROR #8\n");
        test_control_return(1);
    }

    /* At this point the other thread has run and there is one block free.  */

    /* Get the last block again.  */
    status = tx_block_allocate(&pool_0, (VOID **) &pointer_3, TX_NO_WAIT);

    /* Check status.  */
    if (status != TX_SUCCESS)
    {

        /* Block memory error.  */
        printf("ERROR #9\n");
        test_control_return(1);
    }

    /* Set all the memory of the blocks.  */
    TX_MEMSET(pointer_3, (CHAR) 0xEF, 100);

    /* Resume the second thread.  */
    tx_thread_resume(&thread_2);

    /* Let both threads suspend on the block pool via relinquish.  */
    tx_thread_relinquish();

    /* Now release the block.  */
    status =  tx_block_release(pointer_3);

    /* Check status and run counter.  */
    if ((status != TX_SUCCESS) || (thread_1_counter != 1) || (thread_2_counter != 0))
    {

        /* Block memory error.  */
        printf("ERROR #10\n");
        test_control_return(1);
    }

    /* Let thread 1 release the block.  */
    tx_thread_relinquish();

    /* Let thread 2 get the block and release the block.  */
    tx_thread_relinquish();

    /* Check status and run counter.  */
    if ((thread_1_counter != 3) || (thread_2_counter != 1))
    {

        /* Block memory error.  */
        printf("ERROR #11\n");
        test_control_return(1);
    }
    else
    {
        /* Successful test.  */
        printf("SUCCESS!\n");
        test_control_return(0);
    }
}


static void    thread_1_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer_1;


    /* Attempt to get a block from the pool.  */
    while(1)
    {

        /* Allocate a block from the pool.  */
        status =  tx_block_allocate(&pool_0, (VOID **) &pointer_1, TX_WAIT_FOREVER);

        /* Determine if the allocate was successful.  */
        if (status != TX_SUCCESS)
            return;

        /* Set all the memory of the blocks.  */
        TX_MEMSET(pointer_1, (CHAR) 0xEF, 100);

        /* Increment the thread counter.  */
        thread_1_counter++;

        /* Release the block.  */
        tx_block_release(pointer_1);

        /* Switch back to other thread.  */
        tx_thread_relinquish();
    }
}


static void    thread_2_entry(ULONG thread_input)
{

UINT    status;
CHAR    *pointer_1;


    /* Attempt to get a block from the pool.  */
    while(1)
    {

        /* Allocate a block from the pool.  */
        status =  tx_block_allocate(&pool_0, (VOID **) &pointer_1, TX_WAIT_FOREVER);

        /* Determine if the allocate was successful.  */
        if (status != TX_SUCCESS)
            return;

        /* Set all the memory of the blocks.  */
        TX_MEMSET(pointer_1, (CHAR) 0xEF, 100);

        /* Increment the thread counter.  */
        thread_2_counter++;

        /* Release the block.  */
        tx_block_release(pointer_1);

        /* Switch back to other thread.  */
        tx_thread_relinquish();
    }
}

