src/bin/lttng-sessiond/trace-ust.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 #define _LGPL_SOURCE
  20 #include <stdio.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <unistd.h>
  24 #include <inttypes.h>
  25
  26 #include <common/common.h>
  27 #include <common/defaults.h>
  28
  29 #include "buffer-registry.h"
  30 #include "trace-ust.h"
  31 #include "utils.h"
  32 #include "ust-app.h"
  33
  34 /*
  35  * Match function for the events hash table lookup.
  36  *
  37  * Matches by name only. Used by the disable command.
  38  */
  39 int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
  40                 const void *_key)
  41 {
  42         struct ltt_ust_event *event;
  43         const char *name;
  44
  45         assert(node);
  46         assert(_key);
  47
  48         event = caa_container_of(node, struct ltt_ust_event, node.node);
  49         name = _key;
  50
  51         /* Event name */
  52         if (strncmp(event->attr.name, name, sizeof(event->attr.name)) != 0) {
  53                 goto no_match;
  54         }
  55
  56         /* Match */
  57         return 1;
  58
  59 no_match:
  60         return 0;
  61 }
  62
  63 /*
  64  * Match function for the hash table lookup.
  65  *
  66  * It matches an ust event based on three attributes which are the event name,
  67  * the filter bytecode and the loglevel.
  68  */
  69 int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key)
  70 {
  71         struct ltt_ust_event *event;
  72         const struct ltt_ust_ht_key *key;
  73         int ev_loglevel_value;
  74
  75         assert(node);
  76         assert(_key);
  77
  78         event = caa_container_of(node, struct ltt_ust_event, node.node);
  79         key = _key;
  80         ev_loglevel_value = event->attr.loglevel;
  81
  82         /* Match the 4 elements of the key: name, filter, loglevel, exclusions. */
  83
  84         /* Event name */
  85         if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
  86                 goto no_match;
  87         }
  88
  89         /* Event loglevel. */
  90         if (ev_loglevel_value != key->loglevel_type) {
  91                 if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
  92                                 && key->loglevel_type == 0 && ev_loglevel_value == -1) {
  93                         /*
  94                          * Match is accepted. This is because on event creation, the
  95                          * loglevel is set to -1 if the event loglevel type is ALL so 0 and
  96                          * -1 are accepted for this loglevel type since 0 is the one set by
  97                          * the API when receiving an enable event.
  98                          */
  99                 } else {
 100                         goto no_match;
 101                 }
 102         }
 103
 104         /* Only one of the filters is NULL, fail. */
 105         if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
 106                 goto no_match;
 107         }
 108
 109         if (key->filter && event->filter) {
 110                 /* Both filters exists, check length followed by the bytecode. */
 111                 if (event->filter->len != key->filter->len ||
 112                                 memcmp(event->filter->data, key->filter->data,
 113                                         event->filter->len) != 0) {
 114                         goto no_match;
 115                 }
 116         }
 117
 118         /* If only one of the exclusions is NULL, fail. */
 119         if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
 120                 goto no_match;
 121         }
 122
 123         if (key->exclusion && event->exclusion) {
 124                 /* Both exclusions exist; check count followed by names. */
 125                 if (event->exclusion->count != key->exclusion->count ||
 126                                 memcmp(event->exclusion->names, key->exclusion->names,
 127                                         event->exclusion->count * LTTNG_SYMBOL_NAME_LEN) != 0) {
 128                         goto no_match;
 129                 }
 130         }
 131         /* Match. */
 132         return 1;
 133
 134 no_match:
 135         return 0;
 136 }
 137
 138 /*
 139  * Find the channel in the hashtable and return channel pointer. RCU read side
 140  * lock MUST be acquired before calling this.
 141  */
 142 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
 143                 char *name)
 144 {
 145         struct lttng_ht_node_str *node;
 146         struct lttng_ht_iter iter;
 147
 148         /*
 149          * If we receive an empty string for channel name, it means the
 150          * default channel name is requested.
 151          */
 152         if (name[0] == '\0')
 153                 name = DEFAULT_CHANNEL_NAME;
 154
 155         lttng_ht_lookup(ht, (void *)name, &iter);
 156         node = lttng_ht_iter_get_node_str(&iter);
 157         if (node == NULL) {
 158                 goto error;
 159         }
 160
 161         DBG2("Trace UST channel %s found by name", name);
 162
 163         return caa_container_of(node, struct ltt_ust_channel, node);
 164
 165 error:
 166         DBG2("Trace UST channel %s not found by name", name);
 167         return NULL;
 168 }
 169
 170 /*
 171  * Find the event in the hashtable and return event pointer. RCU read side lock
 172  * MUST be acquired before calling this.
 173  */
 174 struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
 175                 char *name, struct lttng_filter_bytecode *filter,
 176                 int loglevel_value, struct lttng_event_exclusion *exclusion)
 177 {
 178         struct lttng_ht_node_str *node;
 179         struct lttng_ht_iter iter;
 180         struct ltt_ust_ht_key key;
 181
 182         assert(name);
 183         assert(ht);
 184
 185         key.name = name;
 186         key.filter = filter;
 187         key.loglevel_type = loglevel_value;
 188         key.exclusion = exclusion;
 189
 190         cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
 191                         trace_ust_ht_match_event, &key, &iter.iter);
 192         node = lttng_ht_iter_get_node_str(&iter);
 193         if (node == NULL) {
 194                 goto error;
 195         }
 196
 197         DBG2("Trace UST event %s found", key.name);
 198
 199         return caa_container_of(node, struct ltt_ust_event, node);
 200
 201 error:
 202         DBG2("Trace UST event %s NOT found", key.name);
 203         return NULL;
 204 }
 205
 206 /*
 207  * Lookup an agent in the session agents hash table by domain type and return
 208  * the object if found else NULL.
 209  *
 210  * RCU read side lock must be acquired before calling and only released
 211  * once the agent is no longer in scope or being used.
 212  */
 213 struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
 214                 enum lttng_domain_type domain_type)
 215 {
 216         struct agent *agt = NULL;
 217         struct lttng_ht_node_u64 *node;
 218         struct lttng_ht_iter iter;
 219         uint64_t key;
 220
 221         assert(session);
 222
 223         DBG3("Trace ust agent lookup for domain %d", domain_type);
 224
 225         key = domain_type;
 226
 227         lttng_ht_lookup(session->agents, &key, &iter);
 228         node = lttng_ht_iter_get_node_u64(&iter);
 229         if (!node) {
 230                 goto end;
 231         }
 232         agt = caa_container_of(node, struct agent, node);
 233
 234 end:
 235         return agt;
 236 }
 237
 238 /*
 239  * Allocate and initialize a ust session data structure.
 240  *
 241  * Return pointer to structure or NULL.
 242  */
 243 struct ltt_ust_session *trace_ust_create_session(uint64_t session_id)
 244 {
 245         struct ltt_ust_session *lus;
 246
 247         /* Allocate a new ltt ust session */
 248         lus = zmalloc(sizeof(struct ltt_ust_session));
 249         if (lus == NULL) {
 250                 PERROR("create ust session zmalloc");
 251                 goto error;
 252         }
 253
 254         /* Init data structure */
 255         lus->id = session_id;
 256         lus->active = 0;
 257
 258         /* Set default metadata channel attribute. */
 259         lus->metadata_attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
 260         lus->metadata_attr.subbuf_size = default_get_metadata_subbuf_size();
 261         lus->metadata_attr.num_subbuf = DEFAULT_METADATA_SUBBUF_NUM;
 262         lus->metadata_attr.switch_timer_interval = DEFAULT_METADATA_SWITCH_TIMER;
 263         lus->metadata_attr.read_timer_interval = DEFAULT_METADATA_READ_TIMER;
 264         lus->metadata_attr.output = LTTNG_UST_MMAP;
 265
 266         /*
 267          * Default buffer type. This can be changed through an enable channel
 268          * requesting a different type. Note that this can only be changed once
 269          * during the session lifetime which is at the first enable channel and
 270          * only before start. The flag buffer_type_changed indicates the status.
 271          */
 272         lus->buffer_type = LTTNG_BUFFER_PER_UID;
 273         /* Once set to 1, the buffer_type is immutable for the session. */
 274         lus->buffer_type_changed = 0;
 275         /* Init it in case it get used after allocation. */
 276         CDS_INIT_LIST_HEAD(&lus->buffer_reg_uid_list);
 277
 278         /* Alloc UST global domain channels' HT */
 279         lus->domain_global.channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
 280         /* Alloc agent hash table. */
 281         lus->agents = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
 282
 283         lus->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
 284         if (lus->consumer == NULL) {
 285                 goto error_consumer;
 286         }
 287
 288         DBG2("UST trace session create successful");
 289
 290         return lus;
 291
 292 error_consumer:
 293         ht_cleanup_push(lus->domain_global.channels);
 294         ht_cleanup_push(lus->agents);
 295         free(lus);
 296 error:
 297         return NULL;
 298 }
 299
 300 /*
 301  * Allocate and initialize a ust channel data structure.
 302  *
 303  * Return pointer to structure or NULL.
 304  */
 305 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan,
 306                 enum lttng_domain_type domain)
 307 {
 308         struct ltt_ust_channel *luc;
 309
 310         assert(chan);
 311
 312         luc = zmalloc(sizeof(struct ltt_ust_channel));
 313         if (luc == NULL) {
 314                 PERROR("ltt_ust_channel zmalloc");
 315                 goto error;
 316         }
 317
 318         luc->domain = domain;
 319
 320         /* Copy UST channel attributes */
 321         luc->attr.overwrite = chan->attr.overwrite;
 322         luc->attr.subbuf_size = chan->attr.subbuf_size;
 323         luc->attr.num_subbuf = chan->attr.num_subbuf;
 324         luc->attr.switch_timer_interval = chan->attr.switch_timer_interval;
 325         luc->attr.read_timer_interval = chan->attr.read_timer_interval;
 326         luc->attr.output = (enum lttng_ust_output) chan->attr.output;
 327
 328         /* Translate to UST output enum */
 329         switch (luc->attr.output) {
 330         default:
 331                 luc->attr.output = LTTNG_UST_MMAP;
 332                 break;
 333         }
 334
 335         /*
 336          * If we receive an empty string for channel name, it means the
 337          * default channel name is requested.
 338          */
 339         if (chan->name[0] == '\0') {
 340                 strncpy(luc->name, DEFAULT_CHANNEL_NAME, sizeof(luc->name));
 341         } else {
 342                 /* Copy channel name */
 343                 strncpy(luc->name, chan->name, sizeof(luc->name));
 344         }
 345         luc->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
 346
 347         /* Init node */
 348         lttng_ht_node_init_str(&luc->node, luc->name);
 349         CDS_INIT_LIST_HEAD(&luc->ctx_list);
 350
 351         /* Alloc hash tables */
 352         luc->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
 353         luc->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
 354
 355         /* On-disk circular buffer parameters */
 356         luc->tracefile_size = chan->attr.tracefile_size;
 357         luc->tracefile_count = chan->attr.tracefile_count;
 358
 359         DBG2("Trace UST channel %s created", luc->name);
 360
 361 error:
 362         return luc;
 363 }
 364
 365 /*
 366  * Allocate and initialize a ust event. Set name and event type.
 367  * We own filter_expression, filter, and exclusion.
 368  *
 369  * Return pointer to structure or NULL.
 370  */
 371 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
 372                 char *filter_expression,
 373                 struct lttng_filter_bytecode *filter,
 374                 struct lttng_event_exclusion *exclusion,
 375                 bool internal_event)
 376 {
 377         struct ltt_ust_event *lue;
 378
 379         assert(ev);
 380
 381         lue = zmalloc(sizeof(struct ltt_ust_event));
 382         if (lue == NULL) {
 383                 PERROR("ust event zmalloc");
 384                 goto error;
 385         }
 386
 387         lue->internal = internal_event;
 388
 389         switch (ev->type) {
 390         case LTTNG_EVENT_PROBE:
 391                 lue->attr.instrumentation = LTTNG_UST_PROBE;
 392                 break;
 393         case LTTNG_EVENT_FUNCTION:
 394                 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
 395                 break;
 396         case LTTNG_EVENT_FUNCTION_ENTRY:
 397                 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
 398                 break;
 399         case LTTNG_EVENT_TRACEPOINT:
 400                 lue->attr.instrumentation = LTTNG_UST_TRACEPOINT;
 401                 break;
 402         default:
 403                 ERR("Unknown ust instrumentation type (%d)", ev->type);
 404                 goto error_free_event;
 405         }
 406
 407         /* Copy event name */
 408         strncpy(lue->attr.name, ev->name, LTTNG_UST_SYM_NAME_LEN);
 409         lue->attr.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
 410
 411         switch (ev->loglevel_type) {
 412         case LTTNG_EVENT_LOGLEVEL_ALL:
 413                 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_ALL;
 414                 lue->attr.loglevel = -1;        /* Force to -1 */
 415                 break;
 416         case LTTNG_EVENT_LOGLEVEL_RANGE:
 417                 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_RANGE;
 418                 lue->attr.loglevel = ev->loglevel;
 419                 break;
 420         case LTTNG_EVENT_LOGLEVEL_SINGLE:
 421                 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_SINGLE;
 422                 lue->attr.loglevel = ev->loglevel;
 423                 break;
 424         default:
 425                 ERR("Unknown ust loglevel type (%d)", ev->loglevel_type);
 426                 goto error_free_event;
 427         }
 428
 429         /* Same layout. */
 430         lue->filter_expression = filter_expression;
 431         lue->filter = filter;
 432         lue->exclusion = exclusion;
 433
 434         /* Init node */
 435         lttng_ht_node_init_str(&lue->node, lue->attr.name);
 436
 437         DBG2("Trace UST event %s, loglevel (%d,%d) created",
 438                 lue->attr.name, lue->attr.loglevel_type,
 439                 lue->attr.loglevel);
 440
 441         return lue;
 442
 443 error_free_event:
 444         free(lue);
 445 error:
 446         free(filter_expression);
 447         free(filter);
 448         free(exclusion);
 449         return NULL;
 450 }
 451
 452 static
 453 int trace_ust_context_type_event_to_ust(enum lttng_event_context_type type)
 454 {
 455         int utype;
 456
 457         switch (type) {
 458         case LTTNG_EVENT_CONTEXT_VTID:
 459                 utype = LTTNG_UST_CONTEXT_VTID;
 460                 break;
 461         case LTTNG_EVENT_CONTEXT_VPID:
 462                 utype = LTTNG_UST_CONTEXT_VPID;
 463                 break;
 464         case LTTNG_EVENT_CONTEXT_PTHREAD_ID:
 465                 utype = LTTNG_UST_CONTEXT_PTHREAD_ID;
 466                 break;
 467         case LTTNG_EVENT_CONTEXT_PROCNAME:
 468                 utype = LTTNG_UST_CONTEXT_PROCNAME;
 469                 break;
 470         case LTTNG_EVENT_CONTEXT_IP:
 471                 utype = LTTNG_UST_CONTEXT_IP;
 472                 break;
 473         case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER:
 474                 if (!ustctl_has_perf_counters()) {
 475                         utype = -1;
 476                         WARN("Perf counters not implemented in UST");
 477                 } else {
 478                         utype = LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER;
 479                 }
 480                 break;
 481         default:
 482                 ERR("Invalid UST context");
 483                 utype = -1;
 484                 break;
 485         }
 486         return utype;
 487 }
 488
 489 /*
 490  * Return 1 if contexts match, 0 otherwise.
 491  */
 492 int trace_ust_match_context(struct ltt_ust_context *uctx,
 493                 struct lttng_event_context *ctx)
 494 {
 495         int utype;
 496
 497         utype = trace_ust_context_type_event_to_ust(ctx->ctx);
 498         if (utype < 0) {
 499                 return 0;
 500         }
 501         if (uctx->ctx.ctx != utype) {
 502                 return 0;
 503         }
 504         switch (utype) {
 505         case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
 506                 if (uctx->ctx.u.perf_counter.type
 507                                 != ctx->u.perf_counter.type) {
 508                         return 0;
 509                 }
 510                 if (uctx->ctx.u.perf_counter.config
 511                                 != ctx->u.perf_counter.config) {
 512                         return 0;
 513                 }
 514                 if (strncmp(uctx->ctx.u.perf_counter.name,
 515                                 ctx->u.perf_counter.name,
 516                                 LTTNG_UST_SYM_NAME_LEN)) {
 517                         return 0;
 518                 }
 519                 break;
 520         default:
 521                 break;
 522
 523         }
 524         return 1;
 525 }
 526
 527 /*
 528  * Allocate and initialize an UST context.
 529  *
 530  * Return pointer to structure or NULL.
 531  */
 532 struct ltt_ust_context *trace_ust_create_context(
 533                 struct lttng_event_context *ctx)
 534 {
 535         struct ltt_ust_context *uctx;
 536         int utype;
 537
 538         assert(ctx);
 539
 540         utype = trace_ust_context_type_event_to_ust(ctx->ctx);
 541         if (utype < 0) {
 542                 return NULL;
 543         }
 544
 545         uctx = zmalloc(sizeof(struct ltt_ust_context));
 546         if (uctx == NULL) {
 547                 PERROR("zmalloc ltt_ust_context");
 548                 goto error;
 549         }
 550
 551         uctx->ctx.ctx = (enum lttng_ust_context_type) utype;
 552         switch (utype) {
 553         case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
 554                 uctx->ctx.u.perf_counter.type = ctx->u.perf_counter.type;
 555                 uctx->ctx.u.perf_counter.config = ctx->u.perf_counter.config;
 556                 strncpy(uctx->ctx.u.perf_counter.name, ctx->u.perf_counter.name,
 557                                 LTTNG_UST_SYM_NAME_LEN);
 558                 uctx->ctx.u.perf_counter.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
 559                 break;
 560         default:
 561                 break;
 562         }
 563         lttng_ht_node_init_ulong(&uctx->node, (unsigned long) uctx->ctx.ctx);
 564
 565         return uctx;
 566
 567 error:
 568         return NULL;
 569 }
 570
 571 static
 572 void destroy_pid_tracker_node_rcu(struct rcu_head *head)
 573 {
 574         struct ust_pid_tracker_node *tracker_node =
 575                 caa_container_of(head, struct ust_pid_tracker_node, node.head);
 576         free(tracker_node);
 577 }
 578
 579 static
 580 void destroy_pid_tracker_node(struct ust_pid_tracker_node *tracker_node)
 581 {
 582
 583         call_rcu(&tracker_node->node.head, destroy_pid_tracker_node_rcu);
 584 }
 585
 586 static
 587 int init_pid_tracker(struct ust_pid_tracker *pid_tracker)
 588 {
 589         int ret = 0;
 590
 591         pid_tracker->ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
 592         if (!pid_tracker->ht) {
 593                 ret = -1;
 594                 goto end;
 595         }
 596
 597 end:
 598         return ret;
 599 }
 600
 601 /*
 602  * Teardown pid tracker content, but don't free pid_tracker object.
 603  */
 604 static
 605 void fini_pid_tracker(struct ust_pid_tracker *pid_tracker)
 606 {
 607         struct ust_pid_tracker_node *tracker_node;
 608         struct lttng_ht_iter iter;
 609
 610         if (!pid_tracker->ht) {
 611                 return;
 612         }
 613         rcu_read_lock();
 614         cds_lfht_for_each_entry(pid_tracker->ht->ht,
 615                         &iter.iter, tracker_node, node.node) {
 616                 int ret = lttng_ht_del(pid_tracker->ht, &iter);
 617
 618                 assert(!ret);
 619                 destroy_pid_tracker_node(tracker_node);
 620         }
 621         rcu_read_unlock();
 622         ht_cleanup_push(pid_tracker->ht);
 623         pid_tracker->ht = NULL;
 624 }
 625
 626 static
 627 struct ust_pid_tracker_node *pid_tracker_lookup(
 628                 struct ust_pid_tracker *pid_tracker, int pid,
 629                 struct lttng_ht_iter *iter)
 630 {
 631         unsigned long _pid = (unsigned long) pid;
 632         struct lttng_ht_node_ulong *node;
 633
 634         lttng_ht_lookup(pid_tracker->ht, (void *) _pid, iter);
 635         node = lttng_ht_iter_get_node_ulong(iter);
 636         if (node) {
 637                 return caa_container_of(node, struct ust_pid_tracker_node,
 638                         node);
 639         } else {
 640                 return NULL;
 641         }
 642 }
 643
 644 static
 645 int pid_tracker_add_pid(struct ust_pid_tracker *pid_tracker, int pid)
 646 {
 647         int retval = LTTNG_OK;
 648         struct ust_pid_tracker_node *tracker_node;
 649         struct lttng_ht_iter iter;
 650
 651         if (pid < 0) {
 652                 retval = LTTNG_ERR_INVALID;
 653                 goto end;
 654         }
 655         tracker_node = pid_tracker_lookup(pid_tracker, pid, &iter);
 656         if (tracker_node) {
 657                 /* Already exists. */
 658                 retval = LTTNG_ERR_PID_TRACKED;
 659                 goto end;
 660         }
 661         tracker_node = zmalloc(sizeof(*tracker_node));
 662         if (!tracker_node) {
 663                 retval = LTTNG_ERR_NOMEM;
 664                 goto end;
 665         }
 666         lttng_ht_node_init_ulong(&tracker_node->node, (unsigned long) pid);
 667         lttng_ht_add_unique_ulong(pid_tracker->ht, &tracker_node->node);
 668 end:
 669         return retval;
 670 }
 671
 672 static
 673 int pid_tracker_del_pid(struct ust_pid_tracker *pid_tracker, int pid)
 674 {
 675         int retval = LTTNG_OK, ret;
 676         struct ust_pid_tracker_node *tracker_node;
 677         struct lttng_ht_iter iter;
 678
 679         if (pid < 0) {
 680                 retval = LTTNG_ERR_INVALID;
 681                 goto end;
 682         }
 683         tracker_node = pid_tracker_lookup(pid_tracker, pid, &iter);
 684         if (!tracker_node) {
 685                 /* Not found */
 686                 retval = LTTNG_ERR_PID_NOT_TRACKED;
 687                 goto end;
 688         }
 689         ret = lttng_ht_del(pid_tracker->ht, &iter);
 690         assert(!ret);
 691
 692         destroy_pid_tracker_node(tracker_node);
 693 end:
 694         return retval;
 695 }
 696
 697 /*
 698  * The session lock is held when calling this function.
 699  */
 700 int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
 701 {
 702         struct lttng_ht_iter iter;
 703
 704         if (!session->pid_tracker.ht) {
 705                 return 1;
 706         }
 707         if (pid_tracker_lookup(&session->pid_tracker, pid, &iter)) {
 708                 return 1;
 709         }
 710         return 0;
 711 }
 712
 713 /*
 714  * Called with the session lock held.
 715  */
 716 int trace_ust_track_pid(struct ltt_ust_session *session, int pid)
 717 {
 718         int retval = LTTNG_OK;
 719
 720         if (pid == -1) {
 721                 /* Track all pids: destroy tracker if exists. */
 722                 if (session->pid_tracker.ht) {
 723                         fini_pid_tracker(&session->pid_tracker);
 724                         /* Ensure all apps have session. */
 725                         ust_app_global_update_all(session);
 726                 }
 727         } else {
 728                 int ret;
 729
 730                 if (!session->pid_tracker.ht) {
 731                         /* Create tracker. */
 732                         if (init_pid_tracker(&session->pid_tracker)) {
 733                                 ERR("Error initializing PID tracker");
 734                                 retval = LTTNG_ERR_NOMEM;
 735                                 goto end;
 736                         }
 737                         ret = pid_tracker_add_pid(&session->pid_tracker, pid);
 738                         if (ret != LTTNG_OK) {
 739                                 retval = ret;
 740                                 fini_pid_tracker(&session->pid_tracker);
 741                                 goto end;
 742                         }
 743                         /* Remove all apps from session except pid. */
 744                         ust_app_global_update_all(session);
 745                 } else {
 746                         struct ust_app *app;
 747
 748                         ret = pid_tracker_add_pid(&session->pid_tracker, pid);
 749                         if (ret != LTTNG_OK) {
 750                                 retval = ret;
 751                                 goto end;
 752                         }
 753                         /* Add session to application */
 754                         app = ust_app_find_by_pid(pid);
 755                         if (app) {
 756                                 ust_app_global_update(session, app);
 757                         }
 758                 }
 759         }
 760 end:
 761         return retval;
 762 }
 763
 764 /*
 765  * Called with the session lock held.
 766  */
 767 int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
 768 {
 769         int retval = LTTNG_OK;
 770
 771         if (pid == -1) {
 772                 /* Create empty tracker, replace old tracker. */
 773                 struct ust_pid_tracker tmp_tracker;
 774
 775                 tmp_tracker = session->pid_tracker;
 776                 if (init_pid_tracker(&session->pid_tracker)) {
 777                         ERR("Error initializing PID tracker");
 778                         retval = LTTNG_ERR_NOMEM;
 779                         /* Rollback operation. */
 780                         session->pid_tracker = tmp_tracker;
 781                         goto end;
 782                 }
 783                 fini_pid_tracker(&tmp_tracker);
 784
 785                 /* Remove session from all applications */
 786                 ust_app_global_update_all(session);
 787         } else {
 788                 int ret;
 789                 struct ust_app *app;
 790
 791                 if (!session->pid_tracker.ht) {
 792                         /* No PID being tracked. */
 793                         retval = LTTNG_ERR_PID_NOT_TRACKED;
 794                         goto end;
 795                 }
 796                 /* Remove PID from tracker */
 797                 ret = pid_tracker_del_pid(&session->pid_tracker, pid);
 798                 if (ret != LTTNG_OK) {
 799                         retval = ret;
 800                         goto end;
 801                 }
 802                 /* Remove session from application. */
 803                 app = ust_app_find_by_pid(pid);
 804                 if (app) {
 805                         ust_app_global_update(session, app);
 806                 }
 807         }
 808 end:
 809         return retval;
 810 }
 811
 812 /*
 813  * Called with session lock held.
 814  */
 815 ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
 816                 int32_t **_pids)
 817 {
 818         struct ust_pid_tracker_node *tracker_node;
 819         struct lttng_ht_iter iter;
 820         unsigned long count, i = 0;
 821         long approx[2];
 822         int32_t *pids;
 823         int ret = 0;
 824
 825         if (!session->pid_tracker.ht) {
 826                 /* Tracker disabled. Set first entry to -1. */
 827                 pids = zmalloc(sizeof(*pids));
 828                 if (!pids) {
 829                         ret = -1;
 830                         goto end;
 831                 }
 832                 pids[0] = -1;
 833                 *_pids = pids;
 834                 return 1;
 835         }
 836
 837         rcu_read_lock();
 838         cds_lfht_count_nodes(session->pid_tracker.ht->ht,
 839                 &approx[0], &count, &approx[1]);
 840         pids = zmalloc(sizeof(*pids) * count);
 841         if (!pids) {
 842                 ret = -1;
 843                 goto end;
 844         }
 845         cds_lfht_for_each_entry(session->pid_tracker.ht->ht,
 846                         &iter.iter, tracker_node, node.node) {
 847                 pids[i++] = tracker_node->node.key;
 848         }
 849         *_pids = pids;
 850         ret = count;
 851 end:
 852         rcu_read_unlock();
 853         return ret;
 854 }
 855
 856 /*
 857  * RCU safe free context structure.
 858  */
 859 static void destroy_context_rcu(struct rcu_head *head)
 860 {
 861         struct lttng_ht_node_ulong *node =
 862                 caa_container_of(head, struct lttng_ht_node_ulong, head);
 863         struct ltt_ust_context *ctx =
 864                 caa_container_of(node, struct ltt_ust_context, node);
 865
 866         free(ctx);
 867 }
 868
 869 /*
 870  * Cleanup UST context hash table.
 871  */
 872 static void destroy_contexts(struct lttng_ht *ht)
 873 {
 874         int ret;
 875         struct lttng_ht_node_ulong *node;
 876         struct lttng_ht_iter iter;
 877         struct ltt_ust_context *ctx;
 878
 879         assert(ht);
 880
 881         rcu_read_lock();
 882         cds_lfht_for_each_entry(ht->ht, &iter.iter, node, node) {
 883                 /* Remove from ordered list. */
 884                 ctx = caa_container_of(node, struct ltt_ust_context, node);
 885                 cds_list_del(&ctx->list);
 886                 /* Remove from channel's hash table. */
 887                 ret = lttng_ht_del(ht, &iter);
 888                 if (!ret) {
 889                         call_rcu(&node->head, destroy_context_rcu);
 890                 }
 891         }
 892         rcu_read_unlock();
 893
 894         ht_cleanup_push(ht);
 895 }
 896
 897 /*
 898  * Cleanup ust event structure.
 899  */
 900 void trace_ust_destroy_event(struct ltt_ust_event *event)
 901 {
 902         assert(event);
 903
 904         DBG2("Trace destroy UST event %s", event->attr.name);
 905         free(event->filter_expression);
 906         free(event->filter);
 907         free(event->exclusion);
 908         free(event);
 909 }
 910
 911 /*
 912  * URCU intermediate call to complete destroy event.
 913  */
 914 static void destroy_event_rcu(struct rcu_head *head)
 915 {
 916         struct lttng_ht_node_str *node =
 917                 caa_container_of(head, struct lttng_ht_node_str, head);
 918         struct ltt_ust_event *event =
 919                 caa_container_of(node, struct ltt_ust_event, node);
 920
 921         trace_ust_destroy_event(event);
 922 }
 923
 924 /*
 925  * Cleanup UST events hashtable.
 926  */
 927 static void destroy_events(struct lttng_ht *events)
 928 {
 929         int ret;
 930         struct lttng_ht_node_str *node;
 931         struct lttng_ht_iter iter;
 932
 933         assert(events);
 934
 935         rcu_read_lock();
 936         cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
 937                 ret = lttng_ht_del(events, &iter);
 938                 assert(!ret);
 939                 call_rcu(&node->head, destroy_event_rcu);
 940         }
 941         rcu_read_unlock();
 942
 943         ht_cleanup_push(events);
 944 }
 945
 946 /*
 947  * Cleanup ust channel structure.
 948  *
 949  * Should _NOT_ be called with RCU read lock held.
 950  */
 951 static void _trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 952 {
 953         assert(channel);
 954
 955         DBG2("Trace destroy UST channel %s", channel->name);
 956
 957         free(channel);
 958 }
 959
 960 /*
 961  * URCU intermediate call to complete destroy channel.
 962  */
 963 static void destroy_channel_rcu(struct rcu_head *head)
 964 {
 965         struct lttng_ht_node_str *node =
 966                 caa_container_of(head, struct lttng_ht_node_str, head);
 967         struct ltt_ust_channel *channel =
 968                 caa_container_of(node, struct ltt_ust_channel, node);
 969
 970         _trace_ust_destroy_channel(channel);
 971 }
 972
 973 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 974 {
 975         /* Destroying all events of the channel */
 976         destroy_events(channel->events);
 977         /* Destroying all context of the channel */
 978         destroy_contexts(channel->ctx);
 979
 980         call_rcu(&channel->node.head, destroy_channel_rcu);
 981 }
 982
 983 /*
 984  * Remove an UST channel from a channel HT.
 985  */
 986 void trace_ust_delete_channel(struct lttng_ht *ht,
 987                 struct ltt_ust_channel *channel)
 988 {
 989         int ret;
 990         struct lttng_ht_iter iter;
 991
 992         assert(ht);
 993         assert(channel);
 994
 995         iter.iter.node = &channel->node.node;
 996         ret = lttng_ht_del(ht, &iter);
 997         assert(!ret);
 998 }
 999
1000 /*
1001  * Iterate over a hash table containing channels and cleanup safely.
1002  */
1003 static void destroy_channels(struct lttng_ht *channels)
1004 {
1005         struct lttng_ht_node_str *node;
1006         struct lttng_ht_iter iter;
1007
1008         assert(channels);
1009
1010         rcu_read_lock();
1011         cds_lfht_for_each_entry(channels->ht, &iter.iter, node, node) {
1012                 struct ltt_ust_channel *chan =
1013                         caa_container_of(node, struct ltt_ust_channel, node);
1014
1015                 trace_ust_delete_channel(channels, chan);
1016                 trace_ust_destroy_channel(chan);
1017         }
1018         rcu_read_unlock();
1019
1020         ht_cleanup_push(channels);
1021 }
1022
1023 /*
1024  * Cleanup UST global domain.
1025  */
1026 static void destroy_domain_global(struct ltt_ust_domain_global *dom)
1027 {
1028         assert(dom);
1029
1030         destroy_channels(dom->channels);
1031 }
1032
1033 /*
1034  * Cleanup ust session structure
1035  *
1036  * Should *NOT* be called with RCU read-side lock held.
1037  */
1038 void trace_ust_destroy_session(struct ltt_ust_session *session)
1039 {
1040         struct agent *agt;
1041         struct buffer_reg_uid *reg, *sreg;
1042         struct lttng_ht_iter iter;
1043
1044         assert(session);
1045
1046         DBG2("Trace UST destroy session %" PRIu64, session->id);
1047
1048         /* Cleaning up UST domain */
1049         destroy_domain_global(&session->domain_global);
1050
1051         rcu_read_lock();
1052         cds_lfht_for_each_entry(session->agents->ht, &iter.iter, agt, node.node) {
1053                 int ret = lttng_ht_del(session->agents, &iter);
1054
1055                 assert(!ret);
1056                 agent_destroy(agt);
1057         }
1058         rcu_read_unlock();
1059
1060         ht_cleanup_push(session->agents);
1061
1062         /* Cleanup UID buffer registry object(s). */
1063         cds_list_for_each_entry_safe(reg, sreg, &session->buffer_reg_uid_list,
1064                         lnode) {
1065                 cds_list_del(&reg->lnode);
1066                 buffer_reg_uid_remove(reg);
1067                 buffer_reg_uid_destroy(reg, session->consumer);
1068         }
1069
1070         consumer_output_put(session->consumer);
1071
1072         fini_pid_tracker(&session->pid_tracker);
1073
1074         free(session);
1075 }