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   char *name = cm->stat_segment_name ? cm->stat_segment_name : cm->name;
  83
  84   if (name == 0)
  85     {
  86       if (cm->counters == 0)
  87         cm->stats_entry_index = ~0;
  88       vec_validate (cm->counters, tm->n_vlib_mains - 1);
  89       for (int i = 0; i < tm->n_vlib_mains; i++)
  90         vec_validate_aligned (cm->counters[i], index, CLIB_CACHE_LINE_BYTES);
  91       return;
  92     }
  93
  94   if (cm->counters == 0)
  95     cm->stats_entry_index = vlib_stats_add_counter_vector ("%s", name);
  96
  97   vlib_stats_validate (cm->stats_entry_index, tm->n_vlib_mains - 1, index);
  98   cm->counters = vlib_stats_get_entry_data_pointer (cm->stats_entry_index);
  99 }
 100
 101 void
 102 vlib_free_simple_counter (vlib_simple_counter_main_t * cm)
 103 {
 104   if (cm->stats_entry_index == ~0)
 105     {
 106       for (int i = 0; i < vec_len (cm->counters); i++)
 107         vec_free (cm->counters[i]);
 108       vec_free (cm->counters);
 109     }
 110   else
 111     vlib_stats_remove_entry (cm->stats_entry_index);
 112 }
 113
 114 void
 115 vlib_validate_combined_counter (vlib_combined_counter_main_t * cm, u32 index)
 116 {
 117   vlib_thread_main_t *tm = vlib_get_thread_main ();
 118   char *name = cm->stat_segment_name ? cm->stat_segment_name : cm->name;
 119
 120   if (name == 0)
 121     {
 122       if (cm->counters == 0)
 123         cm->stats_entry_index = ~0;
 124       vec_validate (cm->counters, tm->n_vlib_mains - 1);
 125       for (int i = 0; i < tm->n_vlib_mains; i++)
 126         vec_validate_aligned (cm->counters[i], index, CLIB_CACHE_LINE_BYTES);
 127       return;
 128     }
 129
 130   if (cm->counters == 0)
 131     cm->stats_entry_index = vlib_stats_add_counter_pair_vector ("%s", name);
 132
 133   vlib_stats_validate (cm->stats_entry_index, tm->n_vlib_mains - 1, index);
 134   cm->counters = vlib_stats_get_entry_data_pointer (cm->stats_entry_index);
 135 }
 136
 137 int
 138   vlib_validate_combined_counter_will_expand
 139   (vlib_combined_counter_main_t * cm, u32 index)
 140 {
 141   vlib_thread_main_t *tm = vlib_get_thread_main ();
 142   int i;
 143   void *oldheap = vlib_stats_set_heap ();
 144
 145   /* Possibly once in recorded history */
 146   if (PREDICT_FALSE (vec_len (cm->counters) == 0))
 147     {
 148       clib_mem_set_heap (oldheap);
 149       return 1;
 150     }
 151
 152   for (i = 0; i < tm->n_vlib_mains; i++)
 153     {
 154       /* Trivially OK, and proves that index >= vec_len(...) */
 155       if (index < vec_len (cm->counters[i]))
 156         continue;
 157       if (vec_resize_will_expand (cm->counters[i],
 158                                   index - vec_len (cm->counters[i]) +
 159                                     1 /* length_increment */))
 160         {
 161           clib_mem_set_heap (oldheap);
 162           return 1;
 163         }
 164     }
 165   clib_mem_set_heap (oldheap);
 166   return 0;
 167 }
 168
 169 void
 170 vlib_free_combined_counter (vlib_combined_counter_main_t * cm)
 171 {
 172   if (cm->stats_entry_index == ~0)
 173     {
 174       for (int i = 0; i < vec_len (cm->counters); i++)
 175         vec_free (cm->counters[i]);
 176       vec_free (cm->counters);
 177     }
 178   else
 179     vlib_stats_remove_entry (cm->stats_entry_index);
 180 }
 181
 182 u32
 183 vlib_combined_counter_n_counters (const vlib_combined_counter_main_t * cm)
 184 {
 185   ASSERT (cm->counters);
 186   return (vec_len (cm->counters[0]));
 187 }
 188
 189 u32
 190 vlib_simple_counter_n_counters (const vlib_simple_counter_main_t * cm)
 191 {
 192   ASSERT (cm->counters);
 193   return (vec_len (cm->counters[0]));
 194 }
 195
 196 /*
 197  * fd.io coding-style-patch-verification: ON
 198  *
 199  * Local Variables:
 200  * eval: (c-set-style "gnu")
 201  * End:
 202  */