summaryrefslogtreecommitdiff
path: root/doc/unw_get_reg.tex
diff options
context:
space:
mode:
authormostang.com!davidm <mostang.com!davidm>2003-03-20 07:51:37 +0000
committermostang.com!davidm <mostang.com!davidm>2003-03-20 07:51:37 +0000
commit27a73b1fe88c4245e261e0e977d3f121e9b2c6cb (patch)
tree6dff95c56d5cc9e48e902e334ae5c6c7232185ef /doc/unw_get_reg.tex
parenta21507ddb3f0433a7188e47f6050e7129c06567d (diff)
downloadlibunwind-27a73b1fe88c4245e261e0e977d3f121e9b2c6cb.tar.gz
Initial revision
Diffstat (limited to 'doc/unw_get_reg.tex')
-rw-r--r--doc/unw_get_reg.tex81
1 files changed, 0 insertions, 81 deletions
diff --git a/doc/unw_get_reg.tex b/doc/unw_get_reg.tex
index a3dc9004..e69de29b 100644
--- a/doc/unw_get_reg.tex
+++ b/doc/unw_get_reg.tex
@@ -1,81 +0,0 @@
-\documentclass{article}
-\usepackage[fancyhdr,pdf]{latex2man}
-
-\input{common.tex}
-
-\begin{document}
-
-\begin{Name}{3}{unw\_get\_reg}{David Mosberger-Tang}{Programming Library}{unw\_get\_reg}
-
- unw\_get\_reg -- get register contents
-\end{Name}
-
-\section{Synopsis}
-
-\File{\#include $<$libunwind.h$>$}\\
-
-\Type{int} \Func{unw\_get\_reg}(\Type{unw\_cursor\_t~*}\Var{cp}, \Type{unw\_regnum\_t} \Var{reg}, \Type{unw\_word\_t~*}\Var{valp});\\
-
-\section{Description}
-
-The \Func{unw\_get\_reg}() routine reads the value of register
-\Var{reg} in the stack frame identified by cursor \Var{cp} and stores
-the value in the word pointed to by \Var{valp}.
-
-The register numbering is target-dependent and described in separate
-manual pages (e.g., libunwind-ia64(3) for the IA-64 target).
-Furthermore, the exact set of accessible registers may depend on the
-type of frame that \Var{cp} is referring to. For ordinary stack
-frames, it is normally possible to access only the preserved
-(``callee-saved'') registers and frame-related registers (such as the
-stack-pointer). However, for signal frames (see
-\Func{unw\_is\_signal\_frame}(3)), it is usually possible to access
-all registers.
-
-Note that \Func{unw\_get\_reg}() can only read the contents of
-registers whose values fit in a single word. See
-\Func{unw\_get\_fpreg}(3) for a way to read registers which do not fit
-this constraint.
-
-\section{Return Value}
-
-On successful completion, \Func{unw\_get\_reg}() returns 0.
-Otherwise the negative value of one of the error-codes below is
-returned.
-
-\section{Thread and Signal Safety}
-
-\Func{unw\_get\_reg}() is thread-safe as well as safe to use
-from a signal handler.
-
-\section{Errors}
-
-\begin{Description}
-\item[\Const{UNW\_EUNSPEC}] An unspecified error occurred.
-\item[\Const{UNW\_EBADREG}] An attempt was made to read a register
- that is either invalid or not accessible in the current frame.
-\end{Description}
-In addition, \Func{unw\_get\_reg}() may return any error returned by
-the \Func{access\_mem}(), \Func{access\_reg}(), and
-\Func{access\_fpreg}() call-backs (see
-\Func{unw\_create\_addr\_space}(3)).
-
-\section{See Also}
-
-\SeeAlso{libunwind(3)},
-\SeeAlso{libunwind-ia64(3)},
-\SeeAlso{unw\_get\_fpreg(3)},
-\SeeAlso{unw\_is\_signal\_frame(3)},
-\SeeAlso{unw\_set\_reg(3)}
-
-\section{Author}
-
-\noindent
-David Mosberger-Tang\\
-Hewlett-Packard Labs\\
-Palo-Alto, CA 94304\\
-Email: \Email{davidm@hpl.hp.com}\\
-WWW: \URL{http://www.hpl.hp.com/research/linux/libunwind/}.
-\LatexManEnd
-
-\end{document}