ci: CI tests on MacOS ARM, and fixes found consequently (#4026)

There's a new GitHub runner in town!

Set up CI to run on Mac ARM. But not all the time -- it's too expensive!

This runner is only available for paid accounts, and it's 20x more
expensive than paying for a Linux runner. The ASWF can't afford to run
this job on every iteration of every PR, and again upon merge.

We split it into a separate workflow so we can direct it to run only for
tagged releases, branches with names containng "-alpha", "-beta",
"release", or contain the substring "macarm" (this last one is so we can
force a particular PR that we think is directly relevant to ARM to test,
even though it's not one of those other release-related cases). We also
run it once a month, on the 27th -- a few days before each monthly
release -- to try to catch any ARM problems we've accidentally
introduced by PRs that didn't test.

It's also rigged to run only on the ASWF repo, so you don't need to
worry that you will get charged for pushes to your own fork. (On the
other hand, it also means you aren't testing against ARM when you push
to your fork prior to making a PR.)

In the process of testing this, of course I found some minor things that
needed to be fixed on ARM -- a couple compile issues, and several
testsuite reference outputs that needed to be updated because they
differ ever so slightly in some math calculations on the different CPU
architecture.

Signed-off-by: Larry Gritz <[email protected]>

Author: lgritz

.github/workflows/macarm.yml

@@ -0,0 +1,99 @@
+# Copyright Contributors to the OpenImageIO project.
+# SPDX-License-Identifier: Apache-2.0
+# https://github.com/AcademySoftwareFoundation/OpenImageIO
+
+
+# This workflow is for CI for ARM-based MacOS. In an ideal world, this would
+# just be another matrix entry in the main CI workflow, but MacOS ARM runners
+# too expensive to run on every PR push. So we break into a separate workflow
+# to have more fine-grained control over when it runs.
+
+name: CI-Mac-ARM
+
+# This section controls when the workflow runs.
+on:
+  # Run upon push, but only for tagged versions, or if the branch name
+  # contains the substrings "macarm", "-alpha", "-beta", or is called
+  # "release".
+  push:
+    tags:
+      - v**
+    branches:
+      - '*macarm*'
+      - '*alpha*'
+      - '*beta*'
+      - 'release'
+  # Run for pull requests whose branch name includes "macarm" (this allows
+  # us to test specific PRs that we think need ARM verification).
+  pull_request:
+    if: contains(github.head_ref, 'macarm')
+  # Run monthly on the 27th (a few days before patch releases) to make sure we
+  # haven't broken anything among the many PRs that didn't test on ARM.
+  schedule:
+    - cron: "0 8 27 * *"
+      if: github.repository == 'AcademySoftwareFoundation/OpenImageIO'
+
+permissions: read-all
+
+
+jobs:
+  # This section should remain an identical copy of the main CI workflow job
+  # for MacOS.
+  macos-arm:
+    name: "${{matrix.os}} appleclang${{matrix.aclang}}/C++${{matrix.cxx_std}} py${{matrix.python_ver}} ${{matrix.desc}} boost1.76 exr3.1 ocio2.1"
+    # Needs special runners, only run on the main repo,
+    if: github.repository == 'AcademySoftwareFoundation/OpenImageIO'
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - desc: MacOS-13 ARM
+            os: macos-13-xlarge
+            nametag: macos13-arm-py311
+            cxx_std: 17
+            python_ver: "3.11"
+            aclang: 14
+            setenvs: export CTEST_TEST_TIMEOUT=600 USE_OPENCV=0 USE_QT=0 PARALLEL=8
+    runs-on: ${{ matrix.os }}
+    env:
+      CC: clang
+      CXX: clang++
+      CMAKE_CXX_STANDARD: ${{ matrix.cxx_std }}
+      PYTHON_VERSION: ${{ matrix.python_ver }}
+    steps:
+      - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # v3.0.2
+      - name: Prepare ccache timestamp
+        id: ccache_cache_keys
+        run: echo "::set-output name=date::`date -u +'%Y-%m-%dT%H:%M:%SZ'`"
+      - name: ccache
+        id: ccache
+        uses: actions/cache@c3f1317a9e7b1ef106c153ac8c0f00fed3ddbc0d # v3.0.4
+        with:
+          path: /Users/runner/.ccache
+          key: ${{github.job}}-${{matrix.nametag}}-${{ steps.ccache_cache_keys.outputs.date }}
+          restore-keys: ${{github.job}}-
+      - name: Build setup
+        run: |
+            ${{matrix.setenvs}}
+            src/build-scripts/ci-startup.bash
+      - name: Dependencies
+        run: |
+            src/build-scripts/install_homebrew_deps.bash
+            ${{matrix.depcmds}}
+      - name: Build
+        run: |
+            export PYTHONPATH=/usr/local/lib/python${PYTHON_VERSION}/site-packages:$PYTHONPATH
+            src/build-scripts/ci-build.bash
+      - name: Testsuite
+        run: src/build-scripts/ci-test.bash
+      - uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+        if: failure()
+        with:
+          name: oiio-${{github.job}}-${{matrix.nametag}}
+          path: |
+            build/cmake-save
+            build/testsuite/*/*.*
+            !build/testsuite/oiio-images
+            !build/testsuite/openexr-images
+            !build/testsuite/fits-images
+            !build/testsuite/j2kp4files_v1_5

src/build-scripts/install_homebrew_deps.bash

@@ -42,8 +42,12 @@ brew install --display-times -q freetype libraw dcmtk pybind11 numpy || true
 brew install --display-times -q ffmpeg libheif ptex || true
 brew install --display-times -q tbb || true
 brew install --display-times -q openvdb || true
-brew install --display-times -q opencv || true
-brew install --display-times -q qt${QT_VERSION}
+if [[ "${USE_OPENCV}" != "0" ]] ; then
+    brew install --display-times -q opencv || true
+fi
+if [[ "${USE_QT}" != "0" ]] ; then
+    brew install --display-times -q qt${QT_VERSION}
+fi
 
 echo ""
 echo "After brew installs:"

src/include/OpenImageIO/simd.h

@@ -46,6 +46,11 @@
 
 #include <OpenImageIO/detail/fmt.h>
 
+// Without SSE, we need to fall back on Imath for matrix44 invert
+#if !OIIO_SIMD_SSE
+#   include <OpenImageIO/Imath.h>
+#endif
+
 
 //////////////////////////////////////////////////////////////////////////
 // Sort out which SIMD capabilities we have and set definitions
@@ -8536,6 +8541,8 @@ OIIO_FORCEINLINE matrix44 matrix44::inverse() const {
 OIIO_FORCEINLINE matrix44 matrix44::inverse() const {
     return matrix44 (((Imath::M44f*)this)->inverse());
 }
+#else
+#error "Don't know how to compute matrix44::inverse()"
 #endif