xref: /freebsd/sys/sys/counter.h (revision 7cc42f6d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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  * $FreeBSD$
29  */
30 
31 #ifndef __SYS_COUNTER_H__
32 #define __SYS_COUNTER_H__
33 
34 typedef uint64_t *counter_u64_t;
35 
36 #ifdef _KERNEL
37 #include <machine/counter.h>
38 
39 counter_u64_t	counter_u64_alloc(int);
40 void		counter_u64_free(counter_u64_t);
41 
42 void		counter_u64_zero(counter_u64_t);
43 uint64_t	counter_u64_fetch(counter_u64_t);
44 
45 #define	COUNTER_ARRAY_ALLOC(a, n, wait)	do {			\
46 	for (int _i = 0; _i < (n); _i++)			\
47 		(a)[_i] = counter_u64_alloc(wait);		\
48 } while (0)
49 
50 #define	COUNTER_ARRAY_FREE(a, n)	do {			\
51 	for (int _i = 0; _i < (n); _i++)			\
52 		counter_u64_free((a)[_i]);			\
53 } while (0)
54 
55 #define	COUNTER_ARRAY_COPY(a, dstp, n)	do {			\
56 	for (int _i = 0; _i < (n); _i++)			\
57 		((uint64_t *)(dstp))[_i] = counter_u64_fetch((a)[_i]);\
58 } while (0)
59 
60 #define	COUNTER_ARRAY_ZERO(a, n)	do {			\
61 	for (int _i = 0; _i < (n); _i++)			\
62 		counter_u64_zero((a)[_i]);			\
63 } while (0)
64 
65 /*
66  * counter(9) based rate checking.
67  */
68 struct counter_rate {
69 	counter_u64_t	cr_rate;	/* Events since last second */
70 	volatile int	cr_lock;	/* Lock to clean the struct */
71 	int		cr_ticks;	/* Ticks on last clean */
72 	int		cr_over;	/* Over limit since cr_ticks? */
73 };
74 
75 int64_t	counter_ratecheck(struct counter_rate *, int64_t);
76 
77 #define	COUNTER_U64_SYSINIT(c)					\
78 	SYSINIT(c##_counter_sysinit, SI_SUB_COUNTER,		\
79 	    SI_ORDER_ANY, counter_u64_sysinit, &c);		\
80 	SYSUNINIT(c##_counter_sysuninit, SI_SUB_COUNTER,	\
81 	    SI_ORDER_ANY, counter_u64_sysuninit, &c)
82 
83 #define	COUNTER_U64_DEFINE_EARLY(c)				\
84 	counter_u64_t __read_mostly c = EARLY_COUNTER;		\
85 	COUNTER_U64_SYSINIT(c)
86 
87 void counter_u64_sysinit(void *);
88 void counter_u64_sysuninit(void *);
89 
90 #endif	/* _KERNEL */
91 #endif	/* ! __SYS_COUNTER_H__ */
92