VirtualBox

source: vbox/trunk/src/VBox/Runtime/win/errmsgwin.cpp@ 39627

Last change on this file since 39627 was 35445, checked in by vboxsync, 14 years ago

Runtime/errmsgwin: add a heuristics for providing a human readable error message in more cases, avoiding the "Unknown Status" all over the place.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1/* $Id: errmsgwin.cpp 35445 2011-01-10 11:05:23Z vboxsync $ */
2/** @file
3 * IPRT - Status code messages.
4 */
5
6/*
7 * Copyright (C) 2006-2011 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* Header Files *
29*******************************************************************************/
30#include <Windows.h>
31
32#include <iprt/err.h>
33#include <iprt/asm.h>
34#include <iprt/string.h>
35#include <iprt/err.h>
36
37
38/*******************************************************************************
39* Global Variables *
40*******************************************************************************/
41/** Array of messages.
42 * The data is generated by a sed script.
43 */
44static const RTWINERRMSG g_aStatusMsgs[] =
45{
46#include "errmsgcomdata.h"
47#if defined(VBOX) && !defined(IN_GUEST)
48# include "errmsgvboxcomdata.h"
49#endif
50 { NULL, NULL, 0 }
51};
52
53
54/** Temporary buffers to format unknown messages in.
55 * @{
56 */
57static char g_aszUnknownStr[4][64];
58static RTWINERRMSG g_aUnknownMsgs[4] =
59{
60 { &g_aszUnknownStr[0][0], &g_aszUnknownStr[0][0], 0 },
61 { &g_aszUnknownStr[1][0], &g_aszUnknownStr[1][0], 0 },
62 { &g_aszUnknownStr[2][0], &g_aszUnknownStr[2][0], 0 },
63 { &g_aszUnknownStr[3][0], &g_aszUnknownStr[3][0], 0 }
64};
65/** Last used index in g_aUnknownMsgs. */
66static volatile uint32_t g_iUnknownMsgs;
67/** @} */
68
69
70/**
71 * Get the message corresponding to a given status code.
72 *
73 * @returns Pointer to read-only message description.
74 * @param rc The status code.
75 */
76RTDECL(PCRTWINERRMSG) RTErrWinGet(long rc)
77{
78 unsigned i;
79 for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs); i++)
80 if (g_aStatusMsgs[i].iCode == rc)
81 return &g_aStatusMsgs[i];
82
83 /* The g_aStatusMsgs table contains a wild mix of error codes with and
84 * without included facility and severity. So the chance is high that there
85 * was no exact match. Try to find a non-exact match, and include the
86 * actual value in case we pick the wrong entry. Better than always using
87 * the "Unknown Status" case. */
88 for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs); i++)
89 if (g_aStatusMsgs[i].iCode == HRESULT_CODE(rc))
90 {
91 int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
92 RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "%s 0x%X", g_aStatusMsgs[i].pszDefine, rc);
93 return &g_aUnknownMsgs[iMsg];
94 }
95
96 /*
97 * Need to use the temporary stuff.
98 */
99 int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
100 RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "Unknown Status 0x%X", rc);
101 return &g_aUnknownMsgs[iMsg];
102}
103
104
105RTDECL(PCRTCOMERRMSG) RTErrCOMGet(uint32_t rc)
106{
107 return RTErrWinGet((long)rc);
108}
109
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