src/libswift/channel.cpp

   1 /*
   2  *  channel.cpp
   3  *  class representing a virtual connection to a peer. In addition,
   4  *  it contains generic functions for socket management (see sock_open
   5  *  class variable)
   6  *
   7  *  Created by Victor Grishchenko on 3/6/09.
   8  *  Copyright 2009-2012 TECHNISCHE UNIVERSITEIT DELFT. All rights reserved.
   9  *
  10  */
  11
  12 #include <cassert>
  13 #include "compat.h"
  14 //#include <glog/logging.h>
  15 #include "swift.h"
  16 #include "../kernel/mptp.h"
  17
  18 using namespace std;
  19 using namespace swift;
  20
  21 /*
  22  * Class variables
  23  */
  24
  25 swift::tint now_t::now = Channel::Time();
  26 tint Channel::start = now_t::now;
  27 tint Channel::epoch = now_t::now/360000000LL*360000000LL; // make logs mergeable
  28 uint64_t Channel::global_dgrams_up=0, Channel::global_dgrams_down=0,
  29          Channel::global_raw_bytes_up=0, Channel::global_raw_bytes_down=0,
  30          Channel::global_bytes_up=0, Channel::global_bytes_down=0;
  31 sckrwecb_t Channel::sock_open[] = {};
  32 int Channel::sock_count = 0;
  33 swift::tint Channel::last_tick = 0;
  34 int Channel::MAX_REORDERING = 4;
  35 bool Channel::SELF_CONN_OK = false;
  36 swift::tint Channel::TIMEOUT = TINT_SEC*60;
  37 std::vector<Channel*> Channel::channels(1);
  38 Address Channel::tracker;
  39 //tbheap Channel::send_queue;
  40 FILE* Channel::debug_file = NULL;
  41 #include "ext/simple_selector.cpp"
  42 PeerSelector* Channel::peer_selector = new SimpleSelector();
  43 tint Channel::MIN_PEX_REQUEST_INTERVAL = TINT_SEC;
  44
  45
  46 /*
  47  * Instance methods
  48  */
  49
  50 Channel::Channel    (FileTransfer* transfer, int socket, Address peer_addr) :
  51         // Arno, 2011-10-03: Reordered to avoid g++ Wall warning
  52         peer_(peer_addr), socket_(socket==INVALID_SOCKET?default_socket():socket), // FIXME
  53     transfer_(transfer), peer_channel_id_(0), own_id_mentioned_(false),
  54     data_in_(TINT_NEVER,bin_t::NONE), data_in_dbl_(bin_t::NONE),
  55     data_out_cap_(bin_t::ALL),hint_out_size_(0),
  56     // Gertjan fix 996e21e8abfc7d88db3f3f8158f2a2c4fc8a8d3f
  57     // "Changed PEX rate limiting to per channel limiting"
  58     last_pex_request_time_(0), next_pex_request_time_(0),
  59     pex_request_outstanding_(false), useless_pex_count_(0),
  60     pex_requested_(false),  // Ric: init var that wasn't initialiazed
  61     //
  62     rtt_avg_(TINT_SEC), dev_avg_(0), dip_avg_(TINT_SEC),
  63     last_send_time_(0), last_recv_time_(0), last_data_out_time_(0), last_data_in_time_(0),
  64     last_loss_time_(0), next_send_time_(0), cwnd_(1), cwnd_count1_(0), send_interval_(TINT_SEC),
  65     send_control_(PING_PONG_CONTROL), sent_since_recv_(0),
  66     lastrecvwaskeepalive_(false), lastsendwaskeepalive_(false), // Arno: nap bug fix
  67     ack_rcvd_recent_(0),
  68     ack_not_rcvd_recent_(0), owd_min_bin_(0), owd_min_bin_start_(NOW),
  69     owd_cur_bin_(0), dgrams_sent_(0), dgrams_rcvd_(0),
  70     raw_bytes_up_(0), raw_bytes_down_(0), bytes_up_(0), bytes_down_(0),
  71     scheduled4close_(false)
  72 {
  73     if (peer_==Address())
  74         peer_ = tracker;
  75     this->id_ = channels.size();
  76     channels.push_back(this);
  77     transfer_->hs_in_.push_back(bin_t(id_));
  78     for(int i=0; i<4; i++) {
  79         owd_min_bins_[i] = TINT_NEVER;
  80         owd_current_[i] = TINT_NEVER;
  81     }
  82     evsend_ptr_ = new struct event;
  83     evtimer_assign(evsend_ptr_,evbase,&Channel::LibeventSendCallback,this);
  84     evtimer_add(evsend_ptr_,tint2tv(next_send_time_));
  85
  86     // RATELIMIT
  87         transfer->mychannels_.insert(this);
  88
  89         dprintf("%s #%u init channel %s\n",tintstr(),id_,peer_.str());
  90         //fprintf(stderr,"new Channel %d %s\n", id_, peer_.str() );
  91 }
  92
  93
  94 Channel::~Channel () {
  95         dprintf("%s #%u dealloc channel\n",tintstr(),id_);
  96     channels[id_] = NULL;
  97     ClearEvents();
  98
  99     // RATELIMIT
 100     if (transfer_ != NULL)
 101         transfer_->mychannels_.erase(this);
 102 }
 103
 104
 105 void Channel::ClearEvents()
 106 {
 107     if (evsend_ptr_ != NULL) {
 108         if (evtimer_pending(evsend_ptr_,NULL))
 109                 evtimer_del(evsend_ptr_);
 110         delete evsend_ptr_;
 111         evsend_ptr_ = NULL;
 112     }
 113 }
 114
 115
 116
 117
 118 bool Channel::IsComplete() {
 119         // Check if peak hash bins are filled.
 120         if (file().peak_count() == 0)
 121                 return false;
 122
 123     for(int i=0; i<file().peak_count(); i++) {
 124         bin_t peak = file().peak(i);
 125         if (!ack_in_.is_filled(peak))
 126             return false;
 127     }
 128         return true;
 129 }
 130
 131
 132
 133 uint16_t Channel::GetMyPort() {
 134         struct sockaddr_in mysin = {};
 135         socklen_t mysinlen = sizeof(mysin);
 136         if (getsockname(socket_, (struct sockaddr *)&mysin, &mysinlen) < 0)
 137         {
 138                 print_error("error on getsockname");
 139                 return 0;
 140         }
 141         else
 142                 return ntohs(mysin.sin_port);
 143 }
 144
 145 bool Channel::IsDiffSenderOrDuplicate(Address addr, uint32_t chid)
 146 {
 147     if (peer() != addr)
 148     {
 149         // Got message from different address than I send to
 150         //
 151                 if (!own_id_mentioned_ && addr.is_private()) {
 152                         // Arno, 2012-02-27: Got HANDSHAKE reply from IANA private address,
 153                         // check for duplicate connections:
 154                         //
 155                         // When two peers A and B are behind the same firewall, they will get
 156                         // extB, resp. extA addresses from the tracker. They will both
 157                         // connect to their counterpart but because the incoming packet
 158                         // will be from the intNAT address the duplicates are not
 159                         // recognized.
 160                         //
 161                         // Solution: when the second datagram comes in (HANDSHAKE reply),
 162                         // see if you have had a first datagram from the same addr
 163                         // (HANDSHAKE). If so, close the channel if his port number is
 164                         // larger than yours (such that one channel remains).
 165                         //
 166                         recv_peer_ = addr;
 167
 168                         Channel *c = transfer().FindChannel(addr,this);
 169                         if (c != NULL) {
 170                                 // I already initiated a connection to this peer,
 171                                 // this new incoming message would establish a duplicate.
 172                                 // One must break the connection, decide using port
 173                                 // number:
 174                                 dprintf("%s #%u found duplicate channel to %s\n",
 175                                                 tintstr(),chid,addr.str());
 176
 177                                 if (addr.port() > GetMyPort()) {
 178                                         //Schedule4Close();
 179                                         dprintf("%s #%u closing duplicate channel to %s\n",
 180                                                         tintstr(),chid,addr.str());
 181                                         return true;
 182                                 }
 183                         }
 184                 }
 185                 else
 186                 {
 187                         // Received HANDSHAKE reply from other address than I sent
 188                         // HANDSHAKE to, and the address is not an IANA private
 189                         // address (=no NAT in play), so close.
 190                         //Schedule4Close();
 191                         dprintf("%s #%u invalid peer address %s!=%s\n",
 192                                         tintstr(),chid,peer().str(),addr.str());
 193                         return true;
 194                 }
 195     }
 196         return false;
 197 }
 198
 199
 200
 201
 202
 203
 204
 205 /*
 206  * Class methods
 207  */
 208 tint Channel::Time () {
 209     //HiResTimeOfDay* tod = HiResTimeOfDay::Instance();
 210     //tint ret = tod->getTimeUSec();
 211     //DLOG(INFO)<<"now is "<<ret;
 212     return now_t::now = usec_time();
 213 }
 214
 215 // SOCKMGMT
 216 evutil_socket_t Channel::Bind (Address address, sckrwecb_t callbacks) {
 217     struct sockaddr_mptp *addr = address.addr;
 218     evutil_socket_t fd;
 219     int len = sizeof(struct sockaddr_mptp) + addr->count*sizeof(struct mptp_dest), sndbuf=1<<20, rcvbuf=1<<20;
 220     #define dbnd_ensure(x) { if (!(x)) { \
 221         print_error("binding fails"); close_socket(fd); return INVALID_SOCKET; } }
 222     dbnd_ensure ( (fd = socket(AF_INET, SOCK_DGRAM, IPPROTO_MPTP)) >= 0 );
 223     dbnd_ensure( make_socket_nonblocking(fd) );  // FIXME may remove this
 224     int enable = true;
 225     dbnd_ensure ( setsockopt(fd, SOL_SOCKET, SO_SNDBUF,
 226                              (setsockoptptr_t)&sndbuf, sizeof(int)) == 0 );
 227     dbnd_ensure ( setsockopt(fd, SOL_SOCKET, SO_RCVBUF,
 228                              (setsockoptptr_t)&rcvbuf, sizeof(int)) == 0 );
 229     //setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (setsockoptptr_t)&enable, sizeof(int));
 230     dbnd_ensure ( ::bind(fd, (sockaddr*)&addr, len) == 0 );
 231
 232     callbacks.sock = fd;
 233     sock_open[sock_count++] = callbacks;
 234     return fd;
 235 }
 236
 237 Address Channel::BoundAddress(evutil_socket_t sock) {
 238
 239     struct sockaddr_in myaddr;
 240     socklen_t mylen = sizeof(myaddr);
 241     int ret = getsockname(sock,(sockaddr*)&myaddr,&mylen);
 242     if (ret >= 0) {
 243                 return Address(myaddr);
 244     }
 245         else {
 246                 return Address();
 247         }
 248 }
 249
 250
 251 Address swift::BoundAddress(evutil_socket_t sock) {
 252         return Channel::BoundAddress(sock);
 253 }
 254
 255
 256 int Channel::SendTo (evutil_socket_t sock, const Address& addr, struct evbuffer *evb) {
 257
 258     int length = evbuffer_get_length(evb);
 259         int addr_len = sizeof(struct sockaddr_mptp) + addr.addr->count * sizeof(struct mptp_dest);
 260     int r = sendto(sock,(const char *)evbuffer_pullup(evb, length),length,0,
 261                    (struct sockaddr*)&(addr.addr),addr_len);
 262     if (r<0) {
 263         print_error("can't send");
 264         evbuffer_drain(evb, length); // Arno: behaviour is to pretend the packet got lost
 265     }
 266     else
 267         evbuffer_drain(evb,r);
 268     global_dgrams_up++;
 269     global_raw_bytes_up+=length;
 270     Time();
 271     return r;
 272 }
 273
 274 int Channel::RecvFrom (evutil_socket_t sock, Address& addr, struct evbuffer *evb) {
 275     socklen_t addrlen = sizeof(struct sockaddr_mptp) + addr.addr->count * sizeof(mptp_dest);
 276     struct evbuffer_iovec vec;
 277     if (evbuffer_reserve_space(evb, SWIFT_MAX_RECV_DGRAM_SIZE, &vec, 1) < 0) {
 278         print_error("error on evbuffer_reserve_space");
 279         return 0;
 280     }
 281     int length = recvfrom (sock, (char *)vec.iov_base, SWIFT_MAX_RECV_DGRAM_SIZE, 0,
 282                            (struct sockaddr*)&(addr.addr), &addrlen);
 283     if (length<0) {
 284         length = 0;
 285
 286         // Linux and Windows report "ICMP port unreachable" if the dest port could
 287         // not be reached:
 288         //    http://support.microsoft.com/kb/260018
 289         //    http://www.faqs.org/faqs/unix-faq/socket/
 290 #ifdef _WIN32
 291         if (WSAGetLastError() == 10054) // Sometimes errno == 2 ?!
 292 #else
 293                 if (errno == ECONNREFUSED)
 294 #endif
 295                 {
 296                 CloseChannelByAddress(addr);
 297                 }
 298         else
 299                 print_error("error on recv");
 300     }
 301     vec.iov_len = length;
 302     if (evbuffer_commit_space(evb, &vec, 1) < 0)  {
 303         length = 0;
 304         print_error("error on evbuffer_commit_space");
 305     }
 306     global_dgrams_down++;
 307     global_raw_bytes_down+=length;
 308     Time();
 309     return length;
 310 }
 311
 312
 313 void Channel::CloseSocket(evutil_socket_t sock) {
 314     for(int i=0; i<sock_count; i++)
 315         if (sock_open[i].sock==sock)
 316             sock_open[i] = sock_open[--sock_count];
 317     if (!close_socket(sock))
 318         print_error("on closing a socket");
 319 }
 320
 321 void Channel::Shutdown () {
 322     while (sock_count--)
 323         CloseSocket(sock_open[sock_count].sock);
 324 }
 325
 326 void     swift::SetTracker(const Address& tracker) {
 327     Channel::tracker = tracker;
 328 }
 329
 330 int Channel::DecodeID(int scrambled) {
 331     return scrambled ^ (int)start;
 332 }
 333 int Channel::EncodeID(int unscrambled) {
 334     return unscrambled ^ (int)start;
 335 }
 336
 337 /*
 338  * class Address implementation
 339  */
 340
 341 void Address::set_ipv4 (const char* ip_str) {
 342     struct hostent *h = gethostbyname(ip_str);
 343     if (h == NULL) {
 344         print_error("cannot lookup address");
 345         return;
 346     } else {
 347         addr->dests[0].addr = *(u_long *) h->h_addr_list[0];
 348     }
 349 }
 350
 351
 352 Address::Address(const char* ip_port) {
 353     clear();
 354     if (strlen(ip_port)>=1024)
 355         return;
 356     char ipp[1024];
 357     strncpy(ipp,ip_port,1024);
 358     char* semi = strchr(ipp,':');
 359     if (semi) {
 360         *semi = 0;
 361         set_ipv4(ipp);
 362         set_port(semi+1);
 363     } else {
 364         if (strchr(ipp, '.')) {
 365             set_ipv4(ipp);
 366             set_port((uint16_t)0);
 367         } else {
 368             set_ipv4((uint32_t)INADDR_ANY);
 369             set_port(ipp);
 370         }
 371     }
 372 }
 373
 374
 375 uint32_t Address::LOCALHOST = INADDR_LOOPBACK;
 376
 377
 378 /*
 379  * Utility methods 1
 380  */
 381
 382
 383 const char* swift::tintstr (tint time) {
 384     if (time==0)
 385         time = now_t::now;
 386     static char ret_str[4][32]; // wow
 387     static int i;
 388     i = (i+1) & 3;
 389     if (time==TINT_NEVER)
 390         return "NEVER";
 391     time -= Channel::epoch;
 392     assert(time>=0);
 393     int hours = time/TINT_HOUR;
 394     time %= TINT_HOUR;
 395     int mins = time/TINT_MIN;
 396     time %= TINT_MIN;
 397     int secs = time/TINT_SEC;
 398     time %= TINT_SEC;
 399     int msecs = time/TINT_MSEC;
 400     time %= TINT_MSEC;
 401     int usecs = time/TINT_uSEC;
 402     sprintf(ret_str[i],"%i_%02i_%02i_%03i_%03i",hours,mins,secs,msecs,usecs);
 403     return ret_str[i];
 404 }
 405
 406
 407 std::string swift::sock2str (struct sockaddr_in addr) {
 408     char ipch[32];
 409 #ifdef _WIN32
 410     //Vista only: InetNtop(AF_INET,&(addr.sin_addr),ipch,32);
 411     // IPv4 only:
 412     struct in_addr inaddr;
 413     memcpy(&inaddr, &(addr.sin_addr), sizeof(inaddr));
 414     strncpy(ipch, inet_ntoa(inaddr),32);
 415 #else
 416     inet_ntop(AF_INET,&(addr.sin_addr),ipch,32);
 417 #endif
 418     sprintf(ipch+strlen(ipch),":%i",ntohs(addr.sin_port));
 419     return std::string(ipch);
 420 }
 421
 422
 423 /*
 424  * Swift top-level API implementation
 425  */
 426
 427 int     swift::Listen (Address addr) {
 428     sckrwecb_t cb;
 429     cb.may_read = &Channel::LibeventReceiveCallback;
 430     cb.sock = Channel::Bind(addr,cb);
 431     // swift UDP receive
 432     event_assign(&Channel::evrecv, Channel::evbase, cb.sock, EV_READ,
 433                  cb.may_read, NULL);
 434     event_add(&Channel::evrecv, NULL);
 435     return cb.sock;
 436 }
 437
 438 void    swift::Shutdown (int sock_des) {
 439     Channel::Shutdown();
 440 }
 441
 442 int      swift::Open (const char* filename, const Sha1Hash& hash, Address tracker, bool force_check_diskvshash, bool check_netwvshash, uint32_t chunk_size) {
 443     FileTransfer* ft = new FileTransfer(filename, hash, force_check_diskvshash, check_netwvshash, chunk_size);
 444     if (ft && ft->file().file_descriptor()) {
 445
 446         /*if (FileTransfer::files.size()<fdes)  // FIXME duplication
 447             FileTransfer::files.resize(fdes);
 448         FileTransfer::files[fdes] = ft;*/
 449
 450         // initiate tracker connections
 451         // SWIFTPROC
 452         ft->SetTracker(tracker);
 453         ft->ConnectToTracker();
 454
 455         return ft->file().file_descriptor();
 456     } else {
 457         if (ft)
 458             delete ft;
 459         return -1;
 460     }
 461 }
 462
 463
 464 void    swift::Close (int fd) {
 465     if (fd<FileTransfer::files.size() && FileTransfer::files[fd])
 466         delete FileTransfer::files[fd];
 467 }
 468
 469
 470 void    swift::AddPeer (Address address, const Sha1Hash& root) {
 471     Channel::peer_selector->AddPeer(address,root);
 472 }
 473
 474
 475 uint64_t  swift::Size (int fdes) {
 476     if (FileTransfer::files.size()>fdes && FileTransfer::files[fdes])
 477         return FileTransfer::files[fdes]->file().size();
 478     else
 479         return 0;
 480 }
 481
 482
 483 bool  swift::IsComplete (int fdes) {
 484     if (FileTransfer::files.size()>fdes && FileTransfer::files[fdes])
 485         return FileTransfer::files[fdes]->file().is_complete();
 486     else
 487         return 0;
 488 }
 489
 490
 491 uint64_t  swift::Complete (int fdes) {
 492     if (FileTransfer::files.size()>fdes && FileTransfer::files[fdes])
 493         return FileTransfer::files[fdes]->file().complete();
 494     else
 495         return 0;
 496 }
 497
 498
 499 uint64_t  swift::SeqComplete (int fdes) {
 500     if (FileTransfer::files.size()>fdes && FileTransfer::files[fdes])
 501         return FileTransfer::files[fdes]->file().seq_complete();
 502     else
 503         return 0;
 504 }
 505
 506
 507 const Sha1Hash& swift::RootMerkleHash (int file) {
 508     FileTransfer* trans = FileTransfer::file(file);
 509     if (!trans)
 510         return Sha1Hash::ZERO;
 511     return trans->file().root_hash();
 512 }
 513
 514
 515 /** Returns the number of bytes in a chunk for this transmission */
 516 uint32_t          swift::ChunkSize(int fdes)
 517 {
 518     if (FileTransfer::files.size()>fdes && FileTransfer::files[fdes])
 519         return FileTransfer::files[fdes]->file().chunk_size();
 520     else
 521         return 0;
 522 }
 523
 524
 525 // CHECKPOINT
 526 void swift::Checkpoint(int transfer) {
 527         // Save transfer's binmap for zero-hashcheck restart
 528         FileTransfer *ft = FileTransfer::file(transfer);
 529         if (ft == NULL)
 530                 return;
 531
 532         std::string binmap_filename = ft->file().filename();
 533         binmap_filename.append(".mbinmap");
 534         //fprintf(stderr,"swift: checkpointing %s at %lli\n", binmap_filename.c_str(), Complete(transfer));
 535         FILE *fp = fopen(binmap_filename.c_str(),"wb");
 536         if (!fp) {
 537                 print_error("cannot open mbinmap for writing");
 538                 return;
 539         }
 540         if (ft->file().serialize(fp) < 0)
 541                 print_error("writing to mbinmap");
 542         fclose(fp);
 543 }
 544
 545
 546
 547 /*
 548  * Utility methods 2
 549  */
 550
 551 int swift::evbuffer_add_string(struct evbuffer *evb, std::string str) {
 552     return evbuffer_add(evb, str.c_str(), str.size());
 553 }
 554
 555 int swift::evbuffer_add_8(struct evbuffer *evb, uint8_t b) {
 556     return evbuffer_add(evb, &b, 1);
 557 }
 558
 559 int swift::evbuffer_add_16be(struct evbuffer *evb, uint16_t w) {
 560     uint16_t wbe = htons(w);
 561     return evbuffer_add(evb, &wbe, 2);
 562 }
 563
 564 int swift::evbuffer_add_32be(struct evbuffer *evb, uint32_t i) {
 565     uint32_t ibe = htonl(i);
 566     return evbuffer_add(evb, &ibe, 4);
 567 }
 568
 569 int swift::evbuffer_add_64be(struct evbuffer *evb, uint64_t l) {
 570     uint32_t lbe[2];
 571     lbe[0] = htonl((uint32_t)(l>>32));
 572     lbe[1] = htonl((uint32_t)(l&0xffffffff));
 573     return evbuffer_add(evb, lbe, 8);
 574 }
 575
 576 int swift::evbuffer_add_hash(struct evbuffer *evb, const Sha1Hash& hash)  {
 577     return evbuffer_add(evb, hash.bits, Sha1Hash::SIZE);
 578 }
 579
 580 uint8_t swift::evbuffer_remove_8(struct evbuffer *evb) {
 581     uint8_t b;
 582     if (evbuffer_remove(evb, &b, 1) < 1)
 583         return 0;
 584     return b;
 585 }
 586
 587 uint16_t swift::evbuffer_remove_16be(struct evbuffer *evb) {
 588     uint16_t wbe;
 589     if (evbuffer_remove(evb, &wbe, 2) < 2)
 590         return 0;
 591     return ntohs(wbe);
 592 }
 593
 594 uint32_t swift::evbuffer_remove_32be(struct evbuffer *evb) {
 595     uint32_t ibe;
 596     if (evbuffer_remove(evb, &ibe, 4) < 4)
 597         return 0;
 598     return ntohl(ibe);
 599 }
 600
 601 uint64_t swift::evbuffer_remove_64be(struct evbuffer *evb) {
 602     uint32_t lbe[2];
 603     if (evbuffer_remove(evb, lbe, 8) < 8)
 604         return 0;
 605     uint64_t l = ntohl(lbe[0]);
 606     l<<=32;
 607     l |= ntohl(lbe[1]);
 608     return l;
 609 }
 610
 611 Sha1Hash swift::evbuffer_remove_hash(struct evbuffer* evb)  {
 612     char bits[Sha1Hash::SIZE];
 613     if (evbuffer_remove(evb, bits, Sha1Hash::SIZE) < Sha1Hash::SIZE)
 614         return Sha1Hash::ZERO;
 615     return Sha1Hash(false, bits);
 616 }
 617