Fix: don't print channel name on enable JUL event
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.h
CommitLineData
97ee3a89
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
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.
97ee3a89
DG
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 *
d14d33bf
AM
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.
97ee3a89
DG
16 */
17
18#ifndef _LTT_TRACE_UST_H
19#define _LTT_TRACE_UST_H
20
3bd1e081 21#include <config.h>
97ee3a89
DG
22#include <limits.h>
23#include <urcu/list.h>
bec39940 24
97ee3a89 25#include <lttng/lttng.h>
10a8a223 26#include <common/hashtable/hashtable.h>
ce2a9e76 27#include <common/defaults.h>
3bd1e081 28
00e2e675 29#include "consumer.h"
0475c50c 30#include "jul.h"
48842b30 31#include "ust-ctl.h"
97ee3a89 32
18eace3b
DG
33struct ltt_ust_ht_key {
34 const char *name;
35 const struct lttng_filter_bytecode *filter;
36 enum lttng_ust_loglevel_type loglevel;
7724731b 37 const struct lttng_event_exclusion *exclusion;
18eace3b
DG
38};
39
f6a9efaa
DG
40/* Context hash table nodes */
41struct ltt_ust_context {
42 struct lttng_ust_context ctx;
bec39940 43 struct lttng_ht_node_ulong node;
31746f93 44 struct cds_list_head list;
97ee3a89
DG
45};
46
47/* UST event */
48struct ltt_ust_event {
37357452 49 unsigned int enabled;
f6a9efaa 50 struct lttng_ust_event attr;
bec39940 51 struct lttng_ht_node_str node;
6b453b5e 52 char *filter_expression;
53a80697 53 struct lttng_ust_filter_bytecode *filter;
40024f8a 54 struct lttng_event_exclusion *exclusion;
2bdd86d4
MD
55};
56
97ee3a89
DG
57/* UST channel */
58struct ltt_ust_channel {
7972aab2 59 uint64_t id; /* unique id per session. */
37357452 60 unsigned int enabled;
44d3bd01 61 char name[LTTNG_UST_SYM_NAME_LEN];
ffe60014 62 struct lttng_ust_channel_attr attr;
bec39940 63 struct lttng_ht *ctx;
31746f93 64 struct cds_list_head ctx_list;
bec39940
DG
65 struct lttng_ht *events;
66 struct lttng_ht_node_str node;
1624d5b7
JD
67 uint64_t tracefile_size;
68 uint64_t tracefile_count;
97ee3a89
DG
69};
70
f6a9efaa
DG
71/* UST domain global (LTTNG_DOMAIN_UST) */
72struct ltt_ust_domain_global {
bec39940 73 struct lttng_ht *channels;
7972aab2 74 struct cds_list_head registry_buffer_uid_list;
f6a9efaa
DG
75};
76
97ee3a89
DG
77/* UST session */
78struct ltt_ust_session {
d9bf3ca4 79 uint64_t id; /* Unique identifier of session */
f6a9efaa 80 struct ltt_ust_domain_global domain_global;
0475c50c 81 struct jul_domain domain_jul;
6df2e2c9
MD
82 /* UID/GID of the user owning the session */
83 uid_t uid;
84 gid_t gid;
14fb1ebe
DG
85 /* Is the session active meaning has is been started or stopped. */
86 unsigned int active:1;
00e2e675
DG
87 /*
88 * Two consumer_output object are needed where one is for the current
89 * output object and the second one is the temporary object used to store
90 * URI being set by the lttng_set_consumer_uri call. Once
91 * lttng_enable_consumer is called, the two pointers are swapped.
92 */
93 struct consumer_output *consumer;
94 struct consumer_output *tmp_consumer;
f3f0db50
DG
95 /* Sequence number for filters so the tracer knows the ordering. */
96 uint64_t filter_seq_num;
7972aab2
DG
97 /* This indicates which type of buffer this session is set for. */
98 enum lttng_buffer_type buffer_type;
99 /* If set to 1, the buffer_type can not be changed anymore. */
100 int buffer_type_changed;
101 /* For per UID buffer, every buffer reg object is kept of this session */
102 struct cds_list_head buffer_reg_uid_list;
103 /* Next channel ID available for a newly registered channel. */
104 uint64_t next_channel_id;
105 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
106 uint64_t used_channel_id;
2bba9e53
DG
107 /* Tell or not if the session has to output the traces. */
108 unsigned int output_traces;
27babd3a 109 unsigned int snapshot_mode;
85076754 110 unsigned int has_non_default_channel;
ecc48a90 111 unsigned int live_timer_interval; /* usec */
84ad93e8
DG
112
113 /* Metadata channel attributes. */
114 struct lttng_ust_channel_attr metadata_attr;
97ee3a89
DG
115};
116
7972aab2
DG
117/*
118 * Validate that the id has reached the maximum allowed or not.
119 *
120 * Return 0 if NOT else 1.
121 */
122static inline int trace_ust_is_max_id(uint64_t id)
123{
124 return (id == UINT64_MAX) ? 1 : 0;
125}
126
127/*
128 * Return next available channel id and increment the used counter. The
129 * trace_ust_is_max_id function MUST be called before in order to validate if
130 * the maximum number of IDs have been reached. If not, it is safe to call this
131 * function.
132 *
133 * Return a unique channel ID. If max is reached, the used_channel_id counter
134 * is returned.
135 */
136static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
137{
138 if (trace_ust_is_max_id(s->used_channel_id)) {
139 return s->used_channel_id;
140 }
141
142 s->used_channel_id++;
143 return s->next_channel_id++;
144}
145
74d0b642 146#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 147
18eace3b
DG
148int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
149int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
150 const void *_key);
151
97ee3a89
DG
152/*
153 * Lookup functions. NULL is returned if not found.
154 */
18eace3b 155struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
156 char *name, struct lttng_filter_bytecode *filter, int loglevel,
157 struct lttng_event_exclusion *exclusion);
bec39940 158struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 159 char *name);
97ee3a89
DG
160
161/*
162 * Create functions malloc() the data structure.
163 */
d9bf3ca4 164struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
dec56f6c 165struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr);
025faf73 166struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 167 char *filter_expression,
561c6897
JI
168 struct lttng_filter_bytecode *filter,
169 struct lttng_event_exclusion *exclusion);
55cc08a6
DG
170struct ltt_ust_context *trace_ust_create_context(
171 struct lttng_event_context *ctx);
aa3514e9
MD
172int trace_ust_match_context(struct ltt_ust_context *uctx,
173 struct lttng_event_context *ctx);
d5979e4a
DG
174void trace_ust_delete_channel(struct lttng_ht *ht,
175 struct ltt_ust_channel *channel);
97ee3a89
DG
176
177/*
178 * Destroy functions free() the data structure and remove from linked list if
179 * it's applies.
180 */
181void trace_ust_destroy_session(struct ltt_ust_session *session);
97ee3a89
DG
182void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
183void trace_ust_destroy_event(struct ltt_ust_event *event);
184
74d0b642 185#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 186
37a86c61
DG
187static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
188 const void *_key)
189{
190 return 0;
191}
192static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
193 const void *_key)
194{
195 return 0;
196}
3bd1e081 197static inline
bec39940 198struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 199 char *name)
3bd1e081
MD
200{
201 return NULL;
202}
f6a9efaa 203
3bd1e081 204static inline
dec56f6c 205struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
3bd1e081
MD
206{
207 return NULL;
208}
209static inline
dec56f6c 210struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr)
3bd1e081
MD
211{
212 return NULL;
213}
214static inline
025faf73 215struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 216 const char *filter_expression,
561c6897
JI
217 struct lttng_filter_bytecode *filter,
218 struct lttng_event_exclusion *exclusion)
3bd1e081
MD
219{
220 return NULL;
221}
3bd1e081
MD
222static inline
223void trace_ust_destroy_session(struct ltt_ust_session *session)
224{
225}
48842b30 226
3bd1e081
MD
227static inline
228void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
229{
230}
48842b30 231
3bd1e081
MD
232static inline
233void trace_ust_destroy_event(struct ltt_ust_event *event)
234{
235}
34378f76
DG
236static inline
237struct ltt_ust_context *trace_ust_create_context(
238 struct lttng_event_context *ctx)
239{
240 return NULL;
241}
aa3514e9
MD
242static inline
243int trace_ust_match_context(struct ltt_ust_context *uctx,
244 struct lttng_event_context *ctx)
245{
246 return 0;
247}
37a86c61 248static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
249 char *name, struct lttng_filter_bytecode *filter, int loglevel,
250 struct lttng_event_exclusion *exclusion)
37a86c61
DG
251{
252 return NULL;
253}
d5979e4a
DG
254static inline
255void trace_ust_delete_channel(struct lttng_ht *ht,
256 struct ltt_ust_channel *channel)
257{
258 return;
259}
3bd1e081 260
74d0b642 261#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 262
97ee3a89 263#endif /* _LTT_TRACE_UST_H */
This page took 0.051337 seconds and 4 git commands to generate.