Welcome to mirror list, hosted at ThFree Co, Russian Federation.

DebugFuncEval.h « Runtime « Native « src - github.com/mono/corert.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 20315c35a72010be4e537a2f6f8ebb9338fdf865 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
// -----------------------------------------------------------------------------------------------------------
// Support for evaluating expression in the debuggee during debugging
// -----------------------------------------------------------------------------------------------------------

#ifndef __DEBUG_FUNC_EVAL_H__
#define __DEBUG_FUNC_EVAL_H__

#include "common.h"
#include "CommonTypes.h"
#include "CommonMacros.h"
#include "daccess.h"

#ifndef DACCESS_COMPILE

typedef void(*HighLevelDebugFuncEvalAbortHelperType)(UInt64);

class DebugFuncEval
{
public:
    /// <summary>
    /// Retrieve the global FuncEval parameter buffer size.
    /// </summary>
    /// <remarks>
    /// During debugging, if a FuncEval is requested, 
    /// the func eval infrastructure needs to know how much buffer to allocate for the debugger to 
    /// write the parameter information in. The C# supporting code will call this API to obtain the 
    /// buffer size. By that time, the value should have been set through the UpdateFuncEvalParameterSize() 
    /// method on the ISosRedhawk7 interface.
    /// </remarks>
    static UInt32 GetFuncEvalParameterBufferSize();

    /// <summary>
    /// Retrieve the global FuncEval mode.
    /// </summary>
    /// <remarks>
    /// During debugging, if a FuncEval is requested, 
    /// the func eval infrastructure needs to know what mode to execute the FuncEval request 
    /// The C# supporting code will call this API to obtain the mode. By that time, the value 
    /// should have been set through the UpdateFuncEvalMode() method on the ISosRedhawk7 interface.
    /// </remarks>
    static UInt32 GetFuncEvalMode();

    /// <summary>
    /// Retrieve the most recent FuncEval Hijack instruction pointer
    /// </summary>
    /// <remarks>
    /// The most recent FuncEval Hijack instruction pointer is set through the debugger
    /// It is used for the stack walker to understand the hijack frame
    /// </remarks>
    static UInt64 GetMostRecentFuncEvalHijackInstructionPointer();

    /// <summary>
    /// Retrieve the high level debug func eval abort helper
    /// </summary>
    static HighLevelDebugFuncEvalAbortHelperType GetHighLevelDebugFuncEvalAbortHelper();


    /// <summary>
    /// Set the high level debug func eval abort helper
    /// </summary>
    static void SetHighLevelDebugFuncEvalAbortHelper(HighLevelDebugFuncEvalAbortHelperType highLevelDebugFuncEvalAbortHelper);

};

#else

class DebugFuncEval
{
public:
    /// <summary>
    /// Retrieve the most recent FuncEval Hijack instruction pointer
    /// </summary>
    /// <remarks>
    /// The most recent FuncEval Hijack instruction pointer is set through the debugger
    /// It is used for the stack walker to understand the hijack frame
    /// </remarks>
    static UInt64 GetMostRecentFuncEvalHijackInstructionPointer();
};

#endif //!DACCESS_COMPILE

#endif // __DEBUG_FUNC_EVAL_H__