FD.io VPP  v21.01.1
Vector Packet Processing
counter.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * counter.c: simple and packet/byte counters
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vlib/vlib.h>
41 #include <vlib/stat_weak_inlines.h>
42 
43 void
45 {
46  counter_t *my_counters;
47  uword i, j;
48 
49  for (i = 0; i < vec_len (cm->counters); i++)
50  {
51  my_counters = cm->counters[i];
52 
53  for (j = 0; j < vec_len (my_counters); j++)
54  {
55  my_counters[j] = 0;
56  }
57  }
58 }
59 
60 void
62 {
63  vlib_counter_t *my_counters;
64  uword i, j;
65 
66  for (i = 0; i < vec_len (cm->counters); i++)
67  {
68  my_counters = cm->counters[i];
69 
70  for (j = 0; j < vec_len (my_counters); j++)
71  {
72  my_counters[j].packets = 0;
73  my_counters[j].bytes = 0;
74  }
75  }
76 }
77 
78 void
80 {
82  int i;
83  void *oldheap = vlib_stats_push_heap (cm->counters);
84 
85  vec_validate (cm->counters, tm->n_vlib_mains - 1);
86  for (i = 0; i < tm->n_vlib_mains; i++)
88 
89  vlib_stats_pop_heap (cm, oldheap, index,
90  2 /* STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE */ );
91 }
92 
93 void
95 {
96  int i;
97 
99 
100  void *oldheap = vlib_stats_push_heap (cm->counters);
101  for (i = 0; i < vec_len (cm->counters); i++)
102  vec_free (cm->counters[i]);
103  vec_free (cm->counters);
104  clib_mem_set_heap (oldheap);
105 }
106 
107 void
109 {
111  int i;
112  void *oldheap = vlib_stats_push_heap (cm->counters);
113 
114  vec_validate (cm->counters, tm->n_vlib_mains - 1);
115  for (i = 0; i < tm->n_vlib_mains; i++)
117 
118  vlib_stats_pop_heap (cm, oldheap, index,
119  3 /*STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED */ );
120 }
121 
122 int
125 {
127  int i;
128  void *oldheap = vlib_stats_push_heap (cm->counters);
129 
130  /* Possibly once in recorded history */
131  if (PREDICT_FALSE (vec_len (cm->counters) == 0))
132  {
133  vlib_stats_pop_heap (cm, oldheap, index,
134  3 /*STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED */ );
135  return 1;
136  }
137 
138  for (i = 0; i < tm->n_vlib_mains; i++)
139  {
140  /* Trivially OK, and proves that index >= vec_len(...) */
141  if (index < vec_len (cm->counters[i]))
142  continue;
143  if (_vec_resize_will_expand
144  (cm->counters[i],
145  index - vec_len (cm->counters[i]) /* length_increment */ ,
146  sizeof (cm->counters[i]) /* data_bytes */ ,
147  0 /* header_bytes */ ,
148  CLIB_CACHE_LINE_BYTES /* data_alignment */ ))
149  {
150  vlib_stats_pop_heap (cm, oldheap, index,
151  3 /*STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED */ );
152  return 1;
153  }
154  }
155  vlib_stats_pop_heap (cm, oldheap, index,
156  3 /*STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED */ );
157  return 0;
158 }
159 
160 void
162 {
163  int i;
164 
166 
167  void *oldheap = vlib_stats_push_heap (cm->counters);
168  for (i = 0; i < vec_len (cm->counters); i++)
169  vec_free (cm->counters[i]);
170  vec_free (cm->counters);
171  clib_mem_set_heap (oldheap);
172 }
173 
174 u32
176 {
177  ASSERT (cm->counters);
178  return (vec_len (cm->counters[0]));
179 }
180 
181 u32
183 {
184  ASSERT (cm->counters);
185  return (vec_len (cm->counters[0]));
186 }
187 
188 /*
189  * fd.io coding-style-patch-verification: ON
190  *
191  * Local Variables:
192  * eval: (c-set-style "gnu")
193  * End:
194  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
void vlib_free_simple_counter(vlib_simple_counter_main_t *cm)
Definition: counter.c:94
u32 vlib_simple_counter_n_counters(const vlib_simple_counter_main_t *cm)
The number of counters (not the number of per-thread counters)
Definition: counter.c:182
void vlib_validate_combined_counter(vlib_combined_counter_main_t *cm, u32 index)
validate a combined counter
Definition: counter.c:108
int vlib_validate_combined_counter_will_expand(vlib_combined_counter_main_t *cm, u32 index)
Definition: counter.c:124
static clib_mem_heap_t * clib_mem_set_heap(clib_mem_heap_t *heap)
Definition: mem.h:365
Combined counter to hold both packets and byte differences.
Definition: counter_types.h:26
void * vlib_stats_push_heap(void *old)
Definition: stat_segment.c:52
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:520
vlib_counter_t ** counters
Per-thread u64 non-atomic counter pairs.
Definition: counter.h:209
void vlib_clear_combined_counters(vlib_combined_counter_main_t *cm)
Clear a collection of combined counters.
Definition: counter.c:61
void vlib_stats_pop_heap(void *cm_arg, void *oldheap, u32 cindex, stat_directory_type_t type)
Definition: stat_segment.c:185
uint64_t counter_t
64bit counters
Definition: counter_types.h:22
void vlib_free_combined_counter(vlib_combined_counter_main_t *cm)
Definition: counter.c:161
unsigned int u32
Definition: types.h:88
A collection of simple counters.
Definition: counter.h:57
counter_t packets
packet counter
Definition: counter_types.h:28
u32 vlib_combined_counter_n_counters(const vlib_combined_counter_main_t *cm)
The number of counters (not the number of per-thread counters)
Definition: counter.c:175
#define PREDICT_FALSE(x)
Definition: clib.h:121
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
void vlib_validate_simple_counter(vlib_simple_counter_main_t *cm, u32 index)
validate a simple counter
Definition: counter.c:79
#define ASSERT(truth)
counter_t bytes
byte counter
Definition: counter_types.h:29
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
A collection of combined counters.
Definition: counter.h:207
counter_t ** counters
Per-thread u64 non-atomic counters.
Definition: counter.h:59
void vlib_clear_simple_counters(vlib_simple_counter_main_t *cm)
Clear a collection of simple counters.
Definition: counter.c:44
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
void vlib_stats_delete_cm(void *cm_arg)
Definition: stat_segment.c:154
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59