nvhls_assert.h

/*
 * Copyright (c) 2017-2019, NVIDIA CORPORATION.  All rights reserved.
 * 
 * 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 NVHLS_ASSERT_H
#define NVHLS_ASSERT_H

#include <systemc.h>
#include <hls_globals.h>

// the following is to avoid "statement has no effect"
// during compilation when CTC coverage is disabled.
// When coverage is enabled, these warnings are present.
#ifdef COV_ENABLE
   #define CTC_SKIP_ASSERT "CTC SKIP";
   #define CTC_ENDSKIP_ASSERT "CTC ENDSKIP";
#else
   #define CTC_SKIP_ASSERT ((void)"CTC SKIP");
   #define CTC_ENDSKIP_ASSERT ((void)"CTC ENDSKIP");
#endif

#ifdef HLS_CATAPULT
#include <ac_assert.h>
#define NVHLS_ASSERT(X) CTC_SKIP_ASSERT assert(X); CTC_ENDSKIP_ASSERT
#else
  #ifndef __SYNTHESIS__
    #define NVHLS_ASSERT(X) CTC_SKIP_ASSERT sc_assert(X); CTC_ENDSKIP_ASSERT
  #else
    #define NVHLS_ASSERT(X) CTC_SKIP_ASSERT ((void)0); CTC_ENDSKIP_ASSERT
  #endif
#endif


#ifndef __SYNTHESIS__
#define CMOD_ASSERT(x) CTC_SKIP_ASSERT assert(x); CTC_ENDSKIP_ASSERT
#else
#define CMOD_ASSERT(x) CTC_SKIP_ASSERT ((void)0); CTC_ENDSKIP_ASSERT
#endif

#ifdef HLS_CATAPULT
#include <ac_assert.h>
#define NVHLS_ASSERT_MSG(X,MSG) \
     CTC_SKIP_ASSERT assert(X && MSG); CTC_ENDSKIP_ASSERT
#else
  #ifndef __SYNTHESIS__
    #define NVHLS_ASSERT_MSG(X,MSG)  \
     CTC_SKIP_ASSERT sc_assert(X && MSG); CTC_ENDSKIP_ASSERT
  #else
    #define NVHLS_ASSERT_MSG(X,MSG) CTC_SKIP_ASSERT ((void)0); CTC_ENDSKIP_ASSERT
  #endif
#endif


#ifndef __SYNTHESIS__
#define CMOD_ASSERT_MSG(X,MSG)              \
  if (!(X)) {                       \
    DCOUT("Assertion Failed. " << MSG << endl);     \
  }                         \
  CTC_SKIP_ASSERT assert(X); CTC_ENDSKIP_ASSERT
#else
#define CMOD_ASSERT_MSG(X,MSG) CTC_SKIP_ASSERT ((void)0); CTC_ENDSKIP_ASSERT
#endif


#endif