Skip to content
Snippets Groups Projects
Commit d01cd57c authored by Reiner Jung's avatar Reiner Jung
Browse files

Cleanup of documentation.

parent a9e32564
No related branches found
No related tags found
No related merge requests found
# OceanDSL Jvava Tools # OceanDSL Java Tools
Project containing all Java-based tools developed in OceanDSL. Project containing all Java-based tools developed in OceanDSL.
...@@ -14,7 +14,7 @@ Each tool has its own set of parameters and can be found in ...@@ -14,7 +14,7 @@ Each tool has its own set of parameters and can be found in
Current tools: Current tools:
- rewrite-log-entries - rewrite-log-entries
- create-architecture-model - create-architecture-model
- pp-static-log
......
...@@ -8,12 +8,24 @@ The tool is intended to be used in conjunctions with kieker-lang-pack-c Kieker l ...@@ -8,12 +8,24 @@ The tool is intended to be used in conjunctions with kieker-lang-pack-c Kieker l
`BeforeOperationEvent`s and `AfterOperationEvent`s do only contain pointer information for `BeforeOperationEvent`s and `AfterOperationEvent`s do only contain pointer information for
operation calls which must be resolved using `addr2line`. operation calls which must be resolved using `addr2line`.
This tool has 5 parameters: Parameters:
-i input kieker log directory> -i, --input (required) Input Kieker log directory or CSV file location
-o path where the output kieker log is placed -o, --output (required) Output directory to store graphics and statistics
-a the location of the addr2line executable to resolve the names -M, --component-map Component, file and function map file
-m the executable (model) to be analyzed by addr2line -a, --addrline Location of the addrline tool
-p prefix path to be removed from path information -e, --executable Location of the executable
-m, --mode Different input read modes, default is kieker; other option is csv
-ia, --input-architecture-model Directory for an input architecture model
-oa, --output-architecture-model Directory for an output architecture model
-l, --source-label (required) Set source label for the read data
-c, --case-insensitive Handle function names case insensitive
This is helpful with Fortran code as function names are handled
case insensitive.
-H, --hostname Hostname to be used in CSV reconstruction, this can be
used with static analysis data to simulate a deployment host
-E, --experiment-name (required) Name of the experiment
-g, --graphs Specify which output graphs must be generated (dot-op, dot-component, graphml)
Build Build
----- -----
......
Preprocessor for Static Logs
============================
Logs based on FParser produce a CSV file with three column refering
to caller file name, caller function name, callee function name.
The callee file name is missing. However, this can be inferred by other
means from the source code and stored in lookup tables. The
**pp-static-log** will read an 3 column CSV file use one or more
lookup tables and generate a 4 column output CSV file.
Parameters
-i, --input (required) Input 3 column static log file
-m, --map (required) Function to map files. One of more files separated by
a space.
-o, --output (required) Output file for 4 column log
...@@ -32,7 +32,7 @@ import com.beust.jcommander.converters.PathConverter; ...@@ -32,7 +32,7 @@ import com.beust.jcommander.converters.PathConverter;
public class Settings { public class Settings {
@Parameter(names = { "-i", @Parameter(names = { "-i",
"--input" }, required = true, converter = PathConverter.class, description = "Input 3 column static log directory") "--input" }, required = true, converter = PathConverter.class, description = "Input 3 column static log file")
private Path inputPath; private Path inputPath;
@Parameter(names = { "-m", @Parameter(names = { "-m",
...@@ -40,7 +40,7 @@ public class Settings { ...@@ -40,7 +40,7 @@ public class Settings {
private List<Path> mapPaths; private List<Path> mapPaths;
@Parameter(names = { "-o", @Parameter(names = { "-o",
"--output" }, required = true, converter = FileConverter.class, description = "Output directory for 4 column log") "--output" }, required = true, converter = FileConverter.class, description = "Output file for 4 column log")
private File outputFile; private File outputFile;
public Path getInputPath() { public Path getInputPath() {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment