Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Const generics #759

Merged
merged 2 commits into from May 9, 2022
Merged

Const generics #759

merged 2 commits into from May 9, 2022

Conversation

jorendorff
Copy link
Contributor

A rough implementation of const generics.

Well, this codebase is a delight to work with. I thought of this as a tricky feature, but it was mostly obvious what to do.

It helped that there was already a place where values could appear in types: array lengths. This reuses ArrayLength. (I can rename that to ConstExpr, if you like.)

The main iffy thing with this PR is that it monomorphizes ArrayString<20> and ArrayString<N> to two different C types, ArrayString_20 and ArrayString_N, even if N is 20. To fix that, we'd have to fully evaluate constant expressions, which requires implementing Rust name lookups. I might need a little help if you want to go that route...

Copy link
Collaborator

@emilio emilio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoa, this is great, thank you so much! I don't really have many concerns after having taken a look, it ended up being much simpler than I expected when I read the PR title ;)

The quirk you point out in the PR description is somewhat annoying to address very generally, because cbindgen doesn't understand much of the Rust module type system.

It's an issue for typedefs as well, see:

#[repr(i32)]
pub enum Foo { A, B }

#[repr(C)]
pub struct Generic<T> {
    t: T,
}

pub type Bar = Foo;

#[no_mangle]
pub extern "C" fn root(a: &Generic<Foo>, b: &Generic<Bar>) {}

Which generates:

#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>

enum Foo {
  A,
  B,
};
typedef int32_t Foo;

typedef struct Generic_Foo {
  Foo t;
} Generic_Foo;

typedef Foo Bar;

typedef struct Generic_Bar {
  Bar t;
} Generic_Bar;

void root(const struct Generic_Foo *a, const struct Generic_Bar *b);

So I think it's something that we can punt on for now, in the sense that we're not generating unsound code or anything...

pub fn rename_for_config(&mut self, config: &Config, generic_params: &GenericParams) {
for generic in &mut self.generics {
generic.rename_for_config(config, generic_params);
}
if !generic_params.contains(&self.path) {
if !generic_params.iter().any(|param| param.name == self.path) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth implementing a proper contains in GenericParams perhaps, if this check needs to be done in many places... For now it's just two so it's probably fine.

@emilio
Copy link
Collaborator

emilio commented May 7, 2022

(Ah, I forgot that CI doesn't run by default for new contributors, so I pushed the button to approve it, and will merge it once it's green. Feel free to ping if I forget. Thanks again!)

@jorendorff
Copy link
Contributor Author

Friendly ping! This is green now.

@emilio emilio merged commit c732069 into mozilla:master May 9, 2022
@emilio
Copy link
Collaborator

emilio commented May 9, 2022

Thanks for the ping!

zshipko pushed a commit to extism/extism that referenced this pull request Aug 29, 2023
Updates the requirements on
[cbindgen](https://github.com/eqrion/cbindgen) to permit the latest
version.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/mozilla/cbindgen/blob/master/CHANGES">cbindgen's
changelog</a>.</em></p>
<blockquote>
<h2>0.25.0</h2>
<pre><code>  * Re-release of yanked 0.24.6 as a major release
  * Update MSRV to 1.57
* Support variadic arguments (`...`)
([#805](mozilla/cbindgen#805))
* Add --depfile option
([#820](mozilla/cbindgen#820))
  * Breaking changes: The `Config` struct now has a private member.
</code></pre>
<h2>0.24.6 (YANKED: depfile option was breaking, see <a
href="https://redirect.github.com/eqrion/cbindgen/issues/841">#841</a>)</h2>
<pre><code>  * Update MSRV to 1.57
* Support variadic arguments (`...`)
([#805](mozilla/cbindgen#805))
* Add --depfile option
([#820](mozilla/cbindgen#820))
</code></pre>
<h2>0.24.5</h2>
<pre><code>  * Don't enforce tempfile version.
</code></pre>
<h2>0.24.4</h2>
<pre><code> * Move expand infinite recursion fix
([#799](mozilla/cbindgen#799))
* Add with_cpp_compat to the builder
([#796](mozilla/cbindgen#796))
* Handle never type in return position consistently
([#780](mozilla/cbindgen#780))
* Fix warnings ([#816](mozilla/cbindgen#816),
[#819](mozilla/cbindgen#819))
* Updated documentation
([#788](mozilla/cbindgen#788),
[#791](mozilla/cbindgen#791),
[#792](mozilla/cbindgen#792),
[#810](mozilla/cbindgen#810),
[#823](mozilla/cbindgen#823))
</code></pre>
<h2>0.24.3</h2>
<pre><code> * Make struct expressions correctly generated through
typedefs ([#768](mozilla/cbindgen#768)).
</code></pre>
<h2>0.24.2</h2>
<pre><code>  * Make bitfield operators use explicit constructors.
</code></pre>
<h2>0.24.1</h2>
<pre><code> * Add support for unary negation
([#765](mozilla/cbindgen#765)).
* Make more bitfield operators constexpr
([#765](mozilla/cbindgen#765)).
</code></pre>
<h2>0.24.0</h2>
<pre><code> * Basic const generic support
([#759](mozilla/cbindgen#759),
[#760](mozilla/cbindgen#760)
[#762](mozilla/cbindgen#762)).
* Suffixes on integer literals are now honored to avoid narrowing
([#764](mozilla/cbindgen#764)).
</code></pre>
<h2>0.23.0</h2>
<pre><code> * Better support for constexpr.
([#756](mozilla/cbindgen#756))
* constexpr is now enabled by default in C++ mode. You can use
const.allow_constexpr=false to revert to previous behavior.
([#756](mozilla/cbindgen#756))
* Minimum syn version no longer parses old rust code.
([#754](mozilla/cbindgen#754))
</code></pre>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/mozilla/cbindgen/commit/dd9a550152cd162a3aa01757a55dd22fc56d0d8a"><code>dd9a550</code></a>
Fix minimal Rust version in CI</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/0529d215e7a1b2ad94ca166c1b26ad96f10e4a1c"><code>0529d21</code></a>
Revert &quot;Upgrade clap 3 to clap 4&quot;</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/289a31ba45c28a6d8d5eb681f7e1c83a23cdb673"><code>289a31b</code></a>
Fix clippy warning</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/67fea1a1a2e77464f96f184b298aed848ac38d53"><code>67fea1a</code></a>
Fix CI</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/80526e72f9109d45da10625e790791fc3a5cc18a"><code>80526e7</code></a>
Update changelog for v0.25.0</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/1e2ffd4414e1124f526a19ccb3b627c0e3694f53"><code>1e2ffd4</code></a>
CI: Replace forbidden actions with cli code</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/f61946b9798982c4c27da9fd5917824db2093095"><code>f61946b</code></a>
CI: Add semver checks to CI deploy job</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/b61aa2c330b3d4fe3bbe4fa71d9bc7104b7c94f7"><code>b61aa2c</code></a>
msrv 1.64</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/b734008c71f31a125797e799f420e1ad32f6b2f9"><code>b734008</code></a>
Upgrade clap 3 to clap 4</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/667de09279c3d5f0524216fefa949e64cbd3bc1a"><code>667de09</code></a>
Add: Add rust-toolchain.toml</li>
<li>Additional commits viewable in <a
href="https://github.com/eqrion/cbindgen/compare/v0.24.0...v0.25.0">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
bhelx pushed a commit to extism/extism that referenced this pull request Sep 20, 2023
Updates the requirements on
[cbindgen](https://github.com/mozilla/cbindgen) to permit the latest
version.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/mozilla/cbindgen/releases">cbindgen's
releases</a>.</em></p>
<blockquote>
<h2>0.26.0</h2>
<ul>
<li>Fix swapping of <code>&gt;&gt;=</code> and <code>&lt;&lt;=</code> in
constants.</li>
<li>Add support for #[deprecated] (<a
href="https://redirect.github.com/mozilla/cbindgen/issues/860">#860</a>).</li>
<li>Built-in support for bitflags 2.0.</li>
<li>Support for &quot;C-unwind&quot; ABI.</li>
<li>Generate bindings for non-public extern items if they are
#[no_mangle].</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/mozilla/cbindgen/blob/master/CHANGES">cbindgen's
changelog</a>.</em></p>
<blockquote>
<h1>0.26.0</h1>
<pre><code>  * Fix swapping of `&gt;&gt;=` and `&lt;&lt;=` in constants.
* Add support for #[deprecated]
([#860](mozilla/cbindgen#860)).
  * Built-in support for bitflags 2.0.
  * Support for &quot;C-unwind&quot; ABI.
* Generate bindings for non-public extern items if they are
#[no_mangle].
</code></pre>
<h2>0.25.0</h2>
<pre><code>  * Re-release of yanked 0.24.6 as a major release
  * Update MSRV to 1.57
* Support variadic arguments (`...`)
([#805](mozilla/cbindgen#805))
* Add --depfile option
([#820](mozilla/cbindgen#820))
  * Breaking changes: The `Config` struct now has a private member.
</code></pre>
<h2>0.24.6 (YANKED: depfile option was breaking, see <a
href="https://redirect.github.com/mozilla/cbindgen/issues/841">#841</a>)</h2>
<pre><code>  * Update MSRV to 1.57
* Support variadic arguments (`...`)
([#805](mozilla/cbindgen#805))
* Add --depfile option
([#820](mozilla/cbindgen#820))
</code></pre>
<h2>0.24.5</h2>
<pre><code>  * Don't enforce tempfile version.
</code></pre>
<h2>0.24.4</h2>
<pre><code> * Move expand infinite recursion fix
([#799](mozilla/cbindgen#799))
* Add with_cpp_compat to the builder
([#796](mozilla/cbindgen#796))
* Handle never type in return position consistently
([#780](mozilla/cbindgen#780))
* Fix warnings ([#816](mozilla/cbindgen#816),
[#819](mozilla/cbindgen#819))
* Updated documentation
([#788](mozilla/cbindgen#788),
[#791](mozilla/cbindgen#791),
[#792](mozilla/cbindgen#792),
[#810](mozilla/cbindgen#810),
[#823](mozilla/cbindgen#823))
</code></pre>
<h2>0.24.3</h2>
<pre><code> * Make struct expressions correctly generated through
typedefs ([#768](mozilla/cbindgen#768)).
</code></pre>
<h2>0.24.2</h2>
<pre><code>  * Make bitfield operators use explicit constructors.
</code></pre>
<h2>0.24.1</h2>
<pre><code> * Add support for unary negation
([#765](mozilla/cbindgen#765)).
* Make more bitfield operators constexpr
([#765](mozilla/cbindgen#765)).
</code></pre>
<h2>0.24.0</h2>
<pre><code> * Basic const generic support
([#759](mozilla/cbindgen#759),
[#760](mozilla/cbindgen#760)
[#762](mozilla/cbindgen#762)).
</code></pre>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/mozilla/cbindgen/commit/703b53c06f9fe2dbc0193d67626558cfa84a0f62"><code>703b53c</code></a>
v0.26.0</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/56f0febc9b5cc7ee957912d55b1fdee67f34d766"><code>56f0feb</code></a>
Update MSRV in Readme</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/9b4a14958ea6ce2a61accb9cdbad84cfca9c3013"><code>9b4a149</code></a>
Add support for out-of-line bitfields declarations</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/35f2e44ef2792d1c2e9e97f8ccf4458b79ae88f2"><code>35f2e44</code></a>
Update URLs</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/85eb0f4436e90d479f5d041b98f160ce2e66eeea"><code>85eb0f4</code></a>
Bump clippy msrv to 1.64</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/43af1ebe6e4d2bb9ec90167616a3d88bf34c7c0b"><code>43af1eb</code></a>
Handle bitflags bits method calls</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/f72e44715697981b9317b7f0688216990e60346d"><code>f72e447</code></a>
CHANGES: Note #[deprecated] support.</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/14730702306533c2805c9dd4a6846e762a4bbcca"><code>1473070</code></a>
utilities: annotation: Clean-up deprecated parsing and getter.</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/0fb5d07ae4ede7d3fcf91c47bcfa29090ce0a8b9"><code>0fb5d07</code></a>
Add support for #[deprecated].</li>
<li><a
href="https://github.com/mozilla/cbindgen/commit/d8355da4664f68d399631f2f215cbf991c121d2f"><code>d8355da</code></a>
Support &quot;C-unwind&quot; ABI</li>
<li>Additional commits viewable in <a
href="https://github.com/mozilla/cbindgen/compare/v0.25.0...0.26.0">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants