Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2017 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #include "VintfObject.h" |
| 18 | |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 19 | #include <dirent.h> |
| 20 | |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 21 | #include <functional> |
| 22 | #include <memory> |
| 23 | #include <mutex> |
| 24 | |
Yifan Hong | 6021703 | 2018-01-08 16:19:42 -0800 | [diff] [blame] | 25 | #include <android-base/logging.h> |
| 26 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 27 | #include "CompatibilityMatrix.h" |
| 28 | #include "VintfObjectAfterUpdate.h" |
| 29 | #include "parse_string.h" |
| 30 | #include "parse_xml.h" |
| 31 | #include "utils.h" |
| 32 | |
Yifan Hong | 6021703 | 2018-01-08 16:19:42 -0800 | [diff] [blame] | 33 | using std::placeholders::_1; |
| 34 | using std::placeholders::_2; |
| 35 | |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 36 | namespace android { |
| 37 | namespace vintf { |
| 38 | |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 39 | using namespace details; |
| 40 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 41 | #ifdef LIBVINTF_TARGET |
| 42 | static constexpr bool kIsTarget = true; |
| 43 | #else |
| 44 | static constexpr bool kIsTarget = false; |
| 45 | #endif |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 46 | |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 47 | template <typename T, typename F> |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 48 | static std::shared_ptr<const T> Get( |
| 49 | LockedSharedPtr<T> *ptr, |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 50 | bool skipCache, |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 51 | const F &fetchAllInformation) { |
| 52 | std::unique_lock<std::mutex> _lock(ptr->mutex); |
Yifan Hong | 7219ba1 | 2018-01-08 16:23:49 -0800 | [diff] [blame] | 53 | if (skipCache || !ptr->fetchedOnce) { |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 54 | ptr->object = std::make_unique<T>(); |
Yifan Hong | 6021703 | 2018-01-08 16:19:42 -0800 | [diff] [blame] | 55 | std::string error; |
| 56 | if (fetchAllInformation(ptr->object.get(), &error) != OK) { |
| 57 | LOG(WARNING) << error; |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 58 | ptr->object = nullptr; // frees the old object |
| 59 | } |
Yifan Hong | 7219ba1 | 2018-01-08 16:23:49 -0800 | [diff] [blame] | 60 | ptr->fetchedOnce = true; |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 61 | } |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 62 | return ptr->object; |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 63 | } |
| 64 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 65 | static std::unique_ptr<FileSystem> createDefaultFileSystem() { |
| 66 | std::unique_ptr<FileSystem> fileSystem; |
| 67 | if (kIsTarget) { |
| 68 | fileSystem = std::make_unique<details::FileSystemImpl>(); |
| 69 | } else { |
| 70 | fileSystem = std::make_unique<details::FileSystemNoOp>(); |
| 71 | } |
| 72 | return fileSystem; |
| 73 | } |
| 74 | |
| 75 | static std::unique_ptr<PropertyFetcher> createDefaultPropertyFetcher() { |
| 76 | std::unique_ptr<PropertyFetcher> propertyFetcher; |
| 77 | if (kIsTarget) { |
| 78 | propertyFetcher = std::make_unique<details::PropertyFetcherImpl>(); |
| 79 | } else { |
| 80 | propertyFetcher = std::make_unique<details::PropertyFetcherNoOp>(); |
| 81 | } |
| 82 | return propertyFetcher; |
| 83 | } |
| 84 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 85 | details::LockedSharedPtr<VintfObject> VintfObject::sInstance{}; |
| 86 | std::shared_ptr<VintfObject> VintfObject::GetInstance() { |
| 87 | std::unique_lock<std::mutex> lock(sInstance.mutex); |
| 88 | if (sInstance.object == nullptr) { |
Yifan Hong | 78f5b57 | 2018-11-27 14:05:03 -0800 | [diff] [blame^] | 89 | sInstance.object = std::shared_ptr<VintfObject>(VintfObject::Builder().build().release()); |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 90 | } |
| 91 | return sInstance.object; |
| 92 | } |
| 93 | |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 94 | std::shared_ptr<const HalManifest> VintfObject::GetDeviceHalManifest(bool skipCache) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 95 | return GetInstance()->getDeviceHalManifest(skipCache); |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 96 | } |
| 97 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 98 | std::shared_ptr<const HalManifest> VintfObject::getDeviceHalManifest(bool skipCache) { |
| 99 | return Get(&mDeviceManifest, skipCache, |
| 100 | std::bind(&VintfObject::fetchDeviceHalManifest, this, _1, _2)); |
| 101 | } |
| 102 | |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 103 | std::shared_ptr<const HalManifest> VintfObject::GetFrameworkHalManifest(bool skipCache) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 104 | return GetInstance()->getFrameworkHalManifest(skipCache); |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 105 | } |
| 106 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 107 | std::shared_ptr<const HalManifest> VintfObject::getFrameworkHalManifest(bool skipCache) { |
| 108 | return Get(&mFrameworkManifest, skipCache, |
| 109 | std::bind(&VintfObject::fetchFrameworkHalManifest, this, _1, _2)); |
| 110 | } |
Yifan Hong | 2272bf8 | 2017-04-28 14:37:56 -0700 | [diff] [blame] | 111 | |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 112 | std::shared_ptr<const CompatibilityMatrix> VintfObject::GetDeviceCompatibilityMatrix(bool skipCache) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 113 | return GetInstance()->getDeviceCompatibilityMatrix(skipCache); |
Yifan Hong | 2272bf8 | 2017-04-28 14:37:56 -0700 | [diff] [blame] | 114 | } |
| 115 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 116 | std::shared_ptr<const CompatibilityMatrix> VintfObject::getDeviceCompatibilityMatrix( |
| 117 | bool skipCache) { |
| 118 | return Get(&mDeviceMatrix, skipCache, std::bind(&VintfObject::fetchDeviceMatrix, this, _1, _2)); |
| 119 | } |
| 120 | |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 121 | std::shared_ptr<const CompatibilityMatrix> VintfObject::GetFrameworkCompatibilityMatrix(bool skipCache) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 122 | return GetInstance()->getFrameworkCompatibilityMatrix(skipCache); |
| 123 | } |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 124 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 125 | std::shared_ptr<const CompatibilityMatrix> VintfObject::getFrameworkCompatibilityMatrix( |
| 126 | bool skipCache) { |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 127 | // To avoid deadlock, get device manifest before any locks. |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 128 | auto deviceManifest = getDeviceHalManifest(); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 129 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 130 | std::unique_lock<std::mutex> _lock(mFrameworkCompatibilityMatrixMutex); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 131 | |
| 132 | auto combined = |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 133 | Get(&mCombinedFrameworkMatrix, skipCache, |
| 134 | std::bind(&VintfObject::getCombinedFrameworkMatrix, this, deviceManifest, _1, _2)); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 135 | if (combined != nullptr) { |
| 136 | return combined; |
| 137 | } |
| 138 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 139 | return Get(&mFrameworkMatrix, skipCache, |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 140 | std::bind(&CompatibilityMatrix::fetchAllInformation, _1, getFileSystem().get(), |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 141 | kSystemLegacyMatrix, _2)); |
Yifan Hong | 2272bf8 | 2017-04-28 14:37:56 -0700 | [diff] [blame] | 142 | } |
| 143 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 144 | status_t VintfObject::getCombinedFrameworkMatrix( |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 145 | const std::shared_ptr<const HalManifest>& deviceManifest, CompatibilityMatrix* out, |
| 146 | std::string* error) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 147 | auto matrixFragments = getAllFrameworkMatrixLevels(error); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 148 | if (matrixFragments.empty()) { |
| 149 | return NAME_NOT_FOUND; |
| 150 | } |
| 151 | |
| 152 | Level deviceLevel = Level::UNSPECIFIED; |
| 153 | |
| 154 | if (deviceManifest != nullptr) { |
| 155 | deviceLevel = deviceManifest->level(); |
| 156 | } |
| 157 | |
| 158 | // TODO(b/70628538): Do not infer from Shipping API level. |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 159 | if (deviceLevel == Level::UNSPECIFIED) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 160 | auto shippingApi = getPropertyFetcher()->getUintProperty("ro.product.first_api_level", 0u); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 161 | if (shippingApi != 0u) { |
| 162 | deviceLevel = details::convertFromApiLevel(shippingApi); |
| 163 | } |
| 164 | } |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 165 | |
| 166 | if (deviceLevel == Level::UNSPECIFIED) { |
| 167 | // Cannot infer FCM version. Combine all matrices by assuming |
| 168 | // Shipping FCM Version == min(all supported FCM Versions in the framework) |
| 169 | for (auto&& pair : matrixFragments) { |
| 170 | Level fragmentLevel = pair.object.level(); |
| 171 | if (fragmentLevel != Level::UNSPECIFIED && deviceLevel > fragmentLevel) { |
| 172 | deviceLevel = fragmentLevel; |
| 173 | } |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | if (deviceLevel == Level::UNSPECIFIED) { |
| 178 | // None of the fragments specify any FCM version. Should never happen except |
| 179 | // for inconsistent builds. |
| 180 | if (error) { |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 181 | *error = "No framework compatibility matrix files under " + kSystemVintfDir + |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 182 | " declare FCM version."; |
| 183 | } |
| 184 | return NAME_NOT_FOUND; |
| 185 | } |
| 186 | |
Yifan Hong | e7837b1 | 2018-10-11 10:38:57 -0700 | [diff] [blame] | 187 | auto combined = CompatibilityMatrix::combine(deviceLevel, &matrixFragments, error); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 188 | if (combined == nullptr) { |
| 189 | return BAD_VALUE; |
| 190 | } |
| 191 | *out = std::move(*combined); |
| 192 | return OK; |
| 193 | } |
| 194 | |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 195 | // Load and combine all of the manifests in a directory |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 196 | status_t VintfObject::addDirectoryManifests(const std::string& directory, HalManifest* manifest, |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 197 | std::string* error) { |
| 198 | std::vector<std::string> fileNames; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 199 | status_t err = getFileSystem()->listFiles(directory, &fileNames, error); |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 200 | // if the directory isn't there, that's okay |
| 201 | if (err == NAME_NOT_FOUND) return OK; |
| 202 | if (err != OK) return err; |
| 203 | |
| 204 | for (const std::string& file : fileNames) { |
| 205 | // Only adds HALs because all other things are added by libvintf |
| 206 | // itself for now. |
| 207 | HalManifest fragmentManifest; |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 208 | err = fetchOneHalManifest(directory + file, &fragmentManifest, error); |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 209 | if (err != OK) return err; |
| 210 | |
| 211 | manifest->addAllHals(&fragmentManifest); |
| 212 | } |
| 213 | |
| 214 | return OK; |
| 215 | } |
| 216 | |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 217 | // Priority for loading vendor manifest: |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 218 | // 1. /vendor/etc/vintf/manifest.xml + device fragments + ODM manifest (optional) + odm fragments |
| 219 | // 2. /vendor/etc/vintf/manifest.xml + device fragments |
| 220 | // 3. ODM manifest (optional) + odm fragments |
| 221 | // 4. /vendor/manifest.xml (legacy, no fragments) |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 222 | // where: |
Steven Moreland | 30a532c | 2018-11-01 08:46:32 -0700 | [diff] [blame] | 223 | // A + B means unioning <hal> tags from A and B. If B declares an override, then this takes priority |
| 224 | // over A. |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 225 | status_t VintfObject::fetchDeviceHalManifest(HalManifest* out, std::string* error) { |
| 226 | status_t vendorStatus = fetchOneHalManifest(kVendorManifest, out, error); |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 227 | if (vendorStatus != OK && vendorStatus != NAME_NOT_FOUND) { |
| 228 | return vendorStatus; |
| 229 | } |
| 230 | |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 231 | if (vendorStatus == OK) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 232 | status_t fragmentStatus = addDirectoryManifests(kVendorManifestFragmentDir, out, error); |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 233 | if (fragmentStatus != OK) { |
| 234 | return fragmentStatus; |
| 235 | } |
| 236 | } |
| 237 | |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 238 | HalManifest odmManifest; |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 239 | status_t odmStatus = fetchOdmHalManifest(&odmManifest, error); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 240 | if (odmStatus != OK && odmStatus != NAME_NOT_FOUND) { |
| 241 | return odmStatus; |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 242 | } |
| 243 | |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 244 | if (vendorStatus == OK) { |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 245 | if (odmStatus == OK) { |
| 246 | out->addAllHals(&odmManifest); |
| 247 | } |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 248 | return addDirectoryManifests(kOdmManifestFragmentDir, out, error); |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 249 | } |
| 250 | |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 251 | // vendorStatus != OK, "out" is not changed. |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 252 | if (odmStatus == OK) { |
| 253 | *out = std::move(odmManifest); |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 254 | return addDirectoryManifests(kOdmManifestFragmentDir, out, error); |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 255 | } |
| 256 | |
| 257 | // Use legacy /vendor/manifest.xml |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 258 | return out->fetchAllInformation(getFileSystem().get(), kVendorLegacyManifest, error); |
Yifan Hong | 5a93bf2 | 2018-01-17 18:22:32 -0800 | [diff] [blame] | 259 | } |
| 260 | |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 261 | // "out" is written to iff return status is OK. |
| 262 | // Priority: |
| 263 | // 1. if {sku} is defined, /odm/etc/vintf/manifest_{sku}.xml |
| 264 | // 2. /odm/etc/vintf/manifest.xml |
| 265 | // 3. if {sku} is defined, /odm/etc/manifest_{sku}.xml |
| 266 | // 4. /odm/etc/manifest.xml |
| 267 | // where: |
| 268 | // {sku} is the value of ro.boot.product.hardware.sku |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 269 | status_t VintfObject::fetchOdmHalManifest(HalManifest* out, std::string* error) { |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 270 | status_t status; |
| 271 | |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 272 | std::string productModel; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 273 | productModel = getPropertyFetcher()->getProperty("ro.boot.product.hardware.sku", ""); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 274 | |
| 275 | if (!productModel.empty()) { |
| 276 | status = |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 277 | fetchOneHalManifest(kOdmVintfDir + "manifest_" + productModel + ".xml", out, error); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 278 | if (status == OK || status != NAME_NOT_FOUND) { |
| 279 | return status; |
| 280 | } |
| 281 | } |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 282 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 283 | status = fetchOneHalManifest(kOdmManifest, out, error); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 284 | if (status == OK || status != NAME_NOT_FOUND) { |
| 285 | return status; |
| 286 | } |
| 287 | |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 288 | if (!productModel.empty()) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 289 | status = fetchOneHalManifest(kOdmLegacyVintfDir + "manifest_" + productModel + ".xml", out, |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 290 | error); |
| 291 | if (status == OK || status != NAME_NOT_FOUND) { |
| 292 | return status; |
| 293 | } |
| 294 | } |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 295 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 296 | status = fetchOneHalManifest(kOdmLegacyManifest, out, error); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 297 | if (status == OK || status != NAME_NOT_FOUND) { |
| 298 | return status; |
| 299 | } |
| 300 | |
| 301 | return NAME_NOT_FOUND; |
| 302 | } |
| 303 | |
| 304 | // Fetch one manifest.xml file. "out" is written to iff return status is OK. |
| 305 | // Returns NAME_NOT_FOUND if file is missing. |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 306 | status_t VintfObject::fetchOneHalManifest(const std::string& path, HalManifest* out, |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 307 | std::string* error) { |
| 308 | HalManifest ret; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 309 | status_t status = ret.fetchAllInformation(getFileSystem().get(), path, error); |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 310 | if (status == OK) { |
| 311 | *out = std::move(ret); |
| 312 | } |
| 313 | return status; |
| 314 | } |
| 315 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 316 | status_t VintfObject::fetchDeviceMatrix(CompatibilityMatrix* out, std::string* error) { |
Yifan Hong | b64ec9e | 2018-01-18 18:57:52 -0800 | [diff] [blame] | 317 | CompatibilityMatrix etcMatrix; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 318 | if (etcMatrix.fetchAllInformation(getFileSystem().get(), kVendorMatrix, error) == OK) { |
Yifan Hong | b64ec9e | 2018-01-18 18:57:52 -0800 | [diff] [blame] | 319 | *out = std::move(etcMatrix); |
| 320 | return OK; |
| 321 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 322 | return out->fetchAllInformation(getFileSystem().get(), kVendorLegacyMatrix, error); |
Yifan Hong | b64ec9e | 2018-01-18 18:57:52 -0800 | [diff] [blame] | 323 | } |
| 324 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 325 | status_t VintfObject::fetchFrameworkHalManifest(HalManifest* out, std::string* error) { |
Yifan Hong | de6d00e | 2018-02-27 17:11:28 -0800 | [diff] [blame] | 326 | HalManifest etcManifest; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 327 | if (etcManifest.fetchAllInformation(getFileSystem().get(), kSystemManifest, error) == OK) { |
Yifan Hong | de6d00e | 2018-02-27 17:11:28 -0800 | [diff] [blame] | 328 | *out = std::move(etcManifest); |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 329 | return addDirectoryManifests(kSystemManifestFragmentDir, out, error); |
Yifan Hong | de6d00e | 2018-02-27 17:11:28 -0800 | [diff] [blame] | 330 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 331 | return out->fetchAllInformation(getFileSystem().get(), kSystemLegacyManifest, error); |
Yifan Hong | de6d00e | 2018-02-27 17:11:28 -0800 | [diff] [blame] | 332 | } |
| 333 | |
Yifan Hong | 9f8f656 | 2018-11-06 16:26:20 -0800 | [diff] [blame] | 334 | static void appendLine(std::string* error, const std::string& message) { |
| 335 | if (error != nullptr) { |
| 336 | if (!error->empty()) *error += "\n"; |
| 337 | *error += message; |
| 338 | } |
| 339 | } |
| 340 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 341 | std::vector<Named<CompatibilityMatrix>> VintfObject::getAllFrameworkMatrixLevels( |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 342 | std::string* error) { |
| 343 | std::vector<std::string> fileNames; |
| 344 | std::vector<Named<CompatibilityMatrix>> results; |
| 345 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 346 | if (getFileSystem()->listFiles(kSystemVintfDir, &fileNames, error) != OK) { |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 347 | return {}; |
| 348 | } |
| 349 | for (const std::string& fileName : fileNames) { |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 350 | std::string path = kSystemVintfDir + fileName; |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 351 | |
| 352 | std::string content; |
| 353 | std::string fetchError; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 354 | status_t status = getFileSystem()->fetch(path, &content, &fetchError); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 355 | if (status != OK) { |
Yifan Hong | 9f8f656 | 2018-11-06 16:26:20 -0800 | [diff] [blame] | 356 | appendLine(error, "Framework Matrix: Ignore file " + path + ": " + fetchError); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 357 | continue; |
| 358 | } |
| 359 | |
| 360 | auto it = results.emplace(results.end()); |
Yifan Hong | 9f8f656 | 2018-11-06 16:26:20 -0800 | [diff] [blame] | 361 | std::string parseError; |
| 362 | if (!gCompatibilityMatrixConverter(&it->object, content, &parseError)) { |
| 363 | appendLine(error, "Framework Matrix: Ignore file " + path + ": " + parseError); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 364 | results.erase(it); |
| 365 | continue; |
| 366 | } |
| 367 | } |
| 368 | |
| 369 | if (results.empty()) { |
| 370 | if (error) { |
Yifan Hong | 9f8f656 | 2018-11-06 16:26:20 -0800 | [diff] [blame] | 371 | error->insert(0, "No framework matrices under " + kSystemVintfDir + |
| 372 | " can be fetched or parsed.\n"); |
Yifan Hong | d52bf3e | 2018-01-11 16:56:51 -0800 | [diff] [blame] | 373 | } |
| 374 | } else { |
| 375 | if (error && !error->empty()) { |
| 376 | LOG(WARNING) << *error; |
| 377 | *error = ""; |
| 378 | } |
| 379 | } |
| 380 | |
| 381 | return results; |
| 382 | } |
| 383 | |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 384 | std::shared_ptr<const RuntimeInfo> VintfObject::GetRuntimeInfo(bool skipCache, |
| 385 | RuntimeInfo::FetchFlags flags) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 386 | return GetInstance()->getRuntimeInfo(skipCache, flags); |
| 387 | } |
| 388 | std::shared_ptr<const RuntimeInfo> VintfObject::getRuntimeInfo(bool skipCache, |
| 389 | RuntimeInfo::FetchFlags flags) { |
| 390 | std::unique_lock<std::mutex> _lock(mDeviceRuntimeInfo.mutex); |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 391 | |
| 392 | if (!skipCache) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 393 | flags &= (~mDeviceRuntimeInfo.fetchedFlags); |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 394 | } |
| 395 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 396 | if (mDeviceRuntimeInfo.object == nullptr) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 397 | mDeviceRuntimeInfo.object = getRuntimeInfoFactory()->make_shared(); |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 398 | } |
| 399 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 400 | status_t status = mDeviceRuntimeInfo.object->fetchAllInformation(flags); |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 401 | if (status != OK) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 402 | mDeviceRuntimeInfo.fetchedFlags &= (~flags); // mark the fields as "not fetched" |
Yifan Hong | 1fb004e | 2017-09-26 15:04:44 -0700 | [diff] [blame] | 403 | return nullptr; |
| 404 | } |
| 405 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 406 | mDeviceRuntimeInfo.fetchedFlags |= flags; |
| 407 | return mDeviceRuntimeInfo.object; |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 408 | } |
| 409 | |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 410 | namespace details { |
| 411 | |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 412 | enum class ParseStatus { |
| 413 | OK, |
| 414 | PARSE_ERROR, |
| 415 | DUPLICATED_FWK_ENTRY, |
| 416 | DUPLICATED_DEV_ENTRY, |
| 417 | }; |
| 418 | |
Yifan Hong | 9532bd2 | 2017-04-14 15:30:52 -0700 | [diff] [blame] | 419 | static std::string toString(ParseStatus status) { |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 420 | switch(status) { |
| 421 | case ParseStatus::OK: return "OK"; |
| 422 | case ParseStatus::PARSE_ERROR: return "parse error"; |
| 423 | case ParseStatus::DUPLICATED_FWK_ENTRY: return "duplicated framework"; |
| 424 | case ParseStatus::DUPLICATED_DEV_ENTRY: return "duplicated device"; |
| 425 | } |
| 426 | return ""; |
| 427 | } |
| 428 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 429 | template <typename T> |
| 430 | static ParseStatus tryParse(const std::string& xml, const XmlConverter<T>& parse, |
| 431 | VintfObjectAfterUpdate* afterUpdate) { |
Yifan Hong | fc73edf | 2017-08-29 11:39:07 -0700 | [diff] [blame] | 432 | std::shared_ptr<T> ret = std::make_shared<T>(); |
Yifan Hong | 9475706 | 2018-02-09 16:36:31 -0800 | [diff] [blame] | 433 | if (!parse(ret.get(), xml, nullptr /* error */)) { |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 434 | return ParseStatus::PARSE_ERROR; |
| 435 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 436 | if (!afterUpdate->set(ret)) { |
| 437 | if (ret->type() == SchemaType::FRAMEWORK) { |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 438 | return ParseStatus::DUPLICATED_FWK_ENTRY; |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 439 | } else if (ret->type() == SchemaType::DEVICE) { |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 440 | return ParseStatus::DUPLICATED_DEV_ENTRY; |
| 441 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 442 | LOG(FATAL) << "unknown SchemaType: " |
| 443 | << static_cast<std::underlying_type_t<SchemaType>>(ret->type()); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 444 | } |
| 445 | return ParseStatus::OK; |
| 446 | } |
| 447 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 448 | } // namespace details |
| 449 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 450 | // Simulate applying xmls to VintfObject, then checkCompatibility as usual. |
Yifan Hong | af3713e | 2018-11-05 13:59:18 -0800 | [diff] [blame] | 451 | int32_t VintfObject::checkCompatibility(const std::vector<std::string>& xmls, std::string* error, |
| 452 | CheckFlags::Type flags) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 453 | VintfObjectAfterUpdate afterUpdate(this); |
| 454 | ParseStatus parseStatus = ParseStatus::OK; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 455 | |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 456 | // parse all information from package |
| 457 | for (const auto &xml : xmls) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 458 | parseStatus = tryParse(xml, gHalManifestConverter, &afterUpdate); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 459 | if (parseStatus == ParseStatus::OK) { |
| 460 | continue; // work on next one |
| 461 | } |
| 462 | if (parseStatus != ParseStatus::PARSE_ERROR) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 463 | appendLine(error, toString(parseStatus) + " manifest"); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 464 | return ALREADY_EXISTS; |
| 465 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 466 | parseStatus = tryParse(xml, gCompatibilityMatrixConverter, &afterUpdate); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 467 | if (parseStatus == ParseStatus::OK) { |
| 468 | continue; // work on next one |
| 469 | } |
| 470 | if (parseStatus != ParseStatus::PARSE_ERROR) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 471 | appendLine(error, toString(parseStatus) + " matrix"); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 472 | return ALREADY_EXISTS; |
| 473 | } |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 474 | appendLine(error, toString(parseStatus)); // parse error |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 475 | return BAD_VALUE; |
| 476 | } |
| 477 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 478 | return afterUpdate.checkCompatibility(error, flags); |
| 479 | } |
Yifan Hong | 8640cd1 | 2017-05-17 12:02:28 -0700 | [diff] [blame] | 480 | |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 481 | int32_t VintfObject::checkCompatibility(std::string* error, CheckFlags::Type flags) { |
| 482 | status_t status = OK; |
| 483 | // null checks for files and runtime info |
| 484 | if (getFrameworkHalManifest() == nullptr) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 485 | appendLine(error, "No framework manifest file from device or from update package"); |
| 486 | status = NO_INIT; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 487 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 488 | if (getDeviceHalManifest() == nullptr) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 489 | appendLine(error, "No device manifest file from device or from update package"); |
| 490 | status = NO_INIT; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 491 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 492 | if (getFrameworkCompatibilityMatrix() == nullptr) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 493 | appendLine(error, "No framework matrix file from device or from update package"); |
| 494 | status = NO_INIT; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 495 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 496 | if (getDeviceCompatibilityMatrix() == nullptr) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 497 | appendLine(error, "No device matrix file from device or from update package"); |
| 498 | status = NO_INIT; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 499 | } |
Yifan Hong | 69c1b11 | 2018-02-27 17:06:00 -0800 | [diff] [blame] | 500 | |
Yifan Hong | 072f12d | 2018-08-08 13:04:51 -0700 | [diff] [blame] | 501 | if (flags.isRuntimeInfoEnabled()) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 502 | if (getRuntimeInfo() == nullptr) { |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 503 | appendLine(error, "No runtime info from device"); |
| 504 | status = NO_INIT; |
Yifan Hong | 69c1b11 | 2018-02-27 17:06:00 -0800 | [diff] [blame] | 505 | } |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 506 | } |
Yifan Hong | 878556e | 2018-07-13 13:45:30 -0700 | [diff] [blame] | 507 | if (status != OK) return status; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 508 | |
| 509 | // compatiblity check. |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 510 | if (!getDeviceHalManifest()->checkCompatibility(*getFrameworkCompatibilityMatrix(), error)) { |
Yifan Hong | ca386fe | 2018-02-07 11:29:03 -0800 | [diff] [blame] | 511 | if (error) { |
| 512 | error->insert(0, |
| 513 | "Device manifest and framework compatibility matrix are incompatible: "); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 514 | } |
Yifan Hong | ca386fe | 2018-02-07 11:29:03 -0800 | [diff] [blame] | 515 | return INCOMPATIBLE; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 516 | } |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 517 | if (!getFrameworkHalManifest()->checkCompatibility(*getDeviceCompatibilityMatrix(), error)) { |
Yifan Hong | ca386fe | 2018-02-07 11:29:03 -0800 | [diff] [blame] | 518 | if (error) { |
| 519 | error->insert(0, |
| 520 | "Framework manifest and device compatibility matrix are incompatible: "); |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 521 | } |
Yifan Hong | ca386fe | 2018-02-07 11:29:03 -0800 | [diff] [blame] | 522 | return INCOMPATIBLE; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 523 | } |
Yifan Hong | 69c1b11 | 2018-02-27 17:06:00 -0800 | [diff] [blame] | 524 | |
Yifan Hong | 072f12d | 2018-08-08 13:04:51 -0700 | [diff] [blame] | 525 | if (flags.isRuntimeInfoEnabled()) { |
Yifan Hong | 12e23c2 | 2018-11-05 14:53:30 -0800 | [diff] [blame] | 526 | if (!getRuntimeInfo()->checkCompatibility(*getFrameworkCompatibilityMatrix(), error, |
| 527 | flags)) { |
Yifan Hong | 69c1b11 | 2018-02-27 17:06:00 -0800 | [diff] [blame] | 528 | if (error) { |
| 529 | error->insert(0, |
| 530 | "Runtime info and framework compatibility matrix are incompatible: "); |
| 531 | } |
| 532 | return INCOMPATIBLE; |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 533 | } |
| 534 | } |
| 535 | |
| 536 | return COMPATIBLE; |
| 537 | } |
| 538 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 539 | namespace details { |
| 540 | |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 541 | const std::string kSystemVintfDir = "/system/etc/vintf/"; |
Yifan Hong | ccbea05 | 2018-01-18 18:48:46 -0800 | [diff] [blame] | 542 | const std::string kVendorVintfDir = "/vendor/etc/vintf/"; |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 543 | const std::string kOdmVintfDir = "/odm/etc/vintf/"; |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 544 | |
| 545 | const std::string kVendorManifest = kVendorVintfDir + "manifest.xml"; |
Yifan Hong | a5ddddf | 2018-01-18 18:50:13 -0800 | [diff] [blame] | 546 | const std::string kSystemManifest = kSystemVintfDir + "manifest.xml"; |
Yifan Hong | b64ec9e | 2018-01-18 18:57:52 -0800 | [diff] [blame] | 547 | const std::string kVendorMatrix = kVendorVintfDir + "compatibility_matrix.xml"; |
Yifan Hong | 12a11ac | 2018-01-19 13:58:32 -0800 | [diff] [blame] | 548 | const std::string kOdmManifest = kOdmVintfDir + "manifest.xml"; |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 549 | |
Steven Moreland | eedf2d4 | 2018-04-04 16:36:27 -0700 | [diff] [blame] | 550 | const std::string kVendorManifestFragmentDir = kVendorVintfDir + "manifest/"; |
| 551 | const std::string kSystemManifestFragmentDir = kSystemVintfDir + "manifest/"; |
| 552 | const std::string kOdmManifestFragmentDir = kOdmVintfDir + "manifest/"; |
| 553 | |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 554 | const std::string kVendorLegacyManifest = "/vendor/manifest.xml"; |
| 555 | const std::string kVendorLegacyMatrix = "/vendor/compatibility_matrix.xml"; |
Yifan Hong | de6d00e | 2018-02-27 17:11:28 -0800 | [diff] [blame] | 556 | const std::string kSystemLegacyManifest = "/system/manifest.xml"; |
Yifan Hong | 270b565 | 2018-01-18 18:46:01 -0800 | [diff] [blame] | 557 | const std::string kSystemLegacyMatrix = "/system/compatibility_matrix.xml"; |
| 558 | const std::string kOdmLegacyVintfDir = "/odm/etc/"; |
| 559 | const std::string kOdmLegacyManifest = kOdmLegacyVintfDir + "manifest.xml"; |
| 560 | |
Yifan Hong | 69c1b11 | 2018-02-27 17:06:00 -0800 | [diff] [blame] | 561 | std::vector<std::string> dumpFileList() { |
| 562 | return { |
| 563 | kSystemVintfDir, kVendorVintfDir, kOdmVintfDir, kOdmLegacyVintfDir, |
| 564 | |
| 565 | kVendorLegacyManifest, kVendorLegacyMatrix, kSystemLegacyManifest, kSystemLegacyMatrix, |
| 566 | }; |
| 567 | } |
| 568 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 569 | } // namespace details |
Yifan Hong | 143cfe6 | 2017-04-13 20:18:01 -0700 | [diff] [blame] | 570 | |
Yifan Hong | db6423e | 2017-09-11 14:38:46 -0700 | [diff] [blame] | 571 | int32_t VintfObject::CheckCompatibility(const std::vector<std::string>& xmls, std::string* error, |
Yifan Hong | 072f12d | 2018-08-08 13:04:51 -0700 | [diff] [blame] | 572 | CheckFlags::Type flags) { |
| 573 | return GetInstance()->checkCompatibility(xmls, error, flags); |
Yifan Hong | fbbf047 | 2017-04-07 18:14:18 -0700 | [diff] [blame] | 574 | } |
| 575 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 576 | bool VintfObject::IsHalDeprecated(const MatrixHal& oldMatrixHal, |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 577 | const CompatibilityMatrix& targetMatrix, |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 578 | const ListInstances& listInstances, std::string* error) { |
Yifan Hong | 7e9e04d | 2018-03-20 13:06:00 -0700 | [diff] [blame] | 579 | bool isDeprecated = false; |
| 580 | oldMatrixHal.forEachInstance([&](const MatrixInstance& oldMatrixInstance) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 581 | if (IsInstanceDeprecated(oldMatrixInstance, targetMatrix, listInstances, error)) { |
Yifan Hong | 7e9e04d | 2018-03-20 13:06:00 -0700 | [diff] [blame] | 582 | isDeprecated = true; |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 583 | } |
Yifan Hong | 7e9e04d | 2018-03-20 13:06:00 -0700 | [diff] [blame] | 584 | return !isDeprecated; // continue if no deprecated instance is found. |
| 585 | }); |
| 586 | return isDeprecated; |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 587 | } |
| 588 | |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 589 | // Let oldMatrixInstance = package@x.y-w::interface with instancePattern. |
| 590 | // If any "servedInstance" in listInstances(package@x.y::interface) matches instancePattern, return |
| 591 | // true iff: |
| 592 | // 1. package@x.?::interface/servedInstance is not in targetMatrix; OR |
| 593 | // 2. package@x.z::interface/servedInstance is in targetMatrix but |
| 594 | // servedInstance is not in listInstances(package@x.z::interface) |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 595 | bool VintfObject::IsInstanceDeprecated(const MatrixInstance& oldMatrixInstance, |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 596 | const CompatibilityMatrix& targetMatrix, |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 597 | const ListInstances& listInstances, std::string* error) { |
Yifan Hong | 7e9e04d | 2018-03-20 13:06:00 -0700 | [diff] [blame] | 598 | const std::string& package = oldMatrixInstance.package(); |
| 599 | const Version& version = oldMatrixInstance.versionRange().minVer(); |
| 600 | const std::string& interface = oldMatrixInstance.interface(); |
Yifan Hong | 7e9e04d | 2018-03-20 13:06:00 -0700 | [diff] [blame] | 601 | |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 602 | std::vector<std::string> instanceHint; |
| 603 | if (!oldMatrixInstance.isRegex()) { |
| 604 | instanceHint.push_back(oldMatrixInstance.exactInstance()); |
| 605 | } |
| 606 | |
| 607 | auto list = listInstances(package, version, interface, instanceHint); |
| 608 | for (const auto& pair : list) { |
| 609 | const std::string& servedInstance = pair.first; |
| 610 | Version servedVersion = pair.second; |
| 611 | if (!oldMatrixInstance.matchInstance(servedInstance)) { |
| 612 | continue; |
| 613 | } |
| 614 | |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 615 | // Find any package@x.? in target matrix, and check if instance is in target matrix. |
Yifan Hong | 217f47e | 2018-03-15 12:34:05 -0700 | [diff] [blame] | 616 | bool foundInstance = false; |
| 617 | Version targetMatrixMinVer; |
| 618 | targetMatrix.forEachInstanceOfPackage(package, [&](const auto& targetMatrixInstance) { |
| 619 | if (targetMatrixInstance.versionRange().majorVer == version.majorVer && |
| 620 | targetMatrixInstance.interface() == interface && |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 621 | targetMatrixInstance.matchInstance(servedInstance)) { |
Yifan Hong | 217f47e | 2018-03-15 12:34:05 -0700 | [diff] [blame] | 622 | targetMatrixMinVer = targetMatrixInstance.versionRange().minVer(); |
| 623 | foundInstance = true; |
| 624 | } |
| 625 | return !foundInstance; // continue if not found |
| 626 | }); |
| 627 | if (!foundInstance) { |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 628 | if (error) { |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 629 | *error = toFQNameString(package, servedVersion, interface, servedInstance) + |
Steven Moreland | a1b984c | 2018-03-09 13:09:15 -0800 | [diff] [blame] | 630 | " is deprecated in compatibility matrix at FCM Version " + |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 631 | to_string(targetMatrix.level()) + "; it should not be served."; |
| 632 | } |
| 633 | return true; |
| 634 | } |
| 635 | |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 636 | // Assuming that targetMatrix requires @x.u-v, require that at least @x.u is served. |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 637 | bool targetVersionServed = false; |
| 638 | for (const auto& newPair : |
| 639 | listInstances(package, targetMatrixMinVer, interface, instanceHint)) { |
| 640 | if (newPair.first == servedInstance) { |
| 641 | targetVersionServed = true; |
| 642 | break; |
| 643 | } |
| 644 | } |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 645 | |
| 646 | if (!targetVersionServed) { |
Yifan Hong | 9f8f656 | 2018-11-06 16:26:20 -0800 | [diff] [blame] | 647 | appendLine(error, toFQNameString(package, servedVersion, interface, servedInstance) + |
| 648 | " is deprecated; requires at least " + |
| 649 | to_string(targetMatrixMinVer)); |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 650 | return true; |
| 651 | } |
| 652 | } |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 653 | |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 654 | return false; |
| 655 | } |
| 656 | |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 657 | int32_t VintfObject::CheckDeprecation(const ListInstances& listInstances, std::string* error) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 658 | return GetInstance()->checkDeprecation(listInstances, error); |
| 659 | } |
| 660 | int32_t VintfObject::checkDeprecation(const ListInstances& listInstances, std::string* error) { |
| 661 | auto matrixFragments = getAllFrameworkMatrixLevels(error); |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 662 | if (matrixFragments.empty()) { |
| 663 | if (error && error->empty()) |
| 664 | *error = "Cannot get framework matrix for each FCM version for unknown error."; |
| 665 | return NAME_NOT_FOUND; |
| 666 | } |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 667 | auto deviceManifest = getDeviceHalManifest(); |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 668 | if (deviceManifest == nullptr) { |
| 669 | if (error) *error = "No device manifest."; |
| 670 | return NAME_NOT_FOUND; |
| 671 | } |
| 672 | Level deviceLevel = deviceManifest->level(); |
| 673 | if (deviceLevel == Level::UNSPECIFIED) { |
| 674 | if (error) *error = "Device manifest does not specify Shipping FCM Version."; |
| 675 | return BAD_VALUE; |
| 676 | } |
| 677 | |
| 678 | const CompatibilityMatrix* targetMatrix = nullptr; |
| 679 | for (const auto& namedMatrix : matrixFragments) { |
| 680 | if (namedMatrix.object.level() == deviceLevel) { |
| 681 | targetMatrix = &namedMatrix.object; |
| 682 | } |
| 683 | } |
| 684 | if (targetMatrix == nullptr) { |
| 685 | if (error) |
| 686 | *error = "Cannot find framework matrix at FCM version " + to_string(deviceLevel) + "."; |
| 687 | return NAME_NOT_FOUND; |
| 688 | } |
| 689 | |
| 690 | bool hasDeprecatedHals = false; |
| 691 | for (const auto& namedMatrix : matrixFragments) { |
| 692 | if (namedMatrix.object.level() == Level::UNSPECIFIED) continue; |
| 693 | if (namedMatrix.object.level() >= deviceLevel) continue; |
| 694 | |
| 695 | const auto& oldMatrix = namedMatrix.object; |
| 696 | for (const MatrixHal& hal : oldMatrix.getHals()) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 697 | hasDeprecatedHals |= IsHalDeprecated(hal, *targetMatrix, listInstances, error); |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 698 | } |
| 699 | } |
| 700 | |
| 701 | return hasDeprecatedHals ? DEPRECATED : NO_DEPRECATED_HALS; |
| 702 | } |
| 703 | |
| 704 | int32_t VintfObject::CheckDeprecation(std::string* error) { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 705 | return GetInstance()->checkDeprecation(error); |
| 706 | } |
| 707 | int32_t VintfObject::checkDeprecation(std::string* error) { |
Yifan Hong | 2a90ffe | 2018-03-05 17:45:34 -0800 | [diff] [blame] | 708 | using namespace std::placeholders; |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 709 | auto deviceManifest = getDeviceHalManifest(); |
Yifan Hong | a8a8fa9 | 2018-03-20 14:42:43 -0700 | [diff] [blame] | 710 | ListInstances inManifest = |
| 711 | [&deviceManifest](const std::string& package, Version version, const std::string& interface, |
| 712 | const std::vector<std::string>& /* hintInstances */) { |
| 713 | std::vector<std::pair<std::string, Version>> ret; |
| 714 | deviceManifest->forEachInstanceOfInterface( |
| 715 | package, version, interface, [&ret](const ManifestInstance& manifestInstance) { |
| 716 | ret.push_back( |
| 717 | std::make_pair(manifestInstance.instance(), manifestInstance.version())); |
| 718 | return true; |
| 719 | }); |
| 720 | return ret; |
| 721 | }; |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 722 | return checkDeprecation(inManifest, error); |
Yifan Hong | f73ba51 | 2018-01-17 15:52:30 -0800 | [diff] [blame] | 723 | } |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 724 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 725 | const std::unique_ptr<FileSystem>& VintfObject::getFileSystem() { |
| 726 | return mFileSystem; |
| 727 | } |
| 728 | |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 729 | const std::unique_ptr<PropertyFetcher>& VintfObject::getPropertyFetcher() { |
| 730 | return mPropertyFetcher; |
| 731 | } |
| 732 | |
Yifan Hong | d038b2b | 2018-11-27 13:57:56 -0800 | [diff] [blame] | 733 | const std::unique_ptr<ObjectFactory<RuntimeInfo>>& VintfObject::getRuntimeInfoFactory() { |
Yifan Hong | 9f78c18 | 2018-07-12 14:45:52 -0700 | [diff] [blame] | 734 | return mRuntimeInfoFactory; |
Yifan Hong | 10d8622 | 2018-04-06 15:41:05 -0700 | [diff] [blame] | 735 | } |
| 736 | |
Yifan Hong | 78f5b57 | 2018-11-27 14:05:03 -0800 | [diff] [blame^] | 737 | // make_unique does not work because VintfObject constructor is private. |
| 738 | VintfObject::Builder::Builder() : mObject(std::unique_ptr<VintfObject>(new VintfObject())) {} |
| 739 | |
| 740 | VintfObject::Builder& VintfObject::Builder::setFileSystem(std::unique_ptr<FileSystem>&& e) { |
| 741 | mObject->mFileSystem = std::move(e); |
| 742 | return *this; |
| 743 | } |
| 744 | |
| 745 | VintfObject::Builder& VintfObject::Builder::setRuntimeInfoFactory( |
| 746 | std::unique_ptr<ObjectFactory<RuntimeInfo>>&& e) { |
| 747 | mObject->mRuntimeInfoFactory = std::move(e); |
| 748 | return *this; |
| 749 | } |
| 750 | |
| 751 | VintfObject::Builder& VintfObject::Builder::setPropertyFetcher( |
| 752 | std::unique_ptr<PropertyFetcher>&& e) { |
| 753 | mObject->mPropertyFetcher = std::move(e); |
| 754 | return *this; |
| 755 | } |
| 756 | |
| 757 | std::unique_ptr<VintfObject> VintfObject::Builder::build() { |
| 758 | if (!mObject->mFileSystem) mObject->mFileSystem = createDefaultFileSystem(); |
| 759 | if (!mObject->mRuntimeInfoFactory) |
| 760 | mObject->mRuntimeInfoFactory = std::make_unique<ObjectFactory<RuntimeInfo>>(); |
| 761 | if (!mObject->mPropertyFetcher) mObject->mPropertyFetcher = createDefaultPropertyFetcher(); |
| 762 | return std::move(mObject); |
| 763 | } |
| 764 | |
Yifan Hong | 3daec81 | 2017-02-27 18:49:11 -0800 | [diff] [blame] | 765 | } // namespace vintf |
| 766 | } // namespace android |