Requirements

Persistency KVS Feature Requirements		status: valid safety: ASIL_B
tags: persistencykvs, persistency realizes: PROCESS_wp__requirements_feat
doc__persistency_kvs_feat_reqs		Generic Document

C++ & Rust Interoperability		status: valid security: NO safety: QM
tags: persistencykvs, persistency reqtype: Non-Functional satisfies: stkh_req__dev_experience__prog_languages
The Key-Value-Storage shall provide access through both C++ and Rust interfaces.
feat_req__persistency__cpp_rust_interop		Feature Requirement

Maximum Size		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store
The Key-Value-Storage shall support specification of its maximum size at compile time.
feat_req__persistency__maximum_size		Feature Requirement

Multiple KVS per Software Architecture Element		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__multi_instance
The Key-Value-Storage shall allow instantiating multiple independent stores per software architecture element.
feat_req__persistency__multiple_kvs		Feature Requirement

Supported Datatypes (Keys)		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__key_naming, comp_req__persistency__key_encoding, comp_req__persistency__key_uniqueness, comp_req__persistency__key_length fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__read_key, feat_arc_dyn__persistency__write_key
The Key-Value-Storage shall support UTF-8 encoded strings as valid key types.
feat_req__persistency__support_datatype_keys		Feature Requirement

Supported Datatypes (Values)		status: valid security: NO safety: ASIL_B
tags: persistency, persistencykvs reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__value_data_types, comp_req__persistency__value_serialize, comp_req__persistency__value_length, comp_req__persistency__value_default, comp_req__persistency__value_reset fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__read_key, feat_arc_dyn__persistency__write_key
The Key-Value-Storage shall support storing both primitive and non-primitive datatypes as values. The supported datatypes shall match those used by the IPC feature.
feat_req__persistency__support_datatype_value		Feature Requirement

Default Values		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__value_default, comp_req__persistency__value_reset, comp_req__persistency__default_value_types, comp_req__persistency__default_value_query, comp_req__persistency__default_value_config, comp_req__persistency__default_value_checksum fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__check_key_default, feat_arc_dyn__persistency__read_key
The Key-Value-Storage shall support predefined default values for keys.
feat_req__persistency__default_values		Feature Requirement

Default Value Retrieval		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__default_value_types, comp_req__persistency__default_value_query, comp_req__persistency__default_value_config, comp_req__persistency__default_value_checksum fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__check_key_default, feat_arc_dyn__persistency__read_key
The Key-Value-Storage shall support retrieving the default value associated with a key.
feat_req__persistency__default_value_get		Feature Requirement

Default Value Reset		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__default_value_types, comp_req__persistency__default_value_query, comp_req__persistency__default_value_config, comp_req__persistency__default_value_checksum
The Key-Value-Storage shall support resetting a single key or all keys to their respective default values.
feat_req__persistency__default_value_reset		Feature Requirement

Persistency		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__persist_data_store_com, comp_req__persistency__pers_data_csum_write, comp_req__persistency__pers_data_csum_verify, comp_req__persistency__pers_data_store_bend, comp_req__persistency__pers_data_store_fmt fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__flush, feat_arc_dyn__persistency__read_from_storage, feat_arc_dyn__persistency__snapshot_restore
The Key-Value-Storage shall persist stored data and provide an API to explicitly trigger persistence.
feat_req__persistency__persistency		Feature Requirement

Integrity Check		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__persist_data_store_com, comp_req__persistency__pers_data_csum_write, comp_req__persistency__pers_data_csum_verify, comp_req__persistency__pers_data_store_bend, comp_req__persistency__pers_data_store_fmt fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__flush, feat_arc_dyn__persistency__read_from_storage
The Key-Value-Storage shall detect and report data corruption. Note: Implementation depends on AoUs.
feat_req__persistency__integrity_check		Feature Requirement

Versioning		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__pers_data_version, comp_req__persistency__pers_data_schema
The Key-Value-Storage shall support versioning for different layout configurations.
feat_req__persistency__versioning		Feature Requirement

Update Mechanism		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__pers_data_version, comp_req__persistency__pers_data_schema
The Key-Value-Storage shall implement mechanisms to upgrade from one version to another, including multi-version jumps.
feat_req__persistency__update_mechanism		Feature Requirement

Snapshots		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functiona_req__support_of_store satisfied by: comp_req__persistency__snapshot_creation, comp_req__persistency__snapshot_max_num, comp_req__persistency__snapshot_id, comp_req__persistency__snapshot_rotate, comp_req__persistency__snapshot_restore, comp_req__persistency__snapshot_delete fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__flush, feat_arc_dyn__persistency__read_from_storage, feat_arc_dyn__persistency__snapshot_restore
The Key-Value-Storage shall support explicit creation of snapshots identified by unique IDs and allow rollback to previous snapshots. Snapshots shall also be deletable.
feat_req__persistency__snapshots		Feature Requirement

Tooling		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Non-Functional satisfies: stkh_req__functiona_req__support_of_store
The Key-Value-Storage shall provide tooling support for viewing and modifying key-value pairs during development and debugging.
feat_req__persistency__tooling		Feature Requirement

Variant management support		status: valid security: NO safety: QM
tags: persistencykvs, persistency reqtype: Non-Functional satisfies: stkh_req__overall_goals__variant_management fulfilled by: feat_arc_sta__persistency__static
The Key-Value-Storage shall ensure compatibility across different architectures and versions.
feat_req__persistency__variant_management		Feature Requirement

Set default key values via file		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functional_req__file_based satisfied by: comp_req__persistency__default_value_types, comp_req__persistency__default_value_query, comp_req__persistency__default_value_config, comp_req__persistency__default_value_checksum fulfilled by: feat_arc_sta__persistency__static
The Key-Value-Storage shall support the configuration of default key values using an external file.
feat_req__persistency__default_value_file		Feature Requirement

Configure limits via file		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functional_req__file_based satisfied by: comp_req__persistency__constraints fulfilled by: feat_arc_sta__persistency__static
The Key-Value-Storage shall support the configuration of memory and other resource limits via a configuration file.
feat_req__persistency__config_file		Feature Requirement

Store persistent data		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__functional_req__data_persistency satisfied by: comp_req__persistency__persist_data_store_com, comp_req__persistency__pers_data_csum_write, comp_req__persistency__pers_data_csum_verify, comp_req__persistency__pers_data_store_bend, comp_req__persistency__pers_data_store_fmt fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__flush, feat_arc_dyn__persistency__read_from_storage, feat_arc_dyn__persistency__snapshot_restore
The Key-Value-Storage shall support storing and loading its data to and from persistent storage.
feat_req__persistency__persist_data		Feature Requirement

Support engineering mode		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__dependability__safety_features satisfied by: comp_req__persistency__eng_mode
The Key-Value-Storage shall an engineering (developer) mode. The engineering mode shall allow unrestricted data access.
feat_req__persistency__eng_mode		Feature Requirement

Support field mode		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__dependability__safety_features satisfied by: comp_req__persistency__field_mode
The Key-Value-Storage shall a field mode. The field mode should enforce the most restrictive data access controls feasible.
feat_req__persistency__field_mode		Feature Requirement

Provide an async API		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__dependability__availability, stkh_req__app_architectures__support_request satisfied by: comp_req__persistency__async_api fulfilled by: feat_arc_sta__persistency__static, logic_arc_int__persistency__interface
The Key-Value-Storage shall provide an asynchronous API for accessing and manipulating data.
feat_req__persistency__async_api		Feature Requirement

Separate data stores		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__dependability__security_features satisfied by: comp_req__persistency__permission_control, comp_req__persistency__permission_err_handle fulfilled by: feat_arc_sta__persistency__static
The Key-Value-Storage shall ensure that only authorized components can access individual data stores.
feat_req__persistency__access_control		Feature Requirement

Data-change events		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__app_architectures__support_data satisfied by: comp_req__persistency__callback_support fulfilled by: feat_arc_sta__persistency__static, feat_arc_dyn__persistency__delete_key
The Key-Value-Storage shall provide an API that allows for the registration of callback functions. These callbacks shall be invoked in response to specific events, such as when keys are changed or removed.
feat_req__persistency__events		Feature Requirement

Fast access		status: valid security: NO safety: QM
tags: persistencykvs, persistency reqtype: Non-Functional satisfies: stkh_req__execution_model__short_app_cycles
The Key-Value-Storage shall ensure that key operations are completed within 5 milliseconds.
feat_req__persistency__fast_access		Feature Requirement

Intra-Process Data Access		status: valid security: NO safety: ASIL_B
tags: persistencykvs, persistency reqtype: Functional satisfies: stkh_req__communication__intra_process satisfied by: comp_req__persistency__concurrency fulfilled by: feat_arc_sta__persistency__static
The Key-Value-Storage shall support concurrent intra-process data access.
feat_req__persistency__intra_process_comm		Feature Requirement

AoU Requirements

Persistency Error handling		status: valid security: NO safety: ASIL_B
tags: environment, persistencykvs, persistency reqtype: Functional mititages: feat_saf_fmea__persistency__message_nreived, feat_saf_fmea__persistency__late_message, feat_saf_fmea__persistency__corrupted_message, feat_saf_fmea__persistency__not_sent, feat_saf_fmea__persistency__err_handl
The application shall handle if the feature persistency is not available.
aou_req__persistency__error_handling		Assumption of Use Requirement

Application deadlock		status: valid security: NO safety: ASIL_B
tags: environment, persistencykvs, persistency reqtype: Functional
The application shall be designed in a way that deadlocks are avoided.
aou_req__persistency__appl_design		Assumption of Use Requirement

Application execution		status: valid security: NO safety: ASIL_B
tags: environment, persistencykvs, persistency reqtype: Functional mititages: feat_saf_dfa__persistency__execution_blocking
The execution of persistency shall not be blocked by the application.
aou_req__persistency__appl_exec		Assumption of Use Requirement