[Feature](gtest): Add mluOpGetGenCaseDirectory/mluOpSetGenCaseDirectory funcs. (#1216)

Co-authored-by: wanglingfeng <[email protected]>

Author: wanglingf

core/gen_case.cpp

@@ -168,6 +168,41 @@ void genCaseModeSet(int mode) {
   LOG(INFO) << "[gen_case] Set GEN_CASE mode to " << mode << ".";
 }
 
+std::string genCaseConfig::replacePlaceholder(std::string pathStr) {
+  size_t pos = pathStr.find("{pid}");
+  if (pos != std::string::npos) {
+    pathStr.replace(pos, 5, "pid" + std::to_string(syscall(SYS_getpid)));
+  }
+  pos = pathStr.find("{deviceid}");
+  if (pos != std::string::npos) {
+    int dev_index = -1;
+    cnrtRet_t ret = cnrtGetDevice(&dev_index);
+    if (ret != cnrtSuccess || dev_index < 0) {
+      LOG(ERROR) << "get device ID failed.";
+    }
+    pathStr.replace(pos, 10, "deviceid" + std::to_string(dev_index));
+  }
+  return pathStr;
+}
+
+void genCaseConfig::setDirectory(const char *path) {
+  std::string pathStr = std::string(path);
+  gen_case_dir_ = pathStr;
+}
+
+std::string genCaseConfig::getDirectory() {
+  if (gen_case_dir_ != "") {
+    std::string pathStr = genCaseConfig::replacePlaceholder(gen_case_dir_);
+    return pathStr;
+  } else {
+    char current_dir[PATH_MAX];
+    if (getcwd(current_dir, sizeof(current_dir)) == NULL) {
+      return "";
+    }
+    return std::string(current_dir);
+  }
+}
+
 // TO DO: can use regex and global variable for efficiency
 inline int getOpNameMask(const std::string op_name_,
                          const std::string op_name) {
@@ -454,6 +489,7 @@ std::string PbNode::getFolderName() {
     folder_name = current_dir;
   }
 
+  folder_name = genCaseConfig::replacePlaceholder(folder_name);
   folder_name = folder_name + "/gen_case/" + op_name;
   return folder_name;
 }
@@ -787,3 +823,51 @@ std::string descToString(mluOpTensorDescriptor_t desc, char delimiter) {
 void MLUOP_WIN_API mluOpSetGenCaseMode(int mode) {
   mluop::gen_case::genCaseModeSet(mode);
 }
+
+mluOpStatus_t MLUOP_WIN_API mluOpSetGenCaseDirectory(const char *path) {
+  PARAM_CHECK("[mluOpSetGenCaseDirectory]", path != NULL);
+  mluop::gen_case::genCaseConfig::setDirectory(path);
+  return MLUOP_STATUS_SUCCESS;
+}
+
+const char MLUOP_WIN_API *mluOpGetGenCaseDirectory(char *buffer,
+                                                   size_t bufferSize,
+                                                   size_t *pathLen,
+                                                   mluOpStatus_t *status) {
+  std::string ret = mluop::gen_case::genCaseConfig::getDirectory();
+  if (ret == "") {
+    LOG(ERROR) << "[mluOpGetGenCaseDirectory] getting directory failed!";
+    mluop::gen_case::genCaseConfig::setValue(pathLen, (size_t)0);
+    mluop::gen_case::genCaseConfig::setValue(status,
+                                             MLUOP_STATUS_INTERNAL_ERROR);
+    return nullptr;
+  }
+  if (ret.size() >= bufferSize && buffer != nullptr) {
+    LOG(ERROR) << "[mluOpGetGenCaseDirectory] buffer size is too small to "
+                  "store the gen case directory.";
+    mluop::gen_case::genCaseConfig::setValue(pathLen, (size_t)0);
+    mluop::gen_case::genCaseConfig::setValue(status, MLUOP_STATUS_BAD_PARAM);
+    return buffer;
+  }
+  if (buffer == nullptr) {
+    char *newBuffer = (char *)malloc(ret.size() + 1);
+    if (newBuffer == nullptr) {
+      LOG(ERROR) << "[mluOpGetGenCaseDirectory] malloc failed.";
+      mluop::gen_case::genCaseConfig::setValue(pathLen, (size_t)0);
+      mluop::gen_case::genCaseConfig::setValue(status,
+                                               MLUOP_STATUS_ALLOC_FAILED);
+      return nullptr;
+    }
+    strncpy(newBuffer, ret.c_str(), ret.size());
+    newBuffer[ret.size()] = '\0';
+    mluop::gen_case::genCaseConfig::setValue(pathLen, ret.size());
+    mluop::gen_case::genCaseConfig::setValue(status, MLUOP_STATUS_SUCCESS);
+    return newBuffer;
+  } else {
+    strncpy(buffer, ret.c_str(), ret.size());
+    buffer[ret.size()] = '\0';
+    mluop::gen_case::genCaseConfig::setValue(pathLen, ret.size());
+    mluop::gen_case::genCaseConfig::setValue(status, MLUOP_STATUS_SUCCESS);
+    return buffer;
+  }
+}

core/gen_case.h

@@ -521,6 +521,19 @@ class PbNode {
   void debugTensorAddress();
 };
 
+class genCaseConfig {
+ public:
+  static void setDirectory(const char *name);
+  static std::string getDirectory();
+  static std::string replacePlaceholder(std::string pathStr);
+  template <typename T>
+  static inline void setValue(T *pointer, T value) {
+    if (pointer != nullptr) {
+      *pointer = value;
+    }
+  }
+};
+
 template <>
 inline void PbNode::appendOpParam<std::string>(std::string param_name,
                                                std::string param_value,

docs/user_guide/11_env_var/index.rst

@@ -54,6 +54,21 @@ MLUOP_GEN_CASE
 
 更详细请参见 `MLU-OPS™ GEN_CASE 使用指南 <https://github.com/Cambricon/mlu-ops/blob/master/docs/Gencase-User-Guide-zh.md>`_ 。
 
+.. _MLUOP_GEN_CASE_DIR:
+
+MLUOP_GEN_CASE_DIR
+######################
+
+**功能描述**
+
+用于指定 :ref:`MLUOP_GEN_CASE` 功能生成的目录所在的根目录。默认在当前目录下生成。
+
+**使用方法**
+
+- export MLUOP_GEN_CASE_DIR={path}: 通过环境变量设置，只在初始化阶段生效。
+
+- 在程序运行过程中也可以调用 ``mluOpSetGenCaseDirectory()`` 和 ``mluOpGetGenCaseDirectory()`` 来动态设置和获取此环境变量的值。更多内容，参见《Cambricon MLU-OPS Developer Guide》。
+
 .. _MLUOP_MIN_VLOG_LEVEL:
 
 MLUOP_MIN_VLOG_LEVEL

mlu_op.h

@@ -13221,6 +13221,67 @@ mluOpSyncBatchNormBackwardElemtV2(mluOpHandle_t handle,
 void MLUOP_WIN_API
 mluOpSetGenCaseMode(int mode);
 
+// Group:Common Interface
+// Subgroup:Debugging
+/*!
+ * @brief Sets the gen case directory name through the \p path parameter. For more
+ * information, see "Cambricon MLU-OPS User Guide".
+ *
+ * @param[in] path
+ * Input. A NULL-terminated character string used to specify the directory name.
+ *
+ * @par Return
+ * - ::MLUOP_STATUS_SUCCESS, ::MLUOP_STATUS_BAD_PARAM
+ *
+ * @note
+ * - The settings of this API are valid for all threads.
+ *
+ * @par Requirements
+ * - None.
+ *
+ * @par Example
+ * - None.
+ */
+mluOpStatus_t MLUOP_WIN_API
+mluOpSetGenCaseDirectory(const char *path);
+
+// Group:Common Interface
+// Subgroup:Debugging
+/*!
+ * @brief Gets the gen case directory name. For more information, see "Cambricon MLU-OPS User Guide".
+ *
+ * @param[in] buffer
+ * Input. This is a buffer used to store the directory name. If \p buffer is NULL,
+ *        the directory name is placed in a region of memory allocated with malloc.
+ *
+ * @param[in] bufferSize
+ * Input. The size of the buffer.
+ *
+ * @param[out] pathLen
+ * Output. If \p pathLen is not NULL, the length of directory name is placed in *pathLen.
+ *
+ * @param[out] status
+ * Output. If \p status is not NULL, the execution status of this API is placed in *status.
+ *         It includes ::MLUOP_STATUS_SUCCESS, ::MLUOP_STATUS_BAD_PARAM, ::MLUOP_STATUS_ALLOC_FAILED,
+ *         ::MLUOP_STATUS_INTERNAL_ERROR.
+ *
+ * @par Return
+ * - A pointer to the start of the NULL-terminated directory name, or NULL if get
+ *   directory name failed. The API caller is responsible for deallocating this memory by using
+ *   the free() function.
+ *
+ * @note
+ * - None.
+ *
+ * @par Requirements
+ * - None.
+ *
+ * @par Example
+ * - None.
+ */
+const char MLUOP_WIN_API *
+mluOpGetGenCaseDirectory(char *buffer, size_t bufferSize, size_t *pathLen, mluOpStatus_t *status);
+
 // Group: DeformConv
 /*!
  * @brief Creates a descriptor pointed by \p dcn_desc for a deformable convolution forward