scripts/coccinelle/api/alloc/zalloc-simple.cocci

   1 ///
   2 /// Use zeroing allocator rather than allocator followed by memset with 0
   3 ///
   4 /// This considers some simple cases that are common and easy to validate
   5 /// Note in particular that there are no ...s in the rule, so all of the
   6 /// matched code has to be contiguous
   7 ///
   8 // Confidence: High
   9 // Copyright: (C) 2009-2010 Julia Lawall, Nicolas Palix, DIKU.  GPLv2.
  10 // Copyright: (C) 2009-2010 Gilles Muller, INRIA/LiP6.  GPLv2.
  11 // Copyright: (C) 2017 Himanshu Jha GPLv2.
  12 // URL: http://coccinelle.lip6.fr/rules/kzalloc.html
  13 // Options: --no-includes --include-headers
  14 //
  15 // Keywords: kmalloc, kzalloc
  16 // Version min: < 2.6.12 kmalloc
  17 // Version min:   2.6.14 kzalloc
  18 //
  19
  20 virtual context
  21 virtual patch
  22 virtual org
  23 virtual report
  24
  25 //----------------------------------------------------------
  26 //  For context mode
  27 //----------------------------------------------------------
  28
  29 @depends on context@
  30 type T, T2;
  31 expression x;
  32 expression E1;
  33 statement S;
  34 @@
  35
  36 * x = (T)\(kmalloc(E1, ...)\|vmalloc(E1)\|dma_alloc_coherent(...,E1,...)\|
  37   kmalloc_node(E1, ...)\|kmem_cache_alloc(...)\|kmem_alloc(E1, ...)\|
  38   devm_kmalloc(...,E1,...)\|kvmalloc(E1, ...)\|pci_alloc_consistent(...,E1,...)\|
  39   kvmalloc_node(E1,...)\);
  40   if ((x==NULL) || ...) S
  41 * memset((T2)x,0,E1);
  42
  43 //----------------------------------------------------------
  44 //  For patch mode
  45 //----------------------------------------------------------
  46
  47 @depends on patch@
  48 type T, T2;
  49 expression x;
  50 expression E1,E2,E3,E4;
  51 statement S;
  52 @@
  53
  54 (
  55 - x = kmalloc(E1,E2);
  56 + x = kzalloc(E1,E2);
  57 |
  58 - x = (T *)kmalloc(E1,E2);
  59 + x = kzalloc(E1,E2);
  60 |
  61 - x = (T)kmalloc(E1,E2);
  62 + x = (T)kzalloc(E1,E2);
  63 |
  64 - x = vmalloc(E1);
  65 + x = vzalloc(E1);
  66 |
  67 - x = (T *)vmalloc(E1);
  68 + x = vzalloc(E1);
  69 |
  70 - x = (T)vmalloc(E1);
  71 + x = (T)vzalloc(E1);
  72 |
  73 - x = dma_alloc_coherent(E2,E1,E3,E4);
  74 + x = dma_zalloc_coherent(E2,E1,E3,E4);
  75 |
  76 - x = (T *)dma_alloc_coherent(E2,E1,E3,E4);
  77 + x = dma_zalloc_coherent(E2,E1,E3,E4);
  78 |
  79 - x = (T)dma_alloc_coherent(E2,E1,E3,E4);
  80 + x = (T)dma_zalloc_coherent(E2,E1,E3,E4);
  81 |
  82 - x = kmalloc_node(E1,E2,E3);
  83 + x = kzalloc_node(E1,E2,E3);
  84 |
  85 - x = (T *)kmalloc_node(E1,E2,E3);
  86 + x = kzalloc_node(E1,E2,E3);
  87 |
  88 - x = (T)kmalloc_node(E1,E2,E3);
  89 + x = (T)kzalloc_node(E1,E2,E3);
  90 |
  91 - x = kmem_cache_alloc(E3,E4);
  92 + x = kmem_cache_zalloc(E3,E4);
  93 |
  94 - x = (T *)kmem_cache_alloc(E3,E4);
  95 + x = kmem_cache_zalloc(E3,E4);
  96 |
  97 - x = (T)kmem_cache_alloc(E3,E4);
  98 + x = (T)kmem_cache_zalloc(E3,E4);
  99 |
 100 - x = kmem_alloc(E1,E2);
 101 + x = kmem_zalloc(E1,E2);
 102 |
 103 - x = (T *)kmem_alloc(E1,E2);
 104 + x = kmem_zalloc(E1,E2);
 105 |
 106 - x = (T)kmem_alloc(E1,E2);
 107 + x = (T)kmem_zalloc(E1,E2);
 108 |
 109 - x = devm_kmalloc(E2,E1,E3);
 110 + x = devm_kzalloc(E2,E1,E3);
 111 |
 112 - x = (T *)devm_kmalloc(E2,E1,E3);
 113 + x = devm_kzalloc(E2,E1,E3);
 114 |
 115 - x = (T)devm_kmalloc(E2,E1,E3);
 116 + x = (T)devm_kzalloc(E2,E1,E3);
 117 |
 118 - x = kvmalloc(E1,E2);
 119 + x = kvzalloc(E1,E2);
 120 |
 121 - x = (T *)kvmalloc(E1,E2);
 122 + x = kvzalloc(E1,E2);
 123 |
 124 - x = (T)kvmalloc(E1,E2);
 125 + x = (T)kvzalloc(E1,E2);
 126 |
 127 - x = pci_alloc_consistent(E2,E1,E3);
 128 + x = pci_zalloc_consistent(E2,E1,E3);
 129 |
 130 - x = (T *)pci_alloc_consistent(E2,E1,E3);
 131 + x = pci_zalloc_consistent(E2,E1,E3);
 132 |
 133 - x = (T)pci_alloc_consistent(E2,E1,E3);
 134 + x = (T)pci_zalloc_consistent(E2,E1,E3);
 135 |
 136 - x = kvmalloc_node(E1,E2,E3);
 137 + x = kvzalloc_node(E1,E2,E3);
 138 |
 139 - x = (T *)kvmalloc_node(E1,E2,E3);
 140 + x = kvzalloc_node(E1,E2,E3);
 141 |
 142 - x = (T)kvmalloc_node(E1,E2,E3);
 143 + x = (T)kvzalloc_node(E1,E2,E3);
 144 )
 145   if ((x==NULL) || ...) S
 146 - memset((T2)x,0,E1);
 147
 148 //----------------------------------------------------------
 149 //  For org mode
 150 //----------------------------------------------------------
 151
 152 @r depends on org || report@
 153 type T, T2;
 154 expression x;
 155 expression E1,E2;
 156 statement S;
 157 position p;
 158 @@
 159
 160  x = (T)kmalloc@p(E1,E2);
 161  if ((x==NULL) || ...) S
 162  memset((T2)x,0,E1);
 163
 164 @script:python depends on org@
 165 p << r.p;
 166 x << r.x;
 167 @@
 168
 169 msg="%s" % (x)
 170 msg_safe=msg.replace("[","@(").replace("]",")")
 171 coccilib.org.print_todo(p[0], msg_safe)
 172
 173 @script:python depends on report@
 174 p << r.p;
 175 x << r.x;
 176 @@
 177
 178 msg="WARNING: kzalloc should be used for %s, instead of kmalloc/memset" % (x)
 179 coccilib.report.print_report(p[0], msg)
 180
 181 //-----------------------------------------------------------------
 182 @r1 depends on org || report@
 183 type T, T2;
 184 expression x;
 185 expression E1;
 186 statement S;
 187 position p;
 188 @@
 189
 190  x = (T)vmalloc@p(E1);
 191  if ((x==NULL) || ...) S
 192  memset((T2)x,0,E1);
 193
 194 @script:python depends on org@
 195 p << r1.p;
 196 x << r1.x;
 197 @@
 198
 199 msg="%s" % (x)
 200 msg_safe=msg.replace("[","@(").replace("]",")")
 201 coccilib.org.print_todo(p[0], msg_safe)
 202
 203 @script:python depends on report@
 204 p << r1.p;
 205 x << r1.x;
 206 @@
 207
 208 msg="WARNING: vzalloc should be used for %s, instead of vmalloc/memset" % (x)
 209 coccilib.report.print_report(p[0], msg)
 210
 211 //-----------------------------------------------------------------
 212 @r2 depends on org || report@
 213 type T, T2;
 214 expression x;
 215 expression E1,E2,E3,E4;
 216 statement S;
 217 position p;
 218 @@
 219
 220  x = (T)dma_alloc_coherent@p(E2,E1,E3,E4);
 221  if ((x==NULL) || ...) S
 222  memset((T2)x,0,E1);
 223
 224 @script:python depends on org@
 225 p << r2.p;
 226 x << r2.x;
 227 @@
 228
 229 msg="%s" % (x)
 230 msg_safe=msg.replace("[","@(").replace("]",")")
 231 coccilib.org.print_todo(p[0], msg_safe)
 232
 233 @script:python depends on report@
 234 p << r2.p;
 235 x << r2.x;
 236 @@
 237
 238 msg="WARNING: dma_zalloc_coherent should be used for %s, instead of dma_alloc_coherent/memset" % (x)
 239 coccilib.report.print_report(p[0], msg)
 240
 241 //-----------------------------------------------------------------
 242 @r3 depends on org || report@
 243 type T, T2;
 244 expression x;
 245 expression E1,E2,E3;
 246 statement S;
 247 position p;
 248 @@
 249
 250  x = (T)kmalloc_node@p(E1,E2,E3);
 251  if ((x==NULL) || ...) S
 252  memset((T2)x,0,E1);
 253
 254 @script:python depends on org@
 255 p << r3.p;
 256 x << r3.x;
 257 @@
 258
 259 msg="%s" % (x)
 260 msg_safe=msg.replace("[","@(").replace("]",")")
 261 coccilib.org.print_todo(p[0], msg_safe)
 262
 263 @script:python depends on report@
 264 p << r3.p;
 265 x << r3.x;
 266 @@
 267
 268 msg="WARNING: kzalloc_node should be used for %s, instead of kmalloc_node/memset" % (x)
 269 coccilib.report.print_report(p[0], msg)
 270
 271 //-----------------------------------------------------------------
 272 @r4 depends on org || report@
 273 type T, T2;
 274 expression x;
 275 expression E1,E2,E3;
 276 statement S;
 277 position p;
 278 @@
 279
 280  x = (T)kmem_cache_alloc@p(E2,E3);
 281  if ((x==NULL) || ...) S
 282  memset((T2)x,0,E1);
 283
 284 @script:python depends on org@
 285 p << r4.p;
 286 x << r4.x;
 287 @@
 288
 289 msg="%s" % (x)
 290 msg_safe=msg.replace("[","@(").replace("]",")")
 291 coccilib.org.print_todo(p[0], msg_safe)
 292
 293 @script:python depends on report@
 294 p << r4.p;
 295 x << r4.x;
 296 @@
 297
 298 msg="WARNING: kmem_cache_zalloc should be used for %s, instead of kmem_cache_alloc/memset" % (x)
 299 coccilib.report.print_report(p[0], msg)
 300
 301 //-----------------------------------------------------------------
 302 @r5 depends on org || report@
 303 type T, T2;
 304 expression x;
 305 expression E1,E2;
 306 statement S;
 307 position p;
 308 @@
 309
 310  x = (T)kmem_alloc@p(E1,E2);
 311  if ((x==NULL) || ...) S
 312  memset((T2)x,0,E1);
 313
 314 @script:python depends on org@
 315 p << r5.p;
 316 x << r5.x;
 317 @@
 318
 319 msg="%s" % (x)
 320 msg_safe=msg.replace("[","@(").replace("]",")")
 321 coccilib.org.print_todo(p[0], msg_safe)
 322
 323 @script:python depends on report@
 324 p << r5.p;
 325 x << r5.x;
 326 @@
 327
 328 msg="WARNING: kmem_zalloc should be used for %s, instead of kmem_alloc/memset" % (x)
 329 coccilib.report.print_report(p[0], msg)
 330
 331 //-----------------------------------------------------------------
 332 @r6 depends on org || report@
 333 type T, T2;
 334 expression x;
 335 expression E1,E2,E3;
 336 statement S;
 337 position p;
 338 @@
 339
 340  x = (T)devm_kmalloc@p(E2,E1,E3);
 341  if ((x==NULL) || ...) S
 342  memset((T2)x,0,E1);
 343
 344 @script:python depends on org@
 345 p << r6.p;
 346 x << r6.x;
 347 @@
 348
 349 msg="%s" % (x)
 350 msg_safe=msg.replace("[","@(").replace("]",")")
 351 coccilib.org.print_todo(p[0], msg_safe)
 352
 353 @script:python depends on report@
 354 p << r6.p;
 355 x << r6.x;
 356 @@
 357
 358 msg="WARNING: devm_kzalloc should be used for %s, instead of devm_kmalloc/memset" % (x)
 359 coccilib.report.print_report(p[0], msg)
 360
 361 //-----------------------------------------------------------------
 362 @r7 depends on org || report@
 363 type T, T2;
 364 expression x;
 365 expression E1,E2;
 366 statement S;
 367 position p;
 368 @@
 369
 370  x = (T)kvmalloc@p(E1,E2);
 371  if ((x==NULL) || ...) S
 372  memset((T2)x,0,E1);
 373
 374 @script:python depends on org@
 375 p << r7.p;
 376 x << r7.x;
 377 @@
 378
 379 msg="%s" % (x)
 380 msg_safe=msg.replace("[","@(").replace("]",")")
 381 coccilib.org.print_todo(p[0], msg_safe)
 382
 383 @script:python depends on report@
 384 p << r7.p;
 385 x << r7.x;
 386 @@
 387
 388 msg="WARNING: kvzalloc should be used for %s, instead of kvmalloc/memset" % (x)
 389 coccilib.report.print_report(p[0], msg)
 390
 391 //-----------------------------------------------------------------
 392 @r8 depends on org || report@
 393 type T, T2;
 394 expression x;
 395 expression E1,E2,E3;
 396 statement S;
 397 position p;
 398 @@
 399
 400  x = (T)pci_alloc_consistent@p(E2,E1,E3);
 401  if ((x==NULL) || ...) S
 402  memset((T2)x,0,E1);
 403
 404 @script:python depends on org@
 405 p << r8.p;
 406 x << r8.x;
 407 @@
 408
 409 msg="%s" % (x)
 410 msg_safe=msg.replace("[","@(").replace("]",")")
 411 coccilib.org.print_todo(p[0], msg_safe)
 412
 413 @script:python depends on report@
 414 p << r8.p;
 415 x << r8.x;
 416 @@
 417
 418 msg="WARNING: pci_zalloc_consistent should be used for %s, instead of pci_alloc_consistent/memset" % (x)
 419 coccilib.report.print_report(p[0], msg)
 420 //-----------------------------------------------------------------
 421 @r9 depends on org || report@
 422 type T, T2;
 423 expression x;
 424 expression E1,E2,E3;
 425 statement S;
 426 position p;
 427 @@
 428
 429  x = (T)kvmalloc_node@p(E1,E2,E3);
 430  if ((x==NULL) || ...) S
 431  memset((T2)x,0,E1);
 432
 433 @script:python depends on org@
 434 p << r9.p;
 435 x << r9.x;
 436 @@
 437
 438 msg="%s" % (x)
 439 msg_safe=msg.replace("[","@(").replace("]",")")
 440 coccilib.org.print_todo(p[0], msg_safe)
 441
 442 @script:python depends on report@
 443 p << r9.p;
 444 x << r9.x;
 445 @@
 446
 447 msg="WARNING: kvzalloc_node should be used for %s, instead of kvmalloc_node/memset" % (x)
 448 coccilib.report.print_report(p[0], msg)