カーウォッチドッグ

カーウォッチドッグは VHAL のデバッグに役立ちます。カーウォッチドッグは、プロセスをモニタリングし、異常なプロセスを強制終了します。カーウォッチドッグでプロセスをモニターするには、プロセスをカーウォッチドッグに登録する必要があります。カーウォッチドッグは、異常なプロセスを強制終了すると、他のアプリケーション応答なし（ANR）ダンプの場合と同様に、プロセスのステータスを data/anr に書き込みます。これにより、デバッグプロセスが簡単になります。

この記事では、ベンダー HAL とサービスがカーウォッチドッグにプロセスを登録する方法について説明します。

ベンダー HAL

通常、ベンダー HAL は hwbinder 用のスレッドプールを使用します。しかし、カーウォッチドッグクライアントは、hwbinder とは異なる binder を介してカーウォッチドッグデーモンと通信します。そのため、binder 用の別のスレッドプールも使用されることになります。

makefile でカーウォッチドッグ AIDL を指定する

shared_libs に carwatchdog_aidl_interface-ndk_platform を含めます。

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 ポリシーを追加する

system_server に HAL の強制終了を許可します。 system_server.te がない場合は作成します。デバイスごとに SELinux ポリシーを追加することを強くおすすめします。
ベンダー HAL にバインダー（binder_use マクロ）の使用を許可し、ベンダー HAL を carwatchdog クライアントドメイン（carwatchdog_client_domain マクロ）に追加します。 systemserver.te と 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)
```

BnCarWatchdogClient を継承してクライアントクラスを実装する

checkIfAlive でヘルスチェックを実行します。たとえば、スレッドループハンドラに投稿します。正常である場合は ICarWatchdog::tellClientAlive を呼び出します。 WatchogClient.h と 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();
}

バインダースレッドを開始し、クライアントを登録する

バインダー通信用のスレッドプールを作成します。ベンダー HAL がそれ自身の目的のために hwbinder を使用している場合は、カーウォッチドッグのバインダー通信用に別のスレッドプールを作成する必要があります）。
名前でデーモンを検索し、ICarWatchdog::registerClient を呼び出します。カーウォッチドッグデーモンのインターフェース名は android.automotive.watchdog.ICarWatchdog/default です。

サービスの応答性に基づいて、カーウォッチドッグでサポートされている次の 3 種類のタイムアウトのうちいずれか 1 つを選択し、選択したタイムアウトを ICarWatchdog::registerClient への呼び出しに渡します。

critical(3s)
moderate(5s)
normal(10s)

VehicleService.cpp と 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;
}

ベンダーサービス（ネイティブ）

カーウォッチドッグ AIDL の makefile を指定する

carwatchdog_aidl_interface-ndk_platform を shared_libs に含めます。

Android.bp

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

SELinux ポリシーを追加する

SELinux ポリシーを追加するには、ベンダーサービスドメインにバインダー（binder_use マクロ）の使用を許可し、ベンダーサービスドメインを carwatchdog クライアントドメイン（carwatchdog_client_domain マクロ）に追加します。 sample_client.te と 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)
```
file_contexts
```
/vendor/bin/sample_native_client  u:object_r:sample_client_exec:s0
```

BnCarWatchdogClient を継承してクライアントクラスを実装する

checkIfAlive でヘルスチェックを実行します。たとえば、スレッドループハンドラに投稿するなどの方法があります。正常である場合は ICarWatchdog::tellClientAlive を呼び出します。 SampleNativeClient.h と 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);
}

バインダースレッドを開始し、クライアントを登録する

カーウォッチドッグデーモンのインターフェース名は android.automotive.watchdog.ICarWatchdog/default です。

名前でデーモンを検索し、ICarWatchdog::registerClient を呼び出します。 main.cpp と 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);
}

ベンダーサービス（Android）

CarWatchdogClientCallback を継承してクライアントを実装する

新しいファイルを以下のように編集します。

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() {}
};

クライアントを登録する

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);
}

クライアントの登録を解除する

サービスの終了時に CarWatchdogManager.unregisterClient() を呼び出します。

private void finishClient() {
    CarWatchdogManager manager =
        (CarWatchdogManager) car.getCarManager(
        Car.CAR_WATCHDOG_SERVICE);
    manager.unregisterClient(mClientCallback);
}

カーウォッチドッグにより強制終了されたプロセスを見つける

カーウォッチドッグは、カーウォッチドッグに登録されているプロセス（ベンダー HAL、ベンダーネイティブサービス、ベンダー Android サービス）が停止して無応答になった場合に、そのプロセスをダンプ / 強制終了します。このようなダンプを見つけるには、logcat をチェックします。問題のあるプロセスがダンプまたは強制終了されると、カーウォッチドッグはログ carwatchdog killed process_name (pid:process_id) を出力します。そのため、以下のコマンドを実行します。

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

これにより、関連するログが取得されます。たとえば、KitchenSink アプリ（カーウォッチドッグクライアント）が停止した場合、次のような行がログに書き込まれます。

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

KitchenSink アプリが停止した原因や箇所を確認するには、Activity ANR ケースを使用する場合と同様に、/data/anr に保存されたプロセスダンプを使用します。

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

次のサンプルは、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 -----

ダンプファイル（上記の例では /data/anr/anr_2020-05-01-09-50-18-290）を見つけて、分析を開始します。

カー ウォッチドッグ

ベンダー HAL

makefile でカー ウォッチドッグ AIDL を指定する

SELinux ポリシーを追加する

system_server.te

hal_vehicle_default.te

BnCarWatchdogClient を継承してクライアント クラスを実装する

WatchogClient.h

WatchogClient.cpp

バインダー スレッドを開始し、クライアントを登録する

VehicleService.cpp

WatchogClient.cpp

ベンダー サービス（ネイティブ）

カー ウォッチドッグ AIDL の makefile を指定する

SELinux ポリシーを追加する

sample_client.te

file_contexts

BnCarWatchdogClient を継承してクライアント クラスを実装する

SampleNativeClient.h

SampleNativeClient.cpp

バインダー スレッドを開始し、クライアントを登録する

main.cpp

SampleNativeClient.cpp

ベンダー サービス（Android）

CarWatchdogClientCallback を継承してクライアントを実装する

クライアントを登録する

クライアントの登録を解除する

カー ウォッチドッグにより強制終了されたプロセスを見つける

カーウォッチドッグ

makefile でカーウォッチドッグ AIDL を指定する

BnCarWatchdogClient を継承してクライアントクラスを実装する

バインダースレッドを開始し、クライアントを登録する

ベンダーサービス（ネイティブ）

カーウォッチドッグ AIDL の makefile を指定する

BnCarWatchdogClient を継承してクライアントクラスを実装する

バインダースレッドを開始し、クライアントを登録する

ベンダーサービス（Android）

カーウォッチドッグにより強制終了されたプロセスを見つける