Skip to contentSkip to conversation

hw/i386/pc: Document pc_system_ovmf_table_find

PATCH In review Dov Murik 3 participants 8 messages Jun 22, 2021 – Jun 29, 2021

lore
Share & tools
lore

Dov Murik

author
#0 lore raw

PATCH 1/1 hw/i386/pc: Document pc_system_ovmf_table_find

---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +14 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().
+ *
+ * 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
Reviewed-by on v1 1/1
#1 lore raw
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

  assert(ovmf_table && ovmf_table_len);

Otherwise,

Thanks!

Quoted 7 lines
hw/i386/pc_sysfw.c +3 -0
+ *
+ * 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)
 {
author
#2 lore raw

+cc: Tom Lendacky

Quoted 29 lines · Philippe Mathieu-Daudé
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

Quoted 2 lines
  assert(ovmf_table && ovmf_table_len);

I think this will break things: in target/i386/sev.c we have SEV-ES code that calls pc_system_ovmf_table_find() and can deal with the case when there's no OVMF table. An assert will break it.

Quoted 4 lines

Otherwise,

Thanks!

-Dov

Quoted 10 lines

Thanks!

Quoted 7 lines
hw/i386/pc_sysfw.c +3 -0
+ *
+ * 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)
 {
#3 lore raw
Quoted 32 lines · Dov Murik

+cc: Tom Lendacky

Quoted 29 lines · Philippe Mathieu-Daudé
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

Quoted 6 lines
Quoted 2 lines
  assert(ovmf_table && ovmf_table_len);

I think this will break things: in target/i386/sev.c we have SEV-ES code that calls pc_system_ovmf_table_find() and can deal with the case when there's no OVMF table. An assert will break it.

Right, what would be best is to differentiate between an OVMF table that isn't present in the flash vs the fact that pc_system_parse_ovmf_flash() wasn't called, asserting only on the latter.

Thanks,
Tom

Quoted 23 lines
Quoted 6 lines

Otherwise,

Thanks!

-Dov

Quoted 10 lines

Thanks!

Quoted 7 lines
hw/i386/pc_sysfw.c +3 -0
+ *
+ * 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)
 {
author
#4 lore raw
Quoted 36 lines · Tom Lendacky
Quoted 35 lines · Dov Murik

+cc: Tom Lendacky

Quoted 31 lines · Philippe Mathieu-Daudé
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

  assert(ovmf_table && ovmf_table_len);
Quoted 8 lines
Quoted 3 lines

I think this will break things: in target/i386/sev.c we have SEV-ES code that calls pc_system_ovmf_table_find() and can deal with the case when there's no OVMF table. An assert will break it.

Right, what would be best is to differentiate between an OVMF table that isn't present in the flash vs the fact that pc_system_parse_ovmf_flash() wasn't called, asserting only on the latter.

[+cc James who wrote this code]

Thanks Tom; I agree. To achieve that, we need one of these:

(a) add a 'static bool ovmf_table_parsed' which will be set to true at the beginning of pc_system_parse_ovmf_flash(). Then, at the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_parsed).

(b) (ab)use our existing ovmf_table_len static variable: initialize it to -1 (meaning that we haven't parsed the OVMF flash yet). When looking for the table set it to 0 (meaning that OVMF table doesn't exist or is invalid). When a proper table is found and copied to ovmf_table, then set it to the real length (>= 0). At the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_len != -1). (this -1 can be #define OVMF_FLASH_NOT_PARSED -1).

Phil, Tom, James: which do you prefer? other options? Rust enum? ;-)

Thanks,
Dov

Quoted 26 lines

Thanks,
Tom

Quoted 23 lines
Quoted 6 lines

Otherwise,

Thanks!

-Dov

Quoted 10 lines

Thanks!

Quoted 7 lines
hw/i386/pc_sysfw.c +3 -0
+ *
+ * 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)
 {
#5 lore raw
Quoted 64 lines · Dov Murik
Quoted 36 lines · Tom Lendacky
Quoted 35 lines · Dov Murik

+cc: Tom Lendacky

Quoted 31 lines · Philippe Mathieu-Daudé
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

  assert(ovmf_table && ovmf_table_len);
Quoted 8 lines
Quoted 3 lines

I think this will break things: in target/i386/sev.c we have SEV-ES code that calls pc_system_ovmf_table_find() and can deal with the case when there's no OVMF table. An assert will break it.

Right, what would be best is to differentiate between an OVMF table that isn't present in the flash vs the fact that pc_system_parse_ovmf_flash() wasn't called, asserting only on the latter.

[+cc James who wrote this code]

Thanks Tom; I agree. To achieve that, we need one of these:

(a) add a 'static bool ovmf_table_parsed' which will be set to true at the beginning of pc_system_parse_ovmf_flash(). Then, at the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_parsed).

(b) (ab)use our existing ovmf_table_len static variable: initialize it to -1 (meaning that we haven't parsed the OVMF flash yet). When looking for the table set it to 0 (meaning that OVMF table doesn't exist or is invalid). When a proper table is found and copied to ovmf_table, then set it to the real length (>= 0). At the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_len != -1). (this -1 can be #define OVMF_FLASH_NOT_PARSED -1).

Quoted 1 line

Phil, Tom, James: which do you prefer? other options? Rust enum? ;-)

Since we are discussing code that should not be called, I don't have strong preference as long as we keep the code easy to review :)

With that in mind, (a) seems simpler.

Regards,

Phil.

#6 lore raw
Quoted 18 lines · Philippe Mathieu-Daudé
Quoted 17 lines · Dov Murik
Quoted 1 line · Tom Lendacky

On 6/22/21 7:58 AM, Dov Murik wrote:

(a) add a 'static bool ovmf_table_parsed' which will be set to true at the beginning of pc_system_parse_ovmf_flash(). Then, at the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_parsed).

(b) (ab)use our existing ovmf_table_len static variable: initialize it to -1 (meaning that we haven't parsed the OVMF flash yet). When looking for the table set it to 0 (meaning that OVMF table doesn't exist or is invalid). When a proper table is found and copied to ovmf_table, then set it to the real length (>= 0). At the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_len != -1). (this -1 can be #define OVMF_FLASH_NOT_PARSED -1).

Quoted 6 lines
Quoted 1 line

Phil, Tom, James: which do you prefer? other options? Rust enum? ;-)

Since we are discussing code that should not be called, I don't have strong preference as long as we keep the code easy to review :)

With that in mind, (a) seems simpler.

Yes, to me (a) seems simpler, too.

Thanks,
Tom

Quoted 5 lines

Regards,

Phil.

author
#7 lore raw
In reply to Dov Murik
Quoted 57 lines · Dov Murik
Quoted 36 lines · Tom Lendacky
Quoted 35 lines · Dov Murik

+cc: Tom Lendacky

Quoted 31 lines · Philippe Mathieu-Daudé
Quoted 15 lines · Dov Murik
---
 hw/i386/pc_sysfw.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
hw/i386/pc_sysfw.c +1 -0
index 6ce37a2b05..e8d20cb83f 100644
@@ -176,6 +176,20 @@ static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size)
     ovmf_table += tot_len;
 }
 
+/**

hw/i386/pc_sysfw.c static void pc_system_parse_ovmf_flash(uint8_t *flash_ptr, size_t flash_size) · line 189

Quoted 10 lines
hw/i386/pc_sysfw.c +10 -0
+ * 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.
+ *
+ * Note that this function must be called after the OVMF table was found and
+ * copied by pc_system_parse_ovmf_flash().

What about replacing this comment by:

  assert(ovmf_table && ovmf_table_len);
Quoted 8 lines
Quoted 3 lines

I think this will break things: in target/i386/sev.c we have SEV-ES code that calls pc_system_ovmf_table_find() and can deal with the case when there's no OVMF table. An assert will break it.

Right, what would be best is to differentiate between an OVMF table that isn't present in the flash vs the fact that pc_system_parse_ovmf_flash() wasn't called, asserting only on the latter.

[+cc James who wrote this code]

Thanks Tom; I agree. To achieve that, we need one of these:

(a) add a 'static bool ovmf_table_parsed' which will be set to true at the beginning of pc_system_parse_ovmf_flash(). Then, at the beginning of pc_system_ovmf_table_find add: assert(ovmf_table_parsed).

Quoted 5 lines

(b) (ab)use our existing ovmf_table_len static variable: initialize it to -1 (meaning that we haven't parsed the OVMF flash yet). When looking for the table set it to 0 (meaning that OVMF table doesn't exist or is invalid). When a proper table is found and copied to ovmf_table, then set it to the real length (>= 0).

typo: That should be (> 0).

Quoted 38 lines

At the beginning of
pc_system_ovmf_table_find add: assert(ovmf_table_len != -1). (this -1 can be #define OVMF_FLASH_NOT_PARSED -1).

Phil, Tom, James: which do you prefer? other options? Rust enum? ;-)

Thanks,
Dov

Quoted 26 lines

Thanks,
Tom

Quoted 23 lines
Quoted 6 lines

Otherwise,

Thanks!

-Dov

Quoted 10 lines

Thanks!

Quoted 7 lines
hw/i386/pc_sysfw.c +3 -0
+ *
+ * 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)
 {