doc/unw_flush_cache.tex

   1 \documentclass{article}
   2 \usepackage[fancyhdr,pdf]{latex2man}
   3
   4 \input{common.tex}
   5
   6 \begin{document}
   7
   8 \begin{Name}{3}{unw\_flush\_cache}{David Mosberger-Tang}{Programming Library}{unw\_flush\_cache}unw\_flush\_cache -- flush cached info
   9 \end{Name}
  10
  11 \section{Synopsis}
  12
  13 \File{\#include $<$libunwind.h$>$}\\
  14
  15 \Type{void} \Func{unw\_flush\_cache}(\Type{unw\_addr\_space\_t} \Var{as}, \Type{unw\_word\_t} \Var{lo}, \Type{unw\_word\_t} \Var{hi});\\
  16
  17 \section{Description}
  18
  19 The \Func{unw\_flush\_cache}() routine flushes all cached info as it
  20 relates to address-range \Var{lo} to \Var{hi} (non-inclusive) in the
  21 target address-space \Var{as}.  In addition, all info cached for
  22 address-space \Var{as} that is not tied to a particular code-range is
  23 also flushed.  For example, the address of the dynamic registration
  24 list is not tied to a code-range and its cached value (if any) is
  25 flushed by a call to this routine.  The address range specified by
  26 \Var{lo} and \Var{hi} should be understood as a hint:
  27 \Func{unw\_flush\_cache}() may flush more information than requested,
  28 but \emph{never} less.  In other words, \Func{unw\_flush\_cache}() may
  29 overflush, but not underflush.
  30
  31 As a special case, if arguments \Var{lo} and \Var{hi} are both 0, all
  32 information cached on behalf of address space \Var{as} is flushed.
  33
  34 \section{Return Value}
  35
  36 The \Func{unw\_flush\_cache}() routine cannot fail and does not
  37 return a value.
  38
  39 \section{Thread and Signal Safety}
  40
  41 The \Func{unw\_flush\_cache}() routine is thread-safe as well as safe to
  42 use from a signal handler.
  43
  44 \section{See Also}
  45
  46 \SeeAlso{libunwind(3)},
  47 \SeeAlso{unw\_set\_caching\_policy(3)}
  48 \SeeAlso{unw\_set\_cache\_size(3)}
  49
  50 \section{Author}
  51
  52 \noindent
  53 David Mosberger-Tang\\
  54 Email: \Email{dmosberger@gmail.com}\\
  55 WWW: \URL{http://www.nongnu.org/libunwind/}.
  56 \LatexManEnd
  57
  58 \end{document}