Re: [PATCH] CodingStyle: add some more error handling guidelines

Dan Carpenter
2016-08-23T11:59:08Z

On Tue, Aug 23, 2016 at 01:03:15PM +0200, Bjørn Mork wrote:
> "Michael S. Tsirkin" <mst@redhat.com> writes:
>
> > foo = kmalloc(SIZE, GFP_KERNEL);
> > if (!foo)
> > goto err_foo;
> >
> > foo->bar = kmalloc(SIZE, GFP_KERNEL);
> > if (!foo->bar)
> > goto err_bar;
> > ...
> >
> > kfree(foo->bar);
> > err_bar:
> >
> > kfree(foo);
> > err_foo:
> >
> > return ret;
>
>
> I believe the CodingStyle already contain far too much personal style to
> be useful as real style guide. FWIW, I prefer a single error label, at
> the "cost" of additional tests in the error path:
>
>
> foo = kmalloc(SIZE, GFP_KERNEL);
> if (!foo)
> goto err;
> foo->bar = kmalloc(SIZE, GFP_KERNEL);
> if (!foo->bar)
> goto err;
> ...
> if (ret)
> goto err;
> return 0;
> err:
> if (foo)
> kfree(foo->bar);
> kfree(foo);
> return ret;
>
>
> The advantage is that I don't have to manage X different labels,
> ensuring that they have the order is correct if some part of the
> function is refactored etc. That tends to get too complicated for my
> simple brain. And since the error path is rarely tested, complicated
> equals buggy.

Empirically, that style is *way* more bug prone. I call these bugs "One
Err Bugs". It's one of the most common types of bugs I deal with from
static analysis.

The order is not hard. It's just the reverse order from how it was
allocated. Hike up the mountain, then if you get stuck hike back down
using the exact same path. Then at the end, you basically have written
your ->remove() function so it's a bonus.

>
> My sample will of course trigger all those nice "optimizing the error
> path" patches, but I ignore those anyway so that's not a big deal.

That's not my fault. :/ I have tried over and over and over to tell
that guy to stop sending patches but everyone else encourages him. I
feel like it should be a rule that if you introduce bugs, you should be
told to stop sending cleanup patches until you have fixed enough bugs to
redeem yourself.

regards,
dan carpenter