MNN/docs/compile/cmake.md

# 编译宏介绍
MNN使用CMake构建项目，CMake中的宏定义列表如下：

|          宏名         |         宏说明         |
| -------------------- | ---------------------- |
| MNN_USE_SYSTEM_LIB   | 在使用`opencl`和`vulkan`时，使用系统库（`ON`）还是通过`dlopen`引入动态库（`OFF`），默认为`OFF` |
| MNN_BUILD_HARD       | 是否使用`-mfloat-abi=hard`，默认为`OFF` |
| MNN_BUILD_SHARED_LIBS   | 是否构建为动态库，默认为`ON` |
| MNN_WIN_RUNTIME_MT      | 在Windows上构建`dll`时是否使用`/MT`，默认为`OFF` |
| MNN_FORBID_MULTI_THREAD | 是否禁止多线程，默认为`OFF` |
| MNN_OPENMP           | 是否使用`OpenMP`的线程池，该选项在`Mac/iOS`平台无效，默认为`OFF` |
| MNN_USE_THREAD_POOL  | 是否使用MNN内部线程池，默认为`ON` |
| MNN_BUILD_TRAIN      | 是否构建MNN的训练框架，默认为`OFF` |
| MNN_BUILD_DEMO       | 是否构建MNN的demo，默认为`OFF` |
| MNN_BUILD_TOOLS      | 是否构建MNN的测试工具，默认为`ON` |
| MNN_BUILD_QUANTOOLS  | 是否构建MNN的量化工具，默认为`OFF` |
| MNN_EVALUATION       | 是否构建MNN的评估工具，默认为`OFF` |
| MNN_BUILD_CONVERTER  | 是否构建MNN的转换工具，默认为`OFF` |
| MNN_SUPPORT_QUANT_EXTEND    | 是否编译非核心算子（Binary/Unary/LayerNorm等）的量化版本，默认为`ON` |
| MNN_SUPPORT_DEPRECATED_OP   | 是否支持Tflite的量化算子等已经废弃的算子，用于兼容历史模型(1.1.0版本之前)，默认为`OFF` |
| MNN_SUPPORT_DEPRECATED_OPV2 | 是否编译MNN更新到3.0之后已经废弃的算子，用于兼容历史模型(3.0.0版本之前)，比如 `Convolution3D` / `ConvTranspose3D`，在3.0.0 版本之后改由模型转换器转化为对应2D算子，不再需要运行时支持，默认为`ON` |
| MNN_REDUCE_SIZE      | 是否裁剪MNN库大小，去除求导相关算子，减少优化策略，默认为`OFF` ，开启时，`MNN_SUPPORT_QUANT_EXTEND` / `MNN_SUPPORT_DEPRECATED_OP` / `MNN_SUPPORT_DEPRECATED_OPV2` / `MNN_USE_SPARSE_COMPUTE` 都会设成 `OFF` |
| MNN_DEBUG_MEMORY     | 是否开启MNN内存调试，默认为`OFF` |
| MNN_DEBUG_TENSOR_SIZE | 是否开启MNN tensor size调试，默认为`OFF` |
| MNN_GPU_TRACE        | 是否开启MNN GPU调试，默认为`OFF` |
| MNN_SEP_BUILD        | 是否构建MNN的后端和表达式分离版本，只在`MNN_BUILD_SHARED_LIBS=ON`时生效，默认为`ON` |
| NATIVE_LIBRARY_OUTPUT | 如果构建为动态库，则指定动态库的输出路径，默认为`OFF` |
| NATIVE_INCLUDE_OUTPUT | 如果构建为动态库，则指定动态库的头文件路径，默认为`OFF` |
| MNN_AAPL_FMWK        | 是否构建`MNN.framework`替代`*.dylib`，默认为`OFF` |
| MNN_WITH_PLUGIN      | 是否支持`Plugin算子`，默认为`OFF` |
| MNN_SKIPBUILD_GEOMETRY   | 是否跳过MNN的几何计算编译，若是，MNN引擎仅支持在模型转换工具时加上 --saveStaticModel 转换出来的固定输入形状的模型，默认为`OFF` |
| MNN_BUILD_MINI       | 是否构建MNN的最小化版本，若是，开启 `MNN_SKIPBUILD_GEOMETRY` 和 `MNN_REDUCE_SIZE`，默认为`OFF` |
| MNN_USE_SSE          | 在x86上是否使用SSE指令集，默认为`OFF` |
| MNN_BUILD_CODEGEN    | 是否构建MNN的代码生成部分，该功能提供了算子融合与代码生成能力，为实验性功能，默认为`OFF` |
| MNN_ENABLE_COVERAGE  | 是否开启MNN的代码覆盖率，默认为`OFF` |
| MNN_BUILD_PROTOBUFFER | 是否使用MNN中的`protobuffer`，默认为`ON` |
| MNN_BUILD_OPENCV     | 是否构建MNN的OpenCV功能，默认为`OFF` |
| MNN_BUILD_AUDIO      | 是否构建MNN的Audio功能，默认为`OFF` |
| MNN_INTERNAL         | 是否构建MNN的一些内部功能，如：日志；默认为`OFF` |
| MNN_JNI              | 是否构建MNN的JNI支持，默认为`OFF` |
| MNN_METAL            | 是否构建`Metal`后端，默认为`OFF` |
| MNN_OPENCL           | 是否构建`OpenCL`后端，默认为`OFF` |
| MNN_OPENGL           | 是否构建`OpenGL`后端，默认为`OFF` |
| MNN_VULKAN           | 是否构建`Vulkan`后端，默认为`OFF` |
| MNN_ARM82            | 编译ARM架构时，是否构建`Armv8.2`后端，以支持FP16计算，默认为`ON` |
| MNN_SME2             | 编译ARM架构时，是否构建`ArmSme2`后端，以支持使用sme2指令集计算，默认为`ON` |
| MNN_SUPPORT_FP16_ARMV7            | 编译armeabi-v7a架构时，是否构建`Armv8.2`后端，以支持FP16计算，默认为`OFF` |
| MNN_ONEDNN           | 是否使用`oneDNN`，默认为`OFF` |
| MNN_AVX2             | 在`MNN_USE_SSE`开启的基础上，是否增加AVX2指令的支持，默认为`ON` |
| MNN_AVX512           | 在`MNN_USE_SSE`和`MNN_AVX2`开启的基础上，是否增加`avx512`指令集的支持，默认为`OFF` |
| MNN_CUDA             | 是否构建`Cuda`后端，默认为`OFF` |
| MNN_CUDA_PROFILE     | 是否打开CUDA profile工具，默认为`OFF` |
| MNN_CUDA_QUANT       | 是否打开CUDA 量化文件编译，默认为`OFF` |
| MNN_CUDA_BF16        | 是否打开CUDA Bf16文件编译，默认为`OFF` |
| MNN_CUDA_TUNE_PARAM  | 是否打开CUDA TUNE相关文件编译，目前仅支持安培及以上架构，默认为`OFF` |
| MNN_TENSORRT         | 是否构建`TensorRT`后端，默认为`OFF` |
| MNN_COREML           | 是否构建`CoreML`后端，默认为`OFF` |
| MNN_NNAPI            | 是否构建`NNAPI`后端，默认为`OFF`  |
| MNN_QNN              | 是否构建`QNN`后端，默认为`OFF` |
| MNN_QNN_ONLINE_FINALIZE | 在`MNN_QNN`开启的基础上,是否构建在线编译模式的QNN后端，默认为`ON` |
| MNN_QNN_CONVERT_MODE | 在`MNN_QNN`开启的基础上,是否构建Convert模式的QNN后端，默认为`OFF` |
| MNN_NPU            | 是否构建HIAI的`NPU`后端，默认为`OFF`  |
| MNN_USE_SPARSE_COMPUTE | 是否使用稀疏计算，默认为`ON` |
| MNN_BUILD_BENCHMARK  | 是否构建MNN的性能测试，默认为`OFF` |
| MNN_BUILD_TEST       | 是否构建MNN的单元测试，默认为`OFF` |
| MNN_BUILD_FOR_ANDROID_COMMAND | 是否使用命令行构建`Android`，默认为`OFF` |
| MNN_USE_LOGCAT       | 是否使用`logcat`代替`printf`输出日志，默认为`ON` |
| MNN_USE_CPP11        | 是否使用`C++11`编译MNN，默认为`ON` |
| MNN_SUPPORT_BF16     | 是否支持`BF16`，默认为`OFF` |
| MNN_SSE_USE_FP16_INSTEAD | 在X86平台是否使用`FP16`替代`BF16`，默认为`OFF` |
| MNN_AVX512_VNNI      | 是否使用`avx512_vnni`指令，该宏仅在`MNN_AVX512=ON`时生效，默认为`OFF` |
| MNN_OPENCL_SIZE_CUT  | 是否为了降低OpenCL大小而关闭OpenCL Buffer实现，该宏仅在`MNN_OPENCL=ON`时生效，默认为`OFF` |
| MNN_GPU_TIME_PROFILE | 是否打开OpenCL后端及Vulkan后端的Kernel性能Profile，该宏仅在`MNN_OPENCL=ON`或`MNN_VULKAN=ON`时生效，默认为`OFF` |
| MNN_METALLIB_SOURCE  | 使用Metal时是否直接使用Metal源码，该宏仅在`MNN_METAL=ON`时生效，默认为`ON` |
| MNN_VULKAN_DEBUG     | 是否打开Vulkan的DEBUG模式，该宏仅在`MNN_VULKAN=ON`时生效，默认为`OFF` |
| MNN_OPENGL_REGEN     | 是否重新生成OpenGL Kenel，该宏仅在`MNN_OPENGL=ON`时生效，默认为`OFF` |
| MNN_TRT_DYNAMIC      | 是否通过dlopen的方式引入TRT的动态库，该宏仅在`MNN_TENSORRT=ON`时生效，默认为`OFF` |
| MNN_BUILD_TORCH      | 构建的`MNNConvert`是否支持`TorchScript`，该宏仅在`MNN_BUILD_CONVERTER=ON`时生效，默认为`OFF` |
| MNN_TRAIN_DEBUG      | 构建的训练模块是否支持调试，该宏仅在`MNN_BUILD_TRAIN=ON`时生效，默认为`OFF` |
| MNN_USE_OPENCV       | 构建的训练Demo是否使用`OpenCV`依赖，该宏仅在`MNN_BUILD_TRAIN=ON`时生效，默认为`OFF` |
| MNN_IMGPROC_COLOR    | 构建MNN的OpenCV功能是否开启`颜色空间转换`，默认为`ON` |
| MNN_IMGPROC_GEOMETRIC | 构建MNN的OpenCV功能是否开启`形变`，默认为`ON` |
| MNN_IMGPROC_DRAW     | 构建MNN的OpenCV功能是否开启`画图`，默认为`ON` |
| MNN_IMGPROC_FILTER   | 构建MNN的OpenCV功能是否开启`滤波`，默认为`ON` |
| MNN_IMGPROC_MISCELLANEOUS | 构建MNN的OpenCV功能是否开启`混合`，默认为`ON` |
| MNN_IMGPROC_STRUCTRAL | 构建MNN的OpenCV功能是否开启`结构`，默认为`ON` |
| MNN_IMGPROC_HISTOGRAMS | 构建MNN的OpenCV功能是否开启`直方图`，默认为`ON` |
| MNN_CALIB3D          | 构建MNN的OpenCV功能是否开启`3d`，默认为`ON` |
| MNN_IMGCODECS        | 构建MNN的OpenCV功能是否开启`图像编解码`，默认为`OFF` |
| MNN_CVCORE           | 构建MNN的OpenCV功能是否开启`core`功能，默认为`ON` |
| MNN_OPENCV_TEST      | 构建MNN的OpenCV功能是否开启单元测试，默认为`OFF` |
| MNN_OPENCV_BENCH     | 构建MNN的OpenCV功能是否开启性能benchmark，默认为`OFF` |
| MNN_AUDIO_TEST       | 构建MNN的Audio功能是否开启单元测试，默认为`OFF` |
| MNN_VULKAN_IMAGE     | 构建MNN的Vulkan后端时采用Image内存模式，以便支持FP16和部分移动端上GPU的加速，默认为`ON` |
| MNN_LOW_MEMORY       | 是否支持低内存模式，支持低内存模式使用权值量化模型并设置`low_memory`则会使用计算时反量化，默认为`OFF` |
| MNN_CPU_WEIGHT_DEQUANT_GEMM       | 是否编译CPU权重反量化的矩阵乘Kernel， 如果打开该编译宏并且在CPU推理时设置MNN::BackendConfig::MemoryMode=Memory_Normal，就会使用权重反量化算子进行权重量化模型的推理，默认为`OFF` |
| MNN_SUPPORT_RENDER   | 是否支持图形渲染相关算子实现，默认为 `OFF` |
| MNN_SUPPORT_TRANSFORMER_FUSE | 是否支持Fuse Transformer相关OP实现，默认为 `OFF` |
| MNN_BUILD_LLM        | 是否构建基于MNN的llm库和demo，默认为`OFF` ，打开时 MNN_LOW_MEMORY , MNN_SUPPORT_TRANSFORMER_FUSE 对应开启|
| MNN_BUILD_LLM_OMNI        | 若构建基于MNN的llm库和demo，是否支持图像和音频输入功能，默认为`OFF` 。仅在MNN_BUILD_LLM 打开时生效。开启时 MNN_BUILD_OPENCV , MNN_IMGCODECS , MNN_BUILD_AUDIO 同时打开|
| MNN_BUILD_DIFFUSION  | 是否构建基于MNN的diffusion demo，默认为`OFF` . 打开时MNN_BUILD_OPENCV , MNN_IMGCODECS, MNN_LOW_MEMORY, MNN_SUPPORT_TRANSFORMER_FUSE 同步开启|
| MNN_KLEIDIAI         | 是否集成ARM的klediAI加速库，默认为`ON` |
| MNN_USE_RVV          | 是否启用RISC-V向量扩展支持，默认为`OFF` |