[libc-commits] [libc] [libc][mman] Implement msync. (PR #84700)
Schrodinger ZHU Yifan via libc-commits
libc-commits at lists.llvm.org
Sun Mar 10 15:49:13 PDT 2024
https://github.com/SchrodingerZhu updated https://github.com/llvm/llvm-project/pull/84700
>From bc50ea2f9608fe85b4cfec3b65d79fff90ead62c Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <yifanzhu at rochester.edu>
Date: Sun, 10 Mar 2024 18:38:36 -0400
Subject: [PATCH 1/2] [libc][mman] implement msync
---
libc/config/linux/aarch64/entrypoints.txt | 1 +
libc/config/linux/riscv/entrypoints.txt | 1 +
libc/config/linux/x86_64/entrypoints.txt | 1 +
libc/spec/posix.td | 5 ++
libc/src/sys/mman/CMakeLists.txt | 7 +++
libc/src/sys/mman/linux/CMakeLists.txt | 13 ++++
libc/src/sys/mman/linux/msync.cpp | 25 ++++++++
libc/src/sys/mman/msync.h | 21 +++++++
libc/test/src/sys/mman/linux/CMakeLists.txt | 20 ++++++
libc/test/src/sys/mman/linux/msync_test.cpp | 69 +++++++++++++++++++++
10 files changed, 163 insertions(+)
create mode 100644 libc/src/sys/mman/linux/msync.cpp
create mode 100644 libc/src/sys/mman/msync.h
create mode 100644 libc/test/src/sys/mman/linux/msync_test.cpp
diff --git a/libc/config/linux/aarch64/entrypoints.txt b/libc/config/linux/aarch64/entrypoints.txt
index c24703840183af..b447b5dfe0989e 100644
--- a/libc/config/linux/aarch64/entrypoints.txt
+++ b/libc/config/linux/aarch64/entrypoints.txt
@@ -185,6 +185,7 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.sys.mman.munlock
libc.src.sys.mman.mlockall
libc.src.sys.mman.munlockall
+ libc.src.sys.mman.msync
# sys/random.h entrypoints
libc.src.sys.random.getrandom
diff --git a/libc/config/linux/riscv/entrypoints.txt b/libc/config/linux/riscv/entrypoints.txt
index f7a65615115f34..5175b14adf2e74 100644
--- a/libc/config/linux/riscv/entrypoints.txt
+++ b/libc/config/linux/riscv/entrypoints.txt
@@ -190,6 +190,7 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.sys.mman.munlock
libc.src.sys.mman.mlockall
libc.src.sys.mman.munlockall
+ libc.src.sys.mman.msync
# sys/random.h entrypoints
libc.src.sys.random.getrandom
diff --git a/libc/config/linux/x86_64/entrypoints.txt b/libc/config/linux/x86_64/entrypoints.txt
index b51227e5f25d74..b8bec14a3d2a6d 100644
--- a/libc/config/linux/x86_64/entrypoints.txt
+++ b/libc/config/linux/x86_64/entrypoints.txt
@@ -228,6 +228,7 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.sys.mman.munlock
libc.src.sys.mman.mlockall
libc.src.sys.mman.munlockall
+ libc.src.sys.mman.msync
# sys/random.h entrypoints
libc.src.sys.random.getrandom
diff --git a/libc/spec/posix.td b/libc/spec/posix.td
index 70be692e208a88..d0f5a4584dd45b 100644
--- a/libc/spec/posix.td
+++ b/libc/spec/posix.td
@@ -309,6 +309,11 @@ def POSIX : StandardSpec<"POSIX"> {
RetValSpec<IntType>,
[ArgSpec<VoidType>]
>,
+ FunctionSpec<
+ "msync",
+ RetValSpec<IntType>,
+ [ArgSpec<VoidPtr>, ArgSpec<SizeTType>, ArgSpec<IntType>]
+ >,
]
>;
diff --git a/libc/src/sys/mman/CMakeLists.txt b/libc/src/sys/mman/CMakeLists.txt
index f11f5ac9df9f2f..b49f73873c2006 100644
--- a/libc/src/sys/mman/CMakeLists.txt
+++ b/libc/src/sys/mman/CMakeLists.txt
@@ -78,3 +78,10 @@ add_entrypoint_object(
DEPENDS
.${LIBC_TARGET_OS}.munlockall
)
+
+add_entrypoint_object(
+ msync
+ ALIAS
+ DEPENDS
+ .${LIBC_TARGET_OS}.msync
+)
diff --git a/libc/src/sys/mman/linux/CMakeLists.txt b/libc/src/sys/mman/linux/CMakeLists.txt
index a6feff1f0bec19..04086ee5d33254 100644
--- a/libc/src/sys/mman/linux/CMakeLists.txt
+++ b/libc/src/sys/mman/linux/CMakeLists.txt
@@ -139,3 +139,16 @@ add_entrypoint_object(
libc.src.__support.OSUtil.osutil
libc.src.errno.errno
)
+
+add_entrypoint_object(
+ msync
+ SRCS
+ msync.cpp
+ HDRS
+ ../msync.h
+ DEPENDS
+ libc.include.sys_mman
+ libc.include.sys_syscall
+ libc.src.__support.OSUtil.osutil
+ libc.src.errno.errno
+)
diff --git a/libc/src/sys/mman/linux/msync.cpp b/libc/src/sys/mman/linux/msync.cpp
new file mode 100644
index 00000000000000..1d2544f023c2c0
--- /dev/null
+++ b/libc/src/sys/mman/linux/msync.cpp
@@ -0,0 +1,25 @@
+//===---------- Linux implementation of the msync 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/msync.h"
+
+#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
+
+#include "src/errno/libc_errno.h"
+#include <sys/syscall.h> // For syscall numbers.
+
+namespace LIBC_NAMESPACE {
+LLVM_LIBC_FUNCTION(int, msync, (void *addr, size_t len, int flags)) {
+ long ret = syscall_impl(SYS_msync, cpp::bit_cast<long>(addr), len, flags);
+ if (ret < 0) {
+ libc_errno = static_cast<int>(-ret);
+ return -1;
+ }
+ return 0;
+}
+} // namespace LIBC_NAMESPACE
diff --git a/libc/src/sys/mman/msync.h b/libc/src/sys/mman/msync.h
new file mode 100644
index 00000000000000..08afdd8c062857
--- /dev/null
+++ b/libc/src/sys/mman/msync.h
@@ -0,0 +1,21 @@
+//===-- Implementation header for msync 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_MSYNC_H
+#define LLVM_LIBC_SRC_SYS_MMAN_MSYNC_H
+
+#include <sys/mman.h>
+#include <sys/syscall.h>
+
+namespace LIBC_NAMESPACE {
+
+int msync(void *addr, size_t len, int flags);
+
+} // namespace LIBC_NAMESPACE
+
+#endif // LLVM_LIBC_SRC_SYS_MMAN_MSYNC_H
diff --git a/libc/test/src/sys/mman/linux/CMakeLists.txt b/libc/test/src/sys/mman/linux/CMakeLists.txt
index 09ab5b09be6403..6f7fc34d8d3ce3 100644
--- a/libc/test/src/sys/mman/linux/CMakeLists.txt
+++ b/libc/test/src/sys/mman/linux/CMakeLists.txt
@@ -107,3 +107,23 @@ add_libc_unittest(
libc.src.unistd.sysconf
libc.test.UnitTest.ErrnoSetterMatcher
)
+
+add_libc_unittest(
+ msync_test
+ SUITE
+ libc_sys_mman_unittests
+ SRCS
+ msync_test.cpp
+ DEPENDS
+ libc.include.sys_mman
+ libc.include.unistd
+ libc.src.errno.errno
+ libc.src.sys.mman.mmap
+ libc.src.sys.mman.munmap
+ libc.src.sys.mman.msync
+ libc.src.sys.mman.mincore
+ libc.src.sys.mman.mlock
+ libc.src.sys.mman.munlock
+ libc.src.unistd.sysconf
+ libc.test.UnitTest.ErrnoSetterMatcher
+)
diff --git a/libc/test/src/sys/mman/linux/msync_test.cpp b/libc/test/src/sys/mman/linux/msync_test.cpp
new file mode 100644
index 00000000000000..cb334f84eaaf4d
--- /dev/null
+++ b/libc/test/src/sys/mman/linux/msync_test.cpp
@@ -0,0 +1,69 @@
+//===-- Unittests for msync -----------------------------------------------===//
+//
+// 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/mlock.h"
+#include "src/sys/mman/mmap.h"
+#include "src/sys/mman/msync.h"
+#include "src/sys/mman/munlock.h"
+#include "src/sys/mman/munmap.h"
+#include "src/unistd/sysconf.h"
+#include "test/UnitTest/ErrnoSetterMatcher.h"
+#include "test/UnitTest/LibcTest.h"
+#include "test/UnitTest/Test.h"
+
+using namespace LIBC_NAMESPACE::testing::ErrnoSetterMatcher;
+
+struct PageHolder {
+ size_t size;
+ void *addr;
+
+ PageHolder()
+ : size(LIBC_NAMESPACE::sysconf(_SC_PAGESIZE)),
+ addr(LIBC_NAMESPACE::mmap(nullptr, size, PROT_READ | PROT_WRITE,
+ MAP_ANONYMOUS | MAP_PRIVATE, -1, 0)) {}
+ ~PageHolder() {
+ if (addr != MAP_FAILED)
+ LIBC_NAMESPACE::munmap(addr, size);
+ }
+
+ char &operator[](size_t i) { return reinterpret_cast<char *>(addr)[i]; }
+
+ bool is_valid() { return addr != MAP_FAILED; }
+};
+
+TEST(LlvmLibcMsyncTest, UnMappedMemory) {
+ EXPECT_THAT(LIBC_NAMESPACE::msync(nullptr, 1024, MS_SYNC), Fails(ENOMEM));
+ EXPECT_THAT(LIBC_NAMESPACE::msync(nullptr, 1024, MS_ASYNC), Fails(ENOMEM));
+}
+
+TEST(LlvmLibcMsyncTest, LockedPage) {
+ PageHolder page;
+ EXPECT_TRUE(page.is_valid());
+ EXPECT_THAT(LIBC_NAMESPACE::mlock(page.addr, page.size), Succeeds());
+ EXPECT_THAT(
+ LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC | MS_INVALIDATE),
+ Fails(EBUSY));
+ EXPECT_THAT(LIBC_NAMESPACE::munlock(page.addr, page.size), Succeeds());
+ EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC), Succeeds());
+}
+
+TEST(LlvmLibcMsyncTest, UnalignedAddress) {
+ PageHolder page;
+ EXPECT_TRUE(page.is_valid());
+ EXPECT_THAT(LIBC_NAMESPACE::msync(&page[1], page.size - 1, MS_SYNC),
+ Fails(EINVAL));
+}
+
+TEST(LlvmLibcMsyncTest, InvalidFlag) {
+ PageHolder page;
+ EXPECT_TRUE(page.is_valid());
+ EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC | MS_ASYNC),
+ Fails(EINVAL));
+ EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, -1), Fails(EINVAL));
+}
>From ad196cd2ad24ec37940f8ec7d0bcd062ead1a6e9 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <yifanzhu at rochester.edu>
Date: Sun, 10 Mar 2024 18:49:00 -0400
Subject: [PATCH 2/2] address CR
---
libc/test/src/sys/mman/linux/msync_test.cpp | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/libc/test/src/sys/mman/linux/msync_test.cpp b/libc/test/src/sys/mman/linux/msync_test.cpp
index cb334f84eaaf4d..0d60415b1243ab 100644
--- a/libc/test/src/sys/mman/linux/msync_test.cpp
+++ b/libc/test/src/sys/mman/linux/msync_test.cpp
@@ -44,25 +44,25 @@ TEST(LlvmLibcMsyncTest, UnMappedMemory) {
TEST(LlvmLibcMsyncTest, LockedPage) {
PageHolder page;
- EXPECT_TRUE(page.is_valid());
- EXPECT_THAT(LIBC_NAMESPACE::mlock(page.addr, page.size), Succeeds());
+ ASSERT_TRUE(page.is_valid());
+ ASSERT_THAT(LIBC_NAMESPACE::mlock(page.addr, page.size), Succeeds());
EXPECT_THAT(
LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC | MS_INVALIDATE),
Fails(EBUSY));
- EXPECT_THAT(LIBC_NAMESPACE::munlock(page.addr, page.size), Succeeds());
+ ASSERT_THAT(LIBC_NAMESPACE::munlock(page.addr, page.size), Succeeds());
EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC), Succeeds());
}
TEST(LlvmLibcMsyncTest, UnalignedAddress) {
PageHolder page;
- EXPECT_TRUE(page.is_valid());
+ ASSERT_TRUE(page.is_valid());
EXPECT_THAT(LIBC_NAMESPACE::msync(&page[1], page.size - 1, MS_SYNC),
Fails(EINVAL));
}
TEST(LlvmLibcMsyncTest, InvalidFlag) {
PageHolder page;
- EXPECT_TRUE(page.is_valid());
+ ASSERT_TRUE(page.is_valid());
EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, MS_SYNC | MS_ASYNC),
Fails(EINVAL));
EXPECT_THAT(LIBC_NAMESPACE::msync(page.addr, page.size, -1), Fails(EINVAL));
More information about the libc-commits
mailing list