Add option to disable docs build
[deb_dpdk.git] / debian / rules
1 #!/usr/bin/make -f
2 # See debhelper(7) (uncomment to enable)
3 # output every command that modifies files on the build system.
4 export DH_VERBOSE=1
5 export DH_OPTIONS=-v
6
7 VERSION := $(shell dpkg-parsechangelog | sed -nr '/^Version:/s/Version: (.*:)?(.*)-(.*)/\2/p')
8
9 # see EXAMPLES in dpkg-buildflags(1) and read /usr/share/dpkg/*
10 include /usr/share/dpkg/default.mk
11
12 DEB_HOST_GNU_CPU := $(shell dpkg-architecture -qDEB_HOST_GNU_CPU)
13
14 # see FEATURE AREAS in dpkg-buildflags(1)
15 export DEB_BUILD_MAINT_OPTIONS = hardening=+all,-pie
16
17 # see ENVIRONMENT in dpkg-buildflags(1)
18 DPKG_EXPORT_BUILDFLAGS = 1
19 include /usr/share/dpkg/buildflags.mk
20
21 # Support backporting to jessie
22 dpkg_version_lt = $(shell dpkg --compare-versions $$(dpkg --status dpkg-dev | grep Version | cut -d' ' -f2) lt-nl "1.18.11" && echo yes)
23 ifeq (yes, $(dpkg_version_lt))
24         # package maintainers to append CFLAGS
25         # For Debian, dpkg-dev >= 1.18.11 and gcc 6.x, dpkg-buildflags and gcc
26         # handle -fPIC and related flags relying on specs files
27         # (/usr/share/dpkg/*specs)
28         export DEB_CFLAGS_MAINT_APPEND  = -fPIC
29         export EXTRA_CFLAGS=$(CFLAGS)
30         export EXTRA_CPPFLAGS=$(CPPFLAGS)
31         export HOST_EXTRA_CFLAGS=$(CFLAGS)
32         export HOST_EXTRA_CPPFLAGS=$(CPPFLAGS)
33         # need to be stripped as DPDK build system adds them and it would be -Wl,-Wl,opt
34         export EXTRA_LDFLAGS=$(shell echo $(LDFLAGS) | sed 's/-Wl,//g')
35         # HOST_CC build system does not add -Wl ...
36         export EXTRA_HOST_LDFLAGS=$(LDFLAGS)
37 endif
38
39 export RTE_DEVEL_BUILD=n
40
41 # People rebuilding this package can overwrite DPDK_CONFIG, RTE_MACHINE and
42 # RTE_TARGET via DEB_BUILD_OPTIONS if they like
43 ifneq (,$(filter dpdk_config=%,$(DEB_BUILD_OPTIONS)))
44     DPDK_CONFIG ?= $(patsubst dpdk_config=%,%,$(filter dpdk_config=%,$(DEB_BUILD_OPTIONS)))
45 endif
46 ifneq (,$(filter rte_machine=%,$(DEB_BUILD_OPTIONS)))
47     RTE_MACHINE ?= $(patsubst rte_machine=%,%,$(filter rte_machine=%,$(DEB_BUILD_OPTIONS)))
48 endif
49 ifneq (,$(filter rte_target=%,$(DEB_BUILD_OPTIONS)))
50     RTE_TARGET ?= $(patsubst rte_target=%,%,$(filter rte_target=%,$(DEB_BUILD_OPTIONS)))
51 endif
52
53 ifneq (,$(filter $(DEB_HOST_ARCH), arm64))
54 DPDK_CONFIG ?= "arm64-armv8a-linuxapp-gcc"
55 RTE_MACHINE ?= "armv8a"
56 RTE_TARGET ?= "arm64-armv8a-linuxapp-gcc"
57 else
58 ifneq (,$(filter $(DEB_HOST_ARCH), ppc64el))
59 DPDK_CONFIG ?= "ppc_64-power8-linuxapp-gcc"
60 RTE_MACHINE ?= "power8"
61 RTE_TARGET ?= "ppc_64-power8-linuxapp-gcc"
62 else
63 DPDK_CONFIG ?= "$(DEB_HOST_GNU_CPU)-native-linuxapp-gcc"
64 RTE_MACHINE ?= "default"
65 RTE_TARGET ?= "$(DEB_HOST_GNU_CPU)-default-linuxapp-gcc"
66 endif
67 endif
68 DPDK_STATIC_DIR = "debian/build/static-root"
69 DPDK_SHARED_DIR = "debian/build/shared-root"
70
71 # now stable with parallel comilation, so support -j
72 ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
73     PAR := $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
74 else
75     PAR := "1"
76 endif
77
78 ifneq (,$(findstring nodocs,$(DEB_BUILD_OPTIONS)))
79 BUILD_DOCS=n
80 else
81 BUILD_DOCS=y
82 endif
83
84 # kernel_modules can be passed via DEB_BUILD_OPTIONS to enable building the
85 # optional binary kernel modules package. By default it will be built against
86 # the current kernel, or ksrc can be passed with a path to the target kernel
87 # sources instead.
88 ifeq (,$(findstring kernel_modules,$(DEB_BUILD_OPTIONS)))
89 DPDK_CONFIG_BUILD_KMOD=n
90 KSRC=""
91 else
92 ifneq (,$(filter ksrc=%,$(DEB_BUILD_OPTIONS)))
93     KSRC := $(patsubst ksrc=%,%,$(filter ksrc=%,$(DEB_BUILD_OPTIONS)))
94 else
95     KSRC := /lib/modules/$(shell uname -r)/build
96 endif
97
98 KVERS := $(shell perl debian/kernel-version $(KSRC))
99 export KVERS
100 export MODULE_CFLAGS=-fno-PIE
101
102 DPDK_CONFIG_BUILD_KMOD=y
103
104 # Since the binary module package is generated at build time depending on the
105 # local kernel version, we have to append the new package in d/control.
106 # We cannot use a separate control file since that wouldn't work with
107 # dpkg-genchanges, and also would require a lot of overrides for debhelpers.
108 get_built_using ?= $(filter-out (=),$(shell dpkg-query -f='$${source:Package} (=$${source:Version})' -W $1))
109
110 override_dh_gencontrol:
111         dh_gencontrol
112         dh_gencontrol -p dpdk-modules-$(KVERS) -- \
113                 -v`cat debian/VERSION` \
114                 -V'built:using:kernel=$(call get_built_using,linux-headers-$(KVERS))'
115
116 build:
117         @if [ x"$(KVERS)" = x ] ; then \
118             echo 'No version in $(KSRC)/include/linux/version.h' >&2; \
119             exit 1; \
120         fi
121         sh debian/prep-modules $(KSRC)
122         cat debian/control.modules >> debian/control
123         dh $@ --with python2,dkms
124 endif
125
126 %:
127         dh $@ --with python2,dkms
128
129 override_dh_auto_clean:
130         rm -rf debian/build debian/tmp debian/dpdk-modules-* \
131                 debian/control.modules debian/VERSION
132         sed -i '/Package: dpdk-modules-/,/`tail -n1 debian/control.modules.in`/d' debian/control
133         test -L config/defconfig_$(DPDK_CONFIG) && rm -f config/defconfig_$(DPDK_CONFIG) || true
134
135 override_dh_clean:
136         dh_clean
137         rm -f debian/libethdev4.links
138         rm -f debian/librte-cryptodev1.links
139         rm -f debian/librte-eal2.links
140
141 override_dh_auto_configure:
142         # Add support for a custom defconfig file in the debian directory.
143 ifneq (,$(filter dpdk_config=%,$(DEB_BUILD_OPTIONS)))
144         test -e config/defconfig_$(DPDK_CONFIG) || ln -fs ../debian/defconfig_$(DPDK_CONFIG) config/defconfig_$(DPDK_CONFIG)
145 endif
146         # report dpkg-buildflags status to build log
147         dpkg-buildflags --status
148         echo EXTRA_CFLAGS $$EXTRA_CFLAGS
149         echo EXTRA_LDFLAGS: $$EXTRA_LDFLAGS
150         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) T=$(DPDK_CONFIG) config
151 ifeq (,$(filter dpdk_config=%,$(DEB_BUILD_OPTIONS)))
152         sed -ri -e 's,(RTE_MACHINE=).*,\1$(RTE_MACHINE),' \
153                 -e 's,(RTE_NEXT_ABI=).*,\1n,' \
154                 -e 's,(CONFIG_RTE_EAL_IGB_UIO=).*,\1$(DPDK_CONFIG_BUILD_KMOD),' \
155                 -e 's,(CONFIG_RTE_KNI_KMOD=).*,\1$(DPDK_CONFIG_BUILD_KMOD),' \
156                 -e 's,(LIBRTE_PMD_PCAP=).*,\1y,' \
157                 -e 's,(LIBRTE_PMD_XENVIRT=).*,\1y,' \
158                 -e 's,(CONFIG_RTE_EAL_PMD_PATH=).*,\1"/usr/lib/$(shell dpkg-architecture -qDEB_HOST_MULTIARCH)/dpdk-pmds/",' \
159                 $(DPDK_STATIC_DIR)/.config
160         # xen not available on ppc64el
161 ifneq (,$(filter $(DEB_HOST_ARCH), ppc64el))
162         sed -ri -e 's,(LIBRTE_PMD_XENVIRT=).*,\1n,' $(DPDK_STATIC_DIR)/.config
163 endif
164 endif
165         dh_auto_configure
166
167 override_dh_auto_build-indep:
168 ifeq (y,$(BUILD_DOCS))
169         $(MAKE) -j $(PAR) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) doc-api-html doc-guides-html \
170                 doc-guides-man
171 endif
172
173 override_dh_auto_install-indep:
174         # Package: dpdk-doc
175         # All files based on the install-doc rule (includes examples)
176 ifeq (y,$(BUILD_DOCS))
177         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) prefix=/usr \
178                 DESTDIR=debian/dpdk-doc install-doc
179 endif
180
181 override_dh_auto_build-arch:
182         $(MAKE) -j $(PAR) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) RTE_KERNELDIR=$(KSRC) build
183         # Unfortunately the decision about having static or shared libraries is
184         # made for the whole build, which then produces only .a or .so files
185         # (but not both).
186         # And the target layout for target selection has no field for the
187         # type of library.
188         # Right now I hack this by doing a second build which only differs in
189         # the selection of shared libs.
190         # Shared libs should be default, so the previous static build is only
191         # used to get static libraries.
192         cp -a $(DPDK_STATIC_DIR) $(DPDK_SHARED_DIR)
193         sed -ri 's,(RTE_BUILD_SHARED_LIB=).*,\1y,' \
194                 $(DPDK_SHARED_DIR)/.config
195         $(MAKE) -j $(PAR) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) RTE_KERNELDIR=$(KSRC) build
196
197 override_dh_auto_install-arch: LIBDIR=/usr/lib/$(shell dpkg-architecture -qDEB_HOST_MULTIARCH)
198 override_dh_auto_install-arch:
199         # Package: dpdk (runtime)
200         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) prefix=/usr libdir=$(LIBDIR) \
201                 DESTDIR=debian/dpdk install-runtime
202         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) prefix=/usr libdir=$(LIBDIR) \
203                 DESTDIR=debian/dpdk install-runtime
204         mkdir -p debian/dpdk/etc/dpdk
205         cp debian/dpdk.interfaces debian/dpdk/etc/dpdk/interfaces
206         rm debian/dpdk/usr/sbin/dpdk-devbind
207         mkdir -p debian/dpdk/sbin
208         ln -s /usr/share/dpdk/tools/dpdk-devbind.py \
209                 debian/dpdk/sbin/dpdk-devbind
210         # Package: dpdk-dev (build environment)
211         # workaround to fix symbolic link creation
212         mkdir -p debian/dpdk-dev/$(LIBDIR)
213         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) prefix=/usr libdir=$(LIBDIR) \
214                 DESTDIR=debian/dpdk-dev install-sdk
215         # remove workaround
216         rm -fr debian/dpdk-dev/usr/lib
217         cp $(DPDK_SHARED_DIR)/.config debian/dpdk-dev/usr/share/dpdk/config
218         sed -e 's/SDK_TARGET/$(RTE_TARGET)/' debian/dpdk-sdk-env.sh.in > \
219                 debian/dpdk-dev/usr/share/dpdk/dpdk-sdk-env.sh
220         # include the bundled autotest suite to be usable from the dpdk-dev package
221         mkdir -p debian/dpdk-dev/usr/share/dpdk/test
222         cp -a app/test/autotest* debian/dpdk-dev/usr/share/dpdk/test
223         cp $(DPDK_SHARED_DIR)/app/test debian/dpdk-dev/usr/share/dpdk/test/
224         # since we move libs to multiarch dirs update the non aware symlink
225         rm debian/dpdk-dev/usr/share/dpdk/$(RTE_TARGET)/lib
226         ln -rs debian/dpdk-dev/$(LIBDIR)/ \
227                 debian/dpdk-dev/usr/share/dpdk/$(RTE_TARGET)/lib
228         # Package: libdpdk-dev (bare headers, static devel libs and linker
229         # script)
230         mkdir -p debian/libdpdk-dev/$(LIBDIR)
231         # linker script
232         mv debian/dpdk/$(LIBDIR)/libdpdk.so debian/libdpdk-dev/$(LIBDIR)/
233         # includes
234         mkdir -p debian/libdpdk-dev/usr/include
235         mv debian/dpdk-dev/usr/include/dpdk debian/libdpdk-dev/usr/include/
236         # all static libs are in the dev package
237         mv debian/dpdk/$(LIBDIR)/lib*.a debian/libdpdk-dev/$(LIBDIR)/
238         # symlinks to last .so's are in the non versioned libdpdk-dev as well
239         # this allows multiple libdpdk-<NAME><VER> at different VER concurrently
240         # libdpdk-dev depends on all sublibs so symlinks are never broken
241         mv debian/dpdk/$(LIBDIR)/*.so debian/libdpdk-dev/$(LIBDIR)/
242         # Package(s): libdpdk-<NAME><VER> (bare runtime libs)
243         for lib in $$(ls -1 debian/dpdk/$(LIBDIR)/*.so.*); do \
244           BN=$$(basename $${lib}); \
245           VER=$$(echo $${BN} | sed -e 's/^.*\.so\.//'); \
246           LN=$$(echo $${BN} | sed -e 's/\.so\.[0-9]*$$//' | tr '_' '-'); \
247           if echo $${LN} | grep -q ".*[0-9]$$"; then \
248             PKG=$${LN}-$${VER}; \
249           else \
250             PKG=$${LN}$${VER}; \
251           fi; \
252           LIBF="$$(basename $${lib})"; \
253           LIBD="debian/$${PKG}/$(LIBDIR)"; \
254           echo "moving $${lib} for library $${PKG}"; \
255           mkdir -p $${LIBD}; \
256           mv $${lib} $${LIBD}; \
257           if [ "$${LIBF#librte_pmd_}x" != "$${LIBF}x" ]; then \
258             mkdir -p $${LIBD}/dpdk-pmds; \
259             echo "PMD: linking $${LIBF} into RTE_EAL_PMD_PATH at $${LIBD}/dpdk-pmds/"; \
260             ln -s --relative --target-directory=$${LIBD}/dpdk-pmds/ $${LIBD}/$${LIBF}; \
261           fi; \
262           if [ "$${LIBF#librte_eal}x" != "$${LIBF}x" ]; then \
263             mkdir -p $${LIBD}/dpdk-pmds; \
264           fi; \
265         done
266         # pkg-config
267         mkdir -p debian/libdpdk-dev/$(LIBDIR)/pkgconfig
268         LIBS=$$(sed -e 's/GROUP ( \(.*\) )/\1/' -e 's/lib/-l/g' -e 's/\.so//g' \
269                 $(CURDIR)/debian/libdpdk-dev/$(LIBDIR)/libdpdk.so); \
270         sed -e "s/@DPDK_LIBS@/$${LIBS}/" -e "s/@VERSION@/$(VERSION)/" \
271                 -e "s|@LIBDIR@|$(LIBDIR)|" \
272                 debian/libdpdk.pc.in > debian/libdpdk-dev/$(LIBDIR)/pkgconfig/libdpdk.pc
273         # Package: dpdk-igb-uio-dkms
274         mkdir -p debian/dpdk-igb-uio-dkms/usr/src/dpdk-igb-uio-$(VERSION)
275         cp lib/librte_eal/linuxapp/igb_uio/* \
276                 debian/dpdk-igb-uio-dkms/usr/src/dpdk-igb-uio-$(VERSION)
277         # Package: dpdk-rte-kni-dkms
278         mkdir -p debian/dpdk-rte-kni-dkms/usr/src/dpdk-rte-kni-$(VERSION)
279         cp -a lib/librte_eal/linuxapp/kni/* \
280                 debian/dpdk-rte-kni-dkms/usr/src/dpdk-rte-kni-$(VERSION)
281 ifneq (,$(KVERS))
282         # Package: dpdk-modules-<kernel version>
283         $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) \
284                 kerneldir=/lib/modules/$(KVERS)/extra/dpdk \
285                 DESTDIR=debian/dpdk-modules-$(KVERS) install-kmod
286 endif
287
288 debian/libethdev4.links: debian/libethdev4.links.in
289         sed -e 's/@DEB_HOST_MULTIARCH@/$(DEB_HOST_MULTIARCH)/g' < $< > $@
290 debian/librte-cryptodev1.links: debian/librte-cryptodev1.links.in
291         sed -e 's/@DEB_HOST_MULTIARCH@/$(DEB_HOST_MULTIARCH)/g' < $< > $@
292 debian/librte-eal2.links: debian/librte-eal2.links.in
293         sed -e 's/@DEB_HOST_MULTIARCH@/$(DEB_HOST_MULTIARCH)/g' < $< > $@
294 override_dh_link: debian/libethdev4.links debian/librte-cryptodev1.links debian/librte-eal2.links
295         dh_link
296
297 override_dh_dkms:
298         dh_dkms -V $(VERSION)
299
300 override_dh_installinit:
301         dh_installinit --no-start --no-restart-on-upgrade
302
303 override_dh_systemd_start:
304         dh_systemd_start --no-start --no-restart-on-upgrade
305
306 override_dh_auto_test:
307