Track which element timeout was hit for in different categories
[dnsseed-rust] / src / main.rs
1 mod printer;
2 mod reader;
3 mod peer;
4 mod timeout_stream;
5 mod datastore;
6
7 use std::{cmp, env};
8 use std::collections::HashMap;
9 use std::sync::{Arc, Mutex};
10 use std::sync::atomic::{Ordering, AtomicBool};
11 use std::time::{Duration, Instant};
12 use std::net::{SocketAddr, ToSocketAddrs};
13
14 use bitcoin_hashes::sha256d;
15
16 use bitcoin::blockdata::block::Block;
17 use bitcoin::blockdata::constants::genesis_block;
18 use bitcoin::network::constants::Network;
19 use bitcoin::network::message::NetworkMessage;
20 use bitcoin::network::message_blockdata::{GetHeadersMessage, Inventory, InvType};
21 use bitcoin::util::hash::BitcoinHash;
22
23 use printer::{Printer, Stat};
24 use peer::Peer;
25 use datastore::{AddressState, Store, U64Setting, RegexSetting};
26 use timeout_stream::TimeoutStream;
27
28 use tokio::prelude::*;
29 use tokio::timer::Delay;
30
31 static mut REQUEST_BLOCK: Option<Box<Mutex<Arc<(u64, sha256d::Hash, Block)>>>> = None;
32 static mut HIGHEST_HEADER: Option<Box<Mutex<(sha256d::Hash, u64)>>> = None;
33 static mut HEADER_MAP: Option<Box<Mutex<HashMap<sha256d::Hash, u64>>>> = None;
34 static mut HEIGHT_MAP: Option<Box<Mutex<HashMap<u64, sha256d::Hash>>>> = None;
35 static mut DATA_STORE: Option<Box<Store>> = None;
36 static mut PRINTER: Option<Box<Printer>> = None;
37 pub static START_SHUTDOWN: AtomicBool = AtomicBool::new(false);
38 static SCANNING: AtomicBool = AtomicBool::new(false);
39
40 struct PeerState {
41         request: Arc<(u64, sha256d::Hash, Block)>,
42         node_services: u64,
43         msg: (String, bool),
44         fail_reason: AddressState,
45         recvd_version: bool,
46         recvd_verack: bool,
47         recvd_addrs: bool,
48         recvd_block: bool,
49 }
50
51 pub fn scan_node(scan_time: Instant, node: SocketAddr, manual: bool) {
52         if START_SHUTDOWN.load(Ordering::Relaxed) { return; }
53         let printer = unsafe { PRINTER.as_ref().unwrap() };
54         let store = unsafe { DATA_STORE.as_ref().unwrap() };
55
56         let peer_state = Arc::new(Mutex::new(PeerState {
57                 recvd_version: false,
58                 recvd_verack: false,
59                 recvd_addrs: false,
60                 recvd_block: false,
61                 node_services: 0,
62                 fail_reason: AddressState::Timeout,
63                 msg: (String::new(), false),
64                 request: Arc::clone(&unsafe { REQUEST_BLOCK.as_ref().unwrap() }.lock().unwrap()),
65         }));
66         let final_peer_state = Arc::clone(&peer_state);
67
68         let peer = Delay::new(scan_time).then(move |_| {
69                 printer.set_stat(Stat::NewConnection);
70                 let timeout = store.get_u64(U64Setting::RunTimeout);
71                 Peer::new(node.clone(), Duration::from_secs(timeout), printer)
72         });
73         tokio::spawn(peer.and_then(move |(mut write, read)| {
74                 TimeoutStream::new_timeout(read, scan_time + Duration::from_secs(store.get_u64(U64Setting::RunTimeout))).map_err(|_| { () }).for_each(move |msg| {
75                         let mut state_lock = peer_state.lock().unwrap();
76                         macro_rules! check_set_flag {
77                                 ($recvd_flag: ident, $msg: expr) => { {
78                                         if state_lock.$recvd_flag {
79                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
80                                                 state_lock.msg = (format!("due to dup {}", $msg), true);
81                                                 state_lock.$recvd_flag = false;
82                                                 return future::err(());
83                                         }
84                                         state_lock.$recvd_flag = true;
85                                 } }
86                         }
87                         state_lock.fail_reason = AddressState::TimeoutDuringRequest;
88                         match msg {
89                                 NetworkMessage::Version(ver) => {
90                                         if ver.start_height < 0 || ver.start_height as u64 > state_lock.request.0 + 1008*2 {
91                                                 state_lock.fail_reason = AddressState::HighBlockCount;
92                                                 return future::err(());
93                                         }
94                                         let safe_ua = ver.user_agent.replace(|c: char| !c.is_ascii() || c < ' ' || c > '~', "");
95                                         if (ver.start_height as u64) < state_lock.request.0 {
96                                                 state_lock.msg = (format!("({} < {})", ver.start_height, state_lock.request.0), true);
97                                                 state_lock.fail_reason = AddressState::LowBlockCount;
98                                                 return future::err(());
99                                         }
100                                         let min_version = store.get_u64(U64Setting::MinProtocolVersion);
101                                         if (ver.version as u64) < min_version {
102                                                 state_lock.msg = (format!("({} < {})", ver.version, min_version), true);
103                                                 state_lock.fail_reason = AddressState::LowVersion;
104                                                 return future::err(());
105                                         }
106                                         if ver.services & (1 | (1 << 10)) == 0 {
107                                                 state_lock.msg = (format!("({}: services {:x})", safe_ua, ver.services), true);
108                                                 state_lock.fail_reason = AddressState::NotFullNode;
109                                                 return future::err(());
110                                         }
111                                         if !store.get_regex(RegexSetting::SubverRegex).is_match(&ver.user_agent) {
112                                                 state_lock.msg = (format!("subver {}", safe_ua), true);
113                                                 state_lock.fail_reason = AddressState::BadVersion;
114                                                 return future::err(());
115                                         }
116                                         check_set_flag!(recvd_version, "version");
117                                         state_lock.node_services = ver.services;
118                                         state_lock.msg = (format!("(subver: {})", safe_ua), false);
119                                         if let Err(_) = write.try_send(NetworkMessage::Verack) {
120                                                 return future::err(());
121                                         }
122                                 },
123                                 NetworkMessage::Verack => {
124                                         check_set_flag!(recvd_verack, "verack");
125                                         if let Err(_) = write.try_send(NetworkMessage::GetAddr) {
126                                                 return future::err(());
127                                         }
128                                 },
129                                 NetworkMessage::Ping(v) => {
130                                         if let Err(_) = write.try_send(NetworkMessage::Pong(v)) {
131                                                 return future::err(())
132                                         }
133                                 },
134                                 NetworkMessage::Addr(addrs) => {
135                                         if addrs.len() > 1000 {
136                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
137                                                 state_lock.msg = (format!("due to oversized addr: {}", addrs.len()), true);
138                                                 state_lock.recvd_addrs = false;
139                                                 return future::err(());
140                                         }
141                                         if !state_lock.recvd_addrs {
142                                                 if let Err(_) = write.try_send(NetworkMessage::GetData(vec![Inventory {
143                                                         inv_type: InvType::WitnessBlock,
144                                                         hash: state_lock.request.1,
145                                                 }])) {
146                                                         return future::err(());
147                                                 }
148                                         }
149                                         state_lock.recvd_addrs = true;
150                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
151                                 },
152                                 NetworkMessage::Block(block) => {
153                                         if block != state_lock.request.2 {
154                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
155                                                 state_lock.msg = ("due to bad block".to_string(), true);
156                                                 return future::err(());
157                                         }
158                                         check_set_flag!(recvd_block, "block");
159                                         return future::err(());
160                                 },
161                                 _ => {},
162                         }
163                         future::ok(())
164                 }).then(|_| {
165                         future::err(())
166                 })
167         }).then(move |_: Result<(), ()>| {
168                 let printer = unsafe { PRINTER.as_ref().unwrap() };
169                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
170                 printer.set_stat(Stat::ConnectionClosed);
171
172                 let mut state_lock = final_peer_state.lock().unwrap();
173                 if state_lock.recvd_version && state_lock.recvd_verack &&
174                                 state_lock.recvd_addrs && state_lock.recvd_block {
175                         let old_state = store.set_node_state(node, AddressState::Good, state_lock.node_services);
176                         if manual || (old_state != AddressState::Good && state_lock.msg.0 != "") {
177                                 printer.add_line(format!("Updating {} from {} to Good {}", node, old_state.to_str(), &state_lock.msg.0), state_lock.msg.1);
178                         }
179                 } else {
180                         assert!(state_lock.fail_reason != AddressState::Good);
181                         if state_lock.fail_reason == AddressState::TimeoutDuringRequest && state_lock.recvd_version && state_lock.recvd_verack {
182                                 if !state_lock.recvd_addrs {
183                                         state_lock.fail_reason = AddressState::TimeoutAwaitingAddr;
184                                 } else if !state_lock.recvd_block {
185                                         state_lock.fail_reason = AddressState::TimeoutAwaitingBlock;
186                                 }
187                         }
188                         let old_state = store.set_node_state(node, state_lock.fail_reason, 0);
189                         if (manual || old_state != state_lock.fail_reason) && state_lock.fail_reason == AddressState::TimeoutDuringRequest {
190                                 printer.add_line(format!("Updating {} from {} to Timeout During Request (ver: {}, vack: {})",
191                                         node, old_state.to_str(), state_lock.recvd_version, state_lock.recvd_verack), true);
192                         } else if manual || (old_state != state_lock.fail_reason && state_lock.msg.0 != "" && state_lock.msg.1) {
193                                 printer.add_line(format!("Updating {} from {} to {} {}", node, old_state.to_str(), state_lock.fail_reason.to_str(), &state_lock.msg.0), state_lock.msg.1);
194                         }
195                 }
196                 future::ok(())
197         }));
198 }
199
200 fn poll_dnsseeds() {
201         tokio::spawn(future::lazy(|| {
202                 let printer = unsafe { PRINTER.as_ref().unwrap() };
203                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
204
205                 let mut new_addrs = 0;
206                 for seed in ["seed.bitcoin.sipa.be", "dnsseed.bitcoin.dashjr.org", "seed.bitcoinstats.com", "seed.bitcoin.jonasschnelli.ch", "seed.btc.petertodd.org", "seed.bitcoin.sprovoost.nl", "dnsseed.emzy.de"].iter() {
207                         new_addrs += store.add_fresh_addrs((*seed, 8333u16).to_socket_addrs().unwrap_or(Vec::new().into_iter()));
208                         new_addrs += store.add_fresh_addrs((("x9.".to_string() + seed).as_str(), 8333u16).to_socket_addrs().unwrap_or(Vec::new().into_iter()));
209                 }
210                 printer.add_line(format!("Added {} new addresses from other DNS seeds", new_addrs), false);
211                 Delay::new(Instant::now() + Duration::from_secs(60)).then(|_| {
212                         if !START_SHUTDOWN.load(Ordering::Relaxed) {
213                                 poll_dnsseeds();
214                         }
215                         future::ok(())
216                 })
217         }));
218 }
219
220 fn scan_net() {
221         tokio::spawn(future::lazy(|| {
222                 let printer = unsafe { PRINTER.as_ref().unwrap() };
223                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
224
225                 let mut scan_nodes = store.get_next_scan_nodes();
226                 printer.add_line(format!("Got {} addresses to scan", scan_nodes.len()), false);
227                 let per_iter_time = Duration::from_millis(1000 / store.get_u64(U64Setting::ConnsPerSec));
228                 let start_time = Instant::now();
229                 let mut iter_time = start_time;
230
231                 for node in scan_nodes.drain(..) {
232                         scan_node(iter_time, node, false);
233                         iter_time += per_iter_time;
234                 }
235                 Delay::new(cmp::max(iter_time, start_time + Duration::from_secs(15))).then(|_| {
236                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
237                         store.save_data().then(|_| {
238                                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
239                                         scan_net();
240                                 }
241                                 future::ok(())
242                         })
243                 })
244         }));
245 }
246
247 fn make_trusted_conn(trusted_sockaddr: SocketAddr) {
248         let printer = unsafe { PRINTER.as_ref().unwrap() };
249         let trusted_peer = Peer::new(trusted_sockaddr.clone(), Duration::from_secs(600), printer);
250         tokio::spawn(trusted_peer.and_then(move |(mut trusted_write, trusted_read)| {
251                 printer.add_line("Connected to local peer".to_string(), false);
252                 let mut starting_height = 0;
253                 TimeoutStream::new_persistent(trusted_read, Duration::from_secs(600)).map_err(|_| { () }).for_each(move |msg| {
254                         if START_SHUTDOWN.load(Ordering::Relaxed) {
255                                 return future::err(());
256                         }
257                         match msg {
258                                 NetworkMessage::Version(ver) => {
259                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Verack) {
260                                                 return future::err(())
261                                         }
262                                         starting_height = ver.start_height;
263                                 },
264                                 NetworkMessage::Verack => {
265                                         if let Err(_) = trusted_write.try_send(NetworkMessage::SendHeaders) {
266                                                 return future::err(());
267                                         }
268                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
269                                                 version: 70015,
270                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
271                                                 stop_hash: Default::default(),
272                                         })) {
273                                                 return future::err(());
274                                         }
275                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetAddr) {
276                                                 return future::err(());
277                                         }
278                                 },
279                                 NetworkMessage::Addr(addrs) => {
280                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
281                                 },
282                                 NetworkMessage::Headers(headers) => {
283                                         if headers.is_empty() {
284                                                 return future::ok(());
285                                         }
286                                         let mut header_map = unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap();
287                                         let mut height_map = unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap();
288
289                                         if let Some(height) = header_map.get(&headers[0].prev_blockhash).cloned() {
290                                                 for i in 0..headers.len() {
291                                                         let hash = headers[i].bitcoin_hash();
292                                                         if i < headers.len() - 1 && headers[i + 1].prev_blockhash != hash {
293                                                                 return future::err(());
294                                                         }
295                                                         header_map.insert(headers[i].bitcoin_hash(), height + 1 + (i as u64));
296                                                         height_map.insert(height + 1 + (i as u64), headers[i].bitcoin_hash());
297                                                 }
298
299                                                 let top_height = height + headers.len() as u64;
300                                                 *unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap()
301                                                         = (headers.last().unwrap().bitcoin_hash(), top_height);
302                                                 printer.set_stat(printer::Stat::HeaderCount(top_height));
303
304                                                 if top_height >= starting_height as u64 {
305                                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetData(vec![Inventory {
306                                                                 inv_type: InvType::WitnessBlock,
307                                                                 hash: height_map.get(&(top_height - 1008)).unwrap().clone(),
308                                                         }])) {
309                                                                 return future::err(());
310                                                         }
311                                                 }
312                                         } else {
313                                                 // Wat? Lets start again...
314                                                 printer.add_line("Got unconnected headers message from local trusted peer".to_string(), true);
315                                         }
316                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
317                                                 version: 70015,
318                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
319                                                 stop_hash: Default::default(),
320                                         })) {
321                                                 return future::err(())
322                                         }
323                                 },
324                                 NetworkMessage::Block(block) => {
325                                         let hash = block.header.bitcoin_hash();
326                                         let header_map = unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap();
327                                         let height = *header_map.get(&hash).expect("Got loose block from trusted peer we coulnd't have requested");
328                                         if height == unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().1 - 1008 {
329                                                 *unsafe { REQUEST_BLOCK.as_ref().unwrap() }.lock().unwrap() = Arc::new((height, hash, block));
330                                                 if !SCANNING.swap(true, Ordering::SeqCst) {
331                                                         scan_net();
332                                                         poll_dnsseeds();
333                                                 }
334                                         }
335                                 },
336                                 NetworkMessage::Ping(v) => {
337                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Pong(v)) {
338                                                 return future::err(())
339                                         }
340                                 },
341                                 _ => {},
342                         }
343                         future::ok(())
344                 }).then(|_| {
345                         future::err(())
346                 })
347         }).then(move |_: Result<(), ()>| {
348                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
349                         printer.add_line("Lost connection from trusted peer".to_string(), true);
350                         make_trusted_conn(trusted_sockaddr);
351                 }
352                 future::ok(())
353         }));
354 }
355
356 fn main() {
357         if env::args().len() != 3 {
358                 println!("USAGE: dnsseed-rust datastore localPeerAddress");
359                 return;
360         }
361
362         unsafe { HEADER_MAP = Some(Box::new(Mutex::new(HashMap::with_capacity(600000)))) };
363         unsafe { HEIGHT_MAP = Some(Box::new(Mutex::new(HashMap::with_capacity(600000)))) };
364         unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap().insert(genesis_block(Network::Bitcoin).bitcoin_hash(), 0);
365         unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap().insert(0, genesis_block(Network::Bitcoin).bitcoin_hash());
366         unsafe { HIGHEST_HEADER = Some(Box::new(Mutex::new((genesis_block(Network::Bitcoin).bitcoin_hash(), 0)))) };
367         unsafe { REQUEST_BLOCK = Some(Box::new(Mutex::new(Arc::new((0, genesis_block(Network::Bitcoin).bitcoin_hash(), genesis_block(Network::Bitcoin)))))) };
368
369         let trt = tokio::runtime::Builder::new()
370                 .blocking_threads(2).core_threads(num_cpus::get().max(1) * 3)
371                 .build().unwrap();
372
373         let _ = trt.block_on_all(future::lazy(|| {
374                 let mut args = env::args();
375                 args.next();
376                 let path = args.next().unwrap();
377                 let addr = args.next().unwrap();
378
379                 Store::new(path).and_then(move |store| {
380                         unsafe { DATA_STORE = Some(Box::new(store)) };
381                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
382                         unsafe { PRINTER = Some(Box::new(Printer::new(store))) };
383
384                         let trusted_sockaddr: SocketAddr = addr.parse().unwrap();
385                         make_trusted_conn(trusted_sockaddr);
386
387                         reader::read(store, unsafe { PRINTER.as_ref().unwrap() });
388
389                         future::ok(())
390                 }).or_else(|_| {
391                         future::err(())
392                 })
393         }));
394
395         tokio::run(future::lazy(|| {
396                 unsafe { DATA_STORE.as_ref().unwrap() }.save_data()
397         }));
398 }