====== Selbstgebautes Image (Custom ROM) ======

Nachfolgend soll das Erstellen eines selbstgebauten Android-Abbildes (Custom ROM) beschrieben werden. Es werden dabei mehrere Seiten im Internet abgearbeitet.

\\

===== Nützliche Webseiten =====

Auf folgenden Webseiten wurden Informationen abgegriffen:
  * [[https://forum.xda-developers.com/chef-central/android/how-to-build-lineageos-14-1-t3551484|xda-developers.com]]
  * [[https://wiki.lineageos.org/devices/klte/build|lineageos.org]]

\\

===== Voraussetzungen =====

Es wird ein DEBIAN-Linux-System vorausgesetzt, sowie eine Verbindung zum Internet, um Dateien herunterzuladen. Es kann ein [[debian-linux:minimalinstallation|Minimalinstallation]] als Voraussetzung genutzt werden. Nachfolgend werden alle Schritte in einer [[software:schroot#schroot|CHROOT-Umgebung]] durchgeführt.

\\

Das gebaute Image wird immer für ein bestimmtes Gerät gebaut. Dafür muss das Gerät, zum Beispiel von [[https://wiki.lineageos.org/devices/|LineageOS]], unterstützt werden.

\\

===== Vorbereitung =====

Zur Vorbereitung des Bausystems gehört das Erstellen einer geeigneten Verzeichnisstruktur, die Installation von bauabhängigen Paketen und JAVA, sowie mehreren Werkzeugen, die von anderen Quellen geholt werden.

\\

=== Verzeichnisstruktur ===

Nachfolgend werden alle zusätzlichen Programme (zum Beispiel das SDK), die nicht als Pakete installiert werden, sowie die späteren Daten, die beim Bauen erstellt werden, in ein eigenen Unterverzeichnis gepackt. Das hat den Vorteil, dass dieses Verzeichnis bei Bedarf auch auf einen anderen Rechner kopiert und dort ebenfalls ausgeführt werdne können.

Es wird ein Verzeichnis erstellt, in dem alle Daten gespeichert werden:

<code>~$ mkdir -p ~/AnroidCustomROM/bin</code>

\\

Es ist ratsam für jede Android-Version, die gebaut werden soll, ein eigenes Unterverzeichnis zu erstellen:

<code>~$ mkdir ~/AndroidCustomROM/cm-14.1</code>

\\

=== Bauabhängigkeiten ===

Im zweiten Schritt müssen die Bauabhängigkeiten installiert werden:

<code>~# apt install bc bison build-essential curl flex g++-multilib gcc-multilib git gnupg gperf imagemagick \
lib32ncurses5-dev lib32readline6-dev lib32z1-dev libesd0-dev liblz4-tool libncurses5-dev libsdl1.2-dev libwxgtk3.0-dev \
libxml2 libxml2-utils lzop pngcrush schedtool squashfs-tools xsltproc zip zlib1g-dev python</code>

\\

=== JAVA ===

Die verschiedenen Versionen von <nowiki>LineageOS</nowiki> benötigen unterschiedliche JAVA-Versionen. Nachfolgend wird aufgrund der Vereinfachung von der Version 14.1 ausgegangen, welche <nowiki>OpenJDK</nowiki> 1.8 benötigt:

<code>~# apt install openjdk-8-jdk</code>

\\

=== SDK ===

Das SDK von [[https://dl.google.com/android/repository/platform-tools-latest-linux.zip|Google]] sollte auf dem System installiert werden, damit die Programme "''adb''" und "''fastboot''" in aktuellen Versionen zur Verfügung stehen. Nach dem Herunterladen des ZIP-Archives wird diese einfach im Bauverzeichnis entpackt:

<code>~$ unzip platform-tools-latest-linux.zip -d ~/AndroidCustomROM/bin/
Archive:  platform-tools-latest-linux.zip
  inflating: ~/AndroidCustomROM/bin/platform-tools/adb  
   creating: ~/AndroidCustomROM/bin/platform-tools/api/
...
  inflating: ~/AndroidCustomROM/bin/platform-tools/systrace/catapult/common/lab/hardware.py  
  inflating: ~/AndroidCustomROM/bin/platform-tools/systrace/systrace.py  
  inflating: ~/AndroidCustomROM/bin/platform-tools/systrace/NOTICE</code>

\\

Damit der Aufruf von "''adb''" und "''fastboot''" auch von überall aus funktioniert, ist es ratsam, das neu erstellte Verzeichnis in die Pfadumgebung mit aufzunehmen. Nachfolgend wird dies über die Datei "''~/.bashrc''" gemacht:

<code>if [ -d "${HOME}/AndroidCustomROM/bin/platform-tools" ]; then
    PATH="${HOME}/AndroidCustomROM/bin/platform-tools:${PATH}";
fi;</code>

\\

=== Repo ===

Das Repo-Kommando dient dazu, die verschiedenen Android-GIT-Repositories zu verwalten. Es ist ein Python-Skript, welches auf GIT selbst aufbaut und das Synchronisieren der Repositories vereinfacht. Das Programm wird ebenfalls von [[https://storage.googleapis.com/git-repo-downloads/repo|Google]] heruntergeladen:

<code>~$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/AndroidCustomROM/bin/repo
~# chmod +x ~/AndroidCustomROM/bin/repo</code>

\\

Auch dieser Pfad kann in die Pfadumgebung aufgenommen werden:

<code>if [ -d "${HOME}/AndroidCustomROM/bin" ]; then
    PATH="${HOME}/AndroidCustomROM/bin:${PATH}";
fi;</code>

\\

=== sdat2img ===

Das Programm "''[[https://github.com/xpirt/sdat2img|sdat2img]]''" wird dazu verwendet, um Android-Image-Datei in ein lesbares Format umzuwandeln:

<code>~$ git clone https://github.com/xpirt/sdat2img /tmp/sdat2img
~$ mv /tmp/sdat2img/sdat2img.py ~//AndroidCustomROM/bin/</code>

\\

=== GNU Arm Embedded Toolchain ===

Damit die Kompilierung funktioniert, ist es erforderlich, dass die [[https://developer.arm.com/open-source/gnu-toolchain/gnu-arm-embedded-toolchain|GNU Arm Embedded Toolchain]] auf dem System installiert sind.

\\

Das aktuelle Archiv wird heruntergeladen und entpackt:

<code>~$ tar xvfj gcc-arm-none-eabi-7-2017-q4-major-linux.tar.bz2 -C ~/AndroidCustomROM/bin/
gcc-arm-none-eabi-7-2017-q4-major/
gcc-arm-none-eabi-7-2017-q4-major/lib/
gcc-arm-none-eabi-7-2017-q4-major/lib/libcc1.so.0.0.0
...
gcc-arm-none-eabi-7-2017-q4-major/bin/arm-none-eabi-cpp
gcc-arm-none-eabi-7-2017-q4-major/bin/arm-none-eabi-gcc-7.2.1
gcc-arm-none-eabi-7-2017-q4-major/bin/arm-none-eabi-nm</code>

\\

Das neu erzeugte Verzeichnis kann zur Vereinfachung noch umbenannt werden:

<code>~$ mv -v ~/AndroidCustomROM/bin/gcc-arm-none-eabi-7-2017-q4-major ~/AndroidCustomROM/bin/gcc-arm-none-eabi                 
'~/AndroidCustomROM/bin/gcc-arm-none-eabi-7-2017-q4-major' -> '~/AndroidCustomROM/bin/gcc-arm-none-eabi'</code>

\\

<note important>In der vorhandenen CHROOT-Umgebung kann der Pfad um die ausführbaren Dateien im Verzeichnis "''gcc-arm-none-eabi/bin/''" erweitert werden. In einer realen Umgebung sollte darauf, wegen eventuellen Kompatiblitätsproblemen, verzichtet werden.</note>

\\

So lautet der Eintrag, wenn er in die Pfadumgebung aufgenommen werden soll:

<code>if [ -d "${HOME}/AndroidCustomROM/bin/gcc-arm-none-eabi/bin" ]; then
    PATH="${HOME}/AndroidCustomROM/bin/gcc-arm-none-eabi/bin:${PATH}";
fi;</code>

\\

=== GIT ===

GIT meckert beim späteren Initialisieren, dass keine Mailadresse und kein Benutzer angegeben sind. Mindestens diese Informationen sollten also vorher eingegeben werden:

<code>~$ git config --global user.email "<Mailadresse>"
~$ git config --global user.name "<Name>"</code>

\\

===== GIT-Repository =====

Es gibt mehrere Android-GIT-Repository, die für das Bauen eines Images (ROM) genutzt werden können. Dabei werden immer die beiden gleichen Schritte durchgeführt:

  * Initialisierung
  * Synchronisation

\\

=== Initialisierung ===

Jetzt erfolgt der Wechsel in das zuvor erstellte Arbeitsverzeichnis und die Initialisierung des Repository:

<code>~$ cd ~/AndroidCustomROM/cm-14.1
~$ repo init -u https://github.com/LineageOS/android.git -b cm-14.1
gpg: keybox '~/.repoconfig/gnupg/pubring.kbx' created
gpg: ~/.repoconfig/gnupg/trustdb.gpg: trustdb created
gpg: key 16530D5E920F5C65: public key "Repo Maintainer <repo@android.kernel.org>" imported
...
 * [new tag]         cm-7.0.2.1            -> cm-7.0.2.1
 * [new tag]         cm-7.0.3              -> cm-7.0.3
 * [new tag]         cm-7.1.0              -> cm-7.1.0

repo has been initialized in ~/AndroidCustomROM/cm-14.1</code>

\\

Zur Erklärung:
  * die Adresse "[[https://github.com/LineageOS/android.git]]" wurde aus der oben genannten Webseite "[[https://wiki.lineageos.org/devices/klte/build|lineageos.org]]" entnommen, die das Bauen eines LineageOS 14.1 für das Gerät "Samsung Galaxy S5" beschreibt
  * mit dem Parameter "''-b''" wird der Branch (hier in dem Fall "''cm-14.1''") ausgewählt
    * hier sind natürlich auch andere Branches möglich

\\

=== Synchronisation ===

Im nächsten Schritt kann dann das Repository synchronisiert werden, was, je nach Internetanbindung, etwas dauern kann, weil mehrere Gigabyte an Daten heruntergeladen werden:

<code>~$ repo sync -f --force-sync -j32
Fetching project platform/external/dagger2
Fetching project platform/external/vixl
Fetching project LineageOS/android_packages_apps_TvSettings
...
Checking out files: 100% (15774/15774), done.ut files:  16% (2540/15774)   
Checking out files: 100% (25/25), done.
Syncing work tree: 100% (580/580), done.</code>

\\

Zur Erklärung:
  * der Parameter "''-f --force-sync''" ist optional
  * der Parameter "''-j32''" kann, je nach Internetanbindung kleiner oder größer gesetzt werden

\\

=== Referenzierung ===

Die Initialisierung und Synchronisation des GIT-Repository muss für jeden Branch neu durchgeführt werden. Im Idealfall gibt es dafür ein neues Verzeichnis und die beiden Schritte werden wieder ausgeführt. Damit nicht wieder alle Repository-Daten heruntergeladen werden müssen, kann eine Referenzierung auf ein bestehendes Repository erfolgen.

\\

Nachfolgend soll das GIT-Repository "[[https://github.com/LineageOS/android]]" mit dem Branch "''lineage-15.1''" erstellt werden und als Referenz das Verzeichnis "''~/AdroidCustomROM/cm-14.1''" nutzen:

<code>~$ mkdir ~/AndroidCustomROM/lineage-15.1
~$ cd ~/AndroidCustomROM/lineage-15.1
~$ repo init -u repo init -u https://github.com/LineageOS/android.git -b lineage-15.1 --reference=~/AndroidCustomROM/cm-14.1/</code>

\\

Die Synchronisation erfolgt dann wie gewohnt:

<code>~$ repo sync -f --force-sync -j32</code>

\\

===== Gerätespezifikationen =====

Im späteren Bauvorgang kann es vorkommen, dass Daten vom Android-Gerät selbst benötigt werden. Dies wird nachfolgend näher beschrieben.

\\

==== Modifiziertes Gerät ===

Gibt es auf dem Android-Gerät bereits ein modifiziertes Betriebssystem (zum Beispiel LineageOS), können die notwendigen Daten von dort einfach extrahiert werden. Dafür muss das Gerät an den Rechner angeschlossen und folgender Befehl ausgeführt werden:

<code>~$ cd ~/AndroidCustomROM/cm-4.1/device/samsung/klte
~$ ./extract-files.sh</code>

\\

Zur Erkärung:
  * dies kann nur durchgeführt werden, wenn die Quellen bereits für ein bestimmtes Android-Gerät, hier in dem Fall "Samsung" mit dem internen Gerätenamen "klte" vorbereitet wurden

\\

==== Unmodifiziertes Gerät ===

Ist das Android-Gerät unmodifiziert, müssen die Gerätedaten manuell extrahiert werden. Dafür wird zum Beispiel ein <nowiki>LineageOS</nowiki>-Image von der [[https://download.lineageos.org/|Webseite]] benötigt. Es muss zwischen datei- und blockbasierten OTA-Images (OTA: over the air) unterschieden werden.

\\

=== Block-basiertes OTA ===

Bei block-basierten Images gibt es ein leeres Verzeichnis "''system''" und eine Datei "''system.transfer.list''".

\\

Im Verzeichnis "''~/AndroidCustomROM/cm-14.1''" wird ein Unterverzeichnis "''system_dump''" erstellt und dort hinein gewechselt werden:

<code>~$ mkdir ~/AndroidCustomROM/cm-14.1/system_dump
~$ cd ~/AndroidCustomROM/cm-14.1/system_dump</code>

\\

Jetzt werden die notwendigen Dateien aus dem heruntergeladenen Archiv entpackt:

<code>~$ unzip lineage-14.1-<Version>-klte-signed.zip system.transfer.list system.new.dat</code>

\\

Dann wird mit Hilfe des Skriptes "''sdat2img''" die block-basierte Images so umwandelt, dass sie eingehängt werden können:

<code>~$ python ~/AndroidCustomROM/bin/sdat2img.py system.transfer.list system.new.dat system.img</code>

\\

Dann ein Verzeichnis anlegen und einhängen:

<code>~# mkdir system/
~$ sudo mount system.img system/</code>

\\

Jetzt wieder zur Wurzel zurückspringen und die Dateien entpacken:

<code>~$ cd ../system/device/samsung/klte
~$ ./extract-files.sh ~/AndroidCustomROM/cm-14.1/system_dump/</code>

\\

Das eingehängte Image kann wieder ausgehängt und das erstellte Verzeichnis entfernt werden:

<code>~$ sudo umount ~/cm-14.1/system_dump/system
~$ rm -rf ~/cm-14.1/system_dump/</code>

\\

=== Datei-basiertes OTA ===

Bei dateibasierten OTAs gibt es ein Unterverzeichnis "''system''" innerhalb des Archives, welches auch weitere Verzeichnisse und Dateien enthält.

\\

Im Verzeichnis "''~/AndroidCustomROM/cm-14.1''" muss ein Unterverzeichnis "''system_dump''" erstellt und dort hinein gewechselt werden.

<code>~$ mkdir ~/AndroidCustomROM/cm-14.1/system_dump
~$ cd ~/AndroidCustomROM/cm-14.1/system_dump</code>

\\

Jetzt werden die notwendigen Dateien aus dem heruntergeladenen Archiv entpackt:

<code>~$ unzip lineage-14.1-<Version>-klte-signed.zip system/*</code>

\\

Jetzt wieder zur Wurzel zurückspringen und die Dateien entpacken:

<code>~$ cd ../system/device/samsung/klte
~$ ./extract-files.sh ~/AndroidCustomROM/cm-14.1/system_dump/</code>

\\

Das erstellte Verzeichnis kann entfernt werden:

<code>~$ rm -rf ~/AndroidCustomROM/cm-14.1/system_dump/</code>

\\

===== Bauumgebung anpassen =====

Es gibt ein paar Einstellungen, welche das Bauen des Images beeinflusst und unter Umständen auch verbessert beziehungsweise beschleunigt.

\\

=== Cache setzen ===

Damit das Bauen beschleunigt wird, kann der Cache-Speicher erhöht werden:

<code>~$ export USE_CCACHE=1</code>
//Diese Zeile kann auch in die Datei "''~/.bashrc''" eingetragen werden.//

\\

<code>~# cd ~/AndroidCustomROM/cm-14.1
~# prebuilts/misc/linux-x86/ccache/ccache -M 50G</code>

\\

==== Jack konfigurieren ====

Jack ist ein neuer JAVA-Compiler, welcher bekannt dafür ist, den Speicher zu überschreiten. Dies kann wie folgt repariert werden:

<code>~# export ANDROID_JACK_VM_ARGS="-Dfile.encoding=UTF-8 -XX:+TieredCompilation -Xmx4G"</code>
//Diese Zeile kann auch in die Datei "''~/.bashrc''" eingetragen werden.//

\\

Sollte diese Einstellung nicht helfen, kann die Datei "''config.properties''" angepasst werden:

<code>~$ mkdir ~/.jack-server
~$ echo "jack.server.max-service=1" >> ~/.jack-server/config.properties</code>
//Sollte die Datei bereits existieren, muss der Parameter eventuell angepasst werden.//

\\























































\\
 --- //[[steffen.bornemann@gmx.de|Steffen Bornemann]] 29.04.2018//
\\
{{tag>Android APK CHROOT DEBIAN JAVA SDK Toolchain GIT }}