| 1 | /* $Id: errmsgwin.cpp 76553 2019-01-01 01:45:53Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Status code messages.
|
|---|
| 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/win/windows.h>
|
|---|
| 32 |
|
|---|
| 33 | #include <iprt/errcore.h>
|
|---|
| 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 RTWINERRMSG g_aStatusMsgs[] =
|
|---|
| 46 | {
|
|---|
| 47 | #if !defined(IPRT_NO_ERROR_DATA) && !defined(DOXYGEN_RUNNING)
|
|---|
| 48 | # include "errmsgcomdata.h"
|
|---|
| 49 | # if defined(VBOX) && !defined(IN_GUEST)
|
|---|
| 50 | # include "errmsgvboxcomdata.h"
|
|---|
| 51 | # endif
|
|---|
| 52 | #else
|
|---|
| 53 | { "Success.", "ERROR_SUCCESS", 0 },
|
|---|
| 54 | #endif
|
|---|
| 55 | { NULL, NULL, 0 }
|
|---|
| 56 | };
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | /** Temporary buffers to format unknown messages in.
|
|---|
| 60 | * @{
|
|---|
| 61 | */
|
|---|
| 62 | static char g_aszUnknownStr[4][64];
|
|---|
| 63 | static RTWINERRMSG g_aUnknownMsgs[4] =
|
|---|
| 64 | {
|
|---|
| 65 | { &g_aszUnknownStr[0][0], &g_aszUnknownStr[0][0], 0 },
|
|---|
| 66 | { &g_aszUnknownStr[1][0], &g_aszUnknownStr[1][0], 0 },
|
|---|
| 67 | { &g_aszUnknownStr[2][0], &g_aszUnknownStr[2][0], 0 },
|
|---|
| 68 | { &g_aszUnknownStr[3][0], &g_aszUnknownStr[3][0], 0 }
|
|---|
| 69 | };
|
|---|
| 70 | /** Last used index in g_aUnknownMsgs. */
|
|---|
| 71 | static volatile uint32_t g_iUnknownMsgs;
|
|---|
| 72 | /** @} */
|
|---|
| 73 |
|
|---|
| 74 |
|
|---|
| 75 | /**
|
|---|
| 76 | * Get the message corresponding to a given status code.
|
|---|
| 77 | *
|
|---|
| 78 | * @returns Pointer to read-only message description.
|
|---|
| 79 | * @param rc The status code.
|
|---|
| 80 | */
|
|---|
| 81 | RTDECL(PCRTWINERRMSG) RTErrWinGet(long rc)
|
|---|
| 82 | {
|
|---|
| 83 | unsigned i;
|
|---|
| 84 | for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs) - 1U; i++)
|
|---|
| 85 | if (g_aStatusMsgs[i].iCode == rc)
|
|---|
| 86 | return &g_aStatusMsgs[i];
|
|---|
| 87 |
|
|---|
| 88 | /* The g_aStatusMsgs table contains a wild mix of error codes with and
|
|---|
| 89 | * without included facility and severity. So the chance is high that there
|
|---|
| 90 | * was no exact match. Try to find a non-exact match, and include the
|
|---|
| 91 | * actual value in case we pick the wrong entry. Better than always using
|
|---|
| 92 | * the "Unknown Status" case. */
|
|---|
| 93 | for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs) - 1U; i++)
|
|---|
| 94 | if (g_aStatusMsgs[i].iCode == HRESULT_CODE(rc))
|
|---|
| 95 | {
|
|---|
| 96 | int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
|
|---|
| 97 | RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "%s 0x%X", g_aStatusMsgs[i].pszDefine, rc);
|
|---|
| 98 | return &g_aUnknownMsgs[iMsg];
|
|---|
| 99 | }
|
|---|
| 100 |
|
|---|
| 101 | /*
|
|---|
| 102 | * Need to use the temporary stuff.
|
|---|
| 103 | */
|
|---|
| 104 | int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
|
|---|
| 105 | RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "Unknown Status 0x%X", rc);
|
|---|
| 106 | return &g_aUnknownMsgs[iMsg];
|
|---|
| 107 | }
|
|---|
| 108 |
|
|---|
| 109 |
|
|---|
| 110 | RTDECL(PCRTCOMERRMSG) RTErrCOMGet(uint32_t rc)
|
|---|
| 111 | {
|
|---|
| 112 | return RTErrWinGet((long)rc);
|
|---|
| 113 | }
|
|---|
| 114 |
|
|---|
