summaryrefslogtreecommitdiffstats
blob: 595c57a98f9073bcfc62586654dcc9300bdf912a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
 * 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.
 */

#ifndef ANDROID_VINTF_MATRIX_HAL_H
#define ANDROID_VINTF_MATRIX_HAL_H

#include <map>
#include <set>
#include <string>
#include <vector>

#include "HalFormat.h"
#include "HalInterface.h"
#include "MatrixInstance.h"
#include "VersionRange.h"

namespace android {
namespace vintf {

// A HAL entry to a compatibility matrix
struct MatrixHal {
    using InstanceType = MatrixInstance;

    bool operator==(const MatrixHal &other) const;
    // Check whether the MatrixHal contains the given version.
    bool containsVersion(const Version& version) const;
    // Get all instances of the ManifestHal with given interface name.
    std::set<std::string> getInstances(const std::string& interfaceName) const;

    HalFormat format = HalFormat::HIDL;
    std::string name;
    std::vector<VersionRange> versionRanges;
    bool optional = false;
    std::map<std::string, HalInterface> interfaces;

    inline const std::string& getName() const { return name; }

    bool forEachInstance(const std::function<bool(const MatrixInstance&)>& func) const;

   private:
    friend struct HalManifest;
    friend struct CompatibilityMatrix;
    // Loop over interface/instance for a specific VersionRange.
    bool forEachInstance(const VersionRange& vr,
                         const std::function<bool(const MatrixInstance&)>& func) const;
    // Loop over interface/instance. VersionRange is supplied to the function as a vector.
    bool forEachInstance(
        const std::function<bool(const std::vector<VersionRange>&, const std::string&,
                                 const std::string&)>& func) const;
    bool isCompatible(const std::set<FqInstance>& providedInstances,
                      const std::set<Version>& providedVersions) const;
    bool isCompatible(const VersionRange& vr, const std::set<FqInstance>& providedInstances,
                      const std::set<Version>& providedVersions) const;

    void setOptional(bool o);
    void insertVersionRanges(const std::vector<VersionRange>& other);
    void insertInstance(const std::string& interface, const std::string& instance);
    // Return true if it has any interface/instance tags.
    bool hasAnyInstance() const;
    bool hasInstance(const std::string& interface, const std::string& instance) const;
    // Return true if it contains only interface/instance.
    bool hasOnlyInstance(const std::string& interface, const std::string& instance) const;
    // Remove a specific interface/instances. Return true if removed, false otherwise.
    bool removeInstance(const std::string& interface, const std::string& instance);
    // Remove all <interface> tags.
    void clearInstances();
};

} // namespace vintf
} // namespace android

#endif // ANDROID_VINTF_MATRIX_HAL_H