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 "CompatibilityMatrix.h"
18
19 #include <iostream>
20 #include <utility>
21
22 #include <android-base/strings.h>
23
24 #include "parse_string.h"
25 #include "parse_xml.h"
26 #include "utils.h"
27
28 namespace android {
29 namespace vintf {
30
31 using details::mergeField;
32
addKernel(MatrixKernel && kernel,std::string * error)33 bool CompatibilityMatrix::addKernel(MatrixKernel&& kernel, std::string* error) {
34 if (mType != SchemaType::FRAMEWORK) {
35 if (error) {
36 *error = "Cannot add <kernel> to a " + to_string(mType) + " compatibility matrix.";
37 }
38 return false;
39 }
40
41 auto it = framework.mKernels.begin();
42 for (; it != framework.mKernels.end(); ++it) {
43 if (it->minLts() == kernel.minLts()) {
44 break;
45 }
46 if (it->minLts().version == kernel.minLts().version &&
47 it->minLts().majorRev == kernel.minLts().majorRev) {
48 if (error) {
49 *error = "Kernel version mismatch; cannot add " + to_string(kernel.minLts()) +
50 " because " + to_string(it->minLts()) + " was added.";
51 }
52 return false;
53 }
54 }
55
56 bool seenVersion = it != framework.mKernels.end();
57
58 if (seenVersion) {
59 // If no conditions, must be the first among the same minLts
60 // because O libvintf only checks the first <kernel> tag that version matches.
61 if (kernel.conditions().empty()) {
62 // Found first <kernel> with the same minLts.
63 // Append config if it does not have <condition>s, else error.
64 if (it->conditions().empty()) {
65 const auto& configs = kernel.configs();
66 it->mConfigs.insert(it->mConfigs.end(), configs.begin(), configs.end());
67 } else {
68 if (error) {
69 *error =
70 "Base compatibility matrix has <condition> for the first <kernel> "
71 "with minlts " +
72 to_string(kernel.minLts()) + " for unknown reason.";
73 }
74 return false;
75 }
76 return true;
77 }
78 } else {
79 // First <kernel> of a minLts must not have <condition>'s for backwards compatibility
80 // with O libvintf.
81 if (!kernel.conditions().empty()) {
82 framework.mKernels.push_back(MatrixKernel(KernelVersion{kernel.minLts()}, {}));
83 }
84 }
85
86 framework.mKernels.push_back(std::move(kernel));
87 return true;
88 }
89
type() const90 SchemaType CompatibilityMatrix::type() const {
91 return mType;
92 }
93
level() const94 Level CompatibilityMatrix::level() const {
95 return mLevel;
96 }
97
getMinimumMetaVersion() const98 Version CompatibilityMatrix::getMinimumMetaVersion() const {
99 // TODO(b/62801658): this needs to depend on whether there are 1.1 requirements
100 // (e.g. required <xmlfile> entry)
101 return {1, 0};
102 }
103
fetchAllInformation(const FileSystem * fileSystem,const std::string & path,std::string * error)104 status_t CompatibilityMatrix::fetchAllInformation(const FileSystem* fileSystem,
105 const std::string& path, std::string* error) {
106 return details::fetchAllInformation(fileSystem, path, gCompatibilityMatrixConverter, this,
107 error);
108 }
109
getXmlSchemaPath(const std::string & xmlFileName,const Version & version) const110 std::string CompatibilityMatrix::getXmlSchemaPath(const std::string& xmlFileName,
111 const Version& version) const {
112 using std::literals::string_literals::operator""s;
113 auto range = getXmlFiles(xmlFileName);
114 for (auto it = range.first; it != range.second; ++it) {
115 const MatrixXmlFile& matrixXmlFile = it->second;
116 if (matrixXmlFile.versionRange().contains(version)) {
117 if (!matrixXmlFile.overriddenPath().empty()) {
118 return matrixXmlFile.overriddenPath();
119 }
120 return "/"s + (type() == SchemaType::DEVICE ? "vendor" : "system") + "/etc/" +
121 xmlFileName + "_V" + std::to_string(matrixXmlFile.versionRange().majorVer) +
122 "_" + std::to_string(matrixXmlFile.versionRange().maxMinor) + "." +
123 to_string(matrixXmlFile.format());
124 }
125 }
126 return "";
127 }
128
129 // Split existingHal into a HAL that contains only interface/instance and a HAL
130 // that does not contain it. Return the HAL that contains only interface/instance.
131 // - Return nullptr if existingHal does not contain interface/instance
132 // - Return existingHal if existingHal contains only interface/instance
133 // - Remove interface/instance from existingHal, and return a new MatrixHal (that is added
134 // to "this") that contains only interface/instance.
splitInstance(MatrixHal * existingHal,const std::string & interface,const std::string & instanceOrPattern,bool isRegex)135 MatrixHal* CompatibilityMatrix::splitInstance(MatrixHal* existingHal, const std::string& interface,
136 const std::string& instanceOrPattern, bool isRegex) {
137 bool found = false;
138 bool foundOthers = false;
139 existingHal->forEachInstance([&](const auto& matrixInstance) {
140 bool interfaceMatch = matrixInstance.interface() == interface;
141 bool instanceMatch = false;
142 if (matrixInstance.isRegex() && isRegex) {
143 instanceMatch = (matrixInstance.regexPattern() == instanceOrPattern);
144 } else if (!matrixInstance.isRegex() && !isRegex) {
145 instanceMatch = (matrixInstance.exactInstance() == instanceOrPattern);
146 }
147
148 bool match = interfaceMatch && instanceMatch;
149
150 found |= match;
151 foundOthers |= (!match);
152
153 return !found || !foundOthers;
154 });
155
156 if (!found) {
157 return nullptr;
158 }
159
160 if (!foundOthers) {
161 return existingHal;
162 }
163
164 existingHal->removeInstance(interface, instanceOrPattern, isRegex);
165 MatrixHal copy = *existingHal;
166 copy.clearInstances();
167 copy.insertInstance(interface, instanceOrPattern, isRegex);
168
169 return addInternal(std::move(copy));
170 }
171
172 // Add all package@other_version::interface/instance as an optional instance.
173 // If package@this_version::interface/instance is in this (that is, some instance
174 // with the same package and interface and instance exists), then other_version is
175 // considered a possible replacement to this_version.
176 // See LibVintfTest.AddOptionalHal* tests for details.
addAllHalsAsOptional(CompatibilityMatrix * other,std::string * error)177 bool CompatibilityMatrix::addAllHalsAsOptional(CompatibilityMatrix* other, std::string* error) {
178 if (other == nullptr || other->level() <= level()) {
179 return true;
180 }
181
182 for (auto& pair : other->mHals) {
183 const std::string& name = pair.first;
184 MatrixHal& halToAdd = pair.second;
185
186 std::set<std::pair<std::string, std::string>> insertedInstances;
187 std::set<std::pair<std::string, std::string>> insertedRegex;
188 auto existingHals = getHals(name);
189
190 halToAdd.forEachInstance([&](const std::vector<VersionRange>& versionRanges,
191 const std::string& interface,
192 const std::string& instanceOrPattern, bool isRegex) {
193 for (auto* existingHal : existingHals) {
194 MatrixHal* splitInstance =
195 this->splitInstance(existingHal, interface, instanceOrPattern, isRegex);
196 if (splitInstance != nullptr) {
197 splitInstance->insertVersionRanges(versionRanges);
198 if (isRegex) {
199 insertedRegex.insert(std::make_pair(interface, instanceOrPattern));
200 } else {
201 insertedInstances.insert(std::make_pair(interface, instanceOrPattern));
202 }
203 }
204 }
205 return true;
206 });
207
208 // Add the remaining instances.
209 for (const auto& pair : insertedInstances) {
210 halToAdd.removeInstance(pair.first, pair.second, false /* isRegex */);
211 }
212 for (const auto& pair : insertedRegex) {
213 halToAdd.removeInstance(pair.first, pair.second, true /* isRegex */);
214 }
215
216 if (halToAdd.instancesCount() > 0) {
217 halToAdd.setOptional(true);
218 if (!add(std::move(halToAdd))) {
219 if (error) {
220 *error = "Cannot add HAL " + name + " for unknown reason.";
221 }
222 return false;
223 }
224 }
225 }
226 return true;
227 }
228
addAllXmlFilesAsOptional(CompatibilityMatrix * other,std::string * error)229 bool CompatibilityMatrix::addAllXmlFilesAsOptional(CompatibilityMatrix* other, std::string* error) {
230 if (other == nullptr || other->level() <= level()) {
231 return true;
232 }
233 for (auto& pair : other->mXmlFiles) {
234 const std::string& name = pair.first;
235 MatrixXmlFile& xmlFileToAdd = pair.second;
236
237 xmlFileToAdd.mOptional = true;
238 if (!addXmlFile(std::move(xmlFileToAdd))) {
239 if (error) {
240 *error = "Cannot add XML File " + name + " for unknown reason.";
241 }
242 return false;
243 }
244 }
245 return true;
246 }
247
248 // Merge Kernel.
249 // Add <kernel> from exact "level", then optionally add <kernel> from high levels to low levels.
250 // For example, (each letter is a kernel version x.y.z)
251 // 1.xml: A1, B1
252 // 2.xml: B2, C2, D2
253 // 3.xml: D3, E3
254 // Then the combined 1.xml should have
255 // A1, B1 (from 1.xml, required), C2, D2, E3 (optional, use earliest possible).
addAllKernels(CompatibilityMatrix * other,std::string * error)256 bool CompatibilityMatrix::addAllKernels(CompatibilityMatrix* other, std::string* error) {
257 for (MatrixKernel& kernel : other->framework.mKernels) {
258 KernelVersion ver = kernel.minLts();
259 if (!addKernel(std::move(kernel), error)) {
260 if (error) {
261 *error = "Cannot add kernel version " + to_string(ver) + ": " + *error;
262 }
263 return false;
264 }
265 }
266 return true;
267 }
268
addAllKernelsAsOptional(CompatibilityMatrix * other,std::string * error)269 bool CompatibilityMatrix::addAllKernelsAsOptional(CompatibilityMatrix* other, std::string* error) {
270 if (other == nullptr || other->level() <= level()) {
271 return true;
272 }
273
274 for (MatrixKernel& kernelToAdd : other->framework.mKernels) {
275 bool exists =
276 std::any_of(this->framework.mKernels.begin(), this->framework.mKernels.end(),
277 [&kernelToAdd](const MatrixKernel& existing) {
278 return kernelToAdd.minLts().version == existing.minLts().version &&
279 kernelToAdd.minLts().majorRev == existing.minLts().majorRev;
280 });
281
282 if (exists) {
283 // Shouldn't retroactively add requirements to minLts(), so ignore this.
284 // This happens even when kernelToAdd.conditions() != existing.conditions().
285 continue;
286 }
287
288 KernelVersion minLts = kernelToAdd.minLts();
289 if (!addKernel(std::move(kernelToAdd), error)) {
290 if (error) {
291 *error = "Cannot add " + to_string(minLts) + ": " + *error;
292 }
293 return false;
294 }
295 }
296 return true;
297 }
298
addSepolicy(CompatibilityMatrix * other,std::string * error)299 bool CompatibilityMatrix::addSepolicy(CompatibilityMatrix* other, std::string* error) {
300 bool success = mergeField(&this->framework.mSepolicy, &other->framework.mSepolicy);
301 if (!success && error) *error = "<sepolicy> is already defined";
302 return success;
303 }
304
addAvbMetaVersion(CompatibilityMatrix * other,std::string * error)305 bool CompatibilityMatrix::addAvbMetaVersion(CompatibilityMatrix* other, std::string* error) {
306 bool success = mergeField(&this->framework.mAvbMetaVersion, &other->framework.mAvbMetaVersion);
307 if (!success && error) *error = "<avb><vbmeta-version> is already defined";
308 return success;
309 }
310
addVndk(CompatibilityMatrix * other,std::string * error)311 bool CompatibilityMatrix::addVndk(CompatibilityMatrix* other, std::string* error) {
312 #pragma clang diagnostic push
313 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
314 bool success = mergeField(&this->device.mVndk, &other->device.mVndk);
315 #pragma clang diagnostic pop
316 if (!success && error) *error = "<vndk> is already defined";
317 return success;
318 }
319
addVendorNdk(CompatibilityMatrix * other,std::string * error)320 bool CompatibilityMatrix::addVendorNdk(CompatibilityMatrix* other, std::string* error) {
321 bool success = mergeField(&this->device.mVendorNdk, &other->device.mVendorNdk);
322 if (!success && error) *error = "<vendor-ndk> is already defined";
323 return success;
324 }
325
addSystemSdk(CompatibilityMatrix * other,std::string *)326 bool CompatibilityMatrix::addSystemSdk(CompatibilityMatrix* other, std::string* /* error */) {
327 this->device.mSystemSdk.addAll(&other->device.mSystemSdk);
328 return true;
329 }
330
operator ==(const CompatibilityMatrix & lft,const CompatibilityMatrix & rgt)331 bool operator==(const CompatibilityMatrix &lft, const CompatibilityMatrix &rgt) {
332 return lft.mType == rgt.mType && lft.mLevel == rgt.mLevel && lft.mHals == rgt.mHals &&
333 lft.mXmlFiles == rgt.mXmlFiles &&
334 (lft.mType != SchemaType::DEVICE ||
335 (
336 #pragma clang diagnostic push
337 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
338 lft.device.mVndk == rgt.device.mVndk &&
339 #pragma clang diagnostic pop
340 lft.device.mVendorNdk == rgt.device.mVendorNdk &&
341 lft.device.mSystemSdk == rgt.device.mSystemSdk)) &&
342 (lft.mType != SchemaType::FRAMEWORK ||
343 (lft.framework.mKernels == rgt.framework.mKernels &&
344 lft.framework.mSepolicy == rgt.framework.mSepolicy &&
345 lft.framework.mAvbMetaVersion == rgt.framework.mAvbMetaVersion));
346 }
347
combine(Level deviceLevel,std::vector<Named<CompatibilityMatrix>> * matrices,std::string * error)348 std::unique_ptr<CompatibilityMatrix> CompatibilityMatrix::combine(
349 Level deviceLevel, std::vector<Named<CompatibilityMatrix>>* matrices, std::string* error) {
350 // Check type.
351 for (const auto& e : *matrices) {
352 if (e.object.type() != SchemaType::FRAMEWORK) {
353 if (error) {
354 *error = "File \"" + e.name + "\" is not a framework compatibility matrix.";
355 return nullptr;
356 }
357 }
358 }
359
360 // Matrices with unspecified (empty) level are auto-filled with deviceLevel.
361 for (auto& e : *matrices) {
362 if (e.object.level() == Level::UNSPECIFIED) {
363 e.object.mLevel = deviceLevel;
364 }
365 }
366
367 // Add from low to high FCM version so that optional <kernel> requirements are added correctly.
368 // See comment in addAllAsOptional.
369 std::sort(matrices->begin(), matrices->end(),
370 [](const auto& x, const auto& y) { return x.object.level() < y.object.level(); });
371
372 auto baseMatrix = std::make_unique<CompatibilityMatrix>();
373 baseMatrix->mLevel = deviceLevel;
374 baseMatrix->mType = SchemaType::FRAMEWORK;
375
376 std::vector<std::string> parsedFiles;
377 for (auto& e : *matrices) {
378 if (e.object.level() < deviceLevel) {
379 continue;
380 }
381
382 bool success = false;
383 if (e.object.level() == deviceLevel) {
384 success = baseMatrix->addAll(&e, error);
385 } else {
386 success = baseMatrix->addAllAsOptional(&e, error);
387 }
388 if (!success) {
389 if (error) {
390 *error = "Conflict when merging \"" + e.name + "\": " + *error + "\n" +
391 "Previous files:\n" + base::Join(parsedFiles, "\n");
392 }
393 return nullptr;
394 }
395 parsedFiles.push_back(e.name);
396 }
397
398 return baseMatrix;
399 }
400
combineDeviceMatrices(std::vector<Named<CompatibilityMatrix>> * matrices,std::string * error)401 std::unique_ptr<CompatibilityMatrix> CompatibilityMatrix::combineDeviceMatrices(
402 std::vector<Named<CompatibilityMatrix>>* matrices, std::string* error) {
403 auto baseMatrix = std::make_unique<CompatibilityMatrix>();
404 baseMatrix->mType = SchemaType::DEVICE;
405
406 std::vector<std::string> parsedFiles;
407 for (auto& e : *matrices) {
408 bool success = baseMatrix->addAll(&e, error);
409 if (!success) {
410 if (error) {
411 *error = "Conflict when merging \"" + e.name + "\": " + *error + "\n" +
412 "Previous files:\n" + base::Join(parsedFiles, "\n");
413 }
414 return nullptr;
415 }
416 parsedFiles.push_back(e.name);
417 }
418 return baseMatrix;
419 }
420
addAll(Named<CompatibilityMatrix> * inputMatrix,std::string * error)421 bool CompatibilityMatrix::addAll(Named<CompatibilityMatrix>* inputMatrix, std::string* error) {
422 if (!addAllHals(&inputMatrix->object, error) || !addAllXmlFiles(&inputMatrix->object, error) ||
423 !addAllKernels(&inputMatrix->object, error) || !addSepolicy(&inputMatrix->object, error) ||
424 !addAvbMetaVersion(&inputMatrix->object, error) || !addVndk(&inputMatrix->object, error) ||
425 !addVendorNdk(&inputMatrix->object, error) || !addSystemSdk(&inputMatrix->object, error)) {
426 if (error) {
427 *error = "File \"" + inputMatrix->name + "\" cannot be added: " + *error + ".";
428 }
429 return false;
430 }
431 return true;
432 }
433
addAllAsOptional(Named<CompatibilityMatrix> * inputMatrix,std::string * error)434 bool CompatibilityMatrix::addAllAsOptional(Named<CompatibilityMatrix>* inputMatrix,
435 std::string* error) {
436 if (!addAllHalsAsOptional(&inputMatrix->object, error) ||
437 !addAllXmlFilesAsOptional(&inputMatrix->object, error) ||
438 !addAllKernelsAsOptional(&inputMatrix->object, error)) {
439 if (error) {
440 *error = "File \"" + inputMatrix->name + "\" cannot be added: " + *error;
441 }
442 return false;
443 }
444 // ignore <sepolicy> requirement from higher level
445 // ignore <avb> requirement from higher level
446 return true;
447 }
448
forEachInstanceOfVersion(const std::string & package,const Version & expectVersion,const std::function<bool (const MatrixInstance &)> & func) const449 bool CompatibilityMatrix::forEachInstanceOfVersion(
450 const std::string& package, const Version& expectVersion,
451 const std::function<bool(const MatrixInstance&)>& func) const {
452 for (const MatrixHal* hal : getHals(package)) {
453 bool cont = hal->forEachInstance([&](const MatrixInstance& matrixInstance) {
454 if (matrixInstance.versionRange().contains(expectVersion)) {
455 return func(matrixInstance);
456 }
457 return true;
458 });
459 if (!cont) return false;
460 }
461 return true;
462 }
463
matchInstance(const std::string & halName,const Version & version,const std::string & interfaceName,const std::string & instance) const464 bool CompatibilityMatrix::matchInstance(const std::string& halName, const Version& version,
465 const std::string& interfaceName,
466 const std::string& instance) const {
467 bool found = false;
468 (void)forEachInstanceOfInterface(halName, version, interfaceName,
469 [&found, &instance](const auto& e) {
470 found |= (e.matchInstance(instance));
471 return !found; // if not found, continue
472 });
473 return found;
474 }
475
getVendorNdkVersion() const476 std::string CompatibilityMatrix::getVendorNdkVersion() const {
477 return type() == SchemaType::DEVICE ? device.mVendorNdk.version() : "";
478 }
479
480 } // namespace vintf
481 } // namespace android
482