/* * Copyright (C) 2017 The Android Open Source Project * * 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. */ // Convert objects from and to xml. #define LOG_TAG "libvintf" #include #include "parse_xml.h" #include #include #include #include #include "Regex.h" #include "constants-private.h" #include "constants.h" #include "parse_string.h" #include "parse_xml_for_test.h" using namespace std::string_literals; namespace android { namespace vintf { // --------------- tinyxml2 details using NodeType = tinyxml2::XMLElement; using DocType = tinyxml2::XMLDocument; // caller is responsible for deleteDocument() call inline DocType *createDocument() { return new tinyxml2::XMLDocument(); } // caller is responsible for deleteDocument() call inline DocType *createDocument(const std::string &xml) { DocType *doc = new tinyxml2::XMLDocument(); if (doc->Parse(xml.c_str()) == tinyxml2::XML_SUCCESS) { return doc; } delete doc; return nullptr; } inline void deleteDocument(DocType *d) { delete d; } inline std::string printDocument(DocType *d) { tinyxml2::XMLPrinter p; d->Print(&p); return std::string{p.CStr()}; } inline NodeType *createNode(const std::string &name, DocType *d) { return d->NewElement(name.c_str()); } inline void appendChild(NodeType *parent, NodeType *child) { parent->InsertEndChild(child); } inline void appendChild(DocType *parent, NodeType *child) { parent->InsertEndChild(child); } inline void appendStrAttr(NodeType *e, const std::string &attrName, const std::string &attr) { e->SetAttribute(attrName.c_str(), attr.c_str()); } // text -> text inline void appendText(NodeType *parent, const std::string &text, DocType *d) { parent->InsertEndChild(d->NewText(text.c_str())); } inline std::string nameOf(NodeType *root) { return root->Name() == NULL ? "" : root->Name(); } inline std::string getText(NodeType *root) { return root->GetText() == NULL ? "" : root->GetText(); } inline NodeType *getChild(NodeType *parent, const std::string &name) { return parent->FirstChildElement(name.c_str()); } inline NodeType *getRootChild(DocType *parent) { return parent->FirstChildElement(); } inline std::vector getChildren(NodeType *parent, const std::string &name) { std::vector v; for (NodeType *child = parent->FirstChildElement(name.c_str()); child != nullptr; child = child->NextSiblingElement(name.c_str())) { v.push_back(child); } return v; } inline bool getAttr(NodeType *root, const std::string &attrName, std::string *s) { const char *c = root->Attribute(attrName.c_str()); if (c == NULL) return false; *s = c; return true; } // --------------- tinyxml2 details end. // Helper functions for XmlConverter static bool parse(const std::string &attrText, bool *attr) { if (attrText == "true" || attrText == "1") { *attr = true; return true; } if (attrText == "false" || attrText == "0") { *attr = false; return true; } return false; } static bool parse(const std::string& attrText, std::optional* attr) { *attr = attrText; return true; } // ---------------------- XmlNodeConverter definitions template struct XmlNodeConverter { XmlNodeConverter() {} virtual ~XmlNodeConverter() {} // sub-types should implement these. virtual void mutateNode(const Object &o, NodeType *n, DocType *d) const = 0; virtual void mutateNode(const Object& o, NodeType* n, DocType* d, SerializeFlags::Type) const { mutateNode(o, n, d); } virtual bool buildObject(Object* o, NodeType* n, std::string* error) const = 0; virtual std::string elementName() const = 0; // convenience methods for user inline NodeType* operator()(const Object& o, DocType* d, SerializeFlags::Type flags = SerializeFlags::EVERYTHING) const { NodeType *root = createNode(this->elementName(), d); this->mutateNode(o, root, d, flags); return root; } inline std::string operator()(const Object& o, SerializeFlags::Type flags) const { DocType *doc = createDocument(); appendChild(doc, (*this)(o, doc, flags)); std::string s = printDocument(doc); deleteDocument(doc); return s; } inline bool operator()(Object* object, NodeType* root, std::string* error) const { if (nameOf(root) != this->elementName()) { return false; } return this->buildObject(object, root, error); } inline bool operator()(Object* o, const std::string& xml, std::string* error) const { std::string errorBuffer; if (error == nullptr) error = &errorBuffer; auto doc = createDocument(xml); if (doc == nullptr) { *error = "Not a valid XML"; return false; } bool ret = (*this)(o, getRootChild(doc), error); deleteDocument(doc); return ret; } // convenience methods for implementor. // All append* functions helps mutateNode() to serialize the object into XML. template inline void appendAttr(NodeType *e, const std::string &attrName, const T &attr) const { return appendStrAttr(e, attrName, ::android::vintf::to_string(attr)); } inline void appendAttr(NodeType *e, const std::string &attrName, bool attr) const { return appendStrAttr(e, attrName, attr ? "true" : "false"); } // text -> text inline void appendTextElement(NodeType *parent, const std::string &name, const std::string &text, DocType *d) const { NodeType *c = createNode(name, d); appendText(c, text, d); appendChild(parent, c); } // text -> text template inline void appendTextElements(NodeType *parent, const std::string &name, const Array &array, DocType *d) const { for (const std::string &text : array) { NodeType *c = createNode(name, d); appendText(c, text, d); appendChild(parent, c); } } template inline void appendChildren(NodeType* parent, const XmlNodeConverter& conv, const Array& array, DocType* d, SerializeFlags::Type flags = SerializeFlags::EVERYTHING) const { for (const T &t : array) { appendChild(parent, conv(t, d, flags)); } } // All parse* functions helps buildObject() to deserialize XML to the object. Returns // true if deserialization is successful, false if any error, and "error" will be // set to error message. template inline bool parseOptionalAttr(NodeType* root, const std::string& attrName, T&& defaultValue, T* attr, std::string* /* error */) const { std::string attrText; bool success = getAttr(root, attrName, &attrText) && ::android::vintf::parse(attrText, attr); if (!success) { *attr = std::move(defaultValue); } return true; } template inline bool parseAttr(NodeType* root, const std::string& attrName, T* attr, std::string* error) const { std::string attrText; bool ret = getAttr(root, attrName, &attrText) && ::android::vintf::parse(attrText, attr); if (!ret) { *error = "Could not find/parse attr with name \"" + attrName + "\" and value \"" + attrText + "\" for element <" + elementName() + ">"; } return ret; } inline bool parseAttr(NodeType* root, const std::string& attrName, std::string* attr, std::string* error) const { bool ret = getAttr(root, attrName, attr); if (!ret) { *error = "Could not find attr with name \"" + attrName + "\" for element <" + elementName() + ">"; } return ret; } inline bool parseTextElement(NodeType* root, const std::string& elementName, std::string* s, std::string* error) const { NodeType *child = getChild(root, elementName); if (child == nullptr) { *error = "Could not find element with name <" + elementName + "> in element <" + this->elementName() + ">"; return false; } *s = getText(child); return true; } inline bool parseOptionalTextElement(NodeType* root, const std::string& elementName, std::string&& defaultValue, std::string* s, std::string* /* error */) const { NodeType* child = getChild(root, elementName); *s = child == nullptr ? std::move(defaultValue) : getText(child); return true; } inline bool parseTextElements(NodeType* root, const std::string& elementName, std::vector* v, std::string* /* error */) const { auto nodes = getChildren(root, elementName); v->resize(nodes.size()); for (size_t i = 0; i < nodes.size(); ++i) { v->at(i) = getText(nodes[i]); } return true; } template inline bool parseChild(NodeType* root, const XmlNodeConverter& conv, T* t, std::string* error) const { NodeType *child = getChild(root, conv.elementName()); if (child == nullptr) { *error = "Could not find element with name <" + conv.elementName() + "> in element <" + this->elementName() + ">"; return false; } return conv(t, child, error); } template inline bool parseOptionalChild(NodeType* root, const XmlNodeConverter& conv, T&& defaultValue, T* t, std::string* error) const { NodeType *child = getChild(root, conv.elementName()); if (child == nullptr) { *t = std::move(defaultValue); return true; } return conv(t, child, error); } template inline bool parseOptionalChild(NodeType* root, const XmlNodeConverter& conv, std::optional* t, std::string* error) const { NodeType* child = getChild(root, conv.elementName()); if (child == nullptr) { *t = std::nullopt; return true; } *t = std::make_optional(); return conv(&**t, child, error); } template inline bool parseChildren(NodeType* root, const XmlNodeConverter& conv, std::vector* v, std::string* error) const { auto nodes = getChildren(root, conv.elementName()); v->resize(nodes.size()); for (size_t i = 0; i < nodes.size(); ++i) { if (!conv(&v->at(i), nodes[i], error)) { *error = "Could not parse element with name <" + conv.elementName() + "> in element <" + this->elementName() + ">: " + *error; return false; } } return true; } template inline bool parseChildren(NodeType* root, const XmlNodeConverter& conv, Container* s, std::string* error) const { std::vector vec; if (!parseChildren(root, conv, &vec, error)) { return false; } s->clear(); s->insert(vec.begin(), vec.end()); if (s->size() != vec.size()) { *error = "Duplicated elements <" + conv.elementName() + "> in element <" + this->elementName() + ">"; s->clear(); return false; } return true; } template inline bool parseChildren(NodeType* root, const XmlNodeConverter>& conv, std::map* s, std::string* error) const { return parseChildren, std::pair>(root, conv, s, error); } inline bool parseText(NodeType* node, std::string* s, std::string* /* error */) const { *s = getText(node); return true; } template inline bool parseText(NodeType* node, T* s, std::string* error) const { bool (*parser)(const std::string&, T*) = ::android::vintf::parse; return parseText(node, s, {parser}, error); } template inline bool parseText(NodeType* node, T* s, const std::function& parse, std::string* error) const { std::string text = getText(node); bool ret = parse(text, s); if (!ret) { *error = "Could not parse text \"" + text + "\" in element <" + elementName() + ">"; } return ret; } }; template struct XmlTextConverter : public XmlNodeConverter { virtual void mutateNode(const Object &object, NodeType *root, DocType *d) const override { appendText(root, ::android::vintf::to_string(object), d); } virtual bool buildObject(Object* object, NodeType* root, std::string* error) const override { return this->parseText(root, object, error); } }; template struct XmlPairConverter : public XmlNodeConverter { virtual void mutateNode(const Pair& pair, NodeType* root, DocType* d) const override { appendChild(root, FirstConverter{}(pair.first, d)); appendChild(root, SecondConverter{}(pair.second, d)); } virtual bool buildObject(Pair* pair, NodeType* root, std::string* error) const override { return this->parseChild(root, FirstConverter{}, &pair->first, error) && this->parseChild(root, SecondConverter{}, &pair->second, error); } }; // ---------------------- XmlNodeConverter definitions end struct VersionConverter : public XmlTextConverter { std::string elementName() const override { return "version"; } }; struct VersionRangeConverter : public XmlTextConverter { std::string elementName() const override { return "version"; } }; // 100 <=> Version{kFakeAidlMajorVersion, 100} struct AidlVersionConverter : public XmlNodeConverter { std::string elementName() const override { return "version"; } void mutateNode(const Version& object, NodeType* root, DocType* d) const override { appendText(root, aidlVersionToString(object), d); } bool buildObject(Version* object, NodeType* root, std::string* error) const override { return parseText(root, object, {parseAidlVersion}, error); } }; // 100 <=> VersionRange{kFakeAidlMajorVersion, 100, 100} // 100-105 <=> VersionRange{kFakeAidlMajorVersion, 100, 105} struct AidlVersionRangeConverter : public XmlNodeConverter { std::string elementName() const override { return "version"; } void mutateNode(const VersionRange& object, NodeType* root, DocType* d) const override { appendText(root, aidlVersionRangeToString(object), d); } bool buildObject(VersionRange* object, NodeType* root, std::string* error) const override { return parseText(root, object, {parseAidlVersionRange}, error); } }; struct TransportArchConverter : public XmlNodeConverter { std::string elementName() const override { return "transport"; } void mutateNode(const TransportArch &object, NodeType *root, DocType *d) const override { if (object.arch != Arch::ARCH_EMPTY) { appendAttr(root, "arch", object.arch); } appendText(root, ::android::vintf::to_string(object.transport), d); } bool buildObject(TransportArch* object, NodeType* root, std::string* error) const override { if (!parseOptionalAttr(root, "arch", Arch::ARCH_EMPTY, &object->arch, error) || !parseText(root, &object->transport, error)) { return false; } if (!object->isValid(error)) { return false; } return true; } }; struct KernelConfigTypedValueConverter : public XmlNodeConverter { std::string elementName() const override { return "value"; } void mutateNode(const KernelConfigTypedValue &object, NodeType *root, DocType *d) const override { appendAttr(root, "type", object.mType); appendText(root, ::android::vintf::to_string(object), d); } bool buildObject(KernelConfigTypedValue* object, NodeType* root, std::string* error) const override { std::string stringValue; if (!parseAttr(root, "type", &object->mType, error) || !parseText(root, &stringValue, error)) { return false; } if (!::android::vintf::parseKernelConfigValue(stringValue, object)) { *error = "Could not parse kernel config value \"" + stringValue + "\""; return false; } return true; } }; struct KernelConfigKeyConverter : public XmlTextConverter { std::string elementName() const override { return "key"; } }; struct MatrixKernelConfigConverter : public XmlPairConverter { std::string elementName() const override { return "config"; } }; struct HalInterfaceConverter : public XmlNodeConverter { std::string elementName() const override { return "interface"; } void mutateNode(const HalInterface &intf, NodeType *root, DocType *d) const override { appendTextElement(root, "name", intf.name(), d); appendTextElements(root, "instance", intf.mInstances, d); appendTextElements(root, "regex-instance", intf.mRegexes, d); } bool buildObject(HalInterface* intf, NodeType* root, std::string* error) const override { std::vector instances; std::vector regexes; if (!parseTextElement(root, "name", &intf->mName, error) || !parseTextElements(root, "instance", &instances, error) || !parseTextElements(root, "regex-instance", ®exes, error)) { return false; } bool success = true; for (const auto& e : instances) { if (!intf->insertInstance(e, false /* isRegex */)) { if (!error->empty()) *error += "\n"; *error += "Duplicated instance '" + e + "' in " + intf->name(); success = false; } } for (const auto& e : regexes) { details::Regex regex; if (!regex.compile(e)) { if (!error->empty()) *error += "\n"; *error += "Invalid regular expression '" + e + "' in " + intf->name(); success = false; } if (!intf->insertInstance(e, true /* isRegex */)) { if (!error->empty()) *error += "\n"; *error += "Duplicated regex-instance '" + e + "' in " + intf->name(); success = false; } } return success; } }; struct MatrixHalConverter : public XmlNodeConverter { std::string elementName() const override { return "hal"; } void mutateNode(const MatrixHal &hal, NodeType *root, DocType *d) const override { appendAttr(root, "format", hal.format); appendAttr(root, "optional", hal.optional); appendTextElement(root, "name", hal.name, d); if (hal.format == HalFormat::AIDL) { // By default, buildObject() assumes a 0 tag if no tag // is specified. Don't output any tag if there's only one 0 // tag. if (hal.versionRanges.size() != 1 || hal.versionRanges[0] != details::kDefaultAidlVersionRange) { appendChildren(root, AidlVersionRangeConverter{}, hal.versionRanges, d); } } else { appendChildren(root, VersionRangeConverter{}, hal.versionRanges, d); } appendChildren(root, HalInterfaceConverter{}, iterateValues(hal.interfaces), d); } bool buildObject(MatrixHal* object, NodeType* root, std::string* error) const override { std::vector interfaces; if (!parseOptionalAttr(root, "format", HalFormat::HIDL, &object->format, error) || !parseOptionalAttr(root, "optional", false /* defaultValue */, &object->optional, error) || !parseTextElement(root, "name", &object->name, error) || !parseChildren(root, HalInterfaceConverter{}, &interfaces, error)) { return false; } if (object->format == HalFormat::AIDL) { if (!parseChildren(root, AidlVersionRangeConverter{}, &object->versionRanges, error)) { return false; } // Insert fake version for AIDL HALs so that compatibility check for AIDL and other // HAL formats can be unified. if (object->versionRanges.empty()) { object->versionRanges.push_back(details::kDefaultAidlVersionRange); } } else { if (!parseChildren(root, VersionRangeConverter{}, &object->versionRanges, error)) { return false; } } for (auto&& interface : interfaces) { std::string name{interface.name()}; auto res = object->interfaces.emplace(std::move(name), std::move(interface)); if (!res.second) { *error = "Duplicated interface entry \"" + res.first->first + "\"; if additional instances are needed, add them to the " "existing node."; return false; } } // Do not check for target-side libvintf to avoid restricting ability for upgrade accidentally. #ifndef LIBVINTF_TARGET if (!checkAdditionalRestrictionsOnHal(*object, error)) { return false; } #endif if (!object->isValid(error)) { error->insert(0, "'" + object->name + "' is not a valid Matrix HAL: "); return false; } return true; } #ifndef LIBVINTF_TARGET private: bool checkAdditionalRestrictionsOnHal(const MatrixHal& hal, std::string* error) const { if (hal.getName() == "netutils-wrapper") { if (hal.versionRanges.size() != 1) { *error = "netutils-wrapper HAL must specify exactly one version x.0, " "but multiple element is specified."; return false; } const VersionRange& v = hal.versionRanges.at(0); if (!v.isSingleVersion()) { *error = "netutils-wrapper HAL must specify exactly one version x.0, " "but a range is provided. Perhaps you mean '" + to_string(Version{v.majorVer, 0}) + "'?"; return false; } if (v.minMinor != 0) { *error = "netutils-wrapper HAL must specify exactly one version x.0, " "but minor version is not 0. Perhaps you mean '" + to_string(Version{v.majorVer, 0}) + "'?"; return false; } } return true; } #endif }; struct MatrixKernelConditionsConverter : public XmlNodeConverter> { std::string elementName() const override { return "conditions"; } void mutateNode(const std::vector& conds, NodeType* root, DocType* d) const override { appendChildren(root, MatrixKernelConfigConverter{}, conds, d); } bool buildObject(std::vector* object, NodeType* root, std::string* error) const override { return parseChildren(root, MatrixKernelConfigConverter{}, object, error); } }; struct MatrixKernelConverter : public XmlNodeConverter { std::string elementName() const override { return "kernel"; } void mutateNode(const MatrixKernel& kernel, NodeType* root, DocType* d) const override { mutateNode(kernel, root, d, SerializeFlags::EVERYTHING); } void mutateNode(const MatrixKernel& kernel, NodeType* root, DocType* d, SerializeFlags::Type flags) const override { KernelVersion kv = kernel.mMinLts; if (!flags.isKernelMinorRevisionEnabled()) { kv.minorRev = 0u; } appendAttr(root, "version", kv); if (kernel.getSourceMatrixLevel() != Level::UNSPECIFIED) { appendAttr(root, "level", kernel.getSourceMatrixLevel()); } if (!kernel.mConditions.empty()) { appendChild(root, MatrixKernelConditionsConverter{}(kernel.mConditions, d)); } if (flags.isKernelConfigsEnabled()) { appendChildren(root, MatrixKernelConfigConverter{}, kernel.mConfigs, d); } } bool buildObject(MatrixKernel* object, NodeType* root, std::string* error) const override { Level sourceMatrixLevel = Level::UNSPECIFIED; if (!parseAttr(root, "version", &object->mMinLts, error) || !parseOptionalAttr(root, "level", Level::UNSPECIFIED, &sourceMatrixLevel, error) || !parseOptionalChild(root, MatrixKernelConditionsConverter{}, {}, &object->mConditions, error) || !parseChildren(root, MatrixKernelConfigConverter{}, &object->mConfigs, error)) { return false; } object->setSourceMatrixLevel(sourceMatrixLevel); return true; } }; struct FqInstanceConverter : public XmlTextConverter { std::string elementName() const override { return "fqname"; } }; // Convert ManifestHal from and to XML. Returned object is guaranteed to have // .isValid() == true. struct ManifestHalConverter : public XmlNodeConverter { std::string elementName() const override { return "hal"; } void mutateNode(const ManifestHal& m, NodeType* root, DocType* d) const override { mutateNode(m, root, d, SerializeFlags::EVERYTHING); } void mutateNode(const ManifestHal& hal, NodeType* root, DocType* d, SerializeFlags::Type flags) const override { appendAttr(root, "format", hal.format); appendTextElement(root, "name", hal.name, d); if (!hal.transportArch.empty()) { appendChild(root, TransportArchConverter{}(hal.transportArch, d)); } if (hal.format == HalFormat::AIDL) { // By default, buildObject() assumes a 0 tag if no tag // is specified. Don't output any tag if there's only one 0 // tag. if (hal.versions.size() != 1 || hal.versions[0] != details::kDefaultAidlVersion) { appendChildren(root, AidlVersionConverter{}, hal.versions, d); } } else { appendChildren(root, VersionConverter{}, hal.versions, d); } appendChildren(root, HalInterfaceConverter{}, iterateValues(hal.interfaces), d); if (hal.isOverride()) { appendAttr(root, "override", hal.isOverride()); } if (const auto& apex = hal.updatableViaApex(); apex.has_value()) { appendAttr(root, "updatable-via-apex", apex.value()); } if (flags.isFqnameEnabled()) { std::set simpleFqInstances; hal.forEachInstance([&simpleFqInstances](const auto& manifestInstance) { simpleFqInstances.emplace(manifestInstance.getSimpleFqInstance()); return true; }); appendTextElements(root, FqInstanceConverter{}.elementName(), simpleFqInstances, d); } if (hal.getMaxLevel() != Level::UNSPECIFIED) { appendAttr(root, "max-level", hal.getMaxLevel()); } } bool buildObject(ManifestHal* object, NodeType* root, std::string* error) const override { std::vector interfaces; if (!parseOptionalAttr(root, "format", HalFormat::HIDL, &object->format, error) || !parseOptionalAttr(root, "override", false, &object->mIsOverride, error) || !parseOptionalAttr(root, "updatable-via-apex", {}, &object->mUpdatableViaApex, error) || !parseTextElement(root, "name", &object->name, error) || !parseOptionalChild(root, TransportArchConverter{}, {}, &object->transportArch, error) || !parseChildren(root, HalInterfaceConverter{}, &interfaces, error) || !parseOptionalAttr(root, "max-level", Level::UNSPECIFIED, &object->mMaxLevel, error)) { return false; } switch (object->format) { case HalFormat::HIDL: { if (!parseChildren(root, VersionConverter{}, &object->versions, error)) return false; if (object->transportArch.empty()) { *error = "HIDL HAL '" + object->name + "' should have defined."; return false; } } break; case HalFormat::NATIVE: { if (!parseChildren(root, VersionConverter{}, &object->versions, error)) return false; if (!object->transportArch.empty()) { *error = "Native HAL '" + object->name + "' should not have defined."; return false; } } break; case HalFormat::AIDL: { if (!object->transportArch.empty()) { LOG(WARNING) << "Ignoring on manifest " << object->name; object->transportArch = {}; } if (!parseChildren(root, AidlVersionConverter{}, &object->versions, error)) { return false; } // Insert fake version for AIDL HALs so that forEachInstance works. if (object->versions.empty()) { object->versions.push_back(details::kDefaultAidlVersion); } } break; default: { LOG(FATAL) << "Unhandled HalFormat " << static_cast::type>( object->format); } break; } if (!object->transportArch.isValid(error)) return false; object->interfaces.clear(); for (auto &&interface : interfaces) { auto res = object->interfaces.emplace(interface.name(), std::move(interface)); if (!res.second) { *error = "Duplicated interface entry \"" + res.first->first + "\"; if additional instances are needed, add them to the " "existing node."; return false; } } // Do not check for target-side libvintf to avoid restricting upgrade accidentally. #ifndef LIBVINTF_TARGET if (!checkAdditionalRestrictionsOnHal(*object, error)) { return false; } #endif std::set fqInstances; if (!parseChildren(root, FqInstanceConverter{}, &fqInstances, error)) { return false; } std::set fqInstancesToInsert; for (auto& e : fqInstances) { if (e.hasPackage()) { *error = "Should not specify package: \"" + e.string() + "\""; return false; } if (object->format == HalFormat::AIDL) { // in AIDL HALs should not contain version. if (e.hasVersion()) { *error = "Should not specify version in for AIDL HAL: \"" + e.string() + "\""; return false; } // Put in the fake kDefaultAidlVersion so that HalManifest can // store it in an FqInstance object with a non-empty package. FqInstance withFakeVersion; if (!withFakeVersion.setTo(details::kDefaultAidlVersion.majorVer, details::kDefaultAidlVersion.minorVer, e.getInterface(), e.getInstance())) { return false; } fqInstancesToInsert.emplace(std::move(withFakeVersion)); } else { fqInstancesToInsert.emplace(std::move(e)); } } if (!object->insertInstances(fqInstancesToInsert, error)) { return false; } if (!object->isValid(error)) { error->insert(0, "'" + object->name + "' is not a valid Manifest HAL: "); return false; } return true; } #ifndef LIBVINTF_TARGET private: bool checkAdditionalRestrictionsOnHal(const ManifestHal& hal, std::string* error) const { if (hal.getName() == "netutils-wrapper") { for (const Version& v : hal.versions) { if (v.minorVer != 0) { *error = "netutils-wrapper HAL must specify exactly one version x.0, " "but minor version is not 0. Perhaps you mean '" + to_string(Version{v.majorVer, 0}) + "'?"; return false; } } } return true; } #endif }; struct KernelSepolicyVersionConverter : public XmlTextConverter { std::string elementName() const override { return "kernel-sepolicy-version"; } }; struct SepolicyVersionConverter : public XmlTextConverter { std::string elementName() const override { return "sepolicy-version"; } }; struct SepolicyConverter : public XmlNodeConverter { std::string elementName() const override { return "sepolicy"; } void mutateNode(const Sepolicy &object, NodeType *root, DocType *d) const override { appendChild(root, KernelSepolicyVersionConverter{}(object.kernelSepolicyVersion(), d)); appendChildren(root, SepolicyVersionConverter{}, object.sepolicyVersions(), d); } bool buildObject(Sepolicy* object, NodeType* root, std::string* error) const override { if (!parseChild(root, KernelSepolicyVersionConverter{}, &object->mKernelSepolicyVersion, error) || !parseChildren(root, SepolicyVersionConverter{}, &object->mSepolicyVersionRanges, error)) { return false; } return true; } }; struct [[deprecated]] VndkVersionRangeConverter : public XmlTextConverter { std::string elementName() const override { return "version"; } }; struct VndkVersionConverter : public XmlTextConverter { std::string elementName() const override { return "version"; } }; struct VndkLibraryConverter : public XmlTextConverter { std::string elementName() const override { return "library"; } }; struct [[deprecated]] VndkConverter : public XmlNodeConverter { std::string elementName() const override { return "vndk"; } void mutateNode(const Vndk &object, NodeType *root, DocType *d) const override { appendChild(root, VndkVersionRangeConverter{}(object.mVersionRange, d)); appendChildren(root, VndkLibraryConverter{}, object.mLibraries, d); } bool buildObject(Vndk* object, NodeType* root, std::string* error) const override { if (!parseChild(root, VndkVersionRangeConverter{}, &object->mVersionRange, error) || !parseChildren(root, VndkLibraryConverter{}, &object->mLibraries, error)) { return false; } return true; } }; struct VendorNdkConverter : public XmlNodeConverter { std::string elementName() const override { return "vendor-ndk"; } void mutateNode(const VendorNdk& object, NodeType* root, DocType* d) const override { appendChild(root, VndkVersionConverter{}(object.mVersion, d)); appendChildren(root, VndkLibraryConverter{}, object.mLibraries, d); } bool buildObject(VendorNdk* object, NodeType* root, std::string* error) const override { if (!parseChild(root, VndkVersionConverter{}, &object->mVersion, error) || !parseChildren(root, VndkLibraryConverter{}, &object->mLibraries, error)) { return false; } return true; } }; struct SystemSdkVersionConverter : public XmlTextConverter { std::string elementName() const override { return "version"; } }; struct SystemSdkConverter : public XmlNodeConverter { std::string elementName() const override { return "system-sdk"; } void mutateNode(const SystemSdk& object, NodeType* root, DocType* d) const override { appendChildren(root, SystemSdkVersionConverter{}, object.versions(), d); } bool buildObject(SystemSdk* object, NodeType* root, std::string* error) const override { return parseChildren(root, SystemSdkVersionConverter{}, &object->mVersions, error); } }; struct HalManifestSepolicyConverter : public XmlNodeConverter { std::string elementName() const override { return "sepolicy"; } void mutateNode(const Version &m, NodeType *root, DocType *d) const override { appendChild(root, VersionConverter{}(m, d)); } bool buildObject(Version* object, NodeType* root, std::string* error) const override { return parseChild(root, VersionConverter{}, object, error); } }; struct ManifestXmlFileConverter : public XmlNodeConverter { std::string elementName() const override { return "xmlfile"; } void mutateNode(const ManifestXmlFile& f, NodeType* root, DocType* d) const override { appendTextElement(root, "name", f.name(), d); appendChild(root, VersionConverter{}(f.version(), d)); if (!f.overriddenPath().empty()) { appendTextElement(root, "path", f.overriddenPath(), d); } } bool buildObject(ManifestXmlFile* object, NodeType* root, std::string* error) const override { if (!parseTextElement(root, "name", &object->mName, error) || !parseChild(root, VersionConverter{}, &object->mVersion, error) || !parseOptionalTextElement(root, "path", {}, &object->mOverriddenPath, error)) { return false; } return true; } }; struct StringKernelConfigKeyConverter : public XmlTextConverter { std::string elementName() const override { return "key"; } }; struct KernelConfigValueConverter : public XmlTextConverter { std::string elementName() const override { return "value"; } }; struct StringKernelConfigConverter : public XmlPairConverter, StringKernelConfigKeyConverter, KernelConfigValueConverter> { std::string elementName() const override { return "config"; } }; struct KernelInfoConverter : public XmlNodeConverter { std::string elementName() const override { return "kernel"; } void mutateNode(const KernelInfo& o, NodeType* root, DocType* d) const override { mutateNode(o, root, d, SerializeFlags::EVERYTHING); } void mutateNode(const KernelInfo& o, NodeType* root, DocType* d, SerializeFlags::Type flags) const override { if (o.version() != KernelVersion{}) { appendAttr(root, "version", o.version()); } if (o.level() != Level::UNSPECIFIED) { appendAttr(root, "target-level", o.level()); } if (flags.isKernelConfigsEnabled()) { appendChildren(root, StringKernelConfigConverter{}, o.configs(), d); } } bool buildObject(KernelInfo* o, NodeType* root, std::string* error) const override { return parseOptionalAttr(root, "version", {}, &o->mVersion, error) && parseOptionalAttr(root, "target-level", Level::UNSPECIFIED, &o->mLevel, error) && parseChildren(root, StringKernelConfigConverter{}, &o->mConfigs, error); } }; struct HalManifestConverter : public XmlNodeConverter { std::string elementName() const override { return "manifest"; } void mutateNode(const HalManifest &m, NodeType *root, DocType *d) const override { mutateNode(m, root, d, SerializeFlags::EVERYTHING); } void mutateNode(const HalManifest& m, NodeType* root, DocType* d, SerializeFlags::Type flags) const override { if (flags.isMetaVersionEnabled()) { appendAttr(root, "version", m.getMetaVersion()); } if (flags.isSchemaTypeEnabled()) { appendAttr(root, "type", m.mType); } if (flags.isHalsEnabled()) { appendChildren(root, ManifestHalConverter{}, m.getHals(), d, flags); } if (m.mType == SchemaType::DEVICE) { if (flags.isSepolicyEnabled()) { if (m.device.mSepolicyVersion != Version{}) { appendChild(root, HalManifestSepolicyConverter{}(m.device.mSepolicyVersion, d)); } } if (m.mLevel != Level::UNSPECIFIED) { this->appendAttr(root, "target-level", m.mLevel); } if (flags.isKernelEnabled()) { if (!!m.kernel()) { appendChild(root, KernelInfoConverter{}(*m.kernel(), d, flags)); } } } else if (m.mType == SchemaType::FRAMEWORK) { if (flags.isVndkEnabled()) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" appendChildren(root, VndkConverter{}, m.framework.mVndks, d); #pragma clang diagnostic pop appendChildren(root, VendorNdkConverter{}, m.framework.mVendorNdks, d); } if (flags.isSsdkEnabled()) { if (!m.framework.mSystemSdk.empty()) { appendChild(root, SystemSdkConverter{}(m.framework.mSystemSdk, d)); } } } if (flags.isXmlFilesEnabled()) { appendChildren(root, ManifestXmlFileConverter{}, m.getXmlFiles(), d); } } bool buildObject(HalManifest* object, NodeType* root, std::string* error) const override { Version metaVersion; if (!parseAttr(root, "version", &metaVersion, error)) return false; if (metaVersion > kMetaVersion) { *error = "Unrecognized manifest.version " + to_string(metaVersion) + " (libvintf@" + to_string(kMetaVersion) + ")"; return false; } if (!parseAttr(root, "type", &object->mType, error)) { return false; } std::vector hals; if (!parseChildren(root, ManifestHalConverter{}, &hals, error)) { return false; } for (auto&& hal : hals) { hal.setFileName(object->fileName()); } if (object->mType == SchemaType::DEVICE) { // tags for device hal manifest only. // can be missing because it can be determined at build time, not hard-coded // in the XML file. if (!parseOptionalChild(root, HalManifestSepolicyConverter{}, {}, &object->device.mSepolicyVersion, error)) { return false; } if (!parseOptionalAttr(root, "target-level", Level::UNSPECIFIED, &object->mLevel, error)) { return false; } if (!parseOptionalChild(root, KernelInfoConverter{}, &object->device.mKernel, error)) { return false; } } else if (object->mType == SchemaType::FRAMEWORK) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" if (!parseChildren(root, VndkConverter{}, &object->framework.mVndks, error)) { return false; } for (const auto &vndk : object->framework.mVndks) { if (!vndk.mVersionRange.isSingleVersion()) { *error = "vndk.version " + to_string(vndk.mVersionRange) + " cannot be a range for manifests"; return false; } } #pragma clang diagnostic pop if (!parseChildren(root, VendorNdkConverter{}, &object->framework.mVendorNdks, error)) { return false; } std::set vendorNdkVersions; for (const auto& vendorNdk : object->framework.mVendorNdks) { if (vendorNdkVersions.find(vendorNdk.version()) != vendorNdkVersions.end()) { *error = "Duplicated manifest.vendor-ndk.version " + vendorNdk.version(); return false; } vendorNdkVersions.insert(vendorNdk.version()); } if (!parseOptionalChild(root, SystemSdkConverter{}, {}, &object->framework.mSystemSdk, error)) { return false; } } for (auto &&hal : hals) { std::string description{hal.name}; if (!object->add(std::move(hal))) { *error = "Duplicated manifest.hal entry " + description; return false; } } std::vector xmlFiles; if (!parseChildren(root, ManifestXmlFileConverter{}, &xmlFiles, error)) { return false; } for (auto&& xmlFile : xmlFiles) { std::string description{xmlFile.name()}; if (!object->addXmlFile(std::move(xmlFile))) { *error = "Duplicated manifest.xmlfile entry " + description + "; entries cannot have duplicated name and version"; return false; } } return true; } }; struct AvbVersionConverter : public XmlTextConverter { std::string elementName() const override { return "vbmeta-version"; } }; struct AvbConverter : public XmlNodeConverter { std::string elementName() const override { return "avb"; } void mutateNode(const Version &m, NodeType *root, DocType *d) const override { appendChild(root, AvbVersionConverter{}(m, d)); } bool buildObject(Version* object, NodeType* root, std::string* error) const override { return parseChild(root, AvbVersionConverter{}, object, error); } }; struct MatrixXmlFileConverter : public XmlNodeConverter { std::string elementName() const override { return "xmlfile"; } void mutateNode(const MatrixXmlFile& f, NodeType* root, DocType* d) const override { appendTextElement(root, "name", f.name(), d); appendAttr(root, "format", f.format()); appendAttr(root, "optional", f.optional()); appendChild(root, VersionRangeConverter{}(f.versionRange(), d)); if (!f.overriddenPath().empty()) { appendTextElement(root, "path", f.overriddenPath(), d); } } bool buildObject(MatrixXmlFile* object, NodeType* root, std::string* error) const override { if (!parseTextElement(root, "name", &object->mName, error) || !parseAttr(root, "format", &object->mFormat, error) || !parseOptionalAttr(root, "optional", false, &object->mOptional, error) || !parseChild(root, VersionRangeConverter{}, &object->mVersionRange, error) || !parseOptionalTextElement(root, "path", {}, &object->mOverriddenPath, error)) { return false; } return true; } }; struct CompatibilityMatrixConverter : public XmlNodeConverter { std::string elementName() const override { return "compatibility-matrix"; } void mutateNode(const CompatibilityMatrix &m, NodeType *root, DocType *d) const override { mutateNode(m, root, d, SerializeFlags::EVERYTHING); } void mutateNode(const CompatibilityMatrix& m, NodeType* root, DocType* d, SerializeFlags::Type flags) const override { if (flags.isMetaVersionEnabled()) { appendAttr(root, "version", kMetaVersion); } if (flags.isSchemaTypeEnabled()) { appendAttr(root, "type", m.mType); } if (flags.isHalsEnabled()) { appendChildren(root, MatrixHalConverter{}, iterateValues(m.mHals), d); } if (m.mType == SchemaType::FRAMEWORK) { if (flags.isKernelEnabled()) { appendChildren(root, MatrixKernelConverter{}, m.framework.mKernels, d, flags); } if (flags.isSepolicyEnabled()) { if (!(m.framework.mSepolicy == Sepolicy{})) { appendChild(root, SepolicyConverter{}(m.framework.mSepolicy, d)); } } if (flags.isAvbEnabled()) { if (!(m.framework.mAvbMetaVersion == Version{})) { appendChild(root, AvbConverter{}(m.framework.mAvbMetaVersion, d)); } } if (m.mLevel != Level::UNSPECIFIED) { this->appendAttr(root, "level", m.mLevel); } } else if (m.mType == SchemaType::DEVICE) { if (flags.isVndkEnabled()) { #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" if (!(m.device.mVndk == Vndk{})) { appendChild(root, VndkConverter{}(m.device.mVndk, d)); } #pragma clang diagnostic pop if (!(m.device.mVendorNdk == VendorNdk{})) { appendChild(root, VendorNdkConverter{}(m.device.mVendorNdk, d)); } } if (flags.isSsdkEnabled()) { if (!m.device.mSystemSdk.empty()) { appendChild(root, SystemSdkConverter{}(m.device.mSystemSdk, d)); } } } if (flags.isXmlFilesEnabled()) { appendChildren(root, MatrixXmlFileConverter{}, m.getXmlFiles(), d); } } bool buildObject(CompatibilityMatrix* object, NodeType* root, std::string* error) const override { Version metaVersion; if (!parseAttr(root, "version", &metaVersion, error)) return false; if (metaVersion > kMetaVersion) { *error = "Unrecognized compatibility-matrix.version " + to_string(metaVersion) + " (libvintf@" + to_string(kMetaVersion) + ")"; return false; } std::vector hals; if (!parseAttr(root, "type", &object->mType, error) || !parseChildren(root, MatrixHalConverter{}, &hals, error)) { return false; } if (object->mType == SchemaType::FRAMEWORK) { // and can be missing because it can be determined at build time, not // hard-coded in the XML file. if (!parseChildren(root, MatrixKernelConverter{}, &object->framework.mKernels, error) || !parseOptionalChild(root, SepolicyConverter{}, {}, &object->framework.mSepolicy, error) || !parseOptionalChild(root, AvbConverter{}, {}, &object->framework.mAvbMetaVersion, error)) { return false; } std::set seenKernelVersions; for (const auto& kernel : object->framework.mKernels) { Version minLts(kernel.minLts().version, kernel.minLts().majorRev); if (seenKernelVersions.find(minLts) != seenKernelVersions.end()) { continue; } if (!kernel.conditions().empty()) { *error = "First for version " + to_string(minLts) + " must have empty for backwards compatibility."; return false; } seenKernelVersions.insert(minLts); } if (!parseOptionalAttr(root, "level", Level::UNSPECIFIED, &object->mLevel, error)) { return false; } } else if (object->mType == SchemaType::DEVICE) { // can be missing because it can be determined at build time, not hard-coded // in the XML file. #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" if (!parseOptionalChild(root, VndkConverter{}, {}, &object->device.mVndk, error)) { return false; } #pragma clang diagnostic pop if (!parseOptionalChild(root, VendorNdkConverter{}, {}, &object->device.mVendorNdk, error)) { return false; } if (!parseOptionalChild(root, SystemSdkConverter{}, {}, &object->device.mSystemSdk, error)) { return false; } } for (auto &&hal : hals) { if (!object->add(std::move(hal))) { *error = "Duplicated compatibility-matrix.hal entry"; return false; } } std::vector xmlFiles; if (!parseChildren(root, MatrixXmlFileConverter{}, &xmlFiles, error)) { return false; } for (auto&& xmlFile : xmlFiles) { if (!xmlFile.optional()) { *error = "compatibility-matrix.xmlfile entry " + xmlFile.name() + " has to be optional for compatibility matrix version 1.0"; return false; } std::string description{xmlFile.name()}; if (!object->addXmlFile(std::move(xmlFile))) { *error = "Duplicated compatibility-matrix.xmlfile entry " + description; return false; } } return true; } }; #define CREATE_CONVERT_FN(type) \ std::string toXml(const type& o, SerializeFlags::Type flags) { \ return type##Converter{}(o, flags); \ } \ bool fromXml(type* o, const std::string& xml, std::string* error) { \ return type##Converter{}(o, xml, error); \ } // Create convert functions for public usage. CREATE_CONVERT_FN(HalManifest) CREATE_CONVERT_FN(CompatibilityMatrix) // Create convert functions for internal usage. CREATE_CONVERT_FN(KernelInfo) // Create convert functions for testing. CREATE_CONVERT_FN(Version) CREATE_CONVERT_FN(KernelConfigTypedValue) CREATE_CONVERT_FN(MatrixHal) CREATE_CONVERT_FN(ManifestHal) #undef CREATE_CONVERT_FN } // namespace vintf } // namespace android