linux/arch/x86/include/asm/orc_types.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2017 Josh Poimboeuf <[email protected]>
 */

#ifndef _ORC_TYPES_H
#define _ORC_TYPES_H

#include <linux/types.h>
#include <linux/compiler.h>

/*
 * The ORC_REG_* registers are base registers which are used to find other
 * registers on the stack.
 *
 * ORC_REG_PREV_SP, also known as DWARF Call Frame Address (CFA), is the
 * address of the previous frame: the caller's SP before it called the current
 * function.
 *
 * ORC_REG_UNDEFINED means the corresponding register's value didn't change in
 * the current frame.
 *
 * The most commonly used base registers are SP and BP -- which the previous SP
 * is usually based on -- and PREV_SP and UNDEFINED -- which the previous BP is
 * usually based on.
 *
 * The rest of the base registers are needed for special cases like entry code
 * and GCC realigned stacks.
 */
#define ORC_REG_UNDEFINED
#define ORC_REG_PREV_SP
#define ORC_REG_DX
#define ORC_REG_DI
#define ORC_REG_BP
#define ORC_REG_SP
#define ORC_REG_R10
#define ORC_REG_R13
#define ORC_REG_BP_INDIRECT
#define ORC_REG_SP_INDIRECT
#define ORC_REG_MAX

#define ORC_TYPE_UNDEFINED
#define ORC_TYPE_END_OF_STACK
#define ORC_TYPE_CALL
#define ORC_TYPE_REGS
#define ORC_TYPE_REGS_PARTIAL

#ifndef __ASSEMBLY__
#include <asm/byteorder.h>

/*
 * This struct is more or less a vastly simplified version of the DWARF Call
 * Frame Information standard.  It contains only the necessary parts of DWARF
 * CFI, simplified for ease of access by the in-kernel unwinder.  It tells the
 * unwinder how to find the previous SP and BP (and sometimes entry regs) on
 * the stack for a given code address.  Each instance of the struct corresponds
 * to one or more code locations.
 */
struct orc_entry {} __packed;

#endif /* __ASSEMBLY__ */

#endif /* _ORC_TYPES_H */