Google Git
Sign in
android / kernel / common / 90baeb9dd2656dd9fa0a66f338f22236be96e69f / . / include / net / pie.h
blob: 24f68c1e9919ab32617f7f7399ded5f623e217bc [file] [log] [blame]
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]1/* SPDX-License-Identifier: GPL-2.0-only */
2#ifndef __NET_SCHED_PIE_H
3#define __NET_SCHED_PIE_H
4
5#include <linux/ktime.h>
6#include <linux/skbuff.h>
7#include <linux/types.h>
8#include <net/inet_ecn.h>
9#include <net/pkt_sched.h>
10
Mohit P. Tahilianicf4eeee2020-01-22 23:52:26 +0530[diff] [blame]11#define MAX_PROB U64_MAX
12#define DTIME_INVALID U64_MAX
13#define QUEUE_THRESHOLD 16384
14#define DQCOUNT_INVALID -1
15#define PIE_SCALE 8
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]16
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]17/**
18 * struct pie_params - contains pie parameters
19 * @target: target delay in pschedtime
20 * @tudpate: interval at which drop probability is calculated
21 * @limit: total number of packets that can be in the queue
22 * @alpha: parameter to control drop probability
23 * @beta: parameter to control drop probability
24 * @ecn: is ECN marking of packets enabled
25 * @bytemode: is drop probability scaled based on pkt size
26 * @dq_rate_estimator: is Little's law used for qdelay calculation
27 */
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]28struct pie_params {
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]29 psched_time_t target;
30 u32 tupdate;
31 u32 limit;
32 u32 alpha;
33 u32 beta;
34 u8 ecn;
35 u8 bytemode;
36 u8 dq_rate_estimator;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]37};
38
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]39/**
40 * struct pie_vars - contains pie variables
41 * @qdelay: current queue delay
42 * @qdelay_old: queue delay in previous qdelay calculation
43 * @burst_time: burst time allowance
44 * @dq_tstamp: timestamp at which dq rate was last calculated
45 * @prob: drop probability
46 * @accu_prob: accumulated drop probability
47 * @dq_count: number of bytes dequeued in a measurement cycle
48 * @avg_dq_rate: calculated average dq rate
Leslie Monis90baeb92020-03-05 00:25:59 +0530[diff] [blame^]49 * @backlog_old: queue backlog during previous qdelay calculation
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]50 * @accu_prob_overflows: number of times accu_prob overflows
51 */
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]52struct pie_vars {
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]53 psched_time_t qdelay;
54 psched_time_t qdelay_old;
Mohit P. Tahiliani2dfb1952020-01-22 23:52:28 +0530[diff] [blame]55 psched_time_t burst_time;
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]56 psched_time_t dq_tstamp;
57 u64 prob;
58 u64 accu_prob;
59 u64 dq_count;
60 u32 avg_dq_rate;
Leslie Monis90baeb92020-03-05 00:25:59 +0530[diff] [blame^]61 u32 backlog_old;
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]62 u8 accu_prob_overflows;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]63};
64
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]65/**
66 * struct pie_stats - contains pie stats
67 * @packets_in: total number of packets enqueued
68 * @dropped: packets dropped due to pie action
69 * @overlimit: packets dropped due to lack of space in queue
70 * @ecn_mark: packets marked with ECN
71 * @maxq: maximum queue size
72 */
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]73struct pie_stats {
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]74 u32 packets_in;
75 u32 dropped;
76 u32 overlimit;
77 u32 ecn_mark;
78 u32 maxq;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]79};
80
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]81/**
82 * struct pie_skb_cb - contains private skb vars
83 * @enqueue_time: timestamp when the packet is enqueued
Mohit P. Tahilianiec97ecf2020-01-22 23:52:33 +0530[diff] [blame]84 * @mem_usage: size of the skb during enqueue
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]85 */
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]86struct pie_skb_cb {
87 psched_time_t enqueue_time;
Mohit P. Tahilianiec97ecf2020-01-22 23:52:33 +0530[diff] [blame]88 u32 mem_usage;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]89};
90
91static inline void pie_params_init(struct pie_params *params)
92{
Mohit P. Tahiliani2dfb1952020-01-22 23:52:28 +0530[diff] [blame]93 params->target = PSCHED_NS2TICKS(15 * NSEC_PER_MSEC); /* 15 ms */
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]94 params->tupdate = usecs_to_jiffies(15 * USEC_PER_MSEC); /* 15 ms */
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]95 params->limit = 1000;
Mohit P. Tahiliani2dfb1952020-01-22 23:52:28 +0530[diff] [blame]96 params->alpha = 2;
97 params->beta = 20;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]98 params->ecn = false;
99 params->bytemode = false;
100 params->dq_rate_estimator = false;
101}
102
103static inline void pie_vars_init(struct pie_vars *vars)
104{
Mohit P. Tahilianib42a3d72020-01-22 23:52:29 +0530[diff] [blame]105 vars->burst_time = PSCHED_NS2TICKS(150 * NSEC_PER_MSEC); /* 150 ms */
Mohit P. Tahiliani2dfb1952020-01-22 23:52:28 +0530[diff] [blame]106 vars->dq_tstamp = DTIME_INVALID;
107 vars->accu_prob = 0;
108 vars->dq_count = DQCOUNT_INVALID;
109 vars->avg_dq_rate = 0;
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]110 vars->accu_prob_overflows = 0;
111}
112
113static inline struct pie_skb_cb *get_pie_cb(const struct sk_buff *skb)
114{
115 qdisc_cb_private_validate(skb, sizeof(struct pie_skb_cb));
116 return (struct pie_skb_cb *)qdisc_skb_cb(skb)->data;
117}
118
119static inline psched_time_t pie_get_enqueue_time(const struct sk_buff *skb)
120{
121 return get_pie_cb(skb)->enqueue_time;
122}
123
124static inline void pie_set_enqueue_time(struct sk_buff *skb)
125{
126 get_pie_cb(skb)->enqueue_time = psched_get_time();
127}
128
Mohit P. Tahiliani5205ea02020-01-22 23:52:32 +0530[diff] [blame]129bool pie_drop_early(struct Qdisc *sch, struct pie_params *params,
Leslie Monis90baeb92020-03-05 00:25:59 +0530[diff] [blame^]130 struct pie_vars *vars, u32 backlog, u32 packet_size);
Mohit P. Tahiliani5205ea02020-01-22 23:52:32 +0530[diff] [blame]131
132void pie_process_dequeue(struct sk_buff *skb, struct pie_params *params,
Leslie Monis90baeb92020-03-05 00:25:59 +0530[diff] [blame^]133 struct pie_vars *vars, u32 backlog);
Mohit P. Tahiliani5205ea02020-01-22 23:52:32 +0530[diff] [blame]134
135void pie_calculate_probability(struct pie_params *params, struct pie_vars *vars,
Leslie Monis90baeb92020-03-05 00:25:59 +0530[diff] [blame^]136 u32 backlog);
Mohit P. Tahiliani5205ea02020-01-22 23:52:32 +0530[diff] [blame]137
Mohit P. Tahiliani84bf557f2020-01-22 23:52:24 +0530[diff] [blame]138#endif