Skip to contentSkip to conversation

bpftool: Align output skeleton ELF code

PATCH Superseded Ian Rogers 2 participants 3 messages Oct 2, 2023 – Oct 3, 2023

Subsystems (2)

v1 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Ian Rogers

author
#0 lore raw

PATCH 1/1 bpftool: Align output skeleton ELF code

libbpf accesses the ELF data requiring at least 8 byte alignment, however, the data is generated into a C string that doesn't guarantee alignment. Fix this by assigning to an aligned char array, use sizeof on the array, less one for the \0 terminator.

---
 tools/bpf/bpftool/gen.c | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)
tools/bpf/bpftool/gen.c +9 -6
index 2883660d6b67..b8ebcee9bc56 100644
@@ -1209,7 +1209,7 @@ static int do_skeleton(int argc, char **argv)
 	codegen("\
 		\n\
 									    \n\
-			s->data = (void *)%2$s__elf_bytes(&s->data_sz);	    \n\
+			s->data = (void *)%1$s__elf_bytes(&s->data_sz);	    \n\
 									    \n\
 			obj->skeleton = s;				    \n\
 			return 0;					    \n\
@@ -1218,12 +1218,12 @@ static int do_skeleton(int argc, char **argv)
 			return err;					    \n\
 		}							    \n\
 									    \n\
-		static inline const void *%2$s__elf_bytes(size_t *sz)	    \n\
+		static inline const void *%1$s__elf_bytes(size_t *sz)	    \n\
 		{							    \n\
-			*sz = %1$d;					    \n\
-			return (const void *)\"\\			    \n\
-		"
-		, file_sz, obj_name);
+			static const char data[] __attribute__((__aligned__(8))) = \"\\\n\
+		",
+		obj_name
+	);
 
 	/* embed contents of BPF object file */
 	print_hex(obj_data, file_sz);
@@ -1231,6 +1231,9 @@ static int do_skeleton(int argc, char **argv)
 	codegen("\
 		\n\
 		\";							    \n\
+									    \n\
+			*sz = sizeof(data) - 1;				    \n\
+			return (const void *)data;			    \n\
 		}							    \n\
 									    \n\
 		#ifdef __cplusplus					    \n\
Signature · 1 line
2.42.0.582.g8ccd20d70d-goog
author
#1 lore raw
Quoted 8 lines · Ian Rogers

libbpf accesses the ELF data requiring at least 8 byte alignment, however, the data is generated into a C string that doesn't guarantee alignment. Fix this by assigning to an aligned char array, use sizeof on the array, less one for the \0 terminator.

---

Perhaps this could have a fixes tag:

Fixes d510296d331a ("bpftool: Use syscall/loader program in "prog

load" and "gen skeleton" command.")

The unaligned problem was seen in perf's offcpu code as well as bcc's libbpf_tools. I didn't see problems with map data and opts data, but inspection of the code shows they likely have the same issue. I was testing with -fsanitize=alignment and -fsanitize-undefined-trap-on-error.

Thanks,
Ian

Quoted 47 lines
 tools/bpf/bpftool/gen.c | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)
tools/bpf/bpftool/gen.c +9 -7
index 2883660d6b67..b8ebcee9bc56 100644
@@ -1209,7 +1209,7 @@ static int do_skeleton(int argc, char **argv)
        codegen("\
                \n\
                                                                            \n\
-                       s->data = (void *)%2$s__elf_bytes(&s->data_sz);     \n\
+                       s->data = (void *)%1$s__elf_bytes(&s->data_sz);     \n\
                                                                            \n\
                        obj->skeleton = s;                                  \n\
                        return 0;                                           \n\
@@ -1218,12 +1218,12 @@ static int do_skeleton(int argc, char **argv)
                        return err;                                         \n\
                }                                                           \n\
                                                                            \n\
-               static inline const void *%2$s__elf_bytes(size_t *sz)       \n\
+               static inline const void *%1$s__elf_bytes(size_t *sz)       \n\
                {                                                           \n\
-                       *sz = %1$d;                                         \n\
-                       return (const void *)\"\\                           \n\
-               "
-               , file_sz, obj_name);
+                       static const char data[] __attribute__((__aligned__(8))) = \"\\\n\
+               ",
+               obj_name
+       );
 
        /* embed contents of BPF object file */
        print_hex(obj_data, file_sz);
@@ -1231,6 +1231,9 @@ static int do_skeleton(int argc, char **argv)
        codegen("\
                \n\
                \";                                                         \n\
+                                                                           \n\
+                       *sz = sizeof(data) - 1;                             \n\
+                       return (const void *)data;                          \n\
                }                                                           \n\
                                                                            \n\
                #ifdef __cplusplus                                          \n\
--

2.42.0.582.g8ccd20d70d-goog

Reviewed-by
#2 lore raw
Quoted 8 lines · Ian Rogers
Quoted 7 lines · Ian Rogers

libbpf accesses the ELF data requiring at least 8 byte alignment, however, the data is generated into a C string that doesn't guarantee alignment. Fix this by assigning to an aligned char array, use sizeof on the array, less one for the \0 terminator.

this looks like a great catch to me!

Quoted 6 lines
Quoted 1 line

---

Perhaps this could have a fixes tag:

Fixes d510296d331a ("bpftool: Use syscall/loader program in "prog

load" and "gen skeleton" command.")

Yep, or perhaps

Fixes a6cc6b34b93e ("bpftool: Provide a helper method for accessing

skeleton's embedded ELF data")

Quoted 57 lines

The unaligned problem was seen in perf's offcpu code as well as bcc's libbpf_tools. I didn't see problems with map data and opts data, but inspection of the code shows they likely have the same issue. I was testing with -fsanitize=alignment and -fsanitize-undefined-trap-on-error.

Thanks,
Ian

Quoted 47 lines
 tools/bpf/bpftool/gen.c | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)
tools/bpf/bpftool/gen.c +9 -7
index 2883660d6b67..b8ebcee9bc56 100644
@@ -1209,7 +1209,7 @@ static int do_skeleton(int argc, char **argv)
        codegen("\
                \n\
                                                                            \n\
-                       s->data = (void *)%2$s__elf_bytes(&s->data_sz);     \n\
+                       s->data = (void *)%1$s__elf_bytes(&s->data_sz);     \n\
                                                                            \n\
                        obj->skeleton = s;                                  \n\
                        return 0;                                           \n\
@@ -1218,12 +1218,12 @@ static int do_skeleton(int argc, char **argv)
                        return err;                                         \n\
                }                                                           \n\
                                                                            \n\
-               static inline const void *%2$s__elf_bytes(size_t *sz)       \n\
+               static inline const void *%1$s__elf_bytes(size_t *sz)       \n\
                {                                                           \n\
-                       *sz = %1$d;                                         \n\
-                       return (const void *)\"\\                           \n\
-               "
-               , file_sz, obj_name);
+                       static const char data[] __attribute__((__aligned__(8))) = \"\\\n\
+               ",
+               obj_name
+       );
 
        /* embed contents of BPF object file */
        print_hex(obj_data, file_sz);
@@ -1231,6 +1231,9 @@ static int do_skeleton(int argc, char **argv)
        codegen("\
                \n\
                \";                                                         \n\
+                                                                           \n\
+                       *sz = sizeof(data) - 1;                             \n\
+                       return (const void *)data;                          \n\
                }                                                           \n\
                                                                            \n\
                #ifdef __cplusplus                                          \n\
--

2.42.0.582.g8ccd20d70d-goog