src/bin/lttng-sessiond/context.cpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4  *
   5  * SPDX-License-Identifier: GPL-2.0-only
   6  *
   7  */
   8
   9 #define _LGPL_SOURCE
  10 #include "agent.hpp"
  11 #include "context.hpp"
  12 #include "kernel.hpp"
  13 #include "trace-ust.hpp"
  14 #include "ust-app.hpp"
  15
  16 #include <common/error.hpp>
  17 #include <common/sessiond-comm/sessiond-comm.hpp>
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <unistd.h>
  23 #include <urcu/list.h>
  24
  25 /*
  26  * Add kernel context to all channel.
  27  *
  28  * Assumes the ownership of kctx.
  29  */
  30 static int add_kctx_all_channels(struct ltt_kernel_session *ksession,
  31                                  struct ltt_kernel_context *kctx)
  32 {
  33         int ret;
  34         struct ltt_kernel_channel *kchan;
  35
  36         LTTNG_ASSERT(ksession);
  37         LTTNG_ASSERT(kctx);
  38
  39         DBG("Adding kernel context to all channels");
  40
  41         /* Go over all channels */
  42         cds_list_for_each_entry (kchan, &ksession->channel_list.head, list) {
  43                 struct ltt_kernel_context *kctx_copy;
  44
  45                 kctx_copy = trace_kernel_copy_context(kctx);
  46                 if (!kctx_copy) {
  47                         PERROR("zmalloc ltt_kernel_context");
  48                         ret = -LTTNG_ERR_NOMEM;
  49                         goto error;
  50                 }
  51
  52                 /* Ownership of kctx_copy is transferred to the callee. */
  53                 ret = kernel_add_channel_context(kchan, kctx_copy);
  54                 kctx_copy = NULL;
  55                 if (ret != 0) {
  56                         goto error;
  57                 }
  58         }
  59
  60         ret = LTTNG_OK;
  61
  62 error:
  63         trace_kernel_destroy_context(kctx);
  64         return ret;
  65 }
  66
  67 /*
  68  * Add kernel context to a specific channel.
  69  *
  70  * Assumes the ownership of kctx.
  71  */
  72 static int add_kctx_to_channel(struct ltt_kernel_context *kctx, struct ltt_kernel_channel *kchan)
  73 {
  74         int ret;
  75
  76         LTTNG_ASSERT(kchan);
  77         LTTNG_ASSERT(kctx);
  78
  79         DBG("Add kernel context to channel '%s'", kchan->channel->name);
  80
  81         /* Ownership of kctx is transferred to the callee. */
  82         ret = kernel_add_channel_context(kchan, kctx);
  83         kctx = NULL;
  84         if (ret != 0) {
  85                 goto error;
  86         }
  87
  88         ret = LTTNG_OK;
  89
  90 error:
  91         return ret;
  92 }
  93
  94 /*
  95  * Add UST context to channel.
  96  */
  97 static int add_uctx_to_channel(struct ltt_ust_session *usess,
  98                                enum lttng_domain_type domain,
  99                                struct ltt_ust_channel *uchan,
 100                                const struct lttng_event_context *ctx)
 101 {
 102         int ret;
 103         struct ltt_ust_context *uctx = NULL;
 104
 105         LTTNG_ASSERT(usess);
 106         LTTNG_ASSERT(uchan);
 107         LTTNG_ASSERT(ctx);
 108
 109         /* Check if context is duplicate */
 110         cds_list_for_each_entry (uctx, &uchan->ctx_list, list) {
 111                 if (trace_ust_match_context(uctx, ctx)) {
 112                         ret = LTTNG_ERR_UST_CONTEXT_EXIST;
 113                         goto duplicate;
 114                 }
 115         }
 116         uctx = NULL;
 117
 118         switch (domain) {
 119         case LTTNG_DOMAIN_JUL:
 120         case LTTNG_DOMAIN_LOG4J:
 121         {
 122                 struct agent *agt;
 123
 124                 if (ctx->ctx != LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
 125                         /* Other contexts are not needed by the agent. */
 126                         break;
 127                 }
 128                 agt = trace_ust_find_agent(usess, domain);
 129
 130                 if (!agt) {
 131                         agt = agent_create(domain);
 132                         if (!agt) {
 133                                 ret = -LTTNG_ERR_NOMEM;
 134                                 goto error;
 135                         }
 136                         agent_add(agt, usess->agents);
 137                 }
 138                 ret = agent_add_context(ctx, agt);
 139                 if (ret != LTTNG_OK) {
 140                         goto error;
 141                 }
 142
 143                 ret = agent_enable_context(ctx, domain);
 144                 if (ret != LTTNG_OK) {
 145                         goto error;
 146                 }
 147                 break;
 148         }
 149         case LTTNG_DOMAIN_UST:
 150                 break;
 151         default:
 152                 abort();
 153         }
 154
 155         /* Create ltt UST context */
 156         uctx = trace_ust_create_context(ctx);
 157         if (uctx == NULL) {
 158                 ret = LTTNG_ERR_UST_CONTEXT_INVAL;
 159                 goto error;
 160         }
 161
 162         /* Add ltt UST context node to ltt UST channel */
 163         lttng_ht_add_ulong(uchan->ctx, &uctx->node);
 164         cds_list_add_tail(&uctx->list, &uchan->ctx_list);
 165
 166         if (!usess->active) {
 167                 goto end;
 168         }
 169
 170         ret = ust_app_add_ctx_channel_glb(usess, uchan, uctx);
 171         if (ret < 0) {
 172                 goto error;
 173         }
 174 end:
 175         DBG("Context UST %d added to channel %s", uctx->ctx.ctx, uchan->name);
 176
 177         return 0;
 178
 179 error:
 180         free(uctx);
 181 duplicate:
 182         return ret;
 183 }
 184
 185 /*
 186  * Add kernel context to tracer.
 187  */
 188 int context_kernel_add(struct ltt_kernel_session *ksession,
 189                        const struct lttng_event_context *ctx,
 190                        const char *channel_name)
 191 {
 192         int ret;
 193         struct ltt_kernel_channel *kchan;
 194         struct ltt_kernel_context *kctx;
 195
 196         LTTNG_ASSERT(ksession);
 197         LTTNG_ASSERT(ctx);
 198         LTTNG_ASSERT(channel_name);
 199
 200         kctx = trace_kernel_create_context(NULL);
 201         if (!kctx) {
 202                 ret = -LTTNG_ERR_NOMEM;
 203                 goto error;
 204         }
 205
 206         /* Setup kernel context structure */
 207         switch (ctx->ctx) {
 208         case LTTNG_EVENT_CONTEXT_PID:
 209                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PID;
 210                 break;
 211         case LTTNG_EVENT_CONTEXT_PROCNAME:
 212                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PROCNAME;
 213                 break;
 214         case LTTNG_EVENT_CONTEXT_PRIO:
 215                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PRIO;
 216                 break;
 217         case LTTNG_EVENT_CONTEXT_NICE:
 218                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_NICE;
 219                 break;
 220         case LTTNG_EVENT_CONTEXT_VPID:
 221                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VPID;
 222                 break;
 223         case LTTNG_EVENT_CONTEXT_TID:
 224                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_TID;
 225                 break;
 226         case LTTNG_EVENT_CONTEXT_VTID:
 227                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VTID;
 228                 break;
 229         case LTTNG_EVENT_CONTEXT_PPID:
 230                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PPID;
 231                 break;
 232         case LTTNG_EVENT_CONTEXT_VPPID:
 233                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VPPID;
 234                 break;
 235         case LTTNG_EVENT_CONTEXT_HOSTNAME:
 236                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_HOSTNAME;
 237                 break;
 238         case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER:
 239         case LTTNG_EVENT_CONTEXT_PERF_COUNTER:
 240                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PERF_CPU_COUNTER;
 241                 break;
 242         case LTTNG_EVENT_CONTEXT_INTERRUPTIBLE:
 243                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_INTERRUPTIBLE;
 244                 break;
 245         case LTTNG_EVENT_CONTEXT_PREEMPTIBLE:
 246                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PREEMPTIBLE;
 247                 break;
 248         case LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE:
 249                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_NEED_RESCHEDULE;
 250                 break;
 251         case LTTNG_EVENT_CONTEXT_MIGRATABLE:
 252                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_MIGRATABLE;
 253                 break;
 254         case LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL:
 255                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_CALLSTACK_KERNEL;
 256                 break;
 257         case LTTNG_EVENT_CONTEXT_CALLSTACK_USER:
 258                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_CALLSTACK_USER;
 259                 break;
 260         case LTTNG_EVENT_CONTEXT_CGROUP_NS:
 261                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_CGROUP_NS;
 262                 break;
 263         case LTTNG_EVENT_CONTEXT_IPC_NS:
 264                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_IPC_NS;
 265                 break;
 266         case LTTNG_EVENT_CONTEXT_MNT_NS:
 267                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_MNT_NS;
 268                 break;
 269         case LTTNG_EVENT_CONTEXT_NET_NS:
 270                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_NET_NS;
 271                 break;
 272         case LTTNG_EVENT_CONTEXT_PID_NS:
 273                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_PID_NS;
 274                 break;
 275         case LTTNG_EVENT_CONTEXT_TIME_NS:
 276                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_TIME_NS;
 277                 break;
 278         case LTTNG_EVENT_CONTEXT_USER_NS:
 279                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_USER_NS;
 280                 break;
 281         case LTTNG_EVENT_CONTEXT_UTS_NS:
 282                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_UTS_NS;
 283                 break;
 284         case LTTNG_EVENT_CONTEXT_UID:
 285                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_UID;
 286                 break;
 287         case LTTNG_EVENT_CONTEXT_EUID:
 288                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_EUID;
 289                 break;
 290         case LTTNG_EVENT_CONTEXT_SUID:
 291                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_SUID;
 292                 break;
 293         case LTTNG_EVENT_CONTEXT_GID:
 294                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_GID;
 295                 break;
 296         case LTTNG_EVENT_CONTEXT_EGID:
 297                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_EGID;
 298                 break;
 299         case LTTNG_EVENT_CONTEXT_SGID:
 300                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_SGID;
 301                 break;
 302         case LTTNG_EVENT_CONTEXT_VUID:
 303                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VUID;
 304                 break;
 305         case LTTNG_EVENT_CONTEXT_VEUID:
 306                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VEUID;
 307                 break;
 308         case LTTNG_EVENT_CONTEXT_VSUID:
 309                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VSUID;
 310                 break;
 311         case LTTNG_EVENT_CONTEXT_VGID:
 312                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VGID;
 313                 break;
 314         case LTTNG_EVENT_CONTEXT_VEGID:
 315                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VEGID;
 316                 break;
 317         case LTTNG_EVENT_CONTEXT_VSGID:
 318                 kctx->ctx.ctx = LTTNG_KERNEL_ABI_CONTEXT_VSGID;
 319                 break;
 320         default:
 321                 ret = LTTNG_ERR_KERN_CONTEXT_FAIL;
 322                 goto error;
 323         }
 324
 325         kctx->ctx.u.perf_counter.type = ctx->u.perf_counter.type;
 326         kctx->ctx.u.perf_counter.config = ctx->u.perf_counter.config;
 327         strncpy(kctx->ctx.u.perf_counter.name, ctx->u.perf_counter.name, LTTNG_SYMBOL_NAME_LEN);
 328         kctx->ctx.u.perf_counter.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 329
 330         if (*channel_name == '\0') {
 331                 ret = add_kctx_all_channels(ksession, kctx);
 332                 /* Ownership of kctx is transferred to the callee. */
 333                 kctx = NULL;
 334                 if (ret != LTTNG_OK) {
 335                         goto error;
 336                 }
 337         } else {
 338                 /* Get kernel channel */
 339                 kchan = trace_kernel_get_channel_by_name(channel_name, ksession);
 340                 if (kchan == NULL) {
 341                         ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
 342                         goto error;
 343                 }
 344
 345                 ret = add_kctx_to_channel(kctx, kchan);
 346                 /* Ownership of kctx is transferred to the callee. */
 347                 kctx = NULL;
 348                 if (ret != LTTNG_OK) {
 349                         goto error;
 350                 }
 351         }
 352
 353         ret = LTTNG_OK;
 354
 355 error:
 356         if (kctx) {
 357                 trace_kernel_destroy_context(kctx);
 358         }
 359         return ret;
 360 }
 361
 362 /*
 363  * Add UST context to tracer.
 364  */
 365 int context_ust_add(struct ltt_ust_session *usess,
 366                     enum lttng_domain_type domain,
 367                     const struct lttng_event_context *ctx,
 368                     const char *channel_name)
 369 {
 370         int ret = LTTNG_OK;
 371         struct lttng_ht_iter iter;
 372         struct lttng_ht *chan_ht;
 373         struct ltt_ust_channel *uchan = NULL;
 374
 375         LTTNG_ASSERT(usess);
 376         LTTNG_ASSERT(ctx);
 377         LTTNG_ASSERT(channel_name);
 378
 379         rcu_read_lock();
 380
 381         chan_ht = usess->domain_global.channels;
 382
 383         /* Get UST channel if defined */
 384         if (channel_name[0] != '\0') {
 385                 uchan = trace_ust_find_channel_by_name(chan_ht, channel_name);
 386                 if (uchan == NULL) {
 387                         ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
 388                         goto error;
 389                 }
 390         }
 391
 392         if (uchan) {
 393                 /* Add ctx to channel */
 394                 ret = add_uctx_to_channel(usess, domain, uchan, ctx);
 395         } else {
 396                 rcu_read_lock();
 397                 /* Add ctx all events, all channels */
 398                 cds_lfht_for_each_entry (chan_ht->ht, &iter.iter, uchan, node.node) {
 399                         ret = add_uctx_to_channel(usess, domain, uchan, ctx);
 400                         if (ret) {
 401                                 ERR("Failed to add context to channel %s", uchan->name);
 402                                 continue;
 403                         }
 404                 }
 405                 rcu_read_unlock();
 406         }
 407
 408         switch (ret) {
 409         case LTTNG_ERR_UST_CONTEXT_EXIST:
 410                 break;
 411         case -ENOMEM:
 412         case -LTTNG_ERR_NOMEM:
 413                 ret = LTTNG_ERR_FATAL;
 414                 break;
 415         case -EINVAL:
 416                 ret = LTTNG_ERR_UST_CONTEXT_INVAL;
 417                 break;
 418         case -ENOSYS:
 419                 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
 420                 break;
 421         default:
 422                 if (ret != 0 && ret != LTTNG_OK) {
 423                         ret = ret > 0 ? ret : LTTNG_ERR_UNK;
 424                 } else {
 425                         ret = LTTNG_OK;
 426                 }
 427                 break;
 428         }
 429
 430 error:
 431         rcu_read_unlock();
 432         return ret;
 433 }