hw/i386/pc: Clarify pc_system_ovmf_table_find usage
v2 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.
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
PATCH v2 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
@@ -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 = false;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
Re: [PATCH v2 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed
Quoted 9 lines · Dov Murik
Add assertion in
pc_system_ovmf_table_findthat verifies that the flash was indeed previously parsed (looking for the OVMF table) bypc_system_parse_ovmf_flash.Now
pc_system_ovmf_table_finddistinguishes between "no one calledpc_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 5 lines
Suggested-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Dov Murik <[email protected]>--- hw/i386/pc_sysfw.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
Thank you Dov,
Phil.
Re: [PATCH v2 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_findthat verifies that the flash was indeed previously parsed (looking for the OVMF table) bypc_system_parse_ovmf_flash.Now
pc_system_ovmf_table_finddistinguishes between "no one calledpc_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 7 lines
Quoted 5 lines
Suggested-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Dov Murik <[email protected]>--- hw/i386/pc_sysfw.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)Reviewed-by Philippe Mathieu-Daudé <[email protected]>
Thanks Phil for the constructive review process.
-Dov
Re: [PATCH v2 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed
In reply to Dov MurikQuoted 11 lines · Dov Murik
Add assertion in
pc_system_ovmf_table_findthat verifies that the flash was indeed previously parsed (looking for the OVMF table) bypc_system_parse_ovmf_flash.Now
pc_system_ovmf_table_finddistinguishes between "no one calledpc_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).Suggested-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Dov Murik <[email protected]>
Does the qemu coding style prefer not initializing the bool to false since it will default to that? Otherwise,
Quoted 40 lines
--- hw/i386/pc_sysfw.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)hw/i386/pc_sysfw.c +6
-1@@ -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 = false;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; }
Re: [PATCH v2 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed
Quoted 10 lines · Tom Lendacky
Quoted 9 lines · Dov Murik
Add assertion in
pc_system_ovmf_table_findthat verifies that the flash was indeed previously parsed (looking for the OVMF table) bypc_system_parse_ovmf_flash.Now
pc_system_ovmf_table_finddistinguishes between "no one calledpc_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 5 lines
Quoted 2 lines
Suggested-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Dov Murik <[email protected]>Does the qemu coding style prefer not initializing the bool to false since it will default to that?
Indeed, you are right, and checkpatch will block this patch:
ERROR: do not initialise statics to 0 or NULL
#33: FILE: hw/i386/pc_sysfw.c:129:
+static bool ovmf_flash_parsed = false;
total: 1 errors, 0 warnings, 28 lines checked
Quoted 45 lines
Otherwise,
Reviewed-by Tom Lendacky <[email protected]>Quoted 40 lines
--- hw/i386/pc_sysfw.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)hw/i386/pc_sysfw.c +6
-1@@ -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 = false;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; }
Re: [PATCH v2 1/2] hw/i386/pc: pc_system_ovmf_table_find: Assert that flash was parsed
Quoted 17 lines · Philippe Mathieu-Daudé
Quoted 10 lines · Tom Lendacky
Quoted 9 lines · Dov Murik
Add assertion in
pc_system_ovmf_table_findthat verifies that the flash was indeed previously parsed (looking for the OVMF table) bypc_system_parse_ovmf_flash.Now
pc_system_ovmf_table_finddistinguishes between "no one calledpc_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 5 lines
Quoted 2 lines
Suggested-by Philippe Mathieu-Daudé <[email protected]>Signed-off-by Dov Murik <[email protected]>Does the qemu coding style prefer not initializing the bool to false since it will default to that?
Quoted 7 lines
Indeed, you are right, and checkpatch will block this patch:
ERROR: do not initialise statics to 0 or NULL
#33: FILE:hw/i386/pc_sysfw.c:129:
+static boolovmf_flash_parsed= false;total: 1 errors, 0 warnings, 28 lines checked
oops, missed that in my flow.
Sent a v3 series with this fix.
Quoted 4 lines
Quoted 4 lines
Otherwise,
Reviewed-by Tom Lendacky <[email protected]>
Thanks, Tom!
-Dov
PATCH v2 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
@@ -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