X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Ftrigger%2Ftrigger-internal.h;h=3b760e1675a83709e4e12bb2568d1957de8c0d39;hp=22975bf41d96136ca64e0488b497ff8cf0acfbcb;hb=58daac01d91347336f24e1fc1cacd4e7a3101e93;hpb=3647288fe42b25340f905046f3bd9aef21e12aaa diff --git a/include/lttng/trigger/trigger-internal.h b/include/lttng/trigger/trigger-internal.h index 22975bf41..3b760e167 100644 --- a/include/lttng/trigger/trigger-internal.h +++ b/include/lttng/trigger/trigger-internal.h @@ -1,52 +1,204 @@ /* - * Copyright (C) 2017 - Jérémie Galarneau + * Copyright (C) 2017 Jérémie Galarneau * - * This library is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License, version 2.1 only, - * as published by the Free Software Foundation. + * SPDX-License-Identifier: LGPL-2.1-only * - * This library is distributed in the hope that it will be useful, but WITHOUT - * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License - * for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library; if not, write to the Free Software Foundation, - * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef LTTNG_TRIGGER_INTERNAL_H #define LTTNG_TRIGGER_INTERNAL_H #include +#include +#include #include -#include -#include +#include #include #include #include +#include + +struct lttng_payload; +struct lttng_payload_view; struct lttng_trigger { + /* Reference counting is only exposed to internal users. */ + struct urcu_ref ref; + struct lttng_condition *condition; struct lttng_action *action; + char *name; + /* For now only the uid portion of the credentials is used. */ + struct lttng_credentials creds; + struct { + enum lttng_trigger_firing_policy type; + uint64_t threshold; + uint64_t current_count; + } firing_policy; + /* + * Internal use only. + * The unique token passed to the tracer to identify an event-rule + * notification. + */ + LTTNG_OPTIONAL(uint64_t) tracer_token; +}; + +struct lttng_triggers { + struct lttng_dynamic_pointer_array array; }; struct lttng_trigger_comm { - /* length excludes its own length. */ + /* + * Credentials, only the uid portion is used for now. + * Used as an override when desired by the root user. + */ + uint64_t uid; + /* + * Length of the variable length payload (name, condition, and + * an action). + */ uint32_t length; - /* A condition and action object follow. */ + /* Includes '\0' terminator. */ + uint32_t name_length; + /* Firing policy. */ + /* Maps to enum lttng_trigger_firing_policy. */ + uint8_t firing_policy_type; + uint64_t firing_policy_threshold; + /* A null-terminated name, a condition, and an action follow. */ char payload[]; } LTTNG_PACKED; +struct lttng_triggers_comm { + uint32_t count; + uint32_t length; + /* Count * lttng_trigger_comm structure */ + char payload[]; +}; + LTTNG_HIDDEN -ssize_t lttng_trigger_create_from_buffer(const struct lttng_buffer_view *view, +ssize_t lttng_trigger_create_from_payload(struct lttng_payload_view *view, struct lttng_trigger **trigger); LTTNG_HIDDEN -int lttng_trigger_serialize(struct lttng_trigger *trigger, - struct lttng_dynamic_buffer *buf); +int lttng_trigger_serialize(const struct lttng_trigger *trigger, + struct lttng_payload *payload); + +LTTNG_HIDDEN +const struct lttng_condition *lttng_trigger_get_const_condition( + const struct lttng_trigger *trigger); + +LTTNG_HIDDEN +const struct lttng_action *lttng_trigger_get_const_action( + const struct lttng_trigger *trigger); LTTNG_HIDDEN bool lttng_trigger_validate(struct lttng_trigger *trigger); +LTTNG_HIDDEN +int lttng_trigger_assign_name( + struct lttng_trigger *dst, const struct lttng_trigger *src); + +LTTNG_HIDDEN +void lttng_trigger_set_tracer_token( + struct lttng_trigger *trigger, uint64_t token); + +LTTNG_HIDDEN +uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger *trigger); + +LTTNG_HIDDEN +int lttng_trigger_generate_name(struct lttng_trigger *trigger, + uint64_t unique_id); + +LTTNG_HIDDEN +bool lttng_trigger_is_equal( + const struct lttng_trigger *a, const struct lttng_trigger *b); + +LTTNG_HIDDEN +void lttng_trigger_get(struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_put(struct lttng_trigger *trigger); + +/* + * Allocate a new set of triggers. + * The returned object must be freed via lttng_triggers_destroy. + */ +LTTNG_HIDDEN +struct lttng_triggers *lttng_triggers_create(void); + +/* + * Return the a pointer to a mutable element at index "index" of an + * lttng_triggers set. + * + * This differs from the public `lttng_triggers_get_at_index` in that + * the returned pointer to a mutable trigger. + * + * The ownership of the trigger set element is NOT transfered. + * The returned object can NOT be freed via lttng_trigger_destroy. + */ +LTTNG_HIDDEN +struct lttng_trigger *lttng_triggers_borrow_mutable_at_index( + const struct lttng_triggers *triggers, unsigned int index); + +/* + * Add a trigger to the triggers set. + * + * A reference to the added trigger is acquired on behalf of the trigger set + * on success. + */ +LTTNG_HIDDEN +int lttng_triggers_add( + struct lttng_triggers *triggers, struct lttng_trigger *trigger); + +/* + * Serialize a trigger set to an lttng_payload object. + * Return LTTNG_OK on success, negative lttng error code on error. + */ +LTTNG_HIDDEN +int lttng_triggers_serialize(const struct lttng_triggers *triggers, + struct lttng_payload *payload); + +LTTNG_HIDDEN +ssize_t lttng_triggers_create_from_payload(struct lttng_payload_view *view, + struct lttng_triggers **triggers); + +LTTNG_HIDDEN +const struct lttng_credentials *lttng_trigger_get_credentials( + const struct lttng_trigger *trigger); + +LTTNG_HIDDEN +void lttng_trigger_set_credentials(struct lttng_trigger *trigger, + const struct lttng_credentials *creds); + + +/* + * Fire the trigger. + * Increments the occurrence count. + */ +LTTNG_HIDDEN +void lttng_trigger_fire(struct lttng_trigger *trigger); + +/* + * Check if the trigger would fire. + */ +LTTNG_HIDDEN +bool lttng_trigger_should_fire(const struct lttng_trigger *trigger); + +/* + * Return the type of any underlying domain restriction. If no particular + * requirement is present, returns LTTNG_DOMAIN_NONE. + */ +LTTNG_HIDDEN +enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction( + const struct lttng_trigger *trigger); + +/* + * Generate any bytecode related to the trigger. + * On success LTTNG_OK. On error, returns lttng_error code. + */ +LTTNG_HIDDEN +enum lttng_error_code lttng_trigger_generate_bytecode( + struct lttng_trigger *trigger, + const struct lttng_credentials *creds); + #endif /* LTTNG_TRIGGER_INTERNAL_H */