Watchdog im Auto

Verwenden Sie den Watchdog im Auto, um die VHAL zu debuggen. Der Car Watchdog überwacht den Zustand fehlerhafter Prozesse und beendet sie. Damit ein Prozess vom Watchdog im Auto überwacht werden kann, muss er beim Watchdog registriert sein. Wenn der Car Watchdog fehlerhafte Prozesse beendet, schreibt er den Status der Prozesse wie bei anderen ANR-Dumps (Application Not Responding) auf data/anr. Dies erleichtert die Fehlerbehebung.

In diesem Artikel wird beschrieben, wie Anbieter-HALs und ‑Dienste einen Prozess beim Car Watchdog registrieren können.

Anbieter-HAL

Normalerweise verwendet die HAL des Anbieters einen Thread-Pool für hwbinder. Der Watchdog-Client für das Auto kommuniziert jedoch über binder mit dem Watchdog-Daemon für das Auto, was sich von hwbinder unterscheidet. Daher wird ein anderer Thread-Pool für binder verwendet.

Watchdog im Auto als aidl im Makefile angeben

  1. carwatchdog_aidl_interface-ndk_platform in shared_libs einschließen:

    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",
        ],
    }

SELinux-Richtlinie hinzufügen

  1. Erlauben Sie system_server, Ihre HAL zu beenden. Wenn Sie noch kein system_server.te-Konto haben, erstellen Sie eines. Wir empfehlen dringend, jedem Gerät eine SELinux-Richtlinie hinzuzufügen.
  2. Erlauben Sie der HAL des Anbieters, den Binder zu verwenden (binder_use-Makro) und fügen Sie die HAL des Anbieters der carwatchdog-Clientdomain hinzu (carwatchdog_client_domain-Makro). Im folgenden Code sind die entsprechenden Codezeilen für systemserver.te und vehicle_default.te zu sehen:
    # Allow system_server to kill vehicle HAL
    allow system_server hal_vehicle_server:process sigkill;
    # Configuration for register VHAL to car watchdog
    carwatchdog_client_domain(hal_vehicle_default)
    binder_use(hal_vehicle_default)

Implementieren Sie eine Clientklasse, indem Sie BnCarWatchdogClient erben.

  1. Führen Sie in checkIfAlive eine Systemdiagnose durch. Beispiel: Posten Sie etwas an den Thread-Loop-Handler. Wenn alles in Ordnung ist, rufen Sie ICarWatchdog::tellClientAlive an. Im folgenden Code sind die entsprechenden Codezeilen für WatchogClient.h und WatchogClient.cpp zu sehen:
    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; };
    ndk::ScopedAStatus WatchdogClient::checkIfAlive(int32_t sessionId, TimeoutLength /*timeout*/) {
        // Implement or call your health check logic here
        return ndk::ScopedAStatus::ok();
    }

Binder-Thread starten und Client registrieren

  1. Erstellen Sie einen Thread-Pool für die Binder-Kommunikation. Wenn die HAL des Anbieters hwbinder für eigene Zwecke verwendet, müssen Sie einen weiteren Thread-Pool für die Kommunikation des Car Watchdog-Binders erstellen.
  2. Suchen Sie nach dem Daemon mit dem Namen und rufen Sie ICarWatchdog::registerClient auf. Der Name der Watchdog-Daemon-Schnittstelle für das Auto lautet android.automotive.watchdog.ICarWatchdog/default.
  3. Wählen Sie je nach Dienstreaktionszeit einen der drei vom Dienst-Watchdog unterstützten Zeitüberschreitungstypen aus und übergeben Sie die Zeitüberschreitung dann im Aufruf an ICarWatchdog::registerClient:
    • critical(3s)
    • moderate(5s)
    • normal(10s)
    Unten finden Sie den Code für VehicleService.cpp und WatchogClient.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;
    }
    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;
    }

Anbieterdienste (nativ)

Aidl-Makefile für den Watchdog im Auto angeben

  1. Fügen Sie carwatchdog_aidl_interface-ndk_platform in shared_libs ein.

    Android.bp

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

SELinux-Richtlinie hinzufügen

  1. Wenn Sie eine SELinux-Richtlinie hinzufügen möchten, erlauben Sie der Domain des Anbieterdiensts, Binder zu verwenden (binder_use-Makro), und fügen Sie die Domain des Anbieterdiensts der carwatchdog-Clientdomain (carwatchdog_client_domain-Makro) hinzu. Im folgenden Code sind die entsprechenden Codezeilen für sample_client.te und file_contexts zu sehen:
    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)
    /vendor/bin/sample_native_client  u:object_r:sample_client_exec:s0

Implementieren Sie eine Clientklasse, indem Sie BnCarWatchdogClient erben.

  1. Führen Sie in checkIfAlive eine Systemdiagnose durch. Eine Möglichkeit besteht darin, eine Nachricht an den Thread-Loop-Handler zu senden. Wenn alles in Ordnung ist, rufen Sie ICarWatchdog::tellClientAlive an. Im folgenden Code sind die entsprechenden Codezeilen für SampleNativeClient.h und SampleNativeClient.cpp zu sehen:
    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;
    };
    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);
    }

Binder-Thread starten und Client registrieren

Der Name der Watchdog-Daemon-Schnittstelle für das Auto lautet android.automotive.watchdog.ICarWatchdog/default.

  1. Suchen Sie nach dem Daemon mit dem Namen und rufen Sie ICarWatchdog::registerClient auf. Im folgenden Code sind die entsprechenden Codezeilen für main.cpp und SampleNativeClient.cpp zu sehen:
    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();
        ...
    }
    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);
    }

Anbieterdienste (Android)

Implementieren Sie einen Client, indem Sie CarWatchdogClientCallback erben.

  1. Bearbeiten Sie die neue Datei so:
    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() {}
    };

Client registrieren

  1. CarWatchdogManager.registerClient() anrufen:
    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);
    }

Client abmelden

  1. Rufe CarWatchdogManager.unregisterClient() auf, wenn der Dienst abgeschlossen ist:
    private void finishClient() {
        CarWatchdogManager manager =
            (CarWatchdogManager) car.getCarManager(
            Car.CAR_WATCHDOG_SERVICE);
        manager.unregisterClient(mClientCallback);
    }

Prozesse erkennen, die vom Watchdog im Auto beendet wurden

Der Car Watchdog beendet Prozesse (HAL des Anbieters, native Dienste des Anbieters, Android-Dienste des Anbieters), die beim Car Watchdog registriert sind, wenn sie hängen und nicht reagieren. Solche Dumps werden durch die Prüfung von Logcats erkannt. Der Car Watchdog gibt ein Protokoll carwatchdog killed process_name (pid:process_id) aus, wenn ein problematischer Prozess gedumpt oder beendet wird. Daher:

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

Die relevanten Protokolle werden erfasst. Wenn beispielsweise die KitchenSink-App (ein Car Watchdog-Client) hängen bleibt, wird in das Protokoll eine Zeile wie die folgende geschrieben:

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

Um herauszufinden, warum oder wo die KitchenSink-App hängengeblieben ist, verwenden Sie den Prozess-Dump, der unter /data/anr gespeichert ist, genau wie Sie ANR-Fehlerfälle für Aktivitäten verwenden würden.

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

Die folgende Beispielausgabe bezieht sich auf die KitchenSink-App:

$ 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 -----

Suchen Sie die Dumpdatei (z. B. /data/anr/anr_2020-05-01-09-50-18-290 im Beispiel oben) und starten Sie die Analyse.