SetCompileConfig

函数功能

设置FunctionPp的json配置文件名字和路径，该配置文件用于将FunctionPp和UDF进行映射。

返回设置好的FunctionPp。

函数原型

FunctionPp &SetCompileConfig(const char_t *json_file_path)

参数说明

{"func_list":[{"func_name":"Add", "inputs_index":[1,0], "outputs_index":[0]}],"input_num":2,"output_num":1,"target_bin":"libadd.so","workspace":"./","cmakelist_path":"CMakeLists.txt","compiler", "./cpu_compile.json","running_resources_info":[{"type":"cpu","num":2},{"type":"memory","num":100}],"heavy_load":false}

• compiler的json配置文件
  内容示例如下，各字段解释如所示。

  {"compiler":[{"resource_type":"X86","toolchain":"/usr/bin/g++"},{"resource_type":"Aarch","toolchain":"/usr/bin/g++"},{"resource_type":"Ascend","toolchain":"/usr/local/Ascend/hcc"}]}

  表2 compiler的json配置文件

  配置项	可选/必选	描述
  compiler	必选	值为list，list的元素为单个资源类型的编译工具的描述。
  compiler.resource_type	必选	值为字符串，设备支持的资源类型。
  compiler.toolchain	必选	值为字符串，该资源类型对应的编译工具路径。

• CMakeLists文件

  DataFlow UDF编译模块解析异构环境的resource.json资源配置和cpu_compiler配置，根据resource.json资源配置类型匹配选择cpu_compiler中指定的交叉编译工具，如果用户未指定cpu_compiler.json配置文件或者cpu_compiler.json未配置该类型的编译工具，则取环境上默认的编译工具进行编译。不同资源类型的编译工具名称和路径如下。${INSTALL_DIR}请替换为CANN软件安装后文件存储路径。例如，若安装的Ascend-cann-toolkit软件包，则安装后文件存储路径为：$HOME/Ascend/ascend-toolkit/latest。

  • X86和Aarch场景下：g++
  • Ascend场景下：${INSTALL_DIR}/toolkit/toolchain/hcc/bin/aarch64-target-linux-gnu-g++
  用户的源代码工程要遵从如下规则：

  • 用户提供的源码工程目录下要包括所有执行代码和依赖库源码。
  • 用户要配置好FuntionPp执行代码和依赖库的编译脚本。
  • 编译脚本要使用RELEASE_DIR变量作为最终输出目录，如果有依赖的so文件，用户需要把依赖的so文件拷贝到该路径下。
  • 编译脚本要使用RESOURCE_TYPE变量判断资源类型，如果当前UDF不支持某一个资源类型，需要将对应的注释放开。
  • CMakeLists sample如下：

    cmake_minimum_required(VERSION 3.5)
    PROJECT(UDF)
    if ("x${RESOURCE_TYPE}" STREQUAL "xAscend")
      message(STATUS "ascend compiler enter")
      # if unsupport current resource type, please uncomment the next line.
      # message(FATAL_ERROR "Unsupport compile Ascend target!")
    elseif("x${RESOURCE_TYPE}" STREQUAL "xAarch")
      message(STATUS "aarch64 compiler enter")
      # if unsupport current resource type, please uncomment the next line.
      # message(FATAL_ERROR "Unsupport compile Aarch64 target!")
    else()
      message(STATUS "x86 compiler enter")
      # if unsupport current resource type, please uncomment the next line.
      # message(FATAL_ERROR "Unsupport compile X86 target!")
    endif()
    
    if(DEFINED ENV{ASCEND_INSTALL_PATH})
      set(ASCEND_INSTALL_PATH $ENV{ASCEND_INSTALL_PATH})
      message(STATUS "Read ASCEND_INSTALL_PATH from ENV: ${ASCEND_INSTALL_PATH}")
    else()
      set(ASCEND_INSTALL_PATH /usr/local/Ascend)
      message(STATUS "Default ASCEND_INSTALL_PATH=${ASCEND_INSTALL_PATH}, you can export ASCEND_INSTALL_PATH to set this environment")
    endif()
    
    # set dynamic library output path
    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/${RELEASE_DIR})
    # set static library output path
    set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/${RELEASE_DIR})
    
    message(STATUS "CMAKE_LIBRARY_OUTPUT_DIRECTORY= ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}")
    
    set(INC_DIR "${ASCEND_INSTALL_PATH}/latest/x86_64-linux/include/flow_func")
    file(GLOB SRC_LIST "*.cpp")
    
    # Specify cross compiler
    add_definitions(-D_GLIBCXX_USE_CXX11_ABI=0)
    
    # set c++ compiler
    set(CMAKE_CXX_COMPILER ${TOOLCHAIN})
    
    # =========================UDF so compile============================
    # check if SRC_LIST is exist
    if("x${SRC_LIST}" STREQUAL "x")
        message(UDF "=========no source file=============")
        add_custom_target(${UDF_TARGET_LIB}
            COMMAND echo "no source to make lib${UDF_TARGET_LIB}.so")
        return(0)
    endif()
    
    add_library(${UDF_TARGET_LIB} SHARED
      ${SRC_LIST}
    )
    
    target_include_directories(${UDF_TARGET_LIB} PRIVATE
      ${INC_DIR}
    )
    
    target_compile_options(${UDF_TARGET_LIB} PRIVATE
      -O2
      -std=c++11
      -ftrapv  
      -fstack-protector-all
      -fPIC
    )
    
    if ("x${RESOURCE_TYPE}" STREQUAL "xAscend")
      target_link_libraries(${UDF_TARGET_LIB} PRIVATE 
        -Wl,--whole-archive
        ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/aarch64/libflow_func.so
        -Wl,--no-whole-archive
      )
      # If there have any dependent so, please release the following comments and copy dependent so to ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      # [[execute_process(
        COMMAND cp ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/aarch64/libflow_func.so ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      )]]
    elseif("x${RESOURCE_TYPE}" STREQUAL "xAarch")
      target_link_libraries(${UDF_TARGET_LIB} PRIVATE 
        -Wl,--whole-archive
        ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/aarch64/libflow_func.so
        -Wl,--no-whole-archive
      )
      # If there have any dependent so, please release the following comments and copy dependent so to ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      # [[execute_process(
        COMMAND cp ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/aarch64/libflow_func.so ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      )]]
    else()
      target_link_libraries(${UDF_TARGET_LIB} PRIVATE 
        -Wl,--whole-archive
        ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/x86_64/libflow_func.so
        -Wl,--no-whole-archive
      )
      # If there have any dependent so, please release the following comments and copy dependent so to ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      # [[execute_process(
        COMMAND cp ${ASCEND_INSTALL_PATH}/latest/x86_64-linux/lib64/stub/x86_64/libflow_func.so ${PROJECT_BINARY_DIR}/${RELEASE_DIR}
      )]]
    endif()
    

返回值

返回设置好的FunctionPp。

异常处理

无。

约束说明

无。