.. _kieker-tools-sar:

Static Architecture Recovery
============================

Recover the architecture based on static code analysis done by the fparser tool.
The tool can currently recognize calls and data flow based on global variables,
e.g., common blocks in Fortran.

===== ========================== ======== ======================================================
Short Long                       Required Description
===== ========================== ======== ======================================================
-i    --input                    yes      Input directory
-o    --output                   yes      Output directory to store graphics and statistics
-M    --component-maps                    Component, file and function map files
-E    --experiment-name                   Name of the experiment
-H    --hostname                          Hostname to be used in CSV reconstruction
-g    --input-mode                        Input mode to be used for static analysis
                                          Possible Values: [CALL, DATAFLOW, BOTH]
-a    --missing-functions                 Output file for the list of functions without an
                                          associated file
-n    --missing-mappings-file             Output file for the list of files with a missing
                                          mapping in the mapping file. 
-m    --module-modes                      Module converter strategies (at lease one of):
                                          module-mode, file-mode, map-mode 
-sc   --separation-character              Separation character for CSV files, default is
                                          comma (,)
-l    --source-label                      Set source label for the read data
===== ========================== ======== ======================================================

The tool reads a list of operation calls, e.g., in Fortran, one subroutine
calling another one, and a data access list from CSV files.

These files are generated by the fparser-based tool that can be found in:
https://cau-git.rz.uni-kiel.de/ifi-ag-se/oceandsl/esm-coupling-analysis

The CSV files should use , as value separator. However, in case they
deviate as other tools to generate operation calls and dataflow are used,
the option allow to set a different character for operation calls -cs, dataflows
-ds, and names -ns from the function names CSV.

Call Input File
---------------

- source-path or component identifier
- source-module
- caller operation
- target-path or component identifier
- target-module
- callee operation (the called operation)

**Note** Dataflow is currently under revision and may not work as intended

Dataflow Input File
-------------------

- module or component identifyer
- operation accessing the data or writing to the data
- direction read or write or both
- shared-data name of the data storage

Function Names File
-------------------

You can use multiple function names files.

- component or module name
- function name

These maps are used to rewrite the component identifiers in a component call
in case these are set to the empty string "".