      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

    // Copyright 2015-2017 Parity Technologies (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/>.

    //! Creates and registers client and network services.

    use util::*;
    use io::*;
    use spec::Spec;
    use error::*;
    use client::{Client, ClientConfig, ChainNotify};
    use miner::Miner;

    use snapshot::ManifestData;
    use snapshot::service::{Service as SnapshotService, ServiceParams as SnapServiceParams};
    use std::sync::atomic::AtomicBool;

    #[cfg(feature="ipc")]
    use nanoipc;

    /// Message type for external and internal events
    #[derive(Clone, PartialEq, Eq, Debug)]
    pub enum ClientIoMessage {
    	/// Best Block Hash in chain has been changed
    	NewChainHead,
    	/// A block is ready
    	BlockVerified,
    	/// New transaction RLPs are ready to be imported
    	NewTransactions(Vec<Bytes>, usize),
    	/// Begin snapshot restoration
    	BeginRestoration(ManifestData),
    	/// Feed a state chunk to the snapshot service
    	FeedStateChunk(H256, Bytes),
    	/// Feed a block chunk to the snapshot service
    	FeedBlockChunk(H256, Bytes),
    	/// Take a snapshot for the block with given number.
    	TakeSnapshot(u64),
    	/// New consensus message received.
    	NewMessage(Bytes)
    }

    /// Client service setup. Creates and registers client and network services with the IO subsystem.
    pub struct ClientService {
    	io_service: Arc<IoService<ClientIoMessage>>,
    	client: Arc<Client>,
    	snapshot: Arc<SnapshotService>,
    	panic_handler: Arc<PanicHandler>,
    	_stop_guard: ::devtools::StopGuard,
    }

    impl ClientService {
    	/// Start the `ClientService`.
    	pub fn start(
    		config: ClientConfig,
    		spec: &Spec,
    		client_path: &Path,
    		snapshot_path: &Path,
    		ipc_path: &Path,
    		miner: Arc<Miner>,
    		) -> Result<ClientService, Error>
    	{
    		let panic_handler = PanicHandler::new_in_arc();
    		let io_service = IoService::<ClientIoMessage>::start()?;
    		panic_handler.forward_from(&io_service);

    		info!("Configured for {} using {} engine", Colour::White.bold().paint(spec.name.clone()), Colour::Yellow.bold().paint(spec.engine.name()));

    		let mut db_config = DatabaseConfig::with_columns(::db::NUM_COLUMNS);

    		// give all rocksdb cache to state column; everything else has its
    		// own caches.
    		if let Some(size) = config.db_cache_size {
    			db_config.set_cache(::db::COL_STATE, size);
    		}

    		db_config.compaction = config.db_compaction.compaction_profile(client_path);
    		db_config.wal = config.db_wal;

    		let pruning = config.pruning;
    		let client = Client::new(config, &spec, client_path, miner, io_service.channel(), &db_config)?;

    		let snapshot_params = SnapServiceParams {
    			engine: spec.engine.clone(),
    			genesis_block: spec.genesis_block(),
    			db_config: db_config.clone(),
    			pruning: pruning,
    			channel: io_service.channel(),
    			snapshot_root: snapshot_path.into(),
    			db_restore: client.clone(),
    		};
    		let snapshot = Arc::new(SnapshotService::new(snapshot_params)?);

    		panic_handler.forward_from(&*client);
    		let client_io = Arc::new(ClientIoHandler {
    			client: client.clone(),
    			snapshot: snapshot.clone(),
    		});
    		io_service.register_handler(client_io)?;

    		spec.engine.register_client(Arc::downgrade(&client));

    		let stop_guard = ::devtools::StopGuard::new();
    		run_ipc(ipc_path, client.clone(), snapshot.clone(), stop_guard.share());

    		Ok(ClientService {
    			io_service: Arc::new(io_service),
    			client: client,
    			snapshot: snapshot,
    			panic_handler: panic_handler,
    			_stop_guard: stop_guard,
    		})
    	}

    	/// Add a node to network
    	pub fn add_node(&mut self, _enode: &str) {
    		unimplemented!();
    	}

    	/// Get general IO interface
    	pub fn register_io_handler(&self, handler: Arc<IoHandler<ClientIoMessage> + Send>) -> Result<(), IoError> {
    		self.io_service.register_handler(handler)
    	}

    	/// Get client interface
    	pub fn client(&self) -> Arc<Client> {
    		self.client.clone()
    	}

    	/// Get snapshot interface.
    	pub fn snapshot_service(&self) -> Arc<SnapshotService> {
    		self.snapshot.clone()
    	}

    	/// Get network service component
    	pub fn io(&self) -> Arc<IoService<ClientIoMessage>> {
    		self.io_service.clone()
    	}

    	/// Set the actor to be notified on certain chain events
    	pub fn add_notify(&self, notify: Arc<ChainNotify>) {
    		self.client.add_notify(notify);
    	}
    }

    impl MayPanic for ClientService {
    	fn on_panic<F>(&self, closure: F) where F: OnPanicListener {
    		self.panic_handler.on_panic(closure);
    	}
    }

    /// IO interface for the Client handler
    struct ClientIoHandler {
    	client: Arc<Client>,
    	snapshot: Arc<SnapshotService>,
    }

    const CLIENT_TICK_TIMER: TimerToken = 0;
    const SNAPSHOT_TICK_TIMER: TimerToken = 1;

    const CLIENT_TICK_MS: u64 = 5000;
    const SNAPSHOT_TICK_MS: u64 = 10000;

    impl IoHandler<ClientIoMessage> for ClientIoHandler {
    	fn initialize(&self, io: &IoContext<ClientIoMessage>) {
    		io.register_timer(CLIENT_TICK_TIMER, CLIENT_TICK_MS).expect("Error registering client timer");
    		io.register_timer(SNAPSHOT_TICK_TIMER, SNAPSHOT_TICK_MS).expect("Error registering snapshot timer");
    	}

    	fn timeout(&self, _io: &IoContext<ClientIoMessage>, timer: TimerToken) {
    		match timer {
    			CLIENT_TICK_TIMER => self.client.tick(),
    			SNAPSHOT_TICK_TIMER => self.snapshot.tick(),
    			_ => warn!("IO service triggered unregistered timer '{}'", timer),
    		}
    	}

    	#[cfg_attr(feature="dev", allow(single_match))]
    	fn message(&self, _io: &IoContext<ClientIoMessage>, net_message: &ClientIoMessage) {
    		use std::thread;

    		match *net_message {
    			ClientIoMessage::BlockVerified => { self.client.import_verified_blocks(); }
    			ClientIoMessage::NewTransactions(ref transactions, peer_id) => {
    				self.client.import_queued_transactions(transactions, peer_id);
    			}
    			ClientIoMessage::BeginRestoration(ref manifest) => {
    				if let Err(e) = self.snapshot.init_restore(manifest.clone(), true) {
    					warn!("Failed to initialize snapshot restoration: {}", e);
    				}
    			}
    			ClientIoMessage::FeedStateChunk(ref hash, ref chunk) => self.snapshot.feed_state_chunk(*hash, chunk),
    			ClientIoMessage::FeedBlockChunk(ref hash, ref chunk) => self.snapshot.feed_block_chunk(*hash, chunk),
    			ClientIoMessage::TakeSnapshot(num) => {
    				let client = self.client.clone();
    				let snapshot = self.snapshot.clone();

    				let res = thread::Builder::new().name("Periodic Snapshot".into()).spawn(move || {
    					if let Err(e) = snapshot.take_snapshot(&*client, num) {
    						warn!("Failed to take snapshot at block #{}: {}", num, e);
    					}
    				});

    				if let Err(e) = res {
    					debug!(target: "snapshot", "Failed to initialize periodic snapshot thread: {:?}", e);
    				}
    			},
    			ClientIoMessage::NewMessage(ref message) => if let Err(e) = self.client.engine().handle_message(message) {
    				trace!(target: "poa", "Invalid message received: {}", e);
    			},
    			_ => {} // ignore other messages
    		}
    	}
    }

    #[cfg(feature="ipc")]
    fn run_ipc(base_path: &Path, client: Arc<Client>, snapshot_service: Arc<SnapshotService>, stop: Arc<AtomicBool>) {
    	let mut path = base_path.to_owned();
    	path.push("parity-chain.ipc");
    	let socket_addr = format!("ipc://{}", path.to_string_lossy());
    	let s = stop.clone();
    	::std::thread::spawn(move || {
    		let mut worker = nanoipc::Worker::new(&(client as Arc<BlockChainClient>));
    		worker.add_reqrep(&socket_addr).expect("Ipc expected to initialize with no issues");

    		while !s.load(::std::sync::atomic::Ordering::Relaxed) {
    			worker.poll();
    		}
    	});

    	let mut path = base_path.to_owned();
    	path.push("parity-snapshot.ipc");
    	let socket_addr = format!("ipc://{}", path.to_string_lossy());
    	::std::thread::spawn(move || {
    		let mut worker = nanoipc::Worker::new(&(snapshot_service as Arc<::snapshot::SnapshotService>));
    		worker.add_reqrep(&socket_addr).expect("Ipc expected to initialize with no issues");

    		while !stop.load(::std::sync::atomic::Ordering::Relaxed) {
    			worker.poll();
    		}
    	});
    }

    #[cfg(not(feature="ipc"))]
    fn run_ipc(_base_path: &Path, _client: Arc<Client>, _snapshot_service: Arc<SnapshotService>, _stop: Arc<AtomicBool>) {
    }

    #[cfg(test)]
    mod tests {
    	use super::*;
    	use tests::helpers::*;
    	use devtools::*;
    	use client::ClientConfig;
    	use std::sync::Arc;
    	use miner::Miner;

    	#[test]
    	fn it_can_be_started() {
    		let temp_path = RandomTempPath::new();
    		let path = temp_path.as_path().to_owned();
    		let client_path = {
    			let mut path = path.to_owned();
    			path.push("client");
    			path
    		};

    		let snapshot_path = {
    			let mut path = path.to_owned();
    			path.push("snapshot");
    			path
    		};

    		let spec = get_test_spec();
    		let service = ClientService::start(
    			ClientConfig::default(),
    			&spec,
    			&client_path,
    			&snapshot_path,
    			&path,
    			Arc::new(Miner::with_spec(&spec)),
    		);
    		assert!(service.is_ok());
    		drop(service.unwrap());
    		::std::thread::park_timeout(::std::time::Duration::from_millis(100));
    	}
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)