1 /*
2 * Copyright (C) 2016 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 #define LOG_TAG "HidlServiceManagement"
18
19 #ifdef __ANDROID__
20 #include <android/dlext.h>
21 #endif // __ANDROID__
22
23 #include <condition_variable>
24 #include <dlfcn.h>
25 #include <dirent.h>
26 #include <fstream>
27 #include <pthread.h>
28 #include <unistd.h>
29
30 #include <mutex>
31 #include <regex>
32 #include <set>
33
34 #include <hidl/HidlBinderSupport.h>
35 #include <hidl/HidlInternal.h>
36 #include <hidl/HidlTransportUtils.h>
37 #include <hidl/ServiceManagement.h>
38 #include <hidl/Status.h>
39 #include <utils/SystemClock.h>
40
41 #include <android-base/file.h>
42 #include <android-base/logging.h>
43 #include <android-base/parseint.h>
44 #include <android-base/properties.h>
45 #include <android-base/stringprintf.h>
46 #include <android-base/strings.h>
47 #include <hwbinder/IPCThreadState.h>
48 #include <hwbinder/Parcel.h>
49 #if !defined(__ANDROID_RECOVERY__) && defined(__ANDROID__)
50 #include <vndksupport/linker.h>
51 #endif
52
53 #include <android/hidl/manager/1.2/BnHwServiceManager.h>
54 #include <android/hidl/manager/1.2/BpHwServiceManager.h>
55 #include <android/hidl/manager/1.2/IServiceManager.h>
56
57 using ::android::hidl::base::V1_0::IBase;
58 using IServiceManager1_0 = android::hidl::manager::V1_0::IServiceManager;
59 using IServiceManager1_1 = android::hidl::manager::V1_1::IServiceManager;
60 using IServiceManager1_2 = android::hidl::manager::V1_2::IServiceManager;
61 using ::android::hidl::manager::V1_0::IServiceNotification;
62
63 namespace android {
64 namespace hardware {
65
66 #if defined(__ANDROID_RECOVERY__)
67 static constexpr bool kIsRecovery = true;
68 #else
69 static constexpr bool kIsRecovery = false;
70 #endif
71
waitForHwServiceManager()72 static void waitForHwServiceManager() {
73 // TODO(b/31559095): need bionic host so that we can use 'prop_info' returned
74 // from WaitForProperty
75 #ifdef __ANDROID__
76 static const char* kHwServicemanagerReadyProperty = "hwservicemanager.ready";
77
78 using std::literals::chrono_literals::operator""s;
79
80 using android::base::WaitForProperty;
81 while (!WaitForProperty(kHwServicemanagerReadyProperty, "true", 1s)) {
82 LOG(WARNING) << "Waited for hwservicemanager.ready for a second, waiting another...";
83 }
84 #endif // __ANDROID__
85 }
86
binaryName()87 static std::string binaryName() {
88 std::ifstream ifs("/proc/self/cmdline");
89 std::string cmdline;
90 if (!ifs) {
91 return "";
92 }
93 ifs >> cmdline;
94
95 size_t idx = cmdline.rfind('/');
96 if (idx != std::string::npos) {
97 cmdline = cmdline.substr(idx + 1);
98 }
99
100 return cmdline;
101 }
102
packageWithoutVersion(const std::string & packageAndVersion)103 static std::string packageWithoutVersion(const std::string& packageAndVersion) {
104 size_t at = packageAndVersion.find('@');
105 if (at == std::string::npos) return packageAndVersion;
106 return packageAndVersion.substr(0, at);
107 }
108
tryShortenProcessName(const std::string & descriptor)109 __attribute__((noinline)) static void tryShortenProcessName(const std::string& descriptor) {
110 const static std::string kTasks = "/proc/self/task/";
111
112 // make sure that this binary name is in the same package
113 std::string processName = binaryName();
114
115 // e.x. android.hardware.foo is this package
116 if (!base::StartsWith(packageWithoutVersion(processName), packageWithoutVersion(descriptor))) {
117 return;
118 }
119
120 // e.x. android.hardware.module.foo@1.2::IFoo -> foo@1.2
121 size_t lastDot = descriptor.rfind('.');
122 if (lastDot == std::string::npos) return;
123 size_t secondDot = descriptor.rfind('.', lastDot - 1);
124 if (secondDot == std::string::npos) return;
125
126 std::string newName = processName.substr(secondDot + 1, std::string::npos);
127 ALOGI("Removing namespace from process name %s to %s.", processName.c_str(), newName.c_str());
128
129 std::unique_ptr<DIR, decltype(&closedir)> dir(opendir(kTasks.c_str()), closedir);
130 if (dir == nullptr) return;
131
132 dirent* dp;
133 while ((dp = readdir(dir.get())) != nullptr) {
134 if (dp->d_type != DT_DIR) continue;
135 if (dp->d_name[0] == '.') continue;
136
137 std::fstream fs(kTasks + dp->d_name + "/comm");
138 if (!fs) {
139 ALOGI("Could not rename process, failed read comm for %s.", dp->d_name);
140 continue;
141 }
142
143 std::string oldComm;
144 if (!(fs >> oldComm)) continue;
145
146 // don't rename if it already has an explicit name
147 if (base::StartsWith(descriptor, oldComm)) {
148 if (!fs.seekg(0, fs.beg)) continue;
149 fs << newName;
150 }
151 }
152 }
153
154 namespace details {
155
156 #ifdef ENFORCE_VINTF_MANIFEST
157 static constexpr bool kEnforceVintfManifest = true;
158 #else
159 static constexpr bool kEnforceVintfManifest = false;
160 #endif
161
getTrebleTestingOverridePtr()162 static bool* getTrebleTestingOverridePtr() {
163 static bool gTrebleTestingOverride = false;
164 return &gTrebleTestingOverride;
165 }
166
setTrebleTestingOverride(bool testingOverride)167 void setTrebleTestingOverride(bool testingOverride) {
168 *getTrebleTestingOverridePtr() = testingOverride;
169 }
170
isDebuggable()171 static bool isDebuggable() {
172 static bool debuggable = base::GetBoolProperty("ro.debuggable", false);
173 return debuggable;
174 }
175
isTrebleTestingOverride()176 static inline bool isTrebleTestingOverride() {
177 // return false early so we don't need to check the debuggable property
178 if (!*getTrebleTestingOverridePtr()) return false;
179
180 if (kEnforceVintfManifest && !isDebuggable()) {
181 // don't allow testing override in production
182 return false;
183 }
184
185 return true;
186 }
187
onRegistrationImpl(const std::string & descriptor,const std::string & instanceName)188 static void onRegistrationImpl(const std::string& descriptor, const std::string& instanceName) {
189 LOG(INFO) << "Registered " << descriptor << "/" << instanceName;
190 tryShortenProcessName(descriptor);
191 }
192
193 // only used by prebuilts - should be able to remove
onRegistration(const std::string & packageName,const std::string & interfaceName,const std::string & instanceName)194 void onRegistration(const std::string& packageName, const std::string& interfaceName,
195 const std::string& instanceName) {
196 return onRegistrationImpl(packageName + "::" + interfaceName, instanceName);
197 }
198
199 } // details
200
defaultServiceManager()201 sp<IServiceManager1_0> defaultServiceManager() {
202 return defaultServiceManager1_2();
203 }
defaultServiceManager1_1()204 sp<IServiceManager1_1> defaultServiceManager1_1() {
205 return defaultServiceManager1_2();
206 }
defaultServiceManager1_2()207 sp<IServiceManager1_2> defaultServiceManager1_2() {
208 using android::hidl::manager::V1_2::BnHwServiceManager;
209 using android::hidl::manager::V1_2::BpHwServiceManager;
210
211 static std::mutex& gDefaultServiceManagerLock = *new std::mutex;
212 static sp<IServiceManager1_2>& gDefaultServiceManager = *new sp<IServiceManager1_2>;
213
214 {
215 std::lock_guard<std::mutex> _l(gDefaultServiceManagerLock);
216 if (gDefaultServiceManager != nullptr) {
217 return gDefaultServiceManager;
218 }
219
220 if (access("/dev/hwbinder", F_OK|R_OK|W_OK) != 0) {
221 // HwBinder not available on this device or not accessible to
222 // this process.
223 return nullptr;
224 }
225
226 waitForHwServiceManager();
227
228 while (gDefaultServiceManager == nullptr) {
229 gDefaultServiceManager =
230 fromBinder<IServiceManager1_2, BpHwServiceManager, BnHwServiceManager>(
231 ProcessState::self()->getContextObject(nullptr));
232 if (gDefaultServiceManager == nullptr) {
233 LOG(ERROR) << "Waited for hwservicemanager, but got nullptr.";
234 sleep(1);
235 }
236 }
237 }
238
239 return gDefaultServiceManager;
240 }
241
findFiles(const std::string & path,const std::string & prefix,const std::string & suffix)242 static std::vector<std::string> findFiles(const std::string& path, const std::string& prefix,
243 const std::string& suffix) {
244 std::unique_ptr<DIR, decltype(&closedir)> dir(opendir(path.c_str()), closedir);
245 if (!dir) return {};
246
247 std::vector<std::string> results{};
248
249 dirent* dp;
250 while ((dp = readdir(dir.get())) != nullptr) {
251 std::string name = dp->d_name;
252
253 if (base::StartsWith(name, prefix) && base::EndsWith(name, suffix)) {
254 results.push_back(name);
255 }
256 }
257
258 return results;
259 }
260
matchPackageName(const std::string & lib,std::string * matchedName,std::string * implName)261 static bool matchPackageName(const std::string& lib, std::string* matchedName,
262 std::string* implName) {
263 #define RE_COMPONENT "[a-zA-Z_][a-zA-Z_0-9]*"
264 #define RE_PATH RE_COMPONENT "(?:[.]" RE_COMPONENT ")*"
265 static const std::regex gLibraryFileNamePattern("(" RE_PATH "@[0-9]+[.][0-9]+)-impl(.*?).so");
266 #undef RE_PATH
267 #undef RE_COMPONENT
268
269 std::smatch match;
270 if (std::regex_match(lib, match, gLibraryFileNamePattern)) {
271 *matchedName = match.str(1) + "::I*";
272 *implName = match.str(2);
273 return true;
274 }
275 return false;
276 }
277
registerReference(const hidl_string & interfaceName,const hidl_string & instanceName)278 static void registerReference(const hidl_string &interfaceName, const hidl_string &instanceName) {
279 if (kIsRecovery) {
280 // No hwservicemanager in recovery.
281 return;
282 }
283
284 sp<IServiceManager1_0> binderizedManager = defaultServiceManager();
285 if (binderizedManager == nullptr) {
286 LOG(WARNING) << "Could not registerReference for "
287 << interfaceName << "/" << instanceName
288 << ": null binderized manager.";
289 return;
290 }
291 auto ret = binderizedManager->registerPassthroughClient(interfaceName, instanceName);
292 if (!ret.isOk()) {
293 LOG(WARNING) << "Could not registerReference for "
294 << interfaceName << "/" << instanceName
295 << ": " << ret.description();
296 return;
297 }
298 LOG(VERBOSE) << "Successfully registerReference for "
299 << interfaceName << "/" << instanceName;
300 }
301
302 using InstanceDebugInfo = hidl::manager::V1_0::IServiceManager::InstanceDebugInfo;
fetchPidsForPassthroughLibraries(std::map<std::string,InstanceDebugInfo> * infos)303 static inline void fetchPidsForPassthroughLibraries(
304 std::map<std::string, InstanceDebugInfo>* infos) {
305 static const std::string proc = "/proc/";
306
307 std::map<std::string, std::set<pid_t>> pids;
308 std::unique_ptr<DIR, decltype(&closedir)> dir(opendir(proc.c_str()), closedir);
309 if (!dir) return;
310 dirent* dp;
311 while ((dp = readdir(dir.get())) != nullptr) {
312 pid_t pid = strtoll(dp->d_name, nullptr, 0);
313 if (pid == 0) continue;
314 std::string mapsPath = proc + dp->d_name + "/maps";
315 std::ifstream ifs{mapsPath};
316 if (!ifs.is_open()) continue;
317
318 for (std::string line; std::getline(ifs, line);) {
319 // The last token of line should look like
320 // vendor/lib64/hw/android.hardware.foo@1.0-impl-extra.so
321 // Use some simple filters to ignore bad lines before extracting libFileName
322 // and checking the key in info to make parsing faster.
323 if (line.back() != 'o') continue;
324 if (line.rfind('@') == std::string::npos) continue;
325
326 auto spacePos = line.rfind(' ');
327 if (spacePos == std::string::npos) continue;
328 auto libFileName = line.substr(spacePos + 1);
329 auto it = infos->find(libFileName);
330 if (it == infos->end()) continue;
331 pids[libFileName].insert(pid);
332 }
333 }
334 for (auto& pair : *infos) {
335 pair.second.clientPids =
336 std::vector<pid_t>{pids[pair.first].begin(), pids[pair.first].end()};
337 }
338 }
339
340 struct PassthroughServiceManager : IServiceManager1_1 {
openLibsandroid::hardware::PassthroughServiceManager341 static void openLibs(
342 const std::string& fqName,
343 const std::function<bool /* continue */ (void* /* handle */, const std::string& /* lib */,
344 const std::string& /* sym */)>& eachLib) {
345 //fqName looks like android.hardware.foo@1.0::IFoo
346 size_t idx = fqName.find("::");
347
348 if (idx == std::string::npos ||
349 idx + strlen("::") + 1 >= fqName.size()) {
350 LOG(ERROR) << "Invalid interface name passthrough lookup: " << fqName;
351 return;
352 }
353
354 std::string packageAndVersion = fqName.substr(0, idx);
355 std::string ifaceName = fqName.substr(idx + strlen("::"));
356
357 const std::string prefix = packageAndVersion + "-impl";
358 const std::string sym = "HIDL_FETCH_" + ifaceName;
359
360 constexpr int dlMode = RTLD_LAZY;
361 void* handle = nullptr;
362
363 dlerror(); // clear
364
365 static std::string halLibPathVndkSp = details::getVndkSpHwPath();
366 std::vector<std::string> paths = {
367 HAL_LIBRARY_PATH_ODM, HAL_LIBRARY_PATH_VENDOR, halLibPathVndkSp,
368 #ifndef __ANDROID_VNDK__
369 HAL_LIBRARY_PATH_SYSTEM,
370 #endif
371 };
372
373 if (details::isTrebleTestingOverride()) {
374 // Load HAL implementations that are statically linked
375 handle = dlopen(nullptr, dlMode);
376 if (handle == nullptr) {
377 const char* error = dlerror();
378 LOG(ERROR) << "Failed to dlopen self: "
379 << (error == nullptr ? "unknown error" : error);
380 } else if (!eachLib(handle, "SELF", sym)) {
381 return;
382 }
383 }
384
385 for (const std::string& path : paths) {
386 std::vector<std::string> libs = findFiles(path, prefix, ".so");
387
388 for (const std::string &lib : libs) {
389 const std::string fullPath = path + lib;
390
391 if (kIsRecovery || path == HAL_LIBRARY_PATH_SYSTEM) {
392 handle = dlopen(fullPath.c_str(), dlMode);
393 } else {
394 #if !defined(__ANDROID_RECOVERY__) && defined(__ANDROID__)
395 handle = android_load_sphal_library(fullPath.c_str(), dlMode);
396 #endif
397 }
398
399 if (handle == nullptr) {
400 const char* error = dlerror();
401 LOG(ERROR) << "Failed to dlopen " << lib << ": "
402 << (error == nullptr ? "unknown error" : error);
403 continue;
404 }
405
406 if (!eachLib(handle, lib, sym)) {
407 return;
408 }
409 }
410 }
411 }
412
getandroid::hardware::PassthroughServiceManager413 Return<sp<IBase>> get(const hidl_string& fqName,
414 const hidl_string& name) override {
415 sp<IBase> ret = nullptr;
416
417 openLibs(fqName, [&](void* handle, const std::string &lib, const std::string &sym) {
418 IBase* (*generator)(const char* name);
419 *(void **)(&generator) = dlsym(handle, sym.c_str());
420 if(!generator) {
421 const char* error = dlerror();
422 LOG(ERROR) << "Passthrough lookup opened " << lib << " but could not find symbol "
423 << sym << ": " << (error == nullptr ? "unknown error" : error)
424 << ". Keeping library open.";
425
426 // dlclose too problematic in multi-threaded environment
427 // dlclose(handle);
428
429 return true; // continue
430 }
431
432 ret = (*generator)(name.c_str());
433
434 if (ret == nullptr) {
435 LOG(ERROR) << "Could not find instance '" << name.c_str() << "' in library " << lib
436 << ". Keeping library open.";
437
438 // dlclose too problematic in multi-threaded environment
439 // dlclose(handle);
440
441 // this module doesn't provide this particular instance
442 return true; // continue
443 }
444
445 // Actual fqname might be a subclass.
446 // This assumption is tested in vts_treble_vintf_test
447 using ::android::hardware::details::getDescriptor;
448 std::string actualFqName = getDescriptor(ret.get());
449 CHECK(actualFqName.size() > 0);
450 registerReference(actualFqName, name);
451 return false;
452 });
453
454 return ret;
455 }
456
addandroid::hardware::PassthroughServiceManager457 Return<bool> add(const hidl_string& /* name */,
458 const sp<IBase>& /* service */) override {
459 LOG(FATAL) << "Cannot register services with passthrough service manager.";
460 return false;
461 }
462
getTransportandroid::hardware::PassthroughServiceManager463 Return<Transport> getTransport(const hidl_string& /* fqName */,
464 const hidl_string& /* name */) {
465 LOG(FATAL) << "Cannot getTransport with passthrough service manager.";
466 return Transport::EMPTY;
467 }
468
listandroid::hardware::PassthroughServiceManager469 Return<void> list(list_cb /* _hidl_cb */) override {
470 LOG(FATAL) << "Cannot list services with passthrough service manager.";
471 return Void();
472 }
listByInterfaceandroid::hardware::PassthroughServiceManager473 Return<void> listByInterface(const hidl_string& /* fqInstanceName */,
474 listByInterface_cb /* _hidl_cb */) override {
475 // TODO: add this functionality
476 LOG(FATAL) << "Cannot list services with passthrough service manager.";
477 return Void();
478 }
479
registerForNotificationsandroid::hardware::PassthroughServiceManager480 Return<bool> registerForNotifications(const hidl_string& /* fqName */,
481 const hidl_string& /* name */,
482 const sp<IServiceNotification>& /* callback */) override {
483 // This makes no sense.
484 LOG(FATAL) << "Cannot register for notifications with passthrough service manager.";
485 return false;
486 }
487
debugDumpandroid::hardware::PassthroughServiceManager488 Return<void> debugDump(debugDump_cb _hidl_cb) override {
489 using Arch = ::android::hidl::base::V1_0::DebugInfo::Architecture;
490 using std::literals::string_literals::operator""s;
491 static std::string halLibPathVndkSp64 = details::getVndkSpHwPath("lib64");
492 static std::string halLibPathVndkSp32 = details::getVndkSpHwPath("lib");
493 static std::vector<std::pair<Arch, std::vector<const char*>>> sAllPaths{
494 {Arch::IS_64BIT,
495 {
496 HAL_LIBRARY_PATH_ODM_64BIT, HAL_LIBRARY_PATH_VENDOR_64BIT,
497 halLibPathVndkSp64.c_str(),
498 #ifndef __ANDROID_VNDK__
499 HAL_LIBRARY_PATH_SYSTEM_64BIT,
500 #endif
501 }},
502 {Arch::IS_32BIT,
503 {
504 HAL_LIBRARY_PATH_ODM_32BIT, HAL_LIBRARY_PATH_VENDOR_32BIT,
505 halLibPathVndkSp32.c_str(),
506 #ifndef __ANDROID_VNDK__
507 HAL_LIBRARY_PATH_SYSTEM_32BIT,
508 #endif
509 }}};
510 std::map<std::string, InstanceDebugInfo> map;
511 for (const auto &pair : sAllPaths) {
512 Arch arch = pair.first;
513 for (const auto &path : pair.second) {
514 std::vector<std::string> libs = findFiles(path, "", ".so");
515 for (const std::string &lib : libs) {
516 std::string matchedName;
517 std::string implName;
518 if (matchPackageName(lib, &matchedName, &implName)) {
519 std::string instanceName{"* ("s + path + ")"s};
520 if (!implName.empty()) instanceName += " ("s + implName + ")"s;
521 map.emplace(path + lib, InstanceDebugInfo{.interfaceName = matchedName,
522 .instanceName = instanceName,
523 .clientPids = {},
524 .arch = arch});
525 }
526 }
527 }
528 }
529 fetchPidsForPassthroughLibraries(&map);
530 hidl_vec<InstanceDebugInfo> vec;
531 vec.resize(map.size());
532 size_t idx = 0;
533 for (auto&& pair : map) {
534 vec[idx++] = std::move(pair.second);
535 }
536 _hidl_cb(vec);
537 return Void();
538 }
539
registerPassthroughClientandroid::hardware::PassthroughServiceManager540 Return<void> registerPassthroughClient(const hidl_string &, const hidl_string &) override {
541 // This makes no sense.
542 LOG(FATAL) << "Cannot call registerPassthroughClient on passthrough service manager. "
543 << "Call it on defaultServiceManager() instead.";
544 return Void();
545 }
546
unregisterForNotificationsandroid::hardware::PassthroughServiceManager547 Return<bool> unregisterForNotifications(const hidl_string& /* fqName */,
548 const hidl_string& /* name */,
549 const sp<IServiceNotification>& /* callback */) override {
550 // This makes no sense.
551 LOG(FATAL) << "Cannot unregister for notifications with passthrough service manager.";
552 return false;
553 }
554
555 };
556
getPassthroughServiceManager()557 sp<IServiceManager1_0> getPassthroughServiceManager() {
558 return getPassthroughServiceManager1_1();
559 }
getPassthroughServiceManager1_1()560 sp<IServiceManager1_1> getPassthroughServiceManager1_1() {
561 static sp<PassthroughServiceManager> manager(new PassthroughServiceManager());
562 return manager;
563 }
564
getAllHalInstanceNames(const std::string & descriptor)565 std::vector<std::string> getAllHalInstanceNames(const std::string& descriptor) {
566 std::vector<std::string> ret;
567 auto sm = defaultServiceManager1_2();
568 sm->listManifestByInterface(descriptor, [&](const auto& instances) {
569 ret.reserve(instances.size());
570 for (const auto& i : instances) {
571 ret.push_back(i);
572 }
573 });
574 return ret;
575 }
576
577 namespace details {
578
preloadPassthroughService(const std::string & descriptor)579 void preloadPassthroughService(const std::string &descriptor) {
580 PassthroughServiceManager::openLibs(descriptor,
581 [&](void* /* handle */, const std::string& /* lib */, const std::string& /* sym */) {
582 // do nothing
583 return true; // open all libs
584 });
585 }
586
587 struct Waiter : IServiceNotification {
Waiterandroid::hardware::details::Waiter588 Waiter(const std::string& interface, const std::string& instanceName,
589 const sp<IServiceManager1_1>& sm) : mInterfaceName(interface),
590 mInstanceName(instanceName), mSm(sm) {
591 }
592
onFirstRefandroid::hardware::details::Waiter593 void onFirstRef() override {
594 // If this process only has one binder thread, and we're calling wait() from
595 // that thread, it will block forever because we hung up the one and only
596 // binder thread on a condition variable that can only be notified by an
597 // incoming binder call.
598 if (IPCThreadState::self()->isOnlyBinderThread()) {
599 LOG(WARNING) << "Can't efficiently wait for " << mInterfaceName << "/"
600 << mInstanceName << ", because we are called from "
601 << "the only binder thread in this process.";
602 return;
603 }
604
605 Return<bool> ret = mSm->registerForNotifications(mInterfaceName, mInstanceName, this);
606
607 if (!ret.isOk()) {
608 LOG(ERROR) << "Transport error, " << ret.description()
609 << ", during notification registration for " << mInterfaceName << "/"
610 << mInstanceName << ".";
611 return;
612 }
613
614 if (!ret) {
615 LOG(ERROR) << "Could not register for notifications for " << mInterfaceName << "/"
616 << mInstanceName << ".";
617 return;
618 }
619
620 mRegisteredForNotifications = true;
621 }
622
~Waiterandroid::hardware::details::Waiter623 ~Waiter() {
624 if (!mDoneCalled) {
625 LOG(FATAL)
626 << "Waiter still registered for notifications, call done() before dropping ref!";
627 }
628 }
629
onRegistrationandroid::hardware::details::Waiter630 Return<void> onRegistration(const hidl_string& /* fqName */,
631 const hidl_string& /* name */,
632 bool /* preexisting */) override {
633 std::unique_lock<std::mutex> lock(mMutex);
634 if (mRegistered) {
635 return Void();
636 }
637 mRegistered = true;
638 lock.unlock();
639
640 mCondition.notify_one();
641 return Void();
642 }
643
waitandroid::hardware::details::Waiter644 void wait(bool timeout) {
645 using std::literals::chrono_literals::operator""s;
646
647 if (!mRegisteredForNotifications) {
648 // As an alternative, just sleep for a second and return
649 LOG(WARNING) << "Waiting one second for " << mInterfaceName << "/" << mInstanceName;
650 sleep(1);
651 return;
652 }
653
654 std::unique_lock<std::mutex> lock(mMutex);
655 do {
656 mCondition.wait_for(lock, 1s, [this]{
657 return mRegistered;
658 });
659
660 if (mRegistered) {
661 break;
662 }
663
664 LOG(WARNING) << "Waited one second for " << mInterfaceName << "/" << mInstanceName;
665 } while (!timeout);
666 }
667
668 // Be careful when using this; after calling reset(), you must always try to retrieve
669 // the corresponding service before blocking on the waiter; otherwise, you might run
670 // into a race-condition where the service has just (re-)registered, you clear the state
671 // here, and subsequently calling waiter->wait() will block forever.
resetandroid::hardware::details::Waiter672 void reset() {
673 std::unique_lock<std::mutex> lock(mMutex);
674 mRegistered = false;
675 }
676
677 // done() must be called before dropping the last strong ref to the Waiter, to make
678 // sure we can properly unregister with hwservicemanager.
doneandroid::hardware::details::Waiter679 void done() {
680 if (mRegisteredForNotifications) {
681 if (!mSm->unregisterForNotifications(mInterfaceName, mInstanceName, this)
682 .withDefault(false)) {
683 LOG(ERROR) << "Could not unregister service notification for " << mInterfaceName
684 << "/" << mInstanceName << ".";
685 } else {
686 mRegisteredForNotifications = false;
687 }
688 }
689 mDoneCalled = true;
690 }
691
692 private:
693 const std::string mInterfaceName;
694 const std::string mInstanceName;
695 sp<IServiceManager1_1> mSm;
696 std::mutex mMutex;
697 std::condition_variable mCondition;
698 bool mRegistered = false;
699 bool mRegisteredForNotifications = false;
700 bool mDoneCalled = false;
701 };
702
waitForHwService(const std::string & interface,const std::string & instanceName)703 void waitForHwService(
704 const std::string &interface, const std::string &instanceName) {
705 sp<Waiter> waiter = new Waiter(interface, instanceName, defaultServiceManager1_1());
706 waiter->wait(false /* timeout */);
707 waiter->done();
708 }
709
710 // Prints relevant error/warning messages for error return values from
711 // details::canCastInterface(), both transaction errors (!castReturn.isOk())
712 // as well as actual cast failures (castReturn.isOk() && castReturn = false).
713 // Returns 'true' if the error is non-fatal and it's useful to retry
handleCastError(const Return<bool> & castReturn,const std::string & descriptor,const std::string & instance)714 bool handleCastError(const Return<bool>& castReturn, const std::string& descriptor,
715 const std::string& instance) {
716 if (castReturn.isOk()) {
717 if (castReturn) {
718 details::logAlwaysFatal("Successful cast value passed into handleCastError.");
719 }
720 // This should never happen, and there's not really a point in retrying.
721 ALOGE("getService: received incompatible service (bug in hwservicemanager?) for "
722 "%s/%s.", descriptor.c_str(), instance.c_str());
723 return false;
724 }
725 if (castReturn.isDeadObject()) {
726 ALOGW("getService: found dead hwbinder service for %s/%s.", descriptor.c_str(),
727 instance.c_str());
728 return true;
729 }
730 // This can happen due to:
731 // 1) No SELinux permissions
732 // 2) Other transaction failure (no buffer space, kernel error)
733 // The first isn't recoverable, but the second is.
734 // Since we can't yet differentiate between the two, and clients depend
735 // on us not blocking in case 1), treat this as a fatal error for now.
736 ALOGW("getService: unable to call into hwbinder service for %s/%s.",
737 descriptor.c_str(), instance.c_str());
738 return false;
739 }
740
getRawServiceInternal(const std::string & descriptor,const std::string & instance,bool retry,bool getStub)741 sp<::android::hidl::base::V1_0::IBase> getRawServiceInternal(const std::string& descriptor,
742 const std::string& instance,
743 bool retry, bool getStub) {
744 using Transport = IServiceManager1_0::Transport;
745 sp<Waiter> waiter;
746
747 sp<IServiceManager1_1> sm;
748 Transport transport = Transport::EMPTY;
749 if (kIsRecovery) {
750 transport = Transport::PASSTHROUGH;
751 } else {
752 sm = defaultServiceManager1_1();
753 if (sm == nullptr) {
754 ALOGE("getService: defaultServiceManager() is null");
755 return nullptr;
756 }
757
758 Return<Transport> transportRet = sm->getTransport(descriptor, instance);
759
760 if (!transportRet.isOk()) {
761 ALOGE("getService: defaultServiceManager()->getTransport returns %s",
762 transportRet.description().c_str());
763 return nullptr;
764 }
765 transport = transportRet;
766 }
767
768 const bool vintfHwbinder = (transport == Transport::HWBINDER);
769 const bool vintfPassthru = (transport == Transport::PASSTHROUGH);
770 const bool trebleTestingOverride = isTrebleTestingOverride();
771 const bool allowLegacy = !kEnforceVintfManifest || (trebleTestingOverride && isDebuggable());
772 const bool vintfLegacy = (transport == Transport::EMPTY) && allowLegacy;
773
774 if (!kEnforceVintfManifest) {
775 ALOGE("getService: Potential race detected. The VINTF manifest is not being enforced. If "
776 "a HAL server has a delay in starting and it is not in the manifest, it will not be "
777 "retrieved. Please make sure all HALs on this device are in the VINTF manifest and "
778 "enable PRODUCT_ENFORCE_VINTF_MANIFEST on this device (this is also enabled by "
779 "PRODUCT_FULL_TREBLE). PRODUCT_ENFORCE_VINTF_MANIFEST will ensure that no race "
780 "condition is possible here.");
781 sleep(1);
782 }
783
784 for (int tries = 0; !getStub && (vintfHwbinder || vintfLegacy); tries++) {
785 if (waiter == nullptr && tries > 0) {
786 waiter = new Waiter(descriptor, instance, sm);
787 }
788 if (waiter != nullptr) {
789 waiter->reset(); // don't reorder this -- see comments on reset()
790 }
791 Return<sp<IBase>> ret = sm->get(descriptor, instance);
792 if (!ret.isOk()) {
793 ALOGE("getService: defaultServiceManager()->get returns %s for %s/%s.",
794 ret.description().c_str(), descriptor.c_str(), instance.c_str());
795 break;
796 }
797 sp<IBase> base = ret;
798 if (base != nullptr) {
799 Return<bool> canCastRet =
800 details::canCastInterface(base.get(), descriptor.c_str(), true /* emitError */);
801
802 if (canCastRet.isOk() && canCastRet) {
803 if (waiter != nullptr) {
804 waiter->done();
805 }
806 return base; // still needs to be wrapped by Bp class.
807 }
808
809 if (!handleCastError(canCastRet, descriptor, instance)) break;
810 }
811
812 // In case of legacy or we were not asked to retry, don't.
813 if (vintfLegacy || !retry) break;
814
815 if (waiter != nullptr) {
816 ALOGI("getService: Trying again for %s/%s...", descriptor.c_str(), instance.c_str());
817 waiter->wait(true /* timeout */);
818 }
819 }
820
821 if (waiter != nullptr) {
822 waiter->done();
823 }
824
825 if (getStub || vintfPassthru || vintfLegacy) {
826 const sp<IServiceManager1_0> pm = getPassthroughServiceManager();
827 if (pm != nullptr) {
828 sp<IBase> base = pm->get(descriptor, instance).withDefault(nullptr);
829 if (!getStub || trebleTestingOverride) {
830 base = wrapPassthrough(base);
831 }
832 return base;
833 }
834 }
835
836 return nullptr;
837 }
838
registerAsServiceInternal(const sp<IBase> & service,const std::string & name)839 status_t registerAsServiceInternal(const sp<IBase>& service, const std::string& name) {
840 if (service == nullptr) {
841 return UNEXPECTED_NULL;
842 }
843
844 sp<IServiceManager1_2> sm = defaultServiceManager1_2();
845 if (sm == nullptr) {
846 return INVALID_OPERATION;
847 }
848
849 const std::string descriptor = getDescriptor(service.get());
850
851 if (kEnforceVintfManifest && !isTrebleTestingOverride()) {
852 using Transport = IServiceManager1_0::Transport;
853 Return<Transport> transport = sm->getTransport(descriptor, name);
854
855 if (!transport.isOk()) {
856 LOG(ERROR) << "Could not get transport for " << descriptor << "/" << name << ": "
857 << transport.description();
858 return UNKNOWN_ERROR;
859 }
860
861 if (transport != Transport::HWBINDER) {
862 LOG(ERROR) << "Service " << descriptor << "/" << name
863 << " must be in VINTF manifest in order to register/get.";
864 return UNKNOWN_ERROR;
865 }
866 }
867
868 bool registered = false;
869 Return<void> ret = service->interfaceChain([&](const auto& chain) {
870 registered = sm->addWithChain(name.c_str(), service, chain).withDefault(false);
871 });
872
873 if (!ret.isOk()) {
874 LOG(ERROR) << "Could not retrieve interface chain: " << ret.description();
875 }
876
877 if (registered) {
878 onRegistrationImpl(descriptor, name);
879 }
880
881 return registered ? OK : UNKNOWN_ERROR;
882 }
883
884 } // namespace details
885
886 } // namespace hardware
887 } // namespace android
888