Debian Codegraph @

libdrgn/drgn_program_parse_vmcoreinfo.inc.strswitch

raw
1 // Copyright (c) Meta Platforms, Inc. and affiliates.
2 // SPDX-License-Identifier: LGPL-2.1-or-later
3
4 static struct drgn_error *parse_vmcoreinfo_u64(const char *value,
5 const char *newline, int base,
6 uint64_t *ret)
7 {
8 errno = 0;
9 char *end;
10 *ret = strtoull(value, &end, base);
11 if (errno == ERANGE) {
12 return drgn_error_create(DRGN_ERROR_OVERFLOW,
13 "number in VMCOREINFO is too large");
14 } else if (errno || end == value || end != newline) {
15 return drgn_error_create(DRGN_ERROR_OTHER,
16 "number in VMCOREINFO is invalid");
17 }
18 return NULL;
19 }
20
21 // Linux kernel commit 905415ff3ffb ("lib/buildid: harden build ID parsing
22 // logic") (in v6.12) contains a bug that results in a garbage build ID in
23 // VMCOREINFO. It was fixed in the same patch series in commits de3ec364c3c3
24 // ("lib/buildid: add single folio-based file reader abstraction") and
25 // d4deb8242341 ("lib/buildid: take into account e_phoff when fetching program
26 // headers"). However, the broken commit was backported to several stable
27 // kernels. Some branches were fixed by "lib/buildid: Fix build ID parsing
28 // logic", but a couple reached their end-of-life while broken. See
29 // https://lore.kernel.org/all/[email protected]/.
30 //
31 // The very sad workaround is to ignore the build ID based on a version check.
32 static void ignore_broken_vmcoreinfo_build_id(struct drgn_program *prog)
33 {
34 char *p = (char *)prog->vmcoreinfo.osrelease;
35 long major = strtol(p, &p, 10), minor = 0, patch = 0;
36 if (*p == '.') {
37 minor = strtol(p + 1, &p, 10);
38 if (*p == '.')
39 patch = strtol(p + 1, NULL, 10);
40 }
41 if ((major == 6 && minor == 11 && patch >= 3 && patch < 10)
42 || (major == 6 && minor == 10 && patch >= 14)
43 || (major == 6 && minor == 6 && patch >= 55 && patch < 63)
44 || (major == 6 && minor == 1 && patch >= 113 && patch < 119)
45 || (major == 5 && minor == 15 && patch >= 168))
46 prog->vmcoreinfo.build_id_len = 0;
47 }
48
49 struct drgn_error *drgn_program_parse_vmcoreinfo(struct drgn_program *prog,
50 const char *desc,
51 size_t descsz)
52 {
53 struct drgn_error *err;
54
55 prog->vmcoreinfo.raw_size = descsz;
56 prog->vmcoreinfo.raw = memdup(desc, descsz);
57 if (!prog->vmcoreinfo.raw)
58 return &drgn_enomem;
59 for (const char *line = desc, *end = &desc[descsz], *newline;
60 (newline = memchr(line, '\n', end - line));
61 line = newline + 1) {
62 const char *equals = memchr(line, '=', newline - line);
63 if (!equals)
64 continue;
65
66 const char *value = equals + 1;
67 @memswitch (line, equals - line)@
68 @case "BUILD-ID"@
69 {
70 size_t build_id_len = (newline - value) / 2;
71 if (build_id_len > sizeof(prog->vmcoreinfo.build_id)) {
72 return drgn_error_create(DRGN_ERROR_OTHER,
73 "BUILD-ID in VMCOREINFO is too long");
74 }
75 if (!unhexlify(value, newline - value,
76 &prog->vmcoreinfo.build_id)) {
77 return drgn_error_create(DRGN_ERROR_OTHER,
78 "couldn't parse BUILD-ID in VMCOREINFO");
79 }
80 prog->vmcoreinfo.build_id_len = build_id_len;
81 break;
82 }
83 @case "CRASHTIME"@
84 prog->vmcoreinfo.have_crashtime = true;
85 break;
86 @case "OSRELEASE"@
87 if ((size_t)(newline - value) >=
88 sizeof(prog->vmcoreinfo.osrelease)) {
89 return drgn_error_create(DRGN_ERROR_OTHER,
90 "OSRELEASE in VMCOREINFO is too long");
91 }
92 memcpy(prog->vmcoreinfo.osrelease, value,
93 newline - value);
94 prog->vmcoreinfo.osrelease[newline - value] = '\0';
95 break;
96 @case "PAGESIZE"@
97 err = parse_vmcoreinfo_u64(value, newline, 0,
98 &prog->vmcoreinfo.page_size);
99 if (err)
100 return err;
101 break;
102 @case "KERNELOFFSET"@
103 err = parse_vmcoreinfo_u64(value, newline, 16,
104 &prog->vmcoreinfo.kaslr_offset);
105 if (err)
106 return err;
107 break;
108 @case "SYMBOL(swapper_pg_dir)"@
109 err = parse_vmcoreinfo_u64(value, newline, 16,
110 &prog->vmcoreinfo.swapper_pg_dir);
111 if (err)
112 return err;
113 break;
114 @case "LENGTH(mem_section)"@
115 err = parse_vmcoreinfo_u64(value, newline, 0,
116 &prog->vmcoreinfo.mem_section_length);
117 if (err)
118 return err;
119 break;
120 @case "NUMBER(SECTION_SIZE_BITS)"@
121 {
122 uint64_t tmp;
123 err = parse_vmcoreinfo_u64(value, newline, 0, &tmp);
124 if (err)
125 return err;
126 if (tmp == 0 || tmp > 64) {
127 return drgn_error_create(DRGN_ERROR_OTHER,
128 "SECTION_SIZE_BITS in VMCOREINFO is invalid");
129 }
130 prog->vmcoreinfo.section_size_bits = tmp;
131 break;
132 }
133 @case "NUMBER(MAX_PHYSMEM_BITS)"@
134 {
135 uint64_t tmp;
136 err = parse_vmcoreinfo_u64(value, newline, 0, &tmp);
137 if (err)
138 return err;
139 if (tmp == 0 || tmp > 64) {
140 return drgn_error_create(DRGN_ERROR_OTHER,
141 "MAX_PHYSMEM_BITS in VMCOREINFO is invalid");
142 }
143 prog->vmcoreinfo.max_physmem_bits = tmp;
144 break;
145 }
146 @case "NUMBER(pgtable_l5_enabled)"@
147 {
148 uint64_t tmp;
149 err = parse_vmcoreinfo_u64(value, newline, 0, &tmp);
150 if (err)
151 return err;
152 prog->vmcoreinfo.pgtable_l5_enabled = tmp;
153 break;
154 }
155 @case "NUMBER(kimage_voffset)"@
156 {
157 err = parse_vmcoreinfo_u64(value, newline, 0,
158 &prog->vmcoreinfo.kimage_voffset);
159 if (err)
160 return err;
161 break;
162 }
163 @case "NUMBER(phys_base)"@
164 {
165 err = parse_vmcoreinfo_u64(value, newline, 0,
166 &prog->vmcoreinfo.phys_base);
167 if (err)
168 return err;
169 prog->vmcoreinfo.have_phys_base = true;
170 break;
171 }
172 @case "NUMBER(KERNELPACMASK)"@
173 err = parse_vmcoreinfo_u64(value, newline, 16,
174 &prog->aarch64_insn_pac_mask);
175 if (err)
176 return err;
177 break;
178 @case "NUMBER(VA_BITS)"@
179 err = parse_vmcoreinfo_u64(value, newline, 0,
180 &prog->vmcoreinfo.va_bits);
181 if (err)
182 return err;
183 break;
184 @case "NUMBER(TCR_EL1_T1SZ)"@
185 err = parse_vmcoreinfo_u64(value, newline, 0,
186 &prog->vmcoreinfo.tcr_el1_t1sz);
187 if (err)
188 return err;
189 break;
190 @case "CONFIG_ARM_LPAE"@
191 prog->vmcoreinfo.arm_lpae = value[0] == 'y';
192 break;
193 @endswitch@
194 }
195 if (!prog->vmcoreinfo.osrelease[0]) {
196 return drgn_error_create(DRGN_ERROR_OTHER,
197 "VMCOREINFO does not contain valid OSRELEASE");
198 }
199 ignore_broken_vmcoreinfo_build_id(prog);
200 if (!is_power_of_two(prog->vmcoreinfo.page_size)) {
201 return drgn_error_create(DRGN_ERROR_OTHER,
202 "VMCOREINFO does not contain valid PAGESIZE");
203 }
204 prog->vmcoreinfo.page_shift = ctz(prog->vmcoreinfo.page_size);
205 if (!prog->vmcoreinfo.swapper_pg_dir) {
206 return drgn_error_create(DRGN_ERROR_OTHER,
207 "VMCOREINFO does not contain valid swapper_pg_dir");
208 }
209 // Everything else is optional.
210 return NULL;
211 }