Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lightning-block-sync/src/gossip.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,12 @@ pub trait UtxoSource: BlockSource + 'static {
pub struct TokioSpawner;
#[cfg(feature = "tokio")]
impl FutureSpawner for TokioSpawner {
fn spawn<T: Future<Output = ()> + Send + 'static>(&self, future: T) {
tokio::spawn(future);
type E = tokio::task::JoinError;
type SpawnedFutureResult<O> = tokio::task::JoinHandle<O>;
fn spawn<O: Send + 'static, F: Future<Output = O> + Send + 'static>(
&self, future: F,
) -> Self::SpawnedFutureResult<O> {
tokio::spawn(future)
}
}

Expand DownExpand Up@@ -254,7 +258,7 @@ where
let fut = res.clone();
let source = self.source.clone();
let block_cache = Arc::clone(&self.block_cache);
self.spawn.spawn(async move {
let _not_polled = self.spawn.spawn(async move {
let res = Self::retrieve_utxo(source, block_cache, scid).await;
fut.resolve(res);
});
Expand Down
94 changes: 84 additions & 10 deletions lightning/src/util/async_poll.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,26 +15,100 @@ use core::marker::Unpin;
use core::pin::Pin;
use core::task::{Context, Poll, RawWaker, RawWakerVTable, Waker};

pub(crate) enum ResultFuture<F: Future<Output = Result<(), E>>, E: Unpin> {
pub(crate) enum ResultFuture<F: Future<Output = O> + Unpin, O> {
Pending(F),
Ready(Result<(), E>),
Ready(O),
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> {
futures_state: Vec<ResultFuture<F, E>>,
pub(crate) struct TwoFutureJoiner<
AO,
BO,
AF: Future<Output = AO> + Unpin,
BF: Future<Output = BO> + Unpin,
> {
a: Option<ResultFuture<AF, AO>>,
b: Option<ResultFuture<BF, BO>>,
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> MultiResultFuturePoller<F, E> {
pub fn new(futures_state: Vec<ResultFuture<F, E>>) -> Self {
impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin>
TwoFutureJoiner<AO, BO, AF, BF>
{
pub fn new(future_a: AF, future_b: BF) -> Self {
Self { a: Some(ResultFuture::Pending(future_a)), b: Some(ResultFuture::Pending(future_b)) }
}
}

impl<AO, BO, AF: Future<Output = AO> + Unpin, BF: Future<Output = BO> + Unpin> Future
for TwoFutureJoiner<AO, BO, AF, BF>
{
type Output = (AO, BO);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<(AO, BO)> {
let mut have_pending_futures = false;
// SAFETY: While we are pinned, we can't get direct access to our internal state because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let state = unsafe { &mut self.get_unchecked_mut() };
macro_rules! poll_future {
($future: ident) => {
match state.$future {
Some(ResultFuture::Pending(ref mut fut)) => match Pin::new(fut).poll(cx) {
Poll::Ready(res) => {
state.$future = Some(ResultFuture::Ready(res));
},
Poll::Pending => {
have_pending_futures = true;
},
},
Some(ResultFuture::Ready(_)) => {},
None => {
debug_assert!(false, "Future polled after Ready");
return Poll::Pending;
},
}
};
}
poll_future!(a);
poll_future!(b);

if have_pending_futures {
Poll::Pending
} else {
Poll::Ready((
match state.a.take() {
Some(ResultFuture::Ready(a)) => a,
_ => unreachable!(),
},
match state.b.take() {
Some(ResultFuture::Ready(b)) => b,
_ => unreachable!(),
},
))
}
}
}

pub(crate) struct MultiResultFuturePoller<F: Future<Output = O> + Unpin, O> {
futures_state: Vec<ResultFuture<F, O>>,
}

impl<F: Future<Output = O> + Unpin, O> MultiResultFuturePoller<F, O> {
pub fn new(futures_state: Vec<ResultFuture<F, O>>) -> Self {
Self { futures_state }
}
}

impl<F: Future<Output = Result<(), E>> + Unpin, E: Unpin> Future for MultiResultFuturePoller<F, E> {
type Output = Vec<Result<(), E>>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<Result<(), E>>> {
impl<F: Future<Output = O> + Unpin, O> Future for MultiResultFuturePoller<F, O> {
type Output = Vec<O>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Vec<O>> {
let mut have_pending_futures = false;
let futures_state = &mut self.get_mut().futures_state;
// SAFETY: While we are pinned, we can't get direct access to `futures_state` because we
// aren't `Unpin`. However, we don't actually need the `Pin` - we only use it below on the
// `Future` in the `ResultFuture::Pending` case, and the `Future` is bound by `Unpin`.
// Thus, the `Pin` is not actually used, and its safe to bypass it and access the inner
// reference directly.
let futures_state = unsafe { &mut self.get_unchecked_mut().futures_state };
for state in futures_state.iter_mut() {
match state {
ResultFuture::Pending(ref mut fut) => match Pin::new(fut).poll(cx) {
Expand Down
123 changes: 117 additions & 6 deletions lightning/src/util/native_async.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,23 +8,44 @@
//! environment.

#[cfg(all(test, feature = "std"))]
use crate::sync::Mutex;
use crate::sync::{Arc, Mutex};
use crate::util::async_poll::{MaybeSend, MaybeSync};

#[cfg(all(test, not(feature = "std")))]
use alloc::rc::Rc;

#[cfg(all(test, not(feature = "std")))]
use core::cell::RefCell;
#[cfg(test)]
use core::convert::Infallible;
use core::future::Future;
#[cfg(test)]
use core::pin::Pin;
#[cfg(test)]
use core::task::{Context, Poll};

/// A generic trait which is able to spawn futures in the background.
/// A generic trait which is able to spawn futures to be polled in the background.
///
/// When the spawned future completes, the returned [`Self::SpawnedFutureResult`] should resolve
/// with the output of the spawned future.
///
/// Spawned futures must be polled independently in the background even if the returned
/// [`Self::SpawnedFutureResult`] is dropped without being polled. This matches the semantics of
/// `tokio::spawn`.
///
/// This is not exported to bindings users as async is only supported in Rust.
pub trait FutureSpawner: MaybeSend + MaybeSync + 'static {
/// The error type of [`Self::SpawnedFutureResult`]. This can be used to indicate that the
/// spawned future was cancelled or panicked.
type E;
/// The result of [`Self::spawn`], a future which completes when the spawned future completes.
type SpawnedFutureResult<O>: Future<Output = Result<O, Self::E>> + Unpin;
/// Spawns the given future as a background task.
///
/// This method MUST NOT block on the given future immediately.
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T);
fn spawn<O: MaybeSend + 'static, T: Future<Output = O> + MaybeSend + 'static>(
&self, future: T,
) -> Self::SpawnedFutureResult<O>;
}

#[cfg(test)]
Expand All@@ -39,6 +60,77 @@ pub(crate) struct FutureQueue(Mutex<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);
#[cfg(all(test, not(feature = "std")))]
pub(crate) struct FutureQueue(RefCell<Vec<Pin<Box<dyn MaybeSendableFuture>>>>);

/// A simple future which can be completed later. Used to implement [`FutureQueue`].
#[cfg(all(test, feature = "std"))]
pub struct FutureQueueCompletion<O>(Arc<Mutex<Option<O>>>);
#[cfg(all(test, not(feature = "std")))]
pub struct FutureQueueCompletion<O>(Rc<RefCell<Option<O>>>);

#[cfg(all(test, feature = "std"))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Arc::new(Mutex::new(None)))
}

fn complete(&self, o: O) {
*self.0.lock().unwrap() = Some(o);
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
#[cfg(all(test, feature = "std"))]
{
Self(Arc::clone(&self.0))
}
#[cfg(all(test, not(feature = "std")))]
{
Self(Rc::clone(&self.0))
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> FutureQueueCompletion<O> {
fn new() -> Self {
Self(Rc::new(RefCell::new(None)))
}

fn complete(&self, o: O) {
*self.0.borrow_mut() = Some(o);
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Clone for FutureQueueCompletion<O> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}

#[cfg(all(test, feature = "std"))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.lock().unwrap().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(all(test, not(feature = "std")))]
impl<O> Future for FutureQueueCompletion<O> {
type Output = Result<O, Infallible>;
fn poll(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<O, Infallible>> {
match Pin::into_inner(self).0.borrow_mut().take() {
None => Poll::Pending,
Some(o) => Poll::Ready(Ok(o)),
}
}
}

#[cfg(test)]
impl FutureQueue {
pub(crate) fn new() -> Self {
Expand DownExpand Up@@ -74,7 +166,6 @@ impl FutureQueue {
futures = self.0.borrow_mut();
}
futures.retain_mut(|fut| {
use core::task::{Context, Poll};
let waker = crate::util::async_poll::dummy_waker();
match fut.as_mut().poll(&mut Context::from_waker(&waker)) {
Poll::Ready(()) => false,
Expand All@@ -86,7 +177,16 @@ impl FutureQueue {

#[cfg(test)]
impl FutureSpawner for FutureQueue {
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -95,14 +195,24 @@ impl FutureSpawner for FutureQueue {
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}

#[cfg(test)]
impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static> FutureSpawner
for D
{
fn spawn<T: Future<Output = ()> + MaybeSend + 'static>(&self, future: T) {
type E = Infallible;
type SpawnedFutureResult<O> = FutureQueueCompletion<O>;
fn spawn<O: MaybeSend + 'static, F: Future<Output = O> + MaybeSend + 'static>(
&self, f: F,
) -> FutureQueueCompletion<O> {
let completion = FutureQueueCompletion::new();
let compl_ref = completion.clone();
let future = async move {
compl_ref.complete(f.await);
};
#[cfg(feature = "std")]
{
self.0.lock().unwrap().push(Box::pin(future));
Expand All@@ -111,5 +221,6 @@ impl<D: core::ops::Deref<Target = FutureQueue> + MaybeSend + MaybeSync + 'static
{
self.0.borrow_mut().push(Box::pin(future));
}
completion
}
}
Loading
Loading