xref: /illumos-gate/usr/src/man/man3c/stack_violation.3c (revision 4f364e7c95ee7fd9d5bbeddc1940e92405bb0e72)
te
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
STACK_VIOLATION 3C "Jul 18, 2002"
NAME
stack_violation - determine stack boundary violation event
SYNOPSIS

#include <ucontext.h>

int stack_violation(int sig, const siginfo_t *sip,
 const ucontext_t *ucp);
DESCRIPTION

The stack_violation() function returns a boolean value indicating whether the signal, sig, and accompanying signal information, sip, and saved context, ucp, represent a stack boundary violation event or a stack overflow.

RETURN VALUES

The stack_violation() function returns 0 if the signal does not represent a stack boundary violation event and 1 if the signal does represent a stack boundary violation event.

ERRORS

No errors are defined.

EXAMPLES

Example 1 Set up a signal handler to run on an alternate stack.

The following example sets up a signal handler for SIGSEGV to run on an alternate signal stack. For each signal it handles, the handler emits a message to indicate if the signal was produced due to a stack boundary violation.

#include <stdlib.h>
#include <unistd.h>
#include <ucontext.h>
#include <signal.h>


static void
handler(int sig, siginfo_t *sip, void *p)
{
 ucontext_t *ucp = p;
 const char *str;

 if (stack_violation(sig, sip, ucp))
 str = "stack violation.\en";
 else
 str = "no stack violation.\en";

 (void) write(STDERR_FILENO, str, strlen(str));

 exit(1);
}

int
main(int argc, char **argv)
{
 struct sigaction sa;
 stack_t altstack;

 altstack.ss_size = SIGSTKSZ;
 altstack.ss_sp = malloc(SIGSTKSZ);
 altstack.ss_flags = 0;

 (void) sigaltstack(&altstack, NULL);

 sa.sa_sigaction = handler;
 (void) sigfillset(&sa.sa_mask);
 sa.sa_flags = SA_ONSTACK | SA_SIGINFO;
 (void) sigaction(SIGSEGV, &sa, NULL);

 /*
 * The application is now set up to use stack_violation(3C).
 */

 return (0);
}
USAGE

An application typically uses stack_violation() in a signal handler that has been installed for SIGSEGV using sigaction(2) with the SA_SIGINFO flag set and is configured to run on an alternate signal stack.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level Async-Signal-Safe
SEE ALSO

sigaction(2), sigaltstack(2), stack_getbounds(3C), stack_inbounds(3C), stack_setbounds(3C), attributes(5)