tf_fuzz: refactor directory structure
Move all C++ source and files related to the C++ tfz binary into a
tfz-cpp subdirectory, and create a new Python project for the suite
generator.
Change-Id: I15aa0ba20e83d6713d17d25b6d636f63ac14f229
Signed-off-by: Nik Dewally <Nik.Dewally@arm.com>
diff --git a/docs/tf_fuzz/source_structure/asset_dir.rst b/docs/tf_fuzz/source_structure/asset_dir.rst
index 4eb358d..46d34d8 100644
--- a/docs/tf_fuzz/source_structure/asset_dir.rst
+++ b/docs/tf_fuzz/source_structure/asset_dir.rst
@@ -1,6 +1,6 @@
-########################
-'assets'-directory guide
-########################
+################################
+'tfz-cpp/assets'-directory guide
+################################
************
Introduction
@@ -11,9 +11,9 @@
during the Simulate phase, after Parse phase, which parses the test-template
file, and prior to writing out the generated C code.
-***********************************************
-``.../tools/tf_fuzz/assets`` directory contents
-***********************************************
+*********************************************
+``tf_fuzz/tfz-cpp/assets`` directory contents
+*********************************************
.. code-block:: bash
crypto_asset.cpp psa_asset.cpp sst_asset.cpp
diff --git a/docs/tf_fuzz/source_structure/boilerplate_dir.rst b/docs/tf_fuzz/source_structure/boilerplate_dir.rst
index d4aea0e..e21bfb3 100644
--- a/docs/tf_fuzz/source_structure/boilerplate_dir.rst
+++ b/docs/tf_fuzz/source_structure/boilerplate_dir.rst
@@ -1,19 +1,19 @@
-#############################
-'boilerplate'-directory guide
-#############################
+#####################################
+'tfz-cpp/boilerplate'-directory guide
+#####################################
************
Introduction
************
This directory contains the C++ header and code files to work with the
-customizable, "boilerplate" code snippets in the ``...tools/tf_fuzz/lib``
+customizable, "boilerplate" code snippets in the ``tf_fuzz/lib``
directory. Mostly what this code does is read these code snippets into an
STL ``vector`` of, essentially, named strings.
-****************************************************
-``.../tools/tf_fuzz/boilerplate`` directory contents
-****************************************************
+**************************************************
+``tf_fuzz/tfz-cpp/boilerplate`` directory contents
+**************************************************
.. code-block:: bash
boilerplate.cpp boilerplate.hpp
diff --git a/docs/tf_fuzz/source_structure/calls_dir.rst b/docs/tf_fuzz/source_structure/calls_dir.rst
index 17c2491..5eb0e63 100644
--- a/docs/tf_fuzz/source_structure/calls_dir.rst
+++ b/docs/tf_fuzz/source_structure/calls_dir.rst
@@ -1,6 +1,6 @@
-#######################
-'calls'-directory guide
-#######################
+###############################
+'tfz-cpp/calls'-directory guide
+###############################
************
Introduction
@@ -16,9 +16,9 @@
Each ``psa_call``-subclass object encapsulates the initial and expected data,
expected pass/fail results, and other information about the call.
-**********************************************
-``.../tools/tf_fuzz/calls`` directory contents
-**********************************************
+********************************************
+``tf_fuzz/tfz-cpp/calls`` directory contents
+********************************************
.. code-block:: bash
crypto_call.cpp psa_call.cpp security_call.cpp sst_call.cpp
diff --git a/docs/tf_fuzz/source_structure/demo_dir.rst b/docs/tf_fuzz/source_structure/demo_dir.rst
index fb49fe7..e137a87 100644
--- a/docs/tf_fuzz/source_structure/demo_dir.rst
+++ b/docs/tf_fuzz/source_structure/demo_dir.rst
@@ -25,9 +25,9 @@
that is, TF-Fuzz only provides a very-compact test-specification format. As
the test number increases, the TF-Fuzz tool infers for you more about test.
-*********************************************
-``.../tools/tf_fuzz/demo`` directory contents
-*********************************************
+***********************************
+``tf_fuzz/demo`` directory contents
+***********************************
.. code-block:: bash
1 10 11 12 13 14 15 16 17 18 19 2 3 4 5 6 7 8 9 r
diff --git a/docs/tf_fuzz/source_structure/lib_dir.rst b/docs/tf_fuzz/source_structure/lib_dir.rst
index fbc54dd..065ebe3 100644
--- a/docs/tf_fuzz/source_structure/lib_dir.rst
+++ b/docs/tf_fuzz/source_structure/lib_dir.rst
@@ -9,7 +9,7 @@
This directory contains the customizable "boilerplate" code snippets used to
write out C source code. The file in this directory currently, is that for
TF-M, but other comparable frameworks could be addressed with equivalent files
-taylored for the required syntax of that other framework.
+tailored for the required syntax of that other framework.
Which file to use for this process is selected by setting two environment
variables pointing to that file: One for the ``lib`` directory and one for the
@@ -21,9 +21,9 @@
export TF_FUZZ_BPLATE=tfm_boilerplate.txt
-********************************************
-``.../tools/tf_fuzz/lib`` directory contents
-********************************************
+**********************************
+``tf_fuzz/lib`` directory contents
+**********************************
.. code-block:: bash
tfm_boilerplate.txt
diff --git a/docs/tf_fuzz/source_structure/parser_dir.rst b/docs/tf_fuzz/source_structure/parser_dir.rst
index ddbca5a..c3403eb 100644
--- a/docs/tf_fuzz/source_structure/parser_dir.rst
+++ b/docs/tf_fuzz/source_structure/parser_dir.rst
@@ -1,6 +1,6 @@
-########################
-'parser'-directory guide
-########################
+################################
+'tfz-cpp/parser'-directory guide
+################################
************
Introduction
@@ -10,9 +10,9 @@
test-template language easily extensible. Much of the actual work is done in
helper functions, but the Lex/YACC grammar manages the process.
-***********************************************
-``.../tools/tf_fuzz/parser`` directory contents
-***********************************************
+*********************************************
+``tf_fuzz/tfz-cpp/parser`` directory contents
+*********************************************
.. code-block:: bash
tf_fuzz_grammar.l tf_fuzz_grammar.y
diff --git a/docs/tf_fuzz/source_structure/regression_dir.rst b/docs/tf_fuzz/source_structure/regression_dir.rst
index ec4ea6d..cda98fd 100644
--- a/docs/tf_fuzz/source_structure/regression_dir.rst
+++ b/docs/tf_fuzz/source_structure/regression_dir.rst
@@ -1,6 +1,6 @@
-############################
-'regression'-directory guide
-############################
+####################################
+'tfz-cpp/regression'-directory guide
+####################################
************
Introduction
@@ -13,9 +13,9 @@
``*active`` and ``*deleted``, nor ``shuffle`` and ``2 to 5 of {...}``
constructs.
-***************************************************
-``.../tools/tf_fuzz/regression`` directory contents
-***************************************************
+*************************************************
+``tf_fuzz/tfz-cpp/regression`` directory contents
+*************************************************
.. code-block:: bash
000001_set_sst_uid_data_expect_pass
diff --git a/docs/tf_fuzz/source_structure/template_dir.rst b/docs/tf_fuzz/source_structure/template_dir.rst
index 86dbbfa..e536098 100644
--- a/docs/tf_fuzz/source_structure/template_dir.rst
+++ b/docs/tf_fuzz/source_structure/template_dir.rst
@@ -1,6 +1,6 @@
-##########################
-'template'-directory guide
-##########################
+##################################
+'tfz-cpp/template'-directory guide
+##################################
************
Introduction
@@ -9,9 +9,9 @@
These classes describe "tracker" objects for parsing test templates, and for
generating PSA calls from them.
-*************************************************
-``.../tools/tf_fuzz/template`` directory contents
-*************************************************
+***********************************************
+``tf_fuzz/tfz-cpp/template`` directory contents
+***********************************************
.. code-block:: bash
crypto_template_line.cpp secure_template_line.hpp template_line.cpp
diff --git a/docs/tf_fuzz/source_structure/tests_dir.rst b/docs/tf_fuzz/source_structure/tests_dir.rst
index 8226451..ea20915 100644
--- a/docs/tf_fuzz/source_structure/tests_dir.rst
+++ b/docs/tf_fuzz/source_structure/tests_dir.rst
@@ -1,6 +1,6 @@
-#######################
-'tests'-directory guide
-#######################
+###############################
+'tfz-cpp/tests'-directory guide
+###############################
************
Introduction
@@ -9,9 +9,9 @@
These are just more examples of test-template-file content. They're not really
organized *tests* as such.
-**********************************************
-``.../tools/tf_fuzz/tests`` directory contents
-**********************************************
+********************************************
+``tf_fuzz/tfz-cpp/tests`` directory contents
+********************************************
.. code-block:: bash
example_template sstReads sstSets
diff --git a/docs/tf_fuzz/source_structure/utility_dir.rst b/docs/tf_fuzz/source_structure/utility_dir.rst
index 89ad060..2af3d66 100644
--- a/docs/tf_fuzz/source_structure/utility_dir.rst
+++ b/docs/tf_fuzz/source_structure/utility_dir.rst
@@ -1,17 +1,17 @@
-#########################
-'utility'-directory guide
-#########################
+#################################
+'tfz-cpp/utility'-directory guide
+#################################
************
Introduction
************
-As its name implies, this ``.../tf_fuzz/utility`` directory just contains
+As its name implies, this ``tf_fuzz/tfz-cpp/utility`` directory just contains
various utility-compute code.
-************************************************
-``.../tools/tf_fuzz/utility`` directory contents
-************************************************
+**********************************************
+``tf_fuzz/tfz-cpp/utility`` directory contents
+**********************************************
.. code-block:: bash
compute.cpp find_or_create_asset.hpp randomization.cpp string_ops.hpp
diff --git a/docs/tf_fuzz/source_structure/visualStudio_dir.rst b/docs/tf_fuzz/source_structure/visualStudio_dir.rst
index a70bbf8..be9894e 100644
--- a/docs/tf_fuzz/source_structure/visualStudio_dir.rst
+++ b/docs/tf_fuzz/source_structure/visualStudio_dir.rst
@@ -1,6 +1,6 @@
-##############################
-'visualStudio'-directory guide
-##############################
+######################################
+'tfz-cpp/visualStudio'-directory guide
+######################################
************
Introduction
@@ -14,9 +14,9 @@
up-coming "interactive mode" for interactively creating test templates may
need an actual working ``isatty()``, but that's not ready yet.
-*************************************************
-.../tools/tf_fuzz/visualStudio directory contents
-*************************************************
+***********************************************
+tf_fuzz/tfz-cpp/visualStudio directory contents
+***********************************************
.. code-block:: bash
unistd.c unistd.h