1 | /* $Id: errmsgxpcom.cpp 76553 2019-01-01 01:45:53Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * IPRT - Status code messages for XPCOM.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2019 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * The contents of this file may alternatively be used under the terms
|
---|
18 | * of the Common Development and Distribution License Version 1.0
|
---|
19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
21 | * CDDL are applicable instead of those of the GPL.
|
---|
22 | *
|
---|
23 | * You may elect to license modified versions of this file under the
|
---|
24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
25 | */
|
---|
26 |
|
---|
27 |
|
---|
28 | /*********************************************************************************************************************************
|
---|
29 | * Header Files *
|
---|
30 | *********************************************************************************************************************************/
|
---|
31 | #include <iprt/errcore.h>
|
---|
32 | #include "internal/iprt.h"
|
---|
33 |
|
---|
34 | #include <iprt/asm.h>
|
---|
35 | #include <iprt/string.h>
|
---|
36 | #include <iprt/errcore.h>
|
---|
37 |
|
---|
38 |
|
---|
39 | /*********************************************************************************************************************************
|
---|
40 | * Global Variables *
|
---|
41 | *********************************************************************************************************************************/
|
---|
42 | /** Array of messages.
|
---|
43 | * The data is generated by a sed script.
|
---|
44 | */
|
---|
45 | static const RTCOMERRMSG g_aStatusMsgs[] =
|
---|
46 | {
|
---|
47 | #define MY_ERR(_def, _desc, _val) { _desc, _def, _val }
|
---|
48 |
|
---|
49 | MY_ERR("NS_OK", "Success", UINT32_C(0x00000000)),
|
---|
50 | MY_ERR("NS_ERROR_NOT_IMPLEMENTED", "Not implemented", UINT32_C(0x80004001)),
|
---|
51 | MY_ERR("NS_ERROR_NO_INTERFACE", "Interface not supported", UINT32_C(0x80004002)),
|
---|
52 | MY_ERR("NS_ERROR_INVALID_POINTER", "Invalid pointer value", UINT32_C(0x80004003)),
|
---|
53 | MY_ERR("NS_ERROR_ABORT", "Operation aborted", UINT32_C(0x80004004)),
|
---|
54 | MY_ERR("NS_ERROR_FAILURE", "Operation failed", UINT32_C(0x80004005)),
|
---|
55 | MY_ERR("NS_ERROR_CALL_FAILED", "Call to remote object failed", UINT32_C(0x800706be)),
|
---|
56 | MY_ERR("NS_ERROR_UNEXPECTED", "Unexpected error", UINT32_C(0x8000ffff)),
|
---|
57 |
|
---|
58 | MY_ERR("NS_ERROR_CANNOT_CONVERT_DATA", "Cannot convert data", UINT32_C(0x80010001)),
|
---|
59 | MY_ERR("NS_ERROR_OBJECT_IS_IMMUTABLE", "Object is immutable", UINT32_C(0x80010002)),
|
---|
60 | MY_ERR("NS_ERROR_LOSS_OF_SIGNIFICANT_DATA", "Loss of significant data", UINT32_C(0x80010003)),
|
---|
61 | MY_ERR("NS_ERROR_PROXY_INVALID_IN_PARAMETER", "Cannot proxy an IN parameter", UINT32_C(0x80010010)),
|
---|
62 | MY_ERR("NS_ERROR_PROXY_INVALID_OUT_PARAMETER", "Cannot proxy an OUT parameter", UINT32_C(0x80010011)),
|
---|
63 | MY_ERR("NS_SUCCESS_LOSS_OF_INSIGNIFICANT_DATA", "Loss of insignificant data", UINT32_C(0x00010001)),
|
---|
64 |
|
---|
65 | MY_ERR("E_ACCESSDENIED", "Access denied", UINT32_C(0x80070005)), /* VirtualBox addition */
|
---|
66 | MY_ERR("NS_ERROR_OUT_OF_MEMORY", "Memory allocation failed", UINT32_C(0x8007000e)),
|
---|
67 | MY_ERR("NS_ERROR_INVALID_ARG", "Invalid argument value", UINT32_C(0x80070057)),
|
---|
68 |
|
---|
69 | MY_ERR("NS_ERROR_NO_AGGREGATION", "Class does not allow aggregation", UINT32_C(0x80040110)),
|
---|
70 | MY_ERR("NS_ERROR_NOT_AVAILABLE", "Resource not available", UINT32_C(0x80040111)),
|
---|
71 | MY_ERR("NS_ERROR_FACTORY_NOT_REGISTERED", "Class not registered", UINT32_C(0x80040154)),
|
---|
72 | MY_ERR("NS_ERROR_FACTORY_REGISTER_AGAIN", "Cannot be registered, try again later", UINT32_C(0x80040155)),
|
---|
73 | MY_ERR("NS_ERROR_FACTORY_NOT_LOADED", "Dynamically loaded factory cannot be found", UINT32_C(0x800401f8)),
|
---|
74 | MY_ERR("NS_ERROR_FACTORY_EXISTS", "Factory already exists", UINT32_C(0xc1f30100)),
|
---|
75 | MY_ERR("NS_ERROR_FACTORY_NO_SIGNATURE_SUPPORT", "Factory does not support signatures", UINT32_C(0xc1f30101)),
|
---|
76 | MY_ERR("NS_ERROR_NOT_INITIALIZED", "Instance not initialized", UINT32_C(0xc1f30001)),
|
---|
77 | MY_ERR("NS_ERROR_ALREADY_INITIALIZED", "Instance already initialized", UINT32_C(0xc1f30002)),
|
---|
78 |
|
---|
79 | MY_ERR("NS_BASE_STREAM_CLOSED", "Stream closed", UINT32_C(0x80470002)),
|
---|
80 | MY_ERR("NS_BASE_STREAM_OSERROR", "Operative system stream error", UINT32_C(0x80470003)),
|
---|
81 | MY_ERR("NS_BASE_STREAM_ILLEGAL_ARGS", "Illegal argument to stream method", UINT32_C(0x80470004)),
|
---|
82 | MY_ERR("NS_BASE_STREAM_NO_CONVERTER", "No stream converter", UINT32_C(0x80470005)),
|
---|
83 | MY_ERR("NS_BASE_STREAM_BAD_CONVERSION", "Badstream conversion", UINT32_C(0x80470006)),
|
---|
84 | MY_ERR("NS_BASE_STREAM_WOULD_BLOCK", "Stream operation would block", UINT32_C(0x80470007)),
|
---|
85 |
|
---|
86 | MY_ERR("NS_ERROR_FILE_UNRECOGNIZED_PATH", "Unrecognized path", UINT32_C(0x80520001)),
|
---|
87 | MY_ERR("NS_ERROR_FILE_UNRESOLVABLE_SYMLINK", "NS_ERROR_FILE_UNRESOLVABLE_SYMLINK", UINT32_C(0x80520002)),
|
---|
88 | MY_ERR("NS_ERROR_FILE_EXECUTION_FAILED", "NS_ERROR_FILE_EXECUTION_FAILED", UINT32_C(0x80520003)),
|
---|
89 | MY_ERR("NS_ERROR_FILE_UNKNOWN_TYPE", "NS_ERROR_FILE_UNKNOWN_TYPE", UINT32_C(0x80520004)),
|
---|
90 | MY_ERR("NS_ERROR_FILE_DESTINATION_NOT_DIR", "NS_ERROR_FILE_DESTINATION_NOT_DIR", UINT32_C(0x80520005)),
|
---|
91 | MY_ERR("NS_ERROR_FILE_TARGET_DOES_NOT_EXIST", "NS_ERROR_FILE_TARGET_DOES_NOT_EXIST", UINT32_C(0x80520006)),
|
---|
92 | MY_ERR("NS_ERROR_FILE_COPY_OR_MOVE_FAILED", "NS_ERROR_FILE_COPY_OR_MOVE_FAILED", UINT32_C(0x80520007)),
|
---|
93 | MY_ERR("NS_ERROR_FILE_ALREADY_EXISTS", "NS_ERROR_FILE_ALREADY_EXISTS", UINT32_C(0x80520008)),
|
---|
94 | MY_ERR("NS_ERROR_FILE_INVALID_PATH", "NS_ERROR_FILE_INVALID_PATH", UINT32_C(0x80520009)),
|
---|
95 | MY_ERR("NS_ERROR_FILE_DISK_FULL", "NS_ERROR_FILE_DISK_FULL", UINT32_C(0x8052000a)),
|
---|
96 | MY_ERR("NS_ERROR_FILE_CORRUPTED", "NS_ERROR_FILE_CORRUPTED", UINT32_C(0x8052000b)),
|
---|
97 | MY_ERR("NS_ERROR_FILE_NOT_DIRECTORY", "NS_ERROR_FILE_NOT_DIRECTORY", UINT32_C(0x8052000c)),
|
---|
98 | MY_ERR("NS_ERROR_FILE_IS_DIRECTORY", "NS_ERROR_FILE_IS_DIRECTORY", UINT32_C(0x8052000d)),
|
---|
99 | MY_ERR("NS_ERROR_FILE_IS_LOCKED", "NS_ERROR_FILE_IS_LOCKED", UINT32_C(0x8052000e)),
|
---|
100 | MY_ERR("NS_ERROR_FILE_TOO_BIG", "NS_ERROR_FILE_TOO_BIG", UINT32_C(0x8052000f)),
|
---|
101 | MY_ERR("NS_ERROR_FILE_NO_DEVICE_SPACE", "NS_ERROR_FILE_NO_DEVICE_SPACE", UINT32_C(0x80520010)),
|
---|
102 | MY_ERR("NS_ERROR_FILE_NAME_TOO_LONG", "NS_ERROR_FILE_NAME_TOO_LONG", UINT32_C(0x80520011)),
|
---|
103 | MY_ERR("NS_ERROR_FILE_NOT_FOUND", "NS_ERROR_FILE_NOT_FOUND", UINT32_C(0x80520012)),
|
---|
104 | MY_ERR("NS_ERROR_FILE_READ_ONLY", "NS_ERROR_FILE_READ_ONLY", UINT32_C(0x80520013)),
|
---|
105 | MY_ERR("NS_ERROR_FILE_DIR_NOT_EMPTY", "NS_ERROR_FILE_DIR_NOT_EMPTY", UINT32_C(0x80520014)),
|
---|
106 | MY_ERR("NS_ERROR_FILE_ACCESS_DENIED", "NS_ERROR_FILE_ACCESS_DENIED", UINT32_C(0x80520015)),
|
---|
107 | MY_ERR("NS_SUCCESS_FILE_DIRECTORY_EMPTY", "NS_SUCCESS_FILE_DIRECTORY_EMPTY", UINT32_C(0x00520001)),
|
---|
108 | MY_ERR("NS_ERROR_SOCKET_FAIL", "IPC daemon socket error", UINT32_C(0xc1f30200)), /* new XPCOM error code */
|
---|
109 |
|
---|
110 | #if defined(VBOX) && !defined(IN_GUEST) && !defined(DOXYGEN_RUNNING)
|
---|
111 | # include "errmsgvboxcomdata.h"
|
---|
112 | #endif
|
---|
113 |
|
---|
114 | { NULL, NULL, 0 }
|
---|
115 | #undef MY_ERR
|
---|
116 | };
|
---|
117 |
|
---|
118 |
|
---|
119 | /** Temporary buffers to format unknown messages in.
|
---|
120 | * @{
|
---|
121 | */
|
---|
122 | static char g_aszUnknownStr[8][64];
|
---|
123 | static RTCOMERRMSG g_aUnknownMsgs[8] =
|
---|
124 | {
|
---|
125 | { &g_aszUnknownStr[0][0], &g_aszUnknownStr[0][0], 0 },
|
---|
126 | { &g_aszUnknownStr[1][0], &g_aszUnknownStr[1][0], 0 },
|
---|
127 | { &g_aszUnknownStr[2][0], &g_aszUnknownStr[2][0], 0 },
|
---|
128 | { &g_aszUnknownStr[3][0], &g_aszUnknownStr[3][0], 0 },
|
---|
129 | { &g_aszUnknownStr[4][0], &g_aszUnknownStr[4][0], 0 },
|
---|
130 | { &g_aszUnknownStr[5][0], &g_aszUnknownStr[5][0], 0 },
|
---|
131 | { &g_aszUnknownStr[6][0], &g_aszUnknownStr[6][0], 0 },
|
---|
132 | { &g_aszUnknownStr[7][0], &g_aszUnknownStr[7][0], 0 }
|
---|
133 | };
|
---|
134 | /** Last used index in g_aUnknownMsgs. */
|
---|
135 | static volatile uint32_t g_iUnknownMsgs;
|
---|
136 | /** @} */
|
---|
137 |
|
---|
138 |
|
---|
139 | RTDECL(PCRTCOMERRMSG) RTErrCOMGet(uint32_t rc)
|
---|
140 | {
|
---|
141 | unsigned i;
|
---|
142 | for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs) - 1; i++)
|
---|
143 | if (g_aStatusMsgs[i].iCode == rc)
|
---|
144 | return &g_aStatusMsgs[i];
|
---|
145 |
|
---|
146 | /*
|
---|
147 | * Need to use the temporary stuff.
|
---|
148 | */
|
---|
149 | int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
|
---|
150 | RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "Unknown Status 0x%X", rc);
|
---|
151 | return &g_aUnknownMsgs[iMsg];
|
---|
152 | }
|
---|
153 | RT_EXPORT_SYMBOL(RTErrCOMGet);
|
---|
154 |
|
---|