[v6] media: atomisp: pci: Replace bytes macros with functions

Message ID 20230118160739.26059-1-bpappas@pappasbrent.com (mailing list archive)
State Accepted
Headers
Series [v6] media: atomisp: pci: Replace bytes macros with functions |

Commit Message

Brent Pappas Jan. 18, 2023, 4:07 p.m. UTC
  Replace the function-like macros FPNTBL_BYTES(), SCTBL_BYTES(), and
MORPH_PLANE_BYTES() with functions to comply with Linux coding style
standards.
Replace multiplication with calls to array_size() and array3_size()
to prevent accidental arithmetic overflow.

Signed-off-by: Brent Pappas <bpappas@pappasbrent.com>
---
Changelog:
V1 -> V2: Use size_mul() to perform size_t multiplication without risk of
		  overflow.
		  Remove the inline keyword from function definitions.

V2 -> V3: Add commit message.

V3 -> V4: Use array_size() and array3_size() for multiplication.

V4 -> V5: Fix indentation.

V5 -> V6: Try again to fix indentation (use tabs of size 8).

 .../staging/media/atomisp/pci/sh_css_params.c | 38 +++++++++++--------
 1 file changed, 23 insertions(+), 15 deletions(-)
  

Comments

Andy Shevchenko Jan. 18, 2023, 4:17 p.m. UTC | #1
On Wed, Jan 18, 2023 at 6:08 PM Brent Pappas <bpappas@pappasbrent.com> wrote:
>
> Replace the function-like macros FPNTBL_BYTES(), SCTBL_BYTES(), and
> MORPH_PLANE_BYTES() with functions to comply with Linux coding style
> standards.
> Replace multiplication with calls to array_size() and array3_size()
> to prevent accidental arithmetic overflow.

In my MUA I don't clearly see if indentations are really being fixed,
assuming that
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Thank you and keep going!

> Signed-off-by: Brent Pappas <bpappas@pappasbrent.com>
> ---
> Changelog:
> V1 -> V2: Use size_mul() to perform size_t multiplication without risk of
>                   overflow.
>                   Remove the inline keyword from function definitions.
>
> V2 -> V3: Add commit message.
>
> V3 -> V4: Use array_size() and array3_size() for multiplication.
>
> V4 -> V5: Fix indentation.
>
> V5 -> V6: Try again to fix indentation (use tabs of size 8).
>
>  .../staging/media/atomisp/pci/sh_css_params.c | 38 +++++++++++--------
>  1 file changed, 23 insertions(+), 15 deletions(-)
>
> diff --git a/drivers/staging/media/atomisp/pci/sh_css_params.c b/drivers/staging/media/atomisp/pci/sh_css_params.c
> index f08564f58242..7e111df5c09d 100644
> --- a/drivers/staging/media/atomisp/pci/sh_css_params.c
> +++ b/drivers/staging/media/atomisp/pci/sh_css_params.c
> @@ -98,17 +98,27 @@
>  #include "sh_css_frac.h"
>  #include "ia_css_bufq.h"
>
> -#define FPNTBL_BYTES(binary) \
> -       (sizeof(char) * (binary)->in_frame_info.res.height * \
> -        (binary)->in_frame_info.padded_width)
> +static size_t fpntbl_bytes(const struct ia_css_binary *binary)
> +{
> +       return array3_size(sizeof(char),
> +                          binary->in_frame_info.res.height,
> +                          binary->in_frame_info.padded_width);
> +}
>
> -#define SCTBL_BYTES(binary) \
> -       (sizeof(unsigned short) * (binary)->sctbl_height * \
> -        (binary)->sctbl_aligned_width_per_color * IA_CSS_SC_NUM_COLORS)
> +static size_t sctbl_bytes(const struct ia_css_binary *binary)
> +{
> +       return size_mul(sizeof(unsigned short),
> +                         array3_size(binary->sctbl_height,
> +                                     binary->sctbl_aligned_width_per_color,
> +                                     IA_CSS_SC_NUM_COLORS));
> +}
>
> -#define MORPH_PLANE_BYTES(binary) \
> -       (SH_CSS_MORPH_TABLE_ELEM_BYTES * (binary)->morph_tbl_aligned_width * \
> -        (binary)->morph_tbl_height)
> +static size_t morph_plane_bytes(const struct ia_css_binary *binary)
> +{
> +       return array3_size(SH_CSS_MORPH_TABLE_ELEM_BYTES,
> +                          binary->morph_tbl_aligned_width,
> +                          binary->morph_tbl_height);
> +}
>
>  /* We keep a second copy of the ptr struct for the SP to access.
>     Again, this would not be necessary on the chip. */
> @@ -3279,7 +3289,7 @@ sh_css_params_write_to_ddr_internal(
>         if (binary->info->sp.enable.fpnr) {
>                 buff_realloced = reallocate_buffer(&ddr_map->fpn_tbl,
>                                                    &ddr_map_size->fpn_tbl,
> -                                                  (size_t)(FPNTBL_BYTES(binary)),
> +                                                  fpntbl_bytes(binary),
>                                                    params->config_changed[IA_CSS_FPN_ID],
>                                                    &err);
>                 if (err) {
> @@ -3304,7 +3314,7 @@ sh_css_params_write_to_ddr_internal(
>
>                 buff_realloced = reallocate_buffer(&ddr_map->sc_tbl,
>                                                    &ddr_map_size->sc_tbl,
> -                                                  SCTBL_BYTES(binary),
> +                                                  sctbl_bytes(binary),
>                                                    params->sc_table_changed,
>                                                    &err);
>                 if (err) {
> @@ -3538,8 +3548,7 @@ sh_css_params_write_to_ddr_internal(
>                         buff_realloced |=
>                             reallocate_buffer(virt_addr_tetra_x[i],
>                                             virt_size_tetra_x[i],
> -                                           (size_t)
> -                                           (MORPH_PLANE_BYTES(binary)),
> +                                           morph_plane_bytes(binary),
>                                             params->morph_table_changed,
>                                             &err);
>                         if (err) {
> @@ -3549,8 +3558,7 @@ sh_css_params_write_to_ddr_internal(
>                         buff_realloced |=
>                             reallocate_buffer(virt_addr_tetra_y[i],
>                                             virt_size_tetra_y[i],
> -                                           (size_t)
> -                                           (MORPH_PLANE_BYTES(binary)),
> +                                           morph_plane_bytes(binary),
>                                             params->morph_table_changed,
>                                             &err);
>                         if (err) {
> --
> 2.34.1
>
  
Brent Pappas Jan. 18, 2023, 5:41 p.m. UTC | #2
> In my MUA I don't clearly see if indentations are really being fixed,
> assuming that

The issue I was having was that my editor had tabs set to size 4.
I switched them to size 8 and could see the issues that Dan was seeing.
I've ran checkpatch.pl on the patch and it passes, but if you see an
issue I will address it.

> Thank you and keep going!

Thank you for your patience.
  
Hans de Goede Jan. 23, 2023, 12:27 p.m. UTC | #3
Hi,

On 1/18/23 17:07, Brent Pappas wrote:
> Replace the function-like macros FPNTBL_BYTES(), SCTBL_BYTES(), and
> MORPH_PLANE_BYTES() with functions to comply with Linux coding style
> standards.
> Replace multiplication with calls to array_size() and array3_size()
> to prevent accidental arithmetic overflow.
> 
> Signed-off-by: Brent Pappas <bpappas@pappasbrent.com>

Thank you.

I have added this to my personal git tree now and I will include
this in the atomisp driver pull-req which I will send to the
media-subsystem maintainer in a couple of weeks.

Regards,

Hans




> ---
> Changelog:
> V1 -> V2: Use size_mul() to perform size_t multiplication without risk of
> 		  overflow.
> 		  Remove the inline keyword from function definitions.
> 
> V2 -> V3: Add commit message.
> 
> V3 -> V4: Use array_size() and array3_size() for multiplication.
> 
> V4 -> V5: Fix indentation.
> 
> V5 -> V6: Try again to fix indentation (use tabs of size 8).
> 
>  .../staging/media/atomisp/pci/sh_css_params.c | 38 +++++++++++--------
>  1 file changed, 23 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/staging/media/atomisp/pci/sh_css_params.c b/drivers/staging/media/atomisp/pci/sh_css_params.c
> index f08564f58242..7e111df5c09d 100644
> --- a/drivers/staging/media/atomisp/pci/sh_css_params.c
> +++ b/drivers/staging/media/atomisp/pci/sh_css_params.c
> @@ -98,17 +98,27 @@
>  #include "sh_css_frac.h"
>  #include "ia_css_bufq.h"
>  
> -#define FPNTBL_BYTES(binary) \
> -	(sizeof(char) * (binary)->in_frame_info.res.height * \
> -	 (binary)->in_frame_info.padded_width)
> +static size_t fpntbl_bytes(const struct ia_css_binary *binary)
> +{
> +	return array3_size(sizeof(char),
> +			   binary->in_frame_info.res.height,
> +			   binary->in_frame_info.padded_width);
> +}
>  
> -#define SCTBL_BYTES(binary) \
> -	(sizeof(unsigned short) * (binary)->sctbl_height * \
> -	 (binary)->sctbl_aligned_width_per_color * IA_CSS_SC_NUM_COLORS)
> +static size_t sctbl_bytes(const struct ia_css_binary *binary)
> +{
> +	return size_mul(sizeof(unsigned short),
> +			  array3_size(binary->sctbl_height,
> +				      binary->sctbl_aligned_width_per_color,
> +				      IA_CSS_SC_NUM_COLORS));
> +}
>  
> -#define MORPH_PLANE_BYTES(binary) \
> -	(SH_CSS_MORPH_TABLE_ELEM_BYTES * (binary)->morph_tbl_aligned_width * \
> -	 (binary)->morph_tbl_height)
> +static size_t morph_plane_bytes(const struct ia_css_binary *binary)
> +{
> +	return array3_size(SH_CSS_MORPH_TABLE_ELEM_BYTES,
> +			   binary->morph_tbl_aligned_width,
> +			   binary->morph_tbl_height);
> +}
>  
>  /* We keep a second copy of the ptr struct for the SP to access.
>     Again, this would not be necessary on the chip. */
> @@ -3279,7 +3289,7 @@ sh_css_params_write_to_ddr_internal(
>  	if (binary->info->sp.enable.fpnr) {
>  		buff_realloced = reallocate_buffer(&ddr_map->fpn_tbl,
>  						   &ddr_map_size->fpn_tbl,
> -						   (size_t)(FPNTBL_BYTES(binary)),
> +						   fpntbl_bytes(binary),
>  						   params->config_changed[IA_CSS_FPN_ID],
>  						   &err);
>  		if (err) {
> @@ -3304,7 +3314,7 @@ sh_css_params_write_to_ddr_internal(
>  
>  		buff_realloced = reallocate_buffer(&ddr_map->sc_tbl,
>  						   &ddr_map_size->sc_tbl,
> -						   SCTBL_BYTES(binary),
> +						   sctbl_bytes(binary),
>  						   params->sc_table_changed,
>  						   &err);
>  		if (err) {
> @@ -3538,8 +3548,7 @@ sh_css_params_write_to_ddr_internal(
>  			buff_realloced |=
>  			    reallocate_buffer(virt_addr_tetra_x[i],
>  					    virt_size_tetra_x[i],
> -					    (size_t)
> -					    (MORPH_PLANE_BYTES(binary)),
> +					    morph_plane_bytes(binary),
>  					    params->morph_table_changed,
>  					    &err);
>  			if (err) {
> @@ -3549,8 +3558,7 @@ sh_css_params_write_to_ddr_internal(
>  			buff_realloced |=
>  			    reallocate_buffer(virt_addr_tetra_y[i],
>  					    virt_size_tetra_y[i],
> -					    (size_t)
> -					    (MORPH_PLANE_BYTES(binary)),
> +					    morph_plane_bytes(binary),
>  					    params->morph_table_changed,
>  					    &err);
>  			if (err) {
  

Patch

diff --git a/drivers/staging/media/atomisp/pci/sh_css_params.c b/drivers/staging/media/atomisp/pci/sh_css_params.c
index f08564f58242..7e111df5c09d 100644
--- a/drivers/staging/media/atomisp/pci/sh_css_params.c
+++ b/drivers/staging/media/atomisp/pci/sh_css_params.c
@@ -98,17 +98,27 @@ 
 #include "sh_css_frac.h"
 #include "ia_css_bufq.h"
 
-#define FPNTBL_BYTES(binary) \
-	(sizeof(char) * (binary)->in_frame_info.res.height * \
-	 (binary)->in_frame_info.padded_width)
+static size_t fpntbl_bytes(const struct ia_css_binary *binary)
+{
+	return array3_size(sizeof(char),
+			   binary->in_frame_info.res.height,
+			   binary->in_frame_info.padded_width);
+}
 
-#define SCTBL_BYTES(binary) \
-	(sizeof(unsigned short) * (binary)->sctbl_height * \
-	 (binary)->sctbl_aligned_width_per_color * IA_CSS_SC_NUM_COLORS)
+static size_t sctbl_bytes(const struct ia_css_binary *binary)
+{
+	return size_mul(sizeof(unsigned short),
+			  array3_size(binary->sctbl_height,
+				      binary->sctbl_aligned_width_per_color,
+				      IA_CSS_SC_NUM_COLORS));
+}
 
-#define MORPH_PLANE_BYTES(binary) \
-	(SH_CSS_MORPH_TABLE_ELEM_BYTES * (binary)->morph_tbl_aligned_width * \
-	 (binary)->morph_tbl_height)
+static size_t morph_plane_bytes(const struct ia_css_binary *binary)
+{
+	return array3_size(SH_CSS_MORPH_TABLE_ELEM_BYTES,
+			   binary->morph_tbl_aligned_width,
+			   binary->morph_tbl_height);
+}
 
 /* We keep a second copy of the ptr struct for the SP to access.
    Again, this would not be necessary on the chip. */
@@ -3279,7 +3289,7 @@  sh_css_params_write_to_ddr_internal(
 	if (binary->info->sp.enable.fpnr) {
 		buff_realloced = reallocate_buffer(&ddr_map->fpn_tbl,
 						   &ddr_map_size->fpn_tbl,
-						   (size_t)(FPNTBL_BYTES(binary)),
+						   fpntbl_bytes(binary),
 						   params->config_changed[IA_CSS_FPN_ID],
 						   &err);
 		if (err) {
@@ -3304,7 +3314,7 @@  sh_css_params_write_to_ddr_internal(
 
 		buff_realloced = reallocate_buffer(&ddr_map->sc_tbl,
 						   &ddr_map_size->sc_tbl,
-						   SCTBL_BYTES(binary),
+						   sctbl_bytes(binary),
 						   params->sc_table_changed,
 						   &err);
 		if (err) {
@@ -3538,8 +3548,7 @@  sh_css_params_write_to_ddr_internal(
 			buff_realloced |=
 			    reallocate_buffer(virt_addr_tetra_x[i],
 					    virt_size_tetra_x[i],
-					    (size_t)
-					    (MORPH_PLANE_BYTES(binary)),
+					    morph_plane_bytes(binary),
 					    params->morph_table_changed,
 					    &err);
 			if (err) {
@@ -3549,8 +3558,7 @@  sh_css_params_write_to_ddr_internal(
 			buff_realloced |=
 			    reallocate_buffer(virt_addr_tetra_y[i],
 					    virt_size_tetra_y[i],
-					    (size_t)
-					    (MORPH_PLANE_BYTES(binary)),
+					    morph_plane_bytes(binary),
 					    params->morph_table_changed,
 					    &err);
 			if (err) {