2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008, Jeffrey Roberson <jeff@freebsd.org>
7 * Copyright (c) 2008 Nokia Corporation
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice unmodified, this list of conditions, and the following
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _SYS_CPUSET_H_
35 #define _SYS_CPUSET_H_
37 #include <sys/_cpuset.h>
39 #include <sys/bitset.h>
41 #define _NCPUBITS _BITSET_BITS
42 #define _NCPUWORDS __bitset_words(CPU_SETSIZE)
44 #define CPUSETBUFSIZ ((2 + sizeof(long) * 2) * _NCPUWORDS)
46 #define CPU_CLR(n, p) BIT_CLR(CPU_SETSIZE, n, p)
47 #define CPU_COPY(f, t) BIT_COPY(CPU_SETSIZE, f, t)
48 #define CPU_ISSET(n, p) BIT_ISSET(CPU_SETSIZE, n, p)
49 #define CPU_SET(n, p) BIT_SET(CPU_SETSIZE, n, p)
50 #define CPU_ZERO(p) BIT_ZERO(CPU_SETSIZE, p)
51 #define CPU_FILL(p) BIT_FILL(CPU_SETSIZE, p)
52 #define CPU_SETOF(n, p) BIT_SETOF(CPU_SETSIZE, n, p)
53 #define CPU_EMPTY(p) BIT_EMPTY(CPU_SETSIZE, p)
54 #define CPU_ISFULLSET(p) BIT_ISFULLSET(CPU_SETSIZE, p)
55 #define CPU_SUBSET(p, c) BIT_SUBSET(CPU_SETSIZE, p, c)
56 #define CPU_OVERLAP(p, c) BIT_OVERLAP(CPU_SETSIZE, p, c)
57 #define CPU_CMP(p, c) BIT_CMP(CPU_SETSIZE, p, c)
58 #define CPU_OR(d, s) BIT_OR(CPU_SETSIZE, d, s)
59 #define CPU_AND(d, s) BIT_AND(CPU_SETSIZE, d, s)
60 #define CPU_ANDNOT(d, s) BIT_ANDNOT(CPU_SETSIZE, d, s)
61 #define CPU_CLR_ATOMIC(n, p) BIT_CLR_ATOMIC(CPU_SETSIZE, n, p)
62 #define CPU_SET_ATOMIC(n, p) BIT_SET_ATOMIC(CPU_SETSIZE, n, p)
63 #define CPU_SET_ATOMIC_ACQ(n, p) BIT_SET_ATOMIC_ACQ(CPU_SETSIZE, n, p)
64 #define CPU_AND_ATOMIC(n, p) BIT_AND_ATOMIC(CPU_SETSIZE, n, p)
65 #define CPU_OR_ATOMIC(d, s) BIT_OR_ATOMIC(CPU_SETSIZE, d, s)
66 #define CPU_COPY_STORE_REL(f, t) BIT_COPY_STORE_REL(CPU_SETSIZE, f, t)
67 #define CPU_FFS(p) BIT_FFS(CPU_SETSIZE, p)
68 #define CPU_COUNT(p) BIT_COUNT(CPU_SETSIZE, p)
69 #define CPUSET_FSET BITSET_FSET(_NCPUWORDS)
70 #define CPUSET_T_INITIALIZER BITSET_T_INITIALIZER
73 * Valid cpulevel_t values.
75 #define CPU_LEVEL_ROOT 1 /* All system cpus. */
76 #define CPU_LEVEL_CPUSET 2 /* Available cpus for which. */
77 #define CPU_LEVEL_WHICH 3 /* Actual mask/id for which. */
80 * Valid cpuwhich_t values.
82 #define CPU_WHICH_TID 1 /* Specifies a thread id. */
83 #define CPU_WHICH_PID 2 /* Specifies a process id. */
84 #define CPU_WHICH_CPUSET 3 /* Specifies a set id. */
85 #define CPU_WHICH_IRQ 4 /* Specifies an irq #. */
86 #define CPU_WHICH_JAIL 5 /* Specifies a jail id. */
87 #define CPU_WHICH_DOMAIN 6 /* Specifies a NUMA domain id. */
88 #define CPU_WHICH_INTRHANDLER 7 /* Specifies an irq # (not ithread). */
89 #define CPU_WHICH_ITHREAD 8 /* Specifies an irq's ithread. */
92 * Reserved cpuset identifiers.
94 #define CPUSET_INVALID -1
95 #define CPUSET_DEFAULT 0
98 #include <sys/queue.h>
100 LIST_HEAD(setlist, cpuset);
103 * cpusets encapsulate cpu binding information for one or more threads.
105 * a - Accessed with atomics.
106 * s - Set at creation, never modified. Only a ref required to read.
107 * c - Locked internally by a cpuset lock.
109 * The bitmask is only modified while holding the cpuset lock. It may be
110 * read while only a reference is held but the consumer must be prepared
111 * to deal with inconsistent results.
114 cpuset_t cs_mask; /* bitmask of valid cpus. */
115 struct domainset *cs_domain; /* (c) NUMA policy. */
116 volatile u_int cs_ref; /* (a) Reference count. */
117 int cs_flags; /* (s) Flags from below. */
118 cpusetid_t cs_id; /* (s) Id or INVALID. */
119 struct cpuset *cs_parent; /* (s) Pointer to our parent. */
120 LIST_ENTRY(cpuset) cs_link; /* (c) All identified sets. */
121 LIST_ENTRY(cpuset) cs_siblings; /* (c) Sibling set link. */
122 struct setlist cs_children; /* (c) List of children. */
125 #define CPU_SET_ROOT 0x0001 /* Set is a root set. */
126 #define CPU_SET_RDONLY 0x0002 /* No modification allowed. */
128 extern cpuset_t *cpuset_root;
133 struct cpuset *cpuset_thread0(void);
134 struct cpuset *cpuset_ref(struct cpuset *);
135 void cpuset_rel(struct cpuset *);
136 int cpuset_setthread(lwpid_t id, cpuset_t *);
137 int cpuset_setithread(lwpid_t id, int cpu);
138 int cpuset_create_root(struct prison *, struct cpuset **);
139 int cpuset_setproc_update_set(struct proc *, struct cpuset *);
140 int cpuset_which(cpuwhich_t, id_t, struct proc **,
141 struct thread **, struct cpuset **);
142 void cpuset_kernthread(struct thread *);
144 char *cpusetobj_strprint(char *, const cpuset_t *);
145 int cpusetobj_strscan(cpuset_t *, const char *);
147 void ddb_display_cpuset(const cpuset_t *);
152 int cpuset(cpusetid_t *);
153 int cpuset_setid(cpuwhich_t, id_t, cpusetid_t);
154 int cpuset_getid(cpulevel_t, cpuwhich_t, id_t, cpusetid_t *);
155 int cpuset_getaffinity(cpulevel_t, cpuwhich_t, id_t, size_t, cpuset_t *);
156 int cpuset_setaffinity(cpulevel_t, cpuwhich_t, id_t, size_t, const cpuset_t *);
159 #endif /* !_SYS_CPUSET_H_ */