forked from carbon-language/carbon-lang
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add basic output of where memory is stored after a compile. (carbon-l…
…anguage#4136) The output is really basic, I'm just adding this to help track how memory is allocated. ``` --- filename: 'check/testdata/expr_category/in_place_tuple_init.carbon' source_: used_bytes: 8057 reserved_bytes: 8057 tokens_.allocator_: used_bytes: 0 reserved_bytes: 0 tokens_.token_infos_: used_bytes: 1040 reserved_bytes: 2032 (eliding) value_stores_.string_literals_.set_: used_bytes: 320 reserved_bytes: 320 Total: used_bytes: 20609 reserved_bytes: 29437 ... ``` --------- Co-authored-by: josh11b <15258583+josh11b@users.noreply.github.com>
- Loading branch information
1 parent
ccf1275
commit d2c1ae1
Showing
20 changed files
with
354 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| // Part of the Carbon Language project, under the Apache License v2.0 with LLVM | ||
| // Exceptions. See /LICENSE for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
|
|
||
| #ifndef CARBON_TOOLCHAIN_BASE_MEM_USAGE_H_ | ||
| #define CARBON_TOOLCHAIN_BASE_MEM_USAGE_H_ | ||
|
|
||
| #include <cstdint> | ||
|
|
||
| #include "common/map.h" | ||
| #include "common/set.h" | ||
| #include "llvm/ADT/STLFunctionalExtras.h" | ||
| #include "llvm/ADT/SmallVector.h" | ||
| #include "llvm/ADT/StringRef.h" | ||
| #include "llvm/Support/FormatVariadic.h" | ||
| #include "toolchain/base/yaml.h" | ||
|
|
||
| namespace Carbon { | ||
|
|
||
| // Helps track memory usage for a compile. | ||
| // | ||
| // Users will mix `Add` and `Collect` calls, using `ConcatLabel` to label | ||
| // allocation sources. Typically we'll collect stats for growable, potentially | ||
| // large data types (such as `SmallVector`), ignoring small fixed-size members | ||
| // (such as pointers or `int32_t`). | ||
| // | ||
| // For example: | ||
| // | ||
| // auto CollectMemUsage(MemUsage& mem_usage, llvm::StringRef label) const | ||
| // -> void { | ||
| // // Explicit tracking. | ||
| // mem_usage.Add(MemUsage::ConcatLabel(label, "data_"), data_.used_bytes(), | ||
| // data_.reserved_bytes()); | ||
| // // Common library types like `Map` and `llvm::SmallVector` have | ||
| // // type-specific support. | ||
| // mem_usage.Add(MemUsage::Concat(label, "array_"), array_); | ||
| // // Implementing `CollectMemUsage` allows use with the same interface. | ||
| // mem_usage.Collect(MemUsage::Concat(label, "obj_"), obj_); | ||
| // } | ||
| class MemUsage { | ||
| public: | ||
| // Adds tracking for used and reserved bytes, paired with the given label. | ||
| auto Add(std::string label, int64_t used_bytes, int64_t reserved_bytes) | ||
| -> void { | ||
| mem_usage_.push_back({.label = std::move(label), | ||
| .used_bytes = used_bytes, | ||
| .reserved_bytes = reserved_bytes}); | ||
| } | ||
|
|
||
| // Adds usage tracking for an allocator. | ||
| auto Add(std::string label, const llvm::BumpPtrAllocator& allocator) -> void { | ||
| Add(std::move(label), allocator.getBytesAllocated(), | ||
| allocator.getTotalMemory()); | ||
| } | ||
|
|
||
| // Adds usage tracking for a map. | ||
| template <typename KeyT, typename ValueT, ssize_t SmallSize, | ||
| typename KeyContextT> | ||
| auto Add(std::string label, Map<KeyT, ValueT, SmallSize, KeyContextT> map, | ||
| KeyContextT key_context = KeyContextT()) -> void { | ||
| // These don't track used bytes, so we set the same value for used and | ||
| // reserved bytes. | ||
| auto bytes = map.ComputeMetrics(key_context).storage_bytes; | ||
| Add(std::move(label), bytes, bytes); | ||
| } | ||
|
|
||
| // Adds usage tracking for a set. | ||
| template <typename KeyT, ssize_t SmallSize, typename KeyContextT> | ||
| auto Add(std::string label, Set<KeyT, SmallSize, KeyContextT> set, | ||
| KeyContextT key_context = KeyContextT()) -> void { | ||
| // These don't track used bytes, so we set the same value for used and | ||
| // reserved bytes. | ||
| auto bytes = set.ComputeMetrics(key_context).storage_bytes; | ||
| Add(std::move(label), bytes, bytes); | ||
| } | ||
|
|
||
| // Adds memory usage of an array's data. This ignores the possible overhead of | ||
| // a SmallVector's in-place storage; if it's used, it's going to be tiny | ||
| // relative to scaling memory costs. | ||
| // | ||
| // This uses SmallVector in order to get proper inference for T, which | ||
| // ArrayRef misses. | ||
| template <typename T, unsigned N> | ||
| auto Add(std::string label, const llvm::SmallVector<T, N>& array) -> void { | ||
| Add(std::move(label), array.size_in_bytes(), array.capacity_in_bytes()); | ||
| } | ||
|
|
||
| // Adds memory usage for an object that provides `CollectMemUsage`. | ||
| // | ||
| // The expected signature of `CollectMemUsage` is above, in MemUsage class | ||
| // comments. | ||
| template <typename T> | ||
| auto Collect(llvm::StringRef label, const T& arg) -> void { | ||
| arg.CollectMemUsage(*this, label); | ||
| } | ||
|
|
||
| // Constructs a label for memory usage, handling the `.` concatenation. | ||
| // We don't expect much depth in labels per-call. | ||
| static auto ConcatLabel(llvm::StringRef label, llvm::StringRef child_label) | ||
| -> std::string { | ||
| return llvm::formatv("{0}.{1}", label, child_label); | ||
| } | ||
| static auto ConcatLabel(llvm::StringRef label, llvm::StringRef child_label1, | ||
| llvm::StringRef child_label2) -> std::string { | ||
| return llvm::formatv("{0}.{1}.{2}", label, child_label1, child_label2); | ||
| } | ||
|
|
||
| auto OutputYaml(llvm::StringRef filename) const -> Yaml::OutputMapping { | ||
| // Explicitly copy the filename. | ||
| return Yaml::OutputMapping([&, filename](Yaml::OutputMapping::Map map) { | ||
| map.Add("filename", filename); | ||
| int64_t total_used = 0; | ||
| int64_t total_reserved = 0; | ||
| for (const auto& entry : mem_usage_) { | ||
| total_used += entry.used_bytes; | ||
| total_reserved += entry.reserved_bytes; | ||
| map.Add(entry.label, | ||
| Yaml::OutputMapping([&](Yaml::OutputMapping::Map byte_map) { | ||
| byte_map.Add("used_bytes", entry.used_bytes); | ||
| byte_map.Add("reserved_bytes", entry.reserved_bytes); | ||
| })); | ||
| } | ||
| map.Add("Total", | ||
| Yaml::OutputMapping([&](Yaml::OutputMapping::Map byte_map) { | ||
| byte_map.Add("used_bytes", total_used); | ||
| byte_map.Add("reserved_bytes", total_reserved); | ||
| })); | ||
| }); | ||
| } | ||
|
|
||
| private: | ||
| // Memory usage for a specific label. | ||
| struct Entry { | ||
| std::string label; | ||
| int64_t used_bytes; | ||
| int64_t reserved_bytes; | ||
| }; | ||
|
|
||
| // The accumulated data on memory usage. | ||
| llvm::SmallVector<Entry> mem_usage_; | ||
| }; | ||
|
|
||
| } // namespace Carbon | ||
|
|
||
| #endif // CARBON_TOOLCHAIN_BASE_MEM_USAGE_H_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Part of the Carbon Language project, under the Apache License v2.0 with LLVM | ||
| // Exceptions. See /LICENSE for license information. | ||
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
| // | ||
| // ARGS: compile --phase=check --dump-mem-usage %s | ||
| // | ||
| // NOAUTOUPDATE | ||
| // | ||
| // Avoid testing specific values: | ||
| // SET-CHECK-SUBSET | ||
|
|
||
| var x: i32 = 1; | ||
|
|
||
| // CHECK:STDOUT: --- | ||
| // CHECK:STDOUT: filename: dump_mem_usage.carbon | ||
| // CHECK:STDOUT: source_: | ||
| // CHECK:STDOUT: used_bytes: 0 | ||
| // CHECK:STDOUT: reserved_bytes: 0 | ||
| // CHECK:STDOUT: ... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.