Skip to content

aya-log-ebpf-macros v0.1.0

Compare
Choose a tag to compare
@alessandrod alessandrod released this 12 Apr 13:39
· 165 commits to main since this release

Chore

  • Don't use path deps in workspace
    This moves the path dependencies back into the per-crate Cargo.toml.
    It is required such that the release tooling can correctly calculate
    which version constraints require changing when we perform a release.

  • 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

Chore

  • add missing changelogs

New Features

  • check format and value type in proc macro

Other

  • fix hygiene
    Before this change we leaked some bindings to the calling scope, so for
    instance logging a variable named "len" led to a compile error.

  • group_imports = "StdExternalCrate"
    High time we stop debating this; let the robots do the work.

  • 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.

  • Define dependencies on the workspace level
    This way we will avoid version mismatches and make differences in
    features across our crates clearer.

  • 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

  • ensure WriteToBuf is used
    Previously any old write method could be selected.

  • update syn requirement from 1.0 to 2.0
    Updates the requirements on syn to permit the latest version.


    updated-dependencies:

    • dependency-name: syn
      dependency-type: direct:production
      ...
  • Add format hints for MAC addresses
    Add {:mac} (for lower-case hex representation) and {:MAC} (for
    upper-case hex representation) format hints for the [u8; 6] type,
    which is the standard one in Linux to store physical addresses in.

    Tested with: https://github.com/vadorovsky/aya-examples/tree/main/xdp-mac

  • Fix the DisplayHint expression names

  • Add display hints
    This change adds optional display hints:

    • {:x}, {:X} - for hex representation of numbers
    • {:ipv4}, {:IPv4} - for IPv4 addresses
    • {:ipv6}, {:IPv6} - for IPv6 addresses

    It also gets rid of dyn-fmt and instead comes with our own parser
    implementation.

    Tested on: https://github.com/vadorovsky/aya-examples/tree/main/tc

Commit Statistics

  • 35 commits contributed to the release over the course of 623 calendar days.
  • 17 commits were understood as conventional.
  • 0 issues like '(#ID)' were seen in commit messages

Commit Details

view details
  • Uncategorized
    • Release aya-log-parser v0.1.13 (04ee35d)
    • Add missing changelogs (1d515fe)
    • Release aya-log-common v0.1.14, aya-log v0.2.0 (c22a696)
    • Don't use path deps in workspace (13b1fc6)
    • Merge pull request #882 from dave-tucker/metadata (0fadd69)
    • Use the cargo workspace package table (b3e7ef7)
    • Fix hygiene (2227223)
    • Merge pull request #797 from aya-rs/rustfmt-group-imports (373fb7b)
    • Group_imports = "StdExternalCrate" (d16e607)
    • Merge pull request #735 from aya-rs/log-option-not-result (ecf0dd9)
    • S/Result<usize, ()>/Option/ (ca3f70b)
    • Merge pull request #683 from aya-rs/logs-wtf (5ebaf5f)
    • Refactor log macro for readability (b3db916)
    • Merge pull request #667 from vadorovsky/workspace-dependencies (f554d42)
    • Define dependencies on the workspace level (96fa08b)
    • 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)
    • Check format and value type in proc macro (0970300)
    • Merge pull request #585 from probulate/tag-len-value (5165bf2)
    • Ensure WriteToBuf is used (4d098ef)
    • Merge pull request #550 from aya-rs/dependabot/cargo/syn-2.0 (3ad3cb9)
    • Update syn requirement from 1.0 to 2.0 (45072c0)
    • Merge pull request #456 from dmitris/uninlined_format_args (16b029e)
    • Fix uninlined_format_args clippy issues (055d94f)
    • Merge pull request #436 from vadorovsky/aya-log-mac-addr (3adb9b0)
    • Add format hints for MAC addresses (2223ab8)
    • Fix the DisplayHint expression names (9a8409e)
    • Add display hints (83ec27f)
    • Change from Rust edition 2018 to 2021 (944d6b8)
    • Merge pull request #350 from dave-tucker/monorepo (f37a514)
    • Re-organize into a single workspace (dc31e11)