diff --git a/ci/ci-install.bash b/ci/ci-install.bash index 96a223c81..668400b07 100755 --- a/ci/ci-install.bash +++ b/ci/ci-install.bash @@ -71,8 +71,8 @@ if [ "$CI_BUILD_STAGE_NAME" = "build" ]; then sudo apt-get install libsystemc libsystemc-dev fi if [ "$CI_RUNS_ON" = "ubuntu-22.04" ]; then - sudo apt-get install mold || - sudo apt-get install mold + sudo apt-get install bear mold || + sudo apt-get install bear mold fi if [ "$COVERAGE" = 1 ]; then yes yes | sudo cpan -fi Parallel::Forker diff --git a/docs/guide/install.rst b/docs/guide/install.rst index 81da117c9..33a90f92c 100644 --- a/docs/guide/install.rst +++ b/docs/guide/install.rst @@ -126,7 +126,7 @@ Those developing Verilator itself may also want these (see internals.rst): :: sudo apt-get install clang clang-format-14 cmake gdb gprof graphviz lcov - sudo apt-get install libclang-dev yapf3 + sudo apt-get install libclang-dev yapf3 bear sudo pip3 install clang sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe ruff cpan install Pod::Perldoc cpan install Parallel::Forker diff --git a/nodist/clang_check_attributes b/nodist/clang_check_attributes index 50409714a..9aacc015f 100755 --- a/nodist/clang_check_attributes +++ b/nodist/clang_check_attributes @@ -19,7 +19,13 @@ import multiprocessing import tempfile import clang.cindex -from clang.cindex import CursorKind, Index, TranslationUnitSaveError, TranslationUnitLoadError +from clang.cindex import ( + CursorKind, + Index, + TranslationUnitSaveError, + TranslationUnitLoadError, + CompilationDatabase, +) def fully_qualified_name(node): @@ -761,7 +767,7 @@ def run_analysis(ccl: Iterable[CompileCommand], pccl: Iterable[CompileCommand], is_ignored_def, is_ignored_call) for compile_command in ccl: cav.compile_and_analyze_file(compile_command.filename, - compile_command.args + extra_args, + extra_args + compile_command.args, compile_command.directory) @@ -947,10 +953,15 @@ def main(): type=int, default=0, help="Number of parallel jobs to use.") + parser.add_argument( + "--compile-commands-dir", + type=str, + default=None, + help="Path to directory containing compile_commands.json.") parser.add_argument("--cxxflags", type=str, default=None, - help="Flags passed to clang++.") + help="Extra flags passed to clang++.") parser.add_argument( "--compilation-root", type=str, @@ -975,34 +986,52 @@ def main(): cmdline.compilation_root = cmdline.verilator_root verilator_root = os.path.abspath(cmdline.verilator_root) - compilation_root = os.path.abspath(cmdline.compilation_root) + default_compilation_root = os.path.abspath(cmdline.compilation_root) + + compdb: Optional[CompilationDatabase] = None + if cmdline.compile_commands_dir: + compdb = CompilationDatabase.fromDirectory( + cmdline.compile_commands_dir) - default_cxx_flags = [ - f"-I{verilator_root}/src", - f"-I{verilator_root}/include", - f"-I{verilator_root}/src/obj_opt", - "-fcoroutines-ts", - ] if cmdline.cxxflags is not None: - cxxflags = shlex.split(cmdline.cxxflags) + common_cxxflags = shlex.split(cmdline.cxxflags) else: - cxxflags = default_cxx_flags + common_cxxflags = [] precompile_commands_list = [] if cmdline.precompile: - hdr_cxxflags = ['-xc++-header'] + cxxflags + hdr_cxxflags = ['-xc++-header'] + common_cxxflags for refid, file in enumerate(cmdline.precompile): filename = os.path.abspath(file) compile_command = CompileCommand(refid, filename, hdr_cxxflags, - compilation_root) + default_compilation_root) precompile_commands_list.append(compile_command) compile_commands_list = [] for refid, file in enumerate(cmdline.file): filename = os.path.abspath(file) - compile_command = CompileCommand(refid, filename, cxxflags, - compilation_root) + root = default_compilation_root + cxxflags = [] + if compdb: + entry = compdb.getCompileCommands(filename) + entry_list = list(entry) + # Compilation database can contain multiple entries for single file, + # e.g. when it has been updated by appending new entries. + # Use last entry for the file, if it exists, as it is the newest one. + if len(entry_list) > 0: + last_entry = entry_list[-1] + root = last_entry.directory + entry_args = list(last_entry.arguments) + # First argument in compile_commands.json arguments list is + # compiler executable name/path. CIndex (libclang) always + # implicitly prepends executable name, so it shouldn't be passed + # here. + cxxflags = common_cxxflags + entry_args[1:] + else: + cxxflags = common_cxxflags[:] + + compile_command = CompileCommand(refid, filename, cxxflags, root) compile_commands_list.append(compile_command) summary_printer = TopDownSummaryPrinter() diff --git a/src/Makefile.in b/src/Makefile.in index a1af5cf21..9a77cfbf1 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -18,14 +18,13 @@ #### Start of system configuration section. #### srcdir = @srcdir@ -PYTHON3 = @PYTHON3@ EXEEXT = @EXEEXT@ +PYTHON3 = @PYTHON3@ # VPATH only does sources; fix install_test's not creating ../bin vpath %.h @srcdir@ #### End of system configuration section. #### - default: dbg opt debug: dbg optimize: opt @@ -36,6 +35,26 @@ endif UNDER_GIT = $(wildcard ${srcdir}/../.git/logs/HEAD) +ifeq (,$(wildcard obj_dbg/bear.o)) + ifneq (, $(shell which bear 2>/dev/null)) + BEAR := $(shell which bear) + ifeq (, $(shell $(BEAR) --output obj_dbg/comptest.json -- true)) + $(shell which bear 2>/dev/null >obj_dbg/bear.o) + else + # unsupported version + BEAR := + endif + endif +else + BEAR := $(shell cat obj_dbg/bear.o) +endif + +ifneq ($(BEAR),) +BEAR_OBJ_OPT := $(BEAR) --append --output obj_dbg/compile_commands.json -- +else +BEAR_OBJ_OPT := +endif + #********************************************************************* obj_opt: @@ -62,8 +81,8 @@ endif dbg: ../bin/verilator_bin_dbg$(EXEEXT) ../bin/verilator_coverage_bin_dbg$(EXEEXT) ../bin/verilator_bin_dbg$(EXEEXT): obj_dbg ../bin prefiles - $(MAKE) -C obj_dbg -j 1 TGT=../$@ VL_DEBUG=1 -f ../Makefile_obj serial - $(MAKE) -C obj_dbg TGT=../$@ VL_DEBUG=1 -f ../Makefile_obj + $(BEAR_OBJ_OPT) $(MAKE) -C obj_dbg -j 1 TGT=../$@ VL_DEBUG=1 -f ../Makefile_obj serial + $(BEAR_OBJ_OPT) $(MAKE) -C obj_dbg TGT=../$@ VL_DEBUG=1 -f ../Makefile_obj ../bin/verilator_coverage_bin_dbg$(EXEEXT): obj_dbg ../bin prefiles $(MAKE) -C obj_dbg TGT=../$@ VL_DEBUG=1 VL_VLCOV=1 -f ../Makefile_obj serial_vlcov