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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/* $Id: TokenImpl.cpp $ */
/** @file
* Token COM class implementation - MachineToken and MediumLockToken
*/
/*
* Copyright (C) 2013-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program 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, in version 3 of the
* License.
*
* This program 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 this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#define LOG_GROUP LOG_GROUP_MAIN_TOKEN
#include "TokenImpl.h"
#include "MachineImpl.h"
#include "MediumImpl.h"
#include "AutoCaller.h"
#include "LoggingNew.h"
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
DEFINE_EMPTY_CTOR_DTOR(MachineToken)
HRESULT MachineToken::FinalConstruct()
{
return BaseFinalConstruct();
}
void MachineToken::FinalRelease()
{
uninit(false);
BaseFinalRelease();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes the token object.
*
* @param pSessionMachine Pointer to a SessionMachine object.
*/
HRESULT MachineToken::init(const ComObjPtr<SessionMachine> &pSessionMachine)
{
LogFlowThisFunc(("pSessionMachine=%p\n", &pSessionMachine));
ComAssertRet(!pSessionMachine.isNull(), E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
m.pSessionMachine = pSessionMachine;
/* Confirm a successful initialization */
autoInitSpan.setSucceeded();
return S_OK;
}
/**
* Uninitializes the instance and sets the ready flag to FALSE.
* Called either from FinalRelease() or by the parent when it gets destroyed.
*/
void MachineToken::uninit(bool fAbandon)
{
LogFlowThisFunc(("\n"));
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
/* Destroy the SessionMachine object, check is paranoia */
if (!m.pSessionMachine.isNull())
{
m.pSessionMachine->uninit(fAbandon ? SessionMachine::Uninit::Normal : SessionMachine::Uninit::Abnormal);
m.pSessionMachine.setNull();
}
}
// IToken methods
/////////////////////////////////////////////////////////////////////////////
HRESULT MachineToken::abandon(AutoCaller &aAutoCaller)
{
/* have to release the AutoCaller before calling uninit(), self-deadlock */
aAutoCaller.release();
/* uninit does everything we need */
uninit(true);
return S_OK;
}
HRESULT MachineToken::dummy()
{
/* Remember, the wrapper contains the AutoCaller, which means that after
* uninit() this code won't be reached any more. */
/* this is a NOOP, no need to lock */
return S_OK;
}
// public methods only for internal purposes
/////////////////////////////////////////////////////////////////////////////
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
DEFINE_EMPTY_CTOR_DTOR(MediumLockToken)
HRESULT MediumLockToken::FinalConstruct()
{
return BaseFinalConstruct();
}
void MediumLockToken::FinalRelease()
{
uninit();
BaseFinalRelease();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes the token object.
*
* @param pMedium Pointer to a Medium object.
* @param fWrite True if this is a write lock, false otherwise.
*/
HRESULT MediumLockToken::init(const ComObjPtr<Medium> &pMedium, bool fWrite)
{
LogFlowThisFunc(("pMedium=%p\n", &pMedium));
ComAssertRet(!pMedium.isNull(), E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan(this);
AssertReturn(autoInitSpan.isOk(), E_FAIL);
m.pMedium = pMedium;
m.fWrite = fWrite;
/* Confirm a successful initialization */
autoInitSpan.setSucceeded();
return S_OK;
}
/**
* Uninitializes the instance and sets the ready flag to FALSE.
* Called either from FinalRelease() or by the parent when it gets destroyed.
*/
void MediumLockToken::uninit()
{
LogFlowThisFunc(("\n"));
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan(this);
if (autoUninitSpan.uninitDone())
return;
/* Release the appropriate lock, check is paranoia */
if (!m.pMedium.isNull())
{
if (m.fWrite)
{
HRESULT hrc = m.pMedium->i_unlockWrite(NULL);
AssertComRC(hrc);
}
else
{
HRESULT hrc = m.pMedium->i_unlockRead(NULL);
AssertComRC(hrc);
}
m.pMedium.setNull();
}
}
// IToken methods
/////////////////////////////////////////////////////////////////////////////
HRESULT MediumLockToken::abandon(AutoCaller &aAutoCaller)
{
/* have to release the AutoCaller before calling uninit(), self-deadlock */
aAutoCaller.release();
/* uninit does everything we need */
uninit();
return S_OK;
}
HRESULT MediumLockToken::dummy()
{
/* Remember, the wrapper contains the AutoCaller, which means that after
* uninit() this code won't be reached any more. */
/* this is a NOOP, no need to lock */
return S_OK;
}
// public methods only for internal purposes
/////////////////////////////////////////////////////////////////////////////
/* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
