aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-light/src/hicn/core/policy_stats.c
blob: 8706a924401dbaa6e51a1ace18f34c42a984fcd4 (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
/*
 * Copyright (c) 2022 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 WITH_POLICY_STATS

// This has to be included first because of _GNU_SOURCE
#include <hicn/core/forwarder.h>

#include <hicn/core/connection_table.h>
#include <hicn/base/loop.h>
#include <hicn/util/log.h>
#include <hicn/core/ticks.h>
#include <hicn/policy.h>
#include <hicn/core/fib.h>

#include "policy_stats.h"

#define ALPHA 0.9
#define STATS_INTERVAL 1000 /* ms */

static int policy_stats_mgr_tick(void* mgr_arg, int fd, unsigned id,
                                 void* data) {
  policy_stats_mgr_t* mgr = mgr_arg;
  assert(mgr);
  assert(id == 0);
  assert(!data);

  uint64_t now = ticks_now();

  /* Loop over FIB entries to compute statistics from counters */
  const fib_t* fib = forwarder_get_fib(mgr->forwarder);

  fib_foreach_entry(fib, entry, {
    policy_stats_update(&entry->policy_stats, &entry->policy_counters, now);
  });

  return 0;
}

int policy_stats_mgr_initialize(policy_stats_mgr_t* mgr, void* forwarder) {
  mgr->forwarder = forwarder;

  loop_timer_create(&mgr->timer, MAIN_LOOP, mgr, policy_stats_mgr_tick, NULL);
  if (!mgr->timer) {
    ERROR("Error allocating prefix stats mgr timer.");
    return -1;
  }

  if (loop_timer_register(mgr->timer, STATS_INTERVAL) < 0) {
    ERROR("Error registering prefix stats mgr timer.");
    return -1;
  }

  return 0;
}

void policy_stats_mgr_finalize(policy_stats_mgr_t* mgr) {
  loop_event_unregister(mgr->timer);
  loop_event_free(mgr->timer);
}

void policy_stats_on_retransmission(const policy_stats_mgr_t* mgr,
                                    policy_counters_t* counters,
                                    const nexthops_t* nexthops) {
  connection_table_t* table = forwarder_get_connection_table(mgr->forwarder);
  nexthops_foreach(nexthops, nexthop, {
#ifdef WITH_POLICY
    const connection_t* conn = connection_table_at(table, nexthop);

    if (connection_has_tag(conn, POLICY_TAG_WIRED))
      counters->wired.num_losses++;
    if (connection_has_tag(conn, POLICY_TAG_WIFI)) counters->wifi.num_losses++;
    if (connection_has_tag(conn, POLICY_TAG_CELLULAR))
      counters->cellular.num_losses++;
#endif /* WITH_POLICY */
    counters->all.num_losses++;
  });
}

#define UPDATE_TAG_STATS(TAG, NAME)                                \
  do {                                                             \
    if (connection_has_tag(conn, TAG)) {                           \
      counters->NAME.num_packets++;                                \
      counters->NAME.num_bytes += msg_size;                        \
      stats->NAME.latency =                                        \
          ALPHA * stats->NAME.latency + (1 - ALPHA) * (double)rtt; \
      counters->NAME.latency_idle = 0;                             \
    }                                                              \
  } while (0)

/* Update statistic counters upon Data packet reception */
void policy_stats_on_data(const policy_stats_mgr_t* mgr, policy_stats_t* stats,
                          policy_counters_t* counters,
                          const nexthops_t* nexthops, const msgbuf_t* msgbuf,
                          Ticks rtt) {
#ifdef WITH_POLICY
  forwarder_t* forwarder = mgr->forwarder;
  connection_table_t* table = forwarder_get_connection_table(forwarder);
#endif /* WITH_POLICY */

  size_t msg_size = msgbuf_get_len(msgbuf);

  nexthops_foreach(nexthops, nexthop, {
#ifdef WITH_POLICY
    const connection_t* conn = connection_table_at(table, nexthop);
    if (!conn) continue;

    UPDATE_TAG_STATS(POLICY_TAG_WIRED, wired);
    UPDATE_TAG_STATS(POLICY_TAG_WIFI, wifi);
    UPDATE_TAG_STATS(POLICY_TAG_CELLULAR, cellular);
#endif /* WITH_POLICY */
  });

  stats->all.latency = ALPHA * stats->all.latency + (1 - ALPHA) * (double)rtt;
  counters->all.latency_idle = 0;
  counters->all.num_packets++;
  counters->all.num_bytes += msg_size;
}

void policy_stats_on_timeout(const policy_stats_mgr_t* mgr,
                             policy_counters_t* counters,
                             const nexthops_t* nexthops) {
#ifdef WITH_POLICY
  connection_table_t* table = forwarder_get_connection_table(mgr->forwarder);

  nexthops_foreach(nexthops, nexthop, {
    const connection_t* conn = connection_table_at(table, nexthop);
    if (!conn) continue;
    if (connection_has_tag(conn, POLICY_TAG_WIRED))
      counters->wired.num_losses++;
    if (connection_has_tag(conn, POLICY_TAG_WIFI)) counters->wifi.num_losses++;
    if (connection_has_tag(conn, POLICY_TAG_CELLULAR))
      counters->cellular.num_losses++;
  });
#endif /* WITH_POLICY */

  counters->all.num_losses++;
}

#define UPDATE_TYPE(TYPE)                                                      \
  do {                                                                         \
    /* (a) throughput */                                                       \
    if (counters->TYPE.num_bytes > 0) {                                        \
      throughput = counters->TYPE.num_bytes / (now - counters->last_update);   \
      throughput = throughput * 8 / 1024;                                      \
      if (throughput < 0) throughput = 0;                                      \
    } else {                                                                   \
      throughput = 0;                                                          \
    }                                                                          \
    stats->TYPE.throughput =                                                   \
        ALPHA * stats->TYPE.throughput + (1 - ALPHA) * throughput;             \
                                                                               \
    /* (b) loss rate */                                                        \
    if ((counters->TYPE.num_losses > 0) && (counters->TYPE.num_packets > 0)) { \
      loss_rate = counters->TYPE.num_losses / counters->TYPE.num_packets;      \
      loss_rate *= 100;                                                        \
    } else {                                                                   \
      loss_rate = 0;                                                           \
    }                                                                          \
    stats->TYPE.loss_rate =                                                    \
        ALPHA * stats->TYPE.loss_rate + (1 - ALPHA) * loss_rate;               \
                                                                               \
    /* (c) latency */                                                          \
    counters->TYPE.latency_idle++;                                             \
    if (counters->TYPE.latency_idle > 1) stats->TYPE.latency = 0;              \
                                                                               \
    /* (d) Reset counters */                                                   \
    counters->TYPE.num_bytes = 0;                                              \
    counters->TYPE.num_losses = 0;                                             \
    counters->TYPE.num_packets = 0;                                            \
  } while (0)

void policy_stats_update(policy_stats_t* stats, policy_counters_t* counters,
                         uint64_t now) {
  double throughput;
  double loss_rate;

  if (now == counters->last_update) return;

#ifdef WITH_POLICY
  UPDATE_TYPE(wired);
  UPDATE_TYPE(wifi);
  UPDATE_TYPE(cellular);
#endif /* WITH_POLICY */
  UPDATE_TYPE(all);

  counters->last_update = now;
}

#endif /* WITH_POLICY_STATS */