跳转到内容

std.valgrind.memcheck

标准库Zig 0.17.1官方原文
源码std/valgrind/memcheck.zig

第 1 行

std.valgrind.memcheck.checkMemIsAddressable

函数

第 77 行

检查 qzz.ptr 开始的 qzz.len 字节内存是否可寻址。 如果不满足所需的可寻址性,Valgrind 输出 错误消息,并返回第一个违规字节的地址。 否则返回零。

pub fn checkMemIsAddressable(qzz: []const u8) usize

参数

qzz: []const u8

std.valgrind.memcheck.checkMemIsDefined

函数

第 85 行

检查 qzz.ptr 开始的 qzz.len 字节内存 是否可寻址且已定义。如果不满足 所需的可寻址性和已定义性,Valgrind 输出错误消息,并返回 第一个违规字节的地址。否则返回零。

pub fn checkMemIsDefined(qzz: []const u8) usize

参数

qzz: []const u8

std.valgrind.memcheck.ClientRequest

容器

第 5 行

字段

MakeMemNoAccess = valgrind.ToolBase("MC".*)
MakeMemUndefined
MakeMemDefined
Discard
CheckMemIsAddressable
CheckMemIsDefined
DoLeakCheck
CountLeaks
GetVbits
SetVbits
CreateBlock
MakeMemDefinedIfAddressable
CountLeakBlocks
EnableAddrErrorReportingInRange
DisableAddrErrorReportingInRange

std.valgrind.memcheck.countLeakBlocks

函数

第 152 行

pub fn countLeakBlocks() CountResult

用法示例

test countLeakBlocks {
    try testing.expectEqual(
        @as(CountResult, .{
            .leaked = 0,
            .dubious = 0,
            .reachable = 0,
            .suppressed = 0,
        }),
        countLeakBlocks(),
    );
}

std.valgrind.memcheck.countLeaks

函数

第 122 行

pub fn countLeaks() CountResult

用法示例

test countLeaks {
    try testing.expectEqual(
        @as(CountResult, .{
            .leaked = 0,
            .dubious = 0,
            .reachable = 0,
            .suppressed = 0,
        }),
        countLeaks(),
    );
}

std.valgrind.memcheck.CountResult

容器

第 115 行

返回先前所有泄漏检查发现的泄漏、可疑、可达和已抑制 字节数量。

字段

leaked: usize
dubious: usize
reachable: usize
suppressed: usize

std.valgrind.memcheck.createBlock

函数

第 61 行

创建内存块描述句柄。描述是 ASCII 字符串,会包含在涉及指定内存范围内 地址的任何消息中。除此之外, 不影响该内存范围的属性。

pub fn createBlock(qzz: []const u8, desc: [*:0]const u8) usize

参数

qzz: []const u8
desc: [*:0]const u8

std.valgrind.memcheck.disableAddrErrorReportingInRange

函数

第 210 行

禁用及重新启用对指定地址范围内 寻址错误的报告。

pub fn disableAddrErrorReportingInRange(qzz: []u8) usize

参数

qzz: []u8

std.valgrind.memcheck.discard

函数

第 68 行

丢弃块描述句柄。句柄无效时返回 1, 有效时返回 0。

pub fn discard(blkindex: usize) bool

参数

blkindex: usize

std.valgrind.memcheck.doAddedLeakCheck

函数

第 97 行

与 doLeakCheck() 相同,但仅显示自上次泄漏搜索以来,泄漏字节数或块数有所增加的条目。

pub fn doAddedLeakCheck() void

std.valgrind.memcheck.doChangedLeakCheck

函数

第 104 行

与 doAddedLeakCheck() 相同,但显示相较于 上次泄漏搜索,泄漏字节/块数 增加或减少的条目。

pub fn doChangedLeakCheck() void

std.valgrind.memcheck.doClientRequestExpr

函数

第 23 行

fn doClientRequestExpr(default: usize, request: ClientRequest, a1: usize, a2: usize, a3: usize, a4: usize, a5: usize) usize

参数

default: usize
request: ClientRequest
a1: usize
a2: usize
a3: usize
a4: usize
a5: usize

std.valgrind.memcheck.doClientRequestStmt

函数

第 27 行

fn doClientRequestStmt(request: ClientRequest, a1: usize, a2: usize, a3: usize, a4: usize, a5: usize) void

参数

request: ClientRequest
a1: usize
a2: usize
a3: usize
a4: usize
a5: usize

std.valgrind.memcheck.doLeakCheck

函数

第 90 行

在执行过程中进行完整内存泄漏检查(类似于 --leak-check=full)。

pub fn doLeakCheck() void

std.valgrind.memcheck.doQuickLeakCheck

函数

第 109 行

在执行期间进行概要内存泄漏检查(类似 --leak-check=summary)。

pub fn doQuickLeakCheck() void

std.valgrind.memcheck.enableAddrErrorReportingInRange

函数

第 215 行

pub fn enableAddrErrorReportingInRange(qzz: []u8) usize

参数

qzz: []u8

std.valgrind.memcheck.getVbits

函数

第 190 行

获取地址 zza 的有效性数据,并复制到给定 zzvbits 数组。 返回值: 0:未在 Valgrind 下运行。 1:成功。 2:以前表示数组未对齐;现在已允许未对齐数组。 3:zzsrc 或 zzvbits 的任意部分不可寻址。 在 0、2 或 3 的情况下不复制元数据,因此使用此调用应不会使程序发生段错误。

pub fn getVbits(zza: []u8, zzvbits: []u8) u2

参数

zza: []u8
zzvbits: []u8

std.valgrind.memcheck.makeMemDefined

函数

第 44 行

将 qzz.ptr 处 qzz.len 字节内存标记为可寻址且已定义。

pub fn makeMemDefined(qzz: []const u8) void

参数

qzz: []const u8

std.valgrind.memcheck.makeMemDefinedIfAddressable

函数

第 52 行

类似 makeMemDefined,但不改变可寻址性: 可寻址字节被标记为已定义, 不可寻址字节保持不变。

pub fn makeMemDefinedIfAddressable(qzz: []const u8) void

参数

qzz: []const u8

std.valgrind.memcheck.makeMemNoAccess

函数

第 32 行

将 qzz.ptr 处长度为 qzz.len 字节的内存标记为不可寻址。

pub fn makeMemNoAccess(qzz: []const u8) void

参数

qzz: []const u8

std.valgrind.memcheck.makeMemUndefined

函数

第 38 行

将 qzz.ptr 处长度为 qzz.len 字节的内存标记为可寻址但未定义。

pub fn makeMemUndefined(qzz: []const u8) void

参数

qzz: []const u8

std.valgrind.memcheck.setVbits

函数

第 203 行

从给定 zzvbits 数组复制数据,设置地址 zza 的有效性数据。 返回值: 0:未在 Valgrind 下运行。 1:成功。 2:以前表示数组未对齐;现在已允许未对齐数组。 3:zza 或 zzvbits 的任意部分不可寻址。 在 0、2 或 3 的情况下不复制元数据,因此使用此调用应不会使程序发生段错误。

pub fn setVbits(zzvbits: []u8, zza: []u8) u2

参数

zzvbits: []u8
zza: []u8

std.valgrind.memcheck.std

别名

第 1 行

别名目标 std

std.valgrind.memcheck.testing

别名

第 2 行

别名目标 std.testing

std.valgrind.memcheck.valgrind

别名

第 3 行

别名目标 std.valgrind

源码

std/valgrind/memcheck.zig

const std = @import("../std.zig");
const testing = std.testing;
const valgrind = std.valgrind;

pub const ClientRequest = enum(usize) {
    MakeMemNoAccess = valgrind.ToolBase("MC".*),
    MakeMemUndefined,
    MakeMemDefined,
    Discard,
    CheckMemIsAddressable,
    CheckMemIsDefined,
    DoLeakCheck,
    CountLeaks,
    GetVbits,
    SetVbits,
    CreateBlock,
    MakeMemDefinedIfAddressable,
    CountLeakBlocks,
    EnableAddrErrorReportingInRange,
    DisableAddrErrorReportingInRange,
};

fn doClientRequestExpr(default: usize, request: ClientRequest, a1: usize, a2: usize, a3: usize, a4: usize, a5: usize) usize {
    return valgrind.doClientRequest(default, @as(usize, @intCast(@backingInt(request))), a1, a2, a3, a4, a5);
}

fn doClientRequestStmt(request: ClientRequest, a1: usize, a2: usize, a3: usize, a4: usize, a5: usize) void {
    _ = doClientRequestExpr(0, request, a1, a2, a3, a4, a5);
}

/// 将 qzz.ptr 处长度为 qzz.len 字节的内存标记为不可寻址。
pub fn makeMemNoAccess(qzz: []const u8) void {
    _ = doClientRequestExpr(0, // 默认返回
        .MakeMemNoAccess, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 将 qzz.ptr 处长度为 qzz.len 字节的内存标记为可寻址但未定义。
pub fn makeMemUndefined(qzz: []const u8) void {
    _ = doClientRequestExpr(0, // 默认返回
        .MakeMemUndefined, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 将 qzz.ptr 处 qzz.len 字节内存标记为可寻址且已定义。
pub fn makeMemDefined(qzz: []const u8) void {
    _ = doClientRequestExpr(0, // 默认返回
        .MakeMemDefined, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 类似 makeMemDefined,但不改变可寻址性:
/// 可寻址字节被标记为已定义,
/// 不可寻址字节保持不变。
pub fn makeMemDefinedIfAddressable(qzz: []const u8) void {
    _ = doClientRequestExpr(0, // 默认返回
        .MakeMemDefinedIfAddressable, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 创建内存块描述句柄。描述是 ASCII
/// 字符串,会包含在涉及指定内存范围内
/// 地址的任何消息中。除此之外,
/// 不影响该内存范围的属性。
pub fn createBlock(qzz: []const u8, desc: [*:0]const u8) usize {
    return doClientRequestExpr(0, // 默认返回
        .CreateBlock, @intFromPtr(qzz.ptr), qzz.len, @intFromPtr(desc), 0, 0);
}

/// 丢弃块描述句柄。句柄无效时返回 1,
/// 有效时返回 0。
pub fn discard(blkindex: usize) bool {
    return doClientRequestExpr(0, // 默认返回
        .Discard, 0, blkindex, 0, 0, 0) != 0;
}

/// 检查 qzz.ptr 开始的 qzz.len 字节内存是否可寻址。
/// 如果不满足所需的可寻址性,Valgrind 输出
/// 错误消息,并返回第一个违规字节的地址。
/// 否则返回零。
pub fn checkMemIsAddressable(qzz: []const u8) usize {
    return doClientRequestExpr(0, .CheckMemIsAddressable, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 检查 qzz.ptr 开始的 qzz.len 字节内存
/// 是否可寻址且已定义。如果不满足
/// 所需的可寻址性和已定义性,Valgrind 输出错误消息,并返回
/// 第一个违规字节的地址。否则返回零。
pub fn checkMemIsDefined(qzz: []const u8) usize {
    return doClientRequestExpr(0, .CheckMemIsDefined, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

/// 在执行过程中进行完整内存泄漏检查(类似于 --leak-check=full)。
pub fn doLeakCheck() void {
    doClientRequestStmt(.DoLeakCheck, 0, 0, 0, 0, 0);
}

/// 与 doLeakCheck() 相同,但仅显示自上次泄漏搜索以来,泄漏字节数或块数有所增加的条目。
///
///
pub fn doAddedLeakCheck() void {
    doClientRequestStmt(.DoLeakCheck, 0, 1, 0, 0, 0);
}

/// 与 doAddedLeakCheck() 相同,但显示相较于
/// 上次泄漏搜索,泄漏字节/块数
/// 增加或减少的条目。
pub fn doChangedLeakCheck() void {
    doClientRequestStmt(.DoLeakCheck, 0, 2, 0, 0, 0);
}

/// 在执行期间进行概要内存泄漏检查(类似 --leak-check=summary)。
pub fn doQuickLeakCheck() void {
    doClientRequestStmt(.DoLeakCheck, 1, 0, 0, 0, 0);
}

/// 返回先前所有泄漏检查发现的泄漏、可疑、可达和已抑制
/// 字节数量。
const CountResult = struct {
    leaked: usize,
    dubious: usize,
    reachable: usize,
    suppressed: usize,
};

pub fn countLeaks() CountResult {
    var res: CountResult = .{
        .leaked = 0,
        .dubious = 0,
        .reachable = 0,
        .suppressed = 0,
    };
    doClientRequestStmt(
        .CountLeaks,
        @intFromPtr(&res.leaked),
        @intFromPtr(&res.dubious),
        @intFromPtr(&res.reachable),
        @intFromPtr(&res.suppressed),
        0,
    );
    return res;
}

test countLeaks {
    try testing.expectEqual(
        @as(CountResult, .{
            .leaked = 0,
            .dubious = 0,
            .reachable = 0,
            .suppressed = 0,
        }),
        countLeaks(),
    );
}

pub fn countLeakBlocks() CountResult {
    var res: CountResult = .{
        .leaked = 0,
        .dubious = 0,
        .reachable = 0,
        .suppressed = 0,
    };
    doClientRequestStmt(
        .CountLeakBlocks,
        @intFromPtr(&res.leaked),
        @intFromPtr(&res.dubious),
        @intFromPtr(&res.reachable),
        @intFromPtr(&res.suppressed),
        0,
    );
    return res;
}

test countLeakBlocks {
    try testing.expectEqual(
        @as(CountResult, .{
            .leaked = 0,
            .dubious = 0,
            .reachable = 0,
            .suppressed = 0,
        }),
        countLeakBlocks(),
    );
}

/// 获取地址 zza 的有效性数据,并复制到给定 zzvbits 数组。
/// 返回值:
///    0:未在 Valgrind 下运行。
///    1:成功。
///    2:以前表示数组未对齐;现在已允许未对齐数组。
///    3:zzsrc 或 zzvbits 的任意部分不可寻址。
/// 在 0、2 或 3 的情况下不复制元数据,因此使用此调用应不会使程序发生段错误。
///
pub fn getVbits(zza: []u8, zzvbits: []u8) u2 {
    std.debug.assert(zzvbits.len >= zza.len / 8);
    return @as(u2, @intCast(doClientRequestExpr(0, .GetVbits, @intFromPtr(zza.ptr), @intFromPtr(zzvbits.ptr), zza.len, 0, 0)));
}

/// 从给定 zzvbits 数组复制数据,设置地址 zza 的有效性数据。
/// 返回值:
///    0:未在 Valgrind 下运行。
///    1:成功。
///    2:以前表示数组未对齐;现在已允许未对齐数组。
///    3:zza 或 zzvbits 的任意部分不可寻址。
/// 在 0、2 或 3 的情况下不复制元数据,因此使用此调用应不会使程序发生段错误。
///
pub fn setVbits(zzvbits: []u8, zza: []u8) u2 {
    std.debug.assert(zzvbits.len >= zza.len / 8);
    return @as(u2, @intCast(doClientRequestExpr(0, .SetVbits, @intFromPtr(zza.ptr), @intFromPtr(zzvbits.ptr), zza.len, 0, 0)));
}

/// 禁用及重新启用对指定地址范围内
/// 寻址错误的报告。
pub fn disableAddrErrorReportingInRange(qzz: []u8) usize {
    return doClientRequestExpr(0, // 默认返回
        .DisableAddrErrorReportingInRange, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}

pub fn enableAddrErrorReportingInRange(qzz: []u8) usize {
    return doClientRequestExpr(0, // 默认返回
        .EnableAddrErrorReportingInRange, @intFromPtr(qzz.ptr), qzz.len, 0, 0, 0);
}