xref: /illumos-gate/usr/src/man/man3c/thr_stksegment.3c (revision 66582b606a8194f7f3ba5b3a3a6dca5b0d346361)
te
Copyright (c) 2000 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]
THR_STKSEGMENT 3C "Jun 15, 2000"
NAME
thr_stksegment - get thread stack address and size
SYNOPSIS

cc -mt [ flag... ] file...[ library... ]
#include <thread.h>
#include <signal.h>

int thr_stksegment(stack_t *ss);
DESCRIPTION

The thr_stksegment() function returns, in its stack_t argument, the address and size of the calling thread's stack.

The stack_t structure includes the following members:

void *ss_sp
size_t ss_size
int ss_flags

On successful return from thr_stksegment(), ss_sp contains the high address of the caller's stack and ss_size contains the size of the stack in bytes. The ss_flags member is always 0. Note that the meaning of ss_sp is reversed from other uses of stack_t such as sigaltstack(2) where ss_sp is the low address.

The stack information provided by thr_stksegment() is typically used by debuggers, garbage collectors, and similar applications. Most applications should not require such information.

RETURN VALUES

The thr_stksegment() function returns 0 if the thread stack address and size were successfully retrieved. Otherwise, it returns a non-zero error value.

ERRORS

The thr_stksegment() function will fail if: EAGAIN

The stack information for the thread is not available because the thread's initialization is not yet complete, or the thread is an internal thread.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

sigaltstack(2), thr_create(3C), attributes(5)