Skip to content

Commit f700ebb

Browse files
committed
Timeout considered when aborting completion
1 parent bbfbfca commit f700ebb

4 files changed

Lines changed: 101 additions & 78 deletions

File tree

‎java-does-usb/src/main/java/net/codecrete/usb/common/UsbDeviceImpl.java‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,19 @@
2424
import java.util.List;
2525
import java.util.function.IntFunction;
2626

27+
import static java.lang.System.Logger.Level.WARNING;
2728
import static java.lang.foreign.ValueLayout.JAVA_BYTE;
2829

2930
@SuppressWarnings("SynchronizationOnLocalVariableOrMethodParameter")
3031
public abstract class UsbDeviceImpl implements UsbDevice {
3132

33+
private static final System.Logger LOG = System.getLogger(UsbDeviceImpl.class.getName());
34+
35+
// Maximum time (ms) to wait for the completion of a transfer that was aborted due to a
36+
// timeout. If the abort's completion is never delivered (e.g. after an unplug), the wait
37+
// degrades to a logged warning instead of a permanent hang. The transfer is then abandoned.
38+
private static final long ABORT_COMPLETION_TIMEOUT_MS = 1000;
39+
3240
/**
3341
* Operating system-specific device ID used for {@link #equals(Object)} and {@link #hashCode()}.
3442
* <p>
@@ -375,7 +383,16 @@ protected void waitForTransfer(Transfer transfer, int timeout, UsbDirection dire
375383
// test for timeout
376384
if (hasTimedOut && transfer.resultCode() == 0) {
377385
abortTransfers(direction, endpointNumber);
378-
waitNoTimeout(transfer);
386+
387+
// Wait for the abort's completion, but bounded: if it never arrives (device
388+
// vanished such that neither the transfer nor the abort yields a callback),
389+
// abandon the transfer instead of blocking forever. Abandoning is safe because
390+
// buffers reaching this path come from an auto arena and survive a late completion.
391+
var abortCompleted = !waitWithTimeout(transfer, (int) ABORT_COMPLETION_TIMEOUT_MS);
392+
if (!abortCompleted)
393+
LOG.log(WARNING, "abort completion for {0} did not arrive within {1} ms - abandoning transfer",
394+
getOperationDescription(direction, endpointNumber), ABORT_COMPLETION_TIMEOUT_MS);
395+
379396
throw new UsbTimeoutException(getOperationDescription(direction, endpointNumber) + " aborted due to timeout");
380397
}
381398
}

‎java-does-usb/src/main/java/net/codecrete/usb/linux/LinuxUsbDevice.java‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -259,33 +259,35 @@ private LinuxTransfer createSyncCtrlTransfer(Arena arena, UsbDirection direction
259259

260260
@Override
261261
public void transferOut(int endpointNumber, byte @NotNull [] data, int offset, int length, int timeout) {
262-
try (var arena = Arena.ofConfined()) {
263-
var buffer = arena.allocate(length);
264-
buffer.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
265-
var transfer = createSyncTransfer(buffer);
266-
267-
synchronized (transfer) {
268-
submitTransfer(UsbDirection.OUT, endpointNumber, transfer);
269-
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
270-
}
262+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
263+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
264+
var arena = Arena.ofAuto();
265+
var buffer = arena.allocate(length);
266+
buffer.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
267+
var transfer = createSyncTransfer(buffer);
268+
269+
synchronized (transfer) {
270+
submitTransfer(UsbDirection.OUT, endpointNumber, transfer);
271+
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
271272
}
272273
}
273274

274275
@Override
275276
public byte @NotNull [] transferIn(int endpointNumber, int timeout) {
276277
var endpoint = getEndpoint(UsbDirection.IN, endpointNumber, UsbTransferType.BULK, UsbTransferType.INTERRUPT);
277278

278-
try (var arena = Arena.ofConfined()) {
279-
var buffer = arena.allocate(endpoint.packetSize());
280-
var transfer = createSyncTransfer(buffer);
279+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
280+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
281+
var arena = Arena.ofAuto();
282+
var buffer = arena.allocate(endpoint.packetSize());
283+
var transfer = createSyncTransfer(buffer);
281284

282-
synchronized (transfer) {
283-
submitTransfer(UsbDirection.IN, endpointNumber, transfer);
284-
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
285-
}
286-
287-
return buffer.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
285+
synchronized (transfer) {
286+
submitTransfer(UsbDirection.IN, endpointNumber, transfer);
287+
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
288288
}
289+
290+
return buffer.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
289291
}
290292

291293
private LinuxTransfer createSyncTransfer(MemorySegment data) {

‎java-does-usb/src/main/java/net/codecrete/usb/macos/MacosUsbDevice.java‎

Lines changed: 43 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -444,26 +444,27 @@ public void transferOut(int endpointNumber, byte @NotNull [] data, int offset, i
444444
var epInfo = getEndpointInfo(endpointNumber, UsbDirection.OUT, UsbTransferType.BULK,
445445
UsbTransferType.INTERRUPT);
446446

447-
try (var arena = Arena.ofConfined()) {
448-
var nativeData = arena.allocate(JAVA_BYTE, length);
449-
nativeData.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
450-
451-
var transfer = new MacosTransfer();
452-
transfer.setData(nativeData);
453-
transfer.setDataSize(length);
454-
transfer.setCompletion(UsbDeviceImpl::onSyncTransferCompleted);
455-
456-
synchronized (transfer) {
457-
if (timeout <= 0 || epInfo.transferType() == UsbTransferType.BULK) {
458-
// no timeout or timeout handled by operating system
459-
submitTransferOut(endpointNumber, transfer, timeout);
460-
waitForTransfer(transfer, 0, UsbDirection.OUT, endpointNumber);
461-
462-
} else {
463-
// interrupt transfer with timeout
464-
submitTransferOut(endpointNumber, transfer, 0);
465-
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
466-
}
447+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
448+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
449+
var arena = Arena.ofAuto();
450+
var nativeData = arena.allocate(JAVA_BYTE, length);
451+
nativeData.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
452+
453+
var transfer = new MacosTransfer();
454+
transfer.setData(nativeData);
455+
transfer.setDataSize(length);
456+
transfer.setCompletion(UsbDeviceImpl::onSyncTransferCompleted);
457+
458+
synchronized (transfer) {
459+
if (timeout <= 0 || epInfo.transferType() == UsbTransferType.BULK) {
460+
// no timeout or timeout handled by operating system
461+
submitTransferOut(endpointNumber, transfer, timeout);
462+
waitForTransfer(transfer, 0, UsbDirection.OUT, endpointNumber);
463+
464+
} else {
465+
// interrupt transfer with timeout
466+
submitTransferOut(endpointNumber, transfer, 0);
467+
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
467468
}
468469
}
469470
}
@@ -474,29 +475,30 @@ public void transferOut(int endpointNumber, byte @NotNull [] data, int offset, i
474475
var epInfo = getEndpointInfo(endpointNumber, UsbDirection.IN, UsbTransferType.BULK,
475476
UsbTransferType.INTERRUPT);
476477

477-
try (var arena = Arena.ofConfined()) {
478-
var nativeData = arena.allocate(JAVA_BYTE, epInfo.packetSize());
479-
480-
var transfer = new MacosTransfer();
481-
transfer.setData(nativeData);
482-
transfer.setDataSize(epInfo.packetSize());
483-
transfer.setCompletion(UsbDeviceImpl::onSyncTransferCompleted);
484-
485-
synchronized (transfer) {
486-
if (timeout <= 0 || epInfo.transferType() == UsbTransferType.BULK) {
487-
// no timeout, or timeout handled by operating system
488-
submitTransferIn(endpointNumber, transfer, timeout);
489-
waitForTransfer(transfer, 0, UsbDirection.IN, endpointNumber);
490-
491-
} else {
492-
// interrupt transfer with timeout
493-
submitTransferIn(endpointNumber, transfer, 0);
494-
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
495-
}
478+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
479+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
480+
var arena = Arena.ofAuto();
481+
var nativeData = arena.allocate(JAVA_BYTE, epInfo.packetSize());
482+
483+
var transfer = new MacosTransfer();
484+
transfer.setData(nativeData);
485+
transfer.setDataSize(epInfo.packetSize());
486+
transfer.setCompletion(UsbDeviceImpl::onSyncTransferCompleted);
487+
488+
synchronized (transfer) {
489+
if (timeout <= 0 || epInfo.transferType() == UsbTransferType.BULK) {
490+
// no timeout, or timeout handled by operating system
491+
submitTransferIn(endpointNumber, transfer, timeout);
492+
waitForTransfer(transfer, 0, UsbDirection.IN, endpointNumber);
493+
494+
} else {
495+
// interrupt transfer with timeout
496+
submitTransferIn(endpointNumber, transfer, 0);
497+
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
496498
}
497-
498-
return nativeData.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
499499
}
500+
501+
return nativeData.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
500502
}
501503

502504
/**

‎java-does-usb/src/main/java/net/codecrete/usb/windows/WindowsUsbDevice.java‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -328,33 +328,35 @@ public void controlTransferOut(@NotNull UsbControlTransfer setup, byte[] data) {
328328

329329
@Override
330330
public void transferOut(int endpointNumber, byte @NotNull [] data, int offset, int length, int timeout) {
331-
try (var arena = Arena.ofConfined()) {
332-
var buffer = arena.allocate(data.length);
333-
buffer.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
334-
var transfer = createSyncTransfer(buffer);
335-
336-
synchronized (transfer) {
337-
submitTransferOut(endpointNumber, transfer);
338-
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
339-
}
331+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
332+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
333+
var arena = Arena.ofAuto();
334+
var buffer = arena.allocate(data.length);
335+
buffer.copyFrom(MemorySegment.ofArray(data).asSlice(offset, length));
336+
var transfer = createSyncTransfer(buffer);
337+
338+
synchronized (transfer) {
339+
submitTransferOut(endpointNumber, transfer);
340+
waitForTransfer(transfer, timeout, UsbDirection.OUT, endpointNumber);
340341
}
341342
}
342343

343344
@Override
344345
public byte @NotNull [] transferIn(int endpointNumber, int timeout) {
345346
var endpoint = getEndpoint(UsbDirection.IN, endpointNumber, UsbTransferType.BULK, UsbTransferType.INTERRUPT);
346347

347-
try (var arena = Arena.ofConfined()) {
348-
var buffer = arena.allocate(endpoint.packetSize());
349-
var transfer = createSyncTransfer(buffer);
348+
// Auto arena: a transfer that times out may be abandoned (see UsbDeviceImpl.waitForTransfer),
349+
// so the buffer must outlive a possible late completion instead of being freed deterministically.
350+
var arena = Arena.ofAuto();
351+
var buffer = arena.allocate(endpoint.packetSize());
352+
var transfer = createSyncTransfer(buffer);
350353

351-
synchronized (transfer) {
352-
submitTransferIn(endpointNumber, transfer);
353-
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
354-
}
355-
356-
return buffer.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
354+
synchronized (transfer) {
355+
submitTransferIn(endpointNumber, transfer);
356+
waitForTransfer(transfer, timeout, UsbDirection.IN, endpointNumber);
357357
}
358+
359+
return buffer.asSlice(0, transfer.resultSize()).toArray(JAVA_BYTE);
358360
}
359361

360362
private WindowsTransfer createSyncControlTransfer() {

0 commit comments

Comments
 (0)