openpmix-src 0.1.0-rc.1

/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2005 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2010 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2009      Sun Microsystems, Inc.  All rights reserved.
 * Copyright (c) 2009-2011 Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2013      Mellanox Technologies, Inc.
 *                         All rights reserved.
 * Copyright (c) 2013-2020 Intel, Inc.  All rights reserved.
 * Copyright (c) 2016      IBM Corporation.  All rights reserved.
 * Copyright (c) 2021-2025 Nanook Consulting  All rights reserved.
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 *
 */

#ifndef PMIX_CONFIG_BOTTOM_H
#define PMIX_CONFIG_BOTTOM_H

/*
 * If we build a static library, Visual C define the _LIB symbol. In the
 * case of a shared library _USERDLL get defined.
 *
 */
#ifndef PMIX_BUILDING
#    define PMIX_BUILDING 1
#endif

/*
 * Flex is trying to include the unistd.h file. As there is no configure
 * option or this, the flex generated files will try to include the file
 * even on platforms without unistd.h. Therefore, if we
 * know this file is not available, we can prevent flex from including it.
 */
#ifndef HAVE_UNISTD_H
#    define YY_NO_UNISTD_H
#endif

/***********************************************************************
 *
 * code that should be in ompi_config_bottom.h regardless of build
 * status
 *
 **********************************************************************/

/* Do we have posix thread lib */
#define PMIX_HAVE_THREADS (PMIX_HAVE_POSIX_THREADS)

/*
 * BEGIN_C_DECLS should be used at the beginning of your declarations,
 * so that C++ compilers don't mangle their names.  Use END_C_DECLS at
 * the end of C declarations.
 */
#undef BEGIN_C_DECLS
#undef END_C_DECLS
#if defined(c_plusplus) || defined(__cplusplus)
#    define BEGIN_C_DECLS extern "C" {
#    define END_C_DECLS   }
#else
#    define BEGIN_C_DECLS /* empty */
#    define END_C_DECLS   /* empty */
#endif

/* Defined to 1 on Linux */
#undef PMIX_LINUX_SYS

/* Defined to 1 if the CPU_SET macro works */
#undef PMIX_HAVE_CPU_SET

/* Defined to 1 if you have the `windows.h' header. */
#undef PMIX_HAVE_WINDOWS_H
#undef pmix_pid_t
#undef pmix_thread_t

/*
 * Note: this is public.  We can not assume anything from the compiler used
 * by the application and thus the PMIX_HAVE_* macros below are not
 * fetched from the autoconf result here. We only automatically use a few
 * well-known easy cases.
 */

/* Some handy constants to make the logic below a little more readable */
#if defined(__cplusplus) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR >= 4))
#    define GXX_ABOVE_3_4 1
#else
#    define GXX_ABOVE_3_4 0
#endif

#if !defined(__cplusplus) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95))
#    define GCC_ABOVE_2_95 1
#else
#    define GCC_ABOVE_2_95 0
#endif

#if !defined(__cplusplus) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 96))
#    define GCC_ABOVE_2_96 1
#else
#    define GCC_ABOVE_2_96 0
#endif

#if !defined(__cplusplus) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
#    define GCC_ABOVE_3_3 1
#else
#    define GCC_ABOVE_3_3 0
#endif

/**
 * The attribute definition should be included before any potential
 * usage.
 */
#if PMIX_HAVE_ATTRIBUTE_ALIGNED
#    define __pmix_attribute_aligned__(a)  __attribute__((__aligned__(a)))
#    define __pmix_attribute_aligned_max__ __attribute__((__aligned__))
#else
#    define __pmix_attribute_aligned__(a)
#    define __pmix_attribute_aligned_max__
#endif

/* Note that if we're compiling C++, then just use the "inline"
   keyword, since it's part of C++ */
#if defined(c_plusplus) || defined(__cplusplus)
#    define __pmix_inline inline
#elif defined(_MSC_VER) || defined(__HP_cc)
#    define __pmix_inline __inline
#else
#    define __pmix_inline __inline__
#endif

#if PMIX_HAVE_ATTRIBUTE_ALWAYS_INLINE
#    define __pmix_attribute_always_inline__ __attribute__((__always_inline__))
#else
#    define __pmix_attribute_always_inline__
#endif

#if PMIX_HAVE_ATTRIBUTE_COLD
#    define __pmix_attribute_cold__ __attribute__((__cold__))
#else
#    define __pmix_attribute_cold__
#endif

#ifdef PMIX_HAVE_ATTRIBUTE_CONST
#    define __PMIX_HAVE_ATTRIBUTE_CONST PMIX_HAVE_ATTRIBUTE_CONST
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_CONST (GXX_ABOVE_3_4 || GCC_ABOVE_2_95)
#else
#    define __PMIX_HAVE_ATTRIBUTE_CONST 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_CONST
#    define __pmix_attribute_const __attribute__((__const__))
#else
#    define __pmix_attribute_const
#endif

#if PMIX_HAVE_ATTRIBUTE_CONST
#    define __pmix_attribute_const__ __attribute__((__const__))
#else
#    define __pmix_attribute_const__
#endif

#ifdef PMIX_HAVE_ATTRIBUTE_DEPRECATED
#    define __PMIX_HAVE_ATTRIBUTE_DEPRECATED PMIX_HAVE_ATTRIBUTE_DEPRECATED
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_DEPRECATED (GXX_ABOVE_3_4 || GCC_ABOVE_3_3)
#else
#    define __PMIX_HAVE_ATTRIBUTE_DEPRECATED 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_DEPRECATED
#    define __pmix_attribute_deprecated __attribute__((__deprecated__))
#else
#    define __pmix_attribute_deprecated
#endif

#if PMIX_HAVE_ATTRIBUTE_DEPRECATED
#    define __pmix_attribute_deprecated__ __attribute__((__deprecated__))
#else
#    define __pmix_attribute_deprecated__
#endif

#if PMIX_HAVE_ATTRIBUTE_FORMAT
    #    define __pmix_attribute_format__(a, b, c) __attribute__((__format__(a, b, c)))
#else
#    define __pmix_attribute_format__(a, b, c)
#endif

/* Use this __atribute__ on function-ptr declarations, only */
#if PMIX_HAVE_ATTRIBUTE_FORMAT_FUNCPTR
#    define __pmix_attribute_format_funcptr__(a, b, c) __attribute__((__format__(a, b, c)))
#else
#    define __pmix_attribute_format_funcptr__(a, b, c)
#endif

#if PMIX_HAVE_ATTRIBUTE_HOT
#    define __pmix_attribute_hot__ __attribute__((__hot__))
#else
#    define __pmix_attribute_hot__
#endif

#ifdef PMIX_HAVE_ATTRIBUTE_MALLOC
#    define __PMIX_HAVE_ATTRIBUTE_MALLOC PMIX_HAVE_ATTRIBUTE_MALLOC
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_MALLOC (GXX_ABOVE_3_4 || GCC_ABOVE_2_96)
#else
#    define __PMIX_HAVE_ATTRIBUTE_MALLOC 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_MALLOC
#    define __pmix_attribute_malloc __attribute__((__malloc__))
#else
#    define __pmix_attribute_malloc
#endif

#if PMIX_HAVE_ATTRIBUTE_MALLOC
#    define __pmix_attribute_malloc__ __attribute__((__malloc__))
#else
#    define __pmix_attribute_malloc__
#endif

#ifdef PMIX_HAVE_ATTRIBUTE_MAY_ALIAS
#    define __PMIX_HAVE_ATTRIBUTE_MAY_ALIAS PMIX_HAVE_ATTRIBUTE_MAY_ALIAS
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_MAY_ALIAS (GXX_ABOVE_3_4 || GCC_ABOVE_3_3)
#else
#    define __PMIX_HAVE_ATTRIBUTE_MAY_ALIAS 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_MAY_ALIAS
#    define __pmix_attribute_may_alias __attribute__((__may_alias__))
#else
#    define __pmix_attribute_may_alias
#endif

#if PMIX_HAVE_ATTRIBUTE_MAY_ALIAS
#    define __pmix_attribute_may_alias__ __attribute__((__may_alias__))
#else
#    define __pmix_attribute_may_alias__
#endif

#if PMIX_HAVE_ATTRIBUTE_NO_INSTRUMENT_FUNCTION
#    define __pmix_attribute_no_instrument_function__ __attribute__((__no_instrument_function__))
#else
#    define __pmix_attribute_no_instrument_function__
#endif

#if PMIX_HAVE_ATTRIBUTE_NONNULL
#    define __pmix_attribute_nonnull__(a)  __attribute__((__nonnull__(a)))
#    define __pmix_attribute_nonnull_all__ __attribute__((__nonnull__))
#else
#    define __pmix_attribute_nonnull__(a)
#    define __pmix_attribute_nonnull_all__
#endif

#if PMIX_HAVE_ATTRIBUTE_NORETURN
#    define __pmix_attribute_noreturn__ __attribute__((__noreturn__))
#else
#    define __pmix_attribute_noreturn__
#endif

/* Use this __atribute__ on function-ptr declarations, only */
#if PMIX_HAVE_ATTRIBUTE_NORETURN_FUNCPTR
#    define __pmix_attribute_noreturn_funcptr__ __attribute__((__noreturn__))
#else
#    define __pmix_attribute_noreturn_funcptr__
#endif

#if PMIX_HAVE_ATTRIBUTE_PACKED
#    define __pmix_attribute_packed__ __attribute__((__packed__))
#else
#    define __pmix_attribute_packed__
#endif

#ifdef PMIX_HAVE_ATTRIBUTE_PURE
#    define __PMIX_HAVE_ATTRIBUTE_PURE PMIX_HAVE_ATTRIBUTE_PURE
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_PURE (GXX_ABOVE_3_4 || GCC_ABOVE_2_96)
#else
#    define __PMIX_HAVE_ATTRIBUTE_PURE 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_PURE
#    define __pmix_attribute_pure __attribute__((__pure__))
#else
#    define __pmix_attribute_pure
#endif

#if PMIX_HAVE_ATTRIBUTE_PURE
#    define __pmix_attribute_pure__ __attribute__((__pure__))
#else
#    define __pmix_attribute_pure__
#endif

#if PMIX_HAVE_ATTRIBUTE_SENTINEL
    #    define __pmix_attribute_sentinel__ __attribute__((__sentinel__))
#else
#    define __pmix_attribute_sentinel__
#endif

/* Maybe before gcc 2.95 too */
#ifdef PMIX_HAVE_ATTRIBUTE_UNUSED
#    define __PMIX_HAVE_ATTRIBUTE_UNUSED PMIX_HAVE_ATTRIBUTE_UNUSED
#elif defined(__GNUC__)
#    define __PMIX_HAVE_ATTRIBUTE_UNUSED (GXX_ABOVE_3_4 || GCC_ABOVE_2_95)
#else
#    define __PMIX_HAVE_ATTRIBUTE_UNUSED 0
#endif
#if __PMIX_HAVE_ATTRIBUTE_UNUSED
#    define __pmix_attribute_unused __attribute__((__unused__))
#else
#    define __pmix_attribute_unused
#endif

#if PMIX_HAVE_ATTRIBUTE_UNUSED
#    define __pmix_attribute_unused__ __attribute__((__unused__))
#else
#    define __pmix_attribute_unused__
#endif

#if PMIX_HAVE_ATTRIBUTE_WARN_UNUSED_RESULT
#    define __pmix_attribute_warn_unused_result__ __attribute__((__warn_unused_result__))
#else
#    define __pmix_attribute_warn_unused_result__
#endif

#if PMIX_HAVE_ATTRIBUTE_DESTRUCTOR
#    define __pmix_attribute_destructor__ __attribute__((__destructor__))
#else
#    define __pmix_attribute_destructor__
#endif

#if PMIX_HAVE_ATTRIBUTE_OPTNONE
#    define __pmix_attribute_optnone__ __attribute__((__optnone__))
#else
#    define __pmix_attribute_optnone__
#endif

#if PMIX_HAVE_ATTRIBUTE_EXTENSION
#    define __pmix_attribute_extension__ __extension__
#else
#    define __pmix_attribute_extension__
#endif

/*
 * Do we have <stdint.h>?
 */
#ifdef HAVE_STDINT_H
#    if !defined(__STDC_LIMIT_MACROS) && (defined(c_plusplus) || defined(__cplusplus))
/* When using a C++ compiler, the max / min value #defines for std
   types are only included if __STDC_LIMIT_MACROS is set before
   including stdint.h */
#        define __STDC_LIMIT_MACROS
#    endif
#    include "src/include/pmix_config.h"
#    include <stdint.h>
#else
#    include "src/include/pmix_stdint.h"
#endif

/***********************************************************************
 *
 * Code that is only for when building PMIx or utilities that are
 * using the internals of PMIx.  It should not be included when
 * building MPI applications
 *
 **********************************************************************/
#if PMIX_BUILDING

#    ifndef HAVE_PTRDIFF_T
typedef PMIX_PTRDIFF_TYPE ptrdiff_t;
#    endif

/*
 * Maximum size of a filename path.
 */
#    include <limits.h>
#    ifdef HAVE_SYS_PARAM_H
#        include <sys/param.h>
#    endif
#    if defined(PATH_MAX)
#        define PMIX_PATH_MAX (PATH_MAX + 1)
#    elif defined(_POSIX_PATH_MAX)
#        define PMIX_PATH_MAX (_POSIX_PATH_MAX + 1)
#    else
#        define PMIX_PATH_MAX 256
#    endif

#    if defined(MAXHOSTNAMELEN)
#        define PMIX_MAXHOSTNAMELEN (MAXHOSTNAMELEN + 1)
#    elif defined(HOST_NAME_MAX)
#        define PMIX_MAXHOSTNAMELEN (HOST_NAME_MAX + 1)
#    else
/* SUSv2 guarantees that "Host names are limited to 255 bytes". */
#        define PMIX_MAXHOSTNAMELEN (255 + 1)
#    endif

/*
 * Set the compile-time path-separator on this system and variable separator
 */
#    define PMIX_PATH_SEP "/"
#    define PMIX_ENV_SEP  ':'

/*
 * printf functions for portability (only when building PMIx)
 */
#    if !defined(HAVE_VASPRINTF) || !defined(HAVE_VSNPRINTF)
#        include <stdarg.h>
#        include <stdlib.h>
#    endif

#    if !defined(HAVE_ASPRINTF) || !defined(HAVE_SNPRINTF) || !defined(HAVE_VASPRINTF) \
        || !defined(HAVE_VSNPRINTF)
#        include "src/util/pmix_printf.h"
#    endif

#    ifndef HAVE_ASPRINTF
#        define asprintf pmix_asprintf
#    endif

#    ifndef HAVE_SNPRINTF
#        define snprintf pmix_snprintf
#    endif

#    ifndef HAVE_VASPRINTF
#        define vasprintf pmix_vasprintf
#    endif

#    ifndef HAVE_VSNPRINTF
#        define vsnprintf pmix_vsnprintf
#    endif


/*
 * Define __func__-preprocessor directive if the compiler does not
 * already define it.  Define it to __FILE__ so that we at least have
 * a clue where the developer is trying to indicate where the error is
 * coming from (assuming that __func__ is typically used for
 * printf-style debugging).
 */
#    if defined(HAVE_DECL___FUNC__) && !HAVE_DECL___FUNC__
#        define __func__ __FILE__
#    endif

#    define IOVBASE_TYPE void

#    include <stdbool.h>
/**
 * If we generate our own bool type, we need a special way to cast the result
 * in such a way to keep the compilers silent.
 */
#    define PMIX_INT_TO_BOOL(VALUE) (bool) (VALUE)

#    if !defined(HAVE_STRUCT_SOCKADDR_STORAGE) && defined(HAVE_STRUCT_SOCKADDR_IN)
#        define sockaddr_storage sockaddr
#        define ss_family        sa_family
#    endif

/* Compatibility structure so that we don't have to have as many
   #if checks in the code base */
#    if !defined(HAVE_STRUCT_SOCKADDR_IN6) && defined(HAVE_STRUCT_SOCKADDR_IN)
#        define sockaddr_in6 sockaddr_in
#        define sin6_len     sin_len
#        define sin6_family  sin_family
#        define sin6_port    sin_port
#        define sin6_addr    sin_addr
#    endif

#    if !HAVE_DECL_AF_UNSPEC
#        define AF_UNSPEC 0
#    endif
#    if !HAVE_DECL_PF_UNSPEC
#        define PF_UNSPEC 0
#    endif
#    if !HAVE_DECL_AF_INET6
#        define AF_INET6 AF_UNSPEC
#    endif
#    if !HAVE_DECL_PF_INET6
#        define PF_INET6 PF_UNSPEC
#    endif

#    if defined(__APPLE__) && defined(HAVE_INTTYPES_H)
/* Prior to Mac OS X 10.3, the length modifier "ll" wasn't
   supported, but "q" was for long long.  This isn't ANSI
   C and causes a warning when using PRI?64 macros.  We
   don't support versions prior to OS X 10.3, so we don't
   need such backward compatibility.  Instead, redefine
   the macros to be "ll", which is ANSI C and doesn't
   cause a compiler warning. */
#        include <inttypes.h>
#        if defined(__PRI_64_LENGTH_MODIFIER__)
#            undef __PRI_64_LENGTH_MODIFIER__
#            define __PRI_64_LENGTH_MODIFIER__ "ll"
#        endif
#        if defined(__SCN_64_LENGTH_MODIFIER__)
#            undef __SCN_64_LENGTH_MODIFIER__
#            define __SCN_64_LENGTH_MODIFIER__ "ll"
#        endif
#    endif

#    ifdef MCS_VXWORKS
/* VXWorks puts some common functions in oddly named headers.  Rather
   than update all the places the functions are used, which would be a
   maintenance disatster, just update here... */
#        ifdef HAVE_IOLIB_H
/* pipe(), ioctl() */
#            include <ioLib.h>
#        endif
#        ifdef HAVE_SOCKLIB_H
/* socket() */
#            include <sockLib.h>
#        endif
#        ifdef HAVE_HOSTLIB_H
/* gethostname() */
#            include <hostLib.h>
#        endif
#    endif

/* If we're in C++, then just undefine restrict and then define it to
   nothing.  "restrict" is not part of the C++ language, and we don't
   have a corresponding AC_CXX_RESTRICT to figure out what the C++
   compiler supports. */
#    if defined(c_plusplus) || defined(__cplusplus)
#        undef restrict
#        define restrict
#    endif

#    if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95))
#        define __pmix_restrict __restrict
#    else
#        if __STDC_VERSION__ >= 199901L
#            define __pmix_restrict restrict
#        else
#            define __pmix_restrict
#        endif
#    endif

#else

/* For a similar reason to what is listed in pmix_config_top.h, we
   want to protect others from the autoconf/automake-generated
   PACKAGE_<foo> macros in pmix_config.h.  We can't put these undef's
   directly in pmix_config.h because they'll be turned into #defines'
   via autoconf.

   So put them here in case any one else includes PMIX's
   config.h files. */

#    undef PACKAGE_BUGREPORT
#    undef PACKAGE_NAME
#    undef PACKAGE_STRING
#    undef PACKAGE_TARNAME
#    undef PACKAGE_VERSION
#    undef PACKAGE_URL
#    undef HAVE_CONFIG_H

#endif /* PMIX_BUILDING */

#endif /* PMIX_CONFIG_BOTTOM_H */