[Sanitizers] intercept ttyent api on FreeBSD

[vitalybuka]

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

7558

More consistent solution is to introduce
SANITIZER_INTERCEPT_SETTTYENTPATH

Actually this part disables setttyentpath on anything but FreeBSD. Is this intentional?

compiler-rt/test/sanitizer_common/TestCases/FreeBSD/ttyent.cpp

24–31 ↗

(On Diff #373272)

can you please extract freebsd specific part into a separate file and move common stuff into Posix or Linux?

[devnexen]

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

7558

yes it is intentional this subpart is unsupported but ok about the new flag

[krytarowski]

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

7558

Please keep it enabled in NetBSD.

[devnexen]

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

7558

It s enabled with a separated flag

[vitalybuka]

compiler-rt/test/sanitizer_common/TestCases/Linux/ttyent.cpp

38–58

Can this be like:

void test4() {
#if defined(__NetBSD__)
  if (!setttyentpath(_PATH_TTYS))
    exit(1);
#else
  return;
#endif

  struct ttyent *typ = getttyent();
  assert(typ && typ->ty_name != nullptr);
  assert(typ->ty_type != nullptr);
  assert(typ->ty_class != nullptr);

  endttyent();
}

int main(void) {
  test1();
  test2();
  test3();
  test4();

[devnexen]

compiler-rt/test/sanitizer_common/TestCases/Linux/ttyent.cpp

38–58

unfortunately I would have to ifdef the last member check which is netbsd specific.

[MaskRay]

compiler-rt/test/sanitizer_common/TestCases/Linux/ttyent.cpp

3

Since sanitizer_common/TestCases/Linux/lit.local.cfg.py has if root.host_os not in ["Linux"]:, the test will not run on FreeBSD/NetBSD.

compiler-rt/lib/sanitizer_common/sanitizer_common_interceptors.inc

INTERCEPTOR(struct __sanitizer_ttyent *, getttynam, char *name) {
   COMMON_INTERCEPTOR_ENTER(ctx, getttynam, name);
   if (name)
     COMMON_INTERCEPTOR_READ_RANGE(ctx, name, internal_strlen(name) + 1);
   struct __sanitizer_ttyent *ttyent = REAL(getttynam)(name);
   if (ttyent)
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, ttyent, struct_ttyent_sz);
   return ttyent;
 }
+#define INIT_TTYENT \
+  COMMON_INTERCEPT_FUNCTION(getttyent); \
+  COMMON_INTERCEPT_FUNCTION(getttynam);
+#else
+#define INIT_TTYENT
+#endif
+
+#if SANITIZER_INTERCEPT_TTYENTPATH
 INTERCEPTOR(int, setttyentpath, char *path) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, setttyentpath, path);
   if (path)
     COMMON_INTERCEPTOR_READ_RANGE(ctx, path, internal_strlen(path) + 1);
   return REAL(setttyentpath)(path);
 }
-#define INIT_TTYENT \
-  COMMON_INTERCEPT_FUNCTION(getttyent); \
-  COMMON_INTERCEPT_FUNCTION(getttynam); \
-  COMMON_INTERCEPT_FUNCTION(setttyentpath)
+#define INIT_TTYENTPATH COMMON_INTERCEPT_FUNCTION(setttyentpath);
 #else
-#define INIT_TTYENT
+#define INIT_TTYENTPATH
 #endif
 
 #if SANITIZER_INTERCEPT_PROTOENT
 static void write_protoent(void *ctx, struct __sanitizer_protoent *p) {
   COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p, sizeof(*p));
 
   COMMON_INTERCEPTOR_WRITE_RANGE(ctx, p->p_name, internal_strlen(p->p_name) + 1);
 

compiler-rt/lib/sanitizer_common/sanitizer_platform_interceptors.h

 #endif
 #define SANITIZER_INTERCEPT_READLINKAT \
   (SI_POSIX && !SI_MAC_DEPLOYMENT_BELOW_10_10)
 
 #define SANITIZER_INTERCEPT_DEVNAME (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_DEVNAME_R (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_FGETLN (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_STRMODE (SI_NETBSD || SI_FREEBSD)
-#define SANITIZER_INTERCEPT_TTYENT SI_NETBSD
+#define SANITIZER_INTERCEPT_TTYENT (SI_NETBSD || SI_FREEBSD)
+#define SANITIZER_INTERCEPT_TTYENTPATH SI_NETBSD
 #define SANITIZER_INTERCEPT_PROTOENT (SI_LINUX || SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_PROTOENT_R SI_GLIBC
 #define SANITIZER_INTERCEPT_NETENT (SI_LINUX || SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_SETVBUF \
   (SI_NETBSD || SI_FREEBSD || SI_LINUX || SI_MAC)
 #define SANITIZER_INTERCEPT_GETMNTINFO (SI_NETBSD || SI_FREEBSD || SI_MAC)
 #define SANITIZER_INTERCEPT_MI_VECTOR_HASH SI_NETBSD
 #define SANITIZER_INTERCEPT_GETVFSSTAT SI_NETBSD

compiler-rt/lib/sanitizer_common/sanitizer_platform_limits_freebsd.h

 };
 
 extern int glob_nomatch;
 extern int glob_altdirfunc;
 extern const int wordexp_wrde_dooffs;
 
 extern unsigned path_max;
 
+extern int struct_ttyent_sz;
+
 struct __sanitizer_wordexp_t {
   uptr we_wordc;
   char **we_wordv;
   uptr we_offs;
   char *we_strings;
   uptr we_nbytes;
 };
 

 // ioctl arguments
 struct __sanitizer_ifconf {
   int ifc_len;
   union {
     void *ifcu_req;
   } ifc_ifcu;
 };
 
+struct __sanitizer__ttyent {
+  char *ty_name;
+  char *ty_getty;
+  char *ty_type;
+  int ty_status;
+  char *ty_window;
+  char *ty_comment;
+  char *ty_group;
+};
+
 #  define IOC_NRBITS 8
 #  define IOC_TYPEBITS 8
 #  if defined(__powerpc__) || defined(__powerpc64__) || defined(__mips__)
 #    define IOC_SIZEBITS 13
 #    define IOC_DIRBITS 3
 #    define IOC_NONE 1U
 #    define IOC_WRITE 4U
 #    define IOC_READ 2U

compiler-rt/lib/sanitizer_common/sanitizer_platform_limits_freebsd.cpp

 #include <semaphore.h>
 #include <signal.h>
 #include <stddef.h>
 #include <stdio.h>
 #include <stringlist.h>
 #include <term.h>
 #include <termios.h>
 #include <time.h>
+#include <ttyent.h>
 #include <utime.h>
 #include <utmpx.h>
 #include <vis.h>
 #include <wchar.h>
 #include <wordexp.h>
 
 #define _KERNEL  // to declare 'shminfo' structure
 #include <sys/shm.h>

 
 unsigned struct_ElfW_Phdr_sz = sizeof(Elf_Phdr);
 int glob_nomatch = GLOB_NOMATCH;
 int glob_altdirfunc = GLOB_ALTDIRFUNC;
 const int wordexp_wrde_dooffs = WRDE_DOOFFS;
 
 unsigned path_max = PATH_MAX;
 
+int struct_ttyent_sz = sizeof(struct ttyent);
+
 // ioctl arguments
 unsigned struct_ifreq_sz = sizeof(struct ifreq);
 unsigned struct_termios_sz = sizeof(struct termios);
 unsigned struct_winsize_sz = sizeof(struct winsize);
 #if SOUND_VERSION >= 0x040000
 unsigned struct_copr_buffer_sz = 0;
 unsigned struct_copr_debug_buf_sz = 0;
 unsigned struct_copr_msg_sz = 0;

compiler-rt/test/sanitizer_common/TestCases/Linux/ttyent.cpp

+// RUN: %clangxx -O0 -g %s -o %t
+//
+// REQUIRES: freebsd, netbsd
+
+#include <assert.h>
+#include <stdlib.h>
+#include <ttyent.h>
+
+#include <assert.h>
+#include <stdlib.h>
+#include <ttyent.h>
+
+void test1() {
+  struct ttyent *typ = getttyent();
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  endttyent();
+}
+
+void test2() {
+  struct ttyent *typ = getttynam("console");
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  endttyent();
+}
+
+void test3() {
+  if (!setttyent())
+    exit(1);
+
+  struct ttyent *typ = getttyent();
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  endttyent();
+}
+
+#if defined(__NetBSD__)
+void test4() {
+  if (!setttyentpath(_PATH_TTYS))
+    exit(1);
+
+  struct ttyent *typ = getttyent();
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  assert(typ->ty_class != nullptr);
+
+  endttyent();
+}
+#endif
+
+int main(void) {
+  test1();
+  test2();
+  test3();
+#if defined(__NetBSD__)
+  test4();
+#endif
+
+  return 0;
+}

compiler-rt/test/sanitizer_common/TestCases/NetBSD/ttyent.cpp

-// RUN: %clangxx -O0 -g %s -o %t && %run %t 2>&1 | FileCheck %s
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <ttyent.h>
-
-#define STRING_OR_NULL(x) ((x) ? (x) : "null")
-
-void test1() {
-  struct ttyent *typ = getttyent();
-
-  printf("%s %s %s %d %s %s %s\n", STRING_OR_NULL(typ->ty_name),
-         STRING_OR_NULL(typ->ty_getty), STRING_OR_NULL(typ->ty_type),
-         typ->ty_status, STRING_OR_NULL(typ->ty_window),
-         STRING_OR_NULL(typ->ty_comment), STRING_OR_NULL(typ->ty_class));
-
-  endttyent();
-}
-
-void test2() {
-  struct ttyent *typ = getttynam("console");
-
-  printf("%s %s %s %d %s %s %s\n", STRING_OR_NULL(typ->ty_name),
-         STRING_OR_NULL(typ->ty_getty), STRING_OR_NULL(typ->ty_type),
-         typ->ty_status, STRING_OR_NULL(typ->ty_window),
-         STRING_OR_NULL(typ->ty_comment), STRING_OR_NULL(typ->ty_class));
-
-  endttyent();
-}
-
-void test3() {
-  if (!setttyent())
-    exit(1);
-
-  struct ttyent *typ = getttyent();
-
-  printf("%s %s %s %d %s %s %s\n", STRING_OR_NULL(typ->ty_name),
-         STRING_OR_NULL(typ->ty_getty), STRING_OR_NULL(typ->ty_type),
-         typ->ty_status, STRING_OR_NULL(typ->ty_window),
-         STRING_OR_NULL(typ->ty_comment), STRING_OR_NULL(typ->ty_class));
-
-  endttyent();
-}
-
-void test4() {
-  if (!setttyentpath(_PATH_TTYS))
-    exit(1);
-
-  struct ttyent *typ = getttyent();
-
-  printf("%s %s %s %d %s %s %s\n", STRING_OR_NULL(typ->ty_name),
-         STRING_OR_NULL(typ->ty_getty), STRING_OR_NULL(typ->ty_type),
-         typ->ty_status, STRING_OR_NULL(typ->ty_window),
-         STRING_OR_NULL(typ->ty_comment), STRING_OR_NULL(typ->ty_class));
-
-  endttyent();
-}
-
-int main(void) {
-  printf("ttyent\n");
-
-  test1();
-  test2();
-  test3();
-  test4();
-
-  // CHECK: ttyent
-
-  return 0;
-}