iot_taskpool_types.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_TYPES_H_
#define IOT_TASKPOOL_TYPES_H_

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

/* Standard includes. */
#include <stdbool.h>
#include <stdint.h>

/* Platform types includes. */
#include "types/iot_platform_types.h"

/* Linear containers (lists and queues) include. */
#include "iot_linear_containers.h"

/*-------------------------- Task pool enumerated types --------------------------*/

typedef enum IotTaskPoolError
{
    IOT_TASKPOOL_SUCCESS = 0,

    IOT_TASKPOOL_BAD_PARAMETER,

    IOT_TASKPOOL_ILLEGAL_OPERATION,

    IOT_TASKPOOL_NO_MEMORY,

    IOT_TASKPOOL_SHUTDOWN_IN_PROGRESS,

    IOT_TASKPOOL_CANCEL_FAILED,

    IOT_TASKPOOL_GENERAL_FAILURE,
} IotTaskPoolError_t;

typedef enum IotTaskPoolJobStatus
{
    IOT_TASKPOOL_STATUS_READY = 0,

    IOT_TASKPOOL_STATUS_SCHEDULED,

    IOT_TASKPOOL_STATUS_DEFERRED,

    IOT_TASKPOOL_STATUS_COMPLETED,

    IOT_TASKPOOL_STATUS_CANCELED,

    IOT_TASKPOOL_STATUS_UNDEFINED,
} IotTaskPoolJobStatus_t;

/*------------------------- Task pool types and handles --------------------------*/

typedef struct _taskPool * IotTaskPool_t;

typedef struct IotTaskPoolJobStorage
{
    IotLink_t link;                 
    void * dummy2;                  
    void * dummy3;                  
    uint32_t dummy4;                
    IotTaskPoolJobStatus_t status;  
} IotTaskPoolJobStorage_t;

typedef struct _taskPoolJob * IotTaskPoolJob_t;

/*------------------------- Task pool parameter structs --------------------------*/

typedef void ( * IotTaskPoolRoutine_t )( IotTaskPool_t pTaskPool,
                                         IotTaskPoolJob_t pJob,
                                         void * pUserContext );

typedef struct IotTaskPoolInfo
{
    uint32_t minThreads; 
    uint32_t maxThreads; 
    uint32_t stackSize;  
    int32_t priority;    
} IotTaskPoolInfo_t;

/*------------------------- TASKPOOL defined constants --------------------------*/

/* @[define_taskpool_initializers] */
#define IOT_TASKPOOL_INFO_INITIALIZER_SMALL     { .minThreads = 1, .maxThreads = 1, .stackSize = IOT_THREAD_DEFAULT_STACK_SIZE, .priority = IOT_THREAD_DEFAULT_PRIORITY }

#define IOT_TASKPOOL_INFO_INITIALIZER_MEDIUM    { .minThreads = 1, .maxThreads = 2, .stackSize = IOT_THREAD_DEFAULT_STACK_SIZE, .priority = IOT_THREAD_DEFAULT_PRIORITY }

#define IOT_TASKPOOL_INFO_INITIALIZER_LARGE     { .minThreads = 2, .maxThreads = 3, .stackSize = IOT_THREAD_DEFAULT_STACK_SIZE, .priority = IOT_THREAD_DEFAULT_PRIORITY }

#define IOT_TASKPOOL_INFO_INITIALIZER_XLARGE    { .minThreads = 2, .maxThreads = 4, .stackSize = IOT_THREAD_DEFAULT_STACK_SIZE, .priority = IOT_THREAD_DEFAULT_PRIORITY }

#define IOT_TASKPOOL_INFO_INITIALIZER           IOT_TASKPOOL_INFO_INITIALIZER_MEDIUM

#define IOT_TASKPOOL_INITIALIZER                NULL

#define IOT_TASKPOOL_JOB_STORAGE_INITIALIZER    { { NULL, NULL }, NULL, NULL, 0, IOT_TASKPOOL_STATUS_UNDEFINED }

#define IOT_TASKPOOL_JOB_INITIALIZER            NULL
/* @[define_taskpool_initializers] */

#define IOT_TASKPOOL_JOB_HIGH_PRIORITY    ( ( uint32_t ) 0x00000001 )

#define IOT_SYSTEM_TASKPOOL               ( IotTaskPool_GetSystemTaskPool() )

#endif /* ifndef IOT_TASKPOOL_TYPES_H_ */