alloc_cast.cocci 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /// Remove casting the values returned by memory allocation functions
  3. /// like kmalloc, kzalloc, kmem_cache_alloc, kmem_cache_zalloc etc.
  4. ///
  5. //# This makes an effort to find cases of casting of values returned by
  6. //# kmalloc, kzalloc, kcalloc, kmem_cache_alloc, kmem_cache_zalloc,
  7. //# kmem_cache_alloc_node, kmalloc_node and kzalloc_node and removes
  8. //# the casting as it is not required. The result in the patch case may
  9. //# need some reformatting.
  10. //
  11. // Confidence: High
  12. // Copyright: (C) 2014 Himangi Saraogi
  13. // Copyright: (C) 2017 Himanshu Jha
  14. // Comments:
  15. // Options: --no-includes --include-headers
  16. //
  17. virtual context
  18. virtual patch
  19. virtual org
  20. virtual report
  21. @initialize:python@
  22. @@
  23. import re
  24. pattern = '__'
  25. m = re.compile(pattern)
  26. @r1 depends on context || patch@
  27. type T;
  28. @@
  29. (T *)
  30. \(kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|kmem_cache_zalloc\|
  31. kmem_cache_alloc_node\|kmalloc_node\|kzalloc_node\|vmalloc\|vzalloc\|
  32. dma_alloc_coherent\|devm_kmalloc\|devm_kzalloc\|
  33. kvmalloc\|kvzalloc\|kvmalloc_node\|kvzalloc_node\|pci_alloc_consistent\|
  34. pci_zalloc_consistent\|kmem_alloc\|kmem_zalloc\|kmem_zone_alloc\|
  35. kmem_zone_zalloc\|vmalloc_node\|vzalloc_node\)(...)
  36. //----------------------------------------------------------
  37. // For context mode
  38. //----------------------------------------------------------
  39. @script:python depends on context@
  40. t << r1.T;
  41. @@
  42. if m.search(t) != None:
  43. cocci.include_match(False)
  44. @depends on context && r1@
  45. type r1.T;
  46. @@
  47. * (T *)
  48. \(kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|kmem_cache_zalloc\|
  49. kmem_cache_alloc_node\|kmalloc_node\|kzalloc_node\|vmalloc\|vzalloc\|
  50. dma_alloc_coherent\|devm_kmalloc\|devm_kzalloc\|
  51. kvmalloc\|kvzalloc\|kvmalloc_node\|kvzalloc_node\|pci_alloc_consistent\|
  52. pci_zalloc_consistent\|kmem_alloc\|kmem_zalloc\|kmem_zone_alloc\|
  53. kmem_zone_zalloc\|vmalloc_node\|vzalloc_node\)(...)
  54. //----------------------------------------------------------
  55. // For patch mode
  56. //----------------------------------------------------------
  57. @script:python depends on patch@
  58. t << r1.T;
  59. @@
  60. if m.search(t) != None:
  61. cocci.include_match(False)
  62. @depends on patch && r1@
  63. type r1.T;
  64. @@
  65. - (T *)
  66. \(kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|kmem_cache_zalloc\|
  67. kmem_cache_alloc_node\|kmalloc_node\|kzalloc_node\|vmalloc\|vzalloc\|
  68. dma_alloc_coherent\|devm_kmalloc\|devm_kzalloc\|
  69. kvmalloc\|kvzalloc\|kvmalloc_node\|kvzalloc_node\|pci_alloc_consistent\|
  70. pci_zalloc_consistent\|kmem_alloc\|kmem_zalloc\|kmem_zone_alloc\|
  71. kmem_zone_zalloc\|vmalloc_node\|vzalloc_node\)(...)
  72. //----------------------------------------------------------
  73. // For org and report mode
  74. //----------------------------------------------------------
  75. @r2 depends on org || report@
  76. type T;
  77. position p;
  78. @@
  79. (T@p *)
  80. \(kmalloc\|kzalloc\|kcalloc\|kmem_cache_alloc\|kmem_cache_zalloc\|
  81. kmem_cache_alloc_node\|kmalloc_node\|kzalloc_node\|vmalloc\|vzalloc\|
  82. dma_alloc_coherent\|devm_kmalloc\|devm_kzalloc\|
  83. kvmalloc\|kvzalloc\|kvmalloc_node\|kvzalloc_node\|pci_alloc_consistent\|
  84. pci_zalloc_consistent\|kmem_alloc\|kmem_zalloc\|kmem_zone_alloc\|
  85. kmem_zone_zalloc\|vmalloc_node\|vzalloc_node\)(...)
  86. @script:python depends on org@
  87. p << r2.p;
  88. t << r2.T;
  89. @@
  90. if m.search(t) != None:
  91. cocci.include_match(False)
  92. else:
  93. coccilib.org.print_safe_todo(p[0], t)
  94. @script:python depends on report@
  95. p << r2.p;
  96. t << r2.T;
  97. @@
  98. if m.search(t) != None:
  99. cocci.include_match(False)
  100. else:
  101. msg="WARNING: casting value returned by memory allocation function to (%s *) is useless." % (t)
  102. coccilib.report.print_report(p[0], msg)