b96e585001c9bf7f420b0aac1ce274329550ce7c
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.
22 #include <common/common.h>
23 #include <common/hashtable/utils.h>
25 #include "buffer-registry.h"
27 #include "ust-consumer.h"
32 * Set in main.c during initialization process of the daemon. This contains
33 * buffer_reg_uid object which are global registry for per UID buffer. Object
34 * are indexed by session id and matched by the triplet
35 * <session_id/bits_per_long/uid>.
37 static struct lttng_ht
*buffer_registry_uid
;
40 * Initialized at the daemon start. This contains buffer_reg_pid object and
41 * indexed by session id.
43 static struct lttng_ht
*buffer_registry_pid
;
46 * Match function for the per UID registry hash table. It matches a registry
47 * uid object with the triplet <session_id/abi/uid>.
49 static int ht_match_reg_uid(struct cds_lfht_node
*node
, const void *_key
)
51 struct buffer_reg_uid
*reg
;
52 const struct buffer_reg_uid
*key
;
57 reg
= caa_container_of(node
, struct buffer_reg_uid
, node
.node
);
61 if (key
->session_id
!= reg
->session_id
||
62 key
->bits_per_long
!= reg
->bits_per_long
||
63 key
->uid
!= reg
->uid
) {
74 * Hash function for the per UID registry hash table. This XOR the triplet
77 static unsigned long ht_hash_reg_uid(void *_key
, unsigned long seed
)
80 struct buffer_reg_uid
*key
= _key
;
84 xored_key
= (uint64_t)(key
->session_id
^ key
->bits_per_long
^ key
->uid
);
85 return hash_key_u64(&xored_key
, seed
);
89 * Initialize global buffer per UID registry. Should only be called ONCE!.
91 void buffer_reg_init_uid_registry(void)
93 /* Should be called once. */
94 assert(!buffer_registry_uid
);
95 buffer_registry_uid
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
96 assert(buffer_registry_uid
);
97 buffer_registry_uid
->match_fct
= ht_match_reg_uid
;
98 buffer_registry_uid
->hash_fct
= ht_hash_reg_uid
;
100 DBG3("Global buffer per UID registry initialized");
104 * Allocate and initialize object. Set regp with the object pointer.
106 * Return 0 on success else a negative value and regp is untouched.
108 int buffer_reg_uid_create(uint64_t session_id
, uint32_t bits_per_long
, uid_t uid
,
109 enum lttng_domain_type domain
, struct buffer_reg_uid
**regp
,
110 const char *shm_path
)
113 struct buffer_reg_uid
*reg
= NULL
;
117 reg
= zmalloc(sizeof(*reg
));
119 PERROR("zmalloc buffer registry uid");
124 reg
->registry
= zmalloc(sizeof(struct buffer_reg_session
));
125 if (!reg
->registry
) {
126 PERROR("zmalloc buffer registry uid session");
131 reg
->session_id
= session_id
;
132 reg
->bits_per_long
= bits_per_long
;
134 reg
->domain
= domain
;
136 strncpy(reg
->shm_path
, shm_path
, sizeof(reg
->shm_path
));
137 reg
->shm_path
[sizeof(reg
->shm_path
) - 1] = '\0';
138 DBG3("shm path '%s' is assigned to uid buffer registry for session id %" PRIu64
,
139 reg
->shm_path
, session_id
);
141 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
142 if (!reg
->registry
->channels
) {
147 cds_lfht_node_init(®
->node
.node
);
150 DBG3("Buffer registry per UID created id: %" PRIu64
", ABI: %u, uid: %d, domain: %d",
151 session_id
, bits_per_long
, uid
, domain
);
163 * Add a buffer registry per UID object to the global registry.
165 void buffer_reg_uid_add(struct buffer_reg_uid
*reg
)
167 struct cds_lfht_node
*nodep
;
168 struct lttng_ht
*ht
= buffer_registry_uid
;
172 DBG3("Buffer registry per UID adding to global registry with id: %" PRIu64
,
176 nodep
= cds_lfht_add_unique(ht
->ht
, ht
->hash_fct(reg
, lttng_ht_seed
),
177 ht
->match_fct
, reg
, ®
->node
.node
);
178 assert(nodep
== ®
->node
.node
);
183 * Find a buffer registry per UID object with given params. RCU read side lock
184 * MUST be acquired before calling this and hold on to protect the object.
186 * Return the object pointer or NULL on error.
188 struct buffer_reg_uid
*buffer_reg_uid_find(uint64_t session_id
,
189 uint32_t bits_per_long
, uid_t uid
)
191 struct lttng_ht_node_u64
*node
;
192 struct lttng_ht_iter iter
;
193 struct buffer_reg_uid
*reg
= NULL
, key
;
194 struct lttng_ht
*ht
= buffer_registry_uid
;
196 /* Setup key we are looking for. */
197 key
.session_id
= session_id
;
198 key
.bits_per_long
= bits_per_long
;
201 DBG3("Buffer registry per UID find id: %" PRIu64
", ABI: %u, uid: %d",
202 session_id
, bits_per_long
, uid
);
204 /* Custom lookup function since it's a different key. */
205 cds_lfht_lookup(ht
->ht
, ht
->hash_fct(&key
, lttng_ht_seed
), ht
->match_fct
,
207 node
= lttng_ht_iter_get_node_u64(&iter
);
211 reg
= caa_container_of(node
, struct buffer_reg_uid
, node
);
218 * Initialize global buffer per PID registry. Should only be called ONCE!.
220 void buffer_reg_init_pid_registry(void)
222 /* Should be called once. */
223 assert(!buffer_registry_pid
);
224 buffer_registry_pid
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
225 assert(buffer_registry_pid
);
227 DBG3("Global buffer per PID registry initialized");
231 * Allocate and initialize object. Set regp with the object pointer.
233 * Return 0 on success else a negative value and regp is untouched.
235 int buffer_reg_pid_create(uint64_t session_id
, struct buffer_reg_pid
**regp
,
236 const char *shm_path
)
239 struct buffer_reg_pid
*reg
= NULL
;
243 reg
= zmalloc(sizeof(*reg
));
245 PERROR("zmalloc buffer registry pid");
250 reg
->registry
= zmalloc(sizeof(struct buffer_reg_session
));
251 if (!reg
->registry
) {
252 PERROR("zmalloc buffer registry pid session");
257 /* A cast is done here so we can use the session ID as a u64 ht node. */
258 reg
->session_id
= session_id
;
260 strncpy(reg
->shm_path
, shm_path
, sizeof(reg
->shm_path
));
261 reg
->shm_path
[sizeof(reg
->shm_path
) - 1] = '\0';
262 DBG3("shm path '%s' is assigned to pid buffer registry for session id %" PRIu64
,
263 reg
->shm_path
, session_id
);
265 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
266 if (!reg
->registry
->channels
) {
271 lttng_ht_node_init_u64(®
->node
, reg
->session_id
);
274 DBG3("Buffer registry per PID created with session id: %" PRIu64
,
287 * Add a buffer registry per PID object to the global registry.
289 void buffer_reg_pid_add(struct buffer_reg_pid
*reg
)
293 DBG3("Buffer registry per PID adding to global registry with id: %" PRIu64
,
297 lttng_ht_add_unique_u64(buffer_registry_pid
, ®
->node
);
302 * Find a buffer registry per PID object with given params. RCU read side lock
303 * MUST be acquired before calling this and hold on to protect the object.
305 * Return the object pointer or NULL on error.
307 struct buffer_reg_pid
*buffer_reg_pid_find(uint64_t session_id
)
309 struct lttng_ht_node_u64
*node
;
310 struct lttng_ht_iter iter
;
311 struct buffer_reg_pid
*reg
= NULL
;
312 struct lttng_ht
*ht
= buffer_registry_pid
;
314 DBG3("Buffer registry per PID find id: %" PRIu64
, session_id
);
316 lttng_ht_lookup(ht
, &session_id
, &iter
);
317 node
= lttng_ht_iter_get_node_u64(&iter
);
321 reg
= caa_container_of(node
, struct buffer_reg_pid
, node
);
328 * Allocate and initialize a buffer registry channel with the given key. Set
329 * regp with the object pointer.
331 * Return 0 on success or else a negative value keeping regp untouched.
333 int buffer_reg_channel_create(uint64_t key
, struct buffer_reg_channel
**regp
)
335 struct buffer_reg_channel
*reg
;
339 DBG3("Buffer registry channel create with key: %" PRIu64
, key
);
341 reg
= zmalloc(sizeof(*reg
));
343 PERROR("zmalloc buffer registry channel");
348 CDS_INIT_LIST_HEAD(®
->streams
);
349 pthread_mutex_init(®
->stream_list_lock
, NULL
);
351 lttng_ht_node_init_u64(®
->node
, key
);
358 * Allocate and initialize a buffer registry stream. Set regp with the object
361 * Return 0 on success or else a negative value keeping regp untouched.
363 int buffer_reg_stream_create(struct buffer_reg_stream
**regp
)
365 struct buffer_reg_stream
*reg
;
369 DBG3("Buffer registry creating stream");
371 reg
= zmalloc(sizeof(*reg
));
373 PERROR("zmalloc buffer registry stream");
383 * Add stream to the list in the channel.
385 void buffer_reg_stream_add(struct buffer_reg_stream
*stream
,
386 struct buffer_reg_channel
*channel
)
391 pthread_mutex_lock(&channel
->stream_list_lock
);
392 cds_list_add_tail(&stream
->lnode
, &channel
->streams
);
393 channel
->stream_count
++;
394 pthread_mutex_unlock(&channel
->stream_list_lock
);
398 * Add a buffer registry channel object to the given session.
400 void buffer_reg_channel_add(struct buffer_reg_session
*session
,
401 struct buffer_reg_channel
*channel
)
407 lttng_ht_add_unique_u64(session
->channels
, &channel
->node
);
412 * Find a buffer registry channel object with the given key. RCU read side lock
413 * MUST be acquired and hold on until the object reference is not needed
416 * Return the object pointer or NULL on error.
418 struct buffer_reg_channel
*buffer_reg_channel_find(uint64_t key
,
419 struct buffer_reg_uid
*reg
)
421 struct lttng_ht_node_u64
*node
;
422 struct lttng_ht_iter iter
;
423 struct buffer_reg_channel
*chan
= NULL
;
428 switch (reg
->domain
) {
429 case LTTNG_DOMAIN_UST
:
430 ht
= reg
->registry
->channels
;
437 lttng_ht_lookup(ht
, &key
, &iter
);
438 node
= lttng_ht_iter_get_node_u64(&iter
);
442 chan
= caa_container_of(node
, struct buffer_reg_channel
, node
);
449 * Destroy a buffer registry stream with the given domain.
451 void buffer_reg_stream_destroy(struct buffer_reg_stream
*regp
,
452 enum lttng_domain_type domain
)
458 DBG3("Buffer registry stream destroy with handle %d",
459 regp
->obj
.ust
->handle
);
462 case LTTNG_DOMAIN_UST
:
466 ret
= ust_ctl_release_object(-1, regp
->obj
.ust
);
467 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
468 ERR("Buffer reg stream release obj handle %d failed with ret %d",
469 regp
->obj
.ust
->handle
, ret
);
472 lttng_fd_put(LTTNG_FD_APPS
, 2);
484 * Remove buffer registry channel object from the session hash table. RCU read
485 * side lock MUST be acquired before calling this.
487 void buffer_reg_channel_remove(struct buffer_reg_session
*session
,
488 struct buffer_reg_channel
*regp
)
491 struct lttng_ht_iter iter
;
496 iter
.iter
.node
= ®p
->node
.node
;
497 ret
= lttng_ht_del(session
->channels
, &iter
);
502 * Destroy a buffer registry channel with the given domain.
504 void buffer_reg_channel_destroy(struct buffer_reg_channel
*regp
,
505 enum lttng_domain_type domain
)
511 DBG3("Buffer registry channel destroy with key %" PRIu32
, regp
->key
);
514 case LTTNG_DOMAIN_UST
:
517 struct buffer_reg_stream
*sreg
, *stmp
;
519 cds_list_for_each_entry_safe(sreg
, stmp
, ®p
->streams
, lnode
) {
520 cds_list_del(&sreg
->lnode
);
521 regp
->stream_count
--;
522 buffer_reg_stream_destroy(sreg
, domain
);
526 ret
= ust_ctl_release_object(-1, regp
->obj
.ust
);
527 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
528 ERR("Buffer reg channel release obj handle %d failed with ret %d",
529 regp
->obj
.ust
->handle
, ret
);
533 lttng_fd_put(LTTNG_FD_APPS
, 1);
545 * Destroy a buffer registry session with the given domain.
547 * Should *NOT* be called with RCU read-side lock held.
549 static void buffer_reg_session_destroy(struct buffer_reg_session
*regp
,
550 enum lttng_domain_type domain
)
553 struct lttng_ht_iter iter
;
554 struct buffer_reg_channel
*reg_chan
;
556 DBG3("Buffer registry session destroy");
558 /* Destroy all channels. */
560 cds_lfht_for_each_entry(regp
->channels
->ht
, &iter
.iter
, reg_chan
,
562 ret
= lttng_ht_del(regp
->channels
, &iter
);
564 buffer_reg_channel_destroy(reg_chan
, domain
);
568 ht_cleanup_push(regp
->channels
);
571 case LTTNG_DOMAIN_UST
:
572 ust_registry_session_destroy(regp
->reg
.ust
);
584 * Remove buffer registry UID object from the global hash table.
586 void buffer_reg_uid_remove(struct buffer_reg_uid
*regp
)
589 struct lttng_ht_iter iter
;
594 iter
.iter
.node
= ®p
->node
.node
;
595 ret
= lttng_ht_del(buffer_registry_uid
, &iter
);
600 static void rcu_free_buffer_reg_uid(struct rcu_head
*head
)
602 struct lttng_ht_node_u64
*node
=
603 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
604 struct buffer_reg_uid
*reg
=
605 caa_container_of(node
, struct buffer_reg_uid
, node
);
607 buffer_reg_session_destroy(reg
->registry
, reg
->domain
);
611 static void rcu_free_buffer_reg_pid(struct rcu_head
*head
)
613 struct lttng_ht_node_u64
*node
=
614 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
615 struct buffer_reg_pid
*reg
=
616 caa_container_of(node
, struct buffer_reg_pid
, node
);
618 buffer_reg_session_destroy(reg
->registry
, LTTNG_DOMAIN_UST
);
623 * Destroy buffer registry per UID. The given pointer is NOT removed from any
624 * list or hash table. Use buffer_reg_pid_remove() before calling this function
625 * for the case that the object is in the global hash table.
627 void buffer_reg_uid_destroy(struct buffer_reg_uid
*regp
,
628 struct consumer_output
*consumer
)
630 struct consumer_socket
*socket
;
636 DBG3("Buffer registry per UID destroy with id: %" PRIu64
", ABI: %u, uid: %d",
637 regp
->session_id
, regp
->bits_per_long
, regp
->uid
);
644 /* Get the right socket from the consumer object. */
645 socket
= consumer_find_socket_by_bitness(regp
->bits_per_long
,
651 switch (regp
->domain
) {
652 case LTTNG_DOMAIN_UST
:
653 if (regp
->registry
->reg
.ust
->metadata_key
) {
654 /* Return value does not matter. This call will print errors. */
655 (void) consumer_close_metadata(socket
,
656 regp
->registry
->reg
.ust
->metadata_key
);
668 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_uid
);
672 * Remove buffer registry UID object from the global hash table. RCU read side
673 * lock MUST be acquired before calling this.
675 void buffer_reg_pid_remove(struct buffer_reg_pid
*regp
)
678 struct lttng_ht_iter iter
;
682 iter
.iter
.node
= ®p
->node
.node
;
683 ret
= lttng_ht_del(buffer_registry_pid
, &iter
);
688 * Destroy buffer registry per PID. The pointer is NOT removed from the global
689 * hash table. Call buffer_reg_pid_remove() before that if the object was
690 * previously added to the global hash table.
692 void buffer_reg_pid_destroy(struct buffer_reg_pid
*regp
)
698 DBG3("Buffer registry per PID destroy with id: %" PRIu64
,
701 /* This registry is only used by UST. */
702 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_pid
);
706 * Destroy per PID and UID registry hash table.
708 * Should *NOT* be called with RCU read-side lock held.
710 void buffer_reg_destroy_registries(void)
712 DBG3("Buffer registry destroy all registry");
713 ht_cleanup_push(buffer_registry_uid
);
714 ht_cleanup_push(buffer_registry_pid
);
This page took 0.043386 seconds and 4 git commands to generate.