Merge pull request #490 from Linaro/rust-x86

Initial support for Rust on x86_64

Author: travisg

.github/workflows/github-ci-rust.yml

@@ -24,6 +24,7 @@ jobs:
           # Currently, this is hard-coded here, but should probably be gathered
           # from the source.
           - qemu-virt-arm64-test
+          - pc-x86-64-test
     env:
       PROJECT: ${{ matrix.project }}
       TOOLCHAIN_VER: ${{ matrix.toolchain-ver }}
@@ -64,16 +65,6 @@ jobs:
         echo "LIBGCC=" >> $GITHUB_ENV
         cat "$GITHUB_ENV"
 
-    # Install Rust
-    # Note that rustup is already included in the image, and we just need to add our target.
-    - name: install rust
-      shell: bash
-      run: |
-        rustup install nightly
-        rustup component add rust-src --toolchain nightly
-        rustup target add aarch64-unknown-linux-gnu
-        rustup target add aarch64-unknown-none
-
     # build it
     - name: build
       shell: bash

arch/x86/64/x86_64-llvm.json

@@ -0,0 +1,12 @@
+{
+    "arch": "x86_64",
+    "rustc-abi": "x86-softfloat",
+    "data-layout": "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-i128:128-f80:128-n8:16:32:64-S128",
+    "features": "-mmx,+soft-float,-retpoline-external-thunk,-retpoline-indirect-branches,-retpoline-indirect-calls,+harden-sls-ijmp,+harden-sls-ret",
+    "llvm-target": "x86_64-linux-gnu",
+    "supported-sanitizers": ["kcfi","kernel-address"],
+    "target-pointer-width": 64,
+    "emit-debug-gdb-scripts": false,
+    "frame-pointer": "may-omit",
+    "stack-probes": {"kind": "none"}
+}

lib/libc/string/bcmp.c

@@ -0,0 +1,18 @@
+/*
+** Copyright 2001, Travis Geiselbrecht. All rights reserved.
+** Distributed under the terms of the NewOS License.
+*/
+/*
+ * Copyright (c) 2008 Travis Geiselbrecht
+ *
+ * Use of this source code is governed by a MIT-style
+ * license that can be found in the LICENSE file or at
+ * https://opensource.org/licenses/MIT
+ */
+#include <string.h>
+#include <sys/types.h>
+
+int
+bcmp(const void *cs, const void *ct, size_t count) {
+    return memcmp(cs, ct, count);
+}

lib/libc/string/rules.mk

@@ -1,6 +1,7 @@
 LOCAL_DIR := $(GET_LOCAL_DIR)
 
 C_STRING_OPS := \
+	bcmp \
 	bcopy \
 	bzero \
 	memchr \

lib/rust_support/Cargo.toml.in

@@ -1,5 +1,7 @@
 # Rust meta crate
 
+cargo-features = ["panic-immediate-abort"]
+
 # This crate brings in the other dependencies needed so that cargo builds all of the Rust code that
 # we need.
 
@@ -22,9 +24,11 @@ debug-assertions = true
 overflow-checks = true
 debug = true
 codegen-units = 1
+panic = "immediate-abort"
 
 [profile.dev]
 opt-level = 2
 codegen-units = 1
+panic = "immediate-abort"
 
 @DEPCRATES@

lib/rust_support/rules.mk

@@ -21,6 +21,7 @@ MODULE_SRCDIR := $(MODULE)
 MODULE_BUILDDIR := $(call TOBUILDDIR,$(MODULE_SRCDIR))
 
 MODULE_SRCS := \
+	       $(MODULE_SRCDIR)/rust-toolchain.toml \
 	       $(MODULE_SRCDIR)/Cargo.toml \
 	       $(MODULE_SRCDIR)/src/lib.rs
 MODULE_OBJS := $(foreach d,$(MODULE_SRCS),$(call TOBUILDDIR,$(d)))
@@ -45,10 +46,19 @@ ifeq ($(RUST_TARGET_PATH),)
 RUST_TARGET_PATH := $(RUST_TARGET)
 endif
 
+ifndef RUST_CFLAGS
+RUST_CFLAGS :=
+endif
+
 define TOML_ESC
 $(subst \,\\,$(subst ",\",$1))
 endef
 
+# Expand a make "list" (space separated) into a quoted version appropriate for inserting into TOML.
+define TOML_ARRAY
+[$(foreach w,$(1),\"$(w)\",)]
+endef
+
 CARGO_CONFIG := $(MODULE_BUILDDIR)/.cargo/config.toml
 
 # TODO: Allow debug/release builds
@@ -62,7 +72,7 @@ $(MODULE_OBJECT): MODULE_BUILDDIR:=$(MODULE_BUILDDIR)
 # Override with module local values for the build rule.
 $(MODULE_OBJECT): $(MODULE_OBJECT).phony $(MODULE_OBJS) $(CARGO_CONFIG)
 	cd $(MODULE_BUILDDIR); \
-		cargo +nightly build
+		cargo build
 
 EXTRA_OBJS := $(EXTRA_OBJS) $(MODULE_OBJECT)
 
@@ -96,6 +106,9 @@ $(CARGO_CONFIG): $(CARGO_CONFIG).phony
 		echo "[env]"; \
 		echo 'GLOBAL_INCLUDES = { value = "$(call TOML_ESC,$(GLOBAL_INCLUDES))", force = true }'; \
 		echo; \
+		echo "[target.'cfg(all())']"; \
+		echo "rustflags = $(call TOML_ARRAY,$(RUST_CFLAGS))"; \
+		echo; \
 		echo "[unstable]"; \
 		echo 'build-std = ["core", "alloc"]'; \
 	} > "$$tmp"; \

lib/rust_support/rust-toolchain.toml.in

@@ -0,0 +1,3 @@
+[toolchain]
+channel = "nightly-2025-12-04"
+components = ["rust-src"]

platform/pc/rules.mk

@@ -36,5 +36,22 @@ LK_HEAP_IMPLEMENTATION ?= dlmalloc
 GLOBAL_DEFINES += \
 	PLATFORM_HAS_DYNAMIC_TIMER=1
 
-include make/module.mk
+# TODO: This probably needs to be different for 32 and 64 bit.
+RUST_TARGET := x86_64-llvm
+RUST_TARGET_PATH := $(abspath $(BUILDROOT))/arch/x86/64/x86_64-llvm.json
+
+RUST_CFLAGS := \
+    -Ctarget-feature=-sse,-sse2,-sse3,-ssse3,-sse4.1,-sse4.2,-avx,-avx2 \
+    -Ctarget-cpu=x86-64 \
+    -Ztune-cpu=generic \
+    -Cno-redzone=y \
+    -Copt-level=2 \
+    -Cdebug-assertions=n \
+    -Coverflow-checks=y \
+    -Ccode-model=kernel \
+    -Cforce-frame-pointers=y
+    #  -Zdwarf-version=5 -Cdebuginfo=2
+    # -Zfunction-return=thunk-extern
+    # -Zpatchable-function-entry=16,16
 
+include make/module.mk

project/pc-x86-64-test.mk

@@ -7,3 +7,10 @@ include project/target/pc.mk
 include project/virtual/fs.mk
 include project/virtual/minip.mk
 include project/virtual/test.mk
+
+USE_RUST ?= 0
+
+ifeq ($(call TOBOOL,$(USE_RUST)),true)
+$(info "Including rust support")
+include project/virtual/rust.mk
+endif