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>
33 struct ltt_ust_ht_key
{
35 const struct lttng_filter_bytecode
*filter
;
36 enum lttng_ust_loglevel_type loglevel
;
37 const struct lttng_event_exclusion
*exclusion
;
40 /* Context hash table nodes */
41 struct ltt_ust_context
{
42 struct lttng_ust_context ctx
;
43 struct lttng_ht_node_ulong node
;
44 struct cds_list_head list
;
48 struct ltt_ust_event
{
50 struct lttng_ust_event attr
;
51 struct lttng_ht_node_str node
;
52 char *filter_expression
;
53 struct lttng_filter_bytecode
*filter
;
54 struct lttng_event_exclusion
*exclusion
;
59 struct ltt_ust_channel
{
60 uint64_t id
; /* unique id per session. */
63 * A UST channel can be part of a userspace sub-domain such as JUL,
66 enum lttng_domain_type domain
;
67 char name
[LTTNG_UST_SYM_NAME_LEN
];
68 struct lttng_ust_channel_attr attr
;
70 struct cds_list_head ctx_list
;
71 struct lttng_ht
*events
;
72 struct lttng_ht_node_str node
;
73 uint64_t tracefile_size
;
74 uint64_t tracefile_count
;
77 /* UST domain global (LTTNG_DOMAIN_UST) */
78 struct ltt_ust_domain_global
{
79 struct lttng_ht
*channels
;
80 struct cds_list_head registry_buffer_uid_list
;
83 struct ust_pid_tracker_node
{
84 struct lttng_ht_node_ulong node
;
87 struct ust_pid_tracker
{
92 struct ltt_ust_session
{
93 uint64_t id
; /* Unique identifier of session */
94 struct ltt_ust_domain_global domain_global
;
95 /* Hash table of agent indexed by agent domain. */
96 struct lttng_ht
*agents
;
97 /* UID/GID of the user owning the session */
100 /* Is the session active meaning has is been started or stopped. */
101 unsigned int active
:1;
102 struct consumer_output
*consumer
;
103 /* Sequence number for filters so the tracer knows the ordering. */
104 uint64_t filter_seq_num
;
105 /* This indicates which type of buffer this session is set for. */
106 enum lttng_buffer_type buffer_type
;
107 /* If set to 1, the buffer_type can not be changed anymore. */
108 int buffer_type_changed
;
109 /* For per UID buffer, every buffer reg object is kept of this session */
110 struct cds_list_head buffer_reg_uid_list
;
111 /* Next channel ID available for a newly registered channel. */
112 uint64_t next_channel_id
;
113 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
114 uint64_t used_channel_id
;
115 /* Tell or not if the session has to output the traces. */
116 unsigned int output_traces
;
117 unsigned int snapshot_mode
;
118 unsigned int has_non_default_channel
;
119 unsigned int live_timer_interval
; /* usec */
121 /* Metadata channel attributes. */
122 struct lttng_ust_channel_attr metadata_attr
;
125 * Path where to keep the shared memory files.
127 char root_shm_path
[PATH_MAX
];
128 char shm_path
[PATH_MAX
];
130 struct ust_pid_tracker pid_tracker
;
134 * Validate that the id has reached the maximum allowed or not.
136 * Return 0 if NOT else 1.
138 static inline int trace_ust_is_max_id(uint64_t id
)
140 return (id
== UINT64_MAX
) ? 1 : 0;
144 * Return next available channel id and increment the used counter. The
145 * trace_ust_is_max_id function MUST be called before in order to validate if
146 * the maximum number of IDs have been reached. If not, it is safe to call this
149 * Return a unique channel ID. If max is reached, the used_channel_id counter
152 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session
*s
)
154 if (trace_ust_is_max_id(s
->used_channel_id
)) {
155 return s
->used_channel_id
;
158 s
->used_channel_id
++;
159 return s
->next_channel_id
++;
162 #ifdef HAVE_LIBLTTNG_UST_CTL
164 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
);
165 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
169 * Lookup functions. NULL is returned if not found.
171 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
172 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
173 struct lttng_event_exclusion
*exclusion
);
174 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
176 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
177 enum lttng_domain_type domain_type
);
180 * Create functions malloc() the data structure.
182 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
);
183 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
184 enum lttng_domain_type domain
);
185 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
186 char *filter_expression
,
187 struct lttng_filter_bytecode
*filter
,
188 struct lttng_event_exclusion
*exclusion
,
189 bool internal_event
);
190 struct ltt_ust_context
*trace_ust_create_context(
191 struct lttng_event_context
*ctx
);
192 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
193 struct lttng_event_context
*ctx
);
194 void trace_ust_delete_channel(struct lttng_ht
*ht
,
195 struct ltt_ust_channel
*channel
);
198 * Destroy functions free() the data structure and remove from linked list if
201 void trace_ust_destroy_session(struct ltt_ust_session
*session
);
202 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
);
203 void trace_ust_destroy_event(struct ltt_ust_event
*event
);
205 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
);
206 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
);
208 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
);
210 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
213 #else /* HAVE_LIBLTTNG_UST_CTL */
215 static inline int trace_ust_ht_match_event(struct cds_lfht_node
*node
,
220 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
226 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
233 struct ltt_ust_session
*trace_ust_create_session(unsigned int session_id
)
238 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
,
239 enum lttng_domain_type domain
)
244 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
245 const char *filter_expression
,
246 struct lttng_filter_bytecode
*filter
,
247 struct lttng_event_exclusion
*exclusion
,
253 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
258 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
263 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
267 struct ltt_ust_context
*trace_ust_create_context(
268 struct lttng_event_context
*ctx
)
273 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
274 struct lttng_event_context
*ctx
)
278 static inline struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
279 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
280 struct lttng_event_exclusion
*exclusion
)
285 void trace_ust_delete_channel(struct lttng_ht
*ht
,
286 struct ltt_ust_channel
*channel
)
291 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
292 enum lttng_domain_type domain_type
)
297 int trace_ust_track_pid(struct ltt_ust_session
*session
, int pid
)
302 int trace_ust_untrack_pid(struct ltt_ust_session
*session
, int pid
)
307 int trace_ust_pid_tracker_lookup(struct ltt_ust_session
*session
, int pid
)
312 ssize_t
trace_ust_list_tracker_pids(struct ltt_ust_session
*session
,
317 #endif /* HAVE_LIBLTTNG_UST_CTL */
319 #endif /* _LTT_TRACE_UST_H */