[Native] Add printf-style native logging#12140
Conversation
Introduce printf-style native logging and abort helpers while preserving the existing std::format APIs for MonoVM and CoreCLR. Migrate the NativeAOT-specific formatted call sites to the new primitives. Refs #12139 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 187b207a-083b-461e-9071-e9aab61c9d07
CI failure analysisThe public
The NativeAOT/libunwind collision is additional real-world evidence for #12139. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
|
/review |
|
✅ Android PR Reviewer completed successfully! |
There was a problem hiding this comment.
🤖 Code Review — ⚠️ Minor suggestions (no blockers)
Reviewed the printf-style native logging primitives and the NativeAOT call-site migration. This is clean, well-scoped work.
What I verified
- printf format attributes are correct.
Helpers::abort_applicationfusesformat(printf, 3, 4); since it's a static member (no implicitthis), the 3/4 indices are right. The free functionslog_writef(3,4) andlog_debugf/log_infof/... (2,3) are also indexed correctly. - Category-guard semantics are consistent. The new
(log_categories & category) == 0early-return matches the modern CLRDO_LOG_FMTmacro (!= 0to log), so behavior is unchanged for the migratedlog_debugf/log_infofpaths.log_warnf/errorf/fatalfare unguarded, matching the existinglog_warn/log_error/log_fatal. - Null-format safety.
log_writevandabort_applicationfboth guardnullptrformats with"<null>"/safe_format, andabort_applicationfcorrectly falls back tosafe_formatwhenvasprintfreturns< 0. abort_applicationno longer routes fatal text throughstd::format— good, this preserves full tombstone text and drops the libc++ dependency as intended.- Leak of the
vasprintfbuffer inabort_applicationfis acceptable: it's a[[noreturn]]abort path, so the process dies immediately. - Host-native regression test is a nice addition — it exercises
%s/%p/%dforwarding, priority mapping, and disabled-category suppression against Android log stubs.
Suggestions (both inline, non-blocking)
- 💡 Add an explicit
#include <cstdio>inhelpers.ccforvasprintfrather than relying on a transitive include. - 💡
log_warnf/log_errorf/log_fatalfare currently unused — confirm the follow-up migration PRs consume them so they don't rot.
CI
GitHub commit status is currently pending (checks not yet reported) at 4a27f68. Not treating this as a failure, but the PR isn't mergeable until the Azure DevOps pipeline is green.
Nice, focused first step toward dropping the NativeAOT libc++ dependency. 👍
Generated by Android PR Reviewer for #12140 · 104.3 AIC · ⌖ 13.1 AIC · ⊞ 6.8K
Comment /review to run again
Keep the printf logging PR focused on the runtime implementation instead of introducing new host-native logging test infrastructure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 70f63eb7-6599-414c-a947-d860705aa0fa
|
/review |
|
✅ Android PR Reviewer completed successfully! |
There was a problem hiding this comment.
✅ LGTM (with minor suggestions)
Reviewed the printf-style native logging primitives and the initial NativeAOT call-site migrations. This is a clean, well-scoped change and I verified the details that usually go wrong here:
printfformat attributes are correct —format(printf, 3, 4)forlog_writef/abort_applicationfandformat(printf, 2, 3)forlog_{debug,info,warn,error}fall index the format string and first vararg correctly (source-location/level params counted).- Category filtering is consistent —
log_debugf/log_infofgate onlog_categories, whilelog_warnf/log_errorf/log_writefdo not, exactly mirroring the existinglog_debug/log_infovslog_warn/log_errormacro behavior. - Null-format safety —
log_writevandabort_applicationfsubstitute"<null>"before reaching__android_log_vprint/vasprintf. abort_applicationno longer routes the message throughstd::format(log_write(..., Fatal, message)), which also removes a latent%/{}interpretation hazard on the fatal path.optional_string()returnsconst char*, so the new%susage inhost.ccis safe (not astring_view).- CI — all completed
dotnet-androidlegs are green (build, MSBuild, emulator, package tests); overall status shows pending only from the fresh merge-commit re-trigger.
Suggestions (non-blocking)
- 💡 Document the intentional
vasprintfbuffer leak on the[[noreturn]]abort path (inline). - 💡 Consider hoisting the duplicated
log_*fbodies shared between the CLR and Mono backends into common code to prevent drift as later stacked PRs migrate more call sites (inline).
Verdict:
Generated by Android PR Reviewer for #12140 · 94.2 AIC · ⌖ 13 AIC · ⊞ 6.8K
Comment /review to run again
## Summary Continue the printf-style logging migration introduced by #12140 in the shared native timing infrastructure. The timing headers are used by MonoVM, CoreCLR, and NativeAOT. All three runtimes now use the same printf-style path for variable timing diagnostics rather than maintaining MonoVM-only `std::format` branches. **Base/dependency:** #12140 must merge first. This PR targets `dev/simonrozsival/nativeaot-printf-logging` so its diff contains only the timing migration. Part of #12139. ## Scope Only two shared timing headers change: - `src/native/common/include/runtime-base/timing.hh` - `src/native/common/include/runtime-base/timing-internal.hh` These files do not overlap #12141, #12142, #12145, #12148, #12150, or #12155. ## Changes ### Managed timing records - replace the owning `std::format` result in `Timing::do_log()` with `log_writef()` for every runtime; - preserve the exact `message; elapsed: seconds:milliseconds::nanoseconds` field order; - pass duration values as explicitly converted `unsigned long long` values matching `%llu`. ### Fast timing diagnostics Migrate variable diagnostics to `log_warnf()` for every runtime: - timing event buffer reallocation sizes; - `CLOCK_MONOTONIC_RAW` errors; - unknown event-kind values; - invalid event-index source method names. Constant warning messages continue using the existing non-formatting `string_view` overload. ## Behavior preserved - timing enablement and category gating are unchanged; - timing sequence acquisition/release is unchanged; - elapsed duration units, values, and output order are unchanged; - event-buffer growth, clock error handling, unknown-event fallback, and index validation are unchanged; - no timing data structures, locks, vectors, strings, or event lifecycle code change. ## Runtime behavior | Runtime | Result | |---|---| | NativeAOT | Uses #12140 printf helpers for variable timing diagnostics | | CoreCLR | Uses #12140 printf helpers for variable timing diagnostics | | MonoVM | Uses the matching MonoVM printf helper implementation from #12140 | ## Measured impact Representative Android arm64 Release objects compiled before the MonoVM path was unified: | Runtime/object | Before | After | Difference | |---|---:|---:|---:| | CoreCLR `internal-pinvokes-clr.cc.o` | 145,472 B | 17,080 B | -128,392 B (-88.26%) | | NativeAOT `host.cc.o` | 176,104 B | 175,960 B | -144 B | CoreCLR's representative object drops from 58 formatting symbols to zero. NativeAOT's representative object still contains formatting symbols from other included functionality, but the timing call sites migrated here no longer instantiate them. ## Non-goals - no new timing tests or logging test framework; - no change to timing data ownership or synchronization; - no changes to the logging helper implementation introduced by #12140; - no attempt to migrate unrelated timing output/file-generation code outside these shared timing headers. ## Validation - `git diff --check`; - NDK Clang C++23 syntax compilation of all 36 Android arm64 Release NativeAOT source variants; - NDK Clang C++23 syntax compilation of all 38 Android arm64 Release CoreCLR source variants; - NDK Clang C++23 syntax compilation of all 31 Android arm64 Release MonoVM source variants; - representative before/after object compilation, size comparison, and symbol inspection; - focused review of chrono values, integer format widths, source-location output, and category semantics; - latest head: `21ff66b26`. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
## Summary Continue the printf-style logging migration introduced by #12140 by converting shared CoreCLR/NativeAOT JNI reference logging in `OSBridge`. The `src/native/clr/` location is shared infrastructure: the NativeAOT host explicitly compiles `clr/host/os-bridge.cc`, while MonoVM uses its separate `mono/monodroid/osbridge.cc` implementation. This PR therefore affects CoreCLR and NativeAOT, but not MonoVM. **Base/dependency:** #12140 must merge first. This PR targets `dev/simonrozsival/nativeaot-printf-logging` so its diff contains only this migration. Part of #12139. ## Scope Only two files change: - `src/native/clr/host/os-bridge.cc` - `src/native/clr/include/host/os-bridge.hh` This does not overlap the open sibling work: - #12141 changes `gc-bridge.cc/.hh` — worker-thread and semaphore handoff; - #12142 changes logging/path ownership and source-location parsing elsewhere; - #12145 changes `bridge-processing.cc/.hh` — temporary-peer graph storage; - #12148 changes shared host/runtime utility logging. ## Changes ### Format reference records once - add a private printf-checked `OSBridge::log_itf()` helper; - use `vasprintf()` to produce one NUL-terminated reference-log line; - pass the same formatted line to the existing logcat and file-writing path; - release the C allocation after both destinations have consumed it; - on allocation failure, fall back to the static format string rather than throwing from a `noexcept` `std::format` path. ### Migrate JNI reference events Replace six owning `std::format` constructions: - new global reference; - deleted global reference; - new weak global reference; - deleted weak global reference; - new local reference; - deleted local reference. The replacements use `%d`, `%p`, `%c`, and `%s` with compiler format checking from the private helper declaration. ### Remove ranges-heavy stack-trace splitting - replace `std::views::split` with an in-place `std::string_view` newline scan; - preserve empty, consecutive, and trailing lines; - preserve logcat-only, file-only, and combined output behavior; - write non-NUL-terminated line views with explicit lengths; - convert stack-trace and raw gref logcat forwarding to `%.*s` / `%s`. ## Responsibility boundary with #12141 - `GCBridge` (#12141) controls **when and where** a bridge round runs: callback handoff, worker thread, semaphore synchronization, and Java GC triggering. - `OSBridge` (this PR) tracks and logs **JNI reference events**: gref/weak-gref counters, reference creation/deletion lines, and optional stack traces. The classes call each other through existing stable helpers, but this PR changes no GC scheduling, graph processing, callback lifecycle, or synchronization state. ## Behavior preserved - reference counters are incremented/decremented at the same points; - logging remains gated by `LOG_GREF` / `LOG_LREF` before formatting; - each reference line is still emitted to logcat and, when configured, the corresponding file; - stack traces retain one output line per newline-delimited segment, including empty segments; - logcat/file flushing behavior is unchanged; - pointer, reference-type, thread-name, thread-id, and counter fields retain the same ordering and textual structure. ## Measured impact Android arm64 Release NativeAOT `os-bridge.cc` object, compiled with the repository-generated production NDK command: | Artifact | Before | After | Difference | |---|---:|---:|---:| | `os-bridge.cc.o` | 168,784 B | 31,288 B | -137,496 B (-81.46%) | | format/basic-string symbols | 21 | 6 | -15 | The remaining C++ string symbols come from other shared header functionality; the six `std::format` reference-log instantiations are removed. ## Non-goals - no new logging test framework is introduced; - no GC bridge synchronization or graph-processing code changes; - no MonoVM `osbridge.cc` changes; - no changes to the public logging helpers introduced by #12140. ## Validation - `git diff --check`; - no file overlap with #12141, #12142, #12145, or #12148; - NDK Clang C++23 syntax compilation of all 36 Android arm64 Release NativeAOT source variants; - NDK Clang C++23 syntax compilation of all 38 Android arm64 Release CoreCLR source variants; - before/after NativeAOT object compilation and symbol inspection; - focused read-only review of newline handling, allocation cleanup, OOM fallback, format types, category gating, and dual-destination output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
## Summary Continue the printf-style logging migration introduced by #12140 for native configuration and parsing diagnostics. This PR converts CoreCLR/NativeAOT host-environment messages and the shared MonoVM/CoreCLR/NativeAOT integer-parsing messages to the printf helpers from #12140. Shared code now has one logging path instead of runtime-specific format branches. **Base/dependency:** #12140 must merge first. This PR targets `dev/simonrozsival/nativeaot-printf-logging` so its diff contains only this migration. Part of #12139. ## Scope Only two files change: - `src/native/clr/include/host/host-environment.hh` - `src/native/common/include/runtime-base/strings.hh` These files do not overlap #12141, #12142, #12145, #12148, #12150, or #12153. ## Changes ### Host environment diagnostics `host-environment.hh` is shared by CoreCLR and NativeAOT, but not MonoVM. - migrate generated system-property diagnostics to `%s` formatting; - migrate XDG directory creation diagnostics to `%s` formatting; - migrate XDG directory failure diagnostics while preserving the original errno text; - retain `optional_string()` handling for null C-string inputs. ### Integer parsing diagnostics `strings.hh` is shared by all three runtimes. Its variable diagnostics now use `log_errorf()` without runtime-specific branches: - an invalid starting index, using `%zu` for `size_t`; - signed/unsigned range failures, using explicitly converted `%lld` / `%llu` values; - values that do not represent an integer in the selected `%d` base; - trailing non-numeric characters. The header forward-declares only `log_errorf()` instead of including the heavyweight formatting declarations from `shared/log_types.hh`. ## Behavior preserved - integer conversion logic, range checks, errno handling, and output assignment are unchanged; - the copied parse buffer remains NUL-terminated before `%s` logging; - host environment variables and XDG directory creation behavior are unchanged; - debug category gating and unconditional error/warning semantics remain unchanged. ## Runtime behavior | Runtime | Result | |---|---| | NativeAOT | Uses #12140 printf helpers for all migrated diagnostics | | CoreCLR | Uses #12140 printf helpers for shared parsing and host-environment diagnostics | | MonoVM | Uses the matching MonoVM `log_errorf()` implementation for shared parsing diagnostics | ## Measured impact Representative Android arm64 Release objects compiled before the MonoVM path was unified: | Runtime/object | Before | After | Difference | |---|---:|---:|---:| | NativeAOT `host-environment.cc.o` | 131,288 B | 130,848 B | -440 B | | CoreCLR `timing-internal.cc.o` | 194,048 B | 193,088 B | -960 B | These call sites did not contain explicit `std::format` expressions, so the impact is smaller than #12150/#12153; the change prevents their formatted logging templates from being instantiated. ## Non-goals - no new configuration or parsing behavior; - no changes to environment-variable storage, XDG path construction, or integer parsing buffers; - no new logging tests; - no attempt to migrate unrelated configuration code outside these two headers. ## Validation - `git diff --check`; - NDK Clang C++23 syntax compilation of all 36 Android arm64 Release NativeAOT source variants; - NDK Clang C++23 syntax compilation of all 38 Android arm64 Release CoreCLR source variants; - NDK Clang C++23 syntax compilation of all 31 Android arm64 Release MonoVM source variants; - representative before/after object compilation and size comparison; - focused review of signed/unsigned conversions, format widths, null termination, include dependencies, and runtime behavior; - latest head: `72cad5d01`. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Jonathan Peppers <jonathan.peppers@microsoft.com>
Summary
Introduce printf-style native logging primitives and migrate the initial NativeAOT formatted logging call sites to them.
This is the first implementation step from #12139 toward removing the Android NativeAOT dependency on libc++.
Changes
log_writev(),log_writef(),log_debugf(),log_infof(),log_warnf(), andlog_errorf()alongside the existingstd::formatAPIs;Helpers::abort_applicationf()for formatted fatal messages without truncating tombstone text;<cstdio>explicitly forvasprintf();log_fatalf()wrapper; formatted fatal termination usesabort_applicationf()instead;std::format;{}formatting;std::formatinsideHelpers::abort_application().The existing
std::formatAPIs remain available so unrelated call sites can be migrated incrementally. The current stacked migrations are #12148 (shared runtime utilities), #12150 (JNI reference logging), #12153 (timing logging), and #12155 (configuration diagnostics).Runtime behavior
<null>rather than passed to__android_log_vprint().Validation
git diff --check;src/native/native-nativeaot.csproj;src/native/native-clr.csproj;va_list, category filtering, format checking, source-location behavior, and Android log-priority mapping;09f0690da.Part of #12139.