Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mothership-facing documentation for hardware idle compatibility #23

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions source/mothership.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,13 +242,21 @@ no other information about the application yet.
| | | down the Mothership process as |
| | | *quickly* as possible. |
+-----------------+-----------------------+-----------------------------------+
| `APP`, `EMPT` | 0. `std::string` | Loads all cores with instructions |
| | `codePath` | and data from the same binaries. |
| | 1. `std::string` | This is only used when the |
| | `dataPath` | Orchestrator is deploying an |
| | | application that uses hardware |
| | | level idle detection. This is not |
| | | application-specific. |
+-----------------+-----------------------+-----------------------------------+
| `APP`, `SPEC` | 0. `std::string` | Defines that an application on |
| | `appName` | the receiving Mothership process |
| | 1. `uint32_t` | must have received `distCount` |
| | `distCount` | unique distribution (`APP`, |
| | 2. `uint8_t` | `DIST` and `APP`, `SUPD`) |
| | `appNumber` | messages in order to be fully |
| | | defined. |
| | 3. `bool soloApp` | defined. |
+-----------------+-----------------------+-----------------------------------+
| `APP`, `DIST` | 0. `std::string` | Defines the properties for a |
| | `appName` | given core for a given |
Expand Down Expand Up @@ -469,9 +477,12 @@ information. `AppInfo` is a class with these fields:

- `std::string name`: The name of the application, redundant with the map key.

- `bool soloApp`: Defines how applications are loaded onto the hardware via
the backend. Defined by an (`APP`, `SPEC`) message.

- `AppState state`: The state that the application is in. Table 3 shows how
C&C messages consumed by `MPICncResolver` drive application states. These
states are enumerated by `AppState` as:
C&C messages consumed by `MPICncResolver` drive application states. These
states are enumerated by `AppState` as:

- `UNDERDEFINED`: The application has been partly sent to the Mothership
process, but some cores have not been defined, or their binaries refer to
Expand Down