sys/sys/ucontext.h

   1 /*-
   2  * Copyright (c) 1999 Marcel Moolenaar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer
  10  *    in this position and unchanged.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote products
  15  *    derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _SYS_UCONTEXT_H_
  32 #define _SYS_UCONTEXT_H_
  33
  34 #include <sys/signal.h>
  35 #include <machine/ucontext.h>
  36
  37 typedef struct __ucontext {
  38         /*
  39          * Keep the order of the first two fields. Also,
  40          * keep them the first two fields in the structure.
  41          * This way we can have a union with struct
  42          * sigcontext and ucontext_t. This allows us to
  43          * support them both at the same time.
  44          * note: the union is not defined, though.
  45          */
  46         sigset_t        uc_sigmask;
  47         mcontext_t      uc_mcontext;
  48
  49         struct __ucontext *uc_link;
  50         stack_t         uc_stack;
  51         int             uc_flags;
  52 #define UCF_SWAPPED     0x00000001      /* Used by swapcontext(3). */
  53         int             __spare__[4];
  54 } ucontext_t;
  55
  56 #if defined(_KERNEL) && defined(COMPAT_FREEBSD4)
  57 #if defined(__i386__)
  58 struct ucontext4 {
  59         sigset_t        uc_sigmask;
  60         struct mcontext4 uc_mcontext;
  61         struct ucontext4 *uc_link;
  62         stack_t         uc_stack;
  63         int             __spare__[8];
  64 };
  65 #else   /* __i386__ */
  66 #define ucontext4 ucontext
  67 #endif  /* __i386__ */
  68 #endif  /* _KERNEL */
  69
  70 #ifndef _KERNEL
  71
  72 __BEGIN_DECLS
  73
  74 int     getcontext(ucontext_t *) __returns_twice;
  75 ucontext_t *getcontextx(void);
  76 int     setcontext(const ucontext_t *);
  77 void    makecontext(ucontext_t *, void (*)(void), int, ...);
  78 int     signalcontext(ucontext_t *, int, __sighandler_t *);
  79 int     swapcontext(ucontext_t *, const ucontext_t *);
  80
  81 #if __BSD_VISIBLE
  82 int __getcontextx_size(void);
  83 int __fillcontextx(char *ctx) __returns_twice;
  84 int __fillcontextx2(char *ctx);
  85 #endif
  86
  87 __END_DECLS
  88
  89 #else /* _KERNEL */
  90
  91 struct thread;
  92
  93 /*
  94  * Flags for get_mcontext().  The low order 4 bits (i.e a mask of 0x0f) are
  95  * reserved for use by machine independent code.  All other bits are for use
  96  * by machine dependent code.
  97  */
  98 #define GET_MC_CLEAR_RET        1
  99
 100 /* Machine-dependent functions: */
 101 int     get_mcontext(struct thread *, mcontext_t *, int);
 102 int     set_mcontext(struct thread *, const mcontext_t *);
 103
 104 #endif /* !_KERNEL */
 105
 106 #endif /* !_SYS_UCONTEXT_H_ */