errmsgwin.cpp revision 13493ab7596e827b8d0caab2c89e635dd65f78f9
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/* $Id$ */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/** @file
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * IPRT - Status code messages.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/*
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Copyright (C) 2006-2011 Oracle Corporation
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * This file is part of VirtualBox Open Source Edition (OSE), as
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * available from http://www.virtualbox.org. This file is free software;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * you can redistribute it and/or modify it under the terms of the GNU
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * General Public License (GPL) as published by the Free Software
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Foundation, in version 2 as it comes in the "COPYING" file of the
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * The contents of this file may alternatively be used under the terms
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * of the Common Development and Distribution License Version 1.0
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * VirtualBox OSE distribution, in which case the provisions of the
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * CDDL are applicable instead of those of the GPL.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * You may elect to license modified versions of this file under the
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * terms and conditions of either the GPL or the CDDL or both.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
745f1659d4d3978dd0de6cb3ee017b91610fc12bKamal Sivanandam/*******************************************************************************
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster* Header Files *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster*******************************************************************************/
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster#include <Windows.h>
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest#include <iprt/err.h>
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest#include <iprt/asm.h>
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest#include <iprt/string.h>
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest#include <iprt/err.h>
89fd04babb277ae294172d6fa5c28c1b775cfa9fAndrew Forrest
7197110fbdb6deb7868581c455516161cbcf7e0fJaco Jooste
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/*******************************************************************************
745f1659d4d3978dd0de6cb3ee017b91610fc12bKamal Sivanandam* Global Variables *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster*******************************************************************************/
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/** Array of messages.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * The data is generated by a sed script.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterstatic const RTWINERRMSG g_aStatusMsgs[] =
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster{
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster#ifndef IPRT_NO_ERROR_DATA
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster# include "errmsgcomdata.h"
d0da70ccbba38b773e7a7cc71bc124b06206d201Robert Wapshott# if defined(VBOX) && !defined(IN_GUEST)
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen# include "errmsgvboxcomdata.h"
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster# endif
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster#else
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { "Success.", "ERROR_SUCCESS", 0 },
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster#endif
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { NULL, NULL, 0 }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster};
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/** Temporary buffers to format unknown messages in.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * @{
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterstatic char g_aszUnknownStr[4][64];
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterstatic RTWINERRMSG g_aUnknownMsgs[4] =
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster{
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { &g_aszUnknownStr[0][0], &g_aszUnknownStr[0][0], 0 },
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { &g_aszUnknownStr[1][0], &g_aszUnknownStr[1][0], 0 },
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { &g_aszUnknownStr[2][0], &g_aszUnknownStr[2][0], 0 },
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster { &g_aszUnknownStr[3][0], &g_aszUnknownStr[3][0], 0 }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster};
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/** Last used index in g_aUnknownMsgs. */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterstatic volatile uint32_t g_iUnknownMsgs;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/** @} */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Get the message corresponding to a given status code.
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen *
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * @returns Pointer to read-only message description.
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * @param rc The status code.
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen */
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie BowenRTDECL(PCRTWINERRMSG) RTErrWinGet(long rc)
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen{
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen unsigned i;
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs) - 1U; i++)
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen if (g_aStatusMsgs[i].iCode == rc)
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen return &g_aStatusMsgs[i];
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen /* The g_aStatusMsgs table contains a wild mix of error codes with and
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * without included facility and severity. So the chance is high that there
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * was no exact match. Try to find a non-exact match, and include the
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * actual value in case we pick the wrong entry. Better than always using
5c124de5c36bfc236d55578429df5f048f0d0a07Jamie Bowen * the "Unknown Status" case. */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster for (i = 0; i < RT_ELEMENTS(g_aStatusMsgs) - 1U; i++)
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest if (g_aStatusMsgs[i].iCode == HRESULT_CODE(rc))
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest {
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "%s 0x%X", g_aStatusMsgs[i].pszDefine, rc);
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest return &g_aUnknownMsgs[iMsg];
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest }
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest /*
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest * Need to use the temporary stuff.
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest */
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest int32_t iMsg = (ASMAtomicIncU32(&g_iUnknownMsgs) - 1) % RT_ELEMENTS(g_aUnknownMsgs);
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest RTStrPrintf(&g_aszUnknownStr[iMsg][0], sizeof(g_aszUnknownStr[iMsg]), "Unknown Status 0x%X", rc);
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest return &g_aUnknownMsgs[iMsg];
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest}
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest
cf6215c51096624df2e7776c8b8e6319715d4202Andrew ForrestRTDECL(PCRTCOMERRMSG) RTErrCOMGet(uint32_t rc)
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest{
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest return RTErrWinGet((long)rc);
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest}
cf6215c51096624df2e7776c8b8e6319715d4202Andrew Forrest
2210fc30709625f254e6a6d5dc89c3bfefa48816Robert Wapshott