Skip to contentSkip to conversation

crypto: eip93 - use struct_size() and flexible array for ring allocation

PATCH In review Rosen Penev 3 participants 6 messages Aug 3 – Aug 15

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

PATCH 1/1 crypto: eip93 - use struct_size() and flexible array for ring allocation

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
 .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
 .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
 2 files changed, 12 insertions(+), 16 deletions(-)
drivers/crypto/inside-secure/eip93/eip93-main.c +1 -5
index 1a8dabc4ada4..e62785952b0d 100644
@@ -415,7 +415,7 @@ static int eip93_crypto_probe(struct platform_device *pdev)
 	u32 ver, algo_flags;
 	int ret;
 
-	eip93 = devm_kzalloc(dev, sizeof(*eip93), GFP_KERNEL);
+	eip93 = devm_kzalloc(dev, struct_size(eip93, ring, 1), GFP_KERNEL);
 	if (!eip93)
 		return -ENOMEM;
 
@@ -436,10 +436,6 @@ static int eip93_crypto_probe(struct platform_device *pdev)
 	if (ret)
 		return ret;
 
-	eip93->ring = devm_kcalloc(eip93->dev, 1, sizeof(*eip93->ring), GFP_KERNEL);
-	if (!eip93->ring)
-		return -ENOMEM;
-
 	ret = eip93_desc_init(eip93);
 	if (ret)
 		return ret;
drivers/crypto/inside-secure/eip93/eip93-main.h +11 -11
index 990c2401b7ce..5f0f51081743 100644
@@ -92,17 +92,6 @@
 						    EIP93_HASH_SHA224 | \
 						    EIP93_HASH_SHA256))
 
-/**
- * struct eip93_device - crypto engine device structure
- */
-struct eip93_device {
-	void __iomem		*base;
-	struct device		*dev;
-	struct clk		*clk;
-	int			irq;
-	struct eip93_ring		*ring;
-};
-
 struct eip93_desc_ring {
 	void			*base;
 	void			*base_end;
@@ -131,6 +120,17 @@ struct eip93_ring {
 	struct idr			crypto_async_idr;
 };
 
+/**
+ * struct eip93_device - crypto engine device structure
+ */
+struct eip93_device {
+	void __iomem		*base;
+	struct device		*dev;
+	struct clk		*clk;
+	int			irq;
+	struct eip93_ring	ring[];
+};
+
 enum eip93_alg_type {
 	EIP93_ALG_TYPE_AEAD,
 	EIP93_ALG_TYPE_SKCIPHER,
Signature · 1 line
2.55.0
#1 lore raw
Quoted 61 lines · Rosen Penev

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
  .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
  .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
  2 files changed, 12 insertions(+), 16 deletions(-)
drivers/crypto/inside-secure/eip93/eip93-main.c +1 -5
index 1a8dabc4ada4..e62785952b0d 100644
@@ -415,7 +415,7 @@ static int eip93_crypto_probe(struct platform_device *pdev)
  	u32 ver, algo_flags;
  	int ret;
 
-	eip93 = devm_kzalloc(dev, sizeof(*eip93), GFP_KERNEL);
+	eip93 = devm_kzalloc(dev, struct_size(eip93, ring, 1), GFP_KERNEL);
  	if (!eip93)
  		return -ENOMEM;
 
@@ -436,10 +436,6 @@ static int eip93_crypto_probe(struct platform_device *pdev)
  	if (ret)
  		return ret;
 
-	eip93->ring = devm_kcalloc(eip93->dev, 1, sizeof(*eip93->ring), GFP_KERNEL);
-	if (!eip93->ring)
-		return -ENOMEM;
-
  	ret = eip93_desc_init(eip93);
  	if (ret)
  		return ret;
drivers/crypto/inside-secure/eip93/eip93-main.h +0 -11
index 990c2401b7ce..5f0f51081743 100644
@@ -92,17 +92,6 @@
  						    EIP93_HASH_SHA224 | \
  						    EIP93_HASH_SHA256))
 
-/**
- * struct eip93_device - crypto engine device structure
- */
-struct eip93_device {
-	void __iomem		*base;
-	struct device		*dev;
-	struct clk		*clk;
-	int			irq;
-	struct eip93_ring		*ring;
-};
-
  struct eip93_desc_ring {
  	void			*base;
  	void			*base_end;
@@ -131,6 +120,17 @@ struct eip93_ring {
  	struct idr			crypto_async_idr;
  };
 

drivers/crypto/inside-secure/eip93/eip93-main.h struct eip93_ring { · line 132

Quoted 10 lines
drivers/crypto/inside-secure/eip93/eip93-main.h +10 -0
+/**
+ * struct eip93_device - crypto engine device structure
+ */
+struct eip93_device {
+	void __iomem		*base;
+	struct device		*dev;
+	struct clk		*clk;
+	int			irq;
+	struct eip93_ring	ring[];
+};

This looks weird, too. If there is always only one "ring", why don't you embed it without the "[]" into the struct eip93_device directly?

Thomas

#2 lore raw
Quoted 63 lines · Thomas Huth
Quoted 61 lines · Rosen Penev

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
  .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
  .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
  2 files changed, 12 insertions(+), 16 deletions(-)
drivers/crypto/inside-secure/eip93/eip93-main.c +1 -5
index 1a8dabc4ada4..e62785952b0d 100644
@@ -415,7 +415,7 @@ static int eip93_crypto_probe(struct platform_device *pdev)
      u32 ver, algo_flags;
      int ret;
 
-     eip93 = devm_kzalloc(dev, sizeof(*eip93), GFP_KERNEL);
+     eip93 = devm_kzalloc(dev, struct_size(eip93, ring, 1), GFP_KERNEL);
      if (!eip93)
              return -ENOMEM;
 
@@ -436,10 +436,6 @@ static int eip93_crypto_probe(struct platform_device *pdev)
      if (ret)
              return ret;
 
-     eip93->ring = devm_kcalloc(eip93->dev, 1, sizeof(*eip93->ring), GFP_KERNEL);
-     if (!eip93->ring)
-             return -ENOMEM;
-
      ret = eip93_desc_init(eip93);
      if (ret)
              return ret;
drivers/crypto/inside-secure/eip93/eip93-main.h +0 -11
index 990c2401b7ce..5f0f51081743 100644
@@ -92,17 +92,6 @@
                                                  EIP93_HASH_SHA224 | \
                                                  EIP93_HASH_SHA256))
 
-/**
- * struct eip93_device - crypto engine device structure
- */
-struct eip93_device {
-     void __iomem            *base;
-     struct device           *dev;
-     struct clk              *clk;
-     int                     irq;
-     struct eip93_ring               *ring;
-};
-
  struct eip93_desc_ring {
      void                    *base;
      void                    *base_end;
@@ -131,6 +120,17 @@ struct eip93_ring {
      struct idr                      crypto_async_idr;
  };
 
Quoted 12 lines

drivers/crypto/inside-secure/eip93/eip93-main.h struct eip93_ring { · line 132

Quoted 10 lines
drivers/crypto/inside-secure/eip93/eip93-main.h +10 -0
+/**
+ * struct eip93_device - crypto engine device structure
+ */
+struct eip93_device {
+     void __iomem            *base;
+     struct device           *dev;
+     struct clk              *clk;
+     int                     irq;
+     struct eip93_ring       ring[];
+};

This looks weird, too. If there is always only one "ring", why don't you embed it without the "[]" into the struct eip93_device directly?

keeps all callers the same. -> vs .

Quoted 3 lines

Thomas

#3 lore raw
Quoted 76 lines · Rosen Penev
Quoted 63 lines · Thomas Huth
Quoted 61 lines · Rosen Penev

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
   .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
   .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
   2 files changed, 12 insertions(+), 16 deletions(-)
drivers/crypto/inside-secure/eip93/eip93-main.c +1 -5
index 1a8dabc4ada4..e62785952b0d 100644
@@ -415,7 +415,7 @@ static int eip93_crypto_probe(struct platform_device *pdev)
       u32 ver, algo_flags;
       int ret;
 
-     eip93 = devm_kzalloc(dev, sizeof(*eip93), GFP_KERNEL);
+     eip93 = devm_kzalloc(dev, struct_size(eip93, ring, 1), GFP_KERNEL);
       if (!eip93)
               return -ENOMEM;
 
@@ -436,10 +436,6 @@ static int eip93_crypto_probe(struct platform_device *pdev)
       if (ret)
               return ret;
 
-     eip93->ring = devm_kcalloc(eip93->dev, 1, sizeof(*eip93->ring), GFP_KERNEL);
-     if (!eip93->ring)
-             return -ENOMEM;
-
       ret = eip93_desc_init(eip93);
       if (ret)
               return ret;
drivers/crypto/inside-secure/eip93/eip93-main.h +0 -11
index 990c2401b7ce..5f0f51081743 100644
@@ -92,17 +92,6 @@
                                                   EIP93_HASH_SHA224 | \
                                                   EIP93_HASH_SHA256))
 
-/**
- * struct eip93_device - crypto engine device structure
- */
-struct eip93_device {
-     void __iomem            *base;
-     struct device           *dev;
-     struct clk              *clk;
-     int                     irq;
-     struct eip93_ring               *ring;
-};
-
   struct eip93_desc_ring {
       void                    *base;
       void                    *base_end;
@@ -131,6 +120,17 @@ struct eip93_ring {
       struct idr                      crypto_async_idr;
   };
 
Quoted 12 lines

drivers/crypto/inside-secure/eip93/eip93-main.h struct eip93_ring { · line 132

Quoted 10 lines
drivers/crypto/inside-secure/eip93/eip93-main.h +10 -0
+/**
+ * struct eip93_device - crypto engine device structure
+ */
+struct eip93_device {
+     void __iomem            *base;
+     struct device           *dev;
+     struct clk              *clk;
+     int                     irq;
+     struct eip93_ring       ring[];
+};

This looks weird, too. If there is always only one "ring", why don't you embed it without the "[]" into the struct eip93_device directly?

Quoted 1 line

keeps all callers the same. -> vs .

So it's basically keeping the patch small and generating many WTFs for future reviewers of the code vs. having a bigger patch now and better understable code in the future. Not my decision (it's up to the maintainers), but FWIW I'd rather go with option 2.

Anyway, if you want to keep it short, wouldn't it also be possible to declare it as ring[1] instead and then keep the sizeof() instead of the struct_size() ?

Thomas

#4 lore raw
Quoted 79 lines · Thomas Huth
Quoted 76 lines · Rosen Penev
Quoted 63 lines · Thomas Huth
Quoted 61 lines · Rosen Penev

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
   .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
   .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
   2 files changed, 12 insertions(+), 16 deletions(-)
drivers/crypto/inside-secure/eip93/eip93-main.c +1 -5
index 1a8dabc4ada4..e62785952b0d 100644
@@ -415,7 +415,7 @@ static int eip93_crypto_probe(struct platform_device *pdev)
       u32 ver, algo_flags;
       int ret;
 
-     eip93 = devm_kzalloc(dev, sizeof(*eip93), GFP_KERNEL);
+     eip93 = devm_kzalloc(dev, struct_size(eip93, ring, 1), GFP_KERNEL);
       if (!eip93)
               return -ENOMEM;
 
@@ -436,10 +436,6 @@ static int eip93_crypto_probe(struct platform_device *pdev)
       if (ret)
               return ret;
 
-     eip93->ring = devm_kcalloc(eip93->dev, 1, sizeof(*eip93->ring), GFP_KERNEL);
-     if (!eip93->ring)
-             return -ENOMEM;
-
       ret = eip93_desc_init(eip93);
       if (ret)
               return ret;
drivers/crypto/inside-secure/eip93/eip93-main.h +0 -11
index 990c2401b7ce..5f0f51081743 100644
@@ -92,17 +92,6 @@
                                                   EIP93_HASH_SHA224 | \
                                                   EIP93_HASH_SHA256))
 
-/**
- * struct eip93_device - crypto engine device structure
- */
-struct eip93_device {
-     void __iomem            *base;
-     struct device           *dev;
-     struct clk              *clk;
-     int                     irq;
-     struct eip93_ring               *ring;
-};
-
   struct eip93_desc_ring {
       void                    *base;
       void                    *base_end;
@@ -131,6 +120,17 @@ struct eip93_ring {
       struct idr                      crypto_async_idr;
   };
 
Quoted 12 lines

drivers/crypto/inside-secure/eip93/eip93-main.h struct eip93_ring { · line 132

Quoted 10 lines
drivers/crypto/inside-secure/eip93/eip93-main.h +10 -0
+/**
+ * struct eip93_device - crypto engine device structure
+ */
+struct eip93_device {
+     void __iomem            *base;
+     struct device           *dev;
+     struct clk              *clk;
+     int                     irq;
+     struct eip93_ring       ring[];
+};

This looks weird, too. If there is always only one "ring", why don't you embed it without the "[]" into the struct eip93_device directly?

Quoted 1 line

keeps all callers the same. -> vs .

Quoted 8 lines

So it's basically keeping the patch small and generating many WTFs for future reviewers of the code vs. having a bigger patch now and better understable code in the future. Not my decision (it's up to the maintainers), but FWIW I'd rather go with option 2.

Anyway, if you want to keep it short, wouldn't it also be possible to declare it as ring[1] instead and then keep the sizeof() instead of the struct_size() ?

No because [1] arrays are deprecated.

Quoted 3 lines

Thomas

maintainer
#5 lore raw
In reply to Rosen Penev
Quoted 10 lines · Rosen Penev

Embed the single ring as a flexible array member in eip93_device instead of allocating it separately. This simplifies the probe path and uses struct_size() for a single allocation.

Assisted-by opencode:big-pickle
---
 .../crypto/inside-secure/eip93/eip93-main.c   |  6 +----
 .../crypto/inside-secure/eip93/eip93-main.h   | 22 +++++++++----------
 2 files changed, 12 insertions(+), 16 deletions(-)

Patch applied. Thanks.

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt