Integrazione di sistemi di build C/C++ personalizzati utilizzando Ninja (sperimentale)

Se non utilizzi CMake o ndk-build, ma vuoi un'integrazione completa della build C/C++ del plug-in Android Gradle (AGP) e di Android Studio, puoi creare un sistema di build C/C++ personalizzato creando uno script di shell che scrive le informazioni sulla build nel formato file di build Ninja.

Il supporto sperimentale per i sistemi di build C/C++ personalizzati è stato aggiunto ad Android Studio e AGP. Questa funzionalità è disponibile a partire da Android Studio Dolphin | 2021.3.1 Canary 4.

Panoramica

Un pattern comune per i progetti C/C++, in particolare quelli che hanno come target più piattaforme, è generare progetti per ciascuna di queste piattaforme da una rappresentazione sottostante. Un esempio importante di questo pattern è CMake. CMake può generare progetti per Android, iOS e altre piattaforme da un'unica rappresentazione sottostante, salvata nel file CMakeLists.txt.

Sebbene CMake sia supportato direttamente da AGP, sono disponibili altri generatori di progetti che non sono supportati direttamente:

Questi tipi di generatori di progetti supportano Ninja come rappresentazione di backend della build C/C++ o possono essere adattati per generare Ninja come rappresentazione di backend.

Se configurato correttamente, un progetto AGP con un generatore di sistemi di progetti C/C++ integrato consente agli utenti di:

  • Crea dalla riga di comando e da Android Studio.

  • Modifica le origini con il supporto completo del servizio linguistico (ad esempio, vai alla definizione) in Android Studio.

  • Utilizza i debugger di Android Studio per eseguire il debug di processi nativi e misti.

Come modificare la build per utilizzare uno script di configurazione di compilazione C/C++ personalizzato

Questa sezione illustra i passaggi per utilizzare uno script di configurazione di compilazione C/C++ personalizzato da AGP.

Passaggio 1: modifica il file build.gradle a livello di modulo per fare riferimento a uno script di configurazione

Per attivare il supporto di Ninja in AGP, configura experimentalProperties nel file build.gradle a livello di modulo:

android {
  defaultConfig {
    externalNativeBuild {
      experimentalProperties["ninja.abiFilters"] = [ "x86", "arm64-v8a" ]
      experimentalProperties["ninja.path"] = "source-file-list.txt"
      experimentalProperties["ninja.configure"] = "configure-ninja"
      experimentalProperties["ninja.arguments"] = [
            "\${ndk.moduleMakeFile}",
            "--variant=\${ndk.variantName}",
            "--abi=Android-\${ndk.abi}",
            "--configuration-dir=\${ndk.configurationDir}",
            "--ndk-version=\${ndk.moduleNdkVersion}",
            "--min-sdk-version=\${ndk.minSdkVersion}"
       ]
     }
   }

Le proprietà vengono interpretate da AGP come segue:

  • ninja.abiFilters è un elenco di ABI da creare. I valori validi sono: x86, x86-64, armeabi-v7a e arm64-v8a.

  • ninja.path è un percorso di un file di progetto C/C++. Il formato di questo file può essere quello che preferisci. Le modifiche a questo file attiveranno un prompt per la sincronizzazione di Gradle in Android Studio.

  • ninja.configure è un percorso di un file di script che verrà eseguito da Gradle quando è necessario configurare il progetto C/C++. Un progetto viene configurato alla prima build, durante una sincronizzazione di Gradle in Android Studio o quando uno degli input dello script di configurazione cambia.

  • ninja.arguments è un elenco di argomenti che verranno passati allo script definito da ninja.configure. Gli elementi di questo elenco possono fare riferimento a un insieme di macro i cui valori dipendono dal contesto di configurazione corrente in AGP:

    • ${ndk.moduleMakeFile} è il percorso completo del file ninja.configure. Nell'esempio, sarebbe C:\path\to\configure-ninja.bat.

    • ${ndk.variantName} è il nome della variante AGP corrente che viene creata. Ad esempio, debug o release.

    • ${ndk.abi} è il nome dell'ABI AGP corrente in fase di creazione. Ad esempio, x86 o arm64-v8a.

    • ${ndk.buildRoot} è il nome di una cartella, generata da AGP, in cui lo script scrive il proprio output. I dettagli verranno spiegati nel Passaggio 2: crea lo script di configurazione.

    • ${ndk.ndkVersion} è la versione dell'NDK da utilizzare. In genere, questo è il valore passato ad android.ndkVersion nel file build.gradle o un valore predefinito se non è presente alcun valore.

    • ${ndk.minPlatform} è la piattaforma Android target minima richiesta da AGP.

  • ninja.targets è un elenco dei target Ninja specifici che devono essere creati.

Passaggio 2: crea lo script di configurazione

La responsabilità minima dello script di configurazione (configure-ninja.bat nell'esempio precedente) è generare un file build.ninja che, se creato con Ninja, compilerà e collegherà tutti gli output nativi del progetto. In genere, si tratta di file .o (oggetto), .a (archivio) e .so (oggetto condiviso).

Lo script di configurazione può scrivere il file build.ninja in due posizioni diverse a seconda delle tue esigenze.

  • Se è possibile che AGP scelga una posizione, lo script di configurazione scrive build.ninja nella posizione impostata nella macro ${ndk.buildRoot}.

  • Se lo script di configurazione deve scegliere la posizione del file build.ninja, scrive anche un file denominato build.ninja.txt nella posizione impostata nella macro ${ndk.buildRoot}. Questo file contiene il percorso completo del file build.ninja scritto dallo script di configurazione.

Struttura del file build.ninja

In genere, la maggior parte delle strutture che rappresentano accuratamente una build Android C/C++ funzionerà. Gli elementi chiave richiesti da AGP e Android Studio sono:

  • L'elenco dei file di codice sorgente C/C++ insieme ai flag necessari a Clang per compilarli.

  • L'elenco delle librerie di output. In genere si tratta di file .so (oggetto condiviso), ma possono anche essere file .a (archivio) o eseguibili (senza estensione).

Se hai bisogno di esempi su come generare un file build.ninja, puoi esaminare l'output di CMake quando viene utilizzato il generatore build.ninja.

Ecco un esempio di un template build.ninja minimo.

rule COMPILE
   command = /path/to/ndk/clang -c $in -o $out {other flags}
rule LINK
   command = /path/to/ndk/clang $in -o $out {other flags}

build source.o : COMPILE source.cpp
build lib.so : LINK source.o

Consigli

Oltre ai requisiti (elenco dei file di origine e delle librerie di output), ecco alcuni consigli.

Dichiara gli output denominati con le regole phony

Se possibile, è consigliabile che la struttura build.ninja utilizzi le regole phony per assegnare nomi leggibili agli output della build. Ad esempio, se hai un output denominato c:/path/to/lib.so, puoi assegnargli un nome leggibile come segue.

build curl: phony /path/to/lib.so

Il vantaggio di questa operazione è che puoi specificare questo nome come target di build nel file build.gradle. Ad esempio:

android {
  defaultConfig {
    externalNativeBuild {
      ...
      experimentalProperties["ninja.targets"] = [ "curl" ]

Specifica un target "all"

Quando specifichi un target all, questo sarà l'insieme predefinito di librerie create da AGP quando non vengono specificati esplicitamente target nel file build.gradle.

rule COMPILE
   command = /path/to/ndk/clang $in -o $out {other flags}
rule LINK
   command = /path/to/ndk/clang $in -o $out {other flags}

build foo.o : COMPILE foo.cpp
build bar.o : COMPILE bar.cpp
build libfoo.so : LINK foo.o
build libbar.so : LINK bar.o
build all: phony libfoo.so libbar.so

(Facoltativo) Specifica un metodo di creazione alternativo

Un caso d'uso più avanzato consiste nel wrapping di un sistema di build esistente non basato su Ninja. In questo caso, devi comunque rappresentare tutte le origini con i relativi flag insieme alle librerie di output, in modo che Android Studio possa presentare le funzionalità del servizio linguistico appropriate, come il completamento automatico e la definizione di go-to. Tuttavia, vuoi che AGP si affidi al sistema di build sottostante durante la build effettiva.

Per farlo, puoi utilizzare un output di build Ninja con un'estensione specifica .passthrough.

Come esempio più concreto, per eseguire il wrapping di un MSBuild, lo script di configurazione genera il file build.ninja come di consueto, ma aggiunge anche una destinazione passthrough che definisce il modo in cui AGP richiamerà MSBuild.

rule COMPILE
   command = /path/to/ndk/clang $in -o $out {other flags}
rule LINK
   command = /path/to/ndk/clang $in -o $out {other flags}

rule MBSUILD_CURL
  command = /path/to/msbuild {flags to build curl with MSBuild}

build source.o : COMPILE source.cpp
build lib.so : LINK source.o
build curl : phony lib.so
build curl.passthrough : MBSUILD_CURL

Invia un feedback

Questa funzionalità è sperimentale, pertanto i feedback sono molto apprezzati. Puoi fornire un feedback tramite i seguenti canali:

  • Per un feedback generale, aggiungi un commento al bug correlato.

  • Per segnalare un bug, apri Android Studio e fai clic su Guida > Invia feedback. Assicurati di fare riferimento a "Sistemi di build C/C++ personalizzati" per indirizzare il bug.

  • Per segnalare un bug se non hai installato Android Studio, segnalalo utilizzando il modello di bug.