1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2017,	Jeffrey Roberson <jeff@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 unmodified, this list of conditions, and the following
12 *    disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#ifndef _SYS_DOMAINSET_H_
32#define	_SYS_DOMAINSET_H_
33
34#include <sys/_domainset.h>
35#include <sys/bitset.h>
36#include <sys/queue.h>
37
38#define	_NDOMAINSETBITS			_BITSET_BITS
39#define	_NDOMAINSETWORDS		__bitset_words(DOMAINSET_SETSIZE)
40
41#define	DOMAINSETBUFSIZ							\
42	    (((2 + sizeof(long) * 2) * _NDOMAINSETWORDS) +		\
43	    sizeof("::") + sizeof(__XSTRING(DOMAINSET_POLICY_MAX)) +	\
44	    sizeof(__XSTRING(MAXMEMDOM)))
45
46#define	DOMAINSET_CLR(n, p)		BIT_CLR(DOMAINSET_SETSIZE, n, p)
47#define	DOMAINSET_COPY(f, t)		BIT_COPY(DOMAINSET_SETSIZE, f, t)
48#define	DOMAINSET_ISSET(n, p)		BIT_ISSET(DOMAINSET_SETSIZE, n, p)
49#define	DOMAINSET_SET(n, p)		BIT_SET(DOMAINSET_SETSIZE, n, p)
50#define	DOMAINSET_ZERO(p) 		BIT_ZERO(DOMAINSET_SETSIZE, p)
51#define	DOMAINSET_FILL(p) 		BIT_FILL(DOMAINSET_SETSIZE, p)
52#define	DOMAINSET_SETOF(n, p)		BIT_SETOF(DOMAINSET_SETSIZE, n, p)
53#define	DOMAINSET_EMPTY(p)		BIT_EMPTY(DOMAINSET_SETSIZE, p)
54#define	DOMAINSET_ISFULLSET(p)		BIT_ISFULLSET(DOMAINSET_SETSIZE, p)
55#define	DOMAINSET_SUBSET(p, c)		BIT_SUBSET(DOMAINSET_SETSIZE, p, c)
56#define	DOMAINSET_OVERLAP(p, c)		BIT_OVERLAP(DOMAINSET_SETSIZE, p, c)
57#define	DOMAINSET_CMP(p, c)		BIT_CMP(DOMAINSET_SETSIZE, p, c)
58#define	DOMAINSET_OR(d, s)		BIT_OR(DOMAINSET_SETSIZE, d, s)
59#define	DOMAINSET_AND(d, s)		BIT_AND(DOMAINSET_SETSIZE, d, s)
60#define	DOMAINSET_ANDNOT(d, s)		BIT_ANDNOT(DOMAINSET_SETSIZE, d, s)
61#define	DOMAINSET_CLR_ATOMIC(n, p)	BIT_CLR_ATOMIC(DOMAINSET_SETSIZE, n, p)
62#define	DOMAINSET_SET_ATOMIC(n, p)	BIT_SET_ATOMIC(DOMAINSET_SETSIZE, n, p)
63#define	DOMAINSET_SET_ATOMIC_ACQ(n, p)					\
64	    BIT_SET_ATOMIC_ACQ(DOMAINSET_SETSIZE, n, p)
65#define	DOMAINSET_AND_ATOMIC(n, p)	BIT_AND_ATOMIC(DOMAINSET_SETSIZE, n, p)
66#define	DOMAINSET_OR_ATOMIC(d, s)	BIT_OR_ATOMIC(DOMAINSET_SETSIZE, d, s)
67#define	DOMAINSET_COPY_STORE_REL(f, t)					\
68	    BIT_COPY_STORE_REL(DOMAINSET_SETSIZE, f, t)
69#define	DOMAINSET_FFS(p)		BIT_FFS(DOMAINSET_SETSIZE, p)
70#define	DOMAINSET_FLS(p)		BIT_FLS(DOMAINSET_SETSIZE, p)
71#define	DOMAINSET_COUNT(p)		((int)BIT_COUNT(DOMAINSET_SETSIZE, p))
72#define	DOMAINSET_FSET			BITSET_FSET(_NDOMAINSETWORDS)
73#define	DOMAINSET_T_INITIALIZER		BITSET_T_INITIALIZER
74
75#define	DOMAINSET_POLICY_INVALID	0
76#define	DOMAINSET_POLICY_ROUNDROBIN	1
77#define	DOMAINSET_POLICY_FIRSTTOUCH	2
78#define	DOMAINSET_POLICY_PREFER		3
79#define	DOMAINSET_POLICY_INTERLEAVE	4
80#define	DOMAINSET_POLICY_MAX		DOMAINSET_POLICY_INTERLEAVE
81
82#ifdef _KERNEL
83#if MAXMEMDOM < 256
84typedef	uint8_t		domainid_t;
85#else
86typedef uint16_t	domainid_t;
87#endif
88
89struct domainset {
90	LIST_ENTRY(domainset)	ds_link;
91	domainset_t	ds_mask;	/* allowed domains. */
92	uint16_t	ds_policy;	/* Policy type. */
93	domainid_t	ds_prefer;	/* Preferred domain or -1. */
94	domainid_t	ds_cnt;		/* popcnt from above. */
95	domainid_t	ds_order[MAXMEMDOM];  /* nth domain table. */
96};
97
98extern struct domainset domainset_firsttouch;
99#define	DOMAINSET_FT()		(&domainset_firsttouch)
100extern struct domainset domainset_interleave;
101#define	DOMAINSET_IL()		(&domainset_interleave)
102extern struct domainset domainset_fixed[MAXMEMDOM], domainset_prefer[MAXMEMDOM];
103#define	DOMAINSET_FIXED(domain)	(&domainset_fixed[(domain)])
104#define	DOMAINSET_PREF(domain)	(&domainset_prefer[(domain)])
105extern struct domainset domainset_roundrobin;
106#define	DOMAINSET_RR()		(&domainset_roundrobin)
107
108void domainset_init(void);
109void domainset_zero(void);
110
111/*
112 * Add a domainset to the system based on a key initializing policy, prefer,
113 * and mask.  Do not create and directly use domainset structures.  The
114 * returned value will not match the key pointer.
115 */
116struct domainset *domainset_create(const struct domainset *);
117#ifdef _SYS_SYSCTL_H_
118int sysctl_handle_domainset(SYSCTL_HANDLER_ARGS);
119#endif
120
121#else
122__BEGIN_DECLS
123int	cpuset_getdomain(cpulevel_t, cpuwhich_t, id_t, size_t, domainset_t *,
124	    int *);
125int	cpuset_setdomain(cpulevel_t, cpuwhich_t, id_t, size_t,
126	    const domainset_t *, int);
127
128__END_DECLS
129#endif
130#endif /* !_SYS_DOMAINSET_H_ */
131