root/tools/testing/selftests/rseq/rseq-arm-bits.h
/* SPDX-License-Identifier: LGPL-2.1 OR MIT */
/*
 * rseq-arm-bits.h
 *
 * (C) Copyright 2016-2022 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#include "rseq-bits-template.h"

#if defined(RSEQ_TEMPLATE_MO_RELAXED) && \
        (defined(RSEQ_TEMPLATE_CPU_ID) || defined(RSEQ_TEMPLATE_MM_CID))

static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_cmpeqv_storev)(intptr_t *v, intptr_t expect, intptr_t newv, int cpu)
{
        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[cmpfail])
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error2])
#endif
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[cmpfail]\n\t"
                RSEQ_INJECT_ASM(4)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, %l[error1])
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[error2]\n\t"
#endif
                /* final store */
                "str %[newv], %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(5)
                "b 5f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4, "", abort, 1b, 2b, 4f)
                "5:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  [v]                   "m" (*v),
                  [expect]              "r" (expect),
                  [newv]                "r" (newv)
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort, cmpfail
#ifdef RSEQ_COMPARE_TWICE
                  , error1, error2
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
cmpfail:
        rseq_after_asm_goto();
        return 1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
error2:
        rseq_after_asm_goto();
        rseq_bug("expected value comparison failed");
#endif
}

static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_cmpnev_storeoffp_load)(intptr_t *v, intptr_t expectnot,
                               long voffp, intptr_t *load, int cpu)
{
        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[cmpfail])
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error2])
#endif
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
                "ldr r0, %[v]\n\t"
                "cmp %[expectnot], r0\n\t"
                "beq %l[cmpfail]\n\t"
                RSEQ_INJECT_ASM(4)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, %l[error1])
                "ldr r0, %[v]\n\t"
                "cmp %[expectnot], r0\n\t"
                "beq %l[error2]\n\t"
#endif
                "str r0, %[load]\n\t"
                "add r0, %[voffp]\n\t"
                "ldr r0, [r0]\n\t"
                /* final store */
                "str r0, %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(5)
                "b 5f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4, "", abort, 1b, 2b, 4f)
                "5:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  /* final store input */
                  [v]                   "m" (*v),
                  [expectnot]           "r" (expectnot),
                  [voffp]               "Ir" (voffp),
                  [load]                "m" (*load)
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort, cmpfail
#ifdef RSEQ_COMPARE_TWICE
                  , error1, error2
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
cmpfail:
        rseq_after_asm_goto();
        return 1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
error2:
        rseq_after_asm_goto();
        rseq_bug("expected value comparison failed");
#endif
}

static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_addv)(intptr_t *v, intptr_t count, int cpu)
{
        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
#endif
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, %l[error1])
#endif
                "ldr r0, %[v]\n\t"
                "add r0, %[count]\n\t"
                /* final store */
                "str r0, %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(4)
                "b 5f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4, "", abort, 1b, 2b, 4f)
                "5:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  [v]                   "m" (*v),
                  [count]               "Ir" (count)
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort
#ifdef RSEQ_COMPARE_TWICE
                  , error1
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
#endif
}

static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_cmpeqv_cmpeqv_storev)(intptr_t *v, intptr_t expect,
                              intptr_t *v2, intptr_t expect2,
                              intptr_t newv, int cpu)
{
        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[cmpfail])
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error2])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error3])
#endif
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[cmpfail]\n\t"
                RSEQ_INJECT_ASM(4)
                "ldr r0, %[v2]\n\t"
                "cmp %[expect2], r0\n\t"
                "bne %l[cmpfail]\n\t"
                RSEQ_INJECT_ASM(5)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, %l[error1])
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[error2]\n\t"
                "ldr r0, %[v2]\n\t"
                "cmp %[expect2], r0\n\t"
                "bne %l[error3]\n\t"
#endif
                /* final store */
                "str %[newv], %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(6)
                "b 5f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4, "", abort, 1b, 2b, 4f)
                "5:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  /* cmp2 input */
                  [v2]                  "m" (*v2),
                  [expect2]             "r" (expect2),
                  /* final store input */
                  [v]                   "m" (*v),
                  [expect]              "r" (expect),
                  [newv]                "r" (newv)
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort, cmpfail
#ifdef RSEQ_COMPARE_TWICE
                  , error1, error2, error3
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
cmpfail:
        rseq_after_asm_goto();
        return 1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
error2:
        rseq_after_asm_goto();
        rseq_bug("1st expected value comparison failed");
error3:
        rseq_after_asm_goto();
        rseq_bug("2nd expected value comparison failed");
#endif
}

#endif /* #if defined(RSEQ_TEMPLATE_MO_RELAXED) &&
        (defined(RSEQ_TEMPLATE_CPU_ID) || defined(RSEQ_TEMPLATE_MM_CID)) */

#if (defined(RSEQ_TEMPLATE_MO_RELAXED) || defined(RSEQ_TEMPLATE_MO_RELEASE)) && \
        (defined(RSEQ_TEMPLATE_CPU_ID) || defined(RSEQ_TEMPLATE_MM_CID))

static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_cmpeqv_trystorev_storev)(intptr_t *v, intptr_t expect,
                                 intptr_t *v2, intptr_t newv2,
                                 intptr_t newv, int cpu)
{
        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[cmpfail])
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error2])
#endif
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[cmpfail]\n\t"
                RSEQ_INJECT_ASM(4)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, %l[error1])
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne %l[error2]\n\t"
#endif
                /* try store */
                "str %[newv2], %[v2]\n\t"
                RSEQ_INJECT_ASM(5)
#ifdef RSEQ_TEMPLATE_MO_RELEASE
                "dmb\n\t"       /* full mb provides store-release */
#endif
                /* final store */
                "str %[newv], %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(6)
                "b 5f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4, "", abort, 1b, 2b, 4f)
                "5:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  /* try store input */
                  [v2]                  "m" (*v2),
                  [newv2]               "r" (newv2),
                  /* final store input */
                  [v]                   "m" (*v),
                  [expect]              "r" (expect),
                  [newv]                "r" (newv)
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort, cmpfail
#ifdef RSEQ_COMPARE_TWICE
                  , error1, error2
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
cmpfail:
        rseq_after_asm_goto();
        return 1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
error2:
        rseq_after_asm_goto();
        rseq_bug("expected value comparison failed");
#endif
}


static inline __attribute__((always_inline))
int RSEQ_TEMPLATE_IDENTIFIER(rseq_cmpeqv_trymemcpy_storev)(intptr_t *v, intptr_t expect,
                                 void *dst, void *src, size_t len,
                                 intptr_t newv, int cpu)
{
        uint32_t rseq_scratch[3];

        RSEQ_INJECT_C(9)

        __asm__ __volatile__ goto (
                RSEQ_ASM_DEFINE_TABLE(9, 1f, 2f, 4f) /* start, commit, abort */
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[cmpfail])
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error1])
                RSEQ_ASM_DEFINE_EXIT_POINT(1f, %l[error2])
#endif
                "str %[src], %[rseq_scratch0]\n\t"
                "str %[dst], %[rseq_scratch1]\n\t"
                "str %[len], %[rseq_scratch2]\n\t"
                /* Start rseq by storing table entry pointer into rseq_cs. */
                RSEQ_ASM_STORE_RSEQ_CS(1, 3f, rseq_cs)
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 4f)
                RSEQ_INJECT_ASM(3)
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne 5f\n\t"
                RSEQ_INJECT_ASM(4)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_CMP_CPU_ID(cpu_id, current_cpu_id, 6f)
                "ldr r0, %[v]\n\t"
                "cmp %[expect], r0\n\t"
                "bne 7f\n\t"
#endif
                /* try memcpy */
                "cmp %[len], #0\n\t" \
                "beq 333f\n\t" \
                "222:\n\t" \
                "ldrb %%r0, [%[src]]\n\t" \
                "strb %%r0, [%[dst]]\n\t" \
                "adds %[src], #1\n\t" \
                "adds %[dst], #1\n\t" \
                "subs %[len], #1\n\t" \
                "bne 222b\n\t" \
                "333:\n\t" \
                RSEQ_INJECT_ASM(5)
#ifdef RSEQ_TEMPLATE_MO_RELEASE
                "dmb\n\t"       /* full mb provides store-release */
#endif
                /* final store */
                "str %[newv], %[v]\n\t"
                "2:\n\t"
                RSEQ_INJECT_ASM(6)
                /* teardown */
                "ldr %[len], %[rseq_scratch2]\n\t"
                "ldr %[dst], %[rseq_scratch1]\n\t"
                "ldr %[src], %[rseq_scratch0]\n\t"
                "b 8f\n\t"
                RSEQ_ASM_DEFINE_ABORT(3, 4,
                                      /* teardown */
                                      "ldr %[len], %[rseq_scratch2]\n\t"
                                      "ldr %[dst], %[rseq_scratch1]\n\t"
                                      "ldr %[src], %[rseq_scratch0]\n\t",
                                      abort, 1b, 2b, 4f)
                RSEQ_ASM_DEFINE_CMPFAIL(5,
                                        /* teardown */
                                        "ldr %[len], %[rseq_scratch2]\n\t"
                                        "ldr %[dst], %[rseq_scratch1]\n\t"
                                        "ldr %[src], %[rseq_scratch0]\n\t",
                                        cmpfail)
#ifdef RSEQ_COMPARE_TWICE
                RSEQ_ASM_DEFINE_CMPFAIL(6,
                                        /* teardown */
                                        "ldr %[len], %[rseq_scratch2]\n\t"
                                        "ldr %[dst], %[rseq_scratch1]\n\t"
                                        "ldr %[src], %[rseq_scratch0]\n\t",
                                        error1)
                RSEQ_ASM_DEFINE_CMPFAIL(7,
                                        /* teardown */
                                        "ldr %[len], %[rseq_scratch2]\n\t"
                                        "ldr %[dst], %[rseq_scratch1]\n\t"
                                        "ldr %[src], %[rseq_scratch0]\n\t",
                                        error2)
#endif
                "8:\n\t"
                : /* gcc asm goto does not allow outputs */
                : [cpu_id]              "r" (cpu),
                  [current_cpu_id]      "m" (rseq_get_abi()->RSEQ_TEMPLATE_CPU_ID_FIELD),
                  [rseq_cs]             "m" (rseq_get_abi()->rseq_cs.arch.ptr),
                  /* final store input */
                  [v]                   "m" (*v),
                  [expect]              "r" (expect),
                  [newv]                "r" (newv),
                  /* try memcpy input */
                  [dst]                 "r" (dst),
                  [src]                 "r" (src),
                  [len]                 "r" (len),
                  [rseq_scratch0]       "m" (rseq_scratch[0]),
                  [rseq_scratch1]       "m" (rseq_scratch[1]),
                  [rseq_scratch2]       "m" (rseq_scratch[2])
                  RSEQ_INJECT_INPUT
                : "r0", "memory", "cc"
                  RSEQ_INJECT_CLOBBER
                : abort, cmpfail
#ifdef RSEQ_COMPARE_TWICE
                  , error1, error2
#endif
        );
        rseq_after_asm_goto();
        return 0;
abort:
        rseq_after_asm_goto();
        RSEQ_INJECT_FAILED
        return -1;
cmpfail:
        rseq_after_asm_goto();
        return 1;
#ifdef RSEQ_COMPARE_TWICE
error1:
        rseq_after_asm_goto();
        rseq_bug("cpu_id comparison failed");
error2:
        rseq_after_asm_goto();
        rseq_bug("expected value comparison failed");
#endif
}

#endif /* #if (defined(RSEQ_TEMPLATE_MO_RELAXED) || defined(RSEQ_TEMPLATE_MO_RELEASE)) &&
        (defined(RSEQ_TEMPLATE_CPU_ID) || defined(RSEQ_TEMPLATE_MM_CID)) */

#include "rseq-bits-reset.h"