summaryrefslogtreecommitdiff
path: root/src/ipcpd/unicast/ca.h
blob: fc6de4457608491227abd2d495cc5d5d392ba95c (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
/*
 * Ouroboros - Copyright (C) 2016 - 2026
 *
 * Congestion avoidance
 *
 *    Dimitri Staessens <dimitri@ouroboros.rocks>
 *    Sander Vrijders   <sander@ouroboros.rocks>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., http://www.fsf.org/about/contact/.
 */

#ifndef OUROBOROS_IPCPD_UNICAST_CA_H
#define OUROBOROS_IPCPD_UNICAST_CA_H

#include <ouroboros/ipcp.h>
#include <ouroboros/qoscube.h>

#include <stdbool.h>
#include <sys/types.h>

/* Buffer a policy's ca_print_stats output must fit in. */
#define CA_STATS_STRLEN 2048

int      ca_init(enum pol_cong_avoid ca,
                 uint32_t            rtt_ms);

void     ca_fini(void);


/* OPS */
void *   ca_ctx_get(uint64_t  addr,
                    qoscube_t qc);

void     ca_ctx_put(void * ctx);

time_t   ca_ctx_update_snd(void *     ctx,
                           size_t     len,
                           uint8_t    lecn,
                           uint64_t * ftag);

bool     ca_ctx_update_rcv(void *     ctx,
                           size_t     len,
                           uint8_t    ecn,
                           uint8_t    cap,
                           uint16_t * ece,
                           uint8_t *  fcap);

void     ca_ctx_update_ece(void *   ctx,
                           uint16_t ece,
                           uint8_t  cap);

bool     ca_ctx_hb_due(void *   ctx,
                       uint64_t now);

void     ca_ctx_rtt(void *   ctx,
                    uint64_t now,
                    uint64_t rtt);

int      ca_calc_ecn(size_t    queued,
                     uint8_t * ecn,
                     qoscube_t qc,
                     size_t    len);

bool     ca_marks_ecn(void);

ssize_t  ca_print_stats(void * ctx,
                        char * buf,
                        size_t len);

#endif /* OUROBOROS_IPCPD_UNICAST_CA_H */