aboutsummaryrefslogtreecommitdiffstats
path: root/libtransport/includes/hicn/transport/interfaces/statistics.h
blob: 92c58da230f3510c05d9369ed860ea845bfb36ba (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
/*
 * Copyright (c) 2017-2019 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.
 */

#pragma once

#include <hicn/transport/portability/c_portability.h>

#include <cstdint>

namespace transport {

namespace interface {

class IcnObserver {
 public:
  virtual ~IcnObserver(){};

  virtual void notifyStats(double throughput) = 0;
  virtual void notifyDownloadTime(double downloadTime) = 0;
};

class ProductionStatistics {};

class TransportStatistics {
  static constexpr double default_alpha = 0.7;

 public:
  TransportStatistics(double alpha = default_alpha)
      : retx_count_(0),
        bytes_received_(0),
        average_rtt_(0),
        avg_window_size_(0),
        interest_tx_(0),
        alpha_(alpha),
        loss_ratio_(0.0),
        queuing_delay_(0.0),
        interest_FEC_tx_(0),
        bytes_FEC_received_(0),
        lost_data_(0),
        recovered_data_(0),
        status_(-1),
        // avg_data_rtt_(0),
        avg_pending_pkt_(0.0),
        received_nacks_(0) {}

  TRANSPORT_ALWAYS_INLINE void updateRetxCount(uint64_t retx) {
    retx_count_ += retx;
  }

  TRANSPORT_ALWAYS_INLINE void updateBytesRecv(uint64_t bytes) {
    bytes_received_ += bytes;
  }

  TRANSPORT_ALWAYS_INLINE void updateAverageRtt(uint64_t rtt) {
    average_rtt_ = (alpha_ * average_rtt_) + ((1. - alpha_) * double(rtt));
  }

  TRANSPORT_ALWAYS_INLINE void updateAverageWindowSize(double current_window) {
    avg_window_size_ =
        (alpha_ * avg_window_size_) + ((1. - alpha_) * current_window);
  }

  TRANSPORT_ALWAYS_INLINE void updateInterestTx(uint64_t int_tx) {
    interest_tx_ += int_tx;
  }

  TRANSPORT_ALWAYS_INLINE void updateLossRatio(double loss_ratio) {
    loss_ratio_ = loss_ratio;
  }

  TRANSPORT_ALWAYS_INLINE void updateQueuingDelay(double queuing_delay) {
    queuing_delay_ = queuing_delay;
  }

  TRANSPORT_ALWAYS_INLINE void updateInterestFecTx(uint64_t int_tx) {
    interest_FEC_tx_ += int_tx;
  }

  TRANSPORT_ALWAYS_INLINE void updateBytesFecRecv(uint64_t bytes) {
    bytes_FEC_received_ += bytes;
  }

  TRANSPORT_ALWAYS_INLINE void updateLostData(uint64_t pkt) {
    lost_data_ += pkt;
  }

  TRANSPORT_ALWAYS_INLINE void updateRecoveredData(uint64_t bytes) {
    recovered_data_ += bytes;
  }

  TRANSPORT_ALWAYS_INLINE void updateCCState(int status) { status_ = status; }

  TRANSPORT_ALWAYS_INLINE void updateAveragePendingPktCount(double pkt) {
    avg_pending_pkt_ = (alpha_ * avg_pending_pkt_) + ((1. - alpha_) * pkt);
  }

  TRANSPORT_ALWAYS_INLINE void updateReceivedNacks(uint32_t nacks) {
    received_nacks_ += nacks;
  }

  TRANSPORT_ALWAYS_INLINE uint64_t getRetxCount() const { return retx_count_; }

  TRANSPORT_ALWAYS_INLINE uint64_t getBytesRecv() const {
    return bytes_received_;
  }

  TRANSPORT_ALWAYS_INLINE double getAverageRtt() const { return average_rtt_; }

  TRANSPORT_ALWAYS_INLINE double getAverageWindowSize() const {
    return avg_window_size_;
  }

  TRANSPORT_ALWAYS_INLINE uint64_t getInterestTx() const {
    return interest_tx_;
  }

  TRANSPORT_ALWAYS_INLINE double getLossRatio() const { return loss_ratio_; }

  TRANSPORT_ALWAYS_INLINE double getQueuingDelay() const {
    return queuing_delay_;
  }

  TRANSPORT_ALWAYS_INLINE uint64_t getInterestFecTxCount() const {
    return interest_FEC_tx_;
  }

  TRANSPORT_ALWAYS_INLINE uint64_t getBytesFecRecv() const {
    return bytes_FEC_received_;
  }

  TRANSPORT_ALWAYS_INLINE uint64_t getLostData() const { return lost_data_; }

  TRANSPORT_ALWAYS_INLINE uint64_t getBytesRecoveredData() const {
    return recovered_data_;
  }

  TRANSPORT_ALWAYS_INLINE int getCCStatus() const { return status_; }

  TRANSPORT_ALWAYS_INLINE double getAveragePendingPktCount() const {
    return avg_pending_pkt_;
  }

  TRANSPORT_ALWAYS_INLINE uint32_t getReceivedNacks() const {
    return received_nacks_;
  }

  TRANSPORT_ALWAYS_INLINE void setAlpha(double val) { alpha_ = val; }

  TRANSPORT_ALWAYS_INLINE void reset() {
    retx_count_ = 0;
    bytes_received_ = 0;
    average_rtt_ = 0;
    avg_window_size_ = 0;
    interest_tx_ = 0;
    loss_ratio_ = 0;
    interest_FEC_tx_ = 0;
    bytes_FEC_received_ = 0;
    lost_data_ = 0;
    recovered_data_ = 0;
    status_ = 0;
    // avg_data_rtt_ = 0;
    avg_pending_pkt_ = 0;
    received_nacks_ = 0;
  }

 private:
  uint64_t retx_count_;
  uint64_t bytes_received_;
  double average_rtt_;
  double avg_window_size_;
  uint64_t interest_tx_;
  double alpha_;
  double loss_ratio_;
  double queuing_delay_;
  uint64_t interest_FEC_tx_;
  uint64_t bytes_FEC_received_;
  uint64_t lost_data_;
  uint64_t recovered_data_;
  int status_;  // transport status (e.g. sync status, congestion etc.)
  double avg_pending_pkt_;
  uint32_t received_nacks_;
};

}  // namespace interface

}  // end namespace transport