mirror of
https://github.com/google/tcmalloc.git
synced 2026-10-28 08:35:56 +08:00
Nuthatch AgentandChris Kennelly
a38202fc8c
Return early when growing or shrinking a per-CPU slab size class whose header has not yet been initialized or has been reclaimed back to zeroed memory. Before a CPU populates its slab, a size-class header holds zeroed current and begin indices while its end index already points to the start of that size class slot array. Without a guard, remote cache growth wrapped unsigned 16-bit capacity arithmetic and wrote a corrupt header that armed subsequent pushes at index zero, while remote cache shrinking read pointer slots before the start of the array. Both remote paths and local slab growth now reject uninitialized headers, and both growth paths check that the new end index stays below `Header::kReservedIndexValue`. Co-authored-by: Chris Kennelly <ckennelly@google.com> PiperOrigin-RevId: 1007119235
TCMalloc
This repository contains the TCMalloc C++ code.
TCMalloc is Google's customized implementation of C's malloc() and C++'s
operator new used for memory allocation within our C and C++ code. TCMalloc is
a fast, multi-threaded malloc implementation.
Building TCMalloc
Bazel is the official build system for TCMalloc. Experimental support for CMake is available as well.
The TCMalloc Platforms Guide contains information on platform support for TCMalloc.
Documentation
All users of TCMalloc should consult the following documentation resources:
- The TCMalloc Quickstart covers downloading, installing, building, and testing TCMalloc, including incorporating within your codebase.
- The TCMalloc Overview covers the basic architecture of TCMalloc, and how that may affect configuration choices.
- The TCMalloc Reference covers the C and C++ TCMalloc API endpoints.
More advanced usages of TCMalloc may find the following documentation useful:
- The TCMalloc Tuning Guide covers the configuration choices in more depth, and also illustrates other ways to customize TCMalloc. This also covers important operating system-level properties for improving TCMalloc performance.
- The TCMalloc Design Doc covers how TCMalloc works underneath the hood, and why certain design choices were made. Most developers will not need this level of implementation detail.
- The TCMalloc Compatibility Guide which documents our expectations for how our APIs are used.
License
The TCMalloc library is licensed under the terms of the Apache license. See LICENSE for more information.
Disclaimer: This is not an officially supported Google product.