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 char *name; /**< The counter collection's name. */
61 char *stat_segment_name; /**< Name in stat segment directory */
62 } vlib_simple_counter_main_t;
64 /** The number of counters (not the number of per-thread counters) */
65 u32 vlib_simple_counter_n_counters (const vlib_simple_counter_main_t * cm);
67 /** Increment a simple counter
68 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
69 @param thread_index - (u32) the current cpu index
70 @param index - (u32) index of the counter to increment
71 @param increment - (u64) quantitiy to add to the counter
74 vlib_increment_simple_counter (vlib_simple_counter_main_t * cm,
75 u32 thread_index, u32 index, u64 increment)
77 counter_t *my_counters;
79 my_counters = cm->counters[thread_index];
80 my_counters[index] += increment;
83 /** Decrement a simple counter
84 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
85 @param thread_index - (u32) the current cpu index
86 @param index - (u32) index of the counter to increment
87 @param increment - (u64) quantitiy remove from the counter value
90 vlib_decrement_simple_counter (vlib_simple_counter_main_t * cm,
91 u32 thread_index, u32 index, u64 decrement)
93 counter_t *my_counters;
95 my_counters = cm->counters[thread_index];
97 ASSERT (my_counters[index] >= decrement);
99 my_counters[index] -= decrement;
102 /** Set a simple counter
103 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
104 @param thread_index - (u32) the current cpu index
105 @param index - (u32) index of the counter to increment
106 @param value - (u64) quantitiy to set to the counter
109 vlib_set_simple_counter (vlib_simple_counter_main_t * cm,
110 u32 thread_index, u32 index, u64 value)
112 counter_t *my_counters;
114 my_counters = cm->counters[thread_index];
115 my_counters[index] = value;
118 /** Get the value of a simple counter
119 Scrapes the entire set of per-thread counters. Innacurate unless
120 worker threads which might increment the counter are
123 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
124 @param index - (u32) index of the counter to fetch
125 @returns - (u64) current counter value
127 always_inline counter_t
128 vlib_get_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
130 counter_t *my_counters;
134 ASSERT (index < vlib_simple_counter_n_counters (cm));
138 for (i = 0; i < vec_len (cm->counters); i++)
140 my_counters = cm->counters[i];
141 v += my_counters[index];
147 /** Clear a simple counter
148 Clears the set of per-thread u16 counters, and the u64 counter
150 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
151 @param index - (u32) index of the counter to clear
154 vlib_zero_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
156 counter_t *my_counters;
159 ASSERT (index < vlib_simple_counter_n_counters (cm));
161 for (i = 0; i < vec_len (cm->counters); i++)
163 my_counters = cm->counters[i];
164 my_counters[index] = 0;
168 /** Add two combined counters, results in the first counter
169 @param [in,out] a - (vlib_counter_t *) dst counter
170 @param b - (vlib_counter_t *) src counter
174 vlib_counter_add (vlib_counter_t * a, vlib_counter_t * b)
176 a->packets += b->packets;
177 a->bytes += b->bytes;
180 /** Subtract combined counters, results in the first counter
181 @param [in,out] a - (vlib_counter_t *) dst counter
182 @param b - (vlib_counter_t *) src counter
185 vlib_counter_sub (vlib_counter_t * a, vlib_counter_t * b)
187 ASSERT (a->packets >= b->packets);
188 ASSERT (a->bytes >= b->bytes);
189 a->packets -= b->packets;
190 a->bytes -= b->bytes;
193 /** Clear a combined counter
194 @param a - (vlib_counter_t *) counter to clear
197 vlib_counter_zero (vlib_counter_t * a)
199 a->packets = a->bytes = 0;
202 /** A collection of combined counters */
205 vlib_counter_t **counters; /**< Per-thread u64 non-atomic counter pairs */
206 char *name; /**< The counter collection's name. */
207 char *stat_segment_name; /**< Name in stat segment directory */
208 } vlib_combined_counter_main_t;
210 /** The number of counters (not the number of per-thread counters) */
211 u32 vlib_combined_counter_n_counters (const vlib_combined_counter_main_t *
214 /** Clear a collection of simple counters
215 @param cm - (vlib_simple_counter_main_t *) collection to clear
217 void vlib_clear_simple_counters (vlib_simple_counter_main_t * cm);
219 /** Clear a collection of combined counters
220 @param cm - (vlib_combined_counter_main_t *) collection to clear
222 void vlib_clear_combined_counters (vlib_combined_counter_main_t * cm);
224 /** Increment a combined counter
225 @param cm - (vlib_combined_counter_main_t *) comined counter main pointer
226 @param thread_index - (u32) the current cpu index
227 @param index - (u32) index of the counter to increment
228 @param packet_increment - (u64) number of packets to add to the counter
229 @param byte_increment - (u64) number of bytes to add to the counter
233 vlib_increment_combined_counter (vlib_combined_counter_main_t * cm,
235 u32 index, u64 n_packets, u64 n_bytes)
237 vlib_counter_t *my_counters;
239 /* Use this CPU's counter array */
240 my_counters = cm->counters[thread_index];
242 my_counters[index].packets += n_packets;
243 my_counters[index].bytes += n_bytes;
246 /** Pre-fetch a per-thread combined counter for the given object index */
248 vlib_prefetch_combined_counter (const vlib_combined_counter_main_t * cm,
249 u32 thread_index, u32 index)
251 vlib_counter_t *cpu_counters;
254 * This CPU's index is assumed to already be in cache
256 cpu_counters = cm->counters[thread_index];
257 clib_prefetch_store (cpu_counters + index);
261 /** Get the value of a combined counter, never called in the speed path
262 Scrapes the entire set of per-thread counters. Innacurate unless
263 worker threads which might increment the counter are
266 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
267 @param index - (u32) index of the combined counter to fetch
268 @param result [out] - (vlib_counter_t *) result stored here
272 vlib_get_combined_counter (const vlib_combined_counter_main_t * cm,
273 u32 index, vlib_counter_t * result)
275 vlib_counter_t *my_counters, *counter;
281 for (i = 0; i < vec_len (cm->counters); i++)
283 my_counters = cm->counters[i];
285 counter = vec_elt_at_index (my_counters, index);
286 result->packets += counter->packets;
287 result->bytes += counter->bytes;
291 /** Clear a combined counter
292 Clears the set of per-thread counters.
294 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
295 @param index - (u32) index of the counter to clear
298 vlib_zero_combined_counter (vlib_combined_counter_main_t * cm, u32 index)
300 vlib_counter_t *my_counters, *counter;
303 for (i = 0; i < vec_len (cm->counters); i++)
305 my_counters = cm->counters[i];
307 counter = vec_elt_at_index (my_counters, index);
308 counter->packets = 0;
313 /** validate a simple counter
314 @param cm - (vlib_simple_counter_main_t *) pointer to the counter collection
315 @param index - (u32) index of the counter to validate
318 void vlib_validate_simple_counter (vlib_simple_counter_main_t * cm,
320 void vlib_free_simple_counter (vlib_simple_counter_main_t * cm);
322 /** validate a combined counter
323 @param cm - (vlib_combined_counter_main_t *) pointer to the counter
325 @param index - (u32) index of the counter to validate
328 void vlib_validate_combined_counter (vlib_combined_counter_main_t * cm,
330 int vlib_validate_combined_counter_will_expand
331 (vlib_combined_counter_main_t * cm, u32 index);
333 void vlib_free_combined_counter (vlib_combined_counter_main_t * cm);
335 /** Obtain the number of simple or combined counters allocated.
336 A macro which reduces to to vec_len(cm->maxi), the answer in either
339 @param cm - (vlib_simple_counter_main_t) or
340 (vlib_combined_counter_main_t) the counter collection to interrogate
341 @returns vec_len(cm->maxi)
343 #define vlib_counter_len(cm) vec_len((cm)->maxi)
345 #endif /* included_vlib_counter_h */
348 * fd.io coding-style-patch-verification: ON
351 * eval: (c-set-style "gnu")