在 Cython 中使用带有 SSE 内在函数的 C 联合会导致 SIGSEGV
Using C union with SSE intrinsics in Cython results in SIGSEGV
我有以下 C 代码片段，我想用 Cython 包装并在我的 Python 程序中使用：
typedef union my_mat4
{
float Elements[4][4];
#ifdef MAT4_MATH__USE_SSE
__m128 Rows[4];
#endif
} my_mat4;
static inline my_mat4 init_my_mat4(void)
{
my_mat4 Result = {0};
return (Result);
}
我将此代码包装在 mat4.pxd 中，如下所示：
cdef extern from "mat4.h":
ctypedef union my_mat4:
float Elements[4][4]
my_mat4 init_my_mat4()
cdef class MyClass:
cdef my_mat4 m
cdef object o
和mat4.pyx代码：
cdef class MyClass:
def __cinit__(self):
self.m = init_my_mat4()
当我在 Python
中使用 MyClass 时
my_class = MyClass()
Python 退出并显示消息 进程已完成，退出代码为 139（被信号 11 中断：SIGSEGV）.
但是，当我从 C 联合中禁用 MAT4_MATH__USE_SSE 时，程序运行正常。即使我从 MyClass 中删除 cdef object o，一切运行正常。
我广泛搜索了解决方案，但找不到任何东西。这是某种对齐问题吗？
谢谢，
A.
编辑 1：
Python程序仅在导入模块decimal并且在Cython扩展模块中编译__m128时才会崩溃，所以：
import decimal
my_class = MyClass()
使解释器崩溃（我的 Ubuntu 程序启动器上出现启动图标）
编辑 2：
正如@DavidW 在评论中所说，在这种情况下，导入小数点可能并不重要——对他来说，没有导入的程序段错误，通过导入运行。
编辑 3：
正如@PeterCordes 所写，几乎可以肯定这是错位问题。解决方案是从 union 中删除 __m128 成员，并使用 _mm_loadu_ps.
提出提议的 load_vec() 或类似的宏
编辑 4：
另一个解决方案是使用 unaligned__m128 定义为 typedef float __attribute((vector_size(16), aligned(4))) unaligned__m128; 而不是联合中的 __m128。谢谢@PeterCordes。
Is this some kind of alignment problem?
几乎可以肯定。
C 编译器假定 __m128 object 具有 16 字节对齐，并使用 movaps 到 load/store 它，或者将它用作其他内存操作数SSE 指令（如 addps xmm0, [mem]）。如果指针 不 具有 16 字节对齐，这些使用将在运行时出错。
但是你没有告诉Python分配float Elements[4][4]有任何类型的对齐保证，所以传递给C的指针会给你无效的union object 违反联合对其 most-aligned 成员足够对齐的要求。
如果你不能让 Python 保证你的 objects 的 16 字节对齐，那么你将不得不将你的 C 更改为仍然有效（效率稍低）。在启用 AVX 的情况下进行编译（gcc -O3 -march=native 在 AVX CPU 上）将允许编译器使用未对齐的 16 字节向量作为内存操作数。但它仍然不会使未对齐的 __m128 安全，因为它仍然会存储 vmovaps 而不是 vmovups.
现代硬件具有高效的未对齐负载支持，但 cache-line 拆分仍然不理想。 Instruction-count 也更糟，因为对于 AVX，编译器将不得不使用单独的 movups 加载而不是 addps xmm0, [mem] 来加载只需要加载一次的数据。
在 C 中，删除 __m128 成员，并使用 _mm_loadu_ps() 进行未对齐加载。
typedef struct my_mat4 { float Elements[4][4]; } my_mat4;
static inline
__m128 load_vec(const struct my_mat4 *m4, size_t idx) {
_mm_loadu_ps(&m4->Elements[idx][0]);
}
使用 GNU C：使用 __m128
的未对齐版本重新定义联合
让 Python 对齐您的 object 是最有效的，但如果不是，这将让您编译现有代码，只需对 object 进行一次更改:
__m128 是根据 GNU C 本地向量 in xmmintrin.h#69 定义的。 （其他支持GNU扩展的编译器是兼容的，至少clang是兼容的。）
typedef float __m128 attribute ((vector_size (16), may_alias));
header已经定义了一个未对齐的__m128_u，它也使用了aligned(1)。我们可以使用 aligned(4) 来保证它至少在 float 边界上对齐，以防万一。
这是可行的，因为同一向量类型的不同对齐版本可以自由转换，因此将它传递给内在函数的代码可以在没有警告的情况下进行编译（即使在 -Wall）。
typedef float __attribute((vector_size(16), aligned(4))) unaligned__m128;
// I left out may_alias, only matters if you're using unaligned__m128* to load from non-float data.
// Probably doesn't hurt code-gen if you aren't using unaligned__m128* at all, just objects
//#define __m128 unaligned__m128 // not needed
typedef union my_mat4 {
float Elements[4][4];
unaligned__m128 Rows[4];
} my_mat4;
使用这种类型的函数编译得很好 (gcc8.1 on the Godbolt compiler explorer)。 （您也可以编写 m4->Rows[1] + m4->Rows[2]，即使是在 C 而不是 C++ 中，因为 GNU C 原生向量将 C 运算符映射到 per-element 操作。
__m128 use_row(union my_mat4 *m4) {
__m128 tmp = _mm_add_ps(m4->Rows[1], m4->Rows[2]);
m4->Rows[3] = tmp;
return tmp;
}
只要-O3（没有-march），我们得到
movups xmm0, XMMWORD PTR [rdi+32] # unaligned loads
movups xmm1, XMMWORD PTR [rdi+16]
addps xmm0, xmm1
movups XMMWORD PTR [rdi+48], xmm0 # unaligned store
ret
但是使用 -mavx（例如，由 -march=haswell 启用），我们得到
use_row(my_mat4*):
vmovups xmm1, XMMWORD PTR [rdi+32]
vaddps xmm0, xmm1, XMMWORD PTR [rdi+16] # unaligned memory source is ok for AVX
vmovups XMMWORD PTR [rdi+48], xmm0
ret
当然你希望这些函数内联，我只做了它们 non-inline 所以我可以看看它们是如何编译的。 (How to remove "noise" from GCC/clang assembly output?).
顺便说一句，如果您曾经将此联合用作更广泛结构的成员，则定义 MAT4_MATH__USE_SSE 可以更改 ABI。如果 my_mat4 对齐，struct {int foo; my_mat4 m4; }; 需要 12 个字节的填充，否则不需要填充。
如果你编译一些有宏定义的 C 和一些没有宏定义的 C，你可以做这样的事情（如果你已经解决了让 Python 对齐 objects):
#include <stdalign.h>
// give the same alignment regardless of whether the macro is defined.
typedef union my_mat4
{
alignas(16) float Elements[4][4];
#ifdef MAT4_MATH__USE_SSE
__m128 Rows[4];
#endif
} my_mat4;
如果您不想在宏未定义时保证对齐，也可以不这样做。
我有以下 C 代码片段，我想用 Cython 包装并在我的 Python 程序中使用：
typedef union my_mat4
{
float Elements[4][4];
#ifdef MAT4_MATH__USE_SSE
__m128 Rows[4];
#endif
} my_mat4;
static inline my_mat4 init_my_mat4(void)
{
my_mat4 Result = {0};
return (Result);
}
我将此代码包装在 mat4.pxd 中，如下所示：
cdef extern from "mat4.h":
ctypedef union my_mat4:
float Elements[4][4]
my_mat4 init_my_mat4()
cdef class MyClass:
cdef my_mat4 m
cdef object o
和mat4.pyx代码：
cdef class MyClass:
def __cinit__(self):
self.m = init_my_mat4()
当我在 Python
中使用 MyClass 时my_class = MyClass()
Python 退出并显示消息 进程已完成，退出代码为 139（被信号 11 中断：SIGSEGV）.
但是，当我从 C 联合中禁用 MAT4_MATH__USE_SSE 时，程序运行正常。即使我从 MyClass 中删除 cdef object o，一切运行正常。
我广泛搜索了解决方案，但找不到任何东西。这是某种对齐问题吗？
谢谢， A.
编辑 1：
Python程序仅在导入模块decimal并且在Cython扩展模块中编译__m128时才会崩溃，所以：
import decimal
my_class = MyClass()
使解释器崩溃（我的 Ubuntu 程序启动器上出现启动图标）
编辑 2：
正如@DavidW 在评论中所说，在这种情况下，导入小数点可能并不重要——对他来说，没有导入的程序段错误，通过导入运行。
编辑 3：
正如@PeterCordes 所写，几乎可以肯定这是错位问题。解决方案是从 union 中删除 __m128 成员，并使用 _mm_loadu_ps.
load_vec() 或类似的宏
编辑 4：
另一个解决方案是使用 unaligned__m128 定义为 typedef float __attribute((vector_size(16), aligned(4))) unaligned__m128; 而不是联合中的 __m128。谢谢@PeterCordes。
Is this some kind of alignment problem?
几乎可以肯定。
C 编译器假定 __m128 object 具有 16 字节对齐，并使用 movaps 到 load/store 它，或者将它用作其他内存操作数SSE 指令（如 addps xmm0, [mem]）。如果指针 不 具有 16 字节对齐，这些使用将在运行时出错。
但是你没有告诉Python分配float Elements[4][4]有任何类型的对齐保证，所以传递给C的指针会给你无效的union object 违反联合对其 most-aligned 成员足够对齐的要求。
如果你不能让 Python 保证你的 objects 的 16 字节对齐，那么你将不得不将你的 C 更改为仍然有效（效率稍低）。在启用 AVX 的情况下进行编译（gcc -O3 -march=native 在 AVX CPU 上）将允许编译器使用未对齐的 16 字节向量作为内存操作数。但它仍然不会使未对齐的 __m128 安全，因为它仍然会存储 vmovaps 而不是 vmovups.
现代硬件具有高效的未对齐负载支持，但 cache-line 拆分仍然不理想。 Instruction-count 也更糟，因为对于 AVX，编译器将不得不使用单独的 movups 加载而不是 addps xmm0, [mem] 来加载只需要加载一次的数据。
在 C 中，删除 __m128 成员，并使用 _mm_loadu_ps() 进行未对齐加载。
typedef struct my_mat4 { float Elements[4][4]; } my_mat4;
static inline
__m128 load_vec(const struct my_mat4 *m4, size_t idx) {
_mm_loadu_ps(&m4->Elements[idx][0]);
}
使用 GNU C：使用 __m128
的未对齐版本重新定义联合
让 Python 对齐您的 object 是最有效的，但如果不是，这将让您编译现有代码，只需对 object 进行一次更改:
__m128 是根据 GNU C 本地向量 in xmmintrin.h#69 定义的。 （其他支持GNU扩展的编译器是兼容的，至少clang是兼容的。）
typedef float __m128 attribute ((vector_size (16), may_alias));
header已经定义了一个未对齐的__m128_u，它也使用了aligned(1)。我们可以使用 aligned(4) 来保证它至少在 float 边界上对齐，以防万一。
这是可行的，因为同一向量类型的不同对齐版本可以自由转换，因此将它传递给内在函数的代码可以在没有警告的情况下进行编译（即使在 -Wall）。
typedef float __attribute((vector_size(16), aligned(4))) unaligned__m128;
// I left out may_alias, only matters if you're using unaligned__m128* to load from non-float data.
// Probably doesn't hurt code-gen if you aren't using unaligned__m128* at all, just objects
//#define __m128 unaligned__m128 // not needed
typedef union my_mat4 {
float Elements[4][4];
unaligned__m128 Rows[4];
} my_mat4;
使用这种类型的函数编译得很好 (gcc8.1 on the Godbolt compiler explorer)。 （您也可以编写 m4->Rows[1] + m4->Rows[2]，即使是在 C 而不是 C++ 中，因为 GNU C 原生向量将 C 运算符映射到 per-element 操作。
__m128 use_row(union my_mat4 *m4) {
__m128 tmp = _mm_add_ps(m4->Rows[1], m4->Rows[2]);
m4->Rows[3] = tmp;
return tmp;
}
只要-O3（没有-march），我们得到
movups xmm0, XMMWORD PTR [rdi+32] # unaligned loads
movups xmm1, XMMWORD PTR [rdi+16]
addps xmm0, xmm1
movups XMMWORD PTR [rdi+48], xmm0 # unaligned store
ret
但是使用 -mavx（例如，由 -march=haswell 启用），我们得到
use_row(my_mat4*):
vmovups xmm1, XMMWORD PTR [rdi+32]
vaddps xmm0, xmm1, XMMWORD PTR [rdi+16] # unaligned memory source is ok for AVX
vmovups XMMWORD PTR [rdi+48], xmm0
ret
当然你希望这些函数内联，我只做了它们 non-inline 所以我可以看看它们是如何编译的。 (How to remove "noise" from GCC/clang assembly output?).
顺便说一句，如果您曾经将此联合用作更广泛结构的成员，则定义 MAT4_MATH__USE_SSE 可以更改 ABI。如果 my_mat4 对齐，struct {int foo; my_mat4 m4; }; 需要 12 个字节的填充，否则不需要填充。
如果你编译一些有宏定义的 C 和一些没有宏定义的 C，你可以做这样的事情（如果你已经解决了让 Python 对齐 objects):
#include <stdalign.h>
// give the same alignment regardless of whether the macro is defined.
typedef union my_mat4
{
alignas(16) float Elements[4][4];
#ifdef MAT4_MATH__USE_SSE
__m128 Rows[4];
#endif
} my_mat4;
如果您不想在宏未定义时保证对齐，也可以不这样做。