openvswitch/lib/ovs-numa.h

/*
 * Copyright (c) 2014 Nicira, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef OVS_NUMA_H
#define OVS_NUMA_H 1

#include <limits.h>
#include <stdbool.h>

#include "compiler.h"
#include "list.h"

#define OVS_CORE_UNSPEC INT_MAX
#define OVS_NUMA_UNSPEC INT_MAX

/* Dump of a list of 'struct ovs_numa_info'. */
struct ovs_numa_dump {
    struct ovs_list dump;
};

/* A numa_id - core_id pair. */
struct ovs_numa_info {
    struct ovs_list list_node;
    int numa_id;
    unsigned core_id;
};

#ifdef __linux__

void ovs_numa_init(void);
bool ovs_numa_numa_id_is_valid(int numa_id);
bool ovs_numa_core_id_is_valid(unsigned core_id);
bool ovs_numa_core_is_pinned(unsigned core_id);
int ovs_numa_get_n_numas(void);
void ovs_numa_set_cpu_mask(const char *cmask);
int ovs_numa_get_n_cores(void);
int ovs_numa_get_numa_id(unsigned core_id);
int ovs_numa_get_n_cores_on_numa(int numa_id);
int ovs_numa_get_n_unpinned_cores_on_numa(int numa_id);
bool ovs_numa_try_pin_core_specific(unsigned core_id);
unsigned ovs_numa_get_unpinned_core_any(void);
unsigned ovs_numa_get_unpinned_core_on_numa(int numa_id);
void ovs_numa_unpin_core(unsigned core_id);
struct ovs_numa_dump *ovs_numa_dump_cores_on_numa(int numa_id);
void ovs_numa_dump_destroy(struct ovs_numa_dump *);

#define FOR_EACH_CORE_ON_NUMA(ITER, DUMP)                    \
    LIST_FOR_EACH((ITER), list_node, &(DUMP)->dump)

#else

static inline void
ovs_numa_init(void)
{
    /* Nothing */
}

static inline bool
ovs_numa_numa_id_is_valid(int numa_id OVS_UNUSED)
{
    return false;
}

static inline bool
ovs_numa_core_id_is_valid(unsigned core_id OVS_UNUSED)
{
    return false;
}

static inline bool
ovs_numa_core_is_pinned(unsigned core_id OVS_UNUSED)
{
    return false;
}

static inline void
ovs_numa_set_cpu_mask(const char *cmask OVS_UNUSED)
{
    /* Nothing */
}

static inline int
ovs_numa_get_n_numas(void)
{
    return OVS_NUMA_UNSPEC;
}

static inline int
ovs_numa_get_n_cores(void)
{
    return OVS_CORE_UNSPEC;
}

static inline int
ovs_numa_get_numa_id(unsigned core_id OVS_UNUSED)
{
    return OVS_NUMA_UNSPEC;
}

static inline int
ovs_numa_get_n_cores_on_numa(int numa_id OVS_UNUSED)
{
    return OVS_CORE_UNSPEC;
}

static inline int
ovs_numa_get_n_unpinned_cores_on_numa(int numa_id OVS_UNUSED)
{
    return OVS_CORE_UNSPEC;
}

static inline bool
ovs_numa_try_pin_core_specific(unsigned core_id OVS_UNUSED)
{
    return false;
}

static inline unsigned
ovs_numa_get_unpinned_core_any(void)
{
    return OVS_CORE_UNSPEC;
}

static inline unsigned
ovs_numa_get_unpinned_core_on_numa(int numa_id OVS_UNUSED)
{
    return OVS_CORE_UNSPEC;
}

static inline void
ovs_numa_unpin_core(unsigned core_id OVS_UNUSED)
{
    /* Nothing */
}

static inline struct ovs_numa_dump *
ovs_numa_dump_cores_on_numa(int numa_id OVS_UNUSED)
{
    return NULL;
}

static inline void
ovs_numa_dump_destroy(struct ovs_numa_dump *dump OVS_UNUSED)
{
    /* Nothing */
}

/* No loop. */
#define FOR_EACH_CORE_ON_NUMA(ITER, DUMP)                    \
    for ((ITER) = NULL; (ITER);)

#endif /* __linux__ */
#endif /* ovs-thead.h */