Bug: IMAGE_ORDINAL_FLAG should be pointer-sized, not always equal to IMAGE_ORDINAL_FLAG64

[rsta79]

Which crate is this about?

windows-sys

Crate version

0.36.1

Summary

As the title, IMAGE_ORDINAL_FLAG should be pointer-sized like usize, but IMAGE_ORDINAL_FLAG is not pointer-sized in windows-sys 0.36.1 , IMAGE_ORDINAL_FLAG should define with attribute #[cfg(target-pointer-width = "<32/64>")] or something like that.

Toolchain version/configuration

installed toolchains

stable-x86_64-pc-windows-msvc (default)
nightly-x86_64-pc-windows-msvc
1.59-x86_64-pc-windows-msvc

installed targets for active toolchain

i686-pc-windows-msvc
wasm32-unknown-unknown
wasm32-wasi
x86_64-pc-windows-msvc

active toolchain

Reproducible example

use windows_sys::Win32::System::SystemServices::IMAGE_ORDINAL_FLAG;
use std::mem::size_of;
use std::any::type_name;

fn type_of<T>(_: T) -> &'static str {
	return type_name::<T>()
}
fn main() {
    println!("Size of usize in memory: {size}", size = size_of::<usize>());
    println!("IMAGE_ORDINAL_FLAG: {value}({type})", value = IMAGE_ORDINAL_FLAG, type = type_of(IMAGE_ORDINAL_FLAG));
}

Crate manifest

[package]
name = "windows_ordinal_flag_test"
version = "0.1.0"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
windows-sys = {version = "0.36.1", features = ["Win32_System_SystemServices"]}

Expected behavior

cargo run --target i686-pc-windows-msvc / 32bit target

Size of usize in memory: 4
IMAGE_ORDINAL_FLAG: 2147483648(u32)

cargo run (--target stable-x86_64-pc-windows-msvc) / 64bit target

Size of usize in memory: 8
IMAGE_ORDINAL_FLAG: 9223372036854775808(u64)

Actual behavior

cargo run --target i686-pc-windows-msvc / 32bit target

Size of usize in memory: 4
IMAGE_ORDINAL_FLAG: 9223372036854775808(u64)

cargo run (--target stable-x86_64-pc-windows-msvc) / 64bit target

Size of usize in memory: 8
IMAGE_ORDINAL_FLAG: 9223372036854775808(u64)

Additional comments

No response

[kennykerr]

This is defined by the win32 metadata. Will transfer the issue for consideration.

[mikebattista]

@sotteson1 do we have a pattern for this already in the metadata?

[mikebattista]

This is sort of like how -A/-W APIs are treated where the unqualified name is variable depending the architecture.

win32metadata/generation/WinSDK/RecompiledIdlHeaders/um/winnt.h

Lines 19675 to 19684 in e0c38ed

	#ifdef _WIN64
	#define IMAGE_ORDINAL_FLAG IMAGE_ORDINAL_FLAG64
	#define IMAGE_ORDINAL(Ordinal) IMAGE_ORDINAL64(Ordinal)
	typedef IMAGE_THUNK_DATA64 IMAGE_THUNK_DATA;
	typedef PIMAGE_THUNK_DATA64 PIMAGE_THUNK_DATA;
	#define IMAGE_SNAP_BY_ORDINAL(Ordinal) IMAGE_SNAP_BY_ORDINAL64(Ordinal)
	typedef IMAGE_TLS_DIRECTORY64 IMAGE_TLS_DIRECTORY;
	typedef PIMAGE_TLS_DIRECTORY64 PIMAGE_TLS_DIRECTORY;
	#else
	#define IMAGE_ORDINAL_FLAG IMAGE_ORDINAL_FLAG32

Should we just remove the unqualified name and require you to choose one like we did with -A/-W APIs? Or is there another model we can follow?

[kennykerr]

Seems reasonable to remove the arch-specific IMAGE_ORDINAL_FLAG and then developers can just pick the explicit constant they need.

[riverar]

Agreed.