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