PdcommGemFormattedProgramExecutionActionInfo

Struct

Description of an action, filled by pdcomm_gem_formatted_program_execution_action_info().

typedef struct PdcommGemFormattedProgramExecutionActionInfo { ... } PdcommGemFormattedProgramExecutionActionInfo

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

Before the call, set struct_size, set version to #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION, and zero reserved. The call writes every other field and leaves struct_size and version unchanged. Fields that do not apply to the action kind are 0.

Members

action_sequence

Field

Action sequence number; copy into the action token.

uint64_t action_sequence

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

cancel_next_command_index

Field

Cancel only: index of the first command that was not applied.

size_t cancel_next_command_index

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

capability_revision

Field

Start only: capability catalog revision of the admitting dry run.

uint64_t capability_revision

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

code_format

Field

Step only: SECS-II format code of the command code (#PDCOMM_SECS_ASCII, #PDCOMM_SECS_U1, #PDCOMM_SECS_U2, #PDCOMM_SECS_U4, or #PDCOMM_SECS_U8).

uint8_t code_format

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

command_count

Field

Number of commands in the program, for every kind.

size_t command_count

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

command_index

Field

Step only: zero-based index of the command to apply.

size_t command_index

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

dry_run_outcome

Field

Start only: outcome of the admitting dry run.

uint32_t dry_run_outcome

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

endpoint_id

Field

Endpoint identifier; copy into the action token.

uint64_t endpoint_id

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

execution_generation

Field

Execution generation; copy into the action token.

uint64_t execution_generation

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

id_format

Field

Start only: SECS-II format code of the program identifier.

uint8_t id_format

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

kind

Field

Action kind: START, STEP, or CANCEL.

uint32_t kind

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

parameter_count

Field

Step only: number of parameters of the command.

size_t parameter_count

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

policy_version

Field

Start only: dry-run policy version.

uint32_t policy_version

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

presence_mask

Field

Bit set of action presence flags.

uint32_t presence_mask

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

reserved

Field

Input: must be zero; written as zero.

uint8_t reserved[6]

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

session_generation

Field

HSMS session generation; copy into the action token.

uint64_t session_generation

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

struct_size

Field

Input: size of this structure, at least sizeof(PdcommGemFormattedProgramExecutionActionInfo).

size_t struct_size

Declared in: #include <pdcomm_gem_formatted_program_executions.h>

version

Field

Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION.

uint32_t version

Declared in: #include <pdcomm_gem_formatted_program_executions.h>