/* * Copyright (c) Meta Platforms, Inc. and affiliates. * * 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 "oi/ContainerInfo.h" #include #include #include "oi/support/Toml.h" namespace fs = std::filesystem; ContainerTypeEnum containerTypeEnumFromStr(std::string& str) { static const std::map nameMap = { #define X(name) {#name, name}, LIST_OF_CONTAINER_TYPES #undef X }; if (!nameMap.contains(str)) { return UNKNOWN_TYPE; } return nameMap.at(str); } const char* containerTypeEnumToStr(ContainerTypeEnum ty) { switch (ty) { #define X(name) \ case name: \ return #name; LIST_OF_CONTAINER_TYPES #undef X default: return "UNKNOWN_TYPE"; } } [[deprecated]] std::unique_ptr ContainerInfo::loadFromFile( const fs::path& path) { toml::table container; try { container = toml::parse_file(std::string(path)); } catch (const toml::parse_error& ex) { LOG(ERROR) << "ContainerInfo::loadFromFile: " << path << " : " << ex.description(); return nullptr; } toml::table* info = container["info"].as_table(); if (!info) { LOG(ERROR) << "a container info file requires an `info` table"; return nullptr; } std::string typeName; if (std::optional str = (*info)["typeName"].value()) { typeName = std::move(*str); } else { LOG(ERROR) << "`info.typeName` is a required field"; return nullptr; } boost::regex matcher; if (std::optional str = (*info)["matcher"].value()) { matcher = boost::regex(*str, boost::regex_constants::grep); } else { matcher = boost::regex("^" + typeName, boost::regex_constants::grep); } std::optional numTemplateParams = (*info)["numTemplateParams"].value(); ContainerTypeEnum ctype; if (std::optional str = (*info)["ctype"].value()) { ctype = containerTypeEnumFromStr(*str); if (ctype == UNKNOWN_TYPE) { LOG(ERROR) << "`" << (*str) << "` is not a valid container type"; return nullptr; } } else { LOG(ERROR) << "`info.ctype` is a required field"; return nullptr; } std::string header; if (std::optional str = (*info)["header"].value()) { header = std::move(*str); } else { LOG(ERROR) << "`info.header` is a required field"; return nullptr; } std::vector ns; if (toml::array* arr = (*info)["ns"].as_array()) { ns.reserve(arr->size()); arr->for_each([&](auto&& el) { if constexpr (toml::is_string) { ns.emplace_back(el); } }); } std::vector replaceTemplateParamIndex{}; if (toml::array* arr = (*info)["replaceTemplateParamIndex"].as_array()) { replaceTemplateParamIndex.reserve(arr->size()); arr->for_each([&](auto&& el) { if constexpr (toml::is_integer) { replaceTemplateParamIndex.push_back(*el); } }); } oi::detail::FeatureSet requiredFeatures; if (toml::array* arr = (*info)["required_features"].as_array()) { arr->for_each([&](auto&& el) { if constexpr (toml::is_string) { oi::detail::Feature f = oi::detail::featureFromStr(*el); if (f == oi::detail::Feature::UnknownFeature) { LOG(WARNING) << "unknown feature in container config: " << el; return; } requiredFeatures[f] = true; } }); } std::optional allocatorIndex = (*info)["allocatorIndex"].value(); std::optional underlyingContainerIndex = (*info)["underlyingContainerIndex"].value(); toml::table* codegen = container["codegen"].as_table(); if (!codegen) { LOG(ERROR) << "a container info file requires an `codegen` table"; return nullptr; } std::string decl; if (std::optional str = (*codegen)["decl"].value()) { decl = std::move(*str); } else { LOG(ERROR) << "`codegen.decl` is a required field"; return nullptr; } std::string func; if (std::optional str = (*codegen)["func"].value()) { func = std::move(*str); } else { LOG(ERROR) << "`codegen.func` is a required field"; return nullptr; } return std::unique_ptr(new ContainerInfo{ std::move(typeName), std::move(matcher), numTemplateParams, ctype, std::move(header), std::move(ns), std::move(replaceTemplateParamIndex), allocatorIndex, underlyingContainerIndex, {}, requiredFeatures, { std::move(decl), std::move(func), }, }); } namespace { /* * Create a regex to match a given type name. * * The type name "name" should match "name" and "name". */ boost::regex getMatcher(const std::string& typeName) { return boost::regex("^" + typeName + "$|^" + typeName + "<.*>$", boost::regex_constants::extended); } } // namespace ContainerInfo::ContainerInfo(const fs::path& path) { toml::table container; try { container = toml::parse_file(std::string(path)); } catch (const toml::parse_error& err) { // Convert into a ContainerInfoError, just to avoid having to include // the huge TOML++ header in the caller's file. Use toml::parse_error's // operator<< to generate a pretty message with error location. std::stringstream ss; ss << err; throw ContainerInfoError(path, ss.str()); } if (!container["info"].is_table()) { throw ContainerInfoError(path, "a container info file requires an `info` table"); } const auto& info = container["info"]; if (std::optional str = info["type_name"].value()) { typeName = std::move(*str); } else { throw ContainerInfoError(path, "`info.type_name` is a required field"); } matcher_ = getMatcher(typeName); if (std::optional str = info["ctype"].value()) { ctype = containerTypeEnumFromStr(*str); if (ctype == UNKNOWN_TYPE) { throw ContainerInfoError(path, "`" + *str + "` is not a valid container type"); } } else { throw ContainerInfoError(path, "`info.ctype` is a required field"); } if (std::optional str = info["header"].value()) { header = std::move(*str); } else { throw ContainerInfoError(path, "`info.header` is a required field"); } if (toml::array* arr = info["stub_template_params"].as_array()) { stubTemplateParams.reserve(arr->size()); arr->for_each([&](auto&& el) { if constexpr (toml::is_integer) { stubTemplateParams.push_back(*el); } else { throw ContainerInfoError( path, "stub_template_params should only contain integers"); } }); } underlyingContainerIndex = info["underlying_container_index"].value(); if (toml::array* arr = info["required_features"].as_array()) { arr->for_each([&](auto&& el) { if constexpr (toml::is_string) { oi::detail::Feature f = oi::detail::featureFromStr(*el); if (f == oi::detail::Feature::UnknownFeature) { LOG(WARNING) << "unknown feature in container config: " << el; return; } requiredFeatures[f] = true; } }); } if (!container["codegen"].is_table()) { throw ContainerInfoError( path, "a container info file requires a `codegen` table"); } const auto& codegenToml = container["codegen"]; if (std::optional str = codegenToml["func"].value()) { codegen.func = std::move(*str); } else { throw ContainerInfoError(path, "`codegen.func` is a required field"); } if (std::optional str = codegenToml["decl"].value()) { codegen.decl = std::move(*str); } else { throw ContainerInfoError(path, "`codegen.decl` is a required field"); } if (std::optional str = codegenToml["traversal_func"].value()) { codegen.traversalFunc = std::move(*str); } if (std::optional str = codegenToml["extra"].value()) { codegen.extra = std::move(*str); } if (std::optional str = codegenToml["scoped_extra"].value()) { codegen.scopedExtra = std::move(*str); } if (toml::array* arr = codegenToml["processor"].as_array()) { codegen.processors.reserve(arr->size()); arr->for_each([&](auto&& el) { if (toml::table* proc = el.as_table()) { std::string type, func; if (std::optional str = (*proc)["type"].value()) { type = std::move(*str); } else { throw ContainerInfoError( path, "codegen.processor.type is a required field"); } if (std::optional str = (*proc)["func"].value()) { func = std::move(*str); } else { throw ContainerInfoError( path, "codegen.processor.func is a required field"); } codegen.processors.emplace_back( Processor{std::move(type), std::move(func)}); } else { throw ContainerInfoError( path, "codegen.processor should only contain tables"); } }); } // Only used for TreeBuilder v1: numTemplateParams = info["numTemplateParams"].value(); } ContainerInfo::ContainerInfo(std::string typeName_, ContainerTypeEnum ctype_, std::string header_) : typeName(std::move(typeName_)), ctype(ctype_), header(std::move(header_)), codegen(Codegen{ "// DummyDecl %1%\n", "// DummyFunc %1%\n", "// DummyFunc\n"}), matcher_(getMatcher(typeName)) { }