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>
32 struct ltt_ust_ht_key
{
34 const struct lttng_filter_bytecode
*filter
;
35 enum lttng_ust_loglevel_type loglevel
;
38 /* Context hash table nodes */
39 struct ltt_ust_context
{
40 struct lttng_ust_context ctx
;
41 struct lttng_ht_node_ulong node
;
45 struct ltt_ust_event
{
47 struct lttng_ust_event attr
;
48 struct lttng_ht_node_str node
;
49 struct lttng_ust_filter_bytecode
*filter
;
53 struct ltt_ust_channel
{
54 uint64_t id
; /* unique id per session. */
56 char name
[LTTNG_UST_SYM_NAME_LEN
];
57 struct lttng_ust_channel_attr attr
;
59 struct lttng_ht
*events
;
60 struct lttng_ht_node_str node
;
61 uint64_t tracefile_size
;
62 uint64_t tracefile_count
;
66 struct ltt_ust_metadata
{
68 struct lttng_ust_object_data
*obj
;
69 char pathname
[PATH_MAX
]; /* Trace file path name */
70 struct lttng_ust_channel_attr attr
;
71 struct lttng_ust_object_data
*stream_obj
;
74 /* UST domain global (LTTNG_DOMAIN_UST) */
75 struct ltt_ust_domain_global
{
76 struct lttng_ht
*channels
;
77 struct cds_list_head registry_buffer_uid_list
;
81 struct ltt_ust_session
{
82 uint64_t id
; /* Unique identifier of session */
84 struct ltt_ust_domain_global domain_global
;
85 /* UID/GID of the user owning the session */
89 * Two consumer_output object are needed where one is for the current
90 * output object and the second one is the temporary object used to store
91 * URI being set by the lttng_set_consumer_uri call. Once
92 * lttng_enable_consumer is called, the two pointers are swapped.
94 struct consumer_output
*consumer
;
95 struct consumer_output
*tmp_consumer
;
96 /* Sequence number for filters so the tracer knows the ordering. */
97 uint64_t filter_seq_num
;
98 /* This indicates which type of buffer this session is set for. */
99 enum lttng_buffer_type buffer_type
;
100 /* If set to 1, the buffer_type can not be changed anymore. */
101 int buffer_type_changed
;
102 /* For per UID buffer, every buffer reg object is kept of this session */
103 struct cds_list_head buffer_reg_uid_list
;
104 /* Next channel ID available for a newly registered channel. */
105 uint64_t next_channel_id
;
106 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
107 uint64_t used_channel_id
;
108 /* Tell or not if the session has to output the traces. */
109 unsigned int output_traces
;
110 unsigned int snapshot_mode
;
114 * Validate that the id has reached the maximum allowed or not.
116 * Return 0 if NOT else 1.
118 static inline int trace_ust_is_max_id(uint64_t id
)
120 return (id
== UINT64_MAX
) ? 1 : 0;
124 * Return next available channel id and increment the used counter. The
125 * trace_ust_is_max_id function MUST be called before in order to validate if
126 * the maximum number of IDs have been reached. If not, it is safe to call this
129 * Return a unique channel ID. If max is reached, the used_channel_id counter
132 static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session
*s
)
134 if (trace_ust_is_max_id(s
->used_channel_id
)) {
135 return s
->used_channel_id
;
138 s
->used_channel_id
++;
139 return s
->next_channel_id
++;
142 #ifdef HAVE_LIBLTTNG_UST_CTL
144 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
);
145 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
149 * Lookup functions. NULL is returned if not found.
151 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
152 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
);
153 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
157 * Create functions malloc() the data structure.
159 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
);
160 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
);
161 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
162 struct lttng_filter_bytecode
*filter
);
163 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
);
164 struct ltt_ust_context
*trace_ust_create_context(
165 struct lttng_event_context
*ctx
);
166 void trace_ust_delete_channel(struct lttng_ht
*ht
,
167 struct ltt_ust_channel
*channel
);
170 * Destroy functions free() the data structure and remove from linked list if
173 void trace_ust_destroy_session(struct ltt_ust_session
*session
);
174 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
);
175 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
);
176 void trace_ust_destroy_event(struct ltt_ust_event
*event
);
178 #else /* HAVE_LIBLTTNG_UST_CTL */
180 static inline int trace_ust_ht_match_event(struct cds_lfht_node
*node
,
185 static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
191 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
198 struct ltt_ust_session
*trace_ust_create_session(unsigned int session_id
)
203 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*attr
)
208 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
209 struct lttng_filter_bytecode
*filter
)
214 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
220 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
225 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
230 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
235 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
239 struct ltt_ust_context
*trace_ust_create_context(
240 struct lttng_event_context
*ctx
)
244 static inline struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
245 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
)
250 void trace_ust_delete_channel(struct lttng_ht
*ht
,
251 struct ltt_ust_channel
*channel
)
256 #endif /* HAVE_LIBLTTNG_UST_CTL */
258 #endif /* _LTT_TRACE_UST_H */