Allow selection of verbosity level for `vtrace_fmt!` messages by joannabrozek · Pull Request #3932 · google/xls

joannabrozek · 2026-03-10T14:02:19Z

Add support for excluding vtrace_fmt! messages according to max_trace_verbosity flag for:

DSLX interpreter:
- Added the max_trace_verbosity flag with the default value set to 100 (see xls/dslx/interpreter_main.cc)
- Added a new private member verbosity_ to the TraceData class to be able to pass the verbosity of vtrace_fmt!() messages (see xls/dslx/bytecode/bytecode.h)
- Added max_trace_verbosity flag propagation using BytecodeInterpreterOptions to the bytecode interpreter, where the vtrace messages are filtered (see xls/dslx/bytecode/bytecode_interpreter.cc)
- Added a bytecode interpreter test for vtrace_fmt!() (see xls/dslx/bytecode/bytecode_interpreter_test.cc)
IR interpreter:
- Added code position propagation (by adding the emit_positions flag, which is enabled by default, as it was previously hardcoded as enabled as well - see xls/dslx/ir_convert/ir_converter_main.cc)
- Restored displaying messages from trace_fmt!() and vtrace_fmt!() (see the xls/dslx/run_routines/run_routines.cc file)
- Added a fix to populate SourceInfo inside Trace so that the displayed logs include information about which file they came from and their location (row and column) - see xls/dslx/ir_convert/function_converter.cc
- Added two tests (one for a function and the second for a process) to verify if messages are filtered - see xls/dslx/interpreter_test.py
- Added displaying messages for processes by adding a DslxInterpreterEvents pointer and populating it (see xls/dslx/run_routines/run_routines.cc and xls/dslx/run_routines/ir_test_runner.cc)
- Added vtrace_fmt!() messages filtering (see xls/interpreter/ir_interpreter.cc)
- Updated the test (see xls/interpreter/ir_evaluator_test_base.cc)
JIT and AOT:
- Added a new private member max_trace_verbosity_ to the EvaluatorOptions and JitEvaluatorOptions classes to be able to propagate the max_trace_verbosity flag (see xls/interpreter/evaluator_options.h and xls/jit/jit_evaluator_options.h)
- Added the max_trace_verbosity flag and passed it using JitEvaluatorOptions (see xls/jit/aot_compiler_main.cc)
- Enabled max_trace_verbosity flag propagation using EvaluatorOptions for function and block wrappers (see xls/jit/jit_function_wrapper_cc.tmpl, xls/jit/function_base_jit_wrapper.h and xls/jit/block_base_jit_wrapper.h)
- Added vtrace_fmt!() messages filtering (see xls/jit/jit_callbacks.cc)
- Added an example with JIT tests and defined wrappers (see xls/examples/vtrace_fmt.x, xls/examples/vtrace_fmt_block_jit_test.cc, xls/examples/vtrace_fmt_jit_test.cc, xls/examples/vtrace_fmt_proc_jit_test.cc)
- Added support for JIT functions (see xls/jit/function_jit.cc) and a test (see xls/jit/function_jit_test.cc)
- Added support for JIT blocks (see xls/jit/block_jit.cc) and updated the test (see xls/interpreter/block_evaluator_test_base.cc)
- Added support for JIT processes (see xls/jit/proc_jit.cc) and a test (see xls/interpreter/proc_evaluator_test_base.cc)
- Updated the AOT test (see xls/jit/function_jit_aot_test.cc)
eval_ir_main tool:
- Added the max_trace_verbosity flag and passed it using JitEvaluatorOptions (see xls/tools/eval_ir_main.cc)
- Added a test (see xls/tools/eval_ir_main_test.py)
eval_proc_main tool:
- Added the max_trace_verbosity flag and passed it using BlockEvaluator (see xls/tools/eval_proc_main.cc)
- Added a test (see xls/tools/eval_proc_main_test.py)
codegen_main tool:
- Fixed max_trace_verbosity flag propagation (addressing the issue: Mismatch between max_trace_verbosity and vtrace_fmt! codegen output #3080) - see xls/tools/codegen.cc and xls/tools/codegen_flags.cc
- Added a test (see xls/tools/codegen_main_test.py)

richmckeever · 2026-05-05T13:04:25Z

+  if (node->verbosity().has_value()) {
+    XLS_ASSIGN_OR_RETURN(InterpValue verbosity_val,
+                         type_info_->GetConstExpr(*node->verbosity()));
+    absl::StatusOr<int64_t> verbosity_as_int64 =


We should be able to assume here that if the node has a verbosity value then the constexpr is a valid int64, and just do XLS_ASSIGN_OR_RETURN. Perhaps add a check for this in validate_concrete_type.cc if it's not really checked in type inference currently.

I used XLS_ASSIGN_OR_RETURN as mentioned.

richmckeever · 2026-05-05T13:38:16Z

 }

+TEST_F(BytecodeInterpreterTest, VtraceFmtBitsValueDefaultFormat) {
+  constexpr std::string_view kProgram = R"(


Let's verify, either here or in a different test, that regular trace_fmt! works as expected with a max verbosity set.

Added in the same file.

richmckeever · 2026-05-05T13:41:24Z

    absl::Span<const absl::flat_hash_map<std::string, Value>> inputs,
-    const std::optional<verilog::ResetProto>& reset, int64_t seed) const {
+    const std::optional<verilog::ResetProto>& reset, int64_t seed,
+    const std::optional<int64_t> max_trace_verbosity = 0) const {


I wonder if we should make this non-optional wherever the distinction between 0 and nullopt is irrelevant throughout the PR. It's unusual to have an optional default to 0, and probably a sign that passing in nullopt is irrelevant in such places.

I've migrated to non-optional throughout the PR.

joannabrozek · 2026-05-08T12:58:53Z

@richmckeever, thank you for the review. I've rebased the code and added the suggested changes. Let me know if there's still something missing.

magancarz · 2026-05-15T12:27:45Z

I've rebased changes onto the latest main and resolved conflicts.

proppy · 2026-05-21T06:37:11Z

fyi, we get this failure internally:

libcxx/include/__memory/unique_ptr.h: error: allocating an object of abstract class type 'xls::(anonymous namespace)::JitContinuationAdapter' 756 | return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); | ^ fifo_fuzz_test.cc: note: in instantiation of function template specialization 'std::make_unique<xls::(anonymous namespace)::JitContinuationAdapter, std::unique_ptr<xls::BlockJitContinuation>, xls::BlockJit *&, 0>' requested here 256 | return std::make_unique<JitContinuationAdapter>(std::move(blk_cont), jit); | ^ block_evaluator.h: note: unimplemented pure virtual method 'SetMaxTraceVerbosity' in 'JitContinuationAdapter' 444 | virtual void SetMaxTraceVerbosity(int64_t value) = 0;

I see pure virtual SetMaxTraceVerbosity from BlockContinuation is not implemented in a newly added JitContinuationAdapter class deriving from BlockContinuation. For reference, you can see how we implemented it in BlockContinuationJitWrapper as a lazy init for max_trace_verbosity of BlockJitContinuation or noop in StatelessBlockContinuation.

/cc @joannabrozek

@proppy I see JitContinuationAdapter class is only available internally. Can this be fixed on Google's side?

mikex-oss · 2026-06-15T23:34:06Z

@magancarz @joannabrozek I can try to fix the JitContinuationAdapter issue, but the PR has gotten outdated. The internal import was garbage collected, and I cannot trigger a re-import because it reports "error: Cannot find a merge reference for Pull Request 3932. It might have a conflict with head."

Can you please try rebasing?

richmckeever · 2026-06-16T13:59:00Z

  std::unique_ptr<TypeManager> type_manager = std::make_unique<TypeManager>();

  RuntimeObserver* observer = nullptr;
+  int64_t max_trace_verbosity_ = 0;


Remove underscore (because it's a struct).

rw1nkler · 2026-06-25T15:35:02Z

@mikex-oss I rebased this PR

proppy · 2026-10-09T06:27:49Z

@rw1nkler sorry can you rebase again?

richmckeever · 2026-10-26T14:17:29Z

Looks like we need another rebase.

rw1nkler · 2026-11-04T12:17:31Z

Rebased, requires #5259 to build correctly without the cache in nightly CI

grebe · 2026-11-09T22:38:41Z

 rewrite ftp.gnu.org/(?:pub/)?gnu/(.*) https://ftpmirror.gnu.org/$1
 rewrite ftp.gnu.org/(?:pub/)?gnu/(.*) https://ftp.gnu.org/gnu/$1
+
+# TODO: Remove once BCR fixes sv-lang@10.0.1-20260316-f04e8156 integrity.


superfluous now?

Yes. I updated the PR

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

rw1nkler · 2026-11-12T21:57:03Z

PTAL @grebe @richmckeever

joannabrozek changed the title ~~Add max_trace_verbosity flag~~ Allow selection of verbosity level for vtrace_fmt! messages Mar 10, 2026

joannabrozek force-pushed the max_trace_verbosity branch from 983deff to 5bd314f Compare March 25, 2026 09:08

joannabrozek force-pushed the max_trace_verbosity branch from 5bd314f to 656fb31 Compare April 21, 2026 13:19

joannabrozek marked this pull request as ready for review April 21, 2026 13:24

richmckeever approved these changes May 5, 2026

View reviewed changes

joannabrozek force-pushed the max_trace_verbosity branch from 656fb31 to 641815b Compare May 8, 2026 12:52

magancarz force-pushed the max_trace_verbosity branch from 641815b to 6c51a0e Compare May 15, 2026 12:27

proppy approved these changes May 21, 2026

View reviewed changes

proppy added the Reviewing Internally label May 21, 2026

proppy reviewed May 21, 2026

View reviewed changes

richmckeever approved these changes Jun 16, 2026

View reviewed changes

rw1nkler force-pushed the max_trace_verbosity branch from 6c51a0e to 239b582 Compare June 25, 2026 14:58

proppy approved these changes Aug 27, 2026

View reviewed changes

proppy added Reviewing Internally and removed Reviewing Internally labels Aug 27, 2026

proppy removed the Reviewing Internally label Oct 9, 2026

rw1nkler force-pushed the max_trace_verbosity branch from 239b582 to 5caef4a Compare October 20, 2026 13:04

richmckeever approved these changes Oct 26, 2026

View reviewed changes

richmckeever added Reviewing Internally and removed Reviewing Internally labels Oct 26, 2026

richmckeever approved these changes Oct 27, 2026

View reviewed changes

richmckeever added the Reviewing Internally label Oct 27, 2026

rw1nkler force-pushed the max_trace_verbosity branch from 5caef4a to 89d3261 Compare November 4, 2026 12:15

grebe requested changes Nov 9, 2026

View reviewed changes

grebe requested review from proppy and richmckeever November 9, 2026 23:28

joannabrozek and others added 25 commits November 12, 2026 21:45

xls: tools: Add max_trace_verbosity flag

8973bd5

codegen: Populate max_trace_verbosity flag and add test

9e7b56a

dslx: Add max_trace_verbosity flag to DSLX interpreter

6e79440

xls: ir: Fill SourceInfo for Trace

82ac880

run_rountines: Restore displaying vtrace messages for IR interpreter

c63fc17

interpreter: Add test for vtrace

89f60e8

ir_convert: Add emit_positions flag

8c8de8c

function_jit: Add support for 'max_trace_verbosity' flag

bf501b6

block_jit: Add support for max_trace_verbosity

36d4c31

xls_dslx_rules: Add max_trace_verbosity flag

dad73c5

proc_jit: Add support for max_trace_verbosity

420a075

IR interperter: Add messages filtering for processes

a334521

AOT proc: Add example for vtrace

0dfe60d

AOT function: Add example for vtrace

4281881

AOT block: Add example fot vtrace

82d130e

bytecode_interpreter: Set default value for messages verbosity

afcce24

xls: examples: Move vtrace_fmt!() tests to one file

ef11106

tools: eval_proc: Add test for vtrace_fmt!()

a6d39ef

tools: eval_ir: Add test for vtrace_fmt!()

f65214d

interpreter: Set default value for 'max_trace_verbosity' flag to 100

298e530

bytecode: Update VtraceFmtBitsValueDefaultFormat test

b616647

bytecode: Migrate to non-optional max_trace_verbosity

84a2a3f

jit: Migrate to non-optional max_trace_verbosity

137acfd

block_evaluator: Migrate to non-optional max_trace_verbosity

57c54be

Remove underscore from max_trace_verbosity field in InstanceContext

c732f0b

Signed-off-by: Robert Winkler <rwinkler@antmicro.com>

rw1nkler force-pushed the max_trace_verbosity branch from 89d3261 to c732f0b Compare November 12, 2026 21:39

Conversation

joannabrozek commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joannabrozek commented May 8, 2026

Uh oh!

magancarz commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikex-oss commented Jun 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rw1nkler commented Jun 25, 2026

Uh oh!

proppy commented Oct 9, 2026

Uh oh!

richmckeever commented Oct 26, 2026

Uh oh!

rw1nkler commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rw1nkler commented Nov 12, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

joannabrozek commented Mar 10, 2026 •

edited

Loading

magancarz commented May 15, 2026 •

edited

Loading

rw1nkler commented Nov 4, 2026 •

edited

Loading