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
37 * the registry. Can nest within the ust app session lock.
38 * Also acts as a registry serialization lock. Used by registry
39 * readers to serialize the registry information sent from the
40 * sessiond to the consumerd.
41 * The consumer socket lock nests within this lock.
44 /* Next channel ID available for a newly registered channel. */
45 uint32_t next_channel_id
;
46 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
47 uint32_t used_channel_id
;
48 /* Next enumeration ID available. */
49 uint64_t next_enum_id
;
50 /* Universal unique identifier used by the tracer. */
51 unsigned char uuid
[UUID_LEN
];
53 /* session ABI description */
55 /* Size of long, in bits */
56 unsigned int bits_per_long
;
57 /* Alignment, in bits */
58 unsigned int uint8_t_alignment
,
64 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
66 /* Generated metadata. */
67 char *metadata
; /* NOT null-terminated ! Use memcpy. */
68 size_t metadata_len
, metadata_alloc_len
;
69 /* Length of bytes sent to the consumer. */
70 size_t metadata_len_sent
;
72 char root_shm_path
[PATH_MAX
];
73 char shm_path
[PATH_MAX
];
74 char metadata_path
[PATH_MAX
];
75 int metadata_fd
; /* file-backed metadata FD */
78 * Hash table containing channels sent by the UST tracer. MUST
79 * be accessed with a RCU read side lock acquired.
81 struct lttng_ht
*channels
;
83 * Unique key to identify the metadata on the consumer side.
85 uint64_t metadata_key
;
87 * Indicates if the metadata is closed on the consumer side. This is to
88 * avoid double close of metadata when an application unregisters AND
89 * deletes its sessions.
91 unsigned int metadata_closed
;
93 /* User and group owning the session. */
97 /* Enumerations table. */
98 struct lttng_ht
*enums
;
101 * Copy of the tracer version when the first app is registered.
102 * It is used if we need to regenerate the metadata.
108 struct ust_registry_channel
{
110 /* Id set when replying to a register channel. */
112 enum ustctl_channel_header header_type
;
115 * Flag for this channel if the metadata was dumped once during
116 * registration. 0 means no, 1 yes.
118 unsigned int metadata_dumped
;
119 /* Indicates if this channel registry has already been registered. */
120 unsigned int register_done
;
123 * Hash table containing events sent by the UST tracer. MUST be accessed
124 * with a RCU read side lock acquired.
127 /* Next event ID available for a newly registered event. */
128 uint32_t next_event_id
;
129 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
130 uint32_t used_event_id
;
132 * Context fields of the registry. Context are per channel. Allocated by a
133 * register channel notification from the UST tracer.
135 size_t nr_ctx_fields
;
136 struct ustctl_field
*ctx_fields
;
137 struct lttng_ht_node_u64 node
;
138 /* For delayed reclaim */
139 struct rcu_head rcu_head
;
143 * Event registered from a UST tracer sent to the session daemon. This is
144 * indexed and matched by <event_name/signature>.
146 struct ust_registry_event
{
148 /* Both objd are set by the tracer. */
151 /* Name of the event returned by the tracer. */
152 char name
[LTTNG_UST_SYM_NAME_LEN
];
156 struct ustctl_field
*fields
;
159 * Flag for this channel if the metadata was dumped once during
160 * registration. 0 means no, 1 yes.
162 unsigned int metadata_dumped
;
164 * Node in the ust-registry hash table. The event name is used to
165 * initialize the node and the event_name/signature for the match function.
167 struct lttng_ht_node_u64 node
;
170 struct ust_registry_enum
{
171 char name
[LTTNG_UST_SYM_NAME_LEN
];
172 struct ustctl_enum_entry
*entries
;
174 uint64_t id
; /* enum id in session */
175 /* Enumeration node in session hash table. */
176 struct lttng_ht_node_str node
;
177 /* For delayed reclaim. */
178 struct rcu_head rcu_head
;
182 * Validate that the id has reached the maximum allowed or not.
184 * Return 0 if NOT else 1.
186 static inline int ust_registry_is_max_id(uint32_t id
)
188 return (id
== UINT32_MAX
) ? 1 : 0;
192 * Return next available event id and increment the used counter. The
193 * ust_registry_is_max_id function MUST be called before in order to validate
194 * if the maximum number of IDs have been reached. If not, it is safe to call
197 * Return a unique channel ID. If max is reached, the used_event_id counter is
200 static inline uint32_t ust_registry_get_next_event_id(
201 struct ust_registry_channel
*r
)
203 if (ust_registry_is_max_id(r
->used_event_id
)) {
204 return r
->used_event_id
;
208 return r
->next_event_id
++;
212 * Return next available channel id and increment the used counter. The
213 * ust_registry_is_max_id function MUST be called before in order to validate
214 * if the maximum number of IDs have been reached. If not, it is safe to call
217 * Return a unique channel ID. If max is reached, the used_channel_id counter
220 static inline uint32_t ust_registry_get_next_chan_id(
221 struct ust_registry_session
*r
)
223 if (ust_registry_is_max_id(r
->used_channel_id
)) {
224 return r
->used_channel_id
;
227 r
->used_channel_id
++;
228 return r
->next_channel_id
++;
232 * Return registry event count. This is read atomically.
234 static inline uint32_t ust_registry_get_event_count(
235 struct ust_registry_channel
*r
)
237 return (uint32_t) uatomic_read(&r
->used_event_id
);
240 #ifdef HAVE_LIBLTTNG_UST_CTL
242 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
243 struct ust_registry_channel
*chan
);
244 struct ust_registry_channel
*ust_registry_channel_find(
245 struct ust_registry_session
*session
, uint64_t key
);
246 int ust_registry_channel_add(struct ust_registry_session
*session
,
248 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
251 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
253 uint32_t bits_per_long
,
254 uint32_t uint8_t_alignment
,
255 uint32_t uint16_t_alignment
,
256 uint32_t uint32_t_alignment
,
257 uint32_t uint64_t_alignment
,
258 uint32_t long_alignment
,
262 const char *root_shm_path
,
263 const char *shm_path
,
266 void ust_registry_session_destroy(struct ust_registry_session
*session
);
268 int ust_registry_create_event(struct ust_registry_session
*session
,
269 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
270 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
271 int loglevel_value
, char *model_emf_uri
, int buffer_type
,
272 uint32_t *event_id_p
, struct ust_app
*app
);
273 struct ust_registry_event
*ust_registry_find_event(
274 struct ust_registry_channel
*chan
, char *name
, char *sig
);
275 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
276 struct ust_registry_event
*event
);
278 /* app can be NULL for registry shared across applications. */
279 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
280 struct ust_app
*app
, uint32_t major
, uint32_t minor
);
281 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
282 struct ust_registry_channel
*chan
);
283 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
284 struct ust_registry_channel
*chan
,
285 struct ust_registry_event
*event
);
286 int ust_registry_create_or_find_enum(struct ust_registry_session
*session
,
287 int session_objd
, char *name
,
288 struct ustctl_enum_entry
*entries
, size_t nr_entries
,
290 struct ust_registry_enum
*
291 ust_registry_lookup_enum_by_id(struct ust_registry_session
*session
,
292 const char *name
, uint64_t id
);
294 #else /* HAVE_LIBLTTNG_UST_CTL */
297 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
298 struct ust_registry_channel
*chan
)
301 struct ust_registry_channel
*ust_registry_channel_find(
302 struct ust_registry_session
*session
, uint64_t key
)
307 int ust_registry_channel_add(struct ust_registry_session
*session
,
313 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
317 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
319 uint32_t bits_per_long
,
320 uint32_t uint8_t_alignment
,
321 uint32_t uint16_t_alignment
,
322 uint32_t uint32_t_alignment
,
323 uint32_t uint64_t_alignment
,
324 uint32_t long_alignment
,
330 void ust_registry_session_destroy(struct ust_registry_session
*session
)
333 int ust_registry_create_event(struct ust_registry_session
*session
,
334 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
335 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
336 int loglevel_value
, char *model_emf_uri
, int buffer_type
,
337 uint32_t *event_id_p
)
342 struct ust_registry_event
*ust_registry_find_event(
343 struct ust_registry_channel
*chan
, char *name
, char *sig
)
348 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
349 struct ust_registry_event
*event
)
352 /* The app object can be NULL for registry shared across applications. */
354 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
360 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
361 struct ust_registry_channel
*chan
)
366 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
367 struct ust_registry_channel
*chan
,
368 struct ust_registry_event
*event
)
373 int ust_registry_create_or_find_enum(struct ust_registry_session
*session
,
374 int session_objd
, char *name
,
375 struct ustctl_enum_entry
*entries
, size_t nr_entries
,
381 struct ust_registry_enum
*
382 ust_registry_lookup_enum_by_id(struct ust_registry_session
*session
,
383 const char *name
, uint64_t id
)
388 #endif /* HAVE_LIBLTTNG_UST_CTL */
390 #endif /* LTTNG_UST_REGISTRY_H */