Requirements

KVS Requirements		status: valid security: YES safety: ASIL_B
tags: kvs version: 1 realizes: wp__requirements_comp
doc__kvs_requirements		Generic Document

Component Requirements

Language Bindings		status: valid security: NO safety: QM
tags: kvs reqtype: Non-Functional version: 1 derived from: feat_req__persistency__cpp_rust satisfied by: comp__persistency_kvs
The component shall provide API bindings for both the C++ and Rust programming languages.
comp_req__kvs__language_bindings		Component Requirement

Operating System Abstraction		status: valid security: NO safety: QM
tags: kvs reqtype: Non-Functional version: 1 derived from: feat_req__persistency__os_agnostic satisfied by: comp__persistency_kvs
The component shall access operating system services exclusively through an operating system abstraction layer.
comp_req__kvs__os_abstraction		Component Requirement

No Dynamic Memory Allocation at Runtime		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Non-Functional version: 1 derived from: feat_req__persistency__dynamic_memory_alloc satisfied by: comp__persistency_kvs
The component shall not allocate heap memory after a KVS instance has been successfully created or opened. All memory required for the instance’s operation shall be allocated during its opening, with the constraints defined by Constraint Configuration (comp_req__kvs__constraints).
comp_req__kvs__no_dynamic_memory		Component Requirement

Multi-Instance		status: valid security: NO safety: QM
tags: kvs reqtype: Functional testlink: TestMultipleInstanceIds__test_ok[rust] (passed); TestSameInstanceIdSameValue__test_ok[rust] (passed); TestSameInstanceIdDifferentValue__test_ok[rust] (passed); TestMultipleInstanceIds__test_ok[cpp] (passed); TestSameInstanceIdSameValue__test_ok[cpp] (passed); TestSameInstanceIdDifferentValue__test_ok[cpp] (passed) version: 2 derived from: feat_req__persistency__multiple_kvs satisfied by: comp__persistency_kvs
The component shall support the concurrent existence of multiple KVS instances, such that operations on one instance do not affect the data or state of any other instance.
comp_req__kvs__multi_instance		Component Requirement

Single Process Access		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__multiple_app satisfied by: comp__persistency_kvs
The component shall prevent a single KVS instance from being opened concurrently by more than one OS process.
comp_req__kvs__single_process_access		Component Requirement

Permission Control		status: valid security: YES safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__access_control satisfied by: comp__persistency_kvs
The component shall rely on the underlying filesystem for access and permission management and shall not implement its own access or permission controls.
comp_req__kvs__permission_control		Component Requirement

Permission Error Handling		status: valid security: YES safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__access_control satisfied by: comp__persistency_kvs
The component shall report any access or permission errors encountered at the filesystem level to the application.
comp_req__kvs__permission_err_hndl		Component Requirement

Storage File Permissions		status: valid security: YES safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__access_control satisfied by: comp__persistency_kvs
The component shall create storage files with file permissions 640 (owner read and write, group read, others none).
comp_req__kvs__storage_file_permissions		Component Requirement

Default Storage File Permissions		status: valid security: YES safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__access_control, feat_req__persistency__tooling satisfied by: comp__persistency_kvs
The component shall generate the default-values storage file, via the provided kvs tool, with read-only file permissions 440 (owner and group read, others none), so that the default storage deployed with the application cannot be modified at runtime.
comp_req__kvs__default_storage_permissions		Component Requirement

Constraint Configuration		status: valid security: YES safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cfg satisfied by: comp__persistency_kvs
The component shall allow configuration of KVS constraints at compile-time using source code constants or at runtime using a configuration file.
comp_req__kvs__constraints		Component Requirement

Constraint Configuration priority		status: valid security: YES safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cfg, feat_req__persistency__cfg_priority satisfied by: comp__persistency_kvs
The component shall give configurations provided by file higher priority than compile-time configurations.
comp_req__kvs__constraints_priority		Component Requirement

Maximum Number of Snapshots		status: valid security: YES safety: ASIL_B
tags: valid, kvs reqtype: Functional testlink: TestSnapshotMaxCount__test_ok[0-rust] (passed); TestSnapshotMaxCount__test_ok[1-rust] (passed); TestSnapshotMaxCount__test_ok[3-rust] (passed); TestSnapshotMaxCount__test_ok[0-cpp] (passed); TestSnapshotMaxCount__test_ok[1-cpp] (passed); TestSnapshotMaxCount__test_ok[3-cpp] (passed) version: 1 derived from: feat_req__persistency__cfg satisfied by: comp__persistency_kvs
The component shall maintain a configurable maximum number of snapshots. The maximum number shall be in the range <0..3>. A value of zero shall disable snapshot operations. A non-zero value shall specify the maximum number of snapshots. Default value shall be: 3.
comp_req__kvs__snapshot_max_num_cfg		Component Requirement

Key Naming		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional testlink: TestSupportedDatatypesKeys__test_valid_keys_accepted[rust] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[rust] (passed); TestSupportedDatatypesKeys__test_valid_keys_accepted[cpp] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[cpp] (passed) version: 1 derived from: feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs fulfilled by: comp_arc_dyn__kvs__dynamic_view, comp_arc_sta__kvs__2, comp_arc_sta__kvs__static_view
The component shall accept keys that consist solely of printable ASCII characters (0x20 - 0x7E).
comp_req__kvs__key_naming		Component Requirement

Key Encoding		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional testlink: TestSupportedDatatypesKeys__test_valid_keys_accepted[rust] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[rust] (passed); TestSupportedDatatypesKeys__test_valid_keys_accepted[cpp] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[cpp] (passed) version: 1 derived from: feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall encode each key as valid ASCII, compatible with UTF-8.
comp_req__kvs__key_encoding		Component Requirement

Key Uniqueness		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall ensure that keys are unique within a KVS instance and shall report an error when loading storage that contains duplicate keys.
comp_req__kvs__key_uniqueness		Component Requirement

Key Value Overwrite		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall overwrite the existing value with the new value when a value is set for a key that already exists.
comp_req__kvs__key_value_overwrite		Component Requirement

Key Length		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional testlink: TestSupportedDatatypesKeys__test_valid_keys_accepted[rust] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[rust] (passed); TestSupportedDatatypesKeys__test_valid_keys_accepted[cpp] (passed); TestSupportedDatatypesKeys__test_invalid_keys_rejected[cpp] (passed) version: 1 derived from: feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall disallow empty keys and limit the maximum length of a key to 32 bytes.
comp_req__kvs__key_length		Component Requirement

Key Existence Check		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall provide a capability to report whether a key has been explicitly written, returning false for a key that was never written even if a default value is available for it.
comp_req__kvs__key_exists_api		Component Requirement

Key Listing		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall provide a capability to retrieve the set of keys that have been explicitly written, excluding keys that only have a default value.
comp_req__kvs__key_list_api		Component Requirement

Key Removal		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__support_datatype_keys satisfied by: comp__persistency_kvs
The component shall provide a capability to delete a single explicitly-written key-value pair from the in-memory cache.
comp_req__kvs__key_remove_api		Component Requirement

Value Data Types		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestSupportedDatatypesValues_I32__test_ok[rust] (passed); TestSupportedDatatypesValues_U32__test_ok[rust] (passed); TestSupportedDatatypesValues_I64__test_ok[rust] (passed); TestSupportedDatatypesValues_U64__test_ok[rust] (passed); TestSupportedDatatypesValues_F64__test_ok[rust] (passed); TestSupportedDatatypesValues_Bool__test_ok[rust] (passed); TestSupportedDatatypesValues_String__test_ok[rust] (passed); TestSupportedDatatypesValues_Array__test_ok[rust] (passed); TestSupportedDatatypesValues_Object__test_ok[rust] (passed); TestSupportedDatatypesValues_I32__test_ok[cpp] (passed); TestSupportedDatatypesValues_U32__test_ok[cpp] (passed); TestSupportedDatatypesValues_I64__test_ok[cpp] (passed); TestSupportedDatatypesValues_U64__test_ok[cpp] (passed); TestSupportedDatatypesValues_F64__test_ok[cpp] (passed); TestSupportedDatatypesValues_Bool__test_ok[cpp] (passed); TestSupportedDatatypesValues_String__test_ok[cpp] (passed); TestSupportedDatatypesValues_Array__test_ok[cpp] (passed); TestSupportedDatatypesValues_Object__test_ok[cpp] (passed) version: 2 derived from: feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall accept only values of the following data types: Number, String, Boolean, Null, Array[Value], or Dictionary{Key:Value}.
comp_req__kvs__value_data_types		Component Requirement

Value Retrieval		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall provide a capability to retrieve the in-memory value associated with a key, returning the default value (see Value Default (comp_req__kvs__value_default)) when the key has not been explicitly written.
comp_req__kvs__value_get_api		Component Requirement

Value Store		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall provide a capability to store a value for a given key in the in-memory cache, overwriting any previously written value for that key (see Key Value Overwrite (comp_req__kvs__key_value_overwrite)).
comp_req__kvs__value_set_api		Component Requirement

Value Serialization		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall serialize and deserialize all values to and from JSON.
comp_req__kvs__value_serialize		Component Requirement

Value Default		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestDefaultValues__test_valid[optional-rust] (passed); TestDefaultValues__test_valid[required-rust] (passed); TestDefaultValues__test_valid[without-rust] (passed); TestRemoveKey__test_valid[optional-rust] (passed); TestRemoveKey__test_valid[required-rust] (passed); TestRemoveKey__test_valid[without-rust] (passed); TestMalformedDefaultsFile__test_invalid[optional-rust] (passed); TestMalformedDefaultsFile__test_invalid[required-rust] (passed); TestMissingDefaultsFile__test_invalid[required-rust] (passed); TestResetAllKeys__test_valid[optional-rust] (passed); TestResetAllKeys__test_valid[required-rust] (passed); TestResetSingleKey__test_valid[optional-rust] (passed); TestResetSingleKey__test_valid[required-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[optional-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[required-rust] (passed); TestDefaultValues__test_valid[optional-cpp] (passed); TestDefaultValues__test_valid[required-cpp] (passed); TestDefaultValues__test_valid[without-cpp] (passed); TestRemoveKey__test_valid[optional-cpp] (passed); TestRemoveKey__test_valid[required-cpp] (passed); TestRemoveKey__test_valid[without-cpp] (passed); TestMalformedDefaultsFile__test_invalid[optional-cpp] (passed); TestMalformedDefaultsFile__test_invalid[required-cpp] (passed); TestMissingDefaultsFile__test_invalid[required-cpp] (passed); TestResetAllKeys__test_valid[optional-cpp] (passed); TestResetAllKeys__test_valid[required-cpp] (passed); TestResetSingleKey__test_valid[optional-cpp] (passed); TestResetSingleKey__test_valid[required-cpp] (passed); TestChecksumOnProvidedDefaults__test_valid[optional-cpp] (passed); TestChecksumOnProvidedDefaults__test_valid[required-cpp] (passed) version: 2 derived from: feat_req__persistency__default_value_get, feat_req__persistency__default_values, feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall provide an API get_default_value to retrieve the default value of a key when no value has been set by the user.
comp_req__kvs__value_default		Component Requirement

Value Reset		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestResetAllKeys__test_valid[optional-rust] (passed); TestResetAllKeys__test_valid[required-rust] (passed); TestResetAllKeys__test_valid[optional-cpp] (passed); TestResetAllKeys__test_valid[required-cpp] (passed) version: 2 derived from: feat_req__persistency__default_values, feat_req__persistency__reset_to_default, feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall provide an API to reset a value to its default when a default value is defined. Note The default value can be retrieved via the get_default_value API.
comp_req__kvs__value_reset		Component Requirement

Default Value Datatypes		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestDefaultValues__test_valid[optional-rust] (passed); TestDefaultValues__test_valid[required-rust] (passed); TestDefaultValues__test_valid[without-rust] (passed); TestRemoveKey__test_valid[optional-rust] (passed); TestRemoveKey__test_valid[required-rust] (passed); TestRemoveKey__test_valid[without-rust] (passed); TestMalformedDefaultsFile__test_invalid[optional-rust] (passed); TestMalformedDefaultsFile__test_invalid[required-rust] (passed); TestMissingDefaultsFile__test_invalid[required-rust] (passed); TestResetAllKeys__test_valid[optional-rust] (passed); TestResetAllKeys__test_valid[required-rust] (passed); TestDefaultValues__test_valid[optional-cpp] (passed); TestDefaultValues__test_valid[required-cpp] (passed); TestDefaultValues__test_valid[without-cpp] (passed); TestRemoveKey__test_valid[optional-cpp] (passed); TestRemoveKey__test_valid[required-cpp] (passed); TestRemoveKey__test_valid[without-cpp] (passed); TestMalformedDefaultsFile__test_invalid[optional-cpp] (passed); TestMalformedDefaultsFile__test_invalid[required-cpp] (passed); TestMissingDefaultsFile__test_invalid[required-cpp] (passed); TestResetAllKeys__test_valid[optional-cpp] (passed); TestResetAllKeys__test_valid[required-cpp] (passed) version: 2 derived from: feat_req__persistency__default_values, feat_req__persistency__support_datatype_value satisfied by: comp__persistency_kvs
The component shall accept default values of only the value data types specified in Value Data Types (comp_req__kvs__value_data_types).
comp_req__kvs__default_value_types		Component Requirement

Default Value Query		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestDefaultValues__test_valid[optional-rust] (passed); TestDefaultValues__test_valid[required-rust] (passed); TestDefaultValues__test_valid[without-rust] (passed); TestDefaultValues__test_valid[optional-cpp] (passed); TestDefaultValues__test_valid[required-cpp] (passed); TestDefaultValues__test_valid[without-cpp] (passed) version: 2 derived from: feat_req__persistency__default_value_get, feat_req__persistency__default_values satisfied by: comp__persistency_kvs
The component shall provide an API to retrieve default values even if value is set by the user.
comp_req__kvs__default_value_query		Component Requirement

Default Value Status Query		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__default_value_get, feat_req__persistency__default_values satisfied by: comp__persistency_kvs
The component shall provide a capability to report whether a key has not been explicitly written and a default value is available for it.
comp_req__kvs__default_value_is_default_api		Component Requirement

Default Value Config		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestDefaultValues__test_valid[optional-rust] (passed); TestDefaultValues__test_valid[required-rust] (passed); TestDefaultValues__test_valid[without-rust] (passed); TestRemoveKey__test_valid[optional-rust] (passed); TestRemoveKey__test_valid[required-rust] (passed); TestRemoveKey__test_valid[without-rust] (passed); TestMalformedDefaultsFile__test_invalid[optional-rust] (passed); TestMalformedDefaultsFile__test_invalid[required-rust] (passed); TestMissingDefaultsFile__test_invalid[required-rust] (passed); TestResetAllKeys__test_valid[optional-rust] (passed); TestResetAllKeys__test_valid[required-rust] (passed); TestResetSingleKey__test_valid[optional-rust] (passed); TestResetSingleKey__test_valid[required-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[optional-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[required-rust] (passed); TestDefaultValues__test_valid[optional-cpp] (passed); TestDefaultValues__test_valid[required-cpp] (passed); TestDefaultValues__test_valid[without-cpp] (passed); TestRemoveKey__test_valid[optional-cpp] (passed); TestRemoveKey__test_valid[required-cpp] (passed); TestRemoveKey__test_valid[without-cpp] (passed); TestMalformedDefaultsFile__test_invalid[optional-cpp] (passed); TestMalformedDefaultsFile__test_invalid[required-cpp] (passed); TestMissingDefaultsFile__test_invalid[required-cpp] (passed); TestResetAllKeys__test_valid[optional-cpp] (passed); TestResetAllKeys__test_valid[required-cpp] (passed); TestResetSingleKey__test_valid[optional-cpp] (passed); TestResetSingleKey__test_valid[required-cpp] (passed); TestChecksumOnProvidedDefaults__test_valid[optional-cpp] (passed); TestChecksumOnProvidedDefaults__test_valid[required-cpp] (passed) version: 2 derived from: feat_req__persistency__default_value_file, feat_req__persistency__default_values satisfied by: comp__persistency_kvs
The component shall allow configuration of default values in a separate storage file generated by provided kvs tool.
comp_req__kvs__default_value_cfg		Component Requirement

Default Value Checksum		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional testlink: TestChecksumOnProvidedDefaults__test_valid[optional-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[required-rust] (passed); TestChecksumOnProvidedDefaults__test_valid[optional-cpp] (passed); TestChecksumOnProvidedDefaults__test_valid[required-cpp] (passed) version: 1 derived from: feat_req__persistency__default_value_file satisfied by: comp__persistency_kvs
The component shall secure the configuration file for default values with an associated checksum file when default values are stored in a file.
comp_req__kvs__default_val_chksum		Component Requirement

Reset Resistant Write		status: valid security: YES safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__reset_resistant satisfied by: comp__persistency_kvs
The component shall perform flush operations such that the previously persisted consistent data remains intact until a new flush operation has completed successfully.
comp_req__kvs__reset_resistant_write		Component Requirement

Corruption Detection on Open		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__integrity_check, feat_req__persistency__recovery_from_reset satisfied by: comp__persistency_kvs
The component shall detect an interrupted or corrupted storage file, via its integrity check, when a KVS instance is opened, and shall not automatically load the affected storage.
comp_req__kvs__corruption_detect_open		Component Requirement

Open Behavior on Missing or Corrupted Storage		status: valid security: YES safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cfg, feat_req__persistency__recovery_from_reset satisfied by: comp__persistency_kvs
The component shall behave according to the Need Kvs configuration parameter (represented by the OpenNeedKvs flag) when opening a KVS instance whose storage is missing or fails the integrity check: Required: the component shall report an error; Optional: the component shall report an error when the storage file exists but fails the integrity check, and shall open the KVS instance with an empty storage when no storage file exists; Ignore: the component shall open the KVS instance with an empty storage.
comp_req__kvs__open_need_kvs_behavior		Component Requirement

Recovery via Snapshot Restore		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__recovery_from_reset, feat_req__persistency__snapshot_restore satisfied by: comp__persistency_kvs
The component shall allow the user to explicitly restore a snapshot of their choice in order to recover the data after an interrupted or corrupted storage has been detected.
comp_req__kvs__recovery_snapshot_restore		Component Requirement

Atomic Store		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__atomic_store satisfied by: comp__persistency_kvs
The component shall persist all key-value pairs of a flush operation atomically, such that either all changes are written or none are.
comp_req__kvs__atomic_store		Component Requirement

Explicit Flush		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestExplicitFlush__test_data_stored[rust] (passed) version: 1 derived from: feat_req__persistency__store_data satisfied by: comp__persistency_kvs
The component shall persist in-memory key-value changes to storage only when the user explicitly calls the flush operation, and shall not flush automatically.
comp_req__kvs__explicit_flush		Component Requirement

Write Amplification Minimization		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Non-Functional version: 1 derived from: feat_req__persistency__write_amplification satisfied by: comp__persistency_kvs
The component shall write key-value data to the storage backend only when the in-memory data has changed since the last successful flush operation.
comp_req__kvs__write_amplification		Component Requirement

Cached Access		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access satisfied by: comp__persistency_kvs
The component shall hold key-value pairs in an in-memory cache and shall serve read and write access to key-value pairs from that cache.
comp_req__kvs__cached_access		Component Requirement

Store Reset		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access satisfied by: comp__persistency_kvs
The component shall provide a capability to remove all explicitly-written key-value pairs from the in-memory cache, restoring the KVS instance to its initial, empty state.
comp_req__kvs__store_reset_api		Component Requirement

Discard Pending Changes		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__cached_access, feat_req__persistency__load_data satisfied by: comp__persistency_kvs
The component shall provide a capability to reload key-value pairs from persistent storage, discarding every in-memory change made since the last successful flush operation (or since open, if flush was never called), without affecting default values.
comp_req__kvs__discard_pending_changes_api		Component Requirement

Persistent Data Storage Checksum Write		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__integrity_check, feat_req__persistency__store_data satisfied by: comp__persistency_kvs
The component shall generate a checksum for each data file and shall store it alongside the data.
comp_req__kvs__pers_data_csum		Component Requirement

Persistent Data Storage Checksum Verify		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__integrity_check, feat_req__persistency__load_data satisfied by: comp__persistency_kvs
The component shall verify the checksum when loading data, and shall report an error and not load the affected data when the checksum does not match.
comp_req__kvs__pers_data_csum_vrfy		Component Requirement

Persistent Data Storage Backend		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__integrity_check, feat_req__persistency__store_data satisfied by: comp__persistency_kvs
The component shall use the file API to persist data.
comp_req__kvs__pers_data_store_bnd		Component Requirement

Persistent Data Storage Format		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__integrity_check, feat_req__persistency__store_data satisfied by: comp__persistency_kvs
The component shall use the JSON data format to persist data.
comp_req__kvs__pers_data_store_fmt		Component Requirement

Storage Backend Selection		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__storage_backends satisfied by: comp__persistency_kvs
The component shall allow the storage backend used by a KVS instance to be selected via a compile-time configuration parameter.
comp_req__kvs__storage_backend_select		Component Requirement

Async API		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__async_api satisfied by: comp__persistency_kvs
The component shall provide an asynchronous API for flush function in addition to the standard API.
comp_req__kvs__async_api		Component Requirement

Callback Support		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__async_api, feat_req__persistency__async_completion satisfied by: comp__persistency_kvs
The component shall provide an API for registering callbacks that are triggered by data change events.
comp_req__kvs__callback_support		Component Requirement

Snapshot Create API		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional testlink: TestSnapshotCountFirstFlush__test_ok[0-rust] (passed); TestSnapshotCountFirstFlush__test_ok[1-rust] (passed); TestSnapshotCountFirstFlush__test_ok[3-rust] (passed); TestSnapshotCountFull__test_ok[0-rust] (passed); TestSnapshotCountFull__test_ok[1-rust] (passed); TestSnapshotCountFull__test_ok[3-rust] (passed); TestSnapshotRestorePrevious__test_ok[3-rust] (passed); TestSnapshotRestoreCurrent__test_error[rust] (passed); TestSnapshotRestoreNonexistent__test_error[rust] (passed); TestSnapshotPathsExist__test_ok[rust] (passed); TestSnapshotPathsNonexistent__test_error[rust] (passed); TestSnapshotCountFirstFlush__test_ok[0-cpp] (passed); TestSnapshotCountFirstFlush__test_ok[1-cpp] (passed); TestSnapshotCountFirstFlush__test_ok[3-cpp] (passed); TestSnapshotCountFull__test_ok[0-cpp] (passed); TestSnapshotCountFull__test_ok[1-cpp] (passed); TestSnapshotCountFull__test_ok[3-cpp] (passed); TestSnapshotRestorePrevious__test_ok[3-cpp] (passed); TestSnapshotRestoreCurrent__test_error[cpp] (passed); TestSnapshotRestoreNonexistent__test_error[cpp] (passed); TestSnapshotPathsExist__test_ok[cpp] (passed); TestSnapshotPathsNonexistent__test_error[cpp] (passed) version: 1 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall provide an API for creating a snapshot in the slot selected by index. See Snapshot Slot Indexing (comp_req__kvs__snapshot_id_api) and Snapshot Slot Index Validation (comp_req__kvs__snapshot_slot_index_vali). Note A snapshot is a point-in-time, frozen view of all values in a key-value storage.
comp_req__kvs__snapshot_create_api		Component Requirement

Snapshot Create		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall create a new snapshot in the selected snapshot slot when the slot is empty.
comp_req__kvs__snapshot_create		Component Requirement

Snapshot Overwrite		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional testlink: TestSnapshotRestorePrevious__test_ok[3-rust] (passed); TestSnapshotRestorePrevious__test_ok[3-cpp] (passed) version: 1 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall overwrite the selected snapshot slot when the slot is occupied.
comp_req__kvs__snapshot_overwrite		Component Requirement

Explicit Snapshot Operations		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__snapshot_create, feat_req__persistency__snapshot_remove, feat_req__persistency__snapshot_restore satisfied by: comp__persistency_kvs
The component shall perform snapshot creation, restoration, and deletion only when explicitly triggered by the user through the corresponding APIs.
comp_req__kvs__explicit_snapshot_operations		Component Requirement

Snapshot Slot Indexing		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional version: 2 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall identify snapshot slots by a one-based index in the range <1..3>, where the first slot has index 1, the second slot has index 2 and the third slot has index 3. See Maximum Number of Snapshots (comp_req__kvs__snapshot_max_num_cfg).
comp_req__kvs__snapshot_id_api		Component Requirement

Snapshot Slot Index Validation		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall return an error from every snapshot API that accepts a slot index when the provided index is zero or outside the range defined in Snapshot Slot Indexing (comp_req__kvs__snapshot_id_api).
comp_req__kvs__snapshot_slot_index_vali		Component Requirement

Snapshot Data Source		status: valid security: NO safety: ASIL_B
tags: valid, kvs reqtype: Functional version: 1 derived from: feat_req__persistency__snapshot_create satisfied by: comp__persistency_kvs
The component shall use the live values set by the user, regardless of whether the values have been flushed to disk.
comp_req__kvs__snapshot_source		Component Requirement

Snapshot Slot Free Query API		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__snapshot_create, feat_req__persistency__snapshot_remove satisfied by: comp__persistency_kvs
The component shall provide an API to check whether the slot selected by index is free or occupied. See Snapshot Slot Index Validation (comp_req__kvs__snapshot_slot_index_vali).
comp_req__kvs__snapshot_slot_free_api		Component Requirement

Snapshot Restore API		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional testlink: TestSnapshotRestorePrevious__test_ok[3-rust] (passed); TestSnapshotRestoreNonexistent__test_error[rust] (passed); TestSnapshotRestorePrevious__test_ok[3-cpp] (passed); TestSnapshotRestoreNonexistent__test_error[cpp] (passed) version: 1 derived from: feat_req__persistency__snapshot_restore satisfied by: comp__persistency_kvs
The component shall provide an API for restoring the snapshot in the slot selected by index, and shall return an error when that slot is free. See Snapshot Slot Index Validation (comp_req__kvs__snapshot_slot_index_vali).
comp_req__kvs__snapshot_restore_api		Component Requirement

Snapshot Remove API		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__snapshot_remove satisfied by: comp__persistency_kvs
The component shall provide an API for removing the snapshot in the slot selected by index, and shall return an error when that slot is free. See Snapshot Slot Index Validation (comp_req__kvs__snapshot_slot_index_vali).
comp_req__kvs__snapshot_remove_api		Component Requirement

Concurrency		status: valid security: NO safety: ASIL_B
tags: inspected, kvs reqtype: Functional testlink: TestMultipleInstanceIds__test_ok[rust] (passed); TestSameInstanceIdSameValue__test_ok[rust] (passed); TestSameInstanceIdDifferentValue__test_ok[rust] (passed); TestMultipleInstanceIds__test_ok[cpp] (passed); TestSameInstanceIdSameValue__test_ok[cpp] (passed); TestSameInstanceIdDifferentValue__test_ok[cpp] (passed) version: 1 derived from: feat_req__persistency__concurrency satisfied by: comp__persistency_kvs
The component shall implement thread-safe mechanisms to enable concurrent access to data without data races.
comp_req__kvs__concurrency		Component Requirement

Persistent Data Versioning		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__update_mechanism, feat_req__persistency__versioning satisfied by: comp__persistency_kvs
The component shall store a schema version identifier in each persisted data file.
comp_req__kvs__pers_data_version		Component Requirement

Persistent Data Schema		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 2 derived from: feat_req__persistency__update_mechanism, feat_req__persistency__versioning satisfied by: comp__persistency_kvs
The component shall use a JSON file storage format in which the schema version identifier is a dedicated top-level field, separate from the key-value payload.
comp_req__kvs__pers_data_schema		Component Requirement

Persistent Data Migration		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__update_mechanism, feat_req__persistency__variant_management, feat_req__persistency__versioning satisfied by: comp__persistency_kvs
The component shall migrate persisted data between supported schema versions without involvement of the application.
comp_req__kvs__pers_data_migration		Component Requirement

Random Access Time Complexity		status: valid security: NO safety: QM
tags: kvs reqtype: Non-Functional version: 1 derived from: feat_req__persistency__fast_access satisfied by: comp__persistency_kvs
The component shall provide random read access to a key-value pair with at most logarithmic time complexity relative to the number of stored key-value pairs.
comp_req__kvs__random_access_complexity		Component Requirement

Default Value Config tool		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__tooling satisfied by: comp__persistency_kvs
The component shall provide a tool to generate the default value storage file and its corresponding checksum file.
comp_req__kvs__default_value_cfg_tool		Component Requirement

Storage Tool		status: valid security: NO safety: ASIL_B
tags: kvs reqtype: Functional version: 1 derived from: feat_req__persistency__tooling satisfied by: comp__persistency_kvs
The component shall provide a tool to view, modify and validate storage files.
comp_req__kvs__storage_tool		Component Requirement

Environmental Requirements

none

Assumption of Use Requirements

none