From c5e7c48779905fdebefc0ba30a84e16e669baa3e Mon Sep 17 00:00:00 2001 From: akadmin Date: Mon, 29 Sep 2025 09:45:42 +0300 Subject: [PATCH] chore: initial project setup - Add Dockerfile for build environment - Add docker-compose.yml for container orchestration - Add docker-entrypoint.sh for build process automation - Add .env for environment configuration - Add .gitignore for ignoring build artifacts and temporary files - Add README.md with build instructions - Add LICENSE (Apache 2.0) --- .env | 3 + .gitignore | 3 + Dockerfile | 126 +++++++++++++++++++++++++++ LICENSE | 201 +++++++++++++++++++++++++++++++++++++++++++ README.md | 136 +++++++++++++++++++++++++++++ docker-build.sh | 31 +++++++ docker-compose.yml | 35 ++++++++ docker-entrypoint.sh | 72 ++++++++++++++++ 8 files changed, 607 insertions(+) create mode 100644 .env create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE create mode 100644 README.md create mode 100755 docker-build.sh create mode 100644 docker-compose.yml create mode 100755 docker-entrypoint.sh diff --git a/.env b/.env new file mode 100644 index 0000000..ccf7867 --- /dev/null +++ b/.env @@ -0,0 +1,3 @@ +USE_CCACHE=1 +CCACHE_DIR=/workspace/.ccache +BUILD_THREADS=8 \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9d8199e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +!.gitignore + +.idea \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..411dd2f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,126 @@ +# Use specific Ubuntu version for reproducibility +FROM ubuntu:22.04 + +LABEL maintainer="Brax " \ + description="IodeOS Android OS build environment" \ + version="1.0" + +# Set build arguments for flexibility +ARG CCACHE_SIZE=50G +ARG DEBIAN_FRONTEND=noninteractive +ARG TZ=UTC + +# Environment variables +ENV DEBIAN_FRONTEND=${DEBIAN_FRONTEND} \ + TZ=${TZ} \ + USE_CCACHE=1 \ + CCACHE_EXEC=/usr/bin/ccache \ + JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64 + +# Set timezone to prevent tzdata interactive prompt +RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && \ + echo $TZ > /etc/timezone + +# Update package lists and install essential packages +RUN apt-get update && \ + apt-get install --no-install-recommends -y \ + # Build essentials + bc \ + bison \ + build-essential \ + ccache \ + curl \ + flex \ + g++-multilib \ + gcc-multilib \ + git \ + git-lfs \ + gnupg \ + gperf \ + imagemagick \ + # Development libraries + lib32ncurses5-dev \ + lib32readline-dev \ + lib32z1-dev \ + libc6-dev-i386 \ + libdw-dev \ + libelf-dev \ + libncurses5 \ + libncurses5-dev \ + libsdl1.2-dev \ + libssl-dev \ + libx11-dev \ + libxml2 \ + libxml2-utils \ + # Compression and utilities + lz4 \ + lzop \ + m4 \ + pngcrush \ + # Protocol buffers + protobuf-compiler \ + python3-protobuf \ + # Python + python-is-python3 \ + python3-pip \ + python3-virtualenv \ + # Java + openjdk-11-jdk \ + # System utilities + rsync \ + schedtool \ + software-properties-common \ + squashfs-tools \ + sudo \ + unzip \ + wget \ + x11proto-core-dev \ + xsltproc \ + zip \ + zlib1g-dev \ + # Font support + fontconfig && \ + # Clean up package cache + apt-get autoclean && \ + rm -rf /var/lib/apt/lists/* + + +# Download and install Android platform-tools +RUN mkdir -p /opt/platform-tools && \ + cd /opt/platform-tools && \ + wget -q https://dl.google.com/android/repository/platform-tools-latest-linux.zip && \ + unzip -q platform-tools-latest-linux.zip && \ + rm platform-tools-latest-linux.zip && \ + mv platform-tools/* . && \ + rmdir platform-tools && \ + chmod +x adb fastboot + +# Set up git LFS globally +RUN git lfs install --system + +# Configure ccache +RUN ccache -M ${CCACHE_SIZE} && \ + ccache -s + +# Create workspace directory with proper ownership +RUN mkdir -p /workspace && \ + chown -R ${BUILD_USER}:${BUILD_USER} /workspace + +# Copy and set up entrypoint script +COPY --chown=root:root docker-entrypoint.sh /usr/local/bin/docker-entrypoint +COPY --chown=root:root docker-build.sh /usr/local/bin/docker-build +RUN chmod +x /usr/local/bin/docker-entrypoint && \ + chmod +x /usr/local/bin/docker-build + +# Switch to non-root user for security +USER root +WORKDIR /workspace + +# Set up user-specific configurations +RUN echo 'export USE_CCACHE=1' >> ~/.bashrc && \ + echo 'export CCACHE_EXEC=/usr/bin/ccache' >> ~/.bashrc && \ + echo 'export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64' >> ~/.bashrc + +# Set entrypoint and default command +ENTRYPOINT ["docker-entrypoint"] +CMD ["/bin/bash"] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4725e1e --- /dev/null +++ b/README.md @@ -0,0 +1,136 @@ +# How to Build IodeOs with Docker + +## Why Docker? + +Using Docker ensures all required dependencies are pre-installed and properly configured. +You don’t need to install complex toolchains or modify your host system. + +--- + +## Requirements + +### Software + +- **Docker** + Install Docker using the official script: + ```bash + curl -fsSL https://get.docker.com | sh + ``` + +- **Git** + [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) + +- **Repo tool** + Install the Google `repo` tool: + + ```bash + mkdir -p ~/bin + curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo + chmod a+x ~/bin/repo + export PATH=~/bin:$PATH + ``` + +### Hardware + +- **Disk:** SSD recommended + + * Total required: \~638 GB + + * \~394 GB source code + * \~244 GB build artifacts + +- **CPU:** 64-bit processor (Intel i5/i7 or AMD Ryzen 5/7 and above recommended, 8 cores or more preferred) + +- **Memory:** + + * Minimum: 16 GB RAM + * Bare minimum: 8 GB RAM (with swap; builds will be very slow and unstable) + +--- + +## Usage + +1. **Clone this repo** to your local machine and navigate into it: + + ```bash + git clone https://git.os-source.co/IodeOs/build.git + cd build + ``` + +2. **Initialize and sync the repo** into the `IodeOs/build` checkout directory: + + ```bash + repo init -u https://git.os-source.co/IodeOs/manifests_android -b v6-staging + ``` + +3. **Sync the repo** (this may take a while): + + ```bash + repo sync + ``` + + > 💡 **Tip:** You can speed up and stabilize the sync process with additional options: + > + > ```bash + > repo sync -c -j$(nproc --all) --force-sync --no-clone-bundle --no-tags -f + > ``` + > + > * `-c` : Sync only the current manifest branch + > * `-j$(nproc --all)` : Use all available CPU cores for parallel sync + > * `--force-sync` : Discard local changes and ensure a clean state + > * `--no-clone-bundle` : Skip using potentially outdated pre-packaged bundles + > * `--no-tags` : Avoid downloading all Git tags (saves time/space) + > * `-f` : Continue syncing other projects even if one fails + +4. **Start the build with Docker**: + + ```bash + docker compose up -d + ``` + +5. **Check the build logs and wait**: + + ```bash + docker logs -f repo_build_iode + ``` + +6. Once the "success message" appears in the logs (this typically takes 90–240 minutes, depending on your hardware and + the number of threads used), navigate to the out folder to find your OTA package or fastboot images. + +--- + +## Troubleshooting + +### Repo tool not found + +If you see: + +``` +command not found: repo +``` + +Make sure `~/bin` is in your `PATH`: + +```bash +export PATH=~/bin:$PATH +``` + +Add it to your `~/.bashrc` or `~/.zshrc` to make the change permanent. + +--- + +### Repo sync is very slow or stalls + +* Use more jobs with `-j` (e.g. `repo sync -j16`) if you have a fast CPU and good network. +* If syncing fails, retry with: + + ```bash + repo sync --force-sync --no-clone-bundle --no-tags + ``` + +--- + +## Licensing + +IodeOs/build is licensed under the **Apache License, Version 2.0**. +See [LICENSE](LICENSE) for the full license text. diff --git a/docker-build.sh b/docker-build.sh new file mode 100755 index 0000000..ddc966e --- /dev/null +++ b/docker-build.sh @@ -0,0 +1,31 @@ +#!/usr/bin/env bash +set -e + +# Default environment variables +: "${WITH_ADB_INSECURE:=true}" +: "${BUILD_USERNAME:=android-build}" +: "${BUILD_HOSTNAME:=ar-12fa058809ba38af-bfhg}" +: "${WITH_GMS:=true}" +: "${LUNCH_TARGET:=brax3}" +: "${BUILD_VARIANT:=userdebug}" +: "${BUILD_THREADS:=$(nproc)}" # Automatically detect CPU cores + +# Log current configuration +echo "=== Build Configuration ===" +echo "WITH_ADB_INSECURE = $WITH_ADB_INSECURE" +echo "WITH_GMS = $WITH_GMS" +echo "BUILD_USERNAME = $BUILD_USERNAME" +echo "BUILD_HOSTNAME = $BUILD_HOSTNAME" +echo "LUNCH_TARGET = $LUNCH_TARGET" +echo "BUILD_VARIANT = $BUILD_VARIANT" +echo "BUILD_THREADS = $BUILD_THREADS" +echo "===========================" + +# Load build environment +source build/envsetup.sh + +# Setup target +breakfast "$LUNCH_TARGET" "$BUILD_VARIANT" + +# Build with parallel jobs +make -j"$BUILD_THREADS" dist \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..5abdf62 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,35 @@ +services: + repo-build-iode: + build: + context: . + dockerfile: Dockerfile + image: registry.os-source.co/os-build/iode-os:6.7 + container_name: repo_build_iode + command: "docker-build" + restart: "no" + environment: + WITH_ADB_INSECURE: true + BUILD_USERNAME: "android-build" + BUILD_HOSTNAME: "r-12fa058809ba38af-bfhg" + WITH_GMS: true + env_file: + - .env + volumes: + - ./:/workspace + - ccache_data:/workspace/.ccache + working_dir: /workspace + tty: true + stdin_open: true + init: true + networks: + - build_network + +volumes: + ccache_data: + driver: local + name: iodeos_ccache + +networks: + build_network: + driver: bridge + name: iodeos_build_net \ No newline at end of file diff --git a/docker-entrypoint.sh b/docker-entrypoint.sh new file mode 100755 index 0000000..753a76e --- /dev/null +++ b/docker-entrypoint.sh @@ -0,0 +1,72 @@ +#!/bin/bash +set -euo pipefail + +# Function to log messages with timestamp +log() { + echo "[$(date +'%Y-%m-%d %H:%M:%S')] $*" >&2 +} + +# Function to handle cleanup on exit +cleanup() { + local exit_code=$? + if [ $exit_code -ne 0 ]; then + log "Build process exited with code: $exit_code" + # Optional: Save ccache stats on failure + if command -v ccache >/dev/null 2>&1; then + log "Final ccache stats:" + ccache -s + fi + fi +} + +# Set up signal handlers +trap cleanup EXIT +trap 'log "Received SIGTERM, shutting down gracefully..."; exit 143' TERM +trap 'log "Received SIGINT, shutting down gracefully..."; exit 130' INT + +# Initialize environment +log "Initializing build environment for user: $(whoami)" + +# Ensure proper ownership of workspace +if [ -d "/workspace" ] && [ -w "/workspace" ]; then + log "Workspace permissions verified" +else + log "Warning: Workspace permissions may be incorrect" +fi + +# Display ccache status +if command -v ccache >/dev/null 2>&1; then + log "ccache status:" + ccache -s +fi + +# Display system info for debugging +log "System info - Cores: $(nproc), Memory: $(free -h | awk '/^Mem:/ {print $2}')" + +# Set optimal make flags if not already set +if [ -z "${MAKEFLAGS:-}" ]; then + export MAKEFLAGS="-j$(nproc)" + log "Set MAKEFLAGS to: $MAKEFLAGS" +fi + +# If no arguments provided, start interactive bash +if [ $# -eq 0 ]; then + log "Starting interactive bash session" + exec /bin/bash +fi + +# Define log file path +BUILD_LOG="/workspace/build.log" + +# Clean previous logs +: > "$BUILD_LOG" # This truncates the file without deleting it +# Or, alternatively: rm -f "$BUILD_LOG" && touch "$BUILD_LOG" + +log "Executing command: $*" + +# Run command, tee stdout/stderr to build.log and still display in docker logs +"$@" > >(tee -a "$BUILD_LOG") 2> >(tee -a "$BUILD_LOG" >&2) +exit_code=$? + +log "Command exited with code $exit_code" +exit $exit_code \ No newline at end of file