forked from visoftsolutions/noir_rs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Produce graph of internal Barretenberg dependencies (AztecProto…
…col#4225) The graph is directed, with $A\to B$ meaning that $A$ depends on $B$. Result: ![barretenberg_modules](https://github.com/AztecProtocol/aztec-packages/assets/26756572/5bc0745a-1b14-431f-9059-16e4b6b4a217) A follow on could rewrite the CMakeLists.txt files to actually make use of this minimal representation of dependencies, but that feels unnecessary at the moment.
- Loading branch information
1 parent
6c70548
commit 88e7923
Showing
3 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#!/usr/bin/env bash | ||
set -eu | ||
|
||
TMP=tmp.dot | ||
RESULT_DOT=barretenberg_modules.dot | ||
RESULT_PNG=barretenberg_modules.png | ||
|
||
# initialize a directed graph for graphviz | ||
echo digraph BarretenbergModules { > $TMP | ||
# populate the directed graph | ||
for file in $(find ./src/barretenberg/ -iname CMakeLists.txt); do | ||
opening_chars=$(head -c 19 "$file") | ||
if [ "$opening_chars" == barretenberg_module ]; then | ||
awk -f ./scripts/barretenberg_module_digraph_edges.awk $file >> $TMP | ||
fi | ||
done | ||
echo } >> $TMP | ||
|
||
# apply transitive reduction to remove dependcies that are implied by other dependencies | ||
cat $TMP | tred > $RESULT_DOT | ||
rm $TMP | ||
|
||
# produce a PNG of the graph | ||
dot -Tpng $RESULT_DOT -o $RESULT_PNG |
35 changes: 35 additions & 0 deletions
35
barretenberg/cpp/scripts/barretenberg_module_digraph_edges.awk
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Function to extract words between parentheses | ||
function extract_edges(line) { | ||
match(line, /\(.*\)/); # Find the portion within parentheses | ||
line = substr(line, RSTART + 1, RLENGTH - 2); # Extract the words | ||
gsub(/^[ ]+/, "", line); # Remove leading spaces and tabs | ||
gsub(/[ ]+$/, "", line); # Remove trailing spaces and tabs | ||
gsub(/[ ]+/, " ", line); # Sub multiple spaces for a single space | ||
split(line, modules, " "); # Split into an array of words | ||
|
||
# If node has no dependencies, just add the node | ||
if (length(modules)==1) { | ||
print modules[1]; | ||
} | ||
else { # add edges | ||
for (i = 2; i <= length(modules); i++) { | ||
print modules[1]" -> "modules[i]; | ||
} | ||
} | ||
} | ||
|
||
# Main AWK script | ||
{ | ||
# Concatenate lines if the opening parenthesis is not closed | ||
while (!/\)/) { | ||
current_line = $0; | ||
getline; | ||
$0 = current_line $0; | ||
} | ||
|
||
# Check if the line begins with "barretenberg_module". If so, extact the digraph edges | ||
function_name = "barretenberg_module"; | ||
if ($0 ~ "^" function_name "\\(") { | ||
extract_edges($0); | ||
} | ||
} |