2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_TRIGGER_INTERNAL_H
9 #define LTTNG_TRIGGER_INTERNAL_H
11 #include <lttng/trigger/trigger.h>
12 #include <common/macros.h>
13 #include <common/buffer-view.h>
14 #include <common/dynamic-buffer.h>
15 #include <common/dynamic-array.h>
16 #include <common/credentials.h>
19 #include <sys/types.h>
22 struct lttng_trigger
{
23 struct urcu_ref ref
; /* internal use only */
24 bool owns_internal_objects
; /* internal use only */
26 struct lttng_condition
*condition
;
27 struct lttng_action
*action
;
29 struct { /* Internal use only */
33 struct { /* internal use only */
34 struct lttng_credentials credentials
;
38 enum lttng_trigger_firing_policy_type type
;
40 uint64_t current_count
;
44 struct lttng_triggers
{
45 struct lttng_dynamic_pointer_array array
;
48 struct lttng_trigger_comm
{
49 /* length excludes its own length. */
50 uint32_t name_length
/* Includes '\0' */;
53 uint64_t policy_threshold
;
54 /* A name, condition and action object follow. */
58 struct lttng_triggers_comm
{
61 /* Count * lttng_trigger_comm structure */
66 ssize_t
lttng_trigger_create_from_buffer(const struct lttng_buffer_view
*view
,
67 struct lttng_trigger
**trigger
);
70 int lttng_trigger_serialize(const struct lttng_trigger
*trigger
,
71 struct lttng_dynamic_buffer
*buf
,
75 bool lttng_trigger_validate(const struct lttng_trigger
*trigger
);
78 int lttng_trigger_assign(struct lttng_trigger
*dst
,
79 const struct lttng_trigger
*src
);
82 bool lttng_trigger_is_equal(const struct lttng_trigger
*a
,
83 const struct lttng_trigger
*b
);
86 void lttng_trigger_set_key(struct lttng_trigger
*trigger
, uint64_t key
);
89 uint64_t lttng_trigger_get_key(const struct lttng_trigger
*trigger
);
92 int lttng_trigger_generate_name(struct lttng_trigger
*trigger
, uint64_t offset
);
95 * Allocate a new list of lttng_trigger.
96 * The returned object must be freed via lttng_triggers_destroy.
99 struct lttng_triggers
*lttng_triggers_create(void);
102 * Return the non-const pointer of an element at index "index" of a
105 * The ownership of the lttng_triggers element is NOT transfered.
106 * The returned object can NOT be freed via lttng_trigger_destroy.
109 struct lttng_trigger
*lttng_triggers_get_pointer_of_index(
110 const struct lttng_triggers
*triggers
, unsigned int index
);
116 int lttng_triggers_add(
117 struct lttng_triggers
*triggers
, struct lttng_trigger
*trigger
);
120 * Serialize a trigger collection to a lttng_dynamic_buffer.
121 * Return LTTNG_OK on success, negative lttng error code on error.
124 int lttng_triggers_serialize(const struct lttng_triggers
*triggers
,
125 struct lttng_dynamic_buffer
*buffer
);
128 ssize_t
lttng_triggers_create_from_buffer(const struct lttng_buffer_view
*view
,
129 struct lttng_triggers
**triggers
);
132 const struct lttng_credentials
*lttng_trigger_get_credentials(
133 const struct lttng_trigger
*trigger
);
136 void lttng_trigger_set_credentials(
137 struct lttng_trigger
*trigger
, uid_t uid
, gid_t git
);
140 void lttng_trigger_get(struct lttng_trigger
*trigger
);
143 void lttng_trigger_put(struct lttng_trigger
*trigger
);
146 bool lttng_trigger_is_ready_to_fire(
147 struct lttng_trigger
*trigger
);
150 * Return the type of any uderlying domain requirement. If no particular
151 * requirement is needed return LTTNG_DOMAIN_NONE.
154 enum lttng_domain_type
lttng_trigger_get_underlying_domain_type_restriction(
155 const struct lttng_trigger
*trigger
);
157 #endif /* LTTNG_TRIGGER_INTERNAL_H */