[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

25–32

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

37–57 ↗

(On Diff #374289)

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

37–57 ↗

(On Diff #374289)

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 ↗

(On Diff #374718)

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

   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;
 }
+
+#if SANITIZER_NETBSD
 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)
 #else
+#define INIT_TTYENT \
+  COMMON_INTERCEPT_FUNCTION(getttyent); \
+  COMMON_INTERCEPT_FUNCTION(getttynam);
+#endif
+#else
 #define INIT_TTYENT
 #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_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

 //
 // Sizes and layouts of platform-specific FreeBSD data structures.
 //===----------------------------------------------------------------------===//
 
 #include "sanitizer_platform.h"
 
 #if SANITIZER_FREEBSD
 
-#include <sys/capsicum.h>
-#include <sys/consio.h>
-#include <sys/filio.h>
-#include <sys/ipc.h>
-#include <sys/kbio.h>
-#include <sys/link_elf.h>
-#include <sys/mman.h>
-#include <sys/mount.h>
-#include <sys/mqueue.h>
-#include <sys/msg.h>
-#include <sys/mtio.h>
-#include <sys/ptrace.h>
-#include <sys/resource.h>
-#include <sys/signal.h>
-#include <sys/socket.h>
-#include <sys/sockio.h>
-#include <sys/soundcard.h>
-#include <sys/stat.h>
-#include <sys/statvfs.h>
-#include <sys/time.h>
-#pragma clang diagnostic push
-#pragma clang diagnostic ignored "-W#warnings"
-#include <sys/timeb.h>
-#pragma clang diagnostic pop
-#include <sys/times.h>
-#include <sys/timespec.h>
-#include <sys/types.h>
-#include <sys/ucontext.h>
-#include <sys/utsname.h>
+#  include <sys/capsicum.h>
+#  include <sys/consio.h>
+#  include <sys/filio.h>
+#  include <sys/ipc.h>
+#  include <sys/kbio.h>
+#  include <sys/link_elf.h>
+#  include <sys/mman.h>
+#  include <sys/mount.h>
+#  include <sys/mqueue.h>
+#  include <sys/msg.h>
+#  include <sys/mtio.h>
+#  include <sys/ptrace.h>
+#  include <sys/resource.h>
+#  include <sys/signal.h>
+#  include <sys/socket.h>
+#  include <sys/sockio.h>
+#  include <sys/soundcard.h>
+#  include <sys/stat.h>
+#  include <sys/statvfs.h>
+#  include <sys/time.h>
+#  pragma clang diagnostic push
+#  pragma clang diagnostic ignored "-W#warnings"
+#  include <sys/timeb.h>
+#  pragma clang diagnostic pop
+#  include <sys/times.h>
+#  include <sys/timespec.h>
+#  include <sys/types.h>
+#  include <sys/ucontext.h>
+#  include <sys/utsname.h>
 //
-#include <arpa/inet.h>
-#include <net/ethernet.h>
-#include <net/if.h>
-#include <net/ppp_defs.h>
-#include <net/route.h>
-#include <netdb.h>
-#include <netinet/in.h>
-#include <netinet/ip_mroute.h>
+#  include <arpa/inet.h>
+#  include <net/ethernet.h>
+#  include <net/if.h>
+#  include <net/ppp_defs.h>
+#  include <net/route.h>
+#  include <netdb.h>
+#  include <netinet/in.h>
+#  include <netinet/ip_mroute.h>
 //
-#include <dirent.h>
-#include <dlfcn.h>
-#include <fstab.h>
-#include <fts.h>
-#include <glob.h>
-#include <grp.h>
-#include <ifaddrs.h>
-#include <limits.h>
-#include <poll.h>
-#include <pthread.h>
-#include <pwd.h>
-#include <regex.h>
-#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 <utime.h>
-#include <utmpx.h>
-#include <vis.h>
-#include <wchar.h>
-#include <wordexp.h>
+#  include <dirent.h>
+#  include <dlfcn.h>
+#  include <fstab.h>
+#  include <fts.h>
+#  include <glob.h>
+#  include <grp.h>
+#  include <ifaddrs.h>
+#  include <limits.h>
+#  include <poll.h>
+#  include <pthread.h>
+#  include <pwd.h>
+#  include <regex.h>
+#  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>
-#undef _KERNEL
+#  define _KERNEL  // to declare 'shminfo' structure
+#  include <sys/shm.h>
+#  undef _KERNEL
 
-#undef IOC_DIRMASK
+#  undef IOC_DIRMASK
 
 // Include these after system headers to avoid name clashes and ambiguities.
-#include "sanitizer_internal_defs.h"
-#include "sanitizer_libc.h"
-#include "sanitizer_platform_limits_freebsd.h"
+#  include "sanitizer_internal_defs.h"
+#  include "sanitizer_libc.h"
+#  include "sanitizer_platform_limits_freebsd.h"
 
 namespace __sanitizer {
 void *__sanitizer_get_link_map_by_dlopen_handle(void *handle) {
   void *p = nullptr;
   return internal_dlinfo(handle, RTLD_DI_LINKMAP, &p) == 0 ? p : nullptr;
 }
 
 unsigned struct_cap_rights_sz = sizeof(cap_rights_t);

 
 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
+#  if SOUND_VERSION >= 0x040000
 unsigned struct_copr_buffer_sz = 0;
 unsigned struct_copr_debug_buf_sz = 0;
 unsigned struct_copr_msg_sz = 0;
-#else
+#  else
 unsigned struct_copr_buffer_sz = sizeof(struct copr_buffer);
 unsigned struct_copr_debug_buf_sz = sizeof(struct copr_debug_buf);
 unsigned struct_copr_msg_sz = sizeof(struct copr_msg);
-#endif
+#  endif
 unsigned struct_midi_info_sz = sizeof(struct midi_info);
 unsigned struct_mtget_sz = sizeof(struct mtget);
 unsigned struct_mtop_sz = sizeof(struct mtop);
 unsigned struct_sbi_instrument_sz = sizeof(struct sbi_instrument);
 unsigned struct_seq_event_rec_sz = sizeof(struct seq_event_rec);
 unsigned struct_synth_info_sz = sizeof(struct synth_info);
 unsigned struct_audio_buf_info_sz = sizeof(struct audio_buf_info);
 unsigned struct_ppp_stats_sz = sizeof(struct ppp_stats);

 
 CHECK_TYPE_SIZE(clock_t);
 
 CHECK_TYPE_SIZE(ifaddrs);
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_next);
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_name);
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_addr);
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_netmask);
-#undef ifa_dstaddr
+#  undef ifa_dstaddr
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_dstaddr);
 CHECK_SIZE_AND_OFFSET(ifaddrs, ifa_data);
 
 CHECK_TYPE_SIZE(timeb);
 CHECK_SIZE_AND_OFFSET(timeb, time);
 CHECK_SIZE_AND_OFFSET(timeb, millitm);
 CHECK_SIZE_AND_OFFSET(timeb, timezone);
 CHECK_SIZE_AND_OFFSET(timeb, dstflag);

 CHECK_SIZE_AND_OFFSET(passwd, pw_gecos);
 
 CHECK_TYPE_SIZE(group);
 CHECK_SIZE_AND_OFFSET(group, gr_name);
 CHECK_SIZE_AND_OFFSET(group, gr_passwd);
 CHECK_SIZE_AND_OFFSET(group, gr_gid);
 CHECK_SIZE_AND_OFFSET(group, gr_mem);
 
-#if HAVE_RPC_XDR_H
+#  if HAVE_RPC_XDR_H
 CHECK_TYPE_SIZE(XDR);
 CHECK_SIZE_AND_OFFSET(XDR, x_op);
 CHECK_SIZE_AND_OFFSET(XDR, x_ops);
 CHECK_SIZE_AND_OFFSET(XDR, x_public);
 CHECK_SIZE_AND_OFFSET(XDR, x_private);
 CHECK_SIZE_AND_OFFSET(XDR, x_base);
 CHECK_SIZE_AND_OFFSET(XDR, x_handy);
 COMPILER_CHECK(__sanitizer_XDR_ENCODE == XDR_ENCODE);
 COMPILER_CHECK(__sanitizer_XDR_DECODE == XDR_DECODE);
 COMPILER_CHECK(__sanitizer_XDR_FREE == XDR_FREE);
-#endif
+#  endif
 
 CHECK_TYPE_SIZE(sem_t);
 
 COMPILER_CHECK(sizeof(__sanitizer_cap_rights_t) >= sizeof(cap_rights_t));
 #endif  // SANITIZER_FREEBSD

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

+// RUN: %clangxx -O0 -g %s -o %t
+
+#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);
+  assert(typ->ty_group != nullptr);
+  endttyent();
+}
+
+void test2() {
+  struct ttyent *typ = getttynam("console");
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  assert(typ->ty_group != nullptr);
+  endttyent();
+}
+
+void test3() {
+  if (!setttyent())
+    exit(1);
+
+  struct ttyent *typ = getttyent();
+  assert(typ && typ->ty_name != nullptr);
+  assert(typ->ty_type != nullptr);
+  assert(typ->ty_group != nullptr);
+  endttyent();
+}
+
+int main(void) {
+  test1();
+  test2();
+  test3();
+
+  return 0;
+}