..
   # *******************************************************************************
   # Copyright (c) 2026 Contributors to the Eclipse Foundation
   #
   # See the NOTICE file(s) distributed with this work for additional
   # information regarding copyright ownership.
   #
   # This program and the accompanying materials are made available under the
   # terms of the Apache License Version 2.0 which is available at
   # https://www.apache.org/licenses/LICENSE-2.0
   #
   # SPDX-License-Identifier: Apache-2.0
   # *******************************************************************************

sample_safety_analysis
======================

Overview
--------

.. list-table::
   :header-rows: 1

   * - Failure Mode
     - Guideword
     - ASIL
     - Interface
   * - :ref:`SampleFailureMode <safety-analysis-samplelibrary-samplefailuremode>`
     - 
     - B
     - safety_software_seooc_example.SampleLibraryAPI.GetNumber
   * - :ref:`SampleFailureMode2 <safety-analysis-samplelibrary-samplefailuremode2>`
     - 
     - D
     - safety_software_seooc_example.SampleLibraryAPI.GetNumber


Failure Modes
-------------

.. dropdown:: SampleLibrary.SampleFailureMode
   :name: safety-analysis-samplelibrary-samplefailuremode

   .. grid:: 2
      :gutter: 3

      .. grid-item::
         :class: sd-text-center

         :bdg-warning:`ASIL B`

      .. grid-item-card:: Interface

         safety_software_seooc_example.SampleLibraryAPI.GetNumber

      .. grid-item-card:: Failure Effect

         The world as we know it will end

   .. grid:: 1

      .. grid-item-card:: Description

         SampleFailureMode takes over the world

   .. rubric:: Root Causes

   .. grid:: 1

      .. grid-item-card:: Just bad luck

         Source: :ref:`sample_fta.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta-puml>`, line 25

         .. grid:: 1

            .. grid-item-card::

               **JustBadLuck** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

               Sometimes, the dark side wins. We shall be prepared for that.

      .. grid-item-card:: No More Coffee

         Source: :ref:`sample_fta.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta-puml>`, line 31

         .. grid:: 1

            .. grid-item-card::

               **NoMoreCoffee** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

               We shall keep a coffee reserve for emergencies

      .. grid-item-card:: No More Cookies

         Source: :ref:`sample_fta.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta-puml>`, line 30

         .. grid:: 1

            .. grid-item-card::

               **NoMoreCookies** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

               We shall only order family size cookie jars

      .. grid-item-card:: Shared memory segment created with the wrong name

         Source: :ref:`sample_fta.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta-puml>`, line 26

         .. grid:: 1

            .. grid-item-card::

               **SampleAoU** :bdg-info:`Assumption of Use` :bdg-warning:`ASIL B`

               It shall be made sure that shared memory segments are never created with the wrong name (ShmemCreatedWrongName)

.. dropdown:: SampleLibrary.SampleFailureMode2
   :name: safety-analysis-samplelibrary-samplefailuremode2

   .. grid:: 2
      :gutter: 3

      .. grid-item::
         :class: sd-text-center

         :bdg-danger:`ASIL D`

      .. grid-item-card:: Interface

         safety_software_seooc_example.SampleLibraryAPI.GetNumber

      .. grid-item-card:: Failure Effect

         Downstream consumers time out

   .. grid:: 1

      .. grid-item-card:: Description

         SampleFailureMode2 responds too late

   .. rubric:: Root Causes

   .. grid:: 1

      .. grid-item-card:: Deadline monitor

         Source: :ref:`sample_fta2.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta2-puml>`, line 25

         .. grid:: 1

            .. grid-item-card::

               **DeadlineMonitor** :bdg-warning:`Mitigation` :bdg-danger:`ASIL D`

               Per-request deadline monitoring shall flag late responses

      .. grid-item-card:: Watchdog timer

         Source: :ref:`sample_fta2.puml <safety-analysis-sample-safety-analysis-fta-diagram-sample-fta2-puml>`, line 24

         .. grid:: 1

            .. grid-item-card::

               **WatchdogTimer** :bdg-warning:`Mitigation` :bdg-danger:`ASIL D`

               A watchdog shall detect overruns and force a safe state

Fault Trees
-----------

.. _safety-analysis-sample-safety-analysis-fta-diagram-sample-fta-puml:

sample_fta.puml
~~~~~~~~~~~~~~~

.. uml:: sample_fta.puml

.. _safety-analysis-sample-safety-analysis-fta-diagram-sample-fta2-puml:

sample_fta2.puml
~~~~~~~~~~~~~~~~

.. uml:: sample_fta2.puml

Safety Measures
---------------

.. grid:: 1

   .. grid-item-card::

      **SampleAoU** :bdg-info:`Assumption of Use` :bdg-warning:`ASIL B`

      It shall be made sure that shared memory segments are never created with the wrong name (ShmemCreatedWrongName)

   .. grid-item-card::

      **JustBadLuck** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

      Sometimes, the dark side wins. We shall be prepared for that.

   .. grid-item-card::

      **NoMoreCookies** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

      We shall only order family size cookie jars

   .. grid-item-card::

      **NoMoreCoffee** :bdg-warning:`Mitigation` :bdg-warning:`ASIL B`

      We shall keep a coffee reserve for emergencies

   .. grid-item-card::

      **WatchdogTimer** :bdg-warning:`Mitigation` :bdg-danger:`ASIL D`

      A watchdog shall detect overruns and force a safe state

   .. grid-item-card::

      **DeadlineMonitor** :bdg-warning:`Mitigation` :bdg-danger:`ASIL D`

      Per-request deadline monitoring shall flag late responses