From: Jeff King <peff@peff.net>
To: Stefan Beller <sbeller@google.com>
Cc: git@vger.kernel.org, git@jeffhostetler.com
Subject: Re: [PATCH 0/3] Introduce BUG_ON(cond, msg) MACRO
Date: Wed, 22 Nov 2017 18:24:57 -0500 [thread overview]
Message-ID: <20171122232457.GA8577@sigill> (raw)
In-Reply-To: <20171122223827.26773-1-sbeller@google.com>
On Wed, Nov 22, 2017 at 02:38:24PM -0800, Stefan Beller wrote:
> On reviewing [1] I wondered why there are so many asserts and wondered
> if these asserts could have been prevented by a better functionality around
> bug reporting in our code.
>
> Introduce a BUG_ON macro, which is superior to assert() by
> * being always there, even when compiled with NDEBUG and
> * providind an additional human readable error message, like BUG()
I'm not sure I agree with the aim of the series.
If people want to compile with NDEBUG, that's their business, I guess.
I don't see much _point_ in it for Git, since most of our assertions do
not respect NDEBUG, and I don't think we tend to assert in expensive
ways anyway.
I do like human readable messages. But sometimes such a message just
makes the code harder to read (and to write). E.g., is there any real
value in:
BUG_ON(!foo, "called bar() with a foo!");
over:
assert(foo);
? The error message you'd get from the latter is rather sparse, but the
file and line number information it contains should be enough to find
the original source line. And after all, it's not _supposed_ to happen,
so if it does you're likely going to need to dig into the source anyway.
The human-readable BUG messages I find useful add some context or
summarize the situation. E.g. (pulled from random grepping):
BUG: color parsing ran out of space
is way better than:
assert failed: len < 2
Likewise, in this code:
if (hashmap_put(map, alloc_ref_store_hash_entry(name, refs)))
die("BUG: %s ref_store '%s' initialized twice", type, name);
we get a lot of extra information:
- the type is mentioned
- the name variable is dereferenced
- the implication of "initialized twice" is made clear by the author,
which would not be immediately obvious just from seeing the failed
call
So I _like_ good messages, but I also think a lot of assertions don't
really lend themselves to good messages. And we should shoot for just
making them easy to read and write.
I also find (as your third patch switches):
if (!foo)
BUG("foo has not been setup");
more readable than the BUG_ON() version, if only because it uses
traditional control flow. But that may just be because I'm used to it.
I'm sure kernel folks are used to BUG_ON() at this point, and we'd grow
used to it, too.
-Peff
next prev parent reply other threads:[~2017-11-22 23:25 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-22 22:38 [PATCH 0/3] Introduce BUG_ON(cond, msg) MACRO Stefan Beller
2017-11-22 22:38 ` [PATCH 1/3] Documentation/CodingGuidelines: explain why assert is bad Stefan Beller
2017-11-22 22:59 ` Jonathan Nieder
2017-11-22 23:08 ` Stefan Beller
2017-11-22 23:54 ` Jonathan Nieder
2017-11-22 22:38 ` [PATCH 2/3] git-compat: introduce BUG_ON(condition, fmt, ...) macro Stefan Beller
2017-11-22 23:02 ` Jonathan Nieder
2017-11-22 23:37 ` Jeff King
2017-11-22 22:38 ` [PATCH 3/3] contrib/coccinelle: convert all conditional bugs to bug_on Stefan Beller
2017-11-22 23:24 ` Jeff King [this message]
2017-11-22 23:28 ` [PATCH 0/3] Introduce BUG_ON(cond, msg) MACRO Jonathan Nieder
2017-11-22 23:39 ` Jeff King
2017-11-22 23:45 ` Jonathan Nieder
2017-11-22 23:58 ` Jeff King
2017-11-23 0:08 ` Jonathan Nieder
2017-11-23 0:10 ` Jeff King
2017-11-23 1:38 ` Junio C Hamano
2017-11-23 5:00 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171122232457.GA8577@sigill \
--to=peff@peff.net \
--cc=git@jeffhostetler.com \
--cc=git@vger.kernel.org \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).