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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/** @file
* MS COM / XPCOM Abstraction Layer - Error Reporting.
*
* Error printing macros using shared functions defined in shared glue code.
* Use these CHECK_* macros for efficient error checking around calling COM
* methods.
*/
/*
* Copyright (C) 2009-2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_com_errorprint_h
#define ___VBox_com_errorprint_h
#include <VBox/com/ErrorInfo.h>
namespace com
{
// shared prototypes; these are defined in shared glue code and are
// compiled only once for all front-ends
void GluePrintErrorInfo(const com::ErrorInfo &info);
void GluePrintErrorContext(const char *pcszContext, const char *pcszSourceFile, uint32_t ulLine);
void GluePrintRCMessage(HRESULT rc);
void GlueHandleComError(ComPtr<IUnknown> iface,
const char *pcszContext,
HRESULT rc,
const char *pcszSourceFile,
uint32_t ulLine);
void GlueHandleComErrorProgress(ComPtr<IProgress> progress,
const char *pcszContext,
HRESULT rc,
const char *pcszSourceFile,
uint32_t ulLine);
/**
* Calls the given method of the given interface and then checks if the return
* value (COM result code) indicates a failure. If so, prints the failed
* function/line/file, the description of the result code and attempts to
* query the extended error information on the current thread (using
* com::ErrorInfo) if the interface reports that it supports error information.
*
* Used by command line tools or for debugging and assumes the |HRESULT rc|
* variable is accessible for assigning in the current scope.
*/
#define CHECK_ERROR(iface, method) \
do { \
rc = iface->method; \
if (FAILED(rc)) \
com::GlueHandleComError(iface, #method, rc, __FILE__, __LINE__); \
} while (0)
/**
* Same as CHECK_ERROR except that it also executes the statement |stmt| on
* failure.
*/
#define CHECK_ERROR_STMT(iface, method, stmt) \
do { \
rc = iface->method; \
if (FAILED(rc)) \
{ \
com::GlueHandleComError(iface, #method, rc, __FILE__, __LINE__); \
stmt; \
} \
} while (0)
/**
* Same as CHECK_ERROR_STMT except that it uses an internal variable |hrcCheck|
* for holding the result.
*/
#define CHECK_ERROR2_STMT(iface, method, stmt) \
do { \
HRESULT hrcCheck = iface->method; \
if (FAILED(hrcCheck)) \
{ \
com::GlueHandleComError(iface, #method, hrcCheck, __FILE__, __LINE__); \
stmt; \
} \
} while (0)
/**
* Does the same as CHECK_ERROR(), but executes the |break| statement on
* failure.
*/
#ifdef __GNUC__
# define CHECK_ERROR_BREAK(iface, method) \
__extension__ \
({ \
rc = iface->method; \
if (FAILED(rc)) \
{ \
com::GlueHandleComError(iface, #method, rc, __FILE__, __LINE__); \
break; \
} \
})
#else
# define CHECK_ERROR_BREAK(iface, method) \
if (1) \
{ \
rc = iface->method; \
if (FAILED(rc)) \
{ \
com::GlueHandleComError(iface, #method, rc, __FILE__, __LINE__); \
break; \
} \
} \
else do {} while (0)
#endif
/**
* Does the same as CHECK_ERROR(), but executes the |return ret| statement on
* failure.
*/
#define CHECK_ERROR_RET(iface, method, ret) \
do { \
rc = iface->method; \
if (FAILED(rc)) \
{ \
com::GlueHandleComError(iface, #method, rc, __FILE__, __LINE__); \
return (ret); \
} \
} while (0)
/**
* Does the same as CHECK_ERROR(), but returns @a ret on failure.
*
* Unlike CHECK_ERROR and CHECK_ERROR_RET, this macro does not presuppose a
* |rc| variable but instead employs a local variable |hrcCheck| in its own
* scope. This |hrcCheck| variable can be referenced by the @a rcRet
* parameter.
*
* @param iface The interface pointer (can be a smart pointer object).
* @param method The method to invoke together with the parameters.
* @param rcRet What to return on failure. Use |hrcCheck| to return
* the status code of the method call.
*/
#define CHECK_ERROR2_RET(iface, method, rcRet) \
do { \
HRESULT hrcCheck = iface->method; \
if (FAILED(hrcCheck)) \
{ \
com::GlueHandleComError(iface, #method, hrcCheck, __FILE__, __LINE__); \
return (rcRet); \
} \
} while (0)
/**
* Check the progress object for an error and if there is one print out the
* extended error information.
*/
#define CHECK_PROGRESS_ERROR(progress, msg) \
do { \
LONG iRc; \
rc = progress->COMGETTER(ResultCode)(&iRc); \
if (FAILED(iRc)) \
{ \
rc = iRc; \
RTMsgError msg; \
com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
} \
} while (0)
/**
* Does the same as CHECK_PROGRESS_ERROR(), but executes the |break| statement
* on failure.
*/
#ifdef __GNUC__
# define CHECK_PROGRESS_ERROR_BREAK(progress, msg) \
__extension__ \
({ \
LONG iRc; \
rc = progress->COMGETTER(ResultCode)(&iRc); \
if (FAILED(iRc)) \
{ \
rc = iRc; \
RTMsgError msg; \
com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
break; \
} \
})
#else
# define CHECK_PROGRESS_ERROR_BREAK(progress, msg) \
if (1) \
{ \
LONG iRc; \
rc = progress->COMGETTER(ResultCode)(&iRc); \
if (FAILED(iRc)) \
{ \
rc = iRc; \
RTMsgError msg; \
com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
break; \
} \
} \
else do {} while (0)
#endif
/**
* Does the same as CHECK_PROGRESS_ERROR(), but executes the |return ret|
* statement on failure.
*/
#define CHECK_PROGRESS_ERROR_RET(progress, msg, ret) \
do { \
LONG iRc; \
progress->COMGETTER(ResultCode)(&iRc); \
if (FAILED(iRc)) \
{ \
RTMsgError msg; \
com::GlueHandleComErrorProgress(progress, __PRETTY_FUNCTION__, iRc, __FILE__, __LINE__); \
return (ret); \
} \
} while (0)
/**
* Asserts the given expression is true. When the expression is false, prints
* a line containing the failed function/line/file; otherwise does nothing.
*/
#define ASSERT(expr) \
do { \
if (!(expr)) \
{ \
RTPrintf ("[!] ASSERTION FAILED at line %d: %s\n", __LINE__, #expr); \
Log (("[!] ASSERTION FAILED at line %d: %s\n", __LINE__, #expr)); \
} \
} while (0)
#endif
/**
* Does the same as ASSERT(), but executes the |return ret| statement if the
* expression to assert is false;
*/
#define ASSERT_RET(expr, ret) \
do { ASSERT(expr); if (!(expr)) return (ret); } while (0)
/**
* Does the same as ASSERT(), but executes the |break| statement if the
* expression to assert is false;
*/
#define ASSERT_BREAK(expr, ret) \
if (1) { ASSERT(expr); if (!(expr)) break; } else do {} while (0)
} /* namespace com */
|
