src/plugins/tracedump/tracedump.c

   1 /*
   2  * tracedump.c - skeleton vpp engine plug-in
   3  *
   4  * Copyright (c) <current-year> <your-organization>
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/vnet.h>
  19 #include <vnet/plugin/plugin.h>
  20 #include <tracedump/tracedump.h>
  21 #include <vlib/trace.h>
  22
  23 #include <vlibapi/api.h>
  24 #include <vlibmemory/api.h>
  25 #include <vpp/app/version.h>
  26 #include <stdbool.h>
  27
  28 #include <tracedump/tracedump.api_enum.h>
  29 #include <tracedump/tracedump.api_types.h>
  30
  31 #define REPLY_MSG_ID_BASE tdmp->msg_id_base
  32 #include <vlibapi/api_helper_macros.h>
  33
  34 tracedump_main_t tracedump_main;
  35
  36
  37 static void
  38 vl_api_trace_set_filters_t_handler (vl_api_trace_set_filters_t * mp)
  39 {
  40   vlib_main_t *vm = vlib_get_main ();
  41   tracedump_main_t *tdmp = &tracedump_main;
  42   u32 node_index = clib_net_to_host_u32 (mp->node_index);
  43   u32 flag = clib_net_to_host_u32 (mp->flag);
  44   u32 count = clib_net_to_host_u32 (mp->count);
  45   vl_api_trace_set_filters_reply_t *rmp;
  46   int rv = 0;
  47
  48   if (flag == TRACE_FF_NONE)
  49     {
  50       count = node_index = 0;
  51     }
  52   else if (flag != TRACE_FF_INCLUDE_NODE && flag != TRACE_FF_EXCLUDE_NODE)
  53     {
  54       rv = VNET_API_ERROR_INVALID_VALUE;
  55       goto done;
  56     }
  57
  58   vlib_node_t *node;
  59   node = vlib_get_node (vm, node_index);
  60   if (!node)
  61     {
  62       rv = VNET_API_ERROR_NO_SUCH_NODE;
  63       goto done;
  64     }
  65
  66   trace_filter_set (node_index, flag, count);
  67
  68 done:
  69   REPLY_MACRO (VL_API_TRACE_SET_FILTERS_REPLY);
  70 }
  71
  72
  73 static void
  74 vl_api_trace_capture_packets_t_handler (vl_api_trace_capture_packets_t * mp)
  75 {
  76   vlib_main_t *vm = vlib_get_main ();
  77   tracedump_main_t *tdmp = &tracedump_main;
  78   u32 add = clib_net_to_host_u32 (mp->max_packets);
  79   u32 node_index = clib_net_to_host_u32 (mp->node_index);
  80   u8 filter = mp->use_filter;
  81   u8 verbose = mp->verbose;
  82   u8 pre_clear = mp->pre_capture_clear;
  83   vl_api_trace_capture_packets_reply_t *rmp;
  84   int rv = 0;
  85
  86   if (!vnet_trace_placeholder)
  87     vec_validate_aligned (vnet_trace_placeholder, 2048,
  88                           CLIB_CACHE_LINE_BYTES);
  89
  90   vlib_node_t *node;
  91   node = vlib_get_node (vm, node_index);
  92   if (!node)
  93     {
  94       rv = VNET_API_ERROR_NO_SUCH_NODE;
  95       goto done;
  96     }
  97
  98   if ((node->flags & VLIB_NODE_FLAG_TRACE_SUPPORTED) == 0)
  99     {
 100       /* FIXME: Make a new, better error like "UNSUPPORTED_NODE_OPERATION"? */
 101       rv = VNET_API_ERROR_NO_SUCH_NODE;
 102       goto done;
 103     }
 104
 105   if (pre_clear)
 106     vlib_trace_stop_and_clear ();
 107
 108   trace_update_capture_options (add, node_index, filter, verbose);
 109
 110 done:
 111   REPLY_MACRO (VL_API_TRACE_CAPTURE_PACKETS_REPLY);
 112 }
 113
 114
 115 static void
 116 vl_api_trace_clear_capture_t_handler (vl_api_trace_clear_capture_t * mp)
 117 {
 118   vl_api_trace_clear_capture_reply_t *rmp;
 119   tracedump_main_t *tdmp = &tracedump_main;
 120
 121   vlib_trace_stop_and_clear ();
 122
 123   int rv = 0;
 124   REPLY_MACRO (VL_API_TRACE_CLEAR_CAPTURE_REPLY);
 125 }
 126
 127
 128
 129 static int
 130 trace_cmp (void *a1, void *a2)
 131 {
 132   vlib_trace_header_t **t1 = a1;
 133   vlib_trace_header_t **t2 = a2;
 134   i64 dt = t1[0]->time - t2[0]->time;
 135   return dt < 0 ? -1 : (dt > 0 ? +1 : 0);
 136 }
 137
 138 static void
 139 toss_client_cache (tracedump_main_t * tdmp, u32 client_index,
 140                    vlib_trace_header_t *** client_trace_cache)
 141 {
 142   vlib_trace_header_t **th;
 143   int i;
 144
 145   /* Across each vlib main... */
 146   for (i = 0; i < vec_len (client_trace_cache); i++)
 147     {
 148       th = client_trace_cache[i];
 149       /* Toss the thread's cached data */
 150       vec_free (th);
 151     }
 152   /* And toss the vector of threads */
 153   vec_free (client_trace_cache);
 154   tdmp->traces[client_index] = client_trace_cache;
 155 }
 156
 157 static clib_error_t *
 158 tracedump_cache_reaper (u32 client_index)
 159 {
 160   tracedump_main_t *tdmp = &tracedump_main;
 161   vlib_trace_header_t ***client_trace_cache;
 162
 163   /* Its likely that we won't have a cache entry */
 164   if (client_index >= vec_len (tdmp->traces))
 165     return 0;
 166
 167   client_trace_cache = tdmp->traces[client_index];
 168   toss_client_cache (tdmp, client_index, client_trace_cache);
 169   return 0;
 170 }
 171
 172 VL_MSG_API_REAPER_FUNCTION (tracedump_cache_reaper);
 173
 174 /* API message handler */
 175 static void
 176 vl_api_trace_dump_t_handler (vl_api_trace_dump_t * mp)
 177 {
 178   vl_api_registration_t *rp;
 179   vl_api_trace_dump_reply_t *rmp;
 180   vl_api_trace_details_t *dmp;
 181   tracedump_main_t *tdmp = &tracedump_main;
 182   vlib_trace_header_t ***client_trace_cache, **th;
 183   int i, j;
 184   u32 client_index;
 185   u32 iterator_thread_id, iterator_position, max_records;
 186   i32 retval = VNET_API_ERROR_NO_SUCH_ENTRY;
 187   u32 last_thread_id = ~0, last_position = ~0;
 188   u8 last_done = 0;
 189   u8 last_more_this_thread = 0;
 190   u8 last_more_threads = 0;
 191   u8 *s = 0;
 192
 193   rp = vl_api_client_index_to_registration (mp->client_index);
 194   if (rp == 0)
 195     return;
 196
 197   /* Use the registration pool index... */
 198   client_index = rp->vl_api_registration_pool_index;
 199
 200   vec_validate_init_empty (tdmp->traces, client_index, 0);
 201
 202   client_trace_cache = tdmp->traces[client_index];
 203
 204   /* Clear the per-client cache if requested */
 205   if (mp->clear_cache)
 206     {
 207       toss_client_cache (tdmp, client_index, client_trace_cache);
 208       client_trace_cache = 0;
 209     }
 210
 211   /* Now, where were we? */
 212   iterator_thread_id = clib_net_to_host_u32 (mp->thread_id);
 213   iterator_position = clib_net_to_host_u32 (mp->position);
 214   max_records = clib_net_to_host_u32 (mp->max_records);
 215
 216   /* Don't overflow the existing queue space. */
 217   svm_queue_t *q = rp->vl_input_queue;
 218   u32 queue_slots_available = q->maxsize - q->cursize;
 219   int chunk = (queue_slots_available > 0) ? queue_slots_available - 1 : 0;
 220   if (chunk < max_records)
 221     max_records = chunk;
 222
 223   /* Need a fresh cache for this client? */
 224   if (vec_len (client_trace_cache) == 0
 225       && (iterator_thread_id != ~0 || iterator_position != ~0))
 226     {
 227       vlib_worker_thread_barrier_sync (&vlib_global_main);
 228
 229       /* Make a slot for each worker thread */
 230       vec_validate (client_trace_cache, vec_len (vlib_mains) - 1);
 231       i = 0;
 232
 233       /* *INDENT-OFF* */
 234       foreach_vlib_main (
 235       ({
 236         vlib_trace_main_t *tm = &this_vlib_main->trace_main;
 237
 238         /* Filter as directed */
 239         trace_apply_filter(this_vlib_main);
 240
 241         pool_foreach (th, tm->trace_buffer_pool)
 242          {
 243           vec_add1 (client_trace_cache[i], th[0]);
 244         }
 245
 246         /* Sort them by increasing time. */
 247         if (vec_len (client_trace_cache[i]))
 248           vec_sort_with_function (client_trace_cache[i], trace_cmp);
 249
 250         i++;
 251       }));
 252       /* *INDENT-ON* */
 253       vlib_worker_thread_barrier_release (&vlib_global_main);
 254     }
 255
 256   /* Save the cache, one way or the other */
 257   tdmp->traces[client_index] = client_trace_cache;
 258
 259   for (i = iterator_thread_id; i < vec_len (client_trace_cache); i++)
 260     {
 261       for (j = iterator_position; j < vec_len (client_trace_cache[i]); j++)
 262         {
 263           if (max_records == 0)
 264             break;
 265
 266           retval = 0;
 267           th = &client_trace_cache[i][j];
 268
 269           vec_reset_length (s);
 270
 271           s = format (s, "%U", format_vlib_trace, &vlib_global_main, th[0]);
 272
 273           dmp = vl_msg_api_alloc (sizeof (*dmp) + vec_len (s));
 274           dmp->_vl_msg_id =
 275             htons (VL_API_TRACE_DETAILS + (tdmp->msg_id_base));
 276           dmp->context = mp->context;
 277           last_thread_id = dmp->thread_id = ntohl (i);
 278           last_position = dmp->position = ntohl (j);
 279           vl_api_vec_to_api_string (s, &dmp->trace_data);
 280           dmp->packet_number = htonl (j);
 281           dmp->more_threads = 0;
 282           dmp->more_this_thread = 0;
 283
 284           /* Last record in the batch? */
 285           if (max_records == 1)
 286             {
 287               /* More threads, but not more in this thread? */
 288               if (j == (vec_len (client_trace_cache[i]) - 1))
 289                 dmp->more_threads = 1;
 290               else
 291                 dmp->more_this_thread = 1;
 292             }
 293           /* Done, may or may not be at the end of a batch. */
 294           dmp->done = 0;
 295           if (i == (vec_len (client_trace_cache) - 1) &&
 296               j == (vec_len (client_trace_cache[i]) - 1))
 297             {
 298               last_done = dmp->done = 1;
 299               last_more_threads = dmp->more_threads = 0;
 300               last_more_this_thread = dmp->more_this_thread = 0;
 301               vl_api_send_msg (rp, (u8 *) dmp);
 302               goto doublebreak;
 303             }
 304           last_done = dmp->done;
 305           vl_api_send_msg (rp, (u8 *) dmp);
 306
 307           max_records--;
 308         }
 309       iterator_position = 0;
 310     }
 311
 312 doublebreak:;
 313
 314   rmp = vl_msg_api_alloc (sizeof (*rmp));
 315   rmp->_vl_msg_id = htons (VL_API_TRACE_DUMP_REPLY + (tdmp->msg_id_base));
 316   rmp->context = mp->context;
 317   rmp->retval = clib_host_to_net_u32 (retval);
 318   rmp->last_thread_id = last_thread_id;
 319   rmp->last_position = last_position;
 320   rmp->done = last_done;
 321   rmp->more_this_thread = last_more_this_thread;
 322   rmp->more_threads = last_more_threads;
 323
 324   /* Tag cleanup flushes to make life easy for the client */
 325   if (iterator_thread_id == ~0 && iterator_position == ~0)
 326     {
 327       rmp->retval = 0;
 328       rmp->done = 1;
 329       rmp->flush_only = 1;
 330     }
 331   vl_api_send_msg (rp, (u8 *) rmp);
 332
 333   vec_free (s);
 334 }
 335
 336 /* API definitions */
 337 #include <tracedump/tracedump.api.c>
 338
 339 static clib_error_t *
 340 tracedump_init (vlib_main_t * vm)
 341 {
 342   tracedump_main_t *tdmp = &tracedump_main;
 343   api_main_t *am = vlibapi_get_main ();
 344
 345   clib_error_t *error = 0;
 346
 347   tdmp->vlib_main = vm;
 348   tdmp->vnet_main = vnet_get_main ();
 349
 350   /* Add our API messages to the global name_crc hash table */
 351   tdmp->msg_id_base = setup_message_id_table ();
 352
 353   am->is_mp_safe[tdmp->msg_id_base + VL_API_TRACE_DUMP] = 1;
 354
 355   return error;
 356 }
 357
 358 VLIB_INIT_FUNCTION (tracedump_init);
 359 /* *INDENT-OFF* */
 360 VLIB_PLUGIN_REGISTER () =
 361 {
 362   .version = VPP_BUILD_VER,
 363   .description = "Streaming packet trace dump plugin",
 364 };
 365 /* *INDENT-ON* */
 366
 367 /*
 368  * fd.io coding-style-patch-verification: ON
 369  *
 370  * Local Variables:
 371  * eval: (c-set-style "gnu")
 372  * End:
 373  */