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; | |
97ee3a89 DG |
108 | }; |
109 | ||
7972aab2 DG |
110 | /* |
111 | * Validate that the id has reached the maximum allowed or not. | |
112 | * | |
113 | * Return 0 if NOT else 1. | |
114 | */ | |
115 | static inline int trace_ust_is_max_id(uint64_t id) | |
116 | { | |
117 | return (id == UINT64_MAX) ? 1 : 0; | |
118 | } | |
119 | ||
120 | /* | |
121 | * Return next available channel id and increment the used counter. The | |
122 | * trace_ust_is_max_id function MUST be called before in order to validate if | |
123 | * the maximum number of IDs have been reached. If not, it is safe to call this | |
124 | * function. | |
125 | * | |
126 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
127 | * is returned. | |
128 | */ | |
129 | static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s) | |
130 | { | |
131 | if (trace_ust_is_max_id(s->used_channel_id)) { | |
132 | return s->used_channel_id; | |
133 | } | |
134 | ||
135 | s->used_channel_id++; | |
136 | return s->next_channel_id++; | |
137 | } | |
138 | ||
74d0b642 | 139 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 140 | |
18eace3b DG |
141 | int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key); |
142 | int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
143 | const void *_key); | |
144 | ||
97ee3a89 DG |
145 | /* |
146 | * Lookup functions. NULL is returned if not found. | |
147 | */ | |
18eace3b DG |
148 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
149 | char *name, struct lttng_filter_bytecode *filter, int loglevel); | |
bec39940 | 150 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 151 | char *name); |
97ee3a89 DG |
152 | |
153 | /* | |
154 | * Create functions malloc() the data structure. | |
155 | */ | |
dec56f6c DG |
156 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id); |
157 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr); | |
025faf73 DG |
158 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
159 | struct lttng_filter_bytecode *filter); | |
97ee3a89 | 160 | struct ltt_ust_metadata *trace_ust_create_metadata(char *path); |
55cc08a6 DG |
161 | struct ltt_ust_context *trace_ust_create_context( |
162 | struct lttng_event_context *ctx); | |
97ee3a89 DG |
163 | |
164 | /* | |
165 | * Destroy functions free() the data structure and remove from linked list if | |
166 | * it's applies. | |
167 | */ | |
168 | void trace_ust_destroy_session(struct ltt_ust_session *session); | |
169 | void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata); | |
170 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel); | |
171 | void trace_ust_destroy_event(struct ltt_ust_event *event); | |
172 | ||
74d0b642 | 173 | #else /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 174 | |
37a86c61 DG |
175 | static inline int trace_ust_ht_match_event(struct cds_lfht_node *node, |
176 | const void *_key) | |
177 | { | |
178 | return 0; | |
179 | } | |
180 | static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
181 | const void *_key) | |
182 | { | |
183 | return 0; | |
184 | } | |
3bd1e081 | 185 | static inline |
bec39940 | 186 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 187 | char *name) |
3bd1e081 MD |
188 | { |
189 | return NULL; | |
190 | } | |
f6a9efaa | 191 | |
3bd1e081 | 192 | static inline |
dec56f6c | 193 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id) |
3bd1e081 MD |
194 | { |
195 | return NULL; | |
196 | } | |
197 | static inline | |
dec56f6c | 198 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr) |
3bd1e081 MD |
199 | { |
200 | return NULL; | |
201 | } | |
202 | static inline | |
025faf73 DG |
203 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
204 | struct lttng_filter_bytecode *filter) | |
3bd1e081 MD |
205 | { |
206 | return NULL; | |
207 | } | |
208 | static inline | |
209 | struct ltt_ust_metadata *trace_ust_create_metadata(char *path) | |
210 | { | |
211 | return NULL; | |
212 | } | |
213 | ||
214 | static inline | |
215 | void trace_ust_destroy_session(struct ltt_ust_session *session) | |
216 | { | |
217 | } | |
48842b30 | 218 | |
3bd1e081 MD |
219 | static inline |
220 | void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata) | |
221 | { | |
222 | } | |
48842b30 | 223 | |
3bd1e081 MD |
224 | static inline |
225 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel) | |
226 | { | |
227 | } | |
48842b30 | 228 | |
3bd1e081 MD |
229 | static inline |
230 | void trace_ust_destroy_event(struct ltt_ust_event *event) | |
231 | { | |
232 | } | |
34378f76 DG |
233 | static inline |
234 | struct ltt_ust_context *trace_ust_create_context( | |
235 | struct lttng_event_context *ctx) | |
236 | { | |
237 | return NULL; | |
238 | } | |
37a86c61 DG |
239 | static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
240 | char *name, struct lttng_filter_bytecode *filter, int loglevel) | |
241 | { | |
242 | return NULL; | |
243 | } | |
3bd1e081 | 244 | |
74d0b642 | 245 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 246 | |
97ee3a89 | 247 | #endif /* _LTT_TRACE_UST_H */ |