CompatibilityMatrix.cpp

/*
 * 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.
 */

#include "CompatibilityMatrix.h"

#include <utility>

#include "parse_string.h"
#include "utils.h"

#include <iostream>
#include "parse_xml.h"

namespace android {
namespace vintf {

bool CompatibilityMatrix::add(MatrixHal &&hal) {
    return HalGroup<MatrixHal>::add(std::move(hal));
}

bool CompatibilityMatrix::add(MatrixKernel &&kernel) {
    if (mType != SchemaType::FRAMEWORK) {
        return false;
    }
    framework.mKernels.push_back(std::move(kernel));
    return true;
}

SchemaType CompatibilityMatrix::type() const {
    return mType;
}

Level CompatibilityMatrix::level() const {
    return mLevel;
}

Version CompatibilityMatrix::getMinimumMetaVersion() const {
    // TODO(b/62801658): this needs to depend on whether there are 1.1 requirements
    // (e.g. required <xmlfile> entry)
    return {1, 0};
}

status_t CompatibilityMatrix::fetchAllInformation(const std::string& path, std::string* error) {
    return details::fetchAllInformation(path, gCompatibilityMatrixConverter, this, error);
}

std::string CompatibilityMatrix::getXmlSchemaPath(const std::string& xmlFileName,
                                                  const Version& version) const {
    using std::literals::string_literals::operator""s;
    auto range = getXmlFiles(xmlFileName);
    for (auto it = range.first; it != range.second; ++it) {
        const MatrixXmlFile& matrixXmlFile = it->second;
        if (matrixXmlFile.versionRange().contains(version)) {
            if (!matrixXmlFile.overriddenPath().empty()) {
                return matrixXmlFile.overriddenPath();
            }
            return "/"s + (type() == SchemaType::DEVICE ? "vendor" : "system") + "/etc/" +
                   xmlFileName + "_V" + std::to_string(matrixXmlFile.versionRange().majorVer) +
                   "_" + std::to_string(matrixXmlFile.versionRange().maxMinor) + "." +
                   to_string(matrixXmlFile.format());
        }
    }
    return "";
}

static VersionRange* findRangeWithMajorVersion(std::vector<VersionRange>& versionRanges,
                                               size_t majorVer) {
    for (VersionRange& vr : versionRanges) {
        if (vr.majorVer == majorVer) {
            return &vr;
        }
    }
    return nullptr;
}

std::pair<MatrixHal*, VersionRange*> CompatibilityMatrix::getHalWithMajorVersion(
    const std::string& name, size_t majorVer) {
    for (MatrixHal* hal : getHals(name)) {
        VersionRange* vr = findRangeWithMajorVersion(hal->versionRanges, majorVer);
        if (vr != nullptr) {
            return {hal, vr};
        }
    }
    return {nullptr, nullptr};
}

bool CompatibilityMatrix::addAllHalsAsOptional(CompatibilityMatrix* other, std::string* error) {
    if (other == nullptr || other->level() <= level()) {
        return true;
    }

    for (auto& pair : other->mHals) {
        const std::string& name = pair.first;
        MatrixHal& halToAdd = pair.second;
        for (const VersionRange& vr : halToAdd.versionRanges) {
            MatrixHal* existingHal;
            VersionRange* existingVr;
            std::tie(existingHal, existingVr) = getHalWithMajorVersion(name, vr.majorVer);

            if (existingHal == nullptr) {
                MatrixHal optionalHalToAdd(halToAdd);
                optionalHalToAdd.optional = true;
                optionalHalToAdd.versionRanges = {vr};
                if (!add(std::move(optionalHalToAdd))) {
                    if (error) {
                        *error = "Cannot add HAL " + name + " for unknown reason.";
                    }
                    return false;
                }
                continue;
            }

            if (!existingHal->optional && !existingHal->containsInstances(halToAdd)) {
                if (error != nullptr) {
                    *error = "HAL " + name + "@" + to_string(vr.minVer()) + " is a required " +
                             "HAL, but fully qualified instance names don't match (at FCM "
                             "Version " +
                             std::to_string(level()) + " and " + std::to_string(other->level()) +
                             ")";
                }
                return false;
            }

            existingVr->maxMinor = std::max(existingVr->maxMinor, vr.maxMinor);
        }
    }
    return true;
}

bool CompatibilityMatrix::addAllXmlFilesAsOptional(CompatibilityMatrix* other, std::string* error) {
    if (other == nullptr || other->level() <= level()) {
        return true;
    }
    for (auto& pair : other->mXmlFiles) {
        const std::string& name = pair.first;
        MatrixXmlFile& xmlFileToAdd = pair.second;

        xmlFileToAdd.mOptional = true;
        if (!addXmlFile(std::move(xmlFileToAdd))) {
            if (error) {
                *error = "Cannot add XML File " + name + " for unknown reason.";
            }
            return false;
        }
    }
    return true;
}

bool operator==(const CompatibilityMatrix &lft, const CompatibilityMatrix &rgt) {
    return lft.mType == rgt.mType && lft.mLevel == rgt.mLevel && lft.mHals == rgt.mHals &&
           lft.mXmlFiles == rgt.mXmlFiles &&
           (lft.mType != SchemaType::DEVICE || (lft.device.mVndk == rgt.device.mVndk)) &&
           (lft.mType != SchemaType::FRAMEWORK ||
            (lft.framework.mKernels == rgt.framework.mKernels &&
             lft.framework.mSepolicy == rgt.framework.mSepolicy &&
             lft.framework.mAvbMetaVersion == rgt.framework.mAvbMetaVersion));
}

// Find compatibility_matrix.empty.xml (which has unspecified level) and use it
// as a base matrix.
CompatibilityMatrix* CompatibilityMatrix::findOrInsertBaseMatrix(
    std::vector<std::pair<std::string, CompatibilityMatrix>>* matrices, std::string* error) {
    bool multipleFound = false;
    CompatibilityMatrix* matrix = nullptr;
    for (auto& e : *matrices) {
        if (e.second.level() == Level::UNSPECIFIED) {
            if (!e.second.mHals.empty()) {
                if (error) {
                    *error =
                        "Error: File \"" + e.first + "\" should not contain " + "HAL elements.";
                }
                return nullptr;
            }

            if (!e.second.mXmlFiles.empty()) {
                if (error) {
                    *error = "Error: File \"" + e.first + "\" should not contain " +
                             "XML File elements.";
                }
                return nullptr;
            }

            if (matrix != nullptr) {
                multipleFound = true;
            }

            matrix = &e.second;
            // continue to detect multiple files with "unspecified" levels
        }
    }

    if (multipleFound) {
        if (error) {
            *error =
                "Error: multiple framework compatibility matrix files have "
                "unspecified level; there should only be one such file.\n";
            for (auto& e : *matrices) {
                if (e.second.level() == Level::UNSPECIFIED) {
                    *error += "    " + e.first + "\n";
                }
            }
        }
        return nullptr;
    }

    if (matrix == nullptr) {
        matrix = &matrices->emplace(matrices->end())->second;
        matrix->mType = SchemaType::FRAMEWORK;
        matrix->mLevel = Level::UNSPECIFIED;
    }

    return matrix;
}

CompatibilityMatrix* CompatibilityMatrix::combine(
    Level deviceLevel, std::vector<std::pair<std::string, CompatibilityMatrix>>* matrices,
    std::string* error) {
    if (deviceLevel == Level::UNSPECIFIED) {
        if (error) {
            *error = "Error: device level is unspecified.";
        }
        return nullptr;
    }

    CompatibilityMatrix* matrix = findOrInsertBaseMatrix(matrices, error);
    if (matrix == nullptr) {
        return nullptr;
    }

    matrix->mLevel = deviceLevel;

    for (auto& e : *matrices) {
        if (&e.second != matrix && e.second.level() == deviceLevel) {
            if (!matrix->addAllHals(&e.second, error)) {
                if (error) {
                    *error = "File \"" + e.first + "\" cannot be added: HAL " + *error +
                             " has a conflict.";
                }
                return nullptr;
            }

            if (!matrix->addAllXmlFiles(&e.second, error)) {
                if (error) {
                    *error = "File \"" + e.first + "\" cannot be added: XML File entry " + *error +
                             " has a conflict.";
                }
                return nullptr;
            }
        }
    }

    for (auto& e : *matrices) {
        if (&e.second != matrix && e.second.level() != Level::UNSPECIFIED &&
            e.second.level() > deviceLevel) {
            if (!matrix->addAllHalsAsOptional(&e.second, error)) {
                if (error) {
                    *error = "File \"" + e.first + "\" cannot be added: " + *error +
                             ". See <hal> with the same name " +
                             "in previously parsed files or previously declared in this file.";
                }
                return nullptr;
            }

            if (!matrix->addAllXmlFilesAsOptional(&e.second, error)) {
                if (error) {
                    *error = "File \"" + e.first + "\" cannot be added: XML File entry " + *error +
                             " has a conflict.";
                }
                return nullptr;
            }
        }
    }

    return matrix;
}

} // namespace vintf
} // namespace android