xref: /OK3568_Linux_fs/kernel/scripts/coccinelle/misc/array_size.cocci (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun// SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun/// Use ARRAY_SIZE instead of dividing sizeof array with sizeof an element
3*4882a593Smuzhiyun///
4*4882a593Smuzhiyun//# This makes an effort to find cases where ARRAY_SIZE can be used such as
5*4882a593Smuzhiyun//# where there is a division of sizeof the array by the sizeof its first
6*4882a593Smuzhiyun//# element or by any indexed element or the element type. It replaces the
7*4882a593Smuzhiyun//# division of the two sizeofs by ARRAY_SIZE.
8*4882a593Smuzhiyun//
9*4882a593Smuzhiyun// Confidence: High
10*4882a593Smuzhiyun// Copyright: (C) 2014 Himangi Saraogi.
11*4882a593Smuzhiyun// Comments:
12*4882a593Smuzhiyun// Options: --no-includes --include-headers
13*4882a593Smuzhiyun
14*4882a593Smuzhiyunvirtual patch
15*4882a593Smuzhiyunvirtual context
16*4882a593Smuzhiyunvirtual org
17*4882a593Smuzhiyunvirtual report
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun@i@
20*4882a593Smuzhiyun@@
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun#include <linux/kernel.h>
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun//----------------------------------------------------------
25*4882a593Smuzhiyun//  For context mode
26*4882a593Smuzhiyun//----------------------------------------------------------
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun@depends on i&&context@
29*4882a593Smuzhiyuntype T;
30*4882a593SmuzhiyunT[] E;
31*4882a593Smuzhiyun@@
32*4882a593Smuzhiyun(
33*4882a593Smuzhiyun* (sizeof(E)/sizeof(*E))
34*4882a593Smuzhiyun|
35*4882a593Smuzhiyun* (sizeof(E)/sizeof(E[...]))
36*4882a593Smuzhiyun|
37*4882a593Smuzhiyun* (sizeof(E)/sizeof(T))
38*4882a593Smuzhiyun)
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun//----------------------------------------------------------
41*4882a593Smuzhiyun//  For patch mode
42*4882a593Smuzhiyun//----------------------------------------------------------
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun@depends on i&&patch@
45*4882a593Smuzhiyuntype T;
46*4882a593SmuzhiyunT[] E;
47*4882a593Smuzhiyun@@
48*4882a593Smuzhiyun(
49*4882a593Smuzhiyun- (sizeof(E)/sizeof(*E))
50*4882a593Smuzhiyun+ ARRAY_SIZE(E)
51*4882a593Smuzhiyun|
52*4882a593Smuzhiyun- (sizeof(E)/sizeof(E[...]))
53*4882a593Smuzhiyun+ ARRAY_SIZE(E)
54*4882a593Smuzhiyun|
55*4882a593Smuzhiyun- (sizeof(E)/sizeof(T))
56*4882a593Smuzhiyun+ ARRAY_SIZE(E)
57*4882a593Smuzhiyun)
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun//----------------------------------------------------------
60*4882a593Smuzhiyun//  For org and report mode
61*4882a593Smuzhiyun//----------------------------------------------------------
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun@r depends on (org || report)@
64*4882a593Smuzhiyuntype T;
65*4882a593SmuzhiyunT[] E;
66*4882a593Smuzhiyunposition p;
67*4882a593Smuzhiyun@@
68*4882a593Smuzhiyun(
69*4882a593Smuzhiyun (sizeof(E)@p /sizeof(*E))
70*4882a593Smuzhiyun|
71*4882a593Smuzhiyun (sizeof(E)@p /sizeof(E[...]))
72*4882a593Smuzhiyun|
73*4882a593Smuzhiyun (sizeof(E)@p /sizeof(T))
74*4882a593Smuzhiyun)
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun@script:python depends on org@
77*4882a593Smuzhiyunp << r.p;
78*4882a593Smuzhiyun@@
79*4882a593Smuzhiyun
80*4882a593Smuzhiyuncoccilib.org.print_todo(p[0], "WARNING should use ARRAY_SIZE")
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun@script:python depends on report@
83*4882a593Smuzhiyunp << r.p;
84*4882a593Smuzhiyun@@
85*4882a593Smuzhiyun
86*4882a593Smuzhiyunmsg="WARNING: Use ARRAY_SIZE"
87*4882a593Smuzhiyuncoccilib.report.print_report(p[0], msg)
88*4882a593Smuzhiyun
89