apache · paleolimbot · Jun 22, 2023 · May 25, 2023 · May 25, 2023 · May 25, 2023
diff --git a/.github/workflows/build-and-test-device.yaml b/.github/workflows/build-and-test-device.yaml
@@ -0,0 +1,127 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: test-c-device
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'CMakeLists.txt'
+      - '.github/workflows/build-and-test-device.yaml'
+      - 'src/nanoarrow/**'
+      - 'extensions/nanoarrow_device/**'
+
+jobs:
+  test-c-device:
+
+    runs-on: ubuntu-latest
+
+    name: ${{ matrix.config.label }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - {label: default-build}
+          - {label: namespaced-build, cmake_args: "-DNANOARROW_NAMESPACE=SomeUserNamespace"}
+          - {label: bundled-build, cmake_args: "-DNANOARROW_DEVICE_BUNDLE=ON"}
+
+    env:
+      SUBDIR: 'extensions/nanoarrow_device'
+      NANOARROW_ARROW_TESTING_DIR: '${{ github.workspace }}/arrow-testing'
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Checkout arrow-testing
+        uses: actions/checkout@v3
+        with:
+          repository: apache/arrow-testing
+          fetch-depth: 0
+          path: arrow-testing
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt install -y -V ca-certificates lsb-release wget cmake valgrind
+          wget https://apache.jfrog.io/artifactory/arrow/$(lsb_release --id --short | tr 'A-Z' 'a-z')/apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+          sudo apt-get install -y -V ./apache-arrow-apt-source-latest-$(lsb_release --codename --short).deb
+          sudo apt-get update
+          sudo apt-get install -y -V libarrow-dev
+          rm apache-arrow-apt-*.deb
+
+      - name: Build
+        run: |
+          cd $SUBDIR
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`/dist/lib
+          sudo ldconfig
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_BUILD_TYPE=Debug -DNANOARROW_DEVICE_BUILD_TESTS=ON ${{ matrix.config.cmake_args }}
+          cmake --build .
+
+      - name: Check for non-namespaced symbols in namespaced build
+        if: matrix.config.label == 'namespaced-build'
+        run: |
+          cd $SUBDIR
+
+          # Dump all symbols
+          nm --extern-only build/libnanoarrow_device.a
+
+          # Check for non-namespaced ones
+          ARROW_SYMBOLS=`nm --extern-only build/libnanoarrow_device.a | grep "T Arrow" || true`
+          if [ -z "$ARROW_SYMBOLS" ]; then
+            exit 0
+          fi
+
+          echo "Found the following non-namespaced extern symbols:"
+          echo $ARROW_SYMBOLS
+          exit 1
+
+      - name: Run tests
+        run: |
+          cd $SUBDIR
+
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`/dist/lib
+          sudo ldconfig
+          cd build
+          ctest -T test --output-on-failure .
+
+      - name: Run tests with valgrind
+        if: matrix.config.label == 'default-build' || matrix.config.label == 'default-noatomics'
+        run: |
+          cd $SUBDIR
+
+          export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`/dist/lib
+          sudo ldconfig
+          cd build
+          ctest -T memcheck .
+
+      - name: Upload memcheck results
+        if: failure() && matrix.config.label == 'default-build'
+        uses: actions/upload-artifact@main
+        with:
+          name: nanoarrow-device-memcheck
+          path: extensions/nanoarrow_device/build/Testing/Temporary/MemoryChecker.*.log
diff --git a/.github/workflows/bundle.yaml b/.github/workflows/bundle.yaml
@@ -57,6 +57,14 @@ jobs:
           cmake --build .
           cmake --install . --prefix=../../../nanoarrow-latest
 
+      - name: Bundle nanoarrow_device
+        run: |
+          cd extensions/nanoarrow_device
+          mkdir build && cd build
+          cmake .. -DNANOARROW_DEVICE_BUNDLE=ON
+          cmake --build .
+          cmake --install . --prefix=../../../nanoarrow-latest
+
       - name: Compress bundle
         run: |
           zip nanoarrow-latest.zip $(find nanoarrow-latest -type f)

diff --git a/ci/scripts/build-docs.sh b/ci/scripts/build-docs.sh
@@ -59,18 +59,21 @@ main() {
    rm -rf docs/_build
    mkdir -p docs/_build
 
-   # Run doxygen
    show_header "Run Doxygen for C library"
    pushd src/apidoc
    doxygen
    popd
 
-   # Run doxygen
    show_header "Run Doxygen for IPC extension"
    pushd extensions/nanoarrow_ipc/src/apidoc
    doxygen
    popd
 
+   show_header "Run Doxygen for device extension"
+   pushd extensions/nanoarrow_device/src/apidoc
+   doxygen
+   popd
+
    pushd docs
 
    show_header "Build Sphinx project"

diff --git a/ci/scripts/coverage.sh b/ci/scripts/coverage.sh
@@ -85,6 +85,20 @@ function main() {
 
     pushd "${SANDBOX_DIR}"
 
+    # Build + run tests with gcov for device extension
+    show_header "Build + test nanoarrow_device"
+    mkdir "${SANDBOX_DIR}/nanoarrow_device"
+    pushd "${SANDBOX_DIR}/nanoarrow_device"
+
+    cmake "${TARGET_NANOARROW_DIR}/extensions/nanoarrow_device" \
+        -DNANOARROW_DEVICE_BUILD_TESTS=ON -DNANOARROW_DEVICE_CODE_COVERAGE=ON
+    cmake --build .
+    ctest .
+
+    popd
+
+    pushd "${SANDBOX_DIR}"
+
     # Generate coverage.info file for both cmake projects using lcov
     show_header "Calculate CMake project coverage"
     lcov --capture --directory . \

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -52,7 +52,8 @@
 # Breathe configuration
 breathe_projects = {
     "nanoarrow_c": "../../src/apidoc/xml",
-    "nanoarrow_ipc": "../../extensions/nanoarrow_ipc/src/apidoc/xml"
+    "nanoarrow_ipc": "../../extensions/nanoarrow_ipc/src/apidoc/xml",
+    "nanoarrow_device": "../../extensions/nanoarrow_device/src/apidoc/xml"
 }
 breathe_default_project = "nanoarrow_c"
 
@@ -75,9 +76,7 @@
 html_theme_options = {
     "show_toc_level": 2,
     "use_edit_page_button": True,
-    "external_links": [
-      {"name": "R Package", "url": "r/index.html"},
-  ],
+    "external_links": [],
 }
 
 html_context = {

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -24,6 +24,4 @@ Contents
    :maxdepth: 2
 
    Getting Started <getting-started>
-   C API Reference <c>
-   C++ API Reference <cpp>
-   IPC Extension Reference <ipc>
+   API Reference <reference/index>
diff --git a/docs/source/c.rst → docs/source/reference/c.rst b/docs/source/c.rst → docs/source/reference/c.rst
diff --git a/docs/source/cpp.rst → docs/source/reference/cpp.rst b/docs/source/cpp.rst → docs/source/reference/cpp.rst
diff --git a/docs/source/reference/device.rst b/docs/source/reference/device.rst
@@ -0,0 +1,46 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements.  See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership.  The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License.  You may obtain a copy of the License at
+
+..   http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied.  See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+Device Extension Reference
+==========================
+
+C API
+------------------------
+
+.. doxygengroup:: nanoarrow_device
+   :project: nanoarrow_device
+   :members:
+
+C++ Helpers
+------------------------
+
+.. doxygengroup:: nanoarrow_device_hpp-unique
+   :project: nanoarrow_device
+   :members:
+
+Arrow C Device Interface
+------------------------
+
+.. doxygengroup:: nanoarrow_device-arrow-cdata
+   :project: nanoarrow_device
+   :members:
+   :undoc-members:
+
+.. doxygengroup:: arrow-device-types
+   :project: nanoarrow_device
+   :members:
+   :undoc-members:
diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst
@@ -0,0 +1,28 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements.  See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership.  The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License.  You may obtain a copy of the License at
+
+..   http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied.  See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   R API Reference <r>
+   C API Reference <c>
+   C++ API Reference <cpp>
+   IPC Extension Reference <ipc>
+   Device Extension Reference <device>
diff --git a/docs/source/ipc.rst → docs/source/reference/ipc.rst b/docs/source/ipc.rst → docs/source/reference/ipc.rst
diff --git a/docs/source/reference/r.rst b/docs/source/reference/r.rst
@@ -0,0 +1,21 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+.. or more contributor license agreements.  See the NOTICE file
+.. distributed with this work for additional information
+.. regarding copyright ownership.  The ASF licenses this file
+.. to you under the Apache License, Version 2.0 (the
+.. "License"); you may not use this file except in compliance
+.. with the License.  You may obtain a copy of the License at
+
+..   http://www.apache.org/licenses/LICENSE-2.0
+
+.. Unless required by applicable law or agreed to in writing,
+.. software distributed under the License is distributed on an
+.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.. KIND, either express or implied.  See the License for the
+.. specific language governing permissions and limitations
+.. under the License.
+
+R API Reference
+==================
+
+See `R Documentation <../r/reference/index.html>`__.
diff --git a/extensions/nanoarrow_device/.gitignore b/extensions/nanoarrow_device/.gitignore
@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+dist/