1 // SPDX-License-Identifier: GPL-2.0-only 1 // SPDX-License-Identifier: GPL-2.0-only
2 /// do_div() does a 64-by-32 division. 2 /// do_div() does a 64-by-32 division.
3 /// When the divisor is long, unsigned long, u 3 /// When the divisor is long, unsigned long, u64, or s64,
4 /// do_div() truncates it to 32 bits, this mea 4 /// do_div() truncates it to 32 bits, this means it can test
5 /// non-zero and be truncated to 0 for divisio 5 /// non-zero and be truncated to 0 for division on 64bit platforms.
6 /// 6 ///
7 //# This makes an effort to find those inappro 7 //# This makes an effort to find those inappropriate do_div() calls.
8 // 8 //
9 // Confidence: Moderate 9 // Confidence: Moderate
10 // Copyright: (C) 2020 Wen Yang, Alibaba. 10 // Copyright: (C) 2020 Wen Yang, Alibaba.
11 // Comments: 11 // Comments:
12 // Options: --no-includes --include-headers 12 // Options: --no-includes --include-headers
13 13
14 virtual context 14 virtual context
15 virtual org 15 virtual org
16 virtual report 16 virtual report
17 17
18 @initialize:python@ 18 @initialize:python@
19 @@ 19 @@
20 20
21 def get_digit_type_and_value(str): 21 def get_digit_type_and_value(str):
22 is_digit = False 22 is_digit = False
23 value = 0 23 value = 0
24 24
25 try: 25 try:
26 if (str.isdigit()): 26 if (str.isdigit()):
27 is_digit = True 27 is_digit = True
28 value = int(str, 0) 28 value = int(str, 0)
29 elif (str.upper().endswith('ULL')): 29 elif (str.upper().endswith('ULL')):
30 is_digit = True 30 is_digit = True
31 value = int(str[:-3], 0) 31 value = int(str[:-3], 0)
32 elif (str.upper().endswith('LL')): 32 elif (str.upper().endswith('LL')):
33 is_digit = True 33 is_digit = True
34 value = int(str[:-2], 0) 34 value = int(str[:-2], 0)
35 elif (str.upper().endswith('UL')): 35 elif (str.upper().endswith('UL')):
36 is_digit = True 36 is_digit = True
37 value = int(str[:-2], 0) 37 value = int(str[:-2], 0)
38 elif (str.upper().endswith('L')): 38 elif (str.upper().endswith('L')):
39 is_digit = True 39 is_digit = True
40 value = int(str[:-1], 0) 40 value = int(str[:-1], 0)
41 elif (str.upper().endswith('U')): 41 elif (str.upper().endswith('U')):
42 is_digit = True 42 is_digit = True
43 value = int(str[:-1], 0) 43 value = int(str[:-1], 0)
44 except Exception as e: 44 except Exception as e:
45 print('Error:',e) 45 print('Error:',e)
46 is_digit = False 46 is_digit = False
47 value = 0 47 value = 0
48 finally: 48 finally:
49 return is_digit, value 49 return is_digit, value
50 50
51 def filter_out_safe_constants(str): 51 def filter_out_safe_constants(str):
52 is_digit, value = get_digit_type_and_value 52 is_digit, value = get_digit_type_and_value(str)
53 if (is_digit): 53 if (is_digit):
54 if (value >= 0x100000000): 54 if (value >= 0x100000000):
55 return True 55 return True
56 else: 56 else:
57 return False 57 return False
58 else: 58 else:
59 return True 59 return True
60 60
61 def construct_warnings(suggested_fun): 61 def construct_warnings(suggested_fun):
62 msg="WARNING: do_div() does a 64-by-32 div 62 msg="WARNING: do_div() does a 64-by-32 division, please consider using %s instead."
63 return msg % suggested_fun 63 return msg % suggested_fun
64 64
65 @depends on context@ 65 @depends on context@
66 expression f; 66 expression f;
67 long l: script:python() { filter_out_safe_cons 67 long l: script:python() { filter_out_safe_constants(l) };
68 unsigned long ul : script:python() { filter_ou 68 unsigned long ul : script:python() { filter_out_safe_constants(ul) };
69 u64 ul64 : script:python() { filter_out_safe_c 69 u64 ul64 : script:python() { filter_out_safe_constants(ul64) };
70 s64 sl64 : script:python() { filter_out_safe_c 70 s64 sl64 : script:python() { filter_out_safe_constants(sl64) };
71 71
72 @@ 72 @@
73 ( 73 (
74 * do_div(f, l); 74 * do_div(f, l);
75 | 75 |
76 * do_div(f, ul); 76 * do_div(f, ul);
77 | 77 |
78 * do_div(f, ul64); 78 * do_div(f, ul64);
79 | 79 |
80 * do_div(f, sl64); 80 * do_div(f, sl64);
81 ) 81 )
82 82
83 @r depends on (org || report)@ 83 @r depends on (org || report)@
84 expression f; 84 expression f;
85 position p; 85 position p;
86 long l: script:python() { filter_out_safe_cons 86 long l: script:python() { filter_out_safe_constants(l) };
87 unsigned long ul : script:python() { filter_ou 87 unsigned long ul : script:python() { filter_out_safe_constants(ul) };
88 u64 ul64 : script:python() { filter_out_safe_c 88 u64 ul64 : script:python() { filter_out_safe_constants(ul64) };
89 s64 sl64 : script:python() { filter_out_safe_c 89 s64 sl64 : script:python() { filter_out_safe_constants(sl64) };
90 @@ 90 @@
91 ( 91 (
92 do_div@p(f, l); 92 do_div@p(f, l);
93 | 93 |
94 do_div@p(f, ul); 94 do_div@p(f, ul);
95 | 95 |
96 do_div@p(f, ul64); 96 do_div@p(f, ul64);
97 | 97 |
98 do_div@p(f, sl64); 98 do_div@p(f, sl64);
99 ) 99 )
100 100
101 @script:python depends on org@ 101 @script:python depends on org@
102 p << r.p; 102 p << r.p;
103 ul << r.ul; 103 ul << r.ul;
104 @@ 104 @@
105 105
106 coccilib.org.print_todo(p[0], construct_warnin 106 coccilib.org.print_todo(p[0], construct_warnings("div64_ul"))
107 107
108 @script:python depends on org@ 108 @script:python depends on org@
109 p << r.p; 109 p << r.p;
110 l << r.l; 110 l << r.l;
111 @@ 111 @@
112 112
113 coccilib.org.print_todo(p[0], construct_warnin 113 coccilib.org.print_todo(p[0], construct_warnings("div64_long"))
114 114
115 @script:python depends on org@ 115 @script:python depends on org@
116 p << r.p; 116 p << r.p;
117 ul64 << r.ul64; 117 ul64 << r.ul64;
118 @@ 118 @@
119 119
120 coccilib.org.print_todo(p[0], construct_warnin 120 coccilib.org.print_todo(p[0], construct_warnings("div64_u64"))
121 121
122 @script:python depends on org@ 122 @script:python depends on org@
123 p << r.p; 123 p << r.p;
124 sl64 << r.sl64; 124 sl64 << r.sl64;
125 @@ 125 @@
126 126
127 coccilib.org.print_todo(p[0], construct_warnin 127 coccilib.org.print_todo(p[0], construct_warnings("div64_s64"))
128 128
129 @script:python depends on report@ 129 @script:python depends on report@
130 p << r.p; 130 p << r.p;
131 ul << r.ul; 131 ul << r.ul;
132 @@ 132 @@
133 133
134 coccilib.report.print_report(p[0], construct_w 134 coccilib.report.print_report(p[0], construct_warnings("div64_ul"))
135 135
136 @script:python depends on report@ 136 @script:python depends on report@
137 p << r.p; 137 p << r.p;
138 l << r.l; 138 l << r.l;
139 @@ 139 @@
140 140
141 coccilib.report.print_report(p[0], construct_w 141 coccilib.report.print_report(p[0], construct_warnings("div64_long"))
142 142
143 @script:python depends on report@ 143 @script:python depends on report@
144 p << r.p; 144 p << r.p;
145 sl64 << r.sl64; 145 sl64 << r.sl64;
146 @@ 146 @@
147 147
148 coccilib.report.print_report(p[0], construct_w 148 coccilib.report.print_report(p[0], construct_warnings("div64_s64"))
149 149
150 @script:python depends on report@ 150 @script:python depends on report@
151 p << r.p; 151 p << r.p;
152 ul64 << r.ul64; 152 ul64 << r.ul64;
153 @@ 153 @@
154 154
155 coccilib.report.print_report(p[0], construct_w 155 coccilib.report.print_report(p[0], construct_warnings("div64_u64"))
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.