src/vlib/counter.c

   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
  44 vlib_clear_simple_counters (vlib_simple_counter_main_t * cm)
  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
  61 vlib_clear_combined_counters (vlib_combined_counter_main_t * cm)
  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
  79 vlib_validate_simple_counter (vlib_simple_counter_main_t * cm, u32 index)
  80 {
  81   vlib_thread_main_t *tm = vlib_get_thread_main ();
  82   int i, resized = 0;
  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++)
  87     if (index >= vec_len (cm->counters[i]))
  88       {
  89         if (vec_resize_will_expand (cm->counters[i],
  90                                     index - vec_len (cm->counters[i]) +
  91                                       1 /* length_increment */))
  92           resized++;
  93         vec_validate_aligned (cm->counters[i], index, CLIB_CACHE_LINE_BYTES);
  94       }
  95
  96   /* Avoid the epoch increase when there was no counter vector resize. */
  97   if (resized)
  98     vlib_stats_pop_heap (cm, oldheap, index,
  99                          2 /* STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE */);
 100   else
 101     clib_mem_set_heap (oldheap);
 102 }
 103
 104 void
 105 vlib_free_simple_counter (vlib_simple_counter_main_t * cm)
 106 {
 107   int i;
 108
 109   vlib_stats_delete_cm (cm);
 110
 111   void *oldheap = vlib_stats_push_heap (cm->counters);
 112   for (i = 0; i < vec_len (cm->counters); i++)
 113     vec_free (cm->counters[i]);
 114   vec_free (cm->counters);
 115   clib_mem_set_heap (oldheap);
 116 }
 117
 118 void
 119 vlib_validate_combined_counter (vlib_combined_counter_main_t * cm, u32 index)
 120 {
 121   vlib_thread_main_t *tm = vlib_get_thread_main ();
 122   int i, resized = 0;
 123   void *oldheap = vlib_stats_push_heap (cm->counters);
 124
 125   vec_validate (cm->counters, tm->n_vlib_mains - 1);
 126   for (i = 0; i < tm->n_vlib_mains; i++)
 127     if (index >= vec_len (cm->counters[i]))
 128       {
 129         if (vec_resize_will_expand (cm->counters[i],
 130                                     index - vec_len (cm->counters[i]) +
 131                                       1 /* length_increment */))
 132           resized++;
 133         vec_validate_aligned (cm->counters[i], index, CLIB_CACHE_LINE_BYTES);
 134       }
 135
 136   /* Avoid the epoch increase when there was no counter vector resize. */
 137   if (resized)
 138     vlib_stats_pop_heap (cm, oldheap, index,
 139                          3 /*STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED */);
 140   else
 141     clib_mem_set_heap (oldheap);
 142 }
 143
 144 int
 145   vlib_validate_combined_counter_will_expand
 146   (vlib_combined_counter_main_t * cm, u32 index)
 147 {
 148   vlib_thread_main_t *tm = vlib_get_thread_main ();
 149   int i;
 150   void *oldheap = vlib_stats_push_heap (cm->counters);
 151
 152   /* Possibly once in recorded history */
 153   if (PREDICT_FALSE (vec_len (cm->counters) == 0))
 154     {
 155       clib_mem_set_heap (oldheap);
 156       return 1;
 157     }
 158
 159   for (i = 0; i < tm->n_vlib_mains; i++)
 160     {
 161       /* Trivially OK, and proves that index >= vec_len(...) */
 162       if (index < vec_len (cm->counters[i]))
 163         continue;
 164       if (vec_resize_will_expand (cm->counters[i],
 165                                   index - vec_len (cm->counters[i]) +
 166                                     1 /* length_increment */))
 167         {
 168           clib_mem_set_heap (oldheap);
 169           return 1;
 170         }
 171     }
 172   clib_mem_set_heap (oldheap);
 173   return 0;
 174 }
 175
 176 void
 177 vlib_free_combined_counter (vlib_combined_counter_main_t * cm)
 178 {
 179   int i;
 180
 181   vlib_stats_delete_cm (cm);
 182
 183   void *oldheap = vlib_stats_push_heap (cm->counters);
 184   for (i = 0; i < vec_len (cm->counters); i++)
 185     vec_free (cm->counters[i]);
 186   vec_free (cm->counters);
 187   clib_mem_set_heap (oldheap);
 188 }
 189
 190 u32
 191 vlib_combined_counter_n_counters (const vlib_combined_counter_main_t * cm)
 192 {
 193   ASSERT (cm->counters);
 194   return (vec_len (cm->counters[0]));
 195 }
 196
 197 u32
 198 vlib_simple_counter_n_counters (const vlib_simple_counter_main_t * cm)
 199 {
 200   ASSERT (cm->counters);
 201   return (vec_len (cm->counters[0]));
 202 }
 203
 204 /*
 205  * fd.io coding-style-patch-verification: ON
 206  *
 207  * Local Variables:
 208  * eval: (c-set-style "gnu")
 209  * End:
 210  */