Tests: kernel wildcards
[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 109 struct consumer_output *consumer;
f3f0db50
DG
110 /* Sequence number for filters so the tracer knows the ordering. */
111 uint64_t filter_seq_num;
7972aab2
DG
112 /* This indicates which type of buffer this session is set for. */
113 enum lttng_buffer_type buffer_type;
114 /* If set to 1, the buffer_type can not be changed anymore. */
115 int buffer_type_changed;
116 /* For per UID buffer, every buffer reg object is kept of this session */
117 struct cds_list_head buffer_reg_uid_list;
118 /* Next channel ID available for a newly registered channel. */
119 uint64_t next_channel_id;
120 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
121 uint64_t used_channel_id;
2bba9e53
DG
122 /* Tell or not if the session has to output the traces. */
123 unsigned int output_traces;
27babd3a 124 unsigned int snapshot_mode;
85076754 125 unsigned int has_non_default_channel;
ecc48a90 126 unsigned int live_timer_interval; /* usec */
84ad93e8
DG
127
128 /* Metadata channel attributes. */
129 struct lttng_ust_channel_attr metadata_attr;
d7ba1388
MD
130
131 /*
132 * Path where to keep the shared memory files.
133 */
3d071855 134 char root_shm_path[PATH_MAX];
d7ba1388 135 char shm_path[PATH_MAX];
a9ad0c8f
MD
136
137 struct ust_pid_tracker pid_tracker;
97ee3a89
DG
138};
139
7972aab2
DG
140/*
141 * Validate that the id has reached the maximum allowed or not.
142 *
143 * Return 0 if NOT else 1.
144 */
145static inline int trace_ust_is_max_id(uint64_t id)
146{
147 return (id == UINT64_MAX) ? 1 : 0;
148}
149
150/*
151 * Return next available channel id and increment the used counter. The
152 * trace_ust_is_max_id function MUST be called before in order to validate if
153 * the maximum number of IDs have been reached. If not, it is safe to call this
154 * function.
155 *
156 * Return a unique channel ID. If max is reached, the used_channel_id counter
157 * is returned.
158 */
159static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
160{
161 if (trace_ust_is_max_id(s->used_channel_id)) {
162 return s->used_channel_id;
163 }
164
165 s->used_channel_id++;
166 return s->next_channel_id++;
167}
168
74d0b642 169#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 170
18eace3b
DG
171int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
172int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
173 const void *_key);
174
97ee3a89
DG
175/*
176 * Lookup functions. NULL is returned if not found.
177 */
18eace3b 178struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
179 char *name, struct lttng_filter_bytecode *filter, int loglevel,
180 struct lttng_event_exclusion *exclusion);
bec39940 181struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 182 char *name);
fefd409b
DG
183struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
184 enum lttng_domain_type domain_type);
97ee3a89
DG
185
186/*
187 * Create functions malloc() the data structure.
188 */
d9bf3ca4 189struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
51755dc8
JG
190struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
191 enum lttng_domain_type domain);
025faf73 192struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 193 char *filter_expression,
561c6897 194 struct lttng_filter_bytecode *filter,
88f06f15
JG
195 struct lttng_event_exclusion *exclusion,
196 bool internal_event);
55cc08a6
DG
197struct ltt_ust_context *trace_ust_create_context(
198 struct lttng_event_context *ctx);
aa3514e9
MD
199int trace_ust_match_context(struct ltt_ust_context *uctx,
200 struct lttng_event_context *ctx);
d5979e4a
DG
201void trace_ust_delete_channel(struct lttng_ht *ht,
202 struct ltt_ust_channel *channel);
97ee3a89
DG
203
204/*
205 * Destroy functions free() the data structure and remove from linked list if
206 * it's applies.
207 */
208void trace_ust_destroy_session(struct ltt_ust_session *session);
97ee3a89
DG
209void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
210void trace_ust_destroy_event(struct ltt_ust_event *event);
211
a9ad0c8f
MD
212int trace_ust_track_pid(struct ltt_ust_session *session, int pid);
213int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid);
214
b4650bd0
MD
215int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid);
216
a5dfbb9d
MD
217ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
218 int32_t **_pids);
219
74d0b642 220#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 221
37a86c61
DG
222static inline int trace_ust_ht_match_event(struct cds_lfht_node *node,
223 const void *_key)
224{
225 return 0;
226}
227static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
228 const void *_key)
229{
230 return 0;
231}
3bd1e081 232static inline
bec39940 233struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
f6a9efaa 234 char *name)
3bd1e081
MD
235{
236 return NULL;
237}
f6a9efaa 238
3bd1e081 239static inline
dec56f6c 240struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
3bd1e081
MD
241{
242 return NULL;
243}
244static inline
51755dc8
JG
245struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
246 enum lttng_domain_type domain)
3bd1e081
MD
247{
248 return NULL;
249}
250static inline
025faf73 251struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
6b453b5e 252 const char *filter_expression,
561c6897 253 struct lttng_filter_bytecode *filter,
88f06f15
JG
254 struct lttng_event_exclusion *exclusion,
255 bool internal_event)
3bd1e081
MD
256{
257 return NULL;
258}
3bd1e081
MD
259static inline
260void trace_ust_destroy_session(struct ltt_ust_session *session)
261{
262}
48842b30 263
3bd1e081
MD
264static inline
265void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
266{
267}
48842b30 268
3bd1e081
MD
269static inline
270void trace_ust_destroy_event(struct ltt_ust_event *event)
271{
272}
34378f76
DG
273static inline
274struct ltt_ust_context *trace_ust_create_context(
275 struct lttng_event_context *ctx)
276{
277 return NULL;
278}
aa3514e9
MD
279static inline
280int trace_ust_match_context(struct ltt_ust_context *uctx,
281 struct lttng_event_context *ctx)
282{
283 return 0;
284}
37a86c61 285static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
10646003
JI
286 char *name, struct lttng_filter_bytecode *filter, int loglevel,
287 struct lttng_event_exclusion *exclusion)
37a86c61
DG
288{
289 return NULL;
290}
d5979e4a
DG
291static inline
292void trace_ust_delete_channel(struct lttng_ht *ht,
293 struct ltt_ust_channel *channel)
294{
295 return;
296}
fefd409b
DG
297static inline
298struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
299 enum lttng_domain_type domain_type)
300{
301 return NULL;
302}
a9ad0c8f
MD
303static inline
304int trace_ust_track_pid(struct ltt_ust_session *session, int pid)
305{
306 return 0;
307}
308static inline
309int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
310{
311 return 0;
312}
b4650bd0
MD
313static inline
314int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
315{
316 return 0;
317}
3646a051 318static inline
a5dfbb9d
MD
319ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
320 int32_t **_pids)
321{
322 return -1;
323}
74d0b642 324#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 325
97ee3a89 326#endif /* _LTT_TRACE_UST_H */
This page took 0.05614 seconds and 4 git commands to generate.