Skip to contentSkip to conversation

pci/controller/pcie-rcar-host: Hold the reference returned by of_find_matching_node

PATCH In review Liang He 3 participants 5 messages Jun 21, 2022 – Jun 22, 2022

Subsystems (4)
lore
Share & tools
lore

Liang He

author
#0 lore raw

PATCH 1/1 pci/controller/pcie-rcar-host: Hold the reference returned by of_find_matching_node

In rcar_pcie_init(), we need to hold the reference returned by of_find_matching_node() which is used to call of_node_put() for refcount balance.

---
 drivers/pci/controller/pcie-rcar-host.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/pcie-rcar-host.c +4 -1
index 997c4df6a1e7..405ec3d64f30 100644
@@ -1158,7 +1158,10 @@ static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst
 
 static int __init rcar_pcie_init(void)
 {
-	if (of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match)) {
+	struct device_node *np = of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match);
+
+	if (np) {
+		of_node_put(np);
 #ifdef CONFIG_ARM_LPAE
 		hook_fault_code(17, rcar_pcie_aarch32_abort_handler, SIGBUS, 0,
 				"asynchronous external abort");
Signature · 1 line
2.25.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · Liang He

In rcar_pcie_init(), we need to hold the reference returned by of_find_matching_node() which is used to call of_node_put() for refcount balance.

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds

#2 lore raw
In reply to Liang He
Quoted 14 lines · Liang He

In rcar_pcie_init(), we need to hold the reference returned by of_find_matching_node() which is used to call of_node_put() for refcount balance.

---
 drivers/pci/controller/pcie-rcar-host.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/pcie-rcar-host.c +0 -0
index 997c4df6a1e7..405ec3d64f30 100644

drivers/pci/controller/pcie-rcar-host.c static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst · line 1164

Quoted 8 lines
drivers/pci/controller/pcie-rcar-host.c +4 -1
@@ -1158,7 +1158,10 @@ static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst
 
 static int __init rcar_pcie_init(void)
 {
-	if (of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match)) {
+	struct device_node *np = of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match);
+
+	if (np) {
+		of_node_put(np);

I think this is correct, but it would be nicer to update the way this driver uses of_device_get_match_data(), e.g.,

  struct rcar_variant {
    int (*phy_init_fn)(struct rcar_pcie_host *host);
    bool hook_abort;
  };

  struct rcar_pcie_host {
    ...
    const struct rcar_variant *variant;
  };

  static int rcar_pcie_probe(...)
  {
    host->variant = of_device_get_match_data(dev);
    err = host->variant->phy_init_fn(host);
    ...

  #ifdef CONFIG_ARM
    if (host->variant->hook_abort) {
  #ifdef CONFIG_ARM_LPAE
      hook_fault_code(17, ...);
  # else
      hook_fault_code(22, ...);
  #endif
    }
  #endif
  }

Or keep the hook in a separate function called from rcar_pcie_probe() if you think that's cleaner.

I'm not sure hook_fault_code() needs to be called separately as a device_initcall(). The pci-ixp4xx.c driver does it in ixp4xx_pci_probe(), so I assume rcar could do it in probe as well.

Quoted 6 lines
drivers/pci/controller/pcie-rcar-host.c +0 -0
 #ifdef CONFIG_ARM_LPAE
 		hook_fault_code(17, rcar_pcie_aarch32_abort_handler, SIGBUS, 0,
 				"asynchronous external abort");
Signature · 1 line
2.25.1
author
#3 lore raw
Quoted 54 lines · Bjorn Helgaas
Quoted 14 lines · Liang He

In rcar_pcie_init(), we need to hold the reference returned by of_find_matching_node() which is used to call of_node_put() for refcount balance.

---
 drivers/pci/controller/pcie-rcar-host.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/pcie-rcar-host.c +0 -0
index 997c4df6a1e7..405ec3d64f30 100644

drivers/pci/controller/pcie-rcar-host.c static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst · line 1164

Quoted 8 lines
drivers/pci/controller/pcie-rcar-host.c +4 -1
@@ -1158,7 +1158,10 @@ static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst
 
 static int __init rcar_pcie_init(void)
 {
-	if (of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match)) {
+	struct device_node *np = of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match);
+
+	if (np) {
+		of_node_put(np);

I think this is correct, but it would be nicer to update the way this driver uses of_device_get_match_data(), e.g.,

 struct rcar_variant {
   int (*phy_init_fn)(struct rcar_pcie_host *host);
   bool hook_abort;

};

 struct rcar_pcie_host {
   ...
   const struct rcar_variant *variant;

};

static int rcar_pcie_probe(...)

 {
   host->variant = of_device_get_match_data(dev);
   err = host->variant->phy_init_fn(host);
   ...
 #ifdef CONFIG_ARM
   if (host->variant->hook_abort) {
 #ifdef CONFIG_ARM_LPAE
     hook_fault_code(17, ...);
 # else
     hook_fault_code(22, ...);
 #endif
   }
 #endif
 }
Quoted 13 lines

Or keep the hook in a separate function called from rcar_pcie_probe() if you think that's cleaner.

I'm not sure hook_fault_code() needs to be called separately as a device_initcall(). The pci-ixp4xx.c driver does it in ixp4xx_pci_probe(), so I assume rcar could do it in probe as well.

Quoted 6 lines
drivers/pci/controller/pcie-rcar-host.c +0 -0
 #ifdef CONFIG_ARM_LPAE
 		hook_fault_code(17, rcar_pcie_aarch32_abort_handler, SIGBUS, 0,
 				"asynchronous external abort");
Signature · 1 line
2.25.1

Thanks very much for your effort to review my patch.

Now I am very sorry that I only know how to correctly use of_find_xxx APIs and when there will be a leak bug.

In another word, I have no idea the details of the drivers and I cannot do anyother thing than just fix the leak bug caused by missing of_node_put().

Sorry again.

Liang

#4 lore raw
In reply to Bjorn Helgaas

Hi Bjorn,

Quoted 49 lines · Bjorn Helgaas
Quoted 9 lines · Liang He

In rcar_pcie_init(), we need to hold the reference returned by of_find_matching_node() which is used to call of_node_put() for refcount balance.

drivers/pci/controller/pcie-rcar-host.c static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst · line 1164

Quoted 8 lines
drivers/pci/controller/pcie-rcar-host.c +4 -1
@@ -1158,7 +1158,10 @@ static const struct of_device_id rcar_pcie_abort_handler_of_match[] __initconst
 
 static int __init rcar_pcie_init(void)
 {
-     if (of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match)) {
+     struct device_node *np = of_find_matching_node(NULL, rcar_pcie_abort_handler_of_match);
+
+     if (np) {
+             of_node_put(np);

I think this is correct, but it would be nicer to update the way this driver uses of_device_get_match_data(), e.g.,

  struct rcar_variant {
    int (*phy_init_fn)(struct rcar_pcie_host *host);
    bool hook_abort;
  };

  struct rcar_pcie_host {
    ...
    const struct rcar_variant *variant;
  };

  static int rcar_pcie_probe(...)
  {
    host->variant = of_device_get_match_data(dev);
    err = host->variant->phy_init_fn(host);
    ...

  #ifdef CONFIG_ARM
    if (host->variant->hook_abort) {
  #ifdef CONFIG_ARM_LPAE
      hook_fault_code(17, ...);
  # else
      hook_fault_code(22, ...);
  #endif
    }
  #endif
  }
Quoted 5 lines

Or keep the hook in a separate function called from rcar_pcie_probe() if you think that's cleaner.

I'm not sure hook_fault_code() needs to be called separately as a device_initcall().

Yes it doesn, as hook_fault_code() is __init.

Quoted 2 lines

The pci-ixp4xx.c driver does it in
ixp4xx_pci_probe(), so I assume rcar could do it in probe as well.

The pci-ixp4xx.c driver uses builtin_platform_driver_probe(), and ixp4xx_pci_probe() is marked __init.

Gr{oetje,eeting}s,

Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that.
-- Linus Torvalds