Compute Library
 21.11
clang_tidy_rules.py
Go to the documentation of this file.
1 #!/usr/bin/env python3
2 import os
3 import re
4 import sys
5 
7  return "src/cpu/kernels/assembly " \
8  "src/core/NEON/kernels/assembly " \
9  "src/core/NEON/kernels/convolution/winograd " \
10  "include/linux include " \
11  ". ".split()
12 
13 def get_list_flags( filename, arch):
14  assert arch in ["armv7", "aarch64"]
15  flags = ["-std=c++14"]
16  flags.append("-DARM_COMPUTE_CPP_SCHEDULER=1")
17  flags.append("-DARM_COMPUTE_CL")
18  if arch == "aarch64":
19  flags.append("-DARM_COMPUTE_AARCH64_V8_2")
20  return flags
21 
22 def filter_files( list_files ):
23  to_check = []
24  for f in list_files:
25  if os.path.splitext(f)[1] != ".cpp":
26  continue
27  # Skip OMPScheduler as it causes problems in clang
28  if (("OMPScheduler.cpp" in f) or
29  ("CLTracePoint.cpp" in f) or
30  ("NETracePoint.cpp" in f) or
31  ("TracePoint.cpp" in f)):
32  continue
33  to_check.append(f)
34  return to_check
35 
37  out = []
38  print_context=False
39  for i in range(0, len(lines)):
40  line = lines[i]
41 
42  if "/arm_conv/" in line:
43  continue
44 
45  if "/arm_gemm/" in line:
46  continue
47 
48  if "/convolution/" in line:
49  continue
50 
51  if "/validate_examples/" in line:
52  continue
53 
54  if "error:" in line:
55  if (("Version.cpp" in line and "arm_compute_version.embed" in line and "file not found" in line) or
56  ("arm_fp16.h" in line) or
57  ("omp.h" in line) or
58  ("cast from pointer to smaller type 'uintptr_t' (aka 'unsigned int') loses information" in line) or
59  ("cast from pointer to smaller type 'cl_context_properties' (aka 'int') loses information" in line) or
60  ("cast from pointer to smaller type 'std::uintptr_t' (aka 'unsigned int') loses information" in line) or
61  ("NEMath.inl" in line and "statement expression not allowed at file scope" in line) or
62  ("Utils.h" in line and "no member named 'unmap' in 'arm_compute::Tensor'" in line) or
63  ("Utils.h" in line and "no member named 'map' in 'arm_compute::Tensor'" in line) or
64  ("CPUUtils.cpp" in line and "'asm/hwcap.h' file not found" in line) or
65  ("CPUUtils.cpp" in line and "use of undeclared identifier 'HWCAP_SVE'" in line) or
66  ("sve" in line) or
67  ("'arm_compute_version.embed' file not found" in line) ):
68  print_context=False
69  continue
70 
71  out.append(line)
72  print_context=True
73  elif "warning:" in line:
74  if ("uninitialized record type: '__ret'" in line or
75  "local variable '__bound_functor' is still referred to by the global variable '__once_callable'" in line or
76  "assigning newly created 'gsl::owner<>'" in line or
77  "calling legacy resource function without passing a 'gsl::owner<>'" in line or
78  "deleting a pointer through a type that is not marked 'gsl::owner<>'" in line or
79  (any(f in line for f in ["Error.cpp","Error.h"]) and "thrown exception type is not nothrow copy constructible" in line) or
80  (any(f in line for f in ["Error.cpp","Error.h"]) and "uninitialized record type: 'args'" in line) or
81  (any(f in line for f in ["Error.cpp","Error.h"]) and "do not call c-style vararg functions" in line) or
82  (any(f in line for f in ["Error.cpp","Error.h"]) and "do not define a C-style variadic function" in line) or
83  ("TensorAllocator.cpp" in line and "warning: pointer parameter 'ptr' can be pointer to const" in line) or
84  ("TensorAllocator.cpp" in line and "warning: do not declare C-style arrays" in line) or
85  ("RawTensor.cpp" in line and "warning: pointer parameter 'ptr' can be pointer to const" in line) or
86  ("RawTensor.cpp" in line and "warning: do not declare C-style arrays" in line) or
87  ("NEMinMaxLocationKernel.cpp" in line and "move constructors should be marked noexcept" in line) or
88  ("NEMinMaxLocationKernel.cpp" in line and "move assignment operators should be marked noexcept" in line) or
89  ("CLMinMaxLocationKernel.cpp" in line and "Forming reference to null pointer" in line) or
90  ("PMUCounter.cpp" in line and "consider replacing 'long long' with 'int64'" in line) or
91  ("Validation.cpp" in line and "parameter 'classified_labels' is unused" in line) or
92  ("Validation.cpp" in line and "parameter 'expected_labels' is unused" in line) or
93  ("Reference.cpp" in line and "parameter 'rois' is unused" in line) or
94  ("Reference.cpp" in line and "parameter 'shapes' is unused" in line) or
95  ("Reference.cpp" in line and re.search(r"parameter '[^']+' is unused", line)) or
96  ("ReferenceCPP.cpp" in line and "parameter 'rois' is unused" in line) or
97  ("ReferenceCPP.cpp" in line and "parameter 'srcs' is unused" in line) or
98  ("ReferenceCPP.cpp" in line and re.search(r"parameter '[^']+' is unused", line)) or
99  ("NEGEMMMatrixMultiplyKernel.cpp" in line and "do not use C-style cast to convert between unrelated types" in line) or
100  ("NEPoolingLayerKernel.cpp" in line and "do not use C-style cast to convert between unrelated types" in line) or
101  ("NESoftmaxLayerKernel.cpp" in line and "macro argument should be enclosed in parentheses" in line) or
102  ("GraphUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint32'" in line) or
103  ("GraphUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint64'" in line) or
104  ("ConvolutionLayer.cpp" in line and "move assignment operators should be marked noexcept" in line) or
105  ("ConvolutionLayer.cpp" in line and "move constructors should be marked noexcept" in line) or
106  ("parameter 'memory_manager' is unused" in line) or
107  ("parameter 'memory_manager' is copied for each invocation but only used as a const reference" in line) or
108  ("DeconvolutionLayer.cpp" in line and "casting (double + 0.5) to integer leads to incorrect rounding; consider using lround" in line) or
109  ("NEWinogradLayerKernel.cpp" in line and "use '= default' to define a trivial destructor" in line) or
110  ("NEGEMMLowpMatrixMultiplyCore.cpp" in line and "constructor does not initialize these fields" in line) or
111  ("NEGEMMLowpAssemblyMatrixMultiplyCore" in line and "constructor does not initialize these fields" in line) or
112  ("CpuDepthwiseConv2dNativeKernel" in line and re.search(r"parameter '[^']+' is unused", line)) or
113  ("CpuDepthwiseConv2dAssemblyDispatch" in line and re.search(r"parameter '[^']+' is unused", line)) or
114  ("CpuDepthwiseConv2dAssemblyDispatch" in line and "modernize-use-equals-default" in line) or
115  ("CPUUtils.cpp" in line and "consider replacing 'unsigned long' with 'uint64'" in line) or
116  ("CPUUtils.cpp" in line and "parameter 'cpusv' is unused" in line) or
117  ("CPUUtils.cpp" in line and "warning: uninitialized record type" in line) or
118  ("Utils.h" in line and "warning: Use of zero-allocated memory" in line) or
119  ("sve" in line) or
120  ("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
121  print_context=False
122  continue
123 
124  if "do not use C-style cast to convert between unrelated types" in line:
125  if i + 1 < len(lines) and "vgetq_lane_f16" in lines[i + 1]:
126  print_context=False
127  continue
128 
129  if "use 'using' instead of 'typedef'" in line:
130  if i + 1 < len(lines) and "BOOST_FIXTURE_TEST_SUITE" in lines[i + 1]:
131  print_context=False
132  continue
133 
134  if "do not call c-style vararg functions" in line:
135  if (i + 1 < len(lines) and
136  ("BOOST_TEST" in lines[i + 1] or
137  "BOOST_FAIL" in lines[i + 1] or
138  "BOOST_CHECK_THROW" in lines[i + 1] or
139  "ARM_COMPUTE_ERROR_VAR" in lines[i + 1] or
140  "ARM_COMPUTE_RETURN_ON" in lines[i + 1] or
141  "syscall" in lines[i + 1])):
142  print_context=False
143  continue
144 
145  out.append(line)
146  print_context=True
147  elif (("CLMinMaxLocationKernel.cpp" in line and "'?' condition is false" in line) or
148  ("CLMinMaxLocationKernel.cpp" in line and "Assuming the condition is false" in line) or
149  ("CLMinMaxLocationKernel.cpp" in line and "Assuming pointer value is null" in line) or
150  ("CLMinMaxLocationKernel.cpp" in line and "Forming reference to null pointer" in line)):
151  print_context=False
152  continue
153  elif print_context:
154  out.append(line)
155 
156  return out
157 
158 if __name__ == "__main__":
159  if len(sys.argv) != 2:
160  print("usage: {} CLANG-TIDY_OUTPUT_FILE".format(sys.argv[0]))
161  sys.exit(1)
162 
163  errors = []
164  with open(sys.argv[1], mode="r") as clang_tidy_file:
165  lines = clang_tidy_file.readlines()
166  errors = filter_clang_tidy_lines(lines)
167  print("\n".join(errors))
168 
169  sys.exit(0 if len(errors) == 0 else 1)
std::string join(T first, T last, const std::string &separator)
Helper function to concatenate multiple strings.
Definition: Utils.h:93
def filter_clang_tidy_lines(lines)
def get_list_flags(filename, arch)
SimpleTensor< T > range(SimpleTensor< T > &dst, float start, const size_t num_of_elements, float step)
Definition: Range.cpp:50
def filter_files(list_files)