usr/src/man/man3c/stack_inbounds.3c

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH STACK_INBOUNDS 3C "Jul 18, 2002"
   7 .SH NAME
   8 stack_inbounds \- determine if address is within stack boundaries
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <ucontext.h>
  13
  14 \fBint\fR \fBstack_inbounds\fR(\fBvoid *\fR\fIaddr\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBstack_inbounds()\fR function returns a boolean value indicating whether
  21 the address specified by \fIaddr\fR is within the boundaries of the stack of
  22 the calling thread. The address is compared to the stack boundary information
  23 returned by a call to \fBstack_getbounds\fR(3C).
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBstack_inbounds()\fR function returns 0 to indicate that \fIaddr\fR is
  28 not within the current stack bounds, or a non-zero value to indicate that
  29 \fIaddr\fR is within the stack bounds.
  30 .SH ERRORS
  31 .sp
  32 .LP
  33 No errors are defined.
  34 .SH ATTRIBUTES
  35 .sp
  36 .LP
  37 See \fBattributes\fR(5) for descriptions of the following attributes:
  38 .sp
  39
  40 .sp
  41 .TS
  42 box;
  43 c | c
  44 l | l .
  45 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  46 _
  47 Interface Stability     Evolving
  48 _
  49 MT-Level        Async-Signal-Safe
  50 .TE
  51
  52 .SH SEE ALSO
  53 .sp
  54 .LP
  55 \fBstack_getbounds\fR(3C), \fBattributes\fR(5)