Makefile

# Copyright 2021 Max Planck Institute for Software Systems, and
# National University of Singapore
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-include mk/local.mk
include mk/subdir_pre.mk
include mk/recipes.mk

base_dir := $(d)./

CPPLINT ?= cpplint
CLANG_TIDY ?= clang-tidy
CLANG_FORMAT ?= clang-format
CFLAGS += -Wall -Wextra -Wno-unused-parameter -O3 -fPIC -std=gnu11 $(EXTRA_CFLAGS)
CXXFLAGS += -Wall -Wextra -Wno-unused-parameter -O3 -fPIC -std=gnu++17 $(EXTRA_CXXFLAGS)
CPPFLAGS += -I$(base_dir)/lib -iquote$(base_dir) $(EXTRA_CPPFLAGS)

VERILATOR = verilator
VFLAGS = +1364-2005ext+v \
    -Wno-WIDTH -Wno-PINMISSING -Wno-LITENDIAN -Wno-IMPLICIT -Wno-SELRANGE \
    -Wno-CASEINCOMPLETE -Wno-UNSIGNED $(EXTRA_VFLAGS)


$(eval $(call subdir,docker))
$(eval $(call subdir,lib))
$(eval $(call subdir,sims))
$(eval $(call subdir,dist))
$(eval $(call subdir,doc))
$(eval $(call subdir,images))


all: $(ALL_ALL)
.DEFAULT_GOAL := all

clean:
	rm -rf $(CLEAN_ALL)

clean-external: $(EXTERNAL_CLEAN_TASKS_ALL)

clean-all: clean clean-external

distclean:
	rm -rf $(CLEAN_ALL) $(DISTCLEAN_ALL)

lint-cpplint:
	$(CPPLINT) --quiet --recursive .

lint-clang-tidy:
	./.clang-tidy-wrapper.sh $(CLANG_TIDY) -I$(base_dir) -I$(base_dir)lib \
	    -I/usr/share/verilator/include

clang-format:
	$(CLANG_FORMAT) -i --style=file `cat .lint-files`

lint-clang-format:
	$(CLANG_FORMAT) --Werror --dry-run --style=file `cat .lint-files`

lint-yapf:
	yapf --recursive --diff \
		--exclude experiments/simbricks/orchestration/utils/graphlib.py \
		-- results/ experiments/ doc/

format-yapf:
	yapf --recursive --in-place \
		--exclude experiments/simbricks/orchestration/utils/graphlib.py \
		--exclude experiments/out/ \
		-- results/ experiments/ doc/

lint-isort:
	isort --diff \
		--skip experiments/simbricks/orchestration/utils/graphlib.py \
		results/ experiments/ doc/

format-isort:
	isort --skip experiments/simbricks/orchestration/utils/graphlib.py \
		results/ experiments/ doc/

lint-pylint:
	pylint -d missing-module-docstring,missing-class-docstring \
		--ignore-paths experiments/simbricks/orchestration/utils/graphlib.py \
	  	experiments/ results/

typecheck-python:
	pytype -j 0 --keep-going \
		--exclude experiments/pyexps/ae/ \
			experiments/simbricks/orchestration/utils/graphlib.py \
		-- experiments/ results/

lint-python: lint-pylint typecheck-python
lint: lint-cpplint lint-clang-format lint-python
lint-all: lint lint-clang-tidy

help:
	@echo "Targets:"
	@echo "  all: builds all the tools directly in this repo"
	@echo "  clean: cleans all the tool folders in this repo"
	@echo "  clean-external: cleans all external simulators"
	@echo "  clean-all: executes both clean and clean-external"
	@echo "  build-images: prepare prereqs for VMs (images directory)"
	@echo "  build-images-min: prepare minimal prereqs for VMs"
	@echo "  documentation: build documentation in doc/build_"
	@echo "  external: clone and build our tools in external repos "
	@echo "            (qemu, gem5, ns-3)"
	@echo "  lint: run quick format and style checks"
	@echo "  lint-all: run slow & thorough format and style checks"
	@echo "  clang-format: reformat source (use with caution)"

.PHONY: all clean clean-external clean-all distclean lint lint-all \
	lint-cpplint lint-clang-tidy lint-clang-format clang-format help

include mk/subdir_post.mk
-include $(DEPS_ALL)