Cleanup trace ust destroy functions
[lttng-tools.git] / lttng-sessiond / trace-ust.c
CommitLineData
97ee3a89
DG
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 it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; only version 2 of the License.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307, USA.
16 */
17
18#define _GNU_SOURCE
19#include <stdio.h>
20#include <stdlib.h>
21#include <string.h>
22#include <unistd.h>
23
24#include <lttngerr.h>
25#include <lttng-share.h>
26
f6a9efaa 27#include "hashtable.h"
97ee3a89
DG
28#include "trace-ust.h"
29
0177d773 30/*
f6a9efaa 31 * Find the channel in the hashtable.
0177d773 32 */
f6a9efaa
DG
33struct ltt_ust_channel *trace_ust_find_channel_by_name(struct cds_lfht *ht,
34 char *name)
0177d773 35{
f6a9efaa
DG
36 struct cds_lfht_node *node;
37 struct cds_lfht_iter iter;
0177d773 38
f6a9efaa
DG
39 rcu_read_lock();
40 node = hashtable_lookup(ht, (void *) name, strlen(name), &iter);
41 if (node == NULL) {
42 rcu_read_unlock();
44d3bd01
DG
43 goto error;
44 }
f6a9efaa 45 rcu_read_unlock();
44d3bd01 46
f6a9efaa 47 DBG2("Trace UST channel %s found by name", name);
0177d773 48
f6a9efaa 49 return caa_container_of(node, struct ltt_ust_channel, node);
97ee3a89
DG
50
51error:
f6a9efaa 52 DBG2("Trace UST channel %s not found by name", name);
97ee3a89
DG
53 return NULL;
54}
55
56/*
f6a9efaa 57 * Find the event in the hashtable.
97ee3a89 58 */
f6a9efaa
DG
59struct ltt_ust_event *trace_ust_find_event_by_name(struct cds_lfht *ht,
60 char *name)
97ee3a89 61{
f6a9efaa
DG
62 struct cds_lfht_node *node;
63 struct cds_lfht_iter iter;
97ee3a89 64
f6a9efaa
DG
65 rcu_read_lock();
66 node = hashtable_lookup(ht, (void *) name, strlen(name), &iter);
67 if (node == NULL) {
68 rcu_read_unlock();
97ee3a89
DG
69 goto error;
70 }
f6a9efaa 71 rcu_read_unlock();
97ee3a89 72
f6a9efaa
DG
73 DBG2("Found UST event by name %s", name);
74
75 return caa_container_of(node, struct ltt_ust_event, node);
97ee3a89
DG
76
77error:
78 return NULL;
79}
80
81/*
82 * Allocate and initialize a ust session data structure.
83 *
84 * Return pointer to structure or NULL.
85 */
48842b30 86struct ltt_ust_session *trace_ust_create_session(char *path, unsigned int uid,
44d3bd01 87 struct lttng_domain *domain)
97ee3a89 88{
0177d773 89 int ret;
97ee3a89
DG
90 struct ltt_ust_session *lus;
91
92 /* Allocate a new ltt ust session */
93 lus = malloc(sizeof(struct ltt_ust_session));
94 if (lus == NULL) {
36dc12cc 95 PERROR("create ust session malloc");
97ee3a89
DG
96 goto error;
97 }
98
99 /* Init data structure */
3bd1e081 100 lus->consumer_fds_sent = 0;
48842b30 101 lus->uid = uid;
36dc12cc 102 lus->start_trace = 0;
97ee3a89 103
f6a9efaa
DG
104 /* Alloc UST domain hash tables */
105 lus->domain_pid = hashtable_new(0);
106 lus->domain_exec = hashtable_new_str(0);
107
108 /* Alloc UST global domain channels' HT */
109 lus->domain_global.channels = hashtable_new_str(0);
44d3bd01 110
0177d773 111 /* Set session path */
48842b30 112 ret = snprintf(lus->pathname, PATH_MAX, "%s/ust", path);
0177d773 113 if (ret < 0) {
44d3bd01 114 PERROR("snprintf kernel traces path");
44844c29 115 goto error_free_session;
0177d773
DG
116 }
117
44d3bd01
DG
118 DBG2("UST trace session create successful");
119
97ee3a89
DG
120 return lus;
121
44844c29
MD
122error_free_session:
123 free(lus);
97ee3a89
DG
124error:
125 return NULL;
126}
127
128/*
129 * Allocate and initialize a ust channel data structure.
130 *
131 * Return pointer to structure or NULL.
132 */
44d3bd01
DG
133struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan,
134 char *path)
97ee3a89
DG
135{
136 int ret;
137 struct ltt_ust_channel *luc;
138
139 luc = malloc(sizeof(struct ltt_ust_channel));
140 if (luc == NULL) {
141 perror("ltt_ust_channel malloc");
142 goto error;
143 }
144
44d3bd01 145 /* Copy UST channel attributes */
48842b30
DG
146 luc->attr.overwrite = chan->attr.overwrite;
147 luc->attr.subbuf_size = chan->attr.subbuf_size;
148 luc->attr.num_subbuf = chan->attr.num_subbuf;
149 luc->attr.switch_timer_interval = chan->attr.switch_timer_interval;
150 luc->attr.read_timer_interval = chan->attr.read_timer_interval;
151 luc->attr.output = chan->attr.output;
44d3bd01
DG
152
153 /* Translate to UST output enum */
154 switch (luc->attr.output) {
155 default:
156 luc->attr.output = LTTNG_UST_MMAP;
157 break;
97ee3a89 158 }
97ee3a89 159
97ee3a89 160 /* Copy channel name */
44d3bd01 161 strncpy(luc->name, chan->name, sizeof(&luc->name));
97ee3a89
DG
162 luc->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
163
f6a9efaa
DG
164 /* Init node */
165 hashtable_node_init(&luc->node, (void *) luc->name, strlen(luc->name));
166 /* Alloc hash tables */
167 luc->events = hashtable_new_str(0);
168 luc->ctx = hashtable_new_str(0);
169
97ee3a89 170 /* Set trace output path */
48842b30 171 ret = snprintf(luc->pathname, PATH_MAX, "%s", path);
97ee3a89
DG
172 if (ret < 0) {
173 perror("asprintf ust create channel");
44844c29 174 goto error_free_channel;
97ee3a89
DG
175 }
176
f6a9efaa
DG
177 DBG2("Trace UST channel %s created", luc->name);
178
97ee3a89
DG
179 return luc;
180
44844c29
MD
181error_free_channel:
182 free(luc);
97ee3a89
DG
183error:
184 return NULL;
185}
186
187/*
188 * Allocate and initialize a ust event. Set name and event type.
189 *
190 * Return pointer to structure or NULL.
191 */
192struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev)
193{
194 struct ltt_ust_event *lue;
97ee3a89
DG
195
196 lue = malloc(sizeof(struct ltt_ust_event));
44d3bd01
DG
197 if (lue == NULL) {
198 PERROR("ust event malloc");
97ee3a89
DG
199 goto error;
200 }
201
202 switch (ev->type) {
203 case LTTNG_EVENT_PROBE:
44d3bd01 204 lue->attr.instrumentation = LTTNG_UST_PROBE;
97ee3a89
DG
205 break;
206 case LTTNG_EVENT_FUNCTION:
44d3bd01 207 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
97ee3a89
DG
208 break;
209 case LTTNG_EVENT_FUNCTION_ENTRY:
44d3bd01 210 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
97ee3a89
DG
211 break;
212 case LTTNG_EVENT_TRACEPOINT:
44d3bd01 213 lue->attr.instrumentation = LTTNG_UST_TRACEPOINT;
97ee3a89
DG
214 break;
215 default:
216 ERR("Unknown ust instrumentation type (%d)", ev->type);
44844c29 217 goto error_free_event;
97ee3a89
DG
218 }
219
220 /* Copy event name */
44d3bd01
DG
221 strncpy(lue->attr.name, ev->name, LTTNG_UST_SYM_NAME_LEN);
222 lue->attr.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
97ee3a89 223
f6a9efaa
DG
224 /* Init node */
225 hashtable_node_init(&lue->node, (void *) lue->attr.name,
226 strlen(lue->attr.name));
227 /* Alloc context hash tables */
e03e3332 228 lue->ctx = hashtable_new_str(0);
97ee3a89
DG
229
230 return lue;
231
44844c29
MD
232error_free_event:
233 free(lue);
97ee3a89
DG
234error:
235 return NULL;
236}
237
238/*
239 * Allocate and initialize a ust metadata.
240 *
241 * Return pointer to structure or NULL.
242 */
243struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
244{
245 int ret;
246 struct ltt_ust_metadata *lum;
97ee3a89 247
3a009adb 248 lum = zmalloc(sizeof(struct ltt_ust_metadata));
44d3bd01 249 if (lum == NULL) {
97ee3a89
DG
250 perror("ust metadata malloc");
251 goto error;
252 }
253
254 /* Set default attributes */
44d3bd01
DG
255 lum->attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
256 lum->attr.subbuf_size = DEFAULT_METADATA_SUBBUF_SIZE;
257 lum->attr.num_subbuf = DEFAULT_METADATA_SUBBUF_NUM;
258 lum->attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
259 lum->attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
d41f73b7 260 lum->attr.output = LTTNG_UST_MMAP;
44d3bd01 261
97ee3a89
DG
262 lum->handle = -1;
263 /* Set metadata trace path */
f6a9efaa 264 ret = snprintf(lum->pathname, PATH_MAX, "%s/metadata", path);
97ee3a89
DG
265 if (ret < 0) {
266 perror("asprintf ust metadata");
44844c29 267 goto error_free_metadata;
97ee3a89
DG
268 }
269
270 return lum;
271
44844c29
MD
272error_free_metadata:
273 free(lum);
97ee3a89
DG
274error:
275 return NULL;
276}
277
f6a9efaa
DG
278/*
279 * RCU safe free context structure.
280 */
281static void destroy_context_rcu(struct rcu_head *head)
282{
283 struct cds_lfht_node *node =
284 caa_container_of(head, struct cds_lfht_node, head);
285 struct ltt_ust_context *ctx =
286 caa_container_of(node, struct ltt_ust_context, node);
287
288 free(ctx);
289}
290
291/*
292 * Cleanup UST context hash table.
293 */
294static void destroy_context(struct cds_lfht *ht)
295{
296 int ret;
297 struct cds_lfht_node *node;
298 struct cds_lfht_iter iter;
299
ed52805d 300 cds_lfht_for_each(ht, &iter, node) {
f6a9efaa
DG
301 ret = hashtable_del(ht, &iter);
302 if (!ret) {
303 call_rcu(&node->head, destroy_context_rcu);
304 }
f6a9efaa 305 }
ed52805d
DG
306
307 hashtable_destroy(ht);
f6a9efaa
DG
308}
309
97ee3a89
DG
310/*
311 * Cleanup ust event structure.
312 */
313void trace_ust_destroy_event(struct ltt_ust_event *event)
314{
f6a9efaa
DG
315 DBG2("Trace destroy UST event %s", event->attr.name);
316 destroy_context(event->ctx);
ed52805d 317
97ee3a89
DG
318 free(event);
319}
320
f6a9efaa
DG
321/*
322 * URCU intermediate call to complete destroy event.
323 */
324static void destroy_event_rcu(struct rcu_head *head)
325{
326 struct cds_lfht_node *node =
327 caa_container_of(head, struct cds_lfht_node, head);
328 struct ltt_ust_event *event =
329 caa_container_of(node, struct ltt_ust_event, node);
330
331 trace_ust_destroy_event(event);
332}
333
ed52805d
DG
334static void destroy_event(struct cds_lfht *ht)
335{
336 int ret;
337 struct cds_lfht_node *node;
338 struct cds_lfht_iter iter;
339
340 cds_lfht_for_each(ht, &iter, node) {
341 ret = hashtable_del(ht, &iter);
342 if (!ret) {
343 call_rcu(&node->head, destroy_event_rcu);
344 }
345 }
346
347 hashtable_destroy(ht);
348}
349
97ee3a89
DG
350/*
351 * Cleanup ust channel structure.
352 */
353void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
354{
f6a9efaa
DG
355 int ret;
356 struct cds_lfht_node *node;
357 struct cds_lfht_iter iter;
97ee3a89 358
f6a9efaa 359 DBG2("Trace destroy UST channel %s", channel->name);
97ee3a89 360
f6a9efaa
DG
361 rcu_read_lock();
362
ed52805d 363 cds_lfht_for_each(channel->events, &iter, node) {
f6a9efaa
DG
364 ret = hashtable_del(channel->events, &iter);
365 if (!ret) {
ed52805d 366 destroy_event(channel->events);
f6a9efaa 367 }
97ee3a89
DG
368 }
369
f6a9efaa 370 destroy_context(channel->ctx);
97ee3a89 371 free(channel);
f6a9efaa
DG
372
373 rcu_read_unlock();
374}
375
376/*
377 * URCU intermediate call to complete destroy channel.
378 */
379static void destroy_channel_rcu(struct rcu_head *head)
380{
381 struct cds_lfht_node *node =
382 caa_container_of(head, struct cds_lfht_node, head);
383 struct ltt_ust_channel *channel =
384 caa_container_of(node, struct ltt_ust_channel, node);
385
386 trace_ust_destroy_channel(channel);
97ee3a89
DG
387}
388
389/*
390 * Cleanup ust metadata structure.
391 */
392void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
393{
f6a9efaa 394 DBG2("Trace UST destroy metadata %d", metadata->handle);
97ee3a89 395
97ee3a89
DG
396 free(metadata);
397}
398
399/*
f6a9efaa 400 * Iterate over a hash table containing channels and cleanup safely.
97ee3a89 401 */
f6a9efaa
DG
402static void destroy_channels(struct cds_lfht *channels)
403{
404 int ret;
405 struct cds_lfht_node *node;
406 struct cds_lfht_iter iter;
407
ed52805d 408 cds_lfht_for_each(channels, &iter, node) {
f6a9efaa
DG
409 ret = hashtable_del(channels, &iter);
410 if (!ret) {
411 call_rcu(&node->head, destroy_channel_rcu);
412 }
f6a9efaa 413 }
ed52805d
DG
414
415 hashtable_destroy(channels);
f6a9efaa
DG
416}
417
418/*
419 * Cleanup UST pid domain.
420 */
421static void destroy_domain_pid(struct cds_lfht *ht)
422{
423 int ret;
f6a9efaa 424 struct cds_lfht_iter iter;
ed52805d 425 struct ltt_ust_domain_pid *dpid;
f6a9efaa 426
ed52805d 427 cds_lfht_for_each_entry(ht, &iter, dpid, node) {
f6a9efaa
DG
428 ret = hashtable_del(ht , &iter);
429 if (!ret) {
ed52805d 430 destroy_channels(dpid->channels);
f6a9efaa 431 }
f6a9efaa 432 }
ed52805d
DG
433
434 hashtable_destroy(ht);
f6a9efaa
DG
435}
436
437/*
438 * Cleanup UST exec name domain.
439 */
440static void destroy_domain_exec(struct cds_lfht *ht)
97ee3a89 441{
f6a9efaa 442 int ret;
f6a9efaa 443 struct cds_lfht_iter iter;
ed52805d 444 struct ltt_ust_domain_exec *dexec;
f6a9efaa 445
ed52805d 446 cds_lfht_for_each_entry(ht, &iter, dexec, node) {
f6a9efaa
DG
447 ret = hashtable_del(ht , &iter);
448 if (!ret) {
ed52805d 449 destroy_channels(dexec->channels);
f6a9efaa 450 }
f6a9efaa 451 }
ed52805d
DG
452
453 hashtable_destroy(ht);
f6a9efaa 454}
97ee3a89 455
f6a9efaa
DG
456/*
457 * Cleanup UST global domain.
458 */
459static void destroy_domain_global(struct ltt_ust_domain_global *dom)
460{
461 destroy_channels(dom->channels);
462}
97ee3a89 463
f6a9efaa
DG
464/*
465 * Cleanup ust session structure
466 */
467void trace_ust_destroy_session(struct ltt_ust_session *session)
468{
ed52805d 469 /* Extra protection */
97ee3a89
DG
470 if (session == NULL) {
471 return;
472 }
473
f6a9efaa
DG
474 rcu_read_lock();
475
48842b30 476 DBG2("Trace UST destroy session %d", session->uid);
f6a9efaa 477
f6a9efaa
DG
478 /* Cleaning up UST domain */
479 destroy_domain_global(&session->domain_global);
480 destroy_domain_pid(session->domain_pid);
481 destroy_domain_exec(session->domain_exec);
44d3bd01 482
97ee3a89 483 free(session);
f6a9efaa
DG
484
485 rcu_read_unlock();
97ee3a89 486}
This page took 0.044842 seconds and 4 git commands to generate.