Système de construction Soong

Avant la version Android 7.0, Android utilisait GNU Make exclusivement pour décrire et exécuter ses règles de construction. Le système de construction Make est largement pris en charge et utilisé, mais à l'échelle d'Android, il est devenu lent, sujet aux erreurs, non évolutif et difficile à tester. Le système de build Soong offre la flexibilité requise pour les builds Android.

Pour cette raison, les développeurs de plates-formes devraient passer de Make et adopter Soong dès que possible. Envoyez des questions au groupe Google de création d'Android pour recevoir de l'aide.

Qu'est-ce que Soong ?

Le système de construction Soong a été introduit dans Android 7.0 (Nougat) pour remplacer Make. Il exploite l'outil de clonage Kati GNU Make et le composant du système de construction Ninja pour accélérer les constructions d'Android.

Voir la description du système Android Make Build System dans le projet Open Source Android (AOSP) pour les instructions générales et les modifications du système Build pour les rédacteurs Android.mk pour en savoir plus sur les modifications nécessaires pour s'adapter de Make à Soong.

Voir les entrées liées à la construction dans le glossaire pour les définitions des termes clés et les fichiers de référence Soong pour des détails complets.

Comparaison de Make et Soong

Voici une comparaison de la configuration Make avec Soong accomplissant la même chose dans un fichier de configuration Soong (Blueprint ou .bp ).

Faire un exemple

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE := libxmlrpc++
LOCAL_MODULE_HOST_OS := linux

LOCAL_RTTI_FLAG := -frtti
LOCAL_CPPFLAGS := -Wall -Werror -fexceptions
LOCAL_EXPORT_C_INCLUDES := $(LOCAL_PATH)/src

LOCAL_SRC_FILES := $(call \
     all-cpp-files-under,src)
include $(BUILD_SHARED_LIBRARY)

Exemple de Soong

cc_library_shared {
     name: “libxmlrpc++”,

     rtti: true,
     cppflags: [
           “-Wall”,
           “-Werror”,
           “-fexceptions”,
     ],
     export_include_dirs: [“src”],
     srcs: [“src/**/*.cpp”],

     target: {
           darwin: {
                enabled: false,
           },
     },
}

Voir Configuration de construction simple pour des exemples de configuration Soong spécifiques au test.

Format de fichier Android.bp

De par leur conception, les fichiers Android.bp sont simples. Ils ne contiennent pas de conditions ni d'instructions de flux de contrôle ; toute la complexité est gérée par une logique de construction écrite en Go. Lorsque cela est possible, la syntaxe et la sémantique des fichiers Android.bp sont similaires à celles des fichiers Bazel BUILD .

Modules

Un module dans un fichier Android.bp commence par un type de module suivi d'un ensemble de propriétés de name: "value", format :

cc_binary {
    name: "gzip",
    srcs: ["src/test/minigzip.c"],
    shared_libs: ["libz"],
    stl: "none",
}

Chaque module doit avoir une propriété de name et la valeur doit être unique dans tous les fichiers Android.bp , à l'exception des valeurs de propriété de name dans les espaces de noms et les modules prédéfinis, qui peuvent se répéter.

La propriété srcs spécifie les fichiers source utilisés pour construire le module, sous la forme d'une liste de chaînes. Vous pouvez référencer la sortie d'autres modules qui produisent des fichiers source, comme genrule ou filegroup , en utilisant la syntaxe de référence de module ":<module-name>" .

Pour obtenir une liste des types de modules valides et de leurs propriétés, consultez la Référence des modules Soong .

Les types

Les variables et les propriétés sont fortement typées, avec des variables basées dynamiquement sur la première affectation et des propriétés définies statiquement par le type de module. Les types pris en charge sont :

  • Booléens ( true ou false )
  • Entiers ( int )
  • Chaînes ( "string" )
  • Listes de chaînes ( ["string1", "string2"] )
  • Cartes ( {key1: "value1", key2: ["value2"]} )

Les cartes peuvent contenir des valeurs de n'importe quel type, y compris des cartes imbriquées. Les listes et les cartes peuvent avoir des virgules après la dernière valeur.

Globes

Les propriétés qui prennent une liste de fichiers, telles que srcs , peuvent également prendre des modèles glob. Les modèles Glob peuvent contenir le caractère générique UNIX normal * , par exemple *.java . Les modèles Glob peuvent également contenir un seul caractère générique ** comme élément de chemin, qui correspond à zéro ou plusieurs éléments de chemin. Par exemple, java/**/*.java correspond à la fois aux java/Main.java et java/com/android/Main.java .

variables

Un fichier Android.bp peut contenir des affectations de variables de niveau supérieur :

gzip_srcs = ["src/test/minigzip.c"],
cc_binary {
    name: "gzip",
    srcs: gzip_srcs,
    shared_libs: ["libz"],
    stl: "none",
}

Les variables sont étendues au reste du fichier dans lequel elles sont déclarées, ainsi qu'à tous les fichiers Blueprint enfants. Les variables sont immuables à une exception près : elles peuvent être ajoutées avec une affectation += , mais seulement avant d'avoir été référencées.

commentaires

Les fichiers Android.bp peuvent contenir des commentaires multilignes de style C /* */ et monolignes // de style C++.

Les opérateurs

Les chaînes, les listes de chaînes et les cartes peuvent être ajoutées à l'aide de l'opérateur +. Les nombres entiers peuvent être additionnés à l'aide de l'opérateur + . L'ajout d'une carte produit l'union des clés dans les deux cartes, en ajoutant les valeurs de toutes les clés présentes dans les deux cartes.

Conditionnels

Soong ne prend pas en charge les conditions dans les fichiers Android.bp . Au lieu de cela, la complexité des règles de construction qui nécessiteraient des conditions est gérée dans Go, où des fonctionnalités de langage de haut niveau peuvent être utilisées et les dépendances implicites introduites par les conditions peuvent être suivies. La plupart des conditions sont converties en une propriété de carte, où l'une des valeurs de la carte est sélectionnée et ajoutée aux propriétés de niveau supérieur.

Par exemple, pour prendre en charge des fichiers spécifiques à l'architecture :

cc_library {
    ...
    srcs: ["generic.cpp"],
    arch: {
        arm: {
            srcs: ["arm.cpp"],
        },
        x86: {
            srcs: ["x86.cpp"],
        },
    },
}

Formateur

Soong inclut un formateur canonique pour les fichiers Blueprint, similaire à gofmt . Pour reformater de manière récursive tous les fichiers Android.bp du répertoire actuel, exécutez :

bpfmt -w .

Le format canonique comprend des retraits de quatre espaces, de nouvelles lignes après chaque élément d'une liste multi-éléments et une virgule de fin dans les listes et les cartes.

Modules spéciaux

Certains groupes de modules spéciaux ont des caractéristiques uniques.

Modules par défaut

Un module par défaut peut être utilisé pour répéter les mêmes propriétés dans plusieurs modules. Par example:

cc_defaults {
    name: "gzip_defaults",
    shared_libs: ["libz"],
    stl: "none",
}

cc_binary {
    name: "gzip",
    defaults: ["gzip_defaults"],
    srcs: ["src/test/minigzip.c"],
}

Modules prédéfinis

Certains types de modules prédéfinis permettent à un module d'avoir le même nom que ses homologues basés sur la source. Par exemple, il peut y avoir un cc_prebuilt_binary nommé foo alors qu'il existe déjà un cc_binary avec le même nom. Cela donne aux développeurs la possibilité de choisir la version à inclure dans leur produit final. Si une configuration de génération contient les deux versions, la valeur de l'indicateur de prefer dans la définition du module prédéfini dicte quelle version a la priorité. Notez que certains modules prédéfinis ont des noms qui ne commencent pas par prebuilt , tels que android_app_import .

Modules d'espace de noms

Jusqu'à ce qu'Android effectue une conversion complète de Make vers Soong, la configuration du produit Make doit spécifier une valeur PRODUCT_SOONG_NAMESPACES . Sa valeur doit être une liste d'espaces de noms séparés par des espaces que Soong exporte vers Make pour être construit par la commande m . Une fois la conversion d'Android vers Soong terminée, les détails de l'activation des espaces de noms pourraient changer.

Soong permet aux modules de différents répertoires de spécifier le même nom, tant que chaque module est déclaré dans un espace de noms distinct. Un espace de noms peut être déclaré comme ceci :

soong_namespace {
    imports: ["path/to/otherNamespace1", "path/to/otherNamespace2"],
}

Notez qu'un espace de noms n'a pas de propriété name ; son chemin est automatiquement attribué comme son nom.

Chaque module Soong se voit attribuer un espace de noms en fonction de son emplacement dans l'arborescence. Chaque module Soong est considéré comme étant dans l'espace de noms défini par le soong_namespace trouvé dans un fichier Android.bp dans le répertoire courant ou le répertoire ancêtre le plus proche. Si aucun tel module soong_namespace n'est trouvé, le module est considéré comme étant dans l'espace de noms racine implicite.

Voici un exemple : Soong tente de résoudre la dépendance D déclarée par le module M dans l'espace de noms N qui importe les espaces de noms I1, I2, I3…

  1. Ensuite, si D est un nom pleinement qualifié de la forme //namespace:module , seul l'espace de noms spécifié est recherché pour le nom de module spécifié.
  2. Sinon, Soong recherche d'abord un module nommé D déclaré dans l'espace de noms N.
  3. Si ce module n'existe pas, Soong recherche un module nommé D dans les espaces de noms I1, I2, I3…
  4. Enfin, Soong regarde dans l'espace de noms racine.