Add OpenBSD support to OpenMP

[bcallah]

Summary

This patch permits OpenMP to build and work (with both gcc and clang) on OpenBSD. It mostly follows what was done for FreeBSD and NetBSD, except OpenBSD does not have pthread_getattr_np support, so it follows OS X in that one instance.

[krytarowski]

runtime/src/kmp_platform.h

103

How about switching this check to __x86_64__ or defined(__x86_64) || defined(__x86_64__)?

[bcallah]

Removed amd64 check, changed x86_64 check to x86_64__

runtime/src/kmp_platform.h

103

No objections to the former (or the latter, but I did the former).

[krytarowski]

runtime/src/z_Linux_util.cpp

450

If we are going to alter this comment, perhaps it's worth to make it more generic.

"Supported not by all systems"

[bcallah]

Update a comment, at the request of krytarowski.

runtime/src/z_Linux_util.cpp

450

Sure. The comment also says it's for Linux only, which isn't true either. So I made the whole thing generic.

[bcallah]

Is there anything else I can do to help get this committed?

[bcallah]

I'm sorry to keep poking, but I would really appreciate this getting committed to the tree.
I am willing to work to ensure that OpenMP continues to build on OpenBSD and is not a hindrance to other platforms.

[krytarowski]

Patch looks fine from NetBSD point of view. The rest (to accept and commit) I leave to OpenMP developers. I have not worked on it so far.

[krytarowski]

CMakeLists.txt

7

This comment would be updated to a some more generic one.

[krytarowski]

runtime/src/kmp_wrapper_malloc.h

102

This is beyond the scope of this patch but all platforms (Windows, Linux, BSDs, MacOSX) as far as I can tell ship alloca(3) from <stdlib.h>. The only exception of a modern system that I'm aware of, where <stdlib.h> does not work for this task is Solaris, it requires <alloca.h>.

[bcallah]

Hello.
I would still very much like to add OpenBSD support to OpenMP. I have been using it for the past several months.

I have uploaded a new patch that rebases the OpenBSD additions to HEAD.

Thanks.

CMakeLists.txt

 cmake_minimum_required(VERSION 2.8 FATAL_ERROR)
 
 set(OPENMP_LLVM_TOOLS_DIR "" CACHE PATH "Path to LLVM tools for testing")
 
 add_subdirectory(runtime)
 
 # Currently libomptarget cannot be compiled on Windows or MacOS X.
 # Since the device plugins are only supported on Linux anyway,
 # there is no point in trying to compile libomptarget on other OSes.
-if (NOT (WIN32 OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin"))
+if (NOT (WIN32 OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin" OR ${CMAKE_SYSTEM_NAME} MATCHES "OpenBSD"))
   add_subdirectory(libomptarget)
 endif()

runtime/src/kmp.h

 #elif KMP_OS_FREEBSD
 /* TODO: tune for KMP_OS_FREEBSD */
 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
 #elif KMP_OS_NETBSD
 /* TODO: tune for KMP_OS_NETBSD */
 #define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
 #define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
+#elif KMP_OS_OPENBSD
+/* TODO: tune for KMP_OS_OPENBSD */
+#define KMP_INIT_WAIT 1024U /* initial number of spin-tests   */
+#define KMP_NEXT_WAIT 512U /* susequent number of spin-tests */
 #endif
 
 #if KMP_ARCH_X86 || KMP_ARCH_X86_64
 typedef struct kmp_cpuid {
   kmp_uint32 eax;
   kmp_uint32 ebx;
   kmp_uint32 ecx;
   kmp_uint32 edx;

runtime/src/kmp_ftn_entry.h

 }
 
 int FTN_STDCALL xexpand(FTN_GET_THREAD_NUM)(void) {
 #ifdef KMP_STUB
   return 0;
 #else
   int gtid;
 
-#if KMP_OS_DARWIN || KMP_OS_FREEBSD || KMP_OS_NETBSD
+#if KMP_OS_DARWIN || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
   gtid = __kmp_entry_gtid();
 #elif KMP_OS_WINDOWS
   if (!__kmp_init_parallel ||
       (gtid = (int)((kmp_intptr_t)TlsGetValue(__kmp_gtid_threadprivate_key))) ==
           0) {
     // Either library isn't initialized or thread is not registered
     // 0 is the correct TID in this case
     return 0;

runtime/src/kmp_platform.h

 #ifndef KMP_PLATFORM_H
 #define KMP_PLATFORM_H
 
 /* ---------------------- Operating system recognition ------------------- */
 
 #define KMP_OS_LINUX 0
 #define KMP_OS_FREEBSD 0
 #define KMP_OS_NETBSD 0
+#define KMP_OS_OPENBSD 0
 #define KMP_OS_DARWIN 0
 #define KMP_OS_WINDOWS 0
 #define KMP_OS_CNK 0
 #define KMP_OS_UNIX 0 /* disjunction of KMP_OS_LINUX, KMP_OS_DARWIN etc. */
 
 #ifdef _WIN32
 #undef KMP_OS_WINDOWS
 #define KMP_OS_WINDOWS 1

 #define KMP_OS_FREEBSD 1
 #endif
 
 #if (defined __NetBSD__)
 #undef KMP_OS_NETBSD
 #define KMP_OS_NETBSD 1
 #endif
 
+#if (defined __OpenBSD__)
+#undef KMP_OS_OPENBSD
+#define KMP_OS_OPENBSD 1
+#endif
+
 #if (defined __bgq__)
 #undef KMP_OS_CNK
 #define KMP_OS_CNK 1
 #endif
 
 #if (1 !=                                                                      \
-     KMP_OS_LINUX + KMP_OS_FREEBSD + KMP_OS_NETBSD + KMP_OS_DARWIN +           \
-         KMP_OS_WINDOWS)
+     KMP_OS_LINUX + KMP_OS_FREEBSD + KMP_OS_NETBSD + KMP_OS_OPENBSD +          \
+         KMP_OS_DARWIN + KMP_OS_WINDOWS)
 #error Unknown OS
 #endif
 
-#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_DARWIN
+#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD || KMP_OS_DARWIN
 #undef KMP_OS_UNIX
 #define KMP_OS_UNIX 1
 #endif
 
 /* ---------------------- Architecture recognition ------------------- */
 
 #define KMP_ARCH_X86 0
 #define KMP_ARCH_X86_64 0

 #define KMP_ARCH_X86_64 1
 #else
 #undef KMP_ARCH_X86
 #define KMP_ARCH_X86 1
 #endif
 #endif
 
 #if KMP_OS_UNIX
-#if defined __x86_64
+#if defined __x86_64__
 #undef KMP_ARCH_X86_64
 #define KMP_ARCH_X86_64 1
 #elif defined __i386
 #undef KMP_ARCH_X86
 #define KMP_ARCH_X86 1
 #elif defined __powerpc64__
 #if defined __LITTLE_ENDIAN__
 #undef KMP_ARCH_PPC64_LE

runtime/src/kmp_runtime.cpp

#define FAST_REDUCTION_TREE_METHOD_GENERATED ((reduce_data) && (reduce_func))
 
   } else {
 
     int atomic_available = FAST_REDUCTION_ATOMIC_METHOD_GENERATED;
     int tree_available = FAST_REDUCTION_TREE_METHOD_GENERATED;
 
 #if KMP_ARCH_X86_64 || KMP_ARCH_PPC64 || KMP_ARCH_AARCH64 || KMP_ARCH_MIPS64
 
-#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_WINDOWS ||       \
-    KMP_OS_DARWIN
+#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD ||       \
+    KMP_OS_WINDOWS || KMP_OS_DARWIN
 
     int teamsize_cutoff = 4;
 
 #if KMP_MIC_SUPPORTED
     if (__kmp_mic_type != non_mic) {
       teamsize_cutoff = 8;
     }
 #endif
     if (tree_available) {
       if (team_size <= teamsize_cutoff) {
         if (atomic_available) {
           retval = atomic_reduce_block;
         }
       } else {
         retval = TREE_REDUCE_BLOCK_WITH_REDUCTION_BARRIER;
       }
     } else if (atomic_available) {
       retval = atomic_reduce_block;
     }
 #else
 #error "Unknown or unsupported OS"
-#endif // KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_WINDOWS ||
-// KMP_OS_DARWIN
+#endif // KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD ||
+// KMP_OS_WINDOWS || KMP_OS_DARWIN
 
 #elif KMP_ARCH_X86 || KMP_ARCH_ARM || KMP_ARCH_AARCH || KMP_ARCH_MIPS
 
-#if KMP_OS_LINUX || KMP_OS_WINDOWS
+#if KMP_OS_LINUX || KMP_OS_WINDOWS || KMP_OPENBSD
 
     // basic tuning
 
     if (atomic_available) {
       if (num_vars <= 2) { // && ( team_size <= 8 ) due to false-sharing ???
         retval = atomic_reduce_block;
       }
     } // otherwise: use critical section

runtime/src/kmp_wrapper_malloc.h

 #include <stdlib.h>
 
 #include "kmp_os.h"
 
 // Include alloca() declaration.
 #if KMP_OS_WINDOWS
 #include <malloc.h> // Windows* OS: _alloca() declared in "malloc.h".
 #define alloca _alloca // Allow to use alloca() with no underscore.
-#elif KMP_OS_FREEBSD || KMP_OS_NETBSD
+#elif KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
 // Declared in "stdlib.h".
 #elif KMP_OS_UNIX
 #include <alloca.h> // Linux* OS and OS X*: alloc() declared in "alloca".
 #else
 #error Unknown or unsupported OS.
 #endif
 
 /* KMP_SRC_LOC_DECL -- Declaring source location paramemters, to be used in
    function declaration.
    KMP_SRC_LOC_PARM -- Source location paramemters, to be used to pass
    parameters to underlying levels.

runtime/src/z_Linux_util.cpp

 #include "kmp_io.h"
 #include "kmp_itt.h"
 #include "kmp_lock.h"
 #include "kmp_stats.h"
 #include "kmp_str.h"
 #include "kmp_wait_release.h"
 #include "kmp_wrapper_getpid.h"
 
-#if !KMP_OS_FREEBSD && !KMP_OS_NETBSD
+#if !KMP_OS_FREEBSD && !KMP_OS_NETBSD && !KMP_OS_OPENBSD
 #include <alloca.h>
 #endif
 #include <math.h> // HUGE_VAL.
 #include <sys/resource.h>
 #include <sys/syscall.h>
 #include <sys/time.h>
 #include <sys/times.h>
 #include <unistd.h>

 
 /* Set thread stack info according to values returned by pthread_getattr_np().
    If values are unreasonable, assume call failed and use incremental stack
    refinement method instead. Returns TRUE if the stack parameters could be
    determined exactly, FALSE if incremental refinement is necessary. */
 static kmp_int32 __kmp_set_stack_info(int gtid, kmp_info_t *th) {
   int stack_data;
 #if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD
-  /* Linux* OS only -- no pthread_getattr_np support on OS X* */
+  /* Uses pthread_getattr_np -- not supported on all operating systems */
   pthread_attr_t attr;
   int status;
   size_t size = 0;
   void *addr = 0;
 
   /* Always do incremental stack refinement for ubermaster threads since the
      initial thread stack range can be reduced by sibling thread creation so
      pthread_attr_getstack may cause thread gtid aliasing */

 }
 
 static void *__kmp_launch_worker(void *thr) {
   int status, old_type, old_state;
 #ifdef KMP_BLOCK_SIGNALS
   sigset_t new_set, old_set;
 #endif /* KMP_BLOCK_SIGNALS */
   void *exit_val;
-#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD
+#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
   void *volatile padding = 0;
 #endif
   int gtid;
 
   gtid = ((kmp_info_t *)thr)->th.th_info.ds.ds_gtid;
   __kmp_gtid_set_specific(gtid);
 #ifdef KMP_TDATA_GTID
   __kmp_gtid = gtid;

 
 #ifdef KMP_BLOCK_SIGNALS
   status = sigfillset(&new_set);
   KMP_CHECK_SYSFAIL_ERRNO("sigfillset", status);
   status = pthread_sigmask(SIG_BLOCK, &new_set, &old_set);
   KMP_CHECK_SYSFAIL("pthread_sigmask", status);
 #endif /* KMP_BLOCK_SIGNALS */
 
-#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD
+#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
   if (__kmp_stkoffset > 0 && gtid > 0) {
     padding = KMP_ALLOCA(gtid * __kmp_stkoffset);
   }
 #endif
 
   KMP_MB();
   __kmp_set_stack_info(gtid, (kmp_info_t *)thr);
 

 }
 
 #endif /* BUILD_TV */
 
 static int __kmp_get_xproc(void) {
 
   int r = 0;
 
-#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD
+#if KMP_OS_LINUX || KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
 
   r = sysconf(_SC_NPROCESSORS_ONLN);
 
 #elif KMP_OS_DARWIN
 
   // Bug C77011 High "OpenMP Threads and number of active cores".
 
   // Find the number of available CPUs.
rc = vm_read_overwrite(
       (vm_address_t)(&buffer), // Address of buffer to save read bytes in.
       &count // Address of var to save number of read bytes in.
       );
   if (rc == 0) {
     // Memory successfully read.
     found = 1;
   }; // if
 
-#elif KMP_OS_FREEBSD || KMP_OS_NETBSD
+#elif KMP_OS_FREEBSD || KMP_OS_NETBSD || KMP_OS_OPENBSD
 
-  // FIXME(FreeBSD, NetBSD): Implement this
+  // FIXME(FreeBSD, NetBSD, OpenBSD): Implement this
   found = 1;
 
 #else
 
 #error "Unknown or unsupported OS"
 
 #endif