m2-internship/libunwind-eh_elf
1
0
Fork 0
mirror of https://github.com/tobast/libunwind-eh_elf.git synced 2024-09-28 17:39:29 +02:00
Code Issues Releases Activity

Regenerate.

Browse source 
(Logical change 1.139)
This commit is contained in:
mostang.com!davidm 2003-12-10 07:14:38 +00:00
parent e91ef29727
commit 3dba28237d
2 changed files with 71 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
doc/Makefile.in
View file

@ -102,31 +102,33 @@ arch = @arch@
install_sh = @install_sh@ install_sh = @install_sh@
# man pages that go into section 3: # man pages that go into section 3:
man3_MANS = libunwind.man libunwind-ia64.man \ man3_MANS = libunwind.man libunwind-dynamic.man libunwind-ia64.man \
libunwind-ptrace.man libunwind-setjmp.man \ libunwind-ptrace.man libunwind-setjmp.man \
unw_flush_cache.man \ unw_flush_cache.man \
unw_get_accessors.man \ unw_get_accessors.man \
unw_get_proc_info.man \ unw_get_proc_info.man \
unw_get_proc_info_by_ip.man \ unw_get_proc_info_by_ip.man \
unw_get_proc_name.man \ unw_get_proc_name.man \
unw_get_fpreg.man \ unw_get_fpreg.man \
unw_get_reg.man \ unw_get_reg.man \
unw_getcontext.man \ unw_getcontext.man \
unw_init_local.man unw_init_remote.man \ unw_init_local.man unw_init_remote.man \
unw_is_fpreg.man \ unw_is_fpreg.man \
unw_is_signal_frame.man \ unw_is_signal_frame.man \
unw_create_addr_space.man \ unw_create_addr_space.man \
unw_destroy_addr_space.man \ unw_destroy_addr_space.man \
unw_regname.man unw_resume.man \ unw_regname.man unw_resume.man \
unw_set_caching_policy.man \ unw_set_caching_policy.man \
unw_set_fpreg.man \ unw_set_fpreg.man \
unw_set_reg.man \ unw_set_reg.man \
unw_step.man unw_step.man \
_U_dyn_register.man \
_U_dyn_cancel.man
EXTRA_DIST = NOTES libunwind.trans \ EXTRA_DIST = NOTES libunwind.trans \
libunwind.tex libunwind-ia64.tex libunwind-ptrace.tex \ libunwind.tex libunwind-dynamic.tex libunwind-ia64.tex \
libunwind-setjmp.tex \ libunwind-ptrace.tex libunwind-setjmp.tex \
unw_flush_cache.tex \ unw_flush_cache.tex \
unw_get_accessors.tex \ unw_get_accessors.tex \
unw_get_proc_info.tex \ unw_get_proc_info.tex \
@ -143,6 +145,8 @@ EXTRA_DIST = NOTES libunwind.trans \
unw_set_fpreg.tex \ unw_set_fpreg.tex \
unw_set_reg.tex \ unw_set_reg.tex \
unw_step.tex \ unw_step.tex \
_U_dyn_register.tex \
_U_dyn_cancel.tex \
$(man3_MANS) $(man3_MANS)

79
doc/libunwind.man
View file

@ -1,5 +1,5 @@
'\" t '\" t
.\" Manual page created with latex2man on Mon Mar 31 14:18:01 PST 2003 .\" Manual page created with latex2man on Tue Dec 9 23:06:05 PST 2003
.\" NOTE: This file is generated, DO NOT EDIT. .\" NOTE: This file is generated, DO NOT EDIT.
.de Vb .de Vb
.ft CW .ft CW
@ -10,7 +10,7 @@
.fi .fi
.. ..
.TH "LIBUNWIND" "3" "31 March 2003" "Programming Library " "Programming Library " .TH "LIBUNWIND" "3" "09 December 2003" "Programming Library " "Programming Library "
.SH NAME .SH NAME
libunwind libunwind
\-\- a (mostly) platform\-independent unwind API \-\- a (mostly) platform\-independent unwind API
@ -145,32 +145,32 @@ some sort of error has occurred.
.PP .PP
While it is not possible to directly move the unwind cursor in the While it is not possible to directly move the unwind cursor in the
``down\&'' direction (towards newer stack frames), this effect can be ``down\&'' direction (towards newer stack frames), this effect can be
achieved by making copyies of an unwind cursor. For example, a achieved by making copies of an unwind cursor. For example, a program
program that sometimes has to move ``down\&'' by one stack frame could that sometimes has to move ``down\&'' by one stack frame could maintain
maintain two cursor variables: ``curr\&'' two cursor variables: ``curr\&''
and ``prev\&''\&. and ``prev\&''\&.
The The former
former would be used as the current cursor and prev would be used as the current cursor and prev
would be would be maintained
maintained as the ``previous frame\&'' cursor by copying the contents of as the ``previous frame\&'' cursor by copying the contents of curr
curr
to prev to prev
right before calling unw_step(). right before calling unw_step().
With this approach, the program could move one step ``down\&'' simply by With this
copying back prev approach, the program could move one step ``down\&'' simply by copying
back prev
to curr to curr
whenever that is necessary. In whenever that is necessary. In the most
the mosts extreme case, a program could maintain a separate cursor for extreme case, a program could maintain a separate cursor for each call
each call frame and that way it could move up and down the call frame frame and that way it could move up and down the callframe\-chain at
chain at will. will.
.PP .PP
Given an unwind cursor, it is possible to read and write the CPU Given an unwind cursor, it is possible to read and write the CPU
registers that were preserved for the current stack frame identified registers that were preserved for the current stack frame (as
by the cursor. Libunwind identified by the cursor). Libunwind
provides several routines for this provides several routines
purpose: unw_get_reg() for this purpose: unw_get_reg()
reads an integer (general) register, reads an integer (general)
unw_get_fpreg() register, unw_get_fpreg()
reads a floating\-point register, reads a floating\-point register,
unw_set_reg() unw_set_reg()
writes an integer register, and writes an integer register, and
@ -217,7 +217,7 @@ select this optimized version, simply define the macro
UNW_LOCAL_ONLY UNW_LOCAL_ONLY
before including the headerfile before including the headerfile
<libunwind.h>\&. <libunwind.h>\&.
If is perfectly OK for a single program to It is perfectly OK for a single program to
employ both local\-only and generic unwinding. That is, whether or not employ both local\-only and generic unwinding. That is, whether or not
UNW_LOCAL_ONLY UNW_LOCAL_ONLY
is defined is a choice that each source\-file is defined is a choice that each source\-file
@ -225,12 +225,16 @@ is defined is a choice that each source\-file
of UNW_LOCAL_ONLY, of UNW_LOCAL_ONLY,
you\&'ll always link the same library into you\&'ll always link the same library into
the program (normally \fB\-l\fPunwind). the program (normally \fB\-l\fPunwind).
Furthermore, the
portion of libunwind
that manages unwind\-info for dynamically
generated code is not affected by the setting of
UNW_LOCAL_ONLY\&.
.PP .PP
If we put all of the above together, here is how we could use If we put all of the above together, here is how we could use
libunwind libunwind
write function show_backtrace() to write a function ``show_backtrace()\&''
which prints which prints a classic stack trace:
a classic stack trace:
.PP .PP
.Vb .Vb
#define UNW_LOCAL_ONLY #define UNW_LOCAL_ONLY
@ -245,7 +249,7 @@ void show_backtrace (void) {
while (unw_step(&cursor) > 0) { while (unw_step(&cursor) > 0) {
unw_get_reg(&cursor, UNW_REG_IP, &ip); unw_get_reg(&cursor, UNW_REG_IP, &ip);
unw_get_reg(&cursor, UNW_REG_SP, &sp); unw_get_reg(&cursor, UNW_REG_SP, &sp);
printf ("ip = 0, sp = 0\\n", (long) ip, (long) sp); printf ("ip = %lx, sp = %lx\\n", (long) ip, (long) sp);
} }
} }
.Ve .Ve
@ -263,7 +267,7 @@ used by debuggers and instruction\-set simulators, for example.
.PP .PP
Before you can unwind a remote process, you need to create a new Before you can unwind a remote process, you need to create a new
address\-space object for that process. This is achieved with the address\-space object for that process. This is achieved with the
unw_create_addr_space unw_create_addr_space()
routine. The routine takes two routine. The routine takes two
arguments: a pointer to a set of \fIaccessor\fP arguments: a pointer to a set of \fIaccessor\fP
routines and an routines and an
@ -282,13 +286,13 @@ except that it takes an address\-space
object and an opaque pointer as arguments. The routine uses these object and an opaque pointer as arguments. The routine uses these
arguments to fetch the initial machine state. Libunwind arguments to fetch the initial machine state. Libunwind
never never
uses the opaque pointer on its own, but instead justs passes it on to uses the opaque pointer on its own, but instead just passes it on to
the accessor (callback) routines. Typically, this pointer is used to the accessor (callback) routines. Typically, this pointer is used to
select, e.g., the thread within a process that is to be unwound. select, e.g., the thread within a process that is to be unwound.
.PP .PP
Once a cursor has been initialized with unw_init_remote(), Once a cursor has been initialized with unw_init_remote(),
unwinding works exactly like in the local case. That is, you can use unwinding works exactly like in the local case. That is, you can use
unw_step unw_step()
to move ``up\&'' in the call\-chain, read and write to move ``up\&'' in the call\-chain, read and write
registers, or resume execution at a particular stack frame by calling registers, or resume execution at a particular stack frame by calling
unw_resume\&. unw_resume\&.
@ -314,7 +318,7 @@ unwinding. If they differ, we call it
unwinding. unwinding.
.PP .PP
The principle behind supporting native, cross\-platform, and The principle behind supporting native, cross\-platform, and
multi\-platform unwinding are very simple: for native unwinding, a multi\-platform unwinding is very simple: for native unwinding, a
program includes <libunwind.h> program includes <libunwind.h>
and uses the linker switch and uses the linker switch
\fB\-l\fPunwind\&. \fB\-l\fPunwind\&.
@ -375,7 +379,7 @@ routines are guaranteed to be signal\-safe.
Libunwind Libunwind
provides the routines _U_dyn_register() provides the routines _U_dyn_register()
and and
_U_dyn_cancel _U_dyn_cancel()
to register/cancel the information required to to register/cancel the information required to
unwind through code that has been generated at runtime (e.g., by a unwind through code that has been generated at runtime (e.g., by a
just\-in\-time (JIT) compiler). It is important to register the just\-in\-time (JIT) compiler). It is important to register the
@ -392,6 +396,10 @@ data\-structure encapsulating the dynamic unwind info has been designed
to facilitate sharing, such that similar procedures can share much of to facilitate sharing, such that similar procedures can share much of
the underlying information. the underlying information.
.PP .PP
For more information on the libunwind
support for dynamically
generated code, see libunwind\-dynamic(3)\&.
.PP
.SH CACHING OF UNWIND INFO .SH CACHING OF UNWIND INFO
.PP .PP
@ -432,7 +440,7 @@ platform) unwinding.
.TP .TP
libunwind\-PLAT\&.h libunwind\-PLAT\&.h
Headerfile to include when Headerfile to include when
unwind target runs on platform PLAT\&. the unwind target runs on platform PLAT\&.
For example, to unwind For example, to unwind
an IA\-64 program, the header file libunwind\-ia64.h an IA\-64 program, the header file libunwind\-ia64.h
should be should be
@ -454,6 +462,7 @@ multiple platforms.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
libunwind\-dynamic(3),
libunwind\-ia64(3), libunwind\-ia64(3),
libunwind\-ptrace(3), libunwind\-ptrace(3),
libunwind\-setjmp(3), libunwind\-setjmp(3),
@ -475,7 +484,9 @@ unw_resume(3),
unw_set_caching_policy(3), unw_set_caching_policy(3),
unw_set_fpreg(3), unw_set_fpreg(3),
unw_set_reg(3), unw_set_reg(3),
unw_step(3) unw_step(3),
_U_dyn_register(3),
_U_dyn_cancel(3)
.PP .PP
.SH AUTHOR .SH AUTHOR