Fix: lttng-ctl: deserialize on orderly shutdown of sessiond
[lttng-tools.git] / include / lttng / trigger / trigger-internal.h
CommitLineData
a58c490f 1/*
ab5be9fa 2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
a58c490f 3 *
ab5be9fa 4 * SPDX-License-Identifier: LGPL-2.1-only
a58c490f 5 *
a58c490f
JG
6 */
7
8#ifndef LTTNG_TRIGGER_INTERNAL_H
9#define LTTNG_TRIGGER_INTERNAL_H
10
11#include <lttng/trigger/trigger.h>
3da864a9 12#include <common/credentials.h>
a02903c0 13#include <common/dynamic-array.h>
a58c490f 14#include <common/macros.h>
3da864a9 15#include <common/optional.h>
a58c490f
JG
16#include <stdint.h>
17#include <stdbool.h>
72756a3f 18#include <sys/types.h>
f01d28b4 19#include <urcu/ref.h>
a58c490f 20
c0a66c84
JG
21struct lttng_payload;
22struct lttng_payload_view;
23
a58c490f 24struct lttng_trigger {
f01d28b4
JR
25 /* Reference counting is only exposed to internal users. */
26 struct urcu_ref ref;
27
a58c490f
JG
28 struct lttng_condition *condition;
29 struct lttng_action *action;
242388e4 30 char *name;
64eafdf6
JR
31 /* For now only the uid portion of the credentials is used. */
32 struct lttng_credentials creds;
e6887944
JR
33 /*
34 * Internal use only.
35 * The unique token passed to the tracer to identify an event-rule
36 * notification.
37 */
38 LTTNG_OPTIONAL(uint64_t) tracer_token;
a58c490f
JG
39};
40
a02903c0
JR
41struct lttng_triggers {
42 struct lttng_dynamic_pointer_array array;
43};
44
a58c490f 45struct lttng_trigger_comm {
64eafdf6
JR
46 /*
47 * Credentials, only the uid portion is used for now.
48 * Used as an override when desired by the root user.
49 */
50 uint64_t uid;
242388e4
JR
51 /*
52 * Length of the variable length payload (name, condition, and
53 * an action).
54 */
55 uint32_t length;
56 /* Includes '\0' terminator. */
57 uint32_t name_length;
58 /* A null-terminated name, a condition, and an action follow. */
a58c490f
JG
59 char payload[];
60} LTTNG_PACKED;
61
a02903c0
JR
62struct lttng_triggers_comm {
63 uint32_t count;
64 uint32_t length;
65 /* Count * lttng_trigger_comm structure */
66 char payload[];
67};
68
a58c490f 69LTTNG_HIDDEN
c0a66c84 70ssize_t lttng_trigger_create_from_payload(struct lttng_payload_view *view,
a58c490f
JG
71 struct lttng_trigger **trigger);
72
73LTTNG_HIDDEN
a02903c0 74int lttng_trigger_serialize(const struct lttng_trigger *trigger,
c0a66c84 75 struct lttng_payload *payload);
a58c490f 76
9b63a4aa
JG
77LTTNG_HIDDEN
78const struct lttng_condition *lttng_trigger_get_const_condition(
79 const struct lttng_trigger *trigger);
80
81LTTNG_HIDDEN
82const struct lttng_action *lttng_trigger_get_const_action(
83 const struct lttng_trigger *trigger);
84
a58c490f
JG
85LTTNG_HIDDEN
86bool lttng_trigger_validate(struct lttng_trigger *trigger);
87
242388e4
JR
88LTTNG_HIDDEN
89int lttng_trigger_assign_name(
90 struct lttng_trigger *dst, const struct lttng_trigger *src);
91
e6887944
JR
92LTTNG_HIDDEN
93void lttng_trigger_set_tracer_token(
94 struct lttng_trigger *trigger, uint64_t token);
95
96LTTNG_HIDDEN
97uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger *trigger);
98
242388e4
JR
99LTTNG_HIDDEN
100int lttng_trigger_generate_name(struct lttng_trigger *trigger,
101 uint64_t unique_id);
102
85c06c44
JR
103LTTNG_HIDDEN
104bool lttng_trigger_is_equal(
105 const struct lttng_trigger *a, const struct lttng_trigger *b);
106
f01d28b4
JR
107LTTNG_HIDDEN
108void lttng_trigger_get(struct lttng_trigger *trigger);
109
110LTTNG_HIDDEN
111void lttng_trigger_put(struct lttng_trigger *trigger);
112
a02903c0
JR
113/*
114 * Allocate a new set of triggers.
115 * The returned object must be freed via lttng_triggers_destroy.
116 */
117LTTNG_HIDDEN
118struct lttng_triggers *lttng_triggers_create(void);
119
120/*
121 * Return the a pointer to a mutable element at index "index" of an
122 * lttng_triggers set.
123 *
124 * This differs from the public `lttng_triggers_get_at_index` in that
125 * the returned pointer to a mutable trigger.
126 *
127 * The ownership of the trigger set element is NOT transfered.
128 * The returned object can NOT be freed via lttng_trigger_destroy.
129 */
130LTTNG_HIDDEN
131struct lttng_trigger *lttng_triggers_borrow_mutable_at_index(
132 const struct lttng_triggers *triggers, unsigned int index);
133
134/*
135 * Add a trigger to the triggers set.
136 *
137 * A reference to the added trigger is acquired on behalf of the trigger set
138 * on success.
139 */
140LTTNG_HIDDEN
141int lttng_triggers_add(
142 struct lttng_triggers *triggers, struct lttng_trigger *trigger);
143
144/*
145 * Serialize a trigger set to an lttng_payload object.
146 * Return LTTNG_OK on success, negative lttng error code on error.
147 */
148LTTNG_HIDDEN
149int lttng_triggers_serialize(const struct lttng_triggers *triggers,
150 struct lttng_payload *payload);
151
152LTTNG_HIDDEN
153ssize_t lttng_triggers_create_from_payload(struct lttng_payload_view *view,
154 struct lttng_triggers **triggers);
155
3da864a9
JR
156LTTNG_HIDDEN
157const struct lttng_credentials *lttng_trigger_get_credentials(
158 const struct lttng_trigger *trigger);
159
160LTTNG_HIDDEN
64eafdf6 161void lttng_trigger_set_credentials(struct lttng_trigger *trigger,
3da864a9
JR
162 const struct lttng_credentials *creds);
163
a58c490f 164#endif /* LTTNG_TRIGGER_INTERNAL_H */
This page took 0.05382 seconds and 4 git commands to generate.