Initial import
[external/libunwind.git] / doc / unw_flush_cache.man
1 '\" t
2 .\" Manual page created with latex2man on Thu Aug 16 09:44:44 MDT 2007
3 .\" NOTE: This file is generated, DO NOT EDIT.
4 .de Vb
5 .ft CW
6 .nf
7 ..
8 .de Ve
9 .ft R
10
11 .fi
12 ..
13 .TH "UNW\\_FLUSH\\_CACHE" "3" "16 August 2007" "Programming Library " "Programming Library "
14 .SH NAME
15 unw_flush_cache
16 \-\- flush cached info 
17 .PP
18 .SH SYNOPSIS
19
20 .PP
21 #include <libunwind.h>
22 .br
23 .PP
24 void
25 unw_flush_cache(unw_addr_space_t
26 as,
27 unw_word_t
28 lo,
29 unw_word_t
30 hi);
31 .br
32 .PP
33 .SH DESCRIPTION
34
35 .PP
36 The unw_flush_cache()
37 routine flushes all cached info as it 
38 relates to address\-range lo
39 to hi
40 (non\-inclusive) in the 
41 target address\-space as\&.
42 In addition, all info cached for 
43 address\-space as
44 that is not tied to a particular code\-range is 
45 also flushed. For example, the address of the dynamic registration 
46 list is not tied to a code\-range and its cached value (if any) is 
47 flushed by a call to this routine. The address range specified by 
48 lo
49 and hi
50 should be understood as a hint: 
51 unw_flush_cache()
52 may flush more information than requested, 
53 but \fInever\fP
54 less. In other words, unw_flush_cache()
55 may 
56 overflush, but not underflush. 
57 .PP
58 As a special case, if arguments lo
59 and hi
60 are both 0, all 
61 information cached on behalf of address space as
62 is flushed. 
63 .PP
64 .SH RETURN VALUE
65
66 .PP
67 The unw_flush_cache()
68 routine cannot fail and does not 
69 return a value. 
70 .PP
71 .SH THREAD AND SIGNAL SAFETY
72
73 .PP
74 The unw_flush_cache()
75 routine is thread\-safe as well as safe to 
76 use from a signal handler. 
77 .PP
78 .SH SEE ALSO
79
80 .PP
81 libunwind(3),
82 unw_set_caching_policy(3)
83 .PP
84 .SH AUTHOR
85
86 .PP
87 David Mosberger\-Tang
88 .br
89 Email: \fBdmosberger@gmail.com\fP
90 .br
91 WWW: \fBhttp://www.nongnu.org/libunwind/\fP\&.
92 .\" NOTE: This file is generated, DO NOT EDIT.