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_TTYENT \
   COMMON_INTERCEPT_FUNCTION(getttyent); \
   COMMON_INTERCEPT_FUNCTION(getttynam); \
   COMMON_INTERCEPT_FUNCTION(setttyentpath)
 #else
 #define INIT_TTYENT
 #endif
 
+#if SANITIZER_INTERCEPT_PROTOENT
+INTERCEPTOR(struct __sanitizer_protoent *, getprotoent) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotoent);
+  struct __sanitizer_protoent *p = REAL(getprotoent)();
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_name, REAL(strlen)(p->p_name) + 1);
+
+    SIZE_T pp_size = 1; // One handles the trailing \0
+
+    for (char **pp = p->p_aliases; *pp; ++pp, ++pp_size)
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_aliases,
+                                   pp_size * sizeof(char **));
+  }
+  return p;
+}
+
+INTERCEPTOR(struct __sanitizer_protoent *, getprotobyname, const char *name) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotobyname, name);
+  struct __sanitizer_protoent *p = REAL(getprotobyname)(name);
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_name, REAL(strlen)(p->p_name) + 1);
+
+    SIZE_T pp_size = 1; // One handles the trailing \0
+
+    for (char **pp = p->p_aliases; *pp; ++pp, ++pp_size)
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_aliases,
+                                   pp_size * sizeof(char **));
+  }
+  return p;
+}
+
+INTERCEPTOR(struct __sanitizer_protoent *, getprotobynumber, int proto) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, getprotobynumber, proto);
+  struct __sanitizer_protoent *p = REAL(getprotobynumber)(proto);
+  if (p) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_name, REAL(strlen)(p->p_name) + 1);
+
+    SIZE_T pp_size = 1; // One handles the trailing \0
+
+    for (char **pp = p->p_aliases; *pp; ++pp, ++pp_size)
+       COMMON_INTERCEPTOR_WRITE_RANGE(ctx, *pp, REAL(strlen)(*pp) + 1);
+
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_aliases,
+                                   pp_size * sizeof(char **));
+  }
+  return p;
+}
+#define INIT_PROTOENT \
+  COMMON_INTERCEPT_FUNCTION(getprotoent); \
+  COMMON_INTERCEPT_FUNCTION(getprotobyname); \
+  COMMON_INTERCEPT_FUNCTION(getprotobynumber)
+#else
+#define INIT_PROTOENT
+#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_TTYENT;
+  INIT_PROTOENT;
 
 #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_TTYENT SI_NETBSD
+#define SANITIZER_INTERCEPT_PROTOENT SI_NETBSD
 
 #endif  // #ifndef SANITIZER_PLATFORM_INTERCEPTORS_H

lib/sanitizer_common/sanitizer_platform_limits_netbsd.h

struct __sanitizer_shmid_ds {
   u32 shm_cpid;
   unsigned int shm_nattch;
   u64 shm_atime;
   u64 shm_dtime;
   u64 shm_ctime;
   void *_shm_internal;
 };
 
+struct __sanitizer_protoent {
+  char *p_name;
+  char **p_aliases;
+  int p_proto;
+};
+
 extern unsigned struct_msqid_ds_sz;
 extern unsigned struct_mq_attr_sz;
 extern unsigned struct_timex_sz;
 extern unsigned struct_statvfs_sz;
 
 struct __sanitizer_iovec {
   void *iov_base;
   uptr iov_len;

test/sanitizer_common/TestCases/NetBSD/protoent.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 = getprotoent();
+
+  printf("%s ", STRING_OR_NULL(ptp->p_name));
+
+  for (char **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 = getprotobyname("icmp");
+
+  printf("%s ", STRING_OR_NULL(ptp->p_name));
+
+  for (char **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 = getprotobynumber(1);
+
+  printf("%s ", STRING_OR_NULL(ptp->p_name));
+
+  for (char **cp = ptp->p_aliases; *cp != NULL; cp++)
+    printf("%s ", STRING_OR_NULL(*cp));
+
+  printf("%d\n", ptp->p_proto);
+  endprotoent();
+}
+
+void test4() {
+  setprotoent(1);
+  struct protoent *ptp = getprotobynumber(1);
+
+  ptp = getprotobynumber(2);
+
+  printf("%s ", STRING_OR_NULL(ptp->p_name));
+
+  for (char **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 = getprotobyname("ttp");
+
+  printf("%s ", STRING_OR_NULL(ptp->p_name));
+
+  for (char **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 HOPOPT 0
+  // CHECK: icmp ICMP 1
+  // CHECK: icmp ICMP 1
+  // CHECK: igmp IGMP 2
+  // CHECK: ttp TTP iptm IPTM 84
+
+  return 0;
+}