nl_private.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
#ifndef OPENNL_PRIVATE_H
#define OPENNL_PRIVATE_H
 
#include "nl.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <math.h>
 
#ifndef NDEBUG
#define NL_DEBUG
#endif
 
#if defined(__APPLE__) && defined(__MACH__)
#define NL_OS_APPLE
#endif
 
#if defined(__linux__) || defined(__ANDROID__) || defined(NL_OS_APPLE)
#define NL_OS_UNIX
#endif
 
 
#if defined(WIN32) || defined(_WIN64)
#define NL_OS_WINDOWS
#endif
 
#define nl_arg_used(x) (void)x
 
#if defined(__clang__) || defined(__GNUC__)
#define NL_NORETURN __attribute__((noreturn))
#else
#define NL_NORETURN
#endif
 
#if defined(_MSC_VER)
#define NL_NORETURN_DECL __declspec(noreturn)
#else
#define NL_NORETURN_DECL
#endif
 
NL_NORETURN_DECL void nl_assertion_failed(
    const char* cond, const char* file, int line
) NL_NORETURN;
 
NL_NORETURN_DECL void nl_range_assertion_failed(
    double x, double min_val, double max_val, const char* file, int line
) NL_NORETURN;
 
NL_NORETURN_DECL void nl_should_not_have_reached(
    const char* file, int line
) NL_NORETURN;
 
#define nl_assert(x) {                                          \
        if(!(x)) {                                              \
            nl_assertion_failed(#x,__FILE__, __LINE__) ;        \
        }                                                       \
    }
 
#define nl_range_assert(x,min_val,max_val) {                            \
        if(((int)(x) < (int)(min_val)) || ((int)(x) > (int)(max_val))) { \
            nl_range_assertion_failed(x, min_val, max_val,              \
                                      __FILE__, __LINE__                \
                                     ) ;                                \
        }                                                               \
    }
 
#define nl_assert_not_reached {                                 \
        nl_should_not_have_reached(__FILE__, __LINE__) ;        \
    }
 
#ifdef NL_DEBUG
#define nl_debug_assert(x) nl_assert(x)
#define nl_debug_range_assert(x,min_val,max_val)        \
    nl_range_assert(x,min_val,max_val)
#else
#define nl_debug_assert(x)
#define nl_debug_range_assert(x,min_val,max_val)
#endif
 
#ifdef NL_PARANOID
#define nl_parano_assert(x) nl_assert(x)
#define nl_parano_range_assert(x,min_val,max_val)       \
    nl_range_assert(x,min_val,max_val)
#else
#define nl_parano_assert(x)
#define nl_parano_range_assert(x,min_val,max_val)
#endif
 
void nlError(const char* function, const char* message) ;
 
void nlWarning(const char* function, const char* message) ;
 
NLdouble nlCurrentTime(void);
 
 
NLuint nlGetNumCores(void);
 
NLuint nlGetNumThreads(void);
 
void nlSetNumThreads(NLuint nb_threads);
 
typedef void* NLdll;
 
 
#define NL_LINK_NOW    1
 
#define NL_LINK_LAZY   2
 
#define NL_LINK_GLOBAL 4
 
#define NL_LINK_QUIET  8
 
#define NL_LINK_USE_FALLBACK 16
 
NLdll nlOpenDLL(const char* filename, NLenum flags);
 
void nlCloseDLL(NLdll handle);
 
NLfunc nlFindFunction(NLdll handle, const char* funcname);
 
/******************************************************************************/
/* classic macros */
 
#ifndef MIN
#define MIN(x,y) (((x) < (y)) ? (x) : (y))
#endif
 
#ifndef MAX
#define MAX(x,y) (((x) > (y)) ? (x) : (y))
#endif
 
 
#define NL_NEW(T)                (T*)(calloc(1, sizeof(T)))
 
#define NL_NEW_ARRAY(T,NB)       (T*)(calloc((size_t)(NB),sizeof(T)))
 
#define NL_RENEW_ARRAY(T,x,NB)   (T*)(realloc(x,(size_t)(NB)*sizeof(T)))
 
#define NL_DELETE(x)             free(x); x = NULL
 
#define NL_DELETE_ARRAY(x)       free(x); x = NULL
 
#define NL_CLEAR(T, x)           memset(x, 0, sizeof(T))
 
#define NL_CLEAR_ARRAY(T,x,NB)   memset(x, 0, (size_t)(NB)*sizeof(T))
 
#define NL_UINT_MAX 0xffffffff
 
#define NL_USHORT_MAX 0xffff
 
extern NLprintfFunc nl_printf;
 
extern NLfprintfFunc nl_fprintf;
 
#endif