src/plugins/perfmon/perfmon_periodic.c

   1 /*
   2  * perfmon_periodic.c - skeleton plug-in periodic function
   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 <vlib/vlib.h>
  19 #include <vppinfra/error.h>
  20 #include <perfmon/perfmon.h>
  21 #include <asm/unistd.h>
  22 #include <sys/ioctl.h>
  23
  24 /* "not in glibc" */
  25 static long
  26 perf_event_open (struct perf_event_attr *hw_event, pid_t pid, int cpu,
  27                  int group_fd, unsigned long flags)
  28 {
  29   int ret;
  30
  31   ret = syscall (__NR_perf_event_open, hw_event, pid, cpu, group_fd, flags);
  32   return ret;
  33 }
  34
  35 static void
  36 read_current_perf_counters (vlib_main_t * vm, u64 * c0, u64 * c1,
  37                             vlib_node_runtime_t * node,
  38                             vlib_frame_t * frame, int before_or_after)
  39 {
  40   int i;
  41   u64 *cc;
  42   perfmon_main_t *pm = &perfmon_main;
  43   uword my_thread_index = vm->thread_index;
  44
  45   *c0 = *c1 = 0;
  46
  47   for (i = 0; i < pm->n_active; i++)
  48     {
  49       cc = (i == 0) ? c0 : c1;
  50       if (pm->rdpmc_indices[i][my_thread_index] != ~0)
  51         *cc = clib_rdpmc ((int) pm->rdpmc_indices[i][my_thread_index]);
  52       else
  53         {
  54           u64 sw_value;
  55           int read_result;
  56           if ((read_result = read (pm->pm_fds[i][my_thread_index], &sw_value,
  57                                    sizeof (sw_value)) != sizeof (sw_value)))
  58             {
  59               clib_unix_warning
  60                 ("counter read returned %d, expected %d",
  61                  read_result, sizeof (sw_value));
  62               clib_callback_enable_disable
  63                 (vm->vlib_node_runtime_perf_counter_cbs,
  64                  vm->vlib_node_runtime_perf_counter_cb_tmp,
  65                  vm->worker_thread_main_loop_callback_lock,
  66                  read_current_perf_counters, 0 /* enable */ );
  67               return;
  68             }
  69           *cc = sw_value;
  70         }
  71     }
  72 }
  73
  74 static void
  75 clear_counters (perfmon_main_t * pm)
  76 {
  77   int i, j;
  78   vlib_main_t *vm = pm->vlib_main;
  79   vlib_main_t *stat_vm;
  80   vlib_node_main_t *nm;
  81   vlib_node_t *n;
  82
  83   vlib_worker_thread_barrier_sync (vm);
  84
  85   for (j = 0; j < vec_len (vlib_mains); j++)
  86     {
  87       stat_vm = vlib_mains[j];
  88       if (stat_vm == 0)
  89         continue;
  90
  91       nm = &stat_vm->node_main;
  92
  93       /* Clear the node runtime perfmon counters */
  94       for (i = 0; i < vec_len (nm->nodes); i++)
  95         {
  96           n = nm->nodes[i];
  97           vlib_node_sync_stats (stat_vm, n);
  98         }
  99
 100       /* And clear the node perfmon counters */
 101       for (i = 0; i < vec_len (nm->nodes); i++)
 102         {
 103           n = nm->nodes[i];
 104           n->stats_total.perf_counter0_ticks = 0;
 105           n->stats_total.perf_counter1_ticks = 0;
 106           n->stats_total.perf_counter_vectors = 0;
 107           n->stats_last_clear.perf_counter0_ticks = 0;
 108           n->stats_last_clear.perf_counter1_ticks = 0;
 109           n->stats_last_clear.perf_counter_vectors = 0;
 110         }
 111     }
 112   vlib_worker_thread_barrier_release (vm);
 113 }
 114
 115 static void
 116 enable_current_events (perfmon_main_t * pm)
 117 {
 118   struct perf_event_attr pe;
 119   int fd;
 120   struct perf_event_mmap_page *p = 0;
 121   perfmon_event_config_t *c;
 122   vlib_main_t *vm = vlib_get_main ();
 123   u32 my_thread_index = vm->thread_index;
 124   u32 index;
 125   int i, limit = 1;
 126   int cpu;
 127
 128   if ((pm->current_event + 1) < vec_len (pm->single_events_to_collect))
 129     limit = 2;
 130
 131   for (i = 0; i < limit; i++)
 132     {
 133       c = vec_elt_at_index (pm->single_events_to_collect,
 134                             pm->current_event + i);
 135
 136       memset (&pe, 0, sizeof (struct perf_event_attr));
 137       pe.type = c->pe_type;
 138       pe.size = sizeof (struct perf_event_attr);
 139       pe.config = c->pe_config;
 140       pe.disabled = 1;
 141       pe.pinned = 1;
 142       /*
 143        * Note: excluding the kernel makes the
 144        * (software) context-switch counter read 0...
 145        */
 146       if (pe.type != PERF_TYPE_SOFTWARE)
 147         {
 148           /* Exclude kernel and hypervisor */
 149           pe.exclude_kernel = 1;
 150           pe.exclude_hv = 1;
 151         }
 152
 153       cpu = vm->cpu_id;
 154
 155       fd = perf_event_open (&pe, 0, cpu, -1, 0);
 156       if (fd == -1)
 157         {
 158           clib_unix_warning ("event open: type %d config %d", c->pe_type,
 159                              c->pe_config);
 160           return;
 161         }
 162
 163       if (pe.type != PERF_TYPE_SOFTWARE)
 164         {
 165           p = mmap (0, pm->page_size, PROT_READ, MAP_SHARED, fd, 0);
 166           if (p == MAP_FAILED)
 167             {
 168               clib_unix_warning ("mmap");
 169               close (fd);
 170               return;
 171             }
 172         }
 173       else
 174         p = 0;
 175
 176       if (ioctl (fd, PERF_EVENT_IOC_RESET, 0) < 0)
 177         clib_unix_warning ("reset ioctl");
 178
 179       if (ioctl (fd, PERF_EVENT_IOC_ENABLE, 0) < 0)
 180         clib_unix_warning ("enable ioctl");
 181
 182       pm->perf_event_pages[i][my_thread_index] = (void *) p;
 183       pm->pm_fds[i][my_thread_index] = fd;
 184     }
 185
 186   /*
 187    * Hardware events must be all opened and enabled before aquiring
 188    * pmc indices, otherwise the pmc indices might be out-dated.
 189    */
 190   for (i = 0; i < limit; i++)
 191     {
 192       p =
 193         (struct perf_event_mmap_page *)
 194         pm->perf_event_pages[i][my_thread_index];
 195
 196       /*
 197        * Software event counters - and others not capable of being
 198        * read via the "rdpmc" instruction - will be read
 199        * by system calls.
 200        */
 201       if (p == 0 || p->cap_user_rdpmc == 0)
 202         index = ~0;
 203       else
 204         index = p->index - 1;
 205
 206       pm->rdpmc_indices[i][my_thread_index] = index;
 207     }
 208
 209   pm->n_active = i;
 210   /* Enable the main loop counter snapshot mechanism */
 211   clib_callback_enable_disable
 212     (vm->vlib_node_runtime_perf_counter_cbs,
 213      vm->vlib_node_runtime_perf_counter_cb_tmp,
 214      vm->worker_thread_main_loop_callback_lock,
 215      read_current_perf_counters, 1 /* enable */ );
 216 }
 217
 218 static void
 219 disable_events (perfmon_main_t * pm)
 220 {
 221   vlib_main_t *vm = vlib_get_main ();
 222   u32 my_thread_index = vm->thread_index;
 223   int i;
 224
 225   /* Stop main loop collection */
 226   clib_callback_enable_disable
 227     (vm->vlib_node_runtime_perf_counter_cbs,
 228      vm->vlib_node_runtime_perf_counter_cb_tmp,
 229      vm->worker_thread_main_loop_callback_lock,
 230      read_current_perf_counters, 0 /* enable */ );
 231
 232   for (i = 0; i < pm->n_active; i++)
 233     {
 234       if (pm->pm_fds[i][my_thread_index] == 0)
 235         continue;
 236
 237       if (ioctl (pm->pm_fds[i][my_thread_index], PERF_EVENT_IOC_DISABLE, 0) <
 238           0)
 239         clib_unix_warning ("disable ioctl");
 240
 241       if (pm->perf_event_pages[i][my_thread_index])
 242         if (munmap (pm->perf_event_pages[i][my_thread_index],
 243                     pm->page_size) < 0)
 244           clib_unix_warning ("munmap");
 245
 246       (void) close (pm->pm_fds[i][my_thread_index]);
 247       pm->pm_fds[i][my_thread_index] = 0;
 248     }
 249 }
 250
 251 static void
 252 worker_thread_start_event (vlib_main_t * vm)
 253 {
 254   perfmon_main_t *pm = &perfmon_main;
 255
 256   clib_callback_enable_disable (vm->worker_thread_main_loop_callbacks,
 257                                 vm->worker_thread_main_loop_callback_tmp,
 258                                 vm->worker_thread_main_loop_callback_lock,
 259                                 worker_thread_start_event, 0 /* enable */ );
 260   enable_current_events (pm);
 261 }
 262
 263 static void
 264 worker_thread_stop_event (vlib_main_t * vm)
 265 {
 266   perfmon_main_t *pm = &perfmon_main;
 267   clib_callback_enable_disable (vm->worker_thread_main_loop_callbacks,
 268                                 vm->worker_thread_main_loop_callback_tmp,
 269                                 vm->worker_thread_main_loop_callback_lock,
 270                                 worker_thread_stop_event, 0 /* enable */ );
 271   disable_events (pm);
 272 }
 273
 274 static void
 275 start_event (perfmon_main_t * pm, f64 now, uword event_data)
 276 {
 277   int i;
 278   int last_set;
 279   int all = 0;
 280   pm->current_event = 0;
 281
 282   if (vec_len (pm->single_events_to_collect) == 0)
 283     {
 284       pm->state = PERFMON_STATE_OFF;
 285       return;
 286     }
 287
 288   last_set = clib_bitmap_last_set (pm->thread_bitmap);
 289   all = (last_set == ~0);
 290
 291   pm->state = PERFMON_STATE_RUNNING;
 292   clear_counters (pm);
 293
 294   /* Start collection on thread 0? */
 295   if (all || clib_bitmap_get (pm->thread_bitmap, 0))
 296     {
 297       /* Start collection on this thread */
 298       enable_current_events (pm);
 299     }
 300
 301   /* And also on worker threads */
 302   for (i = 1; i < vec_len (vlib_mains); i++)
 303     {
 304       if (vlib_mains[i] == 0)
 305         continue;
 306
 307       if (all || clib_bitmap_get (pm->thread_bitmap, i))
 308         clib_callback_enable_disable
 309           (vlib_mains[i]->worker_thread_main_loop_callbacks,
 310            vlib_mains[i]->worker_thread_main_loop_callback_tmp,
 311            vlib_mains[i]->worker_thread_main_loop_callback_lock,
 312            (void *) worker_thread_start_event, 1 /* enable */ );
 313     }
 314 }
 315
 316 void
 317 scrape_and_clear_counters (perfmon_main_t * pm)
 318 {
 319   int i, j, k;
 320   vlib_main_t *vm = pm->vlib_main;
 321   vlib_main_t *stat_vm;
 322   vlib_node_main_t *nm;
 323   vlib_node_t ***node_dups = 0;
 324   vlib_node_t **nodes;
 325   vlib_node_t *n;
 326   perfmon_capture_t *c;
 327   perfmon_event_config_t *current_event;
 328   uword *p;
 329   u8 *counter_name;
 330   u64 vectors_this_counter;
 331
 332   /* snapshoot the nodes, including pm counters */
 333   vlib_worker_thread_barrier_sync (vm);
 334
 335   for (j = 0; j < vec_len (vlib_mains); j++)
 336     {
 337       stat_vm = vlib_mains[j];
 338       if (stat_vm == 0)
 339         continue;
 340
 341       nm = &stat_vm->node_main;
 342
 343       for (i = 0; i < vec_len (nm->nodes); i++)
 344         {
 345           n = nm->nodes[i];
 346           vlib_node_sync_stats (stat_vm, n);
 347         }
 348
 349       nodes = 0;
 350       vec_validate (nodes, vec_len (nm->nodes) - 1);
 351       vec_add1 (node_dups, nodes);
 352
 353       /* Snapshoot and clear the per-node perfmon counters */
 354       for (i = 0; i < vec_len (nm->nodes); i++)
 355         {
 356           n = nm->nodes[i];
 357           nodes[i] = clib_mem_alloc (sizeof (*n));
 358           clib_memcpy_fast (nodes[i], n, sizeof (*n));
 359           n->stats_total.perf_counter0_ticks = 0;
 360           n->stats_total.perf_counter1_ticks = 0;
 361           n->stats_total.perf_counter_vectors = 0;
 362           n->stats_last_clear.perf_counter0_ticks = 0;
 363           n->stats_last_clear.perf_counter1_ticks = 0;
 364           n->stats_last_clear.perf_counter_vectors = 0;
 365         }
 366     }
 367
 368   vlib_worker_thread_barrier_release (vm);
 369
 370   for (j = 0; j < vec_len (vlib_mains); j++)
 371     {
 372       stat_vm = vlib_mains[j];
 373       if (stat_vm == 0)
 374         continue;
 375
 376       nodes = node_dups[j];
 377
 378       for (i = 0; i < vec_len (nodes); i++)
 379         {
 380           u8 *capture_name;
 381
 382           n = nodes[i];
 383
 384           if (n->stats_total.perf_counter0_ticks == 0 &&
 385               n->stats_total.perf_counter1_ticks == 0)
 386             goto skip_this_node;
 387
 388           for (k = 0; k < 2; k++)
 389             {
 390               u64 counter_value, counter_last_clear;
 391
 392               /*
 393                * We collect 2 counters at once, except for the
 394                * last counter when the user asks for an odd number of
 395                * counters
 396                */
 397               if ((pm->current_event + k)
 398                   >= vec_len (pm->single_events_to_collect))
 399                 break;
 400
 401               if (k == 0)
 402                 {
 403                   counter_value = n->stats_total.perf_counter0_ticks;
 404                   counter_last_clear =
 405                     n->stats_last_clear.perf_counter0_ticks;
 406                 }
 407               else
 408                 {
 409                   counter_value = n->stats_total.perf_counter1_ticks;
 410                   counter_last_clear =
 411                     n->stats_last_clear.perf_counter1_ticks;
 412                 }
 413
 414               capture_name = format (0, "t%d-%v%c", j, n->name, 0);
 415
 416               p = hash_get_mem (pm->capture_by_thread_and_node_name,
 417                                 capture_name);
 418
 419               if (p == 0)
 420                 {
 421                   pool_get (pm->capture_pool, c);
 422                   memset (c, 0, sizeof (*c));
 423                   c->thread_and_node_name = capture_name;
 424                   hash_set_mem (pm->capture_by_thread_and_node_name,
 425                                 capture_name, c - pm->capture_pool);
 426                 }
 427               else
 428                 {
 429                   c = pool_elt_at_index (pm->capture_pool, p[0]);
 430                   vec_free (capture_name);
 431                 }
 432
 433               /* Snapshoot counters, etc. into the capture */
 434               current_event = pm->single_events_to_collect
 435                 + pm->current_event + k;
 436               counter_name = (u8 *) current_event->name;
 437               vectors_this_counter = n->stats_total.perf_counter_vectors -
 438                 n->stats_last_clear.perf_counter_vectors;
 439
 440               vec_add1 (c->counter_names, counter_name);
 441               vec_add1 (c->counter_values,
 442                         counter_value - counter_last_clear);
 443               vec_add1 (c->vectors_this_counter, vectors_this_counter);
 444             }
 445         skip_this_node:
 446           clib_mem_free (n);
 447         }
 448       vec_free (nodes);
 449     }
 450   vec_free (node_dups);
 451 }
 452
 453 static void
 454 handle_timeout (vlib_main_t * vm, perfmon_main_t * pm, f64 now)
 455 {
 456   int i;
 457   int last_set, all;
 458
 459   last_set = clib_bitmap_last_set (pm->thread_bitmap);
 460   all = (last_set == ~0);
 461
 462   if (all || clib_bitmap_get (pm->thread_bitmap, 0))
 463     disable_events (pm);
 464
 465   /* And also on worker threads */
 466   for (i = 1; i < vec_len (vlib_mains); i++)
 467     {
 468       if (vlib_mains[i] == 0)
 469         continue;
 470       if (all || clib_bitmap_get (pm->thread_bitmap, i))
 471         clib_callback_enable_disable
 472           (vlib_mains[i]->worker_thread_main_loop_callbacks,
 473            vlib_mains[i]->worker_thread_main_loop_callback_tmp,
 474            vlib_mains[i]->worker_thread_main_loop_callback_lock,
 475            (void *) worker_thread_stop_event, 1 /* enable */ );
 476     }
 477
 478   /* Make sure workers have stopped collection */
 479   if (i > 1)
 480     {
 481       f64 deadman = vlib_time_now (vm) + 1.0;
 482
 483       for (i = 1; i < vec_len (vlib_mains); i++)
 484         {
 485           /* Has the worker actually stopped collecting data? */
 486           while (clib_callback_is_set
 487                  (vlib_mains[i]->worker_thread_main_loop_callbacks,
 488                   vlib_mains[i]->worker_thread_main_loop_callback_lock,
 489                   read_current_perf_counters))
 490             {
 491               if (vlib_time_now (vm) > deadman)
 492                 {
 493                   clib_warning ("Thread %d deadman timeout!", i);
 494                   break;
 495                 }
 496               vlib_process_suspend (pm->vlib_main, 1e-3);
 497             }
 498         }
 499     }
 500   scrape_and_clear_counters (pm);
 501   pm->current_event += pm->n_active;
 502   if (pm->current_event >= vec_len (pm->single_events_to_collect))
 503     {
 504       pm->current_event = 0;
 505       pm->state = PERFMON_STATE_OFF;
 506       return;
 507     }
 508
 509   if (all || clib_bitmap_get (pm->thread_bitmap, 0))
 510     enable_current_events (pm);
 511
 512   /* And also on worker threads */
 513   for (i = 1; i < vec_len (vlib_mains); i++)
 514     {
 515       if (vlib_mains[i] == 0)
 516         continue;
 517       if (all || clib_bitmap_get (pm->thread_bitmap, i))
 518         clib_callback_enable_disable
 519           (vlib_mains[i]->worker_thread_main_loop_callbacks,
 520            vlib_mains[i]->worker_thread_main_loop_callback_tmp,
 521            vlib_mains[i]->worker_thread_main_loop_callback_lock,
 522            worker_thread_start_event, 1 /* enable */ );
 523     }
 524 }
 525
 526 static uword
 527 perfmon_periodic_process (vlib_main_t * vm,
 528                           vlib_node_runtime_t * rt, vlib_frame_t * f)
 529 {
 530   perfmon_main_t *pm = &perfmon_main;
 531   f64 now;
 532   uword *event_data = 0;
 533   uword event_type;
 534   int i;
 535
 536   while (1)
 537     {
 538       if (pm->state == PERFMON_STATE_RUNNING)
 539         vlib_process_wait_for_event_or_clock (vm, pm->timeout_interval);
 540       else
 541         vlib_process_wait_for_event (vm);
 542
 543       now = vlib_time_now (vm);
 544
 545       event_type = vlib_process_get_events (vm, (uword **) & event_data);
 546
 547       switch (event_type)
 548         {
 549         case PERFMON_START:
 550           for (i = 0; i < vec_len (event_data); i++)
 551             start_event (pm, now, event_data[i]);
 552           break;
 553
 554           /* Handle timeout */
 555         case ~0:
 556           handle_timeout (vm, pm, now);
 557           break;
 558
 559         default:
 560           clib_warning ("Unexpected event %d", event_type);
 561           break;
 562         }
 563       vec_reset_length (event_data);
 564     }
 565   return 0;                     /* or not */
 566 }
 567
 568 /* *INDENT-OFF* */
 569 VLIB_REGISTER_NODE (perfmon_periodic_node) =
 570 {
 571   .function = perfmon_periodic_process,
 572   .type = VLIB_NODE_TYPE_PROCESS,
 573   .name = "perfmon-periodic-process",
 574 };
 575 /* *INDENT-ON* */
 576
 577 /*
 578  * fd.io coding-style-patch-verification: ON
 579  *
 580  * Local Variables:
 581  * eval: (c-set-style "gnu")
 582  * End:
 583  */