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