[libc-commits] [libc] [libc] Implemented wmemmove (PR #142245)
Uzair Nawaz via libc-commits
libc-commits at lists.llvm.org
Fri May 30 17:23:58 PDT 2025
https://github.com/uzairnawaz created https://github.com/llvm/llvm-project/pull/142245
Implemented wmemmove and added tests
>From e4b5c76fa7220b8a310bb1dd29e8ce2f4756063c Mon Sep 17 00:00:00 2001
From: Uzair Nawaz <uzairnawaz at google.com>
Date: Sat, 31 May 2025 00:11:48 +0000
Subject: [PATCH 1/3] implemented wmemmove
---
libc/config/linux/x86_64/entrypoints.txt | 1 +
libc/include/wchar.yaml | 8 ++
libc/src/wchar/CMakeLists.txt | 13 +++
libc/src/wchar/wmemmove.cpp | 28 ++++++
libc/src/wchar/wmemmove.h | 22 +++++
libc/test/src/wchar/CMakeLists.txt | 10 ++
libc/test/src/wchar/wmemmove_test.cpp | 111 +++++++++++++++++++++++
7 files changed, 193 insertions(+)
create mode 100644 libc/src/wchar/wmemmove.cpp
create mode 100644 libc/src/wchar/wmemmove.h
create mode 100644 libc/test/src/wchar/wmemmove_test.cpp
diff --git a/libc/config/linux/x86_64/entrypoints.txt b/libc/config/linux/x86_64/entrypoints.txt
index 7ddeb4d31b466..ffedf8e088fe5 100644
--- a/libc/config/linux/x86_64/entrypoints.txt
+++ b/libc/config/linux/x86_64/entrypoints.txt
@@ -364,6 +364,7 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.wchar.btowc
libc.src.wchar.wcslen
libc.src.wchar.wctob
+ libc.src.wchar.wmemmove
libc.src.wchar.wmemset
libc.src.wchar.wcschr
libc.src.wchar.wcspbrk
diff --git a/libc/include/wchar.yaml b/libc/include/wchar.yaml
index bd9105f69222c..5117e795d35ea 100644
--- a/libc/include/wchar.yaml
+++ b/libc/include/wchar.yaml
@@ -72,3 +72,11 @@ functions:
- type: __restricted wchar_t *
- type: const __ restricted wchar_t *
- type: size_t
+ - name: wmemmove
+ standards:
+ - stdc
+ return_type: wchar_t *
+ arguments:
+ - type: wchar_t *
+ - type: const wchar_t *
+ - type: size_t
diff --git a/libc/src/wchar/CMakeLists.txt b/libc/src/wchar/CMakeLists.txt
index 9db121762348b..6d839317fb8d8 100644
--- a/libc/src/wchar/CMakeLists.txt
+++ b/libc/src/wchar/CMakeLists.txt
@@ -104,3 +104,16 @@ add_entrypoint_object(
libc.hdr.wchar_macros
libc.src.__support.wctype_utils
)
+
+add_entrypoint_object(
+ wmemmove
+ SRCS
+ wmemmove.cpp
+ HDRS
+ wmemmove.h
+ DEPENDS
+ libc.hdr.types.size_t
+ libc.hdr.wchar_macros
+ libc.src.__support.wctype_utils
+ libc.src.__support.macros.null_check
+)
diff --git a/libc/src/wchar/wmemmove.cpp b/libc/src/wchar/wmemmove.cpp
new file mode 100644
index 0000000000000..46bcb659744e0
--- /dev/null
+++ b/libc/src/wchar/wmemmove.cpp
@@ -0,0 +1,28 @@
+//===-- Implementation of wmemmove ----------------------------------------===//
+//
+// 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/wchar/wmemmove.h"
+
+#include "hdr/types/size_t.h"
+#include "hdr/types/wchar_t.h"
+#include "src/__support/common.h"
+#include "src/__support/macros/null_check.h"
+#include "src/string/memory_utils/inline_memmove.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(wchar_t *, wmemmove,
+ (wchar_t * dest, const wchar_t *src, size_t n)) {
+ LIBC_CRASH_ON_NULLPTR(dest);
+ LIBC_CRASH_ON_NULLPTR(src);
+
+ inline_memmove(dest, src, n * sizeof(wchar_t));
+ return dest;
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/wchar/wmemmove.h b/libc/src/wchar/wmemmove.h
new file mode 100644
index 0000000000000..b4c31ac7b397c
--- /dev/null
+++ b/libc/src/wchar/wmemmove.h
@@ -0,0 +1,22 @@
+//===-- Implementation header for wmemmove --------------------------------===//
+//
+// 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_WCHAR_WMEMMOVE_H
+#define LLVM_LIBC_SRC_WCHAR_WMEMMOVE_H
+
+#include "hdr/types/size_t.h"
+#include "hdr/types/wchar_t.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+wchar_t *wmemmove(wchar_t *dest, const wchar_t *src, size_t n);
+
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_WCHAR_WMEMMOVE_H
diff --git a/libc/test/src/wchar/CMakeLists.txt b/libc/test/src/wchar/CMakeLists.txt
index 9bc230e0bddf3..afe283475be69 100644
--- a/libc/test/src/wchar/CMakeLists.txt
+++ b/libc/test/src/wchar/CMakeLists.txt
@@ -94,3 +94,13 @@ add_libc_test(
DEPENDS
libc.src.wchar.wmemcpy
)
+
+add_libc_test(
+ wmemmove_test
+ SUITE
+ libc_wchar_unittests
+ SRCS
+ wmemmove_test.cpp
+ DEPENDS
+ libc.src.wchar.wmemmove
+)
diff --git a/libc/test/src/wchar/wmemmove_test.cpp b/libc/test/src/wchar/wmemmove_test.cpp
new file mode 100644
index 0000000000000..32ad55d0c42e9
--- /dev/null
+++ b/libc/test/src/wchar/wmemmove_test.cpp
@@ -0,0 +1,111 @@
+//===-- Unittests for wmemmove --------------------------------------------===//
+//
+// 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 "hdr/types/size_t.h"
+#include "hdr/types/wchar_t.h"
+#include "src/wchar/wmemmove.h"
+#include "test/UnitTest/Test.h"
+
+TEST(LlvmLibcWMemmoveTest, MoveZeroByte) {
+ wchar_t buffer[] = {L'a', L'b', L'y', L'z'};
+
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(buffer, buffer + 2, 0);
+ EXPECT_EQ(ret, buffer);
+
+ const wchar_t expected[] = {L'a', L'b', L'y', L'z'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+ EXPECT_TRUE(buffer[2] == expected[2]);
+ EXPECT_TRUE(buffer[3] == expected[3]);
+}
+
+TEST(LlvmLibcWMemmoveTest, DstAndSrcPointToSameAddress) {
+ wchar_t buffer[] = {L'a', L'b'};
+
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(buffer, buffer, 1);
+ EXPECT_EQ(ret, buffer);
+
+ const wchar_t expected[] = {L'a', L'b'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+}
+
+TEST(LlvmLibcWMemmoveTest, DstStartsBeforeSrc) {
+ // Set boundary at beginning and end for not overstepping when
+ // copy forward or backward.
+ wchar_t buffer[] = {L'z', L'a', L'b', L'c', L'z'};
+
+ wchar_t *dst = buffer + 1;
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(dst, buffer + 2, 2);
+ EXPECT_EQ(ret, dst);
+
+ const wchar_t expected[] = {L'z', L'b', L'c', L'c', L'z'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+ EXPECT_TRUE(buffer[2] == expected[2]);
+ EXPECT_TRUE(buffer[3] == expected[3]);
+ EXPECT_TRUE(buffer[4] == expected[4]);
+}
+
+TEST(LlvmLibcWMemmoveTest, DstStartsAfterSrc) {
+ wchar_t buffer[] = {L'z', L'a', L'b', L'c', L'z'};
+
+ wchar_t *dst = buffer + 2;
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(dst, buffer + 1, 2);
+ EXPECT_EQ(ret, dst);
+
+ const wchar_t expected[] = {L'z', L'a', L'a', L'b', L'z'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+ EXPECT_TRUE(buffer[2] == expected[2]);
+ EXPECT_TRUE(buffer[3] == expected[3]);
+ EXPECT_TRUE(buffer[4] == expected[4]);
+}
+
+// e.g. `Dst` follow `src`.
+// str: [abcdefghij]
+// [__src_____]
+// [_____Dst__]
+TEST(LlvmLibcWMemmoveTest, SrcFollowDst) {
+ wchar_t buffer[] = {L'z', L'a', L'b', L'z'};
+
+ wchar_t *dst = buffer + 1;
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(dst, buffer + 2, 1);
+ EXPECT_EQ(ret, dst);
+
+ const char expected[] = {L'z', L'b', L'b', L'z'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+ EXPECT_TRUE(buffer[2] == expected[2]);
+ EXPECT_TRUE(buffer[3] == expected[3]);
+}
+
+TEST(LlvmLibcWMemmoveTest, DstFollowSrc) {
+ wchar_t buffer[] = {L'z', L'a', L'b', L'z'};
+
+ wchar_t *dst = buffer + 2;
+ wchar_t *ret = LIBC_NAMESPACE::wmemmove(dst, buffer + 1, 1);
+ EXPECT_EQ(ret, dst);
+
+ const char expected[] = {L'z', L'a', L'a', L'z'};
+ EXPECT_TRUE(buffer[0] == expected[0]);
+ EXPECT_TRUE(buffer[1] == expected[1]);
+ EXPECT_TRUE(buffer[2] == expected[2]);
+ EXPECT_TRUE(buffer[3] == expected[3]);
+}
+
+#if defined(LIBC_ADD_NULL_CHECKS) && !defined(LIBC_HAS_SANITIZER)
+TEST(LlvmLibcWMemmoveTest, NullptrCrash) {
+ wchar_t buffer[] = {L'a', L'b'};
+ // Passing in a nullptr should crash the program.
+ EXPECT_DEATH([buffer] { LIBC_NAMESPACE::wmemmove(buffer, nullptr, 2); },
+ WITH_SIGNAL(-1));
+ EXPECT_DEATH([buffer] { LIBC_NAMESPACE::wmemmove(nullptr, buffer, 2); },
+ WITH_SIGNAL(-1));
+}
+#endif // LIBC_HAS_ADDRESS_SANITIZER
>From 8119ac2de6918b4cdcb29ba032761c35af6ca73e Mon Sep 17 00:00:00 2001
From: Uzair Nawaz <uzairnawaz at google.com>
Date: Sat, 31 May 2025 00:19:45 +0000
Subject: [PATCH 2/3] fix death testcase
---
libc/test/src/wchar/wmemmove_test.cpp | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/libc/test/src/wchar/wmemmove_test.cpp b/libc/test/src/wchar/wmemmove_test.cpp
index 32ad55d0c42e9..d23aa0f0b3af1 100644
--- a/libc/test/src/wchar/wmemmove_test.cpp
+++ b/libc/test/src/wchar/wmemmove_test.cpp
@@ -103,9 +103,9 @@ TEST(LlvmLibcWMemmoveTest, DstFollowSrc) {
TEST(LlvmLibcWMemmoveTest, NullptrCrash) {
wchar_t buffer[] = {L'a', L'b'};
// Passing in a nullptr should crash the program.
- EXPECT_DEATH([buffer] { LIBC_NAMESPACE::wmemmove(buffer, nullptr, 2); },
+ EXPECT_DEATH([&buffer] { LIBC_NAMESPACE::wmemmove(buffer, nullptr, 2); },
WITH_SIGNAL(-1));
- EXPECT_DEATH([buffer] { LIBC_NAMESPACE::wmemmove(nullptr, buffer, 2); },
+ EXPECT_DEATH([&buffer] { LIBC_NAMESPACE::wmemmove(nullptr, buffer, 2); },
WITH_SIGNAL(-1));
}
#endif // LIBC_HAS_ADDRESS_SANITIZER
>From 2e8a5c844c2513146d92d0028ccb72473ea2976a Mon Sep 17 00:00:00 2001
From: Uzair Nawaz <uzairnawaz at google.com>
Date: Sat, 31 May 2025 00:22:35 +0000
Subject: [PATCH 3/3] style
---
libc/src/wchar/wmemmove.cpp | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libc/src/wchar/wmemmove.cpp b/libc/src/wchar/wmemmove.cpp
index 46bcb659744e0..2b7cf21f52667 100644
--- a/libc/src/wchar/wmemmove.cpp
+++ b/libc/src/wchar/wmemmove.cpp
@@ -17,7 +17,7 @@
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(wchar_t *, wmemmove,
- (wchar_t * dest, const wchar_t *src, size_t n)) {
+ (wchar_t *dest, const wchar_t *src, size_t n)) {
LIBC_CRASH_ON_NULLPTR(dest);
LIBC_CRASH_ON_NULLPTR(src);
More information about the libc-commits
mailing list