diff mbox series

[RESEND,v3,1/1] package/iputils: add configs to select which binaries are built

Message ID 4e8f64ec-1797-a418-79d7-701380a767db@gmail.com
State Accepted
Headers show
Series [RESEND,v3,1/1] package/iputils: add configs to select which binaries are built | expand

Commit Message

Alejandro González Sept. 15, 2019, 10:05 a.m. UTC 
By default, the iputils build script might build binaries which are
useless for certain applications, like tftpd or ninfod. Those binaries
will add to the target filesystem size unless a post-build script removes
them manually, which is cumbersome and doesn't shorten build times.

In particular, in a certain aarch64 Buildroot project with musl selected
as a C library, this patch allowed to shrink the full iputils package from
219 KiB (if every option is selected) to 63 KiB (with only the ping
binary selected) - a 71.2% relative size decrease.

Moreover, upstream recently introduced a commit that disabled tftpd from
building by default, like rarpd. In the current state of things, this change
will introduce inconveniences for Buildroot users which prefer to use the
tftpd implementation provided by this package. With this patch, however, that
decision and similar future ones won't be a concern, because they will
have complete control of what binaries are built.

These changes add Kconfig options which let the user select what
binaries are built with ease.

Signed-off-by: Alejandro González <alejandro.gonzalez.correo@gmail.com>
---
Changes v2 -> v3:
	- Several style revisions (suggested by Arnout)
	- Simplify ninfod crypto dependencies logic (suggested by
	  Arnout)
	- Better explain the rationale for this patch in the commit
	  message

Changes v2 -> v1:
	- Fix several typos

 package/iputils/Config.in  |  68 ++++++++++++++++++++++
 package/iputils/iputils.mk | 116 +++++++++++++++++++++++++------------
 2 files changed, 147 insertions(+), 37 deletions(-)

Comments

Thomas Petazzoni Sept. 15, 2019, 12:23 p.m. UTC | #1 
Hello Alejandro,

On Sun, 15 Sep 2019 12:05:46 +0200
Alejandro González <alejandro.gonzalez.correo@gmail.com> wrote:


> +config BR2_PACKAGE_IPUTILS_NINFOD
> +	bool "ninfod"
> +	depends on BR2_TOOLCHAIN_HAS_THREADS # ninfod requires <pthread.h>
> +	depends on BR2_PACKAGE_NETTLE || BR2_PACKAGE_LIBGCRYPT || BR2_PACKAGE_OPENSSL || BR2_PACKAGE_LINUX_HEADERS

Do we really want to handle this with depends on ? This is indeed what
is the closest to what the current package does, but when we have
sub-options, we generally use "select" to enable the appropriate
dependencies. In this case, it's not easy to know if there is a
preferred crypto provider though, so perhaps what you did is the best.

However, reviewing your commit, I realized we already have this
dependency on BR2_PACKAGE_LINUX_HEADERS, and this is completely bogus.
BR2_PACKAGE_LINUX_HEADERS is only valid when an internal toolchain is
used. When an external toolchain is used, BR2_PACKAGE_LINUX_HEADERS is
always disabled. So it shouldn't be used in packages. This is something
that should be fixed in iputils. In fact, kernel headers are always
available, as they are provided by the toolchain. So this dependency
doesn't make sense.

Could you investigate how USE_CRYPTO=kernel is working, i.e which
APIs/headers it requires ?

Besides this particular problem, the rest of the patch looks good to me.

Thomas
Thomas Petazzoni Sept. 3, 2020, 7:49 p.m. UTC | #2 
On Sun, 15 Sep 2019 12:05:46 +0200
Alejandro González <alejandro.gonzalez.correo@gmail.com> wrote:

> By default, the iputils build script might build binaries which are
> useless for certain applications, like tftpd or ninfod. Those binaries
> will add to the target filesystem size unless a post-build script removes
> them manually, which is cumbersome and doesn't shorten build times.
> 
> In particular, in a certain aarch64 Buildroot project with musl selected
> as a C library, this patch allowed to shrink the full iputils package from
> 219 KiB (if every option is selected) to 63 KiB (with only the ping
> binary selected) - a 71.2% relative size decrease.
> 
> Moreover, upstream recently introduced a commit that disabled tftpd from
> building by default, like rarpd. In the current state of things, this change
> will introduce inconveniences for Buildroot users which prefer to use the
> tftpd implementation provided by this package. With this patch, however, that
> decision and similar future ones won't be a concern, because they will
> have complete control of what binaries are built.
> 
> These changes add Kconfig options which let the user select what
> binaries are built with ease.
> 
> Signed-off-by: Alejandro González <alejandro.gonzalez.correo@gmail.com>
> ---
> Changes v2 -> v3:
> 	- Several style revisions (suggested by Arnout)
> 	- Simplify ninfod crypto dependencies logic (suggested by
> 	  Arnout)
> 	- Better explain the rationale for this patch in the commit
> 	  message

I have finally applied to master. The ninfod situation is now simpler
because iputils no longer needs any external crypto library.

Thanks!

Thomas
Alejandro González Sept. 8, 2020, 1:33 p.m. UTC | #3 
El jue., 3 sept. 2020 a las 21:49, Thomas Petazzoni
(<thomas.petazzoni@bootlin.com>) escribió:
> I have finally applied to master. The ninfod situation is now simpler
> because iputils no longer needs any external crypto library.

Neat! I lost interest over time for this patch after finding better
ways to shrink the resulting image size, but it's good to see that
finally it could be merged :)
diff mbox series

Patch

diff --git a/package/iputils/Config.in b/package/iputils/Config.in
index b5d9141a7d..7d106fa2d7 100644
--- a/package/iputils/Config.in
+++ b/package/iputils/Config.in
@@ -7,3 +7,71 @@  config BR2_PACKAGE_IPUTILS
 	  etc.
 
 	  https://github.com/iputils/iputils
+
+if BR2_PACKAGE_IPUTILS
+
+config BR2_PACKAGE_IPUTILS_ARPING
+	bool "arping"
+	default y
+	help
+	  Installs arping.
+
+config BR2_PACKAGE_IPUTILS_CLOCKDIFF
+	bool "clockdiff"
+	default y
+	help
+	  Installs clockdiff.
+
+config BR2_PACKAGE_IPUTILS_PING
+	bool "ping"
+	default y
+	help
+	  Installs ping.
+
+config BR2_PACKAGE_IPUTILS_RARPD
+	bool "rarpd"
+	help
+	  Installs rarpd.
+
+config BR2_PACKAGE_IPUTILS_RDISC
+	bool "rdisc"
+	default y
+	help
+	  Installs rdisc.
+
+config BR2_PACKAGE_IPUTILS_RDISC_SERVER
+	bool "rdisc (server code)"
+	depends on BR2_PACKAGE_IPUTILS_RDISC
+	default y
+	help
+	  Builds rdisc with server code.
+
+config BR2_PACKAGE_IPUTILS_TFTPD
+	bool "tftpd"
+	help
+	  Installs tftpd.
+
+config BR2_PACKAGE_IPUTILS_TRACEPATH
+	bool "tracepath"
+	default y
+	help
+	  Installs tracepath.
+
+config BR2_PACKAGE_IPUTILS_TRACEROUTE6
+	bool "traceroute6"
+	default y
+	help
+	  Installs traceroute6.
+
+config BR2_PACKAGE_IPUTILS_NINFOD
+	bool "ninfod"
+	depends on BR2_TOOLCHAIN_HAS_THREADS # ninfod requires <pthread.h>
+	depends on BR2_PACKAGE_NETTLE || BR2_PACKAGE_LIBGCRYPT || BR2_PACKAGE_OPENSSL || BR2_PACKAGE_LINUX_HEADERS
+	default y
+	help
+	  Installs ninfod.
+
+comment "ninfod needs nettle, libgcrypt, openssl or Linux headers and a toolchain w/ threads"
+	depends on !BR2_TOOLCHAIN_HAS_THREADS || (!BR2_PACKAGE_NETTLE && !BR2_PACKAGE_LIBGCRYPT && !BR2_PACKAGE_OPENSSL && !BR2_PACKAGE_LINUX_HEADERS)
+
+endif
diff --git a/package/iputils/iputils.mk b/package/iputils/iputils.mk
index 4a06581790..c2bbf0f96d 100644
--- a/package/iputils/iputils.mk
+++ b/package/iputils/iputils.mk
@@ -17,6 +17,66 @@  IPUTILS_LICENSE = GPL-2.0+, BSD-3-Clause
 IPUTILS_LICENSE_FILES = LICENSE Documentation/LICENSE.BSD3 Documentation/LICENSE.GPL2
 IPUTILS_DEPENDENCIES = $(TARGET_NLS_DEPENDENCIES)
 
+# Selectively build binaries
+IPUTILS_CONF_OPTS += \
+	-DBUILD_CLOCKDIFF=$(if $(BR2_PACKAGE_IPUTILS_CLOCKDIFF),true,false) \
+	-DBUILD_RARPD=$(if $(BR2_PACKAGE_IPUTILS_RARPD),true,false) \
+	-DBUILD_RDISC=$(if $(BR2_PACKAGE_IPUTILS_RDISC),true,false) \
+	-DBUILD_RDISC_SERVER=$(if $(BR2_PACKAGE_IPUTILS_RDISC_SERVER),true,false) \
+	-DBUILD_TRACEPATH=$(if $(BR2_PACKAGE_IPUTILS_TRACEPATH),true,false) \
+	-DBUILD_TRACEROUTE6=$(if $(BR2_PACKAGE_IPUTILS_TRACEROUTE6),true,false) \
+	-DBUILD_NINFOD=$(if $(BR2_PACKAGE_IPUTILS_NINFOD),true,false)
+
+# Handle binaries with hooks
+ifeq ($(BR2_PACKAGE_IPUTILS_ARPING),y)
+IPUTILS_CONF_OPTS += -DBUILD_ARPING=true
+
+# move some binaries to the same location as where Busybox installs
+# the corresponding applets, so that we have a single version of the
+# tools (from iputils)
+define IPUTILS_MOVE_ARPING_BINARY
+	mv $(TARGET_DIR)/usr/bin/arping $(TARGET_DIR)/usr/sbin/arping
+endef
+IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_MOVE_ARPING_BINARY
+
+else
+IPUTILS_CONF_OPTS += -DBUILD_ARPING=false
+endif
+
+ifeq ($(BR2_PACKAGE_IPUTILS_PING),y)
+IPUTILS_CONF_OPTS += -DBUILD_PING=true
+
+# same reason to move the ping binary as for arping
+ifeq ($(BR2_ROOTFS_MERGED_USR),)
+define IPUTILS_MOVE_PING_BINARY
+	mv $(TARGET_DIR)/usr/bin/ping $(TARGET_DIR)/bin/ping
+endef
+IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_MOVE_PING_BINARY
+endif
+
+# upstream requires distros to create symlink
+define IPUTILS_CREATE_PING6_SYMLINK
+	ln -sf $(TARGET_DIR)/bin/ping $(TARGET_DIR)/bin/ping6
+endef
+IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_CREATE_PING6_SYMLINK
+
+else
+IPUTILS_CONF_OPTS += -DBUILD_PING=false
+endif
+
+ifeq ($(BR2_PACKAGE_IPUTILS_TFTPD),y)
+IPUTILS_CONF_OPTS += -DBUILD_TFTPD=true
+
+define IPUTILS_MOVE_TFTPD_BINARY
+	mv $(TARGET_DIR)/usr/bin/tftpd $(TARGET_DIR)/usr/sbin/tftpd
+endef
+IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_MOVE_TFTPD_BINARY
+
+else
+IPUTILS_CONF_OPTS += -DBUILD_TFTPD=false
+endif
+
+# Handle libraries
 ifeq ($(BR2_PACKAGE_LIBCAP),y)
 IPUTILS_CONF_OPTS += -DUSE_CAP=true
 IPUTILS_DEPENDENCIES += libcap
@@ -45,13 +105,6 @@  IPUTILS_CONF_OPTS += -DUSE_CRYPTO=kernel
 IPUTILS_DEPENDENCIES += linux-headers
 else
 IPUTILS_CONF_OPTS += -DUSE_CRYPTO=none
-# BUILD_NINFOD=true and USE_CRYPTO=none cannot be combined
-IPUTILS_CONF_OPTS += -DBUILD_NINFOD=false
-endif
-
-# ninfod requires <pthread.h>
-ifneq ($(BR2_TOOLCHAIN_HAS_THREADS),y)
-IPUTILS_CONF_OPTS += -DBUILD_NINFOD=false
 endif
 
 ifeq ($(BR2_SYSTEM_ENABLE_NLS),y)
@@ -60,46 +113,35 @@  else
 IPUTILS_CONF_OPTS += -DUSE_GETTEXT=false
 endif
 
-IPUTILS_CONF_OPTS += -DBUILD_TRACEROUTE6=true
-
 # XSL Stylesheets for DocBook 5 not packaged for buildroot
 IPUTILS_CONF_OPTS += -DBUILD_MANS=false -DBUILD_HTML_MANS=false
 
-# move iputils binaries to the same location as where Busybox installs
-# the corresponding applets, so that we have a single version of the
-# tools (from iputils)
-define IPUTILS_MOVE_BINARIES
-	mv $(TARGET_DIR)/usr/bin/arping $(TARGET_DIR)/usr/sbin/arping
-	$(if $(BR2_ROOTFS_MERGED_USR),,\
-		mv $(TARGET_DIR)/usr/bin/ping $(TARGET_DIR)/bin/ping)
-	mv $(TARGET_DIR)/usr/bin/tftpd $(TARGET_DIR)/usr/sbin/tftpd
-endef
-IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_MOVE_BINARIES
-
-# upstream requires distros to create symlink
-define IPUTILS_CREATE_PING6_SYMLINK
-	ln -sf $(TARGET_DIR)/bin/ping $(TARGET_DIR)/bin/ping6
-endef
-IPUTILS_POST_INSTALL_TARGET_HOOKS += IPUTILS_CREATE_PING6_SYMLINK
-
 # handle permissions ourselves
 IPUTILS_CONF_OPTS += -DNO_SETCAP_OR_SUID=true
 ifeq ($(BR2_ROOTFS_DEVICE_TABLE_SUPPORTS_EXTENDED_ATTRIBUTES),y)
 define IPUTILS_PERMISSIONS
-	/usr/sbin/arping      f 755 0 0 - - - - -
-	/usr/bin/clockdiff    f 755 0 0 - - - - -
-	|xattr cap_net_raw+p
-	/bin/ping             f 755 0 0 - - - - -
-	|xattr cap_net_raw+p
-	/usr/bin/traceroute6  f 755 0 0 - - - - -
-	|xattr cap_net_raw+p
+	$(if $(BR2_PACKAGE_IPUTILS_ARPING),\
+		/usr/sbin/arping      f 755 0 0 - - - - -,)
+	$(if $(BR2_PACKAGE_IPUTILS_CLOCKDIFF),\
+		/usr/bin/clockdiff    f 755 0 0 - - - - -
+		|xattr cap_net_raw+p,)
+	$(if $(BR2_PACKAGE_IPUTILS_PING),\
+		/bin/ping             f 755 0 0 - - - - -
+		|xattr cap_net_raw+p,)
+	$(if $(BR2_PACKAGE_IPUTILS_TRACEROUTE6),\
+		/usr/bin/traceroute6  f 755 0 0 - - - - -
+		|xattr cap_net_raw+p,)
 endef
 else
 define IPUTILS_PERMISSIONS
-	/usr/sbin/arping      f  755 0 0 - - - - -
-	/usr/bin/clockdiff    f 4755 0 0 - - - - -
-	/bin/ping             f 4755 0 0 - - - - -
-	/usr/bin/traceroute6  f 4755 0 0 - - - - -
+	$(if $(BR2_PACKAGE_IPUTILS_ARPING),\
+		/usr/sbin/arping      f  755 0 0 - - - - -,)
+	$(if $(BR2_PACKAGE_IPUTILS_CLOCKDIFF),\
+		/usr/bin/clockdiff    f 4755 0 0 - - - - -,)
+	$(if $(BR2_PACKAGE_IPUTILS_PING),\
+		/bin/ping             f 4755 0 0 - - - - -,)
+	$(if $(BR2_PACKAGE_IPUTILS_TRACEROUTE6),\
+		/usr/bin/traceroute6  f 4755 0 0 - - - - -,)
 endef
 endif