Add interceptors for the strtoi(3)/strtou(3) from NetBSD

[krytarowski]

Summary

strtoi/strtou converts string value to an intmax_t/uintmax_t integer.

Add a dedicated test.

Enable this API for NetBSD.

It's a reworked version of the original work by Yang Zheng.

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7308

There is INTERCEPTORS_STRTO_BASE in msan
Probably we should try to move them into common, and than add new interceptors.
If this is hard to move, then just add strtoi there

[krytarowski]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7308

Do you mean, to add strtoi for MSan only?

Yes, the interceptors shall be made generic.. however we are not able to do it in this iteration.

[krytarowski]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7308

BTW. I will drop you a line in a mail.

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7331

we need StrtolFixAndCheck and avoid reading entire string for strict_string_checks=0

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7308

not sure what is long term is better
maybe adding this just into msan and later converting to _common would be easier

[krytarowski]

• rework the interceptor

[krytarowski]

• simplify

[vitalybuka]

test/sanitizer_common/TestCases/NetBSD/strtoi.cc

70

could you please make a single test function with arguments
now they are almost identical

[krytarowski]

test/sanitizer_common/TestCases/NetBSD/strtoi.cc

70

I will do it.

lib/sanitizer_common/sanitizer_common_interceptors.inc

 }
 #define INIT_MI_VECTOR_HASH COMMON_INTERCEPT_FUNCTION(mi_vector_hash)
 #else
 #define INIT_MI_VECTOR_HASH
 #endif
 
 #if SANITIZER_INTERCEPT_SETVBUF
 INTERCEPTOR(int, setvbuf, __sanitizer_FILE *stream, char *buf, int mode,
   SIZE_T size) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, setvbuf, stream, buf, mode, size);
   int ret = REAL(setvbuf)(stream, buf, mode, size);
   if (buf)
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, size);
   if (stream)
       unpoison_file(stream);
   return ret;
 }
 
 INTERCEPTOR(void, setbuf, __sanitizer_FILE *stream, char *buf) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, setbuf, stream, buf);
   REAL(setbuf)(stream, buf);
   if (buf) {
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, __sanitizer_bufsiz);
   }
   if (stream)
       unpoison_file(stream);
 }
 
 INTERCEPTOR(void, setbuffer, __sanitizer_FILE *stream, char *buf, int mode) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, setbuffer, stream, buf, mode);
   REAL(setbuffer)(stream, buf, mode);
   if (buf) {
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, __sanitizer_bufsiz);
   }
   if (stream)
     unpoison_file(stream);
 }
INTERCEPTOR(int, modctl, int operation, void *argp) {
 
   return ret;
 }
 #define INIT_MODCTL COMMON_INTERCEPT_FUNCTION(modctl)
 #else
 #define INIT_MODCTL
 #endif
 
+#if SANITIZER_INTERCEPT_STRTOI
+INTERCEPTOR(INTMAX_T, strtoi, const char *nptr, char **endptr, int base,
+            INTMAX_T low, INTMAX_T high, int *rstatus) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, strtoi, nptr, endptr, base, low, high, rstatus);
+  char *real_endptr;
+  INTMAX_T ret = REAL(strtoi)(nptr, &real_endptr, base, low, high, rstatus);
+  StrtolFixAndCheck(ctx, nptr, endptr, real_endptr, base);
+  if (rstatus)
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, rstatus, sizeof(*rstatus));
+  return ret;
+}
+
+INTERCEPTOR(UINTMAX_T, strtou, const char *nptr, char **endptr, int base,
+            UINTMAX_T low, UINTMAX_T high, int *rstatus) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, strtou, nptr, endptr, base, low, high, rstatus);
+  char *real_endptr;
+  UINTMAX_T ret = REAL(strtou)(nptr, &real_endptr, base, low, high, rstatus);
+  StrtolFixAndCheck(ctx, nptr, endptr, real_endptr, base);
+  if (rstatus)
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, rstatus, sizeof(*rstatus));
+  return ret;
+}
+#define INIT_STRTOI                                                            \
+  COMMON_INTERCEPT_FUNCTION(strtoi);                                           \
+  COMMON_INTERCEPT_FUNCTION(strtou)
+#else
+#define INIT_STRTOI
+#endif
+
 static void InitializeCommonInterceptors() {
   static u64 metadata_mem[sizeof(MetadataHashMap) / sizeof(u64) + 1];
   interceptor_metadata_map = new((void *)&metadata_mem) MetadataHashMap();
 
   INIT_MMAP;
   INIT_MMAP64;
   INIT_TEXTDOMAIN;
   INIT_STRLEN;
static void InitializeCommonInterceptors() {
   INIT_GETVFSSTAT;
   INIT_REGEX;
   INIT_FTS;
   INIT_SYSCTL;
   INIT_ASYSCTL;
   INIT_SYSCTLGETMIBINFO;
   INIT_NL_LANGINFO;
   INIT_MODCTL;
+  INIT_STRTOI;
 
   INIT___PRINTF_CHK;
 }

lib/sanitizer_common/sanitizer_platform_interceptors.h

 #define SANITIZER_INTERCEPT_GETVFSSTAT SI_NETBSD
 #define SANITIZER_INTERCEPT_REGEX SI_NETBSD
 #define SANITIZER_INTERCEPT_FTS SI_NETBSD
 #define SANITIZER_INTERCEPT_SYSCTL (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_ASYSCTL SI_NETBSD
 #define SANITIZER_INTERCEPT_SYSCTLGETMIBINFO SI_NETBSD
 #define SANITIZER_INTERCEPT_NL_LANGINFO (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_MODCTL SI_NETBSD
+#define SANITIZER_INTERCEPT_STRTOI SI_NETBSD
 
 #endif  // #ifndef SANITIZER_PLATFORM_INTERCEPTORS_H

test/sanitizer_common/TestCases/NetBSD/strtoi.cc

+// RUN: %clangxx -O0 -g %s -o %t && %run %t 2>&1 | FileCheck %s
+
+#include <inttypes.h>
+#include <stdio.h>
+
+void test_strtoi1() {
+  const char *cent = "100";
+  char *p;
+  int status;
+  intmax_t i = strtoi(cent, &p, 0, 1, 1000, &status);
+  printf("strtoi: conversion of '%s' to a number %s, using %jd, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+void test_strtoi2() {
+  const char *cent = "100";
+  char *p;
+  int status;
+  intmax_t i = strtoi(cent, &p, 0, 1, 10, &status);
+  printf("strtoi: conversion of '%s' to a number %s, using %jd, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+void test_strtoi3() {
+  const char *cent = "100xyz";
+  char *p;
+  int status;
+  intmax_t i = strtoi(cent, &p, 0, 1, 10, &status);
+  printf("strtoi: conversion of '%s' to a number %s, using %jd, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+void test_strtou1() {
+  const char *cent = "100";
+  char *p;
+  int status;
+  uintmax_t i = strtou(cent, &p, 0, 1, 1000, &status);
+  printf("strtou: conversion of '%s' to a number %s, using %ju, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+void test_strtou2() {
+  const char *cent = "100";
+  char *p;
+  int status;
+  uintmax_t i = strtou(cent, &p, 0, 1, 10, &status);
+  printf("strtou: conversion of '%s' to a number %s, using %ju, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+void test_strtou3() {
+  const char *cent = "100xyz";
+  char *p;
+  int status;
+  uintmax_t i = strtou(cent, &p, 0, 1, 10, &status);
+  printf("strtou: conversion of '%s' to a number %s, using %ju, p=%#" PRIx8
+         "\n",
+         cent, status ? "failed" : "successful", i, *p);
+}
+
+int main(void) {
+  printf("strtoi\n");
+
+  test_strtoi1();
+  test_strtoi2();
+  test_strtoi3();
+  test_strtou1();
+  test_strtou2();
+  test_strtou3();
+
+  // CHECK: strtoi
+  // CHECK: strtoi: conversion of '100' to a number successful, using 100, p=0
+  // CHECK: strtoi: conversion of '100' to a number failed, using 10, p=0
+  // CHECK: strtoi: conversion of '100xyz' to a number failed, using 10, p=0x78
+  // CHECK: strtou: conversion of '100' to a number successful, using 100, p=0
+  // CHECK: strtou: conversion of '100' to a number failed, using 10, p=0
+  // CHECK: strtou: conversion of '100xyz' to a number failed, using 10, p=0x78
+
+  return 0;
+}