Tracing: Added necessary plumbing to make sure clocksync metadata events are always included.

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 177 matching lines @@
 // Adds a metadata event to the trace log. The |AppendValueAsTraceFormat| method
 // on the convertable value will be called at flush time.
 // TRACE_EVENT_API_ADD_METADATA_EVENT(
 //     const unsigned char* category_group_enabled,
 //     const char* event_name,
 //     const char* arg_name,
 //     std::unique_ptr<ConvertableToTraceFormat> arg_value)
 #define TRACE_EVENT_API_ADD_METADATA_EVENT \
     trace_event_internal::AddMetadataEvent
 
+#define TRACE_EVENT_API_ADD_METADATA_EVENT_WITH_TIMESTAMP \
+  trace_event_internal::AddMetadataEventWithTimestamp
+
 // Defines atomic operations used internally by the tracing system.
 #define TRACE_EVENT_API_ATOMIC_WORD base::subtle::AtomicWord
 #define TRACE_EVENT_API_ATOMIC_LOAD(var) base::subtle::NoBarrier_Load(&(var))
 #define TRACE_EVENT_API_ATOMIC_STORE(var, value) \
     base::subtle::NoBarrier_Store(&(var), (value))
 
 // Defines visibility for classes in trace_event.h
 #define TRACE_EVENT_API_CLASS_EXPORT BASE_EXPORT
 
 // The thread buckets for the sampling profiler.
@@ skipping 136 matching lines @@
           phase, INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,      \
           trace_event_trace_id.scope(), trace_event_trace_id.raw_id(),        \
           thread_id, base::TimeTicks::FromInternalValue(timestamp),           \
           trace_event_flags | TRACE_EVENT_FLAG_EXPLICIT_TIMESTAMP,            \
           trace_event_internal::kNoId, ##__VA_ARGS__);                        \
     }                                                                         \
   } while (0)
 
 // Implementation detail: internal macro to create static category and add
 // metadata event if the category is enabled.
-#define INTERNAL_TRACE_EVENT_METADATA_ADD(category_group, name, ...)        \
+#define INTERNAL_TRACE_EVENT_METADATA_ADD_IF_ENABLED(category_group, name,  \
+                                                     ...)                   \
   do {                                                                      \
     INTERNAL_TRACE_EVENT_GET_CATEGORY_INFO(category_group);                 \
     if (INTERNAL_TRACE_EVENT_CATEGORY_GROUP_ENABLED_FOR_RECORDING_MODE()) { \
       TRACE_EVENT_API_ADD_METADATA_EVENT(                                   \
+          TRACE_EVENT_PHASE_METADATA,                                       \
           INTERNAL_TRACE_EVENT_UID(category_group_enabled), name,           \
           ##__VA_ARGS__);                                                   \
     }                                                                       \
   } while (0)
 
+#define INTERNAL_TRACE_EVENT_METADATA_ADD_FORCED(phase, name, ...)             \
+  do {                                                                         \
+    TRACE_EVENT_API_ADD_METADATA_EVENT(                                        \
+        phase, TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED("__metadata"), name, \
+        ##__VA_ARGS__);                                                        \
+  } while (0)
+
+#define INTERNAL_TRACE_EVENT_METADATA_ADD_FORCED_WITH_TIMESTAMP(               \
+    phase, name, timestamp, ...)                                               \
+  do {                                                                         \
+    TRACE_EVENT_API_ADD_METADATA_EVENT_WITH_TIMESTAMP(                         \
+        phase, TRACE_EVENT_API_GET_CATEGORY_GROUP_ENABLED("__metadata"), name, \
+        base::TimeTicks::FromInternalValue(timestamp), ##__VA_ARGS__);         \
+  } while (0)
+
 // Implementation detail: internal macro to enter and leave a
 // context based on the current scope.
 #define INTERNAL_TRACE_EVENT_SCOPED_CONTEXT(category_group, name, context) \
   struct INTERNAL_TRACE_EVENT_UID(ScopedContext) {                         \
    public:                                                                 \
     INTERNAL_TRACE_EVENT_UID(ScopedContext)(uint64_t cid) : cid_(cid) {    \
       TRACE_EVENT_ENTER_CONTEXT(category_group, name, cid_);               \
     }                                                                      \
     ~INTERNAL_TRACE_EVENT_UID(ScopedContext)() {                           \
       TRACE_EVENT_LEAVE_CONTEXT(category_group, name, cid_);               \
@@ skipping 553 matching lines @@
     const char* arg2_name,
     const ARG2_TYPE& arg2_val) {
   int thread_id = static_cast<int>(base::PlatformThread::CurrentId());
   base::TimeTicks now = base::TimeTicks::Now();
   return AddTraceEventWithThreadIdAndTimestamp(
       phase, category_group_enabled, name, scope, id, thread_id, now, flags,
       bind_id, arg1_name, arg1_val, arg2_name, arg2_val);
 }
 
 template <class ARG1_CONVERTABLE_TYPE>
-static inline void AddMetadataEvent(
+static inline void AddMetadataEventWithTimestamp(
+    char phase,
     const unsigned char* category_group_enabled,
     const char* event_name,
+    const base::TimeTicks& timestamp,
     const char* arg_name,
     std::unique_ptr<ARG1_CONVERTABLE_TYPE> arg_value) {
   const char* arg_names[1] = {arg_name};
   unsigned char arg_types[1] = {TRACE_VALUE_TYPE_CONVERTABLE};
   std::unique_ptr<base::trace_event::ConvertableToTraceFormat>
       convertable_values[1] = {std::move(arg_value)};
+
   base::trace_event::TraceLog::GetInstance()->AddMetadataEvent(
-      category_group_enabled, event_name,
+      phase, category_group_enabled, event_name, timestamp,
       1,  // num_args
       arg_names, arg_types,
       nullptr,  // arg_values
       convertable_values, TRACE_EVENT_FLAG_NONE);
 }
 
+template <class ARG1_TYPE, class ARG2_TYPE>
+static inline void AddMetadataEventWithTimestamp(
+    char phase,
+    const unsigned char* category_group_enabled,
+    const char* event_name,
+    const base::TimeTicks& timestamp,
+    const char* arg1_name,
+    const ARG1_TYPE& arg1_val,
+    const char* arg2_name,
+    const ARG2_TYPE& arg2_val) {
+  const int num_args = 2;
+  const char* arg_names[2] = {arg1_name, arg2_name};
+  unsigned char arg_types[2];
+  unsigned long long arg_values[2];
+  SetTraceValue(arg1_val, &arg_types[0], &arg_values[0]);
+  SetTraceValue(arg2_val, &arg_types[1], &arg_values[1]);
+  base::trace_event::TraceLog::GetInstance()->AddMetadataEvent(
+      phase, category_group_enabled, event_name, timestamp, num_args, arg_names,
+      arg_types, arg_values, nullptr, TRACE_EVENT_FLAG_NONE);
+}
+
+template <class ARG1_TYPE, class ARG2_CONVERTABLE_TYPE>
+static inline void AddMetadataEventWithTimestamp(
+    char phase,
+    const unsigned char* category_group_enabled,
+    const char* event_name,
+    const base::TimeTicks& timestamp,
+    const char* arg1_name,
+    const ARG1_TYPE& arg1_val,
+    const char* arg2_name,
+    std::unique_ptr<ARG2_CONVERTABLE_TYPE> arg2_val) {
+  AddMetadataEventWithTimestamp(phase, category_group_enabled, event_name,
+                                timestamp, arg1_name, arg1_val, arg2_name,
+                                std::move(arg2_val));
+}
+
 template <class ARG1_TYPE>
-static void AddMetadataEvent(const unsigned char* category_group_enabled,
-                             const char* event_name,
-                             const char* arg_name,
-                             const ARG1_TYPE& arg_val) {
+static inline void AddMetadataEventWithTimestamp(
+    char phase,
+    const unsigned char* category_group_enabled,
+    const char* event_name,
+    const base::TimeTicks& timestamp,
+    const char* arg_name,
+    const ARG1_TYPE& arg_val) {
   const int num_args = 1;
   const char* arg_names[1] = {arg_name};
   unsigned char arg_types[1];
   unsigned long long arg_values[1];
   SetTraceValue(arg_val, &arg_types[0], &arg_values[0]);
 
   base::trace_event::TraceLog::GetInstance()->AddMetadataEvent(
-      category_group_enabled, event_name, num_args, arg_names, arg_types,
-      arg_values, nullptr, TRACE_EVENT_FLAG_NONE);
+      phase, category_group_enabled, event_name, timestamp, num_args, arg_names,
+      arg_types, arg_values, nullptr, TRACE_EVENT_FLAG_NONE);
+}
+
+template <class ARG1_CONVERTABLE_TYPE>
+static inline void AddMetadataEvent(
+    char phase,
+    const unsigned char* category_group_enabled,
+    const char* event_name,
+    const char* arg_name,
+    std::unique_ptr<ARG1_CONVERTABLE_TYPE> arg_value) {
+  base::TimeTicks now = base::TimeTicks::Now();
+  AddMetadataEventWithTimestamp(phase, category_group_enabled, event_name, now,
+                                arg_name, std::move(arg_value));
+}
+
+template <class ARG1_TYPE>
+static void AddMetadataEvent(char phase,
+                             const unsigned char* category_group_enabled,
+                             const char* event_name,
+                             const char* arg_name,
+                             const ARG1_TYPE& arg_val) {
+  base::TimeTicks now = base::TimeTicks::Now();
+  AddMetadataEventWithTimestamp(phase, category_group_enabled, event_name, now,
+                                arg_name, arg_val);
 }
 
 // Used by TRACE_EVENTx macros. Do not use directly.
 class TRACE_EVENT_API_CLASS_EXPORT ScopedTracer {
  public:
   // Note: members of data_ intentionally left uninitialized. See Initialize.
   ScopedTracer() : p_data_(NULL) {}
 
   ~ScopedTracer() {
     if (p_data_ && *data_.category_group_enabled)
@@ skipping 105 matching lines @@
   const char* name_;
   IDType id_;
 
   DISALLOW_COPY_AND_ASSIGN(TraceScopedTrackableObject);
 };
 
 }  // namespace trace_event
 }  // namespace base
 
 #endif  // BASE_TRACE_EVENT_TRACE_EVENT_H_