[libc] add strtoq and strtouq

[michaelrj]

Summary

These are BSD extension functions.

[sivachandra]

strtoq and strtouq are deprecated functions from FreeBSD. Should we add them at all?

[michaelrj]

These functions probably don't need to be added. They were under consideration due to some build issues, but those turned out to be unrelated.

libc/config/linux/x86_64/entrypoints.txt

set(TARGET_LIBC_ENTRYPOINTS
     libc.src.stdlib.ldiv
     libc.src.stdlib.llabs
     libc.src.stdlib.lldiv
     libc.src.stdlib.qsort
     libc.src.stdlib.strtod
     libc.src.stdlib.strtof
     libc.src.stdlib.strtol
     libc.src.stdlib.strtoll
+    libc.src.stdlib.strtoq
     libc.src.stdlib.strtoul
     libc.src.stdlib.strtoull
+    libc.src.stdlib.strtouq
 )
 
 set(TARGET_LIBM_ENTRYPOINTS
     # fenv.h entrypoints
     libc.src.fenv.feclearexcept
     libc.src.fenv.fedisableexcept
     libc.src.fenv.feenableexcept
     libc.src.fenv.fegetenv

libc/spec/stdc.td

HeaderSpec StdLib = HeaderSpec<
           FunctionSpec<"lldiv", RetValSpec<LLDivTType>, [ArgSpec<LongLongType>, ArgSpec<LongLongType>]>,
 
           FunctionSpec<"qsort", RetValSpec<VoidType>, [ArgSpec<VoidPtr>, ArgSpec<SizeTType>, ArgSpec<SizeTType>, ArgSpec<QSortCompareT>]>,
 
           FunctionSpec<"strtod", RetValSpec<DoubleType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>]>,
           FunctionSpec<"strtof", RetValSpec<FloatType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>]>,
           FunctionSpec<"strtol", RetValSpec<LongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
           FunctionSpec<"strtoll", RetValSpec<LongLongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
+          FunctionSpec<"strtoq", RetValSpec<LongLongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
           FunctionSpec<"strtoul", RetValSpec<UnsignedLongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
           FunctionSpec<"strtoull", RetValSpec<UnsignedLongLongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
+          FunctionSpec<"strtouq", RetValSpec<UnsignedLongLongType>, [ArgSpec<ConstCharRestrictedPtr>, ArgSpec<CharRestrictedPtrPtr>, ArgSpec<IntType>]>,
 
           FunctionSpec<"_Exit", RetValSpec<NoReturn>, [ArgSpec<IntType>]>,
       ]
   >;
 
   NamedType IMaxDivTType = NamedType<"imaxdiv_t">;
 
   HeaderSpec IntTypes = HeaderSpec<

libc/src/stdlib/CMakeLists.txt

SRCS
     strtoll.cpp
   HDRS
     strtoll.h
   DEPENDS
     libc.src.__support.str_conv_utils
 )
 
 add_entrypoint_object(
+  strtoq
+  SRCS
+    strtoq.cpp
+  HDRS
+    strtoq.h
+  DEPENDS
+    libc.src.__support.str_conv_utils
+)
+
+add_entrypoint_object(
   strtoul
   SRCS
     strtoul.cpp
   HDRS
     strtoul.h
   DEPENDS
     libc.src.__support.str_conv_utils
 )
 
 add_entrypoint_object(
   strtoull
   SRCS
     strtoull.cpp
   HDRS
     strtoull.h
   DEPENDS
     libc.src.__support.str_conv_utils
 )
 
 add_entrypoint_object(
+  strtouq
+  SRCS
+    strtouq.cpp
+  HDRS
+    strtouq.h
+  DEPENDS
+    libc.src.__support.str_conv_utils
+)
+
+add_entrypoint_object(
   abs
   SRCS
     abs.cpp
   HDRS
     abs.h
   DEPENDS
     libc.src.__support.integer_operations
 )

libc/src/stdlib/strtoq.h

+//===-- Implementation header for strtoq ------------------------*- 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_STDLIB_STRTOQ_H
+#define LLVM_LIBC_SRC_STDLIB_STRTOQ_H
+
+namespace __llvm_libc {
+
+long long strtoq(const char *__restrict str, char **__restrict str_end,
+                 int base);
+
+} // namespace __llvm_libc
+
+#endif // LLVM_LIBC_SRC_STDLIB_STRTOQ_H

libc/src/stdlib/strtoq.cpp

+//===-- Implementation of strtoq -----------------------------------------===//
+//
+// 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/stdlib/strtoq.h"
+#include "src/__support/common.h"
+#include "src/__support/str_conv_utils.h"
+
+namespace __llvm_libc {
+
+LLVM_LIBC_FUNCTION(long long, strtoq,
+                   (const char *__restrict str, char **__restrict str_end,
+                    int base)) {
+  return internal::strtointeger<long long>(str, str_end, base);
+}
+
+} // namespace __llvm_libc

libc/src/stdlib/strtouq.h

+//===-- Implementation header for strtouq -----------------------*- 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_STDLIB_STRTOUQ_H
+#define LLVM_LIBC_SRC_STDLIB_STRTOUQ_H
+
+namespace __llvm_libc {
+
+unsigned long long strtouq(const char *__restrict str,
+                           char **__restrict str_end, int base);
+
+} // namespace __llvm_libc
+
+#endif // LLVM_LIBC_SRC_STDLIB_STRTOUQ_H

libc/src/stdlib/strtouq.cpp

+//===-- Implementation of strtouq -----------------------------------------===//
+//
+// 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/stdlib/strtouq.h"
+#include "src/__support/common.h"
+#include "src/__support/str_conv_utils.h"
+
+namespace __llvm_libc {
+
+LLVM_LIBC_FUNCTION(unsigned long long, strtouq,
+                   (const char *__restrict str, char **__restrict str_end,
+                    int base)) {
+  return internal::strtointeger<unsigned long long>(str, str_end, base);
+}
+
+} // namespace __llvm_libc

libc/test/src/stdlib/CMakeLists.txt

SUITE
     libc_stdlib_unittests
   SRCS
     strtoll_test.cpp
   DEPENDS
     libc.src.stdlib.strtoll
 )
 
 add_libc_unittest(
+  strtoq_test
+  SUITE
+    libc_stdlib_unittests
+  SRCS
+    strtoq_test.cpp
+  DEPENDS
+    libc.src.stdlib.strtoq
+)
+
+add_libc_unittest(
   strtoul_test
   SUITE
     libc_stdlib_unittests
   SRCS
     strtoul_test.cpp
   DEPENDS
     libc.src.stdlib.strtoul
 )
 
 add_libc_unittest(
   strtoull_test
   SUITE
     libc_stdlib_unittests
   SRCS
     strtoull_test.cpp
   DEPENDS
     libc.src.stdlib.strtoull
 )
 
+add_libc_unittest(
+  strtouq_test
+  SUITE
+    libc_stdlib_unittests
+  SRCS
+    strtouq_test.cpp
+  DEPENDS
+    libc.src.stdlib.strtouq
+)
+
 if(NOT LLVM_LIBC_FULL_BUILD)
   return()
 endif()
 
 add_libc_unittest(
   _Exit_test
   SUITE
     libc_stdlib_unittests

libc/test/src/stdlib/strtoq_test.cpp

+//===-- Unittests for strtoq ----------------------------------------------===//
+//
+// 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/stdlib/strtoq.h"
+
+#include "utils/UnitTest/Test.h"
+
+#include <errno.h>
+#include <limits.h>
+#include <stddef.h>
+
+// strtoq is equivalent to strtoll on all currently supported configurations.
+// Thus to avoid duplicating code there is just one test to make sure that
+// strtoq works at all. For real tests see stdlib/strtoll_test.cpp.
+
+TEST(LlvmLibcStrToQTest, SimpleCheck) {
+  const char *ten = "10";
+  errno = 0;
+  ASSERT_EQ(__llvm_libc::strtoq(ten, nullptr, 10), 10ll);
+  ASSERT_EQ(errno, 0);
+}

libc/test/src/stdlib/strtouq_test.cpp

+//===-- Unittests for strtouq -------------------------------------------===//
+//
+// 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/stdlib/strtouq.h"
+
+#include "utils/UnitTest/Test.h"
+
+#include <errno.h>
+#include <limits.h>
+#include <stddef.h>
+
+// strtouq is equivalent to strtoull on all currently supported configurations.
+// Thus to avoid duplicating code there is just one test to make sure that
+// strtouq works at all. For real tests see stdlib/strtoull_test.cpp.
+
+TEST(LlvmLibcStrToUQTest, SimpleCheck) {
+  const char *ten = "10";
+  errno = 0;
+  ASSERT_EQ(__llvm_libc::strtouq(ten, nullptr, 10), 10ull);
+  ASSERT_EQ(errno, 0);
+}