trigger.h

/*
 * SPDX-FileCopyrightText: 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 */
 
#ifndef LTTNG_TRIGGER_H
#define LTTNG_TRIGGER_H
 
#include <lttng/constant.h>
#include <lttng/lttng-error.h>
#include <lttng/lttng-export.h>
 
#include <inttypes.h>
#include <sys/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct lttng_action;
struct lttng_condition;
 
struct lttng_trigger;
 
struct lttng_triggers;
 
enum lttng_register_trigger_status {
    LTTNG_REGISTER_TRIGGER_STATUS_OK = 0,
    LTTNG_REGISTER_TRIGGER_STATUS_INVALID = -1,
};
 
enum lttng_trigger_status {
    LTTNG_TRIGGER_STATUS_OK = 0,
 
    LTTNG_TRIGGER_STATUS_ERROR = -1,
 
    /* Unused for the moment */
    LTTNG_TRIGGER_STATUS_UNKNOWN = -2,
    LTTNG_TRIGGER_STATUS_UNSUPPORTED = -5,
 
    LTTNG_TRIGGER_STATUS_INVALID = -3,
 
    LTTNG_TRIGGER_STATUS_UNSET = -4,
 
    LTTNG_TRIGGER_STATUS_PERMISSION_DENIED = -6,
};
 
LTTNG_EXPORT extern struct lttng_trigger *lttng_trigger_create(struct lttng_condition *condition,
                                   struct lttng_action *action);
 
LTTNG_EXPORT extern enum lttng_trigger_status
lttng_trigger_set_owner_uid(struct lttng_trigger *trigger, uid_t uid);
 
LTTNG_EXPORT extern enum lttng_trigger_status
lttng_trigger_get_owner_uid(const struct lttng_trigger *trigger, uid_t *uid);
 
LTTNG_EXPORT extern struct lttng_condition *
lttng_trigger_get_condition(struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern const struct lttng_condition *
lttng_trigger_get_const_condition(const struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern struct lttng_action *lttng_trigger_get_action(struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern const struct lttng_action *
lttng_trigger_get_const_action(const struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern enum lttng_trigger_status
lttng_trigger_get_name(const struct lttng_trigger *trigger, const char **name);
 
LTTNG_EXPORT extern void lttng_trigger_destroy(struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern enum lttng_error_code
lttng_register_trigger_with_name(struct lttng_trigger *trigger, const char *name);
 
LTTNG_EXPORT extern enum lttng_error_code
lttng_register_trigger_with_automatic_name(struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern int lttng_unregister_trigger(const struct lttng_trigger *trigger);
 
LTTNG_EXPORT extern enum lttng_error_code lttng_list_triggers(struct lttng_triggers **triggers);
 
LTTNG_EXPORT extern const struct lttng_trigger *
lttng_triggers_get_at_index(const struct lttng_triggers *triggers, unsigned int index);
 
LTTNG_EXPORT extern enum lttng_trigger_status
lttng_triggers_get_count(const struct lttng_triggers *triggers, unsigned int *count);
 
LTTNG_EXPORT extern void lttng_triggers_destroy(struct lttng_triggers *triggers);
 
/*
 * Deprecated: invocations should be replaced by
 * lttng_register_trigger_with_automatic_name().
 *
 * Register a trigger to the session daemon.
 *
 * The trigger can be destroyed after this call.
 *
 * Return 0 on success, a negative LTTng error code on error.
 */
LTTNG_DEPRECATED("Use lttng_register_trigger_with_automatic_name")
LTTNG_EXPORT extern int lttng_register_trigger(struct lttng_trigger *trigger);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* LTTNG_TRIGGER_H */