SoW-2020-0002: Trace Hit Counters: trigger error reporting integration
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.h
index f5fa092629d60e7030ac0b92aba0d943228268ab..53e1ab2b5b2a98836ff520e7bf025426c909f74b 100644 (file)
@@ -1,44 +1,40 @@
 /*
- * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef _LTT_TRACE_UST_H
 #define _LTT_TRACE_UST_H
 
-#include <config.h>
 #include <limits.h>
 #include <urcu/list.h>
 
-#include <lttng/lttng.h>
-#include <common/hashtable/hashtable.h>
 #include <common/defaults.h>
+#include <common/hashtable/hashtable.h>
+#include <common/tracker.h>
+#include <lttng/lttng.h>
 
 #include "consumer.h"
-#include "ust-ctl.h"
+#include "lttng-ust-ctl.h"
+
+struct agent;
 
 struct ltt_ust_ht_key {
        const char *name;
-       const struct lttng_filter_bytecode *filter;
-       enum lttng_ust_loglevel_type loglevel;
+       const struct lttng_bytecode *filter;
+       enum lttng_ust_loglevel_type loglevel_type;
+       int loglevel_value;
+       const struct lttng_event_exclusion *exclusion;
 };
 
 /* Context hash table nodes */
 struct ltt_ust_context {
-       struct lttng_ust_context ctx;
+       struct lttng_ust_context_attr ctx;
        struct lttng_ht_node_ulong node;
+       struct cds_list_head list;
 };
 
 /* UST event */
@@ -46,76 +42,136 @@ struct ltt_ust_event {
        unsigned int enabled;
        struct lttng_ust_event attr;
        struct lttng_ht_node_str node;
-       struct lttng_ust_filter_bytecode *filter;
+       char *filter_expression;
+       struct lttng_bytecode *filter;
+       struct lttng_event_exclusion *exclusion;
+       /*
+        * An internal event is an event which was created by the session daemon
+        * through which, for example, events emitted in Agent domains are
+        * "funelled". This is used to hide internal events from external
+        * clients as they should never be modified by the external world.
+        */
+       bool internal;
 };
 
 /* UST channel */
 struct ltt_ust_channel {
+       uint64_t id;    /* unique id per session. */
        unsigned int enabled;
+       /*
+        * A UST channel can be part of a userspace sub-domain such as JUL,
+        * Log4j, Python.
+        */
+       enum lttng_domain_type domain;
        char name[LTTNG_UST_SYM_NAME_LEN];
-       char pathname[PATH_MAX];
        struct lttng_ust_channel_attr attr;
        struct lttng_ht *ctx;
+       struct cds_list_head ctx_list;
        struct lttng_ht *events;
        struct lttng_ht_node_str node;
-};
-
-/* UST Metadata */
-struct ltt_ust_metadata {
-       int handle;
-       struct lttng_ust_object_data *obj;
-       char pathname[PATH_MAX];              /* Trace file path name */
-       struct lttng_ust_channel_attr attr;
-       struct lttng_ust_object_data *stream_obj;
+       uint64_t tracefile_size;
+       uint64_t tracefile_count;
+       uint64_t per_pid_closed_app_discarded;
+       uint64_t per_pid_closed_app_lost;
+       uint64_t monitor_timer_interval;
 };
 
 /* UST domain global (LTTNG_DOMAIN_UST) */
 struct ltt_ust_domain_global {
        struct lttng_ht *channels;
+       struct cds_list_head registry_buffer_uid_list;
 };
 
-/* UST domain pid (LTTNG_DOMAIN_UST_PID) */
-struct ltt_ust_domain_pid {
-       pid_t pid;
-       struct lttng_ht *channels;
+struct ust_id_tracker_node {
        struct lttng_ht_node_ulong node;
 };
 
-/* UST domain exec name (LTTNG_DOMAIN_UST_EXEC_NAME) */
-struct ltt_ust_domain_exec {
-       char exec_name[LTTNG_UST_SYM_NAME_LEN];
-       struct lttng_ht *channels;
-       struct lttng_ht_node_str node;
+struct ust_id_tracker {
+       struct lttng_ht *ht;
 };
 
 /* UST session */
 struct ltt_ust_session {
-       int id;    /* Unique identifier of session */
-       int start_trace;
-       char pathname[PATH_MAX];
+       uint64_t id;    /* Unique identifier of session */
        struct ltt_ust_domain_global domain_global;
-       /*
-        * Those two hash tables contains data for a specific UST domain and each
-        * contains a HT of channels. See ltt_ust_domain_exec and
-        * ltt_ust_domain_pid data structures.
-        */
-       struct lttng_ht *domain_pid;
-       struct lttng_ht *domain_exec;
+       /* Hash table of agent indexed by agent domain. */
+       struct lttng_ht *agents;
        /* UID/GID of the user owning the session */
        uid_t uid;
        gid_t gid;
-       /*
-        * Two consumer_output object are needed where one is for the current
-        * output object and the second one is the temporary object used to store
-        * URI being set by the lttng_set_consumer_uri call. Once
-        * lttng_enable_consumer is called, the two pointers are swapped.
-        */
+       /* Is the session active meaning has is been started or stopped. */
+       unsigned int active:1;
        struct consumer_output *consumer;
-       struct consumer_output *tmp_consumer;
        /* Sequence number for filters so the tracer knows the ordering. */
        uint64_t filter_seq_num;
+       /* This indicates which type of buffer this session is set for. */
+       enum lttng_buffer_type buffer_type;
+       /* If set to 1, the buffer_type can not be changed anymore. */
+       int buffer_type_changed;
+       /* For per UID buffer, every buffer reg object is kept of this session */
+       struct cds_list_head buffer_reg_uid_list;
+       /* Next channel ID available for a newly registered channel. */
+       uint64_t next_channel_id;
+       /* Once this value reaches UINT32_MAX, no more id can be allocated. */
+       uint64_t used_channel_id;
+       /* Tell or not if the session has to output the traces. */
+       unsigned int output_traces;
+       unsigned int snapshot_mode;
+       unsigned int has_non_default_channel;
+       unsigned int live_timer_interval;       /* usec */
+
+       /* Metadata channel attributes. */
+       struct lttng_ust_channel_attr metadata_attr;
+
+       /*
+        * Path where to keep the shared memory files.
+        */
+       char root_shm_path[PATH_MAX];
+       char shm_path[PATH_MAX];
+
+       /* Current trace chunk of the ltt_session. */
+       struct lttng_trace_chunk *current_trace_chunk;
+
+       /* Trackers used for actual lookup on app registration. */
+       struct ust_id_tracker vpid_tracker;
+       struct ust_id_tracker vuid_tracker;
+       struct ust_id_tracker vgid_tracker;
+
+       /* Tracker list of keys requested by users. */
+       struct process_attr_tracker *tracker_vpid;
+       struct process_attr_tracker *tracker_vuid;
+       struct process_attr_tracker *tracker_vgid;
 };
 
+/*
+ * Validate that the id has reached the maximum allowed or not.
+ *
+ * Return 0 if NOT else 1.
+ */
+static inline int trace_ust_is_max_id(uint64_t id)
+{
+       return (id == UINT64_MAX) ? 1 : 0;
+}
+
+/*
+ * Return next available channel id and increment the used counter. The
+ * trace_ust_is_max_id function MUST be called before in order to validate if
+ * the maximum number of IDs have been reached. If not, it is safe to call this
+ * function.
+ *
+ * Return a unique channel ID. If max is reached, the used_channel_id counter
+ * is returned.
+ */
+static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s)
+{
+       if (trace_ust_is_max_id(s->used_channel_id)) {
+               return s->used_channel_id;
+       }
+
+       s->used_channel_id++;
+       return s->next_channel_id++;
+}
+
 #ifdef HAVE_LIBLTTNG_UST_CTL
 
 int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key);
@@ -126,31 +182,60 @@ int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
  * Lookup functions. NULL is returned if not found.
  */
 struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
-               char *name, struct lttng_filter_bytecode *filter, int loglevel);
+               char *name, struct lttng_bytecode *filter,
+               enum lttng_ust_loglevel_type loglevel_type, int loglevel_value,
+               struct lttng_event_exclusion *exclusion);
 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
-               char *name);
+               const char *name);
+struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
+               enum lttng_domain_type domain_type);
 
 /*
  * Create functions malloc() the data structure.
  */
-struct ltt_ust_session *trace_ust_create_session(char *path,
-               unsigned int session_id);
+struct ltt_ust_session *trace_ust_create_session(uint64_t session_id);
 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
-               char *path);
-struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
-               struct lttng_filter_bytecode *filter);
-struct ltt_ust_metadata *trace_ust_create_metadata(char *path);
+               enum lttng_domain_type domain);
+enum lttng_error_code trace_ust_create_event(struct lttng_event *ev,
+               char *filter_expression,
+               struct lttng_bytecode *filter,
+               struct lttng_event_exclusion *exclusion,
+               bool internal_event, struct ltt_ust_event **ust_event);
 struct ltt_ust_context *trace_ust_create_context(
-               struct lttng_event_context *ctx);
+               const struct lttng_event_context *ctx);
+int trace_ust_match_context(const struct ltt_ust_context *uctx,
+               const struct lttng_event_context *ctx);
+void trace_ust_delete_channel(struct lttng_ht *ht,
+               struct ltt_ust_channel *channel);
 
 /*
  * Destroy functions free() the data structure and remove from linked list if
  * it's applies.
  */
 void trace_ust_destroy_session(struct ltt_ust_session *session);
-void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata);
 void trace_ust_destroy_channel(struct ltt_ust_channel *channel);
 void trace_ust_destroy_event(struct ltt_ust_event *event);
+void trace_ust_destroy_context(struct ltt_ust_context *ctx);
+void trace_ust_free_session(struct ltt_ust_session *session);
+
+int trace_ust_id_tracker_lookup(enum lttng_process_attr process_attr,
+               struct ltt_ust_session *session,
+               int id);
+enum lttng_error_code trace_ust_process_attr_tracker_set_tracking_policy(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               enum lttng_tracking_policy policy);
+enum lttng_error_code trace_ust_process_attr_tracker_inclusion_set_add_value(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               const struct process_attr_value *value);
+enum lttng_error_code trace_ust_process_attr_tracker_inclusion_set_remove_value(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               const struct process_attr_value *value);
+const struct process_attr_tracker *trace_ust_get_process_attr_tracker(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr);
 
 #else /* HAVE_LIBLTTNG_UST_CTL */
 
@@ -166,62 +251,117 @@ static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
 }
 static inline
 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
-               char *name)
+               const char *name)
 {
        return NULL;
 }
 
 static inline
-struct ltt_ust_session *trace_ust_create_session(char *path,
-               unsigned int session_id)
+struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
 {
        return NULL;
 }
 static inline
 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr,
-               char *path)
+               enum lttng_domain_type domain)
 {
        return NULL;
 }
 static inline
-struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
-               struct lttng_filter_bytecode *filter)
+enum lttng_error_code trace_ust_create_event(struct lttng_event *ev,
+               const char *filter_expression,
+               struct lttng_bytecode *filter,
+               struct lttng_event_exclusion *exclusion,
+               bool internal_event, struct ltt_ust_event **ust_event)
 {
-       return NULL;
+       return LTTNG_ERR_NO_UST;
 }
 static inline
-struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
+void trace_ust_destroy_session(struct ltt_ust_session *session)
 {
-       return NULL;
 }
 
 static inline
-void trace_ust_destroy_session(struct ltt_ust_session *session)
+void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 {
 }
 
 static inline
-void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
+void trace_ust_destroy_event(struct ltt_ust_event *event)
 {
 }
 
 static inline
-void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
+void trace_ust_free_session(struct ltt_ust_session *session)
 {
 }
 
 static inline
-void trace_ust_destroy_event(struct ltt_ust_event *event)
+struct ltt_ust_context *trace_ust_create_context(
+               const struct lttng_event_context *ctx)
 {
+       return NULL;
 }
 static inline
-struct ltt_ust_context *trace_ust_create_context(
-               struct lttng_event_context *ctx)
+int trace_ust_match_context(const struct ltt_ust_context *uctx,
+               const struct lttng_event_context *ctx)
+{
+       return 0;
+}
+static inline
+struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
+               char *name, struct lttng_bytecode *filter,
+               enum lttng_ust_loglevel_type loglevel_type, int loglevel_value,
+               struct lttng_event_exclusion *exclusion)
+{
+       return NULL;
+}
+static inline
+void trace_ust_delete_channel(struct lttng_ht *ht,
+               struct ltt_ust_channel *channel)
+{
+       return;
+}
+static inline
+struct agent *trace_ust_find_agent(struct ltt_ust_session *session,
+               enum lttng_domain_type domain_type)
 {
        return NULL;
 }
-static inline struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
-               char *name, struct lttng_filter_bytecode *filter, int loglevel)
+static inline int trace_ust_id_tracker_lookup(
+               enum lttng_process_attr process_attr,
+               struct ltt_ust_session *session,
+               int id)
+{
+       return 0;
+}
+static inline enum lttng_error_code
+trace_ust_process_attr_tracker_set_tracking_policy(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               enum lttng_tracking_policy policy)
+{
+       return LTTNG_OK;
+}
+static inline enum lttng_error_code
+trace_ust_process_attr_tracker_inclusion_set_add_value(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               const struct process_attr_value *value)
+{
+       return LTTNG_OK;
+}
+static inline enum lttng_error_code
+trace_ust_process_attr_tracker_inclusion_set_remove_value(
+               struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr,
+               const struct process_attr_value *value)
+{
+       return LTTNG_OK;
+}
+static inline const struct process_attr_tracker *
+trace_ust_get_process_attr_tracker(struct ltt_ust_session *session,
+               enum lttng_process_attr process_attr)
 {
        return NULL;
 }
This page took 0.027959 seconds and 5 git commands to generate.