From 2227223a96b0016ec960a8d5ba354d8c889ecc68 Mon Sep 17 00:00:00 2001
From: Alessandro Decina <alessandro.d@gmail.com>
Date: Sun, 15 Oct 2023 15:45:18 +1100
Subject: [PATCH] aya-log: 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.
---
 aya-log-ebpf-macros/src/expand.rs      | 21 ++++++++++++---------
 test/integration-ebpf/src/log.rs       |  5 +++++
 test/integration-test/src/tests/log.rs |  9 +++++++++
 3 files changed, 26 insertions(+), 9 deletions(-)

diff --git a/aya-log-ebpf-macros/src/expand.rs b/aya-log-ebpf-macros/src/expand.rs
index efc1a943..fb4630b3 100644
--- a/aya-log-ebpf-macros/src/expand.rs
+++ b/aya-log-ebpf-macros/src/expand.rs
@@ -1,6 +1,6 @@
 use aya_log_common::DisplayHint;
 use aya_log_parser::{parse, Fragment};
-use proc_macro2::TokenStream;
+use proc_macro2::{Ident, Span, TokenStream};
 use quote::quote;
 use syn::{
     parse::{Parse, ParseStream},
@@ -141,13 +141,16 @@ pub(crate) fn log(args: LogArgs, level: Option<TokenStream>) -> Result<TokenStre
 
     let num_args = values.len();
     let values_iter = values.iter();
-
+    let size = Ident::new("size", Span::mixed_site());
+    let len = Ident::new("len", Span::mixed_site());
+    let slice = Ident::new("slice", Span::mixed_site());
+    let record = Ident::new("record", Span::mixed_site());
     Ok(quote! {
         match unsafe { &mut ::aya_log_ebpf::AYA_LOG_BUF }.get_ptr_mut(0).and_then(|ptr| unsafe { ptr.as_mut() }) {
             None => {},
             Some(::aya_log_ebpf::LogBuf { buf }) => {
                 let _: Option<()> = (|| {
-                    let size = ::aya_log_ebpf::write_record_header(
+                    let #size = ::aya_log_ebpf::write_record_header(
                         buf,
                         #target,
                         #lvl,
@@ -156,14 +159,14 @@ pub(crate) fn log(args: LogArgs, level: Option<TokenStream>) -> Result<TokenStre
                         line!(),
                         #num_args,
                     )?;
-                    let mut size = size.get();
+                    let mut #size = #size.get();
                     #(
-                        let slice = buf.get_mut(size..)?;
-                        let len = ::aya_log_ebpf::WriteToBuf::write(#values_iter, slice)?;
-                        size += len.get();
+                        let #slice = buf.get_mut(#size..)?;
+                        let #len = ::aya_log_ebpf::WriteToBuf::write(#values_iter, #slice)?;
+                        #size += #len.get();
                     )*
-                    let record = buf.get(..size)?;
-                    unsafe { &mut ::aya_log_ebpf::AYA_LOGS }.output(#ctx, record, 0);
+                    let #record = buf.get(..#size)?;
+                    unsafe { &mut ::aya_log_ebpf::AYA_LOGS }.output(#ctx, #record, 0);
                     Some(())
                 })();
             }
diff --git a/test/integration-ebpf/src/log.rs b/test/integration-ebpf/src/log.rs
index 51c1a46d..8b82f657 100644
--- a/test/integration-ebpf/src/log.rs
+++ b/test/integration-ebpf/src/log.rs
@@ -26,6 +26,11 @@ pub fn test_log(ctx: ProbeContext) {
     warn!(&ctx, "hex lc: {:x}, hex uc: {:X}", hex, hex);
     let hex = [0xde, 0xad, 0xbe, 0xef].as_slice();
     debug!(&ctx, "hex lc: {:x}, hex uc: {:X}", hex, hex);
+    let len = 42;
+    let size = 43;
+    let slice = 44;
+    let record = 45;
+    debug!(&ctx, "{} {} {} {}", len, size, slice, record);
 
     // Testing compilation only.
     if false {
diff --git a/test/integration-test/src/tests/log.rs b/test/integration-test/src/tests/log.rs
index c51f7e96..be99948b 100644
--- a/test/integration-test/src/tests/log.rs
+++ b/test/integration-test/src/tests/log.rs
@@ -138,5 +138,14 @@ async fn log() {
         })
     );
 
+    assert_eq!(
+        records.next(),
+        Some(&CapturedLog {
+            body: "42 43 44 45".into(),
+            level: Level::Debug,
+            target: "log".into(),
+        })
+    );
+
     assert_eq!(records.next(), None);
 }