aboutsummaryrefslogtreecommitdiff
path: root/libs/kstd/gdb/smart_pointers.py
blob: c7b6c6608a7a22be0b3b106a76d3f7b47905ff55 (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
import gdb


def _dereference_dynamic(pointer):
    target = pointer.dereference()
    try:
        dynamic_type = target.dynamic_type
        if dynamic_type != target.type:
            target = target.cast(dynamic_type)
    except gdb.error:
        pass
    return target


class KstdUniquePtrPrinter(gdb.ValuePrinter):
    def __init__(self, val):
        self.__val = val
        self.__type = val.type.template_argument(0)

    def to_string(self):
        pointer = self.__val["m_storage"]
        if int(pointer) == 0:
            return f"kstd::unique_ptr<{self.__type}> (empty)"
        return f"kstd::unique_ptr<{self.__type}>"

    def children(self):
        pointer = self.__val["m_storage"]
        if int(pointer) != 0:
            if pointer.type.target().code == gdb.TYPE_CODE_VOID:
                yield ("get()", pointer)
            else:
                yield ("get()", _dereference_dynamic(pointer))

    def display_hint(self):
        return None


class KstdSharedPtrPrinter(gdb.ValuePrinter):
    def __init__(self, val):
        self.__val = val
        self.__type = val.type.template_argument(0)

    def to_string(self):
        pointer = self.__val["m_pointer"]
        control_block = self.__val["m_control_block"]

        if int(pointer) == 0 or int(control_block) == 0:
            return f"shared_ptr<{self.__type}> (empty)"

        strong_refs = int(control_block["m_strong_count"]["_M_i"])
        weak_refs = int(control_block["m_weak_count"]["_M_i"])

        return (
            f"shared_ptr<{self.__type}> use count {strong_refs}, weak count {weak_refs}"
        )

    def children(self):
        pointer = self.__val["m_pointer"]
        control_block = self.__val["m_control_block"]

        if int(pointer) != 0:
            if pointer.type.target().code == gdb.TYPE_CODE_VOID:
                # GDB cannot dereference a void* - there's no size/layout to interpret it with. This is the
                # shared_ptr<void> case (e.g. kapi::devices::device::driver_data) - show the raw address instead
                # of crashing.
                yield ("get()", pointer)
            else:
                yield ("get()", _dereference_dynamic(pointer))

    def display_hint(self):
        return None


class KstdWeakPtrPrinter(gdb.ValuePrinter):
    def __init__(self, val):
        self.__val = val
        self.__type = val.type.template_argument(0)

    def to_string(self):
        pointer = self.__val["m_pointer"]
        control_block = self.__val["m_control_block"]

        if int(pointer) == 0 or int(control_block) == 0:
            return f"weak_ptr<{self.__type}> (empty)"

        strong_refs = int(control_block["m_strong_count"]["_M_i"])
        weak_refs = int(control_block["m_weak_count"]["_M_i"])
        return (
            f"weak_ptr<{self.__type}> use count {strong_refs}, weak count {weak_refs}"
        )

    def children(self):
        pointer = self.__val["m_pointer"]

        if int(pointer) != 0:
            if pointer.type.target().code == gdb.TYPE_CODE_VOID:
                yield ("get()", pointer)
            else:
                yield ("get()", _dereference_dynamic(pointer))

    def display_hint(self):
        return None


class KstdObserverPtrPrinter(gdb.ValuePrinter):
    def __init__(self, val):
        self.__val = val
        self.__type = val.type.template_argument(0)
        self.__pointer = val["m_ptr"]

    def to_string(self):
        return f"{(self.__pointer)}"

    def children(self):
        if int(self.__pointer) != 0:
            if self.__pointer.type.target().code == gdb.TYPE_CODE_VOID:
                yield ("get()", self.__pointer)
            else:
                yield ("get()", _dereference_dynamic(self.__pointer))

    def display_hint(self):
        return None