6/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 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SIGRETURN 2
  37 .Os
  38 .Sh NAME
  39 .Nm sigreturn
  40 .Nd return from signal
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In signal.h
  45 .Ft int
  46 .Fn sigreturn "ucontext_t *scp"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn sigreturn
  50 system call
  51 allows users to atomically unmask, switch stacks,
  52 and return from a signal context.
  53 The processes signal mask and stack status are
  54 restored from the context structure pointed to by
  55 .Fa scp .
  56 The system call does not return;
  57 the users stack pointer, frame pointer, argument pointer,
  58 and processor status longword are restored from the context.
  59 Execution resumes at the specified pc.
  60 This system call is used by the trampoline code and
  61 .Xr longjmp 3
  62 when returning from a signal to the previously executing program.
  63 .Sh NOTES
  64 This system call is not available in
  65 .Bx 4.2
  66 hence it should not be used if backward compatibility is needed.
  67 .Sh RETURN VALUES
  68 If successful, the system call does not return.
  69 Otherwise, a value of -1 is returned and
  70 .Va errno
  71 is set to indicate the error.
  72 .Sh ERRORS
  73 The
  74 .Fn sigreturn
  75 system call
  76 will fail and the process context will remain unchanged
  77 if one of the following occurs.
  78 .Bl -tag -width Er
  79 .It Bq Er EFAULT
  80 The
  81 .Fa scp
  82 argument
  83 points to memory that is not a valid part of the process
  84 address space.
  85 .It Bq Er EINVAL
  86 The process status longword is invalid or would improperly
  87 raise the privilege level of the process.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr sigvec 2 ,
  91 .Xr setjmp 3 ,
  92 .Xr ucontext 3
  93 .Sh HISTORY
  94 The
  95 .Fn sigreturn
  96 system call appeared in
  97 .Bx 4.3 .