Add new interceptors: getprotoent(3) family

[krytarowski]

Summary

getprotoent, getprotobynumber, getprotobyname - get protocol entry

Reuse them on NetBSD.

Sponsored by <The NetBSD Foundation>

[vitalybuka]

Similar to D43539 and D43543
I'll make the patch "red" just to remove from my dashboard :-)

[krytarowski]

• apply comments from review
• improve the test

[krytarowski]

• apply the remaining comments from review

[krytarowski]

• improve the patch

lib/sanitizer_common/sanitizer_common_interceptors.inc

#define INIT_GETTTYENT \
   COMMON_INTERCEPT_FUNCTION(getttynam); \
   COMMON_INTERCEPT_FUNCTION(setttyent); \
   COMMON_INTERCEPT_FUNCTION(setttyentpath); \
   COMMON_INTERCEPT_FUNCTION(endttyent)
 #else
 #define INIT_GETTTYENT
 #endif
 
+#if SANITIZER_INTERCEPT_GETPROTOENT
+INTERCEPTOR(struct __sanitizer_protoent *, getprotoent) {
+  void *ctx;
+  struct __sanitizer_protoent *p;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotoent);
+  p = REAL(getprotoent)();
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    char **pp = p->p_aliases;
+
+    while (*pp) {
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+       pp++;
+    }
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+  }
+  return p;
+}
+
+INTERCEPTOR(struct __sanitizer_protoent *, getprotobyname, const char *name) {
+  void *ctx;
+  struct __sanitizer_protoent *p;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotobyname, name);
+  p = REAL(getprotobyname)(name);
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    char **pp = p->p_aliases;
+
+    while (*pp) {
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+       pp++;
+    }
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+  }
+  return p;
+}
+
+INTERCEPTOR(struct __sanitizer_protoent *, getprotobynumber, int proto) {
+  void *ctx;
+  struct __sanitizer_protoent *p;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotobynumber, proto);
+  p = REAL(getprotobynumber)(proto);
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    char **pp = p->p_aliases;
+
+    while (*pp) {
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+       pp++;
+    }
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, pp, sizeof(char **));
+  }
+  return p;
+}
+INTERCEPTOR(void, setprotoent, int stayopen) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, setprotoent, stayopen);
+  return REAL(setprotoent)(stayopen);
+}
+
+INTERCEPTOR(void, endprotoent) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, endprotoent);
+  return REAL(endprotoent)();
+}
+#define INIT_GETPROTOENT \
+  COMMON_INTERCEPT_FUNCTION(getprotoent); \
+  COMMON_INTERCEPT_FUNCTION(getprotobyname); \
+  COMMON_INTERCEPT_FUNCTION(getprotobynumber); \
+  COMMON_INTERCEPT_FUNCTION(setprotoent); \
+  COMMON_INTERCEPT_FUNCTION(endprotoent);
+#else
+#define INIT_GETPROTOENT
+#endif
+
 static void InitializeCommonInterceptors() {
   static u64 metadata_mem[sizeof(MetadataHashMap) / sizeof(u64) + 1];
   interceptor_metadata_map = new((void *)&metadata_mem) MetadataHashMap();
 
   INIT_TEXTDOMAIN;
   INIT_STRLEN;
   INIT_STRNLEN;
   INIT_STRNDUP;
static void InitializeCommonInterceptors() {
   INIT_NAME_TO_HANDLE_AT;
   INIT_OPEN_BY_HANDLE_AT;
   INIT_STRLCPY;
   INIT_DEVNAME;
   INIT_DEVNAME_R;
   INIT_FGETLN;
   INIT_STRMODE;
   INIT_GETTTYENT;
+  INIT_GETPROTOENT;
 
 #if SANITIZER_NETBSD
   COMMON_INTERCEPT_FUNCTION(__libc_mutex_lock);
   COMMON_INTERCEPT_FUNCTION(__libc_mutex_unlock);
   COMMON_INTERCEPT_FUNCTION(__libc_thr_setcancelstate);
 #endif
 
   INIT___PRINTF_CHK;
 }

lib/sanitizer_common/sanitizer_platform_interceptors.h

 #define SANITIZER_INTERCEPT_READLINKAT \
   (SI_POSIX && !SI_MAC_DEPLOYMENT_BELOW_10_10)
 
 #define SANITIZER_INTERCEPT_DEVNAME SI_NETBSD
 #define SANITIZER_INTERCEPT_DEVNAME_R SI_NETBSD
 #define SANITIZER_INTERCEPT_FGETLN SI_NETBSD
 #define SANITIZER_INTERCEPT_STRMODE SI_NETBSD
 #define SANITIZER_INTERCEPT_GETTTYENT SI_NETBSD
+#define SANITIZER_INTERCEPT_GETPROTOENT SI_NETBSD
 
 #endif  // #ifndef SANITIZER_PLATFORM_INTERCEPTORS_H

test/sanitizer_common/TestCases/NetBSD/getprotoent.cc

+// RUN: %clangxx -O0 -g %s -o %t && %run %t 2>&1 | FileCheck %s
+
+#include <netdb.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#define STRING_OR_NULL(x) ((x) ? (x) : "null")
+
+void test1() {
+  struct protoent *ptp;
+  char **cp;
+
+  ptp = getprotoent();
+  if (!ptp)
+    exit(1);
+
+  for (cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+void test2() {
+  struct protoent *ptp;
+  char **cp;
+
+  ptp = getprotobyname("icmp");
+  if (!ptp)
+    exit(1);
+
+  for (cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+void test3() {
+  struct protoent *ptp;
+  char **cp;
+
+  ptp = getprotobynumber(1);
+  if (!ptp)
+    exit(1);
+
+  for (cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+void test4() {
+  struct protoent *ptp;
+  char **cp;
+
+  setprotoent(1);
+  ptp = getprotobynumber(1);
+  if (!ptp)
+    exit(1);
+
+  ptp = getprotobynumber(2);
+  if (!ptp)
+    exit(1);
+
+  for (cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+void test5() {
+  struct protoent *ptp;
+  char **cp;
+
+  ptp = getprotobyname("ttp");
+  if (!ptp)
+    exit(1);
+
+  for (cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+int main(void) {
+  test1();
+  test2();
+  test3();
+  test4();
+  test5();
+
+  // CHECK: HOPOPT 0
+  // CHECK: ICMP 1
+  // CHECK: ICMP 1
+  // CHECK: IGMP 2
+  // CHECK: TTP iptm IPTM 84
+
+  return 0;
+}