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 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
#[cfg(feature = "upstream")]
use crate::UpstreamConfig;
use crate::{
global::Global,
route::Endpoint,
router::Router,
types::{GlobalVars, ReadyIndicator},
BanManager, ConnectionList, Result, StratumServerBuilder, VarDiffConfig,
};
use async_std::{
net::TcpListener,
sync::{Arc, Mutex},
task,
task::JoinHandle,
};
use futures::StreamExt;
use tracing::info;
// use metrics_exporter_prometheus::PrometheusBuilder;
use signal_hook::consts::signal::*;
use signal_hook_async_std::{Handle, Signals};
//@todo maybe remove this with time dependency
use extended_primitives::Buffer;
use std::time::Instant;
use stop_token::{future::FutureExt, stream::StreamExt as StopStreamExt, StopSource, StopToken};
//@todo make this not default, but api.
// #[cfg(feature = "default")]
// use crate::api::init_api_server;
// use crate::metrics::Metrics;
use crate::id_manager::IDManager;
use crate::tcp::handle_connection;
// #[derive(Clone)]
pub struct StratumServer<State, CState>
where
State: Clone + Send + Sync + 'static,
CState: Default + Clone + Send + Sync + 'static,
{
pub(crate) id: u8,
pub(crate) host: String,
pub(crate) port: u16,
pub(crate) expected_port: u16,
pub(crate) proxy: bool,
pub(crate) initial_difficulty: u64,
pub(crate) state: State,
pub(crate) connection_list: Arc<ConnectionList<CState>>,
pub(crate) ban_manager: Arc<BanManager>,
pub(crate) router: Arc<Router<State, CState>>,
pub(crate) var_diff_config: VarDiffConfig,
#[cfg(feature = "upstream")]
pub(crate) upstream_router: Arc<Router<State, CState>>,
#[cfg(feature = "upstream")]
pub(crate) upstream_config: UpstreamConfig,
pub(crate) session_id_manager: Arc<IDManager>,
//@todo maybe wrap this in something more friendly... Can use it in connection as well.
pub(crate) stop_source: Arc<Mutex<Option<StopSource>>>,
pub(crate) stop_token: StopToken,
pub(crate) global_thread_list: Vec<JoinHandle<()>>,
//@todo I think we can actually kill this now that I remember.
//Likely why the nimiq server will occasionally get not ready for a long time.
//Although let's look into what scenarios are we marking not ready in the stratums.
//@todo I think revamp this a bit to include getting the correct server_id from our
//homebase
pub(crate) ready_indicator: ReadyIndicator,
pub(crate) shutdown_message: Option<Buffer>,
}
//@todo consider this signal for reloading upstream config?
// SIGHUP => {
// // Reload configuration
// // Reopen the log file
// }
//@todo maybe move this somewhere else outside of this file.
async fn handle_signals(mut signals: Signals, stop_source: Arc<Mutex<Option<StopSource>>>) {
while let Some(signal) = signals.next().await {
tracing::warn!("{:?}", &signal);
match signal {
SIGTERM | SIGINT | SIGQUIT => {
// Shutdown the system;
//@todo print the signal here
info!("Received SIGINT. Initiating shutdown...");
*stop_source.lock().await = None;
info!("Stop token has been dropped");
return;
}
_ => unreachable!(),
}
}
}
impl<State: Clone + Send + Sync + 'static, CState: Default + Clone + Send + Sync + 'static>
StratumServer<State, CState>
{
pub fn builder(state: State, server_id: u8) -> StratumServerBuilder<State, CState> {
StratumServerBuilder::new(state, server_id)
}
//Initialize the server before we want to start accepting any connections.
async fn init(&self) -> Result<(Handle, JoinHandle<()>)> {
info!("Initializing...");
// if cfg!(feature = "default") {
// init_api_server(self.stop_token.clone(), self.ready_indicator.clone()).await?;
// info!("API Server Initialized");
// }
let signals = Signals::new([SIGHUP, SIGTERM, SIGINT, SIGQUIT])?;
let handle = signals.handle();
let signals_task =
async_std::task::spawn(handle_signals(signals, self.stop_source.clone()));
info!("Initialization Complete");
Ok((handle, signals_task))
}
pub fn add(&mut self, method: &str, ep: impl Endpoint<State, CState>) {
//@todo review this code.
let router = Arc::get_mut(&mut self.router)
.expect("Registering routes is not possible after the Server has started");
router.add(method, ep);
}
//@todo will probably change this "Endpoint" here to an upstream endpoint.
#[cfg(feature = "upstream")]
pub fn add_upstream(&mut self, method: &str, ep: impl Endpoint<State, CState>) {
//@todo review this code.
let router = Arc::get_mut(&mut self.upstream_router)
.expect("Registering routes is not possible after the Server has started");
router.add(method, ep);
}
pub fn global(&mut self, global_name: &str, ep: impl Global<State, CState>) {
let state = self.state.clone();
let connection_list = self.connection_list.clone();
let stop_token = self.stop_token.clone();
let handle = async_std::task::Builder::new()
.name(global_name.to_string())
.spawn(async move {
let call = ep.call(state, connection_list).timeout_at(stop_token);
match call.await {
Ok(()) => {}
Err(_e) => {
//@todo - This will only be relevant for when we have results returned by
//Globals because currently this block will only be called if the stop
//token is revoked. Re-enable this when that is implemented.
//2. We should probably have a config setting that asks if we want to nuke everything if a
// global falls. I don't know if we should automatically nuke everything, but it should
// be a setting that is available. Maybe it's available on a per-global basis, but I
// think it's something we should absolutely know about.
// @
// warn!(
// "Global thread id: {} name: {} was unexpected closed by the error: {}",
// async_std::task::current().id(),
// async_std::task::current().name().unwrap_or(""),
// e
// );
info!(
"Global thread id: {} name: {} was closed",
async_std::task::current().id(),
async_std::task::current().name().unwrap_or("")
);
}
};
})
//@todo switch this to expect
.unwrap();
self.global_thread_list.push(handle);
}
pub async fn start(&mut self) -> Result<()> {
//Initalize the recorder
init_metrics_recorder();
let (signal_handle, signal_task) = self.init().await?;
let listen_url = format!("{}:{}", &self.host, self.port);
let listener = TcpListener::bind(&listen_url).await?;
let incoming = listener.incoming();
info!("Listening on {}", &listen_url);
//@todo removing this to see if it's the cause of the memory leak. Would be ince to write
//some tests to see if this causes any leaked threads.
// let mut thread_list = Vec::new();
let mut incoming_with_stop = incoming.timeout_at(self.stop_token.clone());
while let Some(Ok(stream)) = incoming_with_stop.next().await {
let stream = match stream {
Ok(stream) => stream,
//@todo this needs to be handled a lot better, but for now I hope this solves our
//issue.
Err(_e) => continue,
};
let addr = match stream.peer_addr() {
Ok(addr) => addr,
Err(_e) => continue,
};
//@todo a lot of these clones can be moved into the async block (or rather, just
//before). Might clean this section up a bit.
//Wrap this in an if proxy
let connection_list = self.connection_list.clone();
let id_manager = self.session_id_manager.clone();
let proxy = self.proxy;
let expected_port = self.expected_port;
let initial_difficulty = self.initial_difficulty;
let ban_manager = self.ban_manager.clone();
let router = self.router.clone();
#[cfg(feature = "upstream")]
let upstream_router = self.upstream_router.clone();
let state = self.state.clone();
let connection_state = CState::default();
let var_diff_config = self.var_diff_config.clone();
#[cfg(feature = "upstream")]
let upstream_config = self.upstream_config.clone();
let global_vars = GlobalVars::new(self.id);
//@todo should we pass the stop token in this?
// let handle = task::spawn(async move {
task::spawn(async move {
//First things first, since we get a ridiculous amount of no-data stream connections, we are
//going to peak 2 bytes off of this and if we get those 2 bytes we continue, otherwise we are
//burning it down with 0 logs baby.
//@todo for safety reasons we may want to make this like 5 bytes, but thats a rare
//scenario so I'm not too pressed for it imo.
let mut check_bytes = [0u8; 4];
match stream.peek(&mut check_bytes).await {
Err(e) => {
tracing::error!(
"Trouble reading peak bytes from stream: {}. Exiting. Error: {}",
addr,
e
);
return;
}
Ok(n) => {
if n == 0 {
//@todo decide if we want to log this at all, but I'd say probably not.
return;
} else if n >= 4 {
//Gucci
}
// else {
// Right now we do nothing for this block, but catching small byte attacks
// here might be very helpful for us in the long run.
// //
// }
}
};
handle_connection(
id_manager,
ban_manager,
addr,
connection_list,
router,
#[cfg(feature = "upstream")]
upstream_router,
#[cfg(feature = "upstream")]
upstream_config,
state,
stream,
var_diff_config,
initial_difficulty,
connection_state,
//@todo would be nice to be Proxy Config.
//@TODO DO THIS TONIGHT
proxy,
expected_port,
global_vars,
)
//@todo think about it
.await
.unwrap();
});
//@todo this has got to be a memory leak no?
//@TODO really need to fix this.
//https://github.com/smol-rs/async-task/pull/19
//@todo also see this: https://web.mit.edu/rust-lang_v1.25/arch/amd64_ubuntu1404/share/doc/rust/html/book/second-edition/ch20-06-graceful-shutdown-and-cleanup.html
// thread_list.push(handle);
}
let start = Instant::now();
//@todo might be nice to have self.shutdown here?
//Before we return Ok here, we need to finish cleaning up the rest.
//So what I'm thinking we do is iterate through miner list and shutdown everything.
//@todo magic number of 60 should be set somewhere
self.connection_list
.shutdown(self.shutdown_message.clone(), 60)
.await?;
//I believe that shutdown here should basically trigger connect_list to self distruct.
//That being said, if each handle_connection uses the same stop_token, then it won't even
//be necessary to do this. We can just iterate through the futures (task_handles), and
//await them all.
//
//Okay so I'm thinking one way to possibly do this is store an Option<StopSource> in
//connection....
//
//Do the same for globals.
let global_thread_list = self.global_thread_list.drain(..);
//@TODO make this parrallel.
info!("Awaiting for all current globals to complete");
for thread in global_thread_list {
thread.await;
}
//@TODO make this parrallel.
// info!("Awaiting for all current connections to complete");
// for thread in thread_list {
// thread.await;
// }
// Allow for signal threads to close. @todo check this in testing.
info!("Awaiting for all signal handler to complete");
signal_handle.close();
info!("Awaiting for all signal task to complete");
signal_task.await;
//@todo lets get some better parsing here. Seconds and NS would be great
info!("Shutdown complete in {} ns", start.elapsed().as_nanos());
Ok(())
}
pub fn get_ready_indicator(&self) -> ReadyIndicator {
self.ready_indicator.clone()
}
// #[cfg(test)]
pub fn get_miner_list(&self) -> Arc<ConnectionList<CState>> {
self.connection_list.clone()
}
pub fn get_stop_token(&self) -> StopToken {
self.stop_token.clone()
}
}
//Initalizes the prometheus metrics recorder.
pub fn init_metrics_recorder() {
// let (recorder, _) = PrometheusBuilder::new().build().unwrap();
////@todo this is breaking.
// metrics::set_boxed_recorder(Box::new(recorder));
}
impl<State: Clone + Send + Sync + 'static, CState: Default + Clone + Send + Sync + 'static> Drop
for StratumServer<State, CState>
{
fn drop(&mut self) {
info!("Dropping StratumSever with data `{}`!", self.host);
}
}