From 98a0a5a328a3e934a7fdd14da0d0ac53d8111114 Mon Sep 17 00:00:00 2001 From: Vladimir Aubrecht Date: Mon, 10 Aug 2026 18:13:41 +0200 Subject: [PATCH 1/2] Enable SymbolicSgdLogisticRegression (SymSgdNative) on arm64 Build SymSgdNative and a small self-contained libMklImports shim on arm/arm64 so the SymbolicSgdLogisticRegression trainer works there without Intel MKL. - MklImportsArm: implement the four CBLAS routines SymSGD needs (sdot, saxpy, sdoti, saxpyi) as portable C with no external BLAS dependency, plus DFTI stubs. Drop find_package(BLAS) so it configures in the CI cross-compilation sysroots (which ship no BLAS). Export the symbols explicitly since the native build uses -fvisibility=hidden. - CMake: build MklImportsArm + SymSgdNative on arm, link SymSgdNative against the shim, and make the CBLAS calling convention portable. - Directory.Build.targets: ship libMklImports and libSymSgdNative next to the managed assemblies on arm. - SymSgdClassificationTrainer: marshal the native bool parameters of LearnAll as I1. The default 4-byte bool marshalling corrupts later stack arguments and segfaults on arm64. Fixes #5798 Co-authored-by: Anna Maresova Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- Directory.Build.targets | 4 +- .../SymSgdClassificationTrainer.cs | 4 +- src/Native/CMakeLists.txt | 6 +- src/Native/MklImportsArm/CMakeLists.txt | 23 ++++ src/Native/MklImportsArm/MklImportsArm.c | 110 ++++++++++++++++++ src/Native/SymSgdNative/CMakeLists.txt | 6 +- src/Native/SymSgdNative/SparseBLAS.h | 16 ++- 7 files changed, 157 insertions(+), 12 deletions(-) create mode 100644 src/Native/MklImportsArm/CMakeLists.txt create mode 100644 src/Native/MklImportsArm/MklImportsArm.c diff --git a/Directory.Build.targets b/Directory.Build.targets index e086787dc5..19568e2459 100644 --- a/Directory.Build.targets +++ b/Directory.Build.targets @@ -30,10 +30,10 @@ - + - diff --git a/src/Microsoft.ML.Mkl.Components/SymSgdClassificationTrainer.cs b/src/Microsoft.ML.Mkl.Components/SymSgdClassificationTrainer.cs index a56ecda0ba..b31726fdda 100644 --- a/src/Microsoft.ML.Mkl.Components/SymSgdClassificationTrainer.cs +++ b/src/Microsoft.ML.Mkl.Components/SymSgdClassificationTrainer.cs @@ -834,8 +834,8 @@ private static unsafe class Native [DllImport(NativePath), SuppressUnmanagedCodeSecurity] private static extern void LearnAll(int totalNumInstances, int* instSizes, int** instIndices, - float** instValues, float* labels, bool tuneLR, ref float lr, float l2Const, float piw, float* weightVector, ref float bias, - int numFeatres, int numPasses, int numThreads, bool tuneNumLocIter, ref int numLocIter, float tolerance, bool needShuffle, bool shouldInitialize, + float** instValues, float* labels, [MarshalAs(UnmanagedType.I1)] bool tuneLR, ref float lr, float l2Const, float piw, float* weightVector, ref float bias, + int numFeatres, int numPasses, int numThreads, [MarshalAs(UnmanagedType.I1)] bool tuneNumLocIter, ref int numLocIter, float tolerance, [MarshalAs(UnmanagedType.I1)] bool needShuffle, [MarshalAs(UnmanagedType.I1)] bool shouldInitialize, State* state, ChannelCallBack info); /// diff --git a/src/Native/CMakeLists.txt b/src/Native/CMakeLists.txt index 9e3647ede1..846522a489 100644 --- a/src/Native/CMakeLists.txt +++ b/src/Native/CMakeLists.txt @@ -265,9 +265,11 @@ if(NOT ${ARCHITECTURE} MATCHES "arm.*") add_subdirectory(CpuMathNative) add_subdirectory(FastTreeNative) add_subdirectory(MklProxyNative) - # TODO: once we fix the 4 intel MKL methods, SymSgdNative will need to go back in. add_subdirectory(SymSgdNative) - endif() +else() + add_subdirectory(MklImportsArm) + add_subdirectory(SymSgdNative) +endif() if(${ARCHITECTURE} MATCHES "[xX].*64") add_subdirectory(OneDalNative) diff --git a/src/Native/MklImportsArm/CMakeLists.txt b/src/Native/MklImportsArm/CMakeLists.txt new file mode 100644 index 0000000000..34e767a5f8 --- /dev/null +++ b/src/Native/MklImportsArm/CMakeLists.txt @@ -0,0 +1,23 @@ +project(MklImportsArm) + +# On ARM platforms, Intel MKL is not available. This target provides a small, +# self-contained libMklImports covering exactly the symbols SymSGD needs +# (dense/sparse level-1 CBLAS) plus DFTI stubs, with NO external BLAS +# dependency. This is required because the CI cross-compilation sysroots do +# not ship OpenBLAS or any system BLAS. + +set(SOURCES + MklImportsArm.c +) + +if(NOT WIN32) + list(APPEND SOURCES ${VERSION_FILE_PATH}) + SET(CMAKE_SKIP_BUILD_RPATH FALSE) + SET(CMAKE_BUILD_WITH_INSTALL_RPATH FALSE) + SET(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE) + SET(CMAKE_INSTALL_RPATH "$ORIGIN/") +endif() + +add_library(MklImports SHARED ${SOURCES} ${RESOURCES}) + +install_library_and_symbols(MklImports) diff --git a/src/Native/MklImportsArm/MklImportsArm.c b/src/Native/MklImportsArm/MklImportsArm.c new file mode 100644 index 0000000000..c1a15290f1 --- /dev/null +++ b/src/Native/MklImportsArm/MklImportsArm.c @@ -0,0 +1,110 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. +// See the LICENSE file in the project root for more information. + +// ARM replacement for Intel MKL (libMklImports.so). +// +// This provides a small, self-contained libMklImports for arm/arm64 that +// covers exactly the symbols SymSGD needs, with no external BLAS dependency. +// That is important because the cross-compilation sysroots used in CI do not +// ship OpenBLAS (or any system BLAS), so linking against one is not an option. +// +// SymSGD uses only four CBLAS routines: +// * cblas_sdot / cblas_saxpy - dense single-precision dot and AXPY, +// * cblas_sdoti / cblas_saxpyi - their sparse counterparts (MKL extensions). +// All four are implemented below as plain C loops. With -O3 the compiler +// autovectorizes the dense paths to NEON, matching hand-written BLAS closely. +// +// MKL DFTI (FFT) functions are stubbed — they are referenced by the managed +// MKL Components initializer but not used by SymSGD. The stubs return error +// codes so any actual FFT call fails cleanly rather than crashing. + +// The native build is compiled with -fvisibility=hidden, so every symbol that +// must be visible to SymSgdNative (the CBLAS routines) or to the managed +// P/Invoke layer (DftiErrorMessage) has to be exported explicitly. +#if defined(_WIN32) +#define MKLIMPORTS_EXPORT __declspec(dllexport) +#else +#define MKLIMPORTS_EXPORT __attribute__((visibility("default"))) +#endif + +// --- Dense BLAS (CBLAS, level 1) --- + +MKLIMPORTS_EXPORT float cblas_sdot(const int n, const float *x, const int incx, + const float *y, const int incy) +{ + float result = 0.0f; + if (incx == 1 && incy == 1) + { + for (int i = 0; i < n; i++) + result += x[i] * y[i]; + } + else + { + int ix = incx < 0 ? (1 - n) * incx : 0; + int iy = incy < 0 ? (1 - n) * incy : 0; + for (int i = 0; i < n; i++, ix += incx, iy += incy) + result += x[ix] * y[iy]; + } + return result; +} + +MKLIMPORTS_EXPORT void cblas_saxpy(const int n, const float a, const float *x, const int incx, + float *y, const int incy) +{ + if (a == 0.0f) + return; + if (incx == 1 && incy == 1) + { + for (int i = 0; i < n; i++) + y[i] += a * x[i]; + } + else + { + int ix = incx < 0 ? (1 - n) * incx : 0; + int iy = incy < 0 ? (1 - n) * incy : 0; + for (int i = 0; i < n; i++, ix += incx, iy += incy) + y[iy] += a * x[ix]; + } +} + +// --- Sparse BLAS (MKL extensions, not in standard BLAS) --- + +MKLIMPORTS_EXPORT void cblas_saxpyi(const int nz, const float a, + const float *x, const int *indx, float *y) +{ + for (int i = 0; i < nz; i++) + y[indx[i]] += a * x[i]; +} + +MKLIMPORTS_EXPORT float cblas_sdoti(const int nz, const float *x, + const int *indx, const float *y) +{ + float result = 0.0f; + for (int i = 0; i < nz; i++) + result += x[i] * y[indx[i]]; + return result; +} + +// --- DFTI (FFT) stubs --- + +MKLIMPORTS_EXPORT const char* DftiErrorMessage(long status) +{ + return "DFTI not available (arm64 MKL shim build)"; +} + +MKLIMPORTS_EXPORT long DftiCreateDescriptor(void **h, int precision, int domain, int dim, ...) +{ + *h = (void*)0; + return -1; +} + +MKLIMPORTS_EXPORT long DftiSetValue(void *h, int param, ...) +{ + return -1; +} + +MKLIMPORTS_EXPORT long DftiCommitDescriptor(void *h) { return -1; } +MKLIMPORTS_EXPORT long DftiComputeForward(void *h, ...) { return -1; } +MKLIMPORTS_EXPORT long DftiComputeBackward(void *h, ...) { return -1; } +MKLIMPORTS_EXPORT long DftiFreeDescriptor(void **h) { return 0; } diff --git a/src/Native/SymSgdNative/CMakeLists.txt b/src/Native/SymSgdNative/CMakeLists.txt index 01652d2aab..f014b1db76 100644 --- a/src/Native/SymSgdNative/CMakeLists.txt +++ b/src/Native/SymSgdNative/CMakeLists.txt @@ -33,7 +33,11 @@ else() endif() endif() -if(NOT ${ARCHITECTURE} MATCHES "arm.*") +if(${ARCHITECTURE} MATCHES "arm.*") + # On ARM, MklImports is built from MklImportsArm (OpenBLAS-backed). + # Link against the CMake target directly. + set(MKL_LIBRARY MklImports) +else() find_library(MKL_LIBRARY MklImports HINTS ${MKL_LIB_PATH}) endif() diff --git a/src/Native/SymSgdNative/SparseBLAS.h b/src/Native/SymSgdNative/SparseBLAS.h index fdfa1740e2..10e0b6dc83 100644 --- a/src/Native/SymSgdNative/SparseBLAS.h +++ b/src/Native/SymSgdNative/SparseBLAS.h @@ -5,10 +5,16 @@ #pragma once #include "../Stdafx.h" -extern "C" float __cdecl cblas_sdot(const int vecSize, const float* denseVecX, const int incX, const float* denseVecY, const int incY); -extern "C" float __cdecl cblas_sdoti(const int sparseVecSize, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); -extern "C" void __cdecl cblas_saxpy(const int vecSize, const float coef, const float* denseVecX, const int incX, float* denseVecY, const int incY); -extern "C" void __cdecl cblas_saxpyi(const int sparseVecSize, const float coef, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); +#ifdef _WIN32 +#define CBLAS_CALLING_CONV __cdecl +#else +#define CBLAS_CALLING_CONV +#endif + +extern "C" float CBLAS_CALLING_CONV cblas_sdot(const int vecSize, const float* denseVecX, const int incX, const float* denseVecY, const int incY); +extern "C" float CBLAS_CALLING_CONV cblas_sdoti(const int sparseVecSize, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); +extern "C" void CBLAS_CALLING_CONV cblas_saxpy(const int vecSize, const float coef, const float* denseVecX, const int incX, float* denseVecY, const int incY); +extern "C" void CBLAS_CALLING_CONV cblas_saxpyi(const int sparseVecSize, const float coef, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); float SDOT(const int vecSize, const float* denseVecX, const float* denseVecY) { @@ -28,4 +34,4 @@ void SAXPY(const int vecSize, const float* denseVecX, float* denseVecY, float co void SAXPYI(const int sparseVecSize, const int* sparseVecIndices, const float* sparseVecValues, float* denseVec, float coef) { cblas_saxpyi(sparseVecSize, coef, sparseVecValues, sparseVecIndices, denseVec); -} \ No newline at end of file +} From 4de75e4e0e52a8ae00dc51cb4aa4897012a6b35c Mon Sep 17 00:00:00 2001 From: Vladimir Aubrecht Date: Tue, 11 Aug 2026 14:50:30 +0200 Subject: [PATCH 2/2] Address PR review: const-correct cblas_sdoti, null handle in DftiFreeDescriptor, fix misleading comment Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/Native/MklImportsArm/MklImportsArm.c | 10 +++++++++- src/Native/SymSgdNative/CMakeLists.txt | 3 ++- src/Native/SymSgdNative/SparseBLAS.h | 4 ++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src/Native/MklImportsArm/MklImportsArm.c b/src/Native/MklImportsArm/MklImportsArm.c index c1a15290f1..b0db577a39 100644 --- a/src/Native/MklImportsArm/MklImportsArm.c +++ b/src/Native/MklImportsArm/MklImportsArm.c @@ -107,4 +107,12 @@ MKLIMPORTS_EXPORT long DftiSetValue(void *h, int param, ...) MKLIMPORTS_EXPORT long DftiCommitDescriptor(void *h) { return -1; } MKLIMPORTS_EXPORT long DftiComputeForward(void *h, ...) { return -1; } MKLIMPORTS_EXPORT long DftiComputeBackward(void *h, ...) { return -1; } -MKLIMPORTS_EXPORT long DftiFreeDescriptor(void **h) { return 0; } +MKLIMPORTS_EXPORT long DftiFreeDescriptor(void **h) +{ + // Match MKL's contract: clear the caller's handle after freeing so callers + // that rely on the descriptor being nulled out (e.g. the managed + // FreeDescriptor(ref IntPtr) P/Invoke) behave correctly. + if (h != (void*)0) + *h = (void*)0; + return 0; +} diff --git a/src/Native/SymSgdNative/CMakeLists.txt b/src/Native/SymSgdNative/CMakeLists.txt index f014b1db76..212fe017e9 100644 --- a/src/Native/SymSgdNative/CMakeLists.txt +++ b/src/Native/SymSgdNative/CMakeLists.txt @@ -34,7 +34,8 @@ else() endif() if(${ARCHITECTURE} MATCHES "arm.*") - # On ARM, MklImports is built from MklImportsArm (OpenBLAS-backed). + # On ARM, MklImports is built from MklImportsArm, a self-contained CBLAS + # shim implemented as plain C loops (no external BLAS dependency). # Link against the CMake target directly. set(MKL_LIBRARY MklImports) else() diff --git a/src/Native/SymSgdNative/SparseBLAS.h b/src/Native/SymSgdNative/SparseBLAS.h index 10e0b6dc83..0a758131ba 100644 --- a/src/Native/SymSgdNative/SparseBLAS.h +++ b/src/Native/SymSgdNative/SparseBLAS.h @@ -12,7 +12,7 @@ #endif extern "C" float CBLAS_CALLING_CONV cblas_sdot(const int vecSize, const float* denseVecX, const int incX, const float* denseVecY, const int incY); -extern "C" float CBLAS_CALLING_CONV cblas_sdoti(const int sparseVecSize, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); +extern "C" float CBLAS_CALLING_CONV cblas_sdoti(const int sparseVecSize, const float* sparseVecValues, const int* sparseVecIndices, const float* denseVec); extern "C" void CBLAS_CALLING_CONV cblas_saxpy(const int vecSize, const float coef, const float* denseVecX, const int incX, float* denseVecY, const int incY); extern "C" void CBLAS_CALLING_CONV cblas_saxpyi(const int sparseVecSize, const float coef, const float* sparseVecValues, const int* sparseVecIndices, float* denseVec); @@ -21,7 +21,7 @@ float SDOT(const int vecSize, const float* denseVecX, const float* denseVecY) return cblas_sdot(vecSize, denseVecX, 1, denseVecY, 1); } -float SDOTI(const int sparseVecSize, const int* sparseVecIndices, const float* sparseVecValues, float* denseVec) +float SDOTI(const int sparseVecSize, const int* sparseVecIndices, const float* sparseVecValues, const float* denseVec) { return cblas_sdoti(sparseVecSize, sparseVecValues, sparseVecIndices, denseVec); }