openethereum/util/src/io/service.rs

399 lines
12 KiB
Rust
Raw Normal View History

2016-02-05 13:40:41 +01:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
2016-01-21 16:48:37 +01:00
use std::sync::*;
2016-01-12 17:33:40 +01:00
use std::thread::{self, JoinHandle};
2016-01-21 16:48:37 +01:00
use std::collections::HashMap;
2016-01-12 17:33:40 +01:00
use mio::*;
2016-06-17 12:58:28 +02:00
use crossbeam::sync::chase_lev;
use slab::Slab;
2016-01-12 17:33:40 +01:00
use error::*;
use io::{IoError, IoHandler};
2016-01-21 16:48:37 +01:00
use io::worker::{Worker, Work, WorkType};
use panics::*;
2016-01-12 17:33:40 +01:00
/// Timer ID
2016-01-12 17:33:40 +01:00
pub type TimerToken = usize;
/// Timer ID
2016-01-12 17:33:40 +01:00
pub type StreamToken = usize;
/// IO Hadndler ID
2016-01-21 16:48:37 +01:00
pub type HandlerId = usize;
2016-01-12 17:33:40 +01:00
/// Maximum number of tokens a handler can use
2016-01-21 16:48:37 +01:00
pub const TOKENS_PER_HANDLER: usize = 16384;
2016-06-17 12:58:28 +02:00
const MAX_HANDLERS: usize = 8;
2016-01-12 17:33:40 +01:00
/// Messages used to communicate with the event loop from other threads.
2016-01-21 16:48:37 +01:00
#[derive(Clone)]
pub enum IoMessage<Message> where Message: Send + Clone + Sized {
2016-01-12 17:33:40 +01:00
/// Shutdown the event loop
Shutdown,
/// Register a new protocol handler.
AddHandler {
2016-01-21 16:48:37 +01:00
handler: Arc<IoHandler<Message>+Send>,
},
2016-06-17 12:58:28 +02:00
RemoveHandler {
handler_id: HandlerId,
},
2016-01-21 16:48:37 +01:00
AddTimer {
handler_id: HandlerId,
token: TimerToken,
delay: u64,
},
RemoveTimer {
handler_id: HandlerId,
token: TimerToken,
},
RegisterStream {
handler_id: HandlerId,
token: StreamToken,
},
2016-01-22 18:13:59 +01:00
DeregisterStream {
handler_id: HandlerId,
token: StreamToken,
},
2016-01-21 16:48:37 +01:00
UpdateStreamRegistration {
handler_id: HandlerId,
token: StreamToken,
2016-01-12 17:33:40 +01:00
},
/// Broadcast a message across all protocol handlers.
2016-01-13 13:56:48 +01:00
UserMessage(Message)
2016-01-12 17:33:40 +01:00
}
/// IO access point. This is passed to all IO handlers and provides an interface to the IO subsystem.
2016-01-21 16:48:37 +01:00
pub struct IoContext<Message> where Message: Send + Clone + 'static {
channel: IoChannel<Message>,
handler: HandlerId,
2016-01-12 17:33:40 +01:00
}
2016-01-21 16:48:37 +01:00
impl<Message> IoContext<Message> where Message: Send + Clone + 'static {
2016-01-12 17:33:40 +01:00
/// Create a new IO access point. Takes references to all the data that can be updated within the IO handler.
2016-01-21 16:48:37 +01:00
pub fn new(channel: IoChannel<Message>, handler: HandlerId) -> IoContext<Message> {
2016-01-12 17:33:40 +01:00
IoContext {
2016-01-21 16:48:37 +01:00
handler: handler,
channel: channel,
2016-01-12 17:33:40 +01:00
}
}
2016-01-21 16:48:37 +01:00
/// Register a new IO timer. 'IoHandler::timeout' will be called with the token.
pub fn register_timer(&self, token: TimerToken, ms: u64) -> Result<(), UtilError> {
try!(self.channel.send_io(IoMessage::AddTimer {
token: token,
2016-01-12 17:33:40 +01:00
delay: ms,
2016-01-21 16:48:37 +01:00
handler_id: self.handler,
}));
Ok(())
}
/// Delete a timer.
pub fn clear_timer(&self, token: TimerToken) -> Result<(), UtilError> {
try!(self.channel.send_io(IoMessage::RemoveTimer {
token: token,
handler_id: self.handler,
}));
Ok(())
}
2016-01-22 18:13:59 +01:00
2016-01-21 16:48:37 +01:00
/// Register a new IO stream.
pub fn register_stream(&self, token: StreamToken) -> Result<(), UtilError> {
try!(self.channel.send_io(IoMessage::RegisterStream {
token: token,
handler_id: self.handler,
}));
Ok(())
}
2016-01-22 18:13:59 +01:00
/// Deregister an IO stream.
pub fn deregister_stream(&self, token: StreamToken) -> Result<(), UtilError> {
try!(self.channel.send_io(IoMessage::DeregisterStream {
token: token,
handler_id: self.handler,
}));
Ok(())
}
2016-01-21 16:48:37 +01:00
/// Reregister an IO stream.
pub fn update_registration(&self, token: StreamToken) -> Result<(), UtilError> {
try!(self.channel.send_io(IoMessage::UpdateStreamRegistration {
token: token,
handler_id: self.handler,
}));
Ok(())
2016-01-12 17:33:40 +01:00
}
/// Broadcast a message to other IO clients
2016-01-21 16:48:37 +01:00
pub fn message(&self, message: Message) {
self.channel.send(message).expect("Error seding message");
2016-01-12 17:33:40 +01:00
}
2016-01-21 23:33:52 +01:00
/// Get message channel
pub fn channel(&self) -> IoChannel<Message> {
self.channel.clone()
}
2016-06-17 12:58:28 +02:00
/// Unregister current IO handler.
pub fn unregister_handler(&self) -> Result<(), IoError> {
try!(self.channel.send_io(IoMessage::RemoveHandler {
handler_id: self.handler,
}));
Ok(())
}
2016-01-12 17:33:40 +01:00
}
2016-01-21 16:48:37 +01:00
#[derive(Clone)]
2016-01-12 17:33:40 +01:00
struct UserTimer {
delay: u64,
2016-01-21 16:48:37 +01:00
timeout: Timeout,
2016-01-12 17:33:40 +01:00
}
/// Root IO handler. Manages user handlers, messages and IO timers.
2016-01-21 16:48:37 +01:00
pub struct IoManager<Message> where Message: Send + Sync {
timers: Arc<RwLock<HashMap<HandlerId, UserTimer>>>,
2016-06-17 12:58:28 +02:00
handlers: Slab<Arc<IoHandler<Message>>, HandlerId>,
workers: Vec<Worker>,
2016-01-21 16:48:37 +01:00
worker_channel: chase_lev::Worker<Work<Message>>,
work_ready: Arc<Condvar>,
2016-01-12 17:33:40 +01:00
}
2016-01-21 16:48:37 +01:00
impl<Message> IoManager<Message> where Message: Send + Sync + Clone + 'static {
2016-01-12 17:33:40 +01:00
/// Creates a new instance and registers it with the event loop.
2016-02-10 16:35:52 +01:00
pub fn start(panic_handler: Arc<PanicHandler>, event_loop: &mut EventLoop<IoManager<Message>>) -> Result<(), UtilError> {
2016-01-21 16:48:37 +01:00
let (worker, stealer) = chase_lev::deque();
let num_workers = 4;
let work_ready_mutex = Arc::new(Mutex::new(()));
2016-01-21 16:48:37 +01:00
let work_ready = Arc::new(Condvar::new());
let workers = (0..num_workers).map(|i|
2016-02-10 16:35:52 +01:00
Worker::new(
i,
stealer.clone(),
IoChannel::new(event_loop.channel()),
work_ready.clone(),
work_ready_mutex.clone(),
panic_handler.clone()
)
).collect();
2016-01-21 16:48:37 +01:00
2016-01-12 17:33:40 +01:00
let mut io = IoManager {
2016-01-21 16:48:37 +01:00
timers: Arc::new(RwLock::new(HashMap::new())),
2016-06-17 12:58:28 +02:00
handlers: Slab::new(MAX_HANDLERS),
2016-01-21 16:48:37 +01:00
worker_channel: worker,
workers: workers,
2016-01-21 16:48:37 +01:00
work_ready: work_ready,
2016-01-12 17:33:40 +01:00
};
try!(event_loop.run(&mut io));
Ok(())
}
}
2016-01-21 16:48:37 +01:00
impl<Message> Handler for IoManager<Message> where Message: Send + Clone + Sync + 'static {
2016-01-12 17:33:40 +01:00
type Timeout = Token;
2016-01-13 13:56:48 +01:00
type Message = IoMessage<Message>;
2016-01-12 17:33:40 +01:00
2016-01-21 16:48:37 +01:00
fn ready(&mut self, _event_loop: &mut EventLoop<Self>, token: Token, events: EventSet) {
let handler_index = token.as_usize() / TOKENS_PER_HANDLER;
let token_id = token.as_usize() % TOKENS_PER_HANDLER;
2016-06-17 18:26:54 +02:00
if let Some(handler) = self.handlers.get(handler_index) {
if events.is_hup() {
self.worker_channel.push(Work { work_type: WorkType::Hup, token: token_id, handler: handler.clone(), handler_id: handler_index });
2016-01-12 17:33:40 +01:00
}
2016-06-17 18:26:54 +02:00
else {
if events.is_readable() {
self.worker_channel.push(Work { work_type: WorkType::Readable, token: token_id, handler: handler.clone(), handler_id: handler_index });
}
if events.is_writable() {
self.worker_channel.push(Work { work_type: WorkType::Writable, token: token_id, handler: handler.clone(), handler_id: handler_index });
}
2016-01-12 17:33:40 +01:00
}
2016-06-17 18:26:54 +02:00
self.work_ready.notify_all();
2016-01-12 17:33:40 +01:00
}
}
fn timeout(&mut self, event_loop: &mut EventLoop<Self>, token: Token) {
2016-01-21 16:48:37 +01:00
let handler_index = token.as_usize() / TOKENS_PER_HANDLER;
let token_id = token.as_usize() % TOKENS_PER_HANDLER;
2016-06-17 18:26:54 +02:00
if let Some(handler) = self.handlers.get(handler_index) {
if let Some(timer) = self.timers.read().unwrap().get(&token.as_usize()) {
event_loop.timeout_ms(token, timer.delay).expect("Error re-registering user timer");
self.worker_channel.push(Work { work_type: WorkType::Timeout, token: token_id, handler: handler.clone(), handler_id: handler_index });
self.work_ready.notify_all();
}
2016-01-12 17:33:40 +01:00
}
}
fn notify(&mut self, event_loop: &mut EventLoop<Self>, msg: Self::Message) {
2016-01-21 16:48:37 +01:00
match msg {
IoMessage::Shutdown => {
self.workers.clear();
2016-04-07 12:27:54 +02:00
event_loop.shutdown();
},
2016-01-21 16:48:37 +01:00
IoMessage::AddHandler { handler } => {
2016-06-17 12:58:28 +02:00
let handler_id = self.handlers.insert(handler.clone()).unwrap_or_else(|_| panic!("Too many handlers registered"));
2016-01-21 16:48:37 +01:00
handler.initialize(&IoContext::new(IoChannel::new(event_loop.channel()), handler_id));
},
2016-06-17 12:58:28 +02:00
IoMessage::RemoveHandler { handler_id } => {
// TODO: flush event loop
self.handlers.remove(handler_id);
},
2016-01-21 16:48:37 +01:00
IoMessage::AddTimer { handler_id, token, delay } => {
let timer_id = token + handler_id * TOKENS_PER_HANDLER;
let timeout = event_loop.timeout_ms(Token(timer_id), delay).expect("Error registering user timer");
self.timers.write().unwrap().insert(timer_id, UserTimer { delay: delay, timeout: timeout });
},
IoMessage::RemoveTimer { handler_id, token } => {
let timer_id = token + handler_id * TOKENS_PER_HANDLER;
if let Some(timer) = self.timers.write().unwrap().remove(&timer_id) {
event_loop.clear_timeout(timer.timeout);
}
2016-01-12 17:33:40 +01:00
},
2016-01-21 16:48:37 +01:00
IoMessage::RegisterStream { handler_id, token } => {
2016-06-17 18:26:54 +02:00
if let Some(handler) = self.handlers.get(handler_id) {
handler.register_stream(token, Token(token + handler_id * TOKENS_PER_HANDLER), event_loop);
}
2016-01-21 16:48:37 +01:00
},
2016-01-22 18:13:59 +01:00
IoMessage::DeregisterStream { handler_id, token } => {
2016-06-17 18:26:54 +02:00
if let Some(handler) = self.handlers.get(handler_id) {
handler.deregister_stream(token, event_loop);
// unregister a timer associated with the token (if any)
let timer_id = token + handler_id * TOKENS_PER_HANDLER;
if let Some(timer) = self.timers.write().unwrap().remove(&timer_id) {
event_loop.clear_timeout(timer.timeout);
}
2016-02-15 11:54:38 +01:00
}
2016-01-22 18:13:59 +01:00
},
2016-01-21 16:48:37 +01:00
IoMessage::UpdateStreamRegistration { handler_id, token } => {
2016-06-17 18:26:54 +02:00
if let Some(handler) = self.handlers.get(handler_id) {
handler.update_stream(token, Token(token + handler_id * TOKENS_PER_HANDLER), event_loop);
}
2016-01-21 16:48:37 +01:00
},
IoMessage::UserMessage(data) => {
2016-06-17 12:58:28 +02:00
//TODO: better way to iterate the slab
for id in 0 .. MAX_HANDLERS {
if let Some(h) = self.handlers.get(id) {
let handler = h.clone();
self.worker_channel.push(Work { work_type: WorkType::Message(data.clone()), token: 0, handler: handler, handler_id: id });
}
2016-01-12 17:33:40 +01:00
}
2016-01-21 16:48:37 +01:00
self.work_ready.notify_all();
2016-01-12 17:33:40 +01:00
}
}
}
}
2016-01-13 23:13:57 +01:00
/// Allows sending messages into the event loop. All the IO handlers will get the message
/// in the `message` callback.
2016-01-21 16:48:37 +01:00
pub struct IoChannel<Message> where Message: Send + Clone{
2016-01-18 00:24:20 +01:00
channel: Option<Sender<IoMessage<Message>>>
2016-01-13 23:13:57 +01:00
}
2016-01-21 16:48:37 +01:00
impl<Message> Clone for IoChannel<Message> where Message: Send + Clone {
fn clone(&self) -> IoChannel<Message> {
IoChannel {
channel: self.channel.clone()
}
}
}
impl<Message> IoChannel<Message> where Message: Send + Clone {
2016-01-18 00:24:20 +01:00
/// Send a msessage through the channel
2016-01-17 23:07:58 +01:00
pub fn send(&self, message: Message) -> Result<(), IoError> {
2016-01-18 00:24:20 +01:00
if let Some(ref channel) = self.channel {
try!(channel.send(IoMessage::UserMessage(message)));
}
2016-01-13 23:13:57 +01:00
Ok(())
}
2016-01-18 00:24:20 +01:00
/// Send low level io message
2016-01-21 16:48:37 +01:00
pub fn send_io(&self, message: IoMessage<Message>) -> Result<(), IoError> {
if let Some(ref channel) = self.channel {
try!(channel.send(message))
}
Ok(())
}
2016-01-18 00:24:20 +01:00
/// Create a new channel to connected to event loop.
pub fn disconnected() -> IoChannel<Message> {
IoChannel { channel: None }
}
2016-01-21 16:48:37 +01:00
fn new(channel: Sender<IoMessage<Message>>) -> IoChannel<Message> {
IoChannel { channel: Some(channel) }
}
2016-01-13 23:13:57 +01:00
}
2016-01-12 17:33:40 +01:00
/// General IO Service. Starts an event loop and dispatches IO requests.
2016-01-13 13:56:48 +01:00
/// 'Message' is a notification message type
2016-01-21 16:48:37 +01:00
pub struct IoService<Message> where Message: Send + Sync + Clone + 'static {
2016-02-10 15:28:43 +01:00
panic_handler: Arc<PanicHandler>,
2016-01-12 17:33:40 +01:00
thread: Option<JoinHandle<()>>,
2016-01-21 16:48:37 +01:00
host_channel: Sender<IoMessage<Message>>,
2016-01-12 17:33:40 +01:00
}
2016-02-10 15:28:43 +01:00
impl<Message> MayPanic for IoService<Message> where Message: Send + Sync + Clone + 'static {
fn on_panic<F>(&self, closure: F) where F: OnPanicListener {
self.panic_handler.on_panic(closure);
}
}
2016-01-21 16:48:37 +01:00
impl<Message> IoService<Message> where Message: Send + Sync + Clone + 'static {
2016-01-12 17:33:40 +01:00
/// Starts IO event loop
2016-01-13 13:56:48 +01:00
pub fn start() -> Result<IoService<Message>, UtilError> {
2016-02-10 16:35:52 +01:00
let panic_handler = PanicHandler::new_in_arc();
let mut event_loop = EventLoop::new().unwrap();
2016-01-12 17:33:40 +01:00
let channel = event_loop.channel();
let panic = panic_handler.clone();
2016-01-12 17:33:40 +01:00
let thread = thread::spawn(move || {
2016-02-10 16:35:52 +01:00
let p = panic.clone();
panic.catch_panic(move || {
2016-02-10 16:35:52 +01:00
IoManager::<Message>::start(p, &mut event_loop).unwrap();
}).unwrap()
2016-01-12 17:33:40 +01:00
});
Ok(IoService {
panic_handler: panic_handler,
2016-01-12 17:33:40 +01:00
thread: Some(thread),
host_channel: channel
})
}
2016-06-17 12:58:28 +02:00
/// Regiter an IO handler with the event loop.
pub fn register_handler(&self, handler: Arc<IoHandler<Message>+Send>) -> Result<(), IoError> {
2016-01-12 17:33:40 +01:00
try!(self.host_channel.send(IoMessage::AddHandler {
handler: handler,
}));
Ok(())
}
/// Send a message over the network. Normaly `HostIo::send` should be used. This can be used from non-io threads.
2016-06-17 12:58:28 +02:00
pub fn send_message(&self, message: Message) -> Result<(), IoError> {
try!(self.host_channel.send(IoMessage::UserMessage(message)));
Ok(())
}
2016-01-13 23:13:57 +01:00
/// Create a new message channel
2016-06-17 12:58:28 +02:00
pub fn channel(&self) -> IoChannel<Message> {
2016-01-18 00:24:20 +01:00
IoChannel { channel: Some(self.host_channel.clone()) }
2016-01-13 23:13:57 +01:00
}
2016-01-12 17:33:40 +01:00
}
2016-01-21 16:48:37 +01:00
impl<Message> Drop for IoService<Message> where Message: Send + Sync + Clone {
2016-01-12 17:33:40 +01:00
fn drop(&mut self) {
trace!(target: "shutdown", "[IoService] Closing...");
2016-01-12 17:33:40 +01:00
self.host_channel.send(IoMessage::Shutdown).unwrap();
2016-01-22 01:27:51 +01:00
self.thread.take().unwrap().join().ok();
trace!(target: "shutdown", "[IoService] Closed.");
2016-01-12 17:33:40 +01:00
}
}