Mise en cache de la compilation

À partir d'Android 10, l'API Neural Networks (NNAPI) fournit des fonctions pour prendre en charge mise en cache des artefacts de compilation, ce qui réduit le temps consacré à la compilation au démarrage d'une application. Grâce à cette fonctionnalité de mise en cache, le pilote n'a pas besoin de gérer ni de nettoyer les fichiers mis en cache. Cette fonctionnalité facultative peut être implémenté avec NN HAL 1.2. Pour en savoir plus sur cette fonction, voir ANeuralNetworksCompilation_setCaching

Le pilote peut également implémenter le cache de compilation indépendamment de la NNAPI. Ce peuvent être implémentés que les fonctionnalités de mise en cache NNAPI NDK et HAL soient utilisées ou non. AOSP fournit une bibliothèque d'utilitaires de bas niveau (un moteur de mise en cache). Pour plus plus d'informations, consultez l'article Implémenter un moteur de mise en cache.

Présentation du workflow

Cette section décrit les workflows généraux avec la fonctionnalité de mise en cache de compilation implémentée.

Informations sur le cache fournies et succès de cache

  1. L'application transmet un répertoire de mise en cache et une somme de contrôle propre au modèle.
  2. L'environnement d'exécution NNAPI recherche les fichiers de cache en fonction de la somme de contrôle, de la préférence d'exécution et du résultat du partitionnement, puis les trouve.
  3. NNAPI ouvre les fichiers de cache et transmet les poignées au pilote avec prepareModelFromCache.
  4. Le pilote prépare le modèle directement à partir des fichiers de cache et renvoie le modèle préparé.

Informations sur le cache fournies et défaut de cache

  1. L'application transmet une somme de contrôle propre au modèle et un répertoire de mise en cache.
  2. L'environnement d'exécution NNAPI recherche les fichiers de mise en cache en fonction de la somme de contrôle, de la préférence d'exécution et du résultat du partitionnement, et ne les trouve pas.
  3. Le réseau NNAPI crée des fichiers de cache vides en se basant sur la somme de contrôle, l'exécution puis le partitionnement, ouvre les fichiers de cache et transmet et le modèle au pilote prepareModel_1_2
  4. Le pilote compile le modèle, écrit des informations de mise en cache dans les fichiers de cache et renvoie le modèle préparé.

Informations sur le cache non fournies

  1. L'application appelle la compilation sans fournir d'informations de mise en cache.
  2. L'application ne transmet rien concernant la mise en cache.
  3. L'environnement d'exécution NNAPI transmet le modèle au pilote avec prepareModel_1_2.
  4. Le pilote compile le modèle et renvoie le modèle préparé.

Informations sur le cache

Les informations de mise en cache fournies à un pilote se composent d'un jeton et de poignées de fichiers de cache.

Jeton

La jeton est un jeton de mise en cache de longueur Constant::BYTE_SIZE_OF_CACHE_TOKEN qui identifie le modèle préparé. Le même jeton est fourni lors de l'enregistrement des fichiers de cache avec prepareModel_1_2 et de la récupération du modèle préparé avec prepareModelFromCache. Le client du pilote doit choisir un jeton avec un un faible taux de collision. Le pilote ne peut pas détecter de collision de jetons. Une collision entraîne un échec de l'exécution ou une exécution réussie qui produit des valeurs de sortie incorrectes.

Handles de fichiers de cache (deux types de fichiers de cache)

Les deux types de fichiers de cache sont le cache de données et le cache du modèle.

  • Cache de données:permet de mettre en cache des données constantes, y compris les données des tampons de Tensor transformés. Une modification du cache de données ne devrait pas avoir d'effet pire que de générer de mauvaises valeurs de sortie au moment de l'exécution.
  • Cache de modèle : utilisez-le pour mettre en cache des données sensibles à la sécurité telles que le code machine exécutable compilé au format binaire natif de l'appareil. Une modification du cache du modèle peut affecter le comportement d'exécution du pilote, et un client malveillant peut s'en servir pour exécuter des actions au-delà de l'autorisation accordée. Le pilote doit donc vérifier si le cache du modèle est corrompue avant de préparer le modèle à partir du cache. Pour en savoir plus, consultez la section Sécurité.

Le pilote doit décider de la répartition des informations de cache entre les deux types de fichiers de cache et indiquer le nombre de fichiers de cache dont il a besoin pour chaque type avec getNumberOfCacheFilesNeeded.

L'environnement d'exécution NNAPI ouvre toujours les poignées de fichiers de cache avec les autorisations de lecture et d'écriture.

Sécurité

Dans le cas du cache de compilation, le cache du modèle peut contenir des données sensibles à la sécurité, telles que du code machine exécutable compilé au format binaire natif de l'appareil. Si elle n'est pas correctement protégée, une modification du cache du modèle peut affecter le comportement d'exécution du pilote. Étant donné que le contenu du cache est stocké dans le répertoire de l'application, les fichiers de cache peuvent être modifiés par le client. Un client présentant des bugs peut corrompre accidentellement le cache, et un client malveillant pourrait intentionnellement l'utiliser pour exécuter du code non vérifié sur l'appareil. Selon les caractéristiques de l'appareil, cela peut constituer un problème de sécurité. Ainsi, le conducteur doit pouvoir détecter une corruption potentielle du cache du modèle avant de le préparer à partir du cache.

Pour ce faire, le conducteur peut gérer une carte du jeton le hachage cryptographique du cache du modèle. Le pilote peut stocker le jeton le hachage du cache de son modèle lors de l'enregistrement de la compilation dans le cache. Le conducteur vérifie le nouveau hachage du cache du modèle avec le jeton et la paire de hachage enregistrés récupérer la compilation à partir du cache. Cette mise en correspondance doit être persistante lors des redémarrages du système. Le conducteur peut utiliser Service Keystore Android, la bibliothèque d'utilitaires disponible dans framework/ml/nn/driver/cache, ou tout autre mécanisme approprié pour implémenter un gestionnaire de mappage. Lors de la mise à jour du pilote, ce gestionnaire de mappage doit être réinitialisé pour éviter de préparer des fichiers de cache à partir d'une version antérieure.

Pour éviter de l'heure d'arrivée à l'heure d'utilisation (TOCTOU), le pilote doit calculer le hachage enregistré avant de l'enregistrer et calculer le nouveau hachage après avoir copié le contenu du fichier tampon.

Cet exemple de code montre comment implémenter cette logique.

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

Cas d'utilisation avancés

Dans certains cas d'utilisation avancés, un pilote nécessite un accès au contenu du cache (lecture ou écriture) après l'appel de compilation. Voici quelques exemples de cas d'utilisation:

  • Compilation juste à temps:la compilation est retardée jusqu'à pour la première exécution.
  • Compilation à plusieurs étapes:une compilation rapide est effectuée initialement et une compilation optimisée facultative est effectuée ultérieurement selon la fréquence d'utilisation.

Pour accéder au contenu du cache (lecture ou écriture) après l'appel de compilation, assurez-vous que le pilote :

  • Il duplique les descripteurs de fichier lors de l'appel de prepareModel_1_2 ou prepareModelFromCache, et lit/met à jour le cache le contenu par la suite.
  • Implémente la logique de verrouillage de fichier en dehors de l'appel de compilation ordinaire pour éviter qu'une écriture ne se produise simultanément avec une lecture ou une autre écriture.

Implémenter un moteur de mise en cache

En plus de l'interface de mise en cache de la compilation NN HAL 1.2, vous disposez d'un bibliothèque d'utilitaires de mise en cache frameworks/ml/nn/driver/cache . La nnCache contenant le code de stockage persistant que le pilote doit implémenter de la compilation sans utiliser les fonctionnalités de mise en cache NNAPI. Cette forme de mise en cache de compilation peut être implémentée avec n'importe quelle version du HAL de NN. Si le le pilote choisit d’implémenter la mise en cache déconnecté de l’interface HAL, le conducteur est est responsable de la libération des artefacts mis en cache lorsqu’ils ne sont plus nécessaires.