From d105bf230cc7efa40efcda97d032406bedae897c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20M=C3=BCller?= <deso@posteo.net>
Date: Tue, 27 Aug 2024 10:40:18 -0700
Subject: [PATCH] libbpf-cargo: Open skeleton without options by default
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

In the logic we generate for opening the skeleton, we unconditionally
work with some bpf_object_open_opts object, even if the user did not
customize anything. That's fine in principle, but it can trigger a bug
when a old system libbpf is used and which violates its forward
compatibility guarantees.
With this change we work around the issue by invoking
the bpf_object__open_skeleton() libbpf function with a NULL pointer if
SkelBuilder::open() instead of SkelBuilder::open_opts() is being used.
This is generally the common case and so we work around the underlying
libbpf bug until fixed and new releases rolled out to various
distributions.

Closes: #927

Signed-off-by: Daniel Müller <deso@posteo.net>
---
 libbpf-cargo/CHANGELOG.md   |  7 +++++++
 libbpf-cargo/src/gen/mod.rs | 35 ++++++++++++++++++++++-------------
 2 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/libbpf-cargo/CHANGELOG.md b/libbpf-cargo/CHANGELOG.md
index 385a7b8c..de5f19f9 100644
--- a/libbpf-cargo/CHANGELOG.md
+++ b/libbpf-cargo/CHANGELOG.md
@@ -1,3 +1,10 @@
+Unreleased
+----------
+- Adjusted skeleton generation code to work around `libbpf` forward
+  compatibility issue when an old system `libbpf` is being used instead
+  of the vendored copy
+
+
 0.24.3
 ------
 - Silenced possible `clippy` reported warnings in generated skeleton
diff --git a/libbpf-cargo/src/gen/mod.rs b/libbpf-cargo/src/gen/mod.rs
index 18c49e88..e54e95b2 100644
--- a/libbpf-cargo/src/gen/mod.rs
+++ b/libbpf-cargo/src/gen/mod.rs
@@ -957,25 +957,16 @@ fn gen_skel_contents(_debug: bool, raw_obj_name: &str, obj_file_path: &Path) ->
             pub obj_builder: libbpf_rs::ObjectBuilder,
         }}
 
-        impl<'obj> SkelBuilder<'obj> for {name}SkelBuilder {{
-            type Output = Open{name}Skel<'obj>;
-            fn open(
+        impl<'obj> {name}SkelBuilder {{
+            fn open_opts_impl(
                 self,
-                object: &'obj mut std::mem::MaybeUninit<libbpf_rs::OpenObject>,
-            ) -> libbpf_rs::Result<Open{name}Skel<'obj>> {{
-                let opts = unsafe {{ self.obj_builder.as_libbpf_object().as_ref() }};
-                self.open_opts(*opts, object)
-            }}
-
-            fn open_opts(
-                self,
-                open_opts: libbpf_sys::bpf_object_open_opts,
+                open_opts: *const libbpf_sys::bpf_object_open_opts,
                 object: &'obj mut std::mem::MaybeUninit<libbpf_rs::OpenObject>,
             ) -> libbpf_rs::Result<Open{name}Skel<'obj>> {{
                 let skel_config = build_skel_config()?;
                 let skel_ptr = skel_config.as_libbpf_object();
 
-                let ret = unsafe {{ libbpf_sys::bpf_object__open_skeleton(skel_ptr.as_ptr(), &open_opts) }};
+                let ret = unsafe {{ libbpf_sys::bpf_object__open_skeleton(skel_ptr.as_ptr(), open_opts) }};
                 if ret != 0 {{
                     return Err(libbpf_rs::Error::from_raw_os_error(-ret));
                 }}
@@ -1008,6 +999,24 @@ fn gen_skel_contents(_debug: bool, raw_obj_name: &str, obj_file_path: &Path) ->
                 {struct_ops_init}
                 Ok(skel)
             }}
+        }}
+
+        impl<'obj> SkelBuilder<'obj> for {name}SkelBuilder {{
+            type Output = Open{name}Skel<'obj>;
+            fn open(
+                self,
+                object: &'obj mut std::mem::MaybeUninit<libbpf_rs::OpenObject>,
+            ) -> libbpf_rs::Result<Open{name}Skel<'obj>> {{
+                self.open_opts_impl(std::ptr::null(), object)
+            }}
+
+            fn open_opts(
+                self,
+                open_opts: libbpf_sys::bpf_object_open_opts,
+                object: &'obj mut std::mem::MaybeUninit<libbpf_rs::OpenObject>,
+            ) -> libbpf_rs::Result<Open{name}Skel<'obj>> {{
+                self.open_opts_impl(&open_opts, object)
+            }}
 
             fn object_builder(&self) -> &libbpf_rs::ObjectBuilder {{
                 &self.obj_builder