Skip to contentSkip to conversation

pkg-rust: new infrastructure

PATCH In review James Hilliard 4 participants 5 messages Jun 10, 2021 – Jan 6, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 pkg-rust: new infrastructure

Add a new infrastructure to ease the development of packages that use rust's cargo as their build system.

---
 package/Makefile.in |   1 +
 package/pkg-rust.mk | 113 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 package/pkg-rust.mk
package/Makefile.in +1 -0
index 955e6a8e8c..c4fb6a3cb1 100644
@@ -434,3 +434,4 @@ include package/pkg-waf.mk
 include package/pkg-golang.mk
 include package/pkg-meson.mk
 include package/pkg-qmake.mk
+include package/pkg-rust.mk
package/pkg-rust.mk new file +113 -0

113 lines not on this page · raw message

Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/1 pkg-rust: new infrastructure

Hi James,

Quoted 9 lines

-----Original Message-----
From: buildroot <[email protected]> On Behalf Of James Hilliard
Sent: Wednesday, June 09, 2021 9:07 PM
To: buildroot at buildroot.org
Cc: James Hilliard <[email protected]>
Subject: [External] [Buildroot] [PATCH 1/1] pkg-rust: new infrastructure

Add a new infrastructure to ease the development of packages that use rust's cargo as their build system.

Thanks for digging into this, great to see more interest in bringing rust into the ecosystem. There has been some previous efforts[1] which are in differing levels of readiness.

You may wish to look into these, as I believe there is some overlap between the patch sets. I linked the latest, but there are more to be found too.

Sam

1: http://patchwork.ozlabs.org/project/buildroot/list/?series=221371&state=*

Quoted 144 lines

---
package/Makefile.in | 1 +
package/pkg-rust.mk | 113 ++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 114 insertions(+)

create mode 100644 package/pkg-rust.mk

package/Makefile.in +0 -0
index 955e6a8e8c..c4fb6a3cb1 100644
@@ -434,3 +434,4 @@ include package/pkg-waf.mk

include package/pkg-golang.mk
include package/pkg-meson.mk
include package/pkg-qmake.mk

package/Makefile.in +1 -0
+include package/pkg-rust.mk
package/pkg-rust.mk new file +113 -1
new file mode 100644
index 0000000000..3906fc12b4
@@ -0,0 +1,113 @@
+################################################################################
+# Rust package infrastructure
+#
+# This file implements an infrastructure that eases development of
+# package .mk files for Rust packages. It should be used for all
+# packages that use Rust as their build system.
+#
+# See the Buildroot documentation for details on the usage of this
+# infrastructure
+#
+# In terms of implementation, this Rust infrastructure requires
+# the .mk file to only specify metadata information about the
+# package: name, version, download URL, etc.
+#
+# We still allow the package .mk file to override what the different
+# steps are doing, if needed. For example, if <PKG>_BUILD_CMDS is
+# already defined, it is used as the list of commands to perform to
+# build the package, instead of the default Rust behaviour. The
+# package can also define some post operation hooks.
+#
+################################################################################
+
+CARGO = $(HOST_DIR)/bin/cargo
+
+RUSTC_TARGET_TRIPLE = $(subst -,_,$(call UPPERCASE,$(RUSTC_TARGET_NAME)))
+
+PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_BUILD_TARGET=$(RUSTC_TARGET_NAME) \
+??????CARGO_INSTALL_ROOT=$(TARGET_DIR)/usr \
+??????CARGO_TARGET_$(RUSTC_TARGET_TRIPLE)_LINKER=$(notdir $(TARGET_CROSS))gcc
+
+HOST_PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_INSTALL_ROOT=$(HOST_DIR) \
+??????RUSTFLAGS="$(addprefix -C link-args=,$(HOST_LDFLAGS))"
+
+ifeq ($(BR2_ENABLE_RUNTIME_DEBUG),y)
+PKG_RUST_CARGO_OPTS = --debug
+else
+PKG_RUST_CARGO_OPTS = --release
+endif
+
+################################################################################
+# inner-rust-package -- defines how the configuration, compilation and
+# installation of a Rust package should be done, implements a few hooks to
+# tune the build process and calls the generic package infrastructure to
+# generate the necessary make targets
+#
+#  argument 1 is the lowercase package name
+#  argument 2 is the uppercase package name, including a HOST_ prefix
+#             for host packages
+#  argument 3 is the uppercase package name, without the HOST_ prefix
+#             for host packages
+#  argument 4 is the type (target or host)
+################################################################################
+
+define inner-rust-package
+
+$(2)_DEPENDENCIES += host-rustc
+
+#
+# Build step. Only define it if not already defined by the package .mk
+# file.
+#
+ifndef $(2)_BUILD_CMDS
+ifeq ($(4),target)
+define $(2)_BUILD_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS) $$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml
+endef
+else
+define $(2)_BUILD_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS) $$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml
+endef
+endif
+endif
+
+#
+# Host installation step. Only define it if not already defined by the
+# package .mk file.
+#
+ifndef $(2)_INSTALL_CMDS
+define $(2)_INSTALL_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path $$($$(PKG)_BUILDDIR)
+endef
+endif
+
+#
+# Target installation step. Only define it if not already defined by
+# the package .mk file.
+#
+ifndef $(2)_INSTALL_TARGET_CMDS
+define $(2)_INSTALL_TARGET_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path $$($$(PKG)_BUILDDIR)
+endef
+endif
+
+# Call the generic package infrastructure to generate the necessary
+# make targets
+$(call inner-generic-package,$(1),$(2),$(3),$(4))
+
+endef
+
+################################################################################
+# rust-package -- the target generator macro for Rust packages
+################################################################################
+
+rust-package = $(call inner-rust-package,$(pkgname),$(call UPPERCASE,$(pkgname)),$(call UPPERCASE,$(pkgname)),target)
+host-rust-package = $(call inner-rust-package,host-$(pkgname),$(call UPPERCASE,host-$(pkgname)),$(call UPPERCASE,$(pkgname)),host)
--

2.25.1

_______________________________________________
buildroot mailing list
buildroot at busybox.net
https://urldefense.com/v3/__http://lists.busybox.net/mailman/listinfo/buildroot__;!!MvWE!QexAynmm9OiOcSWKCv_ttzGuz9LcnLCGjz_R7rvmHVags54BwN2Zs8i4d7t2LN4$

#2 lore raw

PATCH 1/1 pkg-rust: new infrastructure

Quoted 10 lines · Samuel M Collins

Hi James,

Quoted 7 lines

-----Original Message-----
From: buildroot <[email protected]> On Behalf Of James Hilliard
Sent: Wednesday, June 09, 2021 9:07 PM
To: buildroot at buildroot.org
Cc: James Hilliard <[email protected]>
Subject: [External] [Buildroot] [PATCH 1/1] pkg-rust: new infrastructure

Quoted 6 lines
Quoted 2 lines

Add a new infrastructure to ease the development of packages that use rust's cargo as their build system.

Thanks for digging into this, great to see more interest in bringing rust into the ecosystem. There has been some previous efforts[1] which are in differing levels of readiness.

You may wish to look into these, as I believe there is some overlap between the patch sets. I linked the latest, but there are more to be found too.

Yeah, probably best to get those merged first, I'll rebase this after, I was mostly testing to see if just using env variables instead of a cargo config file was a viable approach for configuring cargo properly. From my understanding cargo can generally be configured with env variables alone.

Quoted 149 lines

Sam

1: http://patchwork.ozlabs.org/project/buildroot/list/?series=221371&state=*

Quoted 144 lines

---
package/Makefile.in | 1 +
package/pkg-rust.mk | 113 ++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 114 insertions(+)

create mode 100644 package/pkg-rust.mk

package/Makefile.in +0 -0
index 955e6a8e8c..c4fb6a3cb1 100644
@@ -434,3 +434,4 @@ include package/pkg-waf.mk

include package/pkg-golang.mk
include package/pkg-meson.mk
include package/pkg-qmake.mk

package/Makefile.in +1 -0
+include package/pkg-rust.mk
package/pkg-rust.mk new file +113 -1
new file mode 100644
index 0000000000..3906fc12b4
@@ -0,0 +1,113 @@
+################################################################################
+# Rust package infrastructure
+#
+# This file implements an infrastructure that eases development of
+# package .mk files for Rust packages. It should be used for all
+# packages that use Rust as their build system.
+#
+# See the Buildroot documentation for details on the usage of this
+# infrastructure
+#
+# In terms of implementation, this Rust infrastructure requires
+# the .mk file to only specify metadata information about the
+# package: name, version, download URL, etc.
+#
+# We still allow the package .mk file to override what the different
+# steps are doing, if needed. For example, if <PKG>_BUILD_CMDS is
+# already defined, it is used as the list of commands to perform to
+# build the package, instead of the default Rust behaviour. The
+# package can also define some post operation hooks.
+#
+################################################################################
+
+CARGO = $(HOST_DIR)/bin/cargo
+
+RUSTC_TARGET_TRIPLE = $(subst -,_,$(call UPPERCASE,$(RUSTC_TARGET_NAME)))
+
+PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_BUILD_TARGET=$(RUSTC_TARGET_NAME) \
+??????CARGO_INSTALL_ROOT=$(TARGET_DIR)/usr \
+??????CARGO_TARGET_$(RUSTC_TARGET_TRIPLE)_LINKER=$(notdir $(TARGET_CROSS))gcc
+
+HOST_PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_INSTALL_ROOT=$(HOST_DIR) \
+??????RUSTFLAGS="$(addprefix -C link-args=,$(HOST_LDFLAGS))"
+
+ifeq ($(BR2_ENABLE_RUNTIME_DEBUG),y)
+PKG_RUST_CARGO_OPTS = --debug
+else
+PKG_RUST_CARGO_OPTS = --release
+endif
+
+################################################################################
+# inner-rust-package -- defines how the configuration, compilation and
+# installation of a Rust package should be done, implements a few hooks to
+# tune the build process and calls the generic package infrastructure to
+# generate the necessary make targets
+#
+#  argument 1 is the lowercase package name
+#  argument 2 is the uppercase package name, including a HOST_ prefix
+#             for host packages
+#  argument 3 is the uppercase package name, without the HOST_ prefix
+#             for host packages
+#  argument 4 is the type (target or host)
+################################################################################
+
+define inner-rust-package
+
+$(2)_DEPENDENCIES += host-rustc
+
+#
+# Build step. Only define it if not already defined by the package .mk
+# file.
+#
+ifndef $(2)_BUILD_CMDS
+ifeq ($(4),target)
+define $(2)_BUILD_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS) $$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml
+endef
+else
+define $(2)_BUILD_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS) $$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml
+endef
+endif
+endif
+
+#
+# Host installation step. Only define it if not already defined by the
+# package .mk file.
+#
+ifndef $(2)_INSTALL_CMDS
+define $(2)_INSTALL_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path $$($$(PKG)_BUILDDIR)
+endef
+endif
+
+#
+# Target installation step. Only define it if not already defined by
+# the package .mk file.
+#
+ifndef $(2)_INSTALL_TARGET_CMDS
+define $(2)_INSTALL_TARGET_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path $$($$(PKG)_BUILDDIR)
+endef
+endif
+
+# Call the generic package infrastructure to generate the necessary
+# make targets
+$(call inner-generic-package,$(1),$(2),$(3),$(4))
+
+endef
+
+################################################################################
+# rust-package -- the target generator macro for Rust packages
+################################################################################
+
+rust-package = $(call inner-rust-package,$(pkgname),$(call UPPERCASE,$(pkgname)),$(call UPPERCASE,$(pkgname)),target)
+host-rust-package = $(call inner-rust-package,host-$(pkgname),$(call UPPERCASE,host-$(pkgname)),$(call UPPERCASE,$(pkgname)),host)
--

2.25.1

_______________________________________________
buildroot mailing list
buildroot at busybox.net
https://urldefense.com/v3/__http://lists.busybox.net/mailman/listinfo/buildroot__;!!MvWE!QexAynmm9OiOcSWKCv_ttzGuz9LcnLCGjz_R7rvmHVags54BwN2Zs8i4d7t2LN4$

#3 lore raw

PATCH 1/1 pkg-rust: new infrastructure

Hi James, all,

Quoted 24 lines · On Sat, 12 Jun 2021 12:37:29 -0600 James Hilliard <[email protected]>…
Quoted 14 lines · Samuel M Collins

Hi James,

Quoted 10 lines

-----Original Message-----
From: buildroot <[email protected]> On Behalf Of James Hilliard Sent: Wednesday, June 09, 2021 9:07 PM
To: buildroot at buildroot.org
Cc: James Hilliard <[email protected]>
Subject: [External] [Buildroot] [PATCH 1/1] pkg-rust: new infrastructure

Add a new infrastructure to ease the development of packages that use rust's cargo as their build system.

Quoted 7 lines

Thanks for digging into this, great to see more interest in bringing rust into the ecosystem. There has been some previous efforts[1] which are in differing levels of readiness.

You may wish to look into these, as I believe there is some overlap between the patch sets. I linked the latest, but there are more to be found too.

Quoted 5 lines

Yeah, probably best to get those merged first, I'll rebase this after, I was mostly testing to see if just using env variables instead of a cargo config file was a viable approach for configuring cargo properly. From my understanding cargo can generally be configured with env variables alone.

The advantage of env variables is that they take precedence over config files. I had some trouble with a config file in my home directory that specified a different linker, and was found before the buildroot one.

J?rgen

Quoted 145 lines
Quoted 145 lines

Sam

1:
http://patchwork.ozlabs.org/project/buildroot/list/?series=221371&state=*

Quoted 140 lines

---
package/Makefile.in | 1 +
package/pkg-rust.mk | 113 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 114 insertions(+) create mode 100644 package/pkg-rust.mk

package/Makefile.in +0 -0
index 955e6a8e8c..c4fb6a3cb1 100644
@@ -434,3 +434,4 @@ include package/pkg-waf.mk

include package/pkg-golang.mk
include package/pkg-meson.mk
include package/pkg-qmake.mk

package/Makefile.in +1 -0
+include package/pkg-rust.mk
package/pkg-rust.mk new file +15 -0
new file mode 100644
index 0000000000..3906fc12b4
@@ -0,0 +1,113 @@
+################################################################################
+# Rust package infrastructure
+#
+# This file implements an infrastructure that eases development of
+# package .mk files for Rust packages. It should be used for all
+# packages that use Rust as their build system.
+#
+# See the Buildroot documentation for details on the usage of this
+# infrastructure
+#
+# In terms of implementation, this Rust infrastructure requires
+# the .mk file to only specify metadata information about the
+# package: name, version, download URL, etc.
+#
+# We still allow the package .mk file to override what the

different +# steps are doing, if needed. For example, if <PKG>_BUILD_CMDS is +# already defined, it is used as the list of commands to perform to +# build the package, instead of the default Rust behaviour. The +# package can also define some post operation hooks. +#

package/pkg-rust.mk new file +5 -0
+################################################################################
+
+CARGO = $(HOST_DIR)/bin/cargo
+
+RUSTC_TARGET_TRIPLE = $(subst -,_,$(call

UPPERCASE,$(RUSTC_TARGET_NAME))) + +PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_BUILD_TARGET=$(RUSTC_TARGET_NAME) \
+??????CARGO_INSTALL_ROOT=$(TARGET_DIR)/usr \
+??????CARGO_TARGET_$(RUSTC_TARGET_TRIPLE)_LINKER=$(notdir $(TARGET_CROSS))gcc +

package/pkg-rust.mk new file +13 -0
+HOST_PKG_RUST_CARGO_ENV = \
+??????CARGO_HOME=$(HOST_DIR)/share/cargo \
+??????CARGO_INSTALL_ROOT=$(HOST_DIR) \
+??????RUSTFLAGS="$(addprefix -C link-args=,$(HOST_LDFLAGS))"
+
+ifeq ($(BR2_ENABLE_RUNTIME_DEBUG),y)
+PKG_RUST_CARGO_OPTS = --debug
+else
+PKG_RUST_CARGO_OPTS = --release
+endif
+
+################################################################################
+# inner-rust-package -- defines how the configuration,

compilation and +# installation of a Rust package should be done, implements a few hooks to +# tune the build process and calls the generic package infrastructure to +# generate the necessary make targets +#

package/pkg-rust.mk new file +2 -0
+#  argument 1 is the lowercase package name
+#  argument 2 is the uppercase package name, including a HOST_

prefix +# for host packages
+# argument 3 is the uppercase package name, without the HOST_
prefix +# for host packages

package/pkg-rust.mk new file +9 -0
+#  argument 4 is the type (target or host)
+################################################################################
+
+define inner-rust-package
+
+$(2)_DEPENDENCIES += host-rustc
+
+#
+# Build step. Only define it if not already defined by the

package .mk +# file.

package/pkg-rust.mk new file +6 -0
+#
+ifndef $(2)_BUILD_CMDS
+ifeq ($(4),target)
+define $(2)_BUILD_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS)

$$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml +endef +else +define $(2)_BUILD_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) build $$(PKG_RUST_CARGO_OPTS) $$($$(PKG)_RUST_CARGO_OPTS) --manifest-path=$$($$(PKG)_BUILDDIR)/Cargo.toml +endef +endif

package/pkg-rust.mk new file +4 -0
+endif
+
+#
+# Host installation step. Only define it if not already defined

by the +# package .mk file.

package/pkg-rust.mk new file +5 -0
+#
+ifndef $(2)_INSTALL_CMDS
+define $(2)_INSTALL_CMDS
+??????$$(HOST_MAKE_ENV) $$(HOST_PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path

$$($$(PKG)_BUILDDIR) +endef

package/pkg-rust.mk new file +4 -0
+endif
+
+#
+# Target installation step. Only define it if not already defined

by +# the package .mk file.

package/pkg-rust.mk new file +5 -0
+#
+ifndef $(2)_INSTALL_TARGET_CMDS
+define $(2)_INSTALL_TARGET_CMDS
+??????$$(TARGET_MAKE_ENV) $$(PKG_RUST_CARGO_ENV) \
+??????????????$$(CARGO) install --offline --frozen --path

$$($$(PKG)_BUILDDIR) +endef

package/pkg-rust.mk new file +3 -0
+endif
+
+# Call the generic package infrastructure to generate the

necessary +# make targets
+$(call inner-generic-package,$(1),$(2),$(3),$(4))

package/pkg-rust.mk new file +8 -0
+
+endef
+
+################################################################################
+# rust-package -- the target generator macro for Rust packages
+################################################################################
+
+rust-package = $(call inner-rust-package,$(pkgname),$(call

UPPERCASE,$(pkgname)),$(call UPPERCASE,$(pkgname)),target) +host-rust-package = $(call inner-rust-package,host-$(pkgname),$(call UPPERCASE,host-$(pkgname)),$(call UPPERCASE,$(pkgname)),host) -- 2.25.1

Signature · 5 lines
J?rgen Stuber <[email protected]>
http://www.jstuber.net/
Tel: +49-208-304 20 50
Mobil: +49-178-39 39 628
1B78 A579 E159 2A85 67BB  1314 C083 224B 0F9C DA21
#4 lore raw
In reply to James Hilliard

Hello James,

Quoted 9 lines · On Wed, 9 Jun 2021 20:06:32 -0600 James Hilliard <[email protected]>…

Add a new infrastructure to ease the development of packages that use rust's cargo as their build system.

---
 package/Makefile.in |   1 +
 package/pkg-rust.mk | 113 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 114 insertions(+)
 create mode 100644 package/pkg-rust.mk

I have re-submitted a new version of the Cargo package infrastructure, which I had submitted a long time ago. I think it's very close to what you have done, but also supports vendoring thanks to additional logic, also shared with the Go package infrastructure.

Could you have a look at the series I just posted?

Thanks!

Thomas

Signature · 7 lines
Thomas Petazzoni, CTO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot