Skip to contentSkip to conversation

hw/i386/pc: Clarify pc_system_ovmf_table_find usage

PATCH In review Dov Murik 2 participants 6 messages Jul 1, 2021 – Jul 12, 2021

lore
Share & tools
lore

Dov Murik

author
#0 lore raw

v3 cover hw/i386/pc: Clarify pc_system_ovmf_table_find usage

Add assertion to verify that the flash was parsed (looking for the OVMF table), and add documentation for pc_system_ovmf_table_find.

v3:
- [style] remove static initalization to 'false'

v2:
- add assertion (insert patch 1/2)

Dov Murik (2):
hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed hw/i386/pc: Document pc_system_ovmf_table_find

 hw/i386/pc_sysfw.c | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)
Signature · 1 line
2.25.1
author
#1 lore raw

PATCH v3 1/2 hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed

Add assertion in pc_system_ovmf_table_find that verifies that the flash was indeed previously parsed (looking for the OVMF table) by pc_system_parse_ovmf_flash.

Now pc_system_ovmf_table_find distinguishes between "no one called pc_system_parse_ovmf_flash" (which will abort due to assertion failure) and "the flash was parsed but no OVMF table was found, or it is invalid" (which will return false).

---
 hw/i386/pc_sysfw.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
hw/i386/pc_sysfw.c +6 -1
index 6ce37a2b05..e353f2a4e9 100644
@@ -126,6 +126,7 @@ void pc_system_flash_cleanup_unused(PCMachineState *pcms)
 
 #define OVMF_TABLE_FOOTER_GUID "96b582de-1fb2-45f7-baea-a366c55a082d"
 
+static bool ovmf_flash_parsed;
 static uint8_t *ovmf_table;
 static int ovmf_table_len;
 
@@ -136,10 +137,12 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     int tot_len;
 
     /* should only be called once */
-    if (ovmf_table) {
+    if (ovmf_flash_parsed) {
         return;
     }
 
+    ovmf_flash_parsed = true;
+
     if (flash_size < TARGET_PAGE_SIZE) {
         return;
     }
@@ -183,6 +186,8 @@ bool pc_system_ovmf_table_find(const char *entry, uint8_t **data,
     int tot_len = ovmf_table_len;
     QemuUUID entry_guid;
 
+    assert(ovmf_flash_parsed);
+
     if (qemu_uuid_parse(entry, &entry_guid) < 0) {
         return false;
     }
Signature · 1 line
2.25.1
Reviewed-by on v3 1/2
#2 lore raw

Re: [PATCH v3 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed

Quoted 4 lines · Dov Murik

Add assertion in pc_system_ovmf_table_find that verifies that the flash was indeed previously parsed (looking for the OVMF table) by pc_system_parse_ovmf_flash.

Quoted 8 lines

Now pc_system_ovmf_table_find distinguishes between "no one called pc_system_parse_ovmf_flash" (which will abort due to assertion failure) and "the flash was parsed but no OVMF table was found, or it is invalid" (which will return false).

For obvious / checkpatch fixes you can keep the tags ;)

Quoted 3 lines
---
 hw/i386/pc_sysfw.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
author
#3 lore raw

Re: [PATCH v3 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed

Quoted 10 lines · Philippe Mathieu-Daudé
Quoted 9 lines · Dov Murik

Add assertion in pc_system_ovmf_table_find that verifies that the flash was indeed previously parsed (looking for the OVMF table) by pc_system_parse_ovmf_flash.

Now pc_system_ovmf_table_find distinguishes between "no one called pc_system_parse_ovmf_flash" (which will abort due to assertion failure) and "the flash was parsed but no OVMF table was found, or it is invalid" (which will return false).

Quoted 8 lines
Quoted 3 lines

For obvious / checkpatch fixes you can keep the tags ;)

Thanks Phil.

-Dov

author
#4 lore raw

PATCH v3 2/2 hw/i386/pc: Document pc_system_ovmf_table_find

In reply to Dov Murik
---
 hw/i386/pc_sysfw.c | 11 +++++++++++
 1 file changed, 11 insertions(+)
hw/i386/pc_sysfw.c +11 -0
index e353f2a4e9..6ddce92a86 100644
@@ -179,6 +179,17 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**
+ * pc_system_ovmf_table_find - Find the data associated with an entry in OVMF's
+ * reset vector GUIDed table.
+ *
+ * @entry: GUID string of the entry to lookup
+ * @data: Filled with a pointer to the entry's value (if not NULL)
+ * @data_len: Filled with the length of the entry's value (if not NULL). Pass
+ *            NULL here if the length of data is known.
+ *
+ * Return: true if the entry was found in the OVMF table; false otherwise.
+ */
 bool pc_system_ovmf_table_find(const char *entry, uint8_t **data,
                                int *data_len)
 {
Signature · 1 line
2.25.1
#5 lore raw
In reply to Dov Murik
Quoted 10 lines · Dov Murik

Add assertion to verify that the flash was parsed (looking for the OVMF table), and add documentation for pc_system_ovmf_table_find.

Dov Murik (2):
hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed hw/i386/pc: Document pc_system_ovmf_table_find

 hw/i386/pc_sysfw.c | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

Thanks, queued to fw-edk2 tree.