// Copyright (c) Meta Platforms, Inc. and affiliates. // SPDX-License-Identifier: LGPL-2.1-or-later /** * @file * * Helpers implemented in C. * * Most drgn helpers are implemented in Python. However, there are a few that we * need internally in libdrgn, so they are implemented in C, instead. */ #ifndef DRGN_HELPERS_H #define DRGN_HELPERS_H #include #include #include "drgn_internal.h" struct drgn_object; struct drgn_program; struct drgn_error *linux_helper_direct_mapping_offset(struct drgn_program *prog, uint64_t *ret); struct drgn_error *linux_helper_read_vm(struct drgn_program *prog, uint64_t pgtable, uint64_t virt_addr, void *buf, size_t count); struct drgn_error *linux_helper_follow_phys(struct drgn_program *prog, uint64_t pgtable, uint64_t virt_addr, uint64_t *ret); struct drgn_error *linux_helper_per_cpu_ptr(struct drgn_object *res, const struct drgn_object *ptr, uint64_t cpu); struct drgn_error *linux_helper_cpu_curr(struct drgn_object *res, uint64_t cpu); struct drgn_error *linux_helper_idle_task(struct drgn_object *res, uint64_t cpu); struct drgn_error * linux_helper_task_thread_info(struct drgn_object *res, const struct drgn_object *task); struct drgn_error *linux_helper_task_cpu(const struct drgn_object *task, uint64_t *ret); struct drgn_error *linux_helper_task_on_cpu(const struct drgn_object *task, bool *ret); struct drgn_error * linux_helper_xa_load(struct drgn_object *res, const struct drgn_object *xa, uint64_t index); struct drgn_error *linux_helper_idr_find(struct drgn_object *res, const struct drgn_object *idr, uint64_t id); struct drgn_error *linux_helper_find_pid(struct drgn_object *res, const struct drgn_object *ns, uint64_t pid); struct drgn_error *linux_helper_pid_task(struct drgn_object *res, const struct drgn_object *pid, uint64_t pid_type); struct drgn_error *linux_helper_find_task(struct drgn_object *res, const struct drgn_object *ns, uint64_t pid); struct linux_helper_task_iterator { struct drgn_object tasks_node; struct drgn_object thread_node; uint64_t tasks_head; uint64_t thread_head; struct drgn_qualified_type task_struct_type; bool done; }; struct drgn_error * linux_helper_task_iterator_init(struct linux_helper_task_iterator *it, struct drgn_program *prog); void linux_helper_task_iterator_deinit(struct linux_helper_task_iterator *it); /** Get the next task from a @ref linux_helper_task_iterator. */ struct drgn_error * linux_helper_task_iterator_next(struct linux_helper_task_iterator *it, struct drgn_object *ret); #endif /* DRGN_HELPERS_H */