FreeBSD port

.github/workflows/freebsd-ci.yml

@@ -0,0 +1,35 @@
+name: FreeBSD Build
+
+on:
+  push:
+    branches: [ "freebsd" ]
+  pull_request:
+    branches: [ "freebsd" ]
+
+jobs:
+  build-freebsd:
+    # vmactions runs a QEMU VM inside an Ubuntu runner, so runs-on MUST be ubuntu-latest
+    runs-on: ubuntu-latest
+    name: Build rdma-core on FreeBSD
+
+    steps:
+      # Step 1: Check out your rdma-core repository into the Ubuntu host runner
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      # Step 2: Fire up the FreeBSD VM and execute the build steps
+      - name: Build in FreeBSD VM
+        uses: vmactions/freebsd-vm@v1
+        with:
+          release: "15.1"
+          usesh: true     # Use standard sh rather than tcsh (default shell on FreeBSD)
+
+          # The 'prepare' section runs inside the VM before copying files,
+          # ideal for installing system package dependencies.
+          prepare: |
+            uname -a
+            pkg install -y gcc cmake ninja python3 bash libepoll-shim \
+                linuxapi libudev-devd pkgconf lang/cython
+
+          run: |
+            bash build-freebsd.sh

CMakeLists.txt

@@ -549,6 +549,13 @@ FIND_PACKAGE (Threads REQUIRED)
 
 FIND_PACKAGE(PkgConfig REQUIRED)
 
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  find_package(linuxapi REQUIRED)
+  include_directories(BEFORE ${linuxapi_INCLUDE_DIR})
+  # We need to add an additional -I flag to all generated .pc files
+  set(PC_FREEBSD_CFLAGS "-I${linuxapi_INCLUDE_DIR}")
+endif()
+
 # libnl
 if (NOT DEFINED ENABLE_RESOLVE_NEIGH)
   set(ENABLE_RESOLVE_NEIGH "ON" CACHE BOOL "Enable internal resolution of neighbours for Etherent")
@@ -564,13 +571,15 @@ else()
   set(NL_LIBRARIES "")
   RDMA_DoFixup(0 "netlink/attr.h")
   RDMA_DoFixup(0 "netlink/msg.h")
-  RDMA_DoFixup(0 "netlink/netlink.h")
   RDMA_DoFixup(0 "netlink/object-api.h")
   RDMA_DoFixup(0 "netlink/route/link.h")
   RDMA_DoFixup(0 "netlink/route/link/vlan.h")
   RDMA_DoFixup(0 "netlink/route/neighbour.h")
-  RDMA_DoFixup(0 "netlink/route/route.h")
   RDMA_DoFixup(0 "netlink/route/rtnl.h")
+  if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
+    RDMA_DoFixup(0 "netlink/netlink.h")
+    RDMA_DoFixup(0 "netlink/route/route.h")
+  endif()
 endif()
 
 # Older stuff blows up if these headers are included together

README-FreeBSD.txt

@@ -0,0 +1,28 @@
+The port just compiles.
+
+FreeBSD version should be main or stable/15, after the tdestroy(3) and
+strdupa()/strndupa() additions.
+
+You need to install the following packages:
+cmake-core
+ninja
+gcc
+python3
+pyXXX-cython3
+pyXXX-docutils
+bash
+libepoll-shim
+libudev-devd
+libdrm
+pkgconf
+
+1. All fake constants for (rt)netlink that are added in
+   freebsd-headers/linux point to the usage areas that need porting.
+2. sysfs accesses must be replaced by sysctl.
+   Similarly, there should be use of /proc that needs to be ported.
+3. I have no idea if the FreeBSD verbs/drivers ABI is compatible with
+   the Linux provided by kernel-headers/*.
+4. Tests for the compilation environment properties done in CMakeLists.txt
+   are performed before the freebsd-headers get chance to populate build
+   environment.  As such, some tests provide invalid results, e.g.
+   the co-existence of netinet/in.h and linux/in*.h.

build-freebsd.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+set -e
+
+LOCALBASE=$(/sbin/sysctl -n user.localbase)
+CMAKE=${LOCALBASE}/bin/cmake
+NINJA=${LOCALBASE}/bin/ninja
+PYTHON=${LOCALBASE}/bin/python3
+GCC=${LOCALBASE}/bin/gcc
+GXX=${LOCALBASE}/bin/g++
+
+SRCDIR=$(dirname $0)
+BUILDDIR=${SRCDIR}/build
+
+mkdir -p ${BUILDDIR}
+
+cd ${BUILDDIR}
+
+${CMAKE} -DIN_PLACE=1 -GNinja -DENABLE_RESOLVE_NEIGH=0 -DIOCTL_MODE=write \
+    -DPYTHON_EXECUTABLE=${PYTHON} \
+    -DCMAKE_C_COMPILER=${GCC} -DCMAKE_CXX_COMPILER=${GXX} \
+    ${EXTRA_CMAKE_FLAGS:-} ..
+${NINJA} -k 0

buildlib/FindLDSymVer.cmake

@@ -3,12 +3,20 @@
 # find_package helper to detect symbol version support in the compiler and
 # linker. If supported then LDSYMVER_MODE will be set to GNU
 
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  set(GLOBAL_SYMBOLS_BIN "
+		environ;
+		__progname;
+  ")
+endif()
+
 # Basic sample GNU style map file
 file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/test.map" "
 IBVERBS_1.0 {
         global:
                 ibv_get_device_list;
-        local: *;
+		${GLOBAL_SYMBOLS_BIN}
+	local:	*;
 };
 
 IBVERBS_1.1 {

buildlib/FindUDev.cmake

@@ -2,6 +2,7 @@
 # Licensed under BSD (MIT variant) or GPLv2. See COPYING.
 
 find_library(LIBUDEV_LIBRARY NAMES udev libudev)
+find_path(UDEV_INCLUDE_DIRS "libudev.h")
 
 set(UDEV_LIBRARIES ${LIBUDEV_LIBRARY})
 

buildlib/config.h.in

@@ -13,7 +13,11 @@
 // FIXME: Remove this, The cmake version hard-requires new style CLOEXEC support
 #define STREAM_CLOEXEC "e"
 
+#if defined __linux__
 #define RDMA_CDEV_DIR "/dev/infiniband"
+#elif defined __FreeBSD__
+#define RDMA_CDEV_DIR "/dev"
+#endif
 
 #define IBV_CONFIG_DIR "@CONFIG_DIR@"
 #define RS_CONF_DIR "@CMAKE_INSTALL_FULL_SYSCONFDIR@/rdma/rsocket"

buildlib/make_abi_structs.py

@@ -19,10 +19,33 @@
 import re;
 import functools;
 import sys;
+import os;
 
-def in_struct(ln,FO,nesting=0):
+sysname=sys.argv[3]
+
+def cpre_sysname():
+    mapping = {"Linux": "__linux__", "FreeBSD": "__FreeBSD__"}
+    try:
+        return mapping[sysname]
+    except KeyError:
+        raise NotImplementedError(sysname)
+
+def in_struct(ln,FO,nesting=0,wait_for_endif=False,skip=False):
     """Copy a top level structure over to the #define output, keeping track of
     nested structures."""
+    if wait_for_endif:
+        g = re.match(r"#endif", ln)
+        if g != None:
+            return functools.partial(in_struct,nesting=nesting,wait_for_endif=False,skip=False)
+    g = re.match(r"#ifdef\s+(\S+)",ln)
+    if g != None:
+        ifdefsym = g.group(1)
+        if ifdefsym == cpre_sysname():
+            return functools.partial(in_struct,nesting=nesting,wait_for_endif=True,skip=False)
+        return functools.partial(in_struct,nesting=nesting,wait_for_endif=True,skip=True)
+    if skip:
+        return functools.partial(in_struct,nesting=nesting,wait_for_endif=wait_for_endif,skip=skip)
+
     if nesting == 0:
         if re.match(r"(}.*);",ln):
             FO.write(ln[:-1] + "\n\n");
@@ -31,11 +54,11 @@ def in_struct(ln,FO,nesting=0):
     FO.write(ln + " \\\n");
 
     if ln == "struct {" or ln == "union {":
-        return functools.partial(in_struct,nesting=nesting+1);
+        return functools.partial(in_struct,nesting=nesting+1,wait_for_endif=wait_for_endif,skip=skip);
 
     if re.match(r"}.*;",ln):
-        return functools.partial(in_struct,nesting=nesting-1);
-    return functools.partial(in_struct,nesting=nesting);
+        return functools.partial(in_struct,nesting=nesting-1,wait_for_endif=wait_for_endif,skip=skip);
+    return functools.partial(in_struct,nesting=nesting,wait_for_endif=wait_for_endif,skip=skip);
 
 def find_struct(ln,FO):
     """Look for the start of a top level structure"""

buildlib/rdma_functions.cmake

@@ -57,7 +57,7 @@ function(rdma_create_symlink LINK_CONTENT DEST)
 
   # Newer versions of cmake can use "${CMAKE_COMMAND}" "-E" "create_symlink"
   # however it is broken weirdly on older versions.
-  execute_process(COMMAND "ln" "-Tsf"
+  execute_process(COMMAND "ln" "-sf"
     "${LINK_CONTENT}" "${DEST}" RESULT_VARIABLE retcode)
   if(NOT "${retcode}" STREQUAL "0")
     message(FATAL_ERROR "Failed to create symlink in ${DEST}")

buildlib/template.pc.in

@@ -8,4 +8,4 @@ Version: @PC_VERSION@
 Libs: -L${libdir} -l@PC_LIB_NAME@ @PC_RPATH@
 Libs.private: @PC_LIB_PRIVATE@
 Requires.private: @PC_REQUIRES_PRIVATE@
-Cflags: -I${includedir}
+Cflags: -I${includedir} @PC_FREEBSD_CFLAGS@

infiniband-diags/ibaddr.c

@@ -36,6 +36,7 @@
 #include <stdlib.h>
 #include <unistd.h>
 #include <arpa/inet.h>
+#include <sys/socket.h>
 
 #include <infiniband/umad.h>
 #include <infiniband/mad.h>

infiniband-diags/ibdiag_common.c

@@ -55,6 +55,7 @@
 #include <stdint.h>
 #include <sys/stat.h>
 #include <stdarg.h>
+#include <sys/socket.h>
 
 #include <infiniband/umad.h>
 #include <infiniband/mad.h>

infiniband-diags/saquery.c

@@ -44,6 +44,7 @@
 #include <ctype.h>
 #include <string.h>
 #include <errno.h>
+#include <sys/socket.h>
 
 #define _GNU_SOURCE
 

kernel-headers/CMakeLists.txt

@@ -51,7 +51,7 @@ function(rdma_kernel_provider_abi)
     set(HDRS ${HDRS} ${OHDR})
     add_custom_command(
       OUTPUT "${OHDR}"
-      COMMAND "${PYTHON_EXECUTABLE}" "${PROJECT_SOURCE_DIR}/buildlib/make_abi_structs.py" "${IHDR}" "${OHDR}"
+      COMMAND "${PYTHON_EXECUTABLE}" "${PROJECT_SOURCE_DIR}/buildlib/make_abi_structs.py" "${IHDR}" "${OHDR}" "${CMAKE_SYSTEM_NAME}"
       MAIN_DEPENDENCY "${IHDR}"
       DEPENDS "${PROJECT_SOURCE_DIR}/buildlib/make_abi_structs.py"
       WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"

kernel-headers/rdma/mlx5-abi.h

@@ -287,6 +287,7 @@ enum mlx5_ib_create_cq_flags {
 };
 
 struct mlx5_ib_create_cq {
+#ifdef __linux__
 	__aligned_u64 buf_addr;
 	__aligned_u64 db_addr;
 	__u32	cqe_size;
@@ -296,6 +297,18 @@ struct mlx5_ib_create_cq {
 	__u16	uar_page_index;
 	__u16	reserved0;
 	__u32	reserved1;
+#endif
+#ifdef __FreeBSD__
+	__u64	buf_addr;
+	__u64	db_addr;
+	__u32	cqe_size;
+	__u16	flags;
+	__u16	uar_page_index;
+	__u8    cqe_comp_en;
+	__u8    cqe_comp_res_format;
+	__u16	reserved0;
+	__u32	reserved1;
+#endif
 };
 
 struct mlx5_ib_create_cq_resp {

libibmad/CMakeLists.txt

@@ -7,9 +7,17 @@ publish_internal_headers(util
   iba_types.h
   )
 
-rdma_library(ibmad libibmad.map
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
   # See Documentation/versioning.md
-  5 5.5.${PACKAGE_VERSION}
+  set(SOVER 5 5.5.${PACKAGE_VERSION})
+endif()
+
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  set(SOVER 100 100.5.${PACKAGE_VERSION})
+endif()
+
+rdma_library(ibmad libibmad.map
+  ${SOVER}
   bm.c
   cc.c
   dump.c

libibmad/mad.h

@@ -1714,6 +1714,7 @@ extern int ibdebug;
 
 /* Misc. macros: */
 /** align value \a l to \a size (ceil) */
+#undef ALIGN
 #define ALIGN(l, size) (((l) + ((size) - 1)) / (size) * (size))
 
 /** printf style warning MACRO, includes name of function and pid */

libibmad/portid.c

@@ -35,6 +35,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <arpa/inet.h>
+#include <sys/socket.h>
 
 #include <infiniband/mad.h>
 

libibmad/resolve.c

@@ -37,6 +37,7 @@
 #include <string.h>
 #include <arpa/inet.h>
 #include <errno.h>
+#include <sys/socket.h>
 
 #include <infiniband/umad.h>
 #include <infiniband/mad.h>

libibumad/CMakeLists.txt

@@ -8,9 +8,17 @@ publish_headers(infiniband
   umad_types.h
   )
 
-rdma_library(ibumad libibumad.map
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
   # See Documentation/versioning.md
-  3 3.4.${PACKAGE_VERSION}
+  set(SOVER 3 3.4.${PACKAGE_VERSION})
+endif()
+
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+  set(SOVER 100 100.4.${PACKAGE_VERSION})
+endif()
+
+rdma_library(ibumad libibumad.map
+  ${SOVER}
   sysfs.c
   umad.c
   umad_str.c

libibumad/tests/umad_sa_mcm_rereg_test.c

@@ -37,6 +37,7 @@
 #include <errno.h>
 #include <inttypes.h>
 #include <unistd.h>
+#include <sys/socket.h>
 
 #include <infiniband/umad.h>
 #include <infiniband/umad_sa_mcm.h>

libibverbs/CMakeLists.txt

@@ -20,9 +20,19 @@ publish_internal_headers(infiniband
 configure_file("libibverbs.map.in"
   "${CMAKE_CURRENT_BINARY_DIR}/libibverbs.map" @ONLY)
 
-rdma_library(ibverbs "${CMAKE_CURRENT_BINARY_DIR}/libibverbs.map"
+if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
+   set(SYSDEP_SOURCES init-sysfs.c sysfs-sysfs.c)
   # See Documentation/versioning.md
-  1 1.18.${PACKAGE_VERSION}
+   set(SOVER 1 1.18.${PACKAGE_VERSION})
+endif()
+
+if (CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
+   set(SYSDEP_SOURCES init-sysctl.c sysfs-sysctl.c)
+   set(SOVER 100 100.18.${PACKAGE_VERSION})
+endif()
+
+rdma_library(ibverbs "${CMAKE_CURRENT_BINARY_DIR}/libibverbs.map"
+  ${SOVER}
   all_providers.c
   cmd.c
   cmd_ah.c
@@ -57,8 +67,8 @@ rdma_library(ibverbs "${CMAKE_CURRENT_BINARY_DIR}/libibverbs.map"
   memory.c
   neigh.c
   static_driver.c
-  sysfs.c
   verbs.c
+  ${SYSDEP_SOURCES}
   )
 target_link_libraries(ibverbs LINK_PRIVATE
   ${NL_LIBRARIES}

libibverbs/cmd_ioctl.h

@@ -146,7 +146,7 @@ unsigned int __ioctl_final_num_attrs(unsigned int num_attrs,
 
 /*
  * C99 does not permit an initializer for VLAs, so this function does the init
- * instead. It is called in the wonky way so that DELCARE_COMMAND_BUFFER can
+ * instead. It is called in the wonky way so that DECLARE_COMMAND_BUFFER can
  * still be a 'variable', and we so we don't require C11 mode.
  */
 static inline int _ioctl_init_cmdb(struct ibv_command_buffer *cmd,