2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * counter.h: simple and packet/byte counters
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_vlib_counter_h
41 #define included_vlib_counter_h
43 #include <vlib/counter_types.h>
47 Optimized thread-safe counters.
49 Each vlib_[simple|combined]_counter_main_t consists of a per-thread
50 vector of per-object counters.
52 The idea is to drastically eliminate atomic operations.
55 /** A collection of simple counters */
59 counter_t **counters; /**< Per-thread u64 non-atomic counters */
60 counter_t *value_at_last_serialize; /**< Values as of last serialize. */
61 u32 last_incremental_serialize_index; /**< Last counter index
62 serialized incrementally. */
64 char *name; /**< The counter collection's name. */
65 char *stat_segment_name; /**< Name in stat segment directory */
66 } vlib_simple_counter_main_t;
68 /** The number of counters (not the number of per-thread counters) */
69 u32 vlib_simple_counter_n_counters (const vlib_simple_counter_main_t * cm);
71 /** Increment a simple counter
72 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
73 @param thread_index - (u32) the current cpu index
74 @param index - (u32) index of the counter to increment
75 @param increment - (u64) quantitiy to add to the counter
78 vlib_increment_simple_counter (vlib_simple_counter_main_t * cm,
79 u32 thread_index, u32 index, u64 increment)
81 counter_t *my_counters;
83 my_counters = cm->counters[thread_index];
84 my_counters[index] += increment;
87 /** Decrement a simple counter
88 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
89 @param thread_index - (u32) the current cpu index
90 @param index - (u32) index of the counter to increment
91 @param increment - (u64) quantitiy remove from the counter value
94 vlib_decrement_simple_counter (vlib_simple_counter_main_t * cm,
95 u32 thread_index, u32 index, u64 decrement)
97 counter_t *my_counters;
99 my_counters = cm->counters[thread_index];
101 ASSERT (my_counters[index] >= decrement);
103 my_counters[index] -= decrement;
106 /** Set a simple counter
107 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
108 @param thread_index - (u32) the current cpu index
109 @param index - (u32) index of the counter to increment
110 @param value - (u64) quantitiy to set to the counter
113 vlib_set_simple_counter (vlib_simple_counter_main_t * cm,
114 u32 thread_index, u32 index, u64 value)
116 counter_t *my_counters;
118 my_counters = cm->counters[thread_index];
119 my_counters[index] = value;
122 /** Get the value of a simple counter
123 Scrapes the entire set of per-thread counters. Innacurate unless
124 worker threads which might increment the counter are
127 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
128 @param index - (u32) index of the counter to fetch
129 @returns - (u64) current counter value
131 always_inline counter_t
132 vlib_get_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
134 counter_t *my_counters;
138 ASSERT (index < vlib_simple_counter_n_counters (cm));
142 for (i = 0; i < vec_len (cm->counters); i++)
144 my_counters = cm->counters[i];
145 v += my_counters[index];
151 /** Clear a simple counter
152 Clears the set of per-thread u16 counters, and the u64 counter
154 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
155 @param index - (u32) index of the counter to clear
158 vlib_zero_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
160 counter_t *my_counters;
163 ASSERT (index < vlib_simple_counter_n_counters (cm));
165 for (i = 0; i < vec_len (cm->counters); i++)
167 my_counters = cm->counters[i];
168 my_counters[index] = 0;
172 /** Add two combined counters, results in the first counter
173 @param [in,out] a - (vlib_counter_t *) dst counter
174 @param b - (vlib_counter_t *) src counter
178 vlib_counter_add (vlib_counter_t * a, vlib_counter_t * b)
180 a->packets += b->packets;
181 a->bytes += b->bytes;
184 /** Subtract combined counters, results in the first counter
185 @param [in,out] a - (vlib_counter_t *) dst counter
186 @param b - (vlib_counter_t *) src counter
189 vlib_counter_sub (vlib_counter_t * a, vlib_counter_t * b)
191 ASSERT (a->packets >= b->packets);
192 ASSERT (a->bytes >= b->bytes);
193 a->packets -= b->packets;
194 a->bytes -= b->bytes;
197 /** Clear a combined counter
198 @param a - (vlib_counter_t *) counter to clear
201 vlib_counter_zero (vlib_counter_t * a)
203 a->packets = a->bytes = 0;
206 /** A collection of combined counters */
209 vlib_counter_t **counters; /**< Per-thread u64 non-atomic counter pairs */
210 vlib_counter_t *value_at_last_serialize; /**< Counter values as of last serialize. */
211 u32 last_incremental_serialize_index; /**< Last counter index serialized incrementally. */
212 char *name; /**< The counter collection's name. */
213 char *stat_segment_name; /**< Name in stat segment directory */
214 } vlib_combined_counter_main_t;
216 /** The number of counters (not the number of per-thread counters) */
217 u32 vlib_combined_counter_n_counters (const vlib_combined_counter_main_t *
220 /** Clear a collection of simple counters
221 @param cm - (vlib_simple_counter_main_t *) collection to clear
223 void vlib_clear_simple_counters (vlib_simple_counter_main_t * cm);
225 /** Clear a collection of combined counters
226 @param cm - (vlib_combined_counter_main_t *) collection to clear
228 void vlib_clear_combined_counters (vlib_combined_counter_main_t * cm);
230 /** Increment a combined counter
231 @param cm - (vlib_combined_counter_main_t *) comined counter main pointer
232 @param thread_index - (u32) the current cpu index
233 @param index - (u32) index of the counter to increment
234 @param packet_increment - (u64) number of packets to add to the counter
235 @param byte_increment - (u64) number of bytes to add to the counter
239 vlib_increment_combined_counter (vlib_combined_counter_main_t * cm,
241 u32 index, u64 n_packets, u64 n_bytes)
243 vlib_counter_t *my_counters;
245 /* Use this CPU's counter array */
246 my_counters = cm->counters[thread_index];
248 my_counters[index].packets += n_packets;
249 my_counters[index].bytes += n_bytes;
252 /** Pre-fetch a per-thread combined counter for the given object index */
254 vlib_prefetch_combined_counter (const vlib_combined_counter_main_t * cm,
255 u32 thread_index, u32 index)
257 vlib_counter_t *cpu_counters;
260 * This CPU's index is assumed to already be in cache
262 cpu_counters = cm->counters[thread_index];
263 CLIB_PREFETCH (cpu_counters + index, CLIB_CACHE_LINE_BYTES, STORE);
267 /** Get the value of a combined counter, never called in the speed path
268 Scrapes the entire set of per-thread counters. Innacurate unless
269 worker threads which might increment the counter are
272 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
273 @param index - (u32) index of the combined counter to fetch
274 @param result [out] - (vlib_counter_t *) result stored here
278 vlib_get_combined_counter (const vlib_combined_counter_main_t * cm,
279 u32 index, vlib_counter_t * result)
281 vlib_counter_t *my_counters, *counter;
287 for (i = 0; i < vec_len (cm->counters); i++)
289 my_counters = cm->counters[i];
291 counter = vec_elt_at_index (my_counters, index);
292 result->packets += counter->packets;
293 result->bytes += counter->bytes;
297 /** Clear a combined counter
298 Clears the set of per-thread counters.
300 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
301 @param index - (u32) index of the counter to clear
304 vlib_zero_combined_counter (vlib_combined_counter_main_t * cm, u32 index)
306 vlib_counter_t *my_counters, *counter;
309 for (i = 0; i < vec_len (cm->counters); i++)
311 my_counters = cm->counters[i];
313 counter = vec_elt_at_index (my_counters, index);
314 counter->packets = 0;
319 /** validate a simple counter
320 @param cm - (vlib_simple_counter_main_t *) pointer to the counter collection
321 @param index - (u32) index of the counter to validate
324 void vlib_validate_simple_counter (vlib_simple_counter_main_t * cm,
326 void vlib_free_simple_counter (vlib_simple_counter_main_t * cm);
328 /** validate a combined counter
329 @param cm - (vlib_combined_counter_main_t *) pointer to the counter
331 @param index - (u32) index of the counter to validate
334 void vlib_validate_combined_counter (vlib_combined_counter_main_t * cm,
336 int vlib_validate_combined_counter_will_expand
337 (vlib_combined_counter_main_t * cm, u32 index);
339 void vlib_free_combined_counter (vlib_combined_counter_main_t * cm);
341 /** Obtain the number of simple or combined counters allocated.
342 A macro which reduces to to vec_len(cm->maxi), the answer in either
345 @param cm - (vlib_simple_counter_main_t) or
346 (vlib_combined_counter_main_t) the counter collection to interrogate
347 @returns vec_len(cm->maxi)
349 #define vlib_counter_len(cm) vec_len((cm)->maxi)
351 #endif /* included_vlib_counter_h */
354 * fd.io coding-style-patch-verification: ON
357 * eval: (c-set-style "gnu")