Skip to content

acpi: refactor error prone build_header() and packed structures usage in ACPI tables

Igor Mammedov qemu-arm qemu-devel 5 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v4 Latest35 patches 4 repliesIn review
  2. v335 patches 42 repliesSuperseded
  3. v2 posting 2/215 patches 21 repliesSuperseded
Earlier versions · 2
VersionPostedPatchesRepliesStatus
v2 posting 1/235 patches20 repliesSuperseded
v153 patches14 repliesSuperseded

Changes in v4 from the cover letter

1. comments fixups and diing missing comments
2. clean up spurious changes
3. rebase on top of (4be8bfcb4d hw/i386/acpi-build: Fix a typo)
4. convert build_iort:
* keep nb_nodes variable
* encode 'Memory access properties' as separate entries according to Table 13

Patches in v4 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/35acpi: add helper routines to initialize ACPI tableshw/acpi/aml-build.c include/hw/acpi/aml-build.h+93 -02 replies
2/35acpi: build_rsdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/aml-build.c include/hw/acpi/acpi-defs.h+15 -260 replies
3/35acpi: build_xsdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/aml-build.c include/hw/acpi/acpi-defs.h+15 -260 replies
4/35acpi: build_slit: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/aml-build.c+5 -80 replies
5/35acpi: build_fadt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/aml-build.c+7 -70 replies
6/35acpi: build_tpm2: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/aml-build.c+5 -60 replies
7/35acpi: acpi_build_hest: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/ghes.c+4 -60 replies
8/35acpi: build_mcfg: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/pci.c+9 -90 replies
9/35acpi: build_hmat: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/hmat.c+6 -80 replies
10/35acpi: nvdimm_build_nfit: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/nvdimm.c+17 -250 replies
11/35acpi: nvdimm_build_ssdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/nvdimm.c+10 -80 replies
12/35acpi: vmgenid_build_acpi: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/acpi/vmgenid.c+6 -70 replies
13/35acpi: x86: build_dsdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c+4 -60 replies
14/35acpi: build_hpet: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c include/hw/acpi/acpi-defs.h+18 -210 replies
15/35acpi: build_tpm_tcpa: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c include/hw/acpi/acpi-defs.h+23 -291 reply
16/35acpi: arm/x86: build_srat: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c hw/i386/acpi-build.c include/hw/acpi/acpi-defs.h+14 -300 replies
17/35acpi: use build_append_int_noprefix() API to compose SRAT tablehw/acpi/aml-build.c hw/acpi/nvdimm.c hw/arm/virt-acpi-build.c +3 more+80 -1060 replies
18/35acpi: build_dmar_q35: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c include/hw/acpi/acpi-defs.h+48 -1070 replies
19/35acpi: build_waet: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c+4 -60 replies
20/35acpi: build_amd_iommu: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-build.c+4 -70 replies
21/35acpi: madt: arm/x86: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c hw/i386/acpi-common.c include/hw/acpi/acpi-defs.h+22 -250 replies
22/35acpi: x86: remove dead codeinclude/hw/acpi/acpi-defs.h+0 -130 replies
23/35acpi: x86: set enabled when composing _MAT entrieshw/acpi/acpi-x86-stub.c hw/acpi/cpu.c hw/i386/acpi-common.c +2 more+15 -320 replies
24/35acpi: x86: madt: use build_append_int_noprefix() API to compose MADT tablehw/i386/acpi-common.c include/hw/acpi/acpi-defs.h+67 -1260 replies
25/35acpi: arm/virt: madt: use build_append_int_noprefix() API to compose MADT tablehw/arm/virt-acpi-build.c include/hw/acpi/acpi-defs.h+90 -1440 replies
26/35acpi: build_dsdt_microvm: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/i386/acpi-microvm.c+6 -70 replies
27/35acpi: arm: virt: build_dsdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c+6 -70 replies
28/35acpi: arm: virt: build_iort: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c include/hw/acpi/acpi-defs.h+18 -400 replies
29/35acpi: arm/virt: convert build_iort() to endian agnostic build_append_FOO() APIhw/arm/virt-acpi-build.c include/hw/acpi/acpi-defs.h+93 -1421 reply
30/35acpi: arm/virt: build_spcr: fix invalid casthw/arm/virt-acpi-build.c+1 -10 replies
31/35acpi: arm/virt: build_spcr: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c include/hw/acpi/acpi-defs.h+41 -590 replies
32/35acpi: arm/virt: build_gtdt: use acpi_table_begin()/acpi_table_end() instead of build_header()hw/arm/virt-acpi-build.c include/hw/acpi/acpi-defs.h+48 -520 replies
33/35acpi: build_facs: use build_append_int_noprefix() API to compose tablehw/i386/acpi-build.c include/hw/acpi/acpi-defs.h+14 -180 replies
34/35acpi: remove no longer used build_header()hw/acpi/aml-build.c include/hw/acpi/acpi-defs.h include/hw/acpi/aml-build.h+0 -520 replies
35/35acpi: AcpiGenericAddress no longer used to map/access fields of MMIO, drop packed attributeinclude/hw/acpi/acpi-defs.h+1 -10 replies

Reviews trailers per patch

34 of 35 patches have a Reviewed-by or Acked-by.

PatchEric AugerStefan BergerDongjiu GengYanan Wang
1/35R-b T-b T-b
2/35R-b
3/35R-b
4/35R-b
5/35R-b
6/35R-b T-b
7/35R-b R-b
8/35R-b
9/35R-b
10/35R-b
11/35R-b
12/35R-b
13/35R-b
14/35
15/35R-b T-b
16/35R-b
17/35R-b
18/35R-b
19/35R-b
20/35R-b
21/35R-b
22/35R-b
23/35R-b
24/35R-b
25/35R-b
26/35R-b
27/35R-b
28/35R-b T-b
29/35R-b T-b
30/35R-b
31/35R-b
32/35R-b
33/35R-b
34/35R-b
35/35R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v4 thread

Cover letter [PATCH v4 00/35] acpi: refactor error prone build_header() and packed structures usage in ACPI tables

v4:
1. comments fixups and diing missing comments
2. clean up spurious changes
3. rebase on top of (4be8bfcb4d hw/i386/acpi-build: Fix a typo)
4. convert build_iort:
* keep nb_nodes variable
* encode 'Memory access properties' as separate entries according to Table 13

v3:
1. s/acpi_init_table()|acpi_table_composed()/acpi_table_begin()|acpi_table_end()/
2. arm:madt fix incorrect length
3. various comment improvments
4. rewrite IORT conversion patch due to heavy conflicts with bypass iommu code merged recently
5 pick up Eric's Reviewed-By where there wasn't significant change (1)

v2:
- drop test related patches, they will be sent as a separate series
- fix bios_loader pointer initialization ordering when using TPM1.2
- extend commit message of [1/35] and add extra comment about table length patching

Highlights:
* drop pointer arithmetic in ACPI tables code
* use endian agnostic API
* simplifies review of tables. /in most cases just line by line comparision with spec/

Series replaces build_header() with acpi_table_begin()/acpi_table_end() API that hides pointer/offset arithmetic from user, to prevent errors caused by it [1].
While doing above, it was necessary to split table header from packed structure that was describing the table, which is counter-productive since it still leaves packed structure drawbacks. So that sort of forced me to rewrite tables that were composed with help of packed structures to preferred build_append_int_noprefix() API. In cases where refactoring to build_append_int_noprefix() was small, it was squashed with acpi_table_begin()/acpi_table_end() patch. Conversion reduced code size quite a bit despite me adding doc comments for every table row.

1) commits
bb9feea43179 x86: acpi: use offset instead of pointer when using build_header() 4d027afeb3a9 Virt: ACPI: fix qemu assert due to re-assigned table data address

Link to repo with this series and tests to validate it:
https://gitlab.com/imammedo/qemu/-/commits/acpi_build_header_refactoring_v4

Previous v3 revision can be found at:
https://lore.kernel.org/qemu-devel/[email protected]/T/

Igor Mammedov (35):
acpi: add helper routines to initialize ACPI tables
acpi: build_rsdt: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_xsdt: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_slit: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_fadt: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_tpm2: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: acpi_build_hest: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: build_mcfg: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_hmat: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: nvdimm_build_nfit: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: nvdimm_build_ssdt: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: vmgenid_build_acpi: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: x86: build_dsdt: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: build_hpet: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_tpm_tcpa: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: arm/x86: build_srat: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: use build_append_int_noprefix() API to compose SRAT table
acpi: build_dmar_q35: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: build_waet: use acpi_table_begin()/acpi_table_end() instead of
build_header()
acpi: build_amd_iommu: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: madt: arm/x86: use acpi_table_begin()/acpi_table_end() instead
of build_header()
acpi: x86: remove dead code
acpi: x86: set enabled when composing _MAT entries
acpi: x86: madt: use build_append_int_noprefix() API to compose MADT
table
acpi: arm/virt: madt: use build_append_int_noprefix() API to compose
MADT table
acpi: build_dsdt_microvm: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: arm: virt: build_dsdt: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: arm: virt: build_iort: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: arm/virt: convert build_iort() to endian agnostic
build_append_FOO() API
acpi: arm/virt: build_spcr: fix invalid cast
acpi: arm/virt: build_spcr: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: arm/virt: build_gtdt: use acpi_table_begin()/acpi_table_end()
instead of build_header()
acpi: build_facs: use build_append_int_noprefix() API to compose table
acpi: remove no longer used build_header()
acpi: AcpiGenericAddress no longer used to map/access fields of MMIO,
drop packed attribute

 include/hw/acpi/acpi-defs.h          | 528 +-----------------------
 include/hw/acpi/acpi_dev_interface.h |   3 +-
 include/hw/acpi/aml-build.h          |  37 +-
 include/hw/i386/pc.h                 |   6 +-
 hw/acpi/acpi-x86-stub.c              |   3 +-
 hw/acpi/aml-build.c                  | 203 ++++++----
 hw/acpi/cpu.c                        |  17 +-
 hw/acpi/ghes.c                       |  10 +-
 hw/acpi/hmat.c                       |  14 +-
 hw/acpi/nvdimm.c                     |  64 ++-
 hw/acpi/pci.c                        |  18 +-
 hw/acpi/vmgenid.c                    |  13 +-
 hw/arm/virt-acpi-build.c             | 577 +++++++++++++++------------
 hw/i386/acpi-build.c                 | 294 ++++++++------
 hw/i386/acpi-common.c                | 160 ++++----
 hw/i386/acpi-microvm.c               |  13 +-
 16 files changed, 801 insertions(+), 1159 deletions(-)
Signature · 1 line
2.27.0