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