1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2020-2021 The FreeBSD Foundation
5 *
6 * This software was developed by Björn Zeeb under sponsorship from
7 * the FreeBSD Foundation.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33 #ifndef _LINUXKPI_LINUX_AVERAGE_H
34 #define _LINUXKPI_LINUX_AVERAGE_H
35
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/types.h>
39 #include <linux/log2.h>
40
41 /* EWMA stands for Exponentially Weighted Moving Average. */
42 /*
43 * Z_t = d X_t + (1 - d) * Z_(t-1); 0 < d <= 1, t >= 1; Roberts (1959).
44 * t : observation number in time.
45 * d : weight for current observation.
46 * Xt : observations over time.
47 * Zt : EWMA value after observation t.
48 *
49 * wmba_*_read seems to return up-to [u]long values; have to deal with 32/64bit.
50 * According to the ath5k.h change log this seems to be a fix-(_p)recision impl.
51 * assert 2/4 bits for frac.
52 * Also all (_d) values seem to be pow2 which simplifies maths (shift by
53 * d = ilog2(_d) instead of doing division (d = 1/_d)). Keep it this way until
54 * we hit the CTASSERT.
55 */
56
57 #define DECLARE_EWMA(_name, _p, _d) \
58 \
59 CTASSERT((sizeof(unsigned long) <= 4) ? (_p < 30) : (_p < 60)); \
60 CTASSERT(_d > 0 && powerof2(_d)); \
61 \
62 struct ewma_ ## _name { \
63 unsigned long zt; \
64 }; \
65 \
66 static __inline void \
67 ewma_ ## _name ## _init(struct ewma_ ## _name *ewma) \
68 { \
69 /* No target (no historical data). */ \
70 ewma->zt = 0; \
71 } \
72 \
73 static __inline void \
74 ewma_ ## _name ## _add(struct ewma_ ## _name *ewma, unsigned long x) \
75 { \
76 unsigned long ztm1 = ewma->zt; /* Z_(t-1). */ \
77 int d = ilog2(_d); \
78 \
79 if (ewma->zt == 0) \
80 ewma->zt = x << (_p); \
81 else \
82 ewma->zt = ((x << (_p)) >> d) + \
83 (((ztm1 << d) - ztm1) >> d); \
84 } \
85 \
86 static __inline unsigned long \
87 ewma_ ## _name ## _read(struct ewma_ ## _name *ewma) \
88 { \
89 return (ewma->zt >> (_p)); \
90 } \
91
92 #endif /* _LINUXKPI_LINUX_AVERAGE_H */
Cache object: 0c837dca12bad13731e5e895027af11b
|