nm_public.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-2026 (see AUTHORS file)
 *
 * 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 2 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.
 */
 
#ifndef NM_PUBLIC_H
#define NM_PUBLIC_H
 
#include <stdlib.h>
#include <stdio.h>
#include <stdint.h>
#include <unistd.h>
#include <nm_config.h>
#include <nm_errno.h>
#include <nm_types.h>
#include <Padico/Puk.h>
#if defined(NMAD_PIOMAN)
#  include <pioman.h>
#endif
 
/* ** Display info & warnings ****************************** */
 
#define NM_DISPF(str, ...)      padico_out(puk_verbose_info, str, ## __VA_ARGS__)
 
#define NM_TRACEF(str, ...)     padico_trace(str, ## __VA_ARGS__)
 
#define NM_WARN(format, ...)    padico_warning(format, ## __VA_ARGS__)
 
#define NM_FATAL(format, ...)   padico_fatal(format, ## __VA_ARGS__)
 
/* ** C++ external linkage ********************************* */
 
#ifdef __cplusplus
#define NM_EXTERN_C extern "C"
#define NM_EXTERN_C_BEGIN extern "C" {
#define NM_EXTERN_C_END }
#else /* __cplusplus */
#define NM_EXTERN_C
#define NM_EXTERN_C_BEGIN
#define NM_EXTERN_C_END
#endif /* __cplusplus */
 
/* ** Config sanity checks ********************************* */
 
#if !defined(NMAD)
#  error "nmad CFLAGS not defined; please compile with CFLAGS returned by 'pkg-config --cflags nmad'"
#endif /* NMAD */
 
#if defined(NMAD_PIOMAN) && !defined(PIOMAN)
#  error "nmad was configured with pioman support; cannot build without pioman flags."
#endif
 
#if defined(PIOMAN) && !defined(NMAD_PIOMAN)
#  error "nmad was configured without pioman support; cannot build with pioman flags."
#endif
 
#if defined(NMAD_PUKABI) && !defined(PUKABI)
#  error "nmad was configured with PukABI support; cannot build without PukABI flags."
#endif
 
#if defined(PUKABI) && !defined(NMAD_PUKABI)
#  error "nmad was configured without PukABI support; cannot build with PukABI flags."
#endif
 
#if defined(PIOMAN_TOPOLOGY_HWLOC) && !defined(NMAD_HWLOC)
#  error "pioman was configured with hwloc, but nmad was configured without hwloc."
#endif
 
#if defined(NMAD_SIMGRID) && !defined(PUK_SIMGRID)
#  error "nmad was configured with simgrid, but Puk was configured without simgrid."
#endif
 
#if defined(PUK_SIMGRID) && !defined(NMAD_SIMGRID)
#  error "Puk was configured with simgrid, but nmad was configured without simgrid."
#endif
 
#if defined(NMAD_SIMGRID) && (defined(PIOMAN) && !defined(PIOMAN_SIMGRID))
#  error "nmad was configured with simgrid, but pioman was configured without simgrid."
#endif
 
 
/* ** ABI config ******************************************* */
 
#ifdef NMAD_PIOMAN
#  define NMAD_CONFIG_PIOMAN 1
#else
#  define NMAD_CONFIG_PIOMAN 0
#endif
 
#ifdef NMAD_HWLOC
#  define NMAD_CONFIG_HWLOC 1
#else
#  define NMAD_CONFIG_HWLOC 0
#endif
 
#ifdef NMAD_PUKABI
#  define NMAD_CONFIG_PUKABI 1
#else
#  define NMAD_CONFIG_PUKABI 0
#endif
 
#ifdef NMAD_DEBUG
#  define NMAD_CONFIG_DEBUG 1
#else
#  define NMAD_CONFIG_DEBUG 0
#endif
 
#ifdef NDEBUG
#  define NMAD_CONFIG_NDEBUG 1
#else
#  define NMAD_CONFIG_NDEBUG 0
#endif
 
#ifdef NMAD_SIMGRID
#  define NMAD_CONFIG_SIMGRID 1
#else
#  define NMAD_CONFIG_SIMGRID 0
#endif
 
#ifdef NMAD_CUDA
#  define NMAD_CONFIG_CUDA 1
#else
#  define NMAD_CONFIG_CUDA 0
#endif
 
#ifdef NMAD_HIP
#  define NMAD_CONFIG_HIP 1
#else
#  define NMAD_CONFIG_HIP 0
#endif
 
#define NM_TOSTRING2(s) #s
#define NM_TOSTRING(s) NM_TOSTRING2(s)
 
#define NMAD_CONFIG_STRING                             \
  " pioman = "  NM_TOSTRING(NMAD_CONFIG_PIOMAN)        \
  " hwloc = "   NM_TOSTRING(NMAD_CONFIG_HWLOC)         \
  " pukabi = "  NM_TOSTRING(NMAD_CONFIG_PUKABI)        \
  " debug = "   NM_TOSTRING(NMAD_CONFIG_DEBUG)         \
  " ndebug = "  NM_TOSTRING(NMAD_CONFIG_NDEBUG)        \
  " simgrid = " NM_TOSTRING(NMAD_CONFIG_SIMGRID)       \
  " cuda = "    NM_TOSTRING(NMAD_CONFIG_CUDA)          \
  " hip = "     NM_TOSTRING(NMAD_CONFIG_HIP)
 
#define NMAD_ABI_CONFIG_STRING                         \
  " pioman = "  NM_TOSTRING(NMAD_CONFIG_PIOMAN)        \
  " hwloc = "   NM_TOSTRING(NMAD_CONFIG_HWLOC)         \
  " pukabi = "  NM_TOSTRING(NMAD_CONFIG_PUKABI)        \
  " debug = "   NM_TOSTRING(NMAD_CONFIG_DEBUG)         \
  " simgrid = " NM_TOSTRING(NMAD_CONFIG_SIMGRID)       \
  " cuda = "    NM_TOSTRING(NMAD_CONFIG_CUDA)          \
  " hip = "     NM_TOSTRING(NMAD_CONFIG_HIP)
 
NM_EXTERN_C void nm_abi_config_check_internal(const char*p_config);
 
static inline void nm_abi_config_check(void)
{
  /* capture ABI config in application context
   * and compare with nmad builtin ABI config */
  nm_abi_config_check_internal(NMAD_ABI_CONFIG_STRING);
}
 
#endif /* NM_PUBLIC_H */