SConscript revision 13512 
1# Copyright 2018 Google, Inc.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met: redistributions of source code must retain the above copyright
6# notice, this list of conditions and the following disclaimer;
7# redistributions in binary form must reproduce the above copyright
8# notice, this list of conditions and the following disclaimer in the
9# documentation and/or other materials provided with the distribution;
10# neither the name of the copyright holders nor the names of its
11# contributors may be used to endorse or promote products derived from
12# this software without specific prior written permission.
13#
14# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
15# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
16# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
17# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
18# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
19# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25#
26# Authors: Gabe Black
27
28from __future__ import print_function
29
30Import('*')
31
32if env['USE_SYSTEMC']:
33
34    from gem5_scons import Transform
35
36    import os.path
37    import json
38
39    src = str(Dir('.').srcdir)
40
41    class SystemCTest(object):
42        def __init__(self, dirname, name):
43            self.name = name
44            self.reldir = os.path.relpath(dirname, src)
45            self.target = os.path.join(self.reldir, name)
46            self.sources = []
47            self.deps = []
48
49            self.compile_only = False
50
51        def add_source(self, source):
52            self.sources.append(os.path.join(self.reldir, source))
53
54        def add_sources(self, sources):
55            for source in sources:
56                self.sources.append(os.path.join(self.reldir, '..', source))
57
58        def properties(self):
59            return {
60                'name' : self.name,
61                'path' : self.reldir,
62                'compile_only' : self.compile_only,
63                'deps' : self.deps
64            }
65
66    test_dir = Dir('.')
67    class SystemCTestBin(Executable):
68        def __init__(self, test):
69            super(SystemCTestBin, self).__init__(test.target, *test.sources)
70            self.reldir = test.reldir
71            self.test_deps = test.deps
72
73        @classmethod
74        def declare_all(cls, env):
75            env = env.Clone()
76
77            # Turn off extra warnings and Werror for the tests.
78            to_remove = ['-Wall', '-Wundef', '-Wextra', '-Werror']
79            env['CCFLAGS'] = \
80                filter(lambda f: f not in to_remove, env['CCFLAGS'])
81
82            env.Append(CPPPATH=test_dir.Dir('include'))
83
84            shared_lib_path = env['SHARED_LIB'][0].abspath
85            sl_dir, sl_base = os.path.split(shared_lib_path)
86            env.Append(LIBPATH=[sl_dir], LIBS=[sl_base])
87
88            super(SystemCTestBin, cls).declare_all(env)
89
90        def declare(self, env):
91            env = env.Clone()
92            sources = list(self.sources)
93            for f in self.filters:
94                sources = Source.all.apply_filter(f)
95            objs = self.srcs_to_objs(env, sources)
96            objs = objs + env['MAIN_OBJS']
97            relpath = os.path.relpath(
98                    env['SHARED_LIB'][0].dir.abspath,
99                    self.path(env).dir.abspath)
100            env.Append(LINKFLAGS=Split('-z origin'))
101            env.Append(RPATH=env.Literal(os.path.join('\\$$ORIGIN', relpath)))
102            test_bin = super(SystemCTestBin, self).declare(env, objs)
103            test_dir = self.dir.Dir(self.reldir)
104            for dep in self.test_deps:
105                env.Depends(test_bin, test_dir.File(dep))
106            return test_bin
107
108    tests = []
109    def new_test(dirname, name):
110        test = SystemCTest(dirname, name)
111        tests.append(test)
112        return test
113
114
115    def scan_dir_for_tests(subdir):
116        def visitor(arg, dirname, names):
117            # If there's a 'DONTRUN' file in this directory, skip it and any
118            # child directories.
119            if 'DONTRUN' in names:
120                del names[:]
121                return
122
123            endswith = lambda sfx: filter(lambda n: n.endswith(sfx), names)
124
125            cpps = endswith('.cpp')
126            if not cpps:
127                return
128
129            def get_entries(fname):
130                with open(os.path.join(dirname, fname)) as content:
131                    lines = content.readlines
132                    # Get rid of leading and trailing whitespace.
133                    lines = map(lambda x: x.strip(), content.readlines())
134                    # Get rid of blank lines.
135                    lines = filter(lambda x: x, lines)
136                    return lines
137
138            # If there's only one source file, then that files name is the test
139            # name, and it's the source for that test.
140            if len(cpps) == 1:
141                cpp = cpps[0]
142
143                test = new_test(dirname, os.path.splitext(cpp)[0])
144                test.add_source(cpp)
145
146            # Otherwise, expect there to be a file that ends in .f. That files
147            # name is the test name, and it will list the source files with
148            # one preceeding path component.
149            else:
150                fs = endswith('.f')
151                if len(fs) != 1:
152                    print("In %s, expected 1 *.f file, but found %d.",
153                          dirname, len(fs))
154                    for f in fs:
155                        print(os.path.join(dirname, f))
156                    return
157                f = fs[0]
158
159                test = new_test(dirname, os.path.splitext(f)[0])
160                # Add all the sources to this test.
161                test.add_sources(get_entries(f))
162
163            if 'COMPILE' in names:
164                test.compile_only = True
165
166            if 'DEPS' in names:
167                test.deps = get_entries('DEPS')
168
169        subdir_src = Dir('.').srcdir.Dir(subdir)
170        os.path.walk(str(subdir_src), visitor, None)
171
172    scan_dir_for_tests('systemc')
173    scan_dir_for_tests('tlm')
174
175
176    def build_tests_json(target, source, env):
177        data = { test.target : test.properties() for test in tests }
178        with open(str(target[0]), "w") as tests_json:
179            json.dump(data, tests_json)
180
181    AlwaysBuild(env.Command(File('tests.json'), None,
182                MakeAction(build_tests_json, Transform("TESTJSON"))))
183
184
185    for test in tests:
186        SystemCTestBin(test)
187