1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
// use crate::message::BaseMessage;
use crate::channel_types::SmallSender;
#[cfg(feature = "std")]
use crate::runtime;
use crate::{
router::{Router, SenderPair},
tokio::runtime::Runtime,
NodeMessage,
};
use core::future::Future;
use ockam_core::{compat::sync::Arc, Address, Result};
#[cfg(feature = "metrics")]
use crate::metrics::Metrics;
// This import is available on emebedded but we don't use the metrics
// collector, thus don't need it in scope.
#[cfg(feature = "metrics")]
use core::sync::atomic::{AtomicBool, Ordering};
#[cfg(feature = "std")]
use opentelemetry::trace::FutureExt;
use ockam_core::flow_control::FlowControls;
#[cfg(feature = "std")]
use ockam_core::{
errcode::{Kind, Origin},
Error,
};
/// Underlying Ockam node executor
///
/// This type is a small wrapper around an inner async runtime (`tokio` by
/// default) and the Ockam router. In most cases it is recommended you use the
/// `ockam::node` function annotation instead!
pub struct Executor {
/// Reference to the runtime needed to spawn tasks
rt: Arc<Runtime>,
/// Main worker and application router
router: Router,
/// Metrics collection endpoint
#[cfg(feature = "metrics")]
metrics: Arc<Metrics>,
}
impl Executor {
/// Create a new Ockam node [`Executor`] instance
pub fn new(rt: Arc<Runtime>, flow_controls: &FlowControls) -> Self {
let router = Router::new(flow_controls);
#[cfg(feature = "metrics")]
let metrics = Metrics::new(&rt, router.get_metrics_readout());
Self {
rt,
router,
#[cfg(feature = "metrics")]
metrics,
}
}
/// Start the router asynchronously
pub async fn start_router(&mut self) -> Result<()> {
self.router.run().await
}
/// Get access to the internal message sender
pub(crate) fn sender(&self) -> SmallSender<NodeMessage> {
self.router.sender()
}
/// Initialize the root application worker
pub(crate) fn initialize_system<S: Into<Address>>(&mut self, address: S, senders: SenderPair) {
trace!("Initializing node executor");
self.router.init(address.into(), senders);
}
/// Initialise and run the Ockam node executor context
///
/// In this background this launches async execution of the Ockam
/// router, while blocking execution on the provided future.
///
/// Any errors encountered by the router or provided application
/// code will be returned from this function.
#[cfg(feature = "std")]
pub fn execute<F, T, E>(&mut self, future: F) -> Result<F::Output>
where
F: Future<Output = core::result::Result<T, E>> + Send + 'static,
T: Send + 'static,
E: Send + 'static,
{
// Spawn the metrics collector first
#[cfg(feature = "metrics")]
let alive = Arc::new(AtomicBool::from(true));
#[cfg(feature = "metrics")]
self.rt.spawn(
self.metrics
.clone()
.run(alive.clone())
.with_current_context(),
);
// Spawn user code second
let sender = self.sender();
let future = Executor::wrapper(sender, future);
let join_body = self.rt.spawn(future.with_current_context());
// Then block on the execution of the router
self.rt.block_on(self.router.run().with_current_context())?;
// Shut down metrics collector
#[cfg(feature = "metrics")]
alive.fetch_or(true, Ordering::Acquire);
// Last join user code
let res = self
.rt
.block_on(join_body)
.map_err(|e| Error::new(Origin::Executor, Kind::Unknown, e))?;
Ok(res)
}
/// Initialise and run the Ockam node executor context
///
/// In this background this launches async execution of the Ockam
/// router, while blocking execution on the provided future.
///
/// Any errors encountered by the router or provided application
/// code will be returned from this function.
///
/// Don't abort the router in case of a failure
#[cfg(feature = "std")]
pub fn execute_no_abort<F, T>(&mut self, future: F) -> Result<F::Output>
where
F: Future<Output = T> + Send + 'static,
T: Send + 'static,
{
// Spawn the metrics collector first
#[cfg(feature = "metrics")]
let alive = Arc::new(AtomicBool::from(true));
#[cfg(feature = "metrics")]
self.rt.spawn(
self.metrics
.clone()
.run(alive.clone())
.with_current_context(),
);
// Spawn user code second
let join_body = self.rt.spawn(future.with_current_context());
// Then block on the execution of the router
self.rt.block_on(self.router.run().with_current_context())?;
// Shut down metrics collector
#[cfg(feature = "metrics")]
alive.fetch_or(true, Ordering::Acquire);
// Last join user code
let res = self
.rt
.block_on(join_body)
.map_err(|e| Error::new(Origin::Executor, Kind::Unknown, e))?;
Ok(res)
}
/// Wrapper around the user provided future that will shut down the node on error
#[cfg(feature = "std")]
async fn wrapper<F, T, E>(
sender: SmallSender<NodeMessage>,
future: F,
) -> core::result::Result<T, E>
where
F: Future<Output = core::result::Result<T, E>> + Send + 'static,
{
match future.await {
Ok(val) => Ok(val),
Err(e) => {
// We earlier sent the AbortNode message to the router here.
// It failed because the router state was not set to `Stopping`
// But sending Graceful shutdown message works because, it internally does that.
//
// I think way AbortNode is implemented right now, it is more of an
// internal/private message not meant to be directly used, without changing the
// router state.
let (req, mut rx) = NodeMessage::stop_node(crate::ShutdownType::Graceful(1));
let _ = sender.send(req).await;
let _ = rx.recv().await;
Err(e)
}
}
}
/// Execute a future and block until a result is returned
/// This function can only be called to run futures before the Executor has been initialized.
/// Otherwise the Executor rt attribute needs to be accessed to execute or spawn futures
#[cfg(feature = "std")]
pub fn execute_future<F>(future: F) -> Result<F::Output>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
let lock = runtime::RUNTIME.lock().unwrap();
let rt = lock.as_ref().expect("Runtime was consumed");
let join_body = rt.spawn(future.with_current_context());
rt.block_on(join_body.with_current_context())
.map_err(|e| Error::new(Origin::Executor, Kind::Unknown, e))
}
#[cfg(not(feature = "std"))]
/// Initialise and run the Ockam node executor context
///
/// In this background this launches async execution of the Ockam
/// router, while blocking execution on the provided future.
///
/// Any errors encountered by the router or provided application
/// code will be returned from this function.
// TODO @antoinevg - support @thomm join & merge with std version
pub fn execute<F>(&mut self, future: F) -> Result<()>
where
F: Future + Send + 'static,
F::Output: Send + 'static,
{
let _join = self.rt.spawn(future);
// Block this task executing the primary message router,
// returning any critical failures that it encounters.
let future = self.router.run();
crate::tokio::runtime::execute(&self.rt, async move { future.await.unwrap() });
Ok(())
}
}