Skip to contentSkip to conversation

of: Convert to using %pOFn for node name printf

PATCH In review Rob Herring 4 participants 10 messages Aug 28, 2018 – Sep 10, 2018

Subsystems (5)
lore
Share & tools
lore

Rob Herring

author maintainer
#0 lore raw

cover of: Convert to using %pOFn for node name printf

This is the DT portion of converting node name printf's to use the %pOFn format specifier rather than device_node.name. Patches for other subsystems are independent and have been sent separately.

Rob

Rob Herring (4):
of/unittest: remove use of node name pointer in overlay high level
test
of/unittest: add printf tests for node name
of: Convert to using %pOFn instead of device_node.name
vsprintf: print OF node name using full_name

 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 26 ++++++++++++++++----------
 lib/vsprintf.c        |  9 +++++++--
 7 files changed, 39 insertions(+), 28 deletions(-)
Signature · 1 line
2.17.1
author maintainer
#1 lore raw

PATCH 1/4 of/unittest: remove use of node name pointer in overlay high level test

In preparation for removing the node name pointer, it needs to be removed from of_unittest_overlay_high_level. However, it's not really correct to use the node name without the unit-address and we should use the full node name. This most easily done by iterating over the child nodes with for_each_child_of_node() which is what of_get_child_by_name() does internally. While at it, we might as well convert the outer loop to use for_each_child_of_node() too instead of open coding it.

---
 drivers/of/unittest.c | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
drivers/of/unittest.c +6 -4
index 722537e14848..69a522e48970 100644
@@ -2347,10 +2347,12 @@ static __init void of_unittest_overlay_high_level(void)
 		}
 	}
 
-	for (np = overlay_base_root->child; np; np = np->sibling) {
-		if (of_get_child_by_name(of_root, np->name)) {
-			unittest(0, "illegal node name in overlay_base %s",
-				np->name);
+	for_each_child_of_node(overlay_base_root, np) {
+		struct device_node *base_child;
+		for_each_child_of_node(of_root, base_child) {
+			if (!strcmp(np->full_name, base_child->full_name))
+				unittest(0, "illegal node name in overlay_base %pOFn",
+					np);
 			return;
 		}
 	}
Signature · 1 line
2.17.1
author maintainer
#2 lore raw

PATCH 2/4 of/unittest: add printf tests for node name

In reply to Rob Herring

Add some printf test for printing the node name (without the unit-address).

---
 drivers/of/unittest.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/of/unittest.c +4 -0
index 69a522e48970..9def7be9c111 100644
@@ -299,6 +299,10 @@ static void __init of_unittest_printf(void)
 
 	of_unittest_printf_one(np, "%pOF",  full_name);
 	of_unittest_printf_one(np, "%pOFf", full_name);
+	of_unittest_printf_one(np, "%pOFn", "dev");
+	of_unittest_printf_one(np, "%2pOFn", "dev");
+	of_unittest_printf_one(np, "%5pOFn", "  dev");
+	of_unittest_printf_one(np, "%pOFnc", "dev:test-sub-device");
 	of_unittest_printf_one(np, "%pOFp", phandle_str);
 	of_unittest_printf_one(np, "%pOFP", "dev@100");
 	of_unittest_printf_one(np, "ABC %pOFP ABC", "ABC dev@100 ABC");
Signature · 1 line
2.17.1
author maintainer
#3 lore raw

PATCH 3/4 of: Convert to using %pOFn instead of device_node.name

In reply to Rob Herring

In preparation to remove the node name pointer from struct device_node, convert printf users to use the %pOFn format specifier.

---
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 12 ++++++------
 6 files changed, 22 insertions(+), 22 deletions(-)
drivers/of/device.c +2 -2
index 5957cd4fa262..daa075d87317 100644
@@ -219,7 +219,7 @@ static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len
 		return -ENODEV;
 
 	/* Name & Type */
-	csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
+	csize = snprintf(str, len, "of:N%pOFnT%s", dev->of_node,
 			 dev->of_node->type);
 	tsize = csize;
 	len -= csize;
@@ -298,7 +298,7 @@ void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
 	if ((!dev) || (!dev->of_node))
 		return;
 
-	add_uevent_var(env, "OF_NAME=%s", dev->of_node->name);
+	add_uevent_var(env, "OF_NAME=%pOFn", dev->of_node);
 	add_uevent_var(env, "OF_FULLNAME=%pOF", dev->of_node);
 	if (dev->of_node->type && strcmp("<NULL>", dev->of_node->type) != 0)
 		add_uevent_var(env, "OF_TYPE=%s", dev->of_node->type);
drivers/of/of_mdio.c +6 -6
index e92391d6d1bd..5ad1342f5682 100644
@@ -97,8 +97,8 @@ static int of_mdiobus_register_phy(struct mii_bus *mdio,
 		return rc;
 	}
 
-	dev_dbg(&mdio->dev, "registered phy %s at address %i\n",
-		child->name, addr);
+	dev_dbg(&mdio->dev, "registered phy %pOFn at address %i\n",
+		child, addr);
 	return 0;
 }
 
@@ -127,8 +127,8 @@ static int of_mdiobus_register_device(struct mii_bus *mdio,
 		return rc;
 	}
 
-	dev_dbg(&mdio->dev, "registered mdio device %s at address %i\n",
-		child->name, addr);
+	dev_dbg(&mdio->dev, "registered mdio device %pOFn at address %i\n",
+		child, addr);
 	return 0;
 }
 
@@ -263,8 +263,8 @@ int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
 				continue;
 
 			/* be noisy to encourage people to set reg property */
-			dev_info(&mdio->dev, "scan phy %s at address %i\n",
-				 child->name, addr);
+			dev_info(&mdio->dev, "scan phy %pOFn at address %i\n",
+				 child, addr);
 
 			if (of_mdiobus_child_is_phy(child)) {
 				rc = of_mdiobus_register_phy(mdio, child, addr);
drivers/of/of_numa.c +2 -2
index 27d9b4bba535..67d3386195bf 100644
@@ -163,8 +163,8 @@ int of_node_to_nid(struct device_node *device)
 		np = of_get_next_parent(np);
 	}
 	if (np && r)
-		pr_warn("Invalid \"numa-node-id\" property in node %s\n",
-			np->name);
+		pr_warn("Invalid \"numa-node-id\" property in node %pOFn\n",
+			np);
 	of_node_put(np);
 
 	/*
drivers/of/overlay.c +2 -2
index eda57ef12fd0..42b1f73ac5f6 100644
@@ -425,8 +425,8 @@ static int build_changeset_next_level(struct overlay_changeset *ovcs,
 	for_each_child_of_node(overlay_node, child) {
 		ret = add_changeset_node(ovcs, target_node, child);
 		if (ret) {
-			pr_debug("Failed to apply node @%pOF/%s, err=%d\n",
-				 target_node, child->name, ret);
+			pr_debug("Failed to apply node @%pOF/%pOFn, err=%d\n",
+				 target_node, child, ret);
 			of_node_put(child);
 			return ret;
 		}
drivers/of/platform.c +4 -4
index 7ba90c290a42..868905f2d638 100644
@@ -91,8 +91,8 @@ static void of_device_make_bus_id(struct device *dev)
 		 */
 		reg = of_get_property(node, "reg", NULL);
 		if (reg && (addr = of_translate_address(node, reg)) != OF_BAD_ADDR) {
-			dev_set_name(dev, dev_name(dev) ? "%llx.%s:%s" : "%llx.%s",
-				     (unsigned long long)addr, node->name,
+			dev_set_name(dev, dev_name(dev) ? "%llx.%pOFn:%s" : "%llx.%pOFn",
+				     (unsigned long long)addr, node,
 				     dev_name(dev));
 			return;
 		}
@@ -142,8 +142,8 @@ struct platform_device *of_device_alloc(struct device_node *np,
 			WARN_ON(rc);
 		}
 		if (of_irq_to_resource_table(np, res, num_irq) != num_irq)
-			pr_debug("not all legacy IRQ resources mapped for %s\n",
-				 np->name);
+			pr_debug("not all legacy IRQ resources mapped for %pOFn\n",
+				 np);
 	}
 
 	dev->dev.of_node = of_node_get(np);
drivers/of/unittest.c +6 -6
index 9def7be9c111..d9d012198ca5 100644
@@ -212,8 +212,8 @@ static int __init of_unittest_check_node_linkage(struct device_node *np)
 
 	for_each_child_of_node(np, child) {
 		if (child->parent != np) {
-			pr_err("Child node %s links to wrong parent %s\n",
-				 child->name, np->name);
+			pr_err("Child node %pOFn links to wrong parent %pOFn\n",
+				 child, np);
 			rc = -EINVAL;
 			goto put_child;
 		}
@@ -1040,16 +1040,16 @@ static void __init of_unittest_platform_populate(void)
 	for_each_child_of_node(np, child) {
 		for_each_child_of_node(child, grandchild)
 			unittest(of_find_device_by_node(grandchild),
-				 "Could not create device for node '%s'\n",
-				 grandchild->name);
+				 "Could not create device for node '%pOFn'\n",
+				 grandchild);
 	}
 
 	of_platform_depopulate(&test_bus->dev);
 	for_each_child_of_node(np, child) {
 		for_each_child_of_node(child, grandchild)
 			unittest(!of_find_device_by_node(grandchild),
-				 "device didn't get destroyed '%s'\n",
-				 grandchild->name);
+				 "device didn't get destroyed '%pOFn'\n",
+				 grandchild);
 	}
 
 	platform_device_unregister(test_bus);
Signature · 1 line
2.17.1
#4 lore raw

Re: [PATCH 3/4] of: Convert to using %pOFn instead of device_node.name

Quoted 23 lines · Rob Herring

In preparation to remove the node name pointer from struct device_node, convert printf users to use the %pOFn format specifier.

---
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 12 ++++++------
 6 files changed, 22 insertions(+), 22 deletions(-)
drivers/of/device.c +0 -0
index 5957cd4fa262..daa075d87317 100644

drivers/of/device.c static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len · line 225

Quoted 8 lines
drivers/of/device.c +1 -1
@@ -219,7 +219,7 @@ static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len
 		return -ENODEV;
 
 	/* Name & Type */
-	csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
+	csize = snprintf(str, len, "of:N%pOFnT%s", dev->of_node,
 			 dev->of_node->type);
 	tsize = csize;
 	len -= csize;

This seems to cause the modalias to be improperly constructed. As a consequence, automatic module loading at boot time is now broken. I think the reason why this fails is because vsnprintf() will skip all alpha-numeric characters after a call to pointer(). Presumably this is meant to be a generic way of skipping whatever specifiers we throw at it.

Unfortunately for the case of OF modaliases, this means that the 'T' character gets eaten, so we end up with something like this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:Ndc<NULL>Cnvidia,tegra124-dc
	[...]

instead of this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:NdcT<NULL>Cnvidia,tegra124-dc
	[...]

Everything is back to normal if I revert this patch. However, since that's obviously not what we want, I think perhaps what we need is a way for pointer() (and its implementations) to report back how many characters in the format string it consumed so that we can support these kinds of back-to-back strings.

If nobody else has the time I can look into coding up a fix, but in the meantime it might be best to back this one out until we can handle the OF modalias format string.

Thierry

author maintainer
#5 lore raw

Re: [PATCH 3/4] of: Convert to using %pOFn instead of device_node.name

Quoted 49 lines · Thierry Reding
Quoted 23 lines · Rob Herring

In preparation to remove the node name pointer from struct device_node, convert printf users to use the %pOFn format specifier.

---
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 12 ++++++------
 6 files changed, 22 insertions(+), 22 deletions(-)
drivers/of/device.c +0 -0
index 5957cd4fa262..daa075d87317 100644

drivers/of/device.c static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len · line 225

Quoted 8 lines
drivers/of/device.c +1 -1
@@ -219,7 +219,7 @@ static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len
              return -ENODEV;
 
      /* Name & Type */
-     csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
+     csize = snprintf(str, len, "of:N%pOFnT%s", dev->of_node,
                       dev->of_node->type);
      tsize = csize;
      len -= csize;

This seems to cause the modalias to be improperly constructed. As a consequence, automatic module loading at boot time is now broken. I think the reason why this fails is because vsnprintf() will skip all alpha-numeric characters after a call to pointer(). Presumably this is meant to be a generic way of skipping whatever specifiers we throw at it.

Unfortunately for the case of OF modaliases, this means that the 'T' character gets eaten, so we end up with something like this:

        # udevadm info /sys/bus/platform/devices/54200000.dc
        [...]
        E: MODALIAS=of:Ndc<NULL>Cnvidia,tegra124-dc
        [...]
Quoted 6 lines

instead of this:

        # udevadm info /sys/bus/platform/devices/54200000.dc
        [...]
        E: MODALIAS=of:NdcT<NULL>Cnvidia,tegra124-dc
        [...]

Oops. Thanks for finding this.

Quoted 5 lines

Everything is back to normal if I revert this patch. However, since that's obviously not what we want, I think perhaps what we need is a way for pointer() (and its implementations) to report back how many characters in the format string it consumed so that we can support these kinds of back-to-back strings.

I don't think we can change it because if I have something like %pOFMoreWords and then later on want to add 'M' as a new modifier we'd break any existing cases with 'M'. Of course, I could search the tree for that case and find unused characters, but that seems fragile (though silently throwing away the characters does too).

Quoted 3 lines

If nobody else has the time I can look into coding up a fix, but in the meantime it might be best to back this one out until we can handle the OF modalias format string.

There's an easy fix though. Just replace the 'T' with a '%c'.

I found one other case in the clock code and one in soundbus (which I haven't posted yet).

Rob

#6 lore raw

Re: [PATCH 3/4] of: Convert to using %pOFn instead of device_node.name

In reply to Thierry Reding
Quoted 61 lines · Thierry Reding
Quoted 23 lines · Rob Herring

In preparation to remove the node name pointer from struct device_node, convert printf users to use the %pOFn format specifier.

---
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 12 ++++++------
 6 files changed, 22 insertions(+), 22 deletions(-)
drivers/of/device.c +0 -0
index 5957cd4fa262..daa075d87317 100644

drivers/of/device.c static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len · line 225

Quoted 8 lines
drivers/of/device.c +1 -1
@@ -219,7 +219,7 @@ static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len
 		return -ENODEV;
 
 	/* Name & Type */
-	csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
+	csize = snprintf(str, len, "of:N%pOFnT%s", dev->of_node,
 			 dev->of_node->type);
 	tsize = csize;
 	len -= csize;

This seems to cause the modalias to be improperly constructed. As a consequence, automatic module loading at boot time is now broken. I think the reason why this fails is because vsnprintf() will skip all alpha-numeric characters after a call to pointer(). Presumably this is meant to be a generic way of skipping whatever specifiers we throw at it.

Unfortunately for the case of OF modaliases, this means that the 'T' character gets eaten, so we end up with something like this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:Ndc<NULL>Cnvidia,tegra124-dc
	[...]

instead of this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:NdcT<NULL>Cnvidia,tegra124-dc
	[...]

Everything is back to normal if I revert this patch. However, since that's obviously not what we want, I think perhaps what we need is a way for pointer() (and its implementations) to report back how many characters in the format string it consumed so that we can support these kinds of back-to-back strings.

Quoted 3 lines

If nobody else has the time I can look into coding up a fix, but in the meantime it might be best to back this one out until we can handle the OF modalias format string.

Or just use 2 consecutive snprintf calls

	csize = snprintf(str, len, "of:N%pOFn", dev->of_node);
	csize += snprintf(str + csize, len - csize, "T%s",
			  dev->of_node->type);
#7 lore raw

Re: [PATCH 3/4] of: Convert to using %pOFn instead of device_node.name

Quoted 66 lines · Joe Perches
Quoted 61 lines · Thierry Reding
Quoted 23 lines · Rob Herring

In preparation to remove the node name pointer from struct device_node, convert printf users to use the %pOFn format specifier.

---
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 12 ++++++------
 6 files changed, 22 insertions(+), 22 deletions(-)
drivers/of/device.c +0 -0
index 5957cd4fa262..daa075d87317 100644

drivers/of/device.c static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len · line 225

Quoted 8 lines
drivers/of/device.c +1 -1
@@ -219,7 +219,7 @@ static ssize_t of_device_get_modalias(struct device *dev, char *str, ssize_t len
 		return -ENODEV;
 
 	/* Name & Type */
-	csize = snprintf(str, len, "of:N%sT%s", dev->of_node->name,
+	csize = snprintf(str, len, "of:N%pOFnT%s", dev->of_node,
 			 dev->of_node->type);
 	tsize = csize;
 	len -= csize;

This seems to cause the modalias to be improperly constructed. As a consequence, automatic module loading at boot time is now broken. I think the reason why this fails is because vsnprintf() will skip all alpha-numeric characters after a call to pointer(). Presumably this is meant to be a generic way of skipping whatever specifiers we throw at it.

Unfortunately for the case of OF modaliases, this means that the 'T' character gets eaten, so we end up with something like this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:Ndc<NULL>Cnvidia,tegra124-dc
	[...]

instead of this:

	# udevadm info /sys/bus/platform/devices/54200000.dc
	[...]
	E: MODALIAS=of:NdcT<NULL>Cnvidia,tegra124-dc
	[...]

Everything is back to normal if I revert this patch. However, since that's obviously not what we want, I think perhaps what we need is a way for pointer() (and its implementations) to report back how many characters in the format string it consumed so that we can support these kinds of back-to-back strings.

Quoted 3 lines

If nobody else has the time I can look into coding up a fix, but in the meantime it might be best to back this one out until we can handle the OF modalias format string.

Quoted 5 lines

Or just use 2 consecutive snprintf calls

	csize = snprintf(str, len, "of:N%pOFn", dev->of_node);
	csize += snprintf(str + csize, len - csize, "T%s",
			  dev->of_node->type);

Yeah, that's what I ended up doing. Rob came up with another alternative which is to output the 'T' via %c, which also works around the issue.

Thierry

author maintainer
#8 lore raw

PATCH 4/4 vsprintf: print OF node name using full_name

In reply to Rob Herring

In preparation to remove the node name pointer from struct device_node, convert the node name print to get the node name from the full name.

---
 lib/vsprintf.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
lib/vsprintf.c +6 -1
index d5b3a3f95c01..891c282092a0 100644
@@ -1596,6 +1596,7 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,
 		fmt = "f";
 
 	for (pass = false; strspn(fmt,"fnpPFcC"); fmt++, pass = true) {
+		int precision;
 		if (pass) {
 			if (buf < end)
 				*buf = ':';
@@ -1607,7 +1608,11 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,
 			buf = device_node_gen_full_name(dn, buf, end);
 			break;
 		case 'n':	/* name */
-			buf = string(buf, end, dn->name, str_spec);
+			p = kbasename(of_node_full_name(dn));
+			precision = str_spec.precision;
+			str_spec.precision = strchrnul(p, '@') - p;
+			buf = string(buf, end, p, str_spec);
+			str_spec.precision = precision;
 			break;
 		case 'p':	/* phandle */
 			buf = number(buf, end, (unsigned int)dn->phandle, num_spec);
Signature · 1 line
2.17.1
Reviewed-by on the v1 series
#9 lore raw
In reply to Rob Herring
Quoted 13 lines · Rob Herring

This is the DT portion of converting node name printf's to use the %pOFn format specifier rather than device_node.name. Patches for other subsystems are independent and have been sent separately.

Rob

Rob Herring (4):
of/unittest: remove use of node name pointer in overlay high level
test
of/unittest: add printf tests for node name
of: Convert to using %pOFn instead of device_node.name
vsprintf: print OF node name using full_name

Quoted 9 lines
 drivers/of/device.c   |  4 ++--
 drivers/of/of_mdio.c  | 12 ++++++------
 drivers/of/of_numa.c  |  4 ++--
 drivers/of/overlay.c  |  4 ++--
 drivers/of/platform.c |  8 ++++----
 drivers/of/unittest.c | 26 ++++++++++++++++----------
 lib/vsprintf.c        |  9 +++++++--
 7 files changed, 39 insertions(+), 28 deletions(-)