Introduce lttng_event_rule_jul_logging
[lttng-tools.git] / src / common / event-rule / event-rule.c
CommitLineData
7a3dcaf6
JR
1/*
2 * Copyright (C) 2019 Jonathan Rajotte
3 * <jonathan.rajotte-julien@efficios.com>
4 *
5 * SPDX-License-Identifier: LGPL-2.1-only
6 *
7 */
8
9#include <assert.h>
10#include <common/error.h>
11#include <common/macros.h>
12#include <common/payload.h>
13#include <common/payload-view.h>
959e3c66
JR
14#include <common/hashtable/hashtable.h>
15#include <common/hashtable/utils.h>
7a3dcaf6 16#include <lttng/event-rule/event-rule-internal.h>
d84633c4 17#include <lttng/event-rule/kernel-kprobe-internal.h>
213efb0c 18#include <lttng/event-rule/kernel-syscall-internal.h>
d440991b 19#include <lttng/event-rule/jul-logging-internal.h>
6d420eff 20#include <lttng/event-rule/tracepoint-internal.h>
b25b2570 21#include <lttng/event-rule/kernel-tracepoint-internal.h>
e60e9a9a 22#include <lttng/event-rule/kernel-uprobe-internal.h>
cc66eccf 23#include <lttng/event-rule/user-tracepoint-internal.h>
7a3dcaf6
JR
24#include <stdbool.h>
25
26enum lttng_event_rule_type lttng_event_rule_get_type(
27 const struct lttng_event_rule *event_rule)
28{
29 return event_rule ? event_rule->type : LTTNG_EVENT_RULE_TYPE_UNKNOWN;
30}
31
32LTTNG_HIDDEN
33enum lttng_domain_type lttng_event_rule_get_domain_type(
34 const struct lttng_event_rule *event_rule)
35{
36 enum lttng_domain_type domain_type = LTTNG_DOMAIN_NONE;
37
38 switch (lttng_event_rule_get_type(event_rule)) {
39 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
6d420eff
JR
40 {
41 enum lttng_event_rule_status status;
42 status = lttng_event_rule_tracepoint_get_domain_type(event_rule, &domain_type);
43 assert(status == LTTNG_EVENT_RULE_STATUS_OK);
7a3dcaf6 44 break;
6d420eff 45 }
cc66eccf
JR
46 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
47 domain_type = LTTNG_DOMAIN_UST;
48 break;
d440991b
JR
49 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
50 domain_type = LTTNG_DOMAIN_JUL;
51 break;
213efb0c 52 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
d84633c4 53 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
f2d09181 54 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
e60e9a9a 55 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
b25b2570 56 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
7a3dcaf6
JR
57 domain_type = LTTNG_DOMAIN_KERNEL;
58 break;
59 case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
60 domain_type = LTTNG_DOMAIN_NONE;
61 break;
62 }
63
64 return domain_type;
65}
66
67static void lttng_event_rule_release(struct urcu_ref *ref)
68{
69 struct lttng_event_rule *event_rule =
70 container_of(ref, typeof(*event_rule), ref);
71
72 assert(event_rule->destroy);
73 event_rule->destroy(event_rule);
74}
75
76void lttng_event_rule_destroy(struct lttng_event_rule *event_rule)
77{
78 lttng_event_rule_put(event_rule);
79}
80
81LTTNG_HIDDEN
82bool lttng_event_rule_validate(const struct lttng_event_rule *event_rule)
83{
84 bool valid;
85
86 if (!event_rule) {
87 valid = false;
88 goto end;
89 }
90
91 if (!event_rule->validate) {
92 /* Sub-class guarantees that it can never be invalid. */
93 valid = true;
94 goto end;
95 }
96
97 valid = event_rule->validate(event_rule);
98end:
99 return valid;
100}
101
102LTTNG_HIDDEN
103int lttng_event_rule_serialize(const struct lttng_event_rule *event_rule,
104 struct lttng_payload *payload)
105{
106 int ret;
107 struct lttng_event_rule_comm event_rule_comm = {};
108
109 if (!event_rule) {
110 ret = -1;
111 goto end;
112 }
113
114 event_rule_comm.event_rule_type = (int8_t) event_rule->type;
115
116 ret = lttng_dynamic_buffer_append(
117 &payload->buffer, &event_rule_comm, sizeof(event_rule_comm));
118 if (ret) {
119 goto end;
120 }
121
122 ret = event_rule->serialize(event_rule, payload);
123 if (ret) {
124 goto end;
125 }
126end:
127 return ret;
128}
129
130LTTNG_HIDDEN
131bool lttng_event_rule_is_equal(const struct lttng_event_rule *a,
132 const struct lttng_event_rule *b)
133{
134 bool is_equal = false;
135
136 if (!a || !b) {
137 goto end;
138 }
139
140 if (a->type != b->type) {
141 goto end;
142 }
143
144 if (a == b) {
145 is_equal = true;
146 goto end;
147 }
148
149 is_equal = a->equal ? a->equal(a, b) : true;
150end:
151 return is_equal;
152}
153
154LTTNG_HIDDEN
155ssize_t lttng_event_rule_create_from_payload(
156 struct lttng_payload_view *view,
157 struct lttng_event_rule **event_rule)
158{
159 ssize_t ret, consumed = 0;
7a3dcaf6 160 event_rule_create_from_payload_cb create_from_payload = NULL;
3e6e0df2
JG
161 const struct lttng_event_rule_comm *event_rule_comm;
162 const struct lttng_payload_view event_rule_comm_view =
163 lttng_payload_view_from_view(
164 view, 0, sizeof(*event_rule_comm));
7a3dcaf6
JR
165
166 if (!view || !event_rule) {
167 ret = -1;
168 goto end;
169 }
170
3e6e0df2
JG
171 if (!lttng_payload_view_is_valid(&event_rule_comm_view)) {
172 ret = -1;
173 goto end;
174 }
175
683d081a 176 DBG("Deserializing event_rule from payload");
3e6e0df2 177 event_rule_comm = (const struct lttng_event_rule_comm *) event_rule_comm_view.buffer.data;
7a3dcaf6
JR
178 consumed += sizeof(*event_rule_comm);
179
180 switch ((enum lttng_event_rule_type) event_rule_comm->event_rule_type) {
181 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
6d420eff
JR
182 create_from_payload =
183 lttng_event_rule_tracepoint_create_from_payload;
7a3dcaf6 184 break;
d84633c4
JR
185 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
186 create_from_payload = lttng_event_rule_kernel_kprobe_create_from_payload;
7a3dcaf6 187 break;
f2d09181 188 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
7a3dcaf6
JR
189 /* TODO */
190 break;
e60e9a9a
JR
191 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
192 create_from_payload = lttng_event_rule_kernel_uprobe_create_from_payload;
7a3dcaf6 193 break;
213efb0c 194 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
e6a39346 195 create_from_payload =
213efb0c 196 lttng_event_rule_kernel_syscall_create_from_payload;
7a3dcaf6 197 break;
b25b2570
JR
198 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
199 create_from_payload =
200 lttng_event_rule_kernel_tracepoint_create_from_payload;
201 break;
cc66eccf
JR
202 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
203 create_from_payload =
204 lttng_event_rule_user_tracepoint_create_from_payload;
205 break;
d440991b
JR
206 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
207 create_from_payload =
208 lttng_event_rule_jul_logging_create_from_payload;
209 break;
7a3dcaf6
JR
210 default:
211 ERR("Attempted to create event rule of unknown type (%i)",
212 (int) event_rule_comm->event_rule_type);
213 ret = -1;
214 goto end;
215 }
216
217 assert(create_from_payload);
218
219 {
220 struct lttng_payload_view child_view =
221 lttng_payload_view_from_view(
222 view, consumed, -1);
223
224 ret = create_from_payload(&child_view, event_rule);
225 if (ret < 0) {
226 goto end;
227 }
228
229 consumed += ret;
230 }
231
232 if (!lttng_event_rule_validate(*event_rule)) {
233 ret = -1;
234 goto end;
235 }
236
237 ret = consumed;
238end:
239 return ret;
240}
241
242LTTNG_HIDDEN
243void lttng_event_rule_init(struct lttng_event_rule *event_rule,
244 enum lttng_event_rule_type type)
245{
246 urcu_ref_init(&event_rule->ref);
247 event_rule->type = type;
248}
249
250LTTNG_HIDDEN
251bool lttng_event_rule_get(struct lttng_event_rule *event_rule)
252{
253 return urcu_ref_get_unless_zero(&event_rule->ref);
254}
255
256LTTNG_HIDDEN
257void lttng_event_rule_put(struct lttng_event_rule *event_rule)
258{
259 if (!event_rule) {
260 return;
261 }
262
263 assert(event_rule->ref.refcount);
264 urcu_ref_put(&event_rule->ref, lttng_event_rule_release);
265}
266
267LTTNG_HIDDEN
268enum lttng_error_code lttng_event_rule_generate_filter_bytecode(
58daac01
JR
269 struct lttng_event_rule *rule,
270 const struct lttng_credentials *creds)
7a3dcaf6
JR
271{
272 assert(rule->generate_filter_bytecode);
58daac01 273 return rule->generate_filter_bytecode(rule, creds);
7a3dcaf6
JR
274}
275
276LTTNG_HIDDEN
277const char *lttng_event_rule_get_filter(const struct lttng_event_rule *rule)
278{
279 assert(rule->get_filter);
280 return rule->get_filter(rule);
281}
282
283LTTNG_HIDDEN
2b00d462 284const struct lttng_bytecode *lttng_event_rule_get_filter_bytecode(
7a3dcaf6
JR
285 const struct lttng_event_rule *rule)
286{
287 assert(rule->get_filter_bytecode);
288 return rule->get_filter_bytecode(rule);
289}
290
291LTTNG_HIDDEN
993578ff
JR
292enum lttng_event_rule_generate_exclusions_status
293lttng_event_rule_generate_exclusions(const struct lttng_event_rule *rule,
294 struct lttng_event_exclusion **exclusions)
7a3dcaf6
JR
295{
296 assert(rule->generate_exclusions);
993578ff 297 return rule->generate_exclusions(rule, exclusions);
7a3dcaf6
JR
298}
299
300LTTNG_HIDDEN
44760c20
JR
301struct lttng_event *lttng_event_rule_generate_lttng_event(
302 const struct lttng_event_rule *rule)
303{
304 assert(rule->generate_lttng_event);
305 return rule->generate_lttng_event(rule);
306}
307
308LTTNG_HIDDEN
309bool lttng_event_rule_targets_agent_domain(const struct lttng_event_rule *rule)
310{
311 bool targets_agent_domain = false;
312 enum lttng_domain_type type = lttng_event_rule_get_domain_type(rule);
313
314 switch (type) {
315 case LTTNG_DOMAIN_JUL:
316 case LTTNG_DOMAIN_LOG4J:
317 case LTTNG_DOMAIN_PYTHON:
318 targets_agent_domain = true;
319 break;
320 case LTTNG_DOMAIN_UST:
321 case LTTNG_DOMAIN_KERNEL:
322 targets_agent_domain = false;
323 break;
324 default:
325 abort();
326 };
327
328 return targets_agent_domain;
329}
330
7a3dcaf6
JR
331const char *lttng_event_rule_type_str(enum lttng_event_rule_type type)
332{
333 switch (type) {
334 case LTTNG_EVENT_RULE_TYPE_UNKNOWN:
335 return "unknown";
336 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT:
337 return "tracepoint";
213efb0c
JR
338 case LTTNG_EVENT_RULE_TYPE_KERNEL_SYSCALL:
339 return "kernel syscall";
d84633c4
JR
340 case LTTNG_EVENT_RULE_TYPE_KERNEL_KPROBE:
341 return "kernel kprobe";
f2d09181 342 case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
7a3dcaf6 343 return "function";
e60e9a9a
JR
344 case LTTNG_EVENT_RULE_TYPE_KERNEL_UPROBE:
345 return "kernel uprobe";
b25b2570
JR
346 case LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT:
347 return "kernel tracepoint";
cc66eccf
JR
348 case LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT:
349 return "user tracepoint";
d440991b
JR
350 case LTTNG_EVENT_RULE_TYPE_JUL_LOGGING:
351 return "jul logging";
7a3dcaf6
JR
352 default:
353 abort();
354 }
355}
959e3c66
JR
356
357LTTNG_HIDDEN
358unsigned long lttng_event_rule_hash(const struct lttng_event_rule *rule)
359{
360 assert(rule->hash);
361 return rule->hash(rule);
362}
This page took 0.044355 seconds and 5 git commands to generate.