CI

Building

Prerequisites

Steps to build

git clone https://github.com/trailofbits/btfparsecd btfparsegit submodule update --init

mkdir buildcd buildcmake .. \  -DCMAKE_BUILD_TYPE=RelWithDebInfo \  -DBTFPARSE_ENABLE_TOOLS=true \  -DBTFPARSE_ENABLE_TESTS=true

cmake \  --build. \  -j$(nproc)

sudo apt-get install linux-tools-generic

cmake \  --build. \  --targettest

Importing btfparse in your project

Examples

Tool example: dump-btf

alessandro@ubuntu2110:~/btfparse-build$ ./tools/dump-btf/dump-btf /sys/kernel/btf/vmlinux| head[1] INT'long unsigned int' size=8 bits_offset=0 nr_bits=64 encoding=(none)[2] CONST'(anon)' type_id=1[3] ARRAY'(anon)' type_id=1 index_type_id=18 nr_elems=2[4] PTR'(anon)' type_id=6[5] INT'char' size=1 bits_offset=0 nr_bits=8 encoding=(none)[6] CONST'(anon)' type_id=5[7] INT'unsigned int' size=4 bits_offset=0 nr_bits=32 encoding=(none)[8] CONST'(anon)' type_id=7[9] INT'signed char' size=1 bits_offset=0 nr_bits=8 encoding=(none)[10] TYPEDEF'__u8' type_id=11

Code example

#include<btfparse/ibtf.h>boolparseTypes() {staticconst std::vector<std::filesystem::path>kPathList{"/sys/kernel/btf/vmlinux"};auto btf_res =btfparse::IBTF::createFromPathList(kPathList);if (btf_res.failed()) {    std::cerr <<"Failed to open the BTF file:" << btf_res.takeError() <<"\n";returnfalse;  }auto btf = btf_res.takeValue();if (btf->count() ==0) {    std::cout <<"No types were found!\n";returnfalse;  }for (constauto &btf_type_map_p : btf->getAll()) {constauto &id = btf_type_map_p.first;constauto &btf_type = btf_type_map_p.second;auto type_kind =btfparse::IBTF::getBTFTypeKind(btf_type);if (type_kind != btfparse::BTFKind::Struct) {continue;    }constauto &btf_struct = std::get<btfparse::StructBTFType>(btf_type);    std::cout <<std::to_string(id) <<":";if (btf_struct.opt_name.has_value()) {      std::cout << btf_struct.opt_name.value() <<"\n";    }else {      std::cout <<"unnamed\n";    }  }returntrue;}