scripts/coccinelle/api/memdup_user.cocci

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /// Use memdup_user rather than duplicating its implementation
   3 /// This is a little bit restricted to reduce false positives
   4 ///
   5 // Confidence: High
   6 // Copyright: (C) 2010-2012 Nicolas Palix.
   7 // Copyright: (C) 2010-2012 Julia Lawall, INRIA/LIP6.
   8 // Copyright: (C) 2010-2012 Gilles Muller, INRIA/LiP6.
   9 // URL: http://coccinelle.lip6.fr/
  10 // Comments:
  11 // Options: --no-includes --include-headers
  12
  13 virtual patch
  14 virtual context
  15 virtual org
  16 virtual report
  17
  18 @initialize:python@
  19 @@
  20 filter = frozenset(['memdup_user', 'vmemdup_user'])
  21
  22 def relevant(p):
  23     return not (filter & {el.current_element for el in p})
  24
  25 @depends on patch@
  26 expression from,to,size;
  27 identifier l1,l2;
  28 position p : script:python() { relevant(p) };
  29 @@
  30
  31 -  to = \(kmalloc@p\|kzalloc@p\)
  32 -               (size,\(GFP_KERNEL\|GFP_USER\|
  33 -                     \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\));
  34 +  to = memdup_user(from,size);
  35    if (
  36 -      to==NULL
  37 +      IS_ERR(to)
  38                  || ...) {
  39    <+... when != goto l1;
  40 -  -ENOMEM
  41 +  PTR_ERR(to)
  42    ...+>
  43    }
  44 -  if (copy_from_user(to, from, size) != 0) {
  45 -    <+... when != goto l2;
  46 -    -EFAULT
  47 -    ...+>
  48 -  }
  49
  50 @depends on patch@
  51 expression from,to,size;
  52 identifier l1,l2;
  53 position p : script:python() { relevant(p) };
  54 @@
  55
  56 -  to = \(kvmalloc@p\|kvzalloc@p\)(size,\(GFP_KERNEL\|GFP_USER\));
  57 +  to = vmemdup_user(from,size);
  58    if (
  59 -      to==NULL
  60 +      IS_ERR(to)
  61                  || ...) {
  62    <+... when != goto l1;
  63 -  -ENOMEM
  64 +  PTR_ERR(to)
  65    ...+>
  66    }
  67 -  if (copy_from_user(to, from, size) != 0) {
  68 -    <+... when != goto l2;
  69 -    -EFAULT
  70 -    ...+>
  71 -  }
  72
  73 @r depends on !patch@
  74 expression from,to,size;
  75 position p : script:python() { relevant(p) };
  76 statement S1,S2;
  77 @@
  78
  79 *  to = \(kmalloc@p\|kzalloc@p\)
  80                 (size,\(GFP_KERNEL\|GFP_USER\|
  81                       \(GFP_KERNEL\|GFP_USER\)|__GFP_NOWARN\));
  82    if (to==NULL || ...) S1
  83    if (copy_from_user(to, from, size) != 0)
  84    S2
  85
  86 @rv depends on !patch@
  87 expression from,to,size;
  88 position p : script:python() { relevant(p) };
  89 statement S1,S2;
  90 @@
  91
  92 *  to = \(kvmalloc@p\|kvzalloc@p\)(size,\(GFP_KERNEL\|GFP_USER\));
  93    if (to==NULL || ...) S1
  94    if (copy_from_user(to, from, size) != 0)
  95    S2
  96
  97 @script:python depends on org@
  98 p << r.p;
  99 @@
 100
 101 coccilib.org.print_todo(p[0], "WARNING opportunity for memdup_user")
 102
 103 @script:python depends on report@
 104 p << r.p;
 105 @@
 106
 107 coccilib.report.print_report(p[0], "WARNING opportunity for memdup_user")
 108
 109 @script:python depends on org@
 110 p << rv.p;
 111 @@
 112
 113 coccilib.org.print_todo(p[0], "WARNING opportunity for vmemdup_user")
 114
 115 @script:python depends on report@
 116 p << rv.p;
 117 @@
 118
 119 coccilib.report.print_report(p[0], "WARNING opportunity for vmemdup_user")