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