.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "bpftool-btf" "8" "" ""
.SH "نام (NAME)"
bpftool-btf \- ابزاری برای بازرسی داده‌های BTF
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBbpftool\fP [\fIOPTIONS\fP] \fBbtf\fP \fICOMMAND\fP
.sp
\fIOPTIONS\fP := { { \fB\-j\fP | \fB\-\-json\fP } [{ \fB\-p\fP | \fB\-\-pretty\fP }] | { \fB\-d\fP | \fB\-\-debug\fP } | { \fB\-B\fP | \fB\-\-base\-btf\fP } }
.sp
\fICOMMANDS\fP := { \fBdump\fP | \fBhelp\fP }
.SH "دستورهای BTF (BTF COMMANDS)"
.nf
\fBbpftool\fP \fBbtf\fP { \fBshow\fP | \fBlist\fP } [\fBid\fP \fIBTF_ID\fP]
\fBbpftool\fP \fBbtf dump\fP \fIBTF_SRC\fP [\fBformat\fP \fIFORMAT\fP] [\fBroot_id\fP \fIROOT_ID\fP]
\fBbpftool\fP \fBbtf help\fP

\fIBTF_SRC\fP := { \fBid\fP \fIBTF_ID\fP | \fBprog\fP \fIPROG\fP | \fBmap\fP \fIMAP\fP [{\fBkey\fP | \fBvalue\fP | \fBkv\fP | \fBall\fP}] | \fBfile\fP \fIFILE\fP [\fBfile\fP \fIFILE\fP]... }
\fIFORMAT\fP := { \fBraw\fP | \fBc\fP [\fBunsorted\fP] }
\fIMAP\fP := { \fBid\fP \fIMAP_ID\fP | \fBpinned\fP \fIFILE\fP }
\fIPROG\fP := { \fBid\fP \fIPROG_ID\fP | \fBpinned\fP \fIFILE\fP | \fBtag\fP \fIPROG_TAG\fP | \fBname\fP \fIPROG_NAME\fP }
.fi
.sp
.SH "توضیحات (DESCRIPTION)"
.INDENT 0.0
.TP
.B bpftool btf { show | list } [id \fIBTF_ID\fP]
نمایش اطلاعات درباره اشیاء BTF بارگذاری‌شده. اگر یک شناسه BTF مشخص شده باشد، اطلاعات فقط درباره شیء BTF داده‌شده نمایش داده می‌شود، در غیر این صورت تمام اشیاء BTF که در حال حاضر روی سیستم بارگذاری شده‌اند فهرست می‌شوند.
.sp
از لینوکس 5.8 به بعد، bpftool قادر است اطلاعات مربوط به فرآیندهایی را که توصیف‌کننده‌های فایل (FD) باز به اشیاء BTF دارند شناسایی کند. روی چنین هسته‌هایی، bpftool به طور خودکار این اطلاعات را نیز صادر می‌کند.
.TP
.B bpftool btf dump \fIBTF_SRC\fP [format \fIFORMAT\fP] [root_id \fIROOT_ID\fP]
تخلیه (Dump) ورودی‌های BTF از یک \fIBTF_SRC\fP مشخص‌شده.
.sp
هنگامی که \fBid\fP مشخص شود، شیء BTF با آن شناسه بارگذاری شده و تمام انواع BTF آن صادر می‌شوند.
.sp
هنگامی که \fBmap\fP ارائه شود، انتظار می‌رود که نقشه دارای شیء BTF مرتبط با انواع BTF توصیف‌کننده کلید و مقدار باشد. امکان انتخاب این وجود دارد که تنها نوع/انواع BTF مرتبط با کلید (\fBkey\fP)، مقدار (\fBvalue\fP)، هم کلید و هم مقدار (\fBkv\fP)، یا تمام انواع BTF موجود در شیء BTF مرتبط (\fBall\fP) تخلیه شوند. در صورت عدم تعیین، \fBkv\fP در نظر گرفته می‌شود.
.sp
هنگامی که \fBprog\fP ارائه شود، انتظار می‌رود که برنامه دارای شیء BTF مرتبط به همراه انواع BTF باشد.
.sp
هنگام مشخص کردن \fIFILE\fP، یک فایل ELF یا یک فایل خام BTF (مانند مسیر \fB/sys/kernel/btf/\fP) مورد انتظار است. می‌توان چندین آرگومان \fBfile\fP را برای ادغام BTF از چند ماژول هسته در یک خروجی واحد مشخص کرد. هنگامی که از مسیرهای sysfs استفاده می‌شود، BTF مربوط به vmlinux به طور خودکار به عنوان پایه بارگذاری می‌شود؛ اگر خود vmlinux در فهرست فایل‌ها ظاهر شود، نادیده گرفته می‌شود. همچنین می‌توان یک BTF پایه را با \fB\-B\fP به‌طور صریح مشخص کرد.
.sp
گزینه \fBformat\fP می‌تواند برای نادیده گرفتن قالب خروجی پیش‌فرض (raw) استفاده شود. قالب‌های خروجی خام (\fBraw\fP) یا نحو زبان C (\fBc\fP) پشتیبانی می‌شوند. با قالب‌بندی به سبک C، خروجی به صورت پیش‌فرض مرتب می‌شود. از گزینه \fBunsorted\fP برای جلوگیری از مرتب‌سازی خروجی استفاده کنید.
.sp
گزینه \fBroot_id\fP می‌تواند برای فیلتر کردن خروجی dump به یک نوع واحد و تمام انواع وابسته به آن استفاده شود. این گزینه نمی‌تواند با هیچ نوع فیلتر دیگری (مانند آرگومان‌های \(dqkey\(dq، \(dqvalue\(dq یا \(dqkv\(dq هنگام تخلیه BTF برای یک نقشه) استفاده شود. می‌توان آن را چندین بار برای تخلیه چندین نوع مشخص کرد.
.TP
.B bpftool btf help
چاپ پیام راهنمای کوتاه.
.UNINDENT
.SH "گزینه‌ها (OPTIONS)"
.INDENT 0.0
.TP
.B  \-h\fP,\fB  \-\-help
چاپ پیام راهنمای کوتاه (مشابه \fBbpftool help\fP).
.TP
.B  \-V\fP,\fB  \-\-version
چاپ شماره نسخه bpftool (مشابه \fBbpftool version\fP)، شماره نسخه libbpf مورد استفاده، و ویژگی‌های اختیاری که هنگام کامپایل bpftool گنجانده شده‌اند. ویژگی‌های اختیاری شامل پیوند با LLVM یا libbfd برای ارائه دیس‌اسمبلر برنامه‌های JIT شده (\fBbpftool prog dump jited\fP) و استفاده از اسکلت‌های BPF (برخی ویژگی‌ها مانند \fBbpftool prog profile\fP یا نمایش pidهای مرتبط با اشیاء BPF ممکن است به آن متکی باشند) است.
.TP
.B  \-j\fP,\fB  \-\-json
تولید خروجی JSON. برای دستوراتی که نمی‌توانند JSON تولید کنند، این گزینه هیچ تاثیری ندارد.
.TP
.B  \-p\fP,\fB  \-\-pretty
تولید خروجی JSON خوانا برای انسان. متضمن گزینه \fB\-j\fP است.
.TP
.B  \-d\fP,\fB  \-\-debug
چاپ تمام لاگ‌های در دسترس، حتی اطلاعات در سطح اشکال‌زدایی (debug). این شامل لاگ‌های libbpf و همچنین اعتبارسنج (verifier) هنگام تلاش برای بارگذاری برنامه‌ها می‌شود.
.UNINDENT
.INDENT 0.0
.TP
.B \-B, \-\-base\-btf \fIFILE\fP
ارسال یک شیء BTF پایه. اشیاء BTF پایه معمولاً با اشیاء BTF برای ماژول‌های هسته استفاده می‌شوند. برای جلوگیری از تکرار تمام نمادهای هسته مورد نیاز ماژول‌ها، اشیاء BTF برای ماژول‌ها به صورت \(dqsplit\(dq (تقسیم‌شده) هستند؛ آن‌ها به صورت افزایشی بر روی شیء BTF هسته (vmlinux) ساخته می‌شوند. بنابراین مرجع BTF پایه معمولاً باید به BTF هسته اشاره کند.
.sp
هنگامی که شیء BTF اصلی برای پردازش (به عنوان مثال، BTF ماژول برای تخلیه) به عنوان یک \fIFILE\fP ارسال شود، bpftool تلاش می‌کند مسیر شیء پایه را به صورت خودکار شناسایی کند و ارسال این گزینه اختیاری است. هنگامی که شیء BTF اصلی از طریق دیگر شناسه‌ها (handles) ارسال شود، این گزینه ضروری می‌گردد.
.UNINDENT
.SH "مثال‌ها (EXAMPLES)"
.sp
\fB# bpftool btf dump id 1226\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[1] PTR \(aq(anon)\(aq type_id=2
[2] STRUCT \(aqdummy_tracepoint_args\(aq size=16 vlen=2
        \(aqpad\(aq type_id=3 bits_offset=0
        \(aqsock\(aq type_id=4 bits_offset=64
[3] INT \(aqlong long unsigned int\(aq size=8 bits_offset=0 nr_bits=64 encoding=(none)
[4] PTR \(aq(anon)\(aq type_id=5
[5] FWD \(aqsock\(aq fwd_kind=union
.EE
.UNINDENT
.UNINDENT
.sp
این یک مثال از خروجی پیش‌فرض برای تمام انواع BTF پشتیبانی‌شده را ارائه می‌دهد.
.sp
\fB$ cat prog.c\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
struct fwd_struct;

enum my_enum {
        VAL1 = 3,
        VAL2 = 7,
};

typedef struct my_struct my_struct_t;

struct my_struct {
        const unsigned int const_int_field;
        int bitfield_field: 4;
        char arr_field[16];
        const struct fwd_struct *restrict fwd_field;
        enum my_enum enum_field;
        volatile my_struct_t *typedef_ptr_field;
};

union my_union {
        int a;
        struct my_struct b;
};

struct my_struct struct_global_var __attribute__((section(\(dqdata_sec\(dq))) = {
        .bitfield_field = 3,
        .enum_field = VAL1,
};
int global_var __attribute__((section(\(dqdata_sec\(dq))) = 7;

__attribute__((noinline))
int my_func(union my_union *arg1, int arg2)
{
        static int static_var __attribute__((section(\(dqdata_sec\(dq))) = 123;
        static_var++;
        return static_var;
}
.EE
.UNINDENT
.UNINDENT
.sp
\fB$ bpftool btf dump file prog.o\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[1] PTR \(aq(anon)\(aq type_id=2
[2] UNION \(aqmy_union\(aq size=48 vlen=2
        \(aqa\(aq type_id=3 bits_offset=0
        \(aqb\(aq type_id=4 bits_offset=0
[3] INT \(aqint\(aq size=4 bits_offset=0 nr_bits=32 encoding=SIGNED
[4] STRUCT \(aqmy_struct\(aq size=48 vlen=6
        \(aqconst_int_field\(aq type_id=5 bits_offset=0
        \(aqbitfield_field\(aq type_id=3 bits_offset=32 bitfield_size=4
        \(aqarr_field\(aq type_id=8 bits_offset=40
        \(aqfwd_field\(aq type_id=10 bits_offset=192
        \(aqenum_field\(aq type_id=14 bits_offset=256
        \(aqtypedef_ptr_field\(aq type_id=15 bits_offset=320
[5] CONST \(aq(anon)\(aq type_id=6
[6] INT \(aqunsigned int\(aq size=4 bits_offset=0 nr_bits=32 encoding=(none)
[7] INT \(aqchar\(aq size=1 bits_offset=0 nr_bits=8 encoding=SIGNED
[8] ARRAY \(aq(anon)\(aq type_id=7 index_type_id=9 nr_elems=16
[9] INT \(aq__ARRAY_SIZE_TYPE__\(aq size=4 bits_offset=0 nr_bits=32 encoding=(none)
[10] RESTRICT \(aq(anon)\(aq type_id=11
[11] PTR \(aq(anon)\(aq type_id=12
[12] CONST \(aq(anon)\(aq type_id=13
[13] FWD \(aqfwd_struct\(aq fwd_kind=union
[14] ENUM \(aqmy_enum\(aq size=4 vlen=2
        \(aqVAL1\(aq val=3
        \(aqVAL2\(aq val=7
[15] PTR \(aq(anon)\(aq type_id=16
[16] VOLATILE \(aq(anon)\(aq type_id=17
[17] TYPEDEF \(aqmy_struct_t\(aq type_id=4
[18] FUNC_PROTO \(aq(anon)\(aq ret_type_id=3 vlen=2
        \(aqarg1\(aq type_id=1
        \(aqarg2\(aq type_id=3
[19] FUNC \(aqmy_func\(aq type_id=18
[20] VAR \(aqstruct_global_var\(aq type_id=4, linkage=global\-alloc
[21] VAR \(aqglobal_var\(aq type_id=3, linkage=global\-alloc
[22] VAR \(aqmy_func.static_var\(aq type_id=3, linkage=static
[23] DATASEC \(aqdata_sec\(aq size=0 vlen=3
        type_id=20 offset=0 size=48
        type_id=21 offset=0 size=4
        type_id=22 offset=52 size=4
.EE
.UNINDENT
.UNINDENT
.sp
دستورات زیر به ترتیب انواع BTF مرتبط با کلید، مقدار، هم کلید و هم مقدار، و تمام انواع BTF نقشه مشخص‌شده را چاپ می‌کنند. به طور پیش‌فرض، انواع هم کلید و هم مقدار چاپ خواهند شد.
.sp
\fB# bpftool btf dump map id 123 key\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[39] TYPEDEF \(aqu32\(aq type_id=37
.EE
.UNINDENT
.UNINDENT
.sp
\fB# bpftool btf dump map id 123 value\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[86] PTR \(aq(anon)\(aq type_id=87
.EE
.UNINDENT
.UNINDENT
.sp
\fB# bpftool btf dump map id 123 kv\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[39] TYPEDEF \(aqu32\(aq type_id=37
[86] PTR \(aq(anon)\(aq type_id=87
.EE
.UNINDENT
.UNINDENT
.sp
\fB# bpftool btf dump map id 123 all\fP
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[1] PTR \(aq(anon)\(aq type_id=0
\&.
\&.
\&.
[2866] ARRAY \(aq(anon)\(aq type_id=52 index_type_id=51 nr_elems=4
.EE
.UNINDENT
.UNINDENT
.sp
تمام روش‌های استاندارد برای تعیین نقشه یا برنامه پشتیبانی می‌شوند:
.sp
\fB# bpftool btf dump map id 123\fP
.sp
\fB# bpftool btf dump map pinned /sys/fs/bpf/map_name\fP
.sp
\fB# bpftool btf dump prog id 456\fP
.sp
\fB# bpftool btf dump prog tag b88e0a09b1d9759d\fP
.sp
\fB# bpftool btf dump prog pinned /sys/fs/bpf/prog_name\fP
.nf

\fB# bpftool btf dump file /sys/kernel/btf/i2c_smbus\fP
(یا)
\fB# I2C_SMBUS_ID=$(bpftool btf show \-p | jq \(aq.[] | select(.name==\(dqi2c_smbus\(dq).id\(aq)\fP
\fB# bpftool btf dump id ${I2C_SMBUS_ID} \-B /sys/kernel/btf/vmlinux\fP
.fi
.sp
.INDENT 0.0
.INDENT 3.5
.sp
.EX
[104848] STRUCT \(aqi2c_smbus_alert\(aq size=40 vlen=2
        \(aqalert\(aq type_id=393 bits_offset=0
        \(aqara\(aq type_id=56050 bits_offset=256
[104849] STRUCT \(aqalert_data\(aq size=12 vlen=3
        \(aqaddr\(aq type_id=16 bits_offset=0
        \(aqtype\(aq type_id=56053 bits_offset=32
        \(aqdata\(aq type_id=7 bits_offset=64
[104850] PTR \(aq(anon)\(aq type_id=104848
[104851] PTR \(aq(anon)\(aq type_id=104849
[104852] FUNC \(aqi2c_register_spd\(aq type_id=84745 linkage=static
[104853] FUNC \(aqsmbalert_driver_init\(aq type_id=1213 linkage=static
[104854] FUNC_PROTO \(aq(anon)\(aq ret_type_id=18 vlen=1
        \(aqara\(aq type_id=56050
[104855] FUNC \(aqi2c_handle_smbus_alert\(aq type_id=104854 linkage=static
[104856] FUNC \(aqsmbalert_remove\(aq type_id=104854 linkage=static
[104857] FUNC_PROTO \(aq(anon)\(aq ret_type_id=18 vlen=2
        \(aqara\(aq type_id=56050
        \(aqid\(aq type_id=56056
[104858] FUNC \(aqsmbalert_probe\(aq type_id=104857 linkage=static
[104859] FUNC \(aqsmbalert_work\(aq type_id=9695 linkage=static
[104860] FUNC \(aqsmbus_alert\(aq type_id=71367 linkage=static
[104861] FUNC \(aqsmbus_do_alert\(aq type_id=84827 linkage=static
.EE
.UNINDENT
.UNINDENT
.SH "همچنین ببینید (SEE ALSO)"
.sp
\fBbpf\fP(2),
\fBbpf\-helpers\fP(7),
\fBbpftool\fP(8),
\fBbpftool\-cgroup\fP(8),
\fBbpftool\-feature\fP(8),
\fBbpftool\-gen\fP(8),
\fBbpftool\-iter\fP(8),
\fBbpftool\-link\fP(8),
\fBbpftool\-map\fP(8),
\fBbpftool\-net\fP(8),
\fBbpftool\-perf\fP(8),
\fBbpftool\-prog\fP(8),
\fBbpftool\-struct_ops\fP(8),
\fBbpftool\-token\fP(8)
.\" End of generated man page.