diff mbox series

[v1] bpftool: Align output skeleton ELF code

Message ID 20231002223219.2966816-1-irogers@google.com (mailing list archive)
State Superseded
Delegated to: BPF
Headers show
Series [v1] bpftool: Align output skeleton ELF code | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch
bpf/vmtest-bpf-VM_Test-0 success Logs for ShellCheck
bpf/vmtest-bpf-VM_Test-5 success Logs for set-matrix
bpf/vmtest-bpf-VM_Test-1 success Logs for build for aarch64 with gcc
bpf/vmtest-bpf-VM_Test-3 success Logs for build for x86_64 with gcc
bpf/vmtest-bpf-VM_Test-4 success Logs for build for x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-2 success Logs for build for s390x with gcc
bpf/vmtest-bpf-VM_Test-6 success Logs for test_maps on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-8 success Logs for test_maps on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-9 success Logs for test_maps on x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-16 success Logs for test_progs_no_alu32 on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-20 success Logs for test_progs_no_alu32_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-17 success Logs for test_progs_no_alu32 on x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-21 success Logs for test_progs_parallel on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-18 success Logs for test_progs_no_alu32_parallel on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-22 success Logs for test_progs_parallel on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-19 success Logs for test_progs_no_alu32_parallel on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-23 success Logs for test_progs_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-24 success Logs for test_verifier on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-27 success Logs for test_verifier on x86_64 with llvm-16
bpf/vmtest-bpf-VM_Test-26 success Logs for test_verifier on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-28 success Logs for veristat
bpf/vmtest-bpf-VM_Test-10 success Logs for test_progs on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-12 success Logs for test_progs on x86_64 with gcc
bpf/vmtest-bpf-VM_Test-14 success Logs for test_progs_no_alu32 on aarch64 with gcc
bpf/vmtest-bpf-VM_Test-25 success Logs for test_verifier on s390x with gcc
bpf/vmtest-bpf-VM_Test-15 success Logs for test_progs_no_alu32 on s390x with gcc
bpf/vmtest-bpf-VM_Test-11 success Logs for test_progs on s390x with gcc
bpf/vmtest-bpf-VM_Test-7 success Logs for test_maps on s390x with gcc
bpf/vmtest-bpf-PR fail PR summary
bpf/vmtest-bpf-VM_Test-13 fail Logs for test_progs on x86_64 with llvm-16

Commit Message

Ian Rogers Oct. 2, 2023, 10:32 p.m. UTC
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.

Signed-off-by: Ian Rogers <irogers@google.com>
---
 tools/bpf/bpftool/gen.c | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

Comments

Ian Rogers Oct. 3, 2023, 4:29 a.m. UTC | #1
On Mon, Oct 2, 2023 at 3:32 PM Ian Rogers <irogers@google.com> wrote:
>
> 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.
>
> Signed-off-by: Ian Rogers <irogers@google.com>
> ---

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

>  tools/bpf/bpftool/gen.c | 15 +++++++++------
>  1 file changed, 9 insertions(+), 6 deletions(-)
>
> diff --git a/tools/bpf/bpftool/gen.c b/tools/bpf/bpftool/gen.c
> index 2883660d6b67..b8ebcee9bc56 100644
> --- a/tools/bpf/bpftool/gen.c
> +++ b/tools/bpf/bpftool/gen.c
> @@ -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
>
Alan Maguire Oct. 3, 2023, 8:58 a.m. UTC | #2
On 03/10/2023 05:29, Ian Rogers wrote:
> On Mon, Oct 2, 2023 at 3:32 PM Ian Rogers <irogers@google.com> wrote:
>>
>> 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.
>>
>> Signed-off-by: Ian Rogers <irogers@google.com>

this looks like a great catch to me!

Reviewed-by: Alan Maguire <alan.maguire@oracle.com>

>> ---
> 
> 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")



> 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
> 
>>  tools/bpf/bpftool/gen.c | 15 +++++++++------
>>  1 file changed, 9 insertions(+), 6 deletions(-)
>>
>> diff --git a/tools/bpf/bpftool/gen.c b/tools/bpf/bpftool/gen.c
>> index 2883660d6b67..b8ebcee9bc56 100644
>> --- a/tools/bpf/bpftool/gen.c
>> +++ b/tools/bpf/bpftool/gen.c
>> @@ -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
>>
>
diff mbox series

Patch

diff --git a/tools/bpf/bpftool/gen.c b/tools/bpf/bpftool/gen.c
index 2883660d6b67..b8ebcee9bc56 100644
--- a/tools/bpf/bpftool/gen.c
+++ b/tools/bpf/bpftool/gen.c
@@ -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\