Release aya-log-common v0.1.14 · aya-rs/aya

Chore

Use the cargo workspace package table
This allows for inheritance of common fields from the workspace root.
The following fields have been made common:
- authors
- license
- repository
- homepage
- edition

Documentation

Add CHANGELOG

New Features

check format and value type in proc macro

Bug Fixes

remove some useless code

Other

update comments
These were missed when the code was updated.
s/Result<usize, ()>/Option/
Option<NonZeroUsize> is guaranteed to have the same size as usize,
which is not guarnateed for Result. This is a minor optimization, but
also results in simpler code.
annotate logging functions inlining
Some of these functions fail to compile when not inlined, so we should
be explicit.

Before deciding on this approach I tried various ways of making all
these functions #[inline(never)] to save instructions but I ran into
blockers:
- These functions currently return Result, which is a structure. This is
  not permitted in BPF.
- I tried inventing a newtype that is a #[repr(transparent)] wrapper of
  u16, and having these functions return that; however it seems that
  even if the object code is legal, the verifier will reject such
  functions because the BTF (if present, and it was in my local
  experiments) would indicate that the return is a structure.
- I tried having these functions return a plain u16 where 0 means error,
  but the verifier still rejected the BTF because the receiver (even if
  made into &self) is considered a structure, and forbidden.
We can eventually overcome these problems by "lying" in our BTF once
support for it matures in the bpf-linker repo (e.g. Option
should be perfectly legal as it is guaranteed to be word-sized), but we
aren't there yet, and this is the safest thing we can do for now.
Simplify
- Remove TagLenValue; this type has a single method, which is now a
  function.
- Remove generics from TagLenValue::write (now write). The tag is
  always u8, and the value is always a sequence of bytes.
- Replace slicing operations which can panic with calls to get which
  explicit check bounds.
Define dependencies on the workspace level
This way we will avoid version mismatches and make differences in
features across our crates clearer.
add formatter and check in CI
simplify argument validation

avoid requiring Copy
Before this change:

error[E0382]: use of moved value: `no_copy`
  --> test/integration-ebpf/src/log.rs:35:9
   |
33 |         let no_copy = NoCopy {};
   |             ------- move occurs because `no_copy` has type `NoCopy`, which does not implement the `Copy` trait
34 |
35 |         debug!(&ctx, "{:x}", no_copy.consume());
   |         ^^^^^^^^^^^^^^^^^^^^^-------^---------^
   |         |                    |       |
   |         |                    |       `no_copy` moved due to this method call
   |         |                    use occurs due to use in closure
   |         value used here after move
   |
note: `NoCopy::consume` takes ownership of the receiver `self`, which moves `no_copy`
  --> test/integration-ebpf/src/log.rs:28:24
   |
28 |             fn consume(self) -> u64 {
   |                        ^^^^
   = note: this error originates in the macro `debug` (in Nightly builds, run with -Z macro-backtrace for more info)

For more information about this error, try `rustc --explain E0382`.
error: could not compile `integration-ebpf` (bin "log") due to previous error

fix compile errors
aya-log-ebpf-macros was failing to compile because it was referencing
a couple of DisplayHint variants that no longer exist. These were
removed in #599.

    Compiling aya-log-ebpf-macros v0.1.0 (/home/robert/aya/aya-log-ebpf-macros)
error[E0599]: no variant or associated item named `Ipv4` found for enum `DisplayHint` in the current scope
  --> aya-log-ebpf-macros/src/expand.rs:93:22
   |
93 |         DisplayHint::Ipv4 => parse_str("::aya_log_ebpf::macro_support::check_impl_ipv4"),
   |                      ^^^^ variant or associated item not found in `DisplayHint`

Unify IP format hints into one, repsesent it by :i token
Having separate format hints and tokens per IP address family is
unnecessary, since they are represented by different types and we handle
format hints for each type separately. So we can just have one format
hint.

Also, we should be consistent with the format strings grammar in
Rust[0]. The type token, which is mapped to formatting traits, usually
consists of one letter[1] (and optional ? for Debug trait, but that
doesn't matter for us). It shouldn't consist of multiple letters. Our
:ipv4 and :ipv6 tokens were clearly breaking that convention, so we
should rather switch to something with one letter - hence :i.

[0] https://doc.rust-lang.org/std/fmt/#syntax
[1] https://doc.rust-lang.org/std/fmt/#formatting-traits
support logging byte slices
These only support LowerHex and UpperHex hints for now.
generalize TagLenValue
This allows logging values backed by generators.
Move the Pod implementations from aya-log-common to aya-log
Keeping the Pod implementations and optional dependency on aya in
aya-log-common breaks the clippy checks (which are made on the entire
workspace).

The reason is that when different crates inside the workspace have the
same dependency with different features, that dependency is built only
once with the sum of features needed by all crates. It's not being
built separately with different feature sets.

That's why, before this change, aya-log-common was built once for the
entire workspace with userspace feature enabled. That made importing
aya-log-ebpf inside integration-ebpf impossible. The aya-log-common
build, with userspace feature enabled, was pulling std as a
dependency. Therefore, importing aya-log-ebpf inside integration-ebpf
resulted in including std and errors like:
```
error[E0152]: found duplicate lang item `panic_impl`
  --> test/integration-ebpf/src/log.rs:23:1
   |
23 | fn panic(_info: &core::panic::PanicInfo) -> ! {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: the lang item is first defined in crate `std` (which `aya` depends on)
```
This change fixes the problem by removing the userspace feature from
aya-log-common and moving the Pod implementations to aya-log.
update num_enum requirement from 0.5 to 0.6
Updates the requirements on num_enum to permit the latest version.
- Release notes
- Commits
updated-dependencies:
- dependency-name: num_enum
  dependency-type: direct:production
  ...

Commit Statistics

37 commits contributed to the release over the course of 469 calendar days.
469 days passed between releases.
18 commits were understood as conventional.
0 issues like '(#ID)' were seen in commit messages

Commit Details

view details

Uncategorized
- Add CHANGELOG (4f0f095)
- Release aya-log-common v0.1.14, aya-log v0.2.0 (c22a696)
- Merge pull request #882 from dave-tucker/metadata (0fadd69)
- Use the cargo workspace package table (b3e7ef7)
- Merge pull request #738 from aya-rs/kill-qemu-better (fbbf191)
- Update comments (b54a106)
- Merge pull request #735 from aya-rs/log-option-not-result (ecf0dd9)
- S/Result<usize, ()>/Option/ (ca3f70b)
- Merge pull request #729 from aya-rs/logs-inline-always (84d5791)
- Annotate logging functions inlining (3cfd886)
- Simplify (fe047d7)
- Merge pull request #667 from vadorovsky/workspace-dependencies (f554d42)
- Define dependencies on the workspace level (96fa08b)
- Merge pull request #666 from aya-rs/toml-fmt (dc3b0b8)
- Add formatter and check in CI (c8bf646)
- Merge pull request #650 from aya-rs/test-cleanup (61608e6)
- Include ~all crates in default members (6d06e2b)
- Merge pull request #641 from aya-rs/logger-messages-plz (4c0983b)
- Add missing test annotation (7f25956)
- Merge pull request #611 from probulate/check-refs-not-values (3f1a469)
- Simplify argument validation (6feebef)
- Avoid requiring Copy (de79724)
- Fix compile errors (47a2f25)
- Unify IP format hints into one, repsesent it by :i token (84e5e28)
- Merge pull request #606 from Hanaasagi/check-format-in-log (58f1ecb)
- Remove some useless code (d999a95)
- Check format and value type in proc macro (0970300)
- Merge pull request #585 from probulate/tag-len-value (5165bf2)
- Support logging byte slices (d9f966e)
- Generalize TagLenValue (9a1a720)
- Aya-log, aya-log-common: economize bytes (a4a69a6)
- Merge pull request #591 from vadorovsky/aya-log-impl-pod (3d3ce8b)
- Move the Pod implementations from aya-log-common to aya-log (5603d72)
- Merge branch 'aya-rs:main' into lsm_sleepable (1f2006b)
- Merge pull request #570 from aya-rs/dependabot/cargo/num_enum-0.6 (fcc8a0d)
- Update num_enum requirement from 0.5 to 0.6 (b10a311)
- Revert "aya-log, aya-log-common: temporarily revert to old map API so we can release" (0b41018)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

aya-log-common v0.1.14