Commit | Line | Data |
---|---|---|
97ee3a89 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
97ee3a89 DG |
7 | * |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
97ee3a89 DG |
16 | */ |
17 | ||
18 | #ifndef _LTT_TRACE_UST_H | |
19 | #define _LTT_TRACE_UST_H | |
20 | ||
3bd1e081 | 21 | #include <config.h> |
97ee3a89 DG |
22 | #include <limits.h> |
23 | #include <urcu/list.h> | |
bec39940 | 24 | |
97ee3a89 | 25 | #include <lttng/lttng.h> |
10a8a223 | 26 | #include <common/hashtable/hashtable.h> |
ce2a9e76 | 27 | #include <common/defaults.h> |
3bd1e081 | 28 | |
00e2e675 | 29 | #include "consumer.h" |
48842b30 | 30 | #include "ust-ctl.h" |
97ee3a89 | 31 | |
18eace3b DG |
32 | struct ltt_ust_ht_key { |
33 | const char *name; | |
34 | const struct lttng_filter_bytecode *filter; | |
35 | enum lttng_ust_loglevel_type loglevel; | |
36 | }; | |
37 | ||
f6a9efaa DG |
38 | /* Context hash table nodes */ |
39 | struct ltt_ust_context { | |
40 | struct lttng_ust_context ctx; | |
bec39940 | 41 | struct lttng_ht_node_ulong node; |
97ee3a89 DG |
42 | }; |
43 | ||
44 | /* UST event */ | |
45 | struct ltt_ust_event { | |
37357452 | 46 | unsigned int enabled; |
f6a9efaa | 47 | struct lttng_ust_event attr; |
bec39940 | 48 | struct lttng_ht_node_str node; |
53a80697 | 49 | struct lttng_ust_filter_bytecode *filter; |
2bdd86d4 MD |
50 | }; |
51 | ||
97ee3a89 DG |
52 | /* UST channel */ |
53 | struct ltt_ust_channel { | |
7972aab2 | 54 | uint64_t id; /* unique id per session. */ |
37357452 | 55 | unsigned int enabled; |
44d3bd01 | 56 | char name[LTTNG_UST_SYM_NAME_LEN]; |
ffe60014 | 57 | struct lttng_ust_channel_attr attr; |
bec39940 DG |
58 | struct lttng_ht *ctx; |
59 | struct lttng_ht *events; | |
60 | struct lttng_ht_node_str node; | |
1624d5b7 JD |
61 | uint64_t tracefile_size; |
62 | uint64_t tracefile_count; | |
97ee3a89 DG |
63 | }; |
64 | ||
65 | /* UST Metadata */ | |
66 | struct ltt_ust_metadata { | |
67 | int handle; | |
13161846 | 68 | struct lttng_ust_object_data *obj; |
f6a9efaa | 69 | char pathname[PATH_MAX]; /* Trace file path name */ |
ffe60014 | 70 | struct lttng_ust_channel_attr attr; |
13161846 | 71 | struct lttng_ust_object_data *stream_obj; |
97ee3a89 DG |
72 | }; |
73 | ||
f6a9efaa DG |
74 | /* UST domain global (LTTNG_DOMAIN_UST) */ |
75 | struct ltt_ust_domain_global { | |
bec39940 | 76 | struct lttng_ht *channels; |
7972aab2 | 77 | struct cds_list_head registry_buffer_uid_list; |
f6a9efaa DG |
78 | }; |
79 | ||
97ee3a89 DG |
80 | /* UST session */ |
81 | struct ltt_ust_session { | |
a991f516 | 82 | int id; /* Unique identifier of session */ |
36dc12cc | 83 | int start_trace; |
f6a9efaa | 84 | struct ltt_ust_domain_global domain_global; |
6df2e2c9 MD |
85 | /* UID/GID of the user owning the session */ |
86 | uid_t uid; | |
87 | gid_t gid; | |
00e2e675 DG |
88 | /* |
89 | * Two consumer_output object are needed where one is for the current | |
90 | * output object and the second one is the temporary object used to store | |
91 | * URI being set by the lttng_set_consumer_uri call. Once | |
92 | * lttng_enable_consumer is called, the two pointers are swapped. | |
93 | */ | |
94 | struct consumer_output *consumer; | |
95 | struct consumer_output *tmp_consumer; | |
f3f0db50 DG |
96 | /* Sequence number for filters so the tracer knows the ordering. */ |
97 | uint64_t filter_seq_num; | |
7972aab2 DG |
98 | /* This indicates which type of buffer this session is set for. */ |
99 | enum lttng_buffer_type buffer_type; | |
100 | /* If set to 1, the buffer_type can not be changed anymore. */ | |
101 | int buffer_type_changed; | |
102 | /* For per UID buffer, every buffer reg object is kept of this session */ | |
103 | struct cds_list_head buffer_reg_uid_list; | |
104 | /* Next channel ID available for a newly registered channel. */ | |
105 | uint64_t next_channel_id; | |
106 | /* Once this value reaches UINT32_MAX, no more id can be allocated. */ | |
107 | uint64_t used_channel_id; | |
2bba9e53 DG |
108 | /* Tell or not if the session has to output the traces. */ |
109 | unsigned int output_traces; | |
97ee3a89 DG |
110 | }; |
111 | ||
7972aab2 DG |
112 | /* |
113 | * Validate that the id has reached the maximum allowed or not. | |
114 | * | |
115 | * Return 0 if NOT else 1. | |
116 | */ | |
117 | static inline int trace_ust_is_max_id(uint64_t id) | |
118 | { | |
119 | return (id == UINT64_MAX) ? 1 : 0; | |
120 | } | |
121 | ||
122 | /* | |
123 | * Return next available channel id and increment the used counter. The | |
124 | * trace_ust_is_max_id function MUST be called before in order to validate if | |
125 | * the maximum number of IDs have been reached. If not, it is safe to call this | |
126 | * function. | |
127 | * | |
128 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
129 | * is returned. | |
130 | */ | |
131 | static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s) | |
132 | { | |
133 | if (trace_ust_is_max_id(s->used_channel_id)) { | |
134 | return s->used_channel_id; | |
135 | } | |
136 | ||
137 | s->used_channel_id++; | |
138 | return s->next_channel_id++; | |
139 | } | |
140 | ||
74d0b642 | 141 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 142 | |
18eace3b DG |
143 | int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key); |
144 | int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
145 | const void *_key); | |
146 | ||
97ee3a89 DG |
147 | /* |
148 | * Lookup functions. NULL is returned if not found. | |
149 | */ | |
18eace3b DG |
150 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
151 | char *name, struct lttng_filter_bytecode *filter, int loglevel); | |
bec39940 | 152 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 153 | char *name); |
97ee3a89 DG |
154 | |
155 | /* | |
156 | * Create functions malloc() the data structure. | |
157 | */ | |
dec56f6c DG |
158 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id); |
159 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr); | |
025faf73 DG |
160 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
161 | struct lttng_filter_bytecode *filter); | |
97ee3a89 | 162 | struct ltt_ust_metadata *trace_ust_create_metadata(char *path); |
55cc08a6 DG |
163 | struct ltt_ust_context *trace_ust_create_context( |
164 | struct lttng_event_context *ctx); | |
d5979e4a DG |
165 | void trace_ust_delete_channel(struct lttng_ht *ht, |
166 | struct ltt_ust_channel *channel); | |
97ee3a89 DG |
167 | |
168 | /* | |
169 | * Destroy functions free() the data structure and remove from linked list if | |
170 | * it's applies. | |
171 | */ | |
172 | void trace_ust_destroy_session(struct ltt_ust_session *session); | |
173 | void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata); | |
174 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel); | |
175 | void trace_ust_destroy_event(struct ltt_ust_event *event); | |
176 | ||
74d0b642 | 177 | #else /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 178 | |
37a86c61 DG |
179 | static inline int trace_ust_ht_match_event(struct cds_lfht_node *node, |
180 | const void *_key) | |
181 | { | |
182 | return 0; | |
183 | } | |
184 | static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
185 | const void *_key) | |
186 | { | |
187 | return 0; | |
188 | } | |
3bd1e081 | 189 | static inline |
bec39940 | 190 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 191 | char *name) |
3bd1e081 MD |
192 | { |
193 | return NULL; | |
194 | } | |
f6a9efaa | 195 | |
3bd1e081 | 196 | static inline |
dec56f6c | 197 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id) |
3bd1e081 MD |
198 | { |
199 | return NULL; | |
200 | } | |
201 | static inline | |
dec56f6c | 202 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr) |
3bd1e081 MD |
203 | { |
204 | return NULL; | |
205 | } | |
206 | static inline | |
025faf73 DG |
207 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
208 | struct lttng_filter_bytecode *filter) | |
3bd1e081 MD |
209 | { |
210 | return NULL; | |
211 | } | |
212 | static inline | |
213 | struct ltt_ust_metadata *trace_ust_create_metadata(char *path) | |
214 | { | |
215 | return NULL; | |
216 | } | |
217 | ||
218 | static inline | |
219 | void trace_ust_destroy_session(struct ltt_ust_session *session) | |
220 | { | |
221 | } | |
48842b30 | 222 | |
3bd1e081 MD |
223 | static inline |
224 | void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata) | |
225 | { | |
226 | } | |
48842b30 | 227 | |
3bd1e081 MD |
228 | static inline |
229 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel) | |
230 | { | |
231 | } | |
48842b30 | 232 | |
3bd1e081 MD |
233 | static inline |
234 | void trace_ust_destroy_event(struct ltt_ust_event *event) | |
235 | { | |
236 | } | |
34378f76 DG |
237 | static inline |
238 | struct ltt_ust_context *trace_ust_create_context( | |
239 | struct lttng_event_context *ctx) | |
240 | { | |
241 | return NULL; | |
242 | } | |
37a86c61 DG |
243 | static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
244 | char *name, struct lttng_filter_bytecode *filter, int loglevel) | |
245 | { | |
246 | return NULL; | |
247 | } | |
d5979e4a DG |
248 | static inline |
249 | void trace_ust_delete_channel(struct lttng_ht *ht, | |
250 | struct ltt_ust_channel *channel) | |
251 | { | |
252 | return; | |
253 | } | |
3bd1e081 | 254 | |
74d0b642 | 255 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 256 | |
97ee3a89 | 257 | #endif /* _LTT_TRACE_UST_H */ |