docs: fusa: Add dom0less domain configuration requirements
PATCH v2 1/1 docs: fusa: Add dom0less domain configuration requirements
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
---
Changes from v1 :-
1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.
2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.
3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.
4. The design requirements will be added later.
docs/fusa/reqs/market-reqs/reqs.rst | 16 ++ docs/fusa/reqs/product-reqs/arm64/reqs.rst | 306 +++++++++++++++++++++ 2 files changed, 322 insertions(+)
docs/fusa/reqs/market-reqs/reqs.rst +16 -0
@@ -47,3 +47,19 @@ Comments: Needs: - XenProd + +Static VM definition +-------------------- + +`XenMkt~static_vm_definition~1` + +Description: +Xen shall support assigning peripherals to various domains. + +Rationale: + +Comments: +Peripheral implies an iomem (input output memory) and/or interrupts. + +Needs: + - XenProd
docs/fusa/reqs/product-reqs/arm64/reqs.rst +306 -0
309 lines not on this page · raw message
Signature · 1 line
2.25.1
Hi Ayan,
Quoted 59 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
Changes from v1 :-1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.
2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.
3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.
4. The design requirements will be added later.
docs/fusa/reqs/market-reqs/reqs.rst| 16 ++docs/fusa/reqs/product-reqs/arm64/reqs.rst| 306 +++++++++++++++++++++2 files changed, 322 insertions(+)docs/fusa/reqs/market-reqs/reqs.rst +0
-0@@ -47,3 +47,19 @@ Comments:Needs:
- XenProddocs/fusa/reqs/market-reqs/reqs.rst +16
-0+ +Static VM definition +-------------------- + +`XenMkt~static_vm_definition~1` + +Description: +Xen shall support assigning peripherals to various domains. + +Rationale: + +Comments: +Peripheral implies an iomem (input output memory) and/or interrupts. + +Needs: + - XenProddocs/fusa/reqs/product-reqs/arm64/reqs.rst +0
-0@@ -40,3 +40,309 @@ Covers:Needs:
- XenSwdgn
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 50
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Linux kernel image +------------------ + +`XenProd~linux_kernel_image~1` + +Description: +Xen shall create a domain with a Arm64 Linux kernel image [1].
This shall be rephrased to mention that it shall be a binary with a header compliant with the Linux kernel image format. We do not want to say that we can only boot Linux.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 68
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Gzip Linux kernel image +----------------------- + +`XenProd~linux_kernel_gzip_image~1` + +Description: +Xen shall create a domain with a Arm64 Gzip compressed Linux kernel image.
Ditto.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 86
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Kernel with uImage header +------------------------- + +`XenProd~kernel_uimage~1` + +Description: +Xen shall create a domain with a kernel containing uImage header [2].
I would remove kernel and say binary executable and add compatible or something like that.
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +9
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs:
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 105
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ - XenSwdgn + +Gzip kernel with uImage header +------------------------------ + +`XenSwdgn~arm64_gzip_kernel_uimage~1` + +Description: +Xen shall create a domain with a Gzip compressed kernel containing uImage +header [2].
Same
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 123
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Kernel command line arguments +----------------------------- + +`XenSwdgn~kernel_cmd_line_args~1` + +Description: +Xen shall pass kernel command line arguments to a domain.
I am a bit wondering if this one and the following are not a bit to generic. Should we say through DT or ACPI header for example ?
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 141
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Ramdisk +------- + +`XenSwdgn~ramdisk~1` + +Description: +Xen shall provide initial ramdisk to a domain.
This should be mentioning that it is provided in memory and the address is provided through DT.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 159
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Memory +------ + +`XenSwdgn~memory~1` + +Description: +Xen shall create a domain with specified amount of memory.
I am missing the where this is specified here ? i guess this is also DT
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 177
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +vCPUs +----- + +`XenSwdgn~vcpus~1` + +Description: +Xen shall create a domain with a number of virtual CPUs.
number here is unprecise
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 195
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Credit2 CPU pool scheduler +-------------------------- + +`XenSwdgn~credit2_cpu_pool_scheduler~1` + +Description: +Xen shall assign a Credit2 CPU pool scheduler [3] to a domain.
What is Credit2 ? this needs to be defined somewhere and in fact it shall have product level requirements.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 213
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +NUL CPU pool scheduler +---------------------- + +`XenSwdgn~nul_cpu_pool_scheduler~1` + +Description: +Xen shall assign a NUL CPU pool scheduler to a domain.
Same
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 218
Quoted 5 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Rationale: + +Comments: +A NUL CPU pool scheduler maps a virtual cpu to a unique physical cpu.
This is a product requirement saying that Xen shall have a scheduler with such characteristics and I think this is not enough to define it.
Quoted 5 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs:
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ - XenSwdgn + +SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.
This is very ambiguous. What do you mean here ?
Quoted 11 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: +A shared peripheral interrupt is an interrupt generated by a peripheral that is +accessible across all the cpu cores. + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~static_vm_definition~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 254
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Grant table frames +------------------ + +`XenSwdgn~grant_table_frames~1` + +Description: +Xen shall create a domain with a specified number of grant table frames.
It is really weird to say that Xen shall create something specific without this being linked to an higher level definition of the goal.
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ +Rationale: + +Comments: +Grant tables are a mechanism for sharing and transferring frames (memory buffers) +between domains. + +Covers: + - `XenMkt~run_arm64_domains~1` +
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 274
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Grant maptrack frames +--------------------- + +`XenSwdgn~grant_maptrack_frames~1` + +Description: +Xen shall create a domain with a specified number of grant maptrack frames.
Why is this needed ? what is the high level req for this ?
Quoted 77 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +74
-0+ +Rationale: + +Comments: +Maptrack frame is the metadata for tracking the memory mapped into a domain. + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Virtual PL011 +------------- + +`XenProd~virtual_pl011~1` + +Description: +Xen shall provide an "Arm PL011 UART" compliant device to the domains. + +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~provide_console_domains~1` + +Needs: + - XenSwdgn + +Assign iomem +------------ + +`XenProd~assign_iomem~1` + +Description: +Xen shall support assigning iomem to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +Forward interrupts +------------------ + +`XenProd~forward_irqs~1` + +Description: +Xen shall support forwarding interrupts to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +| [1] https://github.com/torvalds/linux/blob/master/Documentation/arch/arm64/booting.rst +| [2] https://source.denx.de/u-boot/u-boot/-/blob/master/include/image.h#L315 +| [3] https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/features/sched_credit2.pandocSignature · 1 line
2.25.1
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 123 lines
Quoted 60 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
Changes from v1 :-1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.
2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.
3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.
4. The design requirements will be added later.
docs/fusa/reqs/market-reqs/reqs.rst| 16 ++docs/fusa/reqs/product-reqs/arm64/reqs.rst| 306 +++++++++++++++++++++2 files changed, 322 insertions(+)docs/fusa/reqs/market-reqs/reqs.rst +0
-0@@ -47,3 +47,19 @@ Comments:Needs:
- XenProddocs/fusa/reqs/market-reqs/reqs.rst +16
-0+ +Static VM definition +-------------------- + +`XenMkt~static_vm_definition~1` + +Description: +Xen shall support assigning peripherals to various domains. + +Rationale: + +Comments: +Peripheral implies an iomem (input output memory) and/or interrupts. + +Needs: + - XenProddocs/fusa/reqs/product-reqs/arm64/reqs.rst +0
-0@@ -40,3 +40,309 @@ Covers:Needs:
- XenSwdgndocs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 50
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Linux kernel image +------------------ + +`XenProd~linux_kernel_image~1` + +Description: +Xen shall create a domain with a Arm64 Linux kernel image [1].This shall be rephrased to mention that it shall be a binary with a header compliant with the Linux kernel image format. We do not want to say that we can only boot Linux.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 68
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Gzip Linux kernel image +----------------------- + +`XenProd~linux_kernel_gzip_image~1` + +Description: +Xen shall create a domain with a Arm64 Gzip compressed Linux kernel image.Ditto.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 86
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Kernel with uImage header +------------------------- + +`XenProd~kernel_uimage~1` + +Description: +Xen shall create a domain with a kernel containing uImage header [2].I would remove kernel and say binary executable and add compatible or something like that.
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +12
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Gzip kernel with uImage header
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 105
Quoted 7 lines
+------------------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +6
-0+ +`XenSwdgn~arm64_gzip_kernel_uimage~1` + +Description: +Xen shall create a domain with a Gzip compressed kernel containing uImage +header [2].Same
Agreed with all the above.
Quoted 13 lines
Quoted 13 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +12
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Kernel command line arguments
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 123
Quoted 6 lines
+-----------------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +`XenSwdgn~kernel_cmd_line_args~1` + +Description: +Xen shall pass kernel command line arguments to a domain.I am a bit wondering if this one and the following are not a bit to generic. Should we say through DT or ACPI header for example ?
Yes, I can say through device tree. And then I can explain device tree in the comments.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 141
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Ramdisk +------- + +`XenSwdgn~ramdisk~1` + +Description: +Xen shall provide initial ramdisk to a domain.This should be mentioning that it is provided in memory and the address is provided through DT.
Ack.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 159
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Memory +------ + +`XenSwdgn~memory~1` + +Description: +Xen shall create a domain with specified amount of memory.I am missing the where this is specified here ? i guess this is also DT
Yes, this is also DT.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 177
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+vCPUs +----- + +`XenSwdgn~vcpus~1` + +Description: +Xen shall create a domain with a number of virtual CPUs.number here is unprecise
Can I say with one or more number of virtual CPUS ? How would you want me to define.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 195
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Credit2 CPU pool scheduler +-------------------------- + +`XenSwdgn~credit2_cpu_pool_scheduler~1` + +Description: +Xen shall assign a Credit2 CPU pool scheduler [3] to a domain.What is Credit2 ? this needs to be defined somewhere
I have provided a link to the credit2 documentation.
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/features/sched_credit2.pandoc
Do I still need to define it as
"Credit2 is a scheduling mechanism where more than one virtual cpus shares a physical cpus based on a time sharing mechanism."
or should the requirement be rephrased as
"Xen shall have a scheduler where a physical cpu can be shared between more than one virtual cpu".
Quoted 2 lines
and in fact it
shall have product level requirements.
Do you mean this needs to be a product requirement ?
Quoted 21 lines
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 213
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +NUL CPU pool scheduler +---------------------- + +`XenSwdgn~nul_cpu_pool_scheduler~1` + +Description: +Xen shall assign a NUL CPU pool scheduler to a domain.Same
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 218
Quoted 5 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Rationale: + +Comments: +A NUL CPU pool scheduler maps a virtual cpu to a unique physical cpu.This is a product requirement saying that Xen shall have a scheduler with such characteristics and I think this is not enough to define it.
I don't understand this bit. Do you mean this should be product requirement written as "Xen shall have a scheduler where a virtual cpu is always assigned to a unique physical cpu".
Quoted 17 lines
Quoted 6 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs:docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ - XenSwdgn + +SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
Quoted 16 lines
Quoted 16 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +15
-0+ +Rationale: + +Comments: +A shared peripheral interrupt is an interrupt generated by a peripheral that is +accessible across all the cpu cores. + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +Grant table frames
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 254
Quoted 6 lines
+------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +`XenSwdgn~grant_table_frames~1` + +Description: +Xen shall create a domain with a specified number of grant table frames.It is really weird to say that Xen shall create something specific without this being linked to an higher level definition of the goal.
ok, I will drop this and the following requirement for now.
When we have market requirement to specify that "Xen shall allow sharing of buffer with a domain", then we can add this and the following requirement.
Quoted 92 lines
Quoted 11 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ +Rationale: + +Comments: +Grant tables are a mechanism for sharing and transferring frames (memory buffers) +between domains. + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 274
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Grant maptrack frames +--------------------- + +`XenSwdgn~grant_maptrack_frames~1` + +Description: +Xen shall create a domain with a specified number of grant maptrack frames.Why is this needed ? what is the high level req for this ?
Quoted 69 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +69
-0+ +Rationale: + +Comments: +Maptrack frame is the metadata for tracking the memory mapped into a domain. + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Virtual PL011 +------------- + +`XenProd~virtual_pl011~1` + +Description: +Xen shall provide an "Arm PL011 UART" compliant device to the domains. + +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~provide_console_domains~1` + +Needs: + - XenSwdgn + +Assign iomem +------------ + +`XenProd~assign_iomem~1` + +Description: +Xen shall support assigning iomem to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +Forward interrupts +------------------ + +`XenProd~forward_irqs~1` + +Description: +Xen shall support forwarding interrupts to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs:
Quoted 8 lines
Quoted 8 lines
+ - XenSwdgn
++| [1] https://github.com/torvalds/linux/blob/master/Documentation/arch/arm64/booting.rst +| [2] https://source.denx.de/u-boot/u-boot/-/blob/master/include/image.h#L315 +| [3] https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/features/sched_credit2.pandocSignature · 1 line
2.25.1
- Ayan
Hi Ayan,
Quoted 159 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 123 lines
Quoted 60 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
Changes from v1 :-1. As the dom0less domain creation requirements specifies the dt properties for creating domains, it has been moved to product requirements. Product requirements define the interface Xen exposes to other domains.
2. For the requirements which introduces new terms (like grant table, etc), I have provided the definition as part of the comments.
3. Introduced new market requirements to specify that Xen can assign iomem and irqs to domains.
4. The design requirements will be added later.
docs/fusa/reqs/market-reqs/reqs.rst| 16 ++docs/fusa/reqs/product-reqs/arm64/reqs.rst| 306 +++++++++++++++++++++2 files changed, 322 insertions(+)docs/fusa/reqs/market-reqs/reqs.rst +0
-0@@ -47,3 +47,19 @@ Comments:Needs:
- XenProddocs/fusa/reqs/market-reqs/reqs.rst +16
-0+ +Static VM definition +-------------------- + +`XenMkt~static_vm_definition~1` + +Description: +Xen shall support assigning peripherals to various domains. + +Rationale: + +Comments: +Peripheral implies an iomem (input output memory) and/or interrupts. + +Needs: + - XenProddocs/fusa/reqs/product-reqs/arm64/reqs.rst +0
-0@@ -40,3 +40,309 @@ Covers:Needs:
- XenSwdgndocs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 50
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Linux kernel image +------------------ + +`XenProd~linux_kernel_image~1` + +Description: +Xen shall create a domain with a Arm64 Linux kernel image [1].This shall be rephrased to mention that it shall be a binary with a header compliant with the Linux kernel image format. We do not want to say that we can only boot Linux.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 68
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Gzip Linux kernel image +----------------------- + +`XenProd~linux_kernel_gzip_image~1` + +Description: +Xen shall create a domain with a Arm64 Gzip compressed Linux kernel image.Ditto.
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 86
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Kernel with uImage header +------------------------- + +`XenProd~kernel_uimage~1` + +Description: +Xen shall create a domain with a kernel containing uImage header [2].I would remove kernel and say binary executable and add compatible or something like that.
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +12
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Gzip kernel with uImage headerQuoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 105
Quoted 7 lines
+------------------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +6
-0+ +`XenSwdgn~arm64_gzip_kernel_uimage~1` + +Description: +Xen shall create a domain with a Gzip compressed kernel containing uImage +header [2].Same
Agreed with all the above.
Quoted 13 lines
Quoted 13 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +12
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Kernel command line argumentsQuoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 123
Quoted 6 lines
+-----------------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +`XenSwdgn~kernel_cmd_line_args~1` + +Description: +Xen shall pass kernel command line arguments to a domain.I am a bit wondering if this one and the following are not a bit to generic. Should we say through DT or ACPI header for example ?
Quoted 1 line
Yes, I can say through device tree. And then I can explain device tree in the comments.
Ack
Quoted 62 lines
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 141
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Ramdisk +------- + +`XenSwdgn~ramdisk~1` + +Description: +Xen shall provide initial ramdisk to a domain.This should be mentioning that it is provided in memory and the address is provided through DT.
Ack.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 159
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Memory +------ + +`XenSwdgn~memory~1` + +Description: +Xen shall create a domain with specified amount of memory.I am missing the where this is specified here ? i guess this is also DT
Yes, this is also DT.
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 177
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+vCPUs +----- + +`XenSwdgn~vcpus~1` + +Description: +Xen shall create a domain with a number of virtual CPUs.number here is unprecise
Quoted 1 line
Can I say with one or more number of virtual CPUS ? How would you want me to define.
I start to wonder if we should create interface requirements from the guest PoV:
A domain shall have a configurable number of vCPUs (1 to XX).
What do you think ?
Quoted 22 lines
Quoted 12 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +11
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn +Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 195
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +7
-0+Credit2 CPU pool scheduler +-------------------------- + +`XenSwdgn~credit2_cpu_pool_scheduler~1` + +Description: +Xen shall assign a Credit2 CPU pool scheduler [3] to a domain.What is Credit2 ? this needs to be defined somewhere
I have provided a link to the credit2 documentation.
Quoted 8 lines
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/features/sched_credit2.pandoc
Do I still need to define it as
"Credit2 is a scheduling mechanism where more than one virtual cpus shares a physical cpus based on a time sharing mechanism."or should the requirement be rephrased as
"Xen shall have a scheduler where a physical cpu can be shared between more than one virtual cpu".
Yes i think this rephrasing is right.
And we also need a market one saying that Xen shall provide multiple schedulers (With the details of which and how at product level).
Quoted 4 lines
Quoted 3 lines
and in fact it
shall have product level requirements.Do you mean this needs to be a product requirement ?
Yes, this is visible to users, the design should say how the time share is done.
Quoted 21 lines
Quoted 21 lines
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+ +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 213
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +NUL CPU pool scheduler +---------------------- + +`XenSwdgn~nul_cpu_pool_scheduler~1` + +Description: +Xen shall assign a NUL CPU pool scheduler to a domain.Same
Quoted 8 lines
Quoted 7 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 218
Quoted 5 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Rationale: + +Comments: +A NUL CPU pool scheduler maps a virtual cpu to a unique physical cpu.This is a product requirement saying that Xen shall have a scheduler with such characteristics and I think this is not enough to define it.
I don't understand this bit. Do you mean this should be product requirement written as "Xen shall have a scheduler where a virtual cpu is always assigned to a unique physical cpu".
Yes this is what i mean but be careful as this is not really what the NULL scheduler is doing. What you mean is "pinning" here and the NULL scheduler is only about "what runs run as long as it is using the CPU".
Quoted 17 lines
Quoted 17 lines
Quoted 6 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs:docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ - XenSwdgn + +SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Quoted 1 line
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
I am lost in how you achieve such a thing in the configuration.
All you can do is assigned an interrupt to a domain, but the sharing part I do not see what Xen has to do with it.
Quoted 25 lines
Quoted 16 lines
Quoted 16 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +15
-0+ +Rationale: + +Comments: +A shared peripheral interrupt is an interrupt generated by a peripheral that is +accessible across all the cpu cores. + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +Grant table framesQuoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 254
Quoted 6 lines
+------------------
docs/fusa/reqs/product-reqs/arm64/reqs.rst +5
-0+ +`XenSwdgn~grant_table_frames~1` + +Description: +Xen shall create a domain with a specified number of grant table frames.It is really weird to say that Xen shall create something specific without this being linked to an higher level definition of the goal.
Quoted 3 lines
ok, I will drop this and the following requirement for now.
When we have market requirement to specify that "Xen shall allow sharing of buffer with a domain", then we can add this and the following requirement.
ack
Bertrand
Quoted 102 lines
Quoted 93 lines
Quoted 12 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+ +Rationale: + +Comments: +Grant tables are a mechanism for sharing and transferring frames (memory buffers) +between domains. + +Covers: + - `XenMkt~run_arm64_domains~1` +docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 274
Quoted 10 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +10
-0+Needs: + - XenSwdgn + +Grant maptrack frames +--------------------- + +`XenSwdgn~grant_maptrack_frames~1` + +Description: +Xen shall create a domain with a specified number of grant maptrack frames.Why is this needed ? what is the high level req for this ?
Quoted 69 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +69
-0+ +Rationale: + +Comments: +Maptrack frame is the metadata for tracking the memory mapped into a domain. + +Covers: + - `XenMkt~run_arm64_domains~1` + +Needs: + - XenSwdgn + +Virtual PL011 +------------- + +`XenProd~virtual_pl011~1` + +Description: +Xen shall provide an "Arm PL011 UART" compliant device to the domains. + +Rationale: + +Comments: + +Covers: + - `XenMkt~run_arm64_domains~1` + - `XenMkt~provide_console_domains~1` + +Needs: + - XenSwdgn + +Assign iomem +------------ + +`XenProd~assign_iomem~1` + +Description: +Xen shall support assigning iomem to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs: + - XenSwdgn + +Forward interrupts +------------------ + +`XenProd~forward_irqs~1` + +Description: +Xen shall support forwarding interrupts to a domain. + +Rationale: + +Comments: + +Rationale: + +Covers: + - `XenMkt~static_vm_definition~1` + +Needs:Quoted 8 lines
Quoted 8 lines
+ - XenSwdgn
++| [1] https://github.com/torvalds/linux/blob/master/Documentation/arch/arm64/booting.rst +| [2] https://source.denx.de/u-boot/u-boot/-/blob/master/include/image.h#L315 +| [3] https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/features/sched_credit2.pandocSignature · 1 line
2.25.1- Ayan
Quoted 20 lines · Bertrand Marquis
Hi Ayan,
Quoted 16 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 10 lines
Quoted 10 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
[...]
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Quoted 4 lines
Quoted 1 line
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
I am lost in how you achieve such a thing in the configuration.
All you can do is assigned an interrupt to a domain, but the sharing part I do not see what Xen has to do with it.
This req is about Arm's SPIs (Shared Peripheral Interrupts) and the max number you can allocate to a domU. You can see more here:
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/misc/arm/device-tree/booting.txt;hb=HEAD#l172
~Michal
Hi Michal,
Quoted 36 lines · Michal Orzel
Quoted 20 lines · Bertrand Marquis
Hi Ayan,
Quoted 16 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 10 lines
Quoted 10 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
[...]
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Quoted 7 lines
Quoted 4 lines
Quoted 1 line
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
I am lost in how you achieve such a thing in the configuration.
All you can do is assigned an interrupt to a domain, but the sharing part I do not see what Xen has to do with it.This req is about Arm's SPIs (Shared Peripheral Interrupts) and the max number you can allocate to a domU. You can see more here:
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/misc/arm/device-tree/booting.txt;hb=HEAD#l172
Oh right, no idea how i came to shared interrupts instead of Arm SPIs.
Then this is Arm specific and we need to have a bit more context/clear up here (as comment or introduction). And also this should have arm64 somewhere.
Bertrand
Quoted 2 lines
~Michal
Hi Bertrand/Michal,
Quoted 39 lines · Bertrand Marquis
Hi Michal,
Quoted 37 lines · Michal Orzel
Quoted 18 lines · Bertrand Marquis
Hi Ayan,
Quoted 15 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 9 lines
Quoted 9 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
[...]
Quoted 12 lines
Quoted 10 lines
Quoted 9 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst Covers: · line 233
Quoted 8 lines
docs/fusa/reqs/product-reqs/arm64/reqs.rst +8
-0+SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
I am lost in how you achieve such a thing in the configuration.
All you can do is assigned an interrupt to a domain, but the sharing part I do not see what Xen has to do with it.
Quoted 7 lines
Quoted 3 lines
This req is about Arm's SPIs (Shared Peripheral Interrupts) and the max number you can allocate to a domU. You can see more here:
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/misc/arm/device-tree/booting.txt;hb=HEAD#l172Oh right, no idea how i came to shared interrupts instead of Arm SPIs.
Then this is Arm specific and we need to have a bit more context/clear up here (as comment or introduction). And also this should have arm64 somewhere.
ok, I can add Arm specific bits in the comments. Also, will put arm64 in the tag.
Thinking again, this should be a product requirement as it explains the interface to Xen (in this case a dt property), Is this correct understanding ?
Also, to your other comment :-
Quoted 3 lines
Quoted 3 lines
I start to wonder if we should create interface requirements from the guest PoV:
A domain shall have a configurable number of vCPUs (1 to XX).
This should be a product requirement as well. Correct ?
- Ayan
Hi,
Quoted 47 lines · Ayan Kumar Halder
Hi Bertrand/Michal,
Quoted 42 lines · Bertrand Marquis
Hi Michal,
Quoted 40 lines · Michal Orzel
Quoted 18 lines · Bertrand Marquis
Hi Ayan,
Quoted 15 lines · Ayan Kumar Halder
Quoted 1 line · Bertrand Marquis
Hi Ayan,
Hi Bertrand,
Quoted 9 lines
Quoted 9 lines · Ayan Kumar Halder
From: Michal Orzel <[email protected]>
Add requirements for dom0less domain creation.
Signed-off-by Michal Orzel <[email protected]>Signed-off-by Ayan Kumar Halder <[email protected]>---
[...]
Quoted 9 lines
Quoted 9 lines
Quoted 9 lines
Review
Quoted 8 lines
(quoted diff) +8
-0+SPIs +---- + +`XenSwdgn~spis~1` + +Description: +Xen shall allocate a specified number of shared peripheral interrupts for a +domain.This is very ambiguous. What do you mean here ?
Quoted 3 lines
Quoted 1 line
Xen shall provide a way to specify the number of shared peripheral interrupts for a domain via the device tree .
I am lost in how you achieve such a thing in the configuration.
All you can do is assigned an interrupt to a domain, but the sharing part I do not see what Xen has to do with it.This req is about Arm's SPIs (Shared Peripheral Interrupts) and the max number you can allocate to a domU. You can see more here:
https://xenbits.xenproject.org/gitweb/?p=xen.git;a=blob;f=docs/misc/arm/device-tree/booting.txt;hb=HEAD#l172
Quoted 8 lines
Quoted 4 lines
Oh right, no idea how i came to shared interrupts instead of Arm SPIs.
Then this is Arm specific and we need to have a bit more context/clear up here (as comment or introduction). And also this should have arm64 somewhere.
ok, I can add Arm specific bits in the comments. Also, will put arm64 in the tag.
Thinking again, this should be a product requirement as it explains the interface to Xen (in this case a dt property), Is this correct understanding ?
Yes it should.
Quoted 8 lines
Also, to your other comment :-
Quoted 3 lines
Quoted 3 lines
I start to wonder if we should create interface requirements from the guest PoV:
A domain shall have a configurable number of vCPUs (1 to XX).
This should be a product requirement as well. Correct ?
Correct.
Cheers
Bertrand
Quoted 2 lines
- Ayan