source: mainline/kernel/generic/include/cpu/cpu_mask.h@ 0b7bcb8

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 0b7bcb8 was c79800f, checked in by Adam Hraska <adam.hraska+hos@…>, 13 years ago

Added cpu_mask: represents a set of cpus with a bit vector.

  • Property mode set to 100644
File size: 2.7 KB
Line 
1/*
2 * Copyright (c) 2012 Adam Hraska
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
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/** @addtogroup generic
30 * @{
31 */
32/** @file
33 */
34#ifndef KERN_CPU_CPU_MASK_H_
35#define KERN_CPU_CPU_MASK_H_
36
37#include <cpu.h>
38#include <config.h>
39#include <lib/memfnc.h>
40
41/** Iterates over all cpu id's whose bit is included in the cpu mask.
42 *
43 * Example usage:
44 * @code
45 * DEFINE_CPU_MASK(cpu_mask);
46 * cpu_mask_active(&cpu_mask);
47 *
48 * cpu_mask_for_each(cpu_mask, cpu_id) {
49 * printf("Cpu with logical id %u is active.\n", cpu_id);
50 * }
51 * @endcode
52 */
53#define cpu_mask_for_each(mask, cpu_id) \
54 for (unsigned int (cpu_id) = 0; (cpu_id) < config.cpu_count; ++(cpu_id)) \
55 if (cpu_mask_is_set(&(mask), (cpu_id)))
56
57/** Allocates a cpu_mask_t on stack. */
58#define DEFINE_CPU_MASK(cpu_mask) \
59 cpu_mask_t *(cpu_mask) = (cpu_mask_t*) alloca(cpu_mask_size())
60
61/** If used with DEFINE_CPU_MASK, the mask is large enough for all detected cpus.*/
62typedef struct cpu_mask {
63 unsigned int mask[1];
64} cpu_mask_t;
65
66
67extern size_t cpu_mask_size(void);
68extern void cpu_mask_active(cpu_mask_t *);
69extern void cpu_mask_all(cpu_mask_t *);
70extern void cpu_mask_none(cpu_mask_t *);
71extern void cpu_mask_set(cpu_mask_t *, unsigned int);
72extern void cpu_mask_reset(cpu_mask_t *, unsigned int);
73extern bool cpu_mask_is_set(cpu_mask_t *, unsigned int);
74extern bool cpu_mask_is_none(cpu_mask_t *);
75
76#endif /* KERN_CPU_CPU_MASK_H_ */
77
78/** @}
79 */
Note: See TracBrowser for help on using the repository browser.