VirtualBox

source: vbox/trunk/src/VBox/VMM/include/DBGFInline.h@ 100594

Last change on this file since 100594 was 99739, checked in by vboxsync, 19 months ago

*: doxygen corrections (mostly about removing @returns from functions returning void).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.9 KB
Line 
1/* $Id: DBGFInline.h 99739 2023-05-11 01:01:08Z vboxsync $ */
2/** @file
3 * DBGF - Internal header file containing the inlined functions.
4 */
5
6/*
7 * Copyright (C) 2020-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * SPDX-License-Identifier: GPL-3.0-only
26 */
27
28#ifndef VMM_INCLUDED_SRC_include_DBGFInline_h
29#define VMM_INCLUDED_SRC_include_DBGFInline_h
30#ifndef RT_WITHOUT_PRAGMA_ONCE
31# pragma once
32#endif
33
34
35/**
36 * Initializes the given L2 table entry with the given values.
37 *
38 * @param pL2Entry The L2 entry to intialize.
39 * @param hBp The breakpoint handle.
40 * @param GCPtr The GC pointer used as the key (only the upper 6 bytes are used).
41 * @param idxL2Left The left L2 table index.
42 * @param idxL2Right The right L2 table index.
43 * @param iDepth The depth of the node in the tree.
44 */
45DECLINLINE(void) dbgfBpL2TblEntryInit(PDBGFBPL2ENTRY pL2Entry, DBGFBP hBp, RTGCPTR GCPtr,
46 uint32_t idxL2Left, uint32_t idxL2Right, uint8_t iDepth)
47{
48 uint64_t u64GCPtrKeyAndBpHnd1 = ((uint64_t)hBp & DBGF_BP_L2_ENTRY_BP_1ST_MASK) << DBGF_BP_L2_ENTRY_BP_1ST_SHIFT
49 | DBGF_BP_INT3_L2_KEY_EXTRACT_FROM_ADDR(GCPtr);
50 uint64_t u64LeftRightIdxDepthBpHnd2 = (((uint64_t)hBp & DBGF_BP_L2_ENTRY_BP_2ND_MASK) >> 16) << DBGF_BP_L2_ENTRY_BP_2ND_SHIFT
51 | ((uint64_t)iDepth << DBGF_BP_L2_ENTRY_DEPTH_SHIFT)
52 | ((uint64_t)idxL2Right << DBGF_BP_L2_ENTRY_RIGHT_IDX_SHIFT)
53 | ((uint64_t)idxL2Left << DBGF_BP_L2_ENTRY_LEFT_IDX_SHIFT);
54
55 ASMAtomicWriteU64(&pL2Entry->u64GCPtrKeyAndBpHnd1, u64GCPtrKeyAndBpHnd1);
56 ASMAtomicWriteU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2, u64LeftRightIdxDepthBpHnd2);
57}
58
59
60/**
61 * Updates the given L2 table entry with the new pointers.
62 *
63 * @param pL2Entry The L2 entry to update.
64 * @param idxL2Left The new left L2 table index.
65 * @param idxL2Right The new right L2 table index.
66 * @param iDepth The new depth of the tree.
67 */
68DECLINLINE(void) dbgfBpL2TblEntryUpdate(PDBGFBPL2ENTRY pL2Entry, uint32_t idxL2Left, uint32_t idxL2Right,
69 uint8_t iDepth)
70{
71 uint64_t u64LeftRightIdxDepthBpHnd2 = ASMAtomicReadU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2) & DBGF_BP_L2_ENTRY_BP_2ND_L2_ENTRY_MASK;
72 u64LeftRightIdxDepthBpHnd2 |= ((uint64_t)iDepth << DBGF_BP_L2_ENTRY_DEPTH_SHIFT)
73 | ((uint64_t)idxL2Right << DBGF_BP_L2_ENTRY_RIGHT_IDX_SHIFT)
74 | ((uint64_t)idxL2Left << DBGF_BP_L2_ENTRY_LEFT_IDX_SHIFT);
75
76 ASMAtomicWriteU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2, u64LeftRightIdxDepthBpHnd2);
77}
78
79
80/**
81 * Updates the given L2 table entry with the left pointer.
82 *
83 * @param pL2Entry The L2 entry to update.
84 * @param idxL2Left The new left L2 table index.
85 * @param iDepth The new depth of the tree.
86 */
87DECLINLINE(void) dbgfBpL2TblEntryUpdateLeft(PDBGFBPL2ENTRY pL2Entry, uint32_t idxL2Left, uint8_t iDepth)
88{
89 uint64_t u64LeftRightIdxDepthBpHnd2 = ASMAtomicReadU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2) & ( DBGF_BP_L2_ENTRY_BP_2ND_L2_ENTRY_MASK
90 | DBGF_BP_L2_ENTRY_RIGHT_IDX_MASK);
91
92 u64LeftRightIdxDepthBpHnd2 |= ((uint64_t)iDepth << DBGF_BP_L2_ENTRY_DEPTH_SHIFT)
93 | ((uint64_t)idxL2Left << DBGF_BP_L2_ENTRY_LEFT_IDX_SHIFT);
94
95 ASMAtomicWriteU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2, u64LeftRightIdxDepthBpHnd2);
96}
97
98
99/**
100 * Updates the given L2 table entry with the right pointer.
101 *
102 * @param pL2Entry The L2 entry to update.
103 * @param idxL2Right The new right L2 table index.
104 * @param iDepth The new depth of the tree.
105 */
106DECLINLINE(void) dbgfBpL2TblEntryUpdateRight(PDBGFBPL2ENTRY pL2Entry, uint32_t idxL2Right, uint8_t iDepth)
107{
108 uint64_t u64LeftRightIdxDepthBpHnd2 = ASMAtomicReadU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2) & ( DBGF_BP_L2_ENTRY_BP_2ND_L2_ENTRY_MASK
109 | DBGF_BP_L2_ENTRY_LEFT_IDX_MASK);
110
111 u64LeftRightIdxDepthBpHnd2 |= ((uint64_t)iDepth << DBGF_BP_L2_ENTRY_DEPTH_SHIFT)
112 | ((uint64_t)idxL2Right << DBGF_BP_L2_ENTRY_RIGHT_IDX_SHIFT);
113
114 ASMAtomicWriteU64(&pL2Entry->u64LeftRightIdxDepthBpHnd2, u64LeftRightIdxDepthBpHnd2);
115}
116
117#ifdef IN_RING3
118/**
119 * Returns the internal breakpoint owner state for the given handle.
120 *
121 * @returns Pointer to the internal breakpoint owner state or NULL if the handle is invalid.
122 * @param pUVM The user mode VM handle.
123 * @param hBpOwner The breakpoint owner handle to resolve.
124 */
125DECLINLINE(PDBGFBPOWNERINT) dbgfR3BpOwnerGetByHnd(PUVM pUVM, DBGFBPOWNER hBpOwner)
126{
127 AssertReturn(hBpOwner < DBGF_BP_OWNER_COUNT_MAX, NULL);
128 AssertPtrReturn(pUVM->dbgf.s.pbmBpOwnersAllocR3, NULL);
129
130 AssertReturn(ASMBitTest(pUVM->dbgf.s.pbmBpOwnersAllocR3, hBpOwner), NULL);
131 return &pUVM->dbgf.s.paBpOwnersR3[hBpOwner];
132}
133#endif
134
135#endif /* !VMM_INCLUDED_SRC_include_DBGFInline_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette