Debian Codegraph @

libdrgn/program.c

raw
1 // Copyright (c) Meta Platforms, Inc. and affiliates.
2 // SPDX-License-Identifier: LGPL-2.1-or-later
3
4 #include <assert.h>
5 #include <byteswap.h>
6 #include <dirent.h>
7 #include <elf.h>
8 #include <elfutils/libdw.h>
9 #include <errno.h>
10 #include <fcntl.h>
11 #include <gelf.h>
12 #include <inttypes.h>
13 #include <limits.h>
14 #include <stdio.h>
15 #include <stdlib.h>
16 #include <string.h>
17 #include <sys/statfs.h>
18 #include <sys/types.h>
19 #include <unistd.h>
20
21 #include "cleanup.h"
22 #include "debug_info.h"
23 #include "elf_notes.h"
24 #include "error.h"
25 #include "helpers.h"
26 #include "io.h"
27 #include "language.h"
28 #include "log.h"
29 #include "linux_kernel.h"
30 #include "log.h"
31 #include "memory_reader.h"
32 #include "minmax.h"
33 #include "object.h"
34 #include "plugins.h"
35 #include "program.h"
36 #include "serialize.h"
37 #include "symbol.h"
38 #include "util.h"
39 #include "vector.h"
40
41 static inline uint32_t drgn_thread_to_key(const struct drgn_thread *entry)
42 {
43 return entry->tid;
44 }
45
46 DEFINE_HASH_TABLE_FUNCTIONS(drgn_thread_set, drgn_thread_to_key,
47 int_key_hash_pair, scalar_key_eq);
48
49 struct drgn_thread_iterator {
50 struct drgn_program *prog;
51 union {
52 /* For userspace core dumps. */
53 struct drgn_thread_set_iterator iterator;
54 struct {
55 union {
56 /* For live processes. */
57 DIR *tasks_dir;
58 /* For the Linux kernel. */
59 struct linux_helper_task_iterator task_iter;
60 };
61 /* For both live processes and the Linux kernel. */
62 struct drgn_thread entry;
63 };
64 };
65 };
66
67 LIBDRGN_PUBLIC enum drgn_program_flags
68 drgn_program_flags(struct drgn_program *prog)
69 {
70 return prog->flags;
71 }
72
73 LIBDRGN_PUBLIC const struct drgn_platform *
74 drgn_program_platform(struct drgn_program *prog)
75 {
76 return prog->has_platform ? &prog->platform : NULL;
77 }
78
79 LIBDRGN_PUBLIC struct drgn_error *
80 drgn_program_address_size(struct drgn_program *prog, uint64_t *ret)
81 {
82 if (!prog->has_platform) {
83 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
84 "program address size is not known");
85 }
86 *ret = drgn_platform_address_size(&prog->platform);
87 return NULL;
88 }
89
90 LIBDRGN_PUBLIC
91 const char *drgn_program_core_dump_path(struct drgn_program *prog)
92 {
93 return prog->core_path;
94 }
95
96 LIBDRGN_PUBLIC const struct drgn_language *
97 drgn_program_language(struct drgn_program *prog)
98 {
99 if (prog->lang)
100 return prog->lang;
101 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
102 prog->lang = &drgn_language_c;
103 return prog->lang;
104 }
105 if (!prog->tried_main_language) {
106 prog->tried_main_language = true;
107 prog->lang = drgn_debug_info_main_language(&prog->dbinfo);
108 if (prog->lang) {
109 drgn_log_debug(prog,
110 "set default language to %s from main()",
111 prog->lang->name);
112 return prog->lang;
113 } else {
114 drgn_log_debug(prog,
115 "couldn't find language of main(); defaulting to %s",
116 drgn_default_language.name);
117 }
118 }
119 return &drgn_default_language;
120 }
121
122 LIBDRGN_PUBLIC void drgn_program_set_language(struct drgn_program *prog,
123 const struct drgn_language *lang)
124 {
125 prog->lang = lang;
126 }
127
128 void drgn_program_set_platform(struct drgn_program *prog,
129 const struct drgn_platform *platform)
130 {
131 if (!prog->has_platform) {
132 prog->platform = *platform;
133 prog->has_platform = true;
134 }
135 }
136
137 void drgn_program_init(struct drgn_program *prog,
138 const struct drgn_platform *platform)
139 {
140 memset(prog, 0, sizeof(*prog));
141 drgn_memory_reader_init(&prog->reader);
142 drgn_program_init_types(prog);
143 drgn_debug_info_init(&prog->dbinfo, prog);
144 prog->core_fd = -1;
145 drgn_qmp_conn_init(&prog->qmp_conn);
146 if (platform)
147 drgn_program_set_platform(prog, platform);
148 drgn_thread_set_init(&prog->thread_set);
149 drgn_program_set_log_level(prog, DRGN_LOG_NONE);
150 drgn_program_set_log_file(prog, stderr);
151 prog->default_progress_file = true;
152 drgn_object_init(&prog->vmemmap, prog);
153 }
154
155 void drgn_program_deinit(struct drgn_program *prog)
156 {
157 drgn_thread_set_deinit(&prog->thread_set);
158 if (drgn_program_is_userspace_core(prog)) {
159 free(prog->core_dump_fname_cached);
160 } else {
161 // For userspace core dumps, main_thread and crashed_thread are
162 // in prog->thread_set and thus freed by the above call to
163 // drgn_thread_set_deinit().
164 drgn_thread_destroy(prog->crashed_thread);
165 drgn_thread_destroy(prog->main_thread);
166 }
167 if (prog->pgtable_it)
168 prog->platform.arch->linux_kernel_pgtable_iterator_destroy(prog->pgtable_it);
169
170 drgn_object_deinit(&prog->vmemmap);
171
172 drgn_handler_list_deinit(struct drgn_symbol_finder, finder,
173 &prog->symbol_finders,
174 if (finder->ops.destroy)
175 finder->ops.destroy(finder->arg);
176 );
177 drgn_handler_list_deinit(struct drgn_object_finder, finder,
178 &prog->object_finders,
179 if (finder->ops.destroy)
180 finder->ops.destroy(finder->arg);
181 );
182 drgn_program_deinit_types(prog);
183 drgn_memory_reader_deinit(&prog->reader);
184
185 free(prog->file_segments);
186 free(prog->vmcoreinfo.raw);
187 free(prog->irq_regs_cached);
188
189 drgn_qmp_conn_deinit(&prog->qmp_conn);
190 #ifdef WITH_LIBKDUMPFILE
191 if (prog->kdump_ctx)
192 kdump_free(prog->kdump_ctx);
193 #endif
194 free(prog->core_path);
195 elf_end(prog->core);
196 if (prog->core_fd != -1)
197 close(prog->core_fd);
198
199 drgn_debug_info_deinit(&prog->dbinfo);
200 }
201
202 LIBDRGN_PUBLIC struct drgn_error *
203 drgn_program_add_memory_segment(struct drgn_program *prog, uint64_t address,
204 uint64_t size, drgn_memory_read_fn read_fn,
205 void *arg, bool physical)
206 {
207 uint64_t address_mask;
208 struct drgn_error *err = drgn_program_address_mask(prog, &address_mask);
209 if (err)
210 return err;
211 if (size == 0 || address > address_mask)
212 return NULL;
213 uint64_t max_address = address + min(size - 1, address_mask - address);
214 return drgn_memory_reader_add_segment(&prog->reader, address,
215 max_address, read_fn, arg,
216 physical);
217 }
218
219 #define DRGN_PROGRAM_FINDER(which) \
220 struct drgn_error * \
221 drgn_program_register_##which##_finder_impl(struct drgn_program *prog, \
222 struct drgn_##which##_finder *finder,\
223 const char *name, \
224 const struct drgn_##which##_finder_ops *ops,\
225 void *arg, size_t enable_index) \
226 { \
227 struct drgn_error *err; \
228 if (finder) { \
229 finder->handler.name = name; \
230 finder->handler.free = false; \
231 } else { \
232 finder = malloc(sizeof(*finder)); \
233 if (!finder) \
234 return &drgn_enomem; \
235 finder->handler.name = strdup(name); \
236 if (!finder->handler.name) { \
237 free(finder); \
238 return &drgn_enomem; \
239 } \
240 finder->handler.free = true; \
241 } \
242 memcpy(&finder->ops, ops, sizeof(finder->ops)); \
243 finder->arg = arg; \
244 err = drgn_handler_list_register(&prog->which##_finders, \
245 &finder->handler, enable_index, \
246 #which " finder"); \
247 if (err && finder->handler.free) { \
248 free((char *)finder->handler.name); \
249 free(finder); \
250 } \
251 return err; \
252 } \
253 \
254 LIBDRGN_PUBLIC struct drgn_error * \
255 drgn_program_register_##which##_finder(struct drgn_program *prog, const char *name,\
256 const struct drgn_##which##_finder_ops *ops,\
257 void *arg, size_t enable_index) \
258 { \
259 return drgn_program_register_##which##_finder_impl(prog, NULL, name, \
260 ops, arg, \
261 enable_index); \
262 } \
263 \
264 LIBDRGN_PUBLIC struct drgn_error * \
265 drgn_program_registered_##which##_finders(struct drgn_program *prog, \
266 const char ***names_ret, \
267 size_t *count_ret) \
268 { \
269 return drgn_handler_list_registered(&prog->which##_finders, names_ret, \
270 count_ret); \
271 } \
272 \
273 LIBDRGN_PUBLIC struct drgn_error * \
274 drgn_program_set_enabled_##which##_finders(struct drgn_program *prog, \
275 const char * const *names, \
276 size_t count) \
277 { \
278 return drgn_handler_list_set_enabled(&prog->which##_finders, names, \
279 count, #which "finder"); \
280 } \
281 \
282 LIBDRGN_PUBLIC struct drgn_error * \
283 drgn_program_enabled_##which##_finders(struct drgn_program *prog, \
284 const char ***names_ret, \
285 size_t *count_ret) \
286 { \
287 return drgn_handler_list_enabled(&prog->which##_finders, names_ret, \
288 count_ret); \
289 }
290
291 DRGN_PROGRAM_FINDER(type)
292 DRGN_PROGRAM_FINDER(object)
293 DRGN_PROGRAM_FINDER(symbol)
294 #undef DRGN_PROGRAM_FINDER
295
296 struct drgn_error *
297 drgn_program_check_initialized(struct drgn_program *prog)
298 {
299 if (prog->core_fd != -1 || !drgn_memory_reader_empty(&prog->reader)) {
300 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
301 "program memory was already initialized");
302 }
303 return NULL;
304 }
305
306 static struct drgn_error *
307 has_kdump_signature(struct drgn_program *prog, const char *path, bool *ret)
308 {
309 char signature[max_iconst(KDUMP_SIG_LEN, FLATTENED_SIG_LEN)];
310 ssize_t r = pread_all(prog->core_fd, signature, sizeof(signature), 0);
311 if (r < 0)
312 return drgn_error_create_os("pread", errno, path);
313 *ret = false;
314 if (r >= FLATTENED_SIG_LEN
315 && memcmp(signature, FLATTENED_SIGNATURE, FLATTENED_SIG_LEN) == 0) {
316 drgn_log_warning(prog,
317 "the given file is in the makedumpfile flattened "
318 "format; if open fails or is too slow, reassemble "
319 "it with 'makedumpfile -R newfile <oldfile'");
320 *ret = true;
321 } else if (r >= KDUMP_SIG_LEN
322 && memcmp(signature, KDUMP_SIGNATURE, KDUMP_SIG_LEN) == 0)
323 *ret = true;
324 return NULL;
325 }
326
327 static struct drgn_error *
328 drgn_program_set_core_dump_fd_internal(struct drgn_program *prog, int fd,
329 const char *path)
330 {
331 struct drgn_error *err;
332 GElf_Ehdr ehdr_mem, *ehdr;
333 bool had_platform;
334 bool is_64_bit, little_endian, is_kdump;
335 size_t phnum, i;
336 size_t num_file_segments, j;
337 bool have_phys_addrs = false;
338 bool have_qemu_note = false;
339 const char *vmcoreinfo_note = NULL;
340 size_t vmcoreinfo_size = 0;
341 bool have_nt_taskstruct = false, is_proc_kcore;
342 bool have_vmcoreinfo = prog->vmcoreinfo.raw;
343 bool had_vmcoreinfo = have_vmcoreinfo;
344
345 prog->core_fd = fd;
346 prog->core_path = fd_canonical_path(fd, path);
347 if (!prog->core_path) {
348 err = &drgn_enomem;
349 goto out_fd;
350 }
351
352 err = has_kdump_signature(prog, prog->core_path, &is_kdump);
353 if (err)
354 goto out_path;
355 if (is_kdump) {
356 err = drgn_program_set_kdump(prog);
357 if (err)
358 goto out_path;
359 return NULL;
360 }
361
362 elf_version(EV_CURRENT);
363
364 prog->core = elf_begin(prog->core_fd, ELF_C_READ, NULL);
365 if (!prog->core) {
366 err = drgn_error_libelf();
367 goto out_path;
368 }
369
370 ehdr = gelf_getehdr(prog->core, &ehdr_mem);
371 if (!ehdr || ehdr->e_type != ET_CORE) {
372 err = drgn_error_format(DRGN_ERROR_INVALID_ARGUMENT,
373 "not an ELF core file");
374 goto out_elf;
375 }
376 had_platform = prog->has_platform;
377 if (!had_platform) {
378 struct drgn_platform platform;
379 drgn_platform_from_elf(ehdr, &platform);
380 drgn_program_set_platform(prog, &platform);
381 }
382 is_64_bit = ehdr->e_ident[EI_CLASS] == ELFCLASS64;
383 little_endian = ehdr->e_ident[EI_DATA] == ELFDATA2LSB;
384
385 if (elf_getphdrnum(prog->core, &phnum) != 0) {
386 err = drgn_error_libelf();
387 goto out_platform;
388 }
389
390 /*
391 * First pass: count the number of loadable segments, check if p_paddr
392 * is valid, and check for notes.
393 */
394 num_file_segments = 0;
395 for (i = 0; i < phnum; i++) {
396 GElf_Phdr phdr_mem, *phdr;
397
398 phdr = gelf_getphdr(prog->core, i, &phdr_mem);
399 if (!phdr) {
400 err = drgn_error_libelf();
401 goto out_notes;
402 }
403
404 if (phdr->p_type == PT_LOAD) {
405 if (phdr->p_paddr)
406 have_phys_addrs = true;
407 num_file_segments++;
408 } else if (phdr->p_type == PT_NOTE) {
409 Elf_Data *data;
410 size_t offset;
411 GElf_Nhdr nhdr;
412 size_t name_offset, desc_offset;
413
414 data = elf_getdata_rawchunk(prog->core, phdr->p_offset,
415 phdr->p_filesz,
416 note_header_type(phdr->p_align));
417 if (!data) {
418 err = drgn_error_libelf();
419 goto out_notes;
420 }
421
422 offset = 0;
423 while (offset < data->d_size &&
424 (offset = gelf_getnote(data, offset, &nhdr,
425 &name_offset,
426 &desc_offset))) {
427 const char *name, *desc;
428
429 name = (char *)data->d_buf + name_offset;
430 desc = (char *)data->d_buf + desc_offset;
431 if (nhdr.n_namesz == sizeof("CORE") &&
432 memcmp(name, "CORE", sizeof("CORE")) == 0) {
433 if (nhdr.n_type == NT_TASKSTRUCT)
434 have_nt_taskstruct = true;
435 } else if (nhdr.n_namesz == sizeof("LINUX") &&
436 memcmp(name, "LINUX",
437 sizeof("LINUX")) == 0) {
438 if (nhdr.n_type == NT_ARM_PAC_MASK &&
439 nhdr.n_descsz >=
440 2 * sizeof(uint64_t)) {
441 memcpy(&prog->aarch64_insn_pac_mask,
442 (uint64_t *)desc + 1,
443 sizeof(uint64_t));
444 if (little_endian !=
445 HOST_LITTLE_ENDIAN)
446 bswap_64(prog->aarch64_insn_pac_mask);
447 }
448 } else if (nhdr.n_namesz == sizeof("VMCOREINFO") &&
449 memcmp(name, "VMCOREINFO",
450 sizeof("VMCOREINFO")) == 0) {
451 vmcoreinfo_note = desc;
452 vmcoreinfo_size = nhdr.n_descsz;
453 /*
454 * This is either a vmcore or
455 * /proc/kcore, so even a p_paddr of 0
456 * may be valid.
457 */
458 have_phys_addrs = true;
459 have_vmcoreinfo = true;
460 } else if (nhdr.n_namesz == sizeof("QEMU") &&
461 memcmp(name, "QEMU",
462 sizeof("QEMU")) == 0) {
463 have_qemu_note = true;
464 }
465 }
466 }
467 }
468
469 if (have_nt_taskstruct) {
470 /*
471 * If the core file has an NT_TASKSTRUCT note and is in /proc,
472 * then it's probably /proc/kcore.
473 */
474 struct statfs fs;
475
476 if (fstatfs(prog->core_fd, &fs) == -1) {
477 err = drgn_error_create_os("fstatfs", errno,
478 prog->core_path);
479 if (err)
480 goto out_notes;
481 }
482 is_proc_kcore = fs.f_type == 0x9fa0; /* PROC_SUPER_MAGIC */
483 } else {
484 is_proc_kcore = false;
485 }
486
487 if (have_vmcoreinfo && !is_proc_kcore) {
488 char *env;
489
490 /* Use libkdumpfile for ELF vmcores if it was requested. */
491 env = getenv("DRGN_USE_LIBKDUMPFILE_FOR_ELF");
492 if (env && atoi(env)) {
493 err = drgn_program_set_kdump(prog);
494 if (err)
495 goto out_notes;
496 return NULL;
497 }
498 }
499
500 prog->file_segments = malloc_array(num_file_segments,
501 sizeof(*prog->file_segments));
502 if (!prog->file_segments) {
503 err = &drgn_enomem;
504 goto out_notes;
505 }
506
507 bool pgtable_reader =
508 (is_proc_kcore || have_vmcoreinfo) &&
509 prog->platform.arch->linux_kernel_pgtable_iterator_next;
510 if (pgtable_reader) {
511 /*
512 * Try to read any memory that isn't in the core dump via the
513 * page table.
514 */
515 err = drgn_program_add_memory_segment(prog, 0, UINT64_MAX,
516 read_memory_via_pgtable,
517 prog, false);
518 if (err)
519 goto out_segments;
520 }
521
522 /* Second pass: add the segments. */
523 for (i = 0, j = 0; i < phnum && j < num_file_segments; i++) {
524 GElf_Phdr phdr_mem, *phdr;
525
526 phdr = gelf_getphdr(prog->core, i, &phdr_mem);
527 if (!phdr) {
528 err = drgn_error_libelf();
529 goto out_segments;
530 }
531
532 if (phdr->p_type != PT_LOAD)
533 continue;
534
535 prog->file_segments[j].file_offset = phdr->p_offset;
536 prog->file_segments[j].file_size = phdr->p_filesz;
537 prog->file_segments[j].fd = prog->core_fd;
538 prog->file_segments[j].eio_is_fault = false;
539 /*
540 * p_filesz < p_memsz is ambiguous for core dumps. The ELF
541 * specification says that "if the segment's memory size p_memsz
542 * is larger than the file size p_filesz, the 'extra' bytes are
543 * defined to hold the value 0 and to follow the segment's
544 * initialized area."
545 *
546 * However, the Linux kernel generates userspace core dumps with
547 * segments with p_filesz < p_memsz to indicate that the range
548 * between p_filesz and p_memsz was filtered out (see
549 * coredump_filter in core(5)). These bytes were not necessarily
550 * zeroes in the process's memory, which contradicts the ELF
551 * specification in a way.
552 *
553 * As of Linux 5.19, /proc/kcore and /proc/vmcore never have
554 * segments with p_filesz < p_memsz. However, makedumpfile
555 * creates segments with p_filesz < p_memsz to indicate ranges
556 * that were excluded. This is similar to Linux userspace core
557 * dumps, except that makedumpfile can also exclude ranges that
558 * were all zeroes.
559 *
560 * So, for userspace core dumps, we want to fault for ranges
561 * between p_filesz and p_memsz to indicate that the memory was
562 * not saved rather than lying and returning zeroes. For
563 * /proc/kcore, we don't expect to see p_filesz < p_memsz but we
564 * fault to be safe. For Linux kernel core dumps, we can't
565 * distinguish between memory that was excluded because it was
566 * all zeroes and memory that was excluded by makedumpfile for
567 * another reason, so we're forced to always return zeroes.
568 */
569 prog->file_segments[j].zerofill = have_vmcoreinfo && !is_proc_kcore;
570 err = drgn_program_add_memory_segment(prog, phdr->p_vaddr,
571 phdr->p_memsz,
572 drgn_read_memory_file,
573 &prog->file_segments[j],
574 false);
575 if (err)
576 goto out_segments;
577 if (have_phys_addrs &&
578 phdr->p_paddr != (is_64_bit ? UINT64_MAX : UINT32_MAX)) {
579 err = drgn_program_add_memory_segment(prog,
580 phdr->p_paddr,
581 phdr->p_memsz,
582 drgn_read_memory_file,
583 &prog->file_segments[j],
584 true);
585 if (err)
586 goto out_segments;
587 }
588 j++;
589 }
590 /*
591 * Before Linux kernel commit 464920104bf7 ("/proc/kcore: update
592 * physical address for kcore ram and text") (in v4.11), p_paddr in
593 * /proc/kcore is always zero. If we know the address of the direct
594 * mapping, we can still add physical segments. This needs to be a third
595 * pass, as we may need to read virtual memory to determine the mapping.
596 */
597 if (is_proc_kcore && !have_phys_addrs &&
598 prog->platform.arch->linux_kernel_live_direct_mapping_fallback) {
599 uint64_t direct_mapping, direct_mapping_size;
600 err = prog->platform.arch->linux_kernel_live_direct_mapping_fallback(prog,
601 &direct_mapping,
602 &direct_mapping_size);
603 if (err)
604 goto out_segments;
605
606 for (i = 0, j = 0; i < phnum && j < num_file_segments; i++) {
607 GElf_Phdr phdr_mem, *phdr;
608
609 phdr = gelf_getphdr(prog->core, i, &phdr_mem);
610 if (!phdr) {
611 err = drgn_error_libelf();
612 goto out_segments;
613 }
614
615 if (phdr->p_type != PT_LOAD)
616 continue;
617
618 if (phdr->p_vaddr >= direct_mapping &&
619 phdr->p_vaddr - direct_mapping + phdr->p_memsz <=
620 direct_mapping_size) {
621 uint64_t phys_addr;
622
623 phys_addr = phdr->p_vaddr - direct_mapping;
624 err = drgn_program_add_memory_segment(prog,
625 phys_addr,
626 pgtable_reader ?
627 phdr->p_filesz :
628 phdr->p_memsz,
629 drgn_read_memory_file,
630 &prog->file_segments[j],
631 true);
632 if (err)
633 goto out_segments;
634 }
635 j++;
636 }
637 }
638 if (vmcoreinfo_note && !prog->vmcoreinfo.raw) {
639 err = drgn_program_parse_vmcoreinfo(prog, vmcoreinfo_note,
640 vmcoreinfo_size);
641 if (err)
642 goto out_segments;
643 }
644
645 if (is_proc_kcore) {
646 if (!have_vmcoreinfo) {
647 err = read_vmcoreinfo_fallback(prog);
648 if (err)
649 goto out_segments;
650 }
651 prog->flags |= (DRGN_PROGRAM_IS_LINUX_KERNEL |
652 DRGN_PROGRAM_IS_LIVE |
653 DRGN_PROGRAM_IS_LOCAL);
654 elf_end(prog->core);
655 prog->core = NULL;
656 } else if (have_vmcoreinfo) {
657 prog->flags |= DRGN_PROGRAM_IS_LINUX_KERNEL;
658 } else if (have_qemu_note) {
659 err = drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
660 "unrecognized QEMU memory dump; "
661 "for Linux guests, run QEMU with '-device vmcoreinfo', "
662 "compile the kernel with CONFIG_FW_CFG_SYSFS and CONFIG_KEXEC, "
663 "and load the qemu_fw_cfg kernel module "
664 "before dumping the guest memory "
665 "(requires Linux >= 4.17 and QEMU >= 2.11)");
666 goto out_segments;
667 }
668 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
669 err = drgn_program_finish_set_kernel(prog);
670 if (err)
671 goto out_segments;
672 }
673
674 drgn_call_plugins_prog("drgn_prog_set", prog);
675 return NULL;
676
677 out_segments:
678 drgn_memory_reader_clear(&prog->reader);
679 free(prog->file_segments);
680 prog->file_segments = NULL;
681 out_notes:
682 // Reset anything we parsed from ELF notes.
683 prog->aarch64_insn_pac_mask = 0;
684 // Free vmcoreinfo buffer if it was not provided by the caller
685 if (!had_vmcoreinfo) {
686 free(prog->vmcoreinfo.raw);
687 memset(&prog->vmcoreinfo, 0, sizeof(prog->vmcoreinfo));
688 }
689 out_platform:
690 prog->has_platform = had_platform;
691 out_elf:
692 elf_end(prog->core);
693 prog->core = NULL;
694 out_path:
695 free(prog->core_path);
696 prog->core_path = NULL;
697 out_fd:
698 close(prog->core_fd);
699 prog->core_fd = -1;
700 return err;
701 }
702
703 LIBDRGN_PUBLIC struct drgn_error *
704 drgn_program_set_core_dump_fd(struct drgn_program *prog, int fd)
705 {
706 struct drgn_error *err;
707
708 err = drgn_program_check_initialized(prog);
709 if (err)
710 return err;
711
712 return drgn_program_set_core_dump_fd_internal(prog, fd, NULL);
713 }
714
715 LIBDRGN_PUBLIC struct drgn_error *
716 drgn_program_set_core_dump(struct drgn_program *prog, const char *path)
717 {
718 struct drgn_error *err;
719
720 err = drgn_program_check_initialized(prog);
721 if (err)
722 return err;
723
724 int fd = open(path, O_RDONLY);
725 if (fd == -1)
726 return drgn_error_create_os("open", errno, path);
727
728 return drgn_program_set_core_dump_fd_internal(prog, fd, path);
729 }
730
731 LIBDRGN_PUBLIC struct drgn_error *
732 drgn_program_set_kernel(struct drgn_program *prog)
733 {
734 return drgn_program_set_core_dump(prog, "/proc/kcore");
735 }
736
737 LIBDRGN_PUBLIC struct drgn_error *
738 drgn_program_set_linux_kernel_custom(struct drgn_program *prog,
739 const char *vmcoreinfo,
740 size_t vmcoreinfo_size, bool is_live)
741 {
742 struct drgn_error *err;
743
744 if (!prog->has_platform) {
745 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
746 "platform must be set before calling set_linux_kernel_custom()");
747 }
748
749 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)
750 return NULL;
751
752 // Parse vmcoreinfo if not already set via Program constructor
753 bool had_vmcoreinfo = prog->vmcoreinfo.raw != NULL;
754 if (!had_vmcoreinfo) {
755 err = drgn_program_parse_vmcoreinfo(prog, vmcoreinfo,
756 vmcoreinfo_size);
757 if (err)
758 return err;
759 }
760
761 /*
762 * Register a virtual memory reader that uses page table walking.
763 * This translates virtual addresses to physical using swapper_pg_dir
764 * from vmcoreinfo, then reads physical memory from user-registered
765 * segments.
766 */
767 if (prog->platform.arch->linux_kernel_pgtable_iterator_next) {
768 err = drgn_program_add_memory_segment(prog, 0, UINT64_MAX,
769 read_memory_via_pgtable,
770 prog, false);
771 if (err)
772 goto out_vmcoreinfo;
773 }
774
775 enum drgn_program_flags old_flags = prog->flags;
776 prog->flags |= DRGN_PROGRAM_IS_LINUX_KERNEL;
777 if (is_live)
778 prog->flags |= DRGN_PROGRAM_IS_LIVE;
779
780 err = drgn_program_finish_set_kernel(prog);
781 if (err) {
782 prog->flags = old_flags;
783 drgn_memory_reader_clear_virtual(&prog->reader);
784 goto out_vmcoreinfo;
785 }
786
787 drgn_call_plugins_prog("drgn_prog_set", prog);
788 return NULL;
789
790 out_vmcoreinfo:
791 // Free vmcoreinfo buffer if it was not provided by the caller
792 if (!had_vmcoreinfo) {
793 free(prog->vmcoreinfo.raw);
794 memset(&prog->vmcoreinfo, 0, sizeof(prog->vmcoreinfo));
795 }
796 return err;
797 }
798
799 LIBDRGN_PUBLIC struct drgn_error *
800 drgn_program_set_pid(struct drgn_program *prog, pid_t pid)
801 {
802 struct drgn_error *err;
803
804 err = drgn_program_check_initialized(prog);
805 if (err)
806 return err;
807
808 #define FORMAT "/proc/%ld/mem"
809 char buf[sizeof(FORMAT) - sizeof("%ld") + max_decimal_length(long) + 1];
810 snprintf(buf, sizeof(buf), FORMAT, (long)pid);
811 #undef FORMAT
812 prog->core_fd = open(buf, O_RDONLY);
813 if (prog->core_fd == -1)
814 return drgn_error_create_os("open", errno, buf);
815
816 bool had_platform = prog->has_platform;
817 drgn_program_set_platform(prog, &drgn_host_platform);
818
819 prog->file_segments = malloc(sizeof(*prog->file_segments));
820 if (!prog->file_segments) {
821 err = &drgn_enomem;
822 goto out_fd;
823 }
824 prog->file_segments[0].file_offset = 0;
825 prog->file_segments[0].file_size = UINT64_MAX;
826 prog->file_segments[0].fd = prog->core_fd;
827 prog->file_segments[0].eio_is_fault = true;
828 prog->file_segments[0].zerofill = false;
829 err = drgn_program_add_memory_segment(prog, 0, UINT64_MAX,
830 drgn_read_memory_file,
831 prog->file_segments, false);
832 if (err)
833 goto out_segments;
834
835 prog->pid = pid;
836 prog->flags |= DRGN_PROGRAM_IS_LIVE | DRGN_PROGRAM_IS_LOCAL;
837
838 drgn_call_plugins_prog("drgn_prog_set", prog);
839 return NULL;
840
841 out_segments:
842 drgn_memory_reader_clear(&prog->reader);
843 free(prog->file_segments);
844 prog->file_segments = NULL;
845 out_fd:
846 prog->has_platform = had_platform;
847 close(prog->core_fd);
848 prog->core_fd = -1;
849 return err;
850 }
851
852 #ifndef WITH_JSON_C
853 LIBDRGN_PUBLIC struct drgn_error *
854 drgn_program_set_qemu_qmp_fd(struct drgn_program *prog, int fd)
855 {
856 close(fd);
857 return drgn_error_create(DRGN_ERROR_NOT_IMPLEMENTED,
858 "drgn was not built with json-c");
859 }
860
861 LIBDRGN_PUBLIC struct drgn_error *
862 drgn_program_set_qemu_qmp(struct drgn_program *prog, const char *address)
863 {
864 return drgn_error_create(DRGN_ERROR_NOT_IMPLEMENTED,
865 "drgn was not built with json-c");
866 }
867 #endif
868
869 struct drgn_error *drgn_program_cache_auxv(struct drgn_program *prog)
870 {
871 if (prog->auxv_cached)
872 return NULL;
873
874 _cleanup_close_ int fd = -1;
875 const void *note;
876 size_t note_size;
877 #define FORMAT "/proc/%ld/auxv"
878 char path[sizeof(FORMAT)
879 - sizeof("%ld")
880 + max_decimal_length(long)
881 + 1];
882 if (drgn_program_is_userspace_process(prog)) {
883 snprintf(path, sizeof(path), FORMAT, (long)prog->pid);
884 #undef FORMAT
885 fd = open(path, O_RDONLY);
886 if (fd < 0)
887 return drgn_error_create_os("open", errno, path);
888 drgn_log_debug(prog, "parsing %s", path);
889 } else {
890 assert(drgn_program_is_userspace_core(prog));
891 if (find_elf_note(prog->core, "CORE", NT_AUXV, &note,
892 &note_size))
893 return drgn_error_libelf();
894 if (!note) {
895 return drgn_error_create(DRGN_ERROR_OTHER,
896 "core file is missing NT_AUXV");
897 }
898 drgn_log_debug(prog, "parsing NT_AUXV");
899 }
900
901 memset(&prog->auxv, 0, sizeof(prog->auxv));
902
903 bool is_64_bit = drgn_platform_is_64_bit(&prog->platform);
904 bool bswap = drgn_platform_bswap(&prog->platform);
905 size_t aux_size = is_64_bit ? 16 : 8;
906 #define visit_aux_members(visit_scalar_member, visit_raw_member) do { \
907 visit_scalar_member(a_type); \
908 visit_scalar_member(a_un.a_val); \
909 } while (0)
910 for (;;) {
911 Elf64_auxv_t auxv;
912 if (fd >= 0) {
913 ssize_t r = read_all(fd, &auxv, aux_size);
914 if (r < 0)
915 return drgn_error_create_os("read", errno, path);
916 if (r < aux_size)
917 break;
918 deserialize_struct64_inplace(&auxv, Elf32_auxv_t,
919 visit_aux_members,
920 is_64_bit, bswap);
921 } else {
922 if (note_size < aux_size)
923 break;
924 deserialize_struct64(&auxv, Elf32_auxv_t,
925 visit_aux_members, note, is_64_bit,
926 bswap);
927 note = (char *)note + aux_size;
928 note_size -= aux_size;
929 }
930 if (auxv.a_type == 0 && auxv.a_un.a_val == 0)
931 break;
932 switch (auxv.a_type) {
933 case AT_PHDR:
934 drgn_log_debug(prog, "found AT_PHDR 0x%" PRIx64,
935 auxv.a_un.a_val);
936 prog->auxv.at_phdr = auxv.a_un.a_val;
937 break;
938 case AT_PHNUM:
939 drgn_log_debug(prog, "found AT_PHNUM %" PRIu64,
940 auxv.a_un.a_val);
941 prog->auxv.at_phnum = auxv.a_un.a_val;
942 break;
943 case AT_SYSINFO_EHDR:
944 drgn_log_debug(prog, "found AT_SYSINFO_EHDR 0x%" PRIx64,
945 auxv.a_un.a_val);
946 prog->auxv.at_sysinfo_ehdr = auxv.a_un.a_val;
947 break;
948 }
949 }
950 #undef visit_aux_members
951 prog->auxv_cached = true;
952 return NULL;
953 }
954
955 static struct drgn_error *get_prstatus_pid(struct drgn_program *prog, const char *data,
956 size_t size, uint32_t *ret)
957 {
958 bool is_64_bit, bswap;
959 struct drgn_error *err = drgn_program_is_64_bit(prog, &is_64_bit);
960 if (err)
961 return err;
962 err = drgn_program_bswap(prog, &bswap);
963 if (err)
964 return err;
965
966 size_t offset = is_64_bit ? 32 : 24;
967 uint32_t pr_pid;
968 if (size < offset + sizeof(pr_pid)) {
969 return drgn_error_create(DRGN_ERROR_OTHER,
970 "NT_PRSTATUS is truncated");
971 }
972 memcpy(&pr_pid, data + offset, sizeof(pr_pid));
973 if (bswap)
974 pr_pid = bswap_32(pr_pid);
975 *ret = pr_pid;
976 return NULL;
977 }
978
979 static struct drgn_error *get_prpsinfo_pid(struct drgn_program *prog,
980 const char *data, size_t size,
981 uint32_t *ret)
982 {
983 bool is_64_bit, bswap;
984 struct drgn_error *err = drgn_program_is_64_bit(prog, &is_64_bit);
985 if (err)
986 return err;
987 err = drgn_program_bswap(prog, &bswap);
988 if (err)
989 return err;
990
991 size_t offset = is_64_bit ? 24 : 12;
992 uint32_t pr_pid;
993 if (size < offset + sizeof(pr_pid)) {
994 return drgn_error_create(DRGN_ERROR_OTHER,
995 "NT_PRPSINFO is truncated");
996 }
997 memcpy(&pr_pid, data + offset, sizeof(pr_pid));
998 if (bswap)
999 pr_pid = bswap_32(pr_pid);
1000 *ret = pr_pid;
1001 return NULL;
1002 }
1003
1004 static struct drgn_error *get_prpsinfo_fname(struct drgn_program *prog,
1005 const char *data, size_t size,
1006 char **ret)
1007 {
1008 bool is_64_bit;
1009 struct drgn_error *err = drgn_program_is_64_bit(prog, &is_64_bit);
1010 if (err)
1011 return err;
1012 size_t offset = is_64_bit ? 40 : 28;
1013 // pr_fname is defined as 16 byte buffer in elf_prpsinfo
1014 // https://github.com/torvalds/linux/blob/075dbe9f6e3c21596c5245826a4ee1f1c1676eb8/include/linux/elfcore.h#L73
1015 #define PR_FNAME_LEN 16
1016 if (size < offset + PR_FNAME_LEN) {
1017 return drgn_error_create(DRGN_ERROR_OTHER,
1018 "NT_PRPSINFO is truncated");
1019 }
1020 char *tmp = strndup(data + offset, PR_FNAME_LEN);
1021 #undef PR_FNAME_LEN
1022 if (!tmp)
1023 return &drgn_enomem;
1024 *ret = tmp;
1025 return NULL;
1026 }
1027
1028 struct drgn_error *drgn_thread_dup_internal(const struct drgn_thread *thread,
1029 struct drgn_thread *ret)
1030 {
1031 struct drgn_error *err = NULL;
1032 ret->prog = thread->prog;
1033 ret->tid = thread->tid;
1034 /* Don't need a deep copy here since the PRSTATUS notes are cached. */
1035 ret->prstatus = thread->prstatus;
1036 if (thread->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1037 drgn_object_init(&ret->object, thread->prog);
1038 err = drgn_object_copy(&ret->object, &thread->object);
1039 if (err)
1040 drgn_object_deinit(&ret->object);
1041 }
1042 return err;
1043 }
1044
1045 LIBDRGN_PUBLIC struct drgn_error *
1046 drgn_thread_dup(const struct drgn_thread *thread, struct drgn_thread **ret)
1047 {
1048 if (drgn_program_is_userspace_core(thread->prog)) {
1049 /*
1050 * For userspace core dumps, all threads are cached and
1051 * immutable, so we can return the same handle.
1052 */
1053 *ret = (struct drgn_thread *)thread;
1054 return NULL;
1055 }
1056
1057 *ret = malloc(sizeof(**ret));
1058 if (!*ret)
1059 return &drgn_enomem;
1060 struct drgn_error *err = drgn_thread_dup_internal(thread, *ret);
1061 if (err)
1062 free(*ret);
1063 return err;
1064 }
1065
1066 void drgn_thread_deinit(struct drgn_thread *thread) {
1067 if (thread->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)
1068 drgn_object_deinit(&thread->object);
1069 }
1070
1071 LIBDRGN_PUBLIC void drgn_thread_destroy(struct drgn_thread *thread)
1072 {
1073 if (thread) {
1074 drgn_thread_deinit(thread);
1075 if (!drgn_program_is_userspace_core(thread->prog))
1076 free(thread);
1077 }
1078 }
1079
1080 struct drgn_error *drgn_program_cache_prstatus_entry(struct drgn_program *prog,
1081 const char *data,
1082 size_t size, uint32_t *ret)
1083 {
1084 struct drgn_thread thread = {
1085 .prog = prog,
1086 .prstatus = { data, size },
1087 };
1088 struct drgn_error *err = get_prstatus_pid(prog, data, size,
1089 &thread.tid);
1090 if (err)
1091 return err;
1092 *ret = thread.tid;
1093 if (drgn_thread_set_insert(&prog->thread_set, &thread, NULL) == -1)
1094 return &drgn_enomem;
1095 return NULL;
1096 }
1097
1098 static struct drgn_error *
1099 drgn_program_cache_core_dump_threads(struct drgn_program *prog)
1100 {
1101 struct drgn_error *err;
1102 size_t phnum, i;
1103 bool found_prstatus = false;
1104 uint32_t first_prstatus_tid;
1105 bool found_prpsinfo = false;
1106 uint32_t prpsinfo_pid;
1107 _cleanup_free_ char *prpsinfo_fname = NULL;
1108
1109 if (prog->core_dump_threads_cached)
1110 return NULL;
1111
1112 assert(!(prog->flags & DRGN_PROGRAM_IS_LIVE));
1113
1114 #ifdef WITH_LIBKDUMPFILE
1115 if (prog->kdump_ctx) {
1116 err = drgn_program_cache_kdump_threads(prog);
1117 if (err)
1118 goto err;
1119 goto out;
1120 }
1121 #endif
1122 if (!prog->core) {
1123 err = NULL;
1124 goto out;
1125 }
1126 if (elf_getphdrnum(prog->core, &phnum) != 0) {
1127 err = drgn_error_libelf();
1128 goto err;
1129 }
1130 for (i = 0; i < phnum; i++) {
1131 GElf_Phdr phdr_mem, *phdr;
1132 Elf_Data *data;
1133 size_t offset;
1134 GElf_Nhdr nhdr;
1135 size_t name_offset, desc_offset;
1136
1137 phdr = gelf_getphdr(prog->core, i, &phdr_mem);
1138 if (!phdr) {
1139 err = drgn_error_libelf();
1140 goto err;
1141 }
1142 if (phdr->p_type != PT_NOTE)
1143 continue;
1144
1145 data = elf_getdata_rawchunk(prog->core, phdr->p_offset,
1146 phdr->p_filesz,
1147 note_header_type(phdr->p_align));
1148 if (!data) {
1149 err = drgn_error_libelf();
1150 goto err;
1151 }
1152
1153 offset = 0;
1154 while (offset < data->d_size &&
1155 (offset = gelf_getnote(data, offset, &nhdr, &name_offset,
1156 &desc_offset))) {
1157 const char *name;
1158
1159 name = (char *)data->d_buf + name_offset;
1160 if (strncmp(name, "CORE", nhdr.n_namesz) != 0)
1161 continue;
1162
1163 if (nhdr.n_type == NT_PRPSINFO) {
1164 err = get_prpsinfo_pid(prog,
1165 (char *)data->d_buf + desc_offset,
1166 nhdr.n_descsz,
1167 &prpsinfo_pid);
1168 if (err)
1169 goto err;
1170 err = get_prpsinfo_fname(prog,
1171 (char *)data->d_buf + desc_offset,
1172 nhdr.n_descsz,
1173 &prpsinfo_fname);
1174 if (err)
1175 goto err;
1176 found_prpsinfo = true;
1177 } else if (nhdr.n_type == NT_PRSTATUS) {
1178 uint32_t tid;
1179 err = drgn_program_cache_prstatus_entry(prog,
1180 (char *)data->d_buf + desc_offset,
1181 nhdr.n_descsz,
1182 &tid);
1183 if (err)
1184 goto err;
1185 /*
1186 * The first PRSTATUS note is the crashed thread. See
1187 * fs/binfmt_elf.c:fill_note_info in the Linux kernel
1188 * and bfd/elf.c:elfcore_grok_prstatus in BFD.
1189 */
1190 if (!found_prstatus) {
1191 found_prstatus = true;
1192 first_prstatus_tid = tid;
1193 }
1194 }
1195 }
1196 }
1197
1198 out:
1199 prog->core_dump_threads_cached = true;
1200 if (!(prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)) {
1201 if (found_prpsinfo) {
1202 struct drgn_thread_set_iterator it =
1203 drgn_thread_set_search(&prog->thread_set,
1204 &prpsinfo_pid);
1205 /* If the PID isn't found, then this is NULL. */
1206 prog->main_thread = it.entry;
1207 prog->core_dump_fname_cached = no_cleanup_ptr(prpsinfo_fname);
1208 }
1209 if (found_prstatus) {
1210 /*
1211 * Now that thread_set won't be modified, look up the crashed
1212 * thread entry.
1213 */
1214 struct drgn_thread_set_iterator it =
1215 drgn_thread_set_search(&prog->thread_set,
1216 &first_prstatus_tid);
1217 assert(it.entry);
1218 prog->crashed_thread = it.entry;
1219 }
1220 }
1221 return NULL;
1222
1223 err:
1224 drgn_thread_set_deinit(&prog->thread_set);
1225 drgn_thread_set_init(&prog->thread_set);
1226 return err;
1227 }
1228
1229 static struct drgn_error *
1230 drgn_thread_iterator_init_linux_kernel(struct drgn_thread_iterator *it)
1231 {
1232 struct drgn_error *err = linux_helper_task_iterator_init(&it->task_iter,
1233 it->prog);
1234 if (err)
1235 return err;
1236 drgn_object_init(&it->entry.object, it->prog);
1237 it->entry.prstatus = (struct nstring){};
1238 return NULL;
1239 }
1240
1241 static struct drgn_error *
1242 drgn_thread_iterator_init_userspace_process(struct drgn_thread_iterator *it)
1243 {
1244 #define FORMAT "/proc/%ld/task"
1245 char path[sizeof(FORMAT)
1246 - sizeof("%ld")
1247 + max_decimal_length(long)
1248 + 1];
1249 snprintf(path, sizeof(path), FORMAT, (long)it->prog->pid);
1250 #undef FORMAT
1251 it->tasks_dir = opendir(path);
1252 if (!it->tasks_dir)
1253 return drgn_error_create_os("opendir", errno, path);
1254 it->entry.prog = it->prog;
1255 it->entry.prstatus = (struct nstring){};
1256 return NULL;
1257 }
1258
1259 static struct drgn_error *
1260 drgn_thread_iterator_init_userspace_core(struct drgn_thread_iterator *it)
1261 {
1262 struct drgn_error *err = drgn_program_cache_core_dump_threads(it->prog);
1263 if (err)
1264 return err;
1265 it->iterator = drgn_thread_set_first(&it->prog->thread_set);
1266 return NULL;
1267 }
1268
1269 LIBDRGN_PUBLIC struct drgn_error *
1270 drgn_thread_iterator_create(struct drgn_program *prog,
1271 struct drgn_thread_iterator **ret)
1272 {
1273 struct drgn_error *err;
1274
1275 *ret = malloc(sizeof(**ret));
1276 if (!*ret)
1277 return &drgn_enomem;
1278 (*ret)->prog = prog;
1279 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)
1280 err = drgn_thread_iterator_init_linux_kernel(*ret);
1281 else if (drgn_program_is_userspace_process(prog))
1282 err = drgn_thread_iterator_init_userspace_process(*ret);
1283 else if (drgn_program_is_userspace_core(prog))
1284 err = drgn_thread_iterator_init_userspace_core(*ret);
1285 else
1286 err = NULL;
1287 if (err)
1288 free(*ret);
1289 return err;
1290 }
1291
1292 LIBDRGN_PUBLIC void
1293 drgn_thread_iterator_destroy(struct drgn_thread_iterator *it)
1294 {
1295 if (it) {
1296 if (it->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1297 drgn_object_deinit(&it->entry.object);
1298 linux_helper_task_iterator_deinit(&it->task_iter);
1299 } else if (drgn_program_is_userspace_process(it->prog)) {
1300 closedir(it->tasks_dir);
1301 }
1302 free(it);
1303 }
1304 }
1305
1306 static struct drgn_error *
1307 drgn_thread_iterator_next_linux_kernel(struct drgn_thread_iterator *it,
1308 struct drgn_thread **ret)
1309 {
1310 struct drgn_error *err;
1311 err = linux_helper_task_iterator_next(&it->task_iter,
1312 &it->entry.object);
1313 if (err == &drgn_stop) {
1314 *ret = NULL;
1315 return NULL;
1316 } else if (err) {
1317 return err;
1318 }
1319 it->entry.prog = drgn_object_program(&it->entry.object);
1320 union drgn_value tid_value;
1321 DRGN_OBJECT(tid, drgn_object_program(&it->entry.object));
1322 err = drgn_object_member_dereference(&tid, &it->entry.object, "pid");
1323 if (!err)
1324 err = drgn_object_read_integer(&tid, &tid_value);
1325 if (err)
1326 return err;
1327 it->entry.tid = tid_value.uvalue;
1328 *ret = &it->entry;
1329 return NULL;
1330 }
1331
1332 static struct drgn_error *
1333 drgn_thread_iterator_next_userspace_process(struct drgn_thread_iterator *it,
1334 struct drgn_thread **ret)
1335 {
1336 struct dirent *task;
1337 unsigned long tid;
1338 char *end;
1339 do {
1340 errno = 0;
1341 task = readdir(it->tasks_dir);
1342 if (!task) {
1343 if (errno) {
1344 return drgn_error_create_os("readdir", errno,
1345 NULL);
1346 }
1347 *ret = NULL;
1348 return NULL;
1349 }
1350
1351 errno = 0;
1352 tid = strtoul(task->d_name, &end, 10);
1353 /*
1354 * Skip anything that isn't a number (like "." and "..") or
1355 * overflows (which is impossible normally).
1356 */
1357 } while (*end != '\0' || (tid == ULONG_MAX && errno == ERANGE));
1358 it->entry.tid = tid;
1359 *ret = &it->entry;
1360 return NULL;
1361 }
1362
1363 static void
1364 drgn_thread_iterator_next_userspace_core(struct drgn_thread_iterator *it,
1365 struct drgn_thread **ret)
1366 {
1367 *ret = it->iterator.entry;
1368 if (it->iterator.entry)
1369 it->iterator = drgn_thread_set_next(it->iterator);
1370 }
1371
1372 LIBDRGN_PUBLIC struct drgn_error *
1373 drgn_thread_iterator_next(struct drgn_thread_iterator *it,
1374 struct drgn_thread **ret)
1375 {
1376 if (it->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1377 return drgn_thread_iterator_next_linux_kernel(it, ret);
1378 } else if (drgn_program_is_userspace_process(it->prog)) {
1379 return drgn_thread_iterator_next_userspace_process(it, ret);
1380 } else if (drgn_program_is_userspace_core(it->prog)) {
1381 drgn_thread_iterator_next_userspace_core(it, ret);
1382 return NULL;
1383 } else {
1384 *ret = NULL;
1385 return NULL;
1386 }
1387 }
1388
1389 static struct drgn_error *
1390 drgn_program_find_thread_linux_kernel(struct drgn_program *prog, uint32_t tid,
1391 struct drgn_thread **ret)
1392 {
1393 struct drgn_error *err;
1394
1395 *ret = malloc(sizeof(**ret));
1396 if (!*ret)
1397 return &drgn_enomem;
1398 (*ret)->prog = prog;
1399 (*ret)->tid = tid;
1400 (*ret)->prstatus = (struct nstring){};
1401
1402 struct drgn_object *object = &(*ret)->object;
1403 drgn_object_init(object, prog);
1404 err = drgn_program_find_object(prog, "init_pid_ns", NULL,
1405 DRGN_FIND_OBJECT_VARIABLE, object);
1406 if (err)
1407 goto err;
1408 err = drgn_object_address_of(object, object);
1409 if (err)
1410 goto err;
1411 err = linux_helper_find_task(object, object, tid);
1412 if (err)
1413 goto err;
1414 bool truthy;
1415 err = drgn_object_bool(object, &truthy);
1416 if (err)
1417 goto err;
1418 if (!truthy) {
1419 drgn_thread_destroy(*ret);
1420 *ret = NULL;
1421 }
1422 return NULL;
1423
1424 err:
1425 drgn_thread_destroy(*ret);
1426 return err;
1427 }
1428
1429 static struct drgn_error *
1430 drgn_program_find_thread_userspace_process(struct drgn_program *prog,
1431 uint32_t tid,
1432 struct drgn_thread **ret)
1433 {
1434 #define FORMAT "/proc/%ld/task/%" PRIu32
1435 char path[sizeof(FORMAT)
1436 - sizeof("%ld%" PRIu32)
1437 + max_decimal_length(long)
1438 + max_decimal_length(uint32_t)
1439 + 1];
1440 snprintf(path, sizeof(path), FORMAT, (long)prog->pid, tid);
1441 #undef FORMAT
1442 int r = access(path, F_OK);
1443 if (r == 0) {
1444 *ret = malloc(sizeof(**ret));
1445 if (!*ret)
1446 return &drgn_enomem;
1447 (*ret)->prog = prog;
1448 (*ret)->tid = tid;
1449 (*ret)->prstatus = (struct nstring){};
1450 return NULL;
1451 } else if (errno == ENOENT) {
1452 *ret = NULL;
1453 return NULL;
1454 } else {
1455 return drgn_error_create_os("access", errno, path);
1456 }
1457 }
1458
1459 static struct drgn_error *
1460 drgn_program_find_thread_userspace_core(struct drgn_program *prog, uint32_t tid,
1461 struct drgn_thread **ret)
1462 {
1463 struct drgn_error *err = drgn_program_cache_core_dump_threads(prog);
1464 if (err)
1465 return err;
1466 *ret = drgn_thread_set_search(&prog->thread_set, &tid).entry;
1467 return NULL;
1468 }
1469
1470 LIBDRGN_PUBLIC struct drgn_error *
1471 drgn_program_find_thread(struct drgn_program *prog, uint32_t tid,
1472 struct drgn_thread **ret)
1473 {
1474 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1475 return drgn_program_find_thread_linux_kernel(prog, tid, ret);
1476 } else if (drgn_program_is_userspace_process(prog)) {
1477 return drgn_program_find_thread_userspace_process(prog, tid,
1478 ret);
1479 } else if (drgn_program_is_userspace_core(prog)) {
1480 return drgn_program_find_thread_userspace_core(prog, tid, ret);
1481 } else {
1482 *ret = NULL;
1483 return NULL;
1484 }
1485 }
1486
1487 // Get the CPU that crashed in a Linux kernel core dump.
1488 static struct drgn_error *
1489 drgn_program_kernel_get_crashed_cpu(struct drgn_program *prog, uint64_t *ret)
1490 {
1491 struct drgn_error *err;
1492 DRGN_OBJECT(cpu, prog);
1493 union drgn_value cpu_value;
1494
1495 // Since Linux kernel commit 1717f2096b54 ("panic, x86: Fix re-entrance
1496 // problem due to panic on NMI") (in v4.5), the crashed CPU is stored in
1497 // an atomic_t panic_cpu on all architectures.
1498 err = drgn_program_find_object(prog, "panic_cpu", NULL,
1499 DRGN_FIND_OBJECT_VARIABLE, &cpu);
1500 if (!err) {
1501 err = drgn_object_member(&cpu, &cpu, "counter");
1502 if (err)
1503 return err;
1504 err = drgn_object_read_integer(&cpu, &cpu_value);
1505 if (err)
1506 return err;
1507 if (cpu_value.svalue == -1) {
1508 return drgn_error_create(DRGN_ERROR_LOOKUP,
1509 "panic_cpu is not set");
1510 }
1511 *ret = cpu_value.uvalue;
1512 } else if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
1513 // On x86 and x86-64 only, the crashed CPU is also in an int
1514 // crashing_cpu. Use this as a fallback for kernels before
1515 // commit 1717f2096b54 ("panic, x86: Fix re-entrance problem due
1516 // to panic on NMI") (in v4.5).
1517 err = drgn_program_find_object(prog, "crashing_cpu", NULL,
1518 DRGN_FIND_OBJECT_VARIABLE, &cpu);
1519 if (!err) {
1520 err = drgn_object_read_integer(&cpu, &cpu_value);
1521 if (err)
1522 return err;
1523 // Since Linux kernel commit 5bc329503e81 ("x86/mce:
1524 // Handle broadcasted MCE gracefully with kexec") (in
1525 // v4.12), crashing_cpu is defined in !SMP kernels, but
1526 // it's always -1.
1527 if (cpu_value.svalue == -1)
1528 *ret = 0;
1529 else
1530 *ret = cpu_value.uvalue;
1531 } else if (drgn_error_catch(&err, DRGN_ERROR_LOOKUP)) {
1532 // Before Linux kernel commit 5bc329503e81 ("x86/mce:
1533 // Handle broadcasted MCE gracefully with kexec") (in
1534 // v4.12), crashing_cpu is only defined in SMP kernels.
1535 *ret = 0;
1536 }
1537 }
1538 return err;
1539 }
1540
1541 static struct drgn_error *
1542 drgn_program_find_thread_kernel_cpu_curr(struct drgn_program *prog,
1543 uint64_t cpu,
1544 struct drgn_thread **ret)
1545 {
1546 struct drgn_error *err;
1547 struct drgn_thread *thread = malloc(sizeof(*thread));
1548 if (!thread)
1549 return &drgn_enomem;
1550 thread->prog = prog;
1551
1552 DRGN_OBJECT(tmp, prog);
1553 drgn_object_init(&thread->object, prog);
1554
1555 err = linux_helper_cpu_curr(&thread->object, cpu);
1556 if (err)
1557 goto out;
1558
1559 err = drgn_object_member_dereference(&tmp, &thread->object, "pid");
1560 if (err)
1561 goto out;
1562 union drgn_value tid;
1563 err = drgn_object_read_integer(&tmp, &tid);
1564 if (err)
1565 goto out;
1566 thread->tid = tid.uvalue;
1567 thread->prstatus = (struct nstring){};
1568
1569 *ret = thread;
1570
1571 out:
1572 if (err) {
1573 drgn_object_deinit(&thread->object);
1574 free(thread);
1575 }
1576 return err;
1577 }
1578
1579 static struct drgn_error *
1580 drgn_program_kernel_core_dump_cache_crashed_thread(struct drgn_program *prog)
1581 {
1582 struct drgn_error *err;
1583
1584 assert((prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) &&
1585 !(prog->flags & DRGN_PROGRAM_IS_LIVE));
1586 if (prog->crashed_thread)
1587 return NULL;
1588
1589 uint64_t crashed_cpu;
1590 err = drgn_program_kernel_get_crashed_cpu(prog, &crashed_cpu);
1591 if (err)
1592 return err;
1593
1594 err = drgn_program_find_thread_kernel_cpu_curr(prog, crashed_cpu,
1595 &prog->crashed_thread);
1596 if (err) {
1597 prog->crashed_thread = NULL;
1598 return err;
1599 }
1600 return NULL;
1601 }
1602
1603 LIBDRGN_PUBLIC struct drgn_error *
1604 drgn_program_main_thread(struct drgn_program *prog, struct drgn_thread **ret)
1605 {
1606 struct drgn_error *err;
1607
1608 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1609 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
1610 "main thread is not defined for the Linux kernel");
1611 }
1612 if (drgn_program_is_userspace_process(prog)) {
1613 if (!prog->main_thread) {
1614 err = drgn_program_find_thread(prog, prog->pid,
1615 &prog->main_thread);
1616 if (err) {
1617 prog->main_thread = NULL;
1618 return err;
1619 }
1620 }
1621 } else if (drgn_program_is_userspace_core(prog)) {
1622 err = drgn_program_cache_core_dump_threads(prog);
1623 if (err)
1624 return err;
1625 }
1626 if (!prog->main_thread) {
1627 return drgn_error_create(DRGN_ERROR_OTHER,
1628 "main thread not found");
1629 }
1630 *ret = prog->main_thread;
1631 return NULL;
1632 }
1633
1634 LIBDRGN_PUBLIC struct drgn_error *
1635 drgn_program_crashed_thread(struct drgn_program *prog, struct drgn_thread **ret)
1636 {
1637 struct drgn_error *err;
1638
1639 if (prog->flags & DRGN_PROGRAM_IS_LIVE) {
1640 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
1641 "crashed thread is only defined for core dumps");
1642 }
1643 if (prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)
1644 err = drgn_program_kernel_core_dump_cache_crashed_thread(prog);
1645 else if (drgn_program_is_userspace_core(prog))
1646 err = drgn_program_cache_core_dump_threads(prog);
1647 else
1648 err = NULL;
1649 if (err)
1650 return err;
1651 if (!prog->crashed_thread) {
1652 return drgn_error_create(DRGN_ERROR_OTHER,
1653 "crashed thread not found");
1654 }
1655 *ret = prog->crashed_thread;
1656 return NULL;
1657 }
1658
1659 LIBDRGN_PUBLIC struct drgn_error *
1660 drgn_thread_object(struct drgn_thread *thread, const struct drgn_object **ret)
1661 {
1662 if (!(thread->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL)) {
1663 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
1664 "thread object is currently only defined for the Linux kernel");
1665 }
1666 *ret = &thread->object;
1667 return NULL;
1668 }
1669
1670 static struct drgn_error *
1671 drgn_thread_name_linux_kernel(struct drgn_thread *thread, char **ret)
1672 {
1673 struct drgn_error *err;
1674 DRGN_OBJECT(comm, drgn_object_program(&thread->object));
1675 err = drgn_object_member_dereference(&comm, &thread->object, "comm");
1676 if (!err)
1677 err = drgn_object_read_c_string(&comm, ret);
1678 return err;
1679 }
1680
1681 static struct drgn_error *
1682 drgn_thread_name_userspace_process(struct drgn_thread *thread, char **ret)
1683 {
1684 #define FORMAT "/proc/%" PRIu32 "/comm"
1685 char path[sizeof(FORMAT)
1686 - sizeof("%" PRIu32)
1687 + max_decimal_length(uint32_t)
1688 + 1];
1689 snprintf(path, sizeof(path), FORMAT, thread->tid);
1690 #undef FORMAT
1691 _cleanup_close_ int fd = open(path, O_RDONLY);
1692 if (fd < 0)
1693 return drgn_error_create_os("open", errno, path);
1694 // While userspace threads use 16 byte buffer, kernel threads use a 64 byte buffer
1695 // https://github.com/torvalds/linux/blob/075dbe9f6e3c21596c5245826a4ee1f1c1676eb8/fs/proc/array.c#L101
1696 char buf[64];
1697 ssize_t bytes_read = read_all(fd, buf, sizeof(buf));
1698 if (bytes_read < 0)
1699 return drgn_error_create_os("read", errno, path);
1700
1701 if (bytes_read > 0 && buf[bytes_read - 1] == '\n')
1702 bytes_read--;
1703 char *tmp = strndup(buf, bytes_read);
1704 if (!tmp)
1705 return &drgn_enomem;
1706 *ret = tmp;
1707 return NULL;
1708 }
1709
1710 static struct drgn_error *
1711 drgn_thread_name_userspace_core(struct drgn_thread *thread, char **ret)
1712 {
1713 struct drgn_error *err = drgn_program_cache_core_dump_threads(thread->prog);
1714 if (err)
1715 return err;
1716 // Core dumps only contain the main thread name so check if this is the main thread.
1717 // Otherwise, set ret to NULL which will return None in Python.
1718 bool is_main_thread = thread->prog->main_thread && thread->prog->main_thread->tid == thread->tid;
1719 if (is_main_thread && thread->prog->core_dump_fname_cached) {
1720 char *tmp = strdup(thread->prog->core_dump_fname_cached);
1721 if (!tmp)
1722 return &drgn_enomem;
1723 *ret = tmp;
1724 } else {
1725 *ret = NULL;
1726 }
1727 return NULL;
1728 }
1729
1730 LIBDRGN_PUBLIC struct drgn_error *
1731 drgn_thread_name(struct drgn_thread *thread, char **ret)
1732 {
1733 if (thread->prog->flags & DRGN_PROGRAM_IS_LINUX_KERNEL) {
1734 return drgn_thread_name_linux_kernel(thread, ret);
1735 } else if (drgn_program_is_userspace_process(thread->prog)) {
1736 return drgn_thread_name_userspace_process(thread, ret);
1737 } else if (drgn_program_is_userspace_core(thread->prog)) {
1738 return drgn_thread_name_userspace_core(thread, ret);
1739 } else {
1740 *ret = NULL;
1741 return NULL;
1742 }
1743 }
1744
1745 struct drgn_error *drgn_program_find_prstatus(struct drgn_program *prog,
1746 uint32_t tid, struct nstring *ret)
1747 {
1748 struct drgn_error *err = drgn_program_cache_core_dump_threads(prog);
1749 if (err)
1750 return err;
1751 struct drgn_thread *thread =
1752 drgn_thread_set_search(&prog->thread_set, &tid).entry;
1753 if (!thread) {
1754 ret->str = NULL;
1755 ret->len = 0;
1756 return NULL;
1757 }
1758 *ret = thread->prstatus;
1759 return NULL;
1760 }
1761
1762 struct drgn_error *drgn_program_init_core_dump(struct drgn_program *prog,
1763 const char *path)
1764 {
1765 struct drgn_error *err;
1766
1767 err = drgn_program_set_core_dump(prog, path);
1768 if (err)
1769 return err;
1770 err = drgn_program_load_debug_info(prog, NULL, 0, true, true);
1771 if (err && err->code == DRGN_ERROR_MISSING_DEBUG_INFO) {
1772 drgn_error_destroy(err);
1773 err = NULL;
1774 }
1775 return err;
1776 }
1777
1778 struct drgn_error *drgn_program_init_core_dump_fd(struct drgn_program *prog, int fd)
1779 {
1780 struct drgn_error *err;
1781
1782 err = drgn_program_set_core_dump_fd(prog, fd);
1783 if (err)
1784 return err;
1785 err = drgn_program_load_debug_info(prog, NULL, 0, true, true);
1786 if (err && err->code == DRGN_ERROR_MISSING_DEBUG_INFO) {
1787 drgn_error_destroy(err);
1788 err = NULL;
1789 }
1790 return err;
1791 }
1792
1793 struct drgn_error *drgn_program_init_kernel(struct drgn_program *prog)
1794 {
1795 struct drgn_error *err;
1796
1797 err = drgn_program_set_kernel(prog);
1798 if (err)
1799 return err;
1800 err = drgn_program_load_debug_info(prog, NULL, 0, true, true);
1801 if (err && err->code == DRGN_ERROR_MISSING_DEBUG_INFO) {
1802 drgn_error_destroy(err);
1803 err = NULL;
1804 }
1805 return err;
1806 }
1807
1808 struct drgn_error *drgn_program_init_pid(struct drgn_program *prog, pid_t pid)
1809 {
1810 struct drgn_error *err;
1811
1812 err = drgn_program_set_pid(prog, pid);
1813 if (err)
1814 return err;
1815 err = drgn_program_load_debug_info(prog, NULL, 0, true, true);
1816 if (err && err->code == DRGN_ERROR_MISSING_DEBUG_INFO) {
1817 drgn_error_destroy(err);
1818 err = NULL;
1819 }
1820 return err;
1821 }
1822
1823 LIBDRGN_PUBLIC struct drgn_error *
1824 drgn_program_from_core_dump(const char *path, struct drgn_program **ret)
1825 {
1826 struct drgn_program *prog;
1827 struct drgn_error *err = drgn_program_create(NULL, &prog);
1828 if (err)
1829 return err;
1830
1831 err = drgn_program_init_core_dump(prog, path);
1832 if (err) {
1833 drgn_program_destroy(prog);
1834 return err;
1835 }
1836
1837 *ret = prog;
1838 return NULL;
1839 }
1840
1841 LIBDRGN_PUBLIC struct drgn_error *
1842 drgn_program_from_core_dump_fd(int fd, struct drgn_program **ret)
1843 {
1844 struct drgn_program *prog;
1845 struct drgn_error *err = drgn_program_create(NULL, &prog);
1846 if (err)
1847 return err;
1848
1849 err = drgn_program_init_core_dump_fd(prog, fd);
1850 if (err) {
1851 drgn_program_destroy(prog);
1852 return err;
1853 }
1854
1855 *ret = prog;
1856 return NULL;
1857 }
1858
1859 LIBDRGN_PUBLIC struct drgn_error *
1860 drgn_program_from_kernel(struct drgn_program **ret)
1861 {
1862 struct drgn_program *prog;
1863 struct drgn_error *err = drgn_program_create(NULL, &prog);
1864 if (err)
1865 return err;
1866
1867 err = drgn_program_init_kernel(prog);
1868 if (err) {
1869 drgn_program_destroy(prog);
1870 return err;
1871 }
1872
1873 *ret = prog;
1874 return NULL;
1875 }
1876
1877 LIBDRGN_PUBLIC struct drgn_error *
1878 drgn_program_from_pid(pid_t pid, struct drgn_program **ret)
1879 {
1880 struct drgn_program *prog;
1881 struct drgn_error *err = drgn_program_create(NULL, &prog);
1882 if (err)
1883 return err;
1884
1885 err = drgn_program_init_pid(prog, pid);
1886 if (err) {
1887 drgn_program_destroy(prog);
1888 return err;
1889 }
1890
1891 *ret = prog;
1892 return NULL;
1893 }
1894
1895 LIBDRGN_PUBLIC struct drgn_error *
1896 drgn_program_read_memory(struct drgn_program *prog, void *buf, uint64_t address,
1897 size_t count, bool physical)
1898 {
1899 uint64_t address_mask;
1900 struct drgn_error *err = drgn_program_address_mask(prog, &address_mask);
1901 if (err)
1902 return err;
1903 err = drgn_program_untagged_addr(prog, &address);
1904 if (err)
1905 return err;
1906 char *p = buf;
1907 while (count > 0) {
1908 size_t n = min((uint64_t)(count - 1), address_mask - address) + 1;
1909 err = drgn_memory_reader_read(&prog->reader, p, address, n,
1910 physical);
1911 if (err)
1912 return err;
1913 p += n;
1914 address = 0;
1915 count -= n;
1916 }
1917 return NULL;
1918 }
1919
1920 DEFINE_VECTOR(char_vector, char);
1921
1922 LIBDRGN_PUBLIC struct drgn_error *
1923 drgn_program_read_c_string(struct drgn_program *prog, uint64_t address,
1924 bool physical, size_t max_size, char **ret)
1925 {
1926 VECTOR(char_vector, str);
1927 for (;;) {
1928 struct drgn_error *err = drgn_program_untagged_addr(prog, &address);
1929 if (err)
1930 return err;
1931 char *c = char_vector_append_entry(&str);
1932 if (!c)
1933 return &drgn_enomem;
1934 if (char_vector_size(&str) <= max_size) {
1935 err = drgn_memory_reader_read(&prog->reader, c, address,
1936 1, physical);
1937 if (err)
1938 return err;
1939 if (!*c)
1940 break;
1941 } else {
1942 *c = '\0';
1943 break;
1944 }
1945 address++;
1946 }
1947 char_vector_shrink_to_fit(&str);
1948 char_vector_steal(&str, ret, NULL);
1949 return NULL;
1950 }
1951
1952 LIBDRGN_PUBLIC struct drgn_error *
1953 drgn_program_read_u8(struct drgn_program *prog, uint64_t address, bool physical,
1954 uint8_t *ret)
1955 {
1956 return drgn_program_read_memory(prog, ret, address, sizeof(*ret),
1957 physical);
1958 }
1959
1960 #define DEFINE_PROGRAM_READ_U(n) \
1961 LIBDRGN_PUBLIC struct drgn_error * \
1962 drgn_program_read_u##n(struct drgn_program *prog, uint64_t address, \
1963 bool physical, uint##n##_t *ret) \
1964 { \
1965 bool bswap; \
1966 struct drgn_error *err = drgn_program_bswap(prog, &bswap); \
1967 if (err) \
1968 return err; \
1969 uint##n##_t tmp; \
1970 err = drgn_program_read_memory(prog, &tmp, address, sizeof(tmp), \
1971 physical); \
1972 if (err) \
1973 return err; \
1974 if (bswap) \
1975 tmp = bswap_##n(tmp); \
1976 *ret = tmp; \
1977 return NULL; \
1978 }
1979
1980 DEFINE_PROGRAM_READ_U(16)
1981 DEFINE_PROGRAM_READ_U(32)
1982 DEFINE_PROGRAM_READ_U(64)
1983 #undef DEFINE_PROGRAM_READ_U
1984
1985 LIBDRGN_PUBLIC struct drgn_error *
1986 drgn_program_read_word(struct drgn_program *prog, uint64_t address,
1987 bool physical, uint64_t *ret)
1988 {
1989 bool is_64_bit, bswap;
1990 struct drgn_error *err = drgn_program_is_64_bit(prog, &is_64_bit);
1991 if (err)
1992 return err;
1993 err = drgn_program_bswap(prog, &bswap);
1994 if (err)
1995 return err;
1996 if (is_64_bit) {
1997 uint64_t tmp;
1998 err = drgn_program_read_memory(prog, &tmp, address, sizeof(tmp),
1999 physical);
2000 if (err)
2001 return err;
2002 if (bswap)
2003 tmp = bswap_64(tmp);
2004 *ret = tmp;
2005 } else {
2006 uint32_t tmp;
2007 err = drgn_program_read_memory(prog, &tmp, address, sizeof(tmp),
2008 physical);
2009 if (err)
2010 return err;
2011 if (bswap)
2012 tmp = bswap_32(tmp);
2013 *ret = tmp;
2014 }
2015 return NULL;
2016 }
2017
2018 LIBDRGN_PUBLIC struct drgn_error *
2019 drgn_program_find_object(struct drgn_program *prog, const char *name,
2020 const char *filename,
2021 enum drgn_find_object_flags flags,
2022 struct drgn_object *ret)
2023 {
2024 struct drgn_error *err;
2025
2026 if ((flags & ~DRGN_FIND_OBJECT_ANY) || !flags) {
2027 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
2028 "invalid find object flags");
2029 }
2030 if (ret && drgn_object_program(ret) != prog) {
2031 return drgn_error_create(DRGN_ERROR_INVALID_ARGUMENT,
2032 "object is from wrong program");
2033 }
2034
2035 size_t name_len = strlen(name);
2036 drgn_handler_list_for_each_enabled(struct drgn_object_finder, finder,
2037 &prog->object_finders) {
2038 err = finder->ops.find(name, name_len, filename, flags,
2039 finder->arg, ret);
2040 if (err != &drgn_not_found)
2041 return err;
2042 }
2043
2044 const char *kind_str;
2045 switch (flags) {
2046 case DRGN_FIND_OBJECT_CONSTANT:
2047 kind_str = "constant ";
2048 break;
2049 case DRGN_FIND_OBJECT_FUNCTION:
2050 kind_str = "function ";
2051 break;
2052 case DRGN_FIND_OBJECT_VARIABLE:
2053 kind_str = "variable ";
2054 break;
2055 default:
2056 kind_str = "";
2057 break;
2058 }
2059 if (filename) {
2060 return drgn_error_format(DRGN_ERROR_LOOKUP,
2061 "could not find %s'%s' in '%s'",
2062 kind_str, name, filename);
2063 } else {
2064 return drgn_error_format(DRGN_ERROR_LOOKUP,
2065 "could not find %s'%s'", kind_str,
2066 name);
2067 }
2068 }
2069
2070 struct drgn_error *drgn_error_symbol_not_found(uint64_t address)
2071 {
2072 return drgn_error_format(DRGN_ERROR_LOOKUP,
2073 "could not find symbol containing 0x%" PRIx64,
2074 address);
2075 }
2076
2077 static struct drgn_error *
2078 drgn_program_symbols_search(struct drgn_program *prog, const char *name,
2079 uint64_t addr, enum drgn_find_symbol_flags flags,
2080 struct drgn_symbol_result_builder *builder)
2081 {
2082 struct drgn_error *err = NULL;
2083 drgn_handler_list_for_each_enabled(struct drgn_symbol_finder, finder,
2084 &prog->symbol_finders) {
2085 err = finder->ops.find(name, addr, flags, finder->arg, builder);
2086 if (err ||
2087 ((flags & DRGN_FIND_SYMBOL_ONE)
2088 && drgn_symbol_result_builder_count(builder) > 0))
2089 break;
2090 }
2091 return err;
2092 }
2093
2094 LIBDRGN_PUBLIC struct drgn_error *
2095 drgn_program_find_symbols_by_name(struct drgn_program *prog, const char *name,
2096 struct drgn_symbol ***syms_ret,
2097 size_t *count_ret)
2098 {
2099 struct drgn_symbol_result_builder builder;
2100 enum drgn_find_symbol_flags flags = name ? DRGN_FIND_SYMBOL_NAME : 0;
2101
2102 drgn_symbol_result_builder_init(&builder, false);
2103 struct drgn_error *err = drgn_program_symbols_search(prog, name, 0,
2104 flags, &builder);
2105 if (err)
2106 drgn_symbol_result_builder_abort(&builder);
2107 else
2108 drgn_symbol_result_builder_array(&builder, syms_ret, count_ret);
2109 return err;
2110 }
2111
2112 LIBDRGN_PUBLIC struct drgn_error *
2113 drgn_program_find_symbols_by_address(struct drgn_program *prog,
2114 uint64_t address,
2115 struct drgn_symbol ***syms_ret,
2116 size_t *count_ret)
2117 {
2118 struct drgn_symbol_result_builder builder;
2119 enum drgn_find_symbol_flags flags = DRGN_FIND_SYMBOL_ADDR;
2120
2121 drgn_symbol_result_builder_init(&builder, false);
2122 struct drgn_error *err = drgn_program_symbols_search(prog, NULL, address,
2123 flags, &builder);
2124 if (err)
2125 drgn_symbol_result_builder_abort(&builder);
2126 else
2127 drgn_symbol_result_builder_array(&builder, syms_ret, count_ret);
2128 return err;
2129 }
2130
2131 LIBDRGN_PUBLIC struct drgn_error *
2132 drgn_program_find_symbol_by_name(struct drgn_program *prog,
2133 const char *name, struct drgn_symbol **ret)
2134 {
2135 struct drgn_symbol_result_builder builder;
2136 enum drgn_find_symbol_flags flags = DRGN_FIND_SYMBOL_NAME | DRGN_FIND_SYMBOL_ONE;
2137
2138 drgn_symbol_result_builder_init(&builder, true);
2139 struct drgn_error *err = drgn_program_symbols_search(prog, name, 0,
2140 flags, &builder);
2141 if (err) {
2142 drgn_symbol_result_builder_abort(&builder);
2143 return err;
2144 }
2145
2146 if (!drgn_symbol_result_builder_count(&builder))
2147 return drgn_error_format(DRGN_ERROR_LOOKUP,
2148 "could not find symbol with name '%s'", name);
2149
2150 *ret = drgn_symbol_result_builder_single(&builder);
2151 return err;
2152 }
2153
2154 LIBDRGN_PUBLIC struct drgn_error *
2155 drgn_program_find_symbol_by_address(struct drgn_program *prog, uint64_t address,
2156 struct drgn_symbol **ret)
2157 {
2158 struct drgn_symbol_result_builder builder;
2159 enum drgn_find_symbol_flags flags = DRGN_FIND_SYMBOL_ADDR | DRGN_FIND_SYMBOL_ONE;
2160
2161 drgn_symbol_result_builder_init(&builder, true);
2162 struct drgn_error *err = drgn_program_symbols_search(prog, NULL, address,
2163 flags, &builder);
2164
2165 if (err) {
2166 drgn_symbol_result_builder_abort(&builder);
2167 return err;
2168 }
2169
2170 if (!drgn_symbol_result_builder_count(&builder))
2171 return drgn_error_symbol_not_found(address);
2172
2173 *ret = drgn_symbol_result_builder_single(&builder);
2174 return err;
2175 }
2176
2177 struct drgn_error *
2178 drgn_program_find_symbol_by_address_internal(struct drgn_program *prog,
2179 uint64_t address,
2180 struct drgn_symbol **ret)
2181 {
2182 struct drgn_symbol_result_builder builder;
2183 enum drgn_find_symbol_flags flags = DRGN_FIND_SYMBOL_ADDR | DRGN_FIND_SYMBOL_ONE;
2184
2185 drgn_symbol_result_builder_init(&builder, true);
2186 struct drgn_error *err = drgn_program_symbols_search(prog, NULL, address,
2187 flags, &builder);
2188 if (err)
2189 drgn_symbol_result_builder_abort(&builder);
2190 else
2191 *ret = drgn_symbol_result_builder_single(&builder);
2192 return err;
2193 }
2194
2195 LIBDRGN_PUBLIC struct drgn_error *
2196 drgn_program_element_info(struct drgn_program *prog, struct drgn_type *type,
2197 struct drgn_element_info *ret)
2198 {
2199 struct drgn_type *underlying_type;
2200 bool is_pointer, is_array;
2201
2202 underlying_type = drgn_underlying_type(type);
2203 is_pointer = drgn_type_kind(underlying_type) == DRGN_TYPE_POINTER;
2204 is_array = drgn_type_kind(underlying_type) == DRGN_TYPE_ARRAY;
2205 if (!is_pointer && !is_array)
2206 return drgn_type_error("'%s' is not an array or pointer", type);
2207
2208 ret->qualified_type = drgn_type_type(underlying_type);
2209 return drgn_type_bit_size(ret->qualified_type.type, &ret->bit_size);
2210 }