Save filter expression as part of agent events and save them
[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"
48842b30 30#include "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;
37 enum lttng_ust_loglevel_type loglevel;
7724731b 38 const struct lttng_event_exclusion *exclusion;
18eace3b
DG
39};
40
f6a9efaa
DG
41/* Context hash table nodes */
42struct ltt_ust_context {
43 struct lttng_ust_context ctx;
bec39940 44 struct lttng_ht_node_ulong node;
31746f93 45 struct cds_list_head list;
97ee3a89
DG
46};
47
48/* UST event */
49struct ltt_ust_event {
37357452 50 unsigned int enabled;
f6a9efaa 51 struct lttng_ust_event attr;
bec39940 52 struct lttng_ht_node_str node;
6b453b5e 53 char *filter_expression;
51755dc8 54 struct lttng_filter_bytecode *filter;
40024f8a 55 struct lttng_event_exclusion *exclusion;
5b37cc51
JG
56 /*
57 * An internal event is an event which was created by the session daemon
58 * through which, for example, events emitted in Agent domains are
59 * "funelled". This is used to hide internal events from external
60 * clients as they should never be modified by the external world.
61 */
88f06f15 62 bool internal;
2bdd86d4
MD
63};
64
97ee3a89
DG
65/* UST channel */
66struct ltt_ust_channel {
7972aab2 67 uint64_t id; /* unique id per session. */
37357452 68 unsigned int enabled;
51755dc8
JG
69 /*
70 * A UST channel can be part of a userspace sub-domain such as JUL,
71 * Log4j, Python.
72 */
73 enum lttng_domain_type domain;
44d3bd01 74 char name[LTTNG_UST_SYM_NAME_LEN];
ffe60014 75 struct lttng_ust_channel_attr attr;
bec39940 76 struct lttng_ht *ctx;
31746f93 77 struct cds_list_head ctx_list;
bec39940
DG
78 struct lttng_ht *events;
79 struct lttng_ht_node_str node;
1624d5b7
JD
80 uint64_t tracefile_size;
81 uint64_t tracefile_count;
97ee3a89
DG
82};
83
f6a9efaa
DG
84/* UST domain global (LTTNG_DOMAIN_UST) */
85struct ltt_ust_domain_global {
bec39940 86 struct lttng_ht *channels;
7972aab2 87 struct cds_list_head registry_buffer_uid_list;
f6a9efaa
DG
88};
89
a9ad0c8f
MD
90struct ust_pid_tracker_node {
91 struct lttng_ht_node_ulong node;
92};
93
94struct ust_pid_tracker {
95 struct lttng_ht *ht;
96};
97
97ee3a89
DG
98/* UST session */
99struct ltt_ust_session {
d9bf3ca4 100 uint64_t id; /* Unique identifier of session */
f6a9efaa 101 struct ltt_ust_domain_global domain_global;
fefd409b
DG
102 /* Hash table of agent indexed by agent domain. */
103 struct lttng_ht *agents;
6df2e2c9
MD
104 /* UID/GID of the user owning the session */
105 uid_t uid;
106 gid_t gid;
14fb1ebe
DG
107 /* Is the session active meaning has is been started or stopped. */
108 unsigned int active:1;
00e2e675
DG
109 /*
110 * Two consumer_output object are needed where one is for the current
111 * output object and the second one is the temporary object used to store
112 * URI being set by the lttng_set_consumer_uri call. Once
113 * lttng_enable_consumer is called, the two pointers are swapped.
114 */
115 struct consumer_output *consumer;
116 struct consumer_output *tmp_consumer;
f3f0db50
DG
117 /* Sequence number for filters so the tracer knows the ordering. */
118 uint64_t filter_seq_num;
7972aab2
DG
119 /* This indicates which type of buffer this session is set for. */
120 enum lttng_buffer_type buffer_type;
121 /* If set to 1, the buffer_type can not be changed anymore. */
122 int buffer_type_changed;
123 /* For per UID buffer, every buffer reg object is kept of this session */
124 struct cds_list_head buffer_reg_uid_list;
125 /* Next channel ID available for a newly registered channel. */
126 uint64_t next_channel_id;
127 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
128 uint64_t used_channel_id;
2bba9e53
DG
129 /* Tell or not if the session has to output the traces. */
130 unsigned int output_traces;
27babd3a 131 unsigned int snapshot_mode;
85076754 132 unsigned int has_non_default_channel;
ecc48a90 133 unsigned int live_timer_interval; /* usec */
84ad93e8
DG
134
135 /* Metadata channel attributes. */
136 struct lttng_ust_channel_attr metadata_attr;
d7ba1388
MD
137
138 /*
139 * Path where to keep the shared memory files.
140 */
3d071855 141 char root_shm_path[PATH_MAX];
d7ba1388 142 char shm_path[PATH_MAX];
a9ad0c8f
MD
143
144 struct ust_pid_tracker pid_tracker;
97ee3a89
DG
145};
146
7972aab2
DG
147/*
148 * Validate that the id has reached the maximum allowed or not.
149 *
150 * Return 0 if NOT else 1.
151 */
152static inline int trace_ust_is_max_id(uint64_t id)
153{
154 return (id == UINT64_MAX) ? 1 : 0;
155}
156
157/*
158 * Return next available channel id and increment the used counter. The
159 * trace_ust_is_max_id function MUST be called before in order to validate if
160 * the maximum number of IDs have been reached. If not, it is safe to call this
161 * function.
162 *
163 * Return a unique channel ID. If max is reached, the used_channel_id counter
164 * is returned.
165 */
166static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
167{
168 if (trace_ust_is_max_id(s->used_channel_id)) {
169 return s->used_channel_id;
170 }
171
172 s->used_channel_id++;
173 return s->next_channel_id++;
174}
175
74d0b642 176#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 177
18eace3b
DG
178int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
179int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
180 const void *_key);
181
97ee3a89
DG
182/*
183 * Lookup functions. NULL is returned if not found.
184 */
18eace3b 185struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
186 char *name, struct lttng_filter_bytecode *filter, int loglevel,
187 struct lttng_event_exclusion *exclusion);
bec39940 188struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 189 char *name);
fefd409b
DG
190struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
191 enum lttng_domain_type domain_type);
97ee3a89
DG
192
193/*
194 * Create functions malloc() the data structure.
195 */
d9bf3ca4 196struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
51755dc8
JG
197struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
198 enum lttng_domain_type domain);
025faf73 199struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 200 char *filter_expression,
561c6897 201 struct lttng_filter_bytecode *filter,
88f06f15
JG
202 struct lttng_event_exclusion *exclusion,
203 bool internal_event);
55cc08a6
DG
204struct ltt_ust_context *trace_ust_create_context(
205 struct lttng_event_context *ctx);
aa3514e9
MD
206int trace_ust_match_context(struct ltt_ust_context *uctx,
207 struct lttng_event_context *ctx);
d5979e4a
DG
208void trace_ust_delete_channel(struct lttng_ht *ht,
209 struct ltt_ust_channel *channel);
97ee3a89
DG
210
211/*
212 * Destroy functions free() the data structure and remove from linked list if
213 * it's applies.
214 */
215void trace_ust_destroy_session(struct ltt_ust_session *session);
97ee3a89
DG
216void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
217void trace_ust_destroy_event(struct ltt_ust_event *event);
218
a9ad0c8f
MD
219int trace_ust_track_pid(struct ltt_ust_session *session, int pid);
220int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid);
221
b4650bd0
MD
222int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid);
223
a5dfbb9d
MD
224ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
225 int32_t **_pids);
226
74d0b642 227#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 228
37a86c61
DG
229static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
230 const void *_key)
231{
232 return 0;
233}
234static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
235 const void *_key)
236{
237 return 0;
238}
3bd1e081 239static inline
bec39940 240struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 241 char *name)
3bd1e081
MD
242{
243 return NULL;
244}
f6a9efaa 245
3bd1e081 246static inline
dec56f6c 247struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
3bd1e081
MD
248{
249 return NULL;
250}
251static inline
51755dc8
JG
252struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
253 enum lttng_domain_type domain)
3bd1e081
MD
254{
255 return NULL;
256}
257static inline
025faf73 258struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 259 const char *filter_expression,
561c6897 260 struct lttng_filter_bytecode *filter,
88f06f15
JG
261 struct lttng_event_exclusion *exclusion,
262 bool internal_event)
3bd1e081
MD
263{
264 return NULL;
265}
3bd1e081
MD
266static inline
267void trace_ust_destroy_session(struct ltt_ust_session *session)
268{
269}
48842b30 270
3bd1e081
MD
271static inline
272void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
273{
274}
48842b30 275
3bd1e081
MD
276static inline
277void trace_ust_destroy_event(struct ltt_ust_event *event)
278{
279}
34378f76
DG
280static inline
281struct ltt_ust_context *trace_ust_create_context(
282 struct lttng_event_context *ctx)
283{
284 return NULL;
285}
aa3514e9
MD
286static inline
287int trace_ust_match_context(struct ltt_ust_context *uctx,
288 struct lttng_event_context *ctx)
289{
290 return 0;
291}
37a86c61 292static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
293 char *name, struct lttng_filter_bytecode *filter, int loglevel,
294 struct lttng_event_exclusion *exclusion)
37a86c61
DG
295{
296 return NULL;
297}
d5979e4a
DG
298static inline
299void trace_ust_delete_channel(struct lttng_ht *ht,
300 struct ltt_ust_channel *channel)
301{
302 return;
303}
fefd409b
DG
304static inline
305struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
306 enum lttng_domain_type domain_type)
307{
308 return NULL;
309}
a9ad0c8f
MD
310static inline
311int trace_ust_track_pid(struct ltt_ust_session *session, int pid)
312{
313 return 0;
314}
315static inline
316int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
317{
318 return 0;
319}
b4650bd0
MD
320static inline
321int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
322{
323 return 0;
324}
3646a051 325static inline
a5dfbb9d
MD
326ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
327 int32_t **_pids)
328{
329 return -1;
330}
74d0b642 331#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 332
97ee3a89 333#endif /* _LTT_TRACE_UST_H */
This page took 0.059372 seconds and 4 git commands to generate.