| Message ID | 20200701161153.30988-2-alex.bennee@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | some docs (booting, mttcg, icount) | expand |
On 7/1/20 9:11 AM, Alex Bennée wrote: > While working on some test cases I realised there was quite a lot of > assumed knowledge about how things boot up. I thought it would be > worth gathering this together in a user facing document where we could > pour in the details and background to the boot process. As it's quite > wordy I thought it should be a separate document to the manual (which > can obviously reference this). > > The document follows the socratic method and leaves the reader to ask > themselves some questions in an effort to elucidate them about any > problems they may be having. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> > Message-Id: <20190308211557.22589-1-alex.bennee@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> r~
On Wed, 1 Jul 2020 at 17:16, Alex Bennée <alex.bennee@linaro.org> wrote: > > While working on some test cases I realised there was quite a lot of > assumed knowledge about how things boot up. I thought it would be > worth gathering this together in a user facing document where we could > pour in the details and background to the boot process. As it's quite > wordy I thought it should be a separate document to the manual (which > can obviously reference this). > > The document follows the socratic method and leaves the reader to ask > themselves some questions in an effort to elucidate them about any > problems they may be having. > > Signed-off-by: Alex Bennée <alex.bennee@linaro.org> > Message-Id: <20190308211557.22589-1-alex.bennee@linaro.org> > I have some typo/grammar nits below, but more significantly: I don't really see why this is a bit of QEMU's documentation rather than, say, a blog post. It doesn't really say much about QEMU in particular. It's also rather vague about what guest architecture it's talking about, and they can differ significantly both in the real world and in how QEMU handles them. Also, why put it in interop? > --- > v2 > - fix a lot of it's/its > - mention microvm style booting > - add some questions to the end > --- > docs/interop/booting.rst | 159 +++++++++++++++++++++++++++++++++++++++ > docs/interop/index.rst | 1 + > 2 files changed, 160 insertions(+) > create mode 100644 docs/interop/booting.rst > > diff --git a/docs/interop/booting.rst b/docs/interop/booting.rst > new file mode 100644 > index 00000000000..8579a775d04 > --- /dev/null > +++ b/docs/interop/booting.rst > @@ -0,0 +1,159 @@ > +.. > + Copyright (c) 2019-2020 Linaro Ltd. > + > + This work is licensed under the terms of the GNU GPL, version 2 or > + later. See the COPYING file in the top-level directory. > + > +===================================== > +Anatomy of a Boot, a QEMU perspective > +===================================== > + > +This document attempts to give an overview of how machines boot and > +how this matters to QEMU. We will discuss firmware and BIOSes and the > +things they do before the OS kernel is loaded and your usable system > +is finally ready. > + > +Firmware > +======== > + > +When a CPU is powered up it knows nothing about its environment. The > +internal state, including the program counter (PC), will be reset to a > +defined set of values and it will attempt to fetch the first > +instruction and execute it. It is the job of the firmware to bring a > +CPU up from the initial few instructions to running in a relatively > +sane execution environment. Firmware tends to be specific to the > +hardware in question and is stored on non-volatile memory (memory that > +survives a power off) usually a ROM or flash device on the computers ", usually" > +main board. > + > +Some examples of what firmware does include: > + > +Early Hardware Setup > +-------------------- > + > +Modern hardware often requires configuring before it is usable. For > +example most modern systems won't have working RAM until the memory > +controller has been programmed with the correct timings for whatever > +memory is installed on the system. Processors may boot with a very > +restricted view of the memory map until RAM and other key peripherals > +have been configured to appear in its address space. Some hardware > +may not even appear until some sort of blob has been loaded into it so > +it can start responding to the CPU. > + > +Fortunately for QEMU we don't have to worry too much about this very > +low level configuration. The device model we present to the CPU at > +start-up will generally respond to IO access from processor straight "the processor" > +away. > + > +BIOS or Firmware Services > +------------------------- > + > +In the early days of the PC era the BIOS or Basic Input/Output System > +provided an abstraction interface to the operating system which > +allowed them to do basic IO operations without having to directly "allowed the OS" > +drive the hardware. Since then the scope of these firmware services > +have grown as systems become more and more complex. "has grown" > + > +Modern firmware often follows the Unified Extensible Firmware > +Interface (UEFI) which provides services like secure boot, persistent > +variables and external time-keeping. > + > +There can often be multiple levels of firmware service functions. For > +example systems which support secure execution enclaves generally have > +a firmware component that executes in this secure mode which the > +operating system can call in a defined secure manner to undertake > +security sensitive tasks on its behalf. > + > +Hardware Enumeration > +-------------------- > + > +It is easy to assume that modern hardware is built to be discover-able "discoverable" > +and all the operating system needs to do is enumerate the various > +buses on the system to find out what hardware exists. While buses like > +PCI and USB do support discovery there is usually much more on a > +modern system than just these two things. > + > +This process of discovery can take some time as devices usually need > +to be probed and some time allowed for the buses to settle and the > +probe complete. For purely virtual machines operating in on-demand "probe to complete". > +cloud environments you may operate with stripped down kernels that > +only support a fixed expected environment so they can boot as fast as > +possible. > + > +In the embedded world it used to be acceptable to have a similar > +custom compiled kernel which knew where everything is meant to be. > +However this was a brittle approach and not very flexible. For example > +a general purpose distribution would have to ship a special kernel for > +each variant of hardware you wanted to run on. If you try and use a > +kernel compiled for one platform that nominally uses the same > +processor as another platform the result will rarely work given a > +processor rarely works in isolation. "the result will generally not work." > + > +The more modern approach is to have a "generic" kernel that has a > +number of different drivers compiled in which are then enabled based > +on a hardware description provided by the firmware. This allows > +flexibility on both sides. The software distribution is less concerned > +about managing lots of different kernels for different pieces of > +hardware. The hardware manufacturer is also able to make small changes > +to the board over time to fix bugs or change minor components. > + > +The two main methods for this are the Advanced Configuration and Power > +Interface (ACPI) and Device Trees. ACPI originated from the PC world > +although it is becoming increasingly common for "enterprise" hardware > +like servers. Device Trees of various forms have existed for a while > +with perhaps the most common being Flattened Device Trees (FDT). > + > +Boot Code > +========= > + > +The line between firmware and boot code is a very blurry one. However > +from a functionality point of view we have moved from ensuring the > +hardware is usable as a computing device to finding and loading a > +kernel which is then going to take over control of the system. Modern > +firmware often has the ability to boot a kernel directly and in some > +systems you might chain through several boot loaders before the final > +kernel takes control. > + > +The boot loader needs to do 3 things: > + > + - find a kernel and load it into RAM > + - ensure the CPU is in the correct mode for the kernel to boot > + - pass any information the kernel may need to boot and can't find itself > + > +Once it has done these things it can jump to the kernel and let it get > +on with things. > + > +Kernel > +====== > + > +The Kernel now takes over and will be in charge of the system from now > +on. It will enumerate all the devices on the system (again) and load > +drivers that can control them. It will then locate some sort of > +file-system and eventually start running programs that actually do > +work. > + > +Questions to ask yourself > +========================= > + > +Having given this overview of booting here are some questions you > +should ask when diagnosing boot problems. > + > +Hardware > +~~~~~~~~ Previously you used '-----' as the title format for "next level below "====="; Sphinx will complain that you're not being consistent (see the patchew emails). > + > + - is the platform fixed or dynamic? > + - is the platform enumeratable (e.g. PCI/USB)? > + > +Firmware > +~~~~~~~~ > + > + - is the firmware built for the platform your are booting? "you are" > + - does the firmware need storage for variables (boot index etc)? > + - does the firmware provide a service to kernels (e.g. ACPI/EFI)? > + > +Kernel > +~~~~~~ > + > + - is the kernel platform specific or generic? > + - how will the kernel enumerate the platform? > + - can the kernel interface talk to the firmware? > diff --git a/docs/interop/index.rst b/docs/interop/index.rst > index 049387ac6de..58d587444b3 100644 > --- a/docs/interop/index.rst > +++ b/docs/interop/index.rst > @@ -12,6 +12,7 @@ Contents: > .. toctree:: > :maxdepth: 2 > > + booting > bitmaps > dbus > dbus-vmstate > -- thanks -- PMM
Peter Maydell <peter.maydell@linaro.org> writes: > On Wed, 1 Jul 2020 at 17:16, Alex Bennée <alex.bennee@linaro.org> wrote: >> >> While working on some test cases I realised there was quite a lot of >> assumed knowledge about how things boot up. I thought it would be >> worth gathering this together in a user facing document where we could >> pour in the details and background to the boot process. As it's quite >> wordy I thought it should be a separate document to the manual (which >> can obviously reference this). >> >> The document follows the socratic method and leaves the reader to ask >> themselves some questions in an effort to elucidate them about any >> problems they may be having. >> >> Signed-off-by: Alex Bennée <alex.bennee@linaro.org> >> Message-Id: <20190308211557.22589-1-alex.bennee@linaro.org> >> > > I have some typo/grammar nits below, but more significantly: > I don't really see why this is a bit of QEMU's documentation > rather than, say, a blog post. The aim was to make it an initial overview so when people ask about why they can't boot their systems they have considered the questions at the end. It does seem to be a repeating topic on the IRC channel. > It doesn't really say much > about QEMU in particular. It's also rather vague about > what guest architecture it's talking about, and they can > differ significantly both in the real world and in how QEMU > handles them. Perhaps what we really need is a shorter punchier section offering guidance in the manual itself? It just seemed quite a big topic which is why I ended up with a fairly long explanation without even getting to specifics. I could certainly see the document being expanded in the future with more concrete examples for various architectures and scenarios. > Also, why put it in interop? interop being where QEMU interfaces with other things such as kernels and firmwares? It seems too user focused for devel and too long for the manual itself. -- Alex Bennée
diff --git a/docs/interop/booting.rst b/docs/interop/booting.rst new file mode 100644 index 00000000000..8579a775d04 --- /dev/null +++ b/docs/interop/booting.rst @@ -0,0 +1,159 @@ +.. + Copyright (c) 2019-2020 Linaro Ltd. + + This work is licensed under the terms of the GNU GPL, version 2 or + later. See the COPYING file in the top-level directory. + +===================================== +Anatomy of a Boot, a QEMU perspective +===================================== + +This document attempts to give an overview of how machines boot and +how this matters to QEMU. We will discuss firmware and BIOSes and the +things they do before the OS kernel is loaded and your usable system +is finally ready. + +Firmware +======== + +When a CPU is powered up it knows nothing about its environment. The +internal state, including the program counter (PC), will be reset to a +defined set of values and it will attempt to fetch the first +instruction and execute it. It is the job of the firmware to bring a +CPU up from the initial few instructions to running in a relatively +sane execution environment. Firmware tends to be specific to the +hardware in question and is stored on non-volatile memory (memory that +survives a power off) usually a ROM or flash device on the computers +main board. + +Some examples of what firmware does include: + +Early Hardware Setup +-------------------- + +Modern hardware often requires configuring before it is usable. For +example most modern systems won't have working RAM until the memory +controller has been programmed with the correct timings for whatever +memory is installed on the system. Processors may boot with a very +restricted view of the memory map until RAM and other key peripherals +have been configured to appear in its address space. Some hardware +may not even appear until some sort of blob has been loaded into it so +it can start responding to the CPU. + +Fortunately for QEMU we don't have to worry too much about this very +low level configuration. The device model we present to the CPU at +start-up will generally respond to IO access from processor straight +away. + +BIOS or Firmware Services +------------------------- + +In the early days of the PC era the BIOS or Basic Input/Output System +provided an abstraction interface to the operating system which +allowed them to do basic IO operations without having to directly +drive the hardware. Since then the scope of these firmware services +have grown as systems become more and more complex. + +Modern firmware often follows the Unified Extensible Firmware +Interface (UEFI) which provides services like secure boot, persistent +variables and external time-keeping. + +There can often be multiple levels of firmware service functions. For +example systems which support secure execution enclaves generally have +a firmware component that executes in this secure mode which the +operating system can call in a defined secure manner to undertake +security sensitive tasks on its behalf. + +Hardware Enumeration +-------------------- + +It is easy to assume that modern hardware is built to be discover-able +and all the operating system needs to do is enumerate the various +buses on the system to find out what hardware exists. While buses like +PCI and USB do support discovery there is usually much more on a +modern system than just these two things. + +This process of discovery can take some time as devices usually need +to be probed and some time allowed for the buses to settle and the +probe complete. For purely virtual machines operating in on-demand +cloud environments you may operate with stripped down kernels that +only support a fixed expected environment so they can boot as fast as +possible. + +In the embedded world it used to be acceptable to have a similar +custom compiled kernel which knew where everything is meant to be. +However this was a brittle approach and not very flexible. For example +a general purpose distribution would have to ship a special kernel for +each variant of hardware you wanted to run on. If you try and use a +kernel compiled for one platform that nominally uses the same +processor as another platform the result will rarely work given a +processor rarely works in isolation. + +The more modern approach is to have a "generic" kernel that has a +number of different drivers compiled in which are then enabled based +on a hardware description provided by the firmware. This allows +flexibility on both sides. The software distribution is less concerned +about managing lots of different kernels for different pieces of +hardware. The hardware manufacturer is also able to make small changes +to the board over time to fix bugs or change minor components. + +The two main methods for this are the Advanced Configuration and Power +Interface (ACPI) and Device Trees. ACPI originated from the PC world +although it is becoming increasingly common for "enterprise" hardware +like servers. Device Trees of various forms have existed for a while +with perhaps the most common being Flattened Device Trees (FDT). + +Boot Code +========= + +The line between firmware and boot code is a very blurry one. However +from a functionality point of view we have moved from ensuring the +hardware is usable as a computing device to finding and loading a +kernel which is then going to take over control of the system. Modern +firmware often has the ability to boot a kernel directly and in some +systems you might chain through several boot loaders before the final +kernel takes control. + +The boot loader needs to do 3 things: + + - find a kernel and load it into RAM + - ensure the CPU is in the correct mode for the kernel to boot + - pass any information the kernel may need to boot and can't find itself + +Once it has done these things it can jump to the kernel and let it get +on with things. + +Kernel +====== + +The Kernel now takes over and will be in charge of the system from now +on. It will enumerate all the devices on the system (again) and load +drivers that can control them. It will then locate some sort of +file-system and eventually start running programs that actually do +work. + +Questions to ask yourself +========================= + +Having given this overview of booting here are some questions you +should ask when diagnosing boot problems. + +Hardware +~~~~~~~~ + + - is the platform fixed or dynamic? + - is the platform enumeratable (e.g. PCI/USB)? + +Firmware +~~~~~~~~ + + - is the firmware built for the platform your are booting? + - does the firmware need storage for variables (boot index etc)? + - does the firmware provide a service to kernels (e.g. ACPI/EFI)? + +Kernel +~~~~~~ + + - is the kernel platform specific or generic? + - how will the kernel enumerate the platform? + - can the kernel interface talk to the firmware? diff --git a/docs/interop/index.rst b/docs/interop/index.rst index 049387ac6de..58d587444b3 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -12,6 +12,7 @@ Contents: .. toctree:: :maxdepth: 2 + booting bitmaps dbus dbus-vmstate
While working on some test cases I realised there was quite a lot of assumed knowledge about how things boot up. I thought it would be worth gathering this together in a user facing document where we could pour in the details and background to the boot process. As it's quite wordy I thought it should be a separate document to the manual (which can obviously reference this). The document follows the socratic method and leaves the reader to ask themselves some questions in an effort to elucidate them about any problems they may be having. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20190308211557.22589-1-alex.bennee@linaro.org> --- v2 - fix a lot of it's/its - mention microvm style booting - add some questions to the end --- docs/interop/booting.rst | 159 +++++++++++++++++++++++++++++++++++++++ docs/interop/index.rst | 1 + 2 files changed, 160 insertions(+) create mode 100644 docs/interop/booting.rst -- 2.20.1