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
)
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 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
136 if (!reg
->registry
->channels
) {
141 cds_lfht_node_init(®
->node
.node
);
144 DBG3("Buffer registry per UID created id: %" PRIu64
", ABI: %u, uid: %d, domain: %d",
145 session_id
, bits_per_long
, uid
, domain
);
157 * Add a buffer registry per UID object to the global registry.
159 void buffer_reg_uid_add(struct buffer_reg_uid
*reg
)
161 struct cds_lfht_node
*nodep
;
162 struct lttng_ht
*ht
= buffer_registry_uid
;
166 DBG3("Buffer registry per UID adding to global registry with id: %" PRIu64
,
170 nodep
= cds_lfht_add_unique(ht
->ht
, ht
->hash_fct(reg
, lttng_ht_seed
),
171 ht
->match_fct
, reg
, ®
->node
.node
);
172 assert(nodep
== ®
->node
.node
);
177 * Find a buffer registry per UID object with given params. RCU read side lock
178 * MUST be acquired before calling this and hold on to protect the object.
180 * Return the object pointer or NULL on error.
182 struct buffer_reg_uid
*buffer_reg_uid_find(uint64_t session_id
,
183 uint32_t bits_per_long
, uid_t uid
)
185 struct lttng_ht_node_u64
*node
;
186 struct lttng_ht_iter iter
;
187 struct buffer_reg_uid
*reg
= NULL
, key
;
188 struct lttng_ht
*ht
= buffer_registry_uid
;
190 /* Setup key we are looking for. */
191 key
.session_id
= session_id
;
192 key
.bits_per_long
= bits_per_long
;
195 DBG3("Buffer registry per UID find id: %" PRIu64
", ABI: %u, uid: %d",
196 session_id
, bits_per_long
, uid
);
198 /* Custom lookup function since it's a different key. */
199 cds_lfht_lookup(ht
->ht
, ht
->hash_fct(&key
, lttng_ht_seed
), ht
->match_fct
,
201 node
= lttng_ht_iter_get_node_u64(&iter
);
205 reg
= caa_container_of(node
, struct buffer_reg_uid
, node
);
212 * Initialize global buffer per PID registry. Should only be called ONCE!.
214 void buffer_reg_init_pid_registry(void)
216 /* Should be called once. */
217 assert(!buffer_registry_pid
);
218 buffer_registry_pid
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
219 assert(buffer_registry_pid
);
221 DBG3("Global buffer per PID registry initialized");
225 * Allocate and initialize object. Set regp with the object pointer.
227 * Return 0 on success else a negative value and regp is untouched.
229 int buffer_reg_pid_create(uint64_t session_id
, struct buffer_reg_pid
**regp
)
232 struct buffer_reg_pid
*reg
= NULL
;
236 reg
= zmalloc(sizeof(*reg
));
238 PERROR("zmalloc buffer registry pid");
243 reg
->registry
= zmalloc(sizeof(struct buffer_reg_session
));
244 if (!reg
->registry
) {
245 PERROR("zmalloc buffer registry pid session");
250 /* A cast is done here so we can use the session ID as a u64 ht node. */
251 reg
->session_id
= session_id
;
253 reg
->registry
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
254 if (!reg
->registry
->channels
) {
259 lttng_ht_node_init_u64(®
->node
, reg
->session_id
);
262 DBG3("Buffer registry per PID created with session id: %" PRIu64
,
275 * Add a buffer registry per PID object to the global registry.
277 void buffer_reg_pid_add(struct buffer_reg_pid
*reg
)
281 DBG3("Buffer registry per PID adding to global registry with id: %" PRIu64
,
285 lttng_ht_add_unique_u64(buffer_registry_pid
, ®
->node
);
290 * Find a buffer registry per PID object with given params. RCU read side lock
291 * MUST be acquired before calling this and hold on to protect the object.
293 * Return the object pointer or NULL on error.
295 struct buffer_reg_pid
*buffer_reg_pid_find(uint64_t session_id
)
297 struct lttng_ht_node_u64
*node
;
298 struct lttng_ht_iter iter
;
299 struct buffer_reg_pid
*reg
= NULL
;
300 struct lttng_ht
*ht
= buffer_registry_pid
;
302 DBG3("Buffer registry per PID find id: %" PRIu64
, session_id
);
304 lttng_ht_lookup(ht
, &session_id
, &iter
);
305 node
= lttng_ht_iter_get_node_u64(&iter
);
309 reg
= caa_container_of(node
, struct buffer_reg_pid
, node
);
316 * Allocate and initialize a buffer registry channel with the given key. Set
317 * regp with the object pointer.
319 * Return 0 on success or else a negative value keeping regp untouched.
321 int buffer_reg_channel_create(uint64_t key
, struct buffer_reg_channel
**regp
)
323 struct buffer_reg_channel
*reg
;
327 DBG3("Buffer registry channel create with key: %" PRIu64
, key
);
329 reg
= zmalloc(sizeof(*reg
));
331 PERROR("zmalloc buffer registry channel");
336 CDS_INIT_LIST_HEAD(®
->streams
);
337 pthread_mutex_init(®
->stream_list_lock
, NULL
);
339 lttng_ht_node_init_u64(®
->node
, key
);
346 * Allocate and initialize a buffer registry stream. Set regp with the object
349 * Return 0 on success or else a negative value keeping regp untouched.
351 int buffer_reg_stream_create(struct buffer_reg_stream
**regp
)
353 struct buffer_reg_stream
*reg
;
357 DBG3("Buffer registry creating stream");
359 reg
= zmalloc(sizeof(*reg
));
361 PERROR("zmalloc buffer registry stream");
371 * Add stream to the list in the channel.
373 void buffer_reg_stream_add(struct buffer_reg_stream
*stream
,
374 struct buffer_reg_channel
*channel
)
379 pthread_mutex_lock(&channel
->stream_list_lock
);
380 cds_list_add_tail(&stream
->lnode
, &channel
->streams
);
381 channel
->stream_count
++;
382 pthread_mutex_unlock(&channel
->stream_list_lock
);
386 * Add a buffer registry channel object to the given session.
388 void buffer_reg_channel_add(struct buffer_reg_session
*session
,
389 struct buffer_reg_channel
*channel
)
395 lttng_ht_add_unique_u64(session
->channels
, &channel
->node
);
400 * Find a buffer registry channel object with the given key. RCU read side lock
401 * MUST be acquired and hold on until the object reference is not needed
404 * Return the object pointer or NULL on error.
406 struct buffer_reg_channel
*buffer_reg_channel_find(uint64_t key
,
407 struct buffer_reg_uid
*reg
)
409 struct lttng_ht_node_u64
*node
;
410 struct lttng_ht_iter iter
;
411 struct buffer_reg_channel
*chan
= NULL
;
416 switch (reg
->domain
) {
417 case LTTNG_DOMAIN_UST
:
418 ht
= reg
->registry
->channels
;
425 lttng_ht_lookup(ht
, &key
, &iter
);
426 node
= lttng_ht_iter_get_node_u64(&iter
);
430 chan
= caa_container_of(node
, struct buffer_reg_channel
, node
);
437 * Destroy a buffer registry stream with the given domain.
439 void buffer_reg_stream_destroy(struct buffer_reg_stream
*regp
,
440 enum lttng_domain_type domain
)
446 DBG3("Buffer registry stream destroy with handle %d",
447 regp
->obj
.ust
->handle
);
450 case LTTNG_DOMAIN_UST
:
454 ret
= ust_ctl_release_object(-1, regp
->obj
.ust
);
455 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
456 ERR("Buffer reg stream release obj handle %d failed with ret %d",
457 regp
->obj
.ust
->handle
, ret
);
460 lttng_fd_put(LTTNG_FD_APPS
, 2);
472 * Remove buffer registry channel object from the session hash table. RCU read
473 * side lock MUST be acquired before calling this.
475 void buffer_reg_channel_remove(struct buffer_reg_session
*session
,
476 struct buffer_reg_channel
*regp
)
479 struct lttng_ht_iter iter
;
484 iter
.iter
.node
= ®p
->node
.node
;
485 ret
= lttng_ht_del(session
->channels
, &iter
);
490 * Destroy a buffer registry channel with the given domain.
492 void buffer_reg_channel_destroy(struct buffer_reg_channel
*regp
,
493 enum lttng_domain_type domain
)
499 DBG3("Buffer registry channel destroy with key %" PRIu32
, regp
->key
);
502 case LTTNG_DOMAIN_UST
:
505 struct buffer_reg_stream
*sreg
, *stmp
;
507 cds_list_for_each_entry_safe(sreg
, stmp
, ®p
->streams
, lnode
) {
508 cds_list_del(&sreg
->lnode
);
509 regp
->stream_count
--;
510 buffer_reg_stream_destroy(sreg
, domain
);
514 ret
= ust_ctl_release_object(-1, regp
->obj
.ust
);
515 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
516 ERR("Buffer reg channel release obj handle %d failed with ret %d",
517 regp
->obj
.ust
->handle
, ret
);
521 lttng_fd_put(LTTNG_FD_APPS
, 1);
533 * Destroy a buffer registry session with the given domain.
535 * Should *NOT* be called with RCU read-side lock held.
537 static void buffer_reg_session_destroy(struct buffer_reg_session
*regp
,
538 enum lttng_domain_type domain
)
541 struct lttng_ht_iter iter
;
542 struct buffer_reg_channel
*reg_chan
;
544 DBG3("Buffer registry session destroy");
546 /* Destroy all channels. */
548 cds_lfht_for_each_entry(regp
->channels
->ht
, &iter
.iter
, reg_chan
,
550 ret
= lttng_ht_del(regp
->channels
, &iter
);
552 buffer_reg_channel_destroy(reg_chan
, domain
);
556 ht_cleanup_push(regp
->channels
);
559 case LTTNG_DOMAIN_UST
:
560 ust_registry_session_destroy(regp
->reg
.ust
);
572 * Remove buffer registry UID object from the global hash table.
574 void buffer_reg_uid_remove(struct buffer_reg_uid
*regp
)
577 struct lttng_ht_iter iter
;
582 iter
.iter
.node
= ®p
->node
.node
;
583 ret
= lttng_ht_del(buffer_registry_uid
, &iter
);
588 static void rcu_free_buffer_reg_uid(struct rcu_head
*head
)
590 struct lttng_ht_node_u64
*node
=
591 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
592 struct buffer_reg_uid
*reg
=
593 caa_container_of(node
, struct buffer_reg_uid
, node
);
595 buffer_reg_session_destroy(reg
->registry
, reg
->domain
);
599 static void rcu_free_buffer_reg_pid(struct rcu_head
*head
)
601 struct lttng_ht_node_u64
*node
=
602 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
603 struct buffer_reg_pid
*reg
=
604 caa_container_of(node
, struct buffer_reg_pid
, node
);
606 buffer_reg_session_destroy(reg
->registry
, LTTNG_DOMAIN_UST
);
611 * Destroy buffer registry per UID. The given pointer is NOT removed from any
612 * list or hash table. Use buffer_reg_pid_remove() before calling this function
613 * for the case that the object is in the global hash table.
615 void buffer_reg_uid_destroy(struct buffer_reg_uid
*regp
,
616 struct consumer_output
*consumer
)
618 struct consumer_socket
*socket
;
624 DBG3("Buffer registry per UID destroy with id: %" PRIu64
", ABI: %u, uid: %d",
625 regp
->session_id
, regp
->bits_per_long
, regp
->uid
);
632 /* Get the right socket from the consumer object. */
633 socket
= consumer_find_socket_by_bitness(regp
->bits_per_long
,
639 switch (regp
->domain
) {
640 case LTTNG_DOMAIN_UST
:
641 if (regp
->registry
->reg
.ust
->metadata_key
) {
642 /* Return value does not matter. This call will print errors. */
643 (void) consumer_close_metadata(socket
,
644 regp
->registry
->reg
.ust
->metadata_key
);
656 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_uid
);
660 * Remove buffer registry UID object from the global hash table. RCU read side
661 * lock MUST be acquired before calling this.
663 void buffer_reg_pid_remove(struct buffer_reg_pid
*regp
)
666 struct lttng_ht_iter iter
;
670 iter
.iter
.node
= ®p
->node
.node
;
671 ret
= lttng_ht_del(buffer_registry_pid
, &iter
);
676 * Destroy buffer registry per PID. The pointer is NOT removed from the global
677 * hash table. Call buffer_reg_pid_remove() before that if the object was
678 * previously added to the global hash table.
680 void buffer_reg_pid_destroy(struct buffer_reg_pid
*regp
)
686 DBG3("Buffer registry per PID destroy with id: %" PRIu64
,
689 /* This registry is only used by UST. */
690 call_rcu(®p
->node
.head
, rcu_free_buffer_reg_pid
);
694 * Destroy per PID and UID registry hash table.
696 * Should *NOT* be called with RCU read-side lock held.
698 void buffer_reg_destroy_registries(void)
700 DBG3("Buffer registry destroy all registry");
701 ht_cleanup_push(buffer_registry_uid
);
702 ht_cleanup_push(buffer_registry_pid
);
This page took 0.045236 seconds and 4 git commands to generate.