Skip to contentSkip to conversation

pci/pcie: don't assume cap id 0 is reserved

PATCH In review Michael S. Tsirkin 3 participants 6 messages Feb 15, 2017 – Feb 16, 2017

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 pci/pcie: don't assume cap id 0 is reserved

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

---
 hw/pci/pcie.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
hw/pci/pcie.c +7 -4
index cbd4bb4..f4dd177 100644
@@ -610,7 +610,8 @@ bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev)
  * uint16_t ext_cap_size
  */
 
-static uint16_t pcie_find_capability_list(PCIDevice *dev, uint16_t cap_id,
+/* Passing a cap_id value > 0xffff will return 0 and put end of list in prev */
+static uint16_t pcie_find_capability_list(PCIDevice *dev, uint32_t cap_id,
                                           uint16_t *prev_p)
 {
     uint16_t prev = 0;
@@ -679,9 +680,11 @@ void pcie_add_capability(PCIDevice *dev,
     } else {
         uint16_t prev;
 
-        /* 0 is reserved cap id. use internally to find the last capability
-           in the linked list */
-        next = pcie_find_capability_list(dev, 0, &prev);
+        /*
+         * 0xffffffff is not a valid cap id (it's a 16 bit field). use
+         * internally to find the last capability in the linked list.
+         */
+        next = pcie_find_capability_list(dev, 0xffffffff, &prev);
 
         assert(prev >= PCI_CONFIG_SPACE_SIZE);
         assert(next == 0);
Signature · 1 line
MST
Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines · On Wed, 15 Feb 2017 22:49:47 +0200 "Michael S. Tsirkin" <[email protected]> wrote:

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

---

Quoted 32 lines
 hw/pci/pcie.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
hw/pci/pcie.c +7 -4
index cbd4bb4..f4dd177 100644
@@ -610,7 +610,8 @@ bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev)
  * uint16_t ext_cap_size
  */
 
-static uint16_t pcie_find_capability_list(PCIDevice *dev, uint16_t cap_id,
+/* Passing a cap_id value > 0xffff will return 0 and put end of list in prev */
+static uint16_t pcie_find_capability_list(PCIDevice *dev, uint32_t cap_id,
                                           uint16_t *prev_p)
 {
     uint16_t prev = 0;
@@ -679,9 +680,11 @@ void pcie_add_capability(PCIDevice *dev,
     } else {
         uint16_t prev;
 
-        /* 0 is reserved cap id. use internally to find the last capability
-           in the linked list */
-        next = pcie_find_capability_list(dev, 0, &prev);
+        /*
+         * 0xffffffff is not a valid cap id (it's a 16 bit field). use
+         * internally to find the last capability in the linked list.
+         */
+        next = pcie_find_capability_list(dev, 0xffffffff, &prev);
 
         assert(prev >= PCI_CONFIG_SPACE_SIZE);
         assert(next == 0);
Reviewed-by on v1 1/1
#2 lore raw
In reply to Michael S. Tsirkin
Quoted 10 lines · Michael S. Tsirkin

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

Two nits:

(1) maybe we can s/0xffffffff/0xffff/ in the whole patch since ecap_id is 16 bits

(2) maybe we can add one more sentence in the comment below showing

    where the 0xffff thing comes from (it comes from PCIe spec 7.9.2)

Thanks,

Quoted 35 lines
---
 hw/pci/pcie.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
hw/pci/pcie.c +7 -4
index cbd4bb4..f4dd177 100644
@@ -610,7 +610,8 @@ bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev)
  * uint16_t ext_cap_size
  */
 
-static uint16_t pcie_find_capability_list(PCIDevice *dev, uint16_t cap_id,
+/* Passing a cap_id value > 0xffff will return 0 and put end of list in prev */
+static uint16_t pcie_find_capability_list(PCIDevice *dev, uint32_t cap_id,
                                           uint16_t *prev_p)
 {
     uint16_t prev = 0;
@@ -679,9 +680,11 @@ void pcie_add_capability(PCIDevice *dev,
     } else {
         uint16_t prev;
 
-        /* 0 is reserved cap id. use internally to find the last capability
-           in the linked list */
-        next = pcie_find_capability_list(dev, 0, &prev);
+        /*
+         * 0xffffffff is not a valid cap id (it's a 16 bit field). use
+         * internally to find the last capability in the linked list.
+         */
+        next = pcie_find_capability_list(dev, 0xffffffff, &prev);
 
         assert(prev >= PCI_CONFIG_SPACE_SIZE);
         assert(next == 0);
Signature · 1 line
MST

-- peterx

#3 lore raw
Quoted 10 lines · On Thu, 16 Feb 2017 10:35:28 +0800 Peter Xu <[email protected]> wrote:
Quoted 9 lines · Michael S. Tsirkin

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

Quoted 8 lines
Quoted 1 line

Two nits:

(1) maybe we can s/0xffffffff/0xffff/ in the whole patch since ecap_id is 16 bits

The former is used because it's beyond the address space of a valid capability. Using 0xffff just makes the situation different, not better.

Quoted 3 lines

(2) maybe we can add one more sentence in the comment below showing

    where the 0xffff thing comes from (it comes from PCIe spec 7.9.2)

The capability in hardware is 16bits, thus a value that exceeds 16 bits can never match a valid ID. It has nothing to do with 7.9.2. Thanks,

Alex

Quoted 37 lines
Quoted 35 lines
---
 hw/pci/pcie.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
hw/pci/pcie.c +7 -4
index cbd4bb4..f4dd177 100644
@@ -610,7 +610,8 @@ bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev)
  * uint16_t ext_cap_size
  */
 
-static uint16_t pcie_find_capability_list(PCIDevice *dev, uint16_t cap_id,
+/* Passing a cap_id value > 0xffff will return 0 and put end of list in prev */
+static uint16_t pcie_find_capability_list(PCIDevice *dev, uint32_t cap_id,
                                           uint16_t *prev_p)
 {
     uint16_t prev = 0;
@@ -679,9 +680,11 @@ void pcie_add_capability(PCIDevice *dev,
     } else {
         uint16_t prev;
 
-        /* 0 is reserved cap id. use internally to find the last capability
-           in the linked list */
-        next = pcie_find_capability_list(dev, 0, &prev);
+        /*
+         * 0xffffffff is not a valid cap id (it's a 16 bit field). use
+         * internally to find the last capability in the linked list.
+         */
+        next = pcie_find_capability_list(dev, 0xffffffff, &prev);
 
         assert(prev >= PCI_CONFIG_SPACE_SIZE);
         assert(next == 0);
Signature · 1 line
MST  

-- peterx

#4 lore raw
Quoted 17 lines · Alex Williamson
Quoted 14 lines · On Thu, 16 Feb 2017 10:35:28 +0800 Peter Xu <[email protected]> wrote:
Quoted 10 lines · Michael S. Tsirkin

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

Quoted 8 lines
Quoted 4 lines

Two nits:

(1) maybe we can s/0xffffffff/0xffff/ in the whole patch since ecap_id is 16 bits

The former is used because it's beyond the address space of a valid capability. Using 0xffff just makes the situation different, not better.

But isn't pcie_find_capability_list() defining cap_id parameter as uint16_t? In that case, 0xffffffff will be the same as 0xffff since we'll just take the lower 16 bits?

Quoted 48 lines
Quoted 4 lines

(2) maybe we can add one more sentence in the comment below showing

    where the 0xffff thing comes from (it comes from PCIe spec 7.9.2)

The capability in hardware is 16bits, thus a value that exceeds 16 bits can never match a valid ID. It has nothing to do with 7.9.2. Thanks,

Alex

Quoted 37 lines
Quoted 35 lines
---
 hw/pci/pcie.c | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)
hw/pci/pcie.c +7 -4
index cbd4bb4..f4dd177 100644
@@ -610,7 +610,8 @@ bool pcie_cap_is_arifwd_enabled(const PCIDevice *dev)
  * uint16_t ext_cap_size
  */
 
-static uint16_t pcie_find_capability_list(PCIDevice *dev, uint16_t cap_id,
+/* Passing a cap_id value > 0xffff will return 0 and put end of list in prev */
+static uint16_t pcie_find_capability_list(PCIDevice *dev, uint32_t cap_id,
                                           uint16_t *prev_p)
 {
     uint16_t prev = 0;
@@ -679,9 +680,11 @@ void pcie_add_capability(PCIDevice *dev,
     } else {
         uint16_t prev;
 
-        /* 0 is reserved cap id. use internally to find the last capability
-           in the linked list */
-        next = pcie_find_capability_list(dev, 0, &prev);
+        /*
+         * 0xffffffff is not a valid cap id (it's a 16 bit field). use
+         * internally to find the last capability in the linked list.
+         */
+        next = pcie_find_capability_list(dev, 0xffffffff, &prev);
 
         assert(prev >= PCI_CONFIG_SPACE_SIZE);
         assert(next == 0);
Signature · 1 line
MST  

-- peterx

-- peterx

#5 lore raw
Quoted 23 lines · Peter Xu
Quoted 22 lines · Alex Williamson
Quoted 18 lines · On Thu, 16 Feb 2017 10:35:28 +0800 Peter Xu <[email protected]> wrote:
Quoted 10 lines · Michael S. Tsirkin

VFIO actually wants to create a capability with ID == 0. This is done to make guest drivers skip the given capability. pcie_add_capability then trips up on this capability when looking for end of capability list.

To support this use-case, it's easy enough to switch to e.g. 0xffffffff for these comparisons - we can be sure it will never match a 16-bit capability ID.

Two nits:

(1) maybe we can s/0xffffffff/0xffff/ in the whole patch since ecap_id is 16 bits

Quoted 7 lines
Quoted 3 lines

The former is used because it's beyond the address space of a valid capability. Using 0xffff just makes the situation different, not better.

But isn't pcie_find_capability_list() defining cap_id parameter as uint16_t? In that case, 0xffffffff will be the same as 0xffff since we'll just take the lower 16 bits?

Alex helpped pointing out that this patch has touched the parameter while I didn't notice that. Sorry. :(

Please take my r-b and ignore the two nits. Thanks,

-- peterx