Cost of contract calls snapshot tests (#7440)

## Description

This PR is a prequel for #7419.
It will set the baseline, which future PRs need to improve.

Apart from that it also:
1 - Fix a problem with `SubtsType` for `TyConstantDecl`;
2 - Introduce a new way to write snapshot tests. Now the test source
code can have "blocks"

```
    /* START BOOL */
    fn in_bool(v: bool) -> bool;
    /* END BOOL */
```

These blocks can be manipulated from inside the `snapshot.toml`. In this
case, the `toml` is:

```
cmds = [
    "forc test --path {root} --release --experimental const_generics",
    { repeat = "for-each-block", cmds = [
        "forc test --path {root} --release --experimental const_generics"
    ] }
]
```

Which repeats the inner `forc test` for each block, removing all others.
That allows me to check the cost of the contract method selection
algorithm for each contract method.

For example, `cost_of_in_array_64` with all other contract methods costs
`60382`, but alone it only costs `58218`, which means that around 2000
was "wasted" in the contract method selection.

## Checklist

- [x] I have linked to any relevant issues.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [x] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.

Author: xunilrj

justfile

@@ -19,6 +19,10 @@ update-fuel-dependencies:
 update-contract-ids:
     bash ./test/update-contract-ids.sh
 
+[group('automation')]
+bisect-forc path command:
+    bash ./scripts/bisect-forc/bisect-forc.sh "{{path}}" "{{command}}"
+
 [group('benchmark')]
 benchmark:
     bash ./benchmark.sh
@@ -31,6 +35,33 @@ benchmark-tests:
 collect-gas-usage:
     cargo r -p test --release -- --verbose --forc-test-only | ./scripts/compare-gas-usage/extract-gas-usage.sh
 
+# This recipe should be used on snapshot tests that contains gas usage from `forc test`,
+# because it will extract gas usage from all versions of the file and generate an html interactive report.
+# path: path to file to extract gas usage
+# open: "-o" will open the default browser showing the report
+[linux]
+[group('benchmark')]
+collect-historic-gas-usage path open:
+    #! /bin/bash
+    mkdir -p target
+    rm target/a.csv
+    rm target/a.html
+    echo "test,gas,commit" > target/a.csv
+    for HASH in `git log --format='%H' -- {{path}}`; do
+        TIMESTAMP=$(git show -s --format='%as-%ct-%H' "$HASH")
+        git --no-pager show "$HASH:{{path}}" | bash -c "scripts/compare-gas-usage/extract-gas-usage.sh $TIMESTAMP" >> target/a.csv
+    done
+    ./scripts/csv2html/csv2html.sh target/a.csv >> target/a.html
+    if [ -n "{{open}}" ]; then
+        if which xdg-open &>> /dev/null
+        then
+            xdg-open target/a.html
+        elif which gnome-open &>> /dev/null
+        then
+            gnome-open target/a.html
+        fi
+    fi
+
 [group('build')]
 build-prism:
     cd ./scripts/prism && ./build.sh

scripts/bisect-forc/bisect-forc.sh

@@ -48,7 +48,7 @@ echo -n "Running: "
 
 CACHENAME="$(git show -s --format='%as-%ct-%H' HEAD)"
 compile_and_cp_to_cache "$CACHENAME"
-INITIAL_COMPILATION_STATUS=$(run_cargo)
+INITIAL_COMPILATION_STATUS=$(run_cargo "$1" "$2")
 
 if [ "$INITIAL_COMPILATION_STATUS" = "0" ]; then
     echo -e " ${BOLD_GREEN}Ok${NC}"
@@ -69,7 +69,7 @@ for HASH in `git log --format="%H" --tags --no-walk`; do
 
     CACHENAME="$(git show -s --format='%as-%ct-%H' HEAD)"
     compile_and_cp_to_cache "$CACHENAME"
-    LAST_STATUS=$(run_cargo)
+    LAST_STATUS=$(run_cargo "$1" "$2")
     if [ "$INITIAL_COMPILATION_STATUS" != "$LAST_STATUS" ]; then
         echo -e "^^^^^^^^^ ${BOLD_WHITE}This version result is different!${NC}"
         break
@@ -93,22 +93,22 @@ do
     #git --no-pager bisect visualize --oneline
 
     git bisect next | grep "is the first new commit" &>> /dev/null
-    if [ "$LAST_STATUS" = "0" ]; then
+    if [ "$?" = "0" ]; then
         FIRST_COMMIT="$(git bisect next 2>&1 | head -n 1 | cut -f1 -d" ")"
         git checkout "$FIRST_COMMIT" &>> /dev/null
         break
     fi
-    
+
     git bisect next | grep "Bisecting"
-    if [ "$LAST_STATUS" != "0" ]; then
+    if [ "$?" != "0" ]; then
         break
     fi
 
     git checkout . &>> /dev/null
 
     CACHENAME="$(git show -s --format='%as-%ct-%H' HEAD)"
     compile_and_cp_to_cache "$CACHENAME"
-    LAST_STATUS=$(run_cargo)
+    LAST_STATUS=$(run_cargo "$1" "$2")
     if [ "$LAST_STATUS" = "$INITIAL_COMPILATION_STATUS" ]; then
         git bisect new &>> /dev/null
     else
@@ -127,7 +127,7 @@ echo -n "checking the found commit has the same behaviour as the initial commit.
 
 CACHENAME="$(git show -s --format='%as-%ct-%H' HEAD)"
 compile_and_cp_to_cache "$CACHENAME"
-LAST_STATUS=$(run_cargo)
+LAST_STATUS=$(run_cargo "$1" "$2")
 
 if [ "$INITIAL_COMPILATION_STATUS" != "$LAST_STATUS" ]; then
     echo -e " ${BOLD_RED}Unexpected exit code${NC}"
@@ -143,7 +143,7 @@ git checkout HEAD~1 &>> /dev/null
 PREVIOUS_COMMIT="$(git show -s --format='%H' HEAD)"
 CACHENAME="$(git show -s --format='%as-%ct-%H' HEAD)"
 compile_and_cp_to_cache "$CACHENAME"
-LAST_STATUS=$(run_cargo)
+LAST_STATUS=$(run_cargo "$1" "$2")
 
 if [ "$INITIAL_COMPILATION_STATUS" = "$LAST_STATUS" ]; then
     echo -e " ${BOLD_RED}Unexpected exit code${NC}"

scripts/compare-gas-usage/extract-gas-usage.sh

@@ -2,6 +2,7 @@
 
 # This script extracts full test names and test gas usage from a `forc test` output.
 # Usage: `forc test | test_gas_usage.sh`.
+# if $1 is not empty it will be appended as a new column to the csv
 
 current_suite=""
 results=()
@@ -19,7 +20,12 @@ while IFS= read -r line; do
         # printf 'Test: %s\n' "$test_name"
         gas="${BASH_REMATCH[2]}"
         # printf 'Gas: %s\n' "$gas"
-        results+=("${current_suite}::${test_name},${gas}")
+
+        if [ "$1" = "" ]; then
+            results+=("${current_suite}::${test_name},${gas}")
+        else
+            results+=("${current_suite}::${test_name},${gas},$1")
+        fi
     fi
 done
 

scripts/csv2html/csv2html.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+echo '<!DOCTYPE html>
+<html>
+    <head>
+        <title>Pivot Demo</title>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script>
+        
+        <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/pivottable/2.23.0/pivot.min.css">
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/pivottable/2.23.0/pivot.min.js"></script>
+
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"></script>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/pivottable/2.23.0/d3_renderers.min.js"></script>
+
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/c3/0.4.11/c3.min.js"></script>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/pivottable/2.23.0/c3_renderers.min.js"></script>
+
+        <script src="https://cdn.plot.ly/plotly-basic-latest.min.js"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/pivottable/2.23.0/plotly_renderers.min.js"></script>
+        
+        <style>
+            body {font-family: Verdana;}
+            .node {
+              border: solid 1px white;
+              font: 10px sans-serif;
+              line-height: 12px;
+              overflow: hidden;
+              position: absolute;
+              text-indent: 2px;
+            }
+        </style>
+        <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui-touch-punch/0.2.3/jquery.ui.touch-punch.min.js"></script>
+    </head>
+    <body>
+        <script type="text/javascript">
+        $(function(){
+            var renderers = $.extend(
+                $.pivotUtilities.renderers,
+                $.pivotUtilities.c3_renderers,
+                $.pivotUtilities.d3_renderers,
+                $.pivotUtilities.plotly_renderers
+            );
+            $("#output").pivotUI($("table"), {
+                renderers,
+                rendererName: "Line Chart",
+            });
+        });
+        </script>
+        <div id="output" style="margin: 30px;"></div>
+        <br />
+        <table>
+            <thead>'
+head -n 1 "$1" | sed -e 's/^/<tr><th>/' -e 's/,/<\/th><th>/g' -e 's/$/<\/th><\/tr>/'
+echo '      </thead>
+            <tbody>'
+tail -n +2 "$1" | sed -e 's/^/<tr><td>/' -e 's/,/<\/td><td>/g' -e 's/$/<\/td><\/tr>/'
+echo "      </tbody>
+        </table>
+    <body>
+</html>"

sway-core/src/decl_engine/id.rs

@@ -240,12 +240,23 @@ impl SubstTypes for DeclId<TyTraitType> {
     }
 }
 
+// This implementation deviates from all other DeclId<...> implementations.
+// For more, see https://github.com/FuelLabs/sway/pull/7440#discussion_r2428833840.
+// A better solution will be implemented in the future.
+//
+// TL;DR:
+// When a constant is declared inside a function, its value is shared by every
+// “version” of that function—that is, by all monomorphizations.  If we “replace” the
+// constant, as other implementations do, we would change its value in *every* version,
+// which is incorrect.
 impl SubstTypes for DeclId<TyConstantDecl> {
     fn subst_inner(&mut self, ctx: &SubstTypesContext) -> HasChanges {
         let decl_engine = ctx.engines.de();
         let mut decl = (*decl_engine.get(self)).clone();
         if decl.subst(ctx).has_changes() {
-            decl_engine.replace(*self, decl);
+            *self = *decl_engine
+                .insert(decl, decl_engine.get_parsed_decl_id(self).as_ref())
+                .id();
             HasChanges::Yes
         } else {
             HasChanges::No

sway-core/src/type_system/ast_elements/type_argument.rs

@@ -225,7 +225,12 @@ impl DebugWithEngines for GenericArgument {
     fn fmt(&self, f: &mut fmt::Formatter<'_>, engines: &Engines) -> fmt::Result {
         match self {
             GenericArgument::Type(a) => {
-                write!(f, "{:?}", engines.help_out(&*engines.te().get(a.type_id)))
+                write!(
+                    f,
+                    "{:?} -> {:?}",
+                    engines.help_out(&*engines.te().get(a.initial_type_id)),
+                    engines.help_out(&*engines.te().get(a.type_id))
+                )
             }
             GenericArgument::Const(a) => match &a.expr {
                 ConstGenericExpr::Literal { val, .. } => {

sway-lib-std/src/codec.sw

@@ -2789,6 +2789,13 @@ impl<const N: u64> AbiDecode for str[N] {
     }
 }
 
+#[cfg(experimental_const_generics = false)]
+impl AbiDecode for str[0] {
+    fn abi_decode(ref mut _buffer: BufferReader) -> str[0] {
+        __to_str_array("")
+    }
+}
+
 // BEGIN STRARRAY_DECODE
 #[cfg(experimental_const_generics = false)]
 impl AbiDecode for str[1] {
@@ -3390,6 +3397,16 @@ where
     }
 }
 
+#[cfg(experimental_const_generics = false)]
+impl<T> AbiDecode for [T; 0]
+where
+    T: AbiDecode,
+{
+    fn abi_decode(ref mut _buffer: BufferReader) -> [T; 0] {
+        []
+    }
+}
+
 // BEGIN ARRAY_DECODE
 #[cfg(experimental_const_generics = false)]
 impl<T> AbiDecode for [T; 1]