diff --git a/.github/workflows/clippy.yml b/.github/workflows/clippy.yml index eb6f4f379f..3634903beb 100644 --- a/.github/workflows/clippy.yml +++ b/.github/workflows/clippy.yml @@ -145,6 +145,7 @@ jobs: cargo clippy -p windows-metadata && cargo clippy -p windows-sys && cargo clippy -p windows-targets && + cargo clippy -p windows-version && cargo clippy -p windows_aarch64_gnullvm && cargo clippy -p windows_aarch64_msvc && cargo clippy -p windows_i686_gnu && diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index b97fbec1f0..1374c1b7b8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -99,8 +99,8 @@ jobs: cargo test -p test_enums && cargo test -p test_error && cargo test -p test_event && - cargo clean && cargo test -p test_extensions && + cargo clean && cargo test -p test_handles && cargo test -p test_helpers && cargo test -p test_implement && @@ -152,6 +152,7 @@ jobs: cargo test -p windows-metadata && cargo test -p windows-sys && cargo test -p windows-targets && + cargo test -p windows-version && cargo test -p windows_aarch64_gnullvm && cargo test -p windows_aarch64_msvc && cargo test -p windows_i686_gnu && diff --git a/crates/libs/version/Cargo.toml b/crates/libs/version/Cargo.toml new file mode 100644 index 0000000000..7c612d7405 --- /dev/null +++ b/crates/libs/version/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "windows-version" +version = "0.1.0" +authors = ["Microsoft"] +edition = "2021" +rust-version = "1.56" +license = "MIT OR Apache-2.0" +description = "Windows version information" +repository = "https://github.com/microsoft/windows-rs" +readme = "readme.md" +categories = ["os::windows-apis"] + +[package.metadata.docs.rs] +default-target = "x86_64-pc-windows-msvc" +targets = [] + +[dependencies.windows-targets] +version = "0.52.0" +path = "../targets" + +[dev-dependencies.windows-bindgen] +version = "0.52.0" +path = "../bindgen" diff --git a/crates/libs/version/license-apache-2.0 b/crates/libs/version/license-apache-2.0 new file mode 100644 index 0000000000..b5ed4ecec2 --- /dev/null +++ b/crates/libs/version/license-apache-2.0 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (c) Microsoft Corporation. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/crates/libs/version/license-mit b/crates/libs/version/license-mit new file mode 100644 index 0000000000..9e841e7a26 --- /dev/null +++ b/crates/libs/version/license-mit @@ -0,0 +1,21 @@ + MIT License + + Copyright (c) Microsoft Corporation. + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE diff --git a/crates/libs/version/readme.md b/crates/libs/version/readme.md new file mode 100644 index 0000000000..0d9d829fd1 --- /dev/null +++ b/crates/libs/version/readme.md @@ -0,0 +1,32 @@ +## Windows version information + +The [windows-version](https://crates.io/crates/windows-version) crate provides reliable operating system version information without the need for application manifest files. + +* [Getting started](https://kennykerr.ca/rust-getting-started/) +* [Samples](https://github.com/microsoft/windows-rs/tree/0.52.0/crates/samples) +* [Releases](https://github.com/microsoft/windows-rs/releases) + +Start by adding the following to your Cargo.toml file: + +```toml +[dependencies.windows-version] +version = "0.1" +``` + +Make use of Windows version information as needed: + +```rust,no_run +use windows_version::*; + +fn main() { + println!("Current version: {:?}", OsVersion::current()); + + if is_server() { + println!("Running on a Windows Server release."); + } + + if OsVersion::current() >= OsVersion::new(10, 0, 0, 12345) { + println!("Can use a feature available on this version or later.") + } +} +``` diff --git a/crates/libs/version/rustfmt.toml b/crates/libs/version/rustfmt.toml new file mode 100644 index 0000000000..43d4840c79 --- /dev/null +++ b/crates/libs/version/rustfmt.toml @@ -0,0 +1 @@ +newline_style = "Unix" diff --git a/crates/libs/version/src/bindings.rs b/crates/libs/version/src/bindings.rs new file mode 100644 index 0000000000..8ae08229fd --- /dev/null +++ b/crates/libs/version/src/bindings.rs @@ -0,0 +1,47 @@ +// Bindings generated by `windows-bindgen` 0.52.0 + +#![allow( + non_snake_case, + non_upper_case_globals, + non_camel_case_types, + dead_code, + clippy::all +)] +::windows_targets::link!("ntdll.dll" "system" fn RtlGetVersion(lpversioninformation : *mut OSVERSIONINFOW) -> NTSTATUS); +pub type NTSTATUS = i32; +#[repr(C)] +pub struct OSVERSIONINFOEXW { + pub dwOSVersionInfoSize: u32, + pub dwMajorVersion: u32, + pub dwMinorVersion: u32, + pub dwBuildNumber: u32, + pub dwPlatformId: u32, + pub szCSDVersion: [u16; 128], + pub wServicePackMajor: u16, + pub wServicePackMinor: u16, + pub wSuiteMask: u16, + pub wProductType: u8, + pub wReserved: u8, +} +impl ::core::marker::Copy for OSVERSIONINFOEXW {} +impl ::core::clone::Clone for OSVERSIONINFOEXW { + fn clone(&self) -> Self { + *self + } +} +#[repr(C)] +pub struct OSVERSIONINFOW { + pub dwOSVersionInfoSize: u32, + pub dwMajorVersion: u32, + pub dwMinorVersion: u32, + pub dwBuildNumber: u32, + pub dwPlatformId: u32, + pub szCSDVersion: [u16; 128], +} +impl ::core::marker::Copy for OSVERSIONINFOW {} +impl ::core::clone::Clone for OSVERSIONINFOW { + fn clone(&self) -> Self { + *self + } +} +pub const VER_NT_WORKSTATION: u32 = 1u32; diff --git a/crates/libs/version/src/lib.rs b/crates/libs/version/src/lib.rs new file mode 100644 index 0000000000..6d8990ed39 --- /dev/null +++ b/crates/libs/version/src/lib.rs @@ -0,0 +1,132 @@ +#![cfg_attr(not(test), no_std)] + +mod bindings; +use bindings::*; + +/// Operating system version information. +#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)] +pub struct OsVersion { + /// The major version number of the operating system. + pub major: u32, + + /// The minor version number of the operating system. + pub minor: u32, + + /// The major version number of the latest service pack installed on the system. + pub pack: u32, + + /// The build number of the operating system. + pub build: u32, +} + +impl OsVersion { + /// Creates a new `OsVersion` with the given values. + pub const fn new(major: u32, minor: u32, pack: u32, build: u32) -> Self { + Self { + major, + minor, + pack, + build, + } + } + + /// Gets the version information of the currently running operating system. + #[cfg(not(test))] + pub fn current() -> Self { + unsafe { + let mut info = OSVERSIONINFOEXW { + dwOSVersionInfoSize: core::mem::size_of::() as u32, + ..core::mem::zeroed() + }; + + RtlGetVersion(&mut info as *mut _ as *mut _); + + OsVersion { + major: info.dwMajorVersion, + minor: info.dwMinorVersion, + pack: info.wServicePackMajor as u32, + build: info.dwBuildNumber, + } + } + } + + /// Hook used for testing `ge`. + #[cfg(test)] + fn current() -> Self { + test::test_current() + } +} + +/// Determines if the currently running operating system is a Windows Server release. +pub fn is_server() -> bool { + unsafe { + let mut info = OSVERSIONINFOEXW { + dwOSVersionInfoSize: core::mem::size_of::() as u32, + ..core::mem::zeroed() + }; + + RtlGetVersion(&mut info as *mut _ as *mut _); + info.wProductType as u32 != VER_NT_WORKSTATION + } +} + +#[cfg(test)] +mod test { + use super::OsVersion; + use std::sync::RwLock; + + static TEST_CURRENT: RwLock = RwLock::new(OsVersion::new(0, 0, 0, 0)); + + pub fn test_current() -> OsVersion { + *TEST_CURRENT.read().unwrap() + } + + fn set_current(version: OsVersion) { + *TEST_CURRENT.write().unwrap() = version; + } + + #[test] + fn test() { + assert_eq!(OsVersion::current(), OsVersion::new(0, 0, 0, 0)); + + set_current(OsVersion::new(1, 2, 3, 4)); + assert_eq!(OsVersion::current(), OsVersion::new(1, 2, 3, 4)); + + set_current(OsVersion::new(10, 0, 0, 0)); + assert!(OsVersion::current() >= OsVersion::new(9, 0, 0, 0)); + assert!(OsVersion::current() >= OsVersion::new(10, 0, 0, 0)); + assert!(!(OsVersion::current() >= OsVersion::new(11, 0, 0, 0))); + + set_current(OsVersion::new(10, 100, 0, 0)); + assert!(OsVersion::current() >= OsVersion::new(10, 99, 0, 0)); + assert!(OsVersion::current() >= OsVersion::new(10, 100, 0, 0)); + assert!(!(OsVersion::current() >= OsVersion::new(10, 101, 0, 0))); + + set_current(OsVersion::new(10, 100, 1000, 0)); + assert!(OsVersion::current() >= OsVersion::new(10, 100, 999, 0)); + assert!(OsVersion::current() >= OsVersion::new(10, 100, 1000, 0)); + assert!(!(OsVersion::current() >= OsVersion::new(10, 100, 1001, 0))); + + set_current(OsVersion::new(10, 100, 1_000, 10_000)); + assert!(OsVersion::current() >= OsVersion::new(10, 100, 1_000, 9_999)); + assert!(OsVersion::current() >= OsVersion::new(10, 100, 1_000, 10_000)); + assert!(!(OsVersion::current() >= OsVersion::new(10, 100, 1_000, 10_001))); + } + + #[test] + fn bindgen() { + let args = [ + "--out", + "src/bindings.rs", + "--config", + "flatten", + "sys", + "--filter", + "Windows.Wdk.System.SystemServices.RtlGetVersion", + "Windows.Win32.System.SystemInformation.OSVERSIONINFOEXW", + "Windows.Win32.System.SystemServices.VER_NT_WORKSTATION", + ]; + + windows_bindgen::bindgen(args).unwrap(); + } +}