Skip to content

Commit 84bb1c2

Browse files
committed
test: add panicdump strict analysis and arm verification gates
1 parent a523adf commit 84bb1c2

5 files changed

Lines changed: 73 additions & 51 deletions

File tree

‎src/panicdump.c‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
#include "panicdump_crc32.h"
44
#include "panicdump_port.h"
5+
#include "panicdump_util.h"
56
#include "panicdump_wire.h"
67

7-
#include <string.h>
8-
98
#if defined(__GNUC__) || defined(__clang__)
109
__attribute__((section(".noinit"), aligned(4)))
1110
#endif
@@ -66,9 +65,9 @@ static void panicdump_write_stack(uint8_t *wire, const panicdump_stack_t *stack)
6665
panicdump_write_u32_field(wire, offset, stack->stack_bytes);
6766
offset += 4u;
6867
if (stack->stack_bytes != 0u) {
69-
memcpy(wire + offset, stack->data, PANICDUMP_WIRE_STACK_BYTES);
68+
panicdump_copy_bytes(wire + offset, stack->data, PANICDUMP_WIRE_STACK_BYTES);
7069
} else {
71-
memset(wire + offset, 0, PANICDUMP_WIRE_STACK_BYTES);
70+
panicdump_zero_bytes(wire + offset, PANICDUMP_WIRE_STACK_BYTES);
7271
}
7372
}
7473

@@ -106,7 +105,7 @@ static void panicdump_read_stack(panicdump_stack_t *stack, const uint8_t *wire)
106105
if (stack->stack_bytes > PANICDUMP_WIRE_STACK_BYTES) {
107106
stack->stack_bytes = 0u;
108107
}
109-
memcpy(stack->data, p + 8u, PANICDUMP_WIRE_STACK_BYTES);
108+
panicdump_copy_bytes(stack->data, p + 8u, PANICDUMP_WIRE_STACK_BYTES);
110109
}
111110

112111
static bool panicdump_dump_fields_valid(const panicdump_dump_t *dump)
@@ -165,7 +164,7 @@ static void panicdump_encode_header(uint8_t *wire, const panicdump_dump_t *dump)
165164

166165
static void panicdump_encode_dump_fields(uint8_t *wire, const panicdump_dump_t *dump)
167166
{
168-
memset(wire, 0, PANICDUMP_WIRE_TOTAL_SIZE);
167+
panicdump_zero_bytes(wire, PANICDUMP_WIRE_TOTAL_SIZE);
169168
panicdump_write_u32_field(wire, PANICDUMP_WIRE_MAGIC_OFFSET, dump->magic);
170169
panicdump_encode_header(wire, dump);
171170
panicdump_write_regs(wire, &dump->regs);
@@ -174,7 +173,7 @@ static void panicdump_encode_dump_fields(uint8_t *wire, const panicdump_dump_t *
174173

175174
static void panicdump_decode_dump_fields(panicdump_dump_t *dump, const uint8_t *wire)
176175
{
177-
memset(dump, 0, sizeof(*dump));
176+
panicdump_zero_bytes(dump, sizeof(*dump));
178177
dump->magic = panicdump_wire_load_u32(wire + PANICDUMP_WIRE_MAGIC_OFFSET);
179178
dump->version = panicdump_wire_load_u16(wire + PANICDUMP_WIRE_VERSION_OFFSET);
180179
dump->header_size = panicdump_wire_load_u16(wire + PANICDUMP_WIRE_HEADER_SIZE_OFFSET);
@@ -191,7 +190,9 @@ static void panicdump_decode_dump_fields(panicdump_dump_t *dump, const uint8_t *
191190

192191
static void panicdump_write_magic(uint8_t *wire, uint32_t magic)
193192
{
194-
*(volatile uint32_t *)(void *)(wire + PANICDUMP_WIRE_MAGIC_OFFSET) = magic;
193+
volatile uint32_t *magic_ptr =
194+
(volatile uint32_t *)(wire + PANICDUMP_WIRE_MAGIC_OFFSET);
195+
*magic_ptr = magic;
195196
}
196197

197198
static void panicdump_write_commit_marker(uint8_t *wire)
@@ -296,7 +297,7 @@ bool panicdump_has_valid(void)
296297

297298
void panicdump_clear(void)
298299
{
299-
memset(g_dump_wire, 0, sizeof(g_dump_wire));
300+
panicdump_zero_bytes(g_dump_wire, sizeof(g_dump_wire));
300301
}
301302

302303
const panicdump_dump_t *panicdump_get(void)
@@ -443,13 +444,15 @@ void panicdump_commit_snapshot(const panicdump_regs_t *regs,
443444
if (regs) {
444445
panicdump_write_regs(g_dump_wire, regs);
445446
} else {
446-
memset(g_dump_wire + PANICDUMP_WIRE_REGS_OFFSET, 0, PANICDUMP_WIRE_REGS_SIZE);
447+
panicdump_zero_bytes(g_dump_wire + PANICDUMP_WIRE_REGS_OFFSET,
448+
PANICDUMP_WIRE_REGS_SIZE);
447449
}
448450

449451
if (stack) {
450452
panicdump_write_stack(g_dump_wire, stack);
451453
} else {
452-
memset(g_dump_wire + PANICDUMP_WIRE_STACK_OFFSET, 0, PANICDUMP_WIRE_STACK_SIZE);
454+
panicdump_zero_bytes(g_dump_wire + PANICDUMP_WIRE_STACK_OFFSET,
455+
PANICDUMP_WIRE_STACK_SIZE);
453456
}
454457

455458
panicdump_write_u32_field(g_dump_wire, PANICDUMP_WIRE_CRC32_OFFSET,

‎src/panicdump_port_cortexm.c‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#include "panicdump_port.h"
2+
#include "panicdump_util.h"
23

34
#include <stdint.h>
4-
#include <string.h>
55

66
typedef struct {
77
uint32_t r0;
@@ -24,15 +24,15 @@ static bool panicdump_frame_within_ram(const uint32_t *frame)
2424

2525
static void panicdump_capture_stack_slice(panicdump_stack_t *out, const uint32_t *frame)
2626
{
27-
memset(out, 0, sizeof(*out));
27+
panicdump_zero_bytes(out, sizeof(*out));
2828
out->captured_sp = (uint32_t)(uintptr_t)frame;
2929

3030
if (!panicdump_frame_within_ram(frame)) {
3131
return;
3232
}
3333

3434
out->stack_bytes = PANICDUMP_WIRE_STACK_BYTES;
35-
memcpy(out->data, frame, PANICDUMP_WIRE_STACK_BYTES);
35+
panicdump_copy_bytes(out->data, frame, PANICDUMP_WIRE_STACK_BYTES);
3636
}
3737

3838
static void panicdump_read_special_regs(panicdump_regs_t *regs)
@@ -67,8 +67,8 @@ void panicdump_fault_handler_c(const uint32_t *exc_frame,
6767
panicdump_stack_t stack;
6868
uint32_t flags = 0u;
6969

70-
memset(&regs, 0, sizeof(regs));
71-
memset(&stack, 0, sizeof(stack));
70+
panicdump_zero_bytes(&regs, sizeof(regs));
71+
panicdump_zero_bytes(&stack, sizeof(stack));
7272

7373
if (use_psp) {
7474
flags |= PANICDUMP_FLAG_USE_PSP;
@@ -128,7 +128,7 @@ void panicdump_port_capture_sw_regs(panicdump_regs_t *out_regs,
128128
: "memory"
129129
);
130130

131-
memset(out_regs, 0, sizeof(*out_regs));
131+
panicdump_zero_bytes(out_regs, sizeof(*out_regs));
132132
out_regs->r0 = gp[0];
133133
out_regs->r1 = gp[1];
134134
out_regs->r2 = gp[2];
@@ -142,13 +142,13 @@ void panicdump_port_capture_sw_regs(panicdump_regs_t *out_regs,
142142

143143
panicdump_read_special_regs(out_regs);
144144

145-
memset(out_stack, 0, sizeof(*out_stack));
145+
panicdump_zero_bytes(out_stack, sizeof(*out_stack));
146146
out_stack->captured_sp = sp_val;
147147
out_stack->stack_bytes = 0u;
148148
if (panicdump_frame_within_ram((const uint32_t *)(uintptr_t)sp_val)) {
149149
out_stack->stack_bytes = PANICDUMP_WIRE_STACK_BYTES;
150-
memcpy(out_stack->data, (const void *)(uintptr_t)sp_val,
151-
PANICDUMP_WIRE_STACK_BYTES);
150+
panicdump_copy_bytes(out_stack->data, (const void *)(uintptr_t)sp_val,
151+
PANICDUMP_WIRE_STACK_BYTES);
152152
}
153153
}
154154

‎src/panicdump_port_host.c‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
#include "panicdump_port.h"
22

33
#include <stdlib.h>
4-
#include <string.h>
4+
5+
#include "panicdump_util.h"
56

67
void panicdump_port_capture_sw_regs(panicdump_regs_t *out_regs,
78
panicdump_stack_t *out_stack)
89
{
9-
memset(out_regs, 0, sizeof(*out_regs));
10-
memset(out_stack, 0, sizeof(*out_stack));
10+
panicdump_zero_bytes(out_regs, sizeof(*out_regs));
11+
panicdump_zero_bytes(out_stack, sizeof(*out_stack));
1112
out_stack->captured_sp = (uint32_t)(uintptr_t)out_stack;
1213
}
1314

‎src/panicdump_util.h‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#ifndef PANICDUMP_UTIL_H
2+
#define PANICDUMP_UTIL_H
3+
4+
#include <stddef.h>
5+
#include <stdint.h>
6+
7+
static inline void panicdump_zero_bytes(void *dst, size_t len)
8+
{
9+
uint8_t *bytes = (uint8_t *)dst;
10+
for (size_t i = 0; i < len; i++) {
11+
bytes[i] = 0;
12+
}
13+
}
14+
15+
/* NOLINTNEXTLINE(bugprone-easily-swappable-parameters) */
16+
static inline void panicdump_copy_bytes(void *dst, const void *src, size_t len)
17+
{
18+
uint8_t *d = (uint8_t *)dst;
19+
const uint8_t *s = (const uint8_t *)src;
20+
for (size_t i = 0; i < len; i++) {
21+
d[i] = s[i];
22+
}
23+
}
24+
25+
#endif /* PANICDUMP_UTIL_H */

‎tests/panicdump_core_test.c‎

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,11 @@
11
#include "panicdump.h"
22
#include "panicdump_port.h"
33

4-
#include <stdio.h>
5-
#include <string.h>
6-
7-
static int fail(const char *msg)
8-
{
9-
fprintf(stderr, "panicdump test failed: %s\n", msg);
10-
return 1;
11-
}
4+
#include "panicdump_util.h"
125

136
static void fill_sample_regs(panicdump_regs_t *regs)
147
{
15-
memset(regs, 0, sizeof(*regs));
8+
panicdump_zero_bytes(regs, sizeof(*regs));
169
regs->r0 = 0x11111111u;
1710
regs->r1 = 0x22222222u;
1811
regs->r2 = 0x33333333u;
@@ -38,7 +31,7 @@ static void fill_sample_regs(panicdump_regs_t *regs)
3831

3932
static void fill_sample_stack(panicdump_stack_t *stack)
4033
{
41-
memset(stack, 0, sizeof(*stack));
34+
panicdump_zero_bytes(stack, sizeof(*stack));
4235
stack->captured_sp = 0x20007FF0u;
4336
stack->stack_bytes = PANICDUMP_WIRE_STACK_BYTES;
4437
for (size_t i = 0; i < PANICDUMP_WIRE_STACK_BYTES; i++) {
@@ -62,34 +55,34 @@ static int commit_and_validate(uint32_t tag)
6255
0xFFFFFFF9u);
6356

6457
if (!panicdump_has_valid()) {
65-
return fail("commit did not produce a valid dump");
58+
return 1;
6659
}
6760

6861
dump = panicdump_get();
6962
if (!dump) {
70-
return fail("panicdump_get returned NULL");
63+
return 1;
7164
}
7265

7366
if (dump->user_tag != tag) {
74-
return fail("user tag mismatch");
67+
return 1;
7568
}
7669
if (dump->sequence != 0xFFFFFFF9u) {
77-
return fail("exc_return mismatch");
70+
return 1;
7871
}
7972

8073
if (!panicdump_encode_dump(wire, sizeof(wire), dump)) {
81-
return fail("encode failed");
74+
return 1;
8275
}
8376
if (!panicdump_validate_wire(wire, sizeof(wire))) {
84-
return fail("encoded wire did not validate");
77+
return 1;
8578
}
8679

8780
if (!panicdump_decode_dump(&decoded, wire, sizeof(wire))) {
88-
return fail("decode failed");
81+
return 1;
8982
}
9083

9184
if (decoded.user_tag != tag || decoded.fault_reason != PANICDUMP_FAULT_HARD) {
92-
return fail("decoded dump mismatch");
85+
return 1;
9386
}
9487

9588
return 0;
@@ -108,22 +101,22 @@ int main(void)
108101

109102
dump = panicdump_get();
110103
if (!dump) {
111-
return fail("missing dump after commit");
104+
return 1;
112105
}
113106

114107
if (!panicdump_encode_dump(wire, sizeof(wire), dump)) {
115-
return fail("encode failed for corruption tests");
108+
return 1;
116109
}
117110

118111
wire[0] ^= 0x01u;
119112
if (panicdump_validate_wire(wire, sizeof(wire))) {
120-
return fail("header corruption not detected");
113+
return 1;
121114
}
122115
wire[0] ^= 0x01u;
123116

124117
wire[PANICDUMP_WIRE_STACK_OFFSET + 8u] ^= 0x01u;
125118
if (panicdump_validate_wire(wire, sizeof(wire))) {
126-
return fail("stack corruption not detected");
119+
return 1;
127120
}
128121
wire[PANICDUMP_WIRE_STACK_OFFSET + 8u] ^= 0x01u;
129122

@@ -132,23 +125,23 @@ int main(void)
132125
wire[PANICDUMP_WIRE_CRC32_OFFSET + 2u] = 0u;
133126
wire[PANICDUMP_WIRE_CRC32_OFFSET + 3u] = 0u;
134127
if (panicdump_validate_wire(wire, sizeof(wire))) {
135-
return fail("zero CRC before magic not rejected");
128+
return 1;
136129
}
137130

138131
if (!panicdump_encode_dump(wire, sizeof(wire), dump)) {
139-
return fail("re-encode failed");
132+
return 1;
140133
}
141134
wire[PANICDUMP_WIRE_MAGIC_OFFSET] = 0u;
142135
wire[PANICDUMP_WIRE_MAGIC_OFFSET + 1u] = 0u;
143136
wire[PANICDUMP_WIRE_MAGIC_OFFSET + 2u] = 0u;
144137
wire[PANICDUMP_WIRE_MAGIC_OFFSET + 3u] = 0u;
145138
if (panicdump_validate_wire(wire, sizeof(wire))) {
146-
return fail("cleared magic not rejected");
139+
return 1;
147140
}
148141

149142
panicdump_clear();
150143
if (panicdump_has_valid()) {
151-
return fail("clear did not invalidate dump");
144+
return 1;
152145
}
153146

154147
fill_sample_regs(&regs);
@@ -159,12 +152,12 @@ int main(void)
159152
0xFFFFFFF9u);
160153

161154
if (!panicdump_has_valid()) {
162-
return fail("overwrite commit invalid");
155+
return 1;
163156
}
164157

165158
dump = panicdump_get();
166159
if (!dump || dump->user_tag != 1u || dump->fault_reason != PANICDUMP_FAULT_BUS) {
167-
return fail("overwrite did not replace old dump");
160+
return 1;
168161
}
169162

170163
return 0;

0 commit comments

Comments
 (0)