Difference between revisions of "Buildroot"

From eLinux.org
Jump to: navigation, search
(Core Buildroot infrastructure)
 
(186 intermediate revisions by 24 users not shown)
Line 1: Line 1:
Buildroot is a nice, simple, and efficient embedded Linux build system. [http://www.buildroot.org Buildroot main page]
+
Buildroot is a nice, simple, and efficient embedded Linux build system.
 +
 
 +
== Important links ==
 +
 
 +
* [https://www.buildroot.org Buildroot main page]
 +
* [https://bugs.uclibc.org Bug tracker]
 +
* [http://autobuild.buildroot.org Autobuilders results]
 +
* [https://patchwork.ozlabs.org/project/buildroot/list/ Project patchwork]
 +
* [[Buildroot:ReproducibleBuilds | The reproducible builds work]]
 +
* [[Buildroot:Top_Level_Parallel_Build | The top-level parallel build work]]
 +
* [[Buildroot:Security_Vulnerability_Management | Security Vulnerability Management]]
 +
* [[Buildroot:Language_package_managers_and_dependencies | Language package managers and downloading dependencies (go mod, cargo, php compose)]]
 +
 
 +
== Developer days ==
 +
 
 +
Upcoming:
 +
* [[Buildroot:RegularVirtualMeeting | Regular virtual meeting]], starting September 2020
 +
 
 +
Past:
 +
* [[Buildroot:VirtualDeveloperDaysSummer2020 | Virtual Buildroot Developer Days]], July 27, August 28, August 29, 2020
 +
* [[Buildroot:DeveloperDaysFOSDEM2020 | Buildroot Developer Days]], 3-5 February 2020, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 +
* [[Buildroot:DeveloperDaysELCE2019 | Buildroot Developer Days]], 25-27 October 2019, Lyon, France, before [https://events19.linuxfoundation.org/events/embedded-linux-conference-europe-2019/ ELCE]
 +
* [[Buildroot:DeveloperDaysFOSDEM2019 | Buildroot Developer Days]], 4-6 February 2019, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 +
* [[Buildroot:DeveloperDaysELCE2018 | Buildroot Developer Days]], 20-21 October 2018, Edinburgh, UK, before [https://events.linuxfoundation.org/events/elc-openiot-europe-2018/ ELCE]
 +
* [[Buildroot:DeveloperDaysFOSDEM2018 | Buildroot Developer Days]], 5-6 February 2018, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 +
* [[Buildroot:DeveloperDaysELCE2017 | Buildroot Developer Days]], 21-22 October 2017, Prague, Czech Republic, before [http://events.linuxfoundation.org/events/embedded-linux-conference-europe ELCE].
 +
* [[Buildroot:DeveloperDaysFOSDEM2017 | Buildroot Developer Days]], 6-7 February 2017, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 +
* [[Buildroot:DeveloperDaysELCE2016 | Buildroot Developer Days]], 14-16 October 2016, Berlin, Germany, after [http://events.linuxfoundation.org/events/embedded-linux-conference-europe ELCE].
 +
* [[Buildroot:DeveloperDaysFOSDEM2016 | Buildroot Developer Days]], 1-2 February 2016, Brussels, Belgium, after [http://fosdem.org FOSDEM]
 +
* [[Buildroot:DeveloperDaysELCE2015 | Buildroot Developer Days]], 3-4 October 2015, Dublin, Ireland, before ELC-E ([http://elinux.org/index.php?title=Buildroot:DeveloperDaysELCE2015#Report report]).
 +
* [[Buildroot:DeveloperDaysFOSDEM2015 | Buildroot Developer Days]], 2-3 February 2015, Brussels, Belgium, after FOSDEM.
 +
* [[Buildroot:DeveloperDaysELCE2014 | Buildroot Developer Days]], 11-12 October 2014, Düsseldorf, Germany, before ELC-E.
 +
* [[Buildroot:DeveloperDaysFOSDEM2014 | Buildroot Developer Days]], 3-4 February 2014, Brussels, Belgium, after FOSDEM.
 +
* [[Buildroot:DeveloperDaysELCE2013 | Buildroot Developer Days]], 26-27 October 2013, Edinburgh UK, after ELC-E.
 +
* [[Buildroot:DeveloperDaysFOSDEM2013 | Buildroot Developer Days]], 4-5 February 2013, Brussels Belgium, after FOSDEM.
 +
* [[Buildroot:DeveloperDaysELCE2012 | Buildroot Developer Days]], 3-4 November 2012, Barcelona Spain, before ELC-E.
 +
* Buildroot Developer Days, 3 February 2012, Brussels Belgium, before FOSDEM ([http://lists.busybox.net/pipermail/buildroot/2012-February/050371.html report])
 +
* Buildroot Developer Days, 29 October 2011, Prague, Czech Republic, after ELCE ([http://lists.busybox.net/pipermail/buildroot/2011-November/047229.html report])
 +
 
 +
== Talks ==
 +
 
 +
This section gathers the list of talks given about Buildroot, as well as the slides and video when available.
 +
 
 +
Past:
 +
* [https://elciotna18.sched.com/event/E4qS/buildroot-whats-new-thomas-petazzoni-bootlin-formerly-free-electrons Buildroot: What's New?], Thomas Petazzoni, Embedded Linux Conference, 12-14 March, Portland, Oregon. [https://bootlin.com/pub/conferences/2018/elc/petazzoni-buildroot-whats-new/petazzoni-buildroot-whats-new.pdf Slides], [https://www.youtube.com/watch?v=D6zO4nMX9KY Video].
 +
* [https://osseu17.sched.com/event/ByYU/buildroot-whats-new-thomas-petazzoni-free-electrons Buildroot: What's New?], Thomas Petazzoni, Embedded Linux Conference Europe, 23-25 October, Prague, Czech Republic. [https://elinux.org/images/b/bb/Elce2017-petazzoni-buildroot-whats-new.pdf Slides], [https://youtu.be/839WOdYPYuE Video].
 +
* [https://osseu17.sched.com/event/ByYX/buildroot-making-embedded-linux-easy-a-real-life-example-yann-morin-orange Buildroot: Making Embedded Linux Easy? A Real-Life Example], Yann E. MORIN, Embedded Linux Conference Europe, 23-25 October, Prague, Czech Republic. [https://elinux.org/images/8/8e/2017-10-24_-_ELCE-Buildroot.pdf Slides], [https://youtu.be/SN2hYO2rYtk Video].
 +
* [http://sched.co/3y4O Tutorial: Learning the Basics of Buildroot], Thomas Petazzoni, Embedded Linux Conference Europe, October 5 - 7, 2015, Dublin, Ireland. [https://elinux.org/images/1/1e/Petazzoni-buildroot-tutorial.pdf Slides], [https://www.youtube.com/watch?v=1PfthHCfudY Video].
 +
* "Buildroot: a deep dive into the core", Thomas Petazzoni, Embedded Linux Conference Europe, 13-15 October 2014, Düsseldorf, Germany. [http://events.linuxfoundation.org/sites/events/files/slides/petazzoni-dive-into-buildroot-core.pdf Slides].
 +
* [http://elcabsna2014.sched.org/event/ce9732e662300bace37607a6adacf82b Buildroot: what's new], Thomas Petazzoni, Embedded Linux Conference, 1 May 2014, San Jose, United States. [http://elinux.org/images/1/1d/Petazzoni-buildroot-whats-new.pdf Slides], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot.webm HD video], [http://free-electrons.com/pub/video/2014/elc/elc-2014-thomas-petazzoni-buildroot-450p.webm Low-res video], [http://events.linuxfoundation.org/sites/events/files/Buildroot%20What%27s%20New%20-%20Thomas%20Petazzoni-%20Free%20Electrons.mp3 Audio only]
 +
* "Buildroot: what is new", Peter Korsgaard, Embedded Linux Conference Europe, 25 October 2013, Edinburgh, UK. [http://elinux.org/images/2/23/Buildroot-whats-new-elce2013.pdf Slides], [https://www.youtube.com/watch?v=0G_yJ50RA3I Video].
 +
 
 +
==List of forks==
 +
 
 +
* [https://github.com/home-assistant/operating-system Home Assistant Operating System]. Home Assistant Operating System (formerly HassOS) is an operating system optimized for hosting Home Assistant and its Add-ons.
 +
* [https://github.com/openil/openil OpenIL]. OpenIL is an open source project based on Buildroot and designed for embedded industrial solution.
 +
* [https://github.com/nezticle/RaspberryPi-BuildRoot Bsquask SDK]. A Rasberry-Pi related fork.
 +
* [https://github.com/albertd/buildroot-rpi]. Another RPi related fork, with a lot of focus on Qt5 and GStreamer (appears to be defunct).
 +
* [https://github.com/Openwide-Ingenierie/buildroot-submodule Buildroot Submodule]. Not a fork, but a convenience layer on top of buildroot.
 +
* [http://ymorin.is-a-geek.org/git/buildroot.config/ Experimental 'shell' around Buildroot]. Another wrapper around Buildroot, to help manage projects.
 +
 
 +
==Todo list==
 +
 
 +
This is a list of improvements that we would like to see in buildroot.  Feel free to add suggestions here.  If you're working on one of these items, put your name and the date behind it, to avoid duplicate work.
 +
 
 +
There are a number of patches that have been determined to be useful but for various reasons nobody currently has time to review or test them. Anybody, especially a person new to buildroot, is welcome to adopt these patches and resubmit them to the mailing list.
 +
 
 +
=== Packages ===
 +
 
 +
'''Note: if you start working on any of these packages, please edit this section to indicate it. If the package is proposed in a bug report, please also update the bug report. Sending a mail to the mailing list also never hurts, you never know that someone else started working on it without following this guideline.'''
 +
 
 +
==== Important ====
 +
 
 +
* Improve the imx-gpu-viv package to not install everything. See https://lore.kernel.org/buildroot/20210805233615.4e69d63d@windsurf/T/#u
 +
 
 +
==== Nice to have ====
 +
 
 +
* Create a package for the Qt5 demo/benchmark application at https://github.com/prabindh/xgxperf.
 +
* Packages proposed in bug reports (often with patch)
 +
** openvz https://bugs.busybox.net/show_bug.cgi?id=405
 +
** rdiff-backup https://bugs.busybox.net/show_bug.cgi?id=1309 [Shaym Saini <mayhs11saini@gmail.com> is working on this]
 +
** wxWidgets https://bugs.busybox.net/show_bug.cgi?id=261
 +
* Create a package for UnixBench benchmark suite at https://github.com/kdlucas/byte-unixbench.
 +
* uwsgi => Adam Duskett pending patch series: https://patchwork.ozlabs.org/project/buildroot/list/?series=144709&state=%2A&archive=both
 +
 
 +
=== Toolchain ===
 +
 
 +
* Add the support for the x86-64 x32 capable toolchain. See http://patchwork.ozlabs.org/patch/561904/
 +
* Add the support for the Aarch64 ilp32 capable toolchain (for now the gcc/binutils/glibc upstream support is not ready yet). See http://lists.busybox.net/pipermail/buildroot/2015-August/137356.html, http://patchwork.ozlabs.org/patch/506803/, http://patchwork.ozlabs.org/patch/506800/, http://patchwork.ozlabs.org/patch/506801/
 +
 
 +
=== Documentation ===
 +
 
 +
* [[Buildroot how to contribute | Document how to contribute]] (how often to repost, what to expect, ...) [[Buildroot how to contribute | basic guide]]
 +
* Document that package patches should be sent upstream
 +
 
 +
=== Core Buildroot infrastructure ===
 +
 
 +
* Cargo and Go post-process handling for vendoring
 +
** Add support for tarball formats other than gz
 +
 
 +
* Cargo post-process handling for vendoring
 +
** Either replace "cargo install" by manual installation of files, or ensure that "cargo install" doesn't rebuild things. See https://lore.kernel.org/buildroot/20220106210000.397694-1-thomas.petazzoni@bootlin.com/T/#m2fe31f718c45675f7fb52d001e75cc0386db8aee
 +
** Use more environment variables when calling cargo, to avoid using a cargo configuration file. See https://lore.kernel.org/buildroot/20220106210000.397694-1-thomas.petazzoni@bootlin.com/T/#m8dc0e19638fc1f2c36cac7bba5de615a2a671dc1
 +
 
 +
* Investigate adding support for [https://github.com/icecc ICECC]. See also https://www.pengutronix.de/en/2018-09-13-fixing-icecc.html.
 +
 
 +
* Several improvements are possible in the download infrastructure (even after all the improvements that were already done):
 +
** Rename the downloaded files so they include the package name and version. Special care has to be taken for primary and secondary sites, and for extra downloads (including patches).
 +
** Split between FOO_SITE and FOO_SOURCE shouldn't be necessary. Or it could be made optional, i.e. make it possible to specify the full path in FOO_SOURCE.
 +
 
 +
* Locale handling is broken: it doesn't take into account the alias file when purging aliases. See [http://lists.busybox.net/pipermail/buildroot/2013-December/084724.html this mail from patchwork cleanup #3] and [http://patchwork.ozlabs.org/patch/188623/ this patch that also fixes a locale problem, but not everything]. Tests for this are also required.
 +
 
 +
* Add instrumentation scripts to analyse package installed files:
 +
** find libraries with wrong RPATH/RUNPATH tags
 +
** detect unused .so libs (eg. shared libs that are not DT_NEEDED by anything - note: only detect those libs, don't remove: can be used as plugin (dlopen), or used by an application built outside Buildroot)
 +
 
 +
* A script that checks consistency of depends/select for packages. Maybe it can be integrated to the current check-package.
 +
 
 +
* [[Buildroot:SecurityHardening | Security Hardening]]
 +
 
 +
=== Testing infrastructure ===
 +
 
 +
* Fix run-tests to use a config file for download and output directories, can be overridden in the environment
 +
* Documentation on how to add a test, including naming convention
 +
 
 +
=== TODO items under discussion ===
 +
 
 +
Here are some nice-to-have's for which it is not entirely clear if and how they could be implemented:
 +
 
 +
* Out-of-tree builds, which allows the package source to be shared between different output directories and between host and target compiles.
 +
* It would be nice if you could run a buildroot command that prepares a local copy of a package's source, and allows you to generate patches for it later. This could use git or quilt to keep track of the patches.
 +
* It would be nice if there was a make target to reinstall everything to the target (i.e. remove all the target-installed stamps, remove the root stamp, maybe remove the target too).  However, what is missing is the copying of the toolchain support files (libc.so etc.).  It's not obvious that this can be done in a reliable way.
 +
* To facilitate debugging, all packages should be installed to the staging directory. The target directory should in fact be a subset of the staging directory. See the FOSDEM 2013 discussion at http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013, and the discussion around patch http://patchwork.ozlabs.org/patch/252718/. This is however a significant change in Buildroot, so probably difficult to implement, and will raise a number of quite complicated questions.

Latest revision as of 14:05, 8 January 2022

Buildroot is a nice, simple, and efficient embedded Linux build system.

Important links

Developer days

Upcoming:

Past:

Talks

This section gathers the list of talks given about Buildroot, as well as the slides and video when available.

Past:

List of forks

  • Home Assistant Operating System. Home Assistant Operating System (formerly HassOS) is an operating system optimized for hosting Home Assistant and its Add-ons.
  • OpenIL. OpenIL is an open source project based on Buildroot and designed for embedded industrial solution.
  • Bsquask SDK. A Rasberry-Pi related fork.
  • [1]. Another RPi related fork, with a lot of focus on Qt5 and GStreamer (appears to be defunct).
  • Buildroot Submodule. Not a fork, but a convenience layer on top of buildroot.
  • Experimental 'shell' around Buildroot. Another wrapper around Buildroot, to help manage projects.

Todo list

This is a list of improvements that we would like to see in buildroot. Feel free to add suggestions here. If you're working on one of these items, put your name and the date behind it, to avoid duplicate work.

There are a number of patches that have been determined to be useful but for various reasons nobody currently has time to review or test them. Anybody, especially a person new to buildroot, is welcome to adopt these patches and resubmit them to the mailing list.

Packages

Note: if you start working on any of these packages, please edit this section to indicate it. If the package is proposed in a bug report, please also update the bug report. Sending a mail to the mailing list also never hurts, you never know that someone else started working on it without following this guideline.

Important

Nice to have

Toolchain

Documentation

Core Buildroot infrastructure

  • Cargo and Go post-process handling for vendoring
    • Add support for tarball formats other than gz
  • Several improvements are possible in the download infrastructure (even after all the improvements that were already done):
    • Rename the downloaded files so they include the package name and version. Special care has to be taken for primary and secondary sites, and for extra downloads (including patches).
    • Split between FOO_SITE and FOO_SOURCE shouldn't be necessary. Or it could be made optional, i.e. make it possible to specify the full path in FOO_SOURCE.
  • Add instrumentation scripts to analyse package installed files:
    • find libraries with wrong RPATH/RUNPATH tags
    • detect unused .so libs (eg. shared libs that are not DT_NEEDED by anything - note: only detect those libs, don't remove: can be used as plugin (dlopen), or used by an application built outside Buildroot)
  • A script that checks consistency of depends/select for packages. Maybe it can be integrated to the current check-package.

Testing infrastructure

  • Fix run-tests to use a config file for download and output directories, can be overridden in the environment
  • Documentation on how to add a test, including naming convention

TODO items under discussion

Here are some nice-to-have's for which it is not entirely clear if and how they could be implemented:

  • Out-of-tree builds, which allows the package source to be shared between different output directories and between host and target compiles.
  • It would be nice if you could run a buildroot command that prepares a local copy of a package's source, and allows you to generate patches for it later. This could use git or quilt to keep track of the patches.
  • It would be nice if there was a make target to reinstall everything to the target (i.e. remove all the target-installed stamps, remove the root stamp, maybe remove the target too). However, what is missing is the copying of the toolchain support files (libc.so etc.). It's not obvious that this can be done in a reliable way.
  • To facilitate debugging, all packages should be installed to the staging directory. The target directory should in fact be a subset of the staging directory. See the FOSDEM 2013 discussion at http://elinux.org/Buildroot:DeveloperDaysFOSDEM2013, and the discussion around patch http://patchwork.ozlabs.org/patch/252718/. This is however a significant change in Buildroot, so probably difficult to implement, and will raise a number of quite complicated questions.