src/vlib/trace_funcs.h

   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  * trace_funcs.h: VLIB trace buffer.
  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 #ifndef included_vlib_trace_funcs_h
  41 #define included_vlib_trace_funcs_h
  42
  43 extern u8 *vnet_trace_dummy;
  44
  45 always_inline void
  46 vlib_validate_trace (vlib_trace_main_t * tm, vlib_buffer_t * b)
  47 {
  48   ASSERT (!pool_is_free_index (tm->trace_buffer_pool,
  49                                vlib_buffer_get_trace_index (b)));
  50 }
  51
  52 void vlib_add_handoff_trace (vlib_main_t * vm, vlib_buffer_t * b);
  53
  54 always_inline void *
  55 vlib_add_trace (vlib_main_t * vm,
  56                 vlib_node_runtime_t * r, vlib_buffer_t * b, u32 n_data_bytes)
  57 {
  58   vlib_trace_main_t *tm = &vm->trace_main;
  59   vlib_trace_header_t *h;
  60   u32 n_data_words;
  61
  62   ASSERT (vnet_trace_dummy);
  63
  64   if (PREDICT_FALSE (tm->add_trace_callback != 0))
  65     {
  66       return tm->add_trace_callback ((struct vlib_main_t *) vm,
  67                                      (struct vlib_node_runtime_t *) r,
  68                                      (struct vlib_buffer_t *) b,
  69                                      n_data_bytes);
  70     }
  71   else if (PREDICT_FALSE (tm->trace_enable == 0))
  72     {
  73       ASSERT (vec_len (vnet_trace_dummy) >= n_data_bytes + sizeof (*h));
  74       return vnet_trace_dummy;
  75     }
  76
  77   /* Are we trying to trace a handoff case? */
  78   if (PREDICT_FALSE (vlib_buffer_get_trace_thread (b) != vm->thread_index))
  79     vlib_add_handoff_trace (vm, b);
  80
  81   vlib_validate_trace (tm, b);
  82
  83   n_data_bytes = round_pow2 (n_data_bytes, sizeof (h[0]));
  84   n_data_words = n_data_bytes / sizeof (h[0]);
  85   vec_add2_aligned (tm->trace_buffer_pool[vlib_buffer_get_trace_index (b)], h,
  86                     1 + n_data_words, sizeof (h[0]));
  87
  88   h->time = vm->cpu_time_last_node_dispatch;
  89   h->n_data = n_data_words;
  90   h->node_index = r->node_index;
  91
  92   return h->data;
  93 }
  94
  95 always_inline vlib_trace_header_t *
  96 vlib_trace_header_next (vlib_trace_header_t * h)
  97 {
  98   return h + 1 + h->n_data;
  99 }
 100
 101 always_inline void
 102 vlib_free_trace (vlib_main_t * vm, vlib_buffer_t * b)
 103 {
 104   vlib_trace_main_t *tm = &vm->trace_main;
 105   u32 trace_index = vlib_buffer_get_trace_index (b);
 106   vlib_validate_trace (tm, b);
 107   _vec_len (tm->trace_buffer_pool[trace_index]) = 0;
 108   pool_put_index (tm->trace_buffer_pool, trace_index);
 109 }
 110
 111 always_inline void
 112 vlib_trace_next_frame (vlib_main_t * vm,
 113                        vlib_node_runtime_t * r, u32 next_index)
 114 {
 115   vlib_next_frame_t *nf;
 116   nf = vlib_node_runtime_get_next_frame (vm, r, next_index);
 117   nf->flags |= VLIB_FRAME_TRACE;
 118 }
 119
 120 void trace_apply_filter (vlib_main_t * vm);
 121
 122 /* Mark buffer as traced and allocate trace buffer. */
 123 always_inline void
 124 vlib_trace_buffer (vlib_main_t * vm,
 125                    vlib_node_runtime_t * r,
 126                    u32 next_index, vlib_buffer_t * b, int follow_chain)
 127 {
 128   vlib_trace_main_t *tm = &vm->trace_main;
 129   vlib_trace_header_t **h;
 130
 131   if (PREDICT_FALSE (tm->trace_enable == 0))
 132     return;
 133
 134   /*
 135    * Apply filter to existing traces to keep number of allocated traces low.
 136    * Performed each time around the main loop.
 137    */
 138   if (tm->last_main_loop_count != vm->main_loop_count)
 139     {
 140       tm->last_main_loop_count = vm->main_loop_count;
 141       trace_apply_filter (vm);
 142
 143       if (tm->trace_buffer_callback)
 144         (tm->trace_buffer_callback) ((struct vlib_main_t *) vm,
 145                                      (struct vlib_trace_main_t *) tm);
 146     }
 147
 148   vlib_trace_next_frame (vm, r, next_index);
 149
 150   pool_get (tm->trace_buffer_pool, h);
 151
 152   do
 153     {
 154       b->flags |= VLIB_BUFFER_IS_TRACED;
 155       b->trace_handle = vlib_buffer_make_trace_handle
 156         (vm->thread_index, h - tm->trace_buffer_pool);
 157     }
 158   while (follow_chain && (b = vlib_get_next_buffer (vm, b)));
 159 }
 160
 161 always_inline void
 162 vlib_buffer_copy_trace_flag (vlib_main_t * vm, vlib_buffer_t * b,
 163                              u32 bi_target)
 164 {
 165   vlib_buffer_t *b_target = vlib_get_buffer (vm, bi_target);
 166   b_target->flags |= b->flags & VLIB_BUFFER_IS_TRACED;
 167   b_target->trace_handle = b->trace_handle;
 168 }
 169
 170 always_inline u32
 171 vlib_get_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt)
 172 {
 173   vlib_trace_main_t *tm = &vm->trace_main;
 174   vlib_trace_node_t *tn;
 175   int n;
 176
 177   if (rt->node_index >= vec_len (tm->nodes))
 178     return 0;
 179   tn = tm->nodes + rt->node_index;
 180   n = tn->limit - tn->count;
 181   ASSERT (n >= 0);
 182
 183   return n;
 184 }
 185
 186 always_inline void
 187 vlib_set_trace_count (vlib_main_t * vm, vlib_node_runtime_t * rt, u32 count)
 188 {
 189   vlib_trace_main_t *tm = &vm->trace_main;
 190   vlib_trace_node_t *tn = vec_elt_at_index (tm->nodes, rt->node_index);
 191
 192   ASSERT (count <= tn->limit);
 193   tn->count = tn->limit - count;
 194 }
 195
 196 /* Helper function for nodes which only trace buffer data. */
 197 void
 198 vlib_trace_frame_buffers_only (vlib_main_t * vm,
 199                                vlib_node_runtime_t * node,
 200                                u32 * buffers,
 201                                uword n_buffers,
 202                                uword next_buffer_stride,
 203                                uword n_buffer_data_bytes_in_trace);
 204
 205 #endif /* included_vlib_trace_funcs_h */
 206
 207 /*
 208  * fd.io coding-style-patch-verification: ON
 209  *
 210  * Local Variables:
 211  * eval: (c-set-style "gnu")
 212  * End:
 213  */