diff mbox series

zstd: Fix definition of assert()

Message ID 20230129131436.1343228-1-j.neuschaefer@gmx.net
State New
Headers
Series zstd: Fix definition of assert() |

Commit Message

Jonathan Neuschäfer Jan. 29, 2023, 1:14 p.m. UTC 
  assert(x) should emit a warning if x is false. WARN_ON(x) emits a
warning if x is true. Thus, assert(x) should be defined as WARN_ON(!x)
rather than WARN_ON(x).

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

Commit e0c1b49f5b674 ("lib: zstd: Upgrade to latest upstream zstd
version 1.4.10") mentions that the zstd code was generated from the
upstream version of zstd, so perhaps the definition of assert based on
WARN_ON should be fixed in the conversion script and/or upstream zstd
source code.

---
 lib/zstd/common/zstd_deps.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.39.0

Comments

Nick Terrell March 3, 2023, 6:30 a.m. UTC | #1 
> On Jan 29, 2023, at 5:14 AM, Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> 
> !-------------------------------------------------------------------|
>  This Message Is From an External Sender
> 
> |-------------------------------------------------------------------!
> 
> assert(x) should emit a warning if x is false. WARN_ON(x) emits a
> warning if x is true. Thus, assert(x) should be defined as WARN_ON(!x)
> rather than WARN_ON(x).
> 
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>

Hi Jonathan,

I have to apologize, I just submitted my branch for a PR and I realize that
while I intended to take your patch, I took a different equivalent patch. So
I wanted to say thanks for sending the patch!

> ---
> 
> Commit e0c1b49f5b674 ("lib: zstd: Upgrade to latest upstream zstd
> version 1.4.10") mentions that the zstd code was generated from the
> upstream version of zstd, so perhaps the definition of assert based on
> WARN_ON should be fixed in the conversion script and/or upstream zstd
> source code.

Yeah, we need to fix it upstream, so if you would like to submit the upstream PR
the file is contrib/linux-kernel/zstd_deps.h [0]. Otherwise, I will update it before
the next import.

Best,
Nick Terrell

[0] https://github.com/facebook/zstd/blob/dev/contrib/linux-kernel/zstd_deps.h

> ---
> lib/zstd/common/zstd_deps.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/zstd/common/zstd_deps.h b/lib/zstd/common/zstd_deps.h
> index 7a5bf44839c9c..f06df065dec01 100644
> --- a/lib/zstd/common/zstd_deps.h
> +++ b/lib/zstd/common/zstd_deps.h
> @@ -84,7 +84,7 @@ static uint64_t ZSTD_div64(uint64_t dividend, uint32_t divisor) {
> 
> #include <linux/kernel.h>
> 
> -#define assert(x) WARN_ON((x))
> +#define assert(x) WARN_ON(!(x))
> 
> #endif /* ZSTD_DEPS_ASSERT */
> #endif /* ZSTD_DEPS_NEED_ASSERT */
> --
> 2.39.0
>
Jonathan Neuschäfer March 3, 2023, 2:27 p.m. UTC | #2 
On Fri, Mar 03, 2023 at 06:30:47AM +0000, Nick Terrell wrote:
> On Jan 29, 2023, at 5:14 AM, Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> > 
> > assert(x) should emit a warning if x is false. WARN_ON(x) emits a
> > warning if x is true. Thus, assert(x) should be defined as WARN_ON(!x)
> > rather than WARN_ON(x).
> > 
> > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> 
> Hi Jonathan,
> 
> I have to apologize, I just submitted my branch for a PR and I realize that
> while I intended to take your patch, I took a different equivalent patch. So
> I wanted to say thanks for sending the patch!

No problem at all, and thanks for informing me!

> 
> > ---
> > 
> > Commit e0c1b49f5b674 ("lib: zstd: Upgrade to latest upstream zstd
> > version 1.4.10") mentions that the zstd code was generated from the
> > upstream version of zstd, so perhaps the definition of assert based on
> > WARN_ON should be fixed in the conversion script and/or upstream zstd
> > source code.
> 
> Yeah, we need to fix it upstream, so if you would like to submit the upstream PR
> the file is contrib/linux-kernel/zstd_deps.h [0]. Otherwise, I will update it before
> the next import.

Feel free to do it yourself, as I haven't been involed with zstd
developement so far.


Thanks,
Jonathan
diff mbox series

Patch

diff --git a/lib/zstd/common/zstd_deps.h b/lib/zstd/common/zstd_deps.h
index 7a5bf44839c9c..f06df065dec01 100644
--- a/lib/zstd/common/zstd_deps.h
+++ b/lib/zstd/common/zstd_deps.h
@@ -84,7 +84,7 @@  static uint64_t ZSTD_div64(uint64_t dividend, uint32_t divisor) {

 #include <linux/kernel.h>

-#define assert(x) WARN_ON((x))
+#define assert(x) WARN_ON(!(x))

 #endif /* ZSTD_DEPS_ASSERT */
 #endif /* ZSTD_DEPS_NEED_ASSERT */