xref: /freebsd/sys/sys/counter.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2012 Gleb Smirnoff <glebius@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef __SYS_COUNTER_H__
30 #define __SYS_COUNTER_H__
31 
32 typedef uint64_t *counter_u64_t;
33 
34 #ifdef _KERNEL
35 #include <machine/counter.h>
36 
37 counter_u64_t	counter_u64_alloc(int);
38 void		counter_u64_free(counter_u64_t);
39 
40 void		counter_u64_zero(counter_u64_t);
41 uint64_t	counter_u64_fetch(counter_u64_t);
42 
43 #define	COUNTER_ARRAY_ALLOC(a, n, wait)	do {			\
44 	for (int _i = 0; _i < (n); _i++)			\
45 		(a)[_i] = counter_u64_alloc(wait);		\
46 } while (0)
47 
48 #define	COUNTER_ARRAY_FREE(a, n)	do {			\
49 	for (int _i = 0; _i < (n); _i++)			\
50 		counter_u64_free((a)[_i]);			\
51 } while (0)
52 
53 #define	COUNTER_ARRAY_COPY(a, dstp, n)	do {			\
54 	for (int _i = 0; _i < (n); _i++)			\
55 		((uint64_t *)(dstp))[_i] = counter_u64_fetch((a)[_i]);\
56 } while (0)
57 
58 #define	COUNTER_ARRAY_ZERO(a, n)	do {			\
59 	for (int _i = 0; _i < (n); _i++)			\
60 		counter_u64_zero((a)[_i]);			\
61 } while (0)
62 
63 /*
64  * counter(9) based rate checking.
65  */
66 struct counter_rate {
67 	counter_u64_t	cr_rate;	/* Events since last second */
68 	volatile int	cr_lock;	/* Lock to clean the struct */
69 	int		cr_ticks;	/* Ticks on last clean */
70 	int		cr_over;	/* Over limit since cr_ticks? */
71 };
72 
73 int64_t	counter_ratecheck(struct counter_rate *, int64_t);
74 
75 #define	COUNTER_U64_SYSINIT(c)					\
76 	SYSINIT(c##_counter_sysinit, SI_SUB_COUNTER,		\
77 	    SI_ORDER_ANY, counter_u64_sysinit, &c);		\
78 	SYSUNINIT(c##_counter_sysuninit, SI_SUB_COUNTER,	\
79 	    SI_ORDER_ANY, counter_u64_sysuninit, &c)
80 
81 #define	COUNTER_U64_DEFINE_EARLY(c)				\
82 	counter_u64_t __read_mostly c = EARLY_COUNTER;		\
83 	COUNTER_U64_SYSINIT(c)
84 
85 void counter_u64_sysinit(void *);
86 void counter_u64_sysuninit(void *);
87 
88 #endif	/* _KERNEL */
89 #endif	/* ! __SYS_COUNTER_H__ */
90