Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 1 | // |
Mohammed Suhail Munshi | 0597b7b | 2022-02-14 15:46:20 +0000 | [diff] [blame] | 2 | // Copyright © 2020,2022 Arm Ltd. All rights reserved. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
Mohammed Suhail Munshi | 0597b7b | 2022-02-14 15:46:20 +0000 | [diff] [blame] | 6 | // The following files are omitted due to technical limitations: |
| 7 | // Directories : data, include, python |
| 8 | // Files : LICENSE, README.md, SConscript, SConstruct, Security.md, filelist.json, filedefs.json |
| 9 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 10 | /** @file Android.bp |
| 11 | * @brief Generation script for building AndroidNN driver. |
| 12 | */ |
| 13 | |
| 14 | /** @dir arm_compute |
| 15 | * @brief All the arm_compute headers. |
| 16 | */ |
| 17 | |
| 18 | /** @dir arm_compute/core |
| 19 | * @brief Core module: common basic types and kernels. |
| 20 | */ |
| 21 | |
| 22 | /** @dir arm_compute/core/CL |
| 23 | * @brief OpenCL backend core: kernels and utilities. |
| 24 | */ |
| 25 | |
| 26 | /** @file arm_compute/core/CL/CLKernelLibrary.h |
| 27 | * @brief Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context. |
| 28 | */ |
| 29 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 30 | /** @file arm_compute/core/CL/OpenCL.h |
| 31 | * @brief Wrapper to configure the Khronos OpenCL C++ header |
| 32 | */ |
| 33 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 34 | /** @dir arm_compute/core/CPP |
| 35 | * @brief CPP backend core: kernels and utilities. |
| 36 | */ |
| 37 | |
| 38 | /** @file arm_compute/core/CPP/CPPKernels.h |
| 39 | * @brief Includes all the CPP kernels at once |
| 40 | */ |
| 41 | |
| 42 | /** @dir arm_compute/core/CPP/kernels |
| 43 | * @brief Folder containing all the CPP kernels |
| 44 | */ |
| 45 | |
| 46 | /** @dir arm_compute/core/experimental |
| 47 | * @brief All experimental interfaces |
| 48 | */ |
| 49 | |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 50 | /** @dir src/core/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 51 | * @brief Arm® Neon™ backend core: kernels and utilities. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 52 | */ |
| 53 | |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 54 | /** @file src/core/NEON/NEKernels.h |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 55 | * @brief Includes all the Arm® Neon™ kernels at once |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 56 | */ |
| 57 | |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 58 | /** @dir src/core/NEON/kernels |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 59 | * @brief Folder containing all the Arm® Neon™ kernels |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 60 | */ |
| 61 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 62 | /** @dir arm_compute/core/utils |
| 63 | * @brief Common core utilities. |
| 64 | */ |
| 65 | |
| 66 | /** @dir arm_compute/graph |
| 67 | * @brief Graph API. |
| 68 | */ |
| 69 | |
| 70 | /** @dir arm_compute/graph/algorithms |
| 71 | * @brief Generic algorithms used by the graph backend (e.g Order of traversal) |
| 72 | */ |
| 73 | |
| 74 | /** @dir arm_compute/graph/backends |
| 75 | * @brief The backend specific code |
| 76 | */ |
| 77 | |
| 78 | /** @dir arm_compute/graph/backends/CL |
| 79 | * @brief OpenCL specific operations |
| 80 | */ |
| 81 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 82 | /** @dir arm_compute/graph/backends/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 83 | * @brief Arm® Neon™ specific operations |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 84 | */ |
| 85 | |
| 86 | /** @dir arm_compute/graph/detail |
| 87 | * @brief Collection of internal utilities. |
| 88 | */ |
| 89 | |
| 90 | /** @dir arm_compute/graph/frontend |
| 91 | * @brief Code related to the stream frontend interface. |
| 92 | */ |
| 93 | |
| 94 | /** @dir arm_compute/graph/mutators |
| 95 | * @brief Used to modify / optimise the Graph intermediate representation(Operator fusion, in place operations, etc.) |
| 96 | */ |
| 97 | |
| 98 | /** @dir arm_compute/graph/nodes |
| 99 | * @brief The various nodes supported by the graph API. |
| 100 | */ |
| 101 | |
| 102 | /** @dir arm_compute/graph/printers |
| 103 | * @brief Debug printers. |
| 104 | */ |
| 105 | |
| 106 | /** @file arm_compute/graph.h |
| 107 | * @brief Includes all the Graph headers at once. |
| 108 | */ |
| 109 | |
| 110 | /** @dir arm_compute/runtime |
| 111 | * @brief Runtime interface: memory, scheduler, functions. |
| 112 | */ |
| 113 | |
| 114 | /** @dir arm_compute/runtime/CL |
| 115 | * @brief OpenCL backend runtime interface. |
| 116 | */ |
| 117 | |
| 118 | /** @file arm_compute/runtime/CL/CLFunctions.h |
| 119 | * @brief Includes all the OpenCL functions at once |
| 120 | */ |
| 121 | |
| 122 | /** @file arm_compute/runtime/CL/CLScheduler.h |
| 123 | * @brief Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner. |
| 124 | */ |
| 125 | |
| 126 | /** @file arm_compute/runtime/CL/ICLTuner.h |
| 127 | * @brief Interface used to tune the local work-group size of OpenCL kernels. |
| 128 | */ |
| 129 | |
| 130 | /** @dir arm_compute/runtime/CL/functions |
| 131 | * @brief Folder containing all the OpenCL functions. |
| 132 | */ |
| 133 | |
| 134 | /** @dir arm_compute/runtime/CL/tuners |
| 135 | * @brief Local workgroup size tuners for specific architectures / GPUs. |
| 136 | */ |
| 137 | |
| 138 | /** @dir arm_compute/runtime/CPP |
| 139 | * @brief CPP backend runtime interface. |
| 140 | */ |
| 141 | |
| 142 | /** @file arm_compute/runtime/CPP/CPPScheduler.h |
Sheri Zhang | ac6499a | 2021-02-10 15:32:38 +0000 | [diff] [blame] | 143 | * @brief Basic pool of threads to execute CPP/Neon code on several cores in parallel. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 144 | */ |
| 145 | |
| 146 | /** @dir arm_compute/runtime/CPP/functions |
| 147 | * @brief Folder containing all the CPP functions. |
| 148 | */ |
| 149 | |
| 150 | /** @dir arm_compute/runtime/experimental |
| 151 | * @brief Experimental runtime interface. |
| 152 | */ |
| 153 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 154 | /** @dir arm_compute/runtime/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 155 | * @brief Arm® Neon™ backend runtime interface. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 156 | */ |
| 157 | |
| 158 | /** @file arm_compute/runtime/NEON/NEFunctions.h |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 159 | * @brief Includes all the Arm® Neon™ functions at once. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 160 | */ |
| 161 | |
| 162 | /** @dir arm_compute/runtime/NEON/functions |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 163 | * @brief Folder containing all the Arm® Neon™ functions. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 164 | */ |
| 165 | |
| 166 | /** @dir arm_compute/runtime/OMP |
| 167 | * @brief OpenMP backend runtime interface. |
| 168 | */ |
| 169 | |
| 170 | /** @file arm_compute/runtime/OMP/OMPScheduler.h |
| 171 | * @brief OpenMP scheduler (Alternative to the CPPScheduler). |
| 172 | */ |
| 173 | |
| 174 | /** @dir arm_compute/runtime/common |
| 175 | * @brief Common utility code used by all backends. |
| 176 | */ |
| 177 | |
| 178 | /** @dir docs |
| 179 | * @brief Doxyfile and Doxygen sources used to generate this documentation. |
| 180 | */ |
| 181 | |
| 182 | /** @dir ./examples |
| 183 | * @brief Set of examples using the Compute Library |
| 184 | * |
| 185 | * @details Examples have the following structure: |
| 186 | * |
| 187 | * -# cl_*.cpp --> OpenCL examples |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 188 | * -# graph_*.cpp --> Graph examples |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 189 | * -# neoncl_*.cpp --> Arm® Neon™ / OpenCL interoperability examples |
| 190 | * -# neon_*.cpp --> Arm® Neon™ examples |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 191 | */ |
| 192 | |
| 193 | /** @dir examples/gemm_tuner |
| 194 | * @brief OpenCL GEMM tuner utility. |
| 195 | */ |
| 196 | |
| 197 | /** @dir scripts |
| 198 | * @brief Utility scripts. |
| 199 | */ |
| 200 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 201 | /** @dir src |
| 202 | * @brief Source code implementing all the arm_compute headers. |
| 203 | */ |
| 204 | |
Georgios Pinitas | ddb93bb | 2020-10-02 16:38:59 +0100 | [diff] [blame] | 205 | /** @dir src/core/NEON/kernels/detail |
| 206 | * @brief Common code for several intrinsics implementations. |
| 207 | */ |
| 208 | |
| 209 | /** @dir src/core/NEON/wrapper |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 210 | * @brief Arm® Neon™ wrapper used to simplify code |
Georgios Pinitas | ddb93bb | 2020-10-02 16:38:59 +0100 | [diff] [blame] | 211 | */ |
| 212 | |
| 213 | /** @file src/core/NEON/wrapper/traits.h |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 214 | * @brief Traits defined on Arm® Neon™ vectors |
Georgios Pinitas | ddb93bb | 2020-10-02 16:38:59 +0100 | [diff] [blame] | 215 | */ |
| 216 | |
| 217 | /** @file src/core/NEON/wrapper/wrapper.h |
| 218 | * @brief Includes all wrapper headers at once |
| 219 | */ |
| 220 | |
| 221 | /** @dir src/core/NEON/wrapper/intrinsics |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 222 | * @brief Arm® Neon™ intrinsics wrappers |
Georgios Pinitas | ddb93bb | 2020-10-02 16:38:59 +0100 | [diff] [blame] | 223 | */ |
| 224 | |
| 225 | /** @dir src/core/NEON/wrapper/scalar |
| 226 | * @brief Scalar operations |
| 227 | */ |
| 228 | |
Georgios Pinitas | 7891a73 | 2021-08-20 21:39:25 +0100 | [diff] [blame] | 229 | /** @dir src/gpu/cl/kernels/gemm |
Sang-Hoon Park | 68dd25f | 2020-10-19 16:00:11 +0100 | [diff] [blame] | 230 | * @brief Folder containing all the configuration files for GEMM |
| 231 | */ |
| 232 | |
Sang-Hoon Park | bef7fa2 | 2020-10-21 15:58:54 +0100 | [diff] [blame] | 233 | /** @dir src/core/CL/kernels |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 234 | * @brief All the OpenCL kernels |
| 235 | */ |
| 236 | |
| 237 | /** @dir support |
| 238 | * @brief Various headers to work around toolchains / platform issues. |
| 239 | */ |
| 240 | |
| 241 | /** @dir tests |
| 242 | * @brief All test related files shared between validation and benchmark. |
| 243 | */ |
| 244 | |
Michele Di Giorgio | 674d748 | 2020-10-28 17:27:14 +0000 | [diff] [blame] | 245 | /** @file tests/main.cpp |
| 246 | * @brief Main entry point for the tests. Currently shared between validation and benchmarking. |
| 247 | */ |
| 248 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 249 | /** @dir tests/CL |
| 250 | * @brief OpenCL accessors. |
| 251 | */ |
| 252 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 253 | /** @dir tests/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 254 | * @brief Arm® Neon™ accessors. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 255 | */ |
| 256 | |
| 257 | /** @dir tests/benchmark |
| 258 | * @brief Sources for benchmarking. |
| 259 | */ |
| 260 | |
| 261 | /** @dir tests/benchmark/CL |
| 262 | * @brief OpenCL benchmarking tests. |
| 263 | */ |
| 264 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 265 | /** @dir tests/benchmark/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 266 | * @brief Arm® Neon™ benchmarking tests. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 267 | */ |
| 268 | |
| 269 | /** @dir tests/benchmark_examples |
| 270 | * @brief Sources needed to wrap examples to run through our benchmarking framework. |
| 271 | */ |
| 272 | |
| 273 | /** @dir tests/framework |
| 274 | * @brief Boiler plate code for both validation and benchmark test suites (Command line parsers, instruments, output loggers, etc.) |
| 275 | */ |
| 276 | |
| 277 | /** @dir tests/instruments |
| 278 | * @brief User defined instruments that can be registered to the framework. |
| 279 | */ |
| 280 | |
| 281 | /** @dir tests/validate_examples |
| 282 | * @brief Sources needed to wrap examples to run through our validation framework. |
| 283 | */ |
| 284 | |
| 285 | /** @dir tests/validation |
| 286 | * @brief Source for validation. |
| 287 | */ |
| 288 | |
| 289 | /** @dir tests/validation/CL |
| 290 | * @brief OpenCL validation tests. |
| 291 | */ |
| 292 | |
| 293 | /** @dir tests/validation/CPP |
| 294 | * @brief C++ validation tests. |
| 295 | */ |
| 296 | |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 297 | /** @dir tests/validation/NEON |
Michele Di Giorgio | 33f41fa | 2021-03-09 14:09:08 +0000 | [diff] [blame] | 298 | * @brief Arm® Neon™ validation tests. |
Michele Di Giorgio | 552e11d | 2020-09-23 15:08:38 +0100 | [diff] [blame] | 299 | */ |
| 300 | |
| 301 | /** @dir tests/validation/reference |
| 302 | * @brief Reference implementation used to validate the results of the various backends. |
| 303 | */ |