tracing: Introduce API for composite IDs

base/trace_event/trace_event.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef BASE_TRACE_EVENT_TRACE_EVENT_H_
 #define BASE_TRACE_EVENT_TRACE_EVENT_H_
 
 // This header file defines implementation details of how the trace macros in
 // trace_event_common.h collect and store trace events. Anything not
 // implementation-specific should go in trace_event_common.h instead of here.
@@ skipping 27 matching lines @@
 
 // DEPRECATED: do not use: Consider using TRACE_ID_{GLOBAL, LOCAL} macros,
 // instead. By default, pointers are mangled with the Process ID in
 // TRACE_EVENT_ASYNC macros. Use this macro to prevent Process ID mangling.
 #define TRACE_ID_DONT_MANGLE(id) \
     trace_event_internal::TraceID::DontMangle(id)
 
 // By default, trace IDs are eventually converted to a single 64-bit number. Use
 // this macro to add a scope string.
 #define TRACE_ID_WITH_SCOPE(scope, id) \
-    trace_event_internal::TraceID::WithScope(scope, id)
-
-#define TRACE_ID_GLOBAL(id) trace_event_internal::TraceID::GlobalId(id)
-#define TRACE_ID_LOCAL(id) trace_event_internal::TraceID::LocalId(id)
+  trace_event_internal::TraceID::MakeScopedID(scope, id)
+// Can be nested within TRACE_ID_WITH_SCOPE macro.
+#define TRACE_ID_GLOBAL(id) trace_event_internal::TraceID::MakeGlobalID(id)
+// Can be nested within TRACE_ID_WITH_SCOPE macro.
+#define TRACE_ID_LOCAL(id) trace_event_internal::TraceID::MakeLocalID(id)
+// Can be nested within TRACE_ID_{LOCAL, GLOBAL, WITH_SCOPE} macros.
+#define TRACE_ID_COMPOSITE(prefix, id) \
+  trace_event_internal::TraceID::CompositeID(prefix, id)
 
 #define TRACE_EVENT_API_CURRENT_THREAD_ID \
   static_cast<int>(base::PlatformThread::CurrentId())
 
 #define INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE() \
   UNLIKELY(*INTERNAL_TRACE_EVENT_UID(category_group_enabled) &           \
            (base::trace_event::TraceCategory::ENABLED_FOR_RECORDING |         \
             base::trace_event::TraceCategory::ENABLED_FOR_ETW_EXPORT |        \
             base::trace_event::TraceCategory::ENABLED_FOR_FILTERING))
 
@@ skipping 339 matching lines @@
 // used.
 const int kZeroNumArgs = 0;
 const std::nullptr_t kGlobalScope = nullptr;
 const unsigned long long kNoId = 0;
 
 // TraceID encapsulates an ID that can either be an integer or pointer. Pointers
 // are by default mangled with the Process ID so that they are unlikely to
 // collide when the same pointer is used on different processes.
 class BASE_EXPORT TraceID {
  public:
-  // Can be combined with WithScope.
-  class LocalId {
+  class CompositeID {
    public:
-    explicit LocalId(unsigned long long raw_id) : raw_id_(raw_id) {}
+    CompositeID(unsigned long long prefix, unsigned long long raw_id)
+        : prefix_(prefix), raw_id_(raw_id) {}
+
+    void set_scope(const char* scope) { scope_ = scope; }
+
+    void set_id_flags(unsigned int id_flags) { id_flags_ = id_flags; }
+
+    const char* scope() const { return scope_; }
+    unsigned long long prefix() const { return prefix_; }
+    unsigned long long raw_id() const { return raw_id_; }
+    unsigned int id_flags() const { return id_flags_; }
+
+   private:
+    const char* scope_ = nullptr;
+    unsigned long long prefix_;
+    unsigned long long raw_id_;
+    unsigned int id_flags_ = TRACE_EVENT_FLAG_HAS_ID;
+  };
+
+  class LocalID {
+   public:
+    explicit LocalID(unsigned long long raw_id) : raw_id_(raw_id) {}
     unsigned long long raw_id() const { return raw_id_; }
    private:
     unsigned long long raw_id_;
   };
 
-  // Can be combined with WithScope.
-  class GlobalId {
+  class GlobalID {
    public:
-    explicit GlobalId(unsigned long long raw_id) : raw_id_(raw_id) {}
+    explicit GlobalID(unsigned long long raw_id) : raw_id_(raw_id) {}
     unsigned long long raw_id() const { return raw_id_; }
    private:
     unsigned long long raw_id_;
   };
 
-  class WithScope {
+  class ScopedID {
    public:
-    WithScope(const char* scope, unsigned long long raw_id)
+    ScopedID(const char* scope, unsigned long long raw_id)
         : scope_(scope), raw_id_(raw_id) {}
-    WithScope(const char* scope, LocalId local_id)
+    ScopedID(const char* scope, LocalID local_id)
         : scope_(scope), raw_id_(local_id.raw_id()) {
       id_flags_ = TRACE_EVENT_FLAG_HAS_LOCAL_ID;
     }
-    WithScope(const char* scope, GlobalId global_id)
+    ScopedID(const char* scope, GlobalID global_id)
         : scope_(scope), raw_id_(global_id.raw_id()) {
       id_flags_ = TRACE_EVENT_FLAG_HAS_GLOBAL_ID;
     }
+    const char* scope() const { return scope_; }
     unsigned long long raw_id() const { return raw_id_; }
-    const char* scope() const { return scope_; }
     unsigned int id_flags() const { return id_flags_; }
    private:
     const char* scope_ = nullptr;
     unsigned long long raw_id_;
     unsigned int id_flags_ = TRACE_EVENT_FLAG_HAS_ID;
   };
 
-  // DEPRECATED: consider using LocalId or GlobalId, instead.
+  static inline CompositeID MakeLocalID(CompositeID& composite_id) {
+    composite_id.set_id_flags(TRACE_EVENT_FLAG_HAS_LOCAL_ID);
+    return composite_id;
+  }
+
+  static inline LocalID MakeLocalID(unsigned long long raw_id) {
+    return LocalID(raw_id);
+  }
+
+  static inline CompositeID MakeGlobalID(CompositeID& composite_id) {
+    composite_id.set_id_flags(TRACE_EVENT_FLAG_HAS_GLOBAL_ID);
+    return composite_id;
+  }
+
+  static inline GlobalID MakeGlobalID(unsigned long long raw_id) {
+    return GlobalID(raw_id);
+  }
+
+  static inline CompositeID MakeScopedID(const char* scope,
+                                         CompositeID& composite_id) {

[caseq, 2016/11/21 19:47:20]

const ComositeID&

[chiniforooshan, 2016/11/21 21:12:15]

But composite_id is actually modified in this function.

+    composite_id.set_scope(scope);
+    return composite_id;
+  }
+
+  template <typename T>
+  static inline ScopedID MakeScopedID(const char* scope, T raw_id) {

[caseq, 2016/11/21 19:47:20]

why do we need it to be template? looks like we only would pass the template
parameter to a non-template ScopedID constructor that expects unsigned long
long.

[chiniforooshan, 2016/11/21 21:12:15]

I think you missed the other two constructors :) ScopedID constructor"s" expect
unsgined long long, LocalID, or GlobalID.

+    return ScopedID(scope, raw_id);
+  }
+
+  // DEPRECATED: consider using LocalID or GlobalID, instead.
   class DontMangle {
    public:
     explicit DontMangle(const void* raw_id)
         : raw_id_(static_cast<unsigned long long>(
               reinterpret_cast<uintptr_t>(raw_id))) {}
     explicit DontMangle(unsigned long long raw_id) : raw_id_(raw_id) {}
     explicit DontMangle(unsigned long raw_id) : raw_id_(raw_id) {}
     explicit DontMangle(unsigned int raw_id) : raw_id_(raw_id) {}
     explicit DontMangle(unsigned short raw_id) : raw_id_(raw_id) {}
     explicit DontMangle(unsigned char raw_id) : raw_id_(raw_id) {}
     explicit DontMangle(long long raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     explicit DontMangle(long raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     explicit DontMangle(int raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     explicit DontMangle(short raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     explicit DontMangle(signed char raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     unsigned long long raw_id() const { return raw_id_; }
    private:
     unsigned long long raw_id_;
   };
 
-  // DEPRECATED: consider using LocalId or GlobalId, instead.
+  // DEPRECATED: consider using LocalID or GlobalID, instead.
   class ForceMangle {
    public:
     explicit ForceMangle(unsigned long long raw_id) : raw_id_(raw_id) {}
     explicit ForceMangle(unsigned long raw_id) : raw_id_(raw_id) {}
     explicit ForceMangle(unsigned int raw_id) : raw_id_(raw_id) {}
     explicit ForceMangle(unsigned short raw_id) : raw_id_(raw_id) {}
     explicit ForceMangle(unsigned char raw_id) : raw_id_(raw_id) {}
     explicit ForceMangle(long long raw_id)
         : raw_id_(static_cast<unsigned long long>(raw_id)) {}
     explicit ForceMangle(long raw_id)
@@ skipping 25 matching lines @@
   TraceID(long long raw_id)
       : raw_id_(static_cast<unsigned long long>(raw_id)) {}
   TraceID(long raw_id)
       : raw_id_(static_cast<unsigned long long>(raw_id)) {}
   TraceID(int raw_id)
       : raw_id_(static_cast<unsigned long long>(raw_id)) {}
   TraceID(short raw_id)
       : raw_id_(static_cast<unsigned long long>(raw_id)) {}
   TraceID(signed char raw_id)
       : raw_id_(static_cast<unsigned long long>(raw_id)) {}
-  TraceID(LocalId raw_id) : raw_id_(raw_id.raw_id()) {
+  TraceID(LocalID local_id) : raw_id_(local_id.raw_id()) {
     id_flags_ = TRACE_EVENT_FLAG_HAS_LOCAL_ID;
   }
-  TraceID(GlobalId raw_id) : raw_id_(raw_id.raw_id()) {
+  TraceID(GlobalID global_id) : raw_id_(global_id.raw_id()) {
     id_flags_ = TRACE_EVENT_FLAG_HAS_GLOBAL_ID;
   }
-  TraceID(WithScope scoped_id) : scope_(scoped_id.scope()),
-      raw_id_(scoped_id.raw_id()), id_flags_(scoped_id.id_flags()) {}
+  TraceID(ScopedID scoped_id)
+      : scope_(scoped_id.scope()),
+        raw_id_(scoped_id.raw_id()),
+        id_flags_(scoped_id.id_flags()) {}
+  TraceID(CompositeID composite_id)
+      : scope_(composite_id.scope()),
+        has_prefix_(true),
+        prefix_(composite_id.prefix()),
+        raw_id_(composite_id.raw_id()),
+        id_flags_(composite_id.id_flags()) {}
 
+  const char* scope() const { return scope_; }
+  bool has_prefix() const { return has_prefix_; }
+  unsigned long long prefix() const { return prefix_; }
   unsigned long long raw_id() const { return raw_id_; }
-  const char* scope() const { return scope_; }
   unsigned int id_flags() const { return id_flags_; }
 
   std::unique_ptr<base::trace_event::ConvertableToTraceFormat>
   AsConvertableToTraceFormat() const;
 
  private:
   const char* scope_ = nullptr;
+  bool has_prefix_ = false;
+  unsigned long long prefix_;
   unsigned long long raw_id_;
   unsigned int id_flags_ = TRACE_EVENT_FLAG_HAS_ID;
 };
 
 // Simple union to store various types as unsigned long long.
 union TraceValueUnion {
   bool as_bool;
   unsigned long long as_uint;
   long long as_int;
   double as_double;
@@ skipping 531 matching lines @@
   const char* name_;
   IDType id_;
 
   DISALLOW_COPY_AND_ASSIGN(TraceScopedTrackableObject);
 };
 
 }  // namespace trace_event
 }  // namespace base
 
 #endif  // BASE_TRACE_EVENT_TRACE_EVENT_H_