Remove memory category from chrome://tracing

base/trace_event/trace_event_memory.h

-// Copyright 2013 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_MEMORY_H_
-#define BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_
-
-#include "base/base_export.h"
-#include "base/gtest_prod_util.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/weak_ptr.h"
-#include "base/timer/timer.h"
-#include "base/trace_event/trace_log.h"
-
-// TODO(jamescook): Windows support for memory tracing.
-#if !defined(NO_TCMALLOC) && !defined(OS_NACL) && \
-    (defined(OS_LINUX) || defined(OS_ANDROID))
-#define TCMALLOC_TRACE_MEMORY_SUPPORTED 1
-#endif
-
-namespace base {
-
-class SingleThreadTaskRunner;
-
-namespace trace_event {
-
-// Watches for chrome://tracing to be enabled or disabled. When tracing is
-// enabled, also enables tcmalloc heap profiling. This class is the preferred
-// way to turn trace-base heap memory profiling on and off.
-class BASE_EXPORT TraceMemoryController
-    : public TraceLog::EnabledStateObserver {
- public:
-  typedef int (*StackGeneratorFunction)(int skip_count, void** stack);
-  typedef void (*HeapProfilerStartFunction)(StackGeneratorFunction callback);
-  typedef void (*HeapProfilerStopFunction)();
-  typedef char* (*GetHeapProfileFunction)();
-
-  // |task_runner| must be a task runner for the primary thread for the client
-  // process, e.g. the UI thread in a browser. The function pointers must be
-  // pointers to tcmalloc heap profiling functions; by avoiding direct calls to
-  // these functions we avoid a dependency on third_party/tcmalloc from base.
-  TraceMemoryController(scoped_refptr<SingleThreadTaskRunner> task_runner,
-                        HeapProfilerStartFunction heap_profiler_start_function,
-                        HeapProfilerStopFunction heap_profiler_stop_function,
-                        GetHeapProfileFunction get_heap_profile_function);
-  ~TraceMemoryController() override;
-
-  // base::trace_event::TraceLog::EnabledStateChangedObserver overrides:
-  void OnTraceLogEnabled() override;
-  void OnTraceLogDisabled() override;
-
-  // Starts heap memory profiling.
-  void StartProfiling();
-
-  // Captures a heap profile.
-  void DumpMemoryProfile();
-
-  // If memory tracing is enabled, dumps a memory profile to the tracing system.
-  void StopProfiling();
-
- private:
-  FRIEND_TEST_ALL_PREFIXES(TraceMemoryTest, TraceMemoryController);
-
-  bool IsTimerRunningForTest() const;
-
-  // Ensures the observer starts and stops tracing on the primary thread.
-  scoped_refptr<SingleThreadTaskRunner> task_runner_;
-
-  // Pointers to tcmalloc heap profiling functions. Allows this class to use
-  // tcmalloc functions without introducing a dependency from base to tcmalloc.
-  HeapProfilerStartFunction heap_profiler_start_function_;
-  HeapProfilerStopFunction heap_profiler_stop_function_;
-  GetHeapProfileFunction get_heap_profile_function_;
-
-  // Timer to schedule memory profile dumps.
-  RepeatingTimer dump_timer_;
-
-  WeakPtrFactory<TraceMemoryController> weak_factory_;
-
-  DISALLOW_COPY_AND_ASSIGN(TraceMemoryController);
-};
-
-//////////////////////////////////////////////////////////////////////////////
-
-// A scoped context for memory tracing. Pushes the name onto a stack for
-// recording by tcmalloc heap profiling.
-class BASE_EXPORT ScopedTraceMemory {
- public:
-  struct ScopeData {
-    const char* category;
-    const char* name;
-  };
-
-  // Memory for |category| and |name| must be static, for example, literal
-  // strings in a TRACE_EVENT macro.
-  ScopedTraceMemory(const char* category, const char* name) {
-    if (!enabled_)
-      return;
-    Initialize(category, name);
-  }
-  ~ScopedTraceMemory() {
-    if (!enabled_)
-      return;
-    Destroy();
-  }
-
-  // Enables the storing of trace names on a per-thread stack.
-  static void set_enabled(bool enabled) { enabled_ = enabled; }
-
-  // Testing interface:
-  static void InitForTest();
-  static void CleanupForTest();
-  static int GetStackDepthForTest();
-  static ScopeData GetScopeDataForTest(int stack_index);
-
- private:
-  void Initialize(const char* category, const char* name);
-  void Destroy();
-
-  static bool enabled_;
-  DISALLOW_COPY_AND_ASSIGN(ScopedTraceMemory);
-};
-
-//////////////////////////////////////////////////////////////////////////////
-
-// Converts tcmalloc's heap profiler data with pseudo-stacks in |input| to
-// trace event compatible JSON and appends to |output|. Visible for testing.
-BASE_EXPORT void AppendHeapProfileAsTraceFormat(const char* input,
-                                                std::string* output);
-
-// Converts the first |line| of heap profiler data, which contains totals for
-// all allocations in a special format, into trace event compatible JSON and
-// appends to |output|. Visible for testing.
-BASE_EXPORT void AppendHeapProfileTotalsAsTraceFormat(const std::string& line,
-                                                      std::string* output);
-
-// Converts a single |line| of heap profiler data into trace event compatible
-// JSON and appends to |output|. Returns true if the line was valid and has a
-// non-zero number of current allocations. Visible for testing.
-BASE_EXPORT bool AppendHeapProfileLineAsTraceFormat(const std::string& line,
-                                                    std::string* output);
-
-// Returns a pointer to a string given its hexadecimal address in |hex_address|.
-// Handles both 32-bit and 64-bit addresses. Returns "null" for null pointers
-// and "error" if |address| could not be parsed. Visible for testing.
-BASE_EXPORT const char* StringFromHexAddress(const std::string& hex_address);
-
-}  // namespace trace_event
-}  // namespace base
-
-// Make local variables with unique names based on the line number. Note that
-// the extra level of redirection is needed.
-#define INTERNAL_TRACE_MEMORY_ID3(line) trace_memory_unique_##line
-#define INTERNAL_TRACE_MEMORY_ID2(line) INTERNAL_TRACE_MEMORY_ID3(line)
-#define INTERNAL_TRACE_MEMORY_ID INTERNAL_TRACE_MEMORY_ID2(__LINE__)
-
-// This is the core macro that adds a scope to each TRACE_EVENT location.
-// It generates a unique local variable name using the macros above.
-#if defined(TCMALLOC_TRACE_MEMORY_SUPPORTED)
-#define INTERNAL_TRACE_MEMORY(category, name) \
-  base::trace_event::ScopedTraceMemory INTERNAL_TRACE_MEMORY_ID(category, name);
-#else
-#define INTERNAL_TRACE_MEMORY(category, name)
-#endif  // defined(TRACE_MEMORY_SUPPORTED)
-
-// A special trace name that allows us to ignore memory allocations inside
-// the memory dump system itself. The allocations are recorded, but the
-// visualizer skips them. Must match the value in heap.js.
-#define TRACE_MEMORY_IGNORE "trace-memory-ignore"
-
-#endif  // BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_