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_BUFFER_REGISTRY_H
19 #define LTTNG_BUFFER_REGISTRY_H
22 #include <urcu/list.h>
24 #include <lttng/lttng.h>
25 #include <common/hashtable/hashtable.h>
29 #include "ust-registry.h"
31 struct buffer_reg_stream
{
32 struct cds_list_head lnode
;
34 /* Original object data that MUST be copied over. */
35 struct lttng_ust_object_data
*ust
;
39 struct buffer_reg_channel
{
40 /* This key is the same as a tracing channel key. */
42 /* Key of the channel on the consumer side. */
43 uint64_t consumer_key
;
44 /* Stream registry object of this channel registry. */
45 struct cds_list_head streams
;
46 /* Used to ensure mutual exclusion to the stream's list. */
47 pthread_mutex_t stream_list_lock
;
48 /* Node for hash table usage. */
49 struct lttng_ht_node_u64 node
;
51 /* Original object data that MUST be copied over. */
52 struct lttng_ust_object_data
*ust
;
56 struct buffer_reg_session
{
57 /* Registry per domain. */
59 struct ust_registry_session
*ust
;
62 /* Contains buffer registry channel indexed by tracing channel key. */
63 struct lttng_ht
*channels
;
67 * Registry object for per UID buffers.
69 struct buffer_reg_uid
{
71 * Keys to match this object in a hash table. The following three variables
72 * identify a unique per UID buffer registry.
74 int session_id
; /* Unique tracing session id. */
75 int bits_per_long
; /* ABI */
76 uid_t uid
; /* Owner. */
78 enum lttng_domain_type domain
;
79 struct buffer_reg_session
*registry
;
81 /* Indexed by session id. */
82 struct lttng_ht_node_u64 node
;
83 /* Node of a linked list used to teardown object at a destroy session. */
84 struct cds_list_head lnode
;
88 * Registry object for per PID buffers.
90 struct buffer_reg_pid
{
93 struct buffer_reg_session
*registry
;
95 /* Indexed by session id. */
96 struct lttng_ht_node_ulong node
;
99 /* Buffer registry per UID. */
100 void buffer_reg_init_uid_registry(void);
101 int buffer_reg_uid_create(int session_id
, uint32_t bits_per_long
, uid_t uid
,
102 enum lttng_domain_type domain
, struct buffer_reg_uid
**regp
);
103 void buffer_reg_uid_add(struct buffer_reg_uid
*reg
);
104 struct buffer_reg_uid
*buffer_reg_uid_find(int session_id
,
105 uint32_t bits_per_long
, uid_t uid
);
106 void buffer_reg_uid_remove(struct buffer_reg_uid
*regp
);
107 void buffer_reg_uid_destroy(struct buffer_reg_uid
*regp
,
108 struct consumer_output
*consumer
);
110 /* Buffer registry per PID. */
111 void buffer_reg_init_pid_registry(void);
112 int buffer_reg_pid_create(int session_id
, struct buffer_reg_pid
**regp
);
113 void buffer_reg_pid_add(struct buffer_reg_pid
*reg
);
114 struct buffer_reg_pid
*buffer_reg_pid_find(int session_id
);
115 void buffer_reg_pid_remove(struct buffer_reg_pid
*regp
);
116 void buffer_reg_pid_destroy(struct buffer_reg_pid
*regp
);
119 int buffer_reg_channel_create(uint64_t key
, struct buffer_reg_channel
**regp
);
120 void buffer_reg_channel_add(struct buffer_reg_session
*session
,
121 struct buffer_reg_channel
*channel
);
122 struct buffer_reg_channel
*buffer_reg_channel_find(uint64_t key
,
123 struct buffer_reg_uid
*reg
);
124 void buffer_reg_channel_remove(struct buffer_reg_session
*session
,
125 struct buffer_reg_channel
*regp
);
126 void buffer_reg_channel_destroy(struct buffer_reg_channel
*regp
,
127 enum lttng_domain_type domain
);
130 int buffer_reg_stream_create(struct buffer_reg_stream
**regp
);
131 void buffer_reg_stream_add(struct buffer_reg_stream
*stream
,
132 struct buffer_reg_channel
*channel
);
133 void buffer_reg_stream_destroy(struct buffer_reg_stream
*regp
,
134 enum lttng_domain_type domain
);
137 void buffer_reg_session_destroy(struct buffer_reg_session
*regp
,
138 enum lttng_domain_type domain
);
140 /* Global registry. */
141 void buffer_reg_destroy_registries(void);
143 #endif /* LTTNG_BUFFER_REGISTRY_H */