Bytehound Documentation

The jemalloc ecosystem in this repository consists of three main crates:

• tikv-jemalloc-sys: Builds and links against jemalloc, exposing raw C bindings.
• tikv-jemallocator: Provides the Jemalloc type which implements the GlobalAlloc and Alloc traits for use as a global allocator.
• tikv-jemalloc-ctl: A high-level wrapper over jemalloc's control and introspection APIs (the mallctl*() family of functions and the _MALLCTL NAMESPACE).

The jemalloc-sys crate provides Rust bindings to the jemalloc C library.

Note: If you want to use the Rust allocator API for jemalloc, you should use the tikv-jemallocator crate instead.

Bytehound is a memory profiler for Linux. The documentation provides guidance on several key areas:

• Introduction & Getting Started: Core concepts and initial setup.
• Case Studies: Practical examples, such as memory leak analysis.
• Configuration: How to tune the profiler.
• Troubleshooting: Resolving common issues.
• API Reference: Detailed documentation for using Bytehound's programmatic interfaces, including globally available functions, core data types like Allocation, AllocationList, Backtrace, Data, Graph, Map, and Duration, and their associated methods.

To build jemalloc for Windows using MSVC, follow these steps to set up the environment and generate the necessary Visual Studio solution files.

Prerequisites

1. Cygwin: Install Cygwin with the following packages:
   • autoconf
   • autogen
   • gawk
   • grep
   • sed
2. Visual Studio: Install Visual Studio 2015 or 2017 with Visual C++.
3. Environment: Add Cygwin\bin to your PATH environment variable.

Build Steps

1. Open the "x64 Native Tools Command Prompt for VS 2017".
2. Generate the header files by running:

   sh -c "CC=cl ./autogen.sh"

3. Open the generated solution file in Visual Studio to build the project: msvc\jemalloc_vc2017.sln

The Data object is used to manage loaded data files within Bytehound. You can interact with it in two ways:

1. Access existing data: Use the data global to access the currently loaded data file.
2. Load new data: Use the load global to load a specific data file into the environment.

To use tikv-jemallocator, add it to your Cargo.toml. It is recommended to use a target-specific dependency to avoid issues on MSVC (Windows) platforms, as jemalloc is primarily intended for non-MSVC environments.

[dependencies]

[target.'cfg(not(target_env = "msvc"))'.dependencies]
tikv-jemallocator = "0.4.0"

To use mimalloc as the global allocator in your Rust project, import MiMalloc and annotate a static instance with #[global_allocator].

use mimalloc::MiMalloc;

#[global_allocator]
static GLOBAL: MiMalloc = MiMalloc;