forked from LineageOS/android_frameworks_native
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathListCommand.cpp
1235 lines (1106 loc) · 49.8 KB
/
ListCommand.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 "ListCommand.h"
#include <getopt.h>
#include <algorithm>
#include <fstream>
#include <functional>
#include <iomanip>
#include <iostream>
#include <map>
#include <regex>
#include <sstream>
#include <android-base/file.h>
#include <android-base/hex.h>
#include <android-base/logging.h>
#include <android/hidl/manager/1.0/IServiceManager.h>
#include <hidl-hash/Hash.h>
#include <hidl-util/FQName.h>
#include <private/android_filesystem_config.h>
#include <sys/stat.h>
#include <vintf/HalManifest.h>
#include <vintf/parse_string.h>
#include <vintf/parse_xml.h>
#include "Lshal.h"
#include "PipeRelay.h"
#include "Timeout.h"
#include "utils.h"
using ::android::hardware::hidl_array;
using ::android::hardware::hidl_string;
using ::android::hardware::hidl_vec;
using ::android::hidl::base::V1_0::DebugInfo;
using ::android::hidl::base::V1_0::IBase;
using ::android::hidl::manager::V1_0::IServiceManager;
namespace android {
namespace lshal {
vintf::SchemaType toSchemaType(Partition p) {
return (p == Partition::SYSTEM) ? vintf::SchemaType::FRAMEWORK : vintf::SchemaType::DEVICE;
}
Partition toPartition(vintf::SchemaType t) {
switch (t) {
case vintf::SchemaType::FRAMEWORK: return Partition::SYSTEM;
// TODO(b/71555570): Device manifest does not distinguish HALs from vendor or ODM.
case vintf::SchemaType::DEVICE: return Partition::VENDOR;
}
return Partition::UNKNOWN;
}
std::string getPackageAndVersion(const std::string& fqInstance) {
return splitFirst(fqInstance, ':').first;
}
NullableOStream<std::ostream> ListCommand::out() const {
return mLshal.out();
}
NullableOStream<std::ostream> ListCommand::err() const {
return mLshal.err();
}
std::string ListCommand::GetName() {
return "list";
}
std::string ListCommand::getSimpleDescription() const {
return "List HIDL HALs.";
}
std::string ListCommand::parseCmdline(pid_t pid) const {
return android::procpartition::getCmdline(pid);
}
const std::string &ListCommand::getCmdline(pid_t pid) {
static const std::string kEmptyString{};
if (pid == NO_PID) return kEmptyString;
auto pair = mCmdlines.find(pid);
if (pair != mCmdlines.end()) {
return pair->second;
}
mCmdlines[pid] = parseCmdline(pid);
return mCmdlines[pid];
}
void ListCommand::removeDeadProcesses(Pids *pids) {
static const pid_t myPid = getpid();
pids->erase(std::remove_if(pids->begin(), pids->end(), [this](auto pid) {
return pid == myPid || this->getCmdline(pid).empty();
}), pids->end());
}
Partition ListCommand::getPartition(pid_t pid) {
if (pid == NO_PID) return Partition::UNKNOWN;
auto it = mPartitions.find(pid);
if (it != mPartitions.end()) {
return it->second;
}
Partition partition = android::procpartition::getPartition(pid);
mPartitions.emplace(pid, partition);
return partition;
}
// Give sensible defaults when nothing can be inferred from runtime.
// process: Partition inferred from executable location or cmdline.
Partition ListCommand::resolvePartition(Partition process, const FqInstance& fqInstance) const {
if (fqInstance.inPackage("vendor") || fqInstance.inPackage("com")) {
return Partition::VENDOR;
}
if (fqInstance.inPackage("android.frameworks") || fqInstance.inPackage("android.system") ||
fqInstance.inPackage("android.hidl")) {
return Partition::SYSTEM;
}
// Some android.hardware HALs are served from system. Check the value from executable
// location / cmdline first.
if (fqInstance.inPackage("android.hardware")) {
if (process != Partition::UNKNOWN) {
return process;
}
return Partition::VENDOR;
}
return process;
}
bool match(const vintf::ManifestInstance& instance, const FqInstance& fqInstance,
vintf::TransportArch ta) {
// For hwbinder libs, allow missing arch in manifest.
// For passthrough libs, allow missing interface/instance in table.
return (ta.transport == instance.transport()) &&
(ta.transport == vintf::Transport::HWBINDER ||
vintf::contains(instance.arch(), ta.arch)) &&
(!fqInstance.hasInterface() || fqInstance.getInterface() == instance.interface()) &&
(!fqInstance.hasInstance() || fqInstance.getInstance() == instance.instance());
}
bool match(const vintf::MatrixInstance& instance, const FqInstance& fqInstance,
vintf::TransportArch /* ta */) {
return (!fqInstance.hasInterface() || fqInstance.getInterface() == instance.interface()) &&
(!fqInstance.hasInstance() || instance.matchInstance(fqInstance.getInstance()));
}
template <typename ObjectType>
VintfInfo getVintfInfo(const std::shared_ptr<const ObjectType>& object,
const FqInstance& fqInstance, vintf::TransportArch ta, VintfInfo value) {
bool found = false;
(void)object->forEachHidlInstanceOfVersion(fqInstance.getPackage(), fqInstance.getVersion(),
[&](const auto& instance) {
found = match(instance, fqInstance, ta);
return !found; // continue if not found
});
return found ? value : VINTF_INFO_EMPTY;
}
std::shared_ptr<const vintf::HalManifest> ListCommand::getDeviceManifest() const {
return vintf::VintfObject::GetDeviceHalManifest();
}
std::shared_ptr<const vintf::CompatibilityMatrix> ListCommand::getDeviceMatrix() const {
return vintf::VintfObject::GetDeviceCompatibilityMatrix();
}
std::shared_ptr<const vintf::HalManifest> ListCommand::getFrameworkManifest() const {
return vintf::VintfObject::GetFrameworkHalManifest();
}
std::shared_ptr<const vintf::CompatibilityMatrix> ListCommand::getFrameworkMatrix() const {
return vintf::VintfObject::GetFrameworkCompatibilityMatrix();
}
VintfInfo ListCommand::getVintfInfo(const std::string& fqInstanceName,
vintf::TransportArch ta) const {
FqInstance fqInstance;
if (!fqInstance.setTo(fqInstanceName) &&
// Ignore interface / instance for passthrough libs
!fqInstance.setTo(getPackageAndVersion(fqInstanceName))) {
err() << "Warning: Cannot parse '" << fqInstanceName << "'; no VINTF info." << std::endl;
return VINTF_INFO_EMPTY;
}
return lshal::getVintfInfo(getDeviceManifest(), fqInstance, ta, DEVICE_MANIFEST) |
lshal::getVintfInfo(getFrameworkManifest(), fqInstance, ta, FRAMEWORK_MANIFEST) |
lshal::getVintfInfo(getDeviceMatrix(), fqInstance, ta, DEVICE_MATRIX) |
lshal::getVintfInfo(getFrameworkMatrix(), fqInstance, ta, FRAMEWORK_MATRIX);
}
bool ListCommand::getPidInfo(
pid_t serverPid, BinderPidInfo *pidInfo) const {
const auto& status = getBinderPidInfo(BinderDebugContext::HWBINDER, serverPid, pidInfo);
return status == OK;
}
const BinderPidInfo* ListCommand::getPidInfoCached(pid_t serverPid) {
auto pair = mCachedPidInfos.insert({serverPid, BinderPidInfo{}});
if (pair.second /* did insertion take place? */) {
if (!getPidInfo(serverPid, &pair.first->second)) {
return nullptr;
}
}
return &pair.first->second;
}
bool ListCommand::shouldFetchHalType(const HalType &type) const {
return (std::find(mFetchTypes.begin(), mFetchTypes.end(), type) != mFetchTypes.end());
}
Table* ListCommand::tableForType(HalType type) {
switch (type) {
case HalType::BINDERIZED_SERVICES:
return &mServicesTable;
case HalType::PASSTHROUGH_CLIENTS:
return &mPassthroughRefTable;
case HalType::PASSTHROUGH_LIBRARIES:
return &mImplementationsTable;
case HalType::VINTF_MANIFEST:
return &mManifestHalsTable;
case HalType::LAZY_HALS:
return &mLazyHalsTable;
default:
LOG(FATAL) << "Unknown HAL type " << static_cast<int64_t>(type);
return nullptr;
}
}
const Table* ListCommand::tableForType(HalType type) const {
return const_cast<ListCommand*>(this)->tableForType(type);
}
void ListCommand::forEachTable(const std::function<void(Table &)> &f) {
for (const auto& type : mListTypes) {
f(*tableForType(type));
}
}
void ListCommand::forEachTable(const std::function<void(const Table &)> &f) const {
for (const auto& type : mListTypes) {
f(*tableForType(type));
}
}
void ListCommand::postprocess() {
forEachTable([this](Table &table) {
if (mSortColumn) {
std::sort(table.begin(), table.end(), mSortColumn);
}
for (TableEntry &entry : table) {
entry.serverCmdline = getCmdline(entry.serverPid);
removeDeadProcesses(&entry.clientPids);
for (auto pid : entry.clientPids) {
entry.clientCmdlines.push_back(this->getCmdline(pid));
}
}
for (TableEntry& entry : table) {
if (entry.partition == Partition::UNKNOWN) {
entry.partition = getPartition(entry.serverPid);
}
entry.vintfInfo = getVintfInfo(entry.interfaceName, {entry.transport, entry.arch});
}
});
// use a double for loop here because lshal doesn't care about efficiency.
for (TableEntry &packageEntry : mImplementationsTable) {
std::string packageName = packageEntry.interfaceName;
FQName fqPackageName;
if (!FQName::parse(packageName.substr(0, packageName.find("::")), &fqPackageName)) {
continue;
}
for (TableEntry &interfaceEntry : mPassthroughRefTable) {
if (interfaceEntry.arch != vintf::Arch::ARCH_EMPTY) {
continue;
}
FQName interfaceName;
if (!FQName::parse(splitFirst(interfaceEntry.interfaceName, '/').first, &interfaceName)) {
continue;
}
if (interfaceName.getPackageAndVersion() == fqPackageName) {
interfaceEntry.arch = packageEntry.arch;
}
}
}
mServicesTable.setDescription(
"| All HIDL binderized services (registered with hwservicemanager)");
mPassthroughRefTable.setDescription(
"| All HIDL interfaces getService() has ever returned as a passthrough interface;\n"
"| PIDs / processes shown below might be inaccurate because the process\n"
"| might have relinquished the interface or might have died.\n"
"| The Server / Server CMD column can be ignored.\n"
"| The Clients / Clients CMD column shows all process that have ever dlopen'ed \n"
"| the library and successfully fetched the passthrough implementation.");
mImplementationsTable.setDescription(
"| All available HIDL passthrough implementations (all -impl.so files).\n"
"| These may return subclasses through their respective HIDL_FETCH_I* functions.");
mManifestHalsTable.setDescription(
"| All HIDL HALs that are in VINTF manifest.");
mLazyHalsTable.setDescription(
"| All HIDL HALs that are declared in VINTF manifest:\n"
"| - as hwbinder HALs but are not registered to hwservicemanager, and\n"
"| - as hwbinder/passthrough HALs with no implementation.");
}
bool ListCommand::addEntryWithInstance(const TableEntry& entry,
vintf::HalManifest* manifest) const {
FqInstance fqInstance;
if (!fqInstance.setTo(entry.interfaceName)) {
err() << "Warning: '" << entry.interfaceName << "' is not a valid FqInstance." << std::endl;
return false;
}
if (fqInstance.getPackage() == "android.hidl.base") {
return true; // always remove IBase from manifest
}
Partition partition = resolvePartition(entry.partition, fqInstance);
if (partition == Partition::UNKNOWN) {
err() << "Warning: Cannot guess the partition of FqInstance " << fqInstance.string()
<< std::endl;
return false;
}
if (partition != mVintfPartition) {
return true; // strip out instances that is in a different partition.
}
vintf::Arch arch;
if (entry.transport == vintf::Transport::HWBINDER) {
arch = vintf::Arch::ARCH_EMPTY; // no need to specify arch in manifest
} else if (entry.transport == vintf::Transport::PASSTHROUGH) {
if (entry.arch == vintf::Arch::ARCH_EMPTY) {
err() << "Warning: '" << entry.interfaceName << "' doesn't have bitness info.";
return false;
}
arch = entry.arch;
} else {
err() << "Warning: '" << entry.transport << "' is not a valid transport." << std::endl;
return false;
}
auto vintfFqInstance = vintf::FqInstance::from(fqInstance.string());
if (!vintfFqInstance.has_value()) {
err() << "Unable to convert " << fqInstance.string() << " to vintf::FqInstance"
<< std::endl;
return false;
}
std::string e;
if (!manifest->insertInstance(*vintfFqInstance, entry.transport, arch, vintf::HalFormat::HIDL,
&e)) {
err() << "Warning: Cannot insert '" << fqInstance.string() << ": " << e << std::endl;
return false;
}
return true;
}
bool ListCommand::addEntryWithoutInstance(const TableEntry& entry,
const vintf::HalManifest* manifest) const {
const auto& packageAndVersion = splitFirst(getPackageAndVersion(entry.interfaceName), '@');
const auto& package = packageAndVersion.first;
vintf::Version version;
if (!vintf::parse(packageAndVersion.second, &version)) {
err() << "Warning: Cannot parse version '" << packageAndVersion.second << "' for entry '"
<< entry.interfaceName << "'" << std::endl;
return false;
}
bool found = false;
(void)manifest->forEachHidlInstanceOfVersion(package, version, [&found](const auto&) {
found = true;
return false; // break
});
return found;
}
void ListCommand::dumpVintf(const NullableOStream<std::ostream>& out) const {
using vintf::operator|=;
using vintf::operator<<;
using namespace std::placeholders;
vintf::HalManifest manifest;
manifest.setType(toSchemaType(mVintfPartition));
std::vector<std::string> error;
for (const TableEntry& entry : mServicesTable)
if (!addEntryWithInstance(entry, &manifest)) error.push_back(entry.interfaceName);
for (const TableEntry& entry : mPassthroughRefTable)
if (!addEntryWithInstance(entry, &manifest)) error.push_back(entry.interfaceName);
for (const TableEntry& entry : mManifestHalsTable)
if (!addEntryWithInstance(entry, &manifest)) error.push_back(entry.interfaceName);
std::vector<std::string> passthrough;
for (const TableEntry& entry : mImplementationsTable)
if (!addEntryWithoutInstance(entry, &manifest)) passthrough.push_back(entry.interfaceName);
out << "<!-- " << std::endl
<< " This is a skeleton " << manifest.type() << " manifest. Notes: " << std::endl
<< INIT_VINTF_NOTES;
if (!error.empty()) {
out << std::endl << " The following HALs are not added; see warnings." << std::endl;
for (const auto& e : error) {
out << " " << e << std::endl;
}
}
if (!passthrough.empty()) {
out << std::endl
<< " The following HALs are passthrough and no interface or instance " << std::endl
<< " names can be inferred." << std::endl;
for (const auto& e : passthrough) {
out << " " << e << std::endl;
}
}
out << "-->" << std::endl;
out << vintf::toXml(manifest, vintf::SerializeFlags::HALS_ONLY);
}
std::string ListCommand::INIT_VINTF_NOTES{
" 1. If a HAL is supported in both hwbinder and passthrough transport,\n"
" only hwbinder is shown.\n"
" 2. It is likely that HALs in passthrough transport does not have\n"
" <interface> declared; users will have to write them by hand.\n"
" 3. A HAL with lower minor version can be overridden by a HAL with\n"
" higher minor version if they have the same name and major version.\n"
" 4. This output is intended for launch devices.\n"
" Upgrading devices should not use this tool to generate device\n"
" manifest and replace the existing manifest directly, but should\n"
" edit the existing manifest manually.\n"
" Specifically, devices which launched at Android O-MR1 or earlier\n"
" should not use the 'fqname' format for required HAL entries and\n"
" should instead use the legacy package, name, instance-name format\n"
" until they are updated.\n"
};
static vintf::Arch fromBaseArchitecture(::android::hidl::base::V1_0::DebugInfo::Architecture a) {
switch (a) {
case ::android::hidl::base::V1_0::DebugInfo::Architecture::IS_64BIT:
return vintf::Arch::ARCH_64;
case ::android::hidl::base::V1_0::DebugInfo::Architecture::IS_32BIT:
return vintf::Arch::ARCH_32;
case ::android::hidl::base::V1_0::DebugInfo::Architecture::UNKNOWN: // fallthrough
default:
return vintf::Arch::ARCH_EMPTY;
}
}
void ListCommand::dumpTable(const NullableOStream<std::ostream>& out) const {
if (mNeat) {
std::vector<const Table*> tables;
forEachTable([&tables](const Table &table) {
tables.push_back(&table);
});
MergedTable(std::move(tables)).createTextTable().dump(out.buf());
return;
}
forEachTable([this, &out](const Table &table) {
// We're only interested in dumping debug info for already
// instantiated services. There's little value in dumping the
// debug info for a service we create on the fly, so we only operate
// on the "mServicesTable".
std::function<std::string(const std::string&)> emitDebugInfo = nullptr;
if (mEmitDebugInfo && &table == &mServicesTable) {
emitDebugInfo = [this](const auto& iName) {
std::stringstream ss;
auto pair = splitFirst(iName, '/');
mLshal.emitDebugInfo(pair.first, pair.second, {},
ParentDebugInfoLevel::FQNAME_ONLY, ss,
NullableOStream<std::ostream>(nullptr));
return ss.str();
};
}
table.createTextTable(mNeat, emitDebugInfo).dump(out.buf());
out << std::endl;
});
}
Status ListCommand::dump() {
auto dump = mVintf ? &ListCommand::dumpVintf : &ListCommand::dumpTable;
if (mFileOutputPath.empty()) {
(*this.*dump)(out());
return OK;
}
std::ofstream fileOutput(mFileOutputPath);
if (!fileOutput.is_open()) {
err() << "Could not open file '" << mFileOutputPath << "'." << std::endl;
return IO_ERROR;
}
chown(mFileOutputPath.c_str(), AID_SHELL, AID_SHELL);
(*this.*dump)(NullableOStream<std::ostream>(fileOutput));
fileOutput.flush();
fileOutput.close();
return OK;
}
void ListCommand::putEntry(HalType type, TableEntry &&entry) {
tableForType(type)->add(std::forward<TableEntry>(entry));
}
Status ListCommand::fetchAllLibraries(const sp<IServiceManager> &manager) {
if (!shouldFetchHalType(HalType::PASSTHROUGH_LIBRARIES)) { return OK; }
using namespace ::android::hardware;
using namespace ::android::hidl::manager::V1_0;
using namespace ::android::hidl::base::V1_0;
// The lambda function may be executed asynchrounously because it is passed to timeoutIPC,
// even though the interface function call is synchronous.
// However, there's no need to lock because if ret.isOk(), the background thread has
// already ended, so it is safe to dereference entries.
auto entries = std::make_shared<std::map<std::string, TableEntry>>();
auto ret =
timeoutIPC(mLshal.getDebugDumpWait(), manager, &IServiceManager::debugDump,
[entries](const auto& infos) {
for (const auto& info : infos) {
std::string interfaceName = std::string{info.interfaceName.c_str()} +
"/" + std::string{info.instanceName.c_str()};
entries->emplace(interfaceName,
TableEntry{
.interfaceName = interfaceName,
.transport = vintf::Transport::PASSTHROUGH,
.clientPids = info.clientPids,
})
.first->second.arch |= fromBaseArchitecture(info.arch);
}
});
if (!ret.isOk()) {
err() << "Error: Failed to call list on getPassthroughServiceManager(): "
<< ret.description() << std::endl;
return DUMP_ALL_LIBS_ERROR;
}
for (auto&& pair : *entries) {
putEntry(HalType::PASSTHROUGH_LIBRARIES, std::move(pair.second));
}
return OK;
}
Status ListCommand::fetchPassthrough(const sp<IServiceManager> &manager) {
if (!shouldFetchHalType(HalType::PASSTHROUGH_CLIENTS)) { return OK; }
using namespace ::android::hardware;
using namespace ::android::hardware::details;
using namespace ::android::hidl::manager::V1_0;
using namespace ::android::hidl::base::V1_0;
// The lambda function may be executed asynchrounously because it is passed to timeoutIPC,
// even though the interface function call is synchronous.
// However, there's no need to lock because if ret.isOk(), the background thread has
// already ended, so it is safe to dereference entries.
auto entries = std::make_shared<std::vector<TableEntry>>();
auto ret =
timeoutIPC(mLshal.getIpcCallWait(), manager, &IServiceManager::debugDump,
[entries](const auto& infos) {
for (const auto& info : infos) {
if (info.clientPids.size() <= 0) {
continue;
}
entries->emplace_back(
TableEntry{.interfaceName =
std::string{info.interfaceName.c_str()} +
"/" +
std::string{info.instanceName.c_str()},
.transport = vintf::Transport::PASSTHROUGH,
.serverPid = info.clientPids.size() == 1
? info.clientPids[0]
: NO_PID,
.clientPids = info.clientPids,
.arch = fromBaseArchitecture(info.arch)});
}
});
if (!ret.isOk()) {
err() << "Error: Failed to call debugDump on defaultServiceManager(): "
<< ret.description() << std::endl;
return DUMP_PASSTHROUGH_ERROR;
}
for (auto&& entry : *entries) {
putEntry(HalType::PASSTHROUGH_CLIENTS, std::move(entry));
}
return OK;
}
Status ListCommand::fetchBinderized(const sp<IServiceManager> &manager) {
using vintf::operator<<;
if (!shouldFetchHalType(HalType::BINDERIZED_SERVICES)) { return OK; }
const vintf::Transport mode = vintf::Transport::HWBINDER;
// The lambda function may be executed asynchrounously because it is passed to timeoutIPC,
// even though the interface function call is synchronous.
// However, there's no need to lock because if listRet.isOk(), the background thread has
// already ended, so it is safe to dereference fqInstanceNames.
auto fqInstanceNames = std::make_shared<hidl_vec<hidl_string>>();
auto listRet = timeoutIPC(mLshal.getIpcCallWait(), manager, &IServiceManager::list,
[fqInstanceNames](const auto& names) { *fqInstanceNames = names; });
if (!listRet.isOk()) {
err() << "Error: Failed to list services for " << mode << ": "
<< listRet.description() << std::endl;
return DUMP_BINDERIZED_ERROR;
}
Status status = OK;
std::map<std::string, TableEntry> allTableEntries;
for (const auto& fqInstanceName : *fqInstanceNames) {
// create entry and default assign all fields.
TableEntry& entry = allTableEntries[fqInstanceName];
entry.interfaceName = fqInstanceName;
entry.transport = mode;
entry.serviceStatus = ServiceStatus::NON_RESPONSIVE;
status |= fetchBinderizedEntry(manager, &entry);
}
for (auto& pair : allTableEntries) {
putEntry(HalType::BINDERIZED_SERVICES, std::move(pair.second));
}
return status;
}
Status ListCommand::fetchBinderizedEntry(const sp<IServiceManager> &manager,
TableEntry *entry) {
Status status = OK;
const auto handleError = [&](Status additionalError, const std::string& msg) {
err() << "Warning: Skipping \"" << entry->interfaceName << "\": " << msg << std::endl;
status |= DUMP_BINDERIZED_ERROR | additionalError;
};
const auto pair = splitFirst(entry->interfaceName, '/');
const auto &serviceName = pair.first;
const auto &instanceName = pair.second;
auto getRet = timeoutIPC(mLshal.getIpcCallWait(), manager, &IServiceManager::get, serviceName,
instanceName);
if (!getRet.isOk()) {
handleError(TRANSACTION_ERROR,
"cannot be fetched from service manager:" + getRet.description());
return status;
}
sp<IBase> service = getRet;
if (service == nullptr) {
handleError(NO_INTERFACE, "cannot be fetched from service manager (null)");
return status;
}
// getDebugInfo
do {
// The lambda function may be executed asynchrounously because it is passed to timeoutIPC,
// even though the interface function call is synchronous.
// However, there's no need to lock because if debugRet.isOk(), the background thread has
// already ended, so it is safe to dereference debugInfo.
auto debugInfo = std::make_shared<DebugInfo>();
auto debugRet = timeoutIPC(mLshal.getIpcCallWait(), service, &IBase::getDebugInfo,
[debugInfo](const auto& received) { *debugInfo = received; });
if (!debugRet.isOk()) {
handleError(TRANSACTION_ERROR,
"debugging information cannot be retrieved: " + debugRet.description());
break; // skip getPidInfo
}
entry->serverPid = debugInfo->pid;
entry->serverObjectAddress = debugInfo->ptr;
entry->arch = fromBaseArchitecture(debugInfo->arch);
if (debugInfo->pid != NO_PID) {
const BinderPidInfo* pidInfo = getPidInfoCached(debugInfo->pid);
if (pidInfo == nullptr) {
handleError(IO_ERROR,
"no information for PID " + std::to_string(debugInfo->pid) +
", are you root?");
break;
}
if (debugInfo->ptr != NO_PTR) {
auto it = pidInfo->refPids.find(debugInfo->ptr);
if (it != pidInfo->refPids.end()) {
entry->clientPids = it->second;
}
}
entry->threadUsage = pidInfo->threadUsage;
entry->threadCount = pidInfo->threadCount;
}
} while (0);
// hash
do {
// The lambda function may be executed asynchrounously because it is passed to timeoutIPC,
// even though the interface function call is synchronous.
auto hashIndexStore = std::make_shared<ssize_t>(-1);
auto ifaceChainRet = timeoutIPC(mLshal.getIpcCallWait(), service, &IBase::interfaceChain,
[hashIndexStore, serviceName](const auto& c) {
for (size_t i = 0; i < c.size(); ++i) {
if (serviceName == c[i]) {
*hashIndexStore = static_cast<ssize_t>(i);
break;
}
}
});
if (!ifaceChainRet.isOk()) {
handleError(TRANSACTION_ERROR,
"interfaceChain fails: " + ifaceChainRet.description());
break; // skip getHashChain
}
// if ifaceChainRet.isOk(), the background thread has already ended, so it is safe to
// dereference hashIndex without any locking.
auto hashIndex = *hashIndexStore;
if (hashIndex < 0) {
handleError(BAD_IMPL, "Interface name does not exist in interfaceChain.");
break; // skip getHashChain
}
// See comments about hashIndex above.
auto hashChain = std::make_shared<hidl_vec<hidl_array<uint8_t, 32>>>();
auto hashRet = timeoutIPC(mLshal.getIpcCallWait(), service, &IBase::getHashChain,
[hashChain](const auto& ret) { *hashChain = std::move(ret); });
if (!hashRet.isOk()) {
handleError(TRANSACTION_ERROR, "getHashChain failed: " + hashRet.description());
break; // skip getHashChain
}
if (static_cast<size_t>(hashIndex) >= hashChain->size()) {
handleError(BAD_IMPL,
"interfaceChain indicates position " + std::to_string(hashIndex) +
" but getHashChain returns " + std::to_string(hashChain->size()) +
" hashes");
break; // skip getHashChain
}
auto&& hashArray = (*hashChain)[hashIndex];
entry->hash = android::base::HexString(hashArray.data(), hashArray.size());
} while (0);
if (status == OK) {
entry->serviceStatus = ServiceStatus::ALIVE;
}
return status;
}
Status ListCommand::fetchManifestHals() {
if (!shouldFetchHalType(HalType::VINTF_MANIFEST)) { return OK; }
Status status = OK;
for (auto manifest : {getDeviceManifest(), getFrameworkManifest()}) {
if (manifest == nullptr) {
status |= VINTF_ERROR;
continue;
}
std::map<std::string, TableEntry> entries;
manifest->forEachHidlInstance([&] (const vintf::ManifestInstance& manifestInstance) {
TableEntry entry{
.interfaceName = manifestInstance.description(),
.transport = manifestInstance.transport(),
.arch = manifestInstance.arch(),
// TODO(b/71555570): Device manifest does not distinguish HALs from vendor or ODM.
.partition = toPartition(manifest->type()),
.serviceStatus = ServiceStatus::DECLARED};
std::string key = entry.interfaceName;
entries.emplace(std::move(key), std::move(entry));
return true;
});
for (auto&& pair : entries)
mManifestHalsTable.add(std::move(pair.second));
}
return status;
}
Status ListCommand::fetchLazyHals() {
using vintf::operator<<;
if (!shouldFetchHalType(HalType::LAZY_HALS)) { return OK; }
Status status = OK;
for (const TableEntry& manifestEntry : mManifestHalsTable) {
if (manifestEntry.transport == vintf::Transport::HWBINDER) {
if (!hasHwbinderEntry(manifestEntry)) {
mLazyHalsTable.add(TableEntry(manifestEntry));
}
continue;
}
if (manifestEntry.transport == vintf::Transport::PASSTHROUGH) {
if (!hasPassthroughEntry(manifestEntry)) {
mLazyHalsTable.add(TableEntry(manifestEntry));
}
continue;
}
err() << "Warning: unrecognized transport in VINTF manifest: "
<< manifestEntry.transport;
status |= VINTF_ERROR;
}
return status;
}
bool ListCommand::hasHwbinderEntry(const TableEntry& entry) const {
for (const TableEntry& existing : mServicesTable) {
if (existing.interfaceName == entry.interfaceName) {
return true;
}
}
return false;
}
bool ListCommand::hasPassthroughEntry(const TableEntry& entry) const {
FqInstance entryFqInstance;
if (!entryFqInstance.setTo(entry.interfaceName)) {
return false; // cannot parse, so add it anyway.
}
for (const TableEntry& existing : mImplementationsTable) {
FqInstance existingFqInstance;
if (!existingFqInstance.setTo(getPackageAndVersion(existing.interfaceName))) {
continue;
}
// For example, manifest may say [email protected] but passthroughServiceManager
// can only list [email protected].
if (entryFqInstance.getPackage() == existingFqInstance.getPackage() &&
vintf::Version{entryFqInstance.getVersion()}
.minorAtLeast(vintf::Version{existingFqInstance.getVersion()})) {
return true;
}
}
return false;
}
Status ListCommand::fetch() {
Status status = OK;
auto bManager = mLshal.serviceManager();
if (bManager == nullptr) {
err() << "Failed to get defaultServiceManager()!" << std::endl;
status |= NO_BINDERIZED_MANAGER;
} else {
status |= fetchBinderized(bManager);
// Passthrough PIDs are registered to the binderized manager as well.
status |= fetchPassthrough(bManager);
}
auto pManager = mLshal.passthroughManager();
if (pManager == nullptr) {
err() << "Failed to get getPassthroughServiceManager()!" << std::endl;
status |= NO_PASSTHROUGH_MANAGER;
} else {
status |= fetchAllLibraries(pManager);
}
status |= fetchManifestHals();
status |= fetchLazyHals();
return status;
}
void ListCommand::initFetchTypes() {
// TODO: refactor to do polymorphism on each table (so that dependency graph is not hardcoded).
static const std::map<HalType, std::set<HalType>> kDependencyGraph{
{HalType::LAZY_HALS, {HalType::BINDERIZED_SERVICES,
HalType::PASSTHROUGH_LIBRARIES,
HalType::VINTF_MANIFEST}},
};
mFetchTypes.insert(mListTypes.begin(), mListTypes.end());
for (HalType listType : mListTypes) {
auto it = kDependencyGraph.find(listType);
if (it != kDependencyGraph.end()) {
mFetchTypes.insert(it->second.begin(), it->second.end());
}
}
}
// Get all values of enum type T, assuming the first value is 0 and the last value is T::LAST.
// T::LAST is not included in the returned list.
template <typename T>
std::vector<T> GetAllValues() {
using BaseType = std::underlying_type_t<T>;
std::vector<T> ret;
for (BaseType i = 0; i < static_cast<BaseType>(T::LAST); ++i) {
ret.push_back(static_cast<T>(i));
}
return ret;
}
void ListCommand::registerAllOptions() {
int v = mOptions.size();
// A list of acceptable command line options
// key: value returned by getopt_long
// long options with short alternatives
mOptions.push_back({'h', "help", no_argument, v++, [](ListCommand*, const char*) {
return USAGE;
}, ""});
mOptions.push_back({'i', "interface", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::INTERFACE_NAME);
return OK;
}, "print the instance name column"});
mOptions.push_back({'l', "released", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::RELEASED);
return OK;
}, "print the 'is released?' column\n(Y=released, N=unreleased, ?=unknown)"});
mOptions.push_back({'t', "transport", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::TRANSPORT);
return OK;
}, "print the transport mode column"});
mOptions.push_back({'r', "arch", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::ARCH);
return OK;
}, "print the bitness column"});
mOptions.push_back({'s', "hash", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::HASH);
return OK;
}, "print hash of the interface"});
mOptions.push_back({'p', "pid", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::SERVER_PID);
return OK;
}, "print the server PID, or server cmdline if -m is set"});
mOptions.push_back({'a', "address", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::SERVER_ADDR);
return OK;
}, "print the server object address column"});
mOptions.push_back({'c', "clients", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::CLIENT_PIDS);
return OK;
}, "print the client PIDs, or client cmdlines if -m is set"});
mOptions.push_back({'e', "threads", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::THREADS);
return OK;
}, "print currently used/available threads\n(note, available threads created lazily)"});
mOptions.push_back({'m', "cmdline", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mEnableCmdlines = true;
return OK;
}, "print cmdline instead of PIDs"});
mOptions.push_back({'d', "debug", optional_argument, v++, [](ListCommand* thiz, const char* arg) {
thiz->mEmitDebugInfo = true;
if (arg) thiz->mFileOutputPath = arg;
return OK;
}, "Emit debug info from\nIBase::debug with empty options. Cannot be used with --neat.\n"
"Writes to specified file if 'arg' is provided, otherwise stdout."});
mOptions.push_back({'V', "vintf", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::VINTF);
return OK;
}, "print VINTF info. This column contains a comma-separated list of:\n"
" - DM: if the HIDL HAL is in the device manifest\n"
" - DC: if the HIDL HAL is in the device compatibility matrix\n"
" - FM: if the HIDL HAL is in the framework manifest\n"
" - FC: if the HIDL HAL is in the framework compatibility matrix\n"
" - X: if the HIDL HAL is in none of the above lists"});
mOptions.push_back({'S', "service-status", no_argument, v++, [](ListCommand* thiz, const char*) {
thiz->mSelectedColumns.push_back(TableColumnType::SERVICE_STATUS);
return OK;
}, "print service status column. Possible values are:\n"
" - alive: alive and running hwbinder service;\n"
" - registered;dead: registered to hwservicemanager but is not responsive;\n"
" - declared: only declared in VINTF manifest but is not registered to hwservicemanager;\n"
" - N/A: no information for passthrough HALs."});
mOptions.push_back({'A', "all", no_argument, v++,
[](ListCommand* thiz, const char*) {
auto allColumns = GetAllValues<TableColumnType>();
thiz->mSelectedColumns.insert(thiz->mSelectedColumns.end(),
allColumns.begin(), allColumns.end());
return OK;
},
"print all columns"});
// long options without short alternatives
mOptions.push_back({'\0', "init-vintf", no_argument, v++, [](ListCommand* thiz, const char* arg) {
thiz->mVintf = true;
if (thiz->mVintfPartition == Partition::UNKNOWN)
thiz->mVintfPartition = Partition::VENDOR;
if (arg) thiz->mFileOutputPath = arg;
return OK;
}, "form a skeleton HAL manifest to specified file,\nor stdout if no file specified."});
mOptions.push_back({'\0', "init-vintf-partition", required_argument, v++, [](ListCommand* thiz, const char* arg) {
if (!arg) return USAGE;
thiz->mVintfPartition = android::procpartition::parsePartition(arg);
if (thiz->mVintfPartition == Partition::UNKNOWN) return USAGE;
return OK;
}, "Specify the partition of the HAL manifest\ngenerated by --init-vintf.\n"
"Valid values are 'system', 'vendor', and 'odm'. Default is 'vendor'."});
mOptions.push_back({'\0', "sort", required_argument, v++, [](ListCommand* thiz, const char* arg) {
if (strcmp(arg, "interface") == 0 || strcmp(arg, "i") == 0) {
thiz->mSortColumn = TableEntry::sortByInterfaceName;
} else if (strcmp(arg, "pid") == 0 || strcmp(arg, "p") == 0) {
thiz->mSortColumn = TableEntry::sortByServerPid;
} else {
thiz->err() << "Unrecognized sorting column: " << arg << std::endl;
return USAGE;
}
return OK;
}, "sort by a column. 'arg' can be (i|interface) or (p|pid)."});
mOptions.push_back({'\0', "neat", no_argument, v++, [](ListCommand* thiz, const char*) {