2946cd7010
to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
80 lines
2.3 KiB
C++
80 lines
2.3 KiB
C++
//===-- MIUtilDebug.h -------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#pragma once
|
|
|
|
#define MI_USE_DEBUG_TRACE_FN // Undefine to compile out fn trace code
|
|
|
|
// In-house headers:
|
|
#include "MIUtilString.h"
|
|
|
|
// Declarations:
|
|
class CMICmnLog;
|
|
|
|
//++
|
|
//============================================================================
|
|
// Details: MI debugging aid utility class.
|
|
//--
|
|
class CMIUtilDebug {
|
|
// Statics:
|
|
public:
|
|
static void WaitForDbgAttachInfinteLoop();
|
|
|
|
// Methods:
|
|
public:
|
|
/* ctor */ CMIUtilDebug();
|
|
|
|
// Overrideable:
|
|
public:
|
|
// From CMICmnBase
|
|
/* dtor */ virtual ~CMIUtilDebug();
|
|
};
|
|
|
|
//++
|
|
//============================================================================
|
|
// Details: MI debug utility class. Used to indicate the current function
|
|
// depth in the call stack. It uses the CMIlCmnLog logger to output
|
|
// the current fn trace information.
|
|
// Use macro MI_TRACEFN( "Some fn name" ) and implement the scope of
|
|
// the functions you wish to build up a trace off.
|
|
// Use preprocessor definition MI_USE_DEBUG_TRACE_FN to turn off or on
|
|
// tracing code.
|
|
//--
|
|
class CMIUtilDebugFnTrace {
|
|
// Methods:
|
|
public:
|
|
/* ctor */ CMIUtilDebugFnTrace(const CMIUtilString &vFnName);
|
|
|
|
// Overrideable:
|
|
public:
|
|
// From CMICmnBase
|
|
/* dtor */ virtual ~CMIUtilDebugFnTrace();
|
|
|
|
// Attributes:
|
|
private:
|
|
const CMIUtilString m_strFnName;
|
|
|
|
static CMICmnLog &ms_rLog;
|
|
static MIuint ms_fnDepthCnt; // Increment count as fn depth increases,
|
|
// decrement count as fn stack pops off
|
|
};
|
|
|
|
//++
|
|
//============================================================================
|
|
// Details: Take the given text and send it to the server's Logger to output to
|
|
// the
|
|
// trace file.
|
|
// Type: Compile preprocess.
|
|
// Args: x - (R) Message (may be seen by user).
|
|
//--
|
|
#ifdef MI_USE_DEBUG_TRACE_FN
|
|
#define MI_TRACEFN(x) CMIUtilDebugFnTrace __MITrace(x)
|
|
#else
|
|
#define MI_TRACEFN(x)
|
|
#endif // MI_USE_DEBUG_TRACE_FN
|