src/lib/lttng-ust/lttng-context-vtid.c

   1 /*
   2  * SPDX-License-Identifier: LGPL-2.1-only
   3  *
   4  * Copyright (C) 2009-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   5  *
   6  * LTTng UST vtid context.
   7  */
   8
   9 #define _LGPL_SOURCE
  10 #include <limits.h>
  11 #include <stddef.h>
  12 #include <sys/types.h>
  13 #include <unistd.h>
  14 #include <lttng/ust-events.h>
  15 #include <lttng/ust-tracer.h>
  16 #include <lttng/ust-ringbuffer-context.h>
  17 #include "common/compat/tid.h"
  18 #include <urcu/tls-compat.h>
  19
  20 #include "context-internal.h"
  21 #include "lttng-tracer-core.h"
  22
  23 /*
  24  * We cache the result to ensure we don't trigger a system call for
  25  * each event.
  26  */
  27 static DEFINE_URCU_TLS(pid_t, cached_vtid);
  28
  29 /*
  30  * Upon fork or clone, the TID assigned to our thread is not the same as
  31  * we kept in cache. Luckily, we are the only thread surviving in the
  32  * child process, so we can simply clear our cached version.
  33  */
  34 void lttng_context_vtid_reset(void)
  35 {
  36         CMM_STORE_SHARED(URCU_TLS(cached_vtid), 0);
  37 }
  38
  39 static
  40 size_t vtid_get_size(void *priv __attribute__((unused)),
  41                 struct lttng_ust_probe_ctx *probe_ctx __attribute__((unused)),
  42                 size_t offset)
  43 {
  44         size_t size = 0;
  45
  46         size += lttng_ust_ring_buffer_align(offset, lttng_ust_rb_alignof(pid_t));
  47         size += sizeof(pid_t);
  48         return size;
  49 }
  50
  51 static inline
  52 pid_t wrapper_getvtid(void)
  53 {
  54         pid_t vtid;
  55
  56         vtid = CMM_LOAD_SHARED(URCU_TLS(cached_vtid));
  57         if (caa_unlikely(!vtid)) {
  58                 vtid = lttng_gettid();
  59                 CMM_STORE_SHARED(URCU_TLS(cached_vtid), vtid);
  60         }
  61         return vtid;
  62 }
  63
  64 static
  65 void vtid_record(void *priv __attribute__((unused)),
  66                 struct lttng_ust_probe_ctx *probe_ctx __attribute__((unused)),
  67                 struct lttng_ust_ring_buffer_ctx *ctx,
  68                 struct lttng_ust_channel_buffer *chan)
  69 {
  70         pid_t vtid = wrapper_getvtid();
  71
  72         chan->ops->event_write(ctx, &vtid, sizeof(vtid), lttng_ust_rb_alignof(vtid));
  73 }
  74
  75 static
  76 void vtid_get_value(void *priv __attribute__((unused)),
  77                 struct lttng_ust_probe_ctx *probe_ctx __attribute__((unused)),
  78                 struct lttng_ust_ctx_value *value)
  79 {
  80         value->u.s64 = wrapper_getvtid();
  81 }
  82
  83 static const struct lttng_ust_ctx_field *ctx_field = lttng_ust_static_ctx_field(
  84         lttng_ust_static_event_field("vtid",
  85                 lttng_ust_static_type_integer(sizeof(pid_t) * CHAR_BIT,
  86                                 lttng_ust_rb_alignof(pid_t) * CHAR_BIT,
  87                                 lttng_ust_is_signed_type(pid_t),
  88                                 LTTNG_UST_BYTE_ORDER, 10),
  89                 false, false),
  90         vtid_get_size,
  91         vtid_record,
  92         vtid_get_value,
  93         NULL, NULL);
  94
  95 int lttng_add_vtid_to_ctx(struct lttng_ust_ctx **ctx)
  96 {
  97         int ret;
  98
  99         if (lttng_find_context(*ctx, ctx_field->event_field->name)) {
 100                 ret = -EEXIST;
 101                 goto error_find_context;
 102         }
 103         ret = lttng_ust_context_append(ctx, ctx_field);
 104         if (ret)
 105                 return ret;
 106         return 0;
 107
 108 error_find_context:
 109         return ret;
 110 }
 111
 112 /*
 113  * Force a read (imply TLS allocation for dlopen) of TLS variables.
 114  */
 115 void lttng_ust_vtid_init_thread(int flags)
 116 {
 117         asm volatile ("" : : "m" (URCU_TLS(cached_vtid)));
 118         if (flags & LTTNG_UST_INIT_THREAD_CONTEXT_CACHE)
 119                 (void)wrapper_getvtid();
 120 }