[libc-commits] [libc] add mremap (PR #112804)
Jingyu Qiu via libc-commits
libc-commits at lists.llvm.org
Thu Oct 17 18:11:31 PDT 2024
https://github.com/SoftJing1 updated https://github.com/llvm/llvm-project/pull/112804
>From 525ae42da8f940c8792426b0b4743cc9148eb9f0 Mon Sep 17 00:00:00 2001
From: Jingyu Qiu <118010248 at link.cuhk.edu.cn>
Date: Wed, 9 Oct 2024 17:53:47 -0400
Subject: [PATCH] add mremap
---
libc/newhdrgen/yaml/sys/mman.yaml | 11 ++++
libc/spec/linux.td | 13 +++-
libc/src/sys/mman/CMakeLists.txt | 7 ++
libc/src/sys/mman/linux/CMakeLists.txt | 13 ++++
libc/src/sys/mman/linux/mremap.cpp | 53 ++++++++++++++++
libc/src/sys/mman/mremap.h | 23 +++++++
libc/test/src/sys/mman/linux/CMakeLists.txt | 15 +++++
libc/test/src/sys/mman/linux/mremap_test.cpp | 67 ++++++++++++++++++++
8 files changed, 201 insertions(+), 1 deletion(-)
create mode 100644 libc/src/sys/mman/linux/mremap.cpp
create mode 100644 libc/src/sys/mman/mremap.h
create mode 100644 libc/test/src/sys/mman/linux/mremap_test.cpp
diff --git a/libc/newhdrgen/yaml/sys/mman.yaml b/libc/newhdrgen/yaml/sys/mman.yaml
index 7c4fb1ef09e791..4b062f72020537 100644
--- a/libc/newhdrgen/yaml/sys/mman.yaml
+++ b/libc/newhdrgen/yaml/sys/mman.yaml
@@ -55,6 +55,17 @@ functions:
- type: int
- type: int
- type: off_t
+ - name: mremap
+ standards:
+ - POSIX
+ return_type: void *
+ arguments:
+ - type: void *
+ - type: size_t
+ - type: size_t
+ - type: int
+ - type: void *
+ description: "This argument is optional."
- name: mprotect
standards:
- POSIX
diff --git a/libc/spec/linux.td b/libc/spec/linux.td
index 4aaf18b0803f3d..6dda2c03213e4a 100644
--- a/libc/spec/linux.td
+++ b/libc/spec/linux.td
@@ -103,7 +103,7 @@ def Linux : StandardSpec<"Linux"> {
ArgSpec<UnsignedIntType>,
]
>,
- FunctionSpec<
+ FunctionSpec<
"remap_file_pages",
RetValSpec<IntType>,
[
@@ -114,6 +114,17 @@ def Linux : StandardSpec<"Linux"> {
ArgSpec<IntType>,
]
>,
+ FunctionSpec<
+ "mremap",
+ RetValSpec<VoidPtr>,
+ [
+ ArgSpec<VoidPtr>,
+ ArgSpec<SizeTType>,
+ ArgSpec<SizeTType>,
+ ArgSpec<IntType>,
+ ArgSpec<VoidPtr>,
+ ]
+ >,
] // Functions
>;
diff --git a/libc/src/sys/mman/CMakeLists.txt b/libc/src/sys/mman/CMakeLists.txt
index 4ea43e14be0297..8126d6205c9a1f 100644
--- a/libc/src/sys/mman/CMakeLists.txt
+++ b/libc/src/sys/mman/CMakeLists.txt
@@ -106,3 +106,10 @@ add_entrypoint_object(
DEPENDS
.${LIBC_TARGET_OS}.shm_unlink
)
+
+add_entrypoint_object(
+ mremap,
+ ALIAS,
+ DEPENDS
+ .${LIBC_TARGET_OS}.mremap
+)
diff --git a/libc/src/sys/mman/linux/CMakeLists.txt b/libc/src/sys/mman/linux/CMakeLists.txt
index 11188254cfbd45..50c75179095a48 100644
--- a/libc/src/sys/mman/linux/CMakeLists.txt
+++ b/libc/src/sys/mman/linux/CMakeLists.txt
@@ -24,6 +24,19 @@ add_entrypoint_object(
libc.src.errno.errno
)
+add_entrypoint_object(
+ mremap
+ SRCS
+ mremap.cpp
+ HDRS
+ ../mremap.h
+ DEPENDS
+ libc.include.sys_mman
+ libc.include.sys_syscall
+ libc.src.__support.OSUtil.osutil
+ libc.src.errno.errno
+)
+
add_entrypoint_object(
munmap
SRCS
diff --git a/libc/src/sys/mman/linux/mremap.cpp b/libc/src/sys/mman/linux/mremap.cpp
new file mode 100644
index 00000000000000..182d1c24829358
--- /dev/null
+++ b/libc/src/sys/mman/linux/mremap.cpp
@@ -0,0 +1,53 @@
+//===---------- Linux implementation of the POSIX mremap function
+//-----------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/sys/mman/mremap.h"
+
+#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
+#include "src/__support/common.h"
+
+#include "src/__support/macros/config.h"
+#include "src/errno/libc_errno.h"
+#include <linux/param.h> // For EXEC_PAGESIZE.
+#include <stdarg.h>
+#include <sys/syscall.h> // For syscall numbers.
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(void *, mremap,
+ (void *old_address, size_t old_size, size_t new_size,
+ int flags, ... /* void *new_address */)) {
+
+#ifdef SYS_mremap
+ long syscall_number = SYS_mremap;
+#else
+#error "mremap syscalls not available."
+#endif
+ long ret = 0;
+ if (flags & MREMAP_FIXED) {
+ void *arg;
+ va_list varargs;
+ va_start(varargs, flags);
+ arg = va_arg(varargs, void *);
+ va_end(varargs);
+ ret = LIBC_NAMESPACE::syscall_impl(syscall_number, old_address, old_size,
+ new_size, flags, arg);
+ } else {
+ ret = LIBC_NAMESPACE::syscall_impl(syscall_number, old_address, old_size,
+ new_size, flags);
+ }
+ if (ret < 0 && ret > -EXEC_PAGESIZE) {
+ libc_errno = static_cast<int>(-ret);
+ return MAP_FAILED;
+ }
+
+ return reinterpret_cast<void *>(ret);
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/sys/mman/mremap.h b/libc/src/sys/mman/mremap.h
new file mode 100644
index 00000000000000..5287658089dd54
--- /dev/null
+++ b/libc/src/sys/mman/mremap.h
@@ -0,0 +1,23 @@
+//===-- Implementation header for mremap function -----------------*- C++
+//-*-===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_LIBC_SRC_SYS_MMAN_MREMAP_H
+#define LLVM_LIBC_SRC_SYS_MMAN_MREMAP_H
+
+#include "src/__support/macros/config.h"
+#include <sys/mman.h> // For size_t and off_t
+
+namespace LIBC_NAMESPACE_DECL {
+
+void *mremap(void *old_address, size_t old_size, size_t new_size, int flags,
+ ... /* void *new_address */);
+
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_SYS_MMAN_MREMAP_H
diff --git a/libc/test/src/sys/mman/linux/CMakeLists.txt b/libc/test/src/sys/mman/linux/CMakeLists.txt
index a432d88ffb90c9..cf8e4f41d9441d 100644
--- a/libc/test/src/sys/mman/linux/CMakeLists.txt
+++ b/libc/test/src/sys/mman/linux/CMakeLists.txt
@@ -14,6 +14,21 @@ add_libc_unittest(
libc.test.UnitTest.ErrnoSetterMatcher
)
+add_libc_unittest(
+ mremap_test
+ SUITE
+ libc_sys_mman_unittests
+ SRCS
+ mremap_test.cpp
+ DEPENDS
+ libc.include.sys_mman
+ libc.src.errno.errno
+ libc.src.sys.mman.mmap
+ libc.src.sys.mman.mremap
+ libc.src.sys.mman.munmap
+ libc.test.UnitTest.ErrnoSetterMatcher
+)
+
if (NOT LLVM_USE_SANITIZER)
add_libc_unittest(
mprotect_test
diff --git a/libc/test/src/sys/mman/linux/mremap_test.cpp b/libc/test/src/sys/mman/linux/mremap_test.cpp
new file mode 100644
index 00000000000000..36f606386467db
--- /dev/null
+++ b/libc/test/src/sys/mman/linux/mremap_test.cpp
@@ -0,0 +1,67 @@
+//===-- Unittests for mremap ----------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/errno/libc_errno.h"
+#include "src/sys/mman/mmap.h"
+#include "src/sys/mman/munmap.h"
+#include "test/UnitTest/ErrnoSetterMatcher.h"
+#include "test/UnitTest/Test.h"
+
+#include <sys/mman.h>
+
+using LIBC_NAMESPACE::testing::ErrnoSetterMatcher::Fails;
+using LIBC_NAMESPACE::testing::ErrnoSetterMatcher::Succeeds;
+
+TEST(LlvmLibcMremapTest, NoError) {
+ size_t initial_size = 128;
+ size_t new_size = 256;
+ LIBC_NAMESPACE::libc_errno = 0;
+
+ // Allocate memory using mmap.
+ void *addr =
+ LIBC_NAMESPACE::mmap(nullptr, initial_size, PROT_READ | PROT_WRITE,
+ MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
+ ASSERT_ERRNO_SUCCESS();
+ EXPECT_NE(addr, MAP_FAILED);
+
+ int *array = reinterpret_cast<int *>(addr);
+ // Writing to the memory should not crash the test.
+ array[0] = 123;
+ EXPECT_EQ(array[0], 123);
+
+ // Re-map the memory using mremap with an increased size.
+ void *new_addr =
+ LIBC_NAMESPACE::mremap(addr, initial_size, new_size, MREMAP_MAYMOVE);
+ ASSERT_ERRNO_SUCCESS();
+ EXPECT_NE(new_addr, MAP_FAILED);
+ EXPECT_EQ(reinterpret_cast<int *>(new_addr)[0],
+ 123); // Verify data is preserved.
+
+ // Clean up memory by unmapping it.
+ EXPECT_THAT(LIBC_NAMESPACE::munmap(new_addr, new_size), Succeeds());
+}
+
+TEST(LlvmLibcMremapTest, Error_InvalidSize) {
+ size_t initial_size = 128;
+ LIBC_NAMESPACE::libc_errno = 0;
+
+ // Allocate memory using mmap.
+ void *addr =
+ LIBC_NAMESPACE::mmap(nullptr, initial_size, PROT_READ | PROT_WRITE,
+ MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
+ ASSERT_ERRNO_SUCCESS();
+ EXPECT_NE(addr, MAP_FAILED);
+
+ // Attempt to re-map the memory with an invalid new size (0).
+ void *new_addr =
+ LIBC_NAMESPACE::mremap(addr, initial_size, 0, MREMAP_MAYMOVE);
+ EXPECT_THAT(new_addr, Fails(EINVAL, MAP_FAILED));
+
+ // Clean up the original mapping.
+ EXPECT_THAT(LIBC_NAMESPACE::munmap(addr, initial_size), Succeeds());
+}
More information about the libc-commits
mailing list