src/vlib/trace.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.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_h
  41 #define included_vlib_trace_h
  42
  43 #include <vppinfra/pool.h>
  44
  45 typedef struct
  46 {
  47   /* CPU time stamp trace was made. */
  48   u64 time;
  49
  50   /* Node which generated this trace. */
  51   u32 node_index;
  52
  53   /* Number of data words in this trace. */
  54   u32 n_data;
  55
  56   /* Trace data follows. */
  57   u8 data[0];
  58 } vlib_trace_header_t;
  59
  60 typedef struct
  61 {
  62   /* Current number of traces in buffer. */
  63   u32 count;
  64
  65   /* Max. number of traces to be added to buffer. */
  66   u32 limit;
  67 } vlib_trace_node_t;
  68
  69 /* Callback type for post-processing the vlib trace buffer */
  70 struct vlib_main_t;
  71 struct vlib_trace_main_t;
  72 typedef void (vlib_trace_buffer_callback_t) (struct vlib_main_t *,
  73                                              struct vlib_trace_main_t *);
  74
  75 /* Callback type for alternate handling of vlib_add_trace internals */
  76 struct vlib_node_runtime_t;
  77 struct vlib_buffer_t;
  78 typedef void *(vlib_add_trace_callback_t) (struct vlib_main_t *,
  79                                            struct vlib_node_runtime_t * r,
  80                                            struct vlib_buffer_t * b,
  81                                            u32 n_data_bytes);
  82
  83 typedef struct
  84 {
  85   /* Pool of trace buffers. */
  86   vlib_trace_header_t **trace_buffer_pool;
  87
  88   u32 last_main_loop_count;
  89   u32 filter_node_index;
  90   u32 filter_flag;
  91 #define FILTER_FLAG_NONE    0
  92 #define FILTER_FLAG_INCLUDE 1
  93 #define FILTER_FLAG_EXCLUDE 2
  94   u32 filter_count;
  95
  96   /* set on trace add, cleared on clear trace */
  97   u32 trace_enable;
  98
  99   /* Per node trace counts. */
 100   vlib_trace_node_t *nodes;
 101
 102   /* verbosity */
 103   int verbose;
 104
 105   /* a callback to enable customized consumption of the trace buffer content */
 106   vlib_trace_buffer_callback_t *trace_buffer_callback;
 107
 108   /* a callback to enable customized addition of a new trace */
 109   vlib_add_trace_callback_t *add_trace_callback;
 110
 111 } vlib_trace_main_t;
 112
 113 format_function_t format_vlib_trace;
 114
 115 void trace_apply_filter (struct vlib_main_t *vm);
 116
 117 #endif /* included_vlib_trace_h */
 118
 119 /*
 120  * fd.io coding-style-patch-verification: ON
 121  *
 122  * Local Variables:
 123  * eval: (c-set-style "gnu")
 124  * End:
 125  */