blob: 99a67e662b3c6b747e2ccb81f576e8e5ba040b6b [file] [log] [blame]
Bruno Randolfc5485a72010-11-16 10:58:37 +09001/*
2 * lib/average.c
3 *
4 * This source code is licensed under the GNU General Public License,
5 * Version 2. See the file COPYING for more details.
6 */
7
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -05008#include <linux/export.h>
Bruno Randolfc5485a72010-11-16 10:58:37 +09009#include <linux/average.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050010#include <linux/kernel.h>
Bruno Randolfc5485a72010-11-16 10:58:37 +090011#include <linux/bug.h>
Bruno Randolfaf556882010-12-02 19:50:37 +090012#include <linux/log2.h>
Bruno Randolfc5485a72010-11-16 10:58:37 +090013
14/**
15 * DOC: Exponentially Weighted Moving Average (EWMA)
16 *
17 * These are generic functions for calculating Exponentially Weighted Moving
18 * Averages (EWMA). We keep a structure with the EWMA parameters and a scaled
19 * up internal representation of the average value to prevent rounding errors.
20 * The factor for scaling up and the exponential weight (or decay rate) have to
21 * be specified thru the init fuction. The structure should not be accessed
22 * directly but only thru the helper functions.
23 */
24
25/**
26 * ewma_init() - Initialize EWMA parameters
27 * @avg: Average structure
28 * @factor: Factor to use for the scaled up internal value. The maximum value
Bruno Randolfaf556882010-12-02 19:50:37 +090029 * of averages can be ULONG_MAX/(factor*weight). For performance reasons
30 * factor has to be a power of 2.
Bruno Randolfc5485a72010-11-16 10:58:37 +090031 * @weight: Exponential weight, or decay rate. This defines how fast the
Bruno Randolfaf556882010-12-02 19:50:37 +090032 * influence of older values decreases. For performance reasons weight has
33 * to be a power of 2.
Bruno Randolfc5485a72010-11-16 10:58:37 +090034 *
35 * Initialize the EWMA parameters for a given struct ewma @avg.
36 */
37void ewma_init(struct ewma *avg, unsigned long factor, unsigned long weight)
38{
Bruno Randolfaf556882010-12-02 19:50:37 +090039 WARN_ON(!is_power_of_2(weight) || !is_power_of_2(factor));
40
41 avg->weight = ilog2(weight);
42 avg->factor = ilog2(factor);
Bruno Randolfc5485a72010-11-16 10:58:37 +090043 avg->internal = 0;
Bruno Randolfc5485a72010-11-16 10:58:37 +090044}
45EXPORT_SYMBOL(ewma_init);
46
47/**
48 * ewma_add() - Exponentially weighted moving average (EWMA)
49 * @avg: Average structure
50 * @val: Current value
51 *
52 * Add a sample to the average.
53 */
54struct ewma *ewma_add(struct ewma *avg, unsigned long val)
55{
56 avg->internal = avg->internal ?
Bruno Randolfaf556882010-12-02 19:50:37 +090057 (((avg->internal << avg->weight) - avg->internal) +
58 (val << avg->factor)) >> avg->weight :
59 (val << avg->factor);
Bruno Randolfc5485a72010-11-16 10:58:37 +090060 return avg;
61}
62EXPORT_SYMBOL(ewma_add);