2.11BSD/src/man/man2/sigreturn.2

.\" Copyright (c) 1985 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"	@(#)sigreturn.2	6.2 (Berkeley) 6/30/85
.\"
.TH SIGRETURN 2 "June 30, 1985"
.UC 6
.SH NAME
sigreturn \- return from signal
.SH SYNOPSIS
.nf
.B #include <signal.h>
.PP
.B struct	sigcontext {
.B 	int	sc_onstack;
.B 	long	sc_mask;
.B 	int	sc_sp;
.B 	int	sc_fp;
.B 	int	sc_ap;
.B 	int	sc_pc;
.B 	int	sc_ps;
.B };
.PP
.B sigreturn(scp);
.B struct sigcontext *scp;
.SH DESCRIPTION
.I Sigreturn
allows users to atomically unmask, switch stacks,
and return from a signal context.
The processes signal mask and stack status are
restored from the context.
The system call does not return;
the users stack pointer, frame pointer, argument pointer,
and processor status longword are restored from the context.
Execution resumes at the specified pc.
This system call is used by the trampoline code, and
.IR longjmp (3)
when returning from a signal to the previously executing program.
.SH NOTES
This system call is not available in 4.2BSD,
hence it should not be used if backward compatibility is needed.
.PP
The definition of the
.I sigcontext
structure is machine dependent (the structure cited above is that for a VAX
running 4.3BSD); no program should depend on its internal structure.
.IR Setjmp (3)
may be used to build sigcontext structures in a machine independent manner.
.SH "RETURN VALUE
If successful, the system call does not return.
Otherwise, a value of \-1 is returned and 
.I errno
is set to indicate the error.
.SH ERRORS
.I Sigreturn
will fail and the process context will remain unchanged
if one of the following occurs.
.TP 15
[EFAULT]
.I Scp
points to memory that is not a valid part of the process
address space.
.TP
[EINVAL]
The process status longword is invalid or would improperly
raise the privilege level of the process.
.SH "SEE ALSO"
sigvec(2), setjmp(3)
.SH "NOTES  (PDP-11)"
On the PDP-11 the field \fIsc_ap\fP (argument pointer) does not exist and
the field \fIsc_fp\fP (frame pointer) is the PDP-11 register \fIr5\fP.
Additionally, three new fields \fIsc_r0\fP, \fIsc_r1\fP and \fIsc_ovno\fP are
present on the PDP-11 which hold register values r0 and r1 and the text
overlay number to restore (see \fIld\fP(1)).
.nf
.ta \w' struct 'u +\w'long  'u +\w'sc_onstack  'u
.PP
.B struct	sigcontext {
.B 	int	sc_onstack;		/* sigstack state to restore */
.B 	long	sc_mask;		/* signal mask to restore */
.B 	int	sc_sp;			/* sp to restore */
.B 	int	sc_fp;			/* fp to restore */
.B 	int	sc_r1;			/* r1 to restore */
.B 	int	sc_r0;			/* r0 to restore */
.B 	int	sc_pc;			/* pc to restore */
.B 	int	sc_ps;			/* psl to restore */
.B 	int	sc_ovno			/* overlay to restore */
.B };