Fix: build failures when `--without-lttng-ust`
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.h
CommitLineData
97ee3a89
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
bdf64013 3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
97ee3a89 4 *
d14d33bf
AM
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
97ee3a89
DG
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
d14d33bf
AM
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
97ee3a89
DG
17 */
18
19#ifndef _LTT_TRACE_UST_H
20#define _LTT_TRACE_UST_H
21
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"
75018ab6 30#include "lttng-ust-ctl.h"
97ee3a89 31
7c1d2758
JG
32struct agent;
33
18eace3b
DG
34struct ltt_ust_ht_key {
35 const char *name;
36 const struct lttng_filter_bytecode *filter;
2106efa0 37 enum lttng_ust_loglevel_type loglevel_type;
b953b8cd 38 int loglevel_value;
7724731b 39 const struct lttng_event_exclusion *exclusion;
18eace3b
DG
40};
41
f6a9efaa
DG
42/* Context hash table nodes */
43struct ltt_ust_context {
bdf64013 44 struct lttng_ust_context_attr ctx;
bec39940 45 struct lttng_ht_node_ulong node;
31746f93 46 struct cds_list_head list;
97ee3a89
DG
47};
48
49/* UST event */
50struct ltt_ust_event {
37357452 51 unsigned int enabled;
f6a9efaa 52 struct lttng_ust_event attr;
bec39940 53 struct lttng_ht_node_str node;
6b453b5e 54 char *filter_expression;
51755dc8 55 struct lttng_filter_bytecode *filter;
40024f8a 56 struct lttng_event_exclusion *exclusion;
5b37cc51
JG
57 /*
58 * An internal event is an event which was created by the session daemon
59 * through which, for example, events emitted in Agent domains are
60 * "funelled". This is used to hide internal events from external
61 * clients as they should never be modified by the external world.
62 */
88f06f15 63 bool internal;
2bdd86d4
MD
64};
65
97ee3a89
DG
66/* UST channel */
67struct ltt_ust_channel {
7972aab2 68 uint64_t id; /* unique id per session. */
37357452 69 unsigned int enabled;
51755dc8
JG
70 /*
71 * A UST channel can be part of a userspace sub-domain such as JUL,
72 * Log4j, Python.
73 */
74 enum lttng_domain_type domain;
44d3bd01 75 char name[LTTNG_UST_SYM_NAME_LEN];
ffe60014 76 struct lttng_ust_channel_attr attr;
bec39940 77 struct lttng_ht *ctx;
31746f93 78 struct cds_list_head ctx_list;
bec39940
DG
79 struct lttng_ht *events;
80 struct lttng_ht_node_str node;
1624d5b7
JD
81 uint64_t tracefile_size;
82 uint64_t tracefile_count;
fb83fe64
JD
83 uint64_t per_pid_closed_app_discarded;
84 uint64_t per_pid_closed_app_lost;
e9404c27 85 uint64_t monitor_timer_interval;
97ee3a89
DG
86};
87
f6a9efaa
DG
88/* UST domain global (LTTNG_DOMAIN_UST) */
89struct ltt_ust_domain_global {
bec39940 90 struct lttng_ht *channels;
7972aab2 91 struct cds_list_head registry_buffer_uid_list;
f6a9efaa
DG
92};
93
55c9e7ca 94struct ust_id_tracker_node {
a9ad0c8f
MD
95 struct lttng_ht_node_ulong node;
96};
97
55c9e7ca 98struct ust_id_tracker {
a9ad0c8f
MD
99 struct lttng_ht *ht;
100};
101
97ee3a89
DG
102/* UST session */
103struct ltt_ust_session {
d9bf3ca4 104 uint64_t id; /* Unique identifier of session */
f6a9efaa 105 struct ltt_ust_domain_global domain_global;
fefd409b
DG
106 /* Hash table of agent indexed by agent domain. */
107 struct lttng_ht *agents;
6df2e2c9
MD
108 /* UID/GID of the user owning the session */
109 uid_t uid;
110 gid_t gid;
14fb1ebe
DG
111 /* Is the session active meaning has is been started or stopped. */
112 unsigned int active:1;
00e2e675 113 struct consumer_output *consumer;
f3f0db50
DG
114 /* Sequence number for filters so the tracer knows the ordering. */
115 uint64_t filter_seq_num;
7972aab2
DG
116 /* This indicates which type of buffer this session is set for. */
117 enum lttng_buffer_type buffer_type;
118 /* If set to 1, the buffer_type can not be changed anymore. */
119 int buffer_type_changed;
120 /* For per UID buffer, every buffer reg object is kept of this session */
121 struct cds_list_head buffer_reg_uid_list;
122 /* Next channel ID available for a newly registered channel. */
123 uint64_t next_channel_id;
124 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
125 uint64_t used_channel_id;
2bba9e53
DG
126 /* Tell or not if the session has to output the traces. */
127 unsigned int output_traces;
27babd3a 128 unsigned int snapshot_mode;
85076754 129 unsigned int has_non_default_channel;
ecc48a90 130 unsigned int live_timer_interval; /* usec */
84ad93e8
DG
131
132 /* Metadata channel attributes. */
133 struct lttng_ust_channel_attr metadata_attr;
d7ba1388
MD
134
135 /*
136 * Path where to keep the shared memory files.
137 */
3d071855 138 char root_shm_path[PATH_MAX];
d7ba1388 139 char shm_path[PATH_MAX];
a9ad0c8f 140
82b69413
JG
141 /* Current trace chunk of the ltt_session. */
142 struct lttng_trace_chunk *current_trace_chunk;
55c9e7ca
JR
143
144 /* Trackers used for actual lookup on app registration. */
145 struct ust_id_tracker vpid_tracker;
146 struct ust_id_tracker vuid_tracker;
147 struct ust_id_tracker vgid_tracker;
148
149 /* Tracker list of keys requested by users. */
150 struct lttng_tracker_list *tracker_list_vpid;
151 struct lttng_tracker_list *tracker_list_vuid;
152 struct lttng_tracker_list *tracker_list_vgid;
97ee3a89
DG
153};
154
7972aab2
DG
155/*
156 * Validate that the id has reached the maximum allowed or not.
157 *
158 * Return 0 if NOT else 1.
159 */
160static inline int trace_ust_is_max_id(uint64_t id)
161{
162 return (id == UINT64_MAX) ? 1 : 0;
163}
164
165/*
166 * Return next available channel id and increment the used counter. The
167 * trace_ust_is_max_id function MUST be called before in order to validate if
168 * the maximum number of IDs have been reached. If not, it is safe to call this
169 * function.
170 *
171 * Return a unique channel ID. If max is reached, the used_channel_id counter
172 * is returned.
173 */
174static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
175{
176 if (trace_ust_is_max_id(s->used_channel_id)) {
177 return s->used_channel_id;
178 }
179
180 s->used_channel_id++;
181 return s->next_channel_id++;
182}
183
74d0b642 184#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 185
18eace3b
DG
186int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
187int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
188 const void *_key);
189
97ee3a89
DG
190/*
191 * Lookup functions. NULL is returned if not found.
192 */
18eace3b 193struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
2106efa0 194 char *name, struct lttng_filter_bytecode *filter,
b953b8cd
PP
195 enum lttng_ust_loglevel_type loglevel_type, int loglevel_value,
196 struct lttng_event_exclusion *exclusion);
bec39940 197struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
df4f5a87 198 const char *name);
fefd409b
DG
199struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
200 enum lttng_domain_type domain_type);
97ee3a89
DG
201
202/*
203 * Create functions malloc() the data structure.
204 */
d9bf3ca4 205struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
51755dc8
JG
206struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
207 enum lttng_domain_type domain);
39687410 208enum lttng_error_code trace_ust_create_event(struct lttng_event *ev,
6b453b5e 209 char *filter_expression,
561c6897 210 struct lttng_filter_bytecode *filter,
88f06f15 211 struct lttng_event_exclusion *exclusion,
39687410 212 bool internal_event, struct ltt_ust_event **ust_event);
55cc08a6 213struct ltt_ust_context *trace_ust_create_context(
df4f5a87
JG
214 const struct lttng_event_context *ctx);
215int trace_ust_match_context(const struct ltt_ust_context *uctx,
216 const struct lttng_event_context *ctx);
d5979e4a
DG
217void trace_ust_delete_channel(struct lttng_ht *ht,
218 struct ltt_ust_channel *channel);
97ee3a89
DG
219
220/*
221 * Destroy functions free() the data structure and remove from linked list if
222 * it's applies.
223 */
224void trace_ust_destroy_session(struct ltt_ust_session *session);
97ee3a89
DG
225void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
226void trace_ust_destroy_event(struct ltt_ust_event *event);
bdf64013 227void trace_ust_destroy_context(struct ltt_ust_context *ctx);
d070c424 228void trace_ust_free_session(struct ltt_ust_session *session);
97ee3a89 229
55c9e7ca
JR
230int trace_ust_track_id(enum lttng_tracker_type tracker_type,
231 struct ltt_ust_session *session,
232 const struct lttng_tracker_id *id);
233int trace_ust_untrack_id(enum lttng_tracker_type tracker_type,
234 struct ltt_ust_session *session,
235 const struct lttng_tracker_id *id);
a9ad0c8f 236
55c9e7ca
JR
237int trace_ust_id_tracker_lookup(enum lttng_tracker_type tracker_type,
238 struct ltt_ust_session *session,
239 int id);
b4650bd0 240
a7a533cd 241int trace_ust_list_tracker_ids(enum lttng_tracker_type tracker_type,
55c9e7ca 242 struct ltt_ust_session *session,
a7a533cd 243 struct lttng_tracker_ids **_ids);
a5dfbb9d 244
74d0b642 245#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 246
37a86c61
DG
247static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
248 const void *_key)
249{
250 return 0;
251}
252static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
253 const void *_key)
254{
255 return 0;
256}
3bd1e081 257static inline
bec39940 258struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
df4f5a87 259 const char *name)
3bd1e081
MD
260{
261 return NULL;
262}
f6a9efaa 263
3bd1e081 264static inline
dec56f6c 265struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
3bd1e081
MD
266{
267 return NULL;
268}
269static inline
51755dc8
JG
270struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
271 enum lttng_domain_type domain)
3bd1e081
MD
272{
273 return NULL;
274}
275static inline
39687410 276enum lttng_error_code trace_ust_create_event(struct lttng_event *ev,
6b453b5e 277 const char *filter_expression,
561c6897 278 struct lttng_filter_bytecode *filter,
88f06f15 279 struct lttng_event_exclusion *exclusion,
39687410 280 bool internal_event, struct ltt_ust_event **ust_event)
3bd1e081 281{
39687410 282 return LTTNG_ERR_NO_UST;
3bd1e081 283}
3bd1e081
MD
284static inline
285void trace_ust_destroy_session(struct ltt_ust_session *session)
286{
287}
48842b30 288
3bd1e081
MD
289static inline
290void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
291{
292}
48842b30 293
3bd1e081
MD
294static inline
295void trace_ust_destroy_event(struct ltt_ust_event *event)
296{
297}
d070c424
MD
298
299static inline
300void trace_ust_free_session(struct ltt_ust_session *session)
301{
302}
303
34378f76
DG
304static inline
305struct ltt_ust_context *trace_ust_create_context(
df4f5a87 306 const struct lttng_event_context *ctx)
34378f76
DG
307{
308 return NULL;
309}
aa3514e9 310static inline
df4f5a87
JG
311int trace_ust_match_context(const struct ltt_ust_context *uctx,
312 const struct lttng_event_context *ctx)
aa3514e9
MD
313{
314 return 0;
315}
b953b8cd
PP
316static inline
317struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
2106efa0 318 char *name, struct lttng_filter_bytecode *filter,
b953b8cd
PP
319 enum lttng_ust_loglevel_type loglevel_type, int loglevel_value,
320 struct lttng_event_exclusion *exclusion)
37a86c61
DG
321{
322 return NULL;
323}
d5979e4a
DG
324static inline
325void trace_ust_delete_channel(struct lttng_ht *ht,
326 struct ltt_ust_channel *channel)
327{
328 return;
329}
fefd409b
DG
330static inline
331struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
332 enum lttng_domain_type domain_type)
333{
334 return NULL;
335}
55c9e7ca
JR
336static inline int trace_ust_track_id(enum lttng_tracker_type tracker_type,
337 struct ltt_ust_session *session,
4e6581a7 338 const struct lttng_tracker_id *id)
a9ad0c8f
MD
339{
340 return 0;
341}
55c9e7ca
JR
342static inline int trace_ust_untrack_id(enum lttng_tracker_type tracker_type,
343 struct ltt_ust_session *session,
344 const struct lttng_tracker_id *id)
a9ad0c8f
MD
345{
346 return 0;
347}
55c9e7ca
JR
348static inline int trace_ust_id_tracker_lookup(
349 enum lttng_tracker_type tracker_type,
350 struct ltt_ust_session *session,
351 int pid)
b4650bd0
MD
352{
353 return 0;
354}
a7a533cd 355static inline int trace_ust_list_tracker_ids(
55c9e7ca
JR
356 enum lttng_tracker_type tracker_type,
357 struct ltt_ust_session *session,
a7a533cd 358 struct lttng_tracker_ids **_ids)
a5dfbb9d
MD
359{
360 return -1;
361}
74d0b642 362#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 363
97ee3a89 364#endif /* _LTT_TRACE_UST_H */
This page took 0.124119 seconds and 4 git commands to generate.