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