man0p/ucontext.h.0p

   1 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   2 .TH "<ucontext.h>" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   3 .\" <ucontext.h>
   4 .SH NAME
   5 ucontext.h \- user context
   6 .SH SYNOPSIS
   7 .LP
   8 \fB#include <ucontext.h> \fP
   9 .SH DESCRIPTION
  10 .LP
  11 The \fI<ucontext.h>\fP header shall define the \fBmcontext_t\fP type
  12 through \fBtypedef\fP.
  13 .LP
  14 The \fI<ucontext.h>\fP header shall define the \fBucontext_t\fP type
  15 as a structure that shall include at least the
  16 following members:
  17 .sp
  18 .RS
  19 .nf
  20
  21 \fBucontext_t *uc_link    \fP Pointer to the context that is resumed \fB
  22                        \fP when this context returns. \fB
  23 sigset_t    uc_sigmask \fP The set of signals that are blocked when this \fB
  24                        \fP context is active. \fB
  25 stack_t     uc_stack   \fP The stack used by this context. \fB
  26 mcontext_t  uc_mcontext\fP A machine-specific representation of the saved \fB
  27                        \fP context. \fB
  28 \fP
  29 .fi
  30 .RE
  31 .LP
  32 The types \fBsigset_t\fP and \fBstack_t\fP shall be defined as in
  33 \fI<signal.h>\fP .
  34 .LP
  35 The following shall be declared as functions and may also be defined
  36 as macros, Function prototypes shall be provided.
  37 .sp
  38 .RS
  39 .nf
  40
  41 \fBint  getcontext(ucontext_t *);
  42 int  setcontext(const ucontext_t *);
  43 void makecontext(ucontext_t *, void (*)(void), int, ...);
  44 int  swapcontext(ucontext_t *restrict, const ucontext_t *restrict);
  45 \fP
  46 .fi
  47 .RE
  48 .LP
  49 \fIThe following sections are informative.\fP
  50 .SH APPLICATION USAGE
  51 .LP
  52 None.
  53 .SH RATIONALE
  54 .LP
  55 None.
  56 .SH FUTURE DIRECTIONS
  57 .LP
  58 None.
  59 .SH SEE ALSO
  60 .LP
  61 \fI<signal.h>\fP , the System Interfaces volume of IEEE\ Std\ 1003.1-2001,
  62 \fIgetcontext\fP(), \fImakecontext\fP(), \fIsigaction\fP(), \fIsigprocmask\fP(),
  63 \fIsigaltstack\fP()
  64 .SH COPYRIGHT
  65 Portions of this text are reprinted and reproduced in electronic form
  66 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
  67 -- Portable Operating System Interface (POSIX), The Open Group Base
  68 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
  69 Electrical and Electronics Engineers, Inc and The Open Group. In the
  70 event of any discrepancy between this version and the original IEEE and
  71 The Open Group Standard, the original IEEE and The Open Group Standard
  72 is the referee document. The original Standard can be obtained online at
  73 http://www.opengroup.org/unix/online.html .