xref: /aosp_15_r20/external/ComputeLibrary/scripts/clang_tidy_rules.py (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3#
4# Copyright (c) 2017-2023 Arm Limited.
5#
6# SPDX-License-Identifier: MIT
7#
8# Permission is hereby granted, free of charge, to any person obtaining a copy
9# of this software and associated documentation files (the "Software"), to
10# deal in the Software without restriction, including without limitation the
11# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12# sell copies of the Software, and to permit persons to whom the Software is
13# furnished to do so, subject to the following conditions:
14#
15# The above copyright notice and this permission notice shall be included in all
16# copies or substantial portions of the Software.
17#
18# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24# SOFTWARE.
25
26import os
27import re
28import sys
29
30def get_list_includes():
31    return "src/cpu/kernels/assembly " \
32           "src/core/NEON/kernels/assembly " \
33           "src/core/NEON/kernels/convolution/winograd " \
34           "include/linux include " \
35           ". ".split()
36
37def get_list_flags( filename, arch):
38    assert arch in ["armv7", "aarch64"]
39    flags = ["-std=c++14"]
40    flags.append("-DARM_COMPUTE_CPP_SCHEDULER=1")
41    flags.append("-DARM_COMPUTE_CL")
42    flags.append("-DARM_COMPUTE_OPENCL_ENABLED")
43    if arch == "aarch64":
44        flags.append("-DARM_COMPUTE_AARCH64_V8_2")
45    return flags
46
47def filter_files( list_files ):
48    to_check = []
49    for f in list_files:
50        if os.path.splitext(f)[1] != ".cpp":
51            continue
52        # Skip OMPScheduler as it causes problems in clang
53        if (("OMPScheduler.cpp" in f) or
54            ("CLTracePoint.cpp" in f) or
55            ("NETracePoint.cpp" in f) or
56            ("TracePoint.cpp" in f)):
57            continue
58        to_check.append(f)
59    return to_check
60
61def filter_clang_tidy_lines( lines ):
62    out = []
63    print_context=False
64    for i in range(0, len(lines)):
65        line = lines[i]
66
67        if "/arm_conv/" in line:
68            continue
69
70        if "/arm_gemm/" in line:
71            continue
72
73        if "/convolution/" in line:
74            continue
75
76        if "/validate_examples/" in line:
77            continue
78
79        if "error:" in line:
80            if (("Version.cpp" in line and "arm_compute_version.embed" in line and "file not found" in line) or
81                ("arm_fp16.h" in line) or
82                ("omp.h" in line) or
83                ("cast from pointer to smaller type 'uintptr_t' (aka 'unsigned int') loses information" in line) or
84                ("cast from pointer to smaller type 'cl_context_properties' (aka 'int') loses information" in line) or
85                ("cast from pointer to smaller type 'std::uintptr_t' (aka 'unsigned int') loses information" in line) or
86                ("NEMath.inl" in line and "statement expression not allowed at file scope" in line) or
87                ("Utils.h" in line and "no member named 'unmap' in 'arm_compute::Tensor'" in line) or
88                ("Utils.h" in line and "no member named 'map' in 'arm_compute::Tensor'" in line) or
89                ("CPUUtils.cpp" in line and "'asm/hwcap.h' file not found" in line) or
90                ("CPUUtils.cpp" in line and "use of undeclared identifier 'HWCAP_SVE'" in line) or
91               ("sve" in line) or
92                ("'arm_compute_version.embed' file not found" in line) ):
93                print_context=False
94                continue
95
96            out.append(line)
97            print_context=True
98        elif "warning:" in line:
99            if ("uninitialized record type: '__ret'" in line or
100               "local variable '__bound_functor' is still referred to by the global variable '__once_callable'" in line or
101               "assigning newly created 'gsl::owner<>'" in line or
102               "calling legacy resource function without passing a 'gsl::owner<>'" in line or
103               "deleting a pointer through a type that is not marked 'gsl::owner<>'" in line or
104               (any(f in line for f in ["Error.cpp","Error.h"]) and "thrown exception type is not nothrow copy constructible" in line) or
105               (any(f in line for f in ["Error.cpp","Error.h"]) and "uninitialized record type: 'args'" in line) or
106               (any(f in line for f in ["Error.cpp","Error.h"]) and "do not call c-style vararg functions" in line) or
107               (any(f in line for f in ["Error.cpp","Error.h"]) and "do not define a C-style variadic function" in line) or
108               ("TensorAllocator.cpp" in line and "warning: pointer parameter 'ptr' can be pointer to const" in line) or
109               ("TensorAllocator.cpp" in line and "warning: do not declare C-style arrays" in line) or
110               ("RawTensor.cpp" in line and "warning: pointer parameter 'ptr' can be pointer to const" in line) or
111               ("RawTensor.cpp" in line and "warning: do not declare C-style arrays" in line) or
112               ("NEMinMaxLocationKernel.cpp" in line and "move constructors should be marked noexcept" in line) or
113               ("NEMinMaxLocationKernel.cpp" in line and "move assignment operators should be marked noexcept" in line) or
114               ("CLMinMaxLocationKernel.cpp" in line and "Forming reference to null pointer" in line) or
115               ("PMUCounter.cpp" in line and "consider replacing 'long long' with 'int64'" in line) or
116               ("Validation.cpp" in line and "parameter 'classified_labels' is unused" in line) or
117               ("Validation.cpp" in line and "parameter 'expected_labels' is unused" in line) or
118               ("Reference.cpp" in line and "parameter 'rois' is unused" in line) or
119               ("Reference.cpp" in line and "parameter 'shapes' is unused" in line) or
120               ("Reference.cpp" in line and re.search(r"parameter '[^']+' is unused", line)) or
121               ("ReferenceCPP.cpp" in line and "parameter 'rois' is unused" in line) or
122               ("ReferenceCPP.cpp" in line and "parameter 'srcs' is unused" in line) or
123               ("ReferenceCPP.cpp" in line and re.search(r"parameter '[^']+' is unused", line)) or
124               ("NEGEMMMatrixMultiplyKernel.cpp" in line and "do not use C-style cast to convert between unrelated types" in line) or
125               ("NEPoolingLayerKernel.cpp" in line and "do not use C-style cast to convert between unrelated types" in line) or
126               ("NESoftmaxLayerKernel.cpp" in line and "macro argument should be enclosed in parentheses" in line) or
127               ("GraphUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint32'" in line) or
128               ("GraphUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint64'" in line) or
129               ("ConvolutionLayer.cpp" in line and "move assignment operators should be marked noexcept" in line) or
130               ("ConvolutionLayer.cpp" in line and "move constructors should be marked noexcept" in line) or
131               ("parameter 'memory_manager' is unused" in line) or
132               ("parameter 'memory_manager' is copied for each invocation but only used as a const reference" in line) or
133               ("DeconvolutionLayer.cpp" in line and "casting (double + 0.5) to integer leads to incorrect rounding; consider using lround" in line) or
134               ("NEWinogradLayerKernel.cpp" in line and "use '= default' to define a trivial destructor" in line) or
135               ("NEGEMMLowpMatrixMultiplyCore.cpp" in line and "constructor does not initialize these fields" in line) or
136               ("NEGEMMLowpAssemblyMatrixMultiplyCore" in line and "constructor does not initialize these fields" in line) or
137               ("CpuDepthwiseConv2dNativeKernel" in line and re.search(r"parameter '[^']+' is unused", line)) or
138               ("CpuDepthwiseConv2dAssemblyDispatch" in line and re.search(r"parameter '[^']+' is unused", line)) or
139               ("CpuDepthwiseConv2dAssemblyDispatch" in line and "modernize-use-equals-default" in line) or
140               ("CPUUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint64'" in line) or
141               ("CPUUtils.cpp" in line and "parameter 'cpusv' is unused" in line) or
142               ("CPUUtils.cpp" in line and "warning: uninitialized record type" in line) or
143               ("Utils.h" in line and "warning: Use of zero-allocated memory" in line) or
144               ("sve" in line) or
145               ("CpuDepthwiseConv2dNativeKernel.cpp" in line and "misc-non-private-member-variables-in-classes" in line)): # This is to prevent false positive, should be reassessed with the newer clang-tidy
146                print_context=False
147                continue
148
149            if "do not use C-style cast to convert between unrelated types" in line:
150                if i + 1 < len(lines) and "vgetq_lane_f16" in lines[i + 1]:
151                    print_context=False
152                    continue
153
154            if "use 'using' instead of 'typedef'" in line:
155                if i + 1 < len(lines) and "BOOST_FIXTURE_TEST_SUITE" in lines[i + 1]:
156                    print_context=False
157                    continue
158
159            if "do not call c-style vararg functions" in line:
160                if (i + 1 < len(lines) and
161                   ("BOOST_TEST" in lines[i + 1] or
162                    "BOOST_FAIL" in lines[i + 1] or
163                    "BOOST_CHECK_THROW" in lines[i + 1] or
164                    "ARM_COMPUTE_ERROR_VAR" in lines[i + 1] or
165                    "ARM_COMPUTE_RETURN_ON" in lines[i + 1] or
166                    "syscall" in lines[i + 1])):
167                        print_context=False
168                        continue
169
170            out.append(line)
171            print_context=True
172        elif (("CLMinMaxLocationKernel.cpp" in line and "'?' condition is false" in line) or
173              ("CLMinMaxLocationKernel.cpp" in line and "Assuming the condition is false" in line) or
174              ("CLMinMaxLocationKernel.cpp" in line and "Assuming pointer value is null" in line) or
175              ("CLMinMaxLocationKernel.cpp" in line and "Forming reference to null pointer" in line)):
176               print_context=False
177               continue
178        elif print_context:
179            out.append(line)
180
181    return out
182
183if __name__ == "__main__":
184    if len(sys.argv) != 2:
185        print("usage: {} CLANG-TIDY_OUTPUT_FILE".format(sys.argv[0]))
186        sys.exit(1)
187
188    errors = []
189    with open(sys.argv[1], mode="r") as clang_tidy_file:
190        lines = clang_tidy_file.readlines()
191        errors = filter_clang_tidy_lines(lines)
192        print("\n".join(errors))
193
194    sys.exit(0 if len(errors) == 0 else 1)
195