reduce polling and resume overhead by checking if inflight request exists
[vpp.git] / dpdk / Makefile
1 # Copyright (c) 2015 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 # Scripts require non-POSIX parts of bash
15 SHELL := /bin/bash
16
17 DPDK_BUILD_DIR        ?= $(CURDIR)/_build
18 DPDK_INSTALL_DIR      ?= $(CURDIR)/_install
19 DPDK_PKTMBUF_HEADROOM ?= 128
20 DPDK_CACHE_LINE_SIZE  ?= 64
21 DPDK_DOWNLOAD_DIR     ?= $(HOME)/Downloads
22 DPDK_DEBUG            ?= n
23 DPDK_MLX4_PMD         ?= n
24 DPDK_MLX5_PMD         ?= n
25 DPDK_TAP_PMD          ?= n
26 DPDK_FAILSAFE_PMD     ?= n
27
28 B := $(DPDK_BUILD_DIR)
29 I := $(DPDK_INSTALL_DIR)
30 DPDK_VERSION ?= 18.05
31 PKG_SUFFIX ?= vpp2
32 DPDK_BASE_URL ?= http://fast.dpdk.org/rel
33 DPDK_TARBALL := dpdk-$(DPDK_VERSION).tar.xz
34 DPDK_TAR_URL := $(DPDK_BASE_URL)/$(DPDK_TARBALL)
35 DPDK_18.05_TARBALL_MD5_CKSUM := 9fc86367cd9407ff6a8dfea56c4eddc4
36 DPDK_18.08_TARBALL_MD5_CKSUM := da5e7fb25ab063c47e53929fb8c58be5
37 MACHINE=$(shell uname -m)
38
39 # replace dot with space, and if 3rd word exists we deal with stable dpdk rel
40 ifeq ($(word 3,$(subst ., ,$(DPDK_VERSION))),)
41 DPDK_SOURCE := $(B)/dpdk-$(DPDK_VERSION)
42 else
43 DPDK_SOURCE := $(B)/dpdk-stable-$(DPDK_VERSION)
44 endif
45
46 NASM_BASE_URL := http://www.nasm.us/pub/nasm/releasebuilds
47 NASM_VER := 2.13.01
48 NASM_TARBALL := nasm-$(NASM_VER).tar.xz
49 NASM_TAR_URL := $(NASM_BASE_URL)/$(NASM_VER)/$(NASM_TARBALL)
50 NASM_SOURCE := $(B)/nasm-$(NASM_VER)
51
52 ifneq (,$(findstring 18.02,$(DPDK_VERSION)))
53 IPSEC_MB_VER ?= 0.48
54 else
55 IPSEC_MB_VER ?= 0.49
56 endif
57
58 ifeq ($(MACHINE),$(filter $(MACHINE),x86_64))
59   AESNI ?= y
60 $(info Building IPSec-MB $(IPSEC_MB_VER) library)
61 else
62   AESNI ?= N
63 endif
64
65 AESNIMB_LIB_TARBALL := v$(IPSEC_MB_VER).tar.gz
66 AESNIMB_LIB_TARBALL_URL := http://github.com/01org/intel-ipsec-mb/archive/$(AESNIMB_LIB_TARBALL)
67 AESNIMB_LIB_SOURCE := $(B)/intel-ipsec-mb-$(IPSEC_MB_VER)
68
69 ifneq (,$(findstring clang,$(CC)))
70 DPDK_CC=clang
71 else ifneq (,$(findstring icc,$(CC)))
72 DPDK_CC=icc
73 else
74 DPDK_CC=gcc
75 endif
76
77 ##############################################################################
78 # Intel x86
79 ##############################################################################
80 ifeq ($(MACHINE),$(filter $(MACHINE),x86_64 i686))
81 DPDK_TARGET           ?= $(MACHINE)-native-linuxapp-$(DPDK_CC)
82 DPDK_MACHINE          ?= nhm
83 DPDK_TUNE             ?= core-avx2
84
85 ##############################################################################
86 # ARM64
87 ##############################################################################
88 else ifeq ($(MACHINE),aarch64)
89 CROSS :=
90 export CROSS
91 DPDK_TARGET           ?= arm64-armv8a-linuxapp-$(DPDK_CC)
92 DPDK_MACHINE          ?= armv8a
93 DPDK_TUNE             ?= generic
94
95 CPU_IMP_ARM                     = 0x41
96 CPU_IMP_CAVIUM                  = 0x43
97
98 CPU_PART_ARM_CORTEX_A53         = 0xd03
99 CPU_PART_ARM_CORTEX_A57         = 0xd07
100 CPU_PART_ARM_CORTEX_A72         = 0xd08
101 CPU_PART_ARM_CORTEX_A73         = 0xd09
102
103 CPU_PART_CAVIUM_THUNDERX        = 0x0a1
104 CPU_PART_CAVIUM_THUNDERX_81XX   = 0x0a2
105 CPU_PART_CAVIUM_THUNDERX_83XX   = 0x0a3
106
107 MIDR_IMPLEMENTER=$(shell awk '/implementer/ {print $$4;exit}' /proc/cpuinfo)
108 MIDR_PARTNUM=$(shell awk '/part/ {print $$4;exit}' /proc/cpuinfo)
109
110 ifeq ($(MIDR_IMPLEMENTER),$(CPU_IMP_ARM))
111 ##############################################################################
112 # Arm Cortex
113 ##############################################################################
114 CPU_PART_ARM_TUNE := $(CPU_PART_ARM_CORTEX_A53)/cortex-a53 \
115                      $(CPU_PART_ARM_CORTEX_A57)/cortex-a57 \
116                      $(CPU_PART_ARM_CORTEX_A72)/cortex-a72 \
117                      $(CPU_PART_ARM_CORTEX_A73)/cortex-a73
118 CPU_TUNE = $(notdir $(filter $(MIDR_PARTNUM)/%,$(CPU_PART_ARM_TUNE)))
119 ifneq ($(CPU_TUNE),)
120 DPDK_TUNE             = $(CPU_TUNE)
121 else
122 $(warning Unknown Arm CPU)
123 endif
124
125 else ifeq ($(MIDR_IMPLEMENTER),$(CPU_IMP_CAVIUM))
126 ##############################################################################
127 # Cavium ThunderX
128 ##############################################################################
129 ifneq (,$(findstring $(MIDR_PARTNUM),$(CPU_PART_CAVIUM_THUNDERX) \
130         $(CPU_PART_CAVIUM_THUNDERX_81XX) $(CPU_PART_CAVIUM_THUNDERX_83XX)))
131 DPDK_TARGET           = arm64-thunderx-linuxapp-$(DPDK_CC)
132 DPDK_MACHINE          = thunderx
133 DPDK_CACHE_LINE_SIZE := 128
134 else
135 $(warning Unknown Cavium CPU)
136 endif
137 endif
138
139 ##############################################################################
140 # Unknown platform
141 ##############################################################################
142 else
143 $(error Unknown platform)
144 endif
145
146 # /proc/cpuinfo does not exist on platforms without a /proc and on some
147 # platforms, notably inside containers, it has no content. In those cases
148 # we assume there's 1 processor; we use 2*ncpu for the -j option.
149 # NB: GNU Make 4.2 will let us use '$(file </proc/cpuinfo)' to both test
150 # for file presence and content; for now this will have to do.
151 JOBS := $(if $(shell [ -f /proc/cpuinfo ] && head /proc/cpuinfo),\
152         $(shell grep -c ^processor /proc/cpuinfo), 2)
153
154 # compiler/linker custom arguments
155 ifeq ($(DPDK_CC),clang)
156 DPDK_CPU_CFLAGS := -fPIE -fPIC
157 else
158 DPDK_CPU_CFLAGS := -pie -fPIC
159 endif
160
161 ifeq ($(DPDK_DEBUG),n)
162 DPDK_EXTRA_CFLAGS := -g -mtune=$(DPDK_TUNE)
163 else
164 DPDK_EXTRA_CFLAGS := -g -O0
165 endif
166
167 ifeq ($(AESNI),y)
168 IPSEC_MB_BUILD_PATH := $(B)/intel-ipsec-mb-$(IPSEC_MB_VER)
169 DPDK_EXTRA_CFLAGS += -L$(IPSEC_MB_BUILD_PATH) -I$(IPSEC_MB_BUILD_PATH)
170 endif
171
172 DPDK_MAKE_EXTRA_ARGS += AESNI_MULTI_BUFFER_LIB_PATH=$(AESNIMB_LIB_SOURCE)
173
174 # assemble DPDK make arguments
175 DPDK_MAKE_ARGS := -C $(DPDK_SOURCE) -j $(JOBS) \
176         T=$(DPDK_TARGET) \
177         RTE_CONFIG_TEMPLATE=../custom-config \
178         EXTRA_CFLAGS="$(DPDK_EXTRA_CFLAGS)" \
179         EXTRA_LDFLAGS="$(DPDK_EXTRA_LDFLAGS)" \
180         CPU_CFLAGS="$(DPDK_CPU_CFLAGS)" \
181         DESTDIR=$(I) \
182         $(DPDK_MAKE_EXTRA_ARGS)
183
184 define set
185 @if grep -q CONFIG_$1 $@ ; \
186         then sed -i -e 's/.*\(CONFIG_$1=\).*/\1$2/' $@ ; \
187         else echo CONFIG_$1=$2 >> $@ ; \
188 fi
189 endef
190
191 all: build
192
193 $(B)/custom-config: $(B)/.patch.ok Makefile
194         @echo --- generating custom config from $(DPDK_SOURCE)/config/defconfig_$(DPDK_TARGET) ---
195         @cpp -undef -ffreestanding -x assembler-with-cpp $(DPDK_SOURCE)/config/defconfig_$(DPDK_TARGET) $@
196         $(call set,RTE_MACHINE,$(DPDK_MACHINE))
197         @# modify options
198         $(call set,RTE_MAX_LCORE,256)
199         $(call set,RTE_PKTMBUF_HEADROOM,$(DPDK_PKTMBUF_HEADROOM))
200         $(call set,RTE_CACHE_LINE_SIZE,$(DPDK_CACHE_LINE_SIZE))
201         $(call set,RTE_LIBEAL_USE_HPET,y)
202         $(call set,RTE_BUILD_COMBINE_LIBS,y)
203         $(call set,RTE_PCI_CONFIG,y)
204         $(call set,RTE_PCI_EXTENDED_TAG,"on")
205         $(call set,RTE_PCI_MAX_READ_REQUEST_SIZE,4096)
206         @# enable debug init for device drivers
207         $(call set,RTE_LIBRTE_I40E_DEBUG_INIT,$(DPDK_DEBUG))
208         $(call set,RTE_LIBRTE_IXGBE_DEBUG_INIT,$(DPDK_DEBUG))
209         $(call set,RTE_LIBRTE_E1000_DEBUG_INIT,$(DPDK_DEBUG))
210         $(call set,RTE_LIBRTE_VIRTIO_DEBUG_INIT,$(DPDK_DEBUG))
211         $(call set,RTE_LIBRTE_VMXNET3_DEBUG_INIT,$(DPDK_DEBUG))
212         $(call set,RTE_LIBRTE_PMD_BOND,y)
213         $(call set,RTE_LIBRTE_IP_FRAG,y)
214         $(call set,RTE_LIBRTE_PMD_QAT,y)
215         $(call set,RTE_LIBRTE_PMD_AESNI_MB,$(AESNI))
216         $(call set,RTE_LIBRTE_PMD_AESNI_GCM,$(AESNI))
217         $(call set,RTE_LIBRTE_MLX4_PMD,$(DPDK_MLX4_PMD))
218         $(call set,RTE_LIBRTE_MLX5_PMD,$(DPDK_MLX5_PMD))
219         $(call set,RTE_LIBRTE_PMD_SOFTNIC,n)
220         $(call set,RTE_LIBRTE_MLX4_DLOPEN_DEPS,$(DPDK_MLX4_PMD))
221         $(call set,RTE_LIBRTE_MLX5_DLOPEN_DEPS,$(DPDK_MLX5_PMD))
222         $(call set,RTE_LIBRTE_PMD_TAP,$(DPDK_TAP_PMD))
223         $(call set,RTE_LIBRTE_PMD_FAILSAFE,$(DPDK_FAILSAFE_PMD))
224         @# not needed
225         $(call set,RTE_LIBRTE_CFGFILE,n)
226         $(call set,RTE_LIBRTE_LPM,n)
227         $(call set,RTE_LIBRTE_ACL,n)
228         $(call set,RTE_LIBRTE_POWER,n)
229         $(call set,RTE_LIBRTE_DISTRIBUTOR,n)
230         $(call set,RTE_LIBRTE_PORT,n)
231         $(call set,RTE_LIBRTE_TABLE,n)
232         $(call set,RTE_LIBRTE_PIPELINE,n)
233         $(call set,RTE_LIBRTE_FLOW_CLASSIFY,n)
234         $(call set,RTE_KNI_KMOD,n)
235         $(call set,RTE_EAL_IGB_UIO,n)
236         @# currently broken in 18.02
237         $(call set,RTE_LIBRTE_DPAA_BUS,n)
238         $(call set,RTE_LIBRTE_DPAA_MEMPOOL,n)
239         $(call set,RTE_LIBRTE_DPAA_PMD,n)
240         $(call set,RTE_LIBRTE_PMD_DPAA_SEC,n)
241         $(call set,RTE_LIBRTE_PMD_DPAA_EVENTDEV,n)
242         @rm -f .config.ok
243
244 $(CURDIR)/$(DPDK_TARBALL):
245         @if [ -e $(DPDK_DOWNLOAD_DIR)/$(DPDK_TARBALL) ] ; \
246                 then cp $(DPDK_DOWNLOAD_DIR)/$(DPDK_TARBALL) $(CURDIR) ; \
247                 else curl -o $(CURDIR)/$(DPDK_TARBALL) -LO $(DPDK_TAR_URL) ; \
248         fi
249         @rm -f $(B)/.download.ok
250
251 $(CURDIR)/$(NASM_TARBALL):
252         @if [ -e $(DPDK_DOWNLOAD_DIR)/$(NASM_TARBALL) ] ; \
253                 then cp $(DPDK_DOWNLOAD_DIR)/$(NASM_TARBALL) $(CURDIR) ; \
254                 else curl -o $(CURDIR)/$(NASM_TARBALL) -LO $(NASM_TAR_URL) ; \
255         fi
256
257 $(CURDIR)/$(AESNIMB_LIB_TARBALL):
258         @if [ -e $(DPDK_DOWNLOAD_DIR)/$(AESNIMB_LIB_TARBALL) ] ; \
259                 then cp $(DPDK_DOWNLOAD_DIR)/$(AESNIMB_LIB_TARBALL) $(CURDIR) ; \
260                 else curl -o $@ -LO $(AESNIMB_LIB_TARBALL_URL) ; \
261         fi
262
263 DPDK_DOWNLOADS = $(CURDIR)/$(DPDK_TARBALL)
264 ifeq ($(AESNI),y)
265 DPDK_DOWNLOADS += $(CURDIR)/$(NASM_TARBALL)
266 DPDK_DOWNLOADS += $(CURDIR)/$(AESNIMB_LIB_TARBALL)
267 endif
268
269 $(B)/.download.ok: $(DPDK_DOWNLOADS)
270         @mkdir -p $(B)
271         @openssl md5 $< | cut -f 2 -d " " - > $(B)/$(DPDK_TARBALL).md5sum
272         @([ "$$(<$(B)/$(DPDK_TARBALL).md5sum)" = "$(DPDK_$(DPDK_VERSION)_TARBALL_MD5_CKSUM)" ] || \
273         ( echo "Bad Checksum! Please remove $< and retry" && \
274                 rm $(B)/$(DPDK_TARBALL).md5sum && false ))
275         @touch $@
276
277 .PHONY: download
278 download: $(B)/.download.ok
279
280 $(B)/.extract.ok: $(B)/.download.ok
281         @echo --- extracting $(DPDK_TARBALL) ---
282         @tar --directory $(B) --extract --file $(CURDIR)/$(DPDK_TARBALL)
283 ifeq ($(AESNI),y)
284         @echo --- extracting $(NASM_TARBALL) ---
285         @tar --directory $(B) --extract --file $(CURDIR)/$(NASM_TARBALL)
286         @echo --- extracting $(AESNIMB_LIB_TARBALL) ---
287         @tar --directory $(B) --extract --file $(CURDIR)/$(AESNIMB_LIB_TARBALL)
288 endif
289         @touch $@
290
291 .PHONY: extract
292 extract: $(B)/.extract.ok
293
294 $(B)/.patch.ok: $(B)/.extract.ok
295 ifneq ($(wildcard $(CURDIR)/dpdk-$(DPDK_VERSION)_patches/*.patch),)
296         @echo --- patching ---
297         @for f in $(CURDIR)/dpdk-$(DPDK_VERSION)_patches/*.patch ; do \
298                 echo Applying patch: $$(basename $$f) ; \
299                 patch -p1 -d $(DPDK_SOURCE) < $$f ; \
300         done
301 endif
302         @touch $@
303
304 .PHONY: patch
305 patch: $(B)/.patch.ok
306
307 $(B)/.config.ok: $(B)/.patch.ok $(B)/custom-config
308         @make $(DPDK_MAKE_ARGS) config
309         @touch $@
310
311 .PHONY: config
312 config: $(B)/.config.ok
313
314 .PHONY: build-nasm
315 build-nasm:
316         cd $(NASM_SOURCE) && sh configure && make -j
317
318 .PHONY: build-ipsec-mb
319 build-ipsec-mb:
320         mkdir -p $(I)/lib/
321         # Do not build GCM stuff if we are building ISA_L
322         make -C $(AESNIMB_LIB_SOURCE) -j SHARED=n \
323           EXTRA_CFLAGS=-fPIC NASM=$(NASM_SOURCE)/nasm
324         cp $(AESNIMB_LIB_SOURCE)/libIPSec_MB.a $(I)/lib/
325
326 .PHONY: build-dpdk
327 build-dpdk:
328         @if [ ! -e $(B)/.config.ok ] ; then echo 'Please run "make config" first' && false ; fi
329         @make $(DPDK_MAKE_ARGS) install
330
331 # Order matters
332 ifeq ($(AESNI),y)
333 BUILD_TARGETS += build-nasm
334 BUILD_TARGETS += build-ipsec-mb
335 endif
336 BUILD_TARGETS += build-dpdk
337
338 $(B)/.build.ok: $(BUILD_TARGETS)
339         @touch $@
340
341 .PHONY: build
342 build: $(B)/.build.ok
343
344 .PHONY: install
345 install: $(B)/.build.ok
346
347 .PHONY: clean
348 clean:
349         @rm -rf $(B) $(I)
350
351 ##############################################################################
352 # .deb packaging
353 ##############################################################################
354
355 DEB_ARCH=$(shell dpkg --print-architecture 2> /dev/null)
356 DEV_DEB=vpp-dpdk-dev_$(DPDK_VERSION)-$(PKG_SUFFIX)_$(DEB_ARCH).deb
357 INSTALLED_DEB_VER=$(shell dpkg-query --showformat='$${Version}' --show vpp-dpdk-dev 2> /dev/null)
358
359 .PHONY: build-deb install-deb check-deb
360
361 deb/debian/changelog: Makefile
362         @echo "vpp-dpdk ($(DPDK_VERSION)-$(PKG_SUFFIX)) unstable; urgency=low" > $@
363         @echo "" >> $@
364         @echo "  * DPDK Release $(DPDK_VERSION)" >> $@
365         @echo "" >> $@
366         @echo " -- VPP Dev <vpp-dev@lists.fd.io>  $(shell date -R)" >> $@
367
368 $(DEV_DEB): deb/debian/changelog
369         @cd deb && dpkg-buildpackage -b -uc -us
370         git clean -fdx deb
371
372 build-deb: $(DEV_DEB)
373
374 install-deb:
375 ifneq ($(INSTALLED_DEB_VER),$(DPDK_VERSION)-$(PKG_SUFFIX))
376         @echo "=========================================================="
377         @echo " Out of date DPDK package installed."
378         @echo " Installed: $(INSTALLED_DEB_VER)"
379         @echo " Needed: $(DPDK_VERSION)-$(PKG_SUFFIX)"
380         @echo "=========================================================="
381         @make $(DEV_DEB)
382         @sudo dpkg -i $(DEV_DEB)
383 else
384         @echo "=========================================================="
385         @echo " Up-to-date DPDK package already installed"
386         @echo "=========================================================="
387 endif
388
389 check-deb:
390 ifneq ($(INSTALLED_DEB_VER),$(DPDK_VERSION)-$(PKG_SUFFIX))
391         @echo "=========================================================="
392         @echo " Outdated DPDK package detected:"
393         @echo "  Installed: vpp-dpdk-dev $(INSTALLED_DEB_VER)"
394         @echo "  Current:   vpp-dpdk-dev $(DPDK_VERSION)-$(PKG_SUFFIX)"
395         @echo ""
396         @echo " Please upgrade by invoking 'make dpdk-install-dev'"
397         @echo " from the top level directory."
398         @echo "=========================================================="
399 endif
400
401 ##############################################################################
402 # .rpm packaging
403 ##############################################################################
404
405 RPM_ARCH=$(shell rpm --eval "%{_arch}" 2> /dev/null)
406 DEV_RPM=vpp-dpdk-devel-$(DPDK_VERSION)-$(PKG_SUFFIX).$(RPM_ARCH).rpm
407 INSTALLED_RPM_VER=$(shell rpm -q --queryformat '%{VERSION}-%{RELEASE}' vpp-dpdk-devel 2> /dev/null | grep -v "not inst")
408
409 .PHONY: build-rpm install-rpm check-rpm
410
411 $(DEV_RPM): Makefile rpm/vpp-dpdk.spec
412         @rpmbuild -bb \
413           --define "_topdir $(CURDIR)/rpm" \
414           --define "_version $(DPDK_VERSION)" \
415           --define "_release $(PKG_SUFFIX)" \
416           $(CURDIR)/rpm/vpp-dpdk.spec
417         mv rpm/RPMS/$(RPM_ARCH)/*.rpm .
418         git clean -fdx rpm
419
420 build-rpm: $(DEV_RPM)
421
422 install-rpm:
423 ifneq ($(INSTALLED_RPM_VER),$(DPDK_VERSION)-$(PKG_SUFFIX))
424         @$(MAKE) $(DEV_RPM)
425         sudo rpm -Uih $(DEV_RPM)
426 else
427         @echo "=========================================================="
428         @echo " Up-to-date DPDK package already installed"
429         @echo "=========================================================="
430 endif
431
432 check-rpm:
433 ifneq ($(INSTALLED_RPM_VER),$(DPDK_VERSION)-$(PKG_SUFFIX))
434         @echo "=========================================================="
435         @echo " Outdated DPDK package detected:"
436         @echo "  Installed: vpp-dpdk-devel $(INSTALLED_RPM_VER)"
437         @echo "  Current:   vpp-dpdk-devel $(DPDK_VERSION)-$(PKG_SUFFIX)"
438         @echo ""
439         @echo " Please upgrade by invoking 'make dpdk-install-dev'"
440         @echo " from the top level directory."
441         @echo "=========================================================="
442 endif
443
444 ##############################################################################
445 # ebuild support
446 ##############################################################################
447
448 .PHONY: ebuild-build ebuild-install
449
450 ebuild-build:
451 ifeq ($(INSTALLED_DEB_VER)$(INSTALLED_RPM_VER),)
452         @echo "=========================================================="
453         @echo "Building DPDK from source. Consider installing development"
454         @echo "package by invoking 'make dpdk-install-dev' from the"
455         @echo "top level directory"
456         @echo "=========================================================="
457         make config
458 else
459 ifneq ($(INSTALLED_DEB_VER),)
460         make check-deb
461 endif
462 ifneq ($(INSTALLED_RPM_VER),)
463         make check-rpm
464 endif
465 endif
466
467 ebuild-install:
468 ifeq ($(INSTALLED_DEB_VER)$(INSTALLED_RPM_VER),)
469         make install
470 endif