share/man/man9/man9.i386/return_address.9

   1 .\"     $NetBSD: return_address.9,v 1.1 2009/11/03 05:08:18 dyoung Exp $
   2 .\"
   3 .\" Copyright (c) 2009 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by David Young.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd November 2, 2009
  31 .Dt RETURN_ADDRESS 9 i386
  32 .Os
  33 .Sh NAME
  34 .Nm return_address
  35 .Nd return address from call stack
  36 .Sh SYNOPSIS
  37 .In i386/return.h
  38 .Ft void *
  39 .Fn return_address "unsigned int level"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 function evaluates to the first return address on the call stack
  44 if
  45 .Fa level
  46 equals 0, or else
  47 to the return address for the stack frame
  48 .Fa level
  49 frames down.
  50 .Pp
  51 This function is intended to be called by diagnostic code to record
  52 the call stack.
  53 .Pp
  54 A special fault handler stops
  55 .Nm
  56 from crashing the kernel by examining a non-existent or corrupt stack
  57 frame.
  58 .Pp
  59 Kernel compilation options affect both the ability of
  60 .Nm
  61 to locate return addresses on the stack, and the programmer's
  62 ability to interpret the addresses.
  63 The compiler may optimize away the stack frame pointers that
  64 .Nm
  65 depends on.
  66 To use
  67 .Nm
  68 effecively, try a kernel configuration option such as
  69 .Bd -literal
  70 makeoptions     DEBUG="-g -fno-omit-frame-pointer -fno-optimize-sibling-calls -O0"
  71 .Ed
  72 .Sh RETURN VALUES
  73 .Nm
  74 returns the
  75 requested return address, or
  76 .Dv NULL
  77 if it cannot dissect the call stack.
  78 .Sh CODE REFERENCES
  79 .Pa sys/arch/i386/i386/copy.S ,
  80 .Pa sys/arch/i386/include/return.h
  81 .Sh REFERENCES
  82 .Xr config 5
  83 .Sh HISTORY
  84 .Nm
  85 first appeared in
  86 .Nx 6.0 .
  87 .Sh AUTHORS
  88 .An "David Young" Aq dyoung@NetBSD.org