Loading...
1// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2/* Copyright (C) 2018 Netronome Systems, Inc. */
3
4#define _GNU_SOURCE
5#include <stdarg.h>
6#include <stdio.h>
7#include <stdlib.h>
8#include <string.h>
9#include <sys/types.h>
10#include <bpf/libbpf.h>
11
12#include "disasm.h"
13#include "json_writer.h"
14#include "main.h"
15#include "xlated_dumper.h"
16
17static int kernel_syms_cmp(const void *sym_a, const void *sym_b)
18{
19 return ((struct kernel_sym *)sym_a)->address -
20 ((struct kernel_sym *)sym_b)->address;
21}
22
23void kernel_syms_load(struct dump_data *dd)
24{
25 struct kernel_sym *sym;
26 char buff[256];
27 void *tmp, *address;
28 FILE *fp;
29
30 fp = fopen("/proc/kallsyms", "r");
31 if (!fp)
32 return;
33
34 while (fgets(buff, sizeof(buff), fp)) {
35 tmp = reallocarray(dd->sym_mapping, dd->sym_count + 1,
36 sizeof(*dd->sym_mapping));
37 if (!tmp) {
38out:
39 free(dd->sym_mapping);
40 dd->sym_mapping = NULL;
41 fclose(fp);
42 return;
43 }
44 dd->sym_mapping = tmp;
45 sym = &dd->sym_mapping[dd->sym_count];
46 if (sscanf(buff, "%p %*c %s", &address, sym->name) != 2)
47 continue;
48 sym->address = (unsigned long)address;
49 if (!strcmp(sym->name, "__bpf_call_base")) {
50 dd->address_call_base = sym->address;
51 /* sysctl kernel.kptr_restrict was set */
52 if (!sym->address)
53 goto out;
54 }
55 if (sym->address)
56 dd->sym_count++;
57 }
58
59 fclose(fp);
60
61 qsort(dd->sym_mapping, dd->sym_count,
62 sizeof(*dd->sym_mapping), kernel_syms_cmp);
63}
64
65void kernel_syms_destroy(struct dump_data *dd)
66{
67 free(dd->sym_mapping);
68}
69
70struct kernel_sym *kernel_syms_search(struct dump_data *dd,
71 unsigned long key)
72{
73 struct kernel_sym sym = {
74 .address = key,
75 };
76
77 return dd->sym_mapping ?
78 bsearch(&sym, dd->sym_mapping, dd->sym_count,
79 sizeof(*dd->sym_mapping), kernel_syms_cmp) : NULL;
80}
81
82static void __printf(2, 3) print_insn(void *private_data, const char *fmt, ...)
83{
84 va_list args;
85
86 va_start(args, fmt);
87 vprintf(fmt, args);
88 va_end(args);
89}
90
91static void __printf(2, 3)
92print_insn_for_graph(void *private_data, const char *fmt, ...)
93{
94 char buf[64], *p;
95 va_list args;
96
97 va_start(args, fmt);
98 vsnprintf(buf, sizeof(buf), fmt, args);
99 va_end(args);
100
101 p = buf;
102 while (*p != '\0') {
103 if (*p == '\n') {
104 memmove(p + 3, p, strlen(buf) + 1 - (p - buf));
105 /* Align each instruction dump row left. */
106 *p++ = '\\';
107 *p++ = 'l';
108 /* Output multiline concatenation. */
109 *p++ = '\\';
110 } else if (*p == '<' || *p == '>' || *p == '|' || *p == '&') {
111 memmove(p + 1, p, strlen(buf) + 1 - (p - buf));
112 /* Escape special character. */
113 *p++ = '\\';
114 }
115
116 p++;
117 }
118
119 printf("%s", buf);
120}
121
122static void __printf(2, 3)
123print_insn_json(void *private_data, const char *fmt, ...)
124{
125 unsigned int l = strlen(fmt);
126 char chomped_fmt[l];
127 va_list args;
128
129 va_start(args, fmt);
130 if (l > 0) {
131 strncpy(chomped_fmt, fmt, l - 1);
132 chomped_fmt[l - 1] = '\0';
133 }
134 jsonw_vprintf_enquote(json_wtr, chomped_fmt, args);
135 va_end(args);
136}
137
138static const char *print_call_pcrel(struct dump_data *dd,
139 struct kernel_sym *sym,
140 unsigned long address,
141 const struct bpf_insn *insn)
142{
143 if (!dd->nr_jited_ksyms)
144 /* Do not show address for interpreted programs */
145 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
146 "%+d", insn->off);
147 else if (sym)
148 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
149 "%+d#%s", insn->off, sym->name);
150 else
151 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
152 "%+d#0x%lx", insn->off, address);
153 return dd->scratch_buff;
154}
155
156static const char *print_call_helper(struct dump_data *dd,
157 struct kernel_sym *sym,
158 unsigned long address)
159{
160 if (sym)
161 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
162 "%s", sym->name);
163 else
164 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
165 "0x%lx", address);
166 return dd->scratch_buff;
167}
168
169static const char *print_call(void *private_data,
170 const struct bpf_insn *insn)
171{
172 struct dump_data *dd = private_data;
173 unsigned long address = dd->address_call_base + insn->imm;
174 struct kernel_sym *sym;
175
176 if (insn->src_reg == BPF_PSEUDO_CALL &&
177 (__u32) insn->imm < dd->nr_jited_ksyms && dd->jited_ksyms)
178 address = dd->jited_ksyms[insn->imm];
179
180 sym = kernel_syms_search(dd, address);
181 if (insn->src_reg == BPF_PSEUDO_CALL)
182 return print_call_pcrel(dd, sym, address, insn);
183 else
184 return print_call_helper(dd, sym, address);
185}
186
187static const char *print_imm(void *private_data,
188 const struct bpf_insn *insn,
189 __u64 full_imm)
190{
191 struct dump_data *dd = private_data;
192
193 if (insn->src_reg == BPF_PSEUDO_MAP_FD)
194 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
195 "map[id:%u]", insn->imm);
196 else if (insn->src_reg == BPF_PSEUDO_MAP_VALUE)
197 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
198 "map[id:%u][0]+%u", insn->imm, (insn + 1)->imm);
199 else if (insn->src_reg == BPF_PSEUDO_MAP_IDX_VALUE)
200 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
201 "map[idx:%u]+%u", insn->imm, (insn + 1)->imm);
202 else if (insn->src_reg == BPF_PSEUDO_FUNC)
203 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
204 "subprog[%+d]", insn->imm);
205 else
206 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
207 "0x%llx", (unsigned long long)full_imm);
208 return dd->scratch_buff;
209}
210
211void dump_xlated_json(struct dump_data *dd, void *buf, unsigned int len,
212 bool opcodes, bool linum)
213{
214 const struct bpf_prog_linfo *prog_linfo = dd->prog_linfo;
215 const struct bpf_insn_cbs cbs = {
216 .cb_print = print_insn_json,
217 .cb_call = print_call,
218 .cb_imm = print_imm,
219 .private_data = dd,
220 };
221 struct bpf_func_info *record;
222 struct bpf_insn *insn = buf;
223 struct btf *btf = dd->btf;
224 bool double_insn = false;
225 unsigned int nr_skip = 0;
226 char func_sig[1024];
227 unsigned int i;
228
229 jsonw_start_array(json_wtr);
230 record = dd->func_info;
231 for (i = 0; i < len / sizeof(*insn); i++) {
232 if (double_insn) {
233 double_insn = false;
234 continue;
235 }
236 double_insn = insn[i].code == (BPF_LD | BPF_IMM | BPF_DW);
237
238 jsonw_start_object(json_wtr);
239
240 if (btf && record) {
241 if (record->insn_off == i) {
242 btf_dumper_type_only(btf, record->type_id,
243 func_sig,
244 sizeof(func_sig));
245 if (func_sig[0] != '\0') {
246 jsonw_name(json_wtr, "proto");
247 jsonw_string(json_wtr, func_sig);
248 }
249 record = (void *)record + dd->finfo_rec_size;
250 }
251 }
252
253 if (prog_linfo) {
254 const struct bpf_line_info *linfo;
255
256 linfo = bpf_prog_linfo__lfind(prog_linfo, i, nr_skip);
257 if (linfo) {
258 btf_dump_linfo_json(btf, linfo, linum);
259 nr_skip++;
260 }
261 }
262
263 jsonw_name(json_wtr, "disasm");
264 print_bpf_insn(&cbs, insn + i, true);
265
266 if (opcodes) {
267 jsonw_name(json_wtr, "opcodes");
268 jsonw_start_object(json_wtr);
269
270 jsonw_name(json_wtr, "code");
271 jsonw_printf(json_wtr, "\"0x%02hhx\"", insn[i].code);
272
273 jsonw_name(json_wtr, "src_reg");
274 jsonw_printf(json_wtr, "\"0x%hhx\"", insn[i].src_reg);
275
276 jsonw_name(json_wtr, "dst_reg");
277 jsonw_printf(json_wtr, "\"0x%hhx\"", insn[i].dst_reg);
278
279 jsonw_name(json_wtr, "off");
280 print_hex_data_json((uint8_t *)(&insn[i].off), 2);
281
282 jsonw_name(json_wtr, "imm");
283 if (double_insn && i < len - 1)
284 print_hex_data_json((uint8_t *)(&insn[i].imm),
285 12);
286 else
287 print_hex_data_json((uint8_t *)(&insn[i].imm),
288 4);
289 jsonw_end_object(json_wtr);
290 }
291 jsonw_end_object(json_wtr);
292 }
293 jsonw_end_array(json_wtr);
294}
295
296void dump_xlated_plain(struct dump_data *dd, void *buf, unsigned int len,
297 bool opcodes, bool linum)
298{
299 const struct bpf_prog_linfo *prog_linfo = dd->prog_linfo;
300 const struct bpf_insn_cbs cbs = {
301 .cb_print = print_insn,
302 .cb_call = print_call,
303 .cb_imm = print_imm,
304 .private_data = dd,
305 };
306 struct bpf_func_info *record;
307 struct bpf_insn *insn = buf;
308 struct btf *btf = dd->btf;
309 unsigned int nr_skip = 0;
310 bool double_insn = false;
311 char func_sig[1024];
312 unsigned int i;
313
314 record = dd->func_info;
315 for (i = 0; i < len / sizeof(*insn); i++) {
316 if (double_insn) {
317 double_insn = false;
318 continue;
319 }
320
321 if (btf && record) {
322 if (record->insn_off == i) {
323 btf_dumper_type_only(btf, record->type_id,
324 func_sig,
325 sizeof(func_sig));
326 if (func_sig[0] != '\0')
327 printf("%s:\n", func_sig);
328 record = (void *)record + dd->finfo_rec_size;
329 }
330 }
331
332 if (prog_linfo) {
333 const struct bpf_line_info *linfo;
334
335 linfo = bpf_prog_linfo__lfind(prog_linfo, i, nr_skip);
336 if (linfo) {
337 btf_dump_linfo_plain(btf, linfo, "; ",
338 linum);
339 nr_skip++;
340 }
341 }
342
343 double_insn = insn[i].code == (BPF_LD | BPF_IMM | BPF_DW);
344
345 printf("% 4d: ", i);
346 print_bpf_insn(&cbs, insn + i, true);
347
348 if (opcodes) {
349 printf(" ");
350 fprint_hex(stdout, insn + i, 8, " ");
351 if (double_insn && i < len - 1) {
352 printf(" ");
353 fprint_hex(stdout, insn + i + 1, 8, " ");
354 }
355 printf("\n");
356 }
357 }
358}
359
360void dump_xlated_for_graph(struct dump_data *dd, void *buf_start, void *buf_end,
361 unsigned int start_idx)
362{
363 const struct bpf_insn_cbs cbs = {
364 .cb_print = print_insn_for_graph,
365 .cb_call = print_call,
366 .cb_imm = print_imm,
367 .private_data = dd,
368 };
369 struct bpf_insn *insn_start = buf_start;
370 struct bpf_insn *insn_end = buf_end;
371 struct bpf_insn *cur = insn_start;
372
373 for (; cur <= insn_end; cur++) {
374 printf("% 4d: ", (int)(cur - insn_start + start_idx));
375 print_bpf_insn(&cbs, cur, true);
376 if (cur != insn_end)
377 printf(" | ");
378 }
379}
1// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2/*
3 * Copyright (C) 2018 Netronome Systems, Inc.
4 *
5 * This software is dual licensed under the GNU General License Version 2,
6 * June 1991 as shown in the file COPYING in the top-level directory of this
7 * source tree or the BSD 2-Clause License provided below. You have the
8 * option to license this software under the complete terms of either license.
9 *
10 * The BSD 2-Clause License:
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * 1. Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
18 * disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
36 */
37
38#include <stdarg.h>
39#include <stdio.h>
40#include <stdlib.h>
41#include <string.h>
42#include <sys/types.h>
43
44#include "disasm.h"
45#include "json_writer.h"
46#include "main.h"
47#include "xlated_dumper.h"
48
49static int kernel_syms_cmp(const void *sym_a, const void *sym_b)
50{
51 return ((struct kernel_sym *)sym_a)->address -
52 ((struct kernel_sym *)sym_b)->address;
53}
54
55void kernel_syms_load(struct dump_data *dd)
56{
57 struct kernel_sym *sym;
58 char buff[256];
59 void *tmp, *address;
60 FILE *fp;
61
62 fp = fopen("/proc/kallsyms", "r");
63 if (!fp)
64 return;
65
66 while (!feof(fp)) {
67 if (!fgets(buff, sizeof(buff), fp))
68 break;
69 tmp = realloc(dd->sym_mapping,
70 (dd->sym_count + 1) *
71 sizeof(*dd->sym_mapping));
72 if (!tmp) {
73out:
74 free(dd->sym_mapping);
75 dd->sym_mapping = NULL;
76 fclose(fp);
77 return;
78 }
79 dd->sym_mapping = tmp;
80 sym = &dd->sym_mapping[dd->sym_count];
81 if (sscanf(buff, "%p %*c %s", &address, sym->name) != 2)
82 continue;
83 sym->address = (unsigned long)address;
84 if (!strcmp(sym->name, "__bpf_call_base")) {
85 dd->address_call_base = sym->address;
86 /* sysctl kernel.kptr_restrict was set */
87 if (!sym->address)
88 goto out;
89 }
90 if (sym->address)
91 dd->sym_count++;
92 }
93
94 fclose(fp);
95
96 qsort(dd->sym_mapping, dd->sym_count,
97 sizeof(*dd->sym_mapping), kernel_syms_cmp);
98}
99
100void kernel_syms_destroy(struct dump_data *dd)
101{
102 free(dd->sym_mapping);
103}
104
105static struct kernel_sym *kernel_syms_search(struct dump_data *dd,
106 unsigned long key)
107{
108 struct kernel_sym sym = {
109 .address = key,
110 };
111
112 return dd->sym_mapping ?
113 bsearch(&sym, dd->sym_mapping, dd->sym_count,
114 sizeof(*dd->sym_mapping), kernel_syms_cmp) : NULL;
115}
116
117static void print_insn(void *private_data, const char *fmt, ...)
118{
119 va_list args;
120
121 va_start(args, fmt);
122 vprintf(fmt, args);
123 va_end(args);
124}
125
126static void
127print_insn_for_graph(void *private_data, const char *fmt, ...)
128{
129 char buf[64], *p;
130 va_list args;
131
132 va_start(args, fmt);
133 vsnprintf(buf, sizeof(buf), fmt, args);
134 va_end(args);
135
136 p = buf;
137 while (*p != '\0') {
138 if (*p == '\n') {
139 memmove(p + 3, p, strlen(buf) + 1 - (p - buf));
140 /* Align each instruction dump row left. */
141 *p++ = '\\';
142 *p++ = 'l';
143 /* Output multiline concatenation. */
144 *p++ = '\\';
145 } else if (*p == '<' || *p == '>' || *p == '|' || *p == '&') {
146 memmove(p + 1, p, strlen(buf) + 1 - (p - buf));
147 /* Escape special character. */
148 *p++ = '\\';
149 }
150
151 p++;
152 }
153
154 printf("%s", buf);
155}
156
157static void print_insn_json(void *private_data, const char *fmt, ...)
158{
159 unsigned int l = strlen(fmt);
160 char chomped_fmt[l];
161 va_list args;
162
163 va_start(args, fmt);
164 if (l > 0) {
165 strncpy(chomped_fmt, fmt, l - 1);
166 chomped_fmt[l - 1] = '\0';
167 }
168 jsonw_vprintf_enquote(json_wtr, chomped_fmt, args);
169 va_end(args);
170}
171
172static const char *print_call_pcrel(struct dump_data *dd,
173 struct kernel_sym *sym,
174 unsigned long address,
175 const struct bpf_insn *insn)
176{
177 if (sym)
178 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
179 "%+d#%s", insn->off, sym->name);
180 else
181 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
182 "%+d#0x%lx", insn->off, address);
183 return dd->scratch_buff;
184}
185
186static const char *print_call_helper(struct dump_data *dd,
187 struct kernel_sym *sym,
188 unsigned long address)
189{
190 if (sym)
191 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
192 "%s", sym->name);
193 else
194 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
195 "0x%lx", address);
196 return dd->scratch_buff;
197}
198
199static const char *print_call(void *private_data,
200 const struct bpf_insn *insn)
201{
202 struct dump_data *dd = private_data;
203 unsigned long address = dd->address_call_base + insn->imm;
204 struct kernel_sym *sym;
205
206 sym = kernel_syms_search(dd, address);
207 if (insn->src_reg == BPF_PSEUDO_CALL)
208 return print_call_pcrel(dd, sym, address, insn);
209 else
210 return print_call_helper(dd, sym, address);
211}
212
213static const char *print_imm(void *private_data,
214 const struct bpf_insn *insn,
215 __u64 full_imm)
216{
217 struct dump_data *dd = private_data;
218
219 if (insn->src_reg == BPF_PSEUDO_MAP_FD)
220 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
221 "map[id:%u]", insn->imm);
222 else
223 snprintf(dd->scratch_buff, sizeof(dd->scratch_buff),
224 "0x%llx", (unsigned long long)full_imm);
225 return dd->scratch_buff;
226}
227
228void dump_xlated_json(struct dump_data *dd, void *buf, unsigned int len,
229 bool opcodes)
230{
231 const struct bpf_insn_cbs cbs = {
232 .cb_print = print_insn_json,
233 .cb_call = print_call,
234 .cb_imm = print_imm,
235 .private_data = dd,
236 };
237 struct bpf_insn *insn = buf;
238 bool double_insn = false;
239 unsigned int i;
240
241 jsonw_start_array(json_wtr);
242 for (i = 0; i < len / sizeof(*insn); i++) {
243 if (double_insn) {
244 double_insn = false;
245 continue;
246 }
247 double_insn = insn[i].code == (BPF_LD | BPF_IMM | BPF_DW);
248
249 jsonw_start_object(json_wtr);
250 jsonw_name(json_wtr, "disasm");
251 print_bpf_insn(&cbs, insn + i, true);
252
253 if (opcodes) {
254 jsonw_name(json_wtr, "opcodes");
255 jsonw_start_object(json_wtr);
256
257 jsonw_name(json_wtr, "code");
258 jsonw_printf(json_wtr, "\"0x%02hhx\"", insn[i].code);
259
260 jsonw_name(json_wtr, "src_reg");
261 jsonw_printf(json_wtr, "\"0x%hhx\"", insn[i].src_reg);
262
263 jsonw_name(json_wtr, "dst_reg");
264 jsonw_printf(json_wtr, "\"0x%hhx\"", insn[i].dst_reg);
265
266 jsonw_name(json_wtr, "off");
267 print_hex_data_json((uint8_t *)(&insn[i].off), 2);
268
269 jsonw_name(json_wtr, "imm");
270 if (double_insn && i < len - 1)
271 print_hex_data_json((uint8_t *)(&insn[i].imm),
272 12);
273 else
274 print_hex_data_json((uint8_t *)(&insn[i].imm),
275 4);
276 jsonw_end_object(json_wtr);
277 }
278 jsonw_end_object(json_wtr);
279 }
280 jsonw_end_array(json_wtr);
281}
282
283void dump_xlated_plain(struct dump_data *dd, void *buf, unsigned int len,
284 bool opcodes)
285{
286 const struct bpf_insn_cbs cbs = {
287 .cb_print = print_insn,
288 .cb_call = print_call,
289 .cb_imm = print_imm,
290 .private_data = dd,
291 };
292 struct bpf_insn *insn = buf;
293 bool double_insn = false;
294 unsigned int i;
295
296 for (i = 0; i < len / sizeof(*insn); i++) {
297 if (double_insn) {
298 double_insn = false;
299 continue;
300 }
301
302 double_insn = insn[i].code == (BPF_LD | BPF_IMM | BPF_DW);
303
304 printf("% 4d: ", i);
305 print_bpf_insn(&cbs, insn + i, true);
306
307 if (opcodes) {
308 printf(" ");
309 fprint_hex(stdout, insn + i, 8, " ");
310 if (double_insn && i < len - 1) {
311 printf(" ");
312 fprint_hex(stdout, insn + i + 1, 8, " ");
313 }
314 printf("\n");
315 }
316 }
317}
318
319void dump_xlated_for_graph(struct dump_data *dd, void *buf_start, void *buf_end,
320 unsigned int start_idx)
321{
322 const struct bpf_insn_cbs cbs = {
323 .cb_print = print_insn_for_graph,
324 .cb_call = print_call,
325 .cb_imm = print_imm,
326 .private_data = dd,
327 };
328 struct bpf_insn *insn_start = buf_start;
329 struct bpf_insn *insn_end = buf_end;
330 struct bpf_insn *cur = insn_start;
331
332 for (; cur <= insn_end; cur++) {
333 printf("% 4d: ", (int)(cur - insn_start + start_idx));
334 print_bpf_insn(&cbs, cur, true);
335 if (cur != insn_end)
336 printf(" | ");
337 }
338}