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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)sigreturn.2 8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: head/lib/libc/sys/sigreturn.2 255296 2013-09-06 09:08:40Z jilles $
  30 .\"
  31 .Dd July 20, 2016
  32 .Dt SIGRETURN 2
  33 .Os
  34 .Sh NAME
  35 .Nm sigreturn
  36 .Nd return from signal
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In signal.h
  41 .Ft int
  42 .Fn sigreturn "ucontext_t *scp"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn sigreturn
  46 system call
  47 allows users to atomically unmask, switch stacks,
  48 and return from a signal context.
  49 The thread's signal mask and stack status are
  50 restored from the context structure pointed to by
  51 .Fa scp .
  52 The system call does not return;
  53 the users stack pointer, frame pointer, argument pointer,
  54 and processor status longword are restored from the context.
  55 Execution resumes at the specified pc.
  56 This system call is used by the trampoline code and
  57 .Xr longjmp 3
  58 when returning from a signal to the previously executing program.
  59 .Sh RETURN VALUES
  60 If successful, the system call does not return.
  61 Otherwise, a value of -1 is returned and
  62 .Va errno
  63 is set to indicate the error.
  64 .Sh ERRORS
  65 The
  66 .Fn sigreturn
  67 system call
  68 will fail and the thread context will remain unchanged
  69 if one of the following occurs.
  70 .Bl -tag -width Er
  71 .It Bq Er EFAULT
  72 The
  73 .Fa scp
  74 argument
  75 points to memory that is not a valid part of the process
  76 address space.
  77 .It Bq Er EINVAL
  78 The process status longword is invalid or would improperly
  79 raise the privilege level of the process.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr sigaction 2 ,
  83 .Xr setjmp 3 ,
  84 .Xr ucontext 3
  85 .Sh HISTORY
  86 The
  87 .Fn sigreturn
  88 system call appeared in
  89 .Bx 4.3 .