From e139833eabdcb484f1d496e4e125acf0a75625b4 Mon Sep 17 00:00:00 2001
From: Jan <20126033+JanLJL@users.noreply.github.com>
Date: Mon, 19 Apr 2021 00:27:24 +0200
Subject: [PATCH] added lcd-timeout flag, citations and updated credits
---
README.rst | 20 +++++++++++++++-----
1 file changed, 15 insertions(+), 5 deletions(-)
diff --git a/README.rst b/README.rst
index 0698291..b2dc099 100644
--- a/README.rst
+++ b/README.rst
@@ -82,10 +82,10 @@ The usage of OSACA can be listed as:
.. code:: bash
- osaca [-h] [-V] [--arch ARCH] [--fixed] [--lines LINES] [--db-check]
- [--import MICROBENCH] [--insert-marker]
- [--export-graph GRAPHNAME] [--ignore-unknown] [--verbose]
- [--out OUT]
+ osaca [-h] [-V] [--arch ARCH] [--fixed] [--lines LINES]
+ [--ignore-unknown] [--lcd-timeout SECONDS]
+ [--db-check] [--import MICROBENCH] [--insert-marker]
+ [--export-graph GRAPHNAME] [--out OUT] [--verbose]
FILEPATH
-h, --help
@@ -118,6 +118,9 @@ The usage of OSACA can be listed as:
--ignore-unknown
Force OSACA to apply a throughput and latency of 0.0 cy for all unknown instruction forms.
If not specified, a warning will be printed instead if one ore more isntruction form is unknown to OSACA.
+--lcd-timeout SECONDS
+ Set timeout in seconds for LCD analysis. After timeout, OSACA will continue its analysis with the dependency paths found up to this point.
+ Defaults to `10`.
-v, --verbose
Increases verbosity level
-o OUT, --out OUT
@@ -370,9 +373,16 @@ In the bottom, all loop-carried dependencies are shown, each with a list of line
You can find more (already marked) examples and sample outputs for various architectures in the `examples `__ directory.
+Citations
+=========
+If you use OSACA for scientific work you can cite us as (for the Bibtex, see the `Wiki `_):
+
+* `Automated Instruction Stream Throughput Prediction for Intel and AMD Microarchitectures `_ (`Pre-print `_)
+* `Automatic Throughput and Critical Path Analysis of x86 and ARM Assembly Kernels `_ (`Pre-print `_)
+
Credits
=======
-Implementation: Jan Laukemann
+Implementation: Jan Laukemann, Julian Hammer
License
=======