clang-tidy: add a subset of cppcoreguidelines and other style checks
[lttng-tools.git] / src / bin / lttng-sessiond / ust-registry.hpp
index acfc92404bb6d906bd082403628acd07194f6724..5d8bdb7cee020407098f78bbce22eab9236fed1f 100644 (file)
 #define CTF_SPEC_MINOR 8
 
 struct ust_app;
-class ust_registry_session;
 
 namespace lttng {
 namespace sessiond {
-namespace details {
-void locked_ust_registry_session_release(ust_registry_session *session);
-} /* namespace details */
-} /* namespace sessiond */
-} /* namespace lttng */
-
-class ust_registry_session : public lttng::sessiond::trace::trace_class {
-public:
-       using locked_ptr = std::unique_ptr<ust_registry_session,
-                       lttng::details::create_unique_class<ust_registry_session,
-                                       lttng::sessiond::details::locked_ust_registry_session_release>::
-                                       deleter>;
-
-       virtual lttng_buffer_type get_buffering_scheme() const noexcept = 0;
-       locked_ptr lock();
-
-       void add_channel(uint64_t channel_key);
-       lttng::sessiond::ust::registry_channel& get_channel(uint64_t channel_key) const;
-       void remove_channel(uint64_t channel_key, bool notify);
-
-       void regenerate_metadata();
-       virtual ~ust_registry_session();
-
-       /*
-        * With multiple writers and readers, use this lock to access
-        * the registry. Can nest within the ust app session lock.
-        * Also acts as a registry serialization lock. Used by registry
-        * readers to serialize the registry information sent from the
-        * sessiond to the consumerd.
-        * The consumer socket lock nests within this lock.
-        */
-       mutable pthread_mutex_t _lock;
-       /* Next channel ID available for a newly registered channel. */
-       uint32_t _next_channel_id = 0;
-       /* Once this value reaches UINT32_MAX, no more id can be allocated. */
-       uint32_t _used_channel_id = 0;
-       /* Next enumeration ID available. */
-       uint64_t _next_enum_id = 0;
-
-       /* Generated metadata. */
-       char *_metadata = nullptr; /* NOT null-terminated ! Use memcpy. */
-       size_t _metadata_len = 0, _metadata_alloc_len = 0;
-       /* Length of bytes sent to the consumer. */
-       size_t _metadata_len_sent = 0;
-       /* Current version of the metadata. */
-       uint64_t _metadata_version = 0;
-
-       /*
-        * Those fields are only used when a session is created with
-        * the --shm-path option. In this case, the metadata is output
-        * twice: once to the consumer, as ususal, but a second time
-        * also in the shm path directly. This is done so that a copy
-        * of the metadata that is as fresh as possible is available
-        * on the event of a crash.
-        *
-        * root_shm_path contains the shm-path provided by the user, along with
-        * the session's name and timestamp:
-        *   e.g. /tmp/my_shm/my_session-20180612-135822
-        *
-        * shm_path contains the full path of the memory buffers:
-        *   e.g. /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit
-        *
-        * metadata_path contains the full path to the metadata file that
-        * is kept for the "crash buffer" extraction:
-        *  e.g.
-        * /tmp/my_shm/my_session-20180612-135822/ust/uid/1000/64-bit/metadata
-        *
-        * Note that this is not the trace's final metadata file. It is
-        * only meant to be used to read the contents of the ring buffers
-        * in the event of a crash.
-        *
-        * metadata_fd is a file descriptor that points to the file at
-        * 'metadata_path'.
-        */
-       char _root_shm_path[PATH_MAX] = {};
-       char _shm_path[PATH_MAX] = {};
-       char _metadata_path[PATH_MAX] = {};
-       /* File-backed metadata FD */
-       int _metadata_fd = -1;
-
-       /*
-        * Hash table containing channels sent by the UST tracer. MUST
-        * be accessed with a RCU read side lock acquired.
-        */
-       lttng_ht::uptr _channels;
-
-       /*
-        * Unique key to identify the metadata on the consumer side.
-        */
-       uint64_t _metadata_key = 0;
-       /*
-        * Indicates if the metadata is closed on the consumer side. This is to
-        * avoid double close of metadata when an application unregisters AND
-        * deletes its sessions.
-        */
-       bool _metadata_closed = false;
-
-       /* User and group owning the session. */
-       uid_t _uid = -1;
-       gid_t _gid = -1;
-
-       /* Enumerations table. */
-       lttng_ht::uptr _enums;
-
-       /*
-        * Copy of the tracer version when the first app is registered.
-        * It is used if we need to regenerate the metadata.
-        */
-       uint32_t _app_tracer_version_major = 0;
-       uint32_t _app_tracer_version_minor = 0;
-
-       /* The id of the parent session */
-       ltt_session::id_t _tracing_id = -1ULL;
+namespace ust {
 
-protected:
-       /* Prevent instanciation of this base class. */
-       ust_registry_session(const struct lttng::sessiond::trace::abi& abi,
-                       unsigned int app_tracer_version_major,
-                       unsigned int app_tracer_version_minor,
-                       const char *root_shm_path,
-                       const char *shm_path,
-                       uid_t euid,
-                       gid_t egid,
-                       uint64_t tracing_id);
-       virtual void _visit_environment(
-                       lttng::sessiond::trace::trace_class_visitor& trace_class_visitor)
-                       const override;
-       void _generate_metadata();
-
-private:
-       uint32_t _get_next_channel_id();
-       void _increase_metadata_size(size_t reservation_length);
-       void _append_metadata_fragment(const std::string& fragment);
-       void _reset_metadata();
-
-       virtual void _accept_on_clock_classes(
-                       lttng::sessiond::trace::trace_class_visitor& trace_class_visitor)
-                       const override final;
-       virtual void _accept_on_stream_classes(
-                       lttng::sessiond::trace::trace_class_visitor& trace_class_visitor)
-                       const override final;
-
-       lttng::sessiond::ust::clock_class _clock;
-       const lttng::sessiond::trace::trace_class_visitor::cuptr _metadata_generating_visitor;
-};
+class registry_session;
 
-class ust_registry_session_per_uid : public ust_registry_session {
-public:
-       ust_registry_session_per_uid(const struct lttng::sessiond::trace::abi& trace_abi,
-                       uint32_t major,
-                       uint32_t minor,
-                       const char *root_shm_path,
-                       const char *shm_path,
-                       uid_t euid,
-                       gid_t egid,
-                       uint64_t tracing_id,
-                       uid_t tracing_uid);
-
-       virtual lttng_buffer_type get_buffering_scheme() const noexcept override final;
-
-private:
-       virtual void _visit_environment(
-                       lttng::sessiond::trace::trace_class_visitor& trace_class_visitor)
-                       const override final;
-
-       const uid_t _tracing_uid;
-};
+namespace details {
 
-class ust_registry_session_per_pid : public ust_registry_session {
-public:
-       ust_registry_session_per_pid(const struct ust_app& app,
-                       const struct lttng::sessiond::trace::abi&
-                                       trace_abi,
-                       uint32_t major,
-                       uint32_t minor,
-                       const char *root_shm_path,
-                       const char *shm_path,
-                       uid_t euid,
-                       gid_t egid,
-                       uint64_t tracing_id);
-
-       virtual lttng_buffer_type get_buffering_scheme() const noexcept override final;
-
-private:
-       virtual void _visit_environment(
-                       lttng::sessiond::trace::trace_class_visitor& trace_class_visitor)
-                       const override final;
-
-       const unsigned int _tracer_patch_level_version;
-       const pid_t _vpid;
-       const std::string _procname;
-       const std::time_t _app_creation_time;
-};
+template <class MappingIntegerType>
+typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings_from_ust_ctl_entries(
+               const lttng_ust_ctl_enum_entry *in_entries, size_t in_entry_count)
+{
+       typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings;
 
+       MappingIntegerType next_range_begin = 0;
+       for (size_t entry_idx = 0; entry_idx < in_entry_count; entry_idx++) {
+               const auto& entry = in_entries[entry_idx];
+               MappingIntegerType range_begin, range_end;
+
+               if (entry.u.extra.options & LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO) {
+                       range_begin = range_end = next_range_begin;
+               } else {
+                       range_begin = (MappingIntegerType) entry.start.value;
+                       range_end = (MappingIntegerType) entry.end.value;
+               }
+
+               next_range_begin = range_end + 1;
+               mappings.emplace_back(entry.string,
+                               typename trace::typed_enumeration_type<
+                                               MappingIntegerType>::mapping::range_t{
+                                               range_begin, range_end});
+       }
 
-namespace lttng {
-namespace sessiond {
-namespace ust {
+       return mappings;
+}
+} /* namespace details */
 
 class registry_enum {
 public:
@@ -247,6 +82,10 @@ public:
 
        registry_enum(std::string name, enum lttng::sessiond::trace::integer_type::signedness signedness);
        virtual ~registry_enum() = default;
+       registry_enum(const registry_enum&) = delete;
+       registry_enum(registry_enum&&) = delete;
+       registry_enum& operator=(registry_enum&&) = delete;
+       registry_enum& operator=(const registry_enum&) = delete;
 
        std::string name;
        enum lttng::sessiond::trace::integer_type::signedness signedness;
@@ -264,37 +103,6 @@ protected:
 
 bool operator==(const registry_enum& lhs, const registry_enum& rhs) noexcept;
 
-namespace details {
-template <class MappingIntegerType>
-typename trace::typed_enumeration_type<MappingIntegerType>::mapping mapping_from_ust_ctl_entry(
-               const lttng_ust_ctl_enum_entry& entry)
-{
-       if (entry.u.extra.options & LTTNG_UST_CTL_UST_ENUM_ENTRY_OPTION_IS_AUTO) {
-               return {entry.string};
-
-       } else {
-               return {entry.string,
-                               {(MappingIntegerType) entry.start.value,
-                                               (MappingIntegerType) entry.end.value}};
-       }
-}
-
-template <class MappingIntegerType>
-typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings_from_ust_ctl_entries(
-               const lttng_ust_ctl_enum_entry *in_entries, size_t in_entry_count)
-{
-       typename trace::typed_enumeration_type<MappingIntegerType>::mappings mappings;
-
-       for (size_t entry_idx = 0; entry_idx < in_entry_count; entry_idx++) {
-               const auto& entry = in_entries[entry_idx];
-
-               mappings.emplace_back(mapping_from_ust_ctl_entry<MappingIntegerType>(entry));
-       }
-
-       return mappings;
-}
-} /* namespace details */
-
 template <class MappingIntegerType>
 class registry_typed_enum : public registry_enum {
 public:
@@ -317,7 +125,7 @@ public:
                        _mappings;
 
 protected:
-       virtual bool _is_equal(const registry_enum& base_other) const noexcept
+       bool _is_equal(const registry_enum& base_other) const noexcept override
        {
                const auto &other = static_cast<decltype(*this)&>(base_other);
 
@@ -340,7 +148,7 @@ using registry_unsigned_enum = registry_typed_enum<uint64_t>;
  *
  * Return new instance on success, nullptr on error.
  */
-ust_registry_session *ust_registry_session_per_uid_create(
+lttng::sessiond::ust::registry_session *ust_registry_session_per_uid_create(
                const lttng::sessiond::trace::abi& abi,
                uint32_t major,
                uint32_t minor,
@@ -356,7 +164,7 @@ ust_registry_session *ust_registry_session_per_uid_create(
  *
  * Return new instance on success, nullptr on error.
  */
-ust_registry_session *ust_registry_session_per_pid_create(struct ust_app *app,
+lttng::sessiond::ust::registry_session *ust_registry_session_per_pid_create(struct ust_app *app,
                const lttng::sessiond::trace::abi& abi,
                uint32_t major,
                uint32_t minor,
@@ -365,24 +173,15 @@ ust_registry_session *ust_registry_session_per_pid_create(struct ust_app *app,
                uid_t euid,
                gid_t egid,
                uint64_t tracing_id);
-void ust_registry_session_destroy(ust_registry_session *session);
+void ust_registry_session_destroy(lttng::sessiond::ust::registry_session *session);
 
 void ust_registry_channel_destroy_event(lttng::sessiond::ust::registry_channel *chan,
                lttng::sessiond::ust::registry_event *event);
 
-int ust_registry_create_or_find_enum(ust_registry_session *session,
-               int session_objd, char *name,
-               struct lttng_ust_ctl_enum_entry *entries, size_t nr_entries,
-               uint64_t *enum_id);
-lttng::sessiond::ust::registry_enum::const_rcu_protected_reference
-ust_registry_lookup_enum_by_id(const ust_registry_session *session,
-               const char *name, uint64_t id);
-void ust_registry_destroy_enum(ust_registry_session *reg_session,
-               lttng::sessiond::ust::registry_enum *reg_enum);
 #else /* HAVE_LIBLTTNG_UST_CTL */
 
 static inline
-ust_registry_session *ust_registry_session_per_uid_create(
+lttng::sessiond::ust::registry_session *ust_registry_session_per_uid_create(
                uint32_t bits_per_long __attribute__((unused)),
                uint32_t uint8_t_alignment __attribute__((unused)),
                uint32_t uint16_t_alignment __attribute__((unused)),
@@ -403,7 +202,7 @@ ust_registry_session *ust_registry_session_per_uid_create(
 }
 
 static inline
-ust_registry_session *ust_registry_session_per_pid_create(
+lttng::sessiond::ust::registry_session *ust_registry_session_per_pid_create(
                struct ust_app *app __attribute__((unused)),
                uint32_t bits_per_long __attribute__((unused)),
                uint32_t uint8_t_alignment __attribute__((unused)),
@@ -425,7 +224,7 @@ ust_registry_session *ust_registry_session_per_pid_create(
 
 static inline
 void ust_registry_session_destroy(
-               ust_registry_session *session __attribute__((unused)))
+               lttng::sessiond::ust::registry_session *session __attribute__((unused)))
 {}
 
 static inline
@@ -437,14 +236,14 @@ void ust_registry_destroy_event(
 /* The app object can be NULL for registry shared across applications. */
 static inline
 int ust_metadata_session_statedump(
-               ust_registry_session *session __attribute__((unused)))
+               lttng::sessiond::ust::registry_session *session __attribute__((unused)))
 {
        return 0;
 }
 
 static inline
 int ust_metadata_channel_statedump(
-               ust_registry_session *session __attribute__((unused)),
+               lttng::sessiond::ust::registry_session *session __attribute__((unused)),
                lttng::sessiond::ust::registry_channel *chan __attribute__((unused)))
 {
        return 0;
@@ -452,40 +251,13 @@ int ust_metadata_channel_statedump(
 
 static inline
 int ust_metadata_event_statedump(
-               ust_registry_session *session __attribute__((unused)),
+               lttng::sessiond::ust::registry_session *session __attribute__((unused)),
                lttng::sessiond::ust::registry_channel *chan __attribute__((unused)),
                lttng::sessiond::ust::registry_event *event __attribute__((unused)))
 {
        return 0;
 }
 
-static inline
-int ust_registry_create_or_find_enum(
-               ust_registry_session *session __attribute__((unused)),
-               int session_objd __attribute__((unused)),
-               char *name __attribute__((unused)),
-               struct lttng_ust_ctl_enum_entry *entries __attribute__((unused)),
-               size_t nr_entries __attribute__((unused)),
-               uint64_t *enum_id __attribute__((unused)))
-{
-       return 0;
-}
-
-static inline
-struct ust_registry_enum *
-       ust_registry_lookup_enum_by_id(
-               const ust_registry_session *session __attribute__((unused)),
-               const char *name __attribute__((unused)),
-               uint64_t id __attribute__((unused)))
-{
-       return NULL;
-}
-
-static inline
-void ust_registry_destroy_enum(ust_registry_session *reg_session __attribute__((unused)),
-               struct ust_registry_enum *reg_enum __attribute__((unused)))
-{}
-
 #endif /* HAVE_LIBLTTNG_UST_CTL */
 
 #endif /* LTTNG_UST_REGISTRY_H */
This page took 0.033881 seconds and 4 git commands to generate.