Armazenamento em cache da compilação

Descontinuado:a partir do Android 15 (AOSP experimental), a NNAPI (API NDK) foi descontinuada. A interface HAL de redes neurais continua com suporte.

Para saber mais, consulte o Guia de migração da NNAPI.

No Android 10 e versões mais recentes, a API Neural Networks (NNAPI) fornece funções para oferecer suporte ao armazenamento em cache de artefatos de compilação, o que reduz o tempo usado para compilação quando um app é iniciado. Com essa funcionalidade de armazenamento em cache, o driver não precisa gerenciar ou limpar os arquivos armazenados em cache. Esse é um recurso opcional que pode ser implementado com a NN HAL 1.2. Para mais informações sobre essa função, consulte ANeuralNetworksCompilation_setCaching.

O driver também pode implementar o armazenamento em cache de compilação independente da NNAPI. Isso pode ser implementado independente de os recursos de armazenamento em cache da NNAPI e da HAL serem usados ou não. O AOSP oferece uma biblioteca de utilitários de baixo nível (um mecanismo de armazenamento em cache). Para mais informações, consulte Como implementar um mecanismo de armazenamento em cache.

Visão geral do fluxo de trabalho

Esta seção descreve fluxos de trabalho gerais com o recurso de armazenamento em cache da compilação implementado.

Informações de cache fornecidas e ocorrência em cache

1. O app passa um diretório de armazenamento em cache e uma soma de verificação exclusiva para o modelo.
2. O ambiente de execução da NNAPI procura os arquivos de cache com base na soma de verificação, na preferência de execução e no resultado do particionamento e encontra os arquivos.
3. A NNAPI abre os arquivos de cache e transmite os identificadores ao driver com prepareModelFromCache.
4. O driver prepara o modelo diretamente dos arquivos de cache e retorna o modelo preparado.

Informações de cache fornecidas e ausência no cache

1. O app passa uma soma de verificação exclusiva para o modelo e um diretório de armazenamento em cache.
2. O ambiente de execução da NNAPI procura os arquivos de armazenamento em cache com base na soma de verificação, na preferência de execução e no resultado do particionamento, mas não encontra os arquivos em cache.
3. A NNAPI cria arquivos de cache vazios com base na soma de verificação, na preferência de execução e no particionamento, abre os arquivos de cache e transmite os identificadores e o modelo para o driver com prepareModel_1_2.
4. O driver compila o modelo, grava as informações de armazenamento em cache nos arquivos de cache e retorna o modelo preparado.

Informações de cache não fornecidas

1. O app invoca a compilação sem fornecer nenhuma informação de armazenamento em cache.
2. O app não transmite nada relacionado ao armazenamento em cache.
3. O ambiente de execução da NNAPI passa o modelo para o driver com prepareModel_1_2.
4. O driver compila o modelo e retorna o modelo preparado.

Armazenar informações em cache

As informações de armazenamento em cache fornecidas a um driver consistem em um token e identificadores de arquivo de cache.

Token

O token é um token de armazenamento em cache de comprimento Constant::BYTE_SIZE_OF_CACHE_TOKEN que identifica o modelo preparado. O mesmo token é fornecido ao salvar os arquivos de cache com prepareModel_1_2 e recuperar o modelo preparado com prepareModelFromCache. O cliente do driver precisa escolher um token com uma baixa taxa de colisão. O driver não detecta uma colisão de tokens. Uma colisão resulta em uma execução com falha ou em uma execução bem-sucedida que produz valores de saída incorretos.

Processamentos de arquivos de cache (dois tipos de arquivos de cache)

Os dois tipos de arquivos de cache são cache de dados e cache de modelo.

• Cache de dados: use para armazenar dados constantes em cache, incluindo buffers de tensor pré-processados e transformados. Uma modificação no cache de dados não deve resultar em nenhum efeito pior do que gerar valores de saída incorretos no momento da execução.
• Cache de modelo:use para armazenar dados sensíveis à segurança, como código de máquina executável compilado no formato binário nativo do dispositivo. Uma modificação no cache do modelo pode afetar o comportamento de execução do driver, e um cliente malicioso pode usar isso para executar além da permissão concedida. Portanto, o driver precisa verificar se o cache do modelo está corrompido antes de preparar o modelo do cache. Para mais informações, consulte Segurança.

O driver precisa decidir como as informações de cache são distribuídas entre os dois tipos de arquivos de cache e informar quantos arquivos de cache são necessários para cada tipo com getNumberOfCacheFilesNeeded.

O ambiente de execução da NNAPI sempre abre gerenciadores de arquivos de cache com permissão de leitura e gravação.

Observação: várias linhas de execução podem preparar o mesmo modelo simultaneamente. Para evitar que uma gravação ocorra simultaneamente a uma leitura ou outra, o driver precisa implementar a lógica de bloqueio de arquivos.

Segurança

No armazenamento em cache da compilação, o cache do modelo pode conter dados sensíveis à segurança, como código de máquina executável compilado no formato binário nativo do dispositivo. Se não estiver devidamente protegido, uma modificação no cache do modelo poderá afetar o comportamento de execução do driver. Como o conteúdo do cache é armazenado no diretório de apps, os arquivos de cache podem ser modificados pelo cliente. Um cliente com bugs pode corromper acidentalmente o cache, e um cliente mal-intencionado pode usar isso intencionalmente para executar código não verificado no dispositivo. Dependendo das características do dispositivo, isso pode ser um problema de segurança. Portanto, o driver precisa ser capaz de detectar uma possível corrupção do cache do modelo antes de prepará-lo.

Uma maneira de fazer isso é o driver manter um mapa do token para um hash criptográfico do cache do modelo. O driver pode armazenar o token e o hash do cache do modelo ao salvar a compilação no cache. O driver verifica o novo hash do cache do modelo com o token registrado e o par de hash ao recuperar a compilação do cache. Esse mapeamento precisa ser persistente em todas as reinicializações do sistema. O driver pode usar o serviço de keystore do Android, a biblioteca de utilitários em framework/ml/nn/driver/cache ou qualquer outro mecanismo adequado para implementar um gerenciador de mapeamento. Após a atualização do driver, esse gerenciador de mapeamento precisa ser reinicializado para evitar a preparação de arquivos em cache de uma versão anterior.

Para evitar ataques de tempo de verificação até o horário de uso (TOCTOU, na sigla em inglês), o driver precisa calcular o hash gravado antes de salvar no arquivo e calcular o novo hash depois de copiar o conteúdo do arquivo em um buffer interno.

Este exemplo de código demonstra como implementar essa lógica.

bool saveToCache(const sp<V1_2::IPreparedModel> preparedModel,
                 const hidl_vec<hidl_handle>& modelFds, const hidl_vec<hidl_handle>& dataFds,
                 const HidlToken& token) {
    // Serialize the prepared model to internal buffers.
    auto buffers = serialize(preparedModel);

    // This implementation detail is important: the cache hash must be computed from internal
    // buffers instead of cache files to prevent time-of-check to time-of-use (TOCTOU) attacks.
    auto hash = computeHash(buffers);

    // Store the {token, hash} pair to a mapping manager that is persistent across reboots.
    CacheManager::get()->store(token, hash);

    // Write the cache contents from internal buffers to cache files.
    return writeToFds(buffers, modelFds, dataFds);
}

sp<V1_2::IPreparedModel> prepareFromCache(const hidl_vec<hidl_handle>& modelFds,
                                          const hidl_vec<hidl_handle>& dataFds,
                                          const HidlToken& token) {
    // Copy the cache contents from cache files to internal buffers.
    auto buffers = readFromFds(modelFds, dataFds);

    // This implementation detail is important: the cache hash must be computed from internal
    // buffers instead of cache files to prevent time-of-check to time-of-use (TOCTOU) attacks.
    auto hash = computeHash(buffers);

    // Validate the {token, hash} pair by a mapping manager that is persistent across reboots.
    if (CacheManager::get()->validate(token, hash)) {
        // Retrieve the prepared model from internal buffers.
        return deserialize<V1_2::IPreparedModel>(buffers);
    } else {
        return nullptr;
    }
}

Casos de uso avançados

Em determinados casos de uso avançados, um driver exige acesso ao conteúdo do cache (leitura ou gravação) após a chamada de compilação. Estes são alguns exemplos de casos de uso:

• Compilação just-in-time:a compilação é adiada até a primeira execução.
• Compilação em vários estágios:uma compilação rápida é realizada inicialmente, e uma compilação otimizada opcional é realizada mais tarde, dependendo da frequência de uso.

Para acessar o conteúdo do cache (leitura ou gravação) após a chamada de compilação, verifique se o driver:

• Duplica o gerenciador de arquivos durante a invocação de prepareModel_1_2 ou prepareModelFromCache e lê/atualiza o conteúdo do cache em um momento posterior.
• Implementa a lógica de bloqueio de arquivos fora da chamada de compilação comum para evitar que uma gravação ocorra simultaneamente a uma leitura ou outra.

Implementar um mecanismo de armazenamento em cache

Além da interface de armazenamento em cache da compilação da NN HAL 1.2, também é possível encontrar uma biblioteca de utilitários de armazenamento em cache no diretório frameworks/ml/nn/driver/cache. O subdiretório nnCache contém um código de armazenamento persistente para que o driver implemente o armazenamento em cache de compilação sem usar os recursos de armazenamento em cache da NNAPI. Essa forma de armazenamento em cache de compilação pode ser implementada com qualquer versão da NN HAL. Se o driver optar por implementar o armazenamento em cache desconectado da interface da HAL, ele será responsável por liberar os artefatos em cache quando eles não forem mais necessários.