Merge branch 'connection-callback' into copilot/optimize-hidapi-thread-wait

Author: Youw

.github/workflows/checks.yml

@@ -71,7 +71,7 @@ jobs:
 
 
   coverity-macos:
-    runs-on: macos-13
+    runs-on: macos-15-intel
     needs: [coverity-windows]
 
     steps:

.gitignore

@@ -31,5 +31,8 @@ CMakeLists.txt.user
 # doxgen output
 doxygen/html/
 
+# Visual Studio Code + CMake
+.vscode/
+
 # Local build directory
 build/

netbsd/CMakeLists.txt

@@ -10,6 +10,16 @@ find_package(Threads REQUIRED)
 
 target_link_libraries(hidapi_netbsd PRIVATE Threads::Threads)
 
+# check for error: "conflicting types for 'iconv'"
+include(CheckCSourceCompiles)
+check_c_source_compiles("#include<iconv.h>
+    extern size_t iconv (iconv_t cd, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
+    int main() {}"
+HIDAPI_ICONV_CONST)
+if(HIDAPI_ICONV_CONST)
+    target_compile_definitions(hidapi_netbsd PRIVATE "ICONV_CONST=const")
+endif()
+
 set_target_properties(hidapi_netbsd
     PROPERTIES
         EXPORT_NAME "netbsd"

netbsd/hid.c

@@ -30,6 +30,10 @@
 #include <unistd.h>
 #include <fcntl.h>
 #include <iconv.h>
+#ifndef ICONV_CONST
+#define ICONV_CONST
+#endif
+
 #include <poll.h>
 
 /* NetBSD */
@@ -724,6 +728,7 @@ struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned shor
 	for (size_t i = 0; i < len; i++) {
 		char devpath[USB_MAX_DEVNAMELEN];
 		int bus;
+		struct hid_device_info *prev_end;
 
 		strlcpy(devpath, "/dev/", sizeof(devpath));
 		strlcat(devpath, arr[i], sizeof(devpath));
@@ -732,7 +737,17 @@ struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned shor
 		if (bus == -1)
 			continue;
 
+		/*
+		 * ehci/ohci/uhci/dwctwo etc. use 'addr 1' for root hubs
+		 * but xhci uses 'addr 0' on NetBSD.
+		 * Check addr 0 (that would be unused on other than xhci)
+		 * and then check addr 1 if there is no device at addr 0.
+		 */
+		prev_end = hed.end;
 		enumerate_usb_devices(bus, 0, hid_enumerate_callback, &hed);
+		if (hed.end == prev_end)
+			enumerate_usb_devices(bus, 1,
+			    hid_enumerate_callback, &hed);
 
 		close(bus);
 	}
@@ -1109,7 +1124,7 @@ int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index
 	struct usb_string_desc usd;
 	usb_string_descriptor_t *str;
 	iconv_t ic;
-	const char *src;
+	ICONV_CONST char *src;
 	size_t srcleft;
 	char *dst;
 	size_t dstleft;
@@ -1153,7 +1168,7 @@ int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *dev, int string_index
 		return -1;
 	}
 
-	src = (const char *) str->bString;
+	src = (ICONV_CONST char *)str->bString;
 	srcleft = str->bLength - 2;
 	dst = (char *) string;
 	dstleft = sizeof(wchar_t[maxlen]);

windows/hid.c

@@ -20,12 +20,6 @@
         https://github.com/libusb/hidapi .
 ********************************************************/
 
-#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
-/* Do not warn about wcsncpy usage.
-   https://docs.microsoft.com/cpp/c-runtime-library/security-features-in-the-crt */
-#define _CRT_SECURE_NO_WARNINGS
-#endif
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -67,6 +61,16 @@ typedef LONG NTSTATUS;
 #include <stdlib.h>
 #include <string.h>
 
+/* MSVC secure CRT (VS2005+) provides swprintf_s/wcsncpy_s.
+   Older MSVC and GCC/MinGW/Cygwin use the classic variants. */
+#if defined(_MSC_VER) && (_MSC_VER >= 1400)
+#define HIDAPI_SWPRINTF swprintf_s
+#define HIDAPI_WCSNCPY(dest, dest_count, src) wcsncpy_s((dest), (dest_count), (src), _TRUNCATE)
+#else
+#define HIDAPI_SWPRINTF swprintf
+#define HIDAPI_WCSNCPY(dest, dest_count, src) wcsncpy((dest), (src), (dest_count))
+#endif
+
 #ifdef MIN
 #undef MIN
 #endif
@@ -323,7 +327,8 @@ static void register_winapi_error_to_buffer(wchar_t **error_buffer, const WCHAR
 	if (!msg)
 		return;
 
-	int printf_written = swprintf(msg, msg_len + 1, L"%.*ls: (0x%08X) %.*ls", (int)op_len, op, error_code, (int)system_err_len, system_err_buf);
+	int printf_written = HIDAPI_SWPRINTF(msg, msg_len + 1, L"%.*ls: (0x%08X) %.*ls", (int)op_len, op, error_code, (int)system_err_len, system_err_buf);
+	msg[msg_len] = L'\0';
 
 	if (printf_written < 0)
 	{
@@ -1825,7 +1830,7 @@ int HID_API_EXPORT_CALL HID_API_CALL hid_get_manufacturer_string(hid_device *dev
 		return -1;
 	}
 
-	wcsncpy(string, dev->device_info->manufacturer_string, maxlen);
+	HIDAPI_WCSNCPY(string, maxlen, dev->device_info->manufacturer_string);
 	string[maxlen - 1] = L'\0';
 
 	register_string_error(dev, NULL);
@@ -1845,7 +1850,7 @@ int HID_API_EXPORT_CALL HID_API_CALL hid_get_product_string(hid_device *dev, wch
 		return -1;
 	}
 
-	wcsncpy(string, dev->device_info->product_string, maxlen);
+	HIDAPI_WCSNCPY(string, maxlen, dev->device_info->product_string);
 	string[maxlen - 1] = L'\0';
 
 	register_string_error(dev, NULL);
@@ -1865,7 +1870,7 @@ int HID_API_EXPORT_CALL HID_API_CALL hid_get_serial_number_string(hid_device *de
 		return -1;
 	}
 
-	wcsncpy(string, dev->device_info->serial_number, maxlen);
+	HIDAPI_WCSNCPY(string, maxlen, dev->device_info->serial_number);
 	string[maxlen - 1] = L'\0';
 
 	register_string_error(dev, NULL);

windows/hidapi_descriptor_reconstruct.h

@@ -19,12 +19,6 @@
 #ifndef HIDAPI_DESCRIPTOR_RECONSTRUCT_H__
 #define HIDAPI_DESCRIPTOR_RECONSTRUCT_H__
 
-#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
-/* Do not warn about wcsncpy usage.
-   https://docs.microsoft.com/cpp/c-runtime-library/security-features-in-the-crt */
-#define _CRT_SECURE_NO_WARNINGS
-#endif
-
 #include "hidapi_winapi.h"
 
 #ifdef _MSC_VER

windows/test/hid_report_reconstructor_test.c

@@ -9,13 +9,40 @@
 #include <stdio.h>
 #include <string.h>
 
+#if defined(_MSC_VER) && (_MSC_VER >= 1400)
+#define HIDAPI_SSCANF sscanf_s
+#define HIDAPI_FSCANF fscanf_s
+#define HIDAPI_SCANSET_SIZE(buf) , (unsigned)_countof(buf)
+#else
+#define HIDAPI_SSCANF sscanf
+#define HIDAPI_FSCANF fscanf
+#define HIDAPI_SCANSET_SIZE(buf)
+#endif
+
+#define sscanf HIDAPI_SSCANF
+
+static const char* hidapi_strerror_compat(int errnum, char* buf, size_t buf_size)
+{
+#if defined(_MSC_VER) && (_MSC_VER >= 1400)
+	if (strerror_s(buf, buf_size, errnum) == 0) {
+		return buf;
+	}
+	return "Unknown error";
+#else
+	(void)buf;
+	(void)buf_size;
+	return strerror(errnum);
+#endif
+}
+
 static hidp_preparsed_data * alloc_preparsed_data_from_file(char* filename)
 {
 	FILE* file;
 	errno_t err = fopen_s(&file, filename, "r");
 
 	if (err != 0) {
-		fprintf(stderr, "ERROR: Couldn't open file '%s' for reading: %s\n", filename, strerror(err));
+		char err_buf[128];
+		fprintf(stderr, "ERROR: Couldn't open file '%s' for reading: %s\n", filename, hidapi_strerror_compat((int)err, err_buf, sizeof(err_buf)));
 		return NULL;
 	}
 
@@ -49,8 +76,8 @@ static hidp_preparsed_data * alloc_preparsed_data_from_file(char* filename)
 			if (sscanf(line, "dev->product_id          = 0x%04hX\n", &product_id)) continue;
 			if (sscanf(line, "dev->usage_page          = 0x%04hX\n", &usage_page)) continue;
 			if (sscanf(line, "dev->usage               = 0x%04hX\n", &usage)) continue;
-			if (sscanf(line, "dev->manufacturer_string = \"%127[^\"\n]", manufacturer_string)) continue;
-			if (sscanf(line, "dev->product_string      = \"%127[^\"\n]", product_string)) continue;
+			if (sscanf(line, "dev->manufacturer_string = \"%127[^\"\n]", manufacturer_string HIDAPI_SCANSET_SIZE(manufacturer_string))) continue;
+			if (sscanf(line, "dev->product_string      = \"%127[^\"\n]", product_string HIDAPI_SCANSET_SIZE(product_string))) continue;
 			if (sscanf(line, "dev->release_number      = 0x%04hX\n", &release_number)) continue;
 			if (sscanf(line, "dev->interface_number    = %d\n", &interface_number)) continue;
 			// if (sscanf(line, "dev->path                = \"%127[^\"]\n", path)) continue;
@@ -96,6 +123,11 @@ static hidp_preparsed_data * alloc_preparsed_data_from_file(char* filename)
 
 		if (FirstByteOfLinkCollectionArray != 0 && NumberLinkCollectionNodes != 0) {
 			size_t size_of_preparsed_data = offsetof(hidp_preparsed_data, caps) + FirstByteOfLinkCollectionArray + (NumberLinkCollectionNodes * sizeof(hid_pp_link_collection_node));
+			if (size_of_preparsed_data > 1024 * 1024) {
+				fprintf(stderr, "Error: preparsed data size too large: %zu\n", size_of_preparsed_data);
+				fclose(file);
+				return NULL;
+			}
 			pp_data->FirstByteOfLinkCollectionArray = FirstByteOfLinkCollectionArray;
 			pp_data->NumberLinkCollectionNodes = NumberLinkCollectionNodes;
 			FirstByteOfLinkCollectionArray = 0;
@@ -456,14 +488,15 @@ static BOOLEAN read_hex_data_from_text_file(const char *filename, unsigned char
 	FILE* file = NULL;
 	errno_t err = fopen_s(&file, filename, "r");
 	if (err != 0) {
-		fprintf(stderr, "ERROR: Couldn't open file '%s' for reading: %s\n", filename, strerror(err));
+		char err_buf[128];
+		fprintf(stderr, "ERROR: Couldn't open file '%s' for reading: %s\n", filename, hidapi_strerror_compat((int)err, err_buf, sizeof(err_buf)));
 		return FALSE;
 	}
 
 	BOOLEAN result = TRUE;
 	unsigned int val;
 	char buf[16];
-	while (fscanf(file, "%15s", buf) == 1) {
+	while (HIDAPI_FSCANF(file, "%15s", buf HIDAPI_SCANSET_SIZE(buf)) == 1) {
 		if (sscanf(buf, "0x%X", &val) != 1) {
 			fprintf(stderr, "Invalid HEX text ('%s') file, got %s\n", filename, buf);
 			result = FALSE;