2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
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.
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.
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.
19 #ifndef _LTT_TRACE_UST_H
20 #define _LTT_TRACE_UST_H
23 #include <urcu/list.h>
25 #include <lttng/lttng.h>
26 #include <common/hashtable/hashtable.h>
27 #include <common/defaults.h>
30 #include "lttng-ust-ctl.h"
34 struct ltt_ust_ht_key
{
36 const struct lttng_filter_bytecode
*filter
;
37 enum lttng_ust_loglevel_type loglevel_type
;
39 const struct lttng_event_exclusion
*exclusion
;
42 /* Context hash table nodes */
43 struct ltt_ust_context
{
44 struct lttng_ust_context_attr ctx
;
45 struct lttng_ht_node_ulong node
;
46 struct cds_list_head list
;
50 struct ltt_ust_event
{
52 struct lttng_ust_event attr
;
53 struct lttng_ht_node_str node
;
54 char *filter_expression
;
55 struct lttng_filter_bytecode
*filter
;
56 struct lttng_event_exclusion
*exclusion
;
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.
67 struct ltt_ust_channel
{
68 uint64_t id
; /* unique id per session. */
71 * A UST channel can be part of a userspace sub-domain such as JUL,
74 enum lttng_domain_type domain
;
75 char name
[LTTNG_UST_SYM_NAME_LEN
];
76 struct lttng_ust_channel_attr attr
;
78 struct cds_list_head ctx_list
;
79 struct lttng_ht
*events
;
80 struct lttng_ht_node_str node
;
81 uint64_t tracefile_size
;
82 uint64_t tracefile_count
;
83 uint64_t per_pid_closed_app_discarded
;
84 uint64_t per_pid_closed_app_lost
;
85 uint64_t monitor_timer_interval
;
88 /* UST domain global (LTTNG_DOMAIN_UST) */
89 struct ltt_ust_domain_global
{
90 struct lttng_ht
*channels
;
91 struct cds_list_head registry_buffer_uid_list
;
94 struct ust_pid_tracker_node
{
95 struct lttng_ht_node_ulong node
;
98 struct ust_pid_tracker
{
103 struct ltt_ust_session
{
104 uint64_t id
; /* Unique identifier of session */
105 struct ltt_ust_domain_global domain_global
;
106 /* Hash table of agent indexed by agent domain. */
107 struct lttng_ht
*agents
;
108 /* UID/GID of the user owning the session */
111 /* Is the session active meaning has is been started or stopped. */
112 unsigned int active
:1;
113 struct consumer_output
*consumer
;
114 /* Sequence number for filters so the tracer knows the ordering. */
115 uint64_t filter_seq_num
;
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
;
126 /* Tell or not if the session has to output the traces. */
127 unsigned int output_traces
;
128 unsigned int snapshot_mode
;
129 unsigned int has_non_default_channel
;
130 unsigned int live_timer_interval
; /* usec */
132 /* Metadata channel attributes. */
133 struct lttng_ust_channel_attr metadata_attr
;
136 * Path where to keep the shared memory files.
138 char root_shm_path
[PATH_MAX
];
139 char shm_path
[PATH_MAX
];
141 struct ust_pid_tracker pid_tracker
;
143 /* Current trace chunk of the ltt_session. */
144 struct lttng_trace_chunk
*current_trace_chunk
;
148 * Validate that the id has reached the maximum allowed or not.
150 * Return 0 if NOT else 1.
152 static inline int trace_ust_is_max_id(uint64_t id
)
154 return (id
== UINT64_MAX
) ? 1 : 0;
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
163 * Return a unique channel ID. If max is reached, the used_channel_id counter
166 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session
*s
)
168 if (trace_ust_is_max_id(s
->used_channel_id
)) {
169 return s
->used_channel_id
;
172 s
->used_channel_id
++;
173 return s
->next_channel_id
++;
176 #ifdef HAVE_LIBLTTNG_UST_CTL
178 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
);
179 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
183 * Lookup functions. NULL is returned if not found.
185 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
186 char *name
, struct lttng_filter_bytecode
*filter
,
187 enum lttng_ust_loglevel_type loglevel_type
, int loglevel_value
,
188 struct lttng_event_exclusion
*exclusion
);
189 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
191 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
192 enum lttng_domain_type domain_type
);
195 * Create functions malloc() the data structure.
197 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
);
198 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
199 enum lttng_domain_type domain
);
200 enum lttng_error_code
trace_ust_create_event(struct lttng_event
*ev
,
201 char *filter_expression
,
202 struct lttng_filter_bytecode
*filter
,
203 struct lttng_event_exclusion
*exclusion
,
204 bool internal_event
, struct ltt_ust_event
**ust_event
);
205 struct ltt_ust_context
*trace_ust_create_context(
206 const struct lttng_event_context
*ctx
);
207 int trace_ust_match_context(const struct ltt_ust_context
*uctx
,
208 const struct lttng_event_context
*ctx
);
209 void trace_ust_delete_channel(struct lttng_ht
*ht
,
210 struct ltt_ust_channel
*channel
);
213 * Destroy functions free() the data structure and remove from linked list if
216 void trace_ust_destroy_session(struct ltt_ust_session
*session
);
217 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
);
218 void trace_ust_destroy_event(struct ltt_ust_event
*event
);
219 void trace_ust_destroy_context(struct ltt_ust_context
*ctx
);
220 void trace_ust_free_session(struct ltt_ust_session
*session
);
222 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
);
223 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
);
225 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
);
227 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
230 #else /* HAVE_LIBLTTNG_UST_CTL */
232 static inline int trace_ust_ht_match_event(struct cds_lfht_node
*node
,
237 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
243 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
250 struct ltt_ust_session
*trace_ust_create_session(unsigned int session_id
)
255 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
256 enum lttng_domain_type domain
)
261 enum lttng_error_code
trace_ust_create_event(struct lttng_event
*ev
,
262 const char *filter_expression
,
263 struct lttng_filter_bytecode
*filter
,
264 struct lttng_event_exclusion
*exclusion
,
265 bool internal_event
, struct ltt_ust_event
**ust_event
)
267 return LTTNG_ERR_NO_UST
;
270 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
275 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
280 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
285 void trace_ust_free_session(struct ltt_ust_session
*session
)
290 struct ltt_ust_context
*trace_ust_create_context(
291 const struct lttng_event_context
*ctx
)
296 int trace_ust_match_context(const struct ltt_ust_context
*uctx
,
297 const struct lttng_event_context
*ctx
)
302 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
303 char *name
, struct lttng_filter_bytecode
*filter
,
304 enum lttng_ust_loglevel_type loglevel_type
, int loglevel_value
,
305 struct lttng_event_exclusion
*exclusion
)
310 void trace_ust_delete_channel(struct lttng_ht
*ht
,
311 struct ltt_ust_channel
*channel
)
316 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
317 enum lttng_domain_type domain_type
)
322 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
)
327 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
)
332 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
)
337 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
342 #endif /* HAVE_LIBLTTNG_UST_CTL */
344 #endif /* _LTT_TRACE_UST_H */