Component Requirements

mw::log Backend Component Requirements		status: valid security: YES safety: ASIL_B
version: 1 realizes: wp__requirements_comp
doc__mw_log_backend_requirements		Generic Document

mw::log

Inactive LogStream Behavior		status: valid security: NO safety: QM
reqtype: Functional testlink: DataRouterRecorderFixtureWithLogLevelCheck__WillObtainEmptySlotForInsufficentLogLevel (passed); DataRouterRecorderFixtureWithLogLevelCheck__DisablesOrEnablesLogAccordingToLevel (passed) version: 1 derived from: feat_req__logging__filtering_log_levels, feat_req__logging__resource_performance satisfied by: comp__mw_log_backend
mw::log library shall not perform any useful activity if log level of LogStream object is insufficient for given context.
comp_req__log__inactive_logstream		Component Requirement

Avoid Signal Processing		status: valid security: YES safety: ASIL_B
reqtype: Functional testlink: SignalHandlingTest__PThreadBlockSigTerm_AllSucceed_ReturnsSuccess (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__error_handling_isolation satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall not register any signal handler.
comp_req__log__avoid_signal_processing		Component Requirement

File Descriptor Flags		status: valid security: YES safety: ASIL_B
reqtype: Functional testlink: FileRecorderFactoryConfigFixture__FileConfigurionShallCallFileCreationAndReturnFileRecorder (passed); WriterFactoryFixture__WhenTheFileExistsItShallBeUnlinked (passed) version: 1 derived from: feat_req__logging__security_log_access satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall ensure that file descriptors it owns are not inherited by processes started by the application. Note This requirement can be satisfied in unit-test, by checking int flags = fcntl(fd, F_GETFD); assert((flags != -1) && (flags & FD_CLOEXEC)); for every file descriptor owned by the component.
comp_req__log__file_descriptor_flags		Component Requirement

DLT Verbose Mode		status: valid security: NO safety: QM
reqtype: Functional testlink: DataRouterBackendFixture__LogLevelVerbose (passed) version: 1 derived from: feat_req__logging__compat_dlt satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall generate log messages in DLT verbose mode format, so that Datarouter can send them without additional reprocessing.
comp_req__log__dlt_verbose_mode		Component Requirement

AUTOSAR Log and Trace Specification		status: valid security: YES safety: QM
reqtype: Functional testlink: DltMessageBuilderFixture__ShallDepleteAfterHeaderAndPayload (passed) version: 1 derived from: feat_req__logging__compat_dlt, feat_req__logging__severity_levels satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall implement “Specification of Log and Trace for Adaptive Platform”. Release of specification used shall be in agreement with the rest of Adaptive AUTOSAR stack.
comp_req__log__autosar_log_trace_spec		Component Requirement

Shared Memory File Permissions		status: valid security: YES safety: ASIL_B
reqtype: Functional version: 1 derived from: feat_req__logging__asil_support satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall ensure that the shared-memory files it creates are not writable by group and others. Note mw::log creates a shared memory file for each app.
comp_req__log__shm_file_permissions		Component Requirement

Remote Backend

Send Messages to Datarouter		status: valid security: NO safety: QM
reqtype: Functional testlink: DataRouterBackendFixture__LogLevelVerbose (passed); DatarouterMessageClientFixture__ConnectToDatarouterShouldSendConnectMessage (passed); DatarouterMessageClientFixture__AcquireNotifyShouldSendExpectedAcquireResponse (passed) version: 1 derived from: feat_req__logging__log_sinks_network, feat_req__logging__log_sources_user_app satisfied by: comp__mw_log_backend
mw::log shall hand over the log messages to the Datarouter process for forwarding when the remote backend is used. mw::log shall not transmit log messages to the network itself.
comp_req__log__send_to_datarouter		Component Requirement

Remote Backend Activation		status: valid security: NO safety: QM
reqtype: Functional version: 1 derived from: feat_req__logging__config_on_demand, feat_req__logging__log_sinks_local_fs satisfied by: comp__mw_log_backend
mw::log shall enable the file backend if and only if the log mode contains “kRemote”.
comp_req__log__remote_backend_activation		Component Requirement

System Backend

System logger backend shall forward the logs to the native system logger.

Forward to System Logger		status: valid security: NO safety: QM
reqtype: Functional testlink: SyslogBackendFixture__SyslogOpenlog (passed) version: 2 derived from: feat_req__logging__log_sinks_console satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall forward the logs to the native system logger mechanism when the system logger backend is used. Note mw::log shall use slogger2 on QNX and syslog(3) on Linux.
comp_req__log__forward_to_system_logger		Component Requirement

System Backend Activation		status: valid security: NO safety: QM
reqtype: Functional version: 1 derived from: feat_req__logging__config_on_demand satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall enable the system logger backend if and only if the log mode contains “kSystem”.
comp_req__log__system_backend_activation		Component Requirement

File Backend

File backend shall write the logs to the local file system.

Write to Local File		status: valid security: NO safety: QM
reqtype: Functional version: 1 derived from: feat_req__logging__log_sinks_local_fs satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall write the logs to a file on the local file system when the file backend is used.
comp_req__log__write_to_local_file		Component Requirement

File Backend Activation		status: valid security: NO safety: QM
reqtype: Functional version: 1 derived from: feat_req__logging__config_on_demand, feat_req__logging__log_sinks_local_fs satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall enable the file backend if and only if the log mode contains “kFile”.
comp_req__log__file_backend_activation		Component Requirement

Non-Functional Requirements

Heap Allocation Only During Initialization		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional testlink: FileRecorderFixture__TooManyArgumentsWillYieldTruncatedLog (passed); RecorderFactoryConfigFixture__RemoteConfiguredShallReturnDataRouterRecorder (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__resource_runtime satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall allocate heap memory only during the initialization phase of the application lifecycle, and shall therefore satisfy any memory needs after that phase from pre-allocated, bounded memory resources.
comp_req__log__local_allocation_strategy		Component Requirement

Avoid Locks		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional testlink: WaitFreeLinearWriter__EnsureAtomicRequirements (passed); CommonTests__TypesShallBeLockFree (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__resource_performance satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall be free of time-unbound locks and shall implement strategies to limit wait time. Time limit shall be defined based on requirements from functions on individual ECU. Mutual exclusion mechanisms shall include priority inversion protection.
comp_req__log__avoid_locks		Component Requirement

Cross-Locking Prevention		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional testlink: WaitFreeAlternatingWriterTests__EnsureAtomicRequirements (passed); WaitFreeLinearWriter__EnsureAtomicRequirements (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__error_handling_isolation satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
Cross-application and cross-thread dependencies shall be avoided. A thread logging in a loop shall not block other thread’s execution.
comp_req__log__cross_locking		Component Requirement

Index and Size Checking		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional testlink: LinearReaderTests__LengthExceedingMaxThresholdShouldReturnEmpty (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__error_handling_recoverable satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall check indices in data structures and sizes of data accessed or copied for plausibility, to avoid high runtime utilization through long iterations or data corruption. If a check fails, mw::log shall discard the affected log message without performing the access.
comp_req__log__index_size_checking		Component Requirement

Memory Bound Checking		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional testlink: SharedMemoryReaderFixture__GetterShallReadSharedDataNumberOfDropsInvalidSize (passed) version: 1 derived from: feat_req__logging__asil_support, feat_req__logging__error_handling_recoverable satisfied by: comp__mw_log_backend fulfilled by: comp_arc_sta__log__sv
mw::log shall check memory boundaries before writing to shared memory. If a check fails, mw::log shall discard the affected log message without performing the write.
comp_req__log__memory_bound_checking		Component Requirement