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