summaryrefslogtreecommitdiffstats
path: root/icnet/transport/icnet_transport_raaqm.cc
blob: 7216d29e111a90002b60591f635e773a5b9d1ea4 (plain)
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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifdef __ANDROID__
#include <android/log.h>
#endif

#include "icnet_transport_raaqm.h"

namespace icnet {

RaaqmTransportProtocol::RaaqmTransportProtocol(Socket *icnet_socket)
    : VegasTransportProtocol(icnet_socket), rate_estimator_(NULL) {
  init();
}

RaaqmTransportProtocol::~RaaqmTransportProtocol() {
  if (this->rate_estimator_) {
    delete this->rate_estimator_;
  }
}

void RaaqmTransportProtocol::init() {
  std::ifstream is(RAAQM_CONFIG_PATH);

  std::string line;

  socket_->setSocketOption(RaaqmTransportOptions::BETA_VALUE, default_values::beta_value);
  socket_->setSocketOption(RaaqmTransportOptions::DROP_FACTOR, default_values::drop_factor);
  socket_->setSocketOption(GeneralTransportOptions::INTEREST_LIFETIME, default_values::interest_lifetime);
  socket_->setSocketOption(ConsumerCallbacksOptions::INTEREST_RETRANSMISSION,
                           default_values::transport_protocol_max_retransmissions);
  raaqm_autotune_ = false;
  default_beta_ = default_values::beta_value;
  default_drop_ = default_values::drop_factor;
  beta_wifi_ = default_values::beta_value;
  drop_wifi_ = default_values::drop_factor;
  beta_lte_ = default_values::beta_value;
  drop_lte_ = default_values::drop_factor;
  wifi_delay_ = 1000;
  lte_delay_ = 15000;
  avg_rtt_ = 0.0;

  if (!is) {
#ifdef __ANDROID__
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "WARNING: RAAQM parameters not found, set default values\n");
#else
    std::cout << "WARNING: RAAQM parameters not found, set default values" << std::endl;
#endif
    return;
  }

#ifdef __ANDROID__
  __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "Setting RAAQM parameters:\n");
#else
  std::cout << "Setting RAAQM parameters:" << std::endl;
#endif
  while (getline(is, line)) {
    std::string command;
    std::istringstream line_s(line);

    line_s >> command;

    if (command == ";") {
      continue;
    }

    if (command == "autotune") {
      std::string tmp;
      std::string val;
      line_s >> tmp >> val;
      if (val == "yes") {
        raaqm_autotune_ = true;
      } else {
        raaqm_autotune_ = false;
      }
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  autotune = %s",raaqm_autotune_ == 1 ? "true" : "false");
#else
      std::cout << "params:  autotune = " << raaqm_autotune_ << std::endl;
#endif
      continue;
    }

    if (command == "lifetime") {
      std::string tmp;
      int lifetime;
      line_s >> tmp >> lifetime;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  lifetime = %d\n", lifetime);
#else
      std::cout << "params:  lifetime = " << lifetime << std::endl;
#endif
      socket_->setSocketOption(GeneralTransportOptions::INTEREST_LIFETIME, lifetime);
      continue;
    }

    if (command == "retransmissions") {
      std::string tmp;
      int rtx;
      line_s >> tmp >> rtx;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  retransmissions = %d\n", rtx);
#else
      std::cout << "params:  retransmissions = " << rtx << std::endl;
#endif
      socket_->setSocketOption(ConsumerCallbacksOptions::INTEREST_RETRANSMISSION, rtx);
      continue;
    }

    if (command == "beta") {
      std::string tmp;
      line_s >> tmp >> default_beta_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  beta = %f\n", default_beta_);
#else
      std::cout << "params:  beta = " << default_beta_ << std::endl;
#endif
      socket_->setSocketOption(RaaqmTransportOptions::BETA_VALUE, default_beta_);
      continue;
    }

    if (command == "drop") {
      std::string tmp;
      line_s >> tmp >> default_drop_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  drop = %f\n", default_drop_);
#else
      std::cout << "params:  drop = " << default_drop_ << std::endl;
#endif
      socket_->setSocketOption(RaaqmTransportOptions::DROP_FACTOR, default_drop_);
      continue;
    }

    if (command == "beta_wifi_") {
      std::string tmp;
      line_s >> tmp >> beta_wifi_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  beta_wifi_ = %f\n", beta_wifi_);
#else
      std::cout << "params:  beta_wifi_ = " << beta_wifi_ << std::endl;
#endif
      continue;
    }

    if (command == "drop_wifi_") {
      std::string tmp;
      line_s >> tmp >> drop_wifi_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  drop_wifi_ = %f\n", drop_wifi_);
#else
      std::cout << "params:  drop_wifi_ = " << drop_wifi_ << std::endl;
#endif
      continue;
    }

    if (command == "beta_lte_") {
      std::string tmp;
      line_s >> tmp >> beta_lte_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  beta_lte_ = %f\n", beta_lte_);
#else
      std::cout << "params:  beta_lte_ = " << beta_lte_ << std::endl;
#endif
      continue;
    }

    if (command == "drop_lte_") {
      std::string tmp;
      line_s >> tmp >> drop_lte_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  drop_lte_ = %f\n", drop_lte_);
#else
      std::cout << "params:  drop_lte_ = " << drop_lte_ << std::endl;
#endif
      continue;
    }

    if (command == "wifi_delay_") {
      std::string tmp;
      line_s >> tmp >> wifi_delay_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  wifi_delay_ = %u\n", wifi_delay_);
#else
      std::cout << "params:  wifi_delay_ = " << wifi_delay_ << std::endl;
#endif
      continue;
    }

    if (command == "lte_delay_") {
      std::string tmp;
      line_s >> tmp >> lte_delay_;
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  lte_delay_ = %u\n", lte_delay_);
#else
      std::cout << "params:  lte_delay_ = " << lte_delay_ << std::endl;
#endif
      continue;
    }
    if (command == "alpha") {
      std::string tmp;
      double rate_alpha = 0.0;
      line_s >> tmp >> rate_alpha;
      socket_->setSocketOption(RateEstimationOptions::RATE_ESTIMATION_ALPHA, rate_alpha);
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  alpha = %f\n", rate_alpha);
#else
      std::cout << "params:  alpha = " << rate_alpha << std::endl;
#endif
      continue;
    }

    if (command == "batching_parameter") {
      std::string tmp;
      int batching_param = 0;
      line_s >> tmp >> batching_param;
      socket_->setSocketOption(RateEstimationOptions::RATE_ESTIMATION_BATCH_PARAMETER, batching_param);
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params:  batching = %d\n", batching_param);
#else
      std::cout << "params:  batching = " << batching_param << std::endl;
#endif
      continue;
    }

    if (command == "rate_estimator") {
      std::string tmp;
      int choice_param = 0;
      line_s >> tmp >> choice_param;
      socket_->setSocketOption(RateEstimationOptions::RATE_ESTIMATION_CHOICE, choice_param);
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "params: choice = %d\n", choice_param);
#else
      std::cout << "params: choice = " << choice_param << std::endl;
#endif
      continue;
    }
  }
  is.close();
#ifdef __ANDROID__
  __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "init done\n");
#else
  std::cout << "init done" << std::endl;
#endif
}

void RaaqmTransportProtocol::reset() {
  is_final_block_number_discovered_ = false;
  final_block_number_ = std::numeric_limits<uint64_t>::max();
  segment_number_ = 0;
  interests_in_flight_ = 0;
  last_reassembled_segment_ = 0;
  content_buffer_size_ = 0;
  content_buffer_.clear();
  interest_retransmissions_.clear();
  receive_buffer_.clear();
  unverified_segments_.clear();
  verified_manifests_.clear();
}

void RaaqmTransportProtocol::start() {
  if (this->rate_estimator_) {
    this->rate_estimator_->onStart();
  }

  if (!cur_path_) {

    double drop_factor;
    double minimum_drop_probability;
    int sample_number;
    int interest_lifetime;
    double beta;

    socket_->getSocketOption(DROP_FACTOR, drop_factor);
    socket_->getSocketOption(MINIMUM_DROP_PROBABILITY, minimum_drop_probability);
    socket_->getSocketOption(SAMPLE_NUMBER, sample_number);
    socket_->getSocketOption(INTEREST_LIFETIME, interest_lifetime);
    socket_->getSocketOption(BETA_VALUE, beta);
#ifdef __ANDROID__
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "Drop Factor: %f\n", drop_factor);
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "Minimum drop prob: %f\n", minimum_drop_probability);
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "Sample number: %d\n", sample_number);
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "lifetime: %d\n", interest_lifetime);
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "beta: %f\n", beta);
#else
    std::cout << "Drop Factor: " << drop_factor << std::endl;
    std::cout << "Minimum drop prob: " << minimum_drop_probability << std::endl;
    std::cout << "Sample number: " << sample_number << std::endl;
    std::cout << "lifetime: " << interest_lifetime << std::endl;
    std::cout << "beta: " << beta << std::endl;
#endif

    double alpha = 0.0;
    int batching_param = 0;
    int choice_param = 0;
    socket_->getSocketOption(RATE_ESTIMATION_ALPHA, alpha);
    socket_->getSocketOption(RATE_ESTIMATION_BATCH_PARAMETER, batching_param);
    socket_->getSocketOption(RATE_ESTIMATION_CHOICE, choice_param);
    if (choice_param == 1) {
      this->rate_estimator_ = new ALaTcpEstimator();
    } else {
      this->rate_estimator_ = new SimpleEstimator(alpha, batching_param);
    }

    socket_->getSocketOption(RATE_ESTIMATION_OBSERVER, &(this->rate_estimator_->observer_));

    cur_path_ =
        std::make_shared<RaaqmDataPath>(drop_factor, minimum_drop_probability, interest_lifetime * 1000, sample_number);
    path_table_[default_values::path_id] = cur_path_;
  }

  VegasTransportProtocol::start();
}

void RaaqmTransportProtocol::copyContent(ContentObject &content_object) {
  if ((content_object.getName().get(-1).toSegment() == final_block_number_) || !(is_running_)) {
    this->rate_estimator_->onDownloadFinished();
  }
  VegasTransportProtocol::copyContent(content_object);
}

void RaaqmTransportProtocol::updatePathTable(const ContentObject &content_object) {
  unsigned char path_id = content_object.getPathLabel();

  if (path_table_.find(path_id) == path_table_.end()) {
    if (cur_path_) {
      // Create a new path with some default param
      if (path_table_.empty()) {
#ifdef __ANDROID__
        __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "No path initialized for path table, error could be in default path initialization.\n");
#else
        std::cerr << "No path initialized for path table, error could be in default path initialization." << std::endl;
#endif
        exit(EXIT_FAILURE);
      } else {
        // Initiate the new path default param
        std::shared_ptr<RaaqmDataPath>
            new_path = std::make_shared<RaaqmDataPath>(*(path_table_.at(default_values::path_id)));
        // Insert the new path into hash table
        path_table_[path_id] = new_path;
      }
    } else {
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "UNEXPECTED ERROR: when running,current path not found.\n");
#else
      std::cerr << "UNEXPECTED ERROR: when running,current path not found." << std::endl;
#endif
      exit(EXIT_FAILURE);
    }
  }

  cur_path_ = path_table_[path_id];

  size_t packet_size = content_object.getPacketSize();
  size_t data_size = content_object.getContent().size();

  // Update measurements for path
  cur_path_->updateReceivedStats(packet_size, data_size);
}

void RaaqmTransportProtocol::updateRtt(uint64_t segment) {
  if (!cur_path_) {
    throw std::runtime_error("ERROR: no current path found, exit");
  } else {
    std::chrono::microseconds rtt;

    std::chrono::steady_clock::duration duration =
        std::chrono::steady_clock::now() - interest_timepoints_[segment % default_values::default_buffer_size];
    rtt = std::chrono::duration_cast<std::chrono::microseconds>(duration);
    if (this->rate_estimator_) {
      this->rate_estimator_->onRttUpdate(rtt.count());
    }
    cur_path_->insertNewRtt(rtt.count());
    cur_path_->smoothTimer();

    avg_rtt_ = (avg_rtt_ * 0.99) + ((double) rtt.count() * 0.01);
    if (cur_path_->newPropagationDelayAvailable()) {
      check_drop_probability();
    }
  }
}

void RaaqmTransportProtocol::changeInterestLifetime(uint64_t segment) {
  return;
}

void RaaqmTransportProtocol::check_drop_probability() {
  if (!raaqm_autotune_) {
    return;
  }

  unsigned int max_pd = 0;
  std::unordered_map<unsigned char, std::shared_ptr<RaaqmDataPath >>::iterator it;
  for (it = path_table_.begin(); it != path_table_.end(); ++it) {
    if (it->second->getPropagationDelay() > max_pd && it->second->getPropagationDelay() != UINT_MAX
        && !it->second->isStale()) {
      max_pd = it->second->getPropagationDelay();
    }
  }

  double drop_prob = 0;
  double beta = 0;
  if (max_pd < wifi_delay_) {       //only ethernet paths
    drop_prob = default_drop_;
    beta = default_beta_;
  } else if (max_pd < lte_delay_) { //at least one wifi path
    drop_prob = drop_wifi_;
    beta = beta_wifi_;
  } else {         //at least one lte path
    drop_prob = drop_lte_;
    beta = beta_lte_;
  }

  double old_drop_prob = 0;
  double old_beta = 0;
  socket_->getSocketOption(BETA_VALUE, old_beta);
  socket_->getSocketOption(DROP_FACTOR, old_drop_prob);

  if (drop_prob == old_drop_prob && beta == old_beta) {
    return;
  }
#ifdef __ANDROID__
  __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "*************[RAAQM TUNING] new beta = %f new drop = %f max pd = %u\n", beta, drop_prob, max_pd);
#else
  std::cout << "*************[RAAQM TUNING] new beta = " << beta << " new drop = " << drop_prob << " max pd = "
            << max_pd << std::endl;
#endif
  socket_->setSocketOption(BETA_VALUE, beta);
  socket_->setSocketOption(DROP_FACTOR, drop_prob);

  for (it = path_table_.begin(); it != path_table_.end(); it++) {
    it->second->setDropProb(drop_prob);
  }
}

void RaaqmTransportProtocol::check_for_stale_paths() {
  if (!raaqm_autotune_) {
    return;
  }

  bool stale = false;
  std::unordered_map<unsigned char, std::shared_ptr<RaaqmDataPath >>::iterator it;
  for (it = path_table_.begin(); it != path_table_.end(); ++it) {
    if (it->second->isStale()) {
      stale = true;
      break;
    }
  }
  if (stale) {
    check_drop_probability();
  }
}

void RaaqmTransportProtocol::onTimeout(const Interest &interest) {
  check_for_stale_paths();
  VegasTransportProtocol::onTimeout(interest);
}

void RaaqmTransportProtocol::increaseWindow() {
  double max_window_size = -1;
  socket_->getSocketOption(MAX_WINDOW_SIZE, max_window_size);
  if (current_window_size_ < max_window_size) // don't expand window above max level
  {
    double gamma = -1;
    socket_->getSocketOption(GAMMA_VALUE, gamma);

    current_window_size_ += gamma / current_window_size_;
    socket_->setSocketOption(CURRENT_WINDOW_SIZE, current_window_size_);
  }
  this->rate_estimator_->onWindowIncrease(current_window_size_);
}

void RaaqmTransportProtocol::decreaseWindow() {
  double min_window_size = -1;
  socket_->getSocketOption(MIN_WINDOW_SIZE, min_window_size);
  if (current_window_size_ > min_window_size) // don't shrink window below minimum level
  {
    double beta = -1;
    socket_->getSocketOption(BETA_VALUE, beta);

    current_window_size_ = current_window_size_ * beta;
    if (current_window_size_ < min_window_size) {
      current_window_size_ = min_window_size;
    }

    socket_->setSocketOption(CURRENT_WINDOW_SIZE, current_window_size_);
  }
  this->rate_estimator_->onWindowDecrease(current_window_size_);
}

void RaaqmTransportProtocol::RAAQM() {
  if (!cur_path_) {
#ifdef __ANDROID__
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "ERROR: no current path found, exit\n");
#else
    std::cerr << "ERROR: no current path found, exit" << std::endl;
#endif
    exit(EXIT_FAILURE);
  } else {
    // Change drop probability according to RTT statistics
    cur_path_->updateDropProb();

    if (rand() % 10000 <= cur_path_->getDropProb() * 10000) {
      decreaseWindow();
    }
  }
}

void RaaqmTransportProtocol::afterDataUnsatisfied(uint64_t segment) {
  // Decrease the window because the timeout happened
  decreaseWindow();
}

void RaaqmTransportProtocol::afterContentReception(const Interest &interest, const ContentObject &content_object) {
  updatePathTable(content_object);
  increaseWindow();
  updateRtt(interest.getName().get(-1).toSegment());
  this->rate_estimator_->onDataReceived((int) content_object.getPacketSize());
  // Set drop probablility and window size accordingly
  RAAQM();
}

void RaaqmTransportProtocol::checkForFastRetransmission(const Interest &interest) {
}

#if 0
void
RaaqmTransportProtocol::onInterest(const Interest &interest)
{
  bool mobility = interest.get_MobilityLossFlag();

  if(mobility){
    const Name &name = interest.getName();
    uint64_t segment = name[-1].toSegment();
    timeval now;
    gettimeofday(&now, 0);
#ifdef __ANDROID__
    __android_log_print(ANDROID_LOG_DEBUG, "libICNet", "%ld.%u RAAQM: M-Interest %ld %s\n", (long) now.tv_sec, (unsigned) now.tv_usec, segment, interest.getName());
#else
    std::cout << (long) now.tv_sec << "." << (unsigned) now.tv_usec << " RAAQM: M-Interest " <<
    segment << " " << interest.getName() << std::endl;
#endif
    NackSet::iterator it = m_nackSet.find(segment);
    if(it == m_nackSet.end()){
      m_nackSet.insert(segment);
    }
  }
}
#endif

} // end namespace icnet