scripts/coccinelle/free/clk_put.cocci

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /// Find missing clk_puts.
   3 ///
   4 //# This only signals a missing clk_put when there is a clk_put later
   5 //# in the same function.
   6 //# False positives can be due to loops.
   7 //
   8 // Confidence: Moderate
   9 // Copyright: (C) 2012 Julia Lawall, INRIA/LIP6.
  10 // Copyright: (C) 2012 Gilles Muller, INRIA/LiP6.
  11 // URL: http://coccinelle.lip6.fr/
  12 // Comments:
  13 // Options:
  14
  15 virtual context
  16 virtual org
  17 virtual report
  18
  19 @clk@
  20 expression e;
  21 statement S,S1;
  22 int ret;
  23 position p1,p2,p3;
  24 @@
  25
  26 e = clk_get@p1(...)
  27 ... when != clk_put(e)
  28 if (<+...e...+>) S
  29 ... when any
  30     when != clk_put(e)
  31     when != if (...) { ... clk_put(e); ... }
  32 (
  33  if (ret == 0) S1
  34 |
  35 if (...)
  36    { ...
  37      return 0; }
  38 |
  39 if (...)
  40    { ...
  41      return <+...e...+>; }
  42 |
  43 *if@p2 (...)
  44    { ... when != clk_put(e)
  45          when forall
  46      return@p3 ...; }
  47 )
  48 ... when any
  49 clk_put(e);
  50
  51 @script:python depends on org@
  52 p1 << clk.p1;
  53 p2 << clk.p2;
  54 p3 << clk.p3;
  55 @@
  56
  57 cocci.print_main("clk_get",p1)
  58 cocci.print_secs("if",p2)
  59 cocci.print_secs("needed clk_put",p3)
  60
  61 @script:python depends on report@
  62 p1 << clk.p1;
  63 p2 << clk.p2;
  64 p3 << clk.p3;
  65 @@
  66
  67 msg = "ERROR: missing clk_put; clk_get on line %s and execution via conditional on line %s" % (p1[0].line,p2[0].line)
  68 coccilib.report.print_report(p3[0],msg)