aboutsummaryrefslogtreecommitdiff
path: root/Makefile
blob: 60e17bbc4ae37fc02563534e33620d7c9b21e335 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
#
# Copyright (c) 2019 Nutanix Inc. All rights reserved.
#
# Authors: Thanos Makatos <thanos@nutanix.com>
#          Swapnil Ingle <swapnil.ingle@nutanix.com>
#          Felipe Franciosi <felipe@nutanix.com>
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * 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.
#     * Neither the name of Nutanix 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 <COPYRIGHT HOLDER> 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.
#

BUILD_TYPE ?= dbg

ifeq ($(BUILD_TYPE), dbg)
	CMAKE_BUILD_TYPE = Debug
    CFLAGS += -DDEBUG
else
	CMAKE_BUILD_TYPE = Release
endif

ifdef WITH_ASAN
	CC = clang
	CFLAGS += -fsanitize=address
	LDFLAGS += -fsanitize=address
endif

ifeq ($(MAKECMDGOALS), gcov)
	CFLAGS += --coverage
	LDFLAGS += --coverage
endif

ifeq ($(VERBOSE),)
    MAKEFLAGS += -s
endif

GIT_SHA = $(shell git rev-parse --short HEAD)
CMAKE = $(shell bash -c "command -v cmake3 cmake" | head -1)
RSTLINT = $(shell bash -c "command -v restructuredtext-lint /bin/true" | head -1)
FLAKE8 = $(shell bash -c "command -v flake8 /bin/true" | head -1)

BUILD_DIR_BASE = $(CURDIR)/build
BUILD_DIR = $(BUILD_DIR_BASE)/$(BUILD_TYPE)

INSTALL_PREFIX ?= /usr/local

.PHONY: all install test pytest pytest-valgrind
.PHONY: pre-push clean realclean tags gcov

all install: $(BUILD_DIR)/Makefile
	+$(MAKE) -C $(BUILD_DIR) $@

#
# NB: add --capture=no to get a C-level assert failure output.
#
PYTESTCMD = \
    $(shell bash -c "command -v pytest-3 /bin/true" | head -1) \
    -rP --quiet

PYTEST = \
    BUILD_TYPE=$(BUILD_TYPE) $(PYTESTCMD)

#
# In our tests, we make sure to destroy the ctx at the end of each test; this is
# enough for these settings to detect (most?) library leaks as "definite",
# without all the noise from the rest of the Python runtime.
#
# As running under valgrind is very slow, we don't run this unless requested.
#
PYTESTVALGRIND = \
	BUILD_TYPE=$(BUILD_TYPE) \
	PYTHONMALLOC=malloc \
	valgrind \
	--suppressions=$(CURDIR)/test/py/valgrind.supp \
	--quiet \
	--track-origins=yes \
	--errors-for-leak-kinds=definite \
	--show-leak-kinds=definite \
	--leak-check=full \
	--error-exitcode=1 \
	$(PYTESTCMD)

ifdef WITH_ASAN

pytest pytest-valgrind:

else

pytest: all
	@echo "=== Running python tests ==="
ifeq ($(PYTESTCMD), /bin/true -rP --quiet)
	@echo "No pytest-3 found in system. Try 'apt-get install python3-pytest' or 'which pytest-3'"
	@echo "0 Python tests run"
endif
	$(PYTEST)

pytest-valgrind: all
	@echo "=== Running python tests with valgrind ==="
	$(PYTESTVALGRIND)

endif

ifdef WITH_GCOV
test: all pytest
else
test: all pytest
endif
	cd $(BUILD_DIR)/test; ctest --verbose

pre-push: realclean
	$(RSTLINT) docs/vfio-user.rst
	$(FLAKE8) --extend-ignore=F405,F403,E128,E131,E127 $$(find . -name '*.py')
	make test WITH_ASAN=1
	make realclean
	make test CC=clang BUILD_TYPE=rel
	make test CC=clang
	make realclean
	make test CC=gcc BUILD_TYPE=rel
	make test CC=gcc
	make pytest-valgrind
	make install DESTDIR=tmp.install

coverity: realclean
	curl -sS -L -o coverity.tar.gz -d "token=$$COVERITY_TOKEN&project=nutanix%2Flibvfio-user" https://scan.coverity.com/download/cxx/linux64
	tar xf coverity.tar.gz
	./cov-analysis-linux64-*/bin/cov-build --dir cov-int make -j4 all
	tar czf coverity-results.tar.gz cov-int
	curl --form token=$$COVERITY_TOKEN --form email=$$COVERITY_EMAIL --form file=@coverity-results.tar.gz --form version="$(GIT_SHA)"  https://scan.coverity.com/builds?project=nutanix%2Flibvfio-user

GCOVS=$(patsubst %.c,%.c.gcov, $(wildcard lib/*.c))

gcov: realclean test $(GCOVS)

clean:
	rm -rf $(BUILD_DIR)

realclean:
	rm -rf $(BUILD_DIR_BASE)
	rm -rf $(GCOVS)

$(BUILD_DIR)/Makefile:
ifneq (,$(filter -DNDEBUG,$(CFLAGS)))
	$(error -DNDEBUG flag is not supported)
endif
	mkdir -p $(BUILD_DIR)
	cd $(BUILD_DIR); $(CMAKE) \
		-D "CMAKE_C_COMPILER:STRING=$(CC)" \
		-D "CMAKE_C_FLAGS:STRING=$(CFLAGS)" \
		-D "CMAKE_BUILD_TYPE:STRING=$(CMAKE_BUILD_TYPE)" \
		-D "CMAKE_INSTALL_PREFIX=$(INSTALL_PREFIX)" \
		-D "WITH_ASAN=$(WITH_ASAN)" \
		$(CURDIR)

tags:
	ctags -R --exclude=$(BUILD_DIR)

lib/%.c.gcov: lib/%.c
	cd lib && gcov -o ../build/$(BUILD_TYPE)/lib/CMakeFiles/$*.dir/$*.gcno $<