Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Async KV Store Persister #1470

Open
Tracked by #2394
TheBlueMatt opened this issue May 8, 2022 · 8 comments
Open
Tracked by #2394

Async KV Store Persister #1470

TheBlueMatt opened this issue May 8, 2022 · 8 comments
Assignees
Milestone

Comments

@TheBlueMatt
Copy link
Collaborator

Sensei ran into an issue where ldk-net-tokio (or some other async context) calls into ChannelManager, which handles some message and then goes to update the ChannelMonitor. Because Sensei is using the new KVStorePersister interface to simplify its persistence it ends up in a sync context in an tokio worker thread thread and then has to block on a future to talk to a (possibly remote) database. It then returns control to tokio by blocking on the future, but at the time we're still holding the channel and ChainMonitor locks, causing most other future execution to block.

While tokio should probably be willing to poll the IO driver in the block_on call from Sensei, even if it did it could still decide to run a different future which ends up blocking on the mutex already held and we're back to a deadlock.

Really if you're storing a monitor update via some async future you should use the TemporaryFailure return to do the monitor update asynchronously instead of blocking on IO with locks held, but we don't have good utilities for doing so today.

We need to (a) create a AsyncKVStorePersister (it has to either be runtime-specific because it needs the ability to spawn background tasks, as an alternative we could make the user provide a spawn method which we can call), and (b) adapt the background processor to using it for async manager/graph/score persistence.

@TheBlueMatt TheBlueMatt added this to the 0.0.108 milestone May 8, 2022
@TheBlueMatt
Copy link
Collaborator Author

Oops missed that this is really just a specific instance of #1367, though one that we can fix easily.

@tnull
Copy link
Contributor

tnull commented May 17, 2022

I'd be interested in picking this up soon to get some exposure to the Tokio/Persist side of things.

@TheBlueMatt
Copy link
Collaborator Author

I think this is going to snowball into about 3-4 PRs and a large cleanup of the ChannelMonitorUpdateErr stuff, so I'd prefer to tackle this one if that's okay. There's a few places where ChannelMonitorUpdateErr::TemporaryFailure requires a persistence before returning, which won't work with a fully-asyc persister, so that'll need updating first.

@tnull
Copy link
Contributor

tnull commented May 17, 2022

I think this is going to snowball into about 3-4 PRs and a large cleanup of the ChannelMonitorUpdateErr stuff, so I'd prefer to tackle this one if that's okay.

Alright, go ahead!

@G8XSU
Copy link
Contributor

G8XSU commented Aug 10, 2022

Doubt:
I am assuming async KVStore will return a future.
So basically we move out of persistence blocking but we don't proceed through critical section of any channel state change(open/send/or anything) until future is completed right ?

@TheBlueMatt
Copy link
Collaborator Author

Yep, basically. We actually already support this, but its a bit unsafe - monitor update functions can return Err(ChannelMonitorUpdateRes::TemporaryFailure) which puts a channel on ice and doesn't transmit channel state update functions until the monitor update completes. The intent here is to use that feature to implement the future, but we need to first make that feature a bit more robust.

@TheBlueMatt
Copy link
Collaborator Author

Once we do this, we should also update the docs on the updatestatus's in-progress state variant. #1106 (comment)

@TheBlueMatt TheBlueMatt modified the milestones: 0.0.111, 0.1 Aug 22, 2022
@TheBlueMatt
Copy link
Collaborator Author

This has turned into a very large project :(. #1678 is the first step, but this is basically the 0.1 milestone, at this point, so I'm just gonna tag it as such.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

4 participants