libdazzle-doc 3.28.1-1 / usr / share / gtk-doc / html / libdazzle / libdazzle-dzl-counter.html

This file is indexed.

/usr/share/gtk-doc/html/libdazzle/libdazzle-dzl-counter.html is in libdazzle-doc 3.28.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dzl-counter: Dazzle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dazzle Reference Manual">
<link rel="up" href="dazzle-counters.html" title="Part XIII. Performance Counters">
<link rel="prev" href="dazzle-counters.html" title="Part XIII. Performance Counters">
<link rel="next" href="dazzle-widgets.html" title="Part XIV. Additional Widgets">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libdazzle-dzl-counter.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="dazzle-counters.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="dazzle-counters.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dazzle-widgets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libdazzle-dzl-counter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdazzle-dzl-counter.top_of_page"></a>dzl-counter</span></h2>
<p>dzl-counter</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdazzle-dzl-counter.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#dzl-get-current-cpu-rdtscp" title="dzl_get_current_cpu_rdtscp ()">dzl_get_current_cpu_rdtscp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libdazzle-dzl-counter.html#dzl-get-current-cpu" title="dzl_get_current_cpu">dzl_get_current_cpu</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#DZL-DEFINE-COUNTER:CAPS" title="DZL_DEFINE_COUNTER()">DZL_DEFINE_COUNTER</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#DZL-COUNTER-INC:CAPS" title="DZL_COUNTER_INC()">DZL_COUNTER_INC</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#DZL-COUNTER-DEC:CAPS" title="DZL_COUNTER_DEC()">DZL_COUNTER_DEC</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#DZL-COUNTER-SUB:CAPS" title="DZL_COUNTER_SUB()">DZL_COUNTER_SUB</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-counter.html#DZL-COUNTER-ADD:CAPS" title="DZL_COUNTER_ADD()">DZL_COUNTER_ADD</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libdazzle-dzl-counter.html#DzlCounterForeachFunc" title="DzlCounterForeachFunc ()">*DzlCounterForeachFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-counter.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libdazzle-dzl-counter.html#DZL-COUNTER-REQUIRES-ATOMIC:CAPS" title="DZL_COUNTER_REQUIRES_ATOMIC">DZL_COUNTER_REQUIRES_ATOMIC</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libdazzle-dzl-counter.html#DzlCounter" title="DzlCounter">DzlCounter</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libdazzle-dzl-counter.html#DzlCounterArena" title="DzlCounterArena">DzlCounterArena</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libdazzle-dzl-counter.html#DzlCounterValue" title="DzlCounterValue">DzlCounterValue</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-counter.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-counter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dzl-get-current-cpu-rdtscp"></a><h3>dzl_get_current_cpu_rdtscp ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dzl_get_current_cpu_rdtscp (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-get-current-cpu"></a><h3>dzl_get_current_cpu</h3>
<pre class="programlisting"># define dzl_get_current_cpu() dzl_get_current_cpu_rdtscp()
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DZL-DEFINE-COUNTER:CAPS"></a><h3>DZL_DEFINE_COUNTER()</h3>
<pre class="programlisting">#define             DZL_DEFINE_COUNTER(Identifier, Category, Name, Description)</pre>
<div class="informalexample">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="libdazzle-dzl-counter.html#DZL-DEFINE-COUNTER:CAPS">DZL_DEFINE_COUNTER</a></span> <span class="gtkdoc opt">(</span>my_counter<span class="gtkdoc opt">,</span> <span class="string">&quot;My&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;Counter&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;My Counter Description&quot;</span><span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<div class="refsect3">
<a name="DZL-DEFINE-COUNTER.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>Identifier</p></td>
<td class="parameter_description"><p>The symbol name of the counter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Category</p></td>
<td class="parameter_description"><p>A string category for the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Name</p></td>
<td class="parameter_description"><p>A string name for the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Description</p></td>
<td class="parameter_description"><p>A string description for the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DZL-COUNTER-INC:CAPS"></a><h3>DZL_COUNTER_INC()</h3>
<pre class="programlisting">#define DZL_COUNTER_INC(Identifier) DZL_COUNTER_ADD(Identifier, G_GINT64_CONSTANT(1))
</pre>
<p>Increments the counter <em class="parameter"><code>Identifier</code></em>
 by 1.</p>
<div class="refsect3">
<a name="DZL-COUNTER-INC.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>Identifier</p></td>
<td class="parameter_description"><p>The identifier of the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DZL-COUNTER-DEC:CAPS"></a><h3>DZL_COUNTER_DEC()</h3>
<pre class="programlisting">#define DZL_COUNTER_DEC(Identifier) DZL_COUNTER_SUB(Identifier, G_GINT64_CONSTANT(1))
</pre>
<p>Decrements the counter <em class="parameter"><code>Identifier</code></em>
 by 1.</p>
<div class="refsect3">
<a name="DZL-COUNTER-DEC.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>Identifier</p></td>
<td class="parameter_description"><p>The identifier of the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DZL-COUNTER-SUB:CAPS"></a><h3>DZL_COUNTER_SUB()</h3>
<pre class="programlisting">#define DZL_COUNTER_SUB(Identifier, Count) DZL_COUNTER_ADD(Identifier, (-(Count)))
</pre>
<p>Subtracts from the counter identified by <em class="parameter"><code>Identifier</code></em>
 by <em class="parameter"><code>Count</code></em>
.</p>
<div class="refsect3">
<a name="DZL-COUNTER-SUB.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>Identifier</p></td>
<td class="parameter_description"><p>The identifier of the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Count</p></td>
<td class="parameter_description"><p>the amount to subtract.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DZL-COUNTER-ADD:CAPS"></a><h3>DZL_COUNTER_ADD()</h3>
<pre class="programlisting">#define             DZL_COUNTER_ADD(Identifier, Count)</pre>
<p>Adds <em class="parameter"><code>Count</code></em>
 to <em class="parameter"><code>Identifier</code></em>
.</p>
<p>This operation is not guaranteed to have full correctness. It tries to find
a happy medium between fast, and accurate. When possible, the <code class="literal">rdtscp</code>
instruction is used to get a cacheline owned by the executing CPU, to avoid
collisions. However, this is not guaranteed as the thread could be swapped
between the calls to <code class="literal">rdtscp</code> and <code class="literal">addq</code> (on 64-bit Intel).</p>
<p>Other platforms have fallbacks which may give different guarantees, such as
using atomic operations (and therefore, memory barriers).</p>
<p>See <a class="link" href="libdazzle-dzl-counter.html#DzlCounter" title="DzlCounter"><span class="type">DzlCounter</span></a> for more information.</p>
<div class="refsect3">
<a name="DZL-COUNTER-ADD.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>Identifier</p></td>
<td class="parameter_description"><p>The identifier of the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>Count</p></td>
<td class="parameter_description"><p>the amount to add to the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DzlCounterForeachFunc"></a><h3>DzlCounterForeachFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*DzlCounterForeachFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libdazzle-dzl-counter.html#DzlCounter" title="DzlCounter"><span class="type">DzlCounter</span></a> *counter</code></em>,
                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Function prototype for callbacks provided to <code class="function">dzl_counter_arena_foreach()</code>.</p>
<div class="refsect3">
<a name="DzlCounterForeachFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>counter</p></td>
<td class="parameter_description"><p>the counter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data supplied to <code class="function">dzl_counter_arena_foreach()</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-counter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DZL-COUNTER-REQUIRES-ATOMIC:CAPS"></a><h3>DZL_COUNTER_REQUIRES_ATOMIC</h3>
<pre class="programlisting"># define DZL_COUNTER_REQUIRES_ATOMIC 1
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DzlCounter"></a><h3>DzlCounter</h3>
<pre class="programlisting">typedef struct _DzlCounter DzlCounter;</pre>
</div>
<hr>
<div class="refsect2">
<a name="DzlCounterArena"></a><h3>DzlCounterArena</h3>
<pre class="programlisting">typedef struct _DzlCounterArena DzlCounterArena;</pre>
</div>
<hr>
<div class="refsect2">
<a name="DzlCounterValue"></a><h3>DzlCounterValue</h3>
<pre class="programlisting">typedef struct _DzlCounterValue DzlCounterValue;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.