2 * Copyright (C) 2013 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 #ifndef LTTNG_UST_REGISTRY_H
19 #define LTTNG_UST_REGISTRY_H
24 #include <common/hashtable/hashtable.h>
25 #include <common/compat/uuid.h>
29 #define CTF_SPEC_MAJOR 1
30 #define CTF_SPEC_MINOR 8
34 struct ust_registry_session
{
36 * With multiple writers and readers, use this lock to access the registry.
37 * Can nest within the ust app session lock.
40 /* Next channel ID available for a newly registered channel. */
41 uint32_t next_channel_id
;
42 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
43 uint32_t used_channel_id
;
44 /* Universal unique identifier used by the tracer. */
45 unsigned char uuid
[UUID_LEN
];
47 /* session ABI description */
49 /* Size of long, in bits */
50 unsigned int bits_per_long
;
51 /* Alignment, in bits */
52 unsigned int uint8_t_alignment
,
58 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
60 /* Generated metadata. */
61 char *metadata
; /* NOT null-terminated ! Use memcpy. */
62 size_t metadata_len
, metadata_alloc_len
;
63 /* Length of bytes sent to the consumer. */
64 size_t metadata_len_sent
;
66 * Hash table containing channels sent by the UST tracer. MUST be accessed
67 * with a RCU read side lock acquired.
69 struct lttng_ht
*channels
;
70 /* Unique key to identify the metadata on the consumer side. */
71 uint64_t metadata_key
;
73 * Indicates if the metadata is closed on the consumer side. This is to
74 * avoid double close of metadata when an application unregisters AND
75 * deletes its sessions.
77 unsigned int metadata_closed
;
80 struct ust_registry_channel
{
82 /* Id set when replying to a register channel. */
84 enum ustctl_channel_header header_type
;
87 * Flag for this channel if the metadata was dumped once during
88 * registration. 0 means no, 1 yes.
90 unsigned int metadata_dumped
;
91 /* Indicates if this channel registry has already been registered. */
92 unsigned int register_done
;
95 * Hash table containing events sent by the UST tracer. MUST be accessed
96 * with a RCU read side lock acquired.
99 /* Next event ID available for a newly registered event. */
100 uint32_t next_event_id
;
101 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
102 uint32_t used_event_id
;
104 * Context fields of the registry. Context are per channel. Allocated by a
105 * register channel notification from the UST tracer.
107 size_t nr_ctx_fields
;
108 struct ustctl_field
*ctx_fields
;
109 struct lttng_ht_node_u64 node
;
113 * Event registered from a UST tracer sent to the session daemon. This is
114 * indexed and matched by <event_name/signature>.
116 struct ust_registry_event
{
118 /* Both objd are set by the tracer. */
121 /* Name of the event returned by the tracer. */
122 char name
[LTTNG_UST_SYM_NAME_LEN
];
126 struct ustctl_field
*fields
;
128 struct lttng_ust_object_data
*obj
;
130 * Flag for this channel if the metadata was dumped once during
131 * registration. 0 means no, 1 yes.
133 unsigned int metadata_dumped
;
135 * Node in the ust-registry hash table. The event name is used to
136 * initialize the node and the event_name/signature for the match function.
138 struct lttng_ht_node_u64 node
;
142 * Validate that the id has reached the maximum allowed or not.
144 * Return 0 if NOT else 1.
146 static inline int ust_registry_is_max_id(uint32_t id
)
148 return (id
== UINT32_MAX
) ? 1 : 0;
152 * Return next available event id and increment the used counter. The
153 * ust_registry_is_max_id function MUST be called before in order to validate
154 * if the maximum number of IDs have been reached. If not, it is safe to call
157 * Return a unique channel ID. If max is reached, the used_event_id counter is
160 static inline uint32_t ust_registry_get_next_event_id(
161 struct ust_registry_channel
*r
)
163 if (ust_registry_is_max_id(r
->used_event_id
)) {
164 return r
->used_event_id
;
168 return r
->next_event_id
++;
172 * Return next available channel id and increment the used counter. The
173 * ust_registry_is_max_id function MUST be called before in order to validate
174 * if the maximum number of IDs have been reached. If not, it is safe to call
177 * Return a unique channel ID. If max is reached, the used_channel_id counter
180 static inline uint32_t ust_registry_get_next_chan_id(
181 struct ust_registry_session
*r
)
183 if (ust_registry_is_max_id(r
->used_channel_id
)) {
184 return r
->used_channel_id
;
187 r
->used_channel_id
++;
188 return r
->next_channel_id
++;
192 * Return registry event count. This is read atomically.
194 static inline uint32_t ust_registry_get_event_count(
195 struct ust_registry_channel
*r
)
197 return (uint32_t) uatomic_read(&r
->used_event_id
);
200 #ifdef HAVE_LIBLTTNG_UST_CTL
202 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
203 struct ust_registry_channel
*chan
);
204 struct ust_registry_channel
*ust_registry_channel_find(
205 struct ust_registry_session
*session
, uint64_t key
);
206 int ust_registry_channel_add(struct ust_registry_session
*session
,
208 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
211 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
213 uint32_t bits_per_long
,
214 uint32_t uint8_t_alignment
,
215 uint32_t uint16_t_alignment
,
216 uint32_t uint32_t_alignment
,
217 uint32_t uint64_t_alignment
,
218 uint32_t long_alignment
,
220 void ust_registry_session_destroy(struct ust_registry_session
*session
);
222 int ust_registry_create_event(struct ust_registry_session
*session
,
223 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
224 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
225 char *model_emf_uri
, int buffer_type
, uint32_t *event_id_p
);
226 struct ust_registry_event
*ust_registry_find_event(
227 struct ust_registry_channel
*chan
, char *name
, char *sig
);
228 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
229 struct ust_registry_event
*event
);
231 /* app can be NULL for registry shared across applications. */
232 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
233 struct ust_app
*app
);
234 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
235 struct ust_registry_channel
*chan
);
236 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
237 struct ust_registry_channel
*chan
,
238 struct ust_registry_event
*event
);
240 #else /* HAVE_LIBLTTNG_UST_CTL */
243 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
244 struct ust_registry_channel
*chan
)
247 struct ust_registry_channel
*ust_registry_channel_find(
248 struct ust_registry_session
*session
, uint64_t key
)
253 int ust_registry_channel_add(struct ust_registry_session
*session
,
259 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
263 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
265 uint32_t bits_per_long
,
266 uint32_t uint8_t_alignment
,
267 uint32_t uint16_t_alignment
,
268 uint32_t uint32_t_alignment
,
269 uint32_t uint64_t_alignment
,
270 uint32_t long_alignment
,
276 void ust_registry_session_destroy(struct ust_registry_session
*session
)
279 int ust_registry_create_event(struct ust_registry_session
*session
,
280 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
281 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
282 char *model_emf_uri
, int buffer_type
, uint32_t *event_id_p
)
287 struct ust_registry_event
*ust_registry_find_event(
288 struct ust_registry_channel
*chan
, char *name
, char *sig
)
293 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
294 struct ust_registry_event
*event
)
297 /* The app object can be NULL for registry shared across applications. */
299 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
305 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
306 struct ust_registry_channel
*chan
)
311 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
312 struct ust_registry_channel
*chan
,
313 struct ust_registry_event
*event
)
318 #endif /* HAVE_LIBLTTNG_UST_CTL */
320 #endif /* LTTNG_UST_REGISTRY_H */