lib-log

lib-log is the logging client helper library for EriX.

EriX is a clean-room, capability-based microkernel operating system written entirely in Rust.

Technical requirements are tracked in the EriX requirements, conventions, and project documentation.

See:

• docs for design documents, specifications, and development plans.
• Related architecture repositories for kernel, services, libraries, drivers, and integration tooling.

Purpose of This Repository

This repository implements the EriX log library. Its purpose in EriX is to provide reusable log primitives and contracts to EriX components.

Functionally, it exposes the log APIs, validation tests, and documentation used by dependent repositories. The repository keeps the implementation, interface contracts, tests, and documentation for that behavior in one reviewable ownership boundary.

The maintained responsibilities are:

• expose the lib-log crate API for log behavior used by dependent components
• keep data formats, constants, and validation helpers documented and tested
• preserve clean-room, no-external-crate implementation boundaries
• maintain compatibility expectations for downstream repositories

Clean-Room Policy

EriX follows a strict clean-room philosophy:

• No external source code may be copied.
• No external Rust crates are allowed.
• No code generation tools that embed third-party code.
• All code must be authored within the project.

Violations will result in rejection of the contribution.

License

All EriX repositories are licensed under the ISC License.

Development Model

EriX development is modular, deterministic, reproducible, authority-explicit, security-first, and self-hosting oriented.

This repository follows the project roadmap and the validation rules documented in its own roadmap.

Current status

• Cargo.toml and the lib_log crate are present.
• The crate exposes allocation-free submit_str, submit_nul_terminated_bytes, and query helpers over a caller-supplied transport callback.
• Log messages are arbitrary-length strings sent through lib-ipc LogdSubmitStringRequestV1 transport fragments.
• Submit helpers return LogSubmitResponseV1, a logical record result that hides the fragment-response transport frame from service callers and offers an is_success() helper for result checks.
• Submit transport buffer sizing is exposed as logical LOG_SUBMIT_* constants, so services do not depend on transport-frame payload sizes.
• submit_str accepts Rust str messages with no interior NUL; submit_nul_terminated_bytes accepts raw caller scratch up to its first NUL. The terminator and any trailing scratch bytes are not transported.
• Queries return one retained record chunk at a time through LogdQueryResponseV1.
• Submit and query options expose only implemented fields; the protocol carries no speculative metadata selector or compatibility padding.
• Newlines stay as \n; serial newline compatibility is handled by the serial sink path, not by this library.

Governance Principles

lib-log governance is scoped to reusable log contracts shared by dependent repositories.

The scoped governance rules are:

• It must expose narrow, documented APIs rather than component-specific policy.
• It keeps wire formats, constants, parsers, and validation helpers deterministic and testable through lib-ipc.
• It preserves clean-room implementation boundaries and does not introduce external crate dependencies.
• Breaking API or format changes require coordinated updates in every dependent repository.

Library Boundaries

• lib-log carries no runtime authority by itself; authority is held by callers that use the library.
• The crate must not hide ambient I/O, allocation policy, or service discovery behind helper APIs.

Contact

Development occurs in EriX organization and discussions happen in issues and design documents.

No decisions are considered valid without documented rationale.

Maintainers can be reached via email: admin@erikinkinen.fi.