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
45 Optimized thread-safe counters.
47 Each vlib_[simple|combined]_counter_main_t consists of a per-thread
48 vector of per-object counters.
50 The idea is to drastically eliminate atomic operations.
54 typedef u64 counter_t;
56 /** A collection of simple counters */
60 counter_t **counters; /**< Per-thread u64 non-atomic counters */
61 counter_t *value_at_last_serialize; /**< Values as of last serialize. */
62 u32 last_incremental_serialize_index; /**< Last counter index
63 serialized incrementally. */
65 char *name; /**< The counter collection's name. */
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 /** Get the value of a simple counter
88 Scrapes the entire set of per-thread counters. Innacurate unless
89 worker threads which might increment the counter are
92 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
93 @param index - (u32) index of the counter to fetch
94 @returns - (u64) current counter value
96 always_inline counter_t
97 vlib_get_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
99 counter_t *my_counters;
103 ASSERT (index < vlib_simple_counter_n_counters (cm));
107 for (i = 0; i < vec_len (cm->counters); i++)
109 my_counters = cm->counters[i];
110 v += my_counters[index];
116 /** Clear a simple counter
117 Clears the set of per-thread u16 counters, and the u64 counter
119 @param cm - (vlib_simple_counter_main_t *) simple counter main pointer
120 @param index - (u32) index of the counter to clear
123 vlib_zero_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
125 counter_t *my_counters;
128 ASSERT (index < vlib_simple_counter_n_counters (cm));
130 for (i = 0; i < vec_len (cm->counters); i++)
132 my_counters = cm->counters[i];
133 my_counters[index] = 0;
137 /** Combined counter to hold both packets and byte differences.
141 counter_t packets; /**< packet counter */
142 counter_t bytes; /**< byte counter */
145 /** Add two combined counters, results in the first counter
146 @param [in,out] a - (vlib_counter_t *) dst counter
147 @param b - (vlib_counter_t *) src counter
151 vlib_counter_add (vlib_counter_t * a, vlib_counter_t * b)
153 a->packets += b->packets;
154 a->bytes += b->bytes;
157 /** Subtract combined counters, results in the first counter
158 @param [in,out] a - (vlib_counter_t *) dst counter
159 @param b - (vlib_counter_t *) src counter
162 vlib_counter_sub (vlib_counter_t * a, vlib_counter_t * b)
164 ASSERT (a->packets >= b->packets);
165 ASSERT (a->bytes >= b->bytes);
166 a->packets -= b->packets;
167 a->bytes -= b->bytes;
170 /** Clear a combined counter
171 @param a - (vlib_counter_t *) counter to clear
174 vlib_counter_zero (vlib_counter_t * a)
176 a->packets = a->bytes = 0;
179 /** A collection of combined counters */
182 vlib_counter_t **counters; /**< Per-thread u64 non-atomic counter pairs */
183 vlib_counter_t *value_at_last_serialize; /**< Counter values as of last serialize. */
184 u32 last_incremental_serialize_index; /**< Last counter index serialized incrementally. */
185 char *name; /**< The counter collection's name. */
186 } vlib_combined_counter_main_t;
188 /** The number of counters (not the number of per-thread counters) */
189 u32 vlib_combined_counter_n_counters (const vlib_combined_counter_main_t *
192 /** Clear a collection of simple counters
193 @param cm - (vlib_simple_counter_main_t *) collection to clear
195 void vlib_clear_simple_counters (vlib_simple_counter_main_t * cm);
197 /** Clear a collection of combined counters
198 @param cm - (vlib_combined_counter_main_t *) collection to clear
200 void vlib_clear_combined_counters (vlib_combined_counter_main_t * cm);
202 /** Increment a combined counter
203 @param cm - (vlib_combined_counter_main_t *) comined counter main pointer
204 @param thread_index - (u32) the current cpu index
205 @param index - (u32) index of the counter to increment
206 @param packet_increment - (u64) number of packets to add to the counter
207 @param byte_increment - (u64) number of bytes to add to the counter
211 vlib_increment_combined_counter (vlib_combined_counter_main_t * cm,
213 u32 index, u64 n_packets, u64 n_bytes)
215 vlib_counter_t *my_counters;
217 /* Use this CPU's counter array */
218 my_counters = cm->counters[thread_index];
220 my_counters[index].packets += n_packets;
221 my_counters[index].bytes += n_bytes;
224 /** Pre-fetch a per-thread combined counter for the given object index */
226 vlib_prefetch_combined_counter (const vlib_combined_counter_main_t * cm,
227 u32 thread_index, u32 index)
229 vlib_counter_t *cpu_counters;
232 * This CPU's index is assumed to already be in cache
234 cpu_counters = cm->counters[thread_index];
235 CLIB_PREFETCH (cpu_counters + index, CLIB_CACHE_LINE_BYTES, STORE);
239 /** Get the value of a combined counter, never called in the speed path
240 Scrapes the entire set of per-thread counters. Innacurate unless
241 worker threads which might increment the counter are
244 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
245 @param index - (u32) index of the combined counter to fetch
246 @param result [out] - (vlib_counter_t *) result stored here
250 vlib_get_combined_counter (const vlib_combined_counter_main_t * cm,
251 u32 index, vlib_counter_t * result)
253 vlib_counter_t *my_counters, *counter;
259 for (i = 0; i < vec_len (cm->counters); i++)
261 my_counters = cm->counters[i];
263 counter = vec_elt_at_index (my_counters, index);
264 result->packets += counter->packets;
265 result->bytes += counter->bytes;
269 /** Clear a combined counter
270 Clears the set of per-thread counters.
272 @param cm - (vlib_combined_counter_main_t *) combined counter main pointer
273 @param index - (u32) index of the counter to clear
276 vlib_zero_combined_counter (vlib_combined_counter_main_t * cm, u32 index)
278 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 counter->packets = 0;
291 /** validate a simple counter
292 @param cm - (vlib_simple_counter_main_t *) pointer to the counter collection
293 @param index - (u32) index of the counter to validate
296 void vlib_validate_simple_counter (vlib_simple_counter_main_t * cm,
298 /** validate a combined counter
299 @param cm - (vlib_combined_counter_main_t *) pointer to the counter
301 @param index - (u32) index of the counter to validate
304 void vlib_validate_combined_counter (vlib_combined_counter_main_t * cm,
307 /** Obtain the number of simple or combined counters allocated.
308 A macro which reduces to to vec_len(cm->maxi), the answer in either
311 @param cm - (vlib_simple_counter_main_t) or
312 (vlib_combined_counter_main_t) the counter collection to interrogate
313 @returns vec_len(cm->maxi)
315 #define vlib_counter_len(cm) vec_len((cm)->maxi)
317 serialize_function_t serialize_vlib_simple_counter_main,
318 unserialize_vlib_simple_counter_main;
319 serialize_function_t serialize_vlib_combined_counter_main,
320 unserialize_vlib_combined_counter_main;
322 #endif /* included_vlib_counter_h */
325 * fd.io coding-style-patch-verification: ON
328 * eval: (c-set-style "gnu")