/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __X86_KERNEL_KPROBES_COMMON_H
#define __X86_KERNEL_KPROBES_COMMON_H

/* Kprobes and Optprobes common header */

#include <asm/asm.h>
#include <asm/frame.h>
#include <asm/insn.h>

#ifdef CONFIG_X86_64

#define SAVE_REGS_STRING                        \
        /* Skip cs, ip, orig_ax. */             \
        "       subq $24, %rsp\n"               \
        "       pushq %rdi\n"                   \
        "       pushq %rsi\n"                   \
        "       pushq %rdx\n"                   \
        "       pushq %rcx\n"                   \
        "       pushq %rax\n"                   \
        "       pushq %r8\n"                    \
        "       pushq %r9\n"                    \
        "       pushq %r10\n"                   \
        "       pushq %r11\n"                   \
        "       pushq %rbx\n"                   \
        "       pushq %rbp\n"                   \
        "       pushq %r12\n"                   \
        "       pushq %r13\n"                   \
        "       pushq %r14\n"                   \
        "       pushq %r15\n"                   \
        ENCODE_FRAME_POINTER

#define RESTORE_REGS_STRING                     \
        "       popq %r15\n"                    \
        "       popq %r14\n"                    \
        "       popq %r13\n"                    \
        "       popq %r12\n"                    \
        "       popq %rbp\n"                    \
        "       popq %rbx\n"                    \
        "       popq %r11\n"                    \
        "       popq %r10\n"                    \
        "       popq %r9\n"                     \
        "       popq %r8\n"                     \
        "       popq %rax\n"                    \
        "       popq %rcx\n"                    \
        "       popq %rdx\n"                    \
        "       popq %rsi\n"                    \
        "       popq %rdi\n"                    \
        /* Skip orig_ax, ip, cs */              \
        "       addq $24, %rsp\n"
#else

#define SAVE_REGS_STRING                        \
        /* Skip cs, ip, orig_ax and gs. */      \
        "       subl $4*4, %esp\n"              \
        "       pushl %fs\n"                    \
        "       pushl %es\n"                    \
        "       pushl %ds\n"                    \
        "       pushl %eax\n"                   \
        "       pushl %ebp\n"                   \
        "       pushl %edi\n"                   \
        "       pushl %esi\n"                   \
        "       pushl %edx\n"                   \
        "       pushl %ecx\n"                   \
        "       pushl %ebx\n"                   \
        ENCODE_FRAME_POINTER

#define RESTORE_REGS_STRING                     \
        "       popl %ebx\n"                    \
        "       popl %ecx\n"                    \
        "       popl %edx\n"                    \
        "       popl %esi\n"                    \
        "       popl %edi\n"                    \
        "       popl %ebp\n"                    \
        "       popl %eax\n"                    \
        /* Skip ds, es, fs, gs, orig_ax, ip, and cs. */\
        "       addl $7*4, %esp\n"
#endif

/* Ensure if the instruction can be boostable */
extern bool can_boost(struct insn *insn, void *orig_addr);
/* Recover instruction if given address is probed */
extern unsigned long recover_probed_instruction(kprobe_opcode_t *buf,
                                         unsigned long addr);
/*
 * Copy an instruction and adjust the displacement if the instruction
 * uses the %rip-relative addressing mode.
 */
extern int __copy_instruction(u8 *dest, u8 *src, u8 *real, struct insn *insn);

/* Generate a relative-jump/call instruction */
extern void synthesize_reljump(void *dest, void *from, void *to);
extern void synthesize_relcall(void *dest, void *from, void *to);

#ifdef  CONFIG_OPTPROBES
extern int setup_detour_execution(struct kprobe *p, struct pt_regs *regs, int reenter);
extern unsigned long __recover_optprobed_insn(kprobe_opcode_t *buf, unsigned long addr);
#else   /* !CONFIG_OPTPROBES */
static inline int setup_detour_execution(struct kprobe *p, struct pt_regs *regs, int reenter)
{
        return 0;
}
static inline unsigned long __recover_optprobed_insn(kprobe_opcode_t *buf, unsigned long addr)
{
        return addr;
}
#endif

#endif