core.cxxm File Reference

DGP synchronization-contract typestate and validation interface. More...

import std;
import lib.error;
import zxfoundation.base.types;

Include dependency graph for core.cxxm:

Data Structures
struct	zxfoundation::dgp::sync_contract::contract_state
	Snapshot of synchronization state supplied to a DGP contract check. More...

Enumerations
enum class	zxfoundation::dgp::sync_contract::irq_contract : u8 { unchanged = 0 , must_be_enabled = 1 , must_be_disabled = 2 }
	Interrupt-state contract for an operation.
enum class	zxfoundation::dgp::sync_contract::lock_context : u8 {   boot_single_cpu = 0 , thread = 1 , irq_disabled = 2 , rcu_read_side = 3 ,   teardown = 4 }
	Execution context in which a DGP synchronization-sensitive operation occurs.
enum class	zxfoundation::dgp::sync_contract::teardown_phase : u8 {   none = 0 , deny_new_entries = 1 , drain_gates = 2 , drain_portals = 3 ,   release_memory = 4 , release_identity = 5 }
	Domain teardown phase used by lock-order documentation and checks.

Functions
auto	zxfoundation::dgp::sync_contract::advance_teardown_phase (teardown_phase &current, teardown_phase expected, teardown_phase requested) noexcept -> std::expected< void, lib::kernel_error >
	Advance a domain-owned teardown phase by exactly one stage.
auto	zxfoundation::dgp::sync_contract::contract_snapshot (lock_context context, teardown_phase phase, u32 domain_id) noexcept -> contract_state
	Capture the current CPU synchronization state for a DGP call-site check.
auto	zxfoundation::dgp::sync_contract::validate_authority_lookup (const contract_state &state) noexcept -> std::expected< void, lib::kernel_error >
	Validate that a DGP authority lookup may run in the supplied context.
auto	zxfoundation::dgp::sync_contract::validate_irq_state (const contract_state &state, irq_contract contract) noexcept -> std::expected< void, lib::kernel_error >
	Validate an IRQ-state precondition.
auto	zxfoundation::dgp::sync_contract::validate_teardown_phase (teardown_phase current, teardown_phase requested) noexcept -> std::expected< void, lib::kernel_error >
	Validate one exact teardown-phase transition.

Detailed Description

DGP synchronization-contract typestate and validation interface.

SPDX-License-Identifier: Apache-2.0

Function Documentation

advance_teardown_phase()

auto zxfoundation::dgp::sync_contract::advance_teardown_phase ( teardown_phase & current, teardown_phase expected, teardown_phase requested )->std::expected< void, lib::kernel_error >

nodiscardexportnoexcept

Advance a domain-owned teardown phase by exactly one stage.

Parameters

[in,out]	current	Stored phase owned by the domain being destroyed.
[in]	expected	Phase the domain must currently hold.
[in]	requested	Immediate phase to record.

Returns

Success when the stored phase was advanced.

Parameters

[in,out]	current	Stored phase owned by the domain being destroyed.
[in]	expected	Phase the domain must currently hold.
[in]	requested	Immediate phase to record.

Returns

Success when the stored phase was advanced.

Note

Callers must serialize access to current with the domain lifecycle lock.

contract_snapshot()

auto zxfoundation::dgp::sync_contract::contract_snapshot ( lock_context context, teardown_phase phase, u32 domain_id )->contract_state

nodiscardexportnoexcept

Capture the current CPU synchronization state for a DGP call-site check.

Parameters

[in]	context	Synchronization context expected by the caller.
[in]	phase	Domain teardown phase associated with the operation.
[in]	domain_id	Domain whose authority or lifecycle state is being checked.

Returns

Snapshot containing CPU ID, qspinlock depth, interrupt mask state, and RCU read-side state.

validate_authority_lookup()

auto zxfoundation::dgp::sync_contract::validate_authority_lookup ( const contract_state & state ) ->std::expected< void, lib::kernel_error >

nodiscardexportnoexcept

Validate that a DGP authority lookup may run in the supplied context.

Parameters

[in]

state

Current synchronization state.

Returns

Success when the context is safe for non-blocking authority validation.

validate_irq_state()

auto zxfoundation::dgp::sync_contract::validate_irq_state ( const contract_state & state, irq_contract contract )->std::expected< void, lib::kernel_error >

nodiscardexportnoexcept

Validate an IRQ-state precondition.

Parameters

[in]	state	Current synchronization state.
[in]	contract	Required interrupt-state contract.

Returns

Success when the current state satisfies the required interrupt condition.

validate_teardown_phase()

auto zxfoundation::dgp::sync_contract::validate_teardown_phase ( teardown_phase current, teardown_phase requested )->std::expected< void, lib::kernel_error >

nodiscardexportnoexcept

Validate one exact teardown-phase transition.

Parameters

[in]	current	Current teardown phase.
[in]	requested	Requested teardown phase.

Returns

Success when requested is the immediate successor of current.