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
23 #include <urcu/list.h>
25 #include <lttng/lttng.h>
26 #include <common/hashtable/hashtable.h>
27 #include <common/defaults.h>
34 struct ltt_ust_ht_key
{
36 const struct lttng_filter_bytecode
*filter
;
37 enum lttng_ust_loglevel_type loglevel
;
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_ust_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. */
69 char name
[LTTNG_UST_SYM_NAME_LEN
];
70 struct lttng_ust_channel_attr attr
;
72 struct cds_list_head ctx_list
;
73 struct lttng_ht
*events
;
74 struct lttng_ht_node_str node
;
75 uint64_t tracefile_size
;
76 uint64_t tracefile_count
;
79 /* UST domain global (LTTNG_DOMAIN_UST) */
80 struct ltt_ust_domain_global
{
81 struct lttng_ht
*channels
;
82 struct cds_list_head registry_buffer_uid_list
;
85 struct ust_pid_tracker_node
{
86 struct lttng_ht_node_ulong node
;
89 struct ust_pid_tracker
{
94 struct ltt_ust_session
{
95 uint64_t id
; /* Unique identifier of session */
96 struct ltt_ust_domain_global domain_global
;
97 /* Hash table of agent indexed by agent domain. */
98 struct lttng_ht
*agents
;
99 /* UID/GID of the user owning the session */
102 /* Is the session active meaning has is been started or stopped. */
103 unsigned int active
:1;
105 * Two consumer_output object are needed where one is for the current
106 * output object and the second one is the temporary object used to store
107 * URI being set by the lttng_set_consumer_uri call. Once
108 * lttng_enable_consumer is called, the two pointers are swapped.
110 struct consumer_output
*consumer
;
111 struct consumer_output
*tmp_consumer
;
112 /* Sequence number for filters so the tracer knows the ordering. */
113 uint64_t filter_seq_num
;
114 /* This indicates which type of buffer this session is set for. */
115 enum lttng_buffer_type buffer_type
;
116 /* If set to 1, the buffer_type can not be changed anymore. */
117 int buffer_type_changed
;
118 /* For per UID buffer, every buffer reg object is kept of this session */
119 struct cds_list_head buffer_reg_uid_list
;
120 /* Next channel ID available for a newly registered channel. */
121 uint64_t next_channel_id
;
122 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
123 uint64_t used_channel_id
;
124 /* Tell or not if the session has to output the traces. */
125 unsigned int output_traces
;
126 unsigned int snapshot_mode
;
127 unsigned int has_non_default_channel
;
128 unsigned int live_timer_interval
; /* usec */
130 /* Metadata channel attributes. */
131 struct lttng_ust_channel_attr metadata_attr
;
134 * Path where to keep the shared memory files.
136 char root_shm_path
[PATH_MAX
];
137 char shm_path
[PATH_MAX
];
139 struct ust_pid_tracker pid_tracker
;
143 * Validate that the id has reached the maximum allowed or not.
145 * Return 0 if NOT else 1.
147 static inline int trace_ust_is_max_id(uint64_t id
)
149 return (id
== UINT64_MAX
) ? 1 : 0;
153 * Return next available channel id and increment the used counter. The
154 * trace_ust_is_max_id function MUST be called before in order to validate if
155 * the maximum number of IDs have been reached. If not, it is safe to call this
158 * Return a unique channel ID. If max is reached, the used_channel_id counter
161 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session
*s
)
163 if (trace_ust_is_max_id(s
->used_channel_id
)) {
164 return s
->used_channel_id
;
167 s
->used_channel_id
++;
168 return s
->next_channel_id
++;
171 #ifdef HAVE_LIBLTTNG_UST_CTL
173 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
);
174 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
178 * Lookup functions. NULL is returned if not found.
180 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
181 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
182 struct lttng_event_exclusion
*exclusion
);
183 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
185 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
186 enum lttng_domain_type domain_type
);
189 * Create functions malloc() the data structure.
191 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
);
192 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
);
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
)
251 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
252 const char *filter_expression
,
253 struct lttng_filter_bytecode
*filter
,
254 struct lttng_event_exclusion
*exclusion
,
260 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
265 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
270 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
274 struct ltt_ust_context
*trace_ust_create_context(
275 struct lttng_event_context
*ctx
)
280 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
281 struct lttng_event_context
*ctx
)
285 static inline struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
286 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
287 struct lttng_event_exclusion
*exclusion
)
292 void trace_ust_delete_channel(struct lttng_ht
*ht
,
293 struct ltt_ust_channel
*channel
)
298 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
299 enum lttng_domain_type domain_type
)
304 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
)
309 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
)
314 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
)
319 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
324 #endif /* HAVE_LIBLTTNG_UST_CTL */
326 #endif /* _LTT_TRACE_UST_H */