drgn/libdrgn/python/drgnpy.h
Omar Sandoval 0d35dec8ee libdrgn: python: define Py_RETURN_BOOL
And use it instead of an if statement with
Py_RETURN_TRUE/Py_RETURN_FALSE or PyBool_FromLong().

Signed-off-by: Omar Sandoval <osandov@osandov.com>
2021-01-28 11:35:09 -08:00

307 lines
9.1 KiB
C

// Copyright (c) Facebook, Inc. and its affiliates.
// SPDX-License-Identifier: GPL-3.0+
#ifndef DRGNPY_H
#define DRGNPY_H
#define PY_SSIZE_T_CLEAN
// IWYU pragma: begin_exports
#include <Python.h>
#include "structmember.h"
#include "docstrings.h"
#include "../drgn.h"
// IWYU pragma: end_exports
#include "../hash_table.h"
#include "../program.h"
/* These were added in Python 3.7. */
#ifndef Py_UNREACHABLE
#define Py_UNREACHABLE() abort()
#endif
#ifndef Py_RETURN_RICHCOMPARE
#define Py_RETURN_RICHCOMPARE(val1, val2, op) \
do { \
switch (op) { \
case Py_EQ: if ((val1) == (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
case Py_NE: if ((val1) != (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
case Py_LT: if ((val1) < (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
case Py_GT: if ((val1) > (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
case Py_LE: if ((val1) <= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
case Py_GE: if ((val1) >= (val2)) Py_RETURN_TRUE; Py_RETURN_FALSE; \
default: \
Py_UNREACHABLE(); \
} \
} while (0)
#endif
#define DRGNPY_PUBLIC __attribute__((visibility("default")))
#define Py_RETURN_BOOL(cond) do { \
if (cond) \
Py_RETURN_TRUE; \
else \
Py_RETURN_FALSE; \
} while (0)
typedef struct {
PyObject_HEAD
struct drgn_object obj;
} DrgnObject;
typedef struct {
PyObject_HEAD
struct drgn_type *type;
enum drgn_qualifiers qualifiers;
/*
* Cache of attributes which were previously converted from a struct
* drgn_type member or used to create the type.
*/
PyObject *attr_cache;
} DrgnType;
typedef struct {
PyObject_HEAD
/*
* "Python-friendly" name used for the object, which may differ from the
* language name if the language name is not a valid identifier (e.g.,
* C++).
*/
const char *attr_name;
const struct drgn_language *language;
} Language;
typedef struct {
PyObject_HEAD
DrgnObject *obj;
uint64_t length, index;
} ObjectIterator;
typedef struct {
PyObject_HEAD
struct drgn_platform *platform;
} Platform;
DEFINE_HASH_SET_TYPE(pyobjectp_set, PyObject *)
typedef struct {
PyObject_HEAD
struct drgn_program prog;
PyObject *cache;
/*
* Set of objects that we need to hold a reference to during the
* lifetime of the Program.
*/
struct pyobjectp_set objects;
} Program;
typedef struct {
PyObject_HEAD
struct drgn_stack_trace *trace;
} StackTrace;
typedef struct {
PyObject_HEAD
StackTrace *trace;
size_t i;
} StackFrame;
typedef struct {
PyObject_HEAD
Program *prog;
struct drgn_symbol *sym;
} Symbol;
typedef struct {
PyObject_HEAD
PyObject *name;
PyObject *value;
} TypeEnumerator;
typedef struct {
PyObject_HEAD
PyObject *obj;
/*
* If DRGNPY_LAZY_OBJECT_EVALUATED, obj is the evaluated Object.
* If DRGNPY_LAZY_OBJECT_CALLABLE, obj is a Python callable that should
* return the Object.
* Otherwise, this must be evaluated and wrapped, and obj is a reference
* required to keep this alive.
*/
union drgn_lazy_object *lazy_obj;
} LazyObject;
typedef struct {
LazyObject lazy_obj;
PyObject *name;
PyObject *bit_offset;
} TypeMember;
typedef struct {
LazyObject lazy_obj;
PyObject *name;
} TypeParameter;
typedef struct {
LazyObject lazy_obj;
PyObject *name;
PyObject *is_default;
} TypeTemplateParameter;
extern PyObject *Architecture_class;
extern PyObject *FindObjectFlags_class;
extern PyObject *PlatformFlags_class;
extern PyObject *PrimitiveType_class;
extern PyObject *ProgramFlags_class;
extern PyObject *Qualifiers_class;
extern PyObject *TypeKind_class;
extern PyStructSequence_Desc Register_desc;
extern PyTypeObject DrgnObject_type;
extern PyTypeObject DrgnType_type;
extern PyTypeObject FaultError_type;
extern PyTypeObject Language_type;
extern PyTypeObject ObjectIterator_type;
extern PyTypeObject Platform_type;
extern PyTypeObject Program_type;
extern PyTypeObject Register_type;
extern PyTypeObject StackFrame_type;
extern PyTypeObject StackTrace_type;
extern PyTypeObject Symbol_type;
extern PyTypeObject TypeEnumerator_type;
extern PyTypeObject TypeMember_type;
extern PyTypeObject TypeParameter_type;
extern PyTypeObject TypeTemplateParameter_type;
extern PyObject *MissingDebugInfoError;
extern PyObject *ObjectAbsentError;
extern PyObject *OutOfBoundsError;
int add_module_constants(PyObject *m);
bool set_drgn_in_python(void);
void clear_drgn_in_python(void);
struct drgn_error *drgn_error_from_python(void);
void *set_drgn_error(struct drgn_error *err);
void *set_error_type_name(const char *format,
struct drgn_qualified_type qualified_type);
PyObject *Language_wrap(const struct drgn_language *language);
int language_converter(PyObject *o, void *p);
int add_languages(void);
static inline DrgnObject *DrgnObject_alloc(Program *prog)
{
DrgnObject *ret;
ret = (DrgnObject *)DrgnObject_type.tp_alloc(&DrgnObject_type, 0);
if (ret) {
drgn_object_init(&ret->obj, &prog->prog);
Py_INCREF(prog);
}
return ret;
}
static inline Program *DrgnObject_prog(DrgnObject *obj)
{
return container_of(drgn_object_program(&obj->obj), Program, prog);
}
PyObject *DrgnObject_NULL(PyObject *self, PyObject *args, PyObject *kwds);
DrgnObject *cast(PyObject *self, PyObject *args, PyObject *kwds);
DrgnObject *reinterpret(PyObject *self, PyObject *args, PyObject *kwds);
DrgnObject *DrgnObject_container_of(PyObject *self, PyObject *args,
PyObject *kwds);
PyObject *Platform_wrap(const struct drgn_platform *platform);
int Program_hold_object(Program *prog, PyObject *obj);
bool Program_hold_reserve(Program *prog, size_t n);
int Program_type_arg(Program *prog, PyObject *type_obj, bool can_be_none,
struct drgn_qualified_type *ret);
Program *program_from_core_dump(PyObject *self, PyObject *args, PyObject *kwds);
Program *program_from_kernel(PyObject *self);
Program *program_from_pid(PyObject *self, PyObject *args, PyObject *kwds);
PyObject *Symbol_wrap(struct drgn_symbol *sym, Program *prog);
static inline Program *DrgnType_prog(DrgnType *type)
{
return container_of(drgn_type_program(type->type), Program, prog);
}
PyObject *DrgnType_wrap(struct drgn_qualified_type qualified_type);
DrgnType *Program_void_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_int_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_bool_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_float_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_complex_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_struct_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_union_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_class_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_enum_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_typedef_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_pointer_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_array_type(Program *self, PyObject *args, PyObject *kwds);
DrgnType *Program_function_type(Program *self, PyObject *args, PyObject *kwds);
int append_string(PyObject *parts, const char *s);
int append_format(PyObject *parts, const char *format, ...);
PyObject *join_strings(PyObject *parts);
PyObject *byteorder_string(bool little_endian);
struct byteorder_arg {
bool allow_none;
bool is_none;
enum drgn_byte_order value;
};
int byteorder_converter(PyObject *o, void *p);
struct index_arg {
bool allow_none;
bool is_none;
bool is_signed;
union {
unsigned long long uvalue;
long long svalue;
};
};
int index_converter(PyObject *o, void *p);
/* Helpers for path arguments based on posixmodule.c in CPython. */
struct path_arg {
bool allow_none;
char *path;
Py_ssize_t length;
PyObject *object;
PyObject *cleanup;
};
int path_converter(PyObject *o, void *p);
void path_cleanup(struct path_arg *path);
struct enum_arg {
PyObject *type;
unsigned long value;
bool allow_none;
};
int enum_converter(PyObject *o, void *p);
PyObject *drgnpy_linux_helper_read_vm(PyObject *self, PyObject *args,
PyObject *kwds);
DrgnObject *drgnpy_linux_helper_radix_tree_lookup(PyObject *self,
PyObject *args,
PyObject *kwds);
DrgnObject *drgnpy_linux_helper_idr_find(PyObject *self, PyObject *args,
PyObject *kwds);
DrgnObject *drgnpy_linux_helper_find_pid(PyObject *self, PyObject *args,
PyObject *kwds);
DrgnObject *drgnpy_linux_helper_pid_task(PyObject *self, PyObject *args,
PyObject *kwds);
DrgnObject *drgnpy_linux_helper_find_task(PyObject *self, PyObject *args,
PyObject *kwds);
PyObject *drgnpy_linux_helper_task_state_to_char(PyObject *self, PyObject *args,
PyObject *kwds);
PyObject *drgnpy_linux_helper_kaslr_offset(PyObject *self, PyObject *args,
PyObject *kwds);
PyObject *drgnpy_linux_helper_pgtable_l5_enabled(PyObject *self, PyObject *args,
PyObject *kwds);
#endif /* DRGNPY_H */