Files
gem5/util/tlm/SConstruct
Alex Richardson 5e096f5b5d scons: allow building without duplicating source files
This adds a new scons flag --no-duplicate-sources to build without
linking source files to the build directory.

I find this very helpful when using CLion, since I can now generate a
compilation database using
`bear scons build/ALL/gem5.debug --no-duplicate-sources` and CLion will
now correctly semantically analyze all the files inside src/.
It also ensures that clicking on a build warning/error now opens the
real source file rather than a symlink.

This is not enabled by default since it's possible that certain use
cases are not working correctly, but the basic testing I've done so
far appears to work just fine.

It appears that with this change the `<root>/src` directory is no longer
added to `PYTHONPATH` when running `tests/main.py`, so this change
depends on https://gem5-review.git.corp.google.com/c/public/gem5/+/68757

Change-Id: Iddc9bf9c8211e68e5432c0a07f5c95f427c1ca16
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/68518
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Bobby Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby Bruce <bbruce@ucdavis.edu>
2023-04-05 22:00:07 +00:00

105 lines
4.0 KiB
Python

#!python
# Copyright (c) 2016, Dresden University of Technology (TU Dresden)
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
# OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
import os
import sys
gem5_arch = 'ARM'
gem5_variant = 'opt'
#gem5_variant = 'debug'
gem5_root = Dir('#../..').srcnode().abspath
env = Environment()
#Make the gem5 root available in SConscripts
env['GEM5_ROOT'] = gem5_root
shlibsuffix = env['SHLIBSUFFIX']
# add include dirs
env.Append(CPPPATH=[gem5_root + '/build/' + gem5_arch,
gem5_root + '/util/systemc/gem5_within_systemc',
gem5_root + '/ext/systemc/src',
gem5_root + '/ext',
'#src',
'#examples/common',
])
env.Append(CXXFLAGS=['-std=c++17',
'-DSC_INCLUDE_DYNAMIC_PROCESSES',
'-DTRACING_ON',
])
if gem5_variant == 'debug':
env.Append(CXXFLAGS=['-g', '-DGEM5_DEBUG'])
deps = [] # keep track of all dependencies required for building the binaries
deps += SConscript('src/SConscript', variant_dir='build/tlm', exports='env',
duplicate=GetOption('duplicate_sources'))
deps += SConscript('examples/common/SConscript',
variant_dir='build/examples/common',
exports=['env'],
duplicate=GetOption('duplicate_sources'))
# the SystemC SConscript makes certain assumptions, we need to fulfill these
# assumptions before calling the SConscript.
sys.path.append(gem5_root + '/src/python')
AddOption('--no-colors', dest='use_colors', action='store_false',
help="Don't add color to abbreviated scons output")
env.SConsignFile('build/systemc/sconsign')
SConscript(gem5_root + '/ext/systemc/SConscript',
variant_dir='build/systemc',
exports='env', duplicate=GetOption('duplicate_sources'))
# By adding libraries as dependencies instead of using LIBS, we avoid that
# the user needs to set the LD_LIBRARY_PATH
deps.append(File('build/systemc/libsystemc' + shlibsuffix))
deps.append(File(os.path.join(gem5_root, 'build', gem5_arch,
'libgem5_' + gem5_variant + shlibsuffix)))
ex_master = SConscript('examples/master_port/SConscript',
variant_dir='build/examples/master_port',
exports=['env', 'deps'],
duplicate=GetOption('duplicate_sources'))
ex_slave = SConscript('examples/slave_port/SConscript',
variant_dir='build/examples/slave_port',
exports=['env', 'deps'],
duplicate=GetOption('duplicate_sources'))
Default(ex_master + ex_slave)