Add generic exponentially weighted moving average (EWMA) function
PATCH v6 1/1 Add generic exponentially weighted moving average (EWMA) function
This adds generic functions for calculating Exponentially Weighted Moving Averages (EWMA). This implementation makes use of a structure which keeps the EWMA parameters and a scaled up internal representation to reduce rounding errors.
The original idea for this implementation came from the rt2x00 driver (rt2x00link.c). I would like to use it in several places in the mac80211 and ath5k code and I hope it can be useful in many other places in the kernel code.
--
v6: Fixed ULONG_MAX in comment. Add reviewed by KOSAKI Motohiro.
v5: Use unsigned long instead of insigned int.
v4: Initialize internal variable to 0. Remove unneeded const qualifiers.
v3: Addressing Andrew Mortons comments: Implement in lib/average.c and make
access and initalization functions. Use unsigned int for values. Rename functions to ewma_* since there might be other moving average implementations which are not exponentially weighted.
v2: Renamed 'samples' to 'weight'. Added more documentation. Use avg_val
pointer. Add a WARN_ON_ONCE for invalid values of 'weight'. Divide and round up/down.
--- include/linux/average.h | 32 ++++++++++++++++++++++++++ lib/Makefile | 2 +- lib/average.c | 58 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+), 1 deletions(-) create mode 100644 include/linux/average.h create mode 100644 lib/average.c
include/linux/average.h new file +32 -0
@@ -0,0 +1,32 @@ +#ifndef _LINUX_AVERAGE_H +#define _LINUX_AVERAGE_H + +#include <linux/kernel.h> + +/* Exponentially weighted moving average (EWMA) */ + +/* For more documentation see lib/average.c */ + +struct ewma { +unsigned long internal; +unsigned long factor; +unsigned long weight; +}; + +extern struct ewma *ewma_init (struct ewma *avg,unsigned long factor, +unsigned long weight); + +extern struct ewma *ewma_add (struct ewma *avg,unsigned long val); + +/** +* ewma_get() - Get average value +* @avg: Average structure +* +* Returns the average value held in @avg. +*/ +static inline unsigned long ewma_get (const struct ewma *avg) +{ +return DIV_ROUND_CLOSEST (avg->internal, avg->factor); +} + +#endif /* _LINUX_AVERAGE_H */
lib/Makefile +1 -1
@@ -21,7 +21,7 @@ lib-y += kobject.o kref.o klist.o obj-y += bcd.o div64.o sort.o parser.o halfmd4.o debug_locks.o random32.o \ bust_spinlocks.o hexdump.o kasprintf.o bitmap.o scatterlist.o \ - string_helpers.o gcd.o lcm.o list_sort.o uuid.o + string_helpers.o gcd.o lcm.o list_sort.o uuid.o average.o ifeq ($(CONFIG_DEBUG_KOBJECT),y) CFLAGS_kobject.o += -DDEBUG
lib/average.c new file +58 -0
58 lines not on this page · raw message