SConscript

   1 # Copyright (c) 2016, 2017 ARM Limited.
   2 #
   3 # SPDX-License-Identifier: MIT
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to
   7 # deal in the Software without restriction, including without limitation the
   8 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   9 # sell copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in all
  13 # copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 # SOFTWARE.
  22 import collections
  23 import os.path
  24 import re
  25 import subprocess
  26
  27 VERSION = "v18.01"
  28 SONAME_VERSION="7.0.0"
  29
  30 Import('env')
  31 Import('vars')
  32
  33 def build_library(name, sources, static=False, libs=[]):
  34     if static:
  35         obj = arm_compute_env.StaticLibrary(name, source=sources, LIBS = arm_compute_env["LIBS"] + libs)
  36     else:
  37         if env['set_soname']:
  38             obj = arm_compute_env.SharedLibrary(name, source=sources, SHLIBVERSION = SONAME_VERSION, LIBS = arm_compute_env["LIBS"] + libs)
  39
  40             symlinks = []
  41             # Manually delete symlinks or SCons will get confused:
  42             directory = os.path.dirname(obj[0].path)
  43             library_prefix = obj[0].path[:-(1 + len(SONAME_VERSION))]
  44             real_lib = "%s.%s" % (library_prefix, SONAME_VERSION)
  45
  46             for f in Glob("#%s*" % library_prefix):
  47                 if str(f) != real_lib:
  48                     symlinks.append("%s/%s" % (directory,str(f)))
  49
  50             clean = arm_compute_env.Command('clean-%s' % str(obj[0]), [], Delete(symlinks))
  51             Default(clean)
  52             Depends(obj, clean)
  53         else:
  54             obj = arm_compute_env.SharedLibrary(name, source=sources, LIBS = arm_compute_env["LIBS"] + libs)
  55
  56     Default(obj)
  57     return obj
  58
  59 def resolve_includes(target, source, env):
  60     # File collection
  61     FileEntry = collections.namedtuple('FileEntry', 'target_name file_contents')
  62
  63     # Include pattern
  64     pattern = re.compile("#include \"(.*)\"")
  65
  66     # Get file contents
  67     files = []
  68     for i in range(len(source)):
  69         src = source[i]
  70         dst = target[i]
  71         contents = src.get_contents().splitlines()
  72         entry = FileEntry(target_name=dst, file_contents=contents)
  73         files.append((os.path.basename(src.get_path()),entry))
  74
  75     # Create dictionary of tupled list
  76     files_dict = dict(files)
  77
  78     # Check for includes (can only be files in the same folder)
  79     final_files = []
  80     for file in files:
  81         done = False
  82         tmp_file = file[1].file_contents
  83         while not done:
  84             file_count = 0
  85             updated_file = []
  86             for line in tmp_file:
  87                 found = pattern.search(line)
  88                 if found:
  89                     include_file = found.group(1)
  90                     data = files_dict[include_file].file_contents
  91                     updated_file.extend(data)
  92                 else:
  93                     updated_file.append(line)
  94                     file_count += 1
  95
  96             # Check if all include are replaced.
  97             if file_count == len(tmp_file):
  98                 done = True
  99
 100             # Update temp file
 101             tmp_file = updated_file
 102
 103         # Append and prepend string literal identifiers and add expanded file to final list
 104         tmp_file.insert(0, "R\"(\n")
 105         tmp_file.append("\n)\"")
 106         entry = FileEntry(target_name=file[1].target_name, file_contents=tmp_file)
 107         final_files.append((file[0], entry))
 108
 109     # Write output files
 110     for file in final_files:
 111         with open(file[1].target_name.get_path(), 'w+') as out_file:
 112             out_file.write( "\n".join( file[1].file_contents ))
 113
 114 def create_version_file(target, source, env):
 115 # Generate string with build options library version to embed in the library:
 116     try:
 117         git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"])
 118     except (OSError, subprocess.CalledProcessError):
 119         git_hash="unknown"
 120
 121     version_filename = "%s/arm_compute_version.embed" % Dir("src/core").path
 122     build_info = "\"arm_compute_version=%s Build options: %s Git hash=%s\"" % (VERSION, vars.args, git_hash.strip())
 123     with open(target[0].get_path(), "w") as fd:
 124         fd.write(build_info)
 125
 126
 127 arm_compute_env = env.Clone()
 128 # Don't allow undefined references in the libraries:
 129 arm_compute_env.Append(LINKFLAGS=['-Wl,--no-undefined','-Wl,--no-allow-shlib-undefined'])
 130
 131 generate_embed = [ arm_compute_env.Command("src/core/arm_compute_version.embed", "", action=create_version_file) ]
 132 arm_compute_env.Append(CPPPATH =[Dir("./src/core/").path] )
 133
 134 if env["os"] not in ["android", "bare_metal"]:
 135     arm_compute_env.Append(LIBS = ['pthread'])
 136
 137 arm_compute_env.Append(LIBS = ['dl'])
 138
 139 core_files = Glob('src/core/*.cpp')
 140 core_files += Glob('src/core/CPP/*.cpp')
 141 core_files += Glob('src/core/CPP/kernels/*.cpp')
 142 core_files += Glob('src/core/utils/*/*.cpp')
 143
 144 runtime_files = Glob('src/runtime/*.cpp')
 145 runtime_files += Glob('src/runtime/CPP/ICPPSimpleFunction.cpp')
 146 runtime_files += Glob('src/runtime/CPP/functions/*.cpp')
 147
 148 # CLHarrisCorners uses the Scheduler to run CPP kernels
 149 runtime_files += Glob('src/runtime/CPP/SingleThreadScheduler.cpp')
 150
 151 if env['cppthreads']:
 152      runtime_files += Glob('src/runtime/CPP/CPPScheduler.cpp')
 153
 154 if env['openmp']:
 155      runtime_files += Glob('src/runtime/OMP/OMPScheduler.cpp')
 156
 157 if env['opencl']:
 158     core_files += Glob('src/core/CL/*.cpp')
 159     core_files += Glob('src/core/CL/kernels/*.cpp')
 160
 161     runtime_files += Glob('src/runtime/CL/*.cpp')
 162     runtime_files += Glob('src/runtime/CL/functions/*.cpp')
 163
 164     # Generate embed files
 165     if env['embed_kernels']:
 166         cl_files = Glob('src/core/CL/cl_kernels/*.cl')
 167         cl_files += Glob('src/core/CL/cl_kernels/*.h')
 168
 169         embed_files = [ f.get_path()+"embed" for f in cl_files ]
 170         arm_compute_env.Append(CPPPATH =[Dir("./src/core/CL/").path] )
 171
 172         generate_embed.append(arm_compute_env.Command(embed_files, cl_files, action=resolve_includes))
 173
 174 if env['neon']:
 175     core_files += Glob('src/core/NEON/*.cpp')
 176     core_files += Glob('src/core/NEON/kernels/*.cpp')
 177
 178     # build winograd sources for either v7a / v8a
 179     core_files += Glob('src/core/NEON/kernels/winograd/*.cpp')
 180     core_files += Glob('src/core/NEON/kernels/winograd/transforms/*.cpp')
 181     arm_compute_env.Append(CPPPATH = ["arm_compute/core/NEON/kernels/winograd/"])
 182
 183     if env['arch'] == "armv7a":
 184         core_files += Glob('src/core/NEON/kernels/arm32/*.cpp')
 185
 186     if "arm64-v8" in env['arch']:
 187         core_files += Glob('src/core/NEON/kernels/arm64/*.cpp')
 188
 189     runtime_files += Glob('src/runtime/NEON/*.cpp')
 190     runtime_files += Glob('src/runtime/NEON/functions/*.cpp')
 191
 192 if env['gles_compute']:
 193     if env['os'] != 'android':
 194         arm_compute_env.Append(CPPPATH = ["#opengles-3.1/include", "#opengles-3.1/mali_include"])
 195
 196     core_files += Glob('src/core/GLES_COMPUTE/*.cpp')
 197     core_files += Glob('src/core/GLES_COMPUTE/kernels/*.cpp')
 198
 199     runtime_files += Glob('src/runtime/GLES_COMPUTE/*.cpp')
 200     runtime_files += Glob('src/runtime/GLES_COMPUTE/functions/*.cpp')
 201
 202     # Generate embed files
 203     if env['embed_kernels']:
 204         cs_files = Glob('src/core/GLES_COMPUTE/cs_shaders/*.cs')
 205         cs_files += Glob('src/core/GLES_COMPUTE/cs_shaders/*.h')
 206
 207         embed_files = [ f.get_path()+"embed" for f in cs_files ]
 208         arm_compute_env.Append(CPPPATH =[Dir("./src/core/GLES_COMPUTE/").path] )
 209
 210         generate_embed.append(arm_compute_env.Command(embed_files, cs_files, action=resolve_includes))
 211
 212 arm_compute_core_a = build_library('arm_compute_core-static', core_files, static=True)
 213 Export('arm_compute_core_a')
 214
 215 if env['os'] != 'bare_metal' and not env['standalone']:
 216     arm_compute_core_so = build_library('arm_compute_core', core_files, static=False)
 217     Export('arm_compute_core_so')
 218
 219 arm_compute_a = build_library('arm_compute-static', runtime_files, static=True, libs = [ arm_compute_core_a ])
 220 Export('arm_compute_a')
 221
 222 if env['os'] != 'bare_metal' and not env['standalone']:
 223     arm_compute_so = build_library('arm_compute', runtime_files, static=False, libs = [ "arm_compute_core" ])
 224     Depends(arm_compute_so, arm_compute_core_so)
 225     Export('arm_compute_so')
 226
 227 if env['neon'] and env['opencl']:
 228     Import('opencl')
 229     graph_files = Glob('src/graph/*.cpp')
 230     graph_files += Glob('src/graph/nodes/*.cpp')
 231     graph_files += Glob('src/graph/operations/*.cpp')
 232
 233     graph_files += Glob('src/graph/CL/*.cpp')
 234     graph_files += Glob('src/graph/NEON/*.cpp')
 235
 236     shared_graph_objects = [arm_compute_env.SharedObject(f) for f in graph_files]
 237     static_graph_objects = [arm_compute_env.StaticObject(f) for f in graph_files]
 238
 239     arm_compute_graph_a = build_library('arm_compute_graph-static', static_graph_objects, static=True, libs = [ arm_compute_a ])
 240     Export('arm_compute_graph_a')
 241
 242     arm_compute_env.Append(LIBPATH = ["#build/%s/opencl-1.2-stubs" % env['build_dir']])
 243     arm_compute_graph_so = build_library('arm_compute_graph', shared_graph_objects, static=False, libs = [ "arm_compute", "arm_compute_core"])
 244     Depends(arm_compute_graph_so, arm_compute_so)
 245     Depends(arm_compute_graph_so, opencl)
 246     Export('arm_compute_graph_so')
 247
 248     graph_alias = arm_compute_env.Alias("arm_compute_graph", [arm_compute_graph_a, arm_compute_graph_so])
 249     Default(graph_alias)
 250
 251 if env['standalone']:
 252     alias = arm_compute_env.Alias("arm_compute", [arm_compute_a])
 253 else:
 254     alias = arm_compute_env.Alias("arm_compute", [arm_compute_a, arm_compute_so])
 255
 256 Default(alias)
 257
 258 Default(generate_embed)
 259
 260 if env['standalone']:
 261     Depends([alias,arm_compute_core_a], generate_embed)
 262 else:
 263     Depends([alias,arm_compute_core_so, arm_compute_core_a], generate_embed)