numa.hpp

Go to the documentation of this file.

/**
 * @file
 * @ingroup numapp_numa
 * @copyright
 *   SPDX-FileCopyrightText: 2023-2023 European Southern Observatory (ESO)
 *
 *   SPDX-License-Identifier: LGPL-3.0-only
 */
#ifndef NUMAPP_NUMA_HPP
#define NUMAPP_NUMA_HPP
#include <numa.h>
 
namespace numapp {
 
/**
 * Query whether system has NUMA support.
 *
 * Example use:
 *
 * @include schedulerExample1.cpp
 *
 * @returns true if system has NUMA support available.
 * @returns false otherwise which makes result of any other NUMA++ function unspecified.
 *
 * @manpages
 * @manpage{numa,3,@c numa_available}
 * @ingroup numapp_numa
 * @par Header file
 * @c <numapp/numa.hpp>
 */
[[nodiscard]] inline bool NumaAvailable() noexcept;
 
}  // namespace numapp
 
[[nodiscard]] inline bool numapp::NumaAvailable() noexcept {
    return numa_available() != -1;
}
 
#endif  // NUMAPP_NUMA_HPP