Milestone (March 1 -> May 9)

[Dandielo]

Focus for this milestone is to improve, simplify and document the Tasks API, both for the system API and the provided implementation for IceShard.

The next milestone starting with iteration TBD (March 1'st)

Milestone: Task, Queues and Multithreading
Branch: ms-2303010415

Topic: Task, Queues and Multithreading

• Refactoring APIs: Task, Queues, Threads, Thread Pools
• Reimplementing Resource Tasks
• Reimplementing Asset Tasks
• Reimplementing GFX Tasks
• Reimplementing Frame Tasks

Resulting version change: [major, minor + 1, patch = 0]

Scope

So far this will be focused on the following things (by priority):

• Refactor the Tasks API #146 (address Remove 'Sleep' call from task_thead_v2::run #130)
• Refactor resource system task API #147
• Refactor asset system API and redesign the internal state machine. #148 (closes Data race on asset loader when two threads 'request' the same asset. #135)
• Redesign the Gfx API in the Engine interface. #149
• Update the Frame implementation in the Engine. #150
• Research the MSVC tail call issue related to coroutines. #111, Check if an optimizer bug found in the MSVC toolchain was fixed and remove resulting workarounds from the code. #108 (Depends on VS update containing the fix)
• Implement basic synchronization objects for linux. #90

Complexity estimations (1, 2, 3, 5, 8)

• [~5 + 1] Refactor the Tasks API #146 (address Remove 'Sleep' call from task_thead_v2::run #130)
• [3] Refactor resource system task API #147
• [5] Refactor asset system API and redesign the internal state machine. #148 (closes Data race on asset loader when two threads 'request' the same asset. #135)
• [5] Redesign the Gfx API in the Engine interface. #149
• [2] Update the Frame implementation in the Engine. #150
• [~] Research the MSVC tail call issue related to coroutines. #111, Check if an optimizer bug found in the MSVC toolchain was fixed and remove resulting workarounds from the code. #108 (Depends on VS update containing the fix)
• [2] Implement basic synchronization objects for linux. #90

Time estimations (rough values in hours)

• [10] Refactor the Tasks API #146 (address Remove 'Sleep' call from task_thead_v2::run #130)
• [7] Refactor resource system task API #147
• [12] Refactor asset system API and redesign the internal state machine. #148 (closes Data race on asset loader when two threads 'request' the same asset. #135)
• [10] Redesign the Gfx API in the Engine interface. #149
• [4] Update the Frame implementation in the Engine. #150
• [~] Research the MSVC tail call issue related to coroutines. #111, Check if an optimizer bug found in the MSVC toolchain was fixed and remove resulting workarounds from the code. #108 (Depends on VS update containing the fix)
• [6] Implement basic synchronization objects for linux. #90

Total time for included tasks: 49h
The current milestone limit is: 40h + 20h

Resulting stretch goal tasks:

• Implement a resource tagging API that allows to pick resources (and by extension assets) by providing a set of tags.
  • (no task created yet)

Final list of issues in this milestone

• Refactor the Tasks API #146 (address Remove 'Sleep' call from task_thead_v2::run #130)
• Refactor resource system task API #147
• Refactor asset system API and redesign the internal state machine. #148 (closes Data race on asset loader when two threads 'request' the same asset. #135)
• Redesign the Gfx API in the Engine interface. #149
• Update the Frame implementation in the Engine. #150 (over the limit by 3h)

[Dandielo]

Summary of this milestone:

• The core planned changes where delivered, however any work on the Engine interface was not done due to lack of time.
  In the end the milestone can be considered partial-success.
• The milestone was heavily affected by the fact that Conan was released to version 2, which broke a lot of tools and parts of the engine.
  • This is still not fully resolved, but allows already to work locally.
• New engine version: 0.3.0

[Dandielo]

Milestone finished with the following release:
https://github.com/iceshard-engine/engine/releases/tag/v0.3.0