iot_taskpool_internal.h

Go to the documentation of this file.

/*
 * IoT Common V1.1.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef IOT_TASKPOOL_INTERNAL_H_
#define IOT_TASKPOOL_INTERNAL_H_

/* The config header is always included first. */
#include "iot_config.h"

/* Task pool include. */
#include "iot_error.h"
#include "iot_taskpool.h"

/* Establish a few convenience macros to handle errors in a standard way. */

#define TASKPOOL_SUCCEEDED( x )               ( ( x ) == IOT_TASKPOOL_SUCCESS )

#define TASKPOOL_FAILED( x )                  ( ( x ) != IOT_TASKPOOL_SUCCESS )

#define TASKPOOL_GOTO_CLEANUP()               IOT_GOTO_CLEANUP()

#define  TASKPOOL_FUNCTION_ENTRY( result )    IOT_FUNCTION_ENTRY( IotTaskPoolError_t, result )

#define TASKPOOL_ON_ERROR_GOTO_CLEANUP( expr )                           \
    { if( TASKPOOL_FAILED( status = ( expr ) ) ) { IOT_GOTO_CLEANUP(); } \
    }

#define TASKPOOL_ON_NULL_ARG_GOTO_CLEANUP( ptr )      IOT_VALIDATE_PARAMETER( IOT_TASKPOOL, ( ptr != NULL ) )

#define TASKPOOL_ON_ARG_ERROR_GOTO_CLEANUP( expr )    IOT_VALIDATE_PARAMETER( IOT_TASKPOOL, ( ( expr ) == false ) )

#define TASKPOOL_SET_AND_GOTO_CLEANUP( expr )         IOT_SET_AND_GOTO_CLEANUP( expr )

#define TASKPOOL_FUNCTION_CLEANUP()                   IOT_FUNCTION_CLEANUP_BEGIN()

#define TASKPOOL_FUNCTION_CLEANUP_END()               IOT_FUNCTION_CLEANUP_END()

#define TASKPOOL_NO_FUNCTION_CLEANUP()                IOT_FUNCTION_EXIT_NO_CLEANUP()

#define TASKPOOL_NO_FUNCTION_CLEANUP_NOLABEL()        return status

#if IOT_TASKPOOL_ENABLE_ASSERTS == 1
    #ifndef IotTaskPool_Assert
        #ifdef Iot_DefaultAssert
            #define IotTaskPool_Assert( expression )    Iot_DefaultAssert( expression )
        #else
            #error "Asserts are enabled for Task Pool, but IotTaskPool_Assert is not defined"
        #endif
    #endif
#else /* if IOT_TASKPOOL_ENABLE_ASSERTS == 1 */
    #define IotTaskPool_Assert( expression )
#endif /* if IOT_TASKPOOL_ENABLE_ASSERTS == 1 */

/* Configure logs for TASKPOOL functions. */
#ifdef IOT_LOG_LEVEL_TASKPOOL
    #define LIBRARY_LOG_LEVEL        IOT_LOG_LEVEL_TASKPOOL
#else
    #ifdef IOT_LOG_LEVEL_GLOBAL
        #define LIBRARY_LOG_LEVEL    IOT_LOG_LEVEL_GLOBAL
    #else
        #define LIBRARY_LOG_LEVEL    IOT_LOG_NONE
    #endif
#endif

#define LIBRARY_LOG_NAME    ( "TASKPOOL" )
#include "iot_logging_setup.h"

/*
 * Provide default values for undefined memory allocation functions based on
 * the usage of dynamic memory allocation.
 */
#if IOT_STATIC_MEMORY_ONLY == 1
    #include "iot_static_memory.h"

    void * IotTaskPool_MallocTaskPool( size_t size );

    void IotTaskPool_FreeTaskPool( void * ptr );

    void * IotTaskPool_MallocJob( size_t size );

    void IotTaskPool_FreeJob( void * ptr );

    void * IotTaskPool_MallocTimerEvent( size_t size );

    void IotTaskPool_FreeTimerEvent( void * ptr );

#else /* if IOT_STATIC_MEMORY_ONLY == 1 */
    #include <stdlib.h>

    #ifndef IotTaskPool_MallocTaskPool
        #ifdef Iot_DefaultMalloc
            #define IotTaskPool_MallocTaskPool    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for IotTaskPool_MallocTaskPool"
        #endif
    #endif

    #ifndef IotTaskPool_FreeTaskPool
        #ifdef Iot_DefaultFree
            #define IotTaskPool_FreeTaskPool    Iot_DefaultFree
        #else
            #error "No free function defined for IotTaskPool_FreeTaskPool"
        #endif
    #endif

    #ifndef IotTaskPool_MallocJob
        #ifdef Iot_DefaultMalloc
            #define IotTaskPool_MallocJob    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for IotTaskPool_MallocJob"
        #endif
    #endif

    #ifndef IotTaskPool_FreeJob
        #ifdef Iot_DefaultFree
            #define IotTaskPool_FreeJob    Iot_DefaultFree
        #else
            #error "No free function defined for IotTaskPool_FreeJob"
        #endif
    #endif

    #ifndef IotTaskPool_MallocTimerEvent
        #ifdef Iot_DefaultMalloc
            #define IotTaskPool_MallocTimerEvent    Iot_DefaultMalloc
        #else
            #error "No malloc function defined for IotTaskPool_MallocTimerEvent"
        #endif
    #endif

    #ifndef IotTaskPool_FreeTimerEvent
        #ifdef Iot_DefaultFree
            #define IotTaskPool_FreeTimerEvent    Iot_DefaultFree
        #else
            #error "No free function defined for IotTaskPool_FreeTimerEvent"
        #endif
    #endif
#endif /* if IOT_STATIC_MEMORY_ONLY == 1 */

/* ---------------------------------------------------------------------------------------------- */

#define IOT_TASK_POOL_INTERNAL_STATIC    ( ( uint32_t ) 0x00000001 )      /* Flag to mark a job as user-allocated. */

typedef struct _taskPoolCache
{
    IotListDouble_t freeList; 
    uint32_t freeCount;       
} _taskPoolCache_t;

typedef struct _taskPool
{
    IotDeQueue_t dispatchQueue;      
    IotListDouble_t timerEventsList; 
    _taskPoolCache_t jobsCache;      
    uint32_t minThreads;             
    uint32_t maxThreads;             
    uint32_t activeThreads;          
    uint32_t activeJobs;             
    uint32_t stackSize;              
    int32_t priority;                
    IotSemaphore_t dispatchSignal;   
    IotSemaphore_t startStopSignal;  
    IotTimer_t timer;                
    IotMutex_t lock;                 
} _taskPool_t;

typedef struct _taskPoolJob
{
    IotLink_t link;                    
    IotTaskPoolRoutine_t userCallback; 
    void * pUserContext;               
    uint32_t flags;                    
    IotTaskPoolJobStatus_t status;     
} _taskPoolJob_t;

typedef struct _taskPoolTimerEvent
{
    IotLink_t link;          
    uint64_t expirationTime; 
    _taskPoolJob_t * pJob;   
} _taskPoolTimerEvent_t;

#endif /* ifndef IOT_TASKPOOL_INTERNAL_H_ */