Skip to content

Commit f853c24

Browse files
SchrodingerZhuSchrodingerZhu
committed
[libc][SysMMan] implement mincore
1 parent d462621 commit f853c24

File tree

11 files changed

+199
-1
lines changed

11 files changed

+199
-1
lines changed

‎libc/config/linux/aarch64/entrypoints.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ set(TARGET_LIBC_ENTRYPOINTS
136136
libc.src.sys.mman.mprotect
137137
libc.src.sys.mman.munmap
138138
libc.src.sys.mman.posix_madvise
139+
libc.src.sys.mman.mincore
139140

140141
# sys/random.h entrypoints
141142
libc.src.sys.random.getrandom

‎libc/config/linux/riscv/entrypoints.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ set(TARGET_LIBC_ENTRYPOINTS
142142
libc.src.sys.mman.mprotect
143143
libc.src.sys.mman.munmap
144144
libc.src.sys.mman.posix_madvise
145+
libc.src.sys.mman.mincore
145146

146147
# sys/random.h entrypoints
147148
libc.src.sys.random.getrandom

‎libc/config/linux/x86_64/entrypoints.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ set(TARGET_LIBC_ENTRYPOINTS
142142
libc.src.sys.mman.mprotect
143143
libc.src.sys.mman.munmap
144144
libc.src.sys.mman.posix_madvise
145+
libc.src.sys.mman.mincore
145146

146147
# sys/random.h entrypoints
147148
libc.src.sys.random.getrandom

‎libc/spec/linux.td

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,20 @@ def Linux : StandardSpec<"Linux"> {
7676

7777
HeaderSpec SysMMan = HeaderSpec<
7878
"sys/mman.h",
79-
[Macro<"MAP_ANONYMOUS">]
79+
[Macro<"MAP_ANONYMOUS">],
80+
[], // Types
81+
[], // Enumerations
82+
[
83+
FunctionSpec<
84+
"mincore",
85+
RetValSpec<IntType>,
86+
[
87+
ArgSpec<VoidPtr>,
88+
ArgSpec<SizeTType>,
89+
ArgSpec<UnsignedCharPtr>,
90+
]
91+
>,
92+
] // Functions
8093
>;
8194

8295

‎libc/spec/spec.td

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ def FloatType : NamedType<"float">;
4949
def DoubleType : NamedType<"double">;
5050
def LongDoubleType : NamedType<"long double">;
5151
def CharType : NamedType<"char">;
52+
def UnsignedCharType : NamedType<"unsigned char">;
5253

5354
// TODO: Add compatibility layer to use C23 type _Float128 if possible.
5455
def Float128Type : NamedType<"__float128">;
@@ -109,6 +110,7 @@ def IntPtr : PtrType<IntType>;
109110
def RestrictedIntPtr : RestrictedPtrType<IntType>;
110111
def FloatPtr : PtrType<FloatType>;
111112
def DoublePtr : PtrType<DoubleType>;
113+
def UnsignedCharPtr : PtrType<UnsignedCharType>;
112114

113115
def SigHandlerT : NamedType<"__sighandler_t">;
114116

‎libc/src/sys/mman/CMakeLists.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,10 @@ add_entrypoint_object(
3636
DEPENDS
3737
.${LIBC_TARGET_OS}.posix_madvise
3838
)
39+
40+
add_entrypoint_object(
41+
mincore
42+
ALIAS
43+
DEPENDS
44+
.${LIBC_TARGET_OS}.mincore
45+
)

‎libc/src/sys/mman/linux/CMakeLists.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,16 @@ add_entrypoint_object(
6161
libc.include.sys_syscall
6262
libc.src.__support.OSUtil.osutil
6363
)
64+
65+
add_entrypoint_object(
66+
mincore
67+
SRCS
68+
mincore.cpp
69+
HDRS
70+
../mincore.h
71+
DEPENDS
72+
libc.include.sys_mman
73+
libc.include.sys_syscall
74+
libc.src.__support.OSUtil.osutil
75+
libc.src.errno.errno
76+
)

‎libc/src/sys/mman/linux/mincore.cpp

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
//===---------- Linux implementation of the mincore function --------------===//
2+
//
3+
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
// See https://llvm.org/LICENSE.txt for license information.
5+
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#include "src/sys/mman/mincore.h"
10+
11+
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
12+
13+
#include "src/errno/libc_errno.h"
14+
#include <sys/syscall.h> // For syscall numbers.
15+
16+
namespace LIBC_NAMESPACE {
17+
18+
LLVM_LIBC_FUNCTION(int, mincore, (void *addr, size_t len, unsigned char *vec)) {
19+
long ret = syscall_impl(SYS_mincore, reinterpret_cast<long>(addr), len,
20+
reinterpret_cast<long>(vec));
21+
if (ret < 0) {
22+
libc_errno = static_cast<int>(-ret);
23+
return -1;
24+
}
25+
return 0;
26+
}
27+
28+
} // namespace LIBC_NAMESPACE

‎libc/src/sys/mman/mincore.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
//===-- Implementation header for mincore function --------------*- C++ -*-===//
2+
//
3+
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
// See https://llvm.org/LICENSE.txt for license information.
5+
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#ifndef LLVM_LIBC_SRC_SYS_MMAN_MINCORE_H
10+
#define LLVM_LIBC_SRC_SYS_MMAN_MINCORE_H
11+
12+
#include <sys/mman.h> // For size_t
13+
14+
namespace LIBC_NAMESPACE {
15+
16+
int mincore(void *addr, size_t len, unsigned char *vec);
17+
18+
} // namespace LIBC_NAMESPACE
19+
20+
#endif // LLVM_LIBC_SRC_SYS_MMAN_MINCORE_H

‎libc/test/src/sys/mman/linux/CMakeLists.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,19 @@ add_libc_unittest(
6262
libc.src.sys.mman.posix_madvise
6363
libc.test.UnitTest.ErrnoSetterMatcher
6464
)
65+
66+
add_libc_unittest(
67+
mincore_test
68+
SUITE
69+
libc_sys_mman_unittests
70+
SRCS
71+
mincore_test.cpp
72+
DEPENDS
73+
libc.include.sys_mman
74+
libc.src.errno.errno
75+
libc.src.sys.mman.mmap
76+
libc.src.sys.mman.munmap
77+
libc.src.sys.mman.madvise
78+
libc.src.sys.mman.mincore
79+
libc.test.UnitTest.ErrnoSetterMatcher
80+
)

‎libc/test/src/sys/mman/linux/mincore_test.cpp

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
//===-- Unittests for mincore ---------------------------------------------===//
2+
//
3+
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
// See https://llvm.org/LICENSE.txt for license information.
5+
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#include "src/errno/libc_errno.h"
10+
#include "src/sys/mman/madvise.h"
11+
#include "src/sys/mman/mincore.h"
12+
#include "src/sys/mman/mmap.h"
13+
#include "src/sys/mman/munmap.h"
14+
#include "test/UnitTest/ErrnoSetterMatcher.h"
15+
#include "test/UnitTest/LibcTest.h"
16+
#include "test/UnitTest/Test.h"
17+
18+
#include <linux/param.h> // For EXEC_PAGESIZE
19+
#include <sys/mman.h>
20+
21+
using LIBC_NAMESPACE::testing::ErrnoSetterMatcher::Fails;
22+
using LIBC_NAMESPACE::testing::ErrnoSetterMatcher::Succeeds;
23+
24+
TEST(LlvmLibcMincoreTest, UnMappedMemory) {
25+
libc_errno = 0;
26+
unsigned char vec;
27+
int res = LIBC_NAMESPACE::mincore(nullptr, 1, &vec);
28+
EXPECT_THAT(res, Fails(ENOMEM, -1));
29+
}
30+
31+
TEST(LlvmLibcMincoreTest, InvalidVec) {
32+
void *addr = LIBC_NAMESPACE::mmap(nullptr, EXEC_PAGESIZE, PROT_READ,
33+
MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
34+
EXPECT_NE(addr, MAP_FAILED);
35+
EXPECT_EQ(reinterpret_cast<unsigned long>(addr) % EXEC_PAGESIZE, 0ul);
36+
libc_errno = 0;
37+
int res = LIBC_NAMESPACE::mincore(addr, 1, nullptr);
38+
EXPECT_THAT(res, Fails(EFAULT, -1));
39+
EXPECT_THAT(LIBC_NAMESPACE::munmap(addr, EXEC_PAGESIZE), Succeeds());
40+
}
41+
42+
TEST(LlvmLibcMincoreTest, UnalignedAddr) {
43+
void *addr = LIBC_NAMESPACE::mmap(nullptr, EXEC_PAGESIZE, PROT_READ,
44+
MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
45+
EXPECT_NE(addr, MAP_FAILED);
46+
EXPECT_EQ(reinterpret_cast<unsigned long>(addr) % EXEC_PAGESIZE, 0ul);
47+
libc_errno = 0;
48+
int res = LIBC_NAMESPACE::mincore(static_cast<char *>(addr) + 1, 1, nullptr);
49+
EXPECT_THAT(res, Fails(EINVAL, -1));
50+
EXPECT_THAT(LIBC_NAMESPACE::munmap(addr, EXEC_PAGESIZE), Succeeds());
51+
}
52+
53+
TEST(LlvmLibcMincoreTest, NoError) {
54+
void *addr = LIBC_NAMESPACE::mmap(nullptr, EXEC_PAGESIZE, PROT_READ,
55+
MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
56+
EXPECT_NE(addr, MAP_FAILED);
57+
EXPECT_EQ(reinterpret_cast<unsigned long>(addr) % EXEC_PAGESIZE, 0ul);
58+
unsigned char vec;
59+
libc_errno = 0;
60+
int res = LIBC_NAMESPACE::mincore(static_cast<char *>(addr), 1, &vec);
61+
EXPECT_THAT(res, Succeeds());
62+
EXPECT_THAT(LIBC_NAMESPACE::munmap(addr, EXEC_PAGESIZE), Succeeds());
63+
}
64+
65+
TEST(LlvmLibcMincoreTest, PageOut) {
66+
unsigned char vec;
67+
void *addr =
68+
LIBC_NAMESPACE::mmap(nullptr, EXEC_PAGESIZE, PROT_READ | PROT_WRITE,
69+
MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
70+
EXPECT_NE(addr, MAP_FAILED);
71+
EXPECT_EQ(reinterpret_cast<unsigned long>(addr) % EXEC_PAGESIZE, 0ul);
72+
73+
// touch the page
74+
{
75+
static_cast<char *>(addr)[0] = 0;
76+
libc_errno = 0;
77+
int res = LIBC_NAMESPACE::mincore(static_cast<char *>(addr), 1, &vec);
78+
EXPECT_EQ(vec, static_cast<unsigned char>(1));
79+
EXPECT_THAT(res, Succeeds());
80+
}
81+
82+
// page out the memory
83+
{
84+
libc_errno = 0;
85+
EXPECT_THAT(LIBC_NAMESPACE::madvise(addr, EXEC_PAGESIZE, MADV_DONTNEED),
86+
Succeeds());
87+
88+
libc_errno = 0;
89+
int res =
90+
LIBC_NAMESPACE::mincore(static_cast<char *>(addr), EXEC_PAGESIZE, &vec);
91+
EXPECT_EQ(vec, static_cast<unsigned char>(0));
92+
EXPECT_THAT(res, Succeeds());
93+
}
94+
95+
EXPECT_THAT(LIBC_NAMESPACE::munmap(addr, EXEC_PAGESIZE), Succeeds());
96+
}

0 commit comments

Comments
 (0)