JDK20 and high-throughput streams

Author: manuelbl

.gitignore

@@ -1,3 +1,5 @@
+java-does-usb/sample.bin
+
 # Maven
 target/
 *.ser

README.md

@@ -1,5 +1,7 @@
 # Java Does USB: USB Library for Java
 
+> **Development branch for JDK 20**
+
 [![javadoc](https://javadoc.io/badge2/net.codecrete.usb/java-does-usb/javadoc.svg)](https://javadoc.io/doc/net.codecrete.usb/java-does-usb)
 
 *Java Does USB* is a library for working with USB devices. It allows to query information about all conntected USB devices and to communicate with USB devices using custom / vendor specific protocols. (It is not intended for communication with standard types of USB devices such as mass storage devices, keyboards etc.)
@@ -80,7 +82,7 @@ public class EnumerateDevices {
 
 ## Prerequisite
 
-- Java 19, preview features enabled (available at https://www.azul.com/downloads/?package=jdk)
+- Java 20, preview features enabled (available at https://www.azul.com/downloads/?package=jdk)
 - Windows (x86 64-bit), macOS (x86 64-bit, ARM 64-bit) or Linux 64 bit (x86 64-bit, ARM 64-bit)
 
 For a version compatible with JDK 20, see the branch `jdk20`.
@@ -119,8 +121,6 @@ USB devices can implement certain control requests to instruct Windows to automa
 
 The test devices implement the required control requests. So the driver is installed automatically.
 
-This library does not yet run reliably on Windows as the Java VM sometimes overwrites the last error code, which is needed for proper function, not just in error cases. It works incorrectly when run in the debugger and sometimes even without the debugger. A future version of the Foreign Function & Memory API will hopefully provide a way to save the last error code. The developers are aware of the issue.
-
 The library has not been tested on Windows for ARM64. It might or might not work.
 
 

java-does-usb/jextract/README.md

@@ -92,7 +92,7 @@ The known limitations are:
 
 *jextract* generates a comprehensive set of methods for each function, struct, struct member etc. Most of it will not be used as a typical application just uses a subset of struct members, might only read or write them etc. So a considerable amount of code is generated. For some types, it's a bit excessive.
 
-The worst example is [`IOUSBInterfaceStruct942`](https://github.com/manuelbl/JavaDoesUSB/blob/main/java-does-usb/src/main/java/net/codecrete/usb/macos/gen/iokit/IOUSBDeviceStruct942.java) (macOS). This is a `struct` consisting of about 75 member functions. It's bascially a vtable of a C++ class. *jextract* generates the same number of classes plus a huge class for the struct itself. The total code size (compiled) for this single `struct` is over 300 kByte.
+The worst example is [`IOUSBInterfaceStruct100`](https://github.com/manuelbl/JavaDoesUSB/blob/main/java-does-usb/src/main/java/net/codecrete/usb/macos/gen/iokit/IOUSBDeviceStruct100.java) (macOS). This is a `struct` consisting of about 75 member functions. It's bascially a vtable of a C++ class. *jextract* generates the same number of classes plus a huge class for the struct itself. The total code size (compiled) for this single `struct` is over 300 kByte.
 
 The table below shows statictics for version 0.2.0 of the library:
 

java-does-usb/jextract/linux/gen_linux.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-JEXTRACT=../../../../jextract-19/bin/jextract
+JEXTRACT=../../../../jextract/build/jextract/bin/jextract
 
 # sd-device.h (install libsystemd-dev if file is missing)
 # Error: /usr/include/inttypes.h:290:8: error: unknown type name 'intmax_t'
@@ -14,9 +14,10 @@ JEXTRACT=../../../../jextract-19/bin/jextract
 $JEXTRACT --source --output ../../src/main/java \
   --header-class-name errno \
   --target-package net.codecrete.usb.linux.gen.errno \
-  --include-function __errno_location \
-  --include-macro ETIMEDOUT \
-  --include-macro EPIPE \
+  --include-constant ETIMEDOUT \
+  --include-constant EPIPE \
+  --include-constant EBADF \
+  --include-constant EAGAIN \
   /usr/include/errno.h
 
 # string.h
@@ -26,20 +27,12 @@ $JEXTRACT --source --output ../../src/main/java \
   --include-function strerror \
   /usr/include/string.h
 
-# ioctl.h
-$JEXTRACT --source --output ../../src/main/java \
-  --header-class-name ioctl \
-  --target-package net.codecrete.usb.linux.gen.ioctl \
-  --include-function ioctl \
-  /usr/include/x86_64-linux-gnu/sys/ioctl.h
-
 # fcntl.h
 $JEXTRACT --source --output ../../src/main/java \
   --header-class-name fcntl \
   --target-package net.codecrete.usb.linux.gen.fcntl \
-  --include-function open \
-  --include-macro O_CLOEXEC \
-  --include-macro O_RDWR \
+  --include-constant O_CLOEXEC \
+  --include-constant O_RDWR \
   /usr/include/fcntl.h
 
 # unistd.h
@@ -57,12 +50,20 @@ $JEXTRACT --source --output ../../src/main/java \
   --include-struct usbdevfs_bulktransfer \
   --include-struct usbdevfs_ctrltransfer \
   --include-struct usbdevfs_setinterface \
-  --include-macro USBDEVFS_CONTROL \
-  --include-macro USBDEVFS_BULK \
-  --include-macro USBDEVFS_CLAIMINTERFACE \
-  --include-macro USBDEVFS_RELEASEINTERFACE \
-  --include-macro USBDEVFS_SETINTERFACE \
-  --include-macro USBDEVFS_CLEAR_HALT \
+  --include-struct usbdevfs_urb \
+  --include-constant USBDEVFS_CONTROL \
+  --include-constant USBDEVFS_BULK \
+  --include-constant USBDEVFS_CLAIMINTERFACE \
+  --include-constant USBDEVFS_RELEASEINTERFACE \
+  --include-constant USBDEVFS_SETINTERFACE \
+  --include-constant USBDEVFS_CLEAR_HALT \
+  --include-constant USBDEVFS_SUBMITURB \
+  --include-constant USBDEVFS_DISCARDURB \
+  --include-constant USBDEVFS_REAPURB \
+  --include-constant USBDEVFS_URB_TYPE_INTERRUPT \
+  --include-constant USBDEVFS_URB_TYPE_CONTROL \
+  --include-constant USBDEVFS_URB_TYPE_BULK \
+  --include-constant USBDEVFS_URB_TYPE_ISO \
   /usr/include/linux/usbdevice_fs.h
 
 # libudev.h
@@ -98,6 +99,8 @@ $JEXTRACT --source --output ../../src/main/java \
   --target-package net.codecrete.usb.linux.gen.poll \
   --include-function poll \
   --include-struct pollfd \
-  --include-macro POLLIN \
+  --include-constant POLLIN \
+  --include-constant POLLOUT \
+  --include-constant POLLERR \
   /usr/include/poll.h
 

java-does-usb/jextract/macos/gen_macos.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-JEXTRACT=../../../../jextract-19/bin/jextract
+JEXTRACT=../../../../jextract/build/jextract/bin/jextract
 # If SDK_DIR is changed, it needs to be changed in compile_flags.txt as well.
 SDK_DIR=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
 
@@ -23,9 +23,10 @@ $JEXTRACT --source --output ../../src/main/java \
   --include-function CFNumberGetValue \
   --include-function CFRunLoopGetCurrent \
   --include-function CFRunLoopAddSource \
+  --include-function CFRunLoopRemoveSource \
   --include-function CFRunLoopRun \
   --include-function CFUUIDGetUUIDBytes \
-  --include-macro kCFNumberSInt32Type \
+  --include-constant kCFNumberSInt32Type \
   cf_helper.h
 
 # IOKit
@@ -35,9 +36,9 @@ $JEXTRACT --source --output ../../src/main/java \
   --header-class-name IOKit \
   --target-package net.codecrete.usb.macos.gen.iokit \
   --include-var kIOMasterPortDefault \
-  --include-macro kIOUSBDeviceClassName \
-  --include-macro kIOFirstMatchNotification \
-  --include-macro kIOTerminatedNotification \
+  --include-constant kIOUSBDeviceClassName \
+  --include-constant kIOFirstMatchNotification \
+  --include-constant kIOTerminatedNotification \
   --include-var kCFRunLoopDefaultMode \
   --include-struct IOCFPlugInInterfaceStruct \
   --include-typedef IOCFPlugInInterface \
@@ -52,14 +53,14 @@ $JEXTRACT --source --output ../../src/main/java \
   --include-function IOServiceMatching \
   --include-struct IOUSBDeviceStruct100 \
   --include-typedef IOUSBDeviceInterface100 \
-  --include-macro kIOUSBFindInterfaceDontCare \
+  --include-constant kIOUSBFindInterfaceDontCare \
   --include-typedef IOUSBFindInterfaceRequest \
   --include-typedef IOUSBDevRequest \
   --include-struct IOUSBInterfaceStruct190 \
   --include-typedef IOUSBInterfaceInterface190 \
-  --include-macro kIOUSBTransactionTimeout \
-  --include-macro kIOReturnAborted \
-  --include-macro kIOUSBPipeStalled \
+  --include-constant kIOUSBTransactionTimeout \
+  --include-constant kIOReturnAborted \
+  --include-constant kIOUSBPipeStalled \
   iokit_helper.h
 
 # mach.h

java-does-usb/jextract/windows/gen_win.cmd

@@ -1,4 +1,4 @@
-set JEXTRACT=..\..\..\..\jextract-19\bin\jextract.bat
+set JEXTRACT=..\..\..\..\jextract\build\jextract\bin\jextract.bat
 set SDK_DIR=C:\Program Files (x86)\Windows Kits\10\Include\10.0.22000.0
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -8,32 +8,33 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   -l Kernel32 ^
   --header-class-name Kernel32 ^
   --target-package net.codecrete.usb.windows.gen.kernel32 ^
-  --include-function CreateFileW ^
   --include-function CloseHandle ^
-  --include-function DeviceIoControl ^
-  --include-function GetLastError ^
   --include-function GetModuleHandleW ^
   --include-function FormatMessageW ^
   --include-function LocalFree ^
-  --include-macro ERROR_SUCCESS ^
-  --include-macro ERROR_NO_MORE_ITEMS ^
-  --include-macro ERROR_MORE_DATA ^
-  --include-macro ERROR_INSUFFICIENT_BUFFER ^
-  --include-macro ERROR_FILE_NOT_FOUND ^
-  --include-macro ERROR_SEM_TIMEOUT ^
-  --include-macro ERROR_GEN_FAILURE ^
-  --include-macro GENERIC_READ ^
-  --include-macro GENERIC_WRITE ^
-  --include-macro FILE_SHARE_READ ^
-  --include-macro FILE_SHARE_WRITE ^
-  --include-macro FILE_ATTRIBUTE_NORMAL ^
-  --include-macro FILE_FLAG_OVERLAPPED ^
-  --include-macro OPEN_EXISTING ^
-  --include-macro FORMAT_MESSAGE_ALLOCATE_BUFFER ^
-  --include-macro FORMAT_MESSAGE_FROM_SYSTEM ^
-  --include-macro FORMAT_MESSAGE_IGNORE_INSERTS ^
+  --include-constant ERROR_NO_MORE_ITEMS ^
+  --include-constant ERROR_MORE_DATA ^
+  --include-constant ERROR_INSUFFICIENT_BUFFER ^
+  --include-constant ERROR_FILE_NOT_FOUND ^
+  --include-constant ERROR_GEN_FAILURE ^
+  --include-constant ERROR_NOT_FOUND ^
+  --include-constant ERROR_IO_PENDING ^
+  --include-constant GENERIC_READ ^
+  --include-constant GENERIC_WRITE ^
+  --include-constant FILE_SHARE_READ ^
+  --include-constant FILE_SHARE_WRITE ^
+  --include-constant FILE_ATTRIBUTE_NORMAL ^
+  --include-constant FILE_FLAG_OVERLAPPED ^
+  --include-constant OPEN_EXISTING ^
+  --include-constant FORMAT_MESSAGE_ALLOCATE_BUFFER ^
+  --include-constant FORMAT_MESSAGE_FROM_SYSTEM ^
+  --include-constant FORMAT_MESSAGE_IGNORE_INSERTS ^
+  --include-constant FORMAT_MESSAGE_FROM_HMODULE ^
+  --include-constant INFINITE ^
   --include-struct _GUID ^
   --include-typedef GUID ^
+  --include-struct _OVERLAPPED ^
+  --include-typedef OVERLAPPED ^
   windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -43,39 +44,23 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   -l SetupAPI ^
   --header-class-name SetupAPI ^
   --target-package net.codecrete.usb.windows.gen.setupapi ^
-  --include-function SetupDiGetClassDevsW ^
   --include-function SetupDiDestroyDeviceInfoList ^
-  --include-function SetupDiEnumDeviceInfo ^
-  --include-function SetupDiEnumDeviceInterfaces ^
-  --include-function SetupDiGetDeviceInterfaceDetailW ^
-  --include-function SetupDiGetDeviceRegistryPropertyW ^
-  --include-function SetupDiGetDevicePropertyW ^
-  --include-function SetupDiOpenDeviceInterfaceW ^
-  --include-function SetupDiCreateDeviceInfoList ^
-  --include-function SetupDiOpenDeviceInfoW ^
-  --include-function SetupDiOpenDevRegKey ^
   --include-function SetupDiDeleteDeviceInterfaceData ^
   --include-struct _SP_DEVINFO_DATA ^
   --include-typedef SP_DEVINFO_DATA ^
   --include-struct _SP_DEVICE_INTERFACE_DATA ^
   --include-typedef SP_DEVICE_INTERFACE_DATA ^
   --include-struct _SP_DEVICE_INTERFACE_DETAIL_DATA_W ^
   --include-typedef SP_DEVICE_INTERFACE_DETAIL_DATA_W ^
-  --include-macro DIGCF_PRESENT ^
-  --include-macro DIGCF_DEVICEINTERFACE ^
-  --include-macro SPDRP_ADDRESS ^
-  --include-macro DEVPROP_TYPE_UINT32 ^
-  --include-macro DEVPROP_TYPE_STRING ^
-  --include-macro DEVPROP_TYPEMOD_LIST ^
-  --include-macro DICS_FLAG_GLOBAL ^
-  --include-macro DIREG_DEV ^
-  windows_headers.h
-
-call %JEXTRACT% --source --output ../../src/main/java ^
-  -D _AMD64_ -D _M_AMD64=100 -D UNICODE -D _UNICODE ^
-  --header-class-name StdLib ^
-  --target-package net.codecrete.usb.windows.gen.stdlib ^
-  --include-function wcslen ^
+  --include-struct _DEVPROPKEY ^
+  --include-typedef DEVPROPKEY ^
+  --include-constant DIGCF_PRESENT ^
+  --include-constant DIGCF_DEVICEINTERFACE ^
+  --include-constant DEVPROP_TYPE_UINT32 ^
+  --include-constant DEVPROP_TYPE_STRING ^
+  --include-constant DEVPROP_TYPEMOD_LIST ^
+  --include-constant DICS_FLAG_GLOBAL ^
+  --include-constant DIREG_DEV ^
   windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -84,8 +69,8 @@ call %JEXTRACT% --source --output ../../src/main/java ^
   -I "%SDK_DIR%\shared" ^
   --header-class-name USBIoctl ^
   --target-package net.codecrete.usb.windows.gen.usbioctl ^
-  --include-macro IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX ^
-  --include-macro IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION ^
+  --include-constant IOCTL_USB_GET_NODE_CONNECTION_INFORMATION_EX ^
+  --include-constant IOCTL_USB_GET_DESCRIPTOR_FROM_NODE_CONNECTION ^
   windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -95,17 +80,13 @@ call %JEXTRACT% --source --output ../../src/main/java ^
        -l User32 ^
        --header-class-name User32 ^
        --target-package net.codecrete.usb.windows.gen.user32 ^
-       --include-function RegisterClassExW ^
-       --include-function CreateWindowExW ^
-       --include-function RegisterDeviceNotificationW ^
-       --include-function GetMessageW ^
        --include-function DefWindowProcW ^
-       --include-macro DEVICE_NOTIFY_WINDOW_HANDLE ^
-       --include-macro HWND_MESSAGE ^
-       --include-macro WM_DEVICECHANGE ^
-       --include-macro DBT_DEVICEARRIVAL ^
-       --include-macro DBT_DEVICEREMOVECOMPLETE ^
-       --include-macro DBT_DEVTYP_DEVICEINTERFACE ^
+       --include-constant DEVICE_NOTIFY_WINDOW_HANDLE ^
+       --include-constant HWND_MESSAGE ^
+       --include-constant WM_DEVICECHANGE ^
+       --include-constant DBT_DEVICEARRIVAL ^
+       --include-constant DBT_DEVICEREMOVECOMPLETE ^
+       --include-constant DBT_DEVTYP_DEVICEINTERFACE ^
        --include-struct tagMSG ^
        --include-typedef MSG ^
        --include-struct tagWNDCLASSEXW ^
@@ -123,17 +104,9 @@ call %JEXTRACT% --source --output ../../src/main/java ^
        -l Winusb ^
        --header-class-name WinUSB ^
        --target-package net.codecrete.usb.windows.gen.winusb ^
-       --include-function WinUsb_Initialize ^
        --include-function WinUsb_Free ^
-       --include-function WinUsb_GetDescriptor ^
-       --include-function WinUsb_ControlTransfer ^
-       --include-function WinUsb_WritePipe ^
-       --include-function WinUsb_ReadPipe ^
-       --include-function WinUsb_GetAssociatedInterface ^
-       --include-function WinUsb_SetPipePolicy ^
-       --include-function WinUsb_SetCurrentAlternateSetting ^
-       --include-function WinUsb_ResetPipe ^
-       --include-macro PIPE_TRANSFER_TIMEOUT ^
+       --include-constant PIPE_TRANSFER_TIMEOUT ^
+       --include-constant RAW_IO ^
        windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -145,8 +118,7 @@ call %JEXTRACT% --source --output ../../src/main/java ^
        --target-package net.codecrete.usb.windows.gen.advapi32 ^
        --include-function RegQueryValueExW ^
        --include-function RegCloseKey ^
-       --include-macro REG_MULTI_SZ ^
-       --include-macro KEY_READ ^
+       --include-constant KEY_READ ^
        windows_headers.h
 
 call %JEXTRACT% --source --output ../../src/main/java ^
@@ -158,3 +130,12 @@ call %JEXTRACT% --source --output ../../src/main/java ^
        --target-package net.codecrete.usb.windows.gen.ole32 ^
        --include-function CLSIDFromString ^
        windows_headers.h
+
+call %JEXTRACT% --source --output ../../src/main/java ^
+       -D _AMD64_ -D _M_AMD64=100 -D UNICODE -D _UNICODE ^
+       -I "%SDK_DIR%\um" ^
+       -I "%SDK_DIR%\shared" ^
+       --header-class-name NtDll ^
+       --target-package net.codecrete.usb.windows.gen.ntdll ^
+       --include-constant STATUS_UNSUCCESSFUL ^
+       windows_headers.h

java-does-usb/jextract/windows/windows_headers.h

@@ -1,6 +1,6 @@
 #include <windows.h>
 #include <setupapi.h>
-#include <string.h>
 #include <usbioctl.h>
 #include <winusb.h>
 #include <dbt.h>
+#include <ntstatus.h>