Requirements Traceability

Test case → requirement mapping

ID	Title	Suite	Status	Depends On	Verifies
TC_SAFE_DATA_COMMIT_RESEALS_EXTERNAL_WRITE	commit reseals external write	safe_data	active	CONFIG_SAFE_DATA_ALLOW_UNCHECKED_COMMIT	SD-REQ-022
TC_SAFE_DATA_CONCURRENT_ACCESS_IS_SERIALISED	concurrent access is serialised	safe_data	active		SD-REQ-016
TC_SAFE_DATA_DETECTS_CORRUPTION	detects corruption	safe_data	active		SD-REQ-003; SD-REQ-009
TC_SAFE_DATA_DOUBLE_FAULT_UNRECOVERABLE	double fault unrecoverable	safe_data	active	CONFIG_SAFE_DATA_REDUNDANT	SD-REQ-010
TC_SAFE_DATA_FAULT_HANDLER_EVENTS	fault handler events	safe_data	active		SD-REQ-011; SD-REQ-013
TC_SAFE_DATA_FAULT_REACTION	fault reaction	safe_data_fault	active		SD-REQ-011
TC_SAFE_DATA_INIT_AND_VERIFY	init and verify	safe_data	active		SD-REQ-001; SD-REQ-003
TC_SAFE_DATA_LOCK_FROM_ISR_ASSERTS	lock from isr asserts	safe_data_fault	active	CONFIG_ASSERT	SD-REQ-015
TC_SAFE_DATA_LOCK_TIMEOUT_IS_BOUNDED_AND_REPORTED	lock timeout is bounded and reported	safe_data	active	CONFIG_SAFE_DATA_LOCK_TIMEOUT_MS > 0; CONFIG_SAFE_DATA_LOCKING	SD-REQ-014
TC_SAFE_DATA_NULL_ARGS	null args	safe_data	active		SD-REQ-002
TC_SAFE_DATA_READ_ROUNDTRIP	read roundtrip	safe_data	active		SD-REQ-005; SD-REQ-006
TC_SAFE_DATA_REDUCED_API_SURFACE	reduced api surface	safe_data	active		SD-REQ-020
TC_SAFE_DATA_SECTION_SCOPE	section scope	safe_data	active	CONFIG_SAFE_DATA_GNU_EXTENSIONS	SD-REQ-021
TC_SAFE_DATA_SELFTEST	selftest	safe_data	active	CONFIG_SAFE_DATA_SELFTEST	SD-REQ-017
TC_SAFE_DATA_STALE_TAG_RECOVERS	stale tag recovers	safe_data	draft	CONFIG_SAFE_DATA_REDUNDANT	SD-REQ-009
TC_SAFE_DATA_STATS_COUNT_EVENTS	stats count events	safe_data	active	CONFIG_SAFE_DATA_STATS	SD-REQ-012
TC_SAFE_DATA_UPDATE_ABORT_KEEPS_INTEGRITY	update abort keeps integrity	safe_data	active		SD-REQ-007
TC_SAFE_DATA_UPDATE_CLAMPS_POSITIVE_MUTATOR_RETURN	update clamps positive mutator return	safe_data	active		SD-REQ-008
TC_SAFE_DATA_UPDATE_COMMITS	update commits	safe_data	active		SD-REQ-007
TC_SAFE_DATA_VERIFY_REPAIR_FIXES_IN_PLACE	verify repair fixes in place	safe_data	active	CONFIG_SAFE_DATA_REDUNDANT	SD-REQ-004; SD-REQ-009
TC_SAFE_DATA_WRITE_OBSERVES_OVERWRITTEN_CORRUPTION	write observes overwritten corruption	safe_data	active	CONFIG_SAFE_DATA_WRITE_CHECKS_OLD; CONFIG_SAFE_DATA_STATS	SD-REQ-018
TC_SAFE_DATA_WRITE_RESEALS	write reseals	safe_data	obsolete		SD-REQ-006

Covered requirements

Requirements with at least one test case linked to them.

ID	Title	Verifies Back
SD-REQ-001	Sealing on initialisation	TC_SAFE_DATA_INIT_AND_VERIFY
SD-REQ-002	Argument validation	TC_SAFE_DATA_NULL_ARGS
SD-REQ-003	Pure verification	TC_SAFE_DATA_DETECTS_CORRUPTION; TC_SAFE_DATA_INIT_AND_VERIFY
SD-REQ-004	In-place repair under mutual exclusion	TC_SAFE_DATA_VERIFY_REPAIR_FIXES_IN_PLACE
SD-REQ-005	Validated read	TC_SAFE_DATA_READ_ROUNDTRIP
SD-REQ-006	Atomic sealed write	TC_SAFE_DATA_READ_ROUNDTRIP; TC_SAFE_DATA_WRITE_RESEALS
SD-REQ-007	Transactional read-modify-write	TC_SAFE_DATA_UPDATE_ABORT_KEEPS_INTEGRITY; TC_SAFE_DATA_UPDATE_COMMITS
SD-REQ-008	Mutator contract enforcement	TC_SAFE_DATA_UPDATE_CLAMPS_POSITIVE_MUTATOR_RETURN
SD-REQ-009	Single-copy fault recovery	TC_SAFE_DATA_DETECTS_CORRUPTION; TC_SAFE_DATA_STALE_TAG_RECOVERS; TC_SAFE_DATA_VERIFY_REPAIR_FIXES_IN_PLACE
SD-REQ-010	Double-fault detection	TC_SAFE_DATA_DOUBLE_FAULT_UNRECOVERABLE
SD-REQ-011	Configurable unrecoverable-fault reaction	TC_SAFE_DATA_FAULT_HANDLER_EVENTS; TC_SAFE_DATA_FAULT_REACTION
SD-REQ-012	Integrity-event statistics	TC_SAFE_DATA_STATS_COUNT_EVENTS
SD-REQ-013	Fault-handler registration and event reporting	TC_SAFE_DATA_FAULT_HANDLER_EVENTS
SD-REQ-014	Bounded lock acquisition	TC_SAFE_DATA_LOCK_TIMEOUT_IS_BOUNDED_AND_REPORTED
SD-REQ-015	No ISR-context locking	TC_SAFE_DATA_LOCK_FROM_ISR_ASSERTS
SD-REQ-016	Serialised access — no torn snapshots	TC_SAFE_DATA_CONCURRENT_ACCESS_IS_SERIALISED
SD-REQ-017	Integrity-mechanism self-test	TC_SAFE_DATA_SELFTEST
SD-REQ-018	Write may not silently mask corruption	TC_SAFE_DATA_WRITE_OBSERVES_OVERWRITTEN_CORRUPTION
SD-REQ-020	Reduced API surface at the Strict level	TC_SAFE_DATA_REDUCED_API_SURFACE
SD-REQ-021	Scoped access block	TC_SAFE_DATA_SECTION_SCOPE
SD-REQ-022	Unchecked commit	TC_SAFE_DATA_COMMIT_RESEALS_EXTERNAL_WRITE

Coverage gaps

Requirements not yet covered by any test case.

ID	Title
SD-REQ-019	Compile-time payload guards

Implementation → requirement

API symbols (impl needs from the API Traceability) and the requirements they satisfy (@satisfies in include/safe_data/safe_data.h). A requirement that constrains the whole API (argument validation, fault reaction, bounded locking, the ISR check, serialised access, the reduced API surface) is traced to each public symbol that contains the behaviour:

ID	Title	Depends On	Satisfies
IMPL-SAFE_COMMIT	SAFE_COMMIT	defined(CONFIG_SAFE_DATA_ALLOW_UNCHECKED_COMMIT)	SD-REQ-020
IMPL-SAFE_CONTAINER_DEFINE	SAFE_CONTAINER_DEFINE		SD-REQ-019
IMPL-safe_data_commit	safe_data_commit	defined(CONFIG_SAFE_DATA_ALLOW_UNCHECKED_COMMIT)	SD-REQ-002; SD-REQ-014; SD-REQ-015; SD-REQ-016; SD-REQ-020; SD-REQ-022
IMPL-safe_data_fault_handler	safe_data_fault_handler		SD-REQ-011
IMPL-safe_data_fault_handler_register	safe_data_fault_handler_register		SD-REQ-013
IMPL-safe_data_init	safe_data_init		SD-REQ-001; SD-REQ-002
IMPL-safe_data_read	safe_data_read		SD-REQ-002; SD-REQ-005; SD-REQ-014; SD-REQ-015; SD-REQ-016
IMPL-safe_data_selftest	safe_data_selftest	defined(CONFIG_SAFE_DATA_SELFTEST)	SD-REQ-017
IMPL-safe_data_stats_get	safe_data_stats_get		SD-REQ-002; SD-REQ-012
IMPL-safe_data_update	safe_data_update		SD-REQ-002; SD-REQ-007; SD-REQ-008; SD-REQ-014; SD-REQ-015; SD-REQ-016
IMPL-safe_data_verify	safe_data_verify		SD-REQ-002; SD-REQ-003; SD-REQ-011
IMPL-safe_data_verify_repair	safe_data_verify_repair		SD-REQ-002; SD-REQ-004; SD-REQ-009; SD-REQ-010; SD-REQ-011
IMPL-safe_data_write	safe_data_write		SD-REQ-002; SD-REQ-006; SD-REQ-014; SD-REQ-015; SD-REQ-016; SD-REQ-018
IMPL-SAFE_SECTION	SAFE_SECTION	defined(CONFIG_SAFE_DATA_GNU_EXTENSIONS)	SD-REQ-014; SD-REQ-015; SD-REQ-016; SD-REQ-020; SD-REQ-021

Requirements satisfied by an API symbol:

ID	Title	Satisfies Back
SD-REQ-001	Sealing on initialisation	IMPL-safe_data_init
SD-REQ-002	Argument validation	IMPL-safe_data_commit; IMPL-safe_data_init; IMPL-safe_data_read; IMPL-safe_data_stats_get; IMPL-safe_data_update; IMPL-safe_data_verify; IMPL-safe_data_verify_repair; IMPL-safe_data_write
SD-REQ-003	Pure verification	IMPL-safe_data_verify
SD-REQ-004	In-place repair under mutual exclusion	IMPL-safe_data_verify_repair
SD-REQ-005	Validated read	IMPL-safe_data_read
SD-REQ-006	Atomic sealed write	IMPL-safe_data_write
SD-REQ-007	Transactional read-modify-write	IMPL-safe_data_update
SD-REQ-008	Mutator contract enforcement	IMPL-safe_data_update
SD-REQ-009	Single-copy fault recovery	IMPL-safe_data_verify_repair
SD-REQ-010	Double-fault detection	IMPL-safe_data_verify_repair
SD-REQ-011	Configurable unrecoverable-fault reaction	IMPL-safe_data_fault_handler; IMPL-safe_data_verify; IMPL-safe_data_verify_repair
SD-REQ-012	Integrity-event statistics	IMPL-safe_data_stats_get
SD-REQ-013	Fault-handler registration and event reporting	IMPL-safe_data_fault_handler_register
SD-REQ-014	Bounded lock acquisition	IMPL-safe_data_commit; IMPL-safe_data_read; IMPL-safe_data_update; IMPL-safe_data_write; IMPL-SAFE_SECTION
SD-REQ-015	No ISR-context locking	IMPL-safe_data_commit; IMPL-safe_data_read; IMPL-safe_data_update; IMPL-safe_data_write; IMPL-SAFE_SECTION
SD-REQ-016	Serialised access — no torn snapshots	IMPL-safe_data_commit; IMPL-safe_data_read; IMPL-safe_data_update; IMPL-safe_data_write; IMPL-SAFE_SECTION
SD-REQ-017	Integrity-mechanism self-test	IMPL-safe_data_selftest
SD-REQ-018	Write may not silently mask corruption	IMPL-safe_data_write
SD-REQ-019	Compile-time payload guards	IMPL-SAFE_CONTAINER_DEFINE
SD-REQ-020	Reduced API surface at the Strict level	IMPL-SAFE_COMMIT; IMPL-safe_data_commit; IMPL-SAFE_SECTION
SD-REQ-021	Scoped access block	IMPL-SAFE_SECTION
SD-REQ-022	Unchecked commit	IMPL-safe_data_commit

Requirements that no API symbol satisfies:

No needs passed the filters