104 lines
3.9 KiB
C
104 lines
3.9 KiB
C
// Copyright (c) 2013 Doug Binks
|
|
//
|
|
// This software is provided 'as-is', without any express or implied
|
|
// warranty. In no event will the authors be held liable for any damages
|
|
// arising from the use of this software.
|
|
//
|
|
// Permission is granted to anyone to use this software for any purpose,
|
|
// including commercial applications, and to alter it and redistribute it
|
|
// freely, subject to the following restrictions:
|
|
//
|
|
// 1. The origin of this software must not be misrepresented; you must not
|
|
// claim that you wrote the original software. If you use this software
|
|
// in a product, an acknowledgement in the product documentation would be
|
|
// appreciated but is not required.
|
|
// 2. Altered source versions must be plainly marked as such, and must not be
|
|
// misrepresented as being the original software.
|
|
// 3. This notice may not be removed or altered from any source distribution.
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
|
|
typedef struct enkiTaskScheduler enkiTaskScheduler;
|
|
typedef struct enkiTaskSet enkiTaskSet;
|
|
|
|
typedef void (* enkiTaskExecuteRange)( uint32_t start_, uint32_t end, uint32_t threadnum_, void* pArgs_ );
|
|
|
|
|
|
// Create a new task scheduler
|
|
enkiTaskScheduler* enkiNewTaskScheduler();
|
|
|
|
// Initialize task scheduler - will create GetNumHardwareThreads()-1 threads, which is
|
|
// sufficient to fill the system when including the main thread.
|
|
// Initialize can be called multiple times - it will wait for completion
|
|
// before re-initializing.
|
|
void enkiInitTaskScheduler( enkiTaskScheduler* pETS_ );
|
|
|
|
// Initialize a task scheduler with numThreads_ (must be > 0)
|
|
// will create numThreads_-1 threads, as thread 0 is
|
|
// the thread on which the initialize was called.
|
|
void enkiInitTaskSchedulerNumThreads( enkiTaskScheduler* pETS_, uint32_t numThreads_ );
|
|
|
|
|
|
// Delete a task scheduler
|
|
void enkiDeleteTaskScheduler( enkiTaskScheduler* pETS_ );
|
|
|
|
// Create a task set.
|
|
enkiTaskSet* enkiCreateTaskSet( enkiTaskScheduler* pETS_, enkiTaskExecuteRange taskFunc_ );
|
|
|
|
// Delete a task set.
|
|
void enkiDeleteTaskSet( enkiTaskSet* pTaskSet_ );
|
|
|
|
// Schedule the task
|
|
void enkiAddTaskSetToPipe( enkiTaskScheduler* pETS_, enkiTaskSet* pTaskSet_,
|
|
void* pArgs_, uint32_t setSize_ );
|
|
|
|
// Schedule the task with a minimum range.
|
|
// This should be set to a value which results in computation effort of at least 10k
|
|
// clock cycles to minimize tast scheduler overhead.
|
|
// NOTE: The last partition will be smaller than m_MinRange if m_SetSize is not a multiple
|
|
// of m_MinRange.
|
|
// Also known as grain size in literature.
|
|
void enkiAddTaskSetToPipeMinRange( enkiTaskScheduler* pETS_, enkiTaskSet* pTaskSet_,
|
|
void* pArgs_, uint32_t setSize_, uint32_t minRange_ );
|
|
|
|
|
|
// Check if TaskSet is complete. Doesn't wait. Returns 1 if complete, 0 if not.
|
|
int enkiIsTaskSetComplete( enkiTaskScheduler* pETS_, enkiTaskSet* pTaskSet_ );
|
|
|
|
|
|
// Wait for a given task.
|
|
// should only be called from thread which created the taskscheduler , or within a task
|
|
// if called with 0 it will try to run tasks, and return if none available.
|
|
void enkiWaitForTaskSet( enkiTaskScheduler* pETS_, enkiTaskSet* pTaskSet_ );
|
|
|
|
|
|
// Waits for all task sets to complete - not guaranteed to work unless we know we
|
|
// are in a situation where tasks aren't being continuosly added.
|
|
void enkiWaitForAll( enkiTaskScheduler* pETS_ );
|
|
|
|
|
|
// get number of threads
|
|
uint32_t enkiGetNumTaskThreads( enkiTaskScheduler* pETS_ );
|
|
|
|
// TaskScheduler implements several callbacks intended for profilers
|
|
typedef void (*enkiProfilerCallbackFunc)( uint32_t threadnum_ );
|
|
struct enkiProfilerCallbacks
|
|
{
|
|
enkiProfilerCallbackFunc threadStart;
|
|
enkiProfilerCallbackFunc threadStop;
|
|
enkiProfilerCallbackFunc waitStart;
|
|
enkiProfilerCallbackFunc waitStop;
|
|
};
|
|
|
|
// Get the callback structure so it can be set
|
|
struct enkiProfilerCallbacks* enkiGetProfilerCallbacks( enkiTaskScheduler* pETS_ );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif |