Skip to content

Commit cdba980

Browse files
HolgerNahrstaedtHolgerNahrstaedt
committed
fix: windows create new device
1 parent dcc3e97 commit cdba980

6 files changed

Lines changed: 256 additions & 13 deletions

File tree

‎.github/workflows/wheels_arm64.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ jobs:
3636
uses: docker/setup-qemu-action@v3
3737
- name: Install requirements
3838
run: python -m pip install -r requirements.txt
39+
- name: Install libffi-dev
40+
run: sudo apt-get update && sudo apt-get install -y build-essential libssl-dev libffi-dev python3-dev cmake
3941

4042
- name: Install cibuildwheel
4143
run: python -m pip install cibuildwheel

‎generate_cffi_definitions.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@ def fix_platform_specific_structs(cdef_content):
583583
)
584584

585585
if platform.system() == "Windows":
586-
# Windows version with HANDLE - preserve actual field order from headers
586+
# Windows version with HANDLE - use flexible struct
587587
platform_struct = """typedef struct
588588
{
589589
uint32_t packet_length;
@@ -595,10 +595,10 @@ def fix_platform_specific_structs(cdef_content):
595595
Packet_input_buffer packet_input_buffer;
596596
uint8_t packet_input_buffer_data[120000];
597597
uint8_t packet_input_buffer_state[100];
598+
...;
598599
} Smpt_device;"""
599600
else:
600-
# Linux/macOS version with descriptor - preserve actual field order
601-
# from headers
601+
# Linux/macOS version with descriptor - use flexible struct
602602
platform_struct = """typedef struct
603603
{
604604
uint32_t packet_length;
@@ -610,6 +610,7 @@ def fix_platform_specific_structs(cdef_content):
610610
Packet_input_buffer packet_input_buffer;
611611
uint8_t packet_input_buffer_data[120000];
612612
uint8_t packet_input_buffer_state[100];
613+
...;
613614
} Smpt_device;"""
614615

615616
# Replace any existing Smpt_device struct with the platform-appropriate one

‎sciencemode/sciencemode.cdef‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
#define SMPT_DL_MAX_INVESTIGATOR_NAME_LENGTH ...
2-
#define SMPT_DL_FILE_SIZE_BYTES ...
3-
#define SMPT_DL_MAX_SAMPLE_VALUE ...
4-
#define SMPT_DL_MAX_PATIENT_NAME_LENGTH ...
5-
#define SMPT_DL_MAX_BLOCK_BYTES_LENGTH ...
1+
#define SMPT_DL_MAX_STRING_LENGTH ...
62
#define SMPT_DL_4KHZ 4000
73

8-
#define SMPT_DL_MAX_STRING_LENGTH ...
9-
#define SMPT_DL_MAX_N_MEASUREMENTS ...
4+
#define SMPT_DL_MAX_PATIENT_NAME_LENGTH ...
5+
#define SMPT_DL_MAX_CHANNELS ...
6+
#define SMPT_DL_1KHZ ...
7+
#define SMPT_DL_MAX_INVESTIGATOR_NAME_LENGTH ...
108
#define SMPT_DL_2KHZ 2000
119

12-
#define SMPT_DL_1KHZ ...
13-
#define SMPT_DL_MAX_FILE_NAME_LENGTH ...
1410
#define SMPT_DL_MAX_FILE_ID_LENGTH ...
11+
#define SMPT_DL_MAX_FILE_NAME_LENGTH ...
12+
#define SMPT_DL_MAX_SAMPLE_VALUE ...
13+
#define SMPT_DL_MAX_BLOCK_BYTES_LENGTH ...
14+
#define SMPT_DL_FILE_SIZE_BYTES ...
15+
#define SMPT_DL_MAX_N_MEASUREMENTS ...
1516
#define SMPT_DL_GUID_STRING_LENGTH ...
16-
#define SMPT_DL_MAX_CHANNELS ...
1717
typedef enum
1818
{
1919
Smpt_Cmd_Ll_Init = ...,
@@ -263,6 +263,7 @@ typedef struct
263263
Packet_input_buffer packet_input_buffer;
264264
uint8_t packet_input_buffer_data[120000];
265265
uint8_t packet_input_buffer_state[100];
266+
...;
266267
} Smpt_device;
267268
typedef struct
268269
{

‎tests/run_unittest.py‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@
3232
except Exception as e:
3333
print(f"✗ Error creating device struct: {e}")
3434

35+
# Test struct field access (from new compatibility tests)
36+
try:
37+
device.packet_length = 100
38+
device.current_packet_number = 42
39+
device.packet[0] = 255
40+
41+
# Verify values
42+
assert device.packet_length == 100
43+
assert device.current_packet_number == 42
44+
assert device.packet[0] == 255
45+
print("✓ Struct field access works correctly")
46+
except Exception as e:
47+
print(f"✗ Error accessing struct fields: {e}")
48+
49+
# Test struct size calculation
50+
try:
51+
struct_size = sm.ffi.sizeof("Smpt_device")
52+
print(f"✓ Smpt_device struct size: {struct_size} bytes")
53+
except Exception as e:
54+
print(f"✗ Error calculating struct size: {e}")
55+
3556
# Check library files
3657
package_dir = os.path.dirname(sciencemode.__file__)
3758
lib_files = [

‎tests/test_library_loading.py‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,114 @@ def test_string_conversion():
196196
# Skip device field tests which are causing issues
197197
# They're already tested in test_create_device_struct
198198
print("Skipping device field tests - already covered in other tests")
199+
200+
201+
def test_smpt_device_struct_size_compatibility():
202+
"""Test that Smpt_device struct can be created without size mismatches.
203+
204+
This test specifically addresses the issue where CFFI would fail with:
205+
"ffi.error: Smpt_device: wrong size for field 'packet' (cdef says X, but C
206+
compiler says Y)"
207+
208+
The fix uses flexible struct syntax (...;) to handle platform differences.
209+
"""
210+
from sciencemode import sciencemode
211+
212+
print("Testing Smpt_device struct size compatibility...")
213+
214+
# Test 1: Basic struct allocation should not fail
215+
try:
216+
device = sciencemode.ffi.new("Smpt_device*")
217+
assert device is not None, "Smpt_device* allocation succeeded"
218+
print("✓ Basic Smpt_device* allocation works")
219+
except Exception as e:
220+
pytest.fail(f"Failed to allocate Smpt_device*: {e}")
221+
222+
# Test 2: Test accessing known fields that should be available
223+
try:
224+
# These fields should be accessible based on the struct definition
225+
device.packet_length = 0
226+
device.current_packet_number = 1
227+
228+
# Verify the values were set
229+
assert device.packet_length == 0, "packet_length field accessible"
230+
assert (
231+
device.current_packet_number == 1
232+
), "current_packet_number field accessible"
233+
print("✓ Core struct fields are accessible")
234+
except Exception as e:
235+
pytest.fail(f"Failed to access Smpt_device fields: {e}")
236+
237+
# Test 3: Test array field access (the problematic 'packet' field)
238+
try:
239+
# The packet field was the source of the size mismatch error
240+
# With flexible struct (...;), this should work
241+
device.packet[0] = 42 # Try to write to first element
242+
assert device.packet[0] == 42, "packet array field accessible"
243+
print("✓ Packet array field is accessible (size mismatch fixed)")
244+
except Exception as e:
245+
pytest.fail(f"Failed to access packet array field: {e}")
246+
247+
# Test 4: Test string field access
248+
try:
249+
# Test serial port name field
250+
test_name = b"test_port"
251+
sciencemode.ffi.memmove(device.serial_port_name, test_name, len(test_name))
252+
253+
# Read back the first few bytes
254+
read_back = sciencemode.ffi.string(device.serial_port_name, len(test_name))
255+
assert read_back == test_name, "serial_port_name field accessible"
256+
print("✓ String fields are accessible")
257+
except Exception as e:
258+
pytest.fail(f"Failed to access string fields: {e}")
259+
260+
# Test 5: Test struct size calculation
261+
try:
262+
# This should not throw an error anymore with flexible struct
263+
struct_size = sciencemode.ffi.sizeof("Smpt_device")
264+
assert struct_size > 0, "Struct size calculation succeeds"
265+
print(f"✓ Smpt_device struct size: {struct_size} bytes")
266+
except Exception as e:
267+
pytest.fail(f"Failed to calculate struct size: {e}")
268+
269+
print("All Smpt_device struct compatibility tests passed!")
270+
271+
272+
def test_smpt_device_flexible_struct_behavior():
273+
"""Test that the flexible struct (...;) behaves correctly with different
274+
operations."""
275+
from sciencemode import sciencemode
276+
277+
print("Testing flexible struct behavior...")
278+
279+
# Test multiple device allocations
280+
devices = []
281+
try:
282+
for i in range(3):
283+
device = sciencemode.ffi.new("Smpt_device*")
284+
device.current_packet_number = i
285+
devices.append(device)
286+
287+
# Verify all devices are independent
288+
for i, device in enumerate(devices):
289+
assert (
290+
device.current_packet_number == i
291+
), f"Device {i} has correct packet number"
292+
293+
print("✓ Multiple device allocations work independently")
294+
except Exception as e:
295+
pytest.fail(f"Failed multiple device allocation test: {e}")
296+
297+
# Test that we can still detect the struct properly
298+
try:
299+
device = sciencemode.ffi.new("Smpt_device*")
300+
301+
# The struct should have the expected type
302+
assert sciencemode.ffi.typeof(device) == sciencemode.ffi.typeof(
303+
"Smpt_device*"
304+
), "Device has correct type"
305+
print("✓ Device type detection works correctly")
306+
except Exception as e:
307+
pytest.fail(f"Failed device type detection: {e}")
308+
309+
print("All flexible struct behavior tests passed!")

‎tests/test_struct_compatibility.py‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
#!/usr/bin/env python
2+
3+
"""
4+
Standalone test for Smpt_device struct size compatibility.
5+
6+
This test specifically validates the fix for the CFFI struct size mismatch error:
7+
"ffi.error: Smpt_device: wrong size for field 'packet' (cdef says X, but C
8+
compiler says Y)"
9+
10+
The fix uses flexible struct syntax (...;) in the cdef to handle platform differences.
11+
"""
12+
13+
import os
14+
import sys
15+
16+
# Add parent directory to path
17+
parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
18+
sys.path.insert(0, parent_dir)
19+
20+
21+
def test_struct_size_compatibility():
22+
"""Test that Smpt_device struct can be created without size mismatches."""
23+
print("=== Testing Smpt_device Struct Size Compatibility ===")
24+
25+
try:
26+
from sciencemode import sciencemode
27+
28+
print("✓ Successfully imported sciencemode")
29+
except Exception as e:
30+
print(f"✗ Failed to import sciencemode: {e}")
31+
return False
32+
33+
# Test 1: Basic struct allocation
34+
try:
35+
device = sciencemode.ffi.new("Smpt_device*")
36+
print("✓ Basic Smpt_device* allocation succeeded")
37+
except Exception as e:
38+
print(f"✗ Failed to allocate Smpt_device*: {e}")
39+
return False
40+
41+
# Test 2: Field access
42+
try:
43+
device.packet_length = 100
44+
device.current_packet_number = 42
45+
assert device.packet_length == 100
46+
assert device.current_packet_number == 42
47+
print("✓ Basic field access works")
48+
except Exception as e:
49+
print(f"✗ Failed basic field access: {e}")
50+
return False
51+
52+
# Test 3: Array field access (the problematic 'packet' field)
53+
try:
54+
device.packet[0] = 255
55+
device.packet[1] = 128
56+
assert device.packet[0] == 255
57+
assert device.packet[1] == 128
58+
print("✓ Packet array field access works (size mismatch fixed)")
59+
except Exception as e:
60+
print(f"✗ Failed packet array access: {e}")
61+
return False
62+
63+
# Test 4: String field access
64+
try:
65+
test_name = b"test_port_name"
66+
sciencemode.ffi.memmove(device.serial_port_name, test_name, len(test_name))
67+
read_back = sciencemode.ffi.string(device.serial_port_name, len(test_name))
68+
assert read_back == test_name
69+
print("✓ String field access works")
70+
except Exception as e:
71+
print(f"✗ Failed string field access: {e}")
72+
return False
73+
74+
# Test 5: Struct size calculation
75+
try:
76+
struct_size = sciencemode.ffi.sizeof("Smpt_device")
77+
print(f"✓ Smpt_device struct size: {struct_size} bytes")
78+
except Exception as e:
79+
print(f"✗ Failed to calculate struct size: {e}")
80+
return False
81+
82+
# Test 6: Multiple allocations
83+
try:
84+
devices = []
85+
for i in range(3):
86+
dev = sciencemode.ffi.new("Smpt_device*")
87+
dev.current_packet_number = i
88+
devices.append(dev)
89+
90+
for i, dev in enumerate(devices):
91+
assert dev.current_packet_number == i
92+
print("✓ Multiple device allocations work independently")
93+
except Exception as e:
94+
print(f"✗ Failed multiple allocations test: {e}")
95+
return False
96+
97+
print("\n=== All Struct Compatibility Tests Passed! ===")
98+
print(
99+
"The flexible struct fix (using '...;') successfully resolved the size "
100+
"mismatch issue."
101+
)
102+
return True
103+
104+
105+
if __name__ == "__main__":
106+
success = test_struct_size_compatibility()
107+
sys.exit(0 if success else 1)

0 commit comments

Comments
 (0)