3 * most of the swift's state machine
5 * Created by Victor Grishchenko on 3/6/09.
6 * Copyright 2009 Delft University of Technology. All rights reserved.
10 #include <algorithm> // kill it
12 using namespace swift;
18 - randomized testing of advanced ops (new testcase)
21 void Channel::AddPeakHashes (Datagram& dgram) {
22 for(int i=0; i<file().peak_count(); i++) {
23 bin64_t peak = file().peak(i);
24 dgram.Push8(SWIFT_HASH);
25 dgram.Push32((uint32_t)peak);
26 dgram.PushHash(file().peak_hash(i));
27 dprintf("%s #%u +phash %s\n",tintstr(),id_,peak.str());
32 void Channel::AddUncleHashes (Datagram& dgram, bin64_t pos) {
33 bin64_t peak = file().peak_for(pos);
34 while (pos!=peak && ((NOW&3)==3 || !data_out_cap_.within(pos.parent())) &&
35 ack_in_.get(pos.parent())==binmap_t::EMPTY ) {
36 bin64_t uncle = pos.sibling();
37 dgram.Push8(SWIFT_HASH);
38 dgram.Push32((uint32_t)uncle);
39 dgram.PushHash( file().hash(uncle) );
40 dprintf("%s #%u +hash %s\n",tintstr(),id_,uncle.str());
46 bin64_t Channel::ImposeHint () {
47 uint64_t twist = peer_channel_id_; // got no hints, send something randomly
48 twist &= file().peak(0); // FIXME may make it semi-seq here
49 file().ack_out().twist(twist);
52 file().ack_out().find_filtered(ack_in_,bin64_t::ALL,binmap_t::FILLED);
53 while (my_pick.width()>max(1,(int)cwnd_))
54 my_pick = my_pick.left();
55 file().ack_out().twist(0);
57 return my_pick.twisted(twist);
61 bin64_t Channel::DequeueHint () {
62 if (hint_in_.empty() && last_recv_time_>NOW-rtt_avg_-TINT_SEC) {
63 bin64_t my_pick = ImposeHint(); // FIXME move to the loop
64 if (my_pick!=bin64_t::NONE) {
65 hint_in_.push_back(my_pick);
66 dprintf("%s #%u *hint %s\n",tintstr(),id_,my_pick.str());
69 bin64_t send = bin64_t::NONE;
70 while (!hint_in_.empty() && send==bin64_t::NONE) {
71 bin64_t hint = hint_in_.front().bin;
72 tint time = hint_in_.front().time;
74 while (!hint.is_base()) { // FIXME optimize; possible attack
75 hint_in_.push_front(tintbin(time,hint.right()));
78 //if (time < NOW-TINT_SEC*3/2 )
80 if (ack_in_.get(hint)!=binmap_t::FILLED)
84 for(int i=0; i<hint_in_.size(); i++)
85 mass += hint_in_[i].bin.width();
86 dprintf("%s #%u dequeued %s [%lli]\n",tintstr(),id_,send.str(),mass);
91 void Channel::AddHandshake (Datagram& dgram) {
92 if (!peer_channel_id_) { // initiating
93 dgram.Push8(SWIFT_HASH);
94 dgram.Push32(bin64_t::ALL32);
95 dgram.PushHash(file().root_hash());
96 dprintf("%s #%u +hash ALL %s\n",
97 tintstr(),id_,file().root_hash().hex().c_str());
99 dgram.Push8(SWIFT_HANDSHAKE);
100 int encoded = EncodeID(id_);
101 dgram.Push32(encoded);
102 dprintf("%s #%u +hs %x\n",tintstr(),id_,encoded);
108 void Channel::Send () {
109 Datagram dgram(socket_,peer());
110 dgram.Push32(peer_channel_id_);
111 bin64_t data = bin64_t::NONE;
112 if ( is_established() ) {
113 // FIXME: seeder check
116 if (!file().is_complete())
120 data = AddData(dgram);
126 dprintf("%s #%u sent %ib %s:%x\n",
127 tintstr(),id_,dgram.size(),peer().str(),peer_channel_id_);
128 if (dgram.size()==4) {// only the channel id; bare keep-alive
131 if (dgram.Send()==-1)
132 print_error("can't send datagram");
133 last_send_time_ = NOW;
140 void Channel::AddHint (Datagram& dgram) {
142 tint plan_for = max(TINT_SEC,rtt_avg_*4);
144 tint timed_out = NOW - plan_for*2;
145 while ( !hint_out_.empty() && hint_out_.front().time < timed_out ) {
146 hint_out_size_ -= hint_out_.front().bin.width();
147 hint_out_.pop_front();
150 int plan_pck = max ( (tint)1, plan_for / dip_avg_ );
152 if ( hint_out_size_ < plan_pck ) {
154 int diff = plan_pck - hint_out_size_; // TODO: aggregate
155 bin64_t hint = transfer().picker().Pick(ack_in_,diff,NOW+plan_for*2);
157 if (hint!=bin64_t::NONE) {
158 dgram.Push8(SWIFT_HINT);
160 dprintf("%s #%u +hint %s [%lli]\n",tintstr(),id_,hint.str(),hint_out_size_);
161 hint_out_.push_back(hint);
162 hint_out_size_ += hint.width();
164 dprintf("%s #%u Xhint\n",tintstr(),id_);
170 bin64_t Channel::AddData (Datagram& dgram) {
172 if (!file().size()) // know nothing
173 return bin64_t::NONE;
175 bin64_t tosend = bin64_t::NONE;
176 tint luft = send_interval_>>4; // may wake up a bit earlier
177 if (data_out_.size()<cwnd_ &&
178 last_data_out_time_+send_interval_<=NOW+luft) {
179 tosend = DequeueHint();
180 if (tosend==bin64_t::NONE) {
181 dprintf("%s #%u sendctrl no idea what to send\n",tintstr(),id_);
182 if (send_control_!=KEEP_ALIVE_CONTROL)
183 SwitchSendControl(KEEP_ALIVE_CONTROL);
186 dprintf("%s #%u sendctrl wait cwnd %f data_out %i next %s\n",
187 tintstr(),id_,cwnd_,(int)data_out_.size(),tintstr(last_data_out_time_+NOW-send_interval_));
189 if (tosend==bin64_t::NONE)// && (last_data_out_time_>NOW-TINT_SEC || data_out_.empty()))
190 return bin64_t::NONE; // once in a while, empty data is sent just to check rtt FIXED
192 if (ack_in_.is_empty() && file().size())
193 AddPeakHashes(dgram);
194 AddUncleHashes(dgram,tosend);
195 if (!ack_in_.is_empty()) // TODO: cwnd_>1
196 data_out_cap_ = tosend;
198 if (dgram.size()>254) {
199 dgram.Send(); // kind of fragmentation
200 dgram.Push32(peer_channel_id_);
203 dgram.Push8(SWIFT_DATA);
204 dgram.Push32(tosend.to32());
207 size_t r = pread(file().file_descriptor(),buf,1024,tosend.base_offset()<<10);
208 // TODO: corrupted data, retries, caching
210 print_error("error on reading");
211 return bin64_t::NONE;
213 assert(dgram.space()>=r+4+1);
216 last_data_out_time_ = NOW;
217 data_out_.push_back(tosend);
218 dprintf("%s #%u +data %s\n",tintstr(),id_,tosend.str());
224 void Channel::AddAck (Datagram& dgram) {
225 if (data_in_==tintbin())
227 dgram.Push8(SWIFT_ACK);
228 dgram.Push32(data_in_.bin.to32()); // FIXME not cover
229 dgram.Push64(data_in_.time); // FIXME 32
230 have_out_.set(data_in_.bin);
231 dprintf("%s #%u +ack %s %s\n",
232 tintstr(),id_,data_in_.bin.str(),tintstr(data_in_.time));
233 if (data_in_.bin.layer()>2)
234 data_in_dbl_ = data_in_.bin;
235 data_in_ = tintbin();
239 void Channel::AddHave (Datagram& dgram) {
240 if (data_in_dbl_!=bin64_t::NONE) { // TODO: do redundancy better
241 dgram.Push8(SWIFT_HAVE);
242 dgram.Push32(data_in_dbl_.to32());
243 data_in_dbl_=bin64_t::NONE;
245 for(int count=0; count<4; count++) {
246 bin64_t ack = file().ack_out().find_filtered // FIXME: do rotating queue
247 (have_out_, bin64_t::ALL, binmap_t::FILLED);
248 if (ack==bin64_t::NONE)
250 ack = file().ack_out().cover(ack);
252 dgram.Push8(SWIFT_HAVE);
253 dgram.Push32(ack.to32());
254 dprintf("%s #%u +have %s\n",tintstr(),id_,ack.str());
259 void Channel::Recv (Datagram& dgram) {
260 dprintf("%s #%u recvd %ib\n",tintstr(),id_,dgram.size()+4);
262 if (last_send_time_ && rtt_avg_==TINT_SEC && dev_avg_==0) {
263 rtt_avg_ = NOW - last_send_time_;
266 dprintf("%s #%u sendctrl rtt init %lli\n",tintstr(),id_,rtt_avg_);
268 bin64_t data = dgram.size() ? bin64_t::NONE : bin64_t::ALL;
269 while (dgram.size()) {
270 uint8_t type = dgram.Pull8();
272 case SWIFT_HANDSHAKE: OnHandshake(dgram); break;
273 case SWIFT_DATA: data=OnData(dgram); break;
274 case SWIFT_HAVE: OnHave(dgram); break;
275 case SWIFT_ACK: OnAck(dgram); break;
276 case SWIFT_HASH: OnHash(dgram); break;
277 case SWIFT_HINT: OnHint(dgram); break;
278 case SWIFT_PEX_ADD: OnPex(dgram); break;
280 eprintf("%s #%u ?msg id unknown %i\n",tintstr(),id_,(int)type);
284 last_recv_time_ = NOW;
285 sent_since_recv_ = 0;
290 void Channel::OnHash (Datagram& dgram) {
291 bin64_t pos = dgram.Pull32();
292 Sha1Hash hash = dgram.PullHash();
293 file().OfferHash(pos,hash);
294 dprintf("%s #%u -hash %s\n",tintstr(),id_,pos.str());
298 void Channel::CleanHintOut (bin64_t pos) {
300 while (hi<hint_out_.size() && !pos.within(hint_out_[hi].bin))
302 if (hi==hint_out_.size())
303 return; // something not hinted or hinted in far past
304 while (hi--) { // removing likely snubbed hints
305 hint_out_size_ -= hint_out_.front().bin.width();
306 hint_out_.pop_front();
308 while (hint_out_.front().bin!=pos) {
309 tintbin f = hint_out_.front();
310 f.bin = f.bin.towards(pos);
311 hint_out_.front().bin = f.bin.sibling();
312 hint_out_.push_front(f);
314 hint_out_.pop_front();
319 bin64_t Channel::OnData (Datagram& dgram) { // TODO: HAVE NONE for corrupted data
320 bin64_t pos = dgram.Pull32();
322 int length = dgram.Pull(&data,1024);
323 bool ok = (pos==bin64_t::NONE) || file().OfferData(pos, (char*)data, length) ;
324 dprintf("%s #%u %cdata %s\n",tintstr(),id_,ok?'-':'!',pos.str());
325 data_in_ = tintbin(NOW,bin64_t::NONE);
327 return bin64_t::NONE;
328 bin64_t cover = transfer().ack_out().cover(pos);
329 for(int i=0; i<transfer().cb_installed; i++)
330 if (cover.layer()>=transfer().cb_agg[i])
331 transfer().callbacks[i](transfer().fd(),pos); // FIXME
333 if (pos!=bin64_t::NONE) {
334 if (last_data_in_time_) {
335 tint dip = NOW - last_data_in_time_;
336 dip_avg_ = ( dip_avg_*3 + dip ) >> 2;
338 last_data_in_time_ = NOW;
345 void Channel::OnAck (Datagram& dgram) {
346 bin64_t ackd_pos = dgram.Pull32();
347 tint peer_time = dgram.Pull64(); // FIXME 32
348 // FIXME FIXME: wrap around here
349 if (ackd_pos==bin64_t::NONE)
350 return; // likely, brocken packet / insufficient hashes
351 if (file().size() && ackd_pos.base_offset()>=file().packet_size()) {
352 eprintf("invalid ack: %s\n",ackd_pos.str());
355 ack_in_.set(ackd_pos);
357 // find an entry for the send (data out) event
358 while ( di<data_out_.size() && ( data_out_[di]==tintbin() ||
359 !data_out_[di].bin.within(ackd_pos) ) )
361 // FUTURE: delayed acks
362 // rule out retransmits
363 while ( ri<data_out_tmo_.size() && !data_out_tmo_[ri].bin.within(ackd_pos) )
365 dprintf("%s #%u %cack %s %lli\n",tintstr(),id_,
366 di==data_out_.size()?'?':'-',ackd_pos.str(),peer_time);
367 if (di!=data_out_.size() && ri==data_out_tmo_.size()) { // not a retransmit
368 // round trip time calculations
369 tint rtt = NOW-data_out_[di].time;
370 rtt_avg_ = (rtt_avg_*7 + rtt) >> 3;
371 dev_avg_ = ( dev_avg_*3 + ::abs(rtt-rtt_avg_) ) >> 2;
372 assert(data_out_[di].time!=TINT_NEVER);
373 // one-way delay calculations
374 tint owd = peer_time - data_out_[di].time;
375 owd_cur_bin_ = 0;//(owd_cur_bin_+1) & 3;
376 owd_current_[owd_cur_bin_] = owd;
377 if ( owd_min_bin_start_+TINT_SEC*30 < NOW ) {
378 owd_min_bin_start_ = NOW;
379 owd_min_bin_ = (owd_min_bin_+1) & 3;
380 owd_min_bins_[owd_min_bin_] = TINT_NEVER;
382 if (owd_min_bins_[owd_min_bin_]>owd)
383 owd_min_bins_[owd_min_bin_] = owd;
384 dprintf("%s #%u sendctrl rtt %lli dev %lli based on %s\n",
385 tintstr(),id_,rtt_avg_,dev_avg_,data_out_[di].bin.str());
387 // early loss detection by packet reordering
388 for (int re=0; re<di-MAX_REORDERING; re++) {
389 if (data_out_[re]==tintbin())
391 ack_not_rcvd_recent_++;
392 data_out_tmo_.push_back(data_out_[re].bin);
393 dprintf("%s #%u Rdata %s\n",tintstr(),id_,data_out_.front().bin.str());
394 data_out_cap_ = bin64_t::ALL;
395 data_out_[re] = tintbin();
398 if (di!=data_out_.size())
399 data_out_[di]=tintbin();
400 // clear zeroed items
401 while (!data_out_.empty() && ( data_out_.front()==tintbin() ||
402 ack_in_.is_filled(data_out_.front().bin) ) )
403 data_out_.pop_front();
404 assert(data_out_.empty() || data_out_.front().time!=TINT_NEVER);
408 void Channel::TimeoutDataOut ( ) {
409 // losses: timeouted packets
410 tint timeout = NOW - ack_timeout();
411 while (!data_out_.empty() &&
412 ( data_out_.front().time<timeout || data_out_.front()==tintbin() ) ) {
413 if (data_out_.front()!=tintbin() && ack_in_.is_empty(data_out_.front().bin)) {
414 ack_not_rcvd_recent_++;
415 data_out_cap_ = bin64_t::ALL;
416 data_out_tmo_.push_back(data_out_.front().bin);
417 dprintf("%s #%u Tdata %s\n",tintstr(),id_,data_out_.front().bin.str());
419 data_out_.pop_front();
421 // clear retransmit queue of older items
422 while (!data_out_tmo_.empty() && data_out_tmo_.front().time<NOW-MAX_POSSIBLE_RTT)
423 data_out_tmo_.pop_front();
427 void Channel::OnHave (Datagram& dgram) {
428 bin64_t ackd_pos = dgram.Pull32();
429 if (ackd_pos==bin64_t::NONE)
430 return; // wow, peer has hashes
431 ack_in_.set(ackd_pos);
432 dprintf("%s #%u -have %s\n",tintstr(),id_,ackd_pos.str());
436 void Channel::OnHint (Datagram& dgram) {
437 bin64_t hint = dgram.Pull32();
438 // FIXME: wake up here
439 hint_in_.push_back(hint);
440 dprintf("%s #%u -hint %s\n",tintstr(),id_,hint.str());
444 void Channel::OnHandshake (Datagram& dgram) {
445 peer_channel_id_ = dgram.Pull32();
446 dprintf("%s #%u -hs %x\n",tintstr(),id_,peer_channel_id_);
447 // self-connection check
449 uint32_t try_id = DecodeID(peer_channel_id_);
450 if (channel(try_id) && !channel(try_id)->peer_channel_id_) {
451 peer_channel_id_ = 0;
453 return; // this is a self-connection
456 // FUTURE: channel forking
460 void Channel::OnPex (Datagram& dgram) {
461 uint32_t ipv4 = dgram.Pull32();
462 uint16_t port = dgram.Pull16();
463 Address addr(ipv4,port);
464 dprintf("%s #%u -pex %s\n",tintstr(),id_,addr.str());
465 transfer().OnPexIn(addr);
469 void Channel::AddPex (Datagram& dgram) {
470 int chid = transfer().RevealChannel(pex_out_);
471 if (chid==-1 || chid==id_)
473 Address a = channels[chid]->peer();
474 dgram.Push8(SWIFT_PEX_ADD);
475 dgram.Push32(a.ipv4());
476 dgram.Push16(a.port());
477 dprintf("%s #%u +pex %s\n",tintstr(),id_,a.str());
481 void Channel::RecvDatagram (SOCKET socket) {
482 Datagram data(socket);
484 const Address& addr = data.address();
485 #define return_log(...) { fprintf(stderr,__VA_ARGS__); return; }
487 return_log("datagram shorter than 4 bytes %s\n",addr.str());
488 uint32_t mych = data.Pull32();
490 Channel* channel = NULL;
491 if (mych==0) { // handshake initiated
492 if (data.size()<1+4+1+4+Sha1Hash::SIZE)
493 return_log ("%s #0 incorrect size %i initial handshake packet %s\n",
494 tintstr(),data.size(),addr.str());
495 uint8_t hashid = data.Pull8();
496 if (hashid!=SWIFT_HASH)
497 return_log ("%s #0 no hash in the initial handshake %s\n",
498 tintstr(),addr.str());
499 bin64_t pos = data.Pull32();
500 if (pos!=bin64_t::ALL)
501 return_log ("%s #0 that is not the root hash %s\n",tintstr(),addr.str());
502 hash = data.PullHash();
503 FileTransfer* file = FileTransfer::Find(hash);
505 return_log ("%s #0 hash %s unknown, no such file %s\n",tintstr(),hash.hex().c_str(),addr.str());
506 dprintf("%s #0 -hash ALL %s\n",tintstr(),hash.hex().c_str());
507 for(binqueue::iterator i=file->hs_in_.begin(); i!=file->hs_in_.end(); i++)
508 if (channels[*i] && channels[*i]->peer_==data.address() &&
509 channels[*i]->last_recv_time_>NOW-TINT_SEC*2)
510 return_log("%s #0 have a channel already to %s\n",tintstr(),addr.str());
511 channel = new Channel(file, socket, data.address());
513 mych = DecodeID(mych);
514 if (mych>=channels.size())
515 return_log("%s invalid channel #%u, %s\n",tintstr(),mych,addr.str());
516 channel = channels[mych];
518 return_log ("%s #%u is already closed\n",tintstr(),mych,addr.str());
519 if (channel->peer() != addr)
520 return_log ("%s #%u invalid peer address %s!=%s\n",
521 tintstr(),mych,channel->peer().str(),addr.str());
522 channel->own_id_mentioned_ = true;
524 //dprintf("recvd %i bytes for %i\n",data.size(),channel->id);
529 void Channel::Loop (tint howlong) {
531 tint limit = Datagram::Time() + howlong;
535 tint send_time(TINT_NEVER);
536 Channel* sender(NULL);
537 while (!sender && !send_queue.is_empty()) { // dequeue
538 tintbin next = send_queue.pop();
539 sender = channel((int)next.bin);
540 send_time = next.time;
541 if (sender && sender->next_send_time_!=send_time &&
542 sender->next_send_time_!=TINT_NEVER )
543 sender = NULL; // it was a stale entry
546 if ( sender!=NULL && send_time<=NOW ) { // it's time
548 dprintf("%s #%u sch_send %s\n",tintstr(),sender->id(),
552 } else { // it's too early, wait
554 tint towait = min(limit,send_time) - NOW;
555 dprintf("%s #0 waiting %lliusec\n",tintstr(),towait);
556 Datagram::Wait(towait);
557 if (sender) // get back to that later
558 send_queue.push(tintbin(send_time,sender->id()));
567 void Channel::Close () {
568 this->SwitchSendControl(CLOSE_CONTROL);
572 void Channel::Reschedule () {
573 next_send_time_ = NextSendTime();
574 if (next_send_time_!=TINT_NEVER) {
575 assert(next_send_time_<NOW+TINT_MIN);
576 send_queue.push(tintbin(next_send_time_,id_));
577 dprintf("%s #%u requeue for %s\n",tintstr(),id_,tintstr(next_send_time_));
579 dprintf("%s #%u closed\n",tintstr(),id_);