CHANGELOG.md

Truffle Tools Changelog

This changelog summarizes major changes between Truffle Tools versions.

Version 25.1.0

• GR-72122: --cpusampler.DumpInterval and --cpusampler.ResetAfterIntervalDump options were added to dump the sampler output at a specified interval, optionally clearing all sampler data after each dump. Interval-based dumping is disabled by default; the sampler output is dumped only at the end.
  • CPUSampler#addProcessSampleListener was added to allow users to receive notifications when sampling results are processed. The new interval-based dumping feature uses this API internally.
• GR-72763 PR-12760 Enhanced GraalVM Insight to allow tracking reads and writes of local variables
• GR-73816: Restrict Chrome inspector to binding only to localhost.
• GR-74436: Chrome Inspector now writes informational messages, including the debugger WebSocket address, to the standard output stream instead of the error stream.

Version 24.1.0

• GR-52742: CPUSampler no longer guarantees to keep all contexts on the engine alive. As a result CPUSampler#getData() is deprecated and may not return data for all contexts on the engine. The contexts that were already collected by GC won't be in the returned map. CPUSamplerData#getContext() is also deprecated and returns null if the context was already collected.
• GR-52742: CPUSamplerData#getDataList() was introduced and returns all data collected by the sampler as a list of CPUSamplerData. For each context on the engine, including the ones that were already collected, there is a corresponding element in the list. CPUSamplerData#getContextIndex() returns the index of the data in the list.
• GR-53035: Added CPUSampler support for gathering any async stack trace information for each sample, enabled by default. Introduced configuration option --cpusampler.GatherAsyncStackTrace=true|false, and corresponding API CPUSampler#setGatherAsyncStackTrace, to allow disabling async stack trace sampling again.
• GR-53035: StackTraceEntry#isInlined() is no longer deprecated.
• GR-54751: --inspect.SuspensionTimeout option added to set a timeout of a debugger suspension. The debugger session is disconnected after the timeout expires.

Version 23.0.0

• GR-41407: Added new option --dap.SourcePath to allow to resolve sources with relative paths.

Version 22.3.0

• GR-40233: The interpretation of the depth parameter in Insight heap dumping was off by one and was applied to primitive values as well. This is now corrected to match the documentation.

Version 22.2.0

• GR-37442: Added new options --heap.cacheSize=<int> and --heap.cacheReplacement=flush|lru to enable memory cache in Heap Dumping via Insight.
• GR-37442: Added new method flush() to heap dumping object to flush cached events to the heap dump file.

Version 22.1.0

• Dumping JavaScript Array as Object[] into the .hprof file
• HeapDump.newArray to start building an array

Version 22.0.0

• GR-33316 Remove deprecated cpusampler APIs and CLIs
• GR-34745 Allow short-hand usage of the --cpusampler flag to enable and specify output. For example, --cpusampler=calltree is equivalent to --cpusampler --cpusampler.Output=calltree. NOTE: Since the flame graph output is unreadable in the terminal --cpusampler=flamegraph is equivalent to --cpusampler --cpusampler.Output=flamegraph -cpusampler.OutputFile=flamegraph.svg.
• GR-34209 Added overload of CPUSampler.takeSample with a timeout. By default samples time out when the configured period is exceeded.

Version 21.3.2

• Dumping JavaScript Array as Object[] into the .hprof file
• HeapDump.newArray to start building an array

Version 21.3.0

• Reimplemented CPUSampler to use the Truffle language safepoints thus deprecating several API functions.
• Added new option --cpusampler.SampleContextInitialization which includes code executed during context initialization in the general sampling profile instead of grouping it into a single entry.
• Default CLI output of CPUSampler was simplified to not include compiled times.
• CPUSampler APIs to distinguish compiled from interpreted samples were replaced by a more general API that supports an arbitrary number of compilation tiers.
• Added the --cpusampler.ShowTiers option that shows time spend in each optimization tier.
• Support for hash interoperability in Insight - no need to use Truffle::Interop.hash_keys_as_members anymore
• Cooperative heap dumping when embedding Insight into Java applications
• Add an SVG flamegraph output format to the CPUSampler, use option --cpusampler.OutputFormat=flamegraph.

Version 21.1.0

• Use --heap.dump=/path/to/file/to/generate.hprof to enable Heap Dumping via Insight
• Insight object API provides access to charIndex, charLength and charEndIndex

Version 21.0.0

• --insight option is no longer considered experimental
• Use ctx.iterateFrames to access whole stack and its variables
• Embedders can inject additional objects into Insight scripts

Version 20.3.0

• GraalVM Insight Maven artifact is now org.graalvm.tools:insight:20.3.0
• GraalVM Insight can intercept execution and modify return values

Version 20.2.0

• GraalVM Insight can modify values of local variables
• Write GraalVM Insight scripts in Python

Version 20.1.0

• GraalVM Insight can access local variables in C, C++ and other LLVM languages
• GraalVM Insight is the new name for the former T-Trace technology

Version 20.0.0

• Access to source location (see line, column, etc.) and sourceFilter selector in Insight agent object API
• Embedding Insight into own application is now easily done via Graal SDK
• Apply Insight scripts C/C++/Julia & co. code - e.g. hack into C with JavaScript!
• Better error handling - e.g. propagation of errors from Insight scripts to application code
• Hack your Insight scripts in R!

Version 19.3.0

• Introducing GraalVM Insight - a multipurpose, flexible tool for instrumenting and monitoring applications at full speed.
• Added a CLI code coverage tool for truffle languages. Enabled with --coverage. See --help:tools for more details.