Loading...
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 | // // stack_trace_test.c // libmalloc // // Unit tests for collecting compressed stack traces. // #include <darwintest.h> T_GLOBAL_META(T_META_RUN_CONCURRENTLY(TRUE), T_META_TAG_VM_PREFERRED, T_META_TAG_NO_ALLOCATOR_OVERRIDE); #include "../src/stack_trace.c" #include <stdlib.h> // arc4random_buf() #include <thread_stack_pcs.h> T_DECL(zigzag_encode, "zigzag_encode") { T_EXPECT_EQ(zigzag_encode(0), 0ul, NULL); T_EXPECT_EQ(zigzag_encode(1), 2ul, NULL); T_EXPECT_EQ(zigzag_encode(2), 4ul, NULL); T_EXPECT_EQ(zigzag_encode(-1), 1ul, NULL); T_EXPECT_EQ(zigzag_encode(-2), 3ul, NULL); T_EXPECT_EQ(zigzag_encode(-3), 5ul, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MAX), UINTPTR_MAX - 1, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MAX - 1), UINTPTR_MAX - 3, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MAX - 2), UINTPTR_MAX - 5, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MIN), UINTPTR_MAX, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MIN + 1), UINTPTR_MAX - 2, NULL); T_EXPECT_EQ(zigzag_encode(INTPTR_MIN + 2), UINTPTR_MAX - 4, NULL); } T_DECL(zigzag_decode, "zigzag_decode") { T_EXPECT_EQ(zigzag_decode(0), 0ul, NULL); T_EXPECT_EQ(zigzag_decode(1), -1ul, NULL); T_EXPECT_EQ(zigzag_decode(2), 1ul, NULL); T_EXPECT_EQ(zigzag_decode(3), -2ul, NULL); T_EXPECT_EQ(zigzag_decode(4), 2ul, NULL); T_EXPECT_EQ(zigzag_decode(-1), INTPTR_MIN, NULL); T_EXPECT_EQ(zigzag_decode(-2), INTPTR_MAX, NULL); T_EXPECT_EQ(zigzag_decode(-3), INTPTR_MIN + 1, NULL); T_EXPECT_EQ(zigzag_decode(-4), INTPTR_MAX - 1, NULL); } T_DECL(codeoffset_encode_decode, "codeoffset_encode_decode") { #define CO_roundtrip(x) codeoffset_decode(codeoffset_encode(x)) intptr_t val = (vm_address_t)&trace_collect; T_EXPECT_EQ(CO_roundtrip(val), val, "code offset round-trips"); T_EXPECT_EQ(CO_roundtrip(-val), -val, "negative code offset round-trips"); arc4random_buf(&val, sizeof(val)); if (TARGET_CPU_ARM64) val &= ~3; T_EXPECT_EQ(CO_roundtrip(val), val, "random code offset round-trips"); } T_DECL(varint_encode, "varint_encode") { uint8_t buffer[2] = {}; T_EXPECT_EQ(varint_encode(NULL, 0, 5), 0ul, "zero-sized buffer"); T_EXPECT_EQ(varint_encode(buffer, 1, 0), 1ul, "encode zero"); T_EXPECT_EQ(buffer[0], 0x80, "stop bit"); T_EXPECT_EQ(varint_encode(buffer, 1, 5), 1ul, "encode small value"); T_EXPECT_EQ(buffer[0], 0x85, "0x5 + stop bit"); T_EXPECT_EQ(buffer[1], 0, "no write to buffer[1]"); T_EXPECT_EQ(varint_encode(buffer, 2, 0x105), 2ul, "encode multi-byte value"); T_EXPECT_EQ(buffer[0], 0x05, "first 7 bits"); T_EXPECT_EQ(buffer[1], 0x82, "next 7 bits + stop bit"); buffer[1] = 0; T_EXPECT_EQ(varint_encode(buffer, 1, 0x106), 0ul, "buffer too small"); T_EXPECT_EQ(buffer[0], 0x06, "first 7 bits"); T_EXPECT_EQ(buffer[1], 0, "no write to buffer[1]"); } T_DECL(varint_decode, "varint_decode") { uint8_t buffer[2] = {}; uintptr_t val = 0xAA; T_EXPECT_EQ(varint_decode(NULL, 0, NULL), 0ul, "zero-sized buffer"); buffer[0] = 0x80; T_EXPECT_EQ(varint_decode(buffer, 1, &val), 1ul, "decode zero"); T_EXPECT_EQ(val, 0ul, NULL); buffer[0] = 0x85; T_EXPECT_EQ(varint_decode(buffer, 1, &val), 1ul, "decode small value"); T_EXPECT_EQ(val, 5ul, NULL); buffer[0] = 0x05; buffer[1] = 0x82; T_EXPECT_EQ(varint_decode(buffer, 2, &val), 2ul, "decode multi-byte value"); T_EXPECT_EQ(val, 0x105ul, NULL); T_EXPECT_EQ(varint_decode(buffer, 1, NULL), 0ul, "missing stop bit"); } // varint encoding uses one bit per byte for stop bit static const uint32_t k_max_bytes_per_uint64 = 8 + 2; T_DECL(varint_encode_decode, "varint_encode_decode") { uint8_t buffer[k_max_bytes_per_uint64]; uintptr_t val, decoded_val; for (uint32_t i = 0; i < 10; i++) { arc4random_buf(&val, sizeof(val)); size_t encoded_len = varint_encode(buffer, sizeof(buffer), val); T_QUIET; T_ASSERT_GT(encoded_len, 0ul, NULL); T_QUIET; T_ASSERT_LE(encoded_len, sizeof(buffer), NULL); size_t decoded_len = varint_decode(buffer, sizeof(buffer), &decoded_val); T_QUIET; T_EXPECT_EQ(decoded_len, encoded_len, NULL); T_EXPECT_EQ(decoded_val, val, "64-bit value round-trips"); } } T_DECL(trace_encode, "trace_encode") { uint8_t expected_buffer[10] = { 0x88, // 0x04 << 1 = 0x08 + stop bit 0x78, // 0x80 - 0x04 = 0x7c << 1 = 0xf8 -> [0x1, 0x78] 0x81, // 0x1 + stop bit 0xbf, // 0x60 - 0x80 = -0x20 << 1 = -0x40 ~ = 0x3f + stop bit 0xAA }; vm_address_t addrs[] = {0x04, 0x80, 0x60}; if (TARGET_CPU_ARM64) for (uint32_t i = 0; i < 3; i++) addrs[i] <<= 2; uint8_t buffer[10] = {0, 0, 0, 0, 0xAA}; size_t size = trace_encode(buffer, sizeof(buffer), addrs, 3); T_EXPECT_EQ(size, 4ul, NULL); int res = memcmp(buffer, expected_buffer, sizeof(buffer)); T_EXPECT_EQ(res, 0, "encoded addresses"); } T_DECL(trace_decode, "trace_decode") { uint8_t buffer[10] = { 0x88, // 0x04 << 1 = 0x08 + stop bit 0x78, // 0x80 - 0x04 = 0x7c << 1 = 0xf8 -> [0x1, 0x78] 0x81, // 0x1 + stop bit 0xbf, // 0x60 - 0x80 = -0x20 << 1 = -0x40 ~ = 0x3f + stop bit 0xAA }; vm_address_t expected_addrs[] = {0x04, 0x80, 0x60}; if (TARGET_CPU_ARM64) for (uint32_t i = 0; i < 3; i++) expected_addrs[i] <<= 2; vm_address_t addrs[3]; uint32_t num_addrs = trace_decode(buffer, 4, addrs, 3 + 1/*fudge*/); T_EXPECT_EQ(num_addrs, 3, NULL); int res = memcmp(addrs, expected_addrs, sizeof(addrs)); T_EXPECT_EQ(res, 0, "decoded addresses"); } T_DECL(trace_encode_decode, "trace_encode_decode") { vm_address_t addrs[32]; uint32_t num_addrs = arc4random_uniform(32); arc4random_buf(addrs, num_addrs * sizeof(vm_address_t)); if (TARGET_CPU_ARM64) for (uint32_t i = 0; i < num_addrs; i++) addrs[i] &= ~3; uint8_t buffer[32 * k_max_bytes_per_uint64]; size_t size = trace_encode(buffer, sizeof(buffer), addrs, num_addrs); T_ASSERT_LT(size, sizeof(buffer), NULL); vm_address_t decoded_addrs[32]; uint32_t decoded_num_addrs = trace_decode(buffer, size, decoded_addrs, 32); T_EXPECT_EQ(decoded_num_addrs, num_addrs, NULL); int res = memcmp(decoded_addrs, addrs, num_addrs * sizeof(vm_address_t)); T_EXPECT_EQ(res, 0, "addresses round-trips"); } T_DECL(trace_collect, "trace_collect") { vm_address_t frames[34]; uint32_t num_frames; thread_stack_pcs(frames, 34, &num_frames); num_frames -= 2; T_ASSERT_GE(num_frames, 3, "at least 3 good frames"); uint8_t buffer[32 * k_max_bytes_per_uint64]; size_t size = trace_collect(buffer, sizeof(buffer)); T_ASSERT_LT(size, sizeof(buffer), NULL); vm_address_t decoded_frames[32]; uint32_t decoded_num_frames = trace_decode(buffer, size, decoded_frames, 32); T_EXPECT_EQ(decoded_num_frames, num_frames, NULL); uint32_t start = 1; // call sites in this function don't match for (uint32_t i = start; i < num_frames; i++) { T_EXPECT_EQ(decoded_frames[i], frames[i + 1], "frame %u: %p", i, (void *)frames[i]); } } |