lib/libc/sys/sigreturn.2

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)sigreturn.2 8.1 (Berkeley) 6/4/93
  33 .\"
  34 .Dd June 4, 1993
  35 .Dt SIGRETURN 2
  36 .Os BSD 4.3
  37 .Sh NAME
  38 .Nm sigreturn
  39 .Nd return from signal
  40 .Sh SYNOPSIS
  41 .Fd #include <signal.h>
  42 .Bd -literal
  43 struct  sigcontext {
  44         int     sc_onstack;             /* sigstack state to restore */
  45         int     sc_mask;                /* signal mask to restore */
  46         int     sc_esp;                 /* machine state */
  47         int     sc_ebp;
  48         int     sc_isp;
  49         int     sc_eip;
  50         int     sc_efl;
  51         int     sc_es;
  52         int     sc_ds;
  53         int     sc_cs;
  54         int     sc_ss;
  55         int     sc_edi;
  56         int     sc_esi;
  57         int     sc_ebx;
  58         int     sc_edx;
  59         int     sc_ecx;
  60         int     sc_eax;
  61 #  define sc_sp sc_esp
  62 #  define sc_fp sc_ebp
  63 #  define sc_pc sc_eip
  64 #  define sc_ps sc_efl
  65 };
  66 .Ed
  67 .Ft int
  68 .Fn sigreturn "struct sigcontext *scp"
  69 .Sh DESCRIPTION
  70 .Fn Sigreturn
  71 allows users to atomically unmask, switch stacks,
  72 and return from a signal context.
  73 The processes signal mask and stack status are
  74 restored from the context.
  75 The system call does not return;
  76 the users stack pointer, frame pointer, argument pointer,
  77 and processor status longword are restored from the context.
  78 Execution resumes at the specified pc.
  79 This system call is used by the trampoline code and
  80 .Xr longjmp 3
  81 when returning from a signal to the previously executing program.
  82 .Sh NOTES
  83 This system call is not available in 4.2
  84 .Tn BSD
  85 hence it should not be used if backward compatibility is needed.
  86 .Sh RETURN VALUES
  87 If successful, the system call does not return.
  88 Otherwise, a value of -1 is returned and
  89 .Va errno
  90 is set to indicate the error.
  91 .Sh ERRORS
  92 .Fn Sigreturn
  93 will fail and the process context will remain unchanged
  94 if one of the following occurs.
  95 .Bl -tag -width [EINVAL]
  96 .It Bq Er EFAULT
  97 .Fa Scp
  98 points to memory that is not a valid part of the process
  99 address space.
 100 .It Bq Er EINVAL
 101 The process status longword is invalid or would improperly
 102 raise the privilege level of the process.
 103 .El
 104 .Sh SEE ALSO
 105 .Xr sigvec 2 ,
 106 .Xr setjmp 3
 107 .Sh HISTORY
 108 The
 109 .Fn sigreturn
 110 function call appeared in
 111 .Bx 4.3 .