2016-04-13 18:03:57 +02: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/>.
|
|
|
|
|
|
|
|
//! Parity interprocess hypervisor module
|
|
|
|
|
2016-04-14 20:45:53 +02:00
|
|
|
// while not included in binary
|
2016-04-14 19:56:06 +02:00
|
|
|
#![allow(dead_code)]
|
|
|
|
|
2016-04-13 18:03:57 +02:00
|
|
|
pub mod service;
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Default value for hypervisor ipc listener
|
2016-04-13 18:03:57 +02:00
|
|
|
pub const HYPERVISOR_IPC_URL: &'static str = "ipc:///tmp/parity-internal-hyper-status.ipc";
|
|
|
|
|
|
|
|
use nanoipc;
|
2016-04-14 17:22:31 +02:00
|
|
|
use std::sync::{Arc,RwLock};
|
|
|
|
use hypervisor::service::*;
|
2016-04-14 20:45:53 +02:00
|
|
|
use std::process::{Command,Child};
|
|
|
|
use std::collections::HashMap;
|
|
|
|
|
|
|
|
type BinaryId = &'static str;
|
|
|
|
|
|
|
|
const BLOCKCHAIN_DB_BINARY: BinaryId = "blockchain";
|
2016-04-13 18:03:57 +02:00
|
|
|
|
|
|
|
pub struct Hypervisor {
|
2016-04-14 20:45:53 +02:00
|
|
|
ipc_addr: String,
|
2016-04-14 17:22:31 +02:00
|
|
|
service: Arc<HypervisorService>,
|
2016-04-13 18:03:57 +02:00
|
|
|
ipc_worker: RwLock<nanoipc::Worker<HypervisorService>>,
|
2016-04-14 20:45:53 +02:00
|
|
|
processes: RwLock<HashMap<BinaryId, Child>>,
|
2016-04-13 18:03:57 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Hypervisor {
|
|
|
|
/// initializes the Hypervisor service with the open ipc socket for incoming clients
|
2016-04-14 20:45:53 +02:00
|
|
|
pub fn new() -> Hypervisor {
|
2016-04-14 17:22:31 +02:00
|
|
|
Hypervisor::with_url(HYPERVISOR_IPC_URL)
|
|
|
|
}
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Starts on the specified address for ipc listener
|
2016-04-14 20:45:53 +02:00
|
|
|
fn with_url(addr: &str) -> Hypervisor{
|
2016-04-14 17:49:25 +02:00
|
|
|
Hypervisor::with_url_and_service(addr, HypervisorService::new())
|
|
|
|
}
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Starts with the specified address for the ipc listener and
|
|
|
|
/// the specified list of modules in form of created service
|
2016-04-14 20:45:53 +02:00
|
|
|
fn with_url_and_service(addr: &str, service: Arc<HypervisorService>) -> Hypervisor {
|
|
|
|
let worker = nanoipc::Worker::new(&service);
|
|
|
|
Hypervisor{
|
|
|
|
ipc_addr: addr.to_owned(),
|
2016-04-14 17:22:31 +02:00
|
|
|
service: service,
|
|
|
|
ipc_worker: RwLock::new(worker),
|
2016-04-14 20:45:53 +02:00
|
|
|
processes: RwLock::new(HashMap::new()),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Since one binary can host multiple modules
|
|
|
|
/// we match binaries
|
|
|
|
fn match_module(module_id: &IpcModuleId) -> Option<BinaryId> {
|
|
|
|
match *module_id {
|
|
|
|
BLOCKCHAIN_MODULE_ID => Some(BLOCKCHAIN_DB_BINARY),
|
|
|
|
// none means the module is inside the main binary
|
|
|
|
_ => None
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Creates IPC listener and starts all binaries
|
2016-04-14 20:45:53 +02:00
|
|
|
fn start(&self) {
|
|
|
|
let mut worker = self.ipc_worker.write().unwrap();
|
|
|
|
worker.add_reqrep(&self.ipc_addr).unwrap_or_else(|e| panic!("Hypervisor ipc worker can not start - critical! ({:?})", e));
|
|
|
|
|
|
|
|
for module_id in self.service.module_ids() {
|
|
|
|
self.start_module(module_id);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Start binary for the specified module
|
|
|
|
/// Does nothing when it is already started on module is inside the
|
|
|
|
/// main binary
|
2016-04-14 20:45:53 +02:00
|
|
|
fn start_module(&self, module_id: IpcModuleId) {
|
2016-04-15 07:13:38 +02:00
|
|
|
Self::match_module(&module_id).map(|binary_id| {
|
|
|
|
let mut processes = self.processes.write().unwrap();
|
|
|
|
{
|
|
|
|
if processes.get(binary_id).is_some() {
|
|
|
|
// already started for another module
|
|
|
|
return;
|
2016-04-14 20:45:53 +02:00
|
|
|
}
|
2016-04-15 07:13:38 +02:00
|
|
|
}
|
|
|
|
let child = Command::new(binary_id).spawn().unwrap_or_else(
|
|
|
|
|e| panic!("Hypervisor cannot start binary: {}", e));
|
|
|
|
processes.insert(binary_id, child);
|
|
|
|
});
|
2016-04-13 18:03:57 +02:00
|
|
|
}
|
|
|
|
|
2016-04-14 20:50:35 +02:00
|
|
|
/// Reports if all modules are checked in
|
2016-04-14 17:22:31 +02:00
|
|
|
pub fn modules_ready(&self) -> bool {
|
|
|
|
self.service.unchecked_count() == 0
|
|
|
|
}
|
|
|
|
|
2016-04-13 18:03:57 +02:00
|
|
|
/// Waits for every required module to check in
|
2016-04-14 17:22:31 +02:00
|
|
|
pub fn wait_for_startup(&self) {
|
|
|
|
let mut worker = self.ipc_worker.write().unwrap();
|
|
|
|
while !self.modules_ready() {
|
|
|
|
worker.poll()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-04-21 13:12:43 +02:00
|
|
|
#[cfg(test)]
|
2016-04-14 17:22:31 +02:00
|
|
|
mod tests {
|
|
|
|
use super::*;
|
2016-04-14 17:49:25 +02:00
|
|
|
use std::sync::atomic::{AtomicBool,Ordering};
|
|
|
|
use std::sync::Arc;
|
|
|
|
use super::service::*;
|
|
|
|
use nanoipc;
|
2016-04-14 17:22:31 +02:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn can_init() {
|
2016-04-14 19:43:14 +02:00
|
|
|
let url = "ipc:///tmp/test-parity-hypervisor-10.ipc";
|
2016-04-14 19:56:06 +02:00
|
|
|
let test_module_id = 8080u64;
|
2016-04-14 17:49:25 +02:00
|
|
|
|
2016-04-14 19:56:06 +02:00
|
|
|
let hypervisor = Hypervisor::with_url_and_service(url, HypervisorService::with_modules(vec![test_module_id]));
|
2016-04-14 17:22:31 +02:00
|
|
|
assert_eq!(false, hypervisor.modules_ready());
|
|
|
|
}
|
2016-04-13 18:03:57 +02:00
|
|
|
|
2016-04-14 17:22:31 +02:00
|
|
|
#[test]
|
|
|
|
fn can_wait_for_startup() {
|
2016-04-14 19:43:14 +02:00
|
|
|
let url = "ipc:///tmp/test-parity-hypervisor-20.ipc";
|
2016-04-14 17:49:25 +02:00
|
|
|
let test_module_id = 8080u64;
|
|
|
|
|
|
|
|
let hypervisor_ready = Arc::new(AtomicBool::new(false));
|
|
|
|
let hypervisor_ready_local = hypervisor_ready.clone();
|
|
|
|
|
|
|
|
::std::thread::spawn(move || {
|
|
|
|
while !hypervisor_ready.load(Ordering::Relaxed) { }
|
|
|
|
|
|
|
|
let client = nanoipc::init_client::<HypervisorServiceClient<_>>(url).unwrap();
|
2016-04-14 19:43:14 +02:00
|
|
|
client.handshake().unwrap();
|
2016-04-14 17:49:25 +02:00
|
|
|
client.module_ready(test_module_id);
|
|
|
|
});
|
|
|
|
|
|
|
|
let hypervisor = Hypervisor::with_url_and_service(url, HypervisorService::with_modules(vec![test_module_id]));
|
2016-04-14 20:45:53 +02:00
|
|
|
hypervisor.start();
|
2016-04-14 17:49:25 +02:00
|
|
|
hypervisor_ready_local.store(true, Ordering::Relaxed);
|
2016-04-14 17:22:31 +02:00
|
|
|
hypervisor.wait_for_startup();
|
2016-04-14 17:49:25 +02:00
|
|
|
|
|
|
|
assert_eq!(true, hypervisor.modules_ready());
|
2016-04-13 18:03:57 +02:00
|
|
|
}
|
|
|
|
}
|