Skip to contentSkip to conversation

irqdomain: A couple of fixes

PATCH Applied Andy Shevchenko 4 participants 9 messages Aug 12, 2024 – Aug 13, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

cover irqdomain: A couple of fixes

Recently added code has some issues of different severities. Here are the fixes.

Assuming Thomas has an immutable branch/tag, I think it's worth to pull them there, so if regmap needs that code it will be fixed.

Andy Shevchenko (2):
irqdomain: Unify checks for bus_token
irqdomain: Remove stray '-' in the IRQ domain name

 kernel/irq/irqdomain.c | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#1 lore raw

PATCH 1/2 irqdomain: Unify checks for bus_token

The code uses if (bus_token) and if (bus_token == DOMAIN_BUS_ANY). Since bus_token is enum, the later is more robust against changes. Unify all checks to follow the latter variant.

Fixes 0b21add71bd9 ("irqdomain: Handle domain bus token in irq_domain_create()")
Fixes 1bf2c9282927 ("irqdomain: Cleanup domain name allocation")
---
 kernel/irq/irqdomain.c | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)
kernel/irq/irqdomain.c +14 -8
index 01001eb615ec..18d253e10e87 100644
@@ -130,8 +130,10 @@ EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
 
 static int alloc_name(struct irq_domain *domain, char *base, enum irq_domain_bus_token bus_token)
 {
-	domain->name = bus_token ? kasprintf(GFP_KERNEL, "%s-%d", base, bus_token) :
-				   kasprintf(GFP_KERNEL, "%s", base);
+	if (bus_token == DOMAIN_BUS_ANY)
+		domain->name = kasprintf(GFP_KERNEL, "%s", base);
+	else
+		domain->name = kasprintf(GFP_KERNEL, "%s-%d", base, bus_token);
 	if (!domain->name)
 		return -ENOMEM;
 
@@ -146,8 +148,10 @@ static int alloc_fwnode_name(struct irq_domain *domain, const struct fwnode_hand
 	const char *suf = suffix ? : "";
 	char *name;
 
-	name = bus_token ? kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token) :
-			   kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+	if (bus_token == DOMAIN_BUS_ANY)
+		name = kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+	else
+		name = kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token);
 	if (!name)
 		return -ENOMEM;
 
@@ -166,11 +170,13 @@ static int alloc_unknown_name(struct irq_domain *domain, enum irq_domain_bus_tok
 	static atomic_t unknown_domains;
 	int id = atomic_inc_return(&unknown_domains);
 
-	domain->name = bus_token ? kasprintf(GFP_KERNEL, "unknown-%d-%d", id, bus_token) :
-				   kasprintf(GFP_KERNEL, "unknown-%d", id);
-
+	if (bus_token == DOMAIN_BUS_ANY)
+		domain->name = kasprintf(GFP_KERNEL, "unknown-%d", id);
+	else
+		domain->name = kasprintf(GFP_KERNEL, "unknown-%d-%d", id, bus_token);
 	if (!domain->name)
 		return -ENOMEM;
+
 	domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 	return 0;
 }
@@ -200,7 +206,7 @@ static int irq_domain_set_name(struct irq_domain *domain, const struct irq_domai
 			return alloc_name(domain, fwid->name, bus_token);
 		default:
 			domain->name = fwid->name;
-			if (bus_token)
+			if (bus_token != DOMAIN_BUS_ANY)
 				return alloc_name(domain, fwid->name, bus_token);
 		}
 
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#2 lore raw

Re: [PATCH v1 1/2] irqdomain: Unify checks for bus_token

Quoted 6 lines · Andy Shevchenko

The code uses if (bus_token) and if (bus_token == DOMAIN_BUS_ANY). Since bus_token is enum, the later is more robust against changes. Unify all checks to follow the latter variant.

Fixes 0b21add71bd9 ("irqdomain: Handle domain bus token in irq_domain_create()")
Fixes 1bf2c9282927 ("irqdomain: Cleanup domain name allocation")

I'm fine with the change per se, but what does this fix? It's correct code, no?

#3 lore raw

Re: [PATCH v1 1/2] irqdomain: Unify checks for bus_token

Quoted 10 lines · Thomas Gleixner
Quoted 6 lines · Andy Shevchenko

The code uses if (bus_token) and if (bus_token == DOMAIN_BUS_ANY). Since bus_token is enum, the later is more robust against changes. Unify all checks to follow the latter variant.

Fixes 0b21add71bd9 ("irqdomain: Handle domain bus token in irq_domain_create()")
Fixes 1bf2c9282927 ("irqdomain: Cleanup domain name allocation")

I'm fine with the change per se, but what does this fix? It's correct code, no?

Technically yes, it's correct code as long as nobody touches the mentioned enum. It fixes the style and makes it robust against the changes.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#4 lore raw

[tip: irq/core] irqdomain: Clarify checks for bus_token

In reply to Andy Shevchenko
The following commit has been merged into the irq/core branch of tip:

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     c0ece64497992473aabbcbb007e2afecc8d750a2
Gitweb:        https://git.kernel.org/tip/c0ece64497992473aabbcbb007e2afecc8d750a2
Author:        Andy Shevchenko <[email protected]>
AuthorDate:    Mon, 12 Aug 2024 22:29:39 +03:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Tue, 13 Aug 2024 10:40:09 +02:00

irqdomain: Clarify checks for bus_token

The code uses if (bus_token) and if (bus_token == DOMAIN_BUS_ANY).

Since bus_token is an enum, the latter is more robust against changes.

Convert all !bus_token checks to explicitely check for DOMAIN_BUS_ANY.

---
 kernel/irq/irqdomain.c | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)
kernel/irq/irqdomain.c +14 -8
index 01001eb..18d253e 100644
@@ -130,8 +130,10 @@ EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
 
 static int alloc_name(struct irq_domain *domain, char *base, enum irq_domain_bus_token bus_token)
 {
-	domain->name = bus_token ? kasprintf(GFP_KERNEL, "%s-%d", base, bus_token) :
-				   kasprintf(GFP_KERNEL, "%s", base);
+	if (bus_token == DOMAIN_BUS_ANY)
+		domain->name = kasprintf(GFP_KERNEL, "%s", base);
+	else
+		domain->name = kasprintf(GFP_KERNEL, "%s-%d", base, bus_token);
 	if (!domain->name)
 		return -ENOMEM;
 
@@ -146,8 +148,10 @@ static int alloc_fwnode_name(struct irq_domain *domain, const struct fwnode_hand
 	const char *suf = suffix ? : "";
 	char *name;
 
-	name = bus_token ? kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token) :
-			   kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+	if (bus_token == DOMAIN_BUS_ANY)
+		name = kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+	else
+		name = kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token);
 	if (!name)
 		return -ENOMEM;
 
@@ -166,11 +170,13 @@ static int alloc_unknown_name(struct irq_domain *domain, enum irq_domain_bus_tok
 	static atomic_t unknown_domains;
 	int id = atomic_inc_return(&unknown_domains);
 
-	domain->name = bus_token ? kasprintf(GFP_KERNEL, "unknown-%d-%d", id, bus_token) :
-				   kasprintf(GFP_KERNEL, "unknown-%d", id);
-
+	if (bus_token == DOMAIN_BUS_ANY)
+		domain->name = kasprintf(GFP_KERNEL, "unknown-%d", id);
+	else
+		domain->name = kasprintf(GFP_KERNEL, "unknown-%d-%d", id, bus_token);
 	if (!domain->name)
 		return -ENOMEM;
+
 	domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 	return 0;
 }
@@ -200,7 +206,7 @@ static int irq_domain_set_name(struct irq_domain *domain, const struct irq_domai
 			return alloc_name(domain, fwid->name, bus_token);
 		default:
 			domain->name = fwid->name;
-			if (bus_token)
+			if (bus_token != DOMAIN_BUS_ANY)
 				return alloc_name(domain, fwid->name, bus_token);
 		}
 
Reviewed-by on v1 1/2
#5 lore raw

Re: [PATCH v1 1/2] irqdomain: Unify checks for bus_token

In reply to Andy Shevchenko
Quoted 3 lines · Andy Shevchenko

The code uses if (bus_token) and if (bus_token == DOMAIN_BUS_ANY). Since bus_token is enum, the later is more robust against changes. Unify all checks to follow the latter variant.

I don't really have a strong opinion on this but for me the
if (bus_token) reads better. Te bus_token is either set (and set to something else but zero), or not. This logic is nicely reflected by the check 'if (bus_token)'. Still, I suppose the 'DOMAIN_BUS_ANY' is for a reason, and some people indeed claim that consistency matters ;)

Quoted 12 lines
Fixes 0b21add71bd9 ("irqdomain: Handle domain bus token in irq_domain_create()")
Fixes 1bf2c9282927 ("irqdomain: Cleanup domain name allocation")
---
  kernel/irq/irqdomain.c | 22 ++++++++++++++--------
  1 file changed, 14 insertions(+), 8 deletions(-)
kernel/irq/irqdomain.c +0 -0
index 01001eb615ec..18d253e10e87 100644

kernel/irq/irqdomain.c EXPORT_SYMBOL_GPL(irq_domain_free_fwnode); · line 136

Quoted 9 lines
kernel/irq/irqdomain.c +4 -2
@@ -130,8 +130,10 @@ EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
 
  static int alloc_name(struct irq_domain *domain, char *base, enum irq_domain_bus_token bus_token)
  {
-	domain->name = bus_token ? kasprintf(GFP_KERNEL, "%s-%d", base, bus_token) :
-				   kasprintf(GFP_KERNEL, "%s", base);
+	if (bus_token == DOMAIN_BUS_ANY)
+		domain->name = kasprintf(GFP_KERNEL, "%s", base);
+	else
+		domain->name = kasprintf(GFP_KERNEL, "%s-%d", base, bus_token);

You could do:

	domain->name = bus_token == DOMAIN_BUS_ANY ? kasprintf(...

to squeeze this a bit more compact (and to maintain the previous style) - but my personal preference is to not have a ternary. Well, again nothing I would have a really strong opinion.

Anyways, the logic looks solid to me so, FWIW:

Yours,
-- Matti

Signature · 5 lines
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland

~~ When things go utterly wrong vim users can always type :help! ~~
#6 lore raw

PATCH 2/2 irqdomain: Remove stray '-' in the IRQ domain name

In reply to Andy Shevchenko

When domain suffix is not supplied the fwnode case (not irqchip-fwnode) uses alloc_fwnode_name(). This currently unconditionally adds a separator. Fix the logic to make it conditional and drop stray '-' in the IRQ domain name.

Fixes 1e7c05292531 ("irqdomain: Allow giving name suffix for domain")
---
 kernel/irq/irqdomain.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
kernel/irq/irqdomain.c +2 -2
index 18d253e10e87..1acc5308fcb7 100644
@@ -149,9 +149,9 @@ static int alloc_fwnode_name(struct irq_domain *domain, const struct fwnode_hand
 	char *name;
 
 	if (bus_token == DOMAIN_BUS_ANY)
-		name = kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+		name = kasprintf(GFP_KERNEL, "%pfw%s%s", fwnode, sep, suf);
 	else
-		name = kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token);
+		name = kasprintf(GFP_KERNEL, "%pfw%s%s-%d", fwnode, sep, suf, bus_token);
 	if (!name)
 		return -ENOMEM;
 
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#7 lore raw

[tip: irq/core] irqdomain: Remove stray '-' in the domain name

The following commit has been merged into the irq/core branch of tip:

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     7b9414cb2d370b7c5149b37f585b077af2ae211b
Gitweb:        https://git.kernel.org/tip/7b9414cb2d370b7c5149b37f585b077af2ae211b
Author:        Andy Shevchenko <[email protected]>
AuthorDate:    Mon, 12 Aug 2024 22:29:40 +03:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Tue, 13 Aug 2024 10:40:10 +02:00

irqdomain: Remove stray '-' in the domain name

When the domain suffix is not supplied alloc_fwnode_name() unconditionally adds a separator.

Fix the format strings to get rid of the stray '-' separator.

Fixes 1e7c05292531 ("irqdomain: Allow giving name suffix for domain")
---
 kernel/irq/irqdomain.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
kernel/irq/irqdomain.c +2 -2
index 18d253e..1acc530 100644
@@ -149,9 +149,9 @@ static int alloc_fwnode_name(struct irq_domain *domain, const struct fwnode_hand
 	char *name;
 
 	if (bus_token == DOMAIN_BUS_ANY)
-		name = kasprintf(GFP_KERNEL, "%pfw-%s", fwnode, suf);
+		name = kasprintf(GFP_KERNEL, "%pfw%s%s", fwnode, sep, suf);
 	else
-		name = kasprintf(GFP_KERNEL, "%pfw-%s%s%d", fwnode, suf, sep, bus_token);
+		name = kasprintf(GFP_KERNEL, "%pfw%s%s-%d", fwnode, sep, suf, bus_token);
 	if (!name)
 		return -ENOMEM;
 
Reviewed-by on v1 2/2
#8 lore raw

Re: [PATCH v1 2/2] irqdomain: Remove stray '-' in the IRQ domain name

In reply to Andy Shevchenko
Quoted 7 lines · Andy Shevchenko

When domain suffix is not supplied the fwnode case (not irqchip-fwnode) uses alloc_fwnode_name(). This currently unconditionally adds a separator. Fix the logic to make it conditional and drop stray '-' in the IRQ domain name.

Fixes 1e7c05292531 ("irqdomain: Allow giving name suffix for domain")

Thanks Andy.

Yours,
-- Matti

Signature · 5 lines
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland

~~ When things go utterly wrong vim users can always type :help! ~~