如何使用 memmap 板条箱附加到文件支持的 mmap？

Question

我有一个文件foo.txt，内容为

foobar

我想不断追加到这个文件并访问修改后的文件。

`MmapMut`

我尝试的第一件事是直接改变 mmap:

use memmap;
use std::fs;
use std::io::prelude::*;

fn main() -> Result<(), Box<std::error::Error>> {
    let backing_file = fs::OpenOptions::new()
        .read(true)
        .append(true)
        .create(true)
        .write(true)
        .open("foo.txt")?;

    let mut mmap = unsafe { memmap::MmapMut::map_mut(&backing_file)? };

    loop {
        println!("{}", std::str::from_utf8(&mmap[..])?);
        std::thread::sleep(std::time::Duration::from_secs(5));
        let buf = b"somestring";
        (&mut mmap[..]).write_all(buf)?;
        mmap.flush()?;
    }
}

这会导致恐慌：

Error: Custom { kind: WriteZero, error: StringError("failed to write whole buffer") }

生成的文件显示为 somest

直接附加到支持文件

之后，我尝试直接追加到支持文件：

use memmap;
use std::fs;
use std::io::prelude::*;

fn main() -> Result<(), Box<std::error::Error>> {
    let mut backing_file = fs::OpenOptions::new()
        .read(true)
        .append(true)
        .create(true)
        .write(true)
        .open("foo.txt")?;

    let mmap = unsafe { memmap::MmapMut::map_mut(&backing_file)? };

    loop {
        println!("{}", std::str::from_utf8(&mmap[..])?);
        std::thread::sleep(std::time::Duration::from_secs(5));
        let buf = b"somestring";
        backing_file.write_all(buf)?;
        backing_file.flush()?;
    }
}

这不会导致恐慌。该文件会定期更新，但我的 mmap 不会反映这些更改。我希望标准输出看起来像这样：

foobar
foobarsomestring
foobarsomestringsomestring
...

但是我得到了

foobar
foobar
foobar
...

我主要对 Linux 依赖于平台的解决方案感兴趣。

Answer 1

首先，根据我的理解，我建议您高度怀疑那个板条箱。它允许您在安全的 Rust 中做一些您不应该而不是的事情。

例如，如果您有一个文件支持的 mmap，那么您计算机上对该文件具有正确权限的任何进程都可以修改它。这意味着：

将映射文件视为不可变字节片 (&[u8]) 永远无效，因为它可能会发生变异！
将映射文件视为可变字节片 (&mut [u8]) 永远是无效的，因为可变引用意味着可以更改该数据的独占所有者，但您没有。

documentation for that crate 涵盖了 none 这些问题，但没有讨论您应该如何使用一小部分 unsafe以安全的方式运行。对我来说，这些迹象表明您可能在代码中引入了未定义的行为，这是一件非常糟糕的事情。

例如：

use memmap;
use std::{fs, io::prelude::*};

fn main() -> Result<(), Box<std::error::Error>> {
    let mut backing_file = fs::OpenOptions::new()
        .read(true)
        .append(true)
        .create(true)
        .write(true)
        .open("foo.txt")?;

    backing_file.write_all(b"initial")?;

    let mut mmap_mut = unsafe { memmap::MmapMut::map_mut(&backing_file)? };
    let mmap_immut = unsafe { memmap::Mmap::map(&backing_file)? };

    // Code after here violates the rules of references, but doesn't use `unsafe`
    let a_str: &str = std::str::from_utf8(&mmap_immut)?;
    println!("{}", a_str); // initial

    mmap_mut[0] = b'x';

    // Look, we just changed an "immutable reference"!
    println!("{}", a_str); // xnitial

    Ok(())
}

因为人们通常不喜欢被告知 "no, don't do that, it's a bad idea"，这里是如何让你的代码到 "work"：直接附加到文件然后重新创建 mmap：

use memmap;
use std::{fs, io::prelude::*, thread, time::Duration};

fn main() -> Result<(), Box<std::error::Error>> {
    let mut backing_file = fs::OpenOptions::new()
        .read(true)
        .append(true)
        .create(true)
        .write(true)
        .open("foo.txt")?;

    // mmap requires that the initial mapping be non-zero
    backing_file.write_all(b"initial")?;

    for _ in 0..3 {
        let mmap = unsafe { memmap::MmapMut::map_mut(&backing_file)? };

        // I think this line can introduce memory unsafety
        println!("{}", std::str::from_utf8(&mmap[..])?);

        thread::sleep(Duration::from_secs(1));

        backing_file.write_all(b"somestring")?;
    }

    Ok(())
}

您可能希望在此文件中预分配 space 的 "big" 块，这样您就可以打开它并开始写入，而不必重新映射它。

我自己不会将此代码用于任何重要数据正确的地方。

另请参阅：

Is appending to a file that is Mmap-ed safe and cross-platform?
appending to a memory-mapped file

如何使用 memmap 板条箱附加到文件支持的 mmap？

How to append to a file-backed mmap using the memmap crate?

linux

mmap

rust

`MmapMut`

直接附加到支持文件