[libc-commits] [libc] [libc][search] implement posix `lfind` function (PR #114692)
via libc-commits
libc-commits at lists.llvm.org
Sat Nov 2 20:24:51 PDT 2024
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-libc
Author: Duncan (duncpro)
<details>
<summary>Changes</summary>
# Changes
- Implement the POSIX [`lfind`](https://man7.org/linux/man-pages/man3/lsearch.3.html) function.
- Put a checkmark in the [posix support table docs](https://libc.llvm.org/libc_search.html) next to `lfind`.
Also, I'm not sure how to specify a function pointer type in the [oldhdrgen spec](https://github.com/duncpro/llvm-project/blob/66c36e8c02f62349aed3e578ed8a26de158c2560/libc/spec/posix.td#L1621-L1631) files. If someone could help with that I'd appreciate it.
---
Full diff: https://github.com/llvm/llvm-project/pull/114692.diff
17 Files Affected:
- (modified) libc/config/baremetal/arm/entrypoints.txt (+3)
- (modified) libc/config/baremetal/riscv/entrypoints.txt (+3)
- (modified) libc/config/darwin/arm/entrypoints.txt (+3)
- (modified) libc/config/darwin/x86_64/entrypoints.txt (+3)
- (modified) libc/config/linux/aarch64/entrypoints.txt (+1)
- (modified) libc/config/linux/arm/entrypoints.txt (+3)
- (modified) libc/config/linux/riscv/entrypoints.txt (+1)
- (modified) libc/config/linux/x86_64/entrypoints.txt (+1)
- (modified) libc/config/windows/entrypoints.txt (+3)
- (modified) libc/docs/libc_search.rst (+1-1)
- (modified) libc/newhdrgen/yaml/search.yaml (+10)
- (modified) libc/spec/posix.td (+11)
- (modified) libc/src/search/CMakeLists.txt (+11)
- (added) libc/src/search/lfind.cpp (+29)
- (added) libc/src/search/lfind.h (+20)
- (modified) libc/test/src/search/CMakeLists.txt (+10)
- (added) libc/test/src/search/lfind_test.cpp (+46)
``````````diff
diff --git a/libc/config/baremetal/arm/entrypoints.txt b/libc/config/baremetal/arm/entrypoints.txt
index 68030f7f1775b5..ae71ea9c327b63 100644
--- a/libc/config/baremetal/arm/entrypoints.txt
+++ b/libc/config/baremetal/arm/entrypoints.txt
@@ -26,6 +26,9 @@ set(TARGET_LIBC_ENTRYPOINTS
# errno.h entrypoints
libc.src.errno.errno
+ # search.h entrypoints
+ libc.src.search.lfind
+
# setjmp.h entrypoints
libc.src.setjmp.longjmp
libc.src.setjmp.setjmp
diff --git a/libc/config/baremetal/riscv/entrypoints.txt b/libc/config/baremetal/riscv/entrypoints.txt
index 5894b591072ef0..6106ae1b8b234e 100644
--- a/libc/config/baremetal/riscv/entrypoints.txt
+++ b/libc/config/baremetal/riscv/entrypoints.txt
@@ -26,6 +26,9 @@ set(TARGET_LIBC_ENTRYPOINTS
# errno.h entrypoints
libc.src.errno.errno
+ # search.h entrypoints
+ libc.src.search.lfind
+
# string.h entrypoints
libc.src.string.bcmp
libc.src.string.bcopy
diff --git a/libc/config/darwin/arm/entrypoints.txt b/libc/config/darwin/arm/entrypoints.txt
index 2d5dbeff485747..cc730a7849c714 100644
--- a/libc/config/darwin/arm/entrypoints.txt
+++ b/libc/config/darwin/arm/entrypoints.txt
@@ -20,6 +20,9 @@ set(TARGET_LIBC_ENTRYPOINTS
# errno.h entrypoints
libc.src.errno.errno
+ # search.h entrypoints
+ libc.src.search.lfind
+
# string.h entrypoints
libc.src.string.bcmp
libc.src.string.bcopy
diff --git a/libc/config/darwin/x86_64/entrypoints.txt b/libc/config/darwin/x86_64/entrypoints.txt
index 49c19571ac4192..15b099f7890d2f 100644
--- a/libc/config/darwin/x86_64/entrypoints.txt
+++ b/libc/config/darwin/x86_64/entrypoints.txt
@@ -17,6 +17,9 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.ctype.tolower
libc.src.ctype.toupper
+ # search.h entrypoints
+ libc.src.search.lfind
+
# string.h entrypoints
libc.src.string.bcmp
libc.src.string.bzero
diff --git a/libc/config/linux/aarch64/entrypoints.txt b/libc/config/linux/aarch64/entrypoints.txt
index b3f94a581c8ad9..7ed1386c05b09d 100644
--- a/libc/config/linux/aarch64/entrypoints.txt
+++ b/libc/config/linux/aarch64/entrypoints.txt
@@ -942,6 +942,7 @@ if(LLVM_LIBC_FULL_BUILD)
libc.src.search.hsearch
libc.src.search.hsearch_r
libc.src.search.insque
+ libc.src.search.lfind
libc.src.search.remque
# threads.h entrypoints
diff --git a/libc/config/linux/arm/entrypoints.txt b/libc/config/linux/arm/entrypoints.txt
index 2ddb7aeefe48ec..f5ae0bbcb12f69 100644
--- a/libc/config/linux/arm/entrypoints.txt
+++ b/libc/config/linux/arm/entrypoints.txt
@@ -20,6 +20,9 @@ set(TARGET_LIBC_ENTRYPOINTS
# errno.h entrypoints
libc.src.errno.errno
+ # search.h entrypoints
+ libc.src.search.lfind
+
# string.h entrypoints
libc.src.string.bcmp
libc.src.string.bcopy
diff --git a/libc/config/linux/riscv/entrypoints.txt b/libc/config/linux/riscv/entrypoints.txt
index 5c09edf7cfb266..eef4592e27a85f 100644
--- a/libc/config/linux/riscv/entrypoints.txt
+++ b/libc/config/linux/riscv/entrypoints.txt
@@ -872,6 +872,7 @@ if(LLVM_LIBC_FULL_BUILD)
libc.src.search.hsearch
libc.src.search.hsearch_r
libc.src.search.insque
+ libc.src.search.lfind
libc.src.search.remque
# threads.h entrypoints
diff --git a/libc/config/linux/x86_64/entrypoints.txt b/libc/config/linux/x86_64/entrypoints.txt
index a2fb97d04584d5..ea9e5770fe75c7 100644
--- a/libc/config/linux/x86_64/entrypoints.txt
+++ b/libc/config/linux/x86_64/entrypoints.txt
@@ -1005,6 +1005,7 @@ if(LLVM_LIBC_FULL_BUILD)
libc.src.search.hsearch
libc.src.search.hsearch_r
libc.src.search.insque
+ libc.src.search.lfind
libc.src.search.remque
# threads.h entrypoints
diff --git a/libc/config/windows/entrypoints.txt b/libc/config/windows/entrypoints.txt
index 8f0b50bcc83ea2..679ef981c90afa 100644
--- a/libc/config/windows/entrypoints.txt
+++ b/libc/config/windows/entrypoints.txt
@@ -17,6 +17,9 @@ set(TARGET_LIBC_ENTRYPOINTS
libc.src.ctype.tolower
libc.src.ctype.toupper
+ # search.h entrypoints
+ libc.src.search.lfind
+
# string.h entrypoints
libc.src.string.bcmp
libc.src.string.bcopy
diff --git a/libc/docs/libc_search.rst b/libc/docs/libc_search.rst
index 4a7ee288dd43e8..774622d1e66c3f 100644
--- a/libc/docs/libc_search.rst
+++ b/libc/docs/libc_search.rst
@@ -42,7 +42,7 @@ hcreate |check|
hdestroy |check|
hsearch |check|
insque |check|
-lfind
+lfind |check|
lsearch
remque |check|
tdelete
diff --git a/libc/newhdrgen/yaml/search.yaml b/libc/newhdrgen/yaml/search.yaml
index 37d2650bcf0514..af99719c4df958 100644
--- a/libc/newhdrgen/yaml/search.yaml
+++ b/libc/newhdrgen/yaml/search.yaml
@@ -57,3 +57,13 @@ functions:
return_type: void
arguments:
- type: void *
+ - name: lfind
+ standards:
+ - POSIX
+ return_type: void *
+ arguments:
+ - type: void *
+ - type: void *
+ - type: size_t *
+ - type: size_t
+ - type: int(*compar)(const void *, const void *)
diff --git a/libc/spec/posix.td b/libc/spec/posix.td
index beede79a38ec24..ea30b5c42b0e74 100644
--- a/libc/spec/posix.td
+++ b/libc/spec/posix.td
@@ -1618,6 +1618,17 @@ def POSIX : StandardSpec<"POSIX"> {
ArgSpec<VoidPtr>
]
>,
+ FunctionSpec<
+ "lfind",
+ RetValSpec<VoidPtr>,
+ [
+ ArgSpec<VoidPtr>,
+ ArgSpec<VoidPtr>,
+ ArgSpec<SizeTPtr>,
+ ArgSpec<SizeTType>,
+ // TODO: Unsure how to specify int(*compar)(void *, void *)
+ ]
+ >
]
>;
diff --git a/libc/src/search/CMakeLists.txt b/libc/src/search/CMakeLists.txt
index 46ad3e33c02fa9..0490b5939ab0f8 100644
--- a/libc/src/search/CMakeLists.txt
+++ b/libc/src/search/CMakeLists.txt
@@ -98,3 +98,14 @@ add_entrypoint_object(
libc.include.search
libc.src.__support.intrusive_list
)
+
+add_entrypoint_object(
+ lfind
+ SRCS
+ lfind.cpp
+ HDRS
+ lfind.h
+ DEPENDS
+ libc.include.search
+ libc.src.__support.CPP.cstddef
+)
diff --git a/libc/src/search/lfind.cpp b/libc/src/search/lfind.cpp
new file mode 100644
index 00000000000000..debf38de9f1000
--- /dev/null
+++ b/libc/src/search/lfind.cpp
@@ -0,0 +1,29 @@
+//===-- Implementation of lfind -------------------------------*- 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/search/lfind.h"
+#include "src/__support/CPP/cstddef.h" // cpp::byte
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void *, lfind,
+ (void *key, void *base, size_t *nmemb, size_t size,
+ int (*compar)(void *, void *))) {
+ cpp::byte *next = reinterpret_cast<cpp::byte *>(base);
+ cpp::byte *end = next + (*nmemb * size);
+ while (next < end) {
+ if (compar(key, next) == 0) {
+ return next;
+ }
+ next += size;
+ }
+ return nullptr;
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/search/lfind.h b/libc/src/search/lfind.h
new file mode 100644
index 00000000000000..3e0063f8e19f10
--- /dev/null
+++ b/libc/src/search/lfind.h
@@ -0,0 +1,20 @@
+//===-- Implementation header for lfind -------------------------*- 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_SEARCH_LFIND_H
+#define LLVM_LIBC_SRC_SEARCH_LFIND_H
+
+#include "src/__support/macros/config.h"
+#include <search.h> // size_t
+
+namespace LIBC_NAMESPACE_DECL {
+void *lfind(void *key, void *base, size_t *nmemb, size_t size,
+ int (*compar)(void *, void *));
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_SEARCH_LFIND_H
diff --git a/libc/test/src/search/CMakeLists.txt b/libc/test/src/search/CMakeLists.txt
index 8a33edc4293ab2..a1f9aac2094c9b 100644
--- a/libc/test/src/search/CMakeLists.txt
+++ b/libc/test/src/search/CMakeLists.txt
@@ -25,3 +25,13 @@ add_libc_unittest(
libc.src.search.insque
libc.src.search.remque
)
+
+add_libc_unittest(
+ lfind_test
+ SUITE
+ libc_search_unittests
+ SRCS
+ lfind_test.cpp
+ DEPENDS
+ libc.src.search.lfind
+)
diff --git a/libc/test/src/search/lfind_test.cpp b/libc/test/src/search/lfind_test.cpp
new file mode 100644
index 00000000000000..d434194444c330
--- /dev/null
+++ b/libc/test/src/search/lfind_test.cpp
@@ -0,0 +1,46 @@
+//===-- Unittests for lfind -----------------------------------------------===//
+//
+// 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/search/lfind.h"
+#include "test/UnitTest/Test.h"
+
+int compar(void *a, void *b) {
+ return *reinterpret_cast<int *>(a) - *reinterpret_cast<int *>(b);
+}
+
+TEST(LlvmLibcLfindTest, SearchHead) {
+ int list[3] = {1, 2, 3};
+ size_t len = 3;
+ int key = 1;
+ void *ret = LIBC_NAMESPACE::lfind(&key, list, &len, sizeof(int), compar);
+ ASSERT_TRUE(ret == &list[0]);
+}
+
+TEST(LlvmLibcLfindTest, SearchMiddle) {
+ int list[3] = {1, 2, 3};
+ size_t len = 3;
+ int key = 2;
+ void *ret = LIBC_NAMESPACE::lfind(&key, list, &len, sizeof(int), compar);
+ ASSERT_TRUE(ret == &list[1]);
+}
+
+TEST(LlvmLibcLfindTest, SearchTail) {
+ int list[3] = {1, 2, 3};
+ size_t len = 3;
+ int key = 3;
+ void *ret = LIBC_NAMESPACE::lfind(&key, list, &len, sizeof(int), compar);
+ ASSERT_TRUE(ret == &list[2]);
+}
+
+TEST(LlvmLibcLfindTest, SearchNonExistent) {
+ int list[3] = {1, 2, 3};
+ size_t len = 3;
+ int key = 5;
+ void *ret = LIBC_NAMESPACE::lfind(&key, list, &len, sizeof(int), compar);
+ ASSERT_TRUE(ret == nullptr);
+}
``````````
</details>
https://github.com/llvm/llvm-project/pull/114692
More information about the libc-commits
mailing list