rocketmq-store 0.9.0

Storage layer for Apache RocketMQ in Rust.
Documentation
// Copyright 2023 The RocketMQ Rust Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use rocketmq_error::RocketMQError;
use rocketmq_error::RocketMQResult;

pub const MADV_NORMAL: i32 = 0;
pub const MADV_RANDOM: i32 = 1;
pub const MADV_WILLNEED: i32 = 3;
pub const MADV_DONTNEED: i32 = 4;

#[inline]
pub fn get_page_size() -> usize {
    page_size::get()
}

#[inline]
pub fn mlock(addr: *const u8, len: usize) -> RocketMQResult<()> {
    #[cfg(unix)]
    {
        use std::ffi::c_void;
        let result = unsafe { libc::mlock(addr as *const c_void, len) };
        if result != 0 {
            return Err(RocketMQError::StorageLockFailed {
                path: "memory lock (mlock)".to_string(),
            });
        }
        Ok(())
    }

    #[cfg(windows)]
    {
        use windows::Win32::System::Memory::VirtualLock;
        // Windows does not have mlock, so we just return Ok
        let result = unsafe { VirtualLock(addr as _, len) };
        result.map_err(|e| RocketMQError::StorageLockFailed {
            path: format!("memory lock (VirtualLock): {}", e),
        })?;
        Ok(())
    }
}

#[inline]
pub fn munlock(addr: *const u8, len: usize) -> RocketMQResult<()> {
    #[cfg(unix)]
    {
        use std::ffi::c_void;

        let result = unsafe { libc::munlock(addr as *const c_void, len) };
        if result != 0 {
            return Err(RocketMQError::StorageLockFailed {
                path: "memory unlock (munlock)".to_string(),
            });
        }
        Ok(())
    }
    #[cfg(windows)]
    {
        use windows::Win32::System::Memory::VirtualUnlock;

        // Windows does not have munlock, so we just return Ok
        let result = unsafe { VirtualUnlock(addr as _, len) };
        result.map_err(|e| RocketMQError::StorageLockFailed {
            path: format!("memory unlock (VirtualUnlock): {}", e),
        })?;
        Ok(())
    }
}

pub fn madvise(addr: *const u8, len: usize, advice: i32) -> i32 {
    #[cfg(unix)]
    {
        use std::ffi::c_void;
        unsafe { libc::madvise(addr as *mut c_void, len, advice) }
    }
    #[cfg(windows)]
    {
        // Windows does not have madvise, so we just return 0
        0
    }
}

pub fn mincore(addr: *const u8, len: usize, vec: *const u8) -> i32 {
    #[cfg(target_os = "linux")]
    {
        use std::ffi::c_void;

        use libc::c_uchar;

        unsafe { libc::mincore(addr as *mut c_void, len, vec as *mut c_uchar) }
    }
    #[cfg(target_os = "macos")]
    {
        use std::ffi::c_void;

        use libc::c_char;

        unsafe { libc::mincore(addr as *mut c_void, len, vec as *mut c_char) }
    }

    #[cfg(target_os = "windows")]
    {
        // Windows does not have mincore, so we just return 0
        0
    }
}