Third-party crates support: proc-macro2, quote, syn, serde and serde_derive
#1007
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bjorn3
reviewed
May 6, 2023
| @@ -60,11 +61,73 @@ alloc-cfgs = \ | |||
| --cfg no_sync \ | |||
| --cfg no_thin | |||
|
|
|||
| proc_macro2-skip_flags := \ | |||
| --edition=2021 \ | |||
| -Drust_2018_idioms \ | |||
There was a problem hiding this comment.
Maybe do --cap-lints allow for all third-party crates? This overrides any -D arguments. It is also what cargo passes for all non-local crates.
bjorn3
reviewed
May 6, 2023
|
|
||
| serde-flags := \ | ||
| -Amissing_docs \ | ||
| --cfg no_fp_fmt_parse |
There was a problem hiding this comment.
If you pass --cfg 'feature="derive"' --extern serde_derive and make the serde target depend on serde_derive, you don't need --extern serde_derive elsewhere, but can instead access the derive macros using use serde::{Serialize, Deserialize};.
|
I am getting error when rustc-dev component is installed: |
|
That can probably be fixed by passing the path of |
|
I have the following error with rust-analyzer target: |
This is a subset of the Rust `proc-macro2` crate,
version 1.0.46, licensed under "Apache-2.0 OR MIT", from:
https://github.com/dtolnay/proc-macro2/raw/1.0.46/src
The files are copied as-is, with no modifications whatsoever
(not even adding the SPDX identifiers).
For copyright details, please see:
https://github.com/dtolnay/proc-macro2/blob/1.0.46/README.md#license
https://github.com/dtolnay/proc-macro2/blob/1.0.46/LICENSE-APACHE
https://github.com/dtolnay/proc-macro2/blob/1.0.46/LICENSE-MIT
The next two patches modify these files as needed for use within
the kernel. This patch split allows reviewers to double-check
the import and to clearly see the differences introduced.
The following script may be used to verify the contents:
for path in $(cd rust/proc-macro2/ && find . -type f -name '*.rs'); do
curl --silent --show-error --location \
https://github.com/dtolnay/proc-macro2/raw/1.0.46/src/$path \
| diff --unified rust/proc-macro2/$path - && echo $path: OK
done
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
The `proc-macro2` crate depends on the `unicode-ident` crate to determine whether characters have the XID_Start or XID_Continue properties according to Unicode Standard Annex torvalds#31. However, we only need ASCII identifiers in the kernel, thus we can simplify the check and remove completely that dependency. Signed-off-by: Miguel Ojeda <[email protected]>
This is a subset of the Rust `quote` crate,
version 1.0.21, licensed under "Apache-2.0 OR MIT", from:
https://github.com/dtolnay/quote/raw/1.0.21/src
The files are copied as-is, with no modifications whatsoever
(not even adding the SPDX identifiers).
For copyright details, please see:
https://github.com/dtolnay/quote/blob/1.0.21/README.md#license
https://github.com/dtolnay/quote/blob/1.0.21/LICENSE-APACHE
https://github.com/dtolnay/quote/blob/1.0.21/LICENSE-MIT
The next patch modifies these files as needed for use within
the kernel. This patch split allows reviewers to double-check
the import and to clearly see the differences introduced.
The following script may be used to verify the contents:
for path in $(cd rust/quote/ && find . -type f -name '*.rs'); do
curl --silent --show-error --location \
https://github.com/dtolnay/quote/raw/1.0.21/src/$path \
| diff --unified rust/quote/$path - && echo $path: OK
done
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
This is a subset of the Rust `syn` crate,
version 1.0.104, licensed under "Apache-2.0 OR MIT", from:
https://github.com/dtolnay/syn/raw/1.0.104/src
The files are copied as-is, with no modifications whatsoever
(not even adding the SPDX identifiers).
For copyright details, please see:
https://github.com/dtolnay/syn/blob/1.0.104/README.md#license
https://github.com/dtolnay/syn/blob/1.0.104/LICENSE-APACHE
https://github.com/dtolnay/syn/blob/1.0.104/LICENSE-MIT
The next two patches modify these files as needed for use within
the kernel. This patch split allows reviewers to double-check
the import and to clearly see the differences introduced.
The following script may be used to verify the contents:
for path in $(cd rust/syn/ && find . -type f -name '*.rs'); do
curl --silent --show-error --location \
https://github.com/dtolnay/syn/raw/1.0.104/src/$path \
| diff --unified rust/syn/$path - && echo $path: OK
done
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
The `syn` crate depends on the `unicode-ident` crate to determine whether characters have the XID_Start or XID_Continue properties according to Unicode Standard Annex torvalds#31. However, we only need ASCII identifiers in the kernel, thus we can simplify the check and remove completely that dependency. Signed-off-by: Miguel Ojeda <[email protected]>
This is a subset of the Rust `serde` crate,
version v1.0.156, licensed under "Apache-2.0 OR MIT", from:
https://github.com/serde-rs/serde/tree/v1.0.156/serde/src
The files are copied as-is, with no modifications whatsoever
(not even adding the SPDX identifiers).
For copyright details, please see:
https://github.com/serde-rs/serde/blob/v1.0.156/README.md#license
https://github.com/serde-rs/serde/blob/v1.0.156/LICENSE-APACHE
https://github.com/serde-rs/serde/blob/v1.0.156/LICENSE-MIT
The next three patches modify these files as needed for use within
the kernel. This patch split allows reviewers to double-check
the import and to clearly see the differences introduced.
The following script may be used to verify the contents:
for path in $(cd rust/serde/ && find . -type f -name '*.rs'); do
curl --silent --show-error --location \
https://github.com/serde-rs/serde/raw/v1.0.156/serde/src/$path \
| diff --unified rust/serde/$path - && echo $path: OK
done
Signed-off-by: Miguel Ojeda <[email protected]>
We do not have formatting for floating point in the kernel, thus simple compile out all that. Probably we should name it differently, more similar to `integer128`. Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
This is a subset of the Rust `serde_derive` crate,
version v1.0.156, licensed under "Apache-2.0 OR MIT", from:
https://github.com/serde-rs/serde/tree/v1.0.156/serde_derive/src
The files are copied as-is, with no modifications whatsoever
(not even adding the SPDX identifiers).
For copyright details, please see:
https://github.com/serde-rs/serde/blob/v1.0.156/README.md#license
https://github.com/serde-rs/serde/blob/v1.0.156/LICENSE-APACHE
https://github.com/serde-rs/serde/blob/v1.0.156/LICENSE-MIT
The next patch modifies these files as needed for use within
the kernel. This patch split allows reviewers to double-check
the import and to clearly see the differences introduced.
The following script may be used to verify the contents:
for path in $(cd rust/serde_derive/ && find . -type f -name '*.rs'); do
curl --silent --show-error --location \
https://github.com/serde-rs/serde/raw/v1.0.156/serde_derive/src/$path \
| diff --unified rust/serde_derive/$path - && echo $path: OK
done
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Miguel Ojeda <[email protected]>
…e_derive` With all the new files in place from the new crates, this patch adds support for them in the build system. Note that, if we decide to add third-party crates support to upstream, we would probably want to do it in a different way. But this is useful for playing around with these crates, experimenting, etc. Signed-off-by: Miguel Ojeda <[email protected]>
A trivial example based on `serde`'s `example-format' [1].
It contains both a in-`kernel` data format later used by
the kernel module, as well as a local data format in
the module.
The kernel module gives an output such as:
[ 0.801425] rust_serde: Rust serde sample (init)
[ 0.801634] rust_serde: original = S { a: (), b: false, c: true, d: () }
[ 0.802079] rust_serde: serialized = [2, 0, 1, 0, 1, 1, 0, 3]
[ 0.802506] rust_serde: deserialized = S { a: (), b: false, c: true, d: () }
[ 0.802718] rust_serde: serialized (local) = [2, 0, 1, 42, 1, 43, 0, 3]
[ 0.802895] rust_serde: deserialized (local) = S { a: (), b: false, c: true, d: () }
[ 0.808954] rust_serde: Rust serde sample (exit)
Note that this is just a quick draft/hack to check the previous
commits work. It is not intended to be merged at all.
Link: https://github.com/serde-rs/example-format [1]
Signed-off-by: Miguel Ojeda <[email protected]>
|
That should be fixed in commit 5c7548d, but Let me move |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Like #910, but this time based on top of
rust-next(instead ofrust), and addsserdeandserde_deriveon top.I include a draft commit at the end as a way to test that
serdeandserde_deriveworks in both thekernelcrate and in a kernel module:Important note: it is not yet decided whether third-party crates will be upstreamed or not, or which ones, but this is useful for others to experiment and prototype solutions assuming these crates are available.
Cc @ariel-miculas who wanted to experiment with
serdein the kernel: https://rust-for-linux.zulipchat.com/#narrow/stream/291565-Help/topic/Adding.20crates.20to.20out-of-tree.20modules/near/355792607