Matlab: mex函数介绍，编译器选择设置, OpenMP

mex函数介绍，高级用法,OpenMP

在 MATLAB 中使用 C/C++ 编写MEX 函数（MATLAB Executable）是提升计算性能、调用外部库或复用 C/C++ 代码的核心手段。结合OpenMP等并行技术，可进一步加速计算密集型任务。以下是系统性介绍、高级用法及编译器选择建议。

一、MEX 函数基础

1.什么是 MEX 函数？

• 动态链接库（.mexw64on Windows,.mexa64on Linux），由 MATLAB 调用。
• 使用 C/C++/Fortran 编写，通过MEX API与 MATLAB 数据交互。
• 性能接近原生 C/C++，远高于纯 MATLAB 代码。

2.基本结构（C++ 示例）

// mysum.cpp#include"mex.h"#include<vector>voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[]){// 输入检查if(nrhs!=1)mexErrMsgIdAndTxt("MyToolbox:mysum:invalidNumInputs","One input required.");if(nlhs>1)mexErrMsgIdAndTxt("MyToolbox:mysum:maxOutputs","Too many output arguments.");// 获取输入数组（假设为 double 向量）double*input=mxGetPr(prhs[0]);mwSize n=mxGetNumberOfElements(prhs[0]);// 计算doublesum=0.0;for(mwSize i=0;i<n;++i){sum+=input[i];}// 创建输出plhs[0]=mxCreateDoubleScalar(sum);}

3.编译命令

mex mysum.cpp

MATLAB 自动调用配置好的编译器。

二、高级方法：集成 OpenMP 并行

1.为什么用 OpenMP？

• MEX 函数常用于计算密集型任务（如矩阵运算、图像处理）。
• OpenMP 提供简单指令级并行（#pragma omp parallel for），无需修改算法结构。

2.启用 OpenMP 的步骤

✅ 步骤 1：编写带 OpenMP 的 MEX 代码

// parallel_sum.cpp#include"mex.h"#include<omp.h>voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[]){double*x=mxGetPr(prhs[0]);mwSize n=mxGetNumberOfElements(prhs[0]);doublesum=0.0;#pragmaomp parallelforreduction(+:sum)for(mwSize i=0;i<n;++i){sum+=x[i]*x[i];// 示例：平方和}plhs[0]=mxCreateDoubleScalar(sum);}

✅ 步骤 2：配置编译器支持 OpenMP

方法 A：使用mex命令指定编译选项

% Linux/macOS (GCC/Clang)mex-v COMPFLAGS="$COMPFLAGS-fopenmp" LDFLAGS="$LDFLAGS-fopenmp" parallel_sum.cpp% Windows (MinGW-w64)mex-v COMPFLAGS="$COMPFLAGS-fopenmp" LINKFLAGS="$LINKFLAGS-fopenmp" parallel_sum.cpp% Windows (MSVC)mex-v COMPFLAGS="$COMPFLAGS/openmp" parallel_sum.cpp

💡-v显示详细编译日志，便于调试。

方法 B：修改mexopts.bat（Windows）或mex_C++_maci64.xml（macOS/Linux）

• 位置：prefdir（MATLAB 中运行prefdir获取路径）
• 在<compile>和<link>部分添加 OpenMP 标志

方法 C：使用mexcuda（若涉及 GPU + OpenMP 混合）

• 不推荐，OpenMP 与 CUDA 需谨慎混合。

三、编译器选择与配置

1.查看/设置 MATLAB 编译器

mex-setup C++% 交互式选择mex-setup-v% 查看详细信息

2.各平台推荐编译器

⚠️macOS 特别说明：
Apple Clang 移除了 OpenMP 支持。必须：

1. 安装libomp：brew install libomp
2. 编译命令：

   mex-v CXXFLAGS="$CXXFLAGS-Xclang-fopenmp"...LDFLAGS="$LDFLAGS-lomp" parallel_sum.cpp

四、高级技巧与最佳实践

1.内存管理：避免拷贝大数据

• 使用mxGetData直接访问 MATLAB 数组内存（只读）。
• 若需修改输入，使用mxUnshareArray（R2018a+）避免影响原变量。

2.线程安全：MATLAB API 限制

• MATLAB API 函数（如mexPrintf,mxCreateDoubleMatrix）不是线程安全的！
• OpenMP 并行区域中禁止调用任何 MEX API。
• ✅ 正确做法：并行计算 → 主线程调用 API

// 错误：在 parallel region 中调用 mexPrintf#pragmaomp parallelforfor(...){mexPrintf("Thread %d\n",omp_get_thread_num());// 危险！}// 正确：收集结果后主线程输出std::vector<double>results(num_threads);#pragmaomp parallel{inttid=omp_get_thread_num();// ... 计算 results[tid]}mexPrintf("Done with %d threads\n",num_threads);

3.性能分析

• 使用 MATLAB Profiler 无法深入 MEX 内部。
• 替代方案：
  • 在 MEX 中嵌入计时（omp_get_wtime()）
  • 使用外部工具（Linux:perf, Windows: VTune）

4.错误处理

• 使用mexErrMsgIdAndTxt抛出异常（会终止 MEX 并返回 MATLAB）。
• OpenMP 区域中捕获异常需谨慎（可能破坏并行状态）。

五、完整示例：OpenMP 加速矩阵乘法

// matmul_openmp.cpp#include"mex.h"#include<omp.h>voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[]){// 输入验证if(nrhs!=2)mexErrMsgIdAndTxt("MatMul:nargin","Two inputs required.");if(!mxIsDouble(prhs[0])||!mxIsDouble(prhs[1]))mexErrMsgIdAndTxt("MatMul:inputNotDouble","Inputs must be double.");// 获取矩阵维度mwSize m=mxGetM(prhs[0]);// A: m x kmwSize k=mxGetN(prhs[0]);mwSize k2=mxGetM(prhs[1]);// B: k x nmwSize n=mxGetN(prhs[1]);if(k!=k2)mexErrMsgIdAndTxt("MatMul:dimension","Inner dimensions must agree.");// 创建输出矩阵 C: m x nplhs[0]=mxCreateDoubleMatrix(m,n,mxREAL);double*A=mxGetPr(prhs[0]);double*B=mxGetPr(prhs[1]);double*C=mxGetPr(plhs[0]);// 初始化 C 为 0#pragmaomp parallelforfor(mwSize i=0;i<m*n;++i)C[i]=0.0;// 并行矩阵乘法 (i, j, k 循环)#pragmaomp parallelforcollapse(2)for(mwSize i=0;i<m;++i){for(mwSize j=0;j<n;++j){doublesum=0.0;for(mwSize p=0;p<k;++p){sum+=A[i+p*m]*B[p+j*k];}C[i+j*m]=sum;}}}

编译（Linux/GCC）：

mex-v COMPFLAGS="$COMPFLAGS-fopenmp-O3"...LDFLAGS="$LDFLAGS-fopenmp" matmul_openmp.cpp

六、常见问题解决

七、总结与建议

✅黄金法则：
MEX 函数中，OpenMP 仅用于纯计算逻辑，所有 MATLAB API 调用必须在主线程（非 parallel region）中进行。

通过合理使用 MEX + OpenMP，可轻松获得 4–10 倍性能提升（取决于核心数和算法）。务必进行充分测试，确保数值正确性和稳定性。

使用MinGW不同版本编译套件,使用MinGW编译好的库

是的，MATLAB 完全可以使用其他版本的 MinGW 编译套件（如 MSYS2/MinGW-w64、自定义 GCC 等）来编译 MEX 函数，并链接外部用 MinGW 编译好的静态库（.a）或动态库（.dll）。但需要正确配置编译器路径和链接选项。

以下分三部分详细说明：

一、使用非默认 MinGW 编译器（如 MSYS2/MinGW-w64）

✅ 步骤 1：安装 MinGW-w64（以 MSYS2 为例）

# 安装 MSYS2（https://www.msys2.org/）# 在 MSYS2 MinGW64 shell 中：pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-openblas

安装路径通常为：C:\msys64\mingw64

✅ 步骤 2：配置 MATLAB 使用该 MinGW

MATLAB 默认只识别其内置的 MinGW（R2019a+）。要使用外部 MinGW，需手动创建mexopts.bat（Windows）或修改 XML 配置文件。

方法 A：通过环境变量（推荐，简单）

1. 设置系统环境变量：
   • MW_MINGW64_LOC = C:\msys64\mingw64
2. 重启 MATLAB
3. 运行：

   mex-setup C++

   MATLAB 会自动检测并使用该路径下的 MinGW。

💡 原理：MATLAB 从 R2019a 起支持通过MW_MINGW64_LOC指定 MinGW 根目录。

方法 B：手动创建mexopts.bat（旧版 MATLAB）

• 创建文件：C:\Users\<user>\AppData\Roaming\MathWorks\MATLAB\R2025a\mexopts.bat
• 内容示例（根据你的 MinGW 路径调整）：

  @echo off set MW_MINGW64_PREFIX=C:\msys64\mingw64\bin\ set PATH=%MW_MINGW64_PREFIX%;%PATH%

二、MEX 函数中链接 MinGW 编译的外部库

假设你已用 MinGW 编译了一个静态库mylib.a和头文件mylib.h。

✅ 目录结构示例

project/ ├── mylib.h ├── mylib.a # 静态库（由 MinGW 编译） └── mymex.cpp # MEX 源码

✅ 步骤 1：编写 MEX 源码（mymex.cpp）

#include"mex.h"#include"mylib.h"// 外部库头文件voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[]){doubleresult=mylib_compute(42);// 调用外部库函数plhs[0]=mxCreateDoubleScalar(result);}

✅ 步骤 2：编译 MEX 并链接库

% 在 project 目录下运行mex-I.-L.-lmylib mymex.cpp

• -I.：包含当前目录头文件
• -L.：库文件搜索路径为当前目录
• -lmylib：链接libmylib.a（注意：-lxxx对应libxxx.a）

⚠️关键要求：

• 外部库必须由与 MEX 相同的 MinGW 版本编译（ABI 兼容）
• 若使用动态库（.dll），需将.dll放在 MATLAB 路径或系统 PATH 中

三、完整示例：编译 OpenBLAS 并在 MEX 中调用

场景：用 MinGW 编译 OpenBLAS，供 MEX 调用矩阵乘法

步骤 1：在 MSYS2 中编译 OpenBLAS

# 在 MSYS2 MinGW64 shell 中gitclone https://github.com/xianyi/OpenBLAScdOpenBLASmake-j4# 生成 libopenblas.a 和 libopenblas.dll

步骤 2：编写 MEX 函数（blas_mxm.cpp）

#include"mex.h"extern"C"{voiddgemm_(char*,char*,int*,int*,int*,double*,double*,int*,double*,int*,double*,double*,int*);}voidmexFunction(intnlhs,mxArray*plhs[],intnrhs,constmxArray*prhs[]){// 输入：A (m x k), B (k x n)double*A=mxGetPr(prhs[0]);double*B=mxGetPr(prhs[1]);mwSize m=mxGetM(prhs[0]),k=mxGetN(prhs[0]),n=mxGetN(prhs[1]);// 输出：C = A * Bplhs[0]=mxCreateDoubleMatrix(m,n,mxREAL);double*C=mxGetPr(plhs[0]);// 初始化 C 为 0for(mwSize i=0;i<m*n;++i)C[i]=0.0;// 调用 OpenBLAS dgemmchartransa='N',transb='N';intim=m,in=n,ik=k;doublealpha=1.0,beta=0.0;dgemm_(&transa,&transb,&im,&in,&ik,&alpha,A,&im,B,&ik,&beta,C,&im);}

步骤 3：编译 MEX（在 MATLAB 中）

% 假设 OpenBLAS 编译在 C:\msys64\home\user\OpenBLASopenblas_dir='C:\msys64\home\user\OpenBLAS';mex-I"[openblas_dir]"...-L"[openblas_dir]"...-lopenblas...blas_mxm.cpp

步骤 4：运行测试

A=rand(1000);B=rand(1000);C=blas_mxm(A,B);% 调用 OpenBLAS 加速的矩阵乘法

✅ 优势：比 MATLAB 内置A*B更快（若 OpenBLAS 优化更好）

四、关键注意事项

1.ABI 兼容性

• 必须使用同一 MinGW 工具链编译 MEX 和外部库。
• 混合不同版本（如 TDM-GCC + MSYS2 MinGW）会导致链接错误或运行时崩溃。

2.动态库（DLL）处理

• 若链接.dll（而非.a）：
  • 编译时：mex -L. -lmylib mymex.cpp（仍需.a导入库）
  • 运行时：将mylib.dll放在：
    • MEX 文件同目录
    • 系统 PATH
    • MATLAB 的bin\win64目录

3.C++ 名称修饰（Name Mangling）

• C 库需用extern "C"包裹头文件，避免 C++ 链接错误。
• 示例：

  extern"C"{#include"my_c_library.h"}

4.OpenMP 库冲突

• 若 MEX 和外部库都使用 OpenMP：
  • 必须使用同一 OpenMP 运行时（如都用 GCC 的libgomp）
  • 避免混合 MSVC OpenMP 与 MinGW OpenMP

五、验证编译器是否生效

% 查看当前 MEX 编译器mex-setup-v% 编译时显示详细命令mex-v mymex.cpp

检查输出中是否包含你指定的 MinGW 路径（如C:\msys64\mingw64\bin\g++）。

总结

💡最佳实践：
在 MSYS2 MinGW64 环境中统一编译所有依赖库和 MEX 函数，确保工具链一致性。

通过此方法，你可以无缝集成任何用 MinGW 编译的高性能 C/C++ 库（如 FFTW、GSL、自定义数值库）到 MATLAB 中。