Vigilante de carro

Use o watchdog do carro para ajudar a depurar o VHAL. O cão de guarda do carro monitora a saúde de – e mata – processos insalubres. Para que um processo seja monitorado pelo car watchdog, o processo deve ser registrado no car watchdog. Quando o watchdog do carro elimina processos não íntegros, o watchdog do carro grava o status dos processos em data/anr como acontece com outros dumps de aplicativo não respondendo (ANR). Isso facilita o processo de depuração.

Este artigo descreve como HALs e serviços de fornecedores podem registrar um processo com o watchdog do carro.

Fornecedor HAL

Normalmente, o fornecedor HAL usa um pool de threads para hwbinder . No entanto, o cliente do watchdog do carro se comunica com o daemon do watchdog do carro por meio de binder , que difere do hwbinder . Portanto, outro pool de threads para binder está em uso.

Especifique o watchdog aidl no makefile

  1. Inclua carwatchdog_aidl_interface-ndk_platform em shared_libs :

    Android.bp :

    cc_defaults {
        name: "vhal_v2_0_defaults",
        shared_libs: [
            "libbinder_ndk",
            "libhidlbase",
            "liblog",
            "libutils",
            "android.hardware.automotive.vehicle@2.0",
            "carwatchdog_aidl_interface-ndk_platform",
        ],
        cflags: [
            "-Wall",
            "-Wextra",
            "-Werror",
        ],
    }
    

Adicionar uma política SELinux

  1. Permita que o system_server mate seu HAL. Se você não tiver system_server.te , crie um. É altamente recomendável que você adicione uma política SELinux a cada dispositivo.
  2. Permita que o HAL do fornecedor use o binder ( macro binder_use ) e adicione o HAL do fornecedor ao domínio do cliente carwatchdog ( macro carwatchdog_client_domain ). Veja o código abaixo para systemserver.te e vehicle_default.te :

    system_server.te

    # Allow system_server to kill vehicle HAL
    allow system_server hal_vehicle_server:process sigkill;
    

    hal_vehicle_default.te

    # Configuration for register VHAL to car watchdog
    carwatchdog_client_domain(hal_vehicle_default)
    binder_use(hal_vehicle_default)
    

Implemente uma classe de cliente herdando BnCarWatchdogClient

  1. Em checkIfAlive , execute a verificação de integridade. Por exemplo, poste no manipulador de loop de thread. Se estiver saudável, chame ICarWatchdog::tellClientAlive . Veja o código abaixo para WatchogClient.h e WatchogClient.cpp :

    WatchogClient.h

    class WatchdogClient : public aidl::android::automotive::watchdog::BnCarWatchdogClient {
      public:
        explicit WatchdogClient(const ::android::sp<::android::Looper>& handlerLooper, VehicleHalManager* vhalManager);
    
    ndk::ScopedAStatus checkIfAlive(int32_t sessionId, aidl::android::automotive::watchdog::TimeoutLength timeout) override; ndk::ScopedAStatus prepareProcessTermination() override; };

    WatchogClient.cpp

    ndk::ScopedAStatus WatchdogClient::checkIfAlive(int32_t sessionId, TimeoutLength /*timeout*/) {
        // Implement or call your health check logic here
        return ndk::ScopedAStatus::ok();
    }
    

Inicie o encadeamento do fichário e registre o cliente

  1. Crie um pool de encadeamentos para comunicação de fichário. Se o fornecedor HAL usar o hwbinder para seu próprio propósito, você deverá criar outro conjunto de encadeamentos para comunicação do car watchdog binder).
  2. Procure o daemon com o nome e chame ICarWatchdog::registerClient . O nome da interface do daemon do watchdog do carro é android.automotive.watchdog.ICarWatchdog/default .
  3. Com base na capacidade de resposta do serviço, selecione um dos três tipos de tempo limite a seguir suportados pelo watchdog do carro e, em seguida, passe o tempo limite na chamada para ICarWatchdog::registerClient :
    • crítico(3s)
    • moderado(5s)
    • normal(10s)
    Veja o código abaixo para VehicleService.cpp e WatchogClient.cpp :

    VehicleService.cpp

    int main(int /* argc */, char* /* argv */ []) {
        // Set up thread pool for hwbinder
        configureRpcThreadpool(4, false /* callerWillJoin */);
    
        ALOGI("Registering as service...");
        status_t status = service->registerAsService();
    
        if (status != OK) {
            ALOGE("Unable to register vehicle service (%d)", status);
            return 1;
        }
    
        // Setup a binder thread pool to be a car watchdog client.
        ABinderProcess_setThreadPoolMaxThreadCount(1);
        ABinderProcess_startThreadPool();
        sp<Looper> looper(Looper::prepare(0 /* opts */));
        std::shared_ptr<WatchdogClient> watchdogClient =
                ndk::SharedRefBase::make<WatchdogClient>(looper, service.get());
        // The current health check is done in the main thread, so it falls short of capturing the real
        // situation. Checking through HAL binder thread should be considered.
        if (!watchdogClient->initialize()) {
            ALOGE("Failed to initialize car watchdog client");
            return 1;
        }
        ALOGI("Ready");
        while (true) {
            looper->pollAll(-1 /* timeoutMillis */);
        }
    
        return 1;
    }
    

    WatchogClient.cpp

    bool WatchdogClient::initialize() {
        ndk::SpAIBinder binder(AServiceManager_getService("android.automotive.watchdog.ICarWatchdog/default"));
        if (binder.get() == nullptr) {
            ALOGE("Failed to get carwatchdog daemon");
            return false;
        }
        std::shared_ptr<ICarWatchdog> server = ICarWatchdog::fromBinder(binder);
        if (server == nullptr) {
            ALOGE("Failed to connect to carwatchdog daemon");
            return false;
        }
        mWatchdogServer = server;
    
        binder = this->asBinder();
        if (binder.get() == nullptr) {
            ALOGE("Failed to get car watchdog client binder object");
            return false;
        }
        std::shared_ptr<ICarWatchdogClient> client = ICarWatchdogClient::fromBinder(binder);
        if (client == nullptr) {
            ALOGE("Failed to get ICarWatchdogClient from binder");
            return false;
        }
        mTestClient = client;
        mWatchdogServer->registerClient(client, TimeoutLength::TIMEOUT_NORMAL);
        ALOGI("Successfully registered the client to car watchdog server");
        return true;
    }
    

Serviços do fornecedor (nativo)

Especifique o makefile do watchdog do carro

  1. Inclua carwatchdog_aidl_interface-ndk_platform em shared_libs .

    Android.bp

    cc_binary {
        name: "sample_native_client",
        srcs: [
            "src/*.cpp"
        ],
        shared_libs: [
            "carwatchdog_aidl_interface-ndk_platform",
            "libbinder_ndk",
        ],
        vendor: true,
    }
    

Adicionar uma política SELinux

  1. Para adicionar uma política SELinux, permita que o domínio do serviço do fornecedor use o binder ( macro binder_use ) e adicione o domínio do serviço do fornecedor ao domínio do cliente carwatchdog ( macro carwatchdog_client_domain ). Veja o código abaixo para sample_client.te e file_contexts :

    sample_client.te

    type sample_client, domain;
    type sample_client_exec, exec_type, file_type, vendor_file_type;
    
    carwatchdog_client_domain(sample_client)
    
    init_daemon_domain(sample_client)
    binder_use(sample_client)
    

    arquivo_contexts

    /vendor/bin/sample_native_client  u:object_r:sample_client_exec:s0
    

Implemente uma classe de cliente herdando BnCarWatchdogClient

  1. Em checkIfAlive , execute uma verificação de integridade. Uma opção é postar no manipulador de loop de thread. Se estiver saudável, chame ICarWatchdog::tellClientAlive . Veja o código abaixo para SampleNativeClient.h e SampleNativeClient.cpp :

    SampleNativeClient.h

    class SampleNativeClient : public BnCarWatchdogClient {
    public:
        ndk::ScopedAStatus checkIfAlive(int32_t sessionId, TimeoutLength
            timeout) override;
        ndk::ScopedAStatus prepareProcessTermination() override;
        void initialize();
    
    private:
        void respondToDaemon();
    private:
        ::android::sp<::android::Looper> mHandlerLooper;
        std::shared_ptr<ICarWatchdog> mWatchdogServer;
        std::shared_ptr<ICarWatchdogClient> mClient;
        int32_t mSessionId;
    };
    

    SampleNativeClient.cpp

    ndk::ScopedAStatus WatchdogClient::checkIfAlive(int32_t sessionId, TimeoutLength timeout) {
        mHandlerLooper->removeMessages(mMessageHandler,
            WHAT_CHECK_ALIVE);
        mSessionId = sessionId;
        mHandlerLooper->sendMessage(mMessageHandler,
            Message(WHAT_CHECK_ALIVE));
        return ndk::ScopedAStatus::ok();
    }
    // WHAT_CHECK_ALIVE triggers respondToDaemon from thread handler
    void WatchdogClient::respondToDaemon() {
      // your health checking method here
      ndk::ScopedAStatus status = mWatchdogServer->tellClientAlive(mClient,
            mSessionId);
    }
    

Inicie um encadeamento de fichário e registre o cliente

O nome da interface do daemon do watchdog do carro é android.automotive.watchdog.ICarWatchdog/default .

  1. Procure o daemon com o nome e chame ICarWatchdog::registerClient . Veja o código abaixo para main.cpp e SampleNativeClient.cpp :

    main.cpp

    int main(int argc, char** argv) {
        sp<Looper> looper(Looper::prepare(/*opts=*/0));
    
        ABinderProcess_setThreadPoolMaxThreadCount(1);
        ABinderProcess_startThreadPool();
        std::shared_ptr<SampleNativeClient> client =
            ndk::SharedRefBase::make<SampleNatvieClient>(looper);
    
        // The client is registered in initialize()
        client->initialize();
        ...
    }
    

    SampleNativeClient.cpp

    void SampleNativeClient::initialize() {
        ndk::SpAIBinder binder(AServiceManager_getService(
            "android.automotive.watchdog.ICarWatchdog/default"));
        std::shared_ptr<ICarWatchdog> server =
            ICarWatchdog::fromBinder(binder);
        mWatchdogServer = server;
        ndk::SpAIBinder binder = this->asBinder();
        std::shared_ptr<ICarWatchdogClient> client =
            ICarWatchdogClient::fromBinder(binder)
        mClient = client;
        server->registerClient(client, TimeoutLength::TIMEOUT_NORMAL);
    }
    

Serviços do fornecedor (Android)

Implemente um cliente herdando CarWatchdogClientCallback

  1. Edite o novo arquivo da seguinte forma:
    private final CarWatchdogClientCallback mClientCallback = new CarWatchdogClientCallback() {
        @Override
        public boolean onCheckHealthStatus(int sessionId, int timeout) {
            // Your health check logic here
            // Returning true implies the client is healthy
            // If false is returned, the client should call
            // CarWatchdogManager.tellClientAlive after health check is
            // completed
        }
    
        @Override
        public void onPrepareProcessTermination() {}
    };
    

Registre o cliente

  1. Chame CarWatchdogManager.registerClient() :
    private void startClient() {
        CarWatchdogManager manager =
            (CarWatchdogManager) car.getCarManager(
            Car.CAR_WATCHDOG_SERVICE);
        // Choose a proper executor according to your health check method
        ExecutorService executor = Executors.newFixedThreadPool(1);
        manager.registerClient(executor, mClientCallback,
            CarWatchdogManager.TIMEOUT_NORMAL);
    }
    

Cancelar o registro do cliente

  1. Chame CarWatchdogManager.unregisterClient() quando o serviço for concluído:
    private void finishClient() {
        CarWatchdogManager manager =
            (CarWatchdogManager) car.getCarManager(
            Car.CAR_WATCHDOG_SERVICE);
        manager.unregisterClient(mClientCallback);
    }
    

Detectar processos encerrados pelo watchdog do carro

O watchdog do carro despeja/elimina processos (fornecedor HAL, serviços nativos do fornecedor, serviços Android do fornecedor) que são registrados no watchdog do carro quando estão travados e sem resposta. Tal despejo é detectado verificando logcats. O car watchdog gera um log carwatchdog killed process_name (pid:process_id) quando um processo problemático é despejado ou eliminado. Portanto:

$ adb logcat -s CarServiceHelper | fgrep "carwatchdog killed"

Os logs relevantes são capturados. Por exemplo, se o aplicativo KitchenSink (um cliente de watchdog de carro) ficar travado, uma linha como a abaixo será gravada no log:

05-01 09:50:19.683   578  5777 W CarServiceHelper: carwatchdog killed com.google.android.car.kitchensink (pid: 5574)

Para determinar por que ou onde o aplicativo KitchenSink ficou preso, use o despejo de processo armazenado em /data/anr da mesma forma que usaria os casos de ANR de atividade.

$ adb root
$ adb shell grep -Hn "pid process_pid" /data/anr/*

A saída de exemplo a seguir é específica para o aplicativo KitchenSink:

$ adb shell su root grep -Hn "pid 5574" /data/anr/*.
/data/anr/anr_2020-05-01-09-50-18-290:3:----- pid 5574 at 2020-05-01 09:50:18 -----
/data/anr/anr_2020-05-01-09-50-18-290:285:----- Waiting Channels: pid 5574 at 2020-05-01 09:50:18 -----

Encontre o arquivo de despejo (por exemplo, /data/anr/anr_2020-05-01-09-50-18-290 no exemplo acima) e inicie sua análise.