Skip to content

Commit dd3e0c8

Browse files
no1wudino1wudi
committed
examples: New app to build Rust with Cargo
Build Rust applictions with cargo is the most commn way, and it's more easy to cooporate with Rust ecosystem. This example shows how to use cargo to build a simple hello world application. And please notice that you need to install nighly version of rustc to support this feature, any version after rust-lang/rust#127755 is merged, can use NuttX as cargo target directly. Build ----- To build hello_rust_cargo application, you can use any target that based on RISCV32IMAC, for example: ``` cmake -B build -DBOARD_CONFIG=rv-virt:nsh -GNinja . ``` And disable ARCH_FPU in menuconfig, since the hard coded target triple in this demo is `riscv32imac`. Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
1 parent f517b66 commit dd3e0c8

File tree

8 files changed

+213
-0
lines changed

8 files changed

+213
-0
lines changed

‎examples/hello_rust_cargo/CMakeLists.txt

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# ##############################################################################
2+
# apps/examples/hello_rust_cargo/CMakeLists.txt
3+
#
4+
# Licensed to the Apache Software Foundation (ASF) under one or more contributor
5+
# license agreements. See the NOTICE file distributed with this work for
6+
# additional information regarding copyright ownership. The ASF licenses this
7+
# file to you under the Apache License, Version 2.0 (the "License"); you may not
8+
# use this file except in compliance with the License. You may obtain a copy of
9+
# the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16+
# License for the specific language governing permissions and limitations under
17+
# the License.
18+
#
19+
# ##############################################################################
20+
21+
include(nuttx_add_library)
22+
23+
if(CONFIG_EXAMPLES_HELLO_RUST_CARGO)
24+
25+
# Call cargo build from CMakeLists and add it to the build system. Notice we
26+
# should call cargo build with add_custom_target, otherwise cargo will be
27+
# called every time when cmake is configured.
28+
29+
add_custom_command(
30+
OUTPUT
31+
${CMAKE_BINARY_DIR}/hello_rust_cargo/riscv32imac-unknown-nuttx-elf/release/libhello.a
32+
COMMAND
33+
cargo build --release -Zbuild-std=core --manifest-path
34+
${CMAKE_CURRENT_SOURCE_DIR}/hello/Cargo.toml --target
35+
riscv32imac-unknown-nuttx-elf --target-dir
36+
${CMAKE_BINARY_DIR}/hello_rust_cargo)
37+
38+
add_custom_target(
39+
hello_rust_cargo
40+
DEPENDS
41+
${CMAKE_BINARY_DIR}/hello_rust_cargo/riscv32imac-unknown-nuttx-elf/release/libhello.a
42+
)
43+
44+
# Call cargo_build target each time when cmake is configured or generated.
45+
46+
# Add static library to the build system.
47+
nuttx_library_import(
48+
rust_hello
49+
${CMAKE_BINARY_DIR}/hello_rust_cargo/riscv32imac-unknown-nuttx-elf/release/libhello.a
50+
)
51+
nuttx_add_extra_library(rust_hello)
52+
53+
nuttx_add_application(
54+
NAME
55+
${CONFIG_EXAMPLES_HELLO_RUST_CARGO_PROGNAME}
56+
SRCS
57+
proxy_main.c
58+
STACKSIZE
59+
${CONFIG_EXAMPLES_HELLO_STACKSIZE}
60+
PRIORITY
61+
${CONFIG_EXAMPLES_HELLO_PRIORITY})
62+
63+
endif() # CONFIG_EXAMPLES_HELLO_RUST_CARGO

‎examples/hello_rust_cargo/Kconfig

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#
2+
# For a description of the syntax of this configuration file,
3+
# see the file kconfig-language.txt in the NuttX tools repository.
4+
#
5+
6+
config EXAMPLES_HELLO_RUST_CARGO
7+
tristate "\"Hello, Rust!\" example with Cargo"
8+
default n
9+
---help---
10+
Enable the \"Hello, Rust!\" example using Cargo to build.
11+
12+
if EXAMPLES_HELLO_RUST_CARGO
13+
14+
config EXAMPLES_HELLO_RUST_CARGO_PROGNAME
15+
string "Program name"
16+
default "hello_rust_cargo"
17+
---help---
18+
This is the name of the program that will be used when the
19+
program is installed.
20+
21+
config EXAMPLES_HELLO_RUST_CARGO_PRIORITY
22+
int "Hello Rust task priority"
23+
default 100
24+
25+
config EXAMPLES_HELLO_RUST_CARGO_STACKSIZE
26+
int "Hello Rust stack size"
27+
default DEFAULT_TASK_STACKSIZE
28+
29+
endif

‎examples/hello_rust_cargo/Make.defs

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
############################################################################
2+
# apps/examples/hello_rust_cargo/Make.defs
3+
#
4+
# Licensed to the Apache Software Foundation (ASF) under one or more
5+
# contributor license agreements. See the NOTICE file distributed with
6+
# this work for additional information regarding copyright ownership. The
7+
# ASF licenses this file to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance with the
9+
# License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16+
# License for the specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
############################################################################
20+
21+
ifneq ($(CONFIG_EXAMPLES_HELLO_RUST_CARGO),)
22+
CONFIGURED_APPS += $(APPDIR)/examples/hello_rust_cargo
23+
endif

‎examples/hello_rust_cargo/Makefile

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
############################################################################
2+
# apps/examples/hello_rust/Makefile
3+
#
4+
# Licensed to the Apache Software Foundation (ASF) under one or more
5+
# contributor license agreements. See the NOTICE file distributed with
6+
# this work for additional information regarding copyright ownership. The
7+
# ASF licenses this file to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance with the
9+
# License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16+
# License for the specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
############################################################################
20+
21+
include $(APPDIR)/Make.defs
22+
23+
# Hello, Rust! built-in application info
24+
25+
PROGNAME = $(CONFIG_EXAMPLES_HELLO_RUST_CARGO_PROGNAME)
26+
PRIORITY = $(CONFIG_EXAMPLES_HELLO_RUST_CARGO_PRIORITY)
27+
STACKSIZE = $(CONFIG_EXAMPLES_HELLO_RUST_CARGO_STACKSIZE)
28+
MODULE = $(CONFIG_EXAMPLES_HELLO_RUST_CARGO)
29+
30+
# Do not suppport building this application from Makefile.
31+
32+
include $(APPDIR)/Application.mk

‎examples/hello_rust_cargo/hello/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
target

‎examples/hello_rust_cargo/hello/Cargo.toml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[package]
2+
name = "hello"
3+
version = "0.1.0"
4+
edition = "2021"
5+
6+
[lib]
7+
crate-type = ["staticlib"]
8+
9+
[profile.dev]
10+
panic = "abort"
11+
12+
# Special hanlding for the panic! macro, can be removed once
13+
# the libstd port for NuttX is complete.
14+
[profile.release]
15+
panic = "abort"
16+
lto = true

‎examples/hello_rust_cargo/hello/src/lib.rs

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
// Function hello_rust_cargo without manglng
3+
#[no_mangle]
4+
pub extern "C" fn rust_main() {
5+
// Print hello world to stdout
6+
println!("Hello, world! from Rust and Cargo!");
7+
}

‎examples/hello_rust_cargo/proxy_main.c

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/****************************************************************************
2+
* apps/examples/hello_rust_cargo/proxy_main.c
3+
*
4+
* Licensed to the Apache Software Foundation (ASF) under one or more
5+
* contributor license agreements. See the NOTICE file distributed with
6+
* this work for additional information regarding copyright ownership. The
7+
* ASF licenses this file to you under the Apache License, Version 2.0 (the
8+
* "License"); you may not use this file except in compliance with the
9+
* License. You may obtain a copy of the License at
10+
*
11+
* http://www.apache.org/licenses/LICENSE-2.0
12+
*
13+
* Unless required by applicable law or agreed to in writing, software
14+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16+
* License for the specific language governing permissions and limitations
17+
* under the License.
18+
*
19+
****************************************************************************/
20+
21+
/****************************************************************************
22+
* Included Files
23+
****************************************************************************/
24+
25+
#include <nuttx/config.h>
26+
#include <stdio.h>
27+
28+
/****************************************************************************
29+
* Public Functions
30+
****************************************************************************/
31+
32+
extern void rust_main(void);
33+
34+
/****************************************************************************
35+
* main
36+
****************************************************************************/
37+
38+
int main(int argc, FAR char *argv[])
39+
{
40+
rust_main();
41+
return 0;
42+
}

0 commit comments

Comments
 (0)