forked from huawei/mindspore2022
322 lines
11 KiB
C++
322 lines
11 KiB
C++
/**
|
|
* Copyright 2020-2021 Huawei Technologies Co., Ltd
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#include "debug/common.h"
|
|
|
|
#include <memory>
|
|
#include <iomanip>
|
|
#include <optional>
|
|
#include <fstream>
|
|
#include "utils/system/env.h"
|
|
#include "utils/system/file_system.h"
|
|
#include "utils/log_adapter.h"
|
|
#include "utils/utils.h"
|
|
|
|
namespace mindspore {
|
|
std::optional<std::string> Common::GetRealPath(const std::string &input_path) {
|
|
if (input_path.length() >= PATH_MAX) {
|
|
MS_LOG(EXCEPTION) << "The length of path: " << input_path << " exceeds limit: " << PATH_MAX;
|
|
}
|
|
#if defined(SYSTEM_ENV_POSIX)
|
|
size_t path_split_pos = input_path.find_last_of('/');
|
|
#elif defined(SYSTEM_ENV_WINDOWS)
|
|
size_t path_split_pos = input_path.find_last_of('\\');
|
|
#else
|
|
MS_LOG(EXCEPTION) << "Unsupported platform.";
|
|
#endif
|
|
// get real path
|
|
char real_path[PATH_MAX] = {0};
|
|
// input_path is dir + file_name
|
|
if (path_split_pos != std::string::npos) {
|
|
std::string prefix_path = input_path.substr(0, path_split_pos);
|
|
std::string file_name = input_path.substr(path_split_pos);
|
|
if (!CreateNotExistDirs(prefix_path)) {
|
|
MS_LOG(ERROR) << "Create dir " << prefix_path << " Failed!";
|
|
return std::nullopt;
|
|
}
|
|
#if defined(SYSTEM_ENV_POSIX)
|
|
if (file_name.length() > NAME_MAX) {
|
|
MS_LOG(EXCEPTION) << "The length of file name : " << file_name.length() << " exceeds limit: " << NAME_MAX;
|
|
}
|
|
if (realpath(common::SafeCStr(prefix_path), real_path) == nullptr) {
|
|
MS_LOG(ERROR) << "The dir " << prefix_path << " does not exist.";
|
|
return std::nullopt;
|
|
}
|
|
#elif defined(SYSTEM_ENV_WINDOWS)
|
|
if (_fullpath(real_path, common::SafeCStr(prefix_path), PATH_MAX) == nullptr) {
|
|
MS_LOG(ERROR) << "The dir " << prefix_path << " does not exist.";
|
|
return std::nullopt;
|
|
}
|
|
#endif
|
|
return std::string(real_path) + file_name;
|
|
}
|
|
// input_path is only file_name
|
|
#if defined(SYSTEM_ENV_POSIX)
|
|
if (input_path.length() > NAME_MAX) {
|
|
MS_LOG(EXCEPTION) << "The length of file name : " << input_path.length() << " exceeds limit: " << NAME_MAX;
|
|
}
|
|
if (realpath(common::SafeCStr(input_path), real_path) == nullptr) {
|
|
MS_LOG(INFO) << "The file " << input_path << " does not exist, it will be created.";
|
|
}
|
|
#elif defined(SYSTEM_ENV_WINDOWS)
|
|
if (_fullpath(real_path, common::SafeCStr(input_path), PATH_MAX) == nullptr) {
|
|
MS_LOG(INFO) << "The file " << input_path << " does not exist, it will be created.";
|
|
}
|
|
#endif
|
|
return std::string(real_path);
|
|
}
|
|
|
|
bool Common::CreateNotExistDirs(const std::string &path) {
|
|
std::shared_ptr<system::FileSystem> fs = system::Env::GetFileSystem();
|
|
MS_EXCEPTION_IF_NULL(fs);
|
|
char temp_path[PATH_MAX] = {0};
|
|
if (path.length() >= PATH_MAX) {
|
|
MS_LOG(ERROR) << "Path length is equal to or max than " << PATH_MAX;
|
|
return false;
|
|
}
|
|
for (uint32_t i = 0; i < path.length(); i++) {
|
|
temp_path[i] = path[i];
|
|
if (temp_path[i] == '\\' || temp_path[i] == '/') {
|
|
if (i != 0) {
|
|
char tmp_char = temp_path[i];
|
|
temp_path[i] = '\0';
|
|
std::string path_handle(temp_path);
|
|
if (!fs->FileExist(path_handle)) {
|
|
MS_LOG(INFO) << "Dir " << path_handle << " does not exit, creating...";
|
|
if (!fs->CreateDir(path_handle)) {
|
|
MS_LOG(ERROR) << "Create " << path_handle << " dir error";
|
|
return false;
|
|
}
|
|
}
|
|
temp_path[i] = tmp_char;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!fs->FileExist(path)) {
|
|
MS_LOG(INFO) << "Dir " << path << " does not exit, creating...";
|
|
if (!fs->CreateDir(path)) {
|
|
MS_LOG(ERROR) << "Create " << path << " dir error";
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::optional<std::string> Common::GetConfigFile(const std::string &env) {
|
|
if (env.empty()) {
|
|
MS_LOG(EXCEPTION) << "Invalid env";
|
|
}
|
|
auto config_path_str = std::getenv(env.c_str());
|
|
if (config_path_str == nullptr) {
|
|
MS_LOG(ERROR) << "Please export env:" << env;
|
|
return {};
|
|
}
|
|
MS_LOG(INFO) << "Async Dump Getenv env:" << env << "=" << config_path_str;
|
|
|
|
std::string dump_config_file(config_path_str);
|
|
std::shared_ptr<system::FileSystem> fs = system::Env::GetFileSystem();
|
|
MS_EXCEPTION_IF_NULL(fs);
|
|
if (!fs->FileExist(dump_config_file)) {
|
|
MS_LOG(ERROR) << dump_config_file << " not exist.";
|
|
return {};
|
|
}
|
|
auto point_pos = dump_config_file.find_last_of('.');
|
|
if (point_pos == std::string::npos) {
|
|
MS_LOG(EXCEPTION) << "Invalid json file name:" << dump_config_file;
|
|
}
|
|
auto suffix = dump_config_file.substr(point_pos + 1);
|
|
if (suffix != "json") {
|
|
MS_LOG(EXCEPTION) << "[DataDump] dump config file suffix only supports json! But got:." << suffix;
|
|
}
|
|
return dump_config_file;
|
|
}
|
|
|
|
bool Common::IsStrLengthValid(const std::string &str, size_t length_limit, const std::string &error_message) {
|
|
auto len_str = str.length();
|
|
if (len_str > length_limit) {
|
|
MS_LOG(WARNING) << error_message << "The length is " << str.length() << ", exceeding the limit of " << length_limit
|
|
<< ".";
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool Common::IsEveryFilenameValid(const std::string &path, size_t length_limit, const std::string &error_message) {
|
|
if (path.empty()) {
|
|
MS_LOG(WARNING) << error_message << "The path is empty.";
|
|
return false;
|
|
}
|
|
size_t len_path = path.length();
|
|
size_t left_pos = 0;
|
|
for (size_t i = 0; i < len_path; i++) {
|
|
if (i != 0) {
|
|
if (path[i] == '\\' || path[i] == '/') {
|
|
auto cur_len = i - left_pos;
|
|
if (cur_len > length_limit) {
|
|
MS_LOG(WARNING) << error_message << "The name length of '" << path.substr(left_pos, cur_len) << "' is "
|
|
<< cur_len << ". It is out of the limit which is " << length_limit << ".";
|
|
return false;
|
|
}
|
|
left_pos = i + 1;
|
|
}
|
|
}
|
|
}
|
|
if (!(path[len_path - 1] == '\\' || path[len_path - 1] == '/')) {
|
|
auto cur_len = len_path - left_pos;
|
|
if (cur_len > length_limit) {
|
|
MS_LOG(WARNING) << error_message << "The name length of '" << path.substr(left_pos, cur_len) << "' is " << cur_len
|
|
<< ". It is out of the limit which is " << length_limit << ".";
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool Common::IsPathValid(const std::string &path, size_t length_limit, const std::string &error_message) {
|
|
std::string err_msg = "Detail: ";
|
|
if (!error_message.empty()) {
|
|
err_msg = error_message + " " + err_msg;
|
|
}
|
|
|
|
if (path.empty()) {
|
|
MS_LOG(WARNING) << err_msg << "The path is empty.";
|
|
return false;
|
|
}
|
|
|
|
if (!IsStrLengthValid(path, length_limit, err_msg)) {
|
|
return false;
|
|
}
|
|
|
|
if (!std::all_of(path.begin(), path.end(),
|
|
[](char c) { return ::isalpha(c) || ::isdigit(c) || c == '-' || c == '_' || c == '/'; })) {
|
|
MS_LOG(WARNING) << err_msg << "The path only supports alphabets, digit or {'-', '_', '/'}, but got:" << path << ".";
|
|
return false;
|
|
}
|
|
|
|
if (path[0] != '/') {
|
|
MS_LOG(WARNING) << err_msg << "The path only supports absolute path and should start with '/'.";
|
|
return false;
|
|
}
|
|
|
|
if (!IsEveryFilenameValid(path, MAX_OS_FILENAME_LENGTH, err_msg)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
bool Common::IsFilenameValid(const std::string &filename, size_t length_limit, const std::string &error_message) {
|
|
std::string err_msg = "Detail: ";
|
|
if (!error_message.empty()) {
|
|
err_msg = error_message + " " + err_msg;
|
|
}
|
|
|
|
if (filename.empty()) {
|
|
MS_LOG(WARNING) << err_msg << "The filename is empty.";
|
|
return false;
|
|
}
|
|
|
|
if (!IsStrLengthValid(filename, length_limit, err_msg)) {
|
|
return false;
|
|
}
|
|
|
|
if (!std::all_of(filename.begin(), filename.end(),
|
|
[](char c) { return ::isalpha(c) || ::isdigit(c) || c == '-' || c == '_' || c == '.'; })) {
|
|
MS_LOG(WARNING) << err_msg << "The filename only supports alphabets, digit or {'-', '_', '.'}, but got:" << filename
|
|
<< ".";
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
std::string Common::AddId(const std::string &filename, const std::string &suffix) {
|
|
static size_t g_id = 0;
|
|
std::ostringstream s;
|
|
auto i = filename.rfind(suffix);
|
|
const int spaces = 4;
|
|
if (i >= filename.size()) {
|
|
s << filename;
|
|
s << "_" << std::setfill('0') << std::setw(spaces) << g_id;
|
|
} else {
|
|
s << filename.substr(0, i);
|
|
s << "_" << std::setfill('0') << std::setw(spaces) << g_id;
|
|
if (i + 1 < filename.size()) {
|
|
s << filename.substr(i);
|
|
}
|
|
}
|
|
g_id++;
|
|
return s.str();
|
|
}
|
|
|
|
bool Common::SaveStringToFile(const std::string filename, const std::string string_info) {
|
|
if (filename.size() >= PATH_MAX) {
|
|
MS_LOG(ERROR) << "File path " << filename << " is too long.";
|
|
return false;
|
|
}
|
|
auto real_path = GetRealPath(filename);
|
|
if (!real_path.has_value()) {
|
|
MS_LOG(ERROR) << "Get real path failed. path=" << filename;
|
|
return false;
|
|
}
|
|
|
|
ChangeFileMode(real_path.value(), S_IRWXU);
|
|
std::ofstream ofs;
|
|
ofs.open(real_path.value());
|
|
|
|
if (!ofs.is_open()) {
|
|
MS_LOG(ERROR) << "Open dump file '" << real_path.value() << "' failed!";
|
|
return false;
|
|
}
|
|
ofs << string_info << std::endl;
|
|
ofs.close();
|
|
// set file mode to read only by user
|
|
ChangeFileMode(real_path.value(), S_IRUSR);
|
|
return true;
|
|
}
|
|
|
|
bool Common::FileExists(const std::string &filepath) {
|
|
std::ifstream f(filepath);
|
|
bool cache_file_existed = f.good();
|
|
f.close();
|
|
return cache_file_existed;
|
|
}
|
|
|
|
struct GlogLogDirRegister {
|
|
GlogLogDirRegister() {
|
|
const char *logtostderr = ::getenv("GLOG_logtostderr");
|
|
const char *log_dir = ::getenv("GLOG_log_dir");
|
|
if (logtostderr != nullptr && log_dir != nullptr) {
|
|
std::string logtostderr_str = std::string(logtostderr);
|
|
std::string log_dir_str = std::string(log_dir);
|
|
|
|
auto real_log_dir_str = Common::GetRealPath(log_dir_str);
|
|
|
|
// While 'GLOG_logtostderr' = 0, logs output to files.
|
|
// 'GLOG_log_dir' must be specified as the path of log files.
|
|
if (logtostderr_str == "0" && real_log_dir_str.has_value()) {
|
|
if (!Common::IsPathValid(real_log_dir_str.value(), MAX_DIRECTORY_LENGTH, "")) {
|
|
MS_LOG(EXCEPTION) << "The path of log files, set by 'GLOG_log_dir', is invalid";
|
|
} else if (!Common::CreateNotExistDirs(real_log_dir_str.value())) {
|
|
MS_LOG(EXCEPTION) << "Create the path of log files, set by 'GLOG_log_dir', failed.";
|
|
}
|
|
} else if (logtostderr_str == "0") {
|
|
MS_LOG(EXCEPTION) << "The path of log files, set by 'GLOG_log_dir', is invalid.";
|
|
}
|
|
}
|
|
}
|
|
} _glog_log_dir_register;
|
|
} // namespace mindspore
|