2003-04-01 09:19:34 +02:00
\documentclass { article}
\usepackage [fancyhdr,pdf] { latex2man}
\input { common.tex}
\begin { document}
\begin { Name} { 3} { unw\_ is\_ signal\_ frame} { David Mosberger-Tang} { Programming Library} { unw\_ is\_ signal\_ frame} unw\_ is\_ signal\_ frame -- check if current frame is a signal frame
\end { Name}
\section { Synopsis}
\File { \# include $ < $ libunwind.h$ > $ } \\
\Type { int} \Func { unw\_ is\_ signal\_ frame} (\Type { unw\_ cursor\_ t~*} \Var { cp} );\\
\section { Description}
The \Func { unw\_ is\_ signal\_ frame} () routine returns a positive value
if the current frame identified by \Var { cp} is a signal frame, and a
value of 0 otherwise. For the purpose of this discussion, a signal
frame is a frame that was created in response to a potentially
asynchronous interruption. For UNIX and UNIX-like platforms, such
frames are normally created by the kernel when delivering a signal.
In a kernel-environment, a signal frame might, for example, correspond
to a frame created in response to a device interrupt.
Signal frames are somewhat unusual because the asynchronous nature of
the events that create them require storing the contents of registers
that are normally treated as scratch (``caller-saved'') registers.
\section { Return Value}
On successful completion, \Func { unw\_ is\_ signal\_ frame} () returns a
positive value if the current frame is a signal frame, or 0 if it is
not. Otherwise, a negative value of one of the error-codes below is
returned.
\section { Thread and Signal Safety}
\Func { unw\_ is\_ signal\_ frame} () is thread-safe as well as safe to use
from a signal handler.
\section { Errors}
\begin { Description}
\item [\Const{UNW\_ENOINFO}] \Prog { Libunwind} is unable to determine
whether or not the current frame is a signal frame.
\end { Description}
\section { See Also}
\SeeAlso { libunwind(3)} ,
\SeeAlso { unw\_ get\_ reg(3)} ,
\SeeAlso { unw\_ set\_ reg(3)} ,
\SeeAlso { unw\_ get\_ fpreg(3)} ,
\SeeAlso { unw\_ set\_ fpreg(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}
