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.
21 #include <common/common.h>
22 #include <common/hashtable/utils.h>
24 #include "buffer-registry.h"
26 #include "ust-consumer.h"
31 * Set in main.c during initialization process of the daemon. This contains
32 * buffer_reg_uid object which are global registry for per UID buffer. Object
33 * are indexed by session id and matched by the triplet
34 * <session_id/bits_per_long/uid>.
36 static struct lttng_ht
*buffer_registry_uid
;
39 * Initialized at the daemon start. This contains buffer_reg_pid object and
40 * indexed by session id.
42 static struct lttng_ht
*buffer_registry_pid
;
45 * Match function for the per UID registry hash table. It matches a registry
46 * uid object with the triplet <session_id/abi/uid>.
48 static int ht_match_reg_uid(struct cds_lfht_node
*node
, const void *_key
)
50 struct buffer_reg_uid
*reg
;
51 const struct buffer_reg_uid
*key
;
56 reg
= caa_container_of(node
, struct buffer_reg_uid
, node
.node
);
60 if (key
->session_id
!= reg
->session_id
||
61 key
->bits_per_long
!= reg
->bits_per_long
||
62 key
->uid
!= reg
->uid
) {
73 * Hash function for the per UID registry hash table. This XOR the triplet
76 static unsigned long ht_hash_reg_uid(const void *_key
, unsigned long seed
)
79 const struct buffer_reg_uid
*key
= _key
;
83 xored_key
= (uint64_t)(key
->session_id
^ key
->bits_per_long
^ key
->uid
);
84 return hash_key_u64(&xored_key
, seed
);
88 * Initialize global buffer per UID registry. Should only be called ONCE!.
90 void buffer_reg_init_uid_registry(void)
92 /* Should be called once. */
93 assert(!buffer_registry_uid
);
94 buffer_registry_uid
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
95 assert(buffer_registry_uid
);
96 buffer_registry_uid
->match_fct
= ht_match_reg_uid
;
97 buffer_registry_uid
->hash_fct
= ht_hash_reg_uid
;
99 DBG3("Global buffer per UID registry initialized");
103 * Allocate and initialize object. Set regp with the object pointer.
105 * Return 0 on success else a negative value and regp is untouched.
107 int buffer_reg_uid_create(uint64_t session_id
, uint32_t bits_per_long
, uid_t uid
,
108 enum lttng_domain_type domain
, struct buffer_reg_uid
**regp
,
109 const char *root_shm_path
, const char *shm_path
)
112 struct buffer_reg_uid
*reg
= NULL
;
116 reg
= zmalloc(sizeof(*reg
));
118 PERROR("zmalloc buffer registry uid");
123 reg
->registry
= zmalloc(sizeof(struct buffer_reg_session
));
124 if (!reg
->registry
) {
125 PERROR("zmalloc buffer registry uid session");
130 reg
->session_id
= session_id
;
131 reg
->bits_per_long
= bits_per_long
;
133 reg
->domain
= domain
;
135 strncpy(reg
->root_shm_path
, root_shm_path
, sizeof(reg
->root_shm_path
));
136 reg
->root_shm_path
[sizeof(reg
->root_shm_path
) - 1] = '\0';
137 strncpy(reg
->shm_path
, shm_path
, sizeof(reg
->shm_path
));
138 reg
->shm_path
[sizeof(reg
->shm_path
) - 1] = '\0';
139 DBG3("shm path '%s' is assigned to uid buffer registry for session id %" PRIu64
,
140 reg
->shm_path
, session_id
);
142 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
143 if (!reg
->registry
->channels
) {
148 cds_lfht_node_init(®
->node
.node
);
151 DBG3("Buffer registry per UID created id: %" PRIu64
", ABI: %u, uid: %d, domain: %d",
152 session_id
, bits_per_long
, uid
, domain
);
164 * Add a buffer registry per UID object to the global registry.
166 void buffer_reg_uid_add(struct buffer_reg_uid
*reg
)
168 struct cds_lfht_node
*nodep
;
169 struct lttng_ht
*ht
= buffer_registry_uid
;
173 DBG3("Buffer registry per UID adding to global registry with id: %" PRIu64
,
177 nodep
= cds_lfht_add_unique(ht
->ht
, ht
->hash_fct(reg
, lttng_ht_seed
),
178 ht
->match_fct
, reg
, ®
->node
.node
);
179 assert(nodep
== ®
->node
.node
);
184 * Find a buffer registry per UID object with given params. RCU read side lock
185 * MUST be acquired before calling this and hold on to protect the object.
187 * Return the object pointer or NULL on error.
189 struct buffer_reg_uid
*buffer_reg_uid_find(uint64_t session_id
,
190 uint32_t bits_per_long
, uid_t uid
)
192 struct lttng_ht_node_u64
*node
;
193 struct lttng_ht_iter iter
;
194 struct buffer_reg_uid
*reg
= NULL
, key
;
195 struct lttng_ht
*ht
= buffer_registry_uid
;
197 /* Setup key we are looking for. */
198 key
.session_id
= session_id
;
199 key
.bits_per_long
= bits_per_long
;
202 DBG3("Buffer registry per UID find id: %" PRIu64
", ABI: %u, uid: %d",
203 session_id
, bits_per_long
, uid
);
205 /* Custom lookup function since it's a different key. */
206 cds_lfht_lookup(ht
->ht
, ht
->hash_fct(&key
, lttng_ht_seed
), ht
->match_fct
,
208 node
= lttng_ht_iter_get_node_u64(&iter
);
212 reg
= caa_container_of(node
, struct buffer_reg_uid
, node
);
219 * Initialize global buffer per PID registry. Should only be called ONCE!.
221 void buffer_reg_init_pid_registry(void)
223 /* Should be called once. */
224 assert(!buffer_registry_pid
);
225 buffer_registry_pid
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
226 assert(buffer_registry_pid
);
228 DBG3("Global buffer per PID registry initialized");
232 * Allocate and initialize object. Set regp with the object pointer.
234 * Return 0 on success else a negative value and regp is untouched.
236 int buffer_reg_pid_create(uint64_t session_id
, struct buffer_reg_pid
**regp
,
237 const char *root_shm_path
, const char *shm_path
)
240 struct buffer_reg_pid
*reg
= NULL
;
244 reg
= zmalloc(sizeof(*reg
));
246 PERROR("zmalloc buffer registry pid");
251 reg
->registry
= zmalloc(sizeof(struct buffer_reg_session
));
252 if (!reg
->registry
) {
253 PERROR("zmalloc buffer registry pid session");
258 /* A cast is done here so we can use the session ID as a u64 ht node. */
259 reg
->session_id
= session_id
;
261 strncpy(reg
->root_shm_path
, root_shm_path
, sizeof(reg
->root_shm_path
));
262 reg
->root_shm_path
[sizeof(reg
->root_shm_path
) - 1] = '\0';
263 strncpy(reg
->shm_path
, shm_path
, sizeof(reg
->shm_path
));
264 reg
->shm_path
[sizeof(reg
->shm_path
) - 1] = '\0';
265 DBG3("shm path '%s' is assigned to pid buffer registry for session id %" PRIu64
,
266 reg
->shm_path
, session_id
);
268 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
269 if (!reg
->registry
->channels
) {
274 lttng_ht_node_init_u64(®
->node
, reg
->session_id
);
277 DBG3("Buffer registry per PID created with session id: %" PRIu64
,
290 * Add a buffer registry per PID object to the global registry.
292 void buffer_reg_pid_add(struct buffer_reg_pid
*reg
)
296 DBG3("Buffer registry per PID adding to global registry with id: %" PRIu64
,
300 lttng_ht_add_unique_u64(buffer_registry_pid
, ®
->node
);
305 * Find a buffer registry per PID object with given params. RCU read side lock
306 * MUST be acquired before calling this and hold on to protect the object.
308 * Return the object pointer or NULL on error.
310 struct buffer_reg_pid
*buffer_reg_pid_find(uint64_t session_id
)
312 struct lttng_ht_node_u64
*node
;
313 struct lttng_ht_iter iter
;
314 struct buffer_reg_pid
*reg
= NULL
;
315 struct lttng_ht
*ht
= buffer_registry_pid
;
317 DBG3("Buffer registry per PID find id: %" PRIu64
, session_id
);
319 lttng_ht_lookup(ht
, &session_id
, &iter
);
320 node
= lttng_ht_iter_get_node_u64(&iter
);
324 reg
= caa_container_of(node
, struct buffer_reg_pid
, node
);
331 * Find the consumer channel key from a UST session per-uid channel key.
333 * Return the matching key or -1 if not found.
335 int buffer_reg_uid_consumer_channel_key(
336 struct cds_list_head
*buffer_reg_uid_list
,
337 uint64_t chan_key
, uint64_t *consumer_chan_key
)
339 struct lttng_ht_iter iter
;
340 struct buffer_reg_uid
*uid_reg
= NULL
;
341 struct buffer_reg_session
*session_reg
= NULL
;
342 struct buffer_reg_channel
*reg_chan
;
347 * For the per-uid registry, we have to iterate since we don't have the
348 * uid and bitness key.
350 cds_list_for_each_entry(uid_reg
, buffer_reg_uid_list
, lnode
) {
351 session_reg
= uid_reg
->registry
;
352 cds_lfht_for_each_entry(session_reg
->channels
->ht
,
353 &iter
.iter
, reg_chan
, node
.node
) {
354 if (reg_chan
->key
== chan_key
) {
355 *consumer_chan_key
= reg_chan
->consumer_key
;
368 * Allocate and initialize a buffer registry channel with the given key. Set
369 * regp with the object pointer.
371 * Return 0 on success or else a negative value keeping regp untouched.
373 int buffer_reg_channel_create(uint64_t key
, struct buffer_reg_channel
**regp
)
375 struct buffer_reg_channel
*reg
;
379 DBG3("Buffer registry channel create with key: %" PRIu64
, key
);
381 reg
= zmalloc(sizeof(*reg
));
383 PERROR("zmalloc buffer registry channel");
388 CDS_INIT_LIST_HEAD(®
->streams
);
389 pthread_mutex_init(®
->stream_list_lock
, NULL
);
391 lttng_ht_node_init_u64(®
->node
, key
);
398 * Allocate and initialize a buffer registry stream. Set regp with the object
401 * Return 0 on success or else a negative value keeping regp untouched.
403 int buffer_reg_stream_create(struct buffer_reg_stream
**regp
)
405 struct buffer_reg_stream
*reg
;
409 DBG3("Buffer registry creating stream");
411 reg
= zmalloc(sizeof(*reg
));
413 PERROR("zmalloc buffer registry stream");
423 * Add stream to the list in the channel.
425 void buffer_reg_stream_add(struct buffer_reg_stream
*stream
,
426 struct buffer_reg_channel
*channel
)
431 pthread_mutex_lock(&channel
->stream_list_lock
);
432 cds_list_add_tail(&stream
->lnode
, &channel
->streams
);
433 channel
->stream_count
++;
434 pthread_mutex_unlock(&channel
->stream_list_lock
);
438 * Add a buffer registry channel object to the given session.
440 void buffer_reg_channel_add(struct buffer_reg_session
*session
,
441 struct buffer_reg_channel
*channel
)
447 lttng_ht_add_unique_u64(session
->channels
, &channel
->node
);
452 * Find a buffer registry channel object with the given key. RCU read side lock
453 * MUST be acquired and hold on until the object reference is not needed
456 * Return the object pointer or NULL on error.
458 struct buffer_reg_channel
*buffer_reg_channel_find(uint64_t key
,
459 struct buffer_reg_uid
*reg
)
461 struct lttng_ht_node_u64
*node
;
462 struct lttng_ht_iter iter
;
463 struct buffer_reg_channel
*chan
= NULL
;
468 switch (reg
->domain
) {
469 case LTTNG_DOMAIN_UST
:
470 ht
= reg
->registry
->channels
;
477 lttng_ht_lookup(ht
, &key
, &iter
);
478 node
= lttng_ht_iter_get_node_u64(&iter
);
482 chan
= caa_container_of(node
, struct buffer_reg_channel
, node
);
489 * Destroy a buffer registry stream with the given domain.
491 void buffer_reg_stream_destroy(struct buffer_reg_stream
*regp
,
492 enum lttng_domain_type domain
)
498 DBG3("Buffer registry stream destroy with handle %d",
499 regp
->obj
.ust
->handle
);
502 case LTTNG_DOMAIN_UST
:
506 ret
= ust_app_release_object(NULL
, regp
->obj
.ust
);
507 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
508 ERR("Buffer reg stream release obj handle %d failed with ret %d",
509 regp
->obj
.ust
->handle
, ret
);
512 lttng_fd_put(LTTNG_FD_APPS
, 2);
524 * Remove buffer registry channel object from the session hash table. RCU read
525 * side lock MUST be acquired before calling this.
527 void buffer_reg_channel_remove(struct buffer_reg_session
*session
,
528 struct buffer_reg_channel
*regp
)
531 struct lttng_ht_iter iter
;
536 iter
.iter
.node
= ®p
->node
.node
;
537 ret
= lttng_ht_del(session
->channels
, &iter
);
542 * Destroy a buffer registry channel with the given domain.
544 void buffer_reg_channel_destroy(struct buffer_reg_channel
*regp
,
545 enum lttng_domain_type domain
)
551 DBG3("Buffer registry channel destroy with key %" PRIu32
, regp
->key
);
554 case LTTNG_DOMAIN_UST
:
557 struct buffer_reg_stream
*sreg
, *stmp
;
559 cds_list_for_each_entry_safe(sreg
, stmp
, ®p
->streams
, lnode
) {
560 cds_list_del(&sreg
->lnode
);
561 regp
->stream_count
--;
562 buffer_reg_stream_destroy(sreg
, domain
);
566 ret
= ust_app_release_object(NULL
, regp
->obj
.ust
);
567 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
568 ERR("Buffer reg channel release obj handle %d failed with ret %d",
569 regp
->obj
.ust
->handle
, ret
);
573 lttng_fd_put(LTTNG_FD_APPS
, 1);
585 * Destroy a buffer registry session with the given domain.
587 * Should *NOT* be called with RCU read-side lock held.
589 static void buffer_reg_session_destroy(struct buffer_reg_session
*regp
,
590 enum lttng_domain_type domain
)
593 struct lttng_ht_iter iter
;
594 struct buffer_reg_channel
*reg_chan
;
596 DBG3("Buffer registry session destroy");
598 /* Destroy all channels. */
600 cds_lfht_for_each_entry(regp
->channels
->ht
, &iter
.iter
, reg_chan
,
602 ret
= lttng_ht_del(regp
->channels
, &iter
);
604 buffer_reg_channel_destroy(reg_chan
, domain
);
608 ht_cleanup_push(regp
->channels
);
611 case LTTNG_DOMAIN_UST
:
612 ust_registry_session_destroy(regp
->reg
.ust
);
624 * Remove buffer registry UID object from the global hash table.
626 void buffer_reg_uid_remove(struct buffer_reg_uid
*regp
)
629 struct lttng_ht_iter iter
;
634 iter
.iter
.node
= ®p
->node
.node
;
635 ret
= lttng_ht_del(buffer_registry_uid
, &iter
);
640 static void rcu_free_buffer_reg_uid(struct rcu_head
*head
)
642 struct lttng_ht_node_u64
*node
=
643 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
644 struct buffer_reg_uid
*reg
=
645 caa_container_of(node
, struct buffer_reg_uid
, node
);
647 buffer_reg_session_destroy(reg
->registry
, reg
->domain
);
651 static void rcu_free_buffer_reg_pid(struct rcu_head
*head
)
653 struct lttng_ht_node_u64
*node
=
654 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
655 struct buffer_reg_pid
*reg
=
656 caa_container_of(node
, struct buffer_reg_pid
, node
);
658 buffer_reg_session_destroy(reg
->registry
, LTTNG_DOMAIN_UST
);
663 * Destroy buffer registry per UID. The given pointer is NOT removed from any
664 * list or hash table. Use buffer_reg_pid_remove() before calling this function
665 * for the case that the object is in the global hash table.
667 void buffer_reg_uid_destroy(struct buffer_reg_uid
*regp
,
668 struct consumer_output
*consumer
)
670 struct consumer_socket
*socket
;
676 DBG3("Buffer registry per UID destroy with id: %" PRIu64
", ABI: %u, uid: %d",
677 regp
->session_id
, regp
->bits_per_long
, regp
->uid
);
684 /* Get the right socket from the consumer object. */
685 socket
= consumer_find_socket_by_bitness(regp
->bits_per_long
,
691 switch (regp
->domain
) {
692 case LTTNG_DOMAIN_UST
:
693 if (regp
->registry
->reg
.ust
->metadata_key
) {
694 /* Return value does not matter. This call will print errors. */
695 (void) consumer_close_metadata(socket
,
696 regp
->registry
->reg
.ust
->metadata_key
);
708 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_uid
);
712 * Remove buffer registry UID object from the global hash table. RCU read side
713 * lock MUST be acquired before calling this.
715 void buffer_reg_pid_remove(struct buffer_reg_pid
*regp
)
718 struct lttng_ht_iter iter
;
722 iter
.iter
.node
= ®p
->node
.node
;
723 ret
= lttng_ht_del(buffer_registry_pid
, &iter
);
728 * Destroy buffer registry per PID. The pointer is NOT removed from the global
729 * hash table. Call buffer_reg_pid_remove() before that if the object was
730 * previously added to the global hash table.
732 void buffer_reg_pid_destroy(struct buffer_reg_pid
*regp
)
738 DBG3("Buffer registry per PID destroy with id: %" PRIu64
,
741 /* This registry is only used by UST. */
742 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_pid
);
746 * Destroy per PID and UID registry hash table.
748 * Should *NOT* be called with RCU read-side lock held.
750 void buffer_reg_destroy_registries(void)
752 DBG3("Buffer registry destroy all registry");
753 ht_cleanup_push(buffer_registry_uid
);
754 ht_cleanup_push(buffer_registry_pid
);
This page took 0.047115 seconds and 5 git commands to generate.