src/vppinfra/longjmp.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16   Copyright (c) 2005 Eliot Dresselhaus
  17
  18   Permission is hereby granted, free of charge, to any person obtaining
  19   a copy of this software and associated documentation files (the
  20   "Software"), to deal in the Software without restriction, including
  21   without limitation the rights to use, copy, modify, merge, publish,
  22   distribute, sublicense, and/or sell copies of the Software, and to
  23   permit persons to whom the Software is furnished to do so, subject to
  24   the following conditions:
  25
  26   The above copyright notice and this permission notice shall be
  27   included in all copies or substantial portions of the Software.
  28
  29   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  33   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  34   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  35   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  36 */
  37
  38 #ifndef included_clib_longjmp_h
  39 #define included_clib_longjmp_h
  40
  41 #include <vppinfra/types.h>
  42
  43 #if defined(__x86_64__)
  44 /* rbx, rbp, r12, r13, r14, r15, eip, rsp */
  45 #define CLIB_ARCH_LONGJMP_REGS 8
  46
  47 #elif defined(i386)
  48 /* ebx, ebp, esi, edi, eip, rsp */
  49 #define CLIB_ARCH_LONGJMP_REGS 6
  50
  51 #elif (defined(__powerpc64__) || defined(__powerpc__))
  52
  53 #ifdef __ALTIVEC__
  54 #define CLIB_POWERPC_ALTIVEC_N_REGS 12
  55 #else
  56 #define CLIB_POWERPC_ALTIVEC_N_REGS 0
  57 #endif
  58
  59 /* r1 r2 link condition+vsave regs 14-31 fp regs 14-31 vector regs 20-31 */
  60 #define CLIB_ARCH_LONGJMP_REGS                          \
  61   (/* r1 lr cr vrsave */                                \
  62    4                                                    \
  63    /* gp */                                             \
  64    + (31 - 14 + 1)                                      \
  65    /* fp */                                             \
  66    + (sizeof (f64) / sizeof (uword)) * (31 - 14 + 1)    \
  67    /* vector regs */                                    \
  68    + (16 / sizeof (uword)) * CLIB_POWERPC_ALTIVEC_N_REGS)
  69
  70 #elif defined(__SPU__)
  71 /* FIXME */
  72 #define CLIB_ARCH_LONGJMP_REGS (10)
  73
  74 #elif defined(__arm__)
  75
  76 #ifndef __IWMMXT__
  77 /* v1-v6 sl fp sp lr */
  78 #define CLIB_ARCH_LONGJMP_REGS (10)
  79 #else
  80 /* For iwmmxt we save 6 extra 8 byte registers. */
  81 #define CLIB_ARCH_LONGJMP_REGS (10 + (6*2))
  82 #endif
  83
  84 #elif defined(__xtensa__)
  85
  86 /* setjmp/longjmp not supported for the moment. */
  87 #define CLIB_ARCH_LONGJMP_REGS 0
  88
  89 #elif defined(__TMS320C6X__)
  90
  91 /* setjmp/longjmp not supported for the moment. */
  92 #define CLIB_ARCH_LONGJMP_REGS 0
  93
  94 #elif defined(__aarch64__)
  95 #define CLIB_ARCH_LONGJMP_REGS (22)
  96 #elif defined(_mips) && __mips == 64
  97 #define CLIB_ARCH_LONGJMP_REGS (12)
  98 #elif defined(__riscv)
  99 /* ra, sp, s0-s11, fs0-fs11 */
 100 #define CLIB_ARCH_LONGJMP_REGS (26)
 101 #else
 102 #error "unknown machine"
 103 #endif
 104
 105 typedef struct
 106 {
 107   uword regs[CLIB_ARCH_LONGJMP_REGS];
 108 } clib_longjmp_t __attribute__ ((aligned (16)));
 109
 110 /* Return given value to saved context. */
 111 void clib_longjmp (clib_longjmp_t * save, uword return_value);
 112
 113 /* Save context.  Returns given value if jump is not taken;
 114    otherwise returns value from clib_longjmp if long jump is taken. */
 115 uword clib_setjmp (clib_longjmp_t * save, uword return_value_not_taken);
 116
 117 /* Call function on given stack. */
 118 uword clib_calljmp (uword (*func) (uword func_arg),
 119                     uword func_arg, void *stack);
 120
 121 #endif /* included_clib_longjmp_h */
 122
 123 /*
 124  * fd.io coding-style-patch-verification: ON
 125  *
 126  * Local Variables:
 127  * eval: (c-set-style "gnu")
 128  * End:
 129  */