Skip to content

program-log: Add new crate#356

Merged
febo merged 47 commits intoanza-xyz:masterfrom
febo:solana-program-log
Oct 9, 2025
Merged

program-log: Add new crate#356
febo merged 47 commits intoanza-xyz:masterfrom
febo:solana-program-log

Conversation

@febo
Copy link
Copy Markdown
Contributor

@febo febo commented Oct 8, 2025

Problem

Currently, logging messages that require formatting are a bit heavy on the CU consumption. For example, a simple msg!("lamports={}", lamports) log can take ~627 CUs.

Solution

Create a lightweight log! macro that improves CU consumption.

Below is a sample of the improvements observed when formatting log messages, measured in terms of compute units (CU):

Ouput message log! msg! Improvement (%)
"Hello world!" 104 104 -
"lamports={}" + u64 286 625 (+339) 55%
"{}" + [&str; 2] 119 1610 (+1491) 93%
"lamports={}" + i64 299 659 (+360) 55%
"{}" + [u8; 32] (address bytes) 2783 8397 (+5614) 67%
"lamports={:.9}" + u64 438 2656 (+2218)* 84%

* For msg!, the value is logged as a f64 otherwise the precision formatting is ignored.

febo and others added 30 commits October 8, 2025 03:03
@febo
Lightweight log macro (anza-xyz#32)
2a59454 
* Add log standalone crate

* Refactored

* Fix return value

* Remove additional crate

* Tidy up

* Use memcpy

* Improve digit formatting

* Improve slice formatting

* Improve comments

* Add readme

* Update README.md

* Update README.md

* Remove doctests

* Use workspace values
@febo
Added linked readme
a701bd6
@febo
Add precision formatting (anza-xyz#47)
ed4a105 
* Add precision argument

* Add std feature

* Add std feature cfg

* Add precision to solana target

* Add precision support for signed types

* Add inline

* Update docs

* Fix slice offset

* Fix delta for signed values

* Fix doc tests
@febo
Add precision formatting to log! macro (anza-xyz#50)
d89b9b2 
* Add precision formatting

* Remove lazy lock

* Add precision formatting details

* Update banner image

* Add subtitle
@febo
log: Add precision support to str (anza-xyz#51)
a97c9ef 
* Bump version

* Inline never

* Add precision support to str

* Add trucated attributes
@febo
macro: Add truncate formatting (anza-xyz#52)
4b1016d 
* Add truncate format parsing

* Add formatting options
@febo
Update README.md
ef4504b
@febo
Bump log version
94199a7
@febo
Add formatting examples
0347a5f
@febo
Update banner image
ee41c7b
@febo
Update banner image
c87fdb6
@febo
Add crate type
85300b7
@febo
log: Add support for usize and isize (anza-xyz#69)
8e7d1b5 
* Fix typo

* Add support for usize and isize

* Improve sign conversion

* Add tests

* Simplify isize handling
@rex4539 @febo
Avoid duplicate crates (anza-xyz#74)
6fe8684 
* Avoid duplicate crates

* Fix vulnerable package
@SITADRITA1 @febo
Fix Grammar and Typographical Errors in Documentation (anza-xyz#86)
31d0955 
* Update README.md

* Update README.md

* Update README.md
@febo
Address review comments (anza-xyz#78)
5ff65f2 
* [wip]: Address review comments

* [wip]: Fix pointer reference

* [wip]: Add logger buffer size tests

* Remove unused

* More logger tests

* Rename program to cpi

* Remove dynamic allocation

* Fixed signed tests

* Fix review comments

* Fix unsigned test case

* Add is_owner_by helper
@febo
Update README layout (anza-xyz#100)
886b552 
* Update readme

* Add docs

* Fix link
@febo
chore: Release
adec73b
@febo
chore: Release
d515bfb
@febo
log: Use alloc crate (anza-xyz#120)
94eb99b 
Use alloc
@febo
Publish pinocchio-log-macro v0.4.1
d09d64e
@febo
Add rust version to crates (anza-xyz#135)
f3ae96b 
Add rust version
@osrm @febo
chore: fix typos (anza-xyz#150)
455c243 
fix typos README.md
@febo
log: Improve digit logic (anza-xyz#155)
1ffe5d2 
Tweaks
@febo
log: Add support for bool type (anza-xyz#156)
3ffd29e 
* Tweaks

* Add bool support
@LucasSte @febo
Use static syscalls when available (anza-xyz#157)
ae04fbb
@sonicfromnewyoke @febo
fix: make sol_log_ call public (anza-xyz#168)
8df528a 
* fix: make sol_log_ call public

* fix: logger formatting
@sonicfromnewyoke @febo
feat: addlog_cu_usage proc_macro_attribute (anza-xyz#162)
aa601ac 
* feat: add compute_fn proc_macro_attribute

* WIP: use sol_remaining_compute_units syscall for calc

* docs: actualize docs and add introspection cost comment

* refactor: add static-syscall, remove dep on pinocchio from log, rename compute_fn -> log_cu_usage

* fix: correct comment

* fix: ci format step
@febo
log: Add unsafe to Log trait (anza-xyz#186)
b0e43c0 
Add unsafe
@febo @joncinque
log: Calculate maximum digits for Log implementation (anza-xyz#188)
5d07500 
* Calculate max digits

* Remove second const

Co-authored-by: Jon C <me@jonc.dev>

---------

Co-authored-by: Jon C <me@jonc.dev>
febo and others added 11 commits October 8, 2025 03:03
@febo
ci: Add spellcheck step (anza-xyz#164)
c63bdd8 
* Add invoke instruction helper

* Typos

* Remove new helpers

* Remove unused

* Address review comments

* Tweak inline attributes

* Use invoke signed unchecked

* Refactor inline

* Renamed to with_bounds

* Update docs

* Revert change

* Add constant length check

* Add spellcheck step

* Tweak action

* Fix typos

* More fixes

* Yet more fixes

* Fixes

* Add j1 option

* More and more fixes

* Add missing acronym

* Fix merge

* Fix spelling

* Fix spelling
@febo
Publish pinocchio-log-macro v0.5.0
285a041
@febo
Publish pinocchio-log v0.5.0
1f35a5d
@febo
log: Update precision logic (anza-xyz#252)
06fc0c5 
* Add precision cap

* Add tests

* Refactor precision logic

* Fix miri warning

* Avoid duplication

* Add missing syscall

* More tests

* Fix truncate logic

* Fix review comments
@febo
Publish pinocchio-log v0.5.1
de4f043
@febo
Add solana-program-log
dad5466
@febo
Add no_std check
6b5ae92
@febo
Fix formatting
12a97ae
@febo
Fix formatting
e044513 
Updated README to correct links and improve formatting.
@febo
Add std support
4126c55
@febo
Fix docs
859bcca
@febo febo force-pushed the solana-program-log branch from ab0b1fe to 94e75bb Compare October 8, 2025 02:03
@febo febo marked this pull request as draft October 8, 2025 02:08
@febo febo force-pushed the solana-program-log branch from 94e75bb to ac253fd Compare October 8, 2025 09:18
@febo febo marked this pull request as ready for review October 8, 2025 09:36
@febo febo requested a review from joncinque October 8, 2025 09:36
joncinque
joncinque reviewed Oct 8, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I'm assuming the code is the same as in pinocchio, so I focused on integrating this in the repo

Comment thread Cargo.toml Outdated
Comment thread program-log/README.md Outdated
Comment thread program-log-macro/Cargo.toml
Comment thread program-log/macro/README.md Outdated
Comment thread program-log/crate/README.md Outdated
Comment thread program-log/macro/Cargo.toml Outdated
@febo
Copy link
Copy Markdown
Contributor Author

febo commented Oct 8, 2025

Looks great! I'm assuming the code is the same as in pinocchio, so I focused on integrating this in the repo

Yes, the code is the same.

@febo febo requested a review from joncinque October 8, 2025 22:16
joncinque
joncinque approved these changes Oct 8, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@joncinque joncinque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@febo febo merged commit c14ab07 into anza-xyz:master Oct 9, 2025
26 checks passed
@febo febo deleted the solana-program-log branch October 9, 2025 00:16
@febo febo mentioned this pull request Oct 9, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joncinque joncinque joncinque approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@febo @joncinque @rex4539 @SITADRITA1 @osrm @LucasSte @sonicfromnewyoke