Valgrind.hpp

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  Copyright (C) 2013 by Andreas Lauser

  This file is part of the Open Porous Media project (OPM).

  OPM 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.

  OPM 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.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_VALGRIND_HPP
#define OPM_VALGRIND_HPP

#include <opm/material/common/Unused.hpp>

#if HAVE_VALGRIND
#include <valgrind/memcheck.h>
#endif

namespace Valgrind
{
inline bool IsRunning()
{
#if !defined NDEBUG && HAVE_VALGRIND
    return RUNNING_ON_VALGRIND;
#else
    return false;
#endif
}

template <class T>
inline bool CheckDefined(const T& value OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto tmp = VALGRIND_CHECK_MEM_IS_DEFINED(&value, sizeof(T));
    return tmp == 0;
#else
    return true;
#endif
}

template <class T>
inline bool CheckDefined(const T* value OPM_UNUSED, int size OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto tmp = VALGRIND_CHECK_MEM_IS_DEFINED(value, size*sizeof(T));
    return tmp == 0;
#else
    return true;
#endif
}

template <class T>
inline void SetUndefined(const T &value OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_UNDEFINED(&value, sizeof(T));
#endif
}

template <class T>
inline void SetUndefined(const T* value OPM_UNUSED, int size OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_UNDEFINED(value, size*sizeof(T));
#endif
}

template <class T>
inline void SetDefined(const T& value OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_DEFINED(&value, sizeof(T));
#endif
}

template <class T>
inline void SetDefined(const T *value OPM_UNUSED, int n OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_DEFINED(value, n*sizeof(T));
#endif
}

template <class T>
inline void SetNoAccess(const T &value OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_NOACCESS(&value, sizeof(T));
#endif
}

template <class T>
inline void SetNoAccess(const T *value OPM_UNUSED, int size OPM_UNUSED)
{
#if !defined NDEBUG && HAVE_VALGRIND
    auto OPM_UNUSED result = VALGRIND_MAKE_MEM_NOACCESS(value, size*sizeof(T));
#endif
}

} // namespace Valgrind

#endif