/*
 * Copyright (c) 2013-2014 Richard Braun.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * Processors represented as bit maps.
 *
 * This module acts as a convenient frontend for the bitmap and kmem modules.
 * Since the size of a CPU map varies with the maximum number of processors
 * that can be managed by the system, maps must not be allocated from the
 * stack.
 */

#ifndef KERN_CPUMAP_H
#define KERN_CPUMAP_H

#include <kern/bitmap.h>
#include <kern/init.h>

struct cpumap {
    BITMAP_DECLARE(cpus, CONFIG_MAX_CPUS);
};

static inline void
cpumap_zero(struct cpumap *cpumap)
{
    bitmap_zero(cpumap->cpus, CONFIG_MAX_CPUS);
}

static inline void
cpumap_fill(struct cpumap *cpumap)
{
    bitmap_fill(cpumap->cpus, CONFIG_MAX_CPUS);
}

static inline void
cpumap_copy(struct cpumap *dest, const struct cpumap *src)
{
    bitmap_copy(dest->cpus, src->cpus, CONFIG_MAX_CPUS);
}

static inline int
cpumap_cmp(const struct cpumap *a, const struct cpumap *b)
{
    return bitmap_cmp(a->cpus, b->cpus, CONFIG_MAX_CPUS);
}

static inline void
cpumap_set(struct cpumap *cpumap, int index)
{
    bitmap_set(cpumap->cpus, index);
}

static inline void
cpumap_set_atomic(struct cpumap *cpumap, int index)
{
    bitmap_set_atomic(cpumap->cpus, index);
}

static inline void
cpumap_clear(struct cpumap *cpumap, int index)
{
    bitmap_clear(cpumap->cpus, index);
}

static inline void
cpumap_clear_atomic(struct cpumap *cpumap, int index)
{
    bitmap_clear_atomic(cpumap->cpus, index);
}

static inline int
cpumap_test(const struct cpumap *cpumap, int index)
{
    return bitmap_test(cpumap->cpus, index);
}

static inline void
cpumap_and(struct cpumap *a, const struct cpumap *b)
{
    bitmap_and(a->cpus, b->cpus, CONFIG_MAX_CPUS);
}

static inline void
cpumap_or(struct cpumap *a, const struct cpumap *b)
{
    bitmap_or(a->cpus, b->cpus, CONFIG_MAX_CPUS);
}

static inline void
cpumap_xor(struct cpumap *a, const struct cpumap *b)
{
    bitmap_xor(a->cpus, b->cpus, CONFIG_MAX_CPUS);
}

static inline int
cpumap_find_next(const struct cpumap *cpumap, int index)
{
    return bitmap_find_next(cpumap->cpus, CONFIG_MAX_CPUS, index);
}

static inline int
cpumap_find_first(const struct cpumap *cpumap)
{
    return bitmap_find_first(cpumap->cpus, CONFIG_MAX_CPUS);
}

static inline int
cpumap_find_next_zero(const struct cpumap *cpumap, int index)
{
    return bitmap_find_next_zero(cpumap->cpus, CONFIG_MAX_CPUS, index);
}

static inline int
cpumap_find_first_zero(const struct cpumap *cpumap)
{
    return bitmap_find_first_zero(cpumap->cpus, CONFIG_MAX_CPUS);
}

#define cpumap_for_each(cpumap, index) \
    bitmap_for_each((cpumap)->cpus, CONFIG_MAX_CPUS, index)

#define cpumap_for_each_zero(cpumap, index) \
    bitmap_for_each_zero((cpumap)->cpus, CONFIG_MAX_CPUS, index)

/*
 * Return a cpumap representing all active processors.
 *
 * Until the cpumap module is initialized, the cpumap returned by this
 * function describes the BSP only.
 */
const struct cpumap * cpumap_all(void);

/*
 * Allocate a CPU map.
 *
 * The new map is uninitialized.
 */
int cpumap_create(struct cpumap **cpumapp);

/*
 * Release a CPU map.
 */
void cpumap_destroy(struct cpumap *cpumap);

/*
 * Check the validity of a CPU map.
 *
 * If the map doesn't identify at least one managed processor, return
 * EINVAL.
 */
int cpumap_check(const struct cpumap *cpumap);

/*
 * This init operation provides :
 *  - cpumap creation
 *  - module fully initialized
 */
INIT_OP_DECLARE(cpumap_setup);

#endif /* KERN_CPUMAP_H */