Function madvise [src]

Give advice about use of memory. This syscall is optional and is sometimes configured to be disabled.

Prototype

pub fn madvise(ptr: [*]align(page_size_min) u8, length: usize, advice: u32) MadviseError!void

Parameters

ptr: [*]align(page_size_min) u8length: usizeadvice: u32

Possible Errors

AccessDenied

advice is MADV.REMOVE, but the specified address range is not a shared writable mapping.

InvalidSyscall

One of the following:

addr is not page-aligned or length is negative
advice is not valid
advice is MADV.DONTNEED or MADV.REMOVE and the specified address range includes locked, Huge TLB pages, or VM_PFNMAP pages.
advice is MADV.MERGEABLE or MADV.UNMERGEABLE, but the kernel was not configured with CONFIG_KSM.
advice is MADV.FREE or MADV.WIPEONFORK but the specified address range includes file, Huge TLB, MAP.SHARED, or VM_PFNMAP ranges.

MadviseUnavailable

The madvise syscall is not available on this version and configuration of the Linux kernel.

OutOfMemory

One of the following:

(for MADV.WILLNEED) Not enough memory: paging in failed.
Addresses in the specified range are not currently mapped, or are outside the address space of the process.

PermissionDenied

advice is MADV.HWPOISON, but the caller does not have the CAP_SYS_ADMIN capability.

SystemResources

A kernel resource was temporarily unavailable.

Unexpected

The operating system returned an undocumented error code.

WouldExceedMaximumResidentSetSize

(for MADV.WILLNEED) Paging in this area would exceed the process's maximum resident set size.

Source

  pub fn madvise(ptr: [*]align(page_size_min) u8, length: usize, advice: u32) MadviseError!void {
    switch (errno(system.madvise(ptr, length, advice))) {
        .SUCCESS => return,
        .PERM => return error.PermissionDenied,
        .ACCES => return error.AccessDenied,
        .AGAIN => return error.SystemResources,
        .BADF => unreachable, // The map exists, but the area maps something that isn't a file.
        .INVAL => return error.InvalidSyscall,
        .IO => return error.WouldExceedMaximumResidentSetSize,
        .NOMEM => return error.OutOfMemory,
        .NOSYS => return error.MadviseUnavailable,
        else => |err| return unexpectedErrno(err),
    }
}  