blob: 2357862d5d2bb29eb3acd98ee0d523183189add4 [file] [log] [blame]
// Copyright 2017 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.
#include <iosfwd>
#include <vector>
#include "base/values.h"
#include "components/services/heap_profiling/allocation_event.h"
#include "components/services/heap_profiling/public/cpp/stream.h"
#include "components/services/heap_profiling/public/mojom/heap_profiling_service.mojom.h"
#include "services/resource_coordinator/public/mojom/memory_instrumentation/memory_instrumentation.mojom.h"
namespace heap_profiling {
// Configuration passed to the export functions because they take many
// arguments. All parameters must be set.
struct ExportParams {
// Allocation events to export.
AllocationCountMap allocs;
// VM map of all regions in the process.
std::vector<memory_instrumentation::mojom::VmRegionPtr> maps;
// Map from context string to context ID. A reverse-mapping will tell you
// what the context_id in the allocation mean.
std::map<std::string, int> context_map;
// Some addresses represent strings rather than instruction pointers.
// The strings are assumed to already be escaped for JSON.
std::unordered_map<uint64_t, std::string> mapped_strings;
// The type of browser [browser, renderer, gpu] that is being heap-dumped.
mojom::ProcessType process_type = mojom::ProcessType::OTHER;
// Only allocations exceeding this size or count will be exported.
size_t min_size_threshold = 0;
size_t min_count_threshold = 0;
// Whether or not the paths should be stripped from mapped files. Doing so
// anonymizes the trace, since the paths could potentially contain a username.
// However, it prevents symbolization of locally built instances of Chrome.
bool strip_path_from_mapped_files = false;
// The heaps_v2 trace format requires that ids are unique across heap dumps in
// a single trace. This class is currently stateless, and does not know
// whether a heap dump will be in a trace with other heap dumps. To work
// around this, just make all IDs unique. The parameter is an input parameter
// that tells the exporter which ID to start from. It is also an output
// parameter, and tells the caller the next unused ID.
// See
size_t next_id = 1;
// When sampling is enabled, each allocation is recorded with probability
// (size / sampling_rate). The resulting exported JSON needs to be
// appropriately updated to reflect de-sampled values.
// A |sampling_rate| of 1 is equivalent to recording all allocations.
size_t sampling_rate = 1;
// Creates a JSON string representing a JSON dictionary that contains memory
// maps and v2 format stack traces.
void ExportMemoryMapsAndV2StackTraceToJSON(ExportParams* params,
std::ostream& out);
} // namespace heap_profiling