summaryrefslogtreecommitdiff
path: root/scripts/gdb/linux/bpf.py
blob: 1870534ef6f9b3375af0a5c43ccc7e53f78aa554 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# SPDX-License-Identifier: GPL-2.0

import json
import subprocess
import tempfile

import gdb

from linux import constants, lists, radixtree, utils


if constants.LX_CONFIG_BPF and constants.LX_CONFIG_BPF_JIT:
    bpf_ksym_type = utils.CachedType("struct bpf_ksym")
if constants.LX_CONFIG_BPF_SYSCALL:
    bpf_prog_type = utils.CachedType("struct bpf_prog")


def get_ksym_name(ksym):
    name = ksym["name"].bytes
    end = name.find(b"\x00")
    if end != -1:
        name = name[:end]
    return name.decode()


def list_ksyms():
    if not (constants.LX_CONFIG_BPF and constants.LX_CONFIG_BPF_JIT):
        return []
    bpf_kallsyms = gdb.parse_and_eval("&bpf_kallsyms")
    bpf_ksym_ptr_type = bpf_ksym_type.get_type().pointer()
    return list(lists.list_for_each_entry(bpf_kallsyms,
                                          bpf_ksym_ptr_type,
                                          "lnode"))


class KsymAddBreakpoint(gdb.Breakpoint):
    def __init__(self, monitor):
        super(KsymAddBreakpoint, self).__init__("bpf_ksym_add", internal=True)
        self.silent = True
        self.monitor = monitor

    def stop(self):
        self.monitor.add(gdb.parse_and_eval("ksym"))
        return False


class KsymRemoveBreakpoint(gdb.Breakpoint):
    def __init__(self, monitor):
        super(KsymRemoveBreakpoint, self).__init__("bpf_ksym_del",
                                                   internal=True)
        self.silent = True
        self.monitor = monitor

    def stop(self):
        self.monitor.remove(gdb.parse_and_eval("ksym"))
        return False


class KsymMonitor:
    def __init__(self, add, remove):
        self.add = add
        self.remove = remove

        self.add_bp = KsymAddBreakpoint(self)
        self.remove_bp = KsymRemoveBreakpoint(self)

        self.notify_initial()

    def notify_initial(self):
        for ksym in list_ksyms():
            self.add(ksym)

    def delete(self):
        self.add_bp.delete()
        self.remove_bp.delete()


def list_progs():
    if not constants.LX_CONFIG_BPF_SYSCALL:
        return []
    idr_rt = gdb.parse_and_eval("&prog_idr.idr_rt")
    bpf_prog_ptr_type = bpf_prog_type.get_type().pointer()
    progs = []
    for _, slot in radixtree.for_each_slot(idr_rt):
        prog = slot.dereference().cast(bpf_prog_ptr_type)
        progs.append(prog)
        # Subprogs are not registered in prog_idr, fetch them manually.
        # func[0] is the current prog.
        aux = prog["aux"]
        func = aux["func"]
        real_func_cnt = int(aux["real_func_cnt"])
        for i in range(1, real_func_cnt):
            progs.append(func[i])
    return progs


class ProgAddBreakpoint(gdb.Breakpoint):
    def __init__(self, monitor):
        super(ProgAddBreakpoint, self).__init__("bpf_prog_kallsyms_add",
                                                internal=True)
        self.silent = True
        self.monitor = monitor

    def stop(self):
        self.monitor.add(gdb.parse_and_eval("fp"))
        return False


class ProgRemoveBreakpoint(gdb.Breakpoint):
    def __init__(self, monitor):
        super(ProgRemoveBreakpoint, self).__init__("bpf_prog_free_id",
                                                   internal=True)
        self.silent = True
        self.monitor = monitor

    def stop(self):
        self.monitor.remove(gdb.parse_and_eval("prog"))
        return False


class ProgMonitor:
    def __init__(self, add, remove):
        self.add = add
        self.remove = remove

        self.add_bp = ProgAddBreakpoint(self)
        self.remove_bp = ProgRemoveBreakpoint(self)

        self.notify_initial()

    def notify_initial(self):
        for prog in list_progs():
            self.add(prog)

    def delete(self):
        self.add_bp.delete()
        self.remove_bp.delete()


def btf_str_by_offset(btf, offset):
    while offset < btf["start_str_off"]:
        btf = btf["base_btf"]

    offset -= btf["start_str_off"]
    if offset < btf["hdr"]["str_len"]:
        return (btf["strings"] + offset).string()

    return None


def bpf_line_info_line_num(line_col):
    return line_col >> 10


def bpf_line_info_line_col(line_col):
    return line_col & 0x3ff


class LInfoIter:
    def __init__(self, prog):
        # See bpf_prog_get_file_line() for details.
        self.pos = 0
        self.nr_linfo = 0

        if prog is None:
            return

        self.bpf_func = int(prog["bpf_func"])
        aux = prog["aux"]
        self.btf = aux["btf"]
        linfo_idx = aux["linfo_idx"]
        self.nr_linfo = int(aux["nr_linfo"]) - linfo_idx
        if self.nr_linfo == 0:
            return

        linfo_ptr = aux["linfo"]
        tpe = linfo_ptr.type.target().array(self.nr_linfo).pointer()
        self.linfo = (linfo_ptr + linfo_idx).cast(tpe).dereference()
        jited_linfo_ptr = aux["jited_linfo"]
        tpe = jited_linfo_ptr.type.target().array(self.nr_linfo).pointer()
        self.jited_linfo = (jited_linfo_ptr + linfo_idx).cast(tpe).dereference()

        self.filenos = {}

    def get_code_off(self):
        if self.pos >= self.nr_linfo:
            return -1
        return self.jited_linfo[self.pos] - self.bpf_func

    def advance(self):
        self.pos += 1

    def get_fileno(self):
        file_name_off = int(self.linfo[self.pos]["file_name_off"])
        fileno = self.filenos.get(file_name_off)
        if fileno is not None:
            return fileno, None
        file_name = btf_str_by_offset(self.btf, file_name_off)
        fileno = len(self.filenos) + 1
        self.filenos[file_name_off] = fileno
        return fileno, file_name

    def get_line_col(self):
        line_col = int(self.linfo[self.pos]["line_col"])
        return bpf_line_info_line_num(line_col), \
               bpf_line_info_line_col(line_col)


def generate_debug_obj(ksym, prog):
    name = get_ksym_name(ksym)
    # Avoid read_memory(); it throws bogus gdb.MemoryError in some contexts.
    start = ksym["start"]
    code = start.cast(gdb.lookup_type("unsigned char")
                      .array(int(ksym["end"]) - int(start))
                      .pointer()).dereference().bytes
    linfo_iter = LInfoIter(prog)

    result = tempfile.NamedTemporaryFile(suffix=".o", mode="wb")
    try:
        with tempfile.NamedTemporaryFile(suffix=".s", mode="w") as src:
            # ".loc" does not apply to ".byte"s, only to ".insn"s, but since
            # this needs to work for all architectures, the latter are not an
            # option. Ask the assembler to apply ".loc"s to labels as well,
            # and generate dummy labels after each ".loc".
            src.write(".loc_mark_labels 1\n")

            src.write(".globl {}\n".format(name))
            src.write(".type {},@function\n".format(name))
            src.write("{}:\n".format(name))
            for code_off, code_byte in enumerate(code):
                if linfo_iter.get_code_off() == code_off:
                    fileno, file_name = linfo_iter.get_fileno()
                    if file_name is not None:
                        src.write(".file {} {}\n".format(
                            fileno, json.dumps(file_name)))
                    line, col = linfo_iter.get_line_col()
                    src.write(".loc {} {} {}\n".format(fileno, line, col))
                    src.write("0:\n")
                    linfo_iter.advance()
                src.write(".byte {}\n".format(code_byte))
            src.write(".size {},{}\n".format(name, len(code)))
            src.flush()

            try:
                subprocess.check_call(["as", "-c", src.name, "-o", result.name])
            except FileNotFoundError:
                # "as" is not installed.
                result.close()
                return None
        return result
    except:
        result.close()
        raise