[libc] add strndup

[michaelrj]

Summary

add an implementation of strndup

[sivachandra]

The license headers are messed up because of clang-tidy may be. But, LGTM otherwise.

libc/src/string/strndup.cpp

23

We don't need braces to enclose single statement blocks.

libc/test/src/string/strndup_test.cpp

51

Do we need this empty line here?

[michaelrj]

small formatting fixes

libc/config/linux/x86_64/entrypoints.txt

list(APPEND TARGET_LIBC_ENTRYPOINTS
     # stdlib.h external entrypoints
     libc.src.stdlib.malloc
     libc.src.stdlib.calloc
     libc.src.stdlib.realloc
     libc.src.stdlib.free
 
     # string.h entrypoints that depend on malloc
     libc.src.string.strdup
+    libc.src.string.strndup
   )
 endif()
 
 set(TARGET_LLVMLIBC_ENTRYPOINTS
   ${TARGET_LIBC_ENTRYPOINTS}
   ${TARGET_LIBM_ENTRYPOINTS}
 )

libc/spec/stdc.td

HeaderSpec String = HeaderSpec<
               [ArgSpec<ConstCharPtr>, ArgSpec<ConstCharPtr>]
           >,
           FunctionSpec<
               "strdup",
               RetValSpec<CharPtr>,
               [ArgSpec<ConstCharPtr>]
           >,
           FunctionSpec<
+              "strndup",
+              RetValSpec<CharPtr>,
+              [ArgSpec<ConstCharPtr>,ArgSpec<SizeTType>]
+          >,
+          FunctionSpec<
               "strpbrk",
               RetValSpec<CharPtr>,
               [ArgSpec<ConstCharPtr>, ArgSpec<ConstCharPtr>]
           >,
           FunctionSpec<
               "strrchr",
               RetValSpec<CharPtr>,
               [ArgSpec<ConstCharPtr>, ArgSpec<IntType>]

libc/src/string/CMakeLists.txt

add_entrypoint_object(
   strncpy
   SRCS
     strncpy.cpp
   HDRS
     strncpy.h
 )
 
 add_entrypoint_object(
+  strndup
+  SRCS
+    strndup.cpp
+  HDRS
+    strndup.h
+  DEPENDS
+    .memcpy
+    .string_utils
+    libc.include.stdlib
+)
+
+add_entrypoint_object(
   strnlen
   SRCS
     strnlen.cpp
   HDRS
     strnlen.h
   DEPENDS
     .string_utils
 )

libc/src/string/strndup.h

+//===-- Implementation header for strndup -----------------------*- 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_STRING_STRNDUP_H
+#define LLVM_LIBC_SRC_STRING_STRNDUP_H
+
+#include <string.h>
+
+namespace __llvm_libc {
+
+char *strndup(const char *src, size_t size);
+
+} // namespace __llvm_libc
+
+#endif // LLVM_LIBC_SRC_STRING_STRNDUP_H

libc/src/string/strndup.cpp

+//===-- Implementation of strndup -----------------------------------------===//
+//
+// 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/string/strndup.h"
+#include "src/string/memcpy.h"
+#include "src/string/string_utils.h"
+
+#include "src/__support/common.h"
+
+#include <stddef.h>
+#include <stdlib.h>
+
+namespace __llvm_libc {
+
+LLVM_LIBC_FUNCTION(char *, strndup, (const char *src, size_t size)) {
+  if (src == nullptr)
+    return nullptr;
+  size_t len = internal::string_length(src);
+  if (len > size)
+    len = size;
+  char *dest = reinterpret_cast<char *>(::malloc(len + 1)); // NOLINT
+  if (dest == nullptr)
+    return nullptr;
+  char *result =
+      reinterpret_cast<char *>(__llvm_libc::memcpy(dest, src, len + 1));
+  result[len] = '\0';
+  return result;
+}
+
+} // namespace __llvm_libc

libc/test/src/string/CMakeLists.txt

SUITE
     libc_string_unittests
   SRCS
     strncpy_test.cpp
   DEPENDS
     libc.src.string.strncpy
 )
 
 add_libc_unittest(
+  strndup_test
+  SUITE
+    libc_string_unittests
+  SRCS
+    strndup_test.cpp
+  DEPENDS
+    libc.include.stdlib
+    libc.src.string.strndup
+)
+
+add_libc_unittest(
   strnlen_test
   SUITE
     libc_string_unittests
   SRCS
     strnlen_test.cpp
   DEPENDS
     libc.src.string.strnlen
 )

libc/test/src/string/strndup_test.cpp

+//===-- Unittests for strndup ---------------------------------------------===//
+//
+// 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/string/strndup.h"
+#include "utils/UnitTest/Test.h"
+#include <stdlib.h>
+
+TEST(LlvmLibcstrndupTest, EmptyString) {
+  const char *empty = "";
+
+  char *result = __llvm_libc::strndup(empty, 1);
+  ASSERT_NE(result, static_cast<char *>(nullptr));
+  ASSERT_NE(empty, const_cast<const char *>(result));
+  ASSERT_STREQ(empty, result);
+  ::free(result);
+}
+
+TEST(LlvmLibcstrndupTest, AnyString) {
+  const char *abc = "abc";
+
+  char *result = __llvm_libc::strndup(abc, 3);
+
+  ASSERT_NE(result, static_cast<char *>(nullptr));
+  ASSERT_NE(abc, const_cast<const char *>(result));
+  ASSERT_STREQ(abc, result);
+  ::free(result);
+
+  result = __llvm_libc::strndup(abc, 1);
+
+  ASSERT_NE(result, static_cast<char *>(nullptr));
+  ASSERT_NE(abc, const_cast<const char *>(result));
+  ASSERT_STREQ("a", result);
+  ::free(result);
+
+  result = __llvm_libc::strndup(abc, 10);
+
+  ASSERT_NE(result, static_cast<char *>(nullptr));
+  ASSERT_NE(abc, const_cast<const char *>(result));
+  ASSERT_STREQ(abc, result);
+  ::free(result);
+}
+
+TEST(LlvmLibcstrndupTest, NullPtr) {
+  char *result = __llvm_libc::strndup(nullptr, 0);
+
+  ASSERT_EQ(result, static_cast<char *>(nullptr));
+}