| 1 |
# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 |
# SPDX-License-Identifier: LGPL-2.1-or-later |
| 3 |
|
| 4 |
import collections |
| 5 |
|
| 6 |
from drgn import NULL, container_of |
| 7 |
from drgn.helpers import ValidationError |
| 8 |
from drgn.helpers.linux.rbtree import ( |
| 9 |
RB_EMPTY_NODE, |
| 10 |
RB_EMPTY_ROOT, |
| 11 |
rb_find, |
| 12 |
rb_first, |
| 13 |
rb_last, |
| 14 |
rb_next, |
| 15 |
rb_parent, |
| 16 |
rb_prev, |
| 17 |
rbtree_inorder_for_each, |
| 18 |
rbtree_inorder_for_each_entry, |
| 19 |
rbtree_preorder_for_each, |
| 20 |
rbtree_preorder_for_each_entry, |
| 21 |
validate_rbtree, |
| 22 |
validate_rbtree_inorder_for_each_entry, |
| 23 |
) |
| 24 |
from tests.linux_kernel import LinuxKernelTestCase, skip_unless_have_test_kmod |
| 25 |
|
| 26 |
|
| 27 |
@skip_unless_have_test_kmod |
| 28 |
class TestRbtree(LinuxKernelTestCase): |
| 29 |
@classmethod |
| 30 |
def setUpClass(cls): |
| 31 |
super().setUpClass() |
| 32 |
cls.root = cls.prog["drgn_test_rb_root"].address_of_() |
| 33 |
cls.entries = cls.prog["drgn_test_rb_entries"] |
| 34 |
cls.num_entries = 4 |
| 35 |
cls.empty_root = cls.prog["drgn_test_empty_rb_root"].address_of_() |
| 36 |
|
| 37 |
def node(self, n): |
| 38 |
return self.entries[n].node.address_of_() |
| 39 |
|
| 40 |
def entry(self, n): |
| 41 |
return self.entries[n].address_of_() |
| 42 |
|
| 43 |
def test_RB_EMPTY_ROOT(self): |
| 44 |
self.assertTrue(RB_EMPTY_ROOT(self.empty_root)) |
| 45 |
self.assertFalse(RB_EMPTY_ROOT(self.root)) |
| 46 |
|
| 47 |
def test_RB_EMPTY_NODE(self): |
| 48 |
self.assertTrue( |
| 49 |
RB_EMPTY_NODE(self.prog["drgn_test_empty_rb_node"].address_of_()) |
| 50 |
) |
| 51 |
self.assertFalse(RB_EMPTY_NODE(self.node(0))) |
| 52 |
|
| 53 |
def test_rb_parent(self): |
| 54 |
if self.root.rb_node.rb_left: |
| 55 |
self.assertEqual(rb_parent(self.root.rb_node.rb_left), self.root.rb_node) |
| 56 |
if self.root.rb_node.rb_right: |
| 57 |
self.assertEqual(rb_parent(self.root.rb_node.rb_right), self.root.rb_node) |
| 58 |
|
| 59 |
def test_rb_first(self): |
| 60 |
self.assertEqual(rb_first(self.root), self.node(0)) |
| 61 |
|
| 62 |
def test_rb_last(self): |
| 63 |
self.assertEqual(rb_last(self.root), self.node(self.num_entries - 1)) |
| 64 |
|
| 65 |
def test_rb_next(self): |
| 66 |
for i in range(self.num_entries - 1): |
| 67 |
self.assertEqual(rb_next(self.node(i)), self.node(i + 1)) |
| 68 |
self.assertEqual( |
| 69 |
rb_next(self.node(self.num_entries - 1)), |
| 70 |
NULL(self.prog, "struct rb_node *"), |
| 71 |
) |
| 72 |
|
| 73 |
def test_rb_prev(self): |
| 74 |
for i in range(1, self.num_entries): |
| 75 |
self.assertEqual(rb_prev(self.node(i)), self.node(i - 1)) |
| 76 |
self.assertEqual(rb_prev(self.node(0)), NULL(self.prog, "struct rb_node *")) |
| 77 |
|
| 78 |
def test_rbtree_inorder_for_each(self): |
| 79 |
self.assertEqual( |
| 80 |
list(rbtree_inorder_for_each(self.root)), |
| 81 |
[self.node(i) for i in range(self.num_entries)], |
| 82 |
) |
| 83 |
|
| 84 |
def test_rbtree_inorder_for_each_entry(self): |
| 85 |
self.assertEqual( |
| 86 |
list( |
| 87 |
rbtree_inorder_for_each_entry( |
| 88 |
"struct drgn_test_rb_entry", self.root, "node" |
| 89 |
) |
| 90 |
), |
| 91 |
[self.entry(i) for i in range(self.num_entries)], |
| 92 |
) |
| 93 |
|
| 94 |
def test_rbtree_preorder_for_each(self): |
| 95 |
preorder = list(rbtree_preorder_for_each(self.root)) |
| 96 |
self.assertCountEqual(preorder, [self.node(i) for i in range(self.num_entries)]) |
| 97 |
self.assertEqual(preorder[0], self.root.rb_node) |
| 98 |
|
| 99 |
def test_rbtree_preorder_for_each_entry(self): |
| 100 |
preorder = list( |
| 101 |
rbtree_preorder_for_each_entry( |
| 102 |
"struct drgn_test_rb_entry", self.root, "node" |
| 103 |
) |
| 104 |
) |
| 105 |
self.assertCountEqual( |
| 106 |
preorder, [self.entry(i) for i in range(self.num_entries)] |
| 107 |
) |
| 108 |
self.assertEqual( |
| 109 |
preorder[0], |
| 110 |
container_of(self.root.rb_node, "struct drgn_test_rb_entry", "node"), |
| 111 |
) |
| 112 |
|
| 113 |
def test_rb_find(self): |
| 114 |
def cmp(key, obj): |
| 115 |
value = obj.value.value_() |
| 116 |
return key - value |
| 117 |
|
| 118 |
for i in range(self.num_entries): |
| 119 |
self.assertEqual( |
| 120 |
rb_find("struct drgn_test_rb_entry", self.root, "node", i, cmp), |
| 121 |
self.entry(i), |
| 122 |
) |
| 123 |
self.assertEqual( |
| 124 |
rb_find( |
| 125 |
"struct drgn_test_rb_entry", self.root, "node", self.num_entries, cmp |
| 126 |
), |
| 127 |
NULL(self.prog, "struct drgn_test_rb_entry *"), |
| 128 |
) |
| 129 |
|
| 130 |
@staticmethod |
| 131 |
def cmp_entries(a, b): |
| 132 |
return a.value.value_() - b.value.value_() |
| 133 |
|
| 134 |
def test_validate_rbtree_success(self): |
| 135 |
for root, allow_equal in ( |
| 136 |
(self.root, False), |
| 137 |
(self.empty_root, False), |
| 138 |
(self.prog["drgn_test_rbtree_with_equal"].address_of_(), True), |
| 139 |
): |
| 140 |
validate_rbtree( |
| 141 |
"struct drgn_test_rb_entry", root, "node", self.cmp_entries, allow_equal |
| 142 |
) |
| 143 |
self.assertEqual( |
| 144 |
list( |
| 145 |
validate_rbtree_inorder_for_each_entry( |
| 146 |
"struct drgn_test_rb_entry", |
| 147 |
root, |
| 148 |
"node", |
| 149 |
self.cmp_entries, |
| 150 |
allow_equal, |
| 151 |
) |
| 152 |
), |
| 153 |
list( |
| 154 |
rbtree_inorder_for_each_entry( |
| 155 |
"struct drgn_test_rb_entry", root, "node" |
| 156 |
) |
| 157 |
), |
| 158 |
) |
| 159 |
|
| 160 |
def assert_validation_error(self, regex, name): |
| 161 |
self.assertRaisesRegex( |
| 162 |
ValidationError, |
| 163 |
regex, |
| 164 |
validate_rbtree, |
| 165 |
"struct drgn_test_rb_entry", |
| 166 |
self.prog[name].address_of_(), |
| 167 |
"node", |
| 168 |
self.cmp_entries, |
| 169 |
False, |
| 170 |
) |
| 171 |
self.assertRaisesRegex( |
| 172 |
ValidationError, |
| 173 |
regex, |
| 174 |
collections.deque, |
| 175 |
validate_rbtree_inorder_for_each_entry( |
| 176 |
"struct drgn_test_rb_entry", |
| 177 |
self.prog[name].address_of_(), |
| 178 |
"node", |
| 179 |
self.cmp_entries, |
| 180 |
False, |
| 181 |
), |
| 182 |
0, |
| 183 |
) |
| 184 |
|
| 185 |
def test_validate_rbtree_has_equal(self): |
| 186 |
self.assert_validation_error("compares equal", "drgn_test_rbtree_with_equal") |
| 187 |
|
| 188 |
def test_validate_rbtree_out_of_order(self): |
| 189 |
self.assert_validation_error( |
| 190 |
"compares (greater|less) than", "drgn_test_rbtree_out_of_order" |
| 191 |
) |
| 192 |
|
| 193 |
def test_validate_rbtree_null_root_parent(self): |
| 194 |
self.assert_validation_error( |
| 195 |
"root node .* has parent", "drgn_test_rbtree_with_bad_root_parent" |
| 196 |
) |
| 197 |
|
| 198 |
def test_validate_rbtree_red_root(self): |
| 199 |
self.assert_validation_error( |
| 200 |
"root node .* is red", "drgn_test_rbtree_with_red_root" |
| 201 |
) |
| 202 |
|
| 203 |
def test_validate_rbtree_inconsistent_parents(self): |
| 204 |
self.assert_validation_error( |
| 205 |
"rb_parent", "drgn_test_rbtree_with_inconsistent_parents" |
| 206 |
) |
| 207 |
|
| 208 |
def test_validate_rbtree_red_violation(self): |
| 209 |
self.assert_validation_error( |
| 210 |
"red node .* has red child", "drgn_test_rbtree_with_red_violation" |
| 211 |
) |
| 212 |
|
| 213 |
def test_validate_rbtree_black_violation(self): |
| 214 |
self.assert_validation_error( |
| 215 |
"unequal black heights", "drgn_test_rbtree_with_black_violation" |
| 216 |
) |