-
Notifications
You must be signed in to change notification settings - Fork 0
/
VintfObject.cpp
1254 lines (1114 loc) · 47.9 KB
/
VintfObject.cpp
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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 "VintfObject.h"
#include <dirent.h>
#include <algorithm>
#include <functional>
#include <memory>
#include <mutex>
#include <aidl/metadata.h>
#include <android-base/logging.h>
#include <android-base/result.h>
#include <android-base/strings.h>
#include <hidl/metadata.h>
#include "CompatibilityMatrix.h"
#include "constants-private.h"
#include "parse_string.h"
#include "parse_xml.h"
#include "utils.h"
using std::placeholders::_1;
using std::placeholders::_2;
using std::string_literals::operator""s;
namespace android {
namespace vintf {
using namespace details;
#ifdef LIBVINTF_TARGET
static constexpr bool kIsTarget = true;
#else
static constexpr bool kIsTarget = false;
#endif
template <typename T, typename F>
static std::shared_ptr<const T> Get(const char* id, LockedSharedPtr<T>* ptr,
const F& fetchAllInformation) {
std::unique_lock<std::mutex> _lock(ptr->mutex);
if (!ptr->fetchedOnce) {
LOG(INFO) << id << ": Reading VINTF information.";
ptr->object = std::make_unique<T>();
std::string error;
status_t status = fetchAllInformation(ptr->object.get(), &error);
if (status == OK) {
ptr->fetchedOnce = true;
LOG(INFO) << id << ": Successfully processed VINTF information";
} else {
// Doubled because a malformed error std::string might cause us to
// lose the status.
LOG(ERROR) << id << ": status from fetching VINTF information: " << status;
LOG(ERROR) << id << ": " << status << " VINTF parse error: " << error;
ptr->object = nullptr; // frees the old object
}
}
return ptr->object;
}
static std::unique_ptr<FileSystem> createDefaultFileSystem() {
std::unique_ptr<FileSystem> fileSystem;
if (kIsTarget) {
fileSystem = std::make_unique<details::FileSystemImpl>();
} else {
fileSystem = std::make_unique<details::FileSystemNoOp>();
}
return fileSystem;
}
static std::unique_ptr<PropertyFetcher> createDefaultPropertyFetcher() {
std::unique_ptr<PropertyFetcher> propertyFetcher;
if (kIsTarget) {
propertyFetcher = std::make_unique<details::PropertyFetcherImpl>();
} else {
propertyFetcher = std::make_unique<details::PropertyFetcherNoOp>();
}
return propertyFetcher;
}
std::shared_ptr<VintfObject> VintfObject::GetInstance() {
static details::LockedSharedPtr<VintfObject> sInstance{};
std::unique_lock<std::mutex> lock(sInstance.mutex);
if (sInstance.object == nullptr) {
sInstance.object = std::shared_ptr<VintfObject>(VintfObject::Builder().build().release());
}
return sInstance.object;
}
std::shared_ptr<const HalManifest> VintfObject::GetDeviceHalManifest() {
return GetInstance()->getDeviceHalManifest();
}
std::shared_ptr<const HalManifest> VintfObject::getDeviceHalManifest() {
return Get(__func__, &mDeviceManifest,
std::bind(&VintfObject::fetchDeviceHalManifest, this, _1, _2));
}
std::shared_ptr<const HalManifest> VintfObject::GetFrameworkHalManifest() {
return GetInstance()->getFrameworkHalManifest();
}
std::shared_ptr<const HalManifest> VintfObject::getFrameworkHalManifest() {
return Get(__func__, &mFrameworkManifest,
std::bind(&VintfObject::fetchFrameworkHalManifest, this, _1, _2));
}
std::shared_ptr<const CompatibilityMatrix> VintfObject::GetDeviceCompatibilityMatrix() {
return GetInstance()->getDeviceCompatibilityMatrix();
}
std::shared_ptr<const CompatibilityMatrix> VintfObject::getDeviceCompatibilityMatrix() {
return Get(__func__, &mDeviceMatrix, std::bind(&VintfObject::fetchDeviceMatrix, this, _1, _2));
}
std::shared_ptr<const CompatibilityMatrix> VintfObject::GetFrameworkCompatibilityMatrix() {
return GetInstance()->getFrameworkCompatibilityMatrix();
}
std::shared_ptr<const CompatibilityMatrix> VintfObject::getFrameworkCompatibilityMatrix() {
// To avoid deadlock, get device manifest before any locks.
auto deviceManifest = getDeviceHalManifest();
std::unique_lock<std::mutex> _lock(mFrameworkCompatibilityMatrixMutex);
auto combined =
Get(__func__, &mCombinedFrameworkMatrix,
std::bind(&VintfObject::getCombinedFrameworkMatrix, this, deviceManifest, _1, _2));
if (combined != nullptr) {
return combined;
}
return Get(__func__, &mFrameworkMatrix,
std::bind(&CompatibilityMatrix::fetchAllInformation, _1, getFileSystem().get(),
kSystemLegacyMatrix, _2));
}
status_t VintfObject::getCombinedFrameworkMatrix(
const std::shared_ptr<const HalManifest>& deviceManifest, CompatibilityMatrix* out,
std::string* error) {
std::vector<CompatibilityMatrix> matrixFragments;
auto matrixFragmentsStatus = getAllFrameworkMatrixLevels(&matrixFragments, error);
if (matrixFragmentsStatus != OK) {
return matrixFragmentsStatus;
}
if (matrixFragments.empty()) {
if (error && error->empty()) {
*error = "Cannot get framework matrix for each FCM version for unknown error.";
}
return NAME_NOT_FOUND;
}
Level deviceLevel = Level::UNSPECIFIED;
if (deviceManifest != nullptr) {
deviceLevel = deviceManifest->level();
}
// TODO(b/70628538): Do not infer from Shipping API level.
if (deviceLevel == Level::UNSPECIFIED) {
auto shippingApi = getPropertyFetcher()->getUintProperty("ro.product.first_api_level", 0u);
if (shippingApi != 0u) {
deviceLevel = details::convertFromApiLevel(shippingApi);
}
}
if (deviceLevel == Level::UNSPECIFIED) {
// Cannot infer FCM version. Combine all matrices by assuming
// Shipping FCM Version == min(all supported FCM Versions in the framework)
for (auto&& fragment : matrixFragments) {
Level fragmentLevel = fragment.level();
if (fragmentLevel != Level::UNSPECIFIED && deviceLevel > fragmentLevel) {
deviceLevel = fragmentLevel;
}
}
}
if (deviceLevel == Level::UNSPECIFIED) {
// None of the fragments specify any FCM version. Should never happen except
// for inconsistent builds.
if (error) {
*error = "No framework compatibility matrix files under "s + kSystemVintfDir +
" declare FCM version.";
}
return NAME_NOT_FOUND;
}
auto combined = CompatibilityMatrix::combine(deviceLevel, &matrixFragments, error);
if (combined == nullptr) {
return BAD_VALUE;
}
*out = std::move(*combined);
return OK;
}
// Load and combine all of the manifests in a directory
status_t VintfObject::addDirectoryManifests(const std::string& directory, HalManifest* manifest,
std::string* error) {
std::vector<std::string> fileNames;
status_t err = getFileSystem()->listFiles(directory, &fileNames, error);
// if the directory isn't there, that's okay
if (err == NAME_NOT_FOUND) return OK;
if (err != OK) return err;
for (const std::string& file : fileNames) {
// Only adds HALs because all other things are added by libvintf
// itself for now.
HalManifest fragmentManifest;
err = fetchOneHalManifest(directory + file, &fragmentManifest, error);
if (err != OK) return err;
if (!manifest->addAll(&fragmentManifest, error)) {
if (error) {
error->insert(0, "Cannot add manifest fragment " + directory + file + ": ");
}
return UNKNOWN_ERROR;
}
}
return OK;
}
// Priority for loading vendor manifest:
// 1. Vendor manifest + device fragments + ODM manifest (optional) + odm fragments
// 2. Vendor manifest + device fragments
// 3. ODM manifest (optional) + odm fragments
// 4. /vendor/manifest.xml (legacy, no fragments)
// where:
// A + B means unioning <hal> tags from A and B. If B declares an override, then this takes priority
// over A.
status_t VintfObject::fetchDeviceHalManifest(HalManifest* out, std::string* error) {
HalManifest vendorManifest;
status_t vendorStatus = fetchVendorHalManifest(&vendorManifest, error);
if (vendorStatus != OK && vendorStatus != NAME_NOT_FOUND) {
return vendorStatus;
}
if (vendorStatus == OK) {
*out = std::move(vendorManifest);
status_t fragmentStatus = addDirectoryManifests(kVendorManifestFragmentDir, out, error);
if (fragmentStatus != OK) {
return fragmentStatus;
}
}
HalManifest odmManifest;
status_t odmStatus = fetchOdmHalManifest(&odmManifest, error);
if (odmStatus != OK && odmStatus != NAME_NOT_FOUND) {
return odmStatus;
}
if (vendorStatus == OK) {
if (odmStatus == OK) {
if (!out->addAll(&odmManifest, error)) {
if (error) {
error->insert(0, "Cannot add ODM manifest :");
}
return UNKNOWN_ERROR;
}
}
return addDirectoryManifests(kOdmManifestFragmentDir, out, error);
}
// vendorStatus != OK, "out" is not changed.
if (odmStatus == OK) {
*out = std::move(odmManifest);
return addDirectoryManifests(kOdmManifestFragmentDir, out, error);
}
// Use legacy /vendor/manifest.xml
return out->fetchAllInformation(getFileSystem().get(), kVendorLegacyManifest, error);
}
// Priority:
// 1. if {vendorSku} is defined, /vendor/etc/vintf/manifest_{vendorSku}.xml
// 2. /vendor/etc/vintf/manifest.xml
// where:
// {vendorSku} is the value of ro.boot.product.vendor.sku
status_t VintfObject::fetchVendorHalManifest(HalManifest* out, std::string* error) {
status_t status;
std::string vendorSku;
vendorSku = getPropertyFetcher()->getProperty("ro.boot.product.vendor.sku", "");
if (!vendorSku.empty()) {
status =
fetchOneHalManifest(kVendorVintfDir + "manifest_"s + vendorSku + ".xml", out, error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
}
status = fetchOneHalManifest(kVendorManifest, out, error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
return NAME_NOT_FOUND;
}
// "out" is written to iff return status is OK.
// Priority:
// 1. if {sku} is defined, /odm/etc/vintf/manifest_{sku}.xml
// 2. /odm/etc/vintf/manifest.xml
// 3. if {sku} is defined, /odm/etc/manifest_{sku}.xml
// 4. /odm/etc/manifest.xml
// where:
// {sku} is the value of ro.boot.product.hardware.sku
status_t VintfObject::fetchOdmHalManifest(HalManifest* out, std::string* error) {
status_t status;
std::string productModel;
productModel = getPropertyFetcher()->getProperty("ro.boot.product.hardware.sku", "");
if (!productModel.empty()) {
status =
fetchOneHalManifest(kOdmVintfDir + "manifest_"s + productModel + ".xml", out, error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
}
status = fetchOneHalManifest(kOdmManifest, out, error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
if (!productModel.empty()) {
status = fetchOneHalManifest(kOdmLegacyVintfDir + "manifest_"s + productModel + ".xml", out,
error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
}
status = fetchOneHalManifest(kOdmLegacyManifest, out, error);
if (status == OK || status != NAME_NOT_FOUND) {
return status;
}
return NAME_NOT_FOUND;
}
// Fetch one manifest.xml file. "out" is written to iff return status is OK.
// Returns NAME_NOT_FOUND if file is missing.
status_t VintfObject::fetchOneHalManifest(const std::string& path, HalManifest* out,
std::string* error) {
HalManifest ret;
status_t status = ret.fetchAllInformation(getFileSystem().get(), path, error);
if (status == OK) {
*out = std::move(ret);
}
return status;
}
status_t VintfObject::fetchDeviceMatrix(CompatibilityMatrix* out, std::string* error) {
CompatibilityMatrix etcMatrix;
if (etcMatrix.fetchAllInformation(getFileSystem().get(), kVendorMatrix, error) == OK) {
*out = std::move(etcMatrix);
return OK;
}
return out->fetchAllInformation(getFileSystem().get(), kVendorLegacyMatrix, error);
}
// Priority:
// 1. /system/etc/vintf/manifest.xml
// + /system/etc/vintf/manifest/*.xml if they exist
// + /product/etc/vintf/manifest.xml if it exists
// + /product/etc/vintf/manifest/*.xml if they exist
// 2. (deprecated) /system/manifest.xml
status_t VintfObject::fetchUnfilteredFrameworkHalManifest(HalManifest* out, std::string* error) {
auto systemEtcStatus = fetchOneHalManifest(kSystemManifest, out, error);
if (systemEtcStatus == OK) {
auto dirStatus = addDirectoryManifests(kSystemManifestFragmentDir, out, error);
if (dirStatus != OK) {
return dirStatus;
}
std::vector<std::pair<const char*, const char*>> extensions{
{kProductManifest, kProductManifestFragmentDir},
{kSystemExtManifest, kSystemExtManifestFragmentDir},
};
for (auto&& [manifestPath, frags] : extensions) {
HalManifest halManifest;
auto status = fetchOneHalManifest(manifestPath, &halManifest, error);
if (status != OK && status != NAME_NOT_FOUND) {
return status;
}
if (status == OK) {
if (!out->addAll(&halManifest, error)) {
if (error) {
error->insert(0, "Cannot add "s + manifestPath + ":");
}
return UNKNOWN_ERROR;
}
}
auto fragmentStatus = addDirectoryManifests(frags, out, error);
if (fragmentStatus != OK) {
return fragmentStatus;
}
}
return OK;
} else {
LOG(WARNING) << "Cannot fetch " << kSystemManifest << ": "
<< (error ? *error : strerror(-systemEtcStatus));
}
return out->fetchAllInformation(getFileSystem().get(), kSystemLegacyManifest, error);
}
status_t VintfObject::fetchFrameworkHalManifest(HalManifest* out, std::string* error) {
status_t status = fetchUnfilteredFrameworkHalManifest(out, error);
if (status != OK) {
return status;
}
filterHalsByDeviceManifestLevel(out);
return OK;
}
void VintfObject::filterHalsByDeviceManifestLevel(HalManifest* out) {
auto deviceManifest = getDeviceHalManifest();
if (deviceManifest == nullptr) {
LOG(WARNING) << "Cannot fetch device manifest to determine target FCM version to "
"filter framework manifest HALs.";
return;
}
Level deviceManifestLevel = deviceManifest->level();
if (deviceManifestLevel == Level::UNSPECIFIED) {
LOG(WARNING)
<< "Not filtering framework manifest HALs because target FCM version is unspecified.";
return;
}
out->removeHalsIf([deviceManifestLevel](const ManifestHal& hal) {
if (hal.getMaxLevel() == Level::UNSPECIFIED) {
return false;
}
return hal.getMaxLevel() < deviceManifestLevel;
});
}
static void appendLine(std::string* error, const std::string& message) {
if (error != nullptr) {
if (!error->empty()) *error += "\n";
*error += message;
}
}
status_t VintfObject::getOneMatrix(const std::string& path, CompatibilityMatrix* out,
std::string* error) {
std::string content;
status_t status = getFileSystem()->fetch(path, &content, error);
if (status != OK) {
return status;
}
if (!fromXml(out, content, error)) {
if (error) {
error->insert(0, "Cannot parse " + path + ": ");
}
return BAD_VALUE;
}
out->setFileName(path);
return OK;
}
status_t VintfObject::getAllFrameworkMatrixLevels(std::vector<CompatibilityMatrix>* results,
std::string* error) {
std::vector<std::string> dirs = {
kSystemVintfDir,
kSystemExtVintfDir,
kProductVintfDir,
};
for (const auto& dir : dirs) {
std::vector<std::string> fileNames;
status_t listStatus = getFileSystem()->listFiles(dir, &fileNames, error);
if (listStatus == NAME_NOT_FOUND) {
continue;
}
if (listStatus != OK) {
return listStatus;
}
for (const std::string& fileName : fileNames) {
std::string path = dir + fileName;
CompatibilityMatrix namedMatrix;
std::string matrixError;
status_t matrixStatus = getOneMatrix(path, &namedMatrix, &matrixError);
if (matrixStatus != OK) {
// Manifests and matrices share the same dir. Client may not have enough
// permissions to read system manifests, or may not be able to parse it.
auto logLevel = matrixStatus == BAD_VALUE ? base::DEBUG : base::ERROR;
LOG(logLevel) << "Framework Matrix: Ignore file " << path << ": " << matrixError;
continue;
}
results->emplace_back(std::move(namedMatrix));
}
if (dir == kSystemVintfDir && results->empty()) {
if (error) {
*error = "No framework matrices under " + dir + " can be fetched or parsed.\n";
}
return NAME_NOT_FOUND;
}
}
if (results->empty()) {
if (error) {
*error =
"No framework matrices can be fetched or parsed. "
"The following directories are searched:\n " +
android::base::Join(dirs, "\n ");
}
return NAME_NOT_FOUND;
}
return OK;
}
std::shared_ptr<const RuntimeInfo> VintfObject::GetRuntimeInfo(RuntimeInfo::FetchFlags flags) {
return GetInstance()->getRuntimeInfo(flags);
}
std::shared_ptr<const RuntimeInfo> VintfObject::getRuntimeInfo(RuntimeInfo::FetchFlags flags) {
std::unique_lock<std::mutex> _lock(mDeviceRuntimeInfo.mutex);
// Skip fetching information that has already been fetched previously.
flags &= (~mDeviceRuntimeInfo.fetchedFlags);
if (mDeviceRuntimeInfo.object == nullptr) {
mDeviceRuntimeInfo.object = getRuntimeInfoFactory()->make_shared();
}
status_t status = mDeviceRuntimeInfo.object->fetchAllInformation(flags);
if (status != OK) {
// If only kernel FCM is needed, ignore errors when fetching RuntimeInfo because RuntimeInfo
// is not available on host. On host, the kernel level can still be inferred from device
// manifest.
// If other information is needed, flag the error by returning nullptr.
auto allExceptKernelFcm = RuntimeInfo::FetchFlag::ALL & ~RuntimeInfo::FetchFlag::KERNEL_FCM;
bool needDeviceRuntimeInfo = flags & allExceptKernelFcm;
if (needDeviceRuntimeInfo) {
mDeviceRuntimeInfo.fetchedFlags &= (~flags); // mark the fields as "not fetched"
return nullptr;
}
}
// To support devices without GKI, RuntimeInfo::fetchAllInformation does not report errors
// if kernel level cannot be retrieved. If so, fetch kernel FCM version from device HAL
// manifest and store it in RuntimeInfo too.
if (flags & RuntimeInfo::FetchFlag::KERNEL_FCM) {
Level deviceManifestKernelLevel = Level::UNSPECIFIED;
auto manifest = getDeviceHalManifest();
if (manifest) {
deviceManifestKernelLevel = manifest->inferredKernelLevel();
}
if (deviceManifestKernelLevel != Level::UNSPECIFIED) {
Level kernelLevel = mDeviceRuntimeInfo.object->kernelLevel();
if (kernelLevel == Level::UNSPECIFIED) {
mDeviceRuntimeInfo.object->setKernelLevel(deviceManifestKernelLevel);
} else if (kernelLevel != deviceManifestKernelLevel) {
LOG(WARNING) << "uname() reports kernel level " << kernelLevel
<< " but device manifest sets kernel level "
<< deviceManifestKernelLevel << ". Using kernel level " << kernelLevel;
}
}
}
mDeviceRuntimeInfo.fetchedFlags |= flags;
return mDeviceRuntimeInfo.object;
}
int32_t VintfObject::checkCompatibility(std::string* error, CheckFlags::Type flags) {
status_t status = OK;
// null checks for files and runtime info
if (getFrameworkHalManifest() == nullptr) {
appendLine(error, "No framework manifest file from device or from update package");
status = NO_INIT;
}
if (getDeviceHalManifest() == nullptr) {
appendLine(error, "No device manifest file from device or from update package");
status = NO_INIT;
}
if (getFrameworkCompatibilityMatrix() == nullptr) {
appendLine(error, "No framework matrix file from device or from update package");
status = NO_INIT;
}
if (getDeviceCompatibilityMatrix() == nullptr) {
appendLine(error, "No device matrix file from device or from update package");
status = NO_INIT;
}
if (flags.isRuntimeInfoEnabled()) {
if (getRuntimeInfo() == nullptr) {
appendLine(error, "No runtime info from device");
status = NO_INIT;
}
}
if (status != OK) return status;
// compatiblity check.
if (!getDeviceHalManifest()->checkCompatibility(*getFrameworkCompatibilityMatrix(), error)) {
if (error) {
error->insert(0,
"Device manifest and framework compatibility matrix are incompatible: ");
}
return INCOMPATIBLE;
}
if (!getFrameworkHalManifest()->checkCompatibility(*getDeviceCompatibilityMatrix(), error)) {
if (error) {
error->insert(0,
"Framework manifest and device compatibility matrix are incompatible: ");
}
return INCOMPATIBLE;
}
if (flags.isRuntimeInfoEnabled()) {
if (!getRuntimeInfo()->checkCompatibility(*getFrameworkCompatibilityMatrix(), error,
flags)) {
if (error) {
error->insert(0,
"Runtime info and framework compatibility matrix are incompatible: ");
}
return INCOMPATIBLE;
}
}
return COMPATIBLE;
}
namespace details {
std::vector<std::string> dumpFileList() {
return {
// clang-format off
kSystemVintfDir,
kVendorVintfDir,
kOdmVintfDir,
kProductVintfDir,
kSystemExtVintfDir,
kOdmLegacyVintfDir,
kVendorLegacyManifest,
kVendorLegacyMatrix,
kSystemLegacyManifest,
kSystemLegacyMatrix,
// clang-format on
};
}
} // namespace details
bool VintfObject::IsHalDeprecated(const MatrixHal& oldMatrixHal,
const CompatibilityMatrix& targetMatrix,
const ListInstances& listInstances,
const ChildrenMap& childrenMap, std::string* appendedError) {
bool isDeprecated = false;
oldMatrixHal.forEachInstance([&](const MatrixInstance& oldMatrixInstance) {
if (IsInstanceDeprecated(oldMatrixInstance, targetMatrix, listInstances, childrenMap,
appendedError)) {
isDeprecated = true;
}
return true; // continue to check next instance
});
return isDeprecated;
}
// Let oldMatrixInstance = package@x.y-w::interface/instancePattern.
// If any "@servedVersion::interface/servedInstance" in listInstances(package@x.y::interface)
// matches instancePattern, return true iff for all child interfaces (from
// GetListedInstanceInheritance), IsFqInstanceDeprecated returns false.
bool VintfObject::IsInstanceDeprecated(const MatrixInstance& oldMatrixInstance,
const CompatibilityMatrix& targetMatrix,
const ListInstances& listInstances,
const ChildrenMap& childrenMap, std::string* appendedError) {
const std::string& package = oldMatrixInstance.package();
const Version& version = oldMatrixInstance.versionRange().minVer();
const std::string& interface = oldMatrixInstance.interface();
std::vector<std::string> instanceHint;
if (!oldMatrixInstance.isRegex()) {
instanceHint.push_back(oldMatrixInstance.exactInstance());
}
std::vector<std::string> accumulatedErrors;
auto list = listInstances(package, version, interface, instanceHint);
for (const auto& pair : list) {
const std::string& servedInstance = pair.first;
Version servedVersion = pair.second;
std::string servedFqInstanceString =
toFQNameString(package, servedVersion, interface, servedInstance);
if (!oldMatrixInstance.matchInstance(servedInstance)) {
// ignore unrelated instance
continue;
}
auto inheritance = GetListedInstanceInheritance(package, servedVersion, interface,
servedInstance, listInstances, childrenMap);
if (!inheritance.has_value()) {
accumulatedErrors.push_back(inheritance.error().message());
continue;
}
std::vector<std::string> errors;
for (const auto& fqInstance : *inheritance) {
auto result = IsFqInstanceDeprecated(targetMatrix, oldMatrixInstance.format(),
fqInstance, listInstances);
if (result.ok()) {
errors.clear();
break;
}
errors.push_back(result.error().message());
}
if (errors.empty()) {
continue;
}
accumulatedErrors.insert(accumulatedErrors.end(), errors.begin(), errors.end());
}
if (accumulatedErrors.empty()) {
return false;
}
appendLine(appendedError, android::base::Join(accumulatedErrors, "\n"));
return true;
}
// Check if fqInstance is listed in |listInstances|.
bool VintfObject::IsInstanceListed(const ListInstances& listInstances,
const FqInstance& fqInstance) {
auto list =
listInstances(fqInstance.getPackage(), fqInstance.getVersion(), fqInstance.getInterface(),
{fqInstance.getInstance()} /* instanceHint*/);
return std::any_of(list.begin(), list.end(),
[&](const auto& pair) { return pair.first == fqInstance.getInstance(); });
}
// Return a list of FqInstance, where each element:
// - is listed in |listInstances|; AND
// - is, or inherits from, package@version::interface/instance (as specified by |childrenMap|)
android::base::Result<std::vector<FqInstance>> VintfObject::GetListedInstanceInheritance(
const std::string& package, const Version& version, const std::string& interface,
const std::string& instance, const ListInstances& listInstances,
const ChildrenMap& childrenMap) {
FqInstance fqInstance;
if (!fqInstance.setTo(package, version.majorVer, version.minorVer, interface, instance)) {
return android::base::Error() << toFQNameString(package, version, interface, instance)
<< " is not a valid FqInstance";
}
if (!IsInstanceListed(listInstances, fqInstance)) {
return {};
}
const FQName& fqName = fqInstance.getFqName();
std::vector<FqInstance> ret;
ret.push_back(fqInstance);
auto childRange = childrenMap.equal_range(fqName.string());
for (auto it = childRange.first; it != childRange.second; ++it) {
const auto& childFqNameString = it->second;
FQName childFqName;
if (!childFqName.setTo(childFqNameString)) {
return android::base::Error() << "Cannot parse " << childFqNameString << " as FQName";
}
FqInstance childFqInstance;
if (!childFqInstance.setTo(childFqName, fqInstance.getInstance())) {
return android::base::Error() << "Cannot merge " << childFqName.string() << "/"
<< fqInstance.getInstance() << " as FqInstance";
continue;
}
if (!IsInstanceListed(listInstances, childFqInstance)) {
continue;
}
ret.push_back(childFqInstance);
}
return ret;
}
// Check if |fqInstance| is in |targetMatrix|; essentially equal to
// targetMatrix.matchInstance(fqInstance), but provides richer error message. In details:
// 1. package@x.?::interface/servedInstance is not in targetMatrix; OR
// 2. package@x.z::interface/servedInstance is in targetMatrix but
// servedInstance is not in listInstances(package@x.z::interface)
android::base::Result<void> VintfObject::IsFqInstanceDeprecated(
const CompatibilityMatrix& targetMatrix, HalFormat format, const FqInstance& fqInstance,
const ListInstances& listInstances) {
// Find minimum package@x.? in target matrix, and check if instance is in target matrix.
bool foundInstance = false;
Version targetMatrixMinVer{SIZE_MAX, SIZE_MAX};
targetMatrix.forEachInstanceOfPackage(
format, fqInstance.getPackage(), [&](const auto& targetMatrixInstance) {
if (targetMatrixInstance.versionRange().majorVer == fqInstance.getMajorVersion() &&
targetMatrixInstance.interface() == fqInstance.getInterface() &&
targetMatrixInstance.matchInstance(fqInstance.getInstance())) {
targetMatrixMinVer =
std::min(targetMatrixMinVer, targetMatrixInstance.versionRange().minVer());
foundInstance = true;
}
return true;
});
if (!foundInstance) {
return android::base::Error()
<< fqInstance.string() << " is deprecated in compatibility matrix at FCM Version "
<< targetMatrix.level() << "; it should not be served.";
}
// Assuming that targetMatrix requires @x.u-v, require that at least @x.u is served.
bool targetVersionServed = false;
for (const auto& newPair :
listInstances(fqInstance.getPackage(), targetMatrixMinVer, fqInstance.getInterface(),
{fqInstance.getInstance()} /* instanceHint */)) {
if (newPair.first == fqInstance.getInstance()) {
targetVersionServed = true;
break;
}
}
if (!targetVersionServed) {
return android::base::Error()
<< fqInstance.string() << " is deprecated; requires at least " << targetMatrixMinVer;
}
return {};
}
int32_t VintfObject::checkDeprecation(const ListInstances& listInstances,
const std::vector<HidlInterfaceMetadata>& hidlMetadata,
std::string* error) {
std::vector<CompatibilityMatrix> matrixFragments;
auto matrixFragmentsStatus = getAllFrameworkMatrixLevels(&matrixFragments, error);
if (matrixFragmentsStatus != OK) {
return matrixFragmentsStatus;
}
if (matrixFragments.empty()) {
if (error && error->empty()) {
*error = "Cannot get framework matrix for each FCM version for unknown error.";
}
return NAME_NOT_FOUND;
}
auto deviceManifest = getDeviceHalManifest();
if (deviceManifest == nullptr) {
if (error) *error = "No device manifest.";
return NAME_NOT_FOUND;
}
Level deviceLevel = deviceManifest->level();
if (deviceLevel == Level::UNSPECIFIED) {
if (error) *error = "Device manifest does not specify Shipping FCM Version.";
return BAD_VALUE;
}
std::vector<CompatibilityMatrix> targetMatrices;
// Partition matrixFragments into two groups, where the second group
// contains all matrices whose level == deviceLevel.
auto targetMatricesPartition = std::partition(
matrixFragments.begin(), matrixFragments.end(),
[&](const CompatibilityMatrix& matrix) { return matrix.level() != deviceLevel; });
// Move these matrices into the targetMatrices vector...
std::move(targetMatricesPartition, matrixFragments.end(), std::back_inserter(targetMatrices));
if (targetMatrices.empty()) {
if (error)
*error = "Cannot find framework matrix at FCM version " + to_string(deviceLevel) + ".";
return NAME_NOT_FOUND;
}
// so that they can be combined into one matrix for deprecation checking.
auto targetMatrix = CompatibilityMatrix::combine(deviceLevel, &targetMatrices, error);
if (targetMatrix == nullptr) {
return BAD_VALUE;
}
std::multimap<std::string, std::string> childrenMap;
for (const auto& child : hidlMetadata) {
for (const auto& parent : child.inherited) {
childrenMap.emplace(parent, child.name);
}
}
// Find a list of possibly deprecated HALs by comparing |listInstances| with older matrices.
// Matrices with unspecified level are considered "current".
bool isDeprecated = false;
for (auto it = matrixFragments.begin(); it < targetMatricesPartition; ++it) {
const auto& namedMatrix = *it;
if (namedMatrix.level() == Level::UNSPECIFIED) continue;
if (namedMatrix.level() > deviceLevel) continue;
for (const MatrixHal& hal : namedMatrix.getHals()) {
if (IsHalDeprecated(hal, *targetMatrix, listInstances, childrenMap, error)) {
isDeprecated = true;
}
}
}
return isDeprecated ? DEPRECATED : NO_DEPRECATED_HALS;
}
int32_t VintfObject::checkDeprecation(const std::vector<HidlInterfaceMetadata>& hidlMetadata,
std::string* error) {
using namespace std::placeholders;
auto deviceManifest = getDeviceHalManifest();
ListInstances inManifest =
[&deviceManifest](const std::string& package, Version version, const std::string& interface,
const std::vector<std::string>& /* hintInstances */) {
std::vector<std::pair<std::string, Version>> ret;
deviceManifest->forEachInstanceOfInterface(
HalFormat::HIDL, package, version, interface,
[&ret](const ManifestInstance& manifestInstance) {
ret.push_back(
std::make_pair(manifestInstance.instance(), manifestInstance.version()));
return true;
});
return ret;
};
return checkDeprecation(inManifest, hidlMetadata, error);
}
Level VintfObject::getKernelLevel(std::string* error) {
auto runtimeInfo = getRuntimeInfo(RuntimeInfo::FetchFlag::KERNEL_FCM);
if (!runtimeInfo) {
if (error) *error = "Cannot retrieve runtime info with kernel level.";
return Level::UNSPECIFIED;
}
if (runtimeInfo->kernelLevel() != Level::UNSPECIFIED) {
return runtimeInfo->kernelLevel();
}
if (error) {
*error = "Both device manifest and kernel release do not specify kernel FCM version.";
}
return Level::UNSPECIFIED;
}
const std::unique_ptr<FileSystem>& VintfObject::getFileSystem() {
return mFileSystem;
}
const std::unique_ptr<PropertyFetcher>& VintfObject::getPropertyFetcher() {
return mPropertyFetcher;
}
const std::unique_ptr<ObjectFactory<RuntimeInfo>>& VintfObject::getRuntimeInfoFactory() {
return mRuntimeInfoFactory;
}
android::base::Result<bool> VintfObject::hasFrameworkCompatibilityMatrixExtensions() {
std::vector<CompatibilityMatrix> matrixFragments;
std::string error;
status_t status = getAllFrameworkMatrixLevels(&matrixFragments, &error);
if (status != OK) {
return android::base::Error(-status)
<< "Cannot get all framework matrix fragments: " << error;
}
for (const auto& namedMatrix : matrixFragments) {
// Returns true if product matrix exists.
if (android::base::StartsWith(namedMatrix.fileName(), kProductVintfDir)) {
return true;
}
// Returns true if system_ext matrix exists.
if (android::base::StartsWith(namedMatrix.fileName(), kSystemExtVintfDir)) {
return true;
}
// Returns true if device system matrix exists.
if (android::base::StartsWith(namedMatrix.fileName(), kSystemVintfDir) &&
namedMatrix.level() == Level::UNSPECIFIED && !namedMatrix.getHals().empty()) {
return true;
}
}
return false;
}
android::base::Result<void> VintfObject::checkUnusedHals(
const std::vector<HidlInterfaceMetadata>& hidlMetadata) {
auto matrix = getFrameworkCompatibilityMatrix();
if (matrix == nullptr) {
return android::base::Error(-NAME_NOT_FOUND) << "Missing framework matrix.";
}
auto manifest = getDeviceHalManifest();
if (manifest == nullptr) {
return android::base::Error(-NAME_NOT_FOUND) << "Missing device manifest.";
}
auto unused = manifest->checkUnusedHals(*matrix, hidlMetadata);
if (!unused.empty()) {
return android::base::Error()
<< "The following instances are in the device manifest but "
<< "not specified in framework compatibility matrix: \n"
<< " " << android::base::Join(unused, "\n ") << "\n"
<< "Suggested fix:\n"
<< "1. Update deprecated HALs to the latest version.\n"
<< "2. Check for any typos in device manifest or framework compatibility "
<< "matrices with FCM version >= " << matrix->level() << ".\n"
<< "3. For new platform HALs, add them to any framework compatibility matrix "