mw::log Component Requirements

Logging Component Requirements		status: valid security: YES safety: ASIL_B
realizes: wp__requirements_comp
doc__logging_requirements		Generic Document

Log and Trace

Log and Trace Framework consists of logging libraries and datarouter. The applications use logging libraries to write logs. datarouter implements logging daemon functionality, and can forward log messages from applications as DLT messages.

Use Log and Trace Framework		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__log_sources_user_app, feat_req__logging__log_sources belongs to: comp__logging
All output from logging and instrumentation based logging shall go through “mw::log” framework.
comp_req__log__use_log_trace_framework		Component Requirement

mw::log Configuration

Logging libraries use static configuration based on .json files.

Uniform Configuration File		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__config_entity_id, feat_req__logging__config_fallback belongs to: comp__logging
mw::log shall be uniformly configured via an application-specific configuration file. Configuration file location shall be relative to application binary. E.g.: ./<application name>/etc/logging.json.
comp_req__log__uniform_config_file		Component Requirement

Log Configuration Parameters		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__config_log_level, feat_req__logging__config_entity_id, feat_req__logging__config_log_filter belongs to: comp__logging
Application log configuration shall provide information necessary for log message generation and filtering. The provided parameter set includes, but is not limited to the following: application ID (appId), log mode for mw::log, default log level, log level assignments for individual context IDs.
comp_req__log__log_config_parameters		Component Requirement

Global Configuration Basis		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__config_fallback belongs to: comp__logging
Global configuration shall be used as basis for all applications. Global configuration shall remain in the file /etc/ecu_logging_config.json. Application-specific configuration shall override the global defaults.
comp_req__log__global_config_basis		Component Requirement

Configuration Fallback Defaults		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__config_fallback belongs to: comp__logging
mw::log shall fall back to a default value for a configuration item that is not available from the configuration files.
comp_req__log__config_fallback_defaults		Component Requirement

Discard Syntax Error Configuration		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__error_handling_recoverable belongs to: comp__logging
mw::log shall discard configuration files with syntax errors.
comp_req__log__discard_syntax_errors		Component Requirement

Discard Missing Configuration Files		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__error_handling_recoverable belongs to: comp__logging
mw::log shall discard configuration files that are not found.
comp_req__log__discard_missing_config		Component Requirement

Discard Invalid Settings		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__error_handling_recoverable belongs to: comp__logging
mw::log shall discard invalid configuration settings.
comp_req__log__discard_invalid_settings		Component Requirement

mw::log

Avoid Signal Processing		status: valid security: YES safety: ASIL_B
reqtype: Functional satisfies: feat_req__logging__error_handling_isolation, feat_req__logging__asil_support belongs to: comp__logging
The component 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 satisfies: feat_req__logging__security_log_access belongs to: comp__logging
The component shall set the FD_CLOEXEC (or O_CLOEXEC) flag on all the file descriptors it owns. 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 satisfies: feat_req__logging__compat_dlt belongs to: comp__logging
mw::log shall implement DLT verbose mode. Generation of messages shall be done in DLT-conform format, allowing messages to be sent by Datarouter without additional reprocessing.
comp_req__log__dlt_verbose_mode		Component Requirement

AUTOSAR Log and Trace Specification		status: valid security: YES safety: QM
reqtype: Functional satisfies: feat_req__logging__compat_dlt, feat_req__logging__severity_levels belongs to: comp__logging
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

Send Messages to Datarouter		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__log_sources_user_app, feat_req__logging__log_sinks_network belongs to: comp__logging
mw::log shall use logging library to send verbose messages to datarouter. Applications shall use mw::log interface to log verbose mode messages. Internally mw::log shall be using logging library.
comp_req__log__send_to_datarouter		Component Requirement

Inactive LogStream Behavior		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__filtering_log_levels, feat_req__logging__resource_performance belongs to: comp__logging
mw::log library shall not perform any useful activity if log level of LogStream object is insufficient for given context. LogStream object shall not generate serialized messages if the severity of the message does not allow it to be sent.
comp_req__log__inactive_logstream		Component Requirement

Shared Memory File Permissions		status: valid security: YES safety: ASIL_B
reqtype: Functional satisfies: feat_req__logging__security_log_access, feat_req__logging__config_permissions belongs to: comp__logging
Logging shared-memory files shall have read-only posix file permission for group and others. The shared-memory file created by mw::log shall be read-only for group and others. Note: mw::log creates a shared memory file for each app.
comp_req__log__shm_file_permissions		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 satisfies: feat_req__logging__log_sinks_console belongs to: comp__logging
The system logger backend shall forward the logs to the native system logger mechanism. Note: Under QNX, slogger2 shall be used.
comp_req__log__forward_to_system_logger		Component Requirement

System Backend Activation		status: valid security: NO safety: QM
reqtype: Functional satisfies: feat_req__logging__config_on_demand belongs to: comp__logging
The system logger backend shall be enabled if and only if the log mode contains “kSystem”.
comp_req__log__system_backend_activation		Component Requirement

Non-Functional Requirements

Local Allocation Strategy		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional satisfies: feat_req__logging__resource_runtime, feat_req__logging__asil_support belongs to: comp__logging
mw::log shall use local allocators to avoid using global heap. Global heap allocation (if any) shall be limited to initialization phase of application lifecycle.
comp_req__log__local_allocation_strategy		Component Requirement

No Endless Loops		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional satisfies: feat_req__logging__asil_support, feat_req__logging__resource_performance belongs to: comp__logging
mw::log shall not contain unbound loops or loops with unchecked exit conditions.
comp_req__log__no_endless_loops		Component Requirement

Avoid Locks		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional satisfies: feat_req__logging__asil_support, feat_req__logging__resource_performance belongs to: comp__logging
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 satisfies: feat_req__logging__asil_support, feat_req__logging__error_handling_isolation belongs to: comp__logging
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 satisfies: feat_req__logging__asil_support belongs to: comp__logging
Indices in data structures and sizes of data accessed or copied shall be checked for plausibility to avoid high runtime utilization through long iterations or data corruption.
comp_req__log__index_size_checking		Component Requirement

Memory Bound Checking		status: valid security: YES safety: ASIL_B
reqtype: Non-Functional satisfies: feat_req__logging__asil_support belongs to: comp__logging
Memory boundaries shall be explicitly checked when writing to shared memory.
comp_req__log__memory_bound_checking		Component Requirement