Add a new interceptors for statvfs1(2) and fstatvfs1(2) from NetBSD

[krytarowski]

Summary

statvfs1, fstatvfs1 - get file system statistics.

While there, use file descriptor related macros in the fstatvfs interceptor.

Add a dedicated test.

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

7368

cc @dvyukov
Looks like tsan wants these :

COMMON_INTERCEPTOR_FD_ACCESS(ctx, fd);
if (fd >= 0) COMMON_INTERCEPTOR_FD_RELEASE(ctx, fd);
....
if (res >= 0 && fd >= 0) COMMON_INTERCEPTOR_FD_ACQUIRE(ctx, fd);

[krytarowski]

• apply comment from review

[krytarowski]

• align style

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

4280

Please check RAW DIFF https://reviews.llvm.org/file/data/x5p222jqqe67lsydfoh3/PHID-FILE-dwwqavhtcbz2oecylp4j/D55031.diff
This DIFF has wrong BASE again.

test/sanitizer_common/TestCases/NetBSD/statvfs1.cc

46

test_statvfs1
test_fstatvfs1

[krytarowski]

lib/sanitizer_common/sanitizer_common_interceptors.inc

4280

This looks correct. statvfs/fstatvfs are existing interceptors.

[vitalybuka]

lib/sanitizer_common/sanitizer_common_interceptors.inc

4280

I see, you just updated similar existing one as well.

[krytarowski]

lib/sanitizer_common/sanitizer_common_interceptors.inc

4280

Yes. It was documented in the description.

lib/sanitizer_common/sanitizer_common_interceptors.inc

INTERCEPTOR(int, statvfs, char *path, void *buf) {
   // https://github.com/google/sanitizers/issues/321.
   int res = REAL(statvfs)(path, buf);
   if (!res) COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, struct_statvfs_sz);
   return res;
 }
 INTERCEPTOR(int, fstatvfs, int fd, void *buf) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, fstatvfs, fd, buf);
+  COMMON_INTERCEPTOR_FD_ACCESS(ctx, fd);
   // FIXME: under ASan the call below may write to freed memory and corrupt
   // its metadata. See
   // https://github.com/google/sanitizers/issues/321.
   int res = REAL(fstatvfs)(fd, buf);
-  if (!res) COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, struct_statvfs_sz);
+  if (!res) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, struct_statvfs_sz);
+    if (fd >= 0)
+      COMMON_INTERCEPTOR_FD_ACQUIRE(ctx, fd);
+  }
   return res;
 }
 #define INIT_STATVFS                  \
   COMMON_INTERCEPT_FUNCTION(statvfs); \
   COMMON_INTERCEPT_FUNCTION(fstatvfs);
 #else
 #define INIT_STATVFS
 #endif
#define INIT_SETVBUF COMMON_INTERCEPT_FUNCTION(setvbuf); \
     COMMON_INTERCEPT_FUNCTION(setlinebuf)
 #else
 #define INIT_SETVBUF
 #endif
 
 #if SANITIZER_INTERCEPT_GETVFSSTAT
 INTERCEPTOR(int, getvfsstat, void *buf, SIZE_T bufsize, int flags) {
   void *ctx;
   COMMON_INTERCEPTOR_ENTER(ctx, getvfsstat, buf, bufsize, flags);
   int ret = REAL(getvfsstat)(buf, bufsize, flags);
   if (buf && ret > 0)
     COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, ret * struct_statvfs_sz);
   return ret;
 }
 #define INIT_GETVFSSTAT COMMON_INTERCEPT_FUNCTION(getvfsstat)
 #else
 #define INIT_GETVFSSTAT
INTERCEPTOR(char *, fparseln, __sanitizer_FILE *stream, SIZE_T *len,
   }
   return ret;
 }
 #define INIT_FPARSELN COMMON_INTERCEPT_FUNCTION(fparseln)
 #else
 #define INIT_FPARSELN
 #endif
 
+#if SANITIZER_INTERCEPT_STATVFS1
+INTERCEPTOR(int, statvfs1, const char *path, void *buf, int flags) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, statvfs1, path, buf, flags);
+  if (path) COMMON_INTERCEPTOR_READ_RANGE(ctx, path, REAL(strlen)(path) + 1);
+  int res = REAL(statvfs1)(path, buf, flags);
+  if (!res) COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, struct_statvfs_sz);
+  return res;
+}
+INTERCEPTOR(int, fstatvfs1, int fd, void *buf, int flags) {
+  void *ctx;
+  COMMON_INTERCEPTOR_ENTER(ctx, fstatvfs1, fd, buf, flags);
+  COMMON_INTERCEPTOR_FD_ACCESS(ctx, fd);
+  int res = REAL(fstatvfs1)(fd, buf, flags);
+  if (!res) {
+    COMMON_INTERCEPTOR_WRITE_RANGE(ctx, buf, struct_statvfs_sz);
+    if (fd >= 0)
+      COMMON_INTERCEPTOR_FD_ACQUIRE(ctx, fd);
+  }
+  return res;
+}
+#define INIT_STATVFS1                  \
+  COMMON_INTERCEPT_FUNCTION(statvfs1);  \
+  COMMON_INTERCEPT_FUNCTION(fstatvfs1);
+#else
+#define INIT_STATVFS1
+#endif
+
 static void InitializeCommonInterceptors() {
   static u64 metadata_mem[sizeof(MetadataHashMap) / sizeof(u64) + 1];
   interceptor_metadata_map = new((void *)&metadata_mem) MetadataHashMap();
 
   INIT_MMAP;
   INIT_MMAP64;
   INIT_TEXTDOMAIN;
   INIT_STRLEN;
static void InitializeCommonInterceptors() {
   INIT_FTS;
   INIT_SYSCTL;
   INIT_ASYSCTL;
   INIT_SYSCTLGETMIBINFO;
   INIT_NL_LANGINFO;
   INIT_MODCTL;
   INIT_STRTONUM;
   INIT_FPARSELN;
+  INIT_STATVFS1;
 
   INIT___PRINTF_CHK;
 }

lib/sanitizer_common/sanitizer_platform_interceptors.h

 #define SANITIZER_INTERCEPT_FTS SI_NETBSD
 #define SANITIZER_INTERCEPT_SYSCTL (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_ASYSCTL SI_NETBSD
 #define SANITIZER_INTERCEPT_SYSCTLGETMIBINFO SI_NETBSD
 #define SANITIZER_INTERCEPT_NL_LANGINFO (SI_NETBSD || SI_FREEBSD)
 #define SANITIZER_INTERCEPT_MODCTL SI_NETBSD
 #define SANITIZER_INTERCEPT_STRTONUM SI_NETBSD
 #define SANITIZER_INTERCEPT_FPARSELN SI_NETBSD
+#define SANITIZER_INTERCEPT_STATVFS1 SI_NETBSD
 
 #endif  // #ifndef SANITIZER_PLATFORM_INTERCEPTORS_H

test/sanitizer_common/TestCases/NetBSD/statvfs1.cc

+// RUN: %clangxx -O0 -g %s -o %t && %run %t 2>&1 | FileCheck %s
+
+#include <sys/param.h>
+#include <sys/types.h>
+
+#include <sys/statvfs.h>
+
+#include <assert.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+
+void test_statvfs1() {
+  printf("statvfs1\n");
+
+  struct statvfs buf;
+  int rv = statvfs1("/etc/fstab", &buf, ST_WAIT);
+  assert(rv != -1);
+
+  printf("fstypename='%s'\n", buf.f_fstypename);
+  printf("mntonname='%s'\n", buf.f_mntonname);
+  printf("mntfromname='%s'\n", buf.f_mntfromname);
+}
+
+void test_fstatvfs1() {
+  printf("fstatvfs1\n");
+
+  int fd = open("/etc/fstab", O_RDONLY);
+  assert(fd > 0);
+
+  struct statvfs buf;
+  int rv = fstatvfs1(fd, &buf, ST_WAIT);
+  assert(rv != -1);
+
+  printf("fstypename='%s'\n", buf.f_fstypename);
+  printf("mntonname='%s'\n", buf.f_mntonname);
+  printf("mntfromname='%s'\n", buf.f_mntfromname);
+
+  rv = close(fd);
+  assert(rv != -1);
+}
+
+int main(void) {
+  test_statvfs1();
+  test_fstatvfs1();
+
+  // CHECK: statvfs1
+  // CHECK: fstypename='{{.*}}'
+  // CHECK: mntonname='{{.*}}'
+  // CHECK: mntfromname='{{.*}}'
+  // CHECK: fstatvfs1
+  // CHECK: fstypename='{{.*}}'
+  // CHECK: mntonname='{{.*}}'
+  // CHECK: mntfromname='{{.*}}'
+
+  return 0;
+}