2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
18 #ifndef _LTT_TRACE_UST_H
19 #define _LTT_TRACE_UST_H
22 #include <urcu/list.h>
24 #include <lttng/lttng.h>
25 #include <common/hashtable/hashtable.h>
26 #include <common/defaults.h>
33 struct ltt_ust_ht_key
{
35 const struct lttng_filter_bytecode
*filter
;
36 enum lttng_ust_loglevel_type loglevel_type
;
38 const struct lttng_event_exclusion
*exclusion
;
41 /* Context hash table nodes */
42 struct ltt_ust_context
{
43 struct lttng_ust_context ctx
;
44 struct lttng_ht_node_ulong node
;
45 struct cds_list_head list
;
49 struct ltt_ust_event
{
51 struct lttng_ust_event attr
;
52 struct lttng_ht_node_str node
;
53 char *filter_expression
;
54 struct lttng_filter_bytecode
*filter
;
55 struct lttng_event_exclusion
*exclusion
;
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.
66 struct ltt_ust_channel
{
67 uint64_t id
; /* unique id per session. */
70 * A UST channel can be part of a userspace sub-domain such as JUL,
73 enum lttng_domain_type domain
;
74 char name
[LTTNG_UST_SYM_NAME_LEN
];
75 struct lttng_ust_channel_attr attr
;
77 struct cds_list_head ctx_list
;
78 struct lttng_ht
*events
;
79 struct lttng_ht_node_str node
;
80 uint64_t tracefile_size
;
81 uint64_t tracefile_count
;
84 /* UST domain global (LTTNG_DOMAIN_UST) */
85 struct ltt_ust_domain_global
{
86 struct lttng_ht
*channels
;
87 struct cds_list_head registry_buffer_uid_list
;
90 struct ust_pid_tracker_node
{
91 struct lttng_ht_node_ulong node
;
94 struct ust_pid_tracker
{
99 struct ltt_ust_session
{
100 uint64_t id
; /* Unique identifier of session */
101 struct ltt_ust_domain_global domain_global
;
102 /* Hash table of agent indexed by agent domain. */
103 struct lttng_ht
*agents
;
104 /* UID/GID of the user owning the session */
107 /* Is the session active meaning has is been started or stopped. */
108 unsigned int active
:1;
109 struct consumer_output
*consumer
;
110 /* Sequence number for filters so the tracer knows the ordering. */
111 uint64_t filter_seq_num
;
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
;
122 /* Tell or not if the session has to output the traces. */
123 unsigned int output_traces
;
124 unsigned int snapshot_mode
;
125 unsigned int has_non_default_channel
;
126 unsigned int live_timer_interval
; /* usec */
128 /* Metadata channel attributes. */
129 struct lttng_ust_channel_attr metadata_attr
;
132 * Path where to keep the shared memory files.
134 char root_shm_path
[PATH_MAX
];
135 char shm_path
[PATH_MAX
];
137 struct ust_pid_tracker pid_tracker
;
141 * Validate that the id has reached the maximum allowed or not.
143 * Return 0 if NOT else 1.
145 static inline int trace_ust_is_max_id(uint64_t id
)
147 return (id
== UINT64_MAX
) ? 1 : 0;
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
156 * Return a unique channel ID. If max is reached, the used_channel_id counter
159 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session
*s
)
161 if (trace_ust_is_max_id(s
->used_channel_id
)) {
162 return s
->used_channel_id
;
165 s
->used_channel_id
++;
166 return s
->next_channel_id
++;
169 #ifdef HAVE_LIBLTTNG_UST_CTL
171 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
);
172 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
176 * Lookup functions. NULL is returned if not found.
178 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
179 char *name
, struct lttng_filter_bytecode
*filter
,
180 enum lttng_ust_loglevel_type loglevel_type
, int loglevel_value
,
181 struct lttng_event_exclusion
*exclusion
);
182 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
184 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
185 enum lttng_domain_type domain_type
);
188 * Create functions malloc() the data structure.
190 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
);
191 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
192 enum lttng_domain_type domain
);
193 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
194 char *filter_expression
,
195 struct lttng_filter_bytecode
*filter
,
196 struct lttng_event_exclusion
*exclusion
,
197 bool internal_event
);
198 struct ltt_ust_context
*trace_ust_create_context(
199 struct lttng_event_context
*ctx
);
200 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
201 struct lttng_event_context
*ctx
);
202 void trace_ust_delete_channel(struct lttng_ht
*ht
,
203 struct ltt_ust_channel
*channel
);
206 * Destroy functions free() the data structure and remove from linked list if
209 void trace_ust_destroy_session(struct ltt_ust_session
*session
);
210 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
);
211 void trace_ust_destroy_event(struct ltt_ust_event
*event
);
213 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
);
214 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
);
216 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
);
218 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
221 #else /* HAVE_LIBLTTNG_UST_CTL */
223 static inline int trace_ust_ht_match_event(struct cds_lfht_node
*node
,
228 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
234 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
241 struct ltt_ust_session
*trace_ust_create_session(unsigned int session_id
)
246 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
247 enum lttng_domain_type domain
)
252 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
253 const char *filter_expression
,
254 struct lttng_filter_bytecode
*filter
,
255 struct lttng_event_exclusion
*exclusion
,
261 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
266 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
271 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
275 struct ltt_ust_context
*trace_ust_create_context(
276 struct lttng_event_context
*ctx
)
281 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
282 struct lttng_event_context
*ctx
)
287 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
288 char *name
, struct lttng_filter_bytecode
*filter
,
289 enum lttng_ust_loglevel_type loglevel_type
, int loglevel_value
,
290 struct lttng_event_exclusion
*exclusion
)
295 void trace_ust_delete_channel(struct lttng_ht
*ht
,
296 struct ltt_ust_channel
*channel
)
301 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
302 enum lttng_domain_type domain_type
)
307 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
)
312 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
)
317 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
)
322 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
327 #endif /* HAVE_LIBLTTNG_UST_CTL */
329 #endif /* _LTT_TRACE_UST_H */