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 /* Universal unique identifier used by the tracer. */
49 unsigned char uuid
[UUID_LEN
];
51 /* session ABI description */
53 /* Size of long, in bits */
54 unsigned int bits_per_long
;
55 /* Alignment, in bits */
56 unsigned int uint8_t_alignment
,
62 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
64 /* Generated metadata. */
65 char *metadata
; /* NOT null-terminated ! Use memcpy. */
66 size_t metadata_len
, metadata_alloc_len
;
67 /* Length of bytes sent to the consumer. */
68 size_t metadata_len_sent
;
70 char shm_path
[PATH_MAX
];
71 char metadata_path
[PATH_MAX
];
72 int metadata_fd
; /* file-backed metadata FD */
75 * Hash table containing channels sent by the UST tracer. MUST
76 * be accessed with a RCU read side lock acquired.
78 struct lttng_ht
*channels
;
80 * Unique key to identify the metadata on the consumer side.
82 uint64_t metadata_key
;
84 * Indicates if the metadata is closed on the consumer side. This is to
85 * avoid double close of metadata when an application unregisters AND
86 * deletes its sessions.
88 unsigned int metadata_closed
;
91 struct ust_registry_channel
{
93 /* Id set when replying to a register channel. */
95 enum ustctl_channel_header header_type
;
98 * Flag for this channel if the metadata was dumped once during
99 * registration. 0 means no, 1 yes.
101 unsigned int metadata_dumped
;
102 /* Indicates if this channel registry has already been registered. */
103 unsigned int register_done
;
106 * Hash table containing events sent by the UST tracer. MUST be accessed
107 * with a RCU read side lock acquired.
110 /* Next event ID available for a newly registered event. */
111 uint32_t next_event_id
;
112 /* Once this value reaches UINT32_MAX, no more id can be allocated. */
113 uint32_t used_event_id
;
115 * Context fields of the registry. Context are per channel. Allocated by a
116 * register channel notification from the UST tracer.
118 size_t nr_ctx_fields
;
119 struct ustctl_field
*ctx_fields
;
120 struct lttng_ht_node_u64 node
;
121 /* For delayed reclaim */
122 struct rcu_head rcu_head
;
126 * Event registered from a UST tracer sent to the session daemon. This is
127 * indexed and matched by <event_name/signature>.
129 struct ust_registry_event
{
131 /* Both objd are set by the tracer. */
134 /* Name of the event returned by the tracer. */
135 char name
[LTTNG_UST_SYM_NAME_LEN
];
139 struct ustctl_field
*fields
;
142 * Flag for this channel if the metadata was dumped once during
143 * registration. 0 means no, 1 yes.
145 unsigned int metadata_dumped
;
147 * Node in the ust-registry hash table. The event name is used to
148 * initialize the node and the event_name/signature for the match function.
150 struct lttng_ht_node_u64 node
;
154 * Validate that the id has reached the maximum allowed or not.
156 * Return 0 if NOT else 1.
158 static inline int ust_registry_is_max_id(uint32_t id
)
160 return (id
== UINT32_MAX
) ? 1 : 0;
164 * Return next available event id and increment the used counter. The
165 * ust_registry_is_max_id function MUST be called before in order to validate
166 * if the maximum number of IDs have been reached. If not, it is safe to call
169 * Return a unique channel ID. If max is reached, the used_event_id counter is
172 static inline uint32_t ust_registry_get_next_event_id(
173 struct ust_registry_channel
*r
)
175 if (ust_registry_is_max_id(r
->used_event_id
)) {
176 return r
->used_event_id
;
180 return r
->next_event_id
++;
184 * Return next available channel id and increment the used counter. The
185 * ust_registry_is_max_id function MUST be called before in order to validate
186 * if the maximum number of IDs have been reached. If not, it is safe to call
189 * Return a unique channel ID. If max is reached, the used_channel_id counter
192 static inline uint32_t ust_registry_get_next_chan_id(
193 struct ust_registry_session
*r
)
195 if (ust_registry_is_max_id(r
->used_channel_id
)) {
196 return r
->used_channel_id
;
199 r
->used_channel_id
++;
200 return r
->next_channel_id
++;
204 * Return registry event count. This is read atomically.
206 static inline uint32_t ust_registry_get_event_count(
207 struct ust_registry_channel
*r
)
209 return (uint32_t) uatomic_read(&r
->used_event_id
);
212 #ifdef HAVE_LIBLTTNG_UST_CTL
214 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
215 struct ust_registry_channel
*chan
);
216 struct ust_registry_channel
*ust_registry_channel_find(
217 struct ust_registry_session
*session
, uint64_t key
);
218 int ust_registry_channel_add(struct ust_registry_session
*session
,
220 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
223 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
225 uint32_t bits_per_long
,
226 uint32_t uint8_t_alignment
,
227 uint32_t uint16_t_alignment
,
228 uint32_t uint32_t_alignment
,
229 uint32_t uint64_t_alignment
,
230 uint32_t long_alignment
,
234 const char *shm_path
,
237 void ust_registry_session_destroy(struct ust_registry_session
*session
);
239 int ust_registry_create_event(struct ust_registry_session
*session
,
240 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
241 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
242 char *model_emf_uri
, int buffer_type
, uint32_t *event_id_p
,
243 struct ust_app
*app
);
244 struct ust_registry_event
*ust_registry_find_event(
245 struct ust_registry_channel
*chan
, char *name
, char *sig
);
246 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
247 struct ust_registry_event
*event
);
249 /* app can be NULL for registry shared across applications. */
250 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
251 struct ust_app
*app
, uint32_t major
, uint32_t minor
);
252 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
253 struct ust_registry_channel
*chan
);
254 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
255 struct ust_registry_channel
*chan
,
256 struct ust_registry_event
*event
);
258 #else /* HAVE_LIBLTTNG_UST_CTL */
261 void ust_registry_channel_destroy(struct ust_registry_session
*session
,
262 struct ust_registry_channel
*chan
)
265 struct ust_registry_channel
*ust_registry_channel_find(
266 struct ust_registry_session
*session
, uint64_t key
)
271 int ust_registry_channel_add(struct ust_registry_session
*session
,
277 void ust_registry_channel_del_free(struct ust_registry_session
*session
,
281 int ust_registry_session_init(struct ust_registry_session
**sessionp
,
283 uint32_t bits_per_long
,
284 uint32_t uint8_t_alignment
,
285 uint32_t uint16_t_alignment
,
286 uint32_t uint32_t_alignment
,
287 uint32_t uint64_t_alignment
,
288 uint32_t long_alignment
,
294 void ust_registry_session_destroy(struct ust_registry_session
*session
)
297 int ust_registry_create_event(struct ust_registry_session
*session
,
298 uint64_t chan_key
, int session_objd
, int channel_objd
, char *name
,
299 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
300 char *model_emf_uri
, int buffer_type
, uint32_t *event_id_p
)
305 struct ust_registry_event
*ust_registry_find_event(
306 struct ust_registry_channel
*chan
, char *name
, char *sig
)
311 void ust_registry_destroy_event(struct ust_registry_channel
*chan
,
312 struct ust_registry_event
*event
)
315 /* The app object can be NULL for registry shared across applications. */
317 int ust_metadata_session_statedump(struct ust_registry_session
*session
,
323 int ust_metadata_channel_statedump(struct ust_registry_session
*session
,
324 struct ust_registry_channel
*chan
)
329 int ust_metadata_event_statedump(struct ust_registry_session
*session
,
330 struct ust_registry_channel
*chan
,
331 struct ust_registry_event
*event
)
336 #endif /* HAVE_LIBLTTNG_UST_CTL */
338 #endif /* LTTNG_UST_REGISTRY_H */