mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-07 18:08:53 +00:00
b68b609585
* Debug only wrapper class and funcions to perform some verifications only in debug build The best way to test the code is to create a proper tests. But tests just increase a probability that everithing works correct. To put more checks to runtime means sometimes a notable performance penalty. And there is a debug build for that reason. But writing a debug only code means to put here an there ugly macro conditions. Which make a code hard to read and fix. Function `debug_only::check` is a way to perform this kind of verification in a pure C++ style without macro magic. If you need to have some state for this checks use class `debug_only::Var`. This is a way to have a debug data and do verifications assosiated to it. * Add debug_only::verifyTrue for the simple boolean condition
140 lines
3.0 KiB
C++
140 lines
3.0 KiB
C++
/**
|
|
* Copyright (c) 2018-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under both the Apache 2.0 license (found in the
|
|
* LICENSE file in the root directory of this source tree) and the GPLv2 (found
|
|
* in the COPYING file in the root directory of this source tree).
|
|
* You may select, at your option, one of the above-listed licenses.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifndef NDEBUG
|
|
#include <cassert>
|
|
#include <iostream>
|
|
#endif
|
|
|
|
#include <boost/core/ignore_unused.hpp>
|
|
|
|
namespace osquery {
|
|
namespace debug_only {
|
|
|
|
/**
|
|
* Use it for unconditional abort with message only in debug mode
|
|
*/
|
|
inline void fail(const char* msg) {
|
|
#ifndef NDEBUG
|
|
std::cerr << "Failure in debug mode: \"" << msg << "\"\n";
|
|
assert(false && "Failure in debug mode");
|
|
#endif
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
/**
|
|
* To verify something vital only in debug mode
|
|
* See examples of usage in tests osquery/debug/tests/debug_only_tests.cpp
|
|
*/
|
|
template <typename FunctionType>
|
|
inline void verify(FunctionType checker, const char* msg) {
|
|
#ifndef NDEBUG
|
|
if (!checker()) {
|
|
fail(msg);
|
|
}
|
|
#endif
|
|
boost::ignore_unused(checker);
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
/**
|
|
* Pretty much the same as verify, but for the simple boolean condition
|
|
*/
|
|
inline void verifyTrue(bool expected_true, const char* msg) {
|
|
#ifndef NDEBUG
|
|
if (!expected_true) {
|
|
fail(msg);
|
|
}
|
|
#endif
|
|
boost::ignore_unused(expected_true);
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
/**
|
|
* Class for debug variables and verifys regarding to it.
|
|
* It is designed to contain a value of given type and perform some verifys and
|
|
* updates to it in debug build.
|
|
* In release build objects are empty and verifys and updates do nothing.
|
|
*
|
|
* See examples of usage in tests osquery/debug/tests/debug_only_tests.cpp
|
|
*/
|
|
template <typename VarType>
|
|
class Var final {
|
|
public:
|
|
explicit Var()
|
|
#ifndef NDEBUG
|
|
: value_(VarType{})
|
|
#endif
|
|
{
|
|
}
|
|
|
|
Var(VarType value)
|
|
#ifndef NDEBUG
|
|
: value_(std::move(value))
|
|
#endif
|
|
{
|
|
boost::ignore_unused(value);
|
|
}
|
|
|
|
inline void verify(const char* msg) const {
|
|
#ifndef NDEBUG
|
|
if (!value_) {
|
|
fail(msg);
|
|
}
|
|
#endif
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
template <typename FunctionType>
|
|
inline void verify(FunctionType checker, const char* msg) const {
|
|
#ifndef NDEBUG
|
|
if (!checker(value_)) {
|
|
fail(msg);
|
|
}
|
|
#endif
|
|
boost::ignore_unused(checker);
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
inline void verifyEqual(const VarType& other, const char* msg) const {
|
|
#ifndef NDEBUG
|
|
if (value_ != other) {
|
|
fail(msg);
|
|
}
|
|
#endif
|
|
boost::ignore_unused(other);
|
|
boost::ignore_unused(msg);
|
|
}
|
|
|
|
inline void set(const VarType& newValue) const {
|
|
#ifndef NDEBUG
|
|
value_ = newValue;
|
|
#endif
|
|
boost::ignore_unused(newValue);
|
|
}
|
|
|
|
template <typename FunctionType>
|
|
inline void update(FunctionType modifier) const {
|
|
#ifndef NDEBUG
|
|
value_ = modifier(value_);
|
|
#endif
|
|
boost::ignore_unused(modifier);
|
|
}
|
|
|
|
#ifndef NDEBUG
|
|
mutable VarType value_;
|
|
#endif
|
|
};
|
|
|
|
} // namespace debug_only
|
|
} // namespace osquery
|