~ubuntu-branches/ubuntu/utopic/libunwind/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/unw_create_addr_space.tex

  • Committer: Bazaar Package Importer
  • Author(s): Matthieu Delahaye
  • Date: 2005-04-22 11:12:14 UTC
  • mto: (4.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050422111214-0m74olipxly1ra8a
Tags: upstream-0.98.5
ImportĀ upstreamĀ versionĀ 0.98.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
 
13
13
\File{\#include $<$libunwind.h$>$}\\
14
14
 
15
 
\Type{int} \Func{unw\_create\_addr\_space}(\Type{unw\_accessors\_t~*}\Var{ap}, \Type{int} \Var{byteorder});\\
 
15
\Type{unw\_addr\_space\_t} \Func{unw\_create\_addr\_space}(\Type{unw\_accessors\_t~*}\Var{ap}, \Type{int} \Var{byteorder});\\
16
16
 
17
17
\section{Description}
18
18
 
23
23
\Var{byteorder} can be set to 0 to request the default byte-order of
24
24
the unwind target.  To request a particular byte-order,
25
25
\Var{byteorder} can be set to any constant defined by
26
 
\File{$<$endian.h$>$}.  In particular, \Const{\_\_LITTLE_ENDIAN} would
 
26
\File{$<$endian.h$>$}.  In particular, \Const{\_\_LITTLE\_ENDIAN} would
27
27
request little-endian byte-order and \Const{\_\_BIG\_ENDIAN} would
28
28
request big-endian byte-order.  Whether or not a particular byte-order
29
29
is supported depends on the target platform.
194
194
unwind-cursor that identifies the stack-frame in which execution
195
195
should resume.  By the time \Prog{libunwind} invokes the \Func{resume}
196
196
call-back, it has already established the desired machine- and
197
 
memory-state via calls to the \Func{access_reg}(),
 
197
memory-state via calls to the \Func{access\_reg}(),
198
198
\Func{access\_fpreg}, and \Func{access\_mem}() call-backs.  Thus, all
199
199
the call-back needs to do is perform whatever action is needed to
200
200
actually resume execution.
216
216
procedure.  Argument \Var{addr} is an instruction-address within the
217
217
procedure whose name is to be obtained.  The \Var{bufp} argument is a
218
218
pointer to a character-buffer used to return the procedure name.  The
219
 
size of this buffer is specified in argument \Var{buf_len}.  The
 
219
size of this buffer is specified in argument \Var{buf\_len}.  The
220
220
returned name must be terminated by a NUL character.  If the
221
 
procedure's name is longer than \Var{buf_len} bytes, it must be
 
221
procedure's name is longer than \Var{buf\_len} bytes, it must be
222
222
truncated to \Var{buf\_len}\Prog{-1} bytes, with the last byte in the
223
223
buffer set to the NUL character and -\Const{UNW\_ENOMEM} must be
224
224
returned.  Argument \Var{offp} is a pointer to a word which is used to
245
245
\Func{unw\_create\_addr\_space}() is thread-safe but \emph{not}
246
246
safe to use from a signal handler.
247
247
 
248
 
\end{Description}
249
 
 
250
248
\section{See Also}
251
249
 
252
250
\SeeAlso{\_U\_dyn\_register(3)},