Fix DynamicLibraryTest.cpp on FreeBSD

[dim]

Summary

After rL301562, on FreeBSD the following unittest failures are being reported:

******************** TEST 'LLVM-Unit :: Support/DynamicLibrary/DynamicLibraryTests/DynamicLibrary.Shutdown' FAILED ********************
Note: Google Test filter = DynamicLibrary.Shutdown
[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from DynamicLibrary
[ RUN      ] DynamicLibrary.Shutdown
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:107: Failure
Value of: DL.isValid()
  Actual: false
Expected: true
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:108: Failure
Value of: Err.empty()
  Actual: false
Expected: true
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:112: Failure
Value of: SS != nullptr
  Actual: false
Expected: true

******************** TEST 'LLVM-Unit :: Support/DynamicLibrary/DynamicLibraryTests/DynamicLibrary.Overload' FAILED ********************
Note: Google Test filter = DynamicLibrary.Overload
[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from DynamicLibrary
[ RUN      ] DynamicLibrary.Overload
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:65: Failure
Value of: DL.isValid()
  Actual: false
Expected: true
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:66: Failure
Value of: Err.empty()
  Actual: false
Expected: true
/share/dim/src/llvm/trunk/unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp:69: Failure
Value of: GS != nullptr && GS != &TestA
  Actual: false
Expected: true

This is because the test uses getMainExecutable("DynamicLibraryTests", Ptr);, and since the path does not contain any slashes, retrieving the main executable will not work.

I chose to reimplement getMainExecutable() for FreeBSD using sysctl(3), which is more reliable than fiddling with relative or absolute paths.

However, this approach might not fix any failures for other OSes. So I also added retrieval of the original argv[] from the GoogleTest framework, to use as a fallback.

I also thought that the final fallback name might be "./DynamicLibraryTests", but that will not work on Windows. Is this test run on Windows at all?

[krytarowski]

lib/Support/Unix/Path.inc

80

|| defined ( __NetBSD__)

117

drop defined (__NetBSD__)

170

drop NetBSD ||

186–203

|| defined(__NetBSD__)

188

#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 mib[0] = CTL_KERN;
  mib[1] = KERN_PROC;
  mib[2] = KERN_PROC_PATHNAME;
  mib[3] = -1;
#else
 mib[0] = CTL_KERN;
  mib[1] = KERN_PROC_ARGS;
  mib[2] = -1;
  mib[3] = KERN_PROC_PATHNAME;
#endif

196

drop defined (__NetBSD__)

[dim]

lib/Support/Unix/Path.inc

188

Ah, I wasn't aware that NetBSD already supported KERN_PROC_PATHNAME. I downloaded NetBSD 7.1, and couldn't find the define in sys/sysctl.h, but I see it has been added recently.

[krytarowski]

lib/Support/Unix/Path.inc

188

It was added after the -7 branch a year ago or so. In my opinion no point to support here in upstream sources fallback, better to handle it downstream. By the time of 5.0.0 release we might have 8.0 out (and almost surely branched).

[krytarowski]

lib/Support/Unix/Path.inc

186–203

(defined (NetBSD) && defined(KERN_PROC_PATHNAME))

188

However the fallback isn't that difficult, I will propose a code for it.

[dim]

• Move sys/sysctl.h include to a separate block, specifically for (Free|Net)BSD
• Remove NetBSD from several #if statements
• Use correct mib for NetBSD to retrieve process pathname

lib/Support/Unix/Path.inc

 #include <sys/statvfs.h>
 #define STATVFS statvfs
 #define FSTATVFS fstatvfs
 #define STATVFS_F_FRSIZE(vfs) vfs.f_frsize
 #else
 #if defined(__OpenBSD__) || defined(__FreeBSD__)
 #include <sys/param.h>
 #include <sys/mount.h>
 #elif defined(__linux__)
 #if defined(HAVE_LINUX_MAGIC_H)
 #include <linux/magic.h>
 #else
 #if defined(HAVE_LINUX_NFS_FS_H)
 #include <linux/nfs_fs.h>
 #endif
 #if defined(HAVE_LINUX_SMB_H)
 #include <linux/smb.h>

 #endif
 
 #if defined(__NetBSD__)
 #define STATVFS_F_FLAG(vfs) (vfs).f_flag
 #else
 #define STATVFS_F_FLAG(vfs) (vfs).f_flags
 #endif
 
+#if defined(__FreeBSD__) || defined(__NetBSD__)
+#include <sys/sysctl.h>
+#endif
+
 using namespace llvm;
 
 namespace llvm {
 namespace sys  {
 namespace fs {
-#if defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
-    defined(__OpenBSD__) || defined(__minix) || defined(__FreeBSD_kernel__) || \
+#if defined(__Bitrig__) || defined(__OpenBSD__) || defined(__minix) || \
     defined(__linux__) || defined(__CYGWIN__) || defined(__DragonFly__) || \
     defined(_AIX)
 static int
 test_dir(char ret[PATH_MAX], const char *dir, const char *bin)
 {
   struct stat sb;
   char fullpath[PATH_MAX];
 
   snprintf(fullpath, PATH_MAX, "%s/%s", dir, bin);
   if (!realpath(fullpath, ret))
while ((t = strsep(&s, ":")) != nullptr) {
     if (test_dir(ret, t, bin) == 0) {
       free(pv);
       return ret;
     }
   }
   free(pv);
   return nullptr;
 }
-#endif // __FreeBSD__ || __NetBSD__ || __FreeBSD_kernel__
+#endif // Bitrig || OpenBSD || minix || linux || CYGWIN || DragonFly || AIX
 
 /// GetMainExecutable - Return the path to the main executable, given the
 /// value of argv[0] from program startup.
 std::string getMainExecutable(const char *argv0, void *MainAddr) {
 #if defined(__APPLE__)
   // On OS X the executable path is saved to the stack by dyld. Reading it
   // from there is much faster than calling dladdr, especially for large
   // binaries with symbols.
   char exe_path[MAXPATHLEN];
   uint32_t size = sizeof(exe_path);
   if (_NSGetExecutablePath(exe_path, &size) == 0) {
     char link_path[MAXPATHLEN];
     if (realpath(exe_path, link_path))
       return link_path;
   }
-#elif defined(__FreeBSD__) || defined (__NetBSD__) || defined(__Bitrig__) || \
-      defined(__OpenBSD__) || defined(__minix) || defined(__DragonFly__) || \
-      defined(__FreeBSD_kernel__) || defined(_AIX)
+#elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__NetBSD__)
+  int mib[4];
+  mib[0] = CTL_KERN;
+#if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
+  mib[1] = KERN_PROC;
+  mib[2] = KERN_PROC_PATHNAME;
+  mib[3] = -1;
+#else
+  mib[1] = KERN_PROC_ARGS;
+  mib[2] = -1;
+  mib[3] = KERN_PROC_PATHNAME;
+#endif
+  char exe_path[PATH_MAX];
+  size_t cb = sizeof(exe_path);
+  if (sysctl(mib, 4, exe_path, &cb, NULL, 0) == 0)
+    return exe_path;
+#elif defined(__Bitrig__) || defined(__OpenBSD__) || defined(__minix) || \
+      defined(__DragonFly__) || defined(_AIX)
   char exe_path[PATH_MAX];
 
   if (getprogpath(exe_path, argv0) != NULL)
     return exe_path;
 #elif defined(__linux__) || defined(__CYGWIN__)
   char exe_path[MAXPATHLEN];
   StringRef aPath("/proc/self/exe");
   if (sys::fs::exists(aPath)) {

unittests/Support/DynamicLibrary/DynamicLibraryTest.cpp

 #include <string>
 
 using namespace llvm;
 using namespace llvm::sys;
 
 extern "C" PIPSQUEAK_EXPORT const char *TestA() { return "ProcessCall"; }
 
 std::string LibPath() {
+  const std::vector<testing::internal::string>& Argvs = testing::internal::GetArgvs();
+  const char *Argv0 = Argvs.size() > 0 ? Argvs[0].c_str() : "DynamicLibraryTests";
   void *Ptr = (void*)(intptr_t)TestA;
-  std::string Path = fs::getMainExecutable("DynamicLibraryTests", Ptr);
+  std::string Path = fs::getMainExecutable(Argv0, Ptr);
   llvm::SmallString<256> Buf(path::parent_path(Path));
   path::append(Buf, "PipSqueak.so");
   return Buf.str();
 }
 
 #if defined(_WIN32) || (defined(HAVE_DLFCN_H) && defined(HAVE_DLOPEN))
 
 typedef void (*SetStrings)(std::string &GStr, std::string &LStr);