Received: by 2002:a05:6a10:6744:0:0:0:0 with SMTP id w4csp4136710pxu; Mon, 12 Oct 2020 10:22:33 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwIYv4o2RRwMve4JtKBhDT9r7k3Yfmb1woZ9L2HErGOgS33qUDdLz7Og41coa1VIt+wqRSV X-Received: by 2002:a17:907:20e6:: with SMTP id rh6mr28339640ejb.169.1602523353407; Mon, 12 Oct 2020 10:22:33 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1602523353; cv=none; d=google.com; s=arc-20160816; b=sIYIFaM/u1mHkMdoIx+VmlH2QtNWC409Hs+FB8rBq7JlbASD7dckcos77N4NowWkgA NyjA6pdPe2KqWkKitcVK1JFe7hiw9aiiDP+JhaKi79FRexkNcRoir2g9E0l3w6nkbTmQ 83JeELBHz+ZFA1noMWKWC8Gp5PHLgM8JOVDT7sFI5bibXr8xZMpI5SNJ7T+yo56BDEtd mxN2RPPe6KVheb9e5O4Bb7qcaQSMv3BhBFNSV9ReiSNudxreFEPHY9xjY6JEYGQjfA6N m+V+XU5m5wOIqKlFi7brZjJLIqQYc0EuNkLRHejdUU+oDEBytHYoOMdeLbA4EF0e3jA2 SKPw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-disposition:mime-version:message-id :subject:cc:to:from:date:dkim-signature; bh=vzqIrfL5tQGfCDq/e194NCPT321X2oYruUrL6Phu1Gc=; b=juYk49q4CKgtjBvfyHsR0BpFLCzkqHvyGunGQyi739Xk6RJaUaCeWJvUUxmHOwuX9p nPT8kuf7uEZfR+0k7WvopfjcR12z3pj7Fl405DjEmNQKbP0iwBiXOjnZL2L/iTHuho8z xeoPOpZO/K4PLWpG0WEizMwfFUv11nymQf0BC+921o8HLNhVcVPVnysZChSBsTDZI1Po 3Ac8dKsNQSTPY3zE1l1+HqgbUPQ2PFyZ0KyA/DmUSointdVJgjiDiql/1BUiCPFw05q/ POOT2PDnXx/EXy112h6hBRNFMTVGLgWGOCBpDdk+sjvyZrLcCseo+7Fizlj0yjhGvFrc Ye2w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=uXeZybEO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id t20si12924306eds.136.2020.10.12.10.22.10; Mon, 12 Oct 2020 10:22:33 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=uXeZybEO; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2404112AbgJLRTR (ORCPT + 99 others); Mon, 12 Oct 2020 13:19:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36808 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2404045AbgJLRTQ (ORCPT ); Mon, 12 Oct 2020 13:19:16 -0400 Received: from mail-pg1-x543.google.com (mail-pg1-x543.google.com [IPv6:2607:f8b0:4864:20::543]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1CD43C0613D0 for ; Mon, 12 Oct 2020 10:19:15 -0700 (PDT) Received: by mail-pg1-x543.google.com with SMTP id b193so14055301pga.6 for ; Mon, 12 Oct 2020 10:19:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:mime-version:content-disposition; bh=vzqIrfL5tQGfCDq/e194NCPT321X2oYruUrL6Phu1Gc=; b=uXeZybEO9E4gStg0B9aDvmKZL0+BvJDAfXXYFXSSuzJ+S+CAUgg+WLDNaoz3Rqa4EO gnfxIEzG5gb7eSaQVP72VamEhXeW21if6zPP1y87EnVtPLlqX1R6nXid2pbuXVQctc06 WJst6BrMrG1puAKCwmZPPaAvwviByQLvSqipYMdSYAIfOa5VDh3hM1/2bqBsxTAG9j7v e3AbQcGwzQlA2+i0KX07YPvFfMZUbCkSam/AEVWqFHi+D05RVWaIdwHvySG72C67B8oQ ggCTi0zbQdbxzigeIv7KoJJ5vPsu5bxQK+MmJELYzVdYJeAO6GVdnmav4bBGiGcHtN+v 7cEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:mime-version :content-disposition; bh=vzqIrfL5tQGfCDq/e194NCPT321X2oYruUrL6Phu1Gc=; b=clcctjSOGFAvQmMl7P7xVgEo/mi45vcTkKn5B7ThseCQGrziIt25Z9BN8TECI3HofS eMrnBVuY/dO7t12yCxsto8+zv+FOBQtab0hDpyspQfX9hoSro4Ifu7mHzWHcokuB3VGl Y+1qhnoDI8mvul8s7UbpLM+Tqn1OU9ziaiT7C2KWMfRoDZ/orcdPsmSPM0tFFSKZkxqc 86HV2OnPpm9226B1uBCBN8BMbr1ANqe/2i+Oico3LetQ6UZTzb8g4pVMnX9TJoKc2mD6 UP41pNAzuAwZoCY8vQm863RAvEqSdRNDWUBJAWmky+GoxCeQjmyf+psrzgSiA+CAt3nH m4GQ== X-Gm-Message-State: AOAM533XI5XeH8ESZSi3Hhw9j4yLUMinpkmt0fYESSeKhG8LpenEwga/ vtz2dnzMi8sVfW54Z4PcI6VBUlCI/M/pcQ== X-Received: by 2002:a17:90a:6582:: with SMTP id k2mr21123691pjj.139.1602523154510; Mon, 12 Oct 2020 10:19:14 -0700 (PDT) Received: from adolin ([49.207.194.162]) by smtp.gmail.com with ESMTPSA id t9sm20219051pgp.90.2020.10.12.10.19.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Oct 2020 10:19:13 -0700 (PDT) Date: Mon, 12 Oct 2020 22:49:09 +0530 From: Sumera Priyadarsini To: cocci@systeme.lip6.fr Cc: Julia.Lawall@lip6.fr, Gilles.Muller@lip6.fr, nicolas.palix@imag.fr, linux-kernel@vger.kernel.org, michal.lkml@markovi.net Subject: [PATCH V2] [Cocci] coccinelle: iterators: Add for_each_child.cocci script Message-ID: <20201012171909.ihbx73evyj5dosxl@adolin> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org While iterating over child nodes with the for_each functions, if control is transferred from the middle of the loop, as in the case of a break or return or goto, there is no decrement in the reference counter thus ultimately resulting in a memory leak. Add this script to detect potential memory leaks caused by the absence of of_node_put() before break, goto, or, return statements which transfer control outside the loop. Signed-off-by: Sumera Priyadarsini ---- Changes in V2: - Add options --include-headers and --no-includes - Add 'when forall` to rules for break and goto --- .../coccinelle/iterators/for_each_child.cocci | 355 ++++++++++++++++++ 1 file changed, 355 insertions(+) create mode 100644 scripts/coccinelle/iterators/for_each_child.cocci diff --git a/scripts/coccinelle/iterators/for_each_child.cocci b/scripts/coccinelle/iterators/for_each_child.cocci new file mode 100644 index 000000000000..57caf9b8d7a5 --- /dev/null +++ b/scripts/coccinelle/iterators/for_each_child.cocci @@ -0,0 +1,355 @@ +// SPDX-License-Identifier: GPL-2.0-only +// Adds missing of_node_put() before return/break/goto statement within a for_each iterator for child nodes. +//# False positives can be due to function calls within the for_each +//# loop that may encapsulate an of_node_put. +/// +// Confidence: High +// Copyright: (C) 2020 Sumera Priyadarsini +// URL: http://coccinelle.lip6.fr +// Options: --no-includes --include-headers + +virtual patch +virtual context +virtual org +virtual report + +@r@ +local idexpression n; +expression e1,e2; +iterator name for_each_node_by_name, for_each_node_by_type, +for_each_compatible_node, for_each_matching_node, +for_each_matching_node_and_match, for_each_child_of_node, +for_each_available_child_of_node, for_each_node_with_property; +iterator i; +statement S; +expression list [n1] es; +@@ + +( +( +for_each_node_by_name(n,e1) S +| +for_each_node_by_type(n,e1) S +| +for_each_compatible_node(n,e1,e2) S +| +for_each_matching_node(n,e1) S +| +for_each_matching_node_and_match(n,e1,e2) S +| +for_each_child_of_node(e1,n) S +| +for_each_available_child_of_node(e1,n) S +| +for_each_node_with_property(n,e1) S +) +& +i(es,n,...) S +) + +@ruleone depends on patch && !context && !org && !report@ + +local idexpression r.n; +iterator r.i,i1; +expression e; +expression list [r.n1] es; +statement S; +@@ + + i(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + return n; +| + i1(...,n,...) S +| ++ of_node_put(n); +? return ...; +) + ... when any + } + +@ruletwo depends on patch && !context && !org && !report@ + +local idexpression r.n; +iterator r.i,i1,i2; +expression e,e1; +expression list [r.n1] es; +statement S,S2; +@@ + + i(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + i1(...,n,...) S +| ++ of_node_put(n); +? break; +) + ... when any + } +... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +@rulethree depends on patch && !context && !org && !report exists@ + +local idexpression r.n; +iterator r.i,i1,i2; +expression e,e1; +identifier l; +expression list [r.n1] es; +statement S,S2; +@@ + + i(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + i1(...,n,...) S +| ++ of_node_put(n); +? goto l; +) + ... when any + } +... when exists +l: ... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +// ---------------------------------------------------------------------------- + +@ruleone_context depends on !patch && (context || org || report) exists@ +statement S; +expression e; +expression list[r.n1] es; +iterator r.i, i1; +local idexpression r.n; +position j0, j1; +@@ + + i@j0(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + return n; +| + i1(...,n,...) S +| + return @j1 ...; +) + ... when any + } + +@ruleone_disj depends on !patch && (context || org || report)@ +expression list[r.n1] es; +iterator r.i; +local idexpression r.n; +position ruleone_context.j0, ruleone_context.j1; +@@ + +* i@j0(es,n,...) { + ... +*return @j1...; + ... when any + } + +@ruletwo_context depends on !patch && (context || org || report) exists@ +statement S, S2; +expression e, e1; +expression list[r.n1] es; +iterator r.i, i1, i2; +local idexpression r.n; +position j0, j2; +@@ + + i@j0(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + i1(...,n,...) S +| + break@j2; +) + ... when any + } +... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +@ruletwo_disj depends on !patch && (context || org || report)@ +statement S2; +expression e1; +expression list[r.n1] es; +iterator r.i, i2; +local idexpression r.n; +position ruletwo_context.j0, ruletwo_context.j2; +@@ + +* i@j0(es,n,...) { + ... +*break @j2; + ... when any + } +... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +@rulethree_context depends on !patch && (context || org || report) exists@ +identifier l; +statement S,S2; +expression e, e1; +expression list[r.n1] es; +iterator r.i, i1, i2; +local idexpression r.n; +position j0, j3; +@@ + + i@j0(es,n,...) { + ... +( + of_node_put(n); +| + e = n +| + i1(...,n,...) S +| + goto l@j3; +) + ... when any + } +... when exists +l: +... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +@rulethree_disj depends on !patch && (context || org || report) exists@ +identifier l; +statement S2; +expression e1; +expression list[r.n1] es; +iterator r.i, i2; +local idexpression r.n; +position rulethree_context.j0, rulethree_context.j3; +@@ + +* i@j0(es,n,...) { + ... +*goto l@j3; + ... when any + } +... when exists + l: + ... when != n + when strict + when forall +( + n = e1; +| +?i2(...,n,...) S2 +) + +// ---------------------------------------------------------------------------- + +@script:python ruleone_org depends on org@ +i << r.i; +j0 << ruleone_context.j0; +j1 << ruleone_context. j1; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before return " % (i) +coccilib.org.print_safe_todo(j0[0], msg) +coccilib.org.print_link(j1[0], "") + +@script:python ruletwo_org depends on org@ +i << r.i; +j0 << ruletwo_context.j0; +j2 << ruletwo_context.j2; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before break " % (i) +coccilib.org.print_safe_todo(j0[0], msg) +coccilib.org.print_link(j2[0], "") + +@script:python rulethree_org depends on org@ +i << r.i; +j0 << rulethree_context.j0; +j3 << rulethree_context.j3; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before goto " % (i) +coccilib.org.print_safe_todo(j0[0], msg) +coccilib.org.print_link(j3[0], "") + +// ---------------------------------------------------------------------------- + +@script:python ruleone_report depends on report@ +i << r.i; +j0 << ruleone_context.j0; +j1 << ruleone_context.j1; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before return around line %s." % (i, j1[0].line) +coccilib.report.print_report(j0[0], msg) + +@script:python ruletwo_report depends on report@ +i << r.i; +j0 << ruletwo_context.j0; +j2 << ruletwo_context.j2; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before break around line %s." % (i,j2[0].line) +coccilib.report.print_report(j0[0], msg) + +@script:python rulethree_report depends on report@ +i << r.i; +j0 << rulethree_context.j0; +j3 << rulethree_context.j3; +@@ + +msg = "WARNING: Function \"%s\" should have of_node_put() before goto around lines %s." % (i,j3[0].line) +coccilib.report.print_report(j0[0], msg) -- 2.25.1