enkiTS

通過GitHub贊助商或Patreon來支持Enkits的開發

ENKI任務調度程序

用於創建並行程序的允許許可的C和C ++任務調度程序。需要C ++ 11支持。

ENKIT的主要目標是幫助開發人員創建處理數據和任務級別並行性的程序，以利用多核CPU的全部性能，同時輕巧（僅少量代碼）且易於使用。

• C ++ API通過src/taskscheduler.h
• c api通過src/taskscheduler_c.h

Enkits是為Enkisoftware的Avoyd Codebase開發的。

平台

• Windows，Linux，Mac OS，Android（應在iOS上使用）
• x64＆x86，手臂

Enkits主要是在MS Windows上的X64和X86 Intel架構上開發的，對Linux的測試支持進行了經過良好測試，並且在Mac OS和ARM Android上進行了較少測試的支持。

例子

示例文件夾中存在幾個示例。

有關進一步的示例，請參見https://github.com/dougbinks/enkitsexamples

建築

構建enkit很簡單，只需將enkit/src中的文件添加到您的構建系統（_C。*如果您只需要C ++接口，就可以忽略文件），然後將enkits/src添加到您的INCLUCE路徑。 UNIX / Linux構建可能需要Pthreads庫。

對於C ++

• 使用#include "TaskScheduler.h"
• 將enkits/src添加到您的包含路徑
• 編譯 /添加項目：
  • TaskScheduler.cpp
• UNIX / Linux構建可能需要Pthreads庫。

對於c

• 使用#include "TaskScheduler_c.h"
• 將enkits/src添加到您的包含路徑
• 編譯 /添加項目：
  • TaskScheduler.cpp
  • TaskScheduler_c.cpp
• UNIX / Linux構建可能需要Pthreads庫。

對於Cmake，在安裝CMAKE的Windows / Mac OS X / Linux上，在Enkits目錄中打開一個提示

1. mkdir build
2. cd build
3. cmake ..
4. 運行make all或用於Visual Studio Open enkiTS.sln

項目功能

1. 輕量級- Enkits設計為瘦身，因此您可以輕鬆地使用它並理解它。
2. 快速，然後可擴展- enkits首先是為消費設備設計的，因此在較低的線程上的性能很重要，其次是可擴展性。
3. 編織的並行性- Enkits可以從另一個任務以及創建任務系統的線程中發布任務，並具有簡單的任務接口，用於數據並行和任務並行性。
4. 前期分配友好- ENKITS是在安排期間為零分配而設計的。
5. 可以將任務固定到給定的線程- Enkits可以安排僅在指定線程上運行的任務。
6. 可以設置任務優先級- 最多可以通過define enkits_task_priorities_num（默認為3）來配置最多5個任務優先級。更高的優先任務是在較低的優先級之前運行的。
7. 可以註冊用於與Enkits一起使用的外部線程- 可以用NumexternalTask​​Threads配置Enkits，可以註冊以與Enkits API一起使用。
8. 自定義分配器API-可以使用自定義分配器配置ENKIT，請參見示例/customallocator.cpp和example/customallocator_c.c.c。
9. 依賴項- 可以在任務之間設置依賴項，請參見示例/依賴項.cpp和example/dependencies_c.c。
10. 完成操作- 可以對任務完成執行動作。這避免了將任務添加到調度程序的昂貴動作，並且可以用來安全刪除完成的任務。請參閱示例/ploteionAction.cpp和example/ploteionAction_c.c.c
11. 新的可以等待固定任務- 可以等待固定任務，這對於創建沒有其他工作的IO線程很有用。請參閱示例/waitfornewpinnedtasks.cpp和example/waitfornewpinnedtasks_c.c。

安裝

我建議直接在每個項目中直接使用Enkits，而不是將其安裝以進行系統大量使用。但是，如果ENKITS_INSTALL cmake變量設置為ON （默認為OFF ），則ENKITS的CMAKE腳本也可用於安裝庫。

安裝後，將標頭文件安裝在Include路徑的子目錄中， include/enkiTS以確保它們不會與其他軟件包中的標頭文件衝突。當構建應用程序確保這是INCLUDE_PATH變量的一部分時，或者確保Enkits在源文件中的標頭路徑中，例如使用#include "enkiTS/TaskScheduler.h" ，而不是#include "TaskScheduler.h" 。

使用enkit

C ++用法

• 示例/parellelsum.cpp中的完整示例
• c示例中的示例/parallelsum_c.c

 #include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;

// define a task set, can ignore range if we only do one thing
struct ParallelTaskSet : enki :: ITaskSet {
    void ExecuteRange (  enki :: TaskSetPartition range_ , uint32_t threadnum_ ) override {
        // do something here, can issue tasks with g_TS
    }
};

int main ( int argc , const char * argv []) {
    g_TS . Initialize ();
    ParallelTaskSet task ; // default constructor has a set size of 1
    g_TS . AddTaskSetToPipe ( & task );

    // wait for task set (running tasks if they exist)
    // since we've just added it and it has no range we'll likely run it.
    g_TS . WaitforTask ( & task );
    return 0 ;
}

C ++ 11使用

• 示例/lambdatask.cpp中的完整示例

 #include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;

int main ( int argc , const char * argv []) {
   g_TS . Initialize ();

   enki:: TaskSet task ( 1 , []( enki :: TaskSetPartition range_ , uint32_t threadnum_  ) {
         // do something here
      }  );

   g_TS . AddTaskSetToPipe ( & task );
   g_TS . WaitforTask ( & task );
   return 0 ;
}

C ++中的任務優先級使用

• 示例/優先級中的完整示例
• c示例中的示例/優先級_c.c

 // See full example in Priorities.cpp
#include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;

struct ExampleTask : enki :: ITaskSet
{
    ExampleTask ( ) { m_SetSize = size_ ; }

    void ExecuteRange (  enki :: TaskSetPartition range_ , uint32_t threadnum_ ) override {
        // See full example in Priorities.cpp
    }
};


// This example demonstrates how to run a long running task alongside tasks
// which must complete as early as possible using priorities.
int main ( int argc , const char * argv [])
{
    g_TS . Initialize ();

    ExampleTask lowPriorityTask ( 10 );
    lowPriorityTask . m_Priority  = enki :: TASK_PRIORITY_LOW ;

    ExampleTask highPriorityTask ( 1 );
    highPriorityTask . m_Priority = enki :: TASK_PRIORITY_HIGH ;

    g_TS . AddTaskSetToPipe ( & lowPriorityTask );
    for ( int task = 0 ; task < 10 ; ++ task )
    {
        // run high priority tasks
        g_TS . AddTaskSetToPipe ( & highPriorityTask );

        // wait for task but only run tasks of the same priority or higher on this thread
        g_TS . WaitforTask ( & highPriorityTask , highPriorityTask . m_Priority );
    }
    // wait for low priority task, run any tasks on this thread whilst waiting
    g_TS . WaitforTask ( & lowPriorityTask );

    return 0 ;
}

在C ++中固定任務使用率

• 示例/pinnedtask.cpp中的完整示例
• c示例中的示例/pinnedtask_c.c.c

 #include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;

// define a task set, can ignore range if we only do one thing
struct PinnedTask : enki :: IPinnedTask {
    void Execute () override {
      // do something here, can issue tasks with g_TS
    }
};

int main ( int argc , const char * argv []) {
    g_TS . Initialize ();
    PinnedTask task ; //default constructor sets thread for pinned task to 0 (main thread)
    g_TS . AddPinnedTask ( & task );

    // RunPinnedTasks must be called on main thread to run any pinned tasks for that thread.
    // Tasking threads automatically do this in their task loop.
    g_TS . RunPinnedTasks ();

    // wait for task set (running tasks if they exist)
    // since we've just added it and it has no range we'll likely run it.
    g_TS . WaitforTask ( & task );
    return 0 ;
}

C ++的依賴性用法

• 示例/依賴項中的完整示例.cpp
• C示例中的c示例/依賴項_c.c

 #include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;

// define a task set, can ignore range if we only do one thing
struct TaskA : enki :: ITaskSet {
    void ExecuteRange (  enki :: TaskSetPartition range_ , uint32_t threadnum_ ) override {
        // do something here, can issue tasks with g_TS
    }
};

struct TaskB : enki :: ITaskSet {
    enki:: Dependency m_Dependency ;
    void ExecuteRange (  enki :: TaskSetPartition range_ , uint32_t threadnum_ ) override {
        // do something here, can issue tasks with g_TS
    }
};

int main ( int argc , const char * argv []) {
    g_TS . Initialize ();
    
    // set dependencies once (can set more than one if needed).
    TaskA taskA ;
    TaskB taskB ;
    taskB . SetDependency ( taskB . m_Dependency , & taskA );

    g_TS . AddTaskSetToPipe ( & taskA ); // add first task
    g_TS . WaitforTask ( & taskB );      // wait for last
    return 0 ;
}

C ++中的外部任務線程用法

• 示例/externaltaskthread.cpp中的完整示例
• C示例中的示例/externalTask​​Thread_c.c.c

 #include "TaskScheduler.h"

enki:: TaskScheduler g_TS ;
struct ParallelTaskSet : ITaskSet
{
    void ExecuteRange (  enki :: TaskSetPartition range_ , uint32_t threadnum_ ) override {
        // Do something
    }
};

void threadFunction ()
{
    g_TS . RegisterExternalTaskThread ();

    // sleep for a while instead of doing something such as file IO
    std::this_thread::sleep_for( std ::chrono:: milliseconds ( num_ * 100 ) );

    ParallelTaskSet task ;
    g_TS . AddTaskSetToPipe ( & task );
    g_TS . WaitforTask ( & task );

    g_TS . DeRegisterExternalTaskThread ();
}

int main ( int argc , const char * argv [])
{
    enki:: TaskSchedulerConfig config ;
    config . numExternalTaskThreads = 1 ; // we have one extra external thread

    g_TS . Initialize ( config );

    std:: thread exampleThread ( threadFunction );

    exampleThread . join ();

    return 0 ;
}

waitforpinnedtasks在C ++中的線程使用率（對IO線程有用）

• 示例/waitfornewpinnedtasks.cpp中的完整示例
• c示例中的示例/waitfornewpinnedtasks_c.c.c

# include " TaskScheduler.h "

enki::TaskScheduler g_TS;

struct RunPinnedTaskLoopTask : enki::IPinnedTask
{
    void Execute () override
    {
        while ( !g_TS. GetIsShutdownRequested () )
        {
            g_TS. WaitForNewPinnedTasks (); // this thread will 'sleep' until there are new pinned tasks
            g_TS. RunPinnedTasks ();
        }
    }
};

struct PretendDoFileIO : enki::IPinnedTask
{
    void Execute () override
    {
        // Do file IO
    }
};

int main ( int argc, const char * argv[])
{
    enki::TaskSchedulerConfig config;

    // In this example we create more threads than the hardware can run,
    // because the IO thread will spend most of it's time idle or blocked
    // and therefore not scheduled for CPU time by the OS
    config. numTaskThreadsToCreate += 1 ;

    g_TS. Initialize ( config );

    // in this example we place our IO threads at the end
    RunPinnedTaskLoopTask runPinnedTaskLoopTasks;
    runPinnedTaskLoopTasks. threadNum = g_TS. GetNumTaskThreads () - 1 ;
    g_TS. AddPinnedTask ( &runPinnedTaskLoopTasks );

    // Send pretend file IO task to external thread FILE_IO
    PretendDoFileIO pretendDoFileIO;
    pretendDoFileIO. threadNum = runPinnedTaskLoopTasks. threadNum ;
    g_TS. AddPinnedTask ( &pretendDoFileIO );

    // ensure runPinnedTaskLoopTasks complete by explicitly calling shutdown
    g_TS. WaitforAllAndShutdown ();

    return 0 ;
}

綁定

• C＃enkitasks C＃

棄用

C ++ 98兼容分支已被棄用，因為我不知道有人需要它。

用戶線程版本不再使用，因為它們不再使用。可以使用外部詞法讀物獲得類似的功能

• Branch用戶線上的用戶線程版本用戶線程在其他任務 /線程系統上運行ENKIT，因此可以像其他引擎一樣使用它，例如在其他引擎中使用。
• C ++ 11版的用戶線程在分支UserThread_c ++ 11

使用Enkits的項目

雅芳

Avoyd是一種抽象的6度自由度Voxel遊戲。 Enkits是開髮用於我們的內部發動機供電Avoyd的。

Imogen

GPU/CPU紋理髮生器

TOYPATHRACER

ArasPranckevičius的代碼在每日路徑示踪劑上使用各種語言進行實驗。

。

使用Vulkan掌握圖形編程

Marco Castorina和Gabriel Sassone的書關於使用Vulkan API從第一原理開發現代渲染引擎的書。 Enkits用作任務庫來跨內核分發工作。

許可證（Zlib）

版權（C）2013-2020 Doug Binks

該軟件提供了“原樣”，而無需任何明示或暗示的保證。在任何情況下，作者都不應對使用此軟件造成的任何損害負責。

授予任何人，包括任何目的，包括商業應用程序，並將其更改並自由地重新分配，但要予以自由限制：

1. 該軟件的起源不得歪曲；您不得聲稱自己編寫了原始軟件。如果您在產品中使用此軟件，則將對產品文檔的確認表示讚賞，但不需要。
2. 更改的源版本必須明確標記為此類版本，並且不得將其歪曲為原始軟件。
3. 本通知不得從任何源分佈中刪除或更改。