1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
29#ifndef _SYS_DOMAINSET_H_
30#define _SYS_DOMAINSET_H_
31
32#include <sys/_domainset.h>
33#include <sys/bitset.h>
34#include <sys/queue.h>
35
36#define _NDOMAINSETBITS _BITSET_BITS
37#define _NDOMAINSETWORDS __bitset_words(DOMAINSET_SETSIZE)
38
39#define DOMAINSETBUFSIZ \
40 (((2 + sizeof(long) * 2) * _NDOMAINSETWORDS) + \
41 sizeof("::") + sizeof(__XSTRING(DOMAINSET_POLICY_MAX)) + \
42 sizeof(__XSTRING(MAXMEMDOM)))
43
44#define DOMAINSET_CLR(n, p) __BIT_CLR(DOMAINSET_SETSIZE, n, p)
45#define DOMAINSET_COPY(f, t) __BIT_COPY(DOMAINSET_SETSIZE, f, t)
46#define DOMAINSET_ISSET(n, p) __BIT_ISSET(DOMAINSET_SETSIZE, n, p)
47#define DOMAINSET_SET(n, p) __BIT_SET(DOMAINSET_SETSIZE, n, p)
48#define DOMAINSET_ZERO(p) __BIT_ZERO(DOMAINSET_SETSIZE, p)
49#define DOMAINSET_FILL(p) __BIT_FILL(DOMAINSET_SETSIZE, p)
50#define DOMAINSET_SETOF(n, p) __BIT_SETOF(DOMAINSET_SETSIZE, n, p)
51#define DOMAINSET_EMPTY(p) __BIT_EMPTY(DOMAINSET_SETSIZE, p)
52#define DOMAINSET_ISFULLSET(p) __BIT_ISFULLSET(DOMAINSET_SETSIZE, p)
53#define DOMAINSET_SUBSET(p, c) __BIT_SUBSET(DOMAINSET_SETSIZE, p, c)
54#define DOMAINSET_OVERLAP(p, c) __BIT_OVERLAP(DOMAINSET_SETSIZE, p, c)
55#define DOMAINSET_CMP(p, c) __BIT_CMP(DOMAINSET_SETSIZE, p, c)
56#define DOMAINSET_OR(d, s) __BIT_OR(DOMAINSET_SETSIZE, d, s)
57#define DOMAINSET_ORNOT(d, s) __BIT_ORNOT(DOMAINSET_SETSIZE, d, s)
58#define DOMAINSET_AND(d, s) __BIT_AND(DOMAINSET_SETSIZE, d, s)
59#define DOMAINSET_ANDNOT(d, s) __BIT_ANDNOT(DOMAINSET_SETSIZE, d, s)
60#define DOMAINSET_CLR_ATOMIC(n, p) __BIT_CLR_ATOMIC(DOMAINSET_SETSIZE, n, p)
61#define DOMAINSET_SET_ATOMIC(n, p) __BIT_SET_ATOMIC(DOMAINSET_SETSIZE, n, p)
62#define DOMAINSET_SET_ATOMIC_ACQ(n, p) \
63 __BIT_SET_ATOMIC_ACQ(DOMAINSET_SETSIZE, n, p)
64#define DOMAINSET_AND_ATOMIC(n, p) __BIT_AND_ATOMIC(DOMAINSET_SETSIZE, n, p)
65#define DOMAINSET_OR_ATOMIC(d, s) __BIT_OR_ATOMIC(DOMAINSET_SETSIZE, d, s)
66#define DOMAINSET_COPY_STORE_REL(f, t) \
67 __BIT_COPY_STORE_REL(DOMAINSET_SETSIZE, f, t)
68#define DOMAINSET_FFS(p) __BIT_FFS(DOMAINSET_SETSIZE, p)
69#define DOMAINSET_FLS(p) __BIT_FLS(DOMAINSET_SETSIZE, p)
70#define DOMAINSET_COUNT(p) ((int)__BIT_COUNT(DOMAINSET_SETSIZE, p))
71#define DOMAINSET_FSET __BITSET_FSET(_NDOMAINSETWORDS)
72#define DOMAINSET_T_INITIALIZER(x) __BITSET_T_INITIALIZER(x)
73
74#define DOMAINSET_POLICY_INVALID 0
75#define DOMAINSET_POLICY_ROUNDROBIN 1
76#define DOMAINSET_POLICY_FIRSTTOUCH 2
77#define DOMAINSET_POLICY_PREFER 3
78#define DOMAINSET_POLICY_INTERLEAVE 4
79#define DOMAINSET_POLICY_MAX DOMAINSET_POLICY_INTERLEAVE
80
81#ifdef _KERNEL
82#if MAXMEMDOM < 256
83typedef uint8_t domainid_t;
84#else
85typedef uint16_t domainid_t;
86#endif
87
88struct domainset {
89 LIST_ENTRY(domainset) ds_link;
90 domainset_t ds_mask; /* allowed domains. */
91 uint16_t ds_policy; /* Policy type. */
92 domainid_t ds_prefer; /* Preferred domain or -1. */
93 domainid_t ds_cnt; /* popcnt from above. */
94 domainid_t ds_order[MAXMEMDOM]; /* nth domain table. */
95};
96
97extern struct domainset domainset_firsttouch;
98#define DOMAINSET_FT() (&domainset_firsttouch)
99extern struct domainset domainset_interleave;
100#define DOMAINSET_IL() (&domainset_interleave)
101extern struct domainset domainset_fixed[MAXMEMDOM], domainset_prefer[MAXMEMDOM];
102#define DOMAINSET_FIXED(domain) (&domainset_fixed[(domain)])
103#define DOMAINSET_PREF(domain) (&domainset_prefer[(domain)])
104extern struct domainset domainset_roundrobin;
105#define DOMAINSET_RR() (&domainset_roundrobin)
106
107void domainset_init(void);
108void domainset_zero(void);
109
110/*
111 * Add a domainset to the system based on a key initializing policy, prefer,
112 * and mask. Do not create and directly use domainset structures. The
113 * returned value will not match the key pointer.
114 */
115struct domainset *domainset_create(const struct domainset *);
116
117/*
118 * Remove empty domains from a given domainset.
119 * Returns 'false' if the domainset consists entirely of empty domains.
120 */
121bool domainset_empty_vm(struct domainset *domain);
122
123/*
124 * Validate and populate a domainset structure according to the specified
125 * policy and mask.
126 */
127int domainset_populate(struct domainset *domain, const domainset_t *mask, int policy,
128 size_t mask_size);
129
130#ifdef _SYS_SYSCTL_H_
131int sysctl_handle_domainset(SYSCTL_HANDLER_ARGS);
132#endif
133
134#else
135__BEGIN_DECLS
136int cpuset_getdomain(cpulevel_t, cpuwhich_t, id_t, size_t, domainset_t *,
137 int *);
138int cpuset_setdomain(cpulevel_t, cpuwhich_t, id_t, size_t,
139 const domainset_t *, int);
140
141__END_DECLS
142#endif
143#endif /* !_SYS_DOMAINSET_H_ */