src/bin/lttng-sessiond/event.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <errno.h>
  20 #include <urcu/list.h>
  21 #include <string.h>
  22
  23 #include <lttng/lttng.h>
  24 #include <common/error.h>
  25 #include <common/sessiond-comm/sessiond-comm.h>
  26
  27 #include "channel.h"
  28 #include "event.h"
  29 #include "kernel.h"
  30 #include "ust-ctl.h"
  31 #include "ust-app.h"
  32 #include "trace-kernel.h"
  33 #include "trace-ust.h"
  34
  35 /*
  36  * Add unique UST event based on the event name, filter bytecode and loglevel.
  37  */
  38 static void add_unique_ust_event(struct lttng_ht *ht,
  39                 struct ltt_ust_event *event)
  40 {
  41         struct cds_lfht_node *node_ptr;
  42         struct ltt_ust_ht_key key;
  43
  44         assert(ht);
  45         assert(ht->ht);
  46         assert(event);
  47
  48         key.name = event->attr.name;
  49         key.filter = (struct lttng_filter_bytecode *) event->filter;
  50         key.loglevel = event->attr.loglevel;
  51
  52         node_ptr = cds_lfht_add_unique(ht->ht,
  53                         ht->hash_fct(event->node.key, lttng_ht_seed),
  54                         trace_ust_ht_match_event, &key, &event->node.node);
  55         assert(node_ptr == &event->node.node);
  56 }
  57
  58 /*
  59  * Setup a lttng_event used to enable *all* syscall tracing.
  60  */
  61 static void init_syscalls_kernel_event(struct lttng_event *event)
  62 {
  63         assert(event);
  64
  65         event->name[0] = '\0';
  66         /*
  67          * We use LTTNG_EVENT* here since the trace kernel creation will make the
  68          * right changes for the kernel.
  69          */
  70         event->type = LTTNG_EVENT_SYSCALL;
  71 }
  72
  73 /*
  74  * Disable kernel tracepoint event for a channel from the kernel session.
  75  */
  76 int event_kernel_disable_tracepoint(struct ltt_kernel_channel *kchan,
  77                 char *event_name)
  78 {
  79         int ret;
  80         struct ltt_kernel_event *kevent;
  81
  82         assert(kchan);
  83
  84         kevent = trace_kernel_get_event_by_name(event_name, kchan);
  85         if (kevent == NULL) {
  86                 ret = LTTNG_ERR_NO_EVENT;
  87                 goto error;
  88         }
  89
  90         ret = kernel_disable_event(kevent);
  91         if (ret < 0) {
  92                 ret = LTTNG_ERR_KERN_DISABLE_FAIL;
  93                 goto error;
  94         }
  95
  96         DBG("Kernel event %s disable for channel %s.",
  97                         kevent->event->name, kchan->channel->name);
  98
  99         ret = LTTNG_OK;
 100
 101 error:
 102         return ret;
 103 }
 104
 105 /*
 106  * Disable kernel tracepoint events for a channel from the kernel session.
 107  */
 108 int event_kernel_disable_all_tracepoints(struct ltt_kernel_channel *kchan)
 109 {
 110         int ret;
 111         struct ltt_kernel_event *kevent;
 112
 113         assert(kchan);
 114
 115         /* For each event in the kernel session */
 116         cds_list_for_each_entry(kevent, &kchan->events_list.head, list) {
 117                 ret = kernel_disable_event(kevent);
 118                 if (ret < 0) {
 119                         /* We continue disabling the rest */
 120                         continue;
 121                 }
 122         }
 123         ret = LTTNG_OK;
 124         return ret;
 125 }
 126
 127 /*
 128  * Disable kernel syscall events for a channel from the kernel session.
 129  */
 130 int event_kernel_disable_all_syscalls(struct ltt_kernel_channel *kchan)
 131 {
 132         ERR("Cannot disable syscall tracing for existing session. Please destroy session instead.");
 133         return LTTNG_OK;        /* Return OK so disable all succeeds */
 134 }
 135
 136 /*
 137  * Disable all kernel event for a channel from the kernel session.
 138  */
 139 int event_kernel_disable_all(struct ltt_kernel_channel *kchan)
 140 {
 141         int ret;
 142
 143         assert(kchan);
 144
 145         ret = event_kernel_disable_all_tracepoints(kchan);
 146         if (ret != LTTNG_OK)
 147                 return ret;
 148         ret = event_kernel_disable_all_syscalls(kchan);
 149         return ret;
 150 }
 151
 152 /*
 153  * Enable kernel tracepoint event for a channel from the kernel session.
 154  */
 155 int event_kernel_enable_tracepoint(struct ltt_kernel_channel *kchan,
 156                 struct lttng_event *event)
 157 {
 158         int ret;
 159         struct ltt_kernel_event *kevent;
 160
 161         assert(kchan);
 162         assert(event);
 163
 164         kevent = trace_kernel_get_event_by_name(event->name, kchan);
 165         if (kevent == NULL) {
 166                 ret = kernel_create_event(event, kchan);
 167                 if (ret < 0) {
 168                         switch (-ret) {
 169                         case EEXIST:
 170                                 ret = LTTNG_ERR_KERN_EVENT_EXIST;
 171                                 break;
 172                         case ENOSYS:
 173                                 ret = LTTNG_ERR_KERN_EVENT_ENOSYS;
 174                                 break;
 175                         default:
 176                                 ret = LTTNG_ERR_KERN_ENABLE_FAIL;
 177                                 break;
 178                         }
 179                         goto end;
 180                 }
 181         } else if (kevent->enabled == 0) {
 182                 ret = kernel_enable_event(kevent);
 183                 if (ret < 0) {
 184                         ret = LTTNG_ERR_KERN_ENABLE_FAIL;
 185                         goto end;
 186                 }
 187         } else {
 188                 /* At this point, the event is considered enabled */
 189                 ret = LTTNG_ERR_KERN_EVENT_EXIST;
 190                 goto end;
 191         }
 192
 193         ret = LTTNG_OK;
 194 end:
 195         return ret;
 196 }
 197
 198 /*
 199  * Enable all kernel tracepoint events of a channel of the kernel session.
 200  */
 201 int event_kernel_enable_all_tracepoints(struct ltt_kernel_channel *kchan,
 202                 int kernel_tracer_fd)
 203 {
 204         int size, i, ret;
 205         struct ltt_kernel_event *kevent;
 206         struct lttng_event *event_list = NULL;
 207
 208         assert(kchan);
 209
 210         /* For each event in the kernel session */
 211         cds_list_for_each_entry(kevent, &kchan->events_list.head, list) {
 212                 if (kevent->enabled == 0) {
 213                         ret = kernel_enable_event(kevent);
 214                         if (ret < 0) {
 215                                 /* Enable failed but still continue */
 216                                 continue;
 217                         }
 218                 }
 219         }
 220
 221         size = kernel_list_events(kernel_tracer_fd, &event_list);
 222         if (size < 0) {
 223                 ret = LTTNG_ERR_KERN_LIST_FAIL;
 224                 goto end;
 225         }
 226
 227         for (i = 0; i < size; i++) {
 228                 kevent = trace_kernel_get_event_by_name(event_list[i].name, kchan);
 229                 if (kevent == NULL) {
 230                         /* Default event type for enable all */
 231                         event_list[i].type = LTTNG_EVENT_TRACEPOINT;
 232                         /* Enable each single tracepoint event */
 233                         ret = kernel_create_event(&event_list[i], kchan);
 234                         if (ret < 0) {
 235                                 /* Ignore error here and continue */
 236                         }
 237                 }
 238         }
 239         free(event_list);
 240
 241         ret = LTTNG_OK;
 242 end:
 243         return ret;
 244 }
 245
 246 /*
 247  * Enable all kernel tracepoint events of a channel of the kernel session.
 248  */
 249 int event_kernel_enable_all_syscalls(struct ltt_kernel_channel *kchan,
 250                 int kernel_tracer_fd)
 251 {
 252         int ret;
 253         struct lttng_event event;
 254
 255         assert(kchan);
 256
 257         init_syscalls_kernel_event(&event);
 258
 259         DBG("Enabling all syscall tracing");
 260
 261         ret = kernel_create_event(&event, kchan);
 262         if (ret < 0) {
 263                 if (ret == -EEXIST) {
 264                         ret = LTTNG_ERR_KERN_EVENT_EXIST;
 265                 } else {
 266                         ret = LTTNG_ERR_KERN_ENABLE_FAIL;
 267                 }
 268                 goto end;
 269         }
 270
 271         ret = LTTNG_OK;
 272 end:
 273         return ret;
 274 }
 275
 276 /*
 277  * Enable all kernel events of a channel of the kernel session.
 278  */
 279 int event_kernel_enable_all(struct ltt_kernel_channel *kchan,
 280                 int kernel_tracer_fd)
 281 {
 282         int tp_ret;
 283
 284         assert(kchan);
 285
 286         tp_ret = event_kernel_enable_all_tracepoints(kchan, kernel_tracer_fd);
 287         if (tp_ret != LTTNG_OK) {
 288                 goto end;
 289         }
 290
 291         /*
 292          * Reaching this code path means that all tracepoints were enabled without
 293          * errors so we ignore the error value of syscalls.
 294          *
 295          * At the moment, failing to enable syscalls on "lttng enable-event -a -k"
 296          * is not considered an error that need to be returned to the client since
 297          * tracepoints did not fail. Future work will allow us to send back
 298          * multiple errors to the client in one API call.
 299          */
 300         (void) event_kernel_enable_all_syscalls(kchan, kernel_tracer_fd);
 301
 302 end:
 303         return tp_ret;
 304 }
 305
 306 /*
 307  * ============================
 308  * UST : The Ultimate Frontier!
 309  * ============================
 310  */
 311
 312 /*
 313  * Enable all UST tracepoints for a channel from a UST session.
 314  */
 315 int event_ust_enable_all_tracepoints(struct ltt_ust_session *usess, int domain,
 316                 struct ltt_ust_channel *uchan, struct lttng_filter_bytecode *filter)
 317 {
 318         int ret, i, size;
 319         struct lttng_ht_iter iter;
 320         struct ltt_ust_event *uevent = NULL;
 321         struct lttng_event *events = NULL;
 322
 323         assert(usess);
 324         assert(uchan);
 325
 326         rcu_read_lock();
 327
 328         switch (domain) {
 329         case LTTNG_DOMAIN_UST:
 330         {
 331                 /* Enable existing events */
 332                 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent,
 333                                 node.node) {
 334                         if (uevent->enabled == 0) {
 335                                 ret = ust_app_enable_event_glb(usess, uchan, uevent);
 336                                 if (ret < 0) {
 337                                         continue;
 338                                 }
 339                                 uevent->enabled = 1;
 340                         }
 341                 }
 342
 343                 /* Get all UST available events */
 344                 size = ust_app_list_events(&events);
 345                 if (size < 0) {
 346                         ret = LTTNG_ERR_UST_LIST_FAIL;
 347                         goto error;
 348                 }
 349
 350                 for (i = 0; i < size; i++) {
 351                         /*
 352                          * Check if event exist and if so, continue since it was enable
 353                          * previously.
 354                          */
 355                         uevent = trace_ust_find_event(uchan->events, events[i].name, filter,
 356                                         events[i].loglevel);
 357                         if (uevent != NULL) {
 358                                 ret = ust_app_enable_event_pid(usess, uchan, uevent,
 359                                                 events[i].pid);
 360                                 if (ret < 0) {
 361                                         if (ret != -LTTNG_UST_ERR_EXIST) {
 362                                                 ret = LTTNG_ERR_UST_ENABLE_FAIL;
 363                                                 goto error;
 364                                         }
 365                                 }
 366                                 continue;
 367                         }
 368
 369                         /* Create ust event */
 370                         uevent = trace_ust_create_event(&events[i], filter);
 371                         if (uevent == NULL) {
 372                                 ret = LTTNG_ERR_FATAL;
 373                                 goto error_destroy;
 374                         }
 375
 376                         /* Create event for the specific PID */
 377                         ret = ust_app_enable_event_pid(usess, uchan, uevent,
 378                                         events[i].pid);
 379                         if (ret < 0) {
 380                                 if (ret == -LTTNG_UST_ERR_EXIST) {
 381                                         ret = LTTNG_ERR_UST_EVENT_EXIST;
 382                                         goto error;
 383                                 } else {
 384                                         ret = LTTNG_ERR_UST_ENABLE_FAIL;
 385                                         goto error_destroy;
 386                                 }
 387                         }
 388
 389                         uevent->enabled = 1;
 390                         /* Add ltt ust event to channel */
 391                         rcu_read_lock();
 392                         add_unique_ust_event(uchan->events, uevent);
 393                         rcu_read_unlock();
 394                 }
 395
 396                 free(events);
 397                 break;
 398         }
 399 #if 0
 400         case LTTNG_DOMAIN_UST_EXEC_NAME:
 401         case LTTNG_DOMAIN_UST_PID:
 402         case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
 403 #endif
 404         default:
 405                 ret = LTTNG_ERR_UND;
 406                 goto error;
 407         }
 408
 409         rcu_read_unlock();
 410         return LTTNG_OK;
 411
 412 error_destroy:
 413         trace_ust_destroy_event(uevent);
 414
 415 error:
 416         free(events);
 417         rcu_read_unlock();
 418         return ret;
 419 }
 420
 421 /*
 422  * Enable UST tracepoint event for a channel from a UST session.
 423  */
 424 int event_ust_enable_tracepoint(struct ltt_ust_session *usess, int domain,
 425                 struct ltt_ust_channel *uchan, struct lttng_event *event,
 426                 struct lttng_filter_bytecode *filter)
 427 {
 428         int ret = LTTNG_OK, to_create = 0;
 429         struct ltt_ust_event *uevent;
 430
 431         assert(usess);
 432         assert(uchan);
 433         assert(event);
 434
 435         rcu_read_lock();
 436
 437         uevent = trace_ust_find_event(uchan->events, event->name, filter,
 438                         event->loglevel);
 439         if (uevent == NULL) {
 440                 uevent = trace_ust_create_event(event, filter);
 441                 if (uevent == NULL) {
 442                         ret = LTTNG_ERR_UST_ENABLE_FAIL;
 443                         goto error;
 444                 }
 445
 446                 /* Valid to set it after the goto error since uevent is still NULL */
 447                 to_create = 1;
 448         }
 449
 450         if (uevent->enabled) {
 451                 /* It's already enabled so everything is OK */
 452                 ret = LTTNG_ERR_UST_EVENT_ENABLED;
 453                 goto end;
 454         }
 455
 456         uevent->enabled = 1;
 457
 458         switch (domain) {
 459         case LTTNG_DOMAIN_UST:
 460         {
 461                 if (to_create) {
 462                         /* Create event on all UST registered apps for session */
 463                         ret = ust_app_create_event_glb(usess, uchan, uevent);
 464                 } else {
 465                         /* Enable event on all UST registered apps for session */
 466                         ret = ust_app_enable_event_glb(usess, uchan, uevent);
 467                 }
 468
 469                 if (ret < 0) {
 470                         if (ret == -LTTNG_UST_ERR_EXIST) {
 471                                 ret = LTTNG_ERR_UST_EVENT_EXIST;
 472                                 goto end;
 473                         } else {
 474                                 ret = LTTNG_ERR_UST_ENABLE_FAIL;
 475                                 goto error;
 476                         }
 477                 }
 478                 break;
 479         }
 480 #if 0
 481         case LTTNG_DOMAIN_UST_EXEC_NAME:
 482         case LTTNG_DOMAIN_UST_PID:
 483         case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
 484 #endif
 485         default:
 486                 ret = LTTNG_ERR_UND;
 487                 goto end;
 488         }
 489
 490         if (to_create) {
 491                 /* Add ltt ust event to channel */
 492                 add_unique_ust_event(uchan->events, uevent);
 493         }
 494
 495         DBG("Event UST %s %s in channel %s", uevent->attr.name,
 496                         to_create ? "created" : "enabled", uchan->name);
 497
 498         ret = LTTNG_OK;
 499
 500 end:
 501         rcu_read_unlock();
 502         return ret;
 503
 504 error:
 505         /*
 506          * Only destroy event on creation time (not enabling time) because if the
 507          * event is found in the channel (to_create == 0), it means that at some
 508          * point the enable_event worked and it's thus valid to keep it alive.
 509          * Destroying it also implies that we also destroy it's shadow copy to sync
 510          * everyone up.
 511          */
 512         if (to_create) {
 513                 /* In this code path, the uevent was not added to the hash table */
 514                 trace_ust_destroy_event(uevent);
 515         }
 516         rcu_read_unlock();
 517         return ret;
 518 }
 519
 520 /*
 521  * Disable UST tracepoint of a channel from a UST session.
 522  */
 523 int event_ust_disable_tracepoint(struct ltt_ust_session *usess, int domain,
 524                 struct ltt_ust_channel *uchan, char *event_name)
 525 {
 526         int ret;
 527         struct ltt_ust_event *uevent;
 528         struct lttng_ht_node_str *node;
 529         struct lttng_ht_iter iter;
 530         struct lttng_ht *ht;
 531
 532         assert(usess);
 533         assert(uchan);
 534         assert(event_name);
 535
 536         ht = uchan->events;
 537
 538         rcu_read_lock();
 539
 540         /*
 541          * We use a custom lookup since we need the iterator for the next_duplicate
 542          * call in the do while loop below.
 543          */
 544         cds_lfht_lookup(ht->ht, ht->hash_fct((void *) event_name, lttng_ht_seed),
 545                         trace_ust_ht_match_event_by_name, event_name, &iter.iter);
 546         node = lttng_ht_iter_get_node_str(&iter);
 547         if (node == NULL) {
 548                 DBG2("Trace UST event NOT found by name %s", event_name);
 549                 ret = LTTNG_ERR_UST_EVENT_NOT_FOUND;
 550                 goto error;
 551         }
 552
 553         do {
 554                 uevent = caa_container_of(node, struct ltt_ust_event, node);
 555                 assert(uevent);
 556
 557                 if (uevent->enabled == 0) {
 558                         /* It's already disabled so everything is OK */
 559                         ret = LTTNG_OK;
 560                         continue;
 561                 }
 562
 563                 switch (domain) {
 564                 case LTTNG_DOMAIN_UST:
 565                         ret = ust_app_disable_event_glb(usess, uchan, uevent);
 566                         if (ret < 0 && ret != -LTTNG_UST_ERR_EXIST) {
 567                                 ret = LTTNG_ERR_UST_DISABLE_FAIL;
 568                                 goto error;
 569                         }
 570                         break;
 571 #if 0
 572                 case LTTNG_DOMAIN_UST_EXEC_NAME:
 573                 case LTTNG_DOMAIN_UST_PID:
 574                 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
 575 #endif
 576                 default:
 577                         ret = LTTNG_ERR_UND;
 578                         goto error;
 579                 }
 580
 581                 uevent->enabled = 0;
 582
 583                 DBG2("Event UST %s disabled in channel %s", uevent->attr.name,
 584                                 uchan->name);
 585
 586                 /* Get next duplicate event by name. */
 587                 cds_lfht_next_duplicate(ht->ht, trace_ust_ht_match_event_by_name,
 588                                 event_name, &iter.iter);
 589                 node = lttng_ht_iter_get_node_str(&iter);
 590         } while (node);
 591
 592         ret = LTTNG_OK;
 593
 594 error:
 595         rcu_read_unlock();
 596         return ret;
 597 }
 598
 599 /*
 600  * Disable all UST tracepoints for a channel from a UST session.
 601  */
 602 int event_ust_disable_all_tracepoints(struct ltt_ust_session *usess, int domain,
 603                 struct ltt_ust_channel *uchan)
 604 {
 605         int ret, i, size;
 606         struct lttng_ht_iter iter;
 607         struct ltt_ust_event *uevent = NULL;
 608         struct lttng_event *events = NULL;
 609
 610         assert(usess);
 611         assert(uchan);
 612
 613         rcu_read_lock();
 614
 615         switch (domain) {
 616         case LTTNG_DOMAIN_UST:
 617         {
 618                 /* Disabling existing events */
 619                 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent,
 620                                 node.node) {
 621                         if (uevent->enabled == 1) {
 622                                 ret = event_ust_disable_tracepoint(usess, domain, uchan,
 623                                                 uevent->attr.name);
 624                                 if (ret < 0) {
 625                                         continue;
 626                                 }
 627                         }
 628                 }
 629
 630                 /* Get all UST available events */
 631                 size = ust_app_list_events(&events);
 632                 if (size < 0) {
 633                         ret = LTTNG_ERR_UST_LIST_FAIL;
 634                         goto error;
 635                 }
 636
 637                 for (i = 0; i < size; i++) {
 638                         ret = event_ust_disable_tracepoint(usess, domain, uchan,
 639                                         events[i].name);
 640                         if (ret != LTTNG_OK) {
 641                                 /* Continue to disable the rest... */
 642                                 continue;
 643                         }
 644                 }
 645
 646                 free(events);
 647                 break;
 648         }
 649 #if 0
 650         case LTTNG_DOMAIN_UST_EXEC_NAME:
 651         case LTTNG_DOMAIN_UST_PID:
 652         case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
 653 #endif
 654         default:
 655                 ret = LTTNG_ERR_UND;
 656                 goto error;
 657         }
 658
 659         rcu_read_unlock();
 660         return LTTNG_OK;
 661
 662 error:
 663         free(events);
 664         rcu_read_unlock();
 665         return ret;
 666 }