Skip to contentSkip to conversation

i2c: mux: demux-pinctrl: Annotate struct i2c_demux_pinctrl_priv with __counted_by

PATCH In review Kees Cook 3 participants 3 messages Sep 22, 2023 – Sep 24, 2023

Subsystems (3)
lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 i2c: mux: demux-pinctrl: Annotate struct i2c_demux_pinctrl_priv with __counted_by

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct i2c_demux_pinctrl_priv. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

---
 drivers/i2c/muxes/i2c-demux-pinctrl.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/i2c/muxes/i2c-demux-pinctrl.c +3 -3
index a3a122fae71e..5e15d8777229 100644
@@ -32,7 +32,7 @@ struct i2c_demux_pinctrl_priv {
 	const char *bus_name;
 	struct i2c_adapter cur_adap;
 	struct i2c_algorithm algo;
-	struct i2c_demux_pinctrl_chan chan[];
+	struct i2c_demux_pinctrl_chan chan[] __counted_by(num_chan);
 };
 
 static int i2c_demux_master_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
@@ -226,6 +226,8 @@ static int i2c_demux_pinctrl_probe(struct platform_device *pdev)
 	if (!priv || !props)
 		return -ENOMEM;
 
+	priv->num_chan = num_chan;
+
 	err = of_property_read_string(np, "i2c-bus-name", &priv->bus_name);
 	if (err)
 		return err;
@@ -248,8 +250,6 @@ static int i2c_demux_pinctrl_probe(struct platform_device *pdev)
 		of_changeset_init(&priv->chan[i].chgset);
 		of_changeset_update_property(&priv->chan[i].chgset, adap_np, &props[i]);
 	}
-
-	priv->num_chan = num_chan;
 	priv->dev = &pdev->dev;
 
 	platform_set_drvdata(pdev, priv);
Signature · 1 line
2.34.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · Kees Cook

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct i2c_demux_pinctrl_priv. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

Quoted 6 lines

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

Thanks

Signature · 1 line
Gustavo
Quoted 35 lines
---
  drivers/i2c/muxes/i2c-demux-pinctrl.c | 6 +++---
  1 file changed, 3 insertions(+), 3 deletions(-)
drivers/i2c/muxes/i2c-demux-pinctrl.c +3 -3
index a3a122fae71e..5e15d8777229 100644
@@ -32,7 +32,7 @@ struct i2c_demux_pinctrl_priv {
  	const char *bus_name;
  	struct i2c_adapter cur_adap;
  	struct i2c_algorithm algo;
-	struct i2c_demux_pinctrl_chan chan[];
+	struct i2c_demux_pinctrl_chan chan[] __counted_by(num_chan);
  };
 
  static int i2c_demux_master_xfer(struct i2c_adapter *adap, struct i2c_msg msgs[], int num)
@@ -226,6 +226,8 @@ static int i2c_demux_pinctrl_probe(struct platform_device *pdev)
  	if (!priv || !props)
  		return -ENOMEM;
 
+	priv->num_chan = num_chan;
+
  	err = of_property_read_string(np, "i2c-bus-name", &priv->bus_name);
  	if (err)
  		return err;
@@ -248,8 +250,6 @@ static int i2c_demux_pinctrl_probe(struct platform_device *pdev)
  		of_changeset_init(&priv->chan[i].chgset);
  		of_changeset_update_property(&priv->chan[i].chgset, adap_np, &props[i]);
  	}
-
-	priv->num_chan = num_chan;
  	priv->dev = &pdev->dev;
 
  	platform_set_drvdata(pdev, priv);
maintainer
#2 lore raw
In reply to Kees Cook
Quoted 10 lines · Kees Cook

Prepare for the coming implementation by GCC and Clang of the __counted_by attribute. Flexible array members annotated with __counted_by can have their accesses bounds-checked at run-time checking via CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for strcpy/memcpy-family functions).

As found with Coccinelle[1], add __counted_by for struct i2c_demux_pinctrl_priv. Additionally, since the element count member must be set before accessing the annotated flexible array member, move its initialization earlier.

Quoted 6 lines

[1] https://github.com/kees/kernel-tools/blob/trunk/coccinelle/examples/counted_by.cocci

Fixed a blank line and applied to for-next, thanks!