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
|
/* SPDX-License-Identifier: GPL-2.0 */
/*
* Dynamic queue limits (dql) - Definitions
*
* Copyright (c) 2011, Tom Herbert <therbert@google.com>
*
* This header file contains the definitions for dynamic queue limits (dql).
* dql would be used in conjunction with a producer/consumer type queue
* (possibly a HW queue). Such a queue would have these general properties:
*
* 1) Objects are queued up to some limit specified as number of objects.
* 2) Periodically a completion process executes which retires consumed
* objects.
* 3) Starvation occurs when limit has been reached, all queued data has
* actually been consumed, but completion processing has not yet run
* so queuing new data is blocked.
* 4) Minimizing the amount of queued data is desirable.
*
* The goal of dql is to calculate the limit as the minimum number of objects
* needed to prevent starvation.
*
* The primary functions of dql are:
* dql_queued - called when objects are enqueued to record number of objects
* dql_avail - returns how many objects are available to be queued based
* on the object limit and how many objects are already enqueued
* dql_completed - called at completion time to indicate how many objects
* were retired from the queue
*
* The dql implementation does not implement any locking for the dql data
* structures, the higher layer should provide this. dql_queued should
* be serialized to prevent concurrent execution of the function; this
* is also true for dql_completed. However, dql_queued and dlq_completed can
* be executed concurrently (i.e. they can be protected by different locks).
*/
#ifndef _LINUX_DQL_H
#define _LINUX_DQL_H
#ifdef __KERNEL__
#include <linux/bitops.h>
#include <asm/bug.h>
#define DQL_HIST_LEN 4
#define DQL_HIST_ENT(dql, idx) ((dql)->history[(idx) % DQL_HIST_LEN])
struct dql {
/* Fields accessed in enqueue path (dql_queued) */
unsigned int num_queued; /* Total ever queued */
unsigned int adj_limit; /* limit + num_completed */
unsigned int last_obj_cnt; /* Count at last queuing */
/* Stall threshold (in jiffies), defined by user */
unsigned short stall_thrs;
unsigned long history_head; /* top 58 bits of jiffies */
/* stall entries, a bit per entry */
unsigned long history[DQL_HIST_LEN];
/* Fields accessed only by completion path (dql_completed) */
unsigned int limit ____cacheline_aligned_in_smp; /* Current limit */
unsigned int num_completed; /* Total ever completed */
unsigned int prev_ovlimit; /* Previous over limit */
unsigned int prev_num_queued; /* Previous queue total */
unsigned int prev_last_obj_cnt; /* Previous queuing cnt */
unsigned int lowest_slack; /* Lowest slack found */
unsigned long slack_start_time; /* Time slacks seen */
/* Configuration */
unsigned int max_limit; /* Max limit */
unsigned int min_limit; /* Minimum limit */
unsigned int slack_hold_time; /* Time to measure slack */
/* Longest stall detected, reported to user */
unsigned short stall_max;
unsigned long last_reap; /* Last reap (in jiffies) */
unsigned long stall_cnt; /* Number of stalls */
};
/* Set some static maximums */
#define DQL_MAX_OBJECT (UINT_MAX / 16)
#define DQL_MAX_LIMIT ((UINT_MAX / 2) - DQL_MAX_OBJECT)
/* Populate the bitmap to be processed later in dql_check_stall() */
static inline void dql_queue_stall(struct dql *dql)
{
unsigned long map, now, now_hi, i;
now = jiffies;
now_hi = now / BITS_PER_LONG;
/* The following code set a bit in the ring buffer, where each
* bit trackes time the packet was queued. The dql->history buffer
* tracks DQL_HIST_LEN * BITS_PER_LONG time (jiffies) slot
*/
if (unlikely(now_hi != dql->history_head)) {
/* About to reuse slots, clear them */
for (i = 0; i < DQL_HIST_LEN; i++) {
/* Multiplication masks high bits */
if (now_hi * BITS_PER_LONG ==
(dql->history_head + i) * BITS_PER_LONG)
break;
DQL_HIST_ENT(dql, dql->history_head + i + 1) = 0;
}
/* pairs with smp_rmb() in dql_check_stall() */
smp_wmb();
WRITE_ONCE(dql->history_head, now_hi);
}
/* __set_bit() does not guarantee WRITE_ONCE() semantics */
map = DQL_HIST_ENT(dql, now_hi);
/* Populate the history with an entry (bit) per queued */
if (!(map & BIT_MASK(now)))
WRITE_ONCE(DQL_HIST_ENT(dql, now_hi), map | BIT_MASK(now));
}
/*
* Record number of objects queued. Assumes that caller has already checked
* availability in the queue with dql_avail.
*/
static inline void dql_queued(struct dql *dql, unsigned int count)
{
if (WARN_ON_ONCE(count > DQL_MAX_OBJECT))
return;
dql->last_obj_cnt = count;
/* We want to force a write first, so that cpu do not attempt
* to get cache line containing last_obj_cnt, num_queued, adj_limit
* in Shared state, but directly does a Request For Ownership
* It is only a hint, we use barrier() only.
*/
barrier();
dql->num_queued += count;
/* Only populate stall information if the threshold is set */
if (READ_ONCE(dql->stall_thrs))
dql_queue_stall(dql);
}
/* Returns how many objects can be queued, < 0 indicates over limit. */
static inline int dql_avail(const struct dql *dql)
{
return READ_ONCE(dql->adj_limit) - READ_ONCE(dql->num_queued);
}
/* Record number of completed objects and recalculate the limit. */
void dql_completed(struct dql *dql, unsigned int count);
/* Reset dql state */
void dql_reset(struct dql *dql);
/* Initialize dql state */
void dql_init(struct dql *dql, unsigned int hold_time);
#endif /* _KERNEL_ */
#endif /* _LINUX_DQL_H */
|
