Add libbpftime.a archive when BPFTIME_BUILD_STATIC_LIB option is provided #294

hp77-creator · 2024-05-12T06:38:50Z

Description

Fixes #232
Changes taken from #271

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Run build with BPFTIME_BUILD_STATIC_LIB

Test Configuration:

Firmware version: 10151.101.3
Hardware: Macbook Air M2 chip
Toolchain: Xcode
SDK:

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
I have checked my code and corrected any misspellings

hp77-creator · 2024-05-12T06:41:36Z

@Officeyutong @yunwei37
I have added targets, I can see when running on a fedora vm that a archive file is generated with the above changes.
I am looking for comments from you two on how can I enhance this more, Shall I directly install the CLI with our archive if BPFTIME_BUILD_STATIC is ON ?
I haven't added that change.
Also on my open PR I had asked for help regarding testing the archive, I will try to do that in a separate program, looking into that now.

Officeyutong · 2024-05-12T08:00:50Z

Please add an example to demonstrate how to use the static library, such as a small program that dumps loaded programs from the shared memory. The program should use headers from bpftime, and links the static library you built. It's ok if this program was not built using CMake, since the main purpose that we release standalone static library is to make it more convenient for users who doesn't want to use CMake

hp77-creator · 2024-05-12T14:40:50Z

Okay @Officeyutong , I am working on that.

hp77-creator · 2024-05-12T16:26:28Z

I wrote one program, I only included "bpftime_shm.hpp" but I had to include libubpf.a for that, I tried to add it into our single archive but I am getting following error:

- Configuring done (0.6s)
CMake Error at CMakeLists.txt:140 (add_custom_command):
  Error evaluating generator expression:

    $<TARGET_FILE:ubpf>

  Target "ubpf" is not an executable or library.

To compile the program, I had to write the following compilation command:

g++ -o example main.cpp -I/home/fedora/codes/bpftime-hp/runtime/include/ -I/home/fedora/codes/bpftime-hp/vm/vm-core/compat/include -I/home/fedora/codes/bpftime-hp/vm/compat/include/ -L/home/fedora/.bpftime -lbpftime -lboost_system -lrt -lbpf -L/home/fedora/codes/bpftime-hp/build/vm/ubpf-vm/ubpf/lib -lubpf

I am trying to add ubpf as well but unable to, any tips?? @Officeyutong @yunwei37

Officeyutong · 2024-05-13T00:51:08Z

I wrote one program, I only included "bpftime_shm.hpp" but I had to include libubpf.a for that, I tried to add it into our single archive but I am getting following error:
- Configuring done (0.6s)
CMake Error at CMakeLists.txt:140 (add_custom_command):
  Error evaluating generator expression:

    $<TARGET_FILE:ubpf>

  Target "ubpf" is not an executable or library.
To compile the program, I had to write the following compilation command:
g++ -o example main.cpp -I/home/fedora/codes/bpftime-hp/runtime/include/ -I/home/fedora/codes/bpftime-hp/vm/vm-core/compat/include -I/home/fedora/codes/bpftime-hp/vm/compat/include/ -L/home/fedora/.bpftime -lbpftime -lboost_system -lrt -lbpf -L/home/fedora/codes/bpftime-hp/build/vm/ubpf-vm/ubpf/lib -lubpf
I am trying to add ubpf as well but unable to, any tips?? @Officeyutong @yunwei37

Because ubpf was not in our project structure. We add ubpf into bpftime through externalproject, not add_subdirectory (because add_subdirectory may lead to a series of directory conflicts).

Besides, your static library should also contain dependencies like ubpf or spdlog. So a user who wants to use bpftime won't need to fetch these libraries by himself

hp77-creator · 2024-05-13T02:39:06Z

Yea, I saw, it is being added via ExternalProject, but still unlike spdlog, I am not able to add it, I don't know why 🤔, will have to look into it.

Officeyutong · 2024-05-13T07:43:39Z

Yea, I saw, it is being added via ExternalProject, but still unlike spdlog, I am not able to add it, I don't know why 🤔, will have to look into it.

spdlog was added using add_subdirectory. You may search keyword spdlog among all cmake files to get detailed configurations

hp77-creator · 2024-05-13T16:32:35Z

I meant, I am able to add spdlog to the static archive. But I am not able to add ubpf. 😅

yunwei37 · 2024-05-13T16:40:39Z

Maybe you can try to manually build ubpf in cmake if It's used, and add it to the static library?

Officeyutong · 2024-05-14T04:23:57Z

I meant, I am able to add spdlog to the static archive. But I am not able to add ubpf. 😅

This is how bpftime links ubpf, you may link it in the same way

bpftime/vm/ubpf-vm/CMakeLists.txt

Line 18 in 307b16f

    
           target_link_libraries(bpftime_ubpf_vm PUBLIC ${UBPF_BUILD_DIR}/lib/libubpf.a bpftime_vm_compat spdlog::spdlog)

hp77-creator · 2024-05-14T05:31:40Z

sure, I will see that, meanwhile I tried to run a program with just "spdlog/spdlog.h" header and linking libbpftime.a, I am getting a lot of undefined reference for the program

/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(frida_attach_utils.cpp.o): in function `bpftime::attach::find_function_addr_by_name(char const*)':
frida_attach_utils.cpp:(.text+0x3f0): undefined reference to `gum_find_function'
/usr/bin/ld: frida_attach_utils.cpp:(.text+0x410): undefined reference to `gum_module_find_export_by_name'
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(frida_attach_utils.cpp.o): in function `bpftime::attach::get_module_base_addr(char const*)':
frida_attach_utils.cpp:(.text+0x444): undefined reference to `gum_module_load'
/usr/bin/ld: frida_attach_utils.cpp:(.text+0x454): undefined reference to `gum_module_find_base_address'

I am figuring its some error because headers are not added but even after including header with -I/home/fedora/bpftime-hp/attach/frida_uprobe_attach_impl/include
error exists, @Officeyutong @yunwei37 can you folks try at your ends as well, if possible and let me know if its giving same error for you for some program that you have
Meanwhile I will look on how we can add libubpf.a to our archive.

Officeyutong · 2024-05-14T06:51:43Z

sure, I will see that, meanwhile I tried to run a program with just "spdlog/spdlog.h" header and linking libbpftime.a, I am getting a lot of undefined reference for the program
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(frida_attach_utils.cpp.o): in function `bpftime::attach::find_function_addr_by_name(char const*)':
frida_attach_utils.cpp:(.text+0x3f0): undefined reference to `gum_find_function'
/usr/bin/ld: frida_attach_utils.cpp:(.text+0x410): undefined reference to `gum_module_find_export_by_name'
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(frida_attach_utils.cpp.o): in function `bpftime::attach::get_module_base_addr(char const*)':
frida_attach_utils.cpp:(.text+0x444): undefined reference to `gum_module_load'
/usr/bin/ld: frida_attach_utils.cpp:(.text+0x454): undefined reference to `gum_module_find_base_address'
I am figuring its some error because headers are not added but even after including header with -I/home/fedora/bpftime-hp/attach/frida_uprobe_attach_impl/include error exists, @Officeyutong @yunwei37 can you folks try at your ends as well, if possible and let me know if its giving same error for you for some program that you have Meanwhile I will look on how we can add libubpf.a to our archive.

Symbols like gum_XXX are defined in frida gum, which is a dependency of frida_uprobe_attach_impl, we link it at

bpftime/attach/frida_uprobe_attach_impl/CMakeLists.txt

Line 17 in 307b16f

    
           target_link_libraries(bpftime_frida_uprobe_attach_impl PRIVATE ${FRIDA_GUM_INSTALL_DIR}/libfrida-gum.a PUBLIC bpftime_base_attach_impl spdlog::spdlog)

yunwei37 · 2024-05-15T20:17:45Z

You also need to link the frida-gum library to libbpftime.a, which is similar to ubpf because they are not built by the project.

Is it possible to call something like bpftime_add_static_lib_component_command on a xxx.a static library?

hp77-creator · 2024-05-15T20:42:18Z

I will check that, sorry, haven't been able to implement @Officeyutong 's suggestions, I guess we can do that on a target for our function but will let you know for sure in some time, by tomorrow or day after tomorrow EOD.

hp77-creator · 2024-05-17T16:29:14Z

Tried adding both lib-ubpf and libfrida-gum and was getting following error:

 g++ -o example spdlog_exam.cpp -I/home/fedora/codes/bpftime-hp/runtime/include/ -I/home/fedora/codes/bpftime-hp/vm/vm-core/compat/include -I/home/fedora/codes/bpftime-hp/vm/compat/include/ -I/home/fedora/codes/bpftime-hp/third_party/spdlog/include -L/home/fedora/.bpftime -lbpftime -lboost_system -lrt -lbpf
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(dwarf_die_deliv.c.o): in function `dwarf_die_from_hash_signature':
/__w/frida/frida/build/fs-tmp-linux-arm64/libdwarf/../../../deps/libdwarf/libdwarf/dwarf_die_deliv.c:1825: undefined reference to `_frida_dwarf_get_cu_die_offset_given_cu_header_offset_b'
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(inflate.c.o): in function `inflate':
/__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:670: undefined reference to `_frida_crc32'
/usr/bin/ld: /__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:671: undefined reference to `_frida_crc32'
/usr/bin/ld: /__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:725: undefined reference to `_frida_crc32'
/usr/bin/ld: /__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:734: undefined reference to `_frida_crc32'
/usr/bin/ld: /__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:745: undefined reference to `_frida_crc32'
/usr/bin/ld: /home/fedora/.bpftime/libbpftime.a(inflate.c.o):/__w/frida/frida/build/fs-tmp-linux-arm64/zlib/../../../deps/zlib/inflate.c:756: more undefined references to `_frida_crc32' follow
collect2: error: ld returned 1 exit status

i don't have much experience with frida do I need to include something or link something else?

Officeyutong · 2024-05-17T18:51:19Z

_frida_crc32

Symbol _frida_crc32 is defined in crc32.c.o of libfrida-gum.a, and _frida_dwarf_get_cu_die_offset_given_cu_header_offset_b is defined in dwarf_global.c.o of libfrida-gum.a. Please check if these two object files are in your static archive.

You may use nm libfrida-gum.a to check which symbols are defined in object files of the given archive.

............
dwarf_global.c.o:
0000000000000000 t dealloc_globals_chain
0000000000000000 t _dwarf_make_global_add_to_chain
                 U _frida__dwarf_check_string_valid
0000000000000000 T _frida_dwarf_CU_dieoffset_given_die
                 U _frida_dwarf_dealloc
                 U _frida__dwarf_error
                 U _frida__dwarf_error_string
                 U _frida__dwarf_get_alloc
0000000000000000 T _frida_dwarf_get_cu_die_offset_given_cu_header_offset
0000000000000000 T _frida_dwarf_get_cu_die_offset_given_cu_header_offset_b
...........

crc32.c.o:
0000000000000000 r crc_braid_table
0000000000000000 r crc_table
0000000000000000 t crc_word
0000000000000000 T _frida_crc32
.............

hp77-creator · 2024-05-17T22:20:40Z

I checked with nm both object files are there but their nm output is different in libbpftime.a and in libfrida-gum.a

hp77-creator · 2024-05-18T01:24:40Z

I tried checking separately.
I checked nm libfrida-gum.a , I could see the same output that you pasted. But when I did ar -x libfrida-gum.a and then tried to check with nm dwarf_global.c.o, symbols were different. Is ar doing something here?

Officeyutong · 2024-05-18T05:21:59Z

I tried checking separately.

I checked nm libfrida-gum.a , I could see the same output that you pasted. But when I did ar -x libfrida-gum.a and then tried to check with nm dwarf_global.c.o, symbols were different. Is ar doing something here?

A possible reason is that there are object files in the same name among different archives. If you unpack these archives containing object files with the same name, and put the unpacked files into a folder, some object files might be overridden by others. Please check archives you used for duplicated files names, if existed, just do a rename for these object files to avoid overridden

Officeyutong · 2024-05-20T15:34:39Z

Seems there are two crc32.c.o in libfrida-gum.a, and they are different files..

hp77-creator · 2024-05-20T15:40:33Z

well, I have taken care of two different files with my latest changes, you can comment out 'remove_directory' step and see in objs there are two files created.
Also can you share the build command that you are using for cmake? @Officeyutong

hp77-creator · 2024-05-20T15:42:38Z

I was using these two:

cmake -Bbuild  -DCMAKE_BUILD_TYPE:STRING=Release -DSPDLOG_ACTIVE_LEVEL=SPDLOG_LEVEL_INFO -DBPFTIME_BUILD_STATIC_LIB=ON
cmake --build build --config Release --target install

Officeyutong · 2024-05-20T15:46:41Z

Seems you may use ar xN <N> XXX.a YYY.o to extract the N-th entry of duplicated name YYY.o

call ar t XXX.a of each archive to extract, and gets a list of files in it (duplicated named occurred multiple times)
count how many times each name occurred. You may call list(REMOVE_DUPLICATES <list>) to dedup a list, then iterate over each unique element and count how many times it occurred. This is O(n^2), but CMake doesn't provide any mapping data structure..
For each name occurred multiple times, call ar xN <I> XXX.a YYY.o (I iterates from 1 to the number of occurrance) to extract the I-th entry, then rename it to a different name, such as YYY.1.o (or other names you like). For other names, just call ar x XXX.a YYY.o
Then we should have all entries extracted. repack them into a new archive

Officeyutong · 2024-05-20T15:49:30Z

well, I have taken care of two different files with my latest changes, you can comment out 'remove_directory' step and see in objs there are two files created. Also can you share the build command that you are using for cmake? @Officeyutong

usr/bin/cmake --no-warn-unused-cli -DBPFTIME_ENABLE_LTO=NO -DBPFTIME_LLVM_JIT=NO -DBPFTIME_ENABLE_MPK=YES -DBPFTIME_ENABLE_UNIT_TESTING=YES -DBUILD_ATTACH_IMPL_EXAMPLE=YES -DENABLE_LLVM_SHARED=YES -DWASMEDGE_PLUGIN_WASM_BPF=YES -DBPFTIME_BUILD_STATIC_LIB=YES -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=TRUE -DCMAKE_C_COMPILER:FILEPATH=/usr/bin/clang-15 -DCMAKE_CXX_COMPILER:FILEPATH=/usr/bin/clang++-15 -S/root/bpftime-hp -B/root/bpftime-hp/build -G Ninja

Besides, I use CMake Tools of Visual Studio Code to handle tasks for cmake. This build command was generated by that plugin. Switches are defined by myself

hp77-creator · 2024-05-20T15:53:01Z

Seems you may use ar xN <N> XXX.a YYY.o to extract the N-th entry of duplicated name YYY.o

call ar t XXX.a of each archive to extract, and gets a list of files in it (duplicated named occurred multiple times)

count how many times each name occurred. You may call list(REMOVE_DUPLICATES <list>) to dedup a list, then iterate over each unique element and count how many times it occurred. This is O(n^2), but CMake doesn't provide any mapping data structure..

For each name occurred multiple times, call ar xN <I> XXX.a YYY.o (I iterates from 1 to the number of occurrance) to extract the I-th entry, then rename it to a different name, such as YYY.1.o (or other names you like). For other names, just call ar x XXX.a YYY.o

Then we should have all entries extracted. repack them into a new archive

is the extract_and_rename shell script still overwriting previous files?? I will try above approach then

Officeyutong · 2024-05-20T16:44:40Z

extract_and_rename

Seems you may use ar xN <N> XXX.a YYY.o to extract the N-th entry of duplicated name YYY.o

call ar t XXX.a of each archive to extract, and gets a list of files in it (duplicated named occurred multiple times)

count how many times each name occurred. You may call list(REMOVE_DUPLICATES <list>) to dedup a list, then iterate over each unique element and count how many times it occurred. This is O(n^2), but CMake doesn't provide any mapping data structure..

For each name occurred multiple times, call ar xN <I> XXX.a YYY.o (I iterates from 1 to the number of occurrance) to extract the I-th entry, then rename it to a different name, such as YYY.1.o (or other names you like). For other names, just call ar x XXX.a YYY.o

Then we should have all entries extracted. repack them into a new archive

is the extract_and_rename shell script still overwriting previous files?? I will try above approach then

extract_and_rename doesn't work. I've tried it, and it just extracted the first occurrence of a duplicated name multiple times

hp77-creator · 2024-05-20T16:51:15Z

ok, there is an issue, i might have messed up while trying to write code from my VM to actual repo, checking.

hp77-creator · 2024-05-20T17:41:47Z

With your recent suggestion the examples that I have added are working, @Officeyutong
I will now include the conditional options like for LLVM and others

hp77-creator · 2024-05-20T18:04:49Z

should we also include, libbpf in the archive, I see that it is also installed but the examples that I have added don't have that requirement. What do you suggest? @Officeyutong @yunwei37

yunwei37 · 2024-05-20T22:35:48Z

I think it would be better to include libbpf

Officeyutong · 2024-05-21T05:33:39Z

Besides, it would be better to have a Makefile to build the examples you wrote

hp77-creator · 2024-05-21T19:12:19Z

I have added the changes, please review. @Officeyutong @yunwei37

example/libbpftime_example/README.md

example/libbpftime_example/main.cpp

example/libbpftime_example/spdlog_exam.cpp

CMakeLists.txt

Signed-off-by: Himanshu Pandey <24816726+hp77-creator@users.noreply.github.com>

hp77-creator added 3 commits May 12, 2024 11:38

hp77 | Add option for BPFTIME_BUILD_STATIC_LIB

c82f4be

hp77 | Add function to archive and fix an ARCH variable issue

f072bcf

hp77 | add targets to the archiving function

4264538

pull-request-size bot added the size/M label May 12, 2024

hp77-creator mentioned this pull request May 12, 2024

Add support for static library support #271

Closed

14 tasks

hp77 | Change destination to bpftime root folder

5239a3d

hp77 | Add example program to test libbpftime.a

c6acc78

pull-request-size bot added size/L and removed size/M labels May 12, 2024

hp77-creator added 2 commits May 17, 2024 06:34

hp77 | Add lib-*.a to main file

321a37f

hp77 | fix path for libubpf

c976574

hp77 | fix script

d6d4994

hp77 | add option for llvm jit

cc0a4e5

hp77-creator added 3 commits May 22, 2024 00:15

hp77 | add libubpf to condition and add target in makefile

a23c881

hp77 | add makefile for examples

04b4a3b

hp77 | Add libbpf

a271e3b

yunwei37 reviewed May 21, 2024

View reviewed changes

example/libbpftime_example/README.md Outdated Show resolved Hide resolved

example/libbpftime_example/main.cpp Outdated Show resolved Hide resolved

example/libbpftime_example/spdlog_exam.cpp Outdated Show resolved Hide resolved

Officeyutong reviewed May 24, 2024

View reviewed changes

CMakeLists.txt Outdated Show resolved Hide resolved

hp77-creator added 4 commits May 25, 2024 12:30

Add better example and remove libtool

b263091

Fix Makefile command

db1c0dd

Signed-off-by: Himanshu Pandey <24816726+hp77-creator@users.noreply.github.com>

Fix example

551f795

Fix spdlog include

d07e7a8

hp77-creator force-pushed the feature_232_new branch from 272fb50 to d07e7a8 Compare May 25, 2024 08:05

Merge branch 'master' into feature_232_new

fbb1627

hp77-creator requested review from Officeyutong and yunwei37 May 25, 2024 08:10

yunwei37 approved these changes May 25, 2024

View reviewed changes

yunwei37 merged commit 6c60ff1 into eunomia-bpf:master May 25, 2024
70 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add libbpftime.a archive when BPFTIME_BUILD_STATIC_LIB option is provided #294

Add libbpftime.a archive when BPFTIME_BUILD_STATIC_LIB option is provided #294

hp77-creator commented May 12, 2024 •

edited

hp77-creator commented May 12, 2024

Officeyutong commented May 12, 2024

hp77-creator commented May 12, 2024

hp77-creator commented May 12, 2024

Officeyutong commented May 13, 2024

hp77-creator commented May 13, 2024

Officeyutong commented May 13, 2024

hp77-creator commented May 13, 2024

yunwei37 commented May 13, 2024

Officeyutong commented May 14, 2024

hp77-creator commented May 14, 2024

Officeyutong commented May 14, 2024 •

edited

yunwei37 commented May 15, 2024 •

edited

hp77-creator commented May 15, 2024

hp77-creator commented May 17, 2024

Officeyutong commented May 17, 2024

hp77-creator commented May 17, 2024

hp77-creator commented May 18, 2024 •

edited

Officeyutong commented May 18, 2024

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

Officeyutong commented May 20, 2024 •

edited

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

yunwei37 commented May 20, 2024

Officeyutong commented May 21, 2024

hp77-creator commented May 21, 2024

Add libbpftime.a archive when BPFTIME_BUILD_STATIC_LIB option is provided #294

Add libbpftime.a archive when BPFTIME_BUILD_STATIC_LIB option is provided #294

Conversation

hp77-creator commented May 12, 2024 • edited

Description

Type of change

How Has This Been Tested?

Checklist

hp77-creator commented May 12, 2024

Officeyutong commented May 12, 2024

hp77-creator commented May 12, 2024

hp77-creator commented May 12, 2024

Officeyutong commented May 13, 2024

hp77-creator commented May 13, 2024

Officeyutong commented May 13, 2024

hp77-creator commented May 13, 2024

yunwei37 commented May 13, 2024

Officeyutong commented May 14, 2024

hp77-creator commented May 14, 2024

Officeyutong commented May 14, 2024 • edited

yunwei37 commented May 15, 2024 • edited

hp77-creator commented May 15, 2024

hp77-creator commented May 17, 2024

Officeyutong commented May 17, 2024

hp77-creator commented May 17, 2024

hp77-creator commented May 18, 2024 • edited

Officeyutong commented May 18, 2024

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

Officeyutong commented May 20, 2024 • edited

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

Officeyutong commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

hp77-creator commented May 20, 2024

yunwei37 commented May 20, 2024

Officeyutong commented May 21, 2024

hp77-creator commented May 21, 2024

hp77-creator commented May 12, 2024 •

edited

Officeyutong commented May 14, 2024 •

edited

yunwei37 commented May 15, 2024 •

edited

hp77-creator commented May 18, 2024 •

edited

Officeyutong commented May 20, 2024 •

edited