SCP-2663 Teach the Plutus Tx compiler to add profiling trace statements (IntersectMBO#3779)

* Add some golden tests and an executable for profiling. 

* Mark plutus-tx-plugin as unbuildable for windows.

Author: thealmarty

nix/pkgs/haskell/haskell.nix

@@ -91,6 +91,7 @@ let
           plutus-ledger.package.buildable = false;
           plutus-pab.package.buildable = false;
           plutus-playground-server.package.buildable = false; # Would also require libpq
+          plutus-tx-plugin.package.buildable = false;
           plutus-use-cases.package.buildable = false;
           web-ghc.package.buildable = false;
           # Needs agda

nix/pkgs/haskell/materialized-darwin/.plan.nix/plutus-tx-plugin.nix

@@ -24,12 +24,14 @@ module PlcTestUtils (
     goldenUEval,
     goldenTEvalCatch,
     goldenUEvalCatch,
+    goldenUEvalProfile,
     NoMarkRenameT(..),
     noMarkRename,
     NoRenameT(..),
     noRename,
     BrokenRenameT(..),
     runBrokenRenameT,
+    runUPlcProfile,
     brokenRename,
     prop_scopingFor,
     test_scopingGood,
@@ -40,24 +42,27 @@ import           PlutusPrelude
 
 import           Common
 
-import qualified PlutusCore                               as TPLC
+import qualified PlutusCore                                           as TPLC
 import           PlutusCore.Check.Scoping
 import           PlutusCore.DeBruijn
 import           PlutusCore.Default.Universe
-import qualified PlutusCore.Evaluation.Machine.Ck         as TPLC
+import qualified PlutusCore.Evaluation.Machine.Ck                     as TPLC
 import           PlutusCore.Generators
 import           PlutusCore.Generators.AST
 import           PlutusCore.Pretty
-import qualified PlutusCore.Rename.Monad                  as TPLC
+import qualified PlutusCore.Rename.Monad                              as TPLC
 
-import qualified UntypedPlutusCore                        as UPLC
-import qualified UntypedPlutusCore.Evaluation.Machine.Cek as UPLC
+import qualified UntypedPlutusCore                                    as UPLC
+import qualified UntypedPlutusCore.Evaluation.Machine.Cek             as UPLC
+import           UntypedPlutusCore.Evaluation.Machine.Cek.EmitterMode (logEmitter)
 
 import           Control.Exception
+import           Control.Lens.Combinators                             (_2)
 import           Control.Monad.Except
 import           Control.Monad.Reader
 import           Control.Monad.State
-import qualified Data.Text.Prettyprint.Doc                as PP
+import           Data.Text                                            (Text)
+import qualified Data.Text.Prettyprint.Doc                            as PP
 import           Hedgehog
 import           System.IO.Unsafe
 import           Test.Tasty
@@ -136,6 +141,20 @@ runUPlc values = do
     let (UPLC.Program _ _ t) = foldl1 UPLC.applyProgram ps
     liftEither $ first toException $ TPLC.extractEvaluationResult $ UPLC.evaluateCekNoEmit TPLC.defaultCekParameters t
 
+-- For golden tests of profiling.
+runUPlcProfile :: ToUPlc a DefaultUni UPLC.DefaultFun =>
+    [a]
+    -> ExceptT
+     SomeException
+     IO
+     (UPLC.Term UPLC.Name DefaultUni UPLC.DefaultFun (), [Text])
+runUPlcProfile values = do
+    ps <- traverse toUPlc values
+    let (UPLC.Program _ _ t) = foldl1 UPLC.applyProgram ps
+        (result, logOut) = UPLC.evaluateCek logEmitter TPLC.defaultCekParameters t
+    res <- either (throwError . SomeException) pure result
+    pure (res, logOut)
+
 ppCatch :: PrettyPlc a => ExceptT SomeException IO a -> IO (Doc ann)
 ppCatch value = either (PP.pretty . show) prettyPlcClassicDebug <$> runExceptT value
 
@@ -190,6 +209,12 @@ goldenUEvalCatch
     => String -> [a] -> TestNested
 goldenUEvalCatch name values = nestedGoldenVsDocM name $ ppCatch $ runUPlc values
 
+-- | Similar to @goldenUEval@ but with profiling turned on.
+goldenUEvalProfile
+    :: ToUPlc a DefaultUni TPLC.DefaultFun
+    => String -> [a] -> TestNested
+goldenUEvalProfile name values = nestedGoldenVsDocM name $ pretty . view _2 <$> (rethrow $ runUPlcProfile values)
+
 -- See Note [Marking].
 -- | A version of 'RenameT' that fails to take free variables into account.
 newtype NoMarkRenameT ren m a = NoMarkRenameT

nix/pkgs/haskell/materialized-darwin/default.nix

@@ -395,7 +395,7 @@ data family TyAppRep (fun :: dom -> cod) (arg :: dom) :: cod
 data family TyForallRep (var :: TyNameRep kind) (a :: GHC.Type) :: GHC.Type
 
 -- See Note [Motivation for polymorphic built-in functions].
--- See Note [Implemetation of polymorphic built-in functions].
+-- See Note [Implementation of polymorphic built-in functions].
 -- See Note [Pattern matching on built-in types].
 -- | The denotation of a term whose PLC type is encoded in @rep@ (for example a type variable or
 -- an application of a type variable). I.e. the denotation of such a term is the term itself.

nix/pkgs/haskell/materialized-linux/.plan.nix/plutus-tx-plugin.nix

@@ -171,7 +171,7 @@ functionDefToType (FunctionDef _ _ funTy _) = functionTypeToType funTy
 functionDefVarDecl :: FunctionDef term tyname name uni fun ann -> VarDecl tyname name uni fun ann
 functionDefVarDecl (FunctionDef ann name funTy _) = VarDecl ann name $ functionTypeToType funTy
 
--- | Make a 'FunctioDef'. Return 'Nothing' if the provided type is not functional.
+-- | Make a 'FunctionDef'. Return 'Nothing' if the provided type is not functional.
 mkFunctionDef
     :: ann
     -> name