Add new interceptors: getttyent(3) family

[krytarowski]

Summary

getttyent, getttynam, setttyentpath - get ttys file entry

Reuse them on NetBSD.

Sponsored by <The NetBSD Foundation>

[krytarowski]

Ping?

[vitalybuka]

LGTM if you address my comments

lib/sanitizer_common/sanitizer_common_interceptors.inc

6859

struct __sanitizer_ttyent *ttyent = REAL...
here and below

6860

please no brackets here and below

6877

it does not check anything, why do you want to intercept it?
same for endttyent

7132

Could you please convert this peace into INIT_ style?
As a separate patch.
Trivial but I can't be sure that it compiles if I do it myself.

test/sanitizer_common/TestCases/NetBSD/getttyent.cc

5 ↗

(On Diff #135172)

maybe ttyent.cc is better name
same for INIT_GETTTYENT->INIT_TTYENT

[vitalybuka]

test/sanitizer_common/TestCases/NetBSD/getttyent.cc

13 ↗

(On Diff #135172)

test would be cleaner without
if (!typ) exit(1);

if it nullptr it will fail anyway at printf

45 ↗

(On Diff #135172)

Could you please combine declaration and initialization here and the rest?
struct ttyent *typ = getttyent();

[krytarowski]

lib/sanitizer_common/sanitizer_common_interceptors.inc

6877

Disable recursive interceptors.

7132

Do you mean, __libc_mutex_lock and the others bellow?

[vitalybuka]

test/sanitizer_common/TestCases/NetBSD/getttyent.cc

77 ↗

(On Diff #135172)

Maybe some checks if you print it?

[vitalybuka]

I'll make it red for consistency and promise to look again ASAP.

lib/sanitizer_common/sanitizer_platform_interceptors.h

464

Why only NETBSD?

[krytarowski]

lib/sanitizer_common/sanitizer_platform_interceptors.h

464

I can assure only NetBSD. Feel free to switch it to POSIX or other combination of OSes in a new commit.

test/sanitizer_common/TestCases/NetBSD/getttyent.cc

77 ↗

(On Diff #135172)

I was thinking about it, however this setup uses the global configuration of a system that might be (and usually is) customized. It's easier with e.g. protoent, as protocol entries aren't usually modified.

[krytarowski]

apply comments from review

[krytarowski]

• add missing changes to sanitizer_platform_limits_netbsd
• fix a typo

[krytarowski]

• drop interceptors for setttyent(3) and endttyent(3)

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

6859

unchanged

struct __sanitizer_ttyent *ttyent = REAL... here and below

6860

unchanged

please no brackets here and below

6877

I don't see how this helps.
Also you already removed such empty interceptors from other patches.

7132

Yes.

Do you mean, __libc_mutex_lock and the others bellow?

lib/sanitizer_common/sanitizer_platform_interceptors.h

464

I can assure only NetBSD. Feel free to switch it to POSIX or other combination of OSes in a new commit.

SGTM

test/sanitizer_common/TestCases/NetBSD/getttyent.cc

13 ↗

(On Diff #135172)

also unchanged

[krytarowski]

@vitalybuka I think you have reviewed an older snapshot. All the mentioned now issues are gone.

I've retested the interceptors without arguments and the code still works fine.

[vitalybuka]

Sorry. I am not sure how did this happen.

[krytarowski]

I will add test name to CHECK in the test, and commit all three tests.

lib/sanitizer_common/sanitizer_common_interceptors.inc

INTERCEPTOR(void, strmode, u32 mode, char *bp) {
   if (bp)
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, bp, REAL(strlen)(bp) + 1);
 }
 #define INIT_STRMODE COMMON_INTERCEPT_FUNCTION(strmode)
 #else
 #define INIT_STRMODE
 #endif
 
+#if SANITIZER_INTERCEPT_TTYENT
+INTERCEPTOR(struct __sanitizer_ttyent *, getttyent, void) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, getttyent);
+  struct __sanitizer_ttyent *ttyent = REAL(getttyent)();
+  if (ttyent)
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, ttyent, struct_ttyent_sz);
+  return ttyent;
+}
+INTERCEPTOR(struct __sanitizer_ttyent *, getttynam, char *name) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, getttynam, name);
+  if (name)
+    COMMON_INTERCEPTOR_READ_RANGE(ctx, name, REAL(strlen)(name) + 1);
+  struct __sanitizer_ttyent *ttyent = REAL(getttynam)(name);
+  if (ttyent)
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, ttyent, struct_ttyent_sz);
+  return ttyent;
+}
+INTERCEPTOR(int, setttyent) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, setttyent);
+  return REAL(setttyent)();
+}
+INTERCEPTOR(int, setttyentpath, char *path) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, setttyentpath, path);
+  if (path)
+    COMMON_INTERCEPTOR_READ_RANGE(ctx, path, REAL(strlen)(path) + 1);
+  return REAL(setttyentpath)(path);
+}
+INTERCEPTOR(int, endttyent) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, endttyent);
+  return REAL(endttyent)();
+}
+#define INIT_TTYENT \
+  COMMON_INTERCEPT_FUNCTION(getttyent); \
+  COMMON_INTERCEPT_FUNCTION(getttynam); \
+  COMMON_INTERCEPT_FUNCTION(setttyent); \
+  COMMON_INTERCEPT_FUNCTION(setttyentpath); \
+  COMMON_INTERCEPT_FUNCTION(endttyent)
+#else
+#define INIT_TTYENT
+#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_READLINKAT;
   INIT_NAME_TO_HANDLE_AT;
   INIT_OPEN_BY_HANDLE_AT;
   INIT_STRLCPY;
   INIT_DEVNAME;
   INIT_DEVNAME_R;
   INIT_FGETLN;
   INIT_STRMODE;
+  INIT_TTYENT;
 
 #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

 #endif
 #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
 
 #endif  // #ifndef SANITIZER_PLATFORM_INTERCEPTORS_H

lib/sanitizer_common/sanitizer_platform_limits_netbsd.h

struct __sanitizer_glob_t {
   int (*gl_stat)(const char *, void * /* struct stat* */);
 };
 
 extern int glob_nomatch;
 extern int glob_altdirfunc;
 
 extern unsigned path_max;
 
+extern int struct_ttyent_sz;
+
 extern int ptrace_pt_io;
 extern int ptrace_pt_lwpinfo;
 extern int ptrace_pt_set_event_mask;
 extern int ptrace_pt_get_event_mask;
 extern int ptrace_pt_get_process_state;
 extern int ptrace_pt_set_siginfo;
 extern int ptrace_pt_get_siginfo;
 extern int ptrace_pt_set_sigmask;

 // 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_class;
+};
+
 #define IOC_NRBITS 8
 #define IOC_TYPEBITS 8
 #define IOC_SIZEBITS 14
 #define IOC_DIRBITS 2
 #define IOC_NONE 0U
 #define IOC_WRITE 1U
 #define IOC_READ 2U
 #define IOC_NRMASK ((1 << IOC_NRBITS) - 1)

lib/sanitizer_common/sanitizer_platform_limits_netbsd.cc

 #include <sys/timespec.h>
 #include <sys/timex.h>
 #include <sys/types.h>
 #include <sys/ucontext.h>
 #include <sys/utsname.h>
 #include <term.h>
 #include <termios.h>
 #include <time.h>
+#include <ttyent.h>
 #include <utime.h>
 #include <utmp.h>
 #include <utmpx.h>
 #include <wchar.h>
 #include <wordexp.h>
 
 // Include these after system headers to avoid name clashes and ambiguities.
 #include "sanitizer_internal_defs.h"

 
 unsigned struct_ElfW_Phdr_sz = sizeof(Elf_Phdr);
 
 int glob_nomatch = GLOB_NOMATCH;
 int glob_altdirfunc = GLOB_ALTDIRFUNC;
 
 unsigned path_max = PATH_MAX;
 
+int struct_ttyent_sz = sizeof(struct ttyent);
+
 // ioctl arguments
 unsigned struct_altqreq_sz = sizeof(altqreq);
 unsigned struct_amr_user_ioctl_sz = sizeof(amr_user_ioctl);
 unsigned struct_ap_control_sz = sizeof(ap_control);
 unsigned struct_apm_ctl_sz = sizeof(apm_ctl);
 unsigned struct_apm_event_info_sz = sizeof(apm_event_info);
 unsigned struct_apm_power_info_sz = sizeof(apm_power_info);
 unsigned struct_atabusiodetach_args_sz = sizeof(atabusiodetach_args);

test/sanitizer_common/TestCases/NetBSD/ttyent.cc

+// RUN: %clangxx -O0 -g %s -o %t && %run %t
+
+#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) {
+  test1();
+  test2();
+  test3();
+  test4();
+
+  return 0;
+}