First example of a Rust module implementation #344

SirVer · 2023-09-15T15:07:03Z

First Example of Rust Modules

This is modeled after the C++ Example modules, but shows up some more rustisms.

Co-authored-by: Dima Dorezyuk ddo@qwello.eu (@dorezyuk)
Co-authored-by: Kai Hermann (@hikinggrass)
Signed-off-by: Holger Rapp HolgerRapp@gmx.net

cmake/everest-generate.cmake

a-w50 · 2023-10-17T09:39:34Z

cmake/everest-generate.cmake

+                COMMAND ${CMAKE_COMMAND} -E env EVEREST_RS_FRAMEWORK_SOURCE_LOCATION="${everest-framework_SOURCE_DIR}" EVEREST_RS_FRAMEWORK_BINARY_LOCATION="${everest-framework_BINARY_DIR}" ${CARGO} build
+                WORKING_DIRECTORY ${MODULE_BUILD_PATH}


Here I would use the generator expressions, to directly link to the correct library

I do not understand what this means.

In cmake you have generator expressions, which can give you information about targets and other things. Say for example you have the library everest::framework (which resolves to a target), then you can get the full path to it via $<TARGET_FILE:everest::framework> instead of using guesses

I defer here, not sure how to implement that.

cmake/everest-generate.cmake

SirVer · 2023-10-24T17:33:03Z

@hikinggrass I fixed the bug that the Rust modules did not properly initialize themselves, they were immediately dropped, hence no work was taking place. This should be working fine now, I think it is ready for merging if you are happy.

The sign-offs are messed up. Once we are all happy, I will rebase once and make sure this is all signed-off correctly by me, the co-authored are all mentioned in the PR description.

a-w50

I wrote down some comments, I'll try to fix them

a-w50 · 2023-10-25T09:10:29Z

cmake/everest-generate.cmake

+            # workspace Cargo.toml, but we cannot easily pass it through the
+            # ev_add_module calls without polluting all CMakeLists.txt files
+            # with it. We bypass this using a global.
+            set_property(GLOBAL PROPERTY RUST_MODULE_LIST "")


Not sure about this one, but doesn't that reset the list all the time?

Furthermore, unfortunately there is this global variable, but a bit cleaner might be to create a custom target with add_custom_target called something like everest_core_build_rust_modules, then, you can set a property on this target with set_property( target ...) (so we have at least some 'encapsulation')
furthermore, when running the add_rust_module ..., this function can add additional targets/dependencies to the everest_core_build_rust_modules if necessary, so we have proper dependency tracking

I defer here, not sure how to implement that. As for resetting: it resets every time ev_add_project is called, so if this is called twice it would reset in between which is probably a problem. I am not sure how you are supposed to use the cMake stuff with out of repo builds, so I could not design for that.

a-w50 · 2023-10-25T09:18:50Z

cmake/everest-generate.cmake

+        return()
+    endif()
+
+    set(OUTPUT_FILE_PATH "${CMAKE_BINARY_DIR}/modules/Cargo.toml")


I would probably choose not the the modules folder, rather the generated/rust-whatever..

The Cargo.toml of the workspace must be in the top level of all Cargo modules. Having it in modules also allows to defer the exact location of where the binary ends up and makes sure that all rust modules use a consistent set of dependencies. I advise leaving it at its current place.

a-w50 · 2023-10-25T09:19:39Z

cmake/everest-generate.cmake

+
+    # Append each symlink path
+    foreach(SYMLINK ${RUST_MODULE_LIST})
+        file(APPEND "${OUTPUT_FILE_PATH}" "    \"${SYMLINK}\",\n")


cant we use just the full path here, instead of symlinking?

no, every member of a Cargo workspace must be in a subdirectory of a cargo workspace, hence symlinking is the only thing that works in the general case.

a-w50 · 2023-10-25T09:23:23Z

cmake/everest-generate.cmake

+    file(APPEND "${OUTPUT_FILE_PATH}" "]\n\n")
+
+    file(APPEND "${OUTPUT_FILE_PATH}" "[workspace.dependencies]\neverestrs = { path = \"")
+    file(APPEND "${OUTPUT_FILE_PATH}" "${everest-framework_SOURCE_DIR}/everestrs/everestrs")


Problem with ${everest-framework_SOURCE_DIR} is, that this only works with the integrated cpm build, not with yocto, it's also better here to use target properties

I defer here, not sure how to implement that, especially since I have no idea how you build this stuff in Yocto. Would be interesting to see though, since we need to build our own Yocto layers too.

a-w50 · 2023-10-25T09:25:44Z

cmake/everest-generate.cmake

+            execute_process(COMMAND rm -f "${MODULE_BUILD_PATH}")
+            execute_process(COMMAND ln -s "${MODULE_PATH}/" "${MODULE_BUILD_PATH}")


don't use execute_process, first of all, this will always run during cmake configure stage, secondly it will not stop the cmake configure stage if it fails
we should use add_custom_command here, which we can tack onto the above mentioned target as a dependency

I defer here, not sure how to implement that.

a-w50 · 2023-10-25T09:26:43Z

cmake/everest-generate.cmake

+            find_program(
+                CARGO
+                cargo
+                REQUIRED
+            )


this should not run for every add module, furthermore, try to things (that can fail) as early as possible, meaning, move it up

a-w50 · 2023-10-25T09:28:21Z

cmake/everest-generate.cmake

+            add_custom_target(
+                ${MODULE_NAME} ALL
+                COMMAND ${CMAKE_COMMAND} -E env EVEREST_RS_FRAMEWORK_SOURCE_LOCATION="${everest-framework_SOURCE_DIR}" EVEREST_RS_FRAMEWORK_BINARY_LOCATION="${everest-framework_BINARY_DIR}" ${CARGO} build ${CARGO_RELEASE_FLAG} --bin ${MODULE_NAME}
+                WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/modules
+                DEPENDS everest::framework
+            )


exactly, add this target as a dependency to the global everest_core_build_rust_modules target, and then do the symlinks inside here using commands

a-w50 · 2023-10-25T09:29:09Z

cmake/everest-generate.cmake

+                PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
+                DESTINATION "${EVEREST_MODULE_INSTALL_PREFIX}/${MODULE_NAME}"


I think if the created binary already has X flag set, then it will also be installed like this

Sure, then we have to figure out why the created binary only has OWNER_READ and OWNER_WRITE set and no *_EXECUTE flags

On my system it is executable, but I have not tested what happens if the flags are removed.

a-w50 · 2023-10-25T09:31:27Z

modules/rust_examples/Cargo.toml

+[workspace]
+resolver = "2"
+members = [
+   "RsExample",
+   "RsExampleUser",
+]
+
+[workspace.dependencies]
+# This is not used when building with cmake, but you can change this for local
+# development to point to a directory that works for you to build with cargo.
+everestrs = { path = "../everest-framework/everestrs/everestrs" }


so this file would be managed by hand for the cargo only experience?

would it be an option, if we supply a sample file here (like Cargo.toml.sample), which then can be copied and modified by the rust developer to Cargo.toml, and putting it into .gitignore, so it won't be uploaded?

I think that is the right solution. Are you doing this too when you brush up the cmake stuff, @a-w50 ?

SirVer · 2023-11-03T16:50:03Z

@hikinggrass What is this still waiting on?

.

hikinggrass · 2023-11-03T17:23:37Z

@hikinggrass What is this still waiting on?

Had to track down a bug in the Cargo.toml generation for the rust_workspace, that's fixed now and I'm on my way to squashing it :)

This is modelled after the C++ Example modules, but shows up some more rustisms. Co-authored-by: Dima Dorezyuk <ddo@qwello.eu> Signed-off-by: Holger Rapp <HolgerRapp@gmx.net> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

And sleep in RsExampleUser. Signed-off-by: Holger Rapp <HolgerRapp@gmx.net> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

- in principle, the strategy is as before, just using some cmake idioms - interesting question would be, if we can somehow setup the workspace via cmake so that rust only developers can use this directly with their IDE, we could make the RUST_WORKSPACE_DIR an user configurable option, and then, the user could use it directly Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

- figure out how to find and parse this file Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

SirVer · 2023-11-06T09:11:45Z

❤️ ❤️ 🎆 H O O R A Y 🚀 ❤️ ❤️

SirVer force-pushed the hrapp/first_rust_module branch 2 times, most recently from 4870363 to 2155b88 Compare September 19, 2023 14:20

SirVer force-pushed the hrapp/first_rust_module branch from 6b36828 to a55f0e3 Compare October 10, 2023 14:17

SirVer mentioned this pull request Oct 10, 2023

Rust integration: Adding variables & clients. EVerest/everest-framework#102

Merged

hikinggrass reviewed Oct 17, 2023

View reviewed changes

cmake/everest-generate.cmake Outdated Show resolved Hide resolved

a-w50 reviewed Oct 17, 2023

View reviewed changes

cmake/everest-generate.cmake Show resolved Hide resolved

a-w50 reviewed Oct 17, 2023

View reviewed changes

SirVer force-pushed the hrapp/first_rust_module branch from fd8af99 to 98fcc43 Compare October 24, 2023 09:40

SirVer requested review from a-w50 and hikinggrass October 24, 2023 09:41

hikinggrass reviewed Oct 24, 2023

View reviewed changes

cmake/everest-generate.cmake Outdated Show resolved Hide resolved

a-w50 previously requested changes Oct 25, 2023

View reviewed changes

hikinggrass force-pushed the hrapp/first_rust_module branch from 7a82a15 to 6ddb0e0 Compare November 2, 2023 11:47

hikinggrass approved these changes Nov 2, 2023

View reviewed changes

hikinggrass requested a review from a-w50 November 3, 2023 16:51

hikinggrass force-pushed the hrapp/first_rust_module branch from 6ddb0e0 to 389212d Compare November 3, 2023 17:12

hikinggrass force-pushed the hrapp/first_rust_module branch from be8d100 to c4e7a78 Compare November 3, 2023 17:26

SirVer and others added 9 commits November 3, 2023 18:27

First Example of Rust Modules

860be72

This is modelled after the C++ Example modules, but shows up some more rustisms. Co-authored-by: Dima Dorezyuk <ddo@qwello.eu> Signed-off-by: Holger Rapp <HolgerRapp@gmx.net> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Add WIP cmake integration for rust modules

828f4f6

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Build rust_example modules if rust support is enabled

9b087a8

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

use Arc::pin

7741122

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Rework how rust modules are build.

f2d3e57

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Install rust binaries with same permissions as c++ binaries

6dfe331

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Do not recurse while removing.

483e0bf

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Do not immediately drop the modules.

f681b9f

And sleep in RsExampleUser. Signed-off-by: Holger Rapp <HolgerRapp@gmx.net> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

a-w50 and others added 5 commits November 3, 2023 18:27

Create file with link dependencies

47a6f32

- figure out how to find and parse this file Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Fix renamed variable

6ca547c

Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Fix workspace dir creation

c3dc0c8

Signed-off-by: aw <aw@pionix.de> Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Fix Cargo.toml generation

2364cc0

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

Update everest-framework dependency

383050b

Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>

hikinggrass force-pushed the hrapp/first_rust_module branch from c4e7a78 to 383050b Compare November 3, 2023 17:27

hikinggrass merged commit f9f7a8e into EVerest:main Nov 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

First example of a Rust module implementation #344

First example of a Rust module implementation #344

SirVer commented Sep 15, 2023 •

edited

Loading

a-w50 Oct 17, 2023

SirVer Oct 24, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

SirVer commented Oct 24, 2023

a-w50 left a comment

a-w50 Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023 •

edited

Loading

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

a-w50 Oct 25, 2023

hikinggrass Oct 25, 2023

SirVer Oct 25, 2023

a-w50 Oct 25, 2023

a-w50 Oct 25, 2023

SirVer Oct 25, 2023

SirVer commented Nov 3, 2023

hikinggrass commented Nov 3, 2023

SirVer commented Nov 6, 2023

		COMMAND ${CMAKE_COMMAND} -E env EVEREST_RS_FRAMEWORK_SOURCE_LOCATION="${everest-framework_SOURCE_DIR}" EVEREST_RS_FRAMEWORK_BINARY_LOCATION="${everest-framework_BINARY_DIR}" ${CARGO} build
		WORKING_DIRECTORY ${MODULE_BUILD_PATH}

		execute_process(COMMAND rm -f "${MODULE_BUILD_PATH}")
		execute_process(COMMAND ln -s "${MODULE_PATH}/" "${MODULE_BUILD_PATH}")

		PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE
		DESTINATION "${EVEREST_MODULE_INSTALL_PREFIX}/${MODULE_NAME}"

First example of a Rust module implementation #344

First example of a Rust module implementation #344

Conversation

SirVer commented Sep 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SirVer commented Oct 24, 2023

a-w50 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SirVer Oct 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SirVer commented Nov 3, 2023

hikinggrass commented Nov 3, 2023

SirVer commented Nov 6, 2023

SirVer commented Sep 15, 2023 •

edited

Loading

SirVer Oct 25, 2023 •

edited

Loading