xref: /illumos-gate/usr/src/man/man3c/stack_getbounds.3c (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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_GETBOUNDS 3C "Jul 18, 2002"
NAME
stack_getbounds - retrieve stack boundaries
SYNOPSIS

#include <ucontext.h>

int stack_getbounds(stack_t *sp);
DESCRIPTION

The stack_getbounds() function retrieves the stack boundaries that the calling thread is currently operating on. If the thread is currently operating on the alternate signal stack, this function will retrieve the bounds of that stack.

If successful, stack_getbounds() sets the ss_sp member of the stack_t structure pointed to by sp to the base of the stack region and the ss_size member to its size (maximum extent) in bytes. The ss_flags member is set to SS_ONSTACK if the calling thread is executing on its alternate signal stack, and zero otherwise.

RETURN VALUES

Upon successful completion, stack_getbounds() returns 0. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The stack_getbounds() function will fail if: EFAULT

The sp argument does not refer to a valid address.

ATTRIBUTES

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

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

getustack (2), sigaction (2), sigaltstack (2), stack_setbounds (3C), attributes (7)