Skip to contentSkip to conversation

staging: media: sunxi: Add bool cast to value

PATCH In review Nishka Dasgupta 5 participants 9 messages Jul 22, 2019 – Jul 25, 2019

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

PATCH v2 1/1 staging: media: sunxi: Add bool cast to value

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

 drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
 static bool cedrus_check_format(u32 pixelformat, u32 directions,
 				unsigned int capabilities)
 {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
 }
 
 static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)
Signature · 1 line
2.19.1
#1 lore raw
Quoted 19 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

 drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -0
index e2b530b1a956..b731745f21f8 100644

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 6 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
 static bool cedrus_check_format(u32 pixelformat, u32 directions,
 				unsigned int capabilities)
 {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
 }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Quoted 3 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -1
 static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)
--

2.19.1

#2 lore raw

Hi,

Quoted 15 lines · Jeremy Sowden
Quoted 14 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

 drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 16 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 11 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
 static bool cedrus_check_format(u32 pixelformat, u32 directions,
 				unsigned int capabilities)
 {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
 }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's /usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero. As a result, I think it's best to be careful.

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

What do you think?

Cheers,

Paul

Quoted 3 lines
Quoted 3 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -1
 static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)
--

2.19.1

Signature · 3 lines
Paul Kocialkowski, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
#3 lore raw
Quoted 50 lines · Paul Kocialkowski
Quoted 24 lines · Jeremy Sowden
Quoted 23 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

 drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
 static bool cedrus_check_format(u32 pixelformat, u32 directions,
 				unsigned int capabilities)
 {
-	return cedrus_find_format(pixelformat, directions, capabilities);
Quoted 8 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 2 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -0
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
 }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's
/usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

Quoted 3 lines

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero.

Ick. I checked the C99 standard and assumed that GCC would use the same semantics. I've just tested with "gcc-8 -std=gnu89" and it appears to do the right thing:

  [azazel@ulthar:/space/azazel/tmp] $ cat test.c
  #include <stdbool.h>
  #include <stdio.h>

  int
  main (void)
    {
    char *p = "test";
    bool b = p;
    fprintf (stderr, "%p, %d\n", (void *) p, b);

    return 0;
    }

[azazel@ulthar:/space/azazel/tmp] $ gcc-8 -O2 -std=gnu89 -Wall -Wextra test.c -o test
[azazel@ulthar:/space/azazel/tmp] $ ./test
0x55d984e0e004, 1

Quoted 1 line

As a result, I think it's best to be careful.

Fair enough.

Quoted 8 lines

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

What do you think?

Seems sensible.

J.

#4 lore raw
In reply to Paul Kocialkowski
Quoted 48 lines · Paul Kocialkowski

Hi,

Quoted 15 lines · Jeremy Sowden
Quoted 14 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

  drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 16 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 11 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
  static bool cedrus_check_format(u32 pixelformat, u32 directions,
  				unsigned int capabilities)
  {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
  }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's /usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

Quoted 6 lines

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero. As a result, I think it's best to be careful.

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

It's not a problem per se. I'm just working on a cleanup project for which I went through all of staging replacing single-line functions with what they were calling. In some cases that makes it easier to figure out what a particular function call does, since the called function actually does something itself instead of just calling a different function? This function was also flagged as one such potentially-removable function by Coccinelle; but in order to do the same replacement that I'd done in other staging drivers, I thought I would do something about the type mismatch first, especially since find_format doesn't appear to be used anywhere else. However, now I won't remove check_format and replace it with find_format as I'd originally planned, since you've said that isn't necessary here. That leaves the return type issue.

Quoted 2 lines

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

Should I send a version 3 that does this?

Thanking you,
Nishka

Quoted 10 lines

What do you think?

Cheers,

Paul

Quoted 3 lines
Quoted 3 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -1
  static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)
--

2.19.1

#5 lore raw

Hi,

Quoted 56 lines · Nishka Dasgupta
Quoted 48 lines · Paul Kocialkowski

Hi,

Quoted 15 lines · Jeremy Sowden
Quoted 14 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

  drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 16 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 11 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
  static bool cedrus_check_format(u32 pixelformat, u32 directions,
  				unsigned int capabilities)
  {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
  }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's /usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

Quoted 6 lines

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero. As a result, I think it's best to be careful.

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

Quoted 12 lines

It's not a problem per se. I'm just working on a cleanup project for which I went through all of staging replacing single-line functions with what they were calling. In some cases that makes it easier to figure out what a particular function call does, since the called function actually does something itself instead of just calling a different function? This function was also flagged as one such potentially-removable function by Coccinelle; but in order to do the same replacement that I'd done in other staging drivers, I thought I would do something about the type mismatch first, especially since find_format doesn't appear to be used anywhere else. However, now I won't remove check_format and replace it with find_format as I'd originally planned, since you've said that isn't necessary here. That leaves the return type issue.

Is that an issue reported by coccinelle?
If so, could you provide details about it?

Quoted 4 lines
Quoted 2 lines

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

Should I send a version 3 that does this?

Yes I think !! would work out fine either way. Apparently we don't need any explicit (bool) cast from a pointer anyway.

Cheers,

Paul

Quoted 14 lines

Thanking you,
Nishka

Quoted 10 lines

What do you think?

Cheers,

Paul

Quoted 3 lines
Quoted 3 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -1
  static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)
--

2.19.1

Signature · 3 lines
Paul Kocialkowski, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
#6 lore raw
In reply to Nishka Dasgupta
Quoted 70 lines · Nishka Dasgupta
Quoted 48 lines · Paul Kocialkowski

Hi,

Quoted 15 lines · Jeremy Sowden
Quoted 14 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

  drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 16 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 11 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
  static bool cedrus_check_format(u32 pixelformat, u32 directions,
  				unsigned int capabilities)
  {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
  }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's /usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

Quoted 6 lines

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero. As a result, I think it's best to be careful.

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

It's not a problem per se. I'm just working on a cleanup project for which I went through all of staging replacing single-line functions with what they were calling. In some cases that makes it easier to figure out what a particular function call does, since the called function actually does something itself instead of just calling a different function? This function was also flagged as one such potentially-removable function by Coccinelle; but in order to do the same replacement that I'd done in other staging drivers, I thought I would do something about the type mismatch first, especially since find_format doesn't appear to be used anywhere else. However, now I won't remove check_format and replace it with find_format as I'd originally planned, since you've said that isn't necessary here. That leaves the return type issue.

Quoted 4 lines
Quoted 2 lines

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

Should I send a version 3 that does this?

bool was introduced in C99. Converting a non-zero value to boolean will yield true as a result. Please keep the code as-is; it's much easier to read that way.

Signature · 3 lines
Kind regards,

Sakari Ailus
#7 lore raw

Hi,

Quoted 71 lines · Sakari Ailus
Quoted 70 lines · Nishka Dasgupta
Quoted 48 lines · Paul Kocialkowski

Hi,

Quoted 15 lines · Jeremy Sowden
Quoted 14 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

  drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 16 lines

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 90

Quoted 11 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
index e2b530b1a956..b731745f21f8 100644
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
  static bool cedrus_check_format(u32 pixelformat, u32 directions,
  				unsigned int capabilities)
  {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);
  }

I think the original was fine. The return value of cedrus_find_format will be automatically converted to bool before being returned from cedrus_check_format since that is the return-type of the function, and the result of converting any non-zero value to bool is 1.

Okay I was a bit unsure about that and wanted to play it on the safe side without really looking it up, but that gave me the occasion to verify.

From what I could find (from my GNU system's /usr/include/unistring/stdbool.h):

Limitations of this substitute, when used in a C89 environment:

- In C99, casts and automatic conversions to '_Bool' or 'bool' are performed in such a way that every nonzero value gets converted to 'true', and zero gets converted to 'false'. This doesn't work with this substitute. With this substitute, only the values 0 and 1 give the expected result when converted to _Bool' or 'bool'.

Quoted 6 lines

So since the kernel is built for C89 (unless I'm mistaken), I don't think the compiler provides any guarantee about bool values being converted to 1 when they are non-zero. As a result, I think it's best to be careful.

However, I'm not sure I really see what cocinelle was unhappy about. You mentionned single-line functions, but I don't see how that can be a problem.

It's not a problem per se. I'm just working on a cleanup project for which I went through all of staging replacing single-line functions with what they were calling. In some cases that makes it easier to figure out what a particular function call does, since the called function actually does something itself instead of just calling a different function? This function was also flagged as one such potentially-removable function by Coccinelle; but in order to do the same replacement that I'd done in other staging drivers, I thought I would do something about the type mismatch first, especially since find_format doesn't appear to be used anywhere else. However, now I won't remove check_format and replace it with find_format as I'd originally planned, since you've said that isn't necessary here. That leaves the return type issue.

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

So in the end, I think we should keep the !! and drop the (bool) cast if there's no particular warning about it.

Should I send a version 3 that does this?

bool was introduced in C99. Converting a non-zero value to boolean will yield true as a result. Please keep the code as-is; it's much easier to read that way.

I was quite doubtful about that given the research and conclusions from yesterday, but it seems that Linux is built for GNU 89 (not C89) which brings support for bool "as in C99", so according to what you described.

So tl;dr, I agree with you that we should just keep the code as it is now.

Cheers,

Paul

Signature · 3 lines
Paul Kocialkowski, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
#8 lore raw
In reply to Nishka Dasgupta
Quoted 19 lines · Nishka Dasgupta

Typecast as bool the return value of cedrus_find_format in cedrus_check_format as the return value of cedrus_check_format is always treated like a boolean value.

---
Changes in v2:
- Add !! to the returned pointer to ensure that the return value is always either true or false, and never a non-zero value other than true.

 drivers/staging/media/sunxi/cedrus/cedrus_video.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -0
index e2b530b1a956..b731745f21f8 100644

drivers/staging/media/sunxi/cedrus/cedrus_video.c static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions, · line 89

Quoted 5 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +1 -1
@@ -86,7 +86,7 @@ static struct cedrus_format *cedrus_find_format(u32 pixelformat, u32 directions,
 static bool cedrus_check_format(u32 pixelformat, u32 directions,
 				unsigned int capabilities)
 {
-	return cedrus_find_format(pixelformat, directions, capabilities);
+	return !!(bool)cedrus_find_format(pixelformat, directions, capabilities);

Why not write:

	return cedrus_find_format(pixelformat, directions, capabilities) != NULL;

That way coccinelle should be happy, and it is clear that cedrus_find_format returns a pointer and that we return true if it is non-NULL.

Regards,

Hans

Quoted 4 lines
drivers/staging/media/sunxi/cedrus/cedrus_video.c +0 -0
 }
 
 static void cedrus_prepare_format(struct v4l2_pix_format *pix_fmt)