From f4bb54e4d167e2a2515bcaef0be018b51a2cabb1 Mon Sep 17 00:00:00 2001
From: Justin Hammond <justin@dynam.ac>
Date: Sat, 15 Aug 2026 15:13:10 +0800
Subject: [PATCH] testing/libc/arch_libc: Test strlcpy.

strlcpy is the one function in this directory's reach that nothing here
covers, and a machine directory may override it like any other.

Sweep every source and destination alignment pair against sizes 1 to 64,
and for each of those every capacity from zero to one past the length.
Check the return value, which is the length of src whether or not the
copy fit, the truncation point, the content, that a capacity of zero
writes nothing at all, and that nothing lands past the terminator.

The alignment pairs are the point.  An implementation that walks one of
the two pointers to a boundary and then copies a register at a time is
correct whenever the two agree, so a test that only ever passes matching
alignments says nothing about it.

The timing half is guarded.  perf_gettime() is not a system call, so an
application reaches it only where the C library builds its own copy or
where the application and the kernel are one image; calling it
unconditionally leaves the test unbuildable on a kernel build, which is
where the correctness half is still wanted.

Assisted-by: Claude:claude-opus-5
Signed-off-by: Justin Hammond <justin@dynam.ac>
---
 testing/libc/arch_libc/Kconfig               |   4 +
 testing/libc/arch_libc/arch_libc_test_main.c | 117 +++++++++++++++++++
 2 files changed, 121 insertions(+)

diff --git a/testing/libc/arch_libc/Kconfig b/testing/libc/arch_libc/Kconfig
index 0de9563cc..fec4ba9c1 100644
--- a/testing/libc/arch_libc/Kconfig
+++ b/testing/libc/arch_libc/Kconfig
@@ -43,6 +43,10 @@ config TESTING_ARCH_LIBC_STRCPY
 	bool "test strcpy"
 	default y
 
+config TESTING_ARCH_LIBC_STRLCPY
+	bool "test strlcpy"
+	default y
+
 config TESTING_ARCH_LIBC_STRLEN
 	bool "test strlen"
 	default y
diff --git a/testing/libc/arch_libc/arch_libc_test_main.c b/testing/libc/arch_libc/arch_libc_test_main.c
index 9e0a222f1..0f14f967c 100644
--- a/testing/libc/arch_libc/arch_libc_test_main.c
+++ b/testing/libc/arch_libc/arch_libc_test_main.c
@@ -681,6 +681,117 @@ static void speed_strcpy(void)
 }
 #endif
 
+/****************************************************************************
+ * Name: test_strlcpy
+ ****************************************************************************/
+
+#ifdef CONFIG_TESTING_ARCH_LIBC_STRLCPY
+static int test_strlcpy(void)
+{
+  int size;
+  int fail = 0;
+  int ai;
+  size_t cap;
+  size_t ret;
+  size_t want;
+
+  printf("Testing strlcpy...\n");
+
+  /* sa != da is the case that matters.  An implementation that walks only
+   * one of the two pointers to a boundary and then copies a register at a
+   * time still passes every sa == da case.
+   */
+
+  for (ai = 0; ai < 64; ai++)
+    {
+      int da = ai / 8;
+      int sa = ai % 8;
+
+      for (size = 1; size <= 64; size++)
+        {
+          fill_pattern(g_buf1 + sa, size);
+          g_buf1[sa + size] = '\0';
+
+          for (cap = 0; cap <= (size_t)size + 1; cap++)
+            {
+              memset(g_buf2, 0x5a, sizeof(g_buf2));
+              ret = strlcpy(g_buf2 + da, g_buf1 + sa, cap);
+
+              if (ret != (size_t)size)
+                {
+                  printf("  FAIL ret: sa=%d da=%d size=%d cap=%zu got=%zu\n",
+                         sa, da, size, cap, ret);
+                  fail++;
+                  continue;
+                }
+
+              if (cap == 0)
+                {
+                  /* Nothing may be written when there is no room */
+
+                  if ((unsigned char)g_buf2[da] != 0x5a)
+                    {
+                      printf("  FAIL cap0 wrote: sa=%d da=%d\n", sa, da);
+                      fail++;
+                    }
+
+                  continue;
+                }
+
+              want = (size_t)size < cap - 1 ? (size_t)size : cap - 1;
+
+              if (strlen(g_buf2 + da) != want ||
+                  memcmp(g_buf2 + da, g_buf1 + sa, want) != 0)
+                {
+                  printf("  FAIL content: sa=%d da=%d size=%d cap=%zu\n",
+                         sa, da, size, cap);
+                  fail++;
+                }
+              else if ((unsigned char)g_buf2[da + want + 1] != 0x5a)
+                {
+                  printf("  FAIL overrun: sa=%d da=%d size=%d cap=%zu\n",
+                         sa, da, size, cap);
+                  fail++;
+                }
+            }
+        }
+    }
+
+  printf("strlcpy: %s\n", fail ? "FAILED" : "PASSED");
+  return fail;
+}
+
+/* perf_gettime() reaches an application only where the C library builds its
+ * own copy, or where the application and the kernel are one image.
+ */
+
+#if defined(CONFIG_ARCH_HAVE_PERF_EVENTS_USER_ACCESS) || \
+    defined(CONFIG_BUILD_FLAT)
+#  define ARCH_LIBC_HAVE_PERF 1
+#endif
+
+#ifdef ARCH_LIBC_HAVE_PERF
+static void speed_strlcpy(void)
+{
+  clock_t start;
+  clock_t end;
+  int i;
+
+  fill_pattern(g_buf1, 128);
+  g_buf1[128] = '\0';
+  start = perf_gettime();
+  for (i = 0; i < TEST_REPEAT; i++)
+    {
+      g_sink = strlcpy(g_buf2, g_buf1, sizeof(g_buf2));
+    }
+
+  end = perf_gettime();
+  printf("strlcpy(128) avg cycles: %ju\n",
+         (uintmax_t)(end - start) / TEST_REPEAT);
+}
+#endif
+#endif
+
 /****************************************************************************
  * Name: test_strchr
  ****************************************************************************/
@@ -1434,6 +1545,12 @@ int main(int argc, FAR char *argv[])
   fail += test_strcpy();
   speed_strcpy();
 #endif
+#ifdef CONFIG_TESTING_ARCH_LIBC_STRLCPY
+  fail += test_strlcpy();
+#  ifdef ARCH_LIBC_HAVE_PERF
+  speed_strlcpy();
+#  endif
+#endif
 #ifdef CONFIG_TESTING_ARCH_LIBC_STRCHR
   fail += test_strchr();
   speed_strchr();