SoW-2019-0002: Dynamic Snapshot
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
index 649c0a96de83f24498e0a5e420cebe6c1ab78b89..a24b42ffd2b40f4a6574151a53e45942ea043a9c 100644 (file)
@@ -1,28 +1,21 @@
 /*
- * 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_UST_APP_H 
+#ifndef _LTT_UST_APP_H
 #define _LTT_UST_APP_H
 
 #include <stdint.h>
 
-#include <common/compat/uuid.h>
+#include <common/uuid.h>
+
 #include "trace-ust.h"
 #include "ust-registry.h"
+#include "session.h"
 
 #define UST_APP_EVENT_LIST_SIZE 32
 
@@ -46,8 +39,9 @@ struct ust_app_notify_sock_obj {
 
 struct ust_app_ht_key {
        const char *name;
-       const struct lttng_ust_filter_bytecode *filter;
-       enum lttng_ust_loglevel_type loglevel;
+       const struct lttng_filter_bytecode *filter;
+       enum lttng_ust_loglevel_type loglevel_type;
+       const struct lttng_event_exclusion *exclusion;
 };
 
 /*
@@ -77,19 +71,21 @@ struct ust_register_msg {
  * Global applications HT used by the session daemon. This table is indexed by
  * PID using the pid_n node and pid value of an ust_app.
  */
-struct lttng_ht *ust_app_ht;
+extern struct lttng_ht *ust_app_ht;
 
 /*
  * Global applications HT used by the session daemon. This table is indexed by
  * socket using the sock_n node and sock value of an ust_app.
+ *
+ * The 'sock' in question here is the 'command' socket.
  */
-struct lttng_ht *ust_app_ht_by_sock;
+extern struct lttng_ht *ust_app_ht_by_sock;
 
 /*
  * Global applications HT used by the session daemon. This table is indexed by
  * socket using the notify_sock_n node and notify_sock value of an ust_app.
  */
-struct lttng_ht *ust_app_ht_by_notify_sock;
+extern struct lttng_ht *ust_app_ht_by_notify_sock;
 
 /* Stream list containing ust_app_stream. */
 struct ust_app_stream_list {
@@ -99,9 +95,10 @@ struct ust_app_stream_list {
 
 struct ust_app_ctx {
        int handle;
-       struct lttng_ust_context ctx;
+       struct lttng_ust_context_attr ctx;
        struct lttng_ust_object_data *obj;
        struct lttng_ht_node_ulong node;
+       struct cds_list_head list;
 };
 
 struct ust_app_event {
@@ -111,7 +108,21 @@ struct ust_app_event {
        struct lttng_ust_event attr;
        char name[LTTNG_UST_SYM_NAME_LEN];
        struct lttng_ht_node_str node;
-       struct lttng_ust_filter_bytecode *filter;
+       struct lttng_filter_bytecode *filter;
+       struct lttng_event_exclusion *exclusion;
+};
+
+struct ust_app_token_event_rule {
+       int enabled;
+       int handle;
+       struct lttng_ust_object_data *obj;
+       struct lttng_event_rule *event_rule;
+       uint64_t token;
+       struct lttng_ht_node_u64 node;
+       /* The event_rule object own this pointer */
+       const struct lttng_filter_bytecode *filter;
+       /* The event_rule object own this pointer */
+       struct lttng_event_exclusion *exclusion;
 };
 
 struct ust_app_stream {
@@ -129,8 +140,14 @@ struct ust_app_channel {
        int handle;
        /* Channel and streams were sent to the UST tracer. */
        int is_sent;
-       /* Unique key used to identify the channel on the consumer side. */
+       /*
+        * Unique key used to identify the channel on the consumer side.
+        * 0 is a reserved 'invalid' value used to indicate that the consumer
+        * does not know about this channel (i.e. an error occurred).
+        */
        uint64_t key;
+       /* Id of the tracing channel set on creation. */
+       uint64_t tracing_channel_id;
        /* Number of stream that this channel is expected to receive. */
        unsigned int expected_stream_count;
        char name[LTTNG_UST_SYM_NAME_LEN];
@@ -139,8 +156,18 @@ struct ust_app_channel {
        struct ust_app_stream_list streams;
        /* Session pointer that owns this object. */
        struct ust_app_session *session;
+       /*
+        * Contexts are kept in a hash table for fast lookup and in an ordered list
+        * so we are able to enable them on the tracer side in the same order the
+        * user added them.
+        */
        struct lttng_ht *ctx;
+       struct cds_list_head ctx_list;
+
        struct lttng_ht *events;
+       uint64_t tracefile_size;
+       uint64_t tracefile_count;
+       uint64_t monitor_timer_interval;
        /*
         * Node indexed by channel name in the channels' hash table of a session.
         */
@@ -150,6 +177,8 @@ struct ust_app_channel {
         * ust_objd hash table in the ust_app object.
         */
        struct lttng_ht_node_ulong ust_objd_node;
+       /* For delayed reclaim */
+       struct rcu_head rcu_head;
 };
 
 struct ust_app_session {
@@ -164,21 +193,48 @@ struct ust_app_session {
        /* started: has the session been in started state at any time ? */
        int started;  /* allows detection of start vs restart. */
        int handle;   /* used has unique identifier for app session */
-       int id;       /* session unique identifier */
-       struct ust_app_channel *metadata;
-       struct ust_registry_session *registry;
+
+       bool deleted;   /* Session deleted flag. Check with lock held. */
+
+       /*
+        * Tracing session ID. Multiple ust app session can have the same tracing
+        * session id making this value NOT unique to the object.
+        */
+       uint64_t tracing_id;
+       uint64_t id;    /* Unique session identifier */
        struct lttng_ht *channels; /* Registered channels */
-       struct lttng_ht_node_ulong node;
+       struct lttng_ht_node_u64 node;
+       /*
+        * Node indexed by UST session object descriptor (handle). Stored in the
+        * ust_sessions_objd hash table in the ust_app object.
+        */
+       struct lttng_ht_node_ulong ust_objd_node;
+       /* Starts with 'ust'; no leading slash. */
        char path[PATH_MAX];
-       /* UID/GID of the user owning the session */
-       uid_t uid;
-       gid_t gid;
+       /* UID/GID of the application owning the session */
+       struct lttng_credentials real_credentials;
+       /* Effective UID and GID. Same as the tracing session. */
+       struct lttng_credentials effective_credentials;
        struct cds_list_head teardown_node;
        /*
         * Once at least *one* session is created onto the application, the
         * corresponding consumer is set so we can use it on unregistration.
         */
        struct consumer_output *consumer;
+       enum lttng_buffer_type buffer_type;
+       /* ABI of the session. Same value as the application. */
+       uint32_t bits_per_long;
+       /* For delayed reclaim */
+       struct rcu_head rcu_head;
+       /* If the channel's streams have to be outputed or not. */
+       unsigned int output_traces;
+       unsigned int live_timer_interval;       /* usec */
+
+       /* Metadata channel attributes. */
+       struct ustctl_consumer_channel_attr metadata_attr;
+
+       char root_shm_path[PATH_MAX];
+       char shm_path[PATH_MAX];
 };
 
 /*
@@ -187,6 +243,8 @@ struct ust_app_session {
  */
 struct ust_app {
        int sock;
+       pthread_mutex_t sock_lock;      /* Protects sock protocol. */
+
        int notify_sock;
        pid_t pid;
        pid_t ppid;
@@ -210,6 +268,8 @@ struct ust_app {
        uint32_t v_minor;    /* Version minor number */
        /* Extra for the NULL byte. */
        char name[UST_APP_PROCNAME_LEN + 1];
+       /* Type of buffer this application uses. */
+       enum lttng_buffer_type buffer_type;
        struct lttng_ht *sessions;
        struct lttng_ht_node_ulong pid_n;
        struct lttng_ht_node_ulong sock_n;
@@ -228,63 +288,103 @@ struct ust_app {
         * Hash table containing ust_app_channel indexed by channel objd.
         */
        struct lttng_ht *ust_objd;
+       /*
+        * Hash table containing ust_app_session indexed by objd.
+        */
+       struct lttng_ht *ust_sessions_objd;
+
+       /*
+        * If this application is of the agent domain and this is non negative then
+        * a lookup MUST be done to acquire a read side reference to the
+        * corresponding agent app object. If the lookup fails, this should be set
+        * to a negative value indicating that the agent application is gone.
+        */
+       int agent_app_sock;
+       /*
+        * Time at which the app is registred.
+        * Used for path creation
+        */
+       time_t registration_time;
+       /*
+        * Trigger
+        */
+       struct {
+               struct lttng_ust_object_data *handle;
+               struct lttng_pipe *trigger_event_pipe;
+       } token_communication;
+       struct lttng_ht *tokens_ht;
 };
 
 #ifdef HAVE_LIBLTTNG_UST_CTL
 
 int ust_app_register(struct ust_register_msg *msg, int sock);
-static inline
-int ust_app_register_done(int sock)
-{
-       return ustctl_register_done(sock);
-}
+int ust_app_register_done(struct ust_app *app);
 int ust_app_version(struct ust_app *app);
 void ust_app_unregister(int sock);
-unsigned long ust_app_list_count(void);
-int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
-int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
 int ust_app_start_trace_all(struct ltt_ust_session *usess);
 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
 int ust_app_list_events(struct lttng_event **events);
 int ust_app_list_event_fields(struct lttng_event_field **fields);
-int ust_app_create_channel_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan);
 int ust_app_create_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
-int ust_app_disable_event_pid(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
-               pid_t pid);
-int ust_app_enable_event_pid(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
-               pid_t pid);
 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan);
 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan);
 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
-int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan);
-int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan);
 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
-void ust_app_global_update(struct ltt_ust_session *usess, int sock);
+void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
+void ust_app_global_update_all(struct ltt_ust_session *usess);
+void ust_app_global_update_tokens(struct ust_app *app);
+void ust_app_global_update_all_tokens(void);
 
 void ust_app_clean_list(void);
-void ust_app_ht_alloc(void);
-struct lttng_ht *ust_app_get_ht(void);
+int ust_app_ht_alloc(void);
 struct ust_app *ust_app_find_by_pid(pid_t pid);
-int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
 struct ust_app_stream *ust_app_alloc_stream(void);
 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
 int ust_app_recv_notify(int sock);
 void ust_app_add(struct ust_app *app);
 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
 void ust_app_notify_sock_unregister(int sock);
+ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
+               struct consumer_socket *socket, int send_zero_data);
+void ust_app_destroy(struct ust_app *app);
+enum lttng_error_code ust_app_snapshot_record(
+               const struct ltt_ust_session *usess,
+               const struct consumer_output *output, int wait,
+               uint64_t nb_packets_per_stream);
+uint64_t ust_app_get_size_one_more_packet_per_stream(
+               const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
+struct ust_app *ust_app_find_by_sock(int sock);
+int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
+               struct cds_list_head *buffer_reg_uid_list,
+               struct consumer_output *consumer, uint64_t uchan_id,
+               int overwrite, uint64_t *discarded, uint64_t *lost);
+int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
+               struct ltt_ust_channel *uchan,
+               struct consumer_output *consumer,
+               int overwrite, uint64_t *discarded, uint64_t *lost);
+int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
+enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
+enum lttng_error_code ust_app_create_channel_subdirectories(
+               const struct ltt_ust_session *session);
+int ust_app_release_object(struct ust_app *app,
+               struct lttng_ust_object_data *data);
+enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
+
+int ust_app_setup_trigger_group(struct ust_app *app);
+
+static inline
+int ust_app_supported(void)
+{
+       return 1;
+}
 
 #else /* HAVE_LIBLTTNG_UST_CTL */
 
@@ -324,7 +424,7 @@ int ust_app_register(struct ust_register_msg *msg, int sock)
        return -ENOSYS;
 }
 static inline
-int ust_app_register_done(int sock)
+int ust_app_register_done(struct ust_app *app)
 {
        return -ENOSYS;
 }
@@ -338,11 +438,6 @@ void ust_app_unregister(int sock)
 {
 }
 static inline
-unsigned int ust_app_list_count(void)
-{
-       return 0;
-}
-static inline
 void ust_app_lock_list(void)
 {
 }
@@ -365,42 +460,32 @@ struct ust_app *ust_app_get_by_pid(pid_t pid)
        return NULL;
 }
 static inline
-struct lttng_ht *ust_app_get_ht(void)
+int ust_app_ht_alloc(void)
 {
-       return NULL;
+       return 0;
 }
 static inline
-void ust_app_ht_alloc(void)
+void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
 {}
 static inline
-void ust_app_global_update(struct ltt_ust_session *usess, int sock)
+void ust_app_global_update_tokens(struct ust_app *app)
 {}
 static inline
-int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan)
-{
-       return 0;
-}
-static inline
-int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan)
-{
-       return 0;
-}
+void ust_app_global_update_all_tokens(void)
+{}
 static inline
-int ust_app_create_channel_glb(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan)
+int ust_app_setup_trigger_group(struct ust_app *app)
 {
-       return 0;
+    return 0;
 }
 static inline
-int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
+int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan)
 {
        return 0;
 }
 static inline
-int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
+int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan)
 {
        return 0;
@@ -437,39 +522,118 @@ int ust_app_enable_event_pid(struct ltt_ust_session *usess,
        return 0;
 }
 static inline
-int ust_app_disable_event_pid(struct ltt_ust_session *usess,
-               struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
-               pid_t pid)
+int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
 {
        return 0;
 }
 static inline
-int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
+int ust_app_recv_notify(int sock)
 {
        return 0;
 }
 static inline
-int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
+struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
+{
+       return NULL;
+}
+static inline
+void ust_app_add(struct ust_app *app)
+{
+}
+static inline
+void ust_app_notify_sock_unregister(int sock)
+{
+}
+static inline
+ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
+               struct consumer_socket *socket, int send_zero_data)
 {
        return 0;
 }
 static inline
-int ust_app_recv_notify(int sock)
+void ust_app_destroy(struct ust_app *app)
+{
+       return;
+}
+static inline
+enum lttng_error_code ust_app_snapshot_record(struct ltt_ust_session *usess,
+               const struct consumer_output *output, int wait, uint64_t max_stream_size)
 {
        return 0;
 }
 static inline
-struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
+unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
+{
+       return 0;
+}
+
+static inline
+int ust_app_supported(void)
+{
+       return 0;
+}
+static inline
+struct ust_app *ust_app_find_by_sock(int sock)
 {
        return NULL;
 }
 static inline
-void ust_app_add(struct ust_app *app)
+struct ust_app *ust_app_find_by_pid(pid_t pid)
 {
+       return NULL;
 }
 static inline
-void ust_app_notify_sock_unregister(int sock)
+uint64_t ust_app_get_size_one_more_packet_per_stream(
+               const struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
+       return 0;
+}
+static inline
+int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
+               struct cds_list_head *buffer_reg_uid_list,
+               struct consumer_output *consumer, int overwrite,
+               uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
+{
+       return 0;
+}
+
+static inline
+int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
+               struct ltt_ust_channel *uchan,
+               struct consumer_output *consumer,
+               int overwrite, uint64_t *discarded, uint64_t *lost)
 {
+       return 0;
+}
+
+static inline
+int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
+{
+       return 0;
+}
+
+static inline
+enum lttng_error_code ust_app_rotate_session(struct ltt_session *session)
+{
+       return 0;
+}
+
+static inline
+enum lttng_error_code ust_app_create_channel_subdirectories(
+               const struct ltt_ust_session *session)
+{
+       return 0;
+}
+
+static inline
+int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
+{
+       return 0;
+}
+
+static inline
+enum lttng_error_code ust_app_clear_session(struct ltt_session *session)
+{
+       return 0;
 }
 
 #endif /* HAVE_LIBLTTNG_UST_CTL */
This page took 0.029629 seconds and 5 git commands to generate.