From fed2adb924852267d52f6463c9b25df3239aa3b0 Mon Sep 17 00:00:00 2001 From: Timo Date: Tue, 30 Dec 2025 01:53:55 +0100 Subject: [PATCH] init --- .gitignore | 3 + .gitmodules | 4 + README.md | 39 +++++ build/conf/bblayers.conf | 12 ++ build/conf/conf-notes.txt | 19 +++ build/conf/conf-summary.txt | 1 + build/conf/local.conf | 310 +++++++++++++++++++++++++++++++++++ build/conf/templateconf.cfg | 1 + docker-compose.yaml | 42 +++++ layers/README.md | 1 + poky | 1 + scripts/docker-entrypoint.sh | 13 ++ scripts/setup-env.sh | 47 ++++++ scripts/setup-paths.sh | 12 ++ scripts/start-docker.sh | 17 ++ 15 files changed, 522 insertions(+) create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 README.md create mode 100644 build/conf/bblayers.conf create mode 100644 build/conf/conf-notes.txt create mode 100644 build/conf/conf-summary.txt create mode 100644 build/conf/local.conf create mode 100644 build/conf/templateconf.cfg create mode 100644 docker-compose.yaml create mode 100644 layers/README.md create mode 160000 poky create mode 100755 scripts/docker-entrypoint.sh create mode 100755 scripts/setup-env.sh create mode 100644 scripts/setup-paths.sh create mode 100755 scripts/start-docker.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..88363af --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.cache +.vscode +build/tmp/ \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..58750d1 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "poky"] + path = poky + url = https://git.yoctoproject.org/poky + branch = scarthgap diff --git a/README.md b/README.md new file mode 100644 index 0000000..7144713 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Yocto template + +Template for a yocto workspace to use with docker. + +## Requirements + +### docker + +This template requires docker to work. +See the [official manual](https://docs.docker.com/engine/install/) to set it up. + +### custom yocto docker image + +The custom image is available on hub.anxietyprime.de/yocto:latest, but requires login. +It can be build locally following the instructions in https://git.anxietyprime.de/timoschneider/docker-yocto. + +## Workspace layout + +```bash +yocto (origin) +├── build +│ └── conf +├── .cache +│ ├── docker +│ └── yocto +├── docker-compose.yaml +├── .git +├── .gitignore +├── .gitmodules +├── layers +├── poky +├── README.md +└── scripts + ├── docker-entrypoint.sh + ├── setup-env.sh + ├── setup-paths.sh + └── start-docker.sh +``` +The cache and download folders are auto generated. \ No newline at end of file diff --git a/build/conf/bblayers.conf b/build/conf/bblayers.conf new file mode 100644 index 0000000..b6f5711 --- /dev/null +++ b/build/conf/bblayers.conf @@ -0,0 +1,12 @@ +# POKY_BBLAYERS_CONF_VERSION is increased each time build/conf/bblayers.conf +# changes incompatibly +POKY_BBLAYERS_CONF_VERSION = "2" + +BBPATH = "${TOPDIR}" +BBFILES ?= "" + +BBLAYERS ?= " \ + /home/yocto/ws/poky/meta \ + /home/yocto/ws/poky/meta-poky \ + /home/yocto/ws/poky/meta-yocto-bsp \ + " diff --git a/build/conf/conf-notes.txt b/build/conf/conf-notes.txt new file mode 100644 index 0000000..cfd1f19 --- /dev/null +++ b/build/conf/conf-notes.txt @@ -0,0 +1,19 @@ + +### Shell environment set up for builds. ### + +You can now run 'bitbake ' + +Common targets are: + core-image-minimal + core-image-full-cmdline + core-image-sato + core-image-weston + meta-toolchain + meta-ide-support + +You can also run generated qemu images with a command like 'runqemu qemux86-64'. + +Other commonly useful commands are: + - 'devtool' and 'recipetool' handle common recipe tasks + - 'bitbake-layers' handles common layer tasks + - 'oe-pkgdata-util' handles common target package tasks diff --git a/build/conf/conf-summary.txt b/build/conf/conf-summary.txt new file mode 100644 index 0000000..8fc0303 --- /dev/null +++ b/build/conf/conf-summary.txt @@ -0,0 +1 @@ +This is the default build configuration for the Poky reference distribution. diff --git a/build/conf/local.conf b/build/conf/local.conf new file mode 100644 index 0000000..6e13615 --- /dev/null +++ b/build/conf/local.conf @@ -0,0 +1,310 @@ +# +# This file is your local configuration file and is where all local user settings +# are placed. The comments in this file give some guide to the options a new user +# to the system might want to change but pretty much any configuration option can +# be set in this file. More adventurous users can look at +# local.conf.sample.extended which contains other examples of configuration which +# can be placed in this file but new users likely won't need any of them +# initially. There's also site.conf.sample which contains examples of site specific +# information such as proxy server addresses. +# +# Lines starting with the '#' character are commented out and in some cases the +# default values are provided as comments to show people example syntax. Enabling +# the option is a question of removing the # character and making any change to the +# variable as required. + +# +# Machine Selection +# +# You need to select a specific machine to target the build with. There are a selection +# of emulated machines available which can boot and run in the QEMU emulator: +# +#MACHINE ?= "qemuarm" +#MACHINE ?= "qemuarm64" +#MACHINE ?= "qemumips" +#MACHINE ?= "qemumips64" +#MACHINE ?= "qemuppc" +#MACHINE ?= "qemux86" +#MACHINE ?= "qemux86-64" +# +# There are also the following hardware board target machines included for +# demonstration purposes: +# +#MACHINE ?= "beaglebone-yocto" +#MACHINE ?= "genericarm64" +#MACHINE ?= "genericx86" +#MACHINE ?= "genericx86-64" +# +# This sets the default machine to be qemux86-64 if no other machine is selected: +MACHINE ??= "qemux86-64" + +# These are some of the more commonly used values. Looking at the files in the +# meta/conf/machine directory, or the conf/machine directory of any additional layers +# you add in will show all the available machines. + +# +# Where to place downloads +# +# During a first build the system will download many different source code tarballs +# from various upstream projects. This can take a while, particularly if your network +# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you +# can preserve this directory to speed up this part of subsequent builds. This directory +# is safe to share between multiple builds on the same machine too. +# +# The default is a downloads directory under TOPDIR which is the build directory. +# +#DL_DIR ?= "${TOPDIR}/downloads" + +# +# Where to place shared-state files +# +# BitBake has the capability to accelerate builds based on previously built output. +# This is done using "shared state" files which can be thought of as cache objects +# and this option determines where those files are placed. +# +# You can wipe out TMPDIR leaving this directory intact and the build would regenerate +# from these files if no changes were made to the configuration. If changes were made +# to the configuration, only shared state files where the state was still valid would +# be used (done using checksums). +# +# The default is a sstate-cache directory under TOPDIR. +# +#SSTATE_DIR ?= "${TOPDIR}/sstate-cache" + +# +# Where to place the build output +# +# This option specifies where the bulk of the building work should be done and +# where BitBake should place its temporary files and output. Keep in mind that +# this includes the extraction and compilation of many applications and the toolchain +# which can use Gigabytes of hard disk space. +# +# The default is a tmp directory under TOPDIR. +# +#TMPDIR = "${TOPDIR}/tmp" + +# +# Default policy config +# +# The distribution setting controls which policy settings are used as defaults. +# The default value is fine for general Yocto project use, at least initially. +# Ultimately when creating custom policy, people will likely end up subclassing +# these defaults. +# +DISTRO ?= "poky" +# As an example of a subclass there is a "bleeding" edge policy configuration +# where many versions are set to the absolute latest code from the upstream +# source control systems. This is just mentioned here as an example, its not +# useful to most new users. +# DISTRO ?= "poky-bleeding" + +# +# Package Management configuration +# +# This variable lists which packaging formats to enable. Multiple package backends +# can be enabled at once and the first item listed in the variable will be used +# to generate the root filesystems. +# Options are: +# - 'package_deb' for debian style deb files +# - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager) +# - 'package_rpm' for rpm style packages +# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk" +# OE-Core defaults to ipkg, whilst Poky defaults to rpm: +# PACKAGE_CLASSES ?= "package_rpm" + +# +# SDK target architecture +# +# This variable specifies the architecture to build SDK items for and means +# you can build the SDK packages for architectures other than the machine you are +# running the build on (i.e. building i686 packages on an x86_64 host). +# Supported values are i686, x86_64, aarch64 +#SDKMACHINE ?= "i686" + +# +# Extra image configuration defaults +# +# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated +# images. Some of these options are added to certain image types automatically. The +# variable can contain the following options: +# "dbg-pkgs" - add -dbg packages for all installed packages +# (adds symbol information for debugging/profiling) +# "src-pkgs" - add -src packages for all installed packages +# (adds source code for debugging) +# "dev-pkgs" - add -dev packages for all installed packages +# (useful if you want to develop against libs in the image) +# "ptest-pkgs" - add -ptest packages for all ptest-enabled packages +# (useful if you want to run the package test suites) +# "tools-sdk" - add development tools (gcc, make, pkgconfig etc.) +# "tools-debug" - add debugging tools (gdb, strace) +# "eclipse-debug" - add Eclipse remote debugging support +# "tools-profile" - add profiling tools (oprofile, lttng, valgrind) +# "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.) +# "debug-tweaks" - make an image suitable for development +# e.g. ssh root access has a blank password +# There are other application targets that can be used here too, see +# meta/classes-recipe/image.bbclass and +# meta/classes-recipe/core-image.bbclass for more details. +# We default to enabling the debugging tweaks. +EXTRA_IMAGE_FEATURES ?= "debug-tweaks" + +# +# Additional image features +# +# The following is a list of additional classes to use when building images which +# enable extra features. Some available options which can be included in this variable +# are: +# - 'buildstats' collect build statistics +USER_CLASSES ?= "buildstats" + +# +# Runtime testing of images +# +# The build system can test booting virtual machine images under qemu (an emulator) +# after any root filesystems are created and run tests against those images. It can also +# run tests against any SDK that are built. To enable this uncomment these lines. +# See meta/classes-recipe/test{image,sdk}.bbclass for further details. +#IMAGE_CLASSES += "testimage testsdk" +#TESTIMAGE_AUTO:qemuall = "1" + +# +# Interactive shell configuration +# +# Under certain circumstances the system may need input from you and to do this it +# can launch an interactive shell. It needs to do this since the build is +# multithreaded and needs to be able to handle the case where more than one parallel +# process may require the user's attention. The default is iterate over the available +# terminal types to find one that works. +# +# Examples of the occasions this may happen are when resolving patches which cannot +# be applied, to use the devshell or the kernel menuconfig +# +# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none +# Note: currently, Konsole support only works for KDE 3.x due to the way +# newer Konsole versions behave +#OE_TERMINAL = "auto" +# By default disable interactive patch resolution (tasks will just fail instead): +PATCHRESOLVE = "noop" + +# +# Disk Space Monitoring during the build +# +# Monitor the disk space during the build. If there is less that 1GB of space or less +# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully +# shutdown the build. If there is less than 100MB or 1K inodes, perform a hard halt +# of the build. The reason for this is that running completely out of space can corrupt +# files and damages the build in ways which may not be easily recoverable. +# It's necessary to monitor /tmp, if there is no space left the build will fail +# with very exotic errors. +BB_DISKMON_DIRS ??= "\ + STOPTASKS,${TMPDIR},1G,100K \ + STOPTASKS,${DL_DIR},1G,100K \ + STOPTASKS,${SSTATE_DIR},1G,100K \ + STOPTASKS,/tmp,100M,100K \ + HALT,${TMPDIR},100M,1K \ + HALT,${DL_DIR},100M,1K \ + HALT,${SSTATE_DIR},100M,1K \ + HALT,/tmp,10M,1K" + +# +# Shared-state files from other locations +# +# As mentioned above, shared state files are prebuilt cache data objects which can be +# used to accelerate build time. This variable can be used to configure the system +# to search other mirror locations for these objects before it builds the data itself. +# +# This can be a filesystem directory, or a remote url such as https or ftp. These +# would contain the sstate-cache results from previous builds (possibly from other +# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the +# cache locations to check for the shared objects. +# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH +# at the end as shown in the examples below. This will be substituted with the +# correct path within the directory structure. +#SSTATE_MIRRORS ?= "\ +#file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \ +#file://.* file:///some/local/dir/sstate/PATH" + +# +# Yocto Project SState Mirror +# +# The Yocto Project has prebuilt artefacts available for its releases, you can enable +# use of these by uncommenting some of the following lines. This will mean the build uses +# the network to check for artefacts at the start of builds, which does slow it down +# initially but it will then speed up the builds by not having to build things if they are +# present in the cache. It assumes you can download something faster than you can build it +# which will depend on your network. +# Note: For this to work you also need hash-equivalence passthrough to the matching server +# There is a choice between our sstate server directly and a faster content delivery network +# (CDN) kindly provided by JSDelivr, uncomment one of the SSTATE_MIRRORS lines, not both. +# Using the CDN rather than the yoctoproject.org address is suggested/preferred. +# +#BB_HASHSERVE_UPSTREAM = 'wss://hashserv.yoctoproject.org/ws' +#SSTATE_MIRRORS ?= "file://.* http://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH" + +# +# Qemu configuration +# +# By default native qemu will build with a builtin VNC server where graphical output can be +# seen. The line below enables the SDL UI frontend too. +PACKAGECONFIG:append:pn-qemu-system-native = " sdl" +# By default libsdl2-native will be built, if you want to use your host's libSDL instead of +# the minimal libsdl built by libsdl2-native then uncomment the ASSUME_PROVIDED line below. +#ASSUME_PROVIDED += "libsdl2-native" + +# You can also enable the Gtk UI frontend, which takes somewhat longer to build, but adds +# a handy set of menus for controlling the emulator. +#PACKAGECONFIG:append:pn-qemu-system-native = " gtk+" + +# +# Hash Equivalence +# +# Enable support for automatically running a local hash equivalence server and +# instruct bitbake to use a hash equivalence aware signature generator. Hash +# equivalence improves reuse of sstate by detecting when a given sstate +# artifact can be reused as equivalent, even if the current task hash doesn't +# match the one that generated the artifact. +# +# A shared hash equivalent server can be set with ":" format +# +#BB_HASHSERVE = "auto" +#BB_SIGNATURE_HANDLER = "OEEquivHash" + +# +# Memory Resident Bitbake +# +# Bitbake's server component can stay in memory after the UI for the current command +# has completed. This means subsequent commands can run faster since there is no need +# for bitbake to reload cache files and so on. Number is in seconds, after which the +# server will shut down. +# +#BB_SERVER_TIMEOUT = "60" + +# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to +# track the version of this file when it was generated. This can safely be ignored if +# this doesn't mean anything to you. +CONF_VERSION = "2" + + + + + + + + + + + + + + + + + + + + + +# >>> yocto cache (managed) >>> +DL_DIR = "/home/yocto/ws/.cache/yocto/downloads" +SSTATE_DIR = "/home/yocto/ws/.cache/yocto/sstate" +# <<< yocto cache (managed) <<< diff --git a/build/conf/templateconf.cfg b/build/conf/templateconf.cfg new file mode 100644 index 0000000..0fcf0ff --- /dev/null +++ b/build/conf/templateconf.cfg @@ -0,0 +1 @@ +meta-poky/conf/templates/default diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..8ff1b74 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,42 @@ +services: + yocto: + image: hub.anxietyprime.de/yocto:latest + container_name: yocto + runtime: nvidia # Enable GPU support + network_mode: host + devices: + - /dev/dri + - /dev/kvm:/dev/kvm + - /dev/net/tun:/dev/net/tun + privileged: true + cap_add: + - SYS_ADMIN + - NET_ADMIN + environment: + - DISPLAY=${DISPLAY} + - XDG_RUNTIME_DIR=${XDG_RUNTIME_DIR} + - NVIDIA_VISIBLE_DEVICES=all + - NVIDIA_DRIVER_CAPABILITIES=all + - LIBGL_ALWAYS_INDIRECT=1 + - __GLX_VENDOR_LIBRARY_NAME=nvidia + volumes: + # display (if needed) + - /tmp/.X11-unix:/tmp/.X11-unix + - ${XDG_RUNTIME_DIR}:${XDG_RUNTIME_DIR} + + # devices + - /dev:/dev + + # cache + - ./.cache/:/home/yocto/ws/.cache + - ./.cache/docker/zsh_history:/home/yocto/.zsh_history + + # ws + - ./build/:/home/yocto/ws/build + - ./layers/:/home/yocto/ws/layers + - ./poky/:/home/yocto/ws/poky + - ./scripts/:/home/yocto/ws/scripts + entrypoint: /home/yocto/ws/scripts/docker-entrypoint.sh + stdin_open: true # equivalent to -it + tty: true # equivalent to -it + restart: always \ No newline at end of file diff --git a/layers/README.md b/layers/README.md new file mode 100644 index 0000000..9b03e43 --- /dev/null +++ b/layers/README.md @@ -0,0 +1 @@ +Place layers here \ No newline at end of file diff --git a/poky b/poky new file mode 160000 index 0000000..553530a --- /dev/null +++ b/poky @@ -0,0 +1 @@ +Subproject commit 553530a8acce3b078473c0fa512246a3e84d46bf diff --git a/scripts/docker-entrypoint.sh b/scripts/docker-entrypoint.sh new file mode 100755 index 0000000..281b4dd --- /dev/null +++ b/scripts/docker-entrypoint.sh @@ -0,0 +1,13 @@ +#!/bin/bash +trap "echo 'Stopping...'; exit 0" SIGTERM + +# source yocto +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +source "${SCRIPT_DIR}/setup-env.sh" + +# add add source to all zsh instances +#echo "souce \"${YOCTO_ROOT}(scripts/setup-env.sh\"" >> ~/.zshrc + +# trap to keep container open in background +/bin/zsh +#while true; do sleep 1; done \ No newline at end of file diff --git a/scripts/setup-env.sh b/scripts/setup-env.sh new file mode 100755 index 0000000..88973f5 --- /dev/null +++ b/scripts/setup-env.sh @@ -0,0 +1,47 @@ +#!/usr/bin/env bash +set -e +# ------------------------------------------------------------------- + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +source "${SCRIPT_DIR}/setup-paths.sh" + +# ------------------------------------------------------------------- + +# Sanity checks +if [ ! -d "${POKY_DIR}" ]; then + echo "ERROR: poky not found at ${POKY_DIR}" + return 1 2>/dev/null || exit 1 +fi + +# Create cache directories +mkdir -p "${DL_DIR}" +mkdir -p "${SSTATE_DIR}" + +# Initialize Yocto build environment +source "${POKY_DIR}/oe-init-build-env" "${YOCTO_ROOT}/${BUILD_DIR}" + +# Inject cache paths into local.conf (idempotent) +CONF_FILE="${BUILDDIR}/conf/local.conf" + +START_MARKER="# >>> yocto cache (managed) >>>" +END_MARKER="# <<< yocto cache (managed) <<<" + +# Remove old managed block if present +sed -i "/${START_MARKER}/,/${END_MARKER}/d" "${CONF_FILE}" + +# Append managed block +cat <> "${CONF_FILE}" + +${START_MARKER} +DL_DIR = "${DL_DIR}" +SSTATE_DIR = "${SSTATE_DIR}" +${END_MARKER} +EOF + + +echo +echo "Yocto environment ready:" +echo " BUILD_DIR = ${BUILDDIR}" +echo " DL_DIR = ${DL_DIR}" +echo " SSTATE_DIR = ${SSTATE_DIR}" +echo diff --git a/scripts/setup-paths.sh b/scripts/setup-paths.sh new file mode 100644 index 0000000..6ed3fb6 --- /dev/null +++ b/scripts/setup-paths.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +# ---- Configuration ------------------------------------------------- +YOCTO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +BUILD_DIR="${1:-build}" + +CACHE_BASE="${YOCTO_ROOT}/.cache/yocto" +DL_DIR="${CACHE_BASE}/downloads" +SSTATE_DIR="${CACHE_BASE}/sstate" + +POKY_DIR="${YOCTO_ROOT}/poky" +# ------------------------------------------------------------------- \ No newline at end of file diff --git a/scripts/start-docker.sh b/scripts/start-docker.sh new file mode 100755 index 0000000..5a90d9c --- /dev/null +++ b/scripts/start-docker.sh @@ -0,0 +1,17 @@ +#!/bin/bash +set -e + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +source "${SCRIPT_DIR}/setup-paths.sh" + +# ------------------------------------------------------------------- + +mkdir -p "${YOCTO_ROOT}/.cache/docker/" +touch "${YOCTO_ROOT}/.cache/docker/zsh_history" +mkdir -p "${BUILD_DIR}" +mkdir -p "${DL_DIR}" +mkdir -p "${SSTATE_DIR}" + +# ------------------------------------------------------------------- + +docker compose -f $YOCTO_ROOT/docker-compose.yaml up -d \ No newline at end of file