Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.6 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0660BC43331 for ; Tue, 31 Mar 2020 18:39:36 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id CB3E320784 for ; Tue, 31 Mar 2020 18:39:35 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="N9+Vwqqp" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org CB3E320784 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:42906 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jJLnS-0000tM-VX for qemu-devel@archiver.kernel.org; Tue, 31 Mar 2020 14:39:34 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:33284) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jJLml-00006D-CJ for qemu-devel@nongnu.org; Tue, 31 Mar 2020 14:38:52 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jJLmj-0001IA-Dq for qemu-devel@nongnu.org; Tue, 31 Mar 2020 14:38:50 -0400 Received: from us-smtp-1.mimecast.com ([205.139.110.61]:57648 helo=us-smtp-delivery-1.mimecast.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1jJLmj-0001Hf-9q for qemu-devel@nongnu.org; Tue, 31 Mar 2020 14:38:49 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1585679928; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=EX3vPLXipDi+P1LUlNwpM9J1LSW2ooF938AWMjmlGEc=; b=N9+Vwqqp6JnhWtoBUEQ1vyEMqx8VXxAE5PqgygHbkQdvgKjWUp9Vlfjo07whvdVPr8Fm+j qqoxTOu3vgBI6h/aXI0HKd6wfndM9Ff20oPwsj61j9jBFZ+CDM5omGHnlztrVprKq/qi0q jqhgqkACZhi8XTHb2+DKAhSTtxuH2B4= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-106--QqEdrohN8uSNtGTQH7ajw-1; Tue, 31 Mar 2020 14:38:44 -0400 X-MC-Unique: -QqEdrohN8uSNtGTQH7ajw-1 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id A13B4800D50; Tue, 31 Mar 2020 18:38:43 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-112-69.ams2.redhat.com [10.36.112.69]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9BD6960BE1; Tue, 31 Mar 2020 18:38:40 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 2F09911385E2; Tue, 31 Mar 2020 20:38:39 +0200 (CEST) From: Markus Armbruster To: Vladimir Sementsov-Ogievskiy Subject: Re: [PATCH 1/6] scripts/coccinelle: add error-use-after-free.cocci References: <20200324153630.11882-1-vsementsov@virtuozzo.com> <20200324153630.11882-2-vsementsov@virtuozzo.com> <87bloc3nmr.fsf@dusky.pond.sub.org> <767ea74a-5964-ce3c-a6c1-b9bebaf4c930@virtuozzo.com> <874ku4wtsd.fsf@dusky.pond.sub.org> Date: Tue, 31 Mar 2020 20:38:39 +0200 In-Reply-To: (Vladimir Sementsov-Ogievskiy's message of "Tue, 31 Mar 2020 16:49:21 +0300") Message-ID: <871rp8s72o.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 205.139.110.61 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: kwolf@redhat.com, zhang.zhanghailiang@huawei.com, qemu-block@nongnu.org, quintela@redhat.com, dgilbert@redhat.com, qemu-devel@nongnu.org, marcandre.lureau@redhat.com, den@openvz.org, mreitz@redhat.com, jsnow@redhat.com, mdroth@linux.vnet.ibm.com Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Vladimir Sementsov-Ogievskiy writes: > 31.03.2020 16:14, Markus Armbruster wrote: >> Vladimir Sementsov-Ogievskiy writes: >> >>> 31.03.2020 12:00, Markus Armbruster wrote: >>>> Vladimir Sementsov-Ogievskiy writes: >>>> >>>>> Add script to find and fix trivial use-after-free of Error objects. >>>>> How to use: >>>>> spatch --sp-file scripts/coccinelle/auto-propagated-errp.cocci \ >>>>> --macro-file scripts/cocci-macro-file.h --in-place \ >>>>> --no-show-diff ( FILES... | --use-gitgrep . ) >>>> >>>> Pasto: you mean scripts/coccinelle/error-use-after-free.cocci. >>>> >>>> --use-gitgrep is just one of several methods. Any particular reason f= or >>>> recommending it over the others? >>> >>> :) >>> >>> In my occasional coccinelle learning, every new bit of information wand= ers me, and I think "wow! it's tricky/weird/cool (underline whatever applic= able), I should note it somewhere". >>> >>> So, no particular reasons. It's just good thing too use. >>> >>>> >>>>> >>>>> Signed-off-by: Vladimir Sementsov-Ogievskiy >>>>> --- >>>>> scripts/coccinelle/error-use-after-free.cocci | 52 +++++++++++++++= ++++ >>>>> MAINTAINERS | 1 + >>>>> 2 files changed, 53 insertions(+) >>>>> create mode 100644 scripts/coccinelle/error-use-after-free.cocci >>>>> >>>>> diff --git a/scripts/coccinelle/error-use-after-free.cocci b/scripts/= coccinelle/error-use-after-free.cocci >>>>> new file mode 100644 >>>>> index 0000000000..7cfa42355b >>>>> --- /dev/null >>>>> +++ b/scripts/coccinelle/error-use-after-free.cocci >>>>> @@ -0,0 +1,52 @@ >>>>> +// Find and fix trivial use-after-free of Error objects >>>>> +// >>>>> +// Copyright (c) 2020 Virtuozzo International GmbH. >>>>> +// >>>>> +// This program is free software; you can redistribute it and/or >>>>> +// modify it under the terms of the GNU General Public License as >>>>> +// published by the Free Software Foundation; either version 2 of th= e >>>>> +// License, or (at your option) any later version. >>>>> +// >>>>> +// This program is distributed in the hope that it will be useful, >>>>> +// but WITHOUT ANY WARRANTY; without even the implied warranty of >>>>> +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the >>>>> +// GNU General Public License for more details. >>>>> +// >>>>> +// You should have received a copy of the GNU General Public License >>>>> +// along with this program. If not, see >>>>> +// . >>>>> +// >>>>> +// How to use: >>>>> +// spatch --sp-file scripts/coccinelle/auto-propagated-errp.cocci \ >>>>> +// --macro-file scripts/cocci-macro-file.h --in-place \ >>>>> +// --no-show-diff ( FILES... | --use-gitgrep . ) >>>> >>>> Same pasto. >>>> >>>> I doubt including basic spatch instructions with every script is a goo= d >>>> idea. Better explain it in one place, with proper maintenance. >>>> scripts/coccinelle/README? We could be a bit more verbose there, >>>> e.g. to clarify required vs. suggested options. >>> >>> Agree, good idea. >> >> I'd like to get your fixes into -rc1, due today. Possible ways to get >> there: >> >> * You respin with such a README. >> >> * We take the script as is, and move basic spatch instructions to a >> README at our leisure. Less stressful, slightly more churn, and we >> need to remember to actually do it. >> >> I favor the latter. You? > > Me too. > >> >>>>> + >>>>> +@ exists@ >>>>> +identifier fn, fn2; >>>>> +expression err; >>>>> +@@ >>>>> + >>>>> + fn(...) >>>>> + { >>>>> + <... >>>>> +( >>>>> + error_free(err); >>>>> ++ err =3D NULL; >>>>> +| >>>>> + error_report_err(err); >>>>> ++ err =3D NULL; >>>>> +| >>>>> + error_reportf_err(err, ...); >>>>> ++ err =3D NULL; >>>>> +| >>>>> + warn_report_err(err); >>>>> ++ err =3D NULL; >>>>> +| >>>>> + warn_reportf_err(err, ...); >>>>> ++ err =3D NULL; >>>>> +) >>>>> + ... when !=3D err =3D NULL >>>>> + when !=3D exit(...) >>>>> + fn2(..., err, ...) >>>>> + ...> >>>>> + } >>>> >>>> This inserts err =3D NULL after error_free() if there is a path to a >>>> certain kind of use of @err without such an assignment. >>>> >>>> The "when !=3D exit()" part excludes certain "phony" paths. It's not = a >>>> tight check; there are other ways to unconditionally terminate the >>>> process or jump elsewhere behind Coccinelle's back. Not a problem, th= e >>>> script is meant to have its output reviewed manually. >>>> >>>> Should we mention the need to review the script's output? >>> >>> I think it's default thing to do. >> >> True. I just wonder whether we wan to document the difference (assuming >> it exists) between "the output of this script is expected to be good >> (but do review it anyway)" and "this script makes suggestions for you to >> review". Different levels of confidence in the script, basically. >> >>>>> diff --git a/MAINTAINERS b/MAINTAINERS >>>>> index b5c86ec494..ba97cc43fc 100644 >>>>> --- a/MAINTAINERS >>>>> +++ b/MAINTAINERS >>>>> @@ -2037,6 +2037,7 @@ F: include/qemu/error-report.h >>>>> F: qapi/error.json >>>>> F: util/error.c >>>>> F: util/qemu-error.c >>>>> +F: scripts/coccinelle/*err*.cocci >>>> >>>> Silently captures existing scripts in addition to this new one. >>>> Tolerable. The globbing looks rather brittle, though. >>> >>> hmm, may be better to rename them all to "error-*.cocci" >> >> Would permit reasonably robust globbing. Fine with me, but requires a >> respin. >> >> I'm also fine with enumerating the scripts here one by one. That I coul= d do >> myself without a respin. > > no objections For the record, with the globbing replaced, and the pastos fixed: Reviewed-by: Markus Armbruster