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

Disable signature transformation for NTSTATUS #2658

Merged
merged 4 commits into from
Sep 15, 2023
Merged

Disable signature transformation for NTSTATUS #2658

merged 4 commits into from
Sep 15, 2023

Conversation

kennykerr
Copy link
Collaborator

Fixes: #2656

@riverar
Copy link
Collaborator

riverar commented Sep 14, 2023

I don't think there are enough STATUS_PENDING returning functions to warrant degrading the developer experience here. Is there something preventing us from specializing the return transformation for NTSTATUS?

@kennykerr
Copy link
Collaborator Author

I think the issue is that there are many many more success codes when it comes to NTSTATUS compared with say HRESULT.

The alternative would be to return Result<NTSTATUS, Error> but that would be very different to the way we handle error transformations today and just seems like it would cause more confusion than anything else.

@ChrisDenton
Copy link
Collaborator

The status quo relies on CanReturnMultipleSuccessValues being accurately applied (or not) to all NTSTATUS returning functions. Otherwise the experience is not just degraded, it's unusable for certain scenarios. But I think we simply don't have the people to ensure that the metadata 100% accurately applies the attribute. Maybe that'll come in time but we're not there yet.

So, all else aside, I think something has to change.

@riverar
Copy link
Collaborator

riverar commented Sep 14, 2023

Agree we'd just be applying CanReturnMultipleSuccessValues to functions as we find them, but in the absence of more data demonstrating a large swath of functions that will be better off, we may want to consider it over regressing the experience across the board. I recognize, though, getting that data is probably not possible in the short term and concede as a result.

@ChrisDenton
Copy link
Collaborator

I guess there are alternatives but they'll require more work to get started on. So maybe the opposite attribute for NTSTATUS would be more useful (e.g. CanReturnSingleSuccessValues)? Have the least destructive behaviour by default and only apply Result ergonomics for functions that have been reviewed as only returning one success value.

@kennykerr
Copy link
Collaborator Author

I just don't think any of these attribute-based approaches are scalable.

@kennykerr
Copy link
Collaborator Author

Unrelated, the build is failing on the diff check for libs. That's probably because GitHub updated their MSVC toolchain and now the libs have a different version stamp again. I really need to get that version stamp wiped out.

ChrisDenton
ChrisDenton previously approved these changes Sep 14, 2023
@riverar
Copy link
Collaborator

riverar commented Sep 14, 2023

Unrelated, the build is failing on the diff check for libs. That's probably because GitHub updated their MSVC toolchain and now the libs have a different version stamp again. I really need to get that version stamp wiped out.

Yup, will pick this up (removing the compiler ID per last discussion).

@kennykerr
Copy link
Collaborator Author

Manually updated the libs to unblock this PR.

@kennykerr kennykerr merged commit 0502c95 into master Sep 15, 2023
47 checks passed
@kennykerr kennykerr deleted the ntstatus branch September 15, 2023 14:41
bors referenced this pull request in rust-lang/cargo Dec 1, 2023
chore(deps): update rust crate windows-sys to 0.52

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [windows-sys](https://togithub.com/microsoft/windows-rs) | workspace.dependencies | minor | `0.48` -> `0.52` |

---

### Release Notes

<details>
<summary>microsoft/windows-rs (windows-sys)</summary>

### [`v0.52.0`](https://togithub.com/microsoft/windows-rs/releases/tag/0.52.0)

[Compare Source](https://togithub.com/microsoft/windows-rs/compare/0.48.0...0.52.0)

This release includes updates to all crates. This includes the first update to the `windows-sys` crate in 8 months. It also includes the first published version of the [riddle](https://crates.io/crates/riddle) tool and the [windows-version](https://crates.io/crates/windows-version) crate.

#### What's Changed

-   Simplify issue templates by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2621](https://togithub.com/microsoft/windows-rs/pull/2621)
-   Switch all crates to Rust edition 2021 by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2620](https://togithub.com/microsoft/windows-rs/pull/2620)
-   Correct workflow trigger ignore paths by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2622](https://togithub.com/microsoft/windows-rs/pull/2622)
-   Detect unused `bindgen`/`riddle` filters by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2634](https://togithub.com/microsoft/windows-rs/pull/2634)
-   Fix `BOOLEAN` parameter binding by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2635](https://togithub.com/microsoft/windows-rs/pull/2635)
-   Provide individual crate readme files by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2645](https://togithub.com/microsoft/windows-rs/pull/2645)
-   Tweak Win32 error code conversion to handle `HRESULT` input by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2646](https://togithub.com/microsoft/windows-rs/pull/2646)
-   Remove support for the defunct `StaticLibrary` attribute by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2647](https://togithub.com/microsoft/windows-rs/pull/2647)
-   Derive `PartialEq`, `Eq`, `Debug`, `Clone` for interfaces by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2651](https://togithub.com/microsoft/windows-rs/pull/2651)
-   Internal `bindgen` refactoring by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2654](https://togithub.com/microsoft/windows-rs/pull/2654)
-   Disable signature transformation for `NTSTATUS` by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2658](https://togithub.com/microsoft/windows-rs/pull/2658)
-   Unhide `query` method on `ComInterface` trait by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2659](https://togithub.com/microsoft/windows-rs/pull/2659)
-   Harden `QueryInterface` implementation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2660](https://togithub.com/microsoft/windows-rs/pull/2660)
-   Mask non-reproducible linker artifacts in libs by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2661](https://togithub.com/microsoft/windows-rs/pull/2661)
-   Slim doc generation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2671](https://togithub.com/microsoft/windows-rs/pull/2671)
-   Update SDK and WDK metadata by [`@&#8203;riverar](https://togithub.com/riverar)` in [https://github.com/microsoft/windows-rs/pull/2664](https://togithub.com/microsoft/windows-rs/pull/2664)
-   Add feature documentation quotes by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2675](https://togithub.com/microsoft/windows-rs/pull/2675)
-   Add `docs` feature by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2676](https://togithub.com/microsoft/windows-rs/pull/2676)
-   Simplify metadata reader by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2682](https://togithub.com/microsoft/windows-rs/pull/2682)
-   Add bindgen config option to disable generating inner attributes by [`@&#8203;dpaoliello](https://togithub.com/dpaoliello)` in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683)
-   Simplify metadata filtering by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2684](https://togithub.com/microsoft/windows-rs/pull/2684)
-   Simplify code generation by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2686](https://togithub.com/microsoft/windows-rs/pull/2686)
-   Fix link from docs.rs to full API documentation by [`@&#8203;ChrisDenton](https://togithub.com/ChrisDenton)` in [https://github.com/microsoft/windows-rs/pull/2688](https://togithub.com/microsoft/windows-rs/pull/2688)
-   Optimize tick trimming by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2689](https://togithub.com/microsoft/windows-rs/pull/2689)
-   Small bindgen refactor and tools refresh by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2695](https://togithub.com/microsoft/windows-rs/pull/2695)
-   Document `implement` and `interface` macros by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2696](https://togithub.com/microsoft/windows-rs/pull/2696)
-   Perform checked integral type conversions for APIs by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2699](https://togithub.com/microsoft/windows-rs/pull/2699)
-   Add `windows-version` crate by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2702](https://togithub.com/microsoft/windows-rs/pull/2702)
-   Add crate-specific readme files by [`@&#8203;kennykerr](https://togithub.com/kennykerr)` in [https://github.com/microsoft/windows-rs/pull/2703](https://togithub.com/microsoft/windows-rs/pull/2703)

#### New Contributors

-   [`@&#8203;dpaoliello](https://togithub.com/dpaoliello)` made their first contribution in [https://github.com/microsoft/windows-rs/pull/2683](https://togithub.com/microsoft/windows-rs/pull/2683)

**Full Changelog**: microsoft/windows-rs@0.48.5...0.52.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
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.

NTSTATUS values are erroneously transformed into Ok(())
3 participants