feat(sbp2): add session registry and command flow by gly11 · Pull Request #19 · mrmidi/ASFireWire

gly11 · 2026-05-27T04:38:56Z

Summary

This PR builds on the foundation changes merged in #18 and splits out the SBP-2 session and command core from the larger SBP-2 bring-up branch. The branch has been rebased onto current main, so the visible diff is now limited to the SBP-2 session layer.

SBP-2 Session Core

Add login, reconnect, and logout session state handling, including bus-reset retry behavior, busy-timeout replay, and unsolicited status setup.
Add a session registry for discovered SBP-2 units and command lifecycle management.
Add command submission helpers for standard SCSI command flow and task management.
Wire SBP-2 session operations through ControllerCore, DriverContext, and the user-client handler.

ORB and Addressing

Extend management and command ORB layout and status handling.
Add full bus/node embedded-address handling and page-table/direct-descriptor updates.
Add command wire formats for the user-client boundary.

Tests

Add login-session and session-registry coverage.
Extend ORB and address-space tests for timeout, status, embedded-address, and command lifecycle behavior.

Why this split

This PR intentionally excludes local debug UI, diagnostic handlers, install-helper changes, diagnostic scripts, and documentation experiments. Those can be reviewed separately or kept local. The async discovery and bus-reset foundations landed in #18; this layer adds SBP-2 session and command behavior on top of that.

Verification

cmake -S . -B build-pr2 -DCMAKE_BUILD_TYPE=Debug
cmake --build build-pr2 --target AddressSpaceManagerTests SBP2ORBTests SBP2LoginSessionTests SBP2SessionRegistryTests --parallel 8
for t in AddressSpaceManagerTests SBP2ORBTests SBP2LoginSessionTests SBP2SessionRegistryTests; do "build-pr2/tests/$t" || exit $?; done
xcodebuild -project ASFW.xcodeproj -scheme ASFW -configuration Debug -destination 'platform=macOS' CODE_SIGNING_ALLOWED=NO build

After #18 merged, this branch was rebased onto current upstream/main; git diff --check upstream/main..pr/sbp2-session-core passes.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 91131392ab

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-05-27T13:36:58Z

+    if (lock_ != nullptr) {
+        IOLockFree(lock_);
+        lock_ = nullptr;


Unlock the registry lock before freeing it

When the registry is destroyed, this frees lock_ while the IOLockGuard created at the top of the destructor is still alive. As the function returns, the guard destructor will call IOLockUnlock on the already-freed lock pointer it captured, which can crash or corrupt memory during driver shutdown/unload. End the guard scope before calling IOLockFree or free the lock after it has been unlocked.

Useful? React with 👍 / 👎.

Fixed in the current branch head (166b8a7). The registry destructor now ends the lock guard scope before freeing lock_, so the guard cannot unlock a freed IOLock during shutdown.

chatgpt-codex-connector · 2026-05-27T13:36:58Z

+    orb->SetFetchAgentWriteRetries(testFetchAgentWriteRetries_);
+    orb->SetAppended(true);
+    outstandingORBs_[MakeORBKey(orb->GetORBAddress())] = orb;


Start submitted ORB timeouts

After a command ORB is prepared and inserted into outstandingORBs_, no code starts the SBP2CommandORB timer. In the case where the fetch-agent write succeeds but the device never writes a status block, the registry leaves commandInFlight set and callers polling GetCommandResult wait forever despite SubmitCommand having configured a timeout on the ORB. Start the ORB timer when the ORB is actually submitted to the fetch agent/chain, and cancel it on normal status completion as this code already does.

Useful? React with 👍 / 👎.

Fixed in the current branch head (166b8a7). Submitted command ORBs now start their timeout once the fetch-agent write succeeds and the target can fetch the ORB; normal completion and failure paths still cancel the timer.

chatgpt-codex-connector · 2026-05-27T13:36:58Z

+        CleanupCommandResources(*rec);
+    });
+
+    if (!record->session->SubmitORB(orb.get())) {


Avoid submit callbacks while holding the registry lock

This calls SubmitORB while still holding the registry IOLock, but SubmitORB can synchronously invoke the ORB completion callback on immediate submit failure (for example when WriteBlock returns an empty handle via AppendORBImmediate → FailSubmittedORB). That callback immediately tries to take the same lock_, so a transient transport submission failure deadlocks the user-client request path instead of returning an error. Move the submission outside the locked section or ensure synchronous submit failures do not call back under this lock.

Useful? React with 👍 / 👎.

Fixed in the current branch head (166b8a7). SubmitCommand now prepares and records the command under the registry lock, releases that lock before calling SubmitORB, and cleans up safely if submission fails. This avoids synchronous submit-failure callbacks re-entering the registry lock.

gly11 · 2026-05-27T15:30:11Z

The failing check on this PR is from the C++ coverage processing step, not from the SBP-2 code or tests. The run completed all 480 tests successfully, then failed while merging LLVM profile data.

I split the CI fix into #20. That PR isolates LLVM profile outputs for both test discovery and test execution, and its Build and Test check passes. Once #20 lands, this PR should only need a rerun/rebase against the updated workflow.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

mrmidi · 2026-06-02T06:05:36Z

Thanks @gly11 — this looks like a great starting point for the SBP-2 implementation.

I’m going to merge this as a foundation. The next step will be to adapt and split the SBP-2 pieces so they align better with the newer protocol/device architecture we now have on the DICE branch. That follow-up restructuring can happen separately; this PR gives us a useful base to build from.

gly11 · 2026-06-02T08:21:57Z

I have a few follow-up draft branches from the old stack, but I do not want to open follow-up PRs against the wrong base or architecture.

Should small independent fixes still target main, or would you prefer follow-up work to target DICE while the newer protocol/device architecture is being developed there?

I can re-split the queue so SBP-2-related work waits for the DICE-aligned structure, while only truly independent app/debug fixes go to main if that is preferred.

mrmidi · 2026-06-02T09:11:02Z

Preferably wait a bit. OR f you have some tokens to burn and time to debug/test — read below :).

I have some ideas how to re-organize different protocols: main idea could be seen in f19d2d2. Bierfly — decouple audio leakage from discovery and clear separation how protocols should be loaded. In the same time — i'm finishing full Bus/IRM manager implementation. So the goal is not to grow the driver for every single device, but make it hardware agnostic where possible — follow the specs first, quirks later.
Also in the DICE branch: some critical bug fixes regarding OHCI hw initialization, some IEEE 1394 constants fixes, etc. Generally it's much more reliable with my hardware right now. (audio performance degraded a bit, but that's not what I care right now). I've already ported your config rom fixes there too — please test if it works with your Nikon if you can.

So for SBP-2 i see it it like that (it's a draft, just the core idea):

ASFWDriver/
  DeviceProfiles/
    Storage/
      StorageProfileTypes.hpp
      StorageProfileRegistry.hpp
      StorageProfileRegistry.cpp
      Generic/
        GenericSBP2Profiles.hpp
        GenericSBP2Profiles.cpp
      Vendors/  <- probably not needed at all for SBP-2

  Storage/
    StorageCoordinator.hpp
    StorageCoordinator.cpp
    StorageRuntimeRegistry.hpp
    StorageRuntimeRegistry.cpp

    SCSI/ <- SCSIControllerDriverKit part
      DriverKitSCSIController.hpp
      DriverKitSCSIController.cpp
      DriverKitSCSIDevice.hpp
      DriverKitSCSIDevice.cpp
      DriverKitSCSIRequestBridge.hpp
      DriverKitSCSIRequestBridge.cpp

  Protocols/
    Storage/
      ISCSITransport.hpp
      SCSITransportTypes.hpp

      SBP2/
        SBP2StorageTransport.hpp
        SBP2StorageTransport.cpp

        Core/
          SBP2Constants.hpp
          SBP2Types.hpp
          SBP2TargetInfo.hpp
          SBP2TargetParser.hpp
          SBP2LoginSession.hpp
          SBP2LoginSession.cpp
          SBP2SessionState.hpp
          SBP2GenerationBinding.hpp

        ORB/
          SBP2WireFormats.hpp
          SBP2ManagementORB.hpp
          SBP2ManagementORB.cpp
          SBP2CommandORB.hpp
          SBP2CommandORB.cpp
          SBP2PageTable.hpp
          SBP2PageTable.cpp
          SBP2ORBExecutor.hpp
          SBP2ORBExecutor.cpp

        Addressing/
          SBP2AddressSpaceManager.hpp
          SBP2AddressSpaceManager.cpp
          SBP2AddressSpaceLease.hpp
          SBP2AddressSpaceLease.cpp
          SBP2StatusBlockAddress.hpp

        Status/
          SBP2StatusBlock.hpp
          SBP2StatusBlock.cpp
          SBP2StatusMapper.hpp
          SBP2StatusMapper.cpp

Ping me on Discord - we could chat about it more there!

gly11 · 2026-06-02T10:25:12Z

Preferably wait a bit. OR f you have some tokens to burn and time to debug/test — read below :).

I have some ideas how to re-organize different protocols: main idea could be seen in f19d2d2. Bierfly — decouple audio leakage from discovery and clear separation how protocols should be loaded. In the same time — i'm finishing full Bus/IRM manager implementation. So the goal is not to grow the driver for every single device, but make it hardware agnostic where possible — follow the specs first, quirks later. Also in the DICE branch: some critical bug fixes regarding OHCI hw initialization, some IEEE 1394 constants fixes, etc. Generally it's much more reliable with my hardware right now. (audio performance degraded a bit, but that's not what I care right now). I've already ported your config rom fixes there too — please test if it works with your Nikon if you can.

So for SBP-2 i see it it like that (it's a draft, just the core idea):
ASFWDriver/
  DeviceProfiles/
    Storage/
      StorageProfileTypes.hpp
      StorageProfileRegistry.hpp
      StorageProfileRegistry.cpp
      Generic/
        GenericSBP2Profiles.hpp
        GenericSBP2Profiles.cpp
      Vendors/  <- probably not needed at all for SBP-2

  Storage/
    StorageCoordinator.hpp
    StorageCoordinator.cpp
    StorageRuntimeRegistry.hpp
    StorageRuntimeRegistry.cpp

    SCSI/ <- SCSIControllerDriverKit part
      DriverKitSCSIController.hpp
      DriverKitSCSIController.cpp
      DriverKitSCSIDevice.hpp
      DriverKitSCSIDevice.cpp
      DriverKitSCSIRequestBridge.hpp
      DriverKitSCSIRequestBridge.cpp

  Protocols/
    Storage/
      ISCSITransport.hpp
      SCSITransportTypes.hpp

      SBP2/
        SBP2StorageTransport.hpp
        SBP2StorageTransport.cpp

        Core/
          SBP2Constants.hpp
          SBP2Types.hpp
          SBP2TargetInfo.hpp
          SBP2TargetParser.hpp
          SBP2LoginSession.hpp
          SBP2LoginSession.cpp
          SBP2SessionState.hpp
          SBP2GenerationBinding.hpp

        ORB/
          SBP2WireFormats.hpp
          SBP2ManagementORB.hpp
          SBP2ManagementORB.cpp
          SBP2CommandORB.hpp
          SBP2CommandORB.cpp
          SBP2PageTable.hpp
          SBP2PageTable.cpp
          SBP2ORBExecutor.hpp
          SBP2ORBExecutor.cpp

        Addressing/
          SBP2AddressSpaceManager.hpp
          SBP2AddressSpaceManager.cpp
          SBP2AddressSpaceLease.hpp
          SBP2AddressSpaceLease.cpp
          SBP2StatusBlockAddress.hpp

        Status/
          SBP2StatusBlock.hpp
          SBP2StatusBlock.cpp
          SBP2StatusMapper.hpp
          SBP2StatusMapper.cpp
Ping me on Discord - we could chat about it more there!

That makes sense. I’ll test the DICE branch with my Nikon hardware next.

If I find any issues, I’ll report them in an issue or open a focused PR with a fix.

I’ll also keep an eye on Discord for follow-up discussion.

gly11 mentioned this pull request May 27, 2026

feat(sbp2): complete SBP-2 login, command transport, and INQUIRY flow #14

Closed

gly11 force-pushed the pr/sbp2-session-core branch from 2823267 to 9113139 Compare May 27, 2026 07:54

gly11 marked this pull request as ready for review May 27, 2026 13:32

chatgpt-codex-connector Bot reviewed May 27, 2026

View reviewed changes

gly11 force-pushed the pr/sbp2-session-core branch 2 times, most recently from eff2132 to 76a8f1d Compare May 27, 2026 14:44

gly11 added 2 commits May 27, 2026 22:57

feat(sbp2): add session registry and command flow

7ffdb64

fix(sbp2): harden command submission lifecycle

166b8a7

gly11 force-pushed the pr/sbp2-session-core branch from 76a8f1d to 166b8a7 Compare May 27, 2026 14:59

gly11 mentioned this pull request May 27, 2026

fix(ci): isolate LLVM profile outputs #20

Merged

mrmidi reviewed May 27, 2026

View reviewed changes

Comment thread ASFWDriver/Protocols/SBP2/SBP2WireFormats.hpp Outdated

mrmidi reviewed May 27, 2026

View reviewed changes

Comment thread ASFWDriver/Protocols/SBP2/SBP2LoginSession.cpp

mrmidi reviewed May 27, 2026

View reviewed changes

Comment thread ASFWDriver/Protocols/SBP2/SBP2LoginSession.cpp