add changelog

Author: SeungheonOh

plutus-tx-plugin/changelog.d/20250618_025657_seungheon.ooh_7146.md

@@ -0,0 +1,4 @@
+### Added
+- `generate-callstack` option: When enabled, the plugin replaces every occurrence of `PlutusTx.Trace.callStack` with a `BuiltinString` containing the callstack at that relative point. Enabling this option incurs execution-cost overhead: it adds an extra callstack argument to all user-defined functions, and every time they are invoked it requires having extra application node for providing the current callstack. When `gennerate-callstack` is not enabled, `PlutusTx.Trace.callStack` is string "<CallStack>".
+
+

plutus-tx-plugin/src/PlutusTx/Compiler/Expr.hs

@@ -613,13 +613,13 @@ ourselves before we start.
 -}
 
 -- | Apply callstack to given term if given 'GHC.Var' requires callstack to be applied.
-applyCallStack
+applyCallStackWhenNeeded
   :: MonadState CompileState m
   => GHC.Var
   -> PIRTerm PLC.DefaultUni PLC.DefaultFun
   -> m (PIRTerm PLC.DefaultUni PLC.DefaultFun)
-applyCallStack currVar t = do
-  csFuns <- gets csNeedsCallStack
+applyCallStackWhenNeeded currVar t = do
+  csFuns <- gets csCallStackDeps
   if Set.member (LexName $ GHC.varName currVar) csFuns
     then do
       lastCs <- lastCallStackName
@@ -651,7 +651,7 @@ lookupTerm
   -> m (Maybe (PIRTerm PLC.DefaultUni PLC.DefaultFun))
 lookupTerm var =
   PIR.lookupTerm (LexName $ GHC.varName var)
-  >>= traverse (applyCallStack var)
+  >>= traverse (applyCallStackWhenNeeded var)
 
 hoistExpr
   :: CompilingDefault uni fun m ann
@@ -744,7 +744,7 @@ hoistExpr var t = do
         PIR.modifyTermDef lexName (const $ PIR.Def var'' (t', PIR.NonStrict))
 
         -- Apply callstack.
-        applyCallStack var $ PIR.mkVar var''
+        applyCallStackWhenNeeded var $ PIR.mkVar var''
 
 maybeProfileRhs
   :: (CompilingDefault uni fun m ann) => PLCVar uni -> PIRTerm uni fun -> m (PIRTerm uni fun)

plutus-tx-plugin/src/PlutusTx/Compiler/Types.hs

@@ -3,7 +3,6 @@
 {-# LANGUAGE DataKinds         #-}
 {-# LANGUAGE FlexibleContexts  #-}
 {-# LANGUAGE FlexibleInstances #-}
-{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE Rank2Types        #-}
 {-# LANGUAGE TypeFamilies      #-}
 {-# LANGUAGE TypeOperators     #-}
@@ -84,7 +83,7 @@ data CompileState = CompileState
   {- ^ The callstack variables bound at the current state. The first element represents the
   most recent callstack.
   -}
-  , csNeedsCallStack :: Set LexName
+  , csCallStackDeps  :: Set LexName
   {- ^ Set of names that requires callstack. A name being in this set indicates that their
   corresponding term is modified to have extra string argument and need to apply callstack
   before using the function.
@@ -100,8 +99,8 @@ lastCallStackName = do
 
 insertCallStackDeps :: MonadState CompileState m => LexName -> m ()
 insertCallStackDeps name =
-  modify' $ \compileState@(CompileState {csNeedsCallStack = fns}) ->
-    compileState {csNeedsCallStack = Set.insert name fns}
+  modify' $ \compileState@(CompileState {csCallStackDeps = fns}) ->
+    compileState {csCallStackDeps = Set.insert name fns}
 
 -- | Verbosity level of the Plutus Tx compiler.
 data Verbosity