1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
|
// SPDX-License-Identifier: MPL-2.0
// (c) Hare authors <https://harelang.org>
use errors;
use fs;
use io;
use path;
use rt;
use strings;
def SHM_PATH: str = "/dev/shm/";
fn shm_path(name: str) (str | fs::error) = {
const name = strings::ltrim(name, '/');
if (len(name) > rt::NAME_MAX) {
return errors::invalid;
};
if (name == "." || name == "..") {
return errors::invalid;
};
static let buf = path::buffer { ... };
path::set(&buf, SHM_PATH, name)!;
return path::string(&buf);
};
// Opens (or creates, given [[fs::flag::CREATE]]) a global shared memory file
// with the given name, suitable for use with [[io::mmap]] to establish shared
// memory areas with other processes using the same name.
//
// The name must not contain any forward slashes (one is permissible at the
// start, e.g. "/example") and cannot be "." or "..".
//
// The "oflag" parameter, if provided, must include either [[fs::flag::RDONLY]]
// or [[fs::flag::RDWR]], and may optionally add [[fs::flag::CREATE]],
// [[fs::flag::EXCL]], and/or [[fs::flag::TRUNC]], other flags are silently
// ignored if set.
//
// The new file descriptor always has CLOEXEC set regardless of the provided
// flags. If creating a new shared memory object, set its initial size with
// [[io::trunc]] before mapping it with [[io::mmap]].
//
// Call [[shm_unlink]] to remove the global shared memory object.
export fn shm_open(
name: str,
oflag: fs::flag = fs::flag::CREATE | fs::flag::RDWR,
mode: fs::mode = 0o600,
) (io::file | fs::error) = {
const path = shm_path(name)?;
oflag |= fs::flag::NOFOLLOW | fs::flag::NONBLOCK;
oflag &= ~fs::flag::NOCLOEXEC; // Unconditionally set CLOEXEC
return create(path, mode, oflag);
};
// Removes the shared memory object with the given name. Processes which already
// hold a reference to the file may continue to use the memory associated with
// it. Once all processes have unmapped the associated shared memory object, or
// exited, the memory is released.
export fn shm_unlink(name: str) (void | fs::error) = {
return remove(shm_path(name)?);
};
|