xref: /aosp_15_r20/frameworks/native/libs/binder/ndk/tests/libbinder_ndk_unit_test.cpp (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)

/*
 * Copyright (C) 2018 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 <IBinderNdkUnitTest.h>
#include <aidl/BnBinderNdkUnitTest.h>
#include <aidl/BnEmpty.h>
#include <android-base/logging.h>
#include <android/binder_ibinder_jni.h>
#include <android/binder_ibinder_platform.h>
#include <android/binder_libbinder.h>
#include <android/binder_manager.h>
#include <android/binder_process.h>
#include <gtest/gtest.h>
#include <iface/iface.h>
#include <utils/Looper.h>

// warning: this is assuming that libbinder_ndk is using the same copy
// of libbinder that we are.
#include <binder/IPCThreadState.h>
#include <binder/IResultReceiver.h>
#include <binder/IServiceManager.h>
#include <binder/IShellCallback.h>
#include <sys/prctl.h>
#include <sys/socket.h>

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <mutex>
#include <thread>

#include "../Utils.h"
#include "android/binder_ibinder.h"

using namespace android;
using namespace std::chrono_literals;

constexpr char kExistingNonNdkService[] = "SurfaceFlinger";
constexpr char kBinderNdkUnitTestService[] = "BinderNdkUnitTest";
constexpr char kLazyBinderNdkUnitTestService[] = "LazyBinderNdkUnitTest";
constexpr char kForcePersistNdkUnitTestService[] = "ForcePersistNdkUnitTestService";
constexpr char kActiveServicesNdkUnitTestService[] = "ActiveServicesNdkUnitTestService";
constexpr char kBinderNdkUnitTestServiceFlagged[] = "BinderNdkUnitTestFlagged";

constexpr auto kShutdownWaitTime = 30s;
constexpr uint64_t kContextTestValue = 0xb4e42fb4d9a1d715;

class MyTestFoo : public IFoo {
    binder_status_t doubleNumber(int32_t in, int32_t* out) override {
        *out = 2 * in;
        LOG(INFO) << "doubleNumber (" << in << ") => " << *out;
        return STATUS_OK;
    }
    binder_status_t die() override {
        ADD_FAILURE() << "die called on local instance";
        return STATUS_OK;
    }
};

class MyBinderNdkUnitTest : public aidl::BnBinderNdkUnitTest {
    ndk::ScopedAStatus repeatInt(int32_t in, int32_t* out) override {
        *out = in;
        return ndk::ScopedAStatus::ok();
    }
    ndk::ScopedAStatus takeInterface(const std::shared_ptr<aidl::IEmpty>& empty) override {
        (void)empty;
        return ndk::ScopedAStatus::ok();
    }
    ndk::ScopedAStatus forceFlushCommands() override {
        // warning: this is assuming that libbinder_ndk is using the same copy
        // of libbinder that we are.
        android::IPCThreadState::self()->flushCommands();
        return ndk::ScopedAStatus::ok();
    }
    ndk::ScopedAStatus getsRequestedSid(bool* out) override {
        const char* sid = AIBinder_getCallingSid();
        std::cout << "Got security context: " << (sid ?: "null") << std::endl;
        *out = sid != nullptr;
        return ndk::ScopedAStatus::ok();
    }
    binder_status_t handleShellCommand(int /*in*/, int out, int /*err*/, const char** args,
                                       uint32_t numArgs) override {
        for (uint32_t i = 0; i < numArgs; i++) {
            dprintf(out, "%s", args[i]);
        }
        fsync(out);
        return STATUS_OK;
    }
    ndk::ScopedAStatus forcePersist(bool persist) override {
        AServiceManager_forceLazyServicesPersist(persist);
        return ndk::ScopedAStatus::ok();
    }
    ndk::ScopedAStatus setCustomActiveServicesCallback() override {
        AServiceManager_setActiveServicesCallback(activeServicesCallback, this);
        return ndk::ScopedAStatus::ok();
    }
    static bool activeServicesCallback(bool hasClients, void* context) {
        if (hasClients) {
            LOG(INFO) << "hasClients, so not unregistering.";
            return false;
        }

        // Unregister all services
        if (!AServiceManager_tryUnregister()) {
            LOG(INFO) << "Could not unregister service the first time.";
            // Prevent shutdown (test will fail)
            return false;
        }

        // Re-register all services
        AServiceManager_reRegister();

        // Unregister again before shutdown
        if (!AServiceManager_tryUnregister()) {
            LOG(INFO) << "Could not unregister service the second time.";
            // Prevent shutdown (test will fail)
            return false;
        }

        // Check if the context was passed correctly
        MyBinderNdkUnitTest* service = static_cast<MyBinderNdkUnitTest*>(context);
        if (service->contextTestValue != kContextTestValue) {
            LOG(INFO) << "Incorrect context value.";
            // Prevent shutdown (test will fail)
            return false;
        }

        exit(EXIT_SUCCESS);
        // Unreachable
    }

    uint64_t contextTestValue = kContextTestValue;
};

int generatedService() {
    ABinderProcess_setThreadPoolMaxThreadCount(0);

    auto service = ndk::SharedRefBase::make<MyBinderNdkUnitTest>();
    auto binder = service->asBinder();

    AIBinder_setRequestingSid(binder.get(), true);

    binder_exception_t exception =
            AServiceManager_addService(binder.get(), kBinderNdkUnitTestService);

    if (exception != EX_NONE) {
        LOG(FATAL) << "Could not register: " << exception << " " << kBinderNdkUnitTestService;
    }

    ABinderProcess_joinThreadPool();

    return 1;  // should not return
}

int generatedFlaggedService(const AServiceManager_AddServiceFlag flags, const char* instance) {
    ABinderProcess_setThreadPoolMaxThreadCount(0);

    auto service = ndk::SharedRefBase::make<MyBinderNdkUnitTest>();
    auto binder = service->asBinder();

    binder_exception_t exception =
            AServiceManager_addServiceWithFlags(binder.get(), instance, flags);

    if (exception != EX_NONE) {
        LOG(FATAL) << "Could not register: " << exception << " " << instance;
    }

    ABinderProcess_joinThreadPool();

    return 1;  // should not return
}

// manually-written parceling class considered bad practice
class MyFoo : public IFoo {
    binder_status_t doubleNumber(int32_t in, int32_t* out) override {
        *out = 2 * in;
        LOG(INFO) << "doubleNumber (" << in << ") => " << *out;
        return STATUS_OK;
    }

    binder_status_t die() override {
        LOG(FATAL) << "IFoo::die called!";
        return STATUS_UNKNOWN_ERROR;
    }
};

void manualService(const char* instance) {
    // Strong reference to MyFoo kept by service manager.
    binder_exception_t exception = (new MyFoo)->addService(instance);

    if (exception != EX_NONE) {
        LOG(FATAL) << "Could not register: " << exception << " " << instance;
    }
}
int manualPollingService(const char* instance) {
    int fd;
    CHECK(STATUS_OK == ABinderProcess_setupPolling(&fd));
    manualService(instance);

    class Handler : public LooperCallback {
        int handleEvent(int /*fd*/, int /*events*/, void* /*data*/) override {
            ABinderProcess_handlePolledCommands();
            return 1;  // Continue receiving callbacks.
        }
    };

    sp<Looper> looper = Looper::prepare(0 /* opts */);
    looper->addFd(fd, Looper::POLL_CALLBACK, Looper::EVENT_INPUT, new Handler(), nullptr /*data*/);
    // normally, would add additional fds
    while (true) {
        looper->pollAll(-1 /* timeoutMillis */);
    }
    return 1;  // should not reach
}
int manualThreadPoolService(const char* instance) {
    ABinderProcess_setThreadPoolMaxThreadCount(0);
    manualService(instance);
    ABinderProcess_joinThreadPool();
    return 1;
}

int lazyService(const char* instance) {
    ABinderProcess_setThreadPoolMaxThreadCount(0);
    // Wait to register this service to make sure the main test process will
    // actually wait for the service to be available. Tested with sleep(60),
    // and reduced for sake of time.
    sleep(1);
    // Strong reference to MyBinderNdkUnitTest kept by service manager.
    // This is just for testing, it has no corresponding init behavior.
    auto service = ndk::SharedRefBase::make<MyBinderNdkUnitTest>();
    auto binder = service->asBinder();

    binder_status_t status = AServiceManager_registerLazyService(binder.get(), instance);
    if (status != STATUS_OK) {
        LOG(FATAL) << "Could not register: " << status << " " << instance;
    }

    ABinderProcess_joinThreadPool();

    return 1;  // should not return
}

bool isServiceRunning(const char* serviceName) {
    static const sp<android::IServiceManager> sm(android::defaultServiceManager());
    const Vector<String16> services = sm->listServices();
    for (const auto service : services) {
        if (service == String16(serviceName)) return true;
    }
    return false;
}

bool isServiceShutdownWithWait(const char* serviceName) {
    LOG(INFO) << "About to check and wait for shutdown of " << std::string(serviceName);
    const auto before = std::chrono::steady_clock::now();
    while (isServiceRunning(serviceName)) {
        sleep(1);
        const auto after = std::chrono::steady_clock::now();
        if (after - before >= kShutdownWaitTime) return false;
    }
    return true;
}

TEST(NdkBinder, DetectDoubleOwn) {
    auto badService = ndk::SharedRefBase::make<MyBinderNdkUnitTest>();
    EXPECT_DEATH(std::shared_ptr<MyBinderNdkUnitTest>(badService.get()),
                 "Is this object double-owned?");
}

TEST(NdkBinder, DetectNoSharedRefBaseCreated) {
    EXPECT_DEATH(MyBinderNdkUnitTest(), "SharedRefBase: no ref created during lifetime");
}

TEST(NdkBinder, GetServiceThatDoesntExist) {
    sp<IFoo> foo = IFoo::getService("asdfghkl;");
    EXPECT_EQ(nullptr, foo.get());
}

TEST(NdkBinder, CheckServiceThatDoesntExist) {
    AIBinder* binder = AServiceManager_checkService("asdfghkl;");
    ASSERT_EQ(nullptr, binder);
}

TEST(NdkBinder, CheckServiceThatDoesExist) {
    AIBinder* binder = AServiceManager_checkService(kExistingNonNdkService);
    ASSERT_NE(nullptr, binder) << "Could not get " << kExistingNonNdkService;
    EXPECT_EQ(STATUS_OK, AIBinder_ping(binder)) << "Could not ping " << kExistingNonNdkService;

    AIBinder_decStrong(binder);
}

struct ServiceData {
    std::string instance;
    ndk::SpAIBinder binder;

    static void fillOnRegister(const char* instance, AIBinder* binder, void* cookie) {
        ServiceData* d = reinterpret_cast<ServiceData*>(cookie);
        d->instance = instance;
        d->binder = ndk::SpAIBinder(binder);
    }
};

TEST(NdkBinder, RegisterForServiceNotificationsNonExisting) {
    ServiceData data;
    auto* notif = AServiceManager_registerForServiceNotifications(
            "DOES_NOT_EXIST", ServiceData::fillOnRegister, (void*)&data);
    ASSERT_NE(notif, nullptr);

    sleep(1);  // give us a chance to fail
    AServiceManager_NotificationRegistration_delete(notif);

    // checking after deleting to avoid needing a mutex over the data - otherwise
    // in an environment w/ multiple threads, you would need to guard access
    EXPECT_EQ(data.instance, "");
    EXPECT_EQ(data.binder, nullptr);
}

TEST(NdkBinder, RegisterForServiceNotificationsExisting) {
    ServiceData data;
    auto* notif = AServiceManager_registerForServiceNotifications(
            kExistingNonNdkService, ServiceData::fillOnRegister, (void*)&data);
    ASSERT_NE(notif, nullptr);

    sleep(1);  // give us a chance to fail
    AServiceManager_NotificationRegistration_delete(notif);

    // checking after deleting to avoid needing a mutex over the data - otherwise
    // in an environment w/ multiple threads, you would need to guard access
    EXPECT_EQ(data.instance, kExistingNonNdkService);
    EXPECT_EQ(data.binder, ndk::SpAIBinder(AServiceManager_checkService(kExistingNonNdkService)));
}

TEST(NdkBinder, UnimplementedDump) {
    ndk::SpAIBinder binder;
    sp<IFoo> foo = IFoo::getService(IFoo::kSomeInstanceName, binder.getR());
    ASSERT_NE(foo, nullptr);
    EXPECT_EQ(OK, AIBinder_dump(binder.get(), STDOUT_FILENO, nullptr, 0));
}

TEST(NdkBinder, UnimplementedShell) {
    // libbinder_ndk doesn't support calling shell, so we are calling from the
    // libbinder across processes to the NDK service which doesn't implement
    // shell
    static const sp<android::IServiceManager> sm(android::defaultServiceManager());
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    sp<IBinder> testService = sm->getService(String16(IFoo::kSomeInstanceName));
    LIBBINDER_IGNORE_END()

    Vector<String16> argsVec;
    EXPECT_EQ(OK, IBinder::shellCommand(testService, STDIN_FILENO, STDOUT_FILENO, STDERR_FILENO,
                                        argsVec, nullptr, nullptr));
}

TEST(NdkBinder, DoubleNumber) {
    sp<IFoo> foo = IFoo::getService(IFoo::kSomeInstanceName);
    ASSERT_NE(foo, nullptr);

    int32_t out;
    EXPECT_EQ(STATUS_OK, foo->doubleNumber(1, &out));
    EXPECT_EQ(2, out);
}

TEST(NdkBinder, ReassociateBpBinderWithSameDescriptor) {
    ndk::SpAIBinder binder;
    sp<IFoo> foo = IFoo::getService(IFoo::kSomeInstanceName, binder.getR());

    EXPECT_TRUE(AIBinder_isRemote(binder.get()));

    EXPECT_TRUE(AIBinder_associateClass(binder.get(), IFoo::kClassDupe));
}

TEST(NdkBinder, CantHaveTwoLocalBinderClassesWithSameDescriptor) {
    sp<IFoo> foo = sp<MyTestFoo>::make();
    ndk::SpAIBinder binder(foo->getBinder());

    EXPECT_FALSE(AIBinder_isRemote(binder.get()));

    EXPECT_FALSE(AIBinder_associateClass(binder.get(), IFoo::kClassDupe));
}

TEST(NdkBinder, GetTestServiceStressTest) {
    constexpr size_t kNumThreads = 10;
    constexpr size_t kNumCalls = 1000;
    std::vector<std::thread> threads;

    // this is not a lazy service, but we must make sure that it's started before calling
    // checkService on it, since the other process serving it might not be started yet.
    {
        // getService, not waitForService, to take advantage of timeout
        LIBBINDER_IGNORE("-Wdeprecated-declarations")
        auto binder = ndk::SpAIBinder(AServiceManager_getService(IFoo::kSomeInstanceName));
        LIBBINDER_IGNORE_END()
        ASSERT_NE(nullptr, binder.get());
    }

    for (size_t i = 0; i < kNumThreads; i++) {
        threads.push_back(std::thread([&]() {
            for (size_t j = 0; j < kNumCalls; j++) {
                auto binder =
                        ndk::SpAIBinder(AServiceManager_checkService(IFoo::kSomeInstanceName));
                ASSERT_NE(nullptr, binder.get());
                EXPECT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
            }
        }));
    }

    for (auto& thread : threads) thread.join();
}

void defaultInstanceCounter(const char* instance, void* context) {
    if (strcmp(instance, "default") == 0) {
        ++*(size_t*)(context);
    }
}

TEST(NdkBinder, GetDeclaredInstances) {
    bool hasLight = AServiceManager_isDeclared("android.hardware.light.ILights/default");

    size_t count;
    AServiceManager_forEachDeclaredInstance("android.hardware.light.ILights", &count,
                                            defaultInstanceCounter);

    // At the time of writing this test, there is no good interface guaranteed
    // to be on all devices. Cuttlefish has light, so this will generally test
    // things.
    EXPECT_EQ(count, hasLight ? 1u : 0u);
}

TEST(NdkBinder, GetLazyService) {
    // Not declared in the vintf manifest
    ASSERT_FALSE(AServiceManager_isDeclared(kLazyBinderNdkUnitTestService));
    ndk::SpAIBinder binder(AServiceManager_waitForService(kLazyBinderNdkUnitTestService));
    std::shared_ptr<aidl::IBinderNdkUnitTest> service =
            aidl::IBinderNdkUnitTest::fromBinder(binder);
    ASSERT_NE(service, nullptr);

    EXPECT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
}

// This is too slow
TEST(NdkBinder, CheckLazyServiceShutDown) {
    ndk::SpAIBinder binder(AServiceManager_waitForService(kLazyBinderNdkUnitTestService));
    std::shared_ptr<aidl::IBinderNdkUnitTest> service =
            aidl::IBinderNdkUnitTest::fromBinder(binder);
    ASSERT_NE(service, nullptr);

    EXPECT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
    binder = nullptr;
    service = nullptr;
    IPCThreadState::self()->flushCommands();
    // Make sure the service is dead after some time of no use
    ASSERT_TRUE(isServiceShutdownWithWait(kLazyBinderNdkUnitTestService))
            << "Service failed to shut down";
}

TEST(NdkBinder, ForcedPersistenceTest) {
    for (int i = 0; i < 2; i++) {
        ndk::SpAIBinder binder(AServiceManager_waitForService(kForcePersistNdkUnitTestService));
        std::shared_ptr<aidl::IBinderNdkUnitTest> service =
                aidl::IBinderNdkUnitTest::fromBinder(binder);
        ASSERT_NE(service, nullptr);
        ASSERT_TRUE(service->forcePersist(i == 0).isOk());

        binder = nullptr;
        service = nullptr;
        IPCThreadState::self()->flushCommands();

        if (i == 0) {
            ASSERT_TRUE(isServiceRunning(kForcePersistNdkUnitTestService))
                    << "Service shut down when it shouldn't have.";
        } else {
            ASSERT_TRUE(isServiceShutdownWithWait(kForcePersistNdkUnitTestService))
                    << "Service failed to shut down";
        }
    }
}

TEST(NdkBinder, ActiveServicesCallbackTest) {
    LOG(INFO) << "ActiveServicesCallbackTest starting";

    ndk::SpAIBinder binder(AServiceManager_waitForService(kActiveServicesNdkUnitTestService));
    std::shared_ptr<aidl::IBinderNdkUnitTest> service =
            aidl::IBinderNdkUnitTest::fromBinder(binder);
    ASSERT_NE(service, nullptr);
    ASSERT_TRUE(service->setCustomActiveServicesCallback().isOk());

    binder = nullptr;
    service = nullptr;
    IPCThreadState::self()->flushCommands();

    ASSERT_TRUE(isServiceShutdownWithWait(kActiveServicesNdkUnitTestService))
            << "Service failed to shut down.";
}

struct DeathRecipientCookie {
    std::function<void(void)>*onDeath, *onUnlink;

    // may contain additional data
    // - if it contains AIBinder, then you must call AIBinder_unlinkToDeath manually,
    //   because it would form a strong reference cycle
    // - if it points to a data member of another structure, this should have a weak
    //   promotable reference or a strong reference, in case that object is deleted
    //   while the death recipient is firing
};
void LambdaOnDeath(void* cookie) {
    auto funcs = static_cast<DeathRecipientCookie*>(cookie);

    // may reference other cookie members

    (*funcs->onDeath)();
}
void LambdaOnUnlink(void* cookie) {
    auto funcs = static_cast<DeathRecipientCookie*>(cookie);
    (*funcs->onUnlink)();

    // may reference other cookie members

    delete funcs;
}
TEST(NdkBinder, DeathRecipient) {
    using namespace std::chrono_literals;

    AIBinder* binder;
    sp<IFoo> foo = IFoo::getService(IFoo::kInstanceNameToDieFor, &binder);
    ASSERT_NE(nullptr, foo.get());
    ASSERT_NE(nullptr, binder);

    std::mutex deathMutex;
    std::condition_variable deathCv;
    bool deathReceived = false;

    std::function<void(void)> onDeath = [&] {
        std::unique_lock<std::mutex> lockDeath(deathMutex);
        std::cerr << "Binder died (as requested)." << std::endl;
        deathReceived = true;
        deathCv.notify_one();
    };

    std::mutex unlinkMutex;
    std::condition_variable unlinkCv;
    bool unlinkReceived = false;
    bool wasDeathReceivedFirst = false;

    std::function<void(void)> onUnlink = [&] {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        std::cerr << "Binder unlinked (as requested)." << std::endl;
        wasDeathReceivedFirst = deathReceived;
        unlinkReceived = true;
        unlinkCv.notify_one();
    };

    DeathRecipientCookie* cookie = new DeathRecipientCookie{&onDeath, &onUnlink};

    AIBinder_DeathRecipient* recipient = AIBinder_DeathRecipient_new(LambdaOnDeath);
    AIBinder_DeathRecipient_setOnUnlinked(recipient, LambdaOnUnlink);

    EXPECT_EQ(STATUS_OK, AIBinder_linkToDeath(binder, recipient, static_cast<void*>(cookie)));

    EXPECT_EQ(STATUS_DEAD_OBJECT, foo->die());

    foo = nullptr;

    std::unique_lock<std::mutex> lockDeath(deathMutex);
    EXPECT_TRUE(deathCv.wait_for(lockDeath, 1s, [&] { return deathReceived; }));
    EXPECT_TRUE(deathReceived);

    std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
    EXPECT_TRUE(deathCv.wait_for(lockUnlink, 1s, [&] { return unlinkReceived; }));
    EXPECT_TRUE(unlinkReceived);
    EXPECT_TRUE(wasDeathReceivedFirst);

    AIBinder_DeathRecipient_delete(recipient);
    AIBinder_decStrong(binder);
    binder = nullptr;
}

TEST(NdkBinder, DeathRecipientDropBinderNoDeath) {
    using namespace std::chrono_literals;

    std::mutex deathMutex;
    std::condition_variable deathCv;
    bool deathReceived = false;

    std::function<void(void)> onDeath = [&] {
        std::unique_lock<std::mutex> lockDeath(deathMutex);
        std::cerr << "Binder died (as requested)." << std::endl;
        deathReceived = true;
        deathCv.notify_one();
    };

    std::mutex unlinkMutex;
    std::condition_variable unlinkCv;
    bool unlinkReceived = false;
    bool wasDeathReceivedFirst = false;

    std::function<void(void)> onUnlink = [&] {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        std::cerr << "Binder unlinked (as requested)." << std::endl;
        wasDeathReceivedFirst = deathReceived;
        unlinkReceived = true;
        unlinkCv.notify_one();
    };

    // keep the death recipient around
    ndk::ScopedAIBinder_DeathRecipient recipient(AIBinder_DeathRecipient_new(LambdaOnDeath));
    AIBinder_DeathRecipient_setOnUnlinked(recipient.get(), LambdaOnUnlink);

    {
        AIBinder* binder;
        sp<IFoo> foo = IFoo::getService(IFoo::kInstanceNameToDieFor2, &binder);
        ASSERT_NE(nullptr, foo.get());
        ASSERT_NE(nullptr, binder);

        DeathRecipientCookie* cookie = new DeathRecipientCookie{&onDeath, &onUnlink};

        EXPECT_EQ(STATUS_OK,
                  AIBinder_linkToDeath(binder, recipient.get(), static_cast<void*>(cookie)));
        // let the sp<IFoo> and AIBinder fall out of scope
        AIBinder_decStrong(binder);
        binder = nullptr;
    }

    {
        std::unique_lock<std::mutex> lockDeath(deathMutex);
        EXPECT_FALSE(deathCv.wait_for(lockDeath, 100ms, [&] { return deathReceived; }));
        EXPECT_FALSE(deathReceived);
    }

    {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        EXPECT_TRUE(deathCv.wait_for(lockUnlink, 1s, [&] { return unlinkReceived; }));
        EXPECT_TRUE(unlinkReceived);
        EXPECT_FALSE(wasDeathReceivedFirst);
    }
}

TEST(NdkBinder, DeathRecipientDropBinderOnDied) {
    using namespace std::chrono_literals;

    std::mutex deathMutex;
    std::condition_variable deathCv;
    bool deathReceived = false;

    sp<IFoo> foo;
    AIBinder* binder;
    std::function<void(void)> onDeath = [&] {
        std::unique_lock<std::mutex> lockDeath(deathMutex);
        std::cerr << "Binder died (as requested)." << std::endl;
        deathReceived = true;
        AIBinder_decStrong(binder);
        binder = nullptr;
        deathCv.notify_one();
    };

    std::mutex unlinkMutex;
    std::condition_variable unlinkCv;
    bool unlinkReceived = false;
    bool wasDeathReceivedFirst = false;

    std::function<void(void)> onUnlink = [&] {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        std::cerr << "Binder unlinked (as requested)." << std::endl;
        wasDeathReceivedFirst = deathReceived;
        unlinkReceived = true;
        unlinkCv.notify_one();
    };

    ndk::ScopedAIBinder_DeathRecipient recipient(AIBinder_DeathRecipient_new(LambdaOnDeath));
    AIBinder_DeathRecipient_setOnUnlinked(recipient.get(), LambdaOnUnlink);

    foo = IFoo::getService(IFoo::kInstanceNameToDieFor2, &binder);
    ASSERT_NE(nullptr, foo.get());
    ASSERT_NE(nullptr, binder);

    DeathRecipientCookie* cookie = new DeathRecipientCookie{&onDeath, &onUnlink};
    EXPECT_EQ(STATUS_OK, AIBinder_linkToDeath(binder, recipient.get(), static_cast<void*>(cookie)));

    EXPECT_EQ(STATUS_DEAD_OBJECT, foo->die());

    {
        std::unique_lock<std::mutex> lockDeath(deathMutex);
        EXPECT_TRUE(deathCv.wait_for(lockDeath, 1s, [&] { return deathReceived; }));
        EXPECT_TRUE(deathReceived);
    }

    {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        EXPECT_TRUE(deathCv.wait_for(lockUnlink, 100ms, [&] { return unlinkReceived; }));
        EXPECT_TRUE(unlinkReceived);
        EXPECT_TRUE(wasDeathReceivedFirst);
    }
}

void LambdaOnUnlinkMultiple(void* cookie) {
    auto funcs = static_cast<DeathRecipientCookie*>(cookie);
    (*funcs->onUnlink)();
}

TEST(NdkBinder, DeathRecipientMultipleLinks) {
    using namespace std::chrono_literals;

    ndk::SpAIBinder binder;
    sp<IFoo> foo = IFoo::getService(IFoo::kSomeInstanceName, binder.getR());
    ASSERT_NE(nullptr, foo.get());
    ASSERT_NE(nullptr, binder);

    std::function<void(void)> onDeath = [&] {};

    std::mutex unlinkMutex;
    std::condition_variable unlinkCv;
    bool unlinkReceived = false;
    constexpr uint32_t kNumberOfLinksToDeath = 4;
    uint32_t countdown = kNumberOfLinksToDeath;

    std::function<void(void)> onUnlink = [&] {
        std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
        countdown--;
        if (countdown == 0) {
            unlinkReceived = true;
            unlinkCv.notify_one();
        }
    };

    DeathRecipientCookie* cookie = new DeathRecipientCookie{&onDeath, &onUnlink};

    ndk::ScopedAIBinder_DeathRecipient recipient(AIBinder_DeathRecipient_new(LambdaOnDeath));
    AIBinder_DeathRecipient_setOnUnlinked(recipient.get(), LambdaOnUnlinkMultiple);

    for (uint32_t i = 0; i < kNumberOfLinksToDeath; i++) {
        EXPECT_EQ(STATUS_OK,
                  AIBinder_linkToDeath(binder.get(), recipient.get(), static_cast<void*>(cookie)));
    }

    foo = nullptr;
    binder = nullptr;

    std::unique_lock<std::mutex> lockUnlink(unlinkMutex);
    EXPECT_TRUE(unlinkCv.wait_for(lockUnlink, 5s, [&] { return unlinkReceived; }))
            << "countdown: " << countdown;
    EXPECT_TRUE(unlinkReceived);
    EXPECT_EQ(countdown, 0u);
}

TEST(NdkBinder, RetrieveNonNdkService) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    AIBinder* binder = AServiceManager_getService(kExistingNonNdkService);
    LIBBINDER_IGNORE_END()
    ASSERT_NE(nullptr, binder);
    EXPECT_TRUE(AIBinder_isRemote(binder));
    EXPECT_TRUE(AIBinder_isAlive(binder));
    EXPECT_EQ(STATUS_OK, AIBinder_ping(binder));

    AIBinder_decStrong(binder);
}

void OnBinderDeath(void* cookie) {
    LOG(ERROR) << "BINDER DIED. COOKIE: " << cookie;
}

TEST(NdkBinder, LinkToDeath) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    AIBinder* binder = AServiceManager_getService(kExistingNonNdkService);
    LIBBINDER_IGNORE_END()
    ASSERT_NE(nullptr, binder);

    AIBinder_DeathRecipient* recipient = AIBinder_DeathRecipient_new(OnBinderDeath);
    ASSERT_NE(nullptr, recipient);

    EXPECT_EQ(STATUS_OK, AIBinder_linkToDeath(binder, recipient, nullptr));
    EXPECT_EQ(STATUS_OK, AIBinder_linkToDeath(binder, recipient, nullptr));
    EXPECT_EQ(STATUS_OK, AIBinder_unlinkToDeath(binder, recipient, nullptr));
    EXPECT_EQ(STATUS_OK, AIBinder_unlinkToDeath(binder, recipient, nullptr));
    EXPECT_EQ(STATUS_NAME_NOT_FOUND, AIBinder_unlinkToDeath(binder, recipient, nullptr));

    AIBinder_DeathRecipient_delete(recipient);
    AIBinder_decStrong(binder);
}

TEST(NdkBinder, SetInheritRt) {
    // functional test in binderLibTest
    sp<IFoo> foo = sp<MyTestFoo>::make();
    AIBinder* binder = foo->getBinder();

    // does not abort
    AIBinder_setInheritRt(binder, true);
    AIBinder_setInheritRt(binder, false);
    AIBinder_setInheritRt(binder, true);

    AIBinder_decStrong(binder);
}

TEST(NdkBinder, SetInheritRtNonLocal) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    AIBinder* binder = AServiceManager_getService(kExistingNonNdkService);
    LIBBINDER_IGNORE_END()
    ASSERT_NE(binder, nullptr);

    ASSERT_TRUE(AIBinder_isRemote(binder));

    EXPECT_DEATH(AIBinder_setInheritRt(binder, true), "");
    EXPECT_DEATH(AIBinder_setInheritRt(binder, false), "");

    AIBinder_decStrong(binder);
}

TEST(NdkBinder, AddNullService) {
    EXPECT_EQ(EX_ILLEGAL_ARGUMENT, AServiceManager_addService(nullptr, "any-service-name"));
}

TEST(NdkBinder, AddInvalidServiceName) {
    sp<IFoo> foo = new MyTestFoo;
    EXPECT_EQ(EX_ILLEGAL_ARGUMENT, foo->addService("!@#$%^&"));
}

TEST(NdkBinder, GetServiceInProcess) {
    static const char* kInstanceName = "test-get-service-in-process";

    sp<IFoo> foo = new MyTestFoo;
    EXPECT_EQ(EX_NONE, foo->addService(kInstanceName));

    ndk::SpAIBinder binder;
    sp<IFoo> getFoo = IFoo::getService(kInstanceName, binder.getR());
    EXPECT_EQ(foo.get(), getFoo.get());

    int32_t out;
    EXPECT_EQ(STATUS_OK, getFoo->doubleNumber(1, &out));
    EXPECT_EQ(2, out);
}

TEST(NdkBinder, EqualityOfRemoteBinderPointer) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    AIBinder* binderA = AServiceManager_getService(kExistingNonNdkService);
    ASSERT_NE(nullptr, binderA);

    AIBinder* binderB = AServiceManager_getService(kExistingNonNdkService);
    ASSERT_NE(nullptr, binderB);
    LIBBINDER_IGNORE_END()

    EXPECT_EQ(binderA, binderB);

    AIBinder_decStrong(binderA);
    AIBinder_decStrong(binderB);
}

TEST(NdkBinder, ToFromJavaNullptr) {
    EXPECT_EQ(nullptr, AIBinder_toJavaBinder(nullptr, nullptr));
    EXPECT_EQ(nullptr, AIBinder_fromJavaBinder(nullptr, nullptr));
}

TEST(NdkBinder, ABpBinderRefCount) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    AIBinder* binder = AServiceManager_getService(kExistingNonNdkService);
    LIBBINDER_IGNORE_END()
    AIBinder_Weak* wBinder = AIBinder_Weak_new(binder);

    ASSERT_NE(nullptr, binder);
    EXPECT_EQ(1, AIBinder_debugGetRefCount(binder));

    AIBinder_decStrong(binder);

    ASSERT_EQ(nullptr, AIBinder_Weak_promote(wBinder));

    AIBinder_Weak_delete(wBinder);
}

TEST(NdkBinder, AddServiceMultipleTimes) {
    static const char* kInstanceName1 = "test-multi-1";
    static const char* kInstanceName2 = "test-multi-2";
    sp<IFoo> foo = new MyTestFoo;
    EXPECT_EQ(EX_NONE, foo->addService(kInstanceName1));
    EXPECT_EQ(EX_NONE, foo->addService(kInstanceName2));
    EXPECT_EQ(IFoo::getService(kInstanceName1), IFoo::getService(kInstanceName2));
}

TEST(NdkBinder, RequestedSidWorks) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    ndk::SpAIBinder binder(AServiceManager_getService(kBinderNdkUnitTestService));
    LIBBINDER_IGNORE_END()
    std::shared_ptr<aidl::IBinderNdkUnitTest> service =
            aidl::IBinderNdkUnitTest::fromBinder(binder);

    bool gotSid = false;
    EXPECT_TRUE(service->getsRequestedSid(&gotSid).isOk());
    EXPECT_TRUE(gotSid);
}

TEST(NdkBinder, SentAidlBinderCanBeDestroyed) {
    static volatile bool destroyed = false;
    static std::mutex dMutex;
    static std::condition_variable cv;

    class MyEmpty : public aidl::BnEmpty {
        virtual ~MyEmpty() {
            destroyed = true;
            cv.notify_one();
        }
    };

    std::shared_ptr<MyEmpty> empty = ndk::SharedRefBase::make<MyEmpty>();

    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    ndk::SpAIBinder binder(AServiceManager_getService(kBinderNdkUnitTestService));
    LIBBINDER_IGNORE_END()
    std::shared_ptr<aidl::IBinderNdkUnitTest> service =
            aidl::IBinderNdkUnitTest::fromBinder(binder);

    EXPECT_FALSE(destroyed);

    service->takeInterface(empty);
    service->forceFlushCommands();
    empty = nullptr;

    // give other binder thread time to process commands
    {
        using namespace std::chrono_literals;
        std::unique_lock<std::mutex> lk(dMutex);
        cv.wait_for(lk, 1s, [] { return destroyed; });
    }

    EXPECT_TRUE(destroyed);
}

TEST(NdkBinder, ConvertToPlatformBinder) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    ndk::SpAIBinder remoteBinder(AServiceManager_getService(kBinderNdkUnitTestService));
    LIBBINDER_IGNORE_END()
    auto localBinder = ndk::SharedRefBase::make<MyBinderNdkUnitTest>()->asBinder();
    for (const ndk::SpAIBinder& binder : {remoteBinder, localBinder}) {
        // convert to platform binder
        EXPECT_NE(binder, nullptr);
        sp<IBinder> platformBinder = AIBinder_toPlatformBinder(binder.get());
        EXPECT_NE(platformBinder, nullptr);
        auto proxy = interface_cast<IBinderNdkUnitTest>(platformBinder);
        EXPECT_NE(proxy, nullptr);

        // use platform binder
        int out;
        EXPECT_TRUE(proxy->repeatInt(4, &out).isOk());
        EXPECT_EQ(out, 4);

        // convert back
        ndk::SpAIBinder backBinder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(platformBinder));
        EXPECT_EQ(backBinder, binder);
    }
}

TEST(NdkBinder, ConvertToPlatformParcel) {
    ndk::ScopedAParcel parcel = ndk::ScopedAParcel(AParcel_create());
    EXPECT_EQ(OK, AParcel_writeInt32(parcel.get(), 42));

    android::Parcel* pparcel = AParcel_viewPlatformParcel(parcel.get());
    pparcel->setDataPosition(0);
    EXPECT_EQ(42, pparcel->readInt32());
}

TEST(NdkBinder, GetAndVerifyScopedAIBinder_Weak) {
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    ndk::SpAIBinder remoteBinder(AServiceManager_getService(kBinderNdkUnitTestService));
    LIBBINDER_IGNORE_END()
    auto localBinder = ndk::SharedRefBase::make<MyBinderNdkUnitTest>()->asBinder();
    for (const ndk::SpAIBinder& binder : {remoteBinder, localBinder}) {
        // get a const ScopedAIBinder_Weak and verify promote
        EXPECT_NE(binder.get(), nullptr);
        const ndk::ScopedAIBinder_Weak wkAIBinder =
                ndk::ScopedAIBinder_Weak(AIBinder_Weak_new(binder.get()));
        EXPECT_EQ(wkAIBinder.promote().get(), binder.get());
        // get another ScopedAIBinder_Weak and verify
        ndk::ScopedAIBinder_Weak wkAIBinder2 =
                ndk::ScopedAIBinder_Weak(AIBinder_Weak_new(binder.get()));
        EXPECT_FALSE(AIBinder_Weak_lt(wkAIBinder.get(), wkAIBinder2.get()));
        EXPECT_FALSE(AIBinder_Weak_lt(wkAIBinder2.get(), wkAIBinder.get()));
        EXPECT_EQ(wkAIBinder2.promote(), wkAIBinder.promote());
    }
}

class MyResultReceiver : public BnResultReceiver {
   public:
    std::mutex mMutex;
    std::condition_variable mCondition;
    bool mHaveResult = false;
    int32_t mResult = 0;

    virtual void send(int32_t resultCode) {
        std::unique_lock<std::mutex> _l(mMutex);
        mResult = resultCode;
        mHaveResult = true;
        mCondition.notify_one();
    }

    int32_t waitForResult() {
        std::unique_lock<std::mutex> _l(mMutex);
        while (!mHaveResult) {
            mCondition.wait(_l);
        }
        return mResult;
    }
};

class MyShellCallback : public BnShellCallback {
   public:
    virtual int openFile(const String16& /*path*/, const String16& /*seLinuxContext*/,
                         const String16& /*mode*/) {
        // Empty implementation.
        return 0;
    }
};

bool ReadFdToString(int fd, std::string* content) {
    char buf[64];
    ssize_t n;
    while ((n = TEMP_FAILURE_RETRY(read(fd, &buf[0], sizeof(buf)))) > 0) {
        content->append(buf, n);
    }
    return (n == 0) ? true : false;
}

std::string shellCmdToString(sp<IBinder> unitTestService, const std::vector<const char*>& args) {
    int inFd[2] = {-1, -1};
    int outFd[2] = {-1, -1};
    int errFd[2] = {-1, -1};

    EXPECT_EQ(0, socketpair(AF_UNIX, SOCK_STREAM, 0, inFd));
    EXPECT_EQ(0, socketpair(AF_UNIX, SOCK_STREAM, 0, outFd));
    EXPECT_EQ(0, socketpair(AF_UNIX, SOCK_STREAM, 0, errFd));

    sp<MyShellCallback> cb = new MyShellCallback();
    sp<MyResultReceiver> resultReceiver = new MyResultReceiver();

    Vector<String16> argsVec;
    for (size_t i = 0; i < args.size(); i++) {
        argsVec.add(String16(args[i]));
    }
    status_t error = IBinder::shellCommand(unitTestService, inFd[0], outFd[0], errFd[0], argsVec,
                                           cb, resultReceiver);
    EXPECT_EQ(error, android::OK);

    status_t res = resultReceiver->waitForResult();
    EXPECT_EQ(res, android::OK);

    close(inFd[0]);
    close(inFd[1]);
    close(outFd[0]);
    close(errFd[0]);
    close(errFd[1]);

    std::string ret;
    EXPECT_TRUE(ReadFdToString(outFd[1], &ret));
    close(outFd[1]);
    return ret;
}

TEST(NdkBinder, UseHandleShellCommand) {
    static const sp<android::IServiceManager> sm(android::defaultServiceManager());
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    sp<IBinder> testService = sm->getService(String16(kBinderNdkUnitTestService));
    LIBBINDER_IGNORE_END()

    EXPECT_EQ("", shellCmdToString(testService, {}));
    EXPECT_EQ("", shellCmdToString(testService, {"", ""}));
    EXPECT_EQ("Hello world!", shellCmdToString(testService, {"Hello ", "world!"}));
    EXPECT_EQ("CMD", shellCmdToString(testService, {"C", "M", "D"}));
}

TEST(NdkBinder, FlaggedServiceAccessible) {
    static const sp<android::IServiceManager> sm(android::defaultServiceManager());
    LIBBINDER_IGNORE("-Wdeprecated-declarations")
    sp<IBinder> testService = sm->getService(String16(kBinderNdkUnitTestServiceFlagged));
    LIBBINDER_IGNORE_END()
    ASSERT_NE(nullptr, testService);
}

TEST(NdkBinder, GetClassInterfaceDescriptor) {
    ASSERT_STREQ(IFoo::kIFooDescriptor, AIBinder_Class_getDescriptor(IFoo::kClass));
}

static void addOne(int* to) {
    if (!to) return;
    ++(*to);
}
struct FakeResource : public ndk::impl::ScopedAResource<int*, addOne, nullptr> {
    explicit FakeResource(int* a) : ScopedAResource(a) {}
};

TEST(NdkBinder_ScopedAResource, GetDelete) {
    int deleteCount = 0;
    { FakeResource resource(&deleteCount); }
    EXPECT_EQ(deleteCount, 1);
}

TEST(NdkBinder_ScopedAResource, Release) {
    int deleteCount = 0;
    {
        FakeResource resource(&deleteCount);
        (void)resource.release();
    }
    EXPECT_EQ(deleteCount, 0);
}

void* EmptyOnCreate(void* args) {
    return args;
}
void EmptyOnDestroy(void* /*userData*/) {}
binder_status_t EmptyOnTransact(AIBinder* /*binder*/, transaction_code_t /*code*/,
                                const AParcel* /*in*/, AParcel* /*out*/) {
    return STATUS_OK;
}

TEST(NdkBinder_DeathTest, SetCodeMapTwice) {
    const char* codeToFunction1[] = {"function-1", "function-2", "function-3"};
    const char* codeToFunction2[] = {"function-4", "function-5"};
    const char* interfaceName = "interface_descriptor";
    AIBinder_Class* clazz =
            AIBinder_Class_define(interfaceName, EmptyOnCreate, EmptyOnDestroy, EmptyOnTransact);
    AIBinder_Class_setTransactionCodeToFunctionNameMap(clazz, codeToFunction1, 3);
    // Reset/clear is not allowed
    EXPECT_DEATH(AIBinder_Class_setTransactionCodeToFunctionNameMap(clazz, codeToFunction2, 2), "");
}

TEST(NdkBinder_DeathTest, SetNullCodeMap) {
    const char* codeToFunction[] = {"function-1", "function-2", "function-3"};
    const char* interfaceName = "interface_descriptor";
    AIBinder_Class* clazz =
            AIBinder_Class_define(interfaceName, EmptyOnCreate, EmptyOnDestroy, EmptyOnTransact);
    EXPECT_DEATH(AIBinder_Class_setTransactionCodeToFunctionNameMap(nullptr, codeToFunction, 3),
                 "");
    EXPECT_DEATH(AIBinder_Class_setTransactionCodeToFunctionNameMap(clazz, nullptr, 0), "");
    EXPECT_DEATH(AIBinder_Class_setTransactionCodeToFunctionNameMap(nullptr, nullptr, 0), "");
}

int main(int argc, char* argv[]) {
    ::testing::InitGoogleTest(&argc, argv);

    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return manualThreadPoolService(IFoo::kInstanceNameToDieFor);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return manualThreadPoolService(IFoo::kInstanceNameToDieFor2);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return manualPollingService(IFoo::kSomeInstanceName);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return lazyService(kLazyBinderNdkUnitTestService);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return lazyService(kForcePersistNdkUnitTestService);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return lazyService(kActiveServicesNdkUnitTestService);
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        return generatedService();
    }
    if (fork() == 0) {
        prctl(PR_SET_PDEATHSIG, SIGHUP);
        // We may want to change this flag to be more generic ones for the future
        AServiceManager_AddServiceFlag test_flags =
                AServiceManager_AddServiceFlag::ADD_SERVICE_ALLOW_ISOLATED;
        return generatedFlaggedService(test_flags, kBinderNdkUnitTestServiceFlagged);
    }

    ABinderProcess_setThreadPoolMaxThreadCount(0);
    ABinderProcess_startThreadPool();

    return RUN_ALL_TESTS();
}

#include <android/binder_auto_utils.h>
#include <android/binder_interface_utils.h>
#include <android/binder_parcel_utils.h>