| 1 | /* $Id: VBoxLogRelCreate.cpp 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * MS COM / XPCOM Abstraction Layer - VBoxLogRelCreate.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2005-2024 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 26 | */
|
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 | /*********************************************************************************************************************************
|
|---|
| 30 | * Header Files *
|
|---|
| 31 | *********************************************************************************************************************************/
|
|---|
| 32 | #include <VBox/com/utils.h>
|
|---|
| 33 |
|
|---|
| 34 | #include <iprt/buildconfig.h>
|
|---|
| 35 | #include <iprt/param.h>
|
|---|
| 36 | #include <iprt/string.h>
|
|---|
| 37 | #include <iprt/system.h>
|
|---|
| 38 | #include <iprt/process.h>
|
|---|
| 39 | #include <iprt/time.h>
|
|---|
| 40 |
|
|---|
| 41 | #include <iprt/errcore.h>
|
|---|
| 42 | #include <VBox/log.h>
|
|---|
| 43 | #include <VBox/version.h>
|
|---|
| 44 | #include "package-generated.h"
|
|---|
| 45 |
|
|---|
| 46 |
|
|---|
| 47 |
|
|---|
| 48 | namespace com
|
|---|
| 49 | {
|
|---|
| 50 |
|
|---|
| 51 | static const char *g_pszLogEntity = NULL;
|
|---|
| 52 |
|
|---|
| 53 | static DECLCALLBACK(void) vboxHeaderFooter(PRTLOGGER pReleaseLogger, RTLOGPHASE enmPhase, PFNRTLOGPHASEMSG pfnLog)
|
|---|
| 54 | {
|
|---|
| 55 | /* some introductory information */
|
|---|
| 56 | static RTTIMESPEC s_TimeSpec;
|
|---|
| 57 | char szTmp[256];
|
|---|
| 58 | if (enmPhase == RTLOGPHASE_BEGIN)
|
|---|
| 59 | RTTimeNow(&s_TimeSpec);
|
|---|
| 60 | RTTimeSpecToString(&s_TimeSpec, szTmp, sizeof(szTmp));
|
|---|
| 61 |
|
|---|
| 62 | switch (enmPhase)
|
|---|
| 63 | {
|
|---|
| 64 | case RTLOGPHASE_BEGIN:
|
|---|
| 65 | {
|
|---|
| 66 | bool fOldBuffered = RTLogSetBuffering(pReleaseLogger, true /*fBuffered*/);
|
|---|
| 67 | pfnLog(pReleaseLogger,
|
|---|
| 68 | "VirtualBox %s %s r%u %s (%s %s) release log\n"
|
|---|
| 69 | #ifdef VBOX_BLEEDING_EDGE
|
|---|
| 70 | "EXPERIMENTAL build " VBOX_BLEEDING_EDGE "\n"
|
|---|
| 71 | #endif
|
|---|
| 72 | "Log opened %s\n",
|
|---|
| 73 | g_pszLogEntity, VBOX_VERSION_STRING, RTBldCfgRevision(),
|
|---|
| 74 | RTBldCfgTargetDotArch(), __DATE__, __TIME__, szTmp);
|
|---|
| 75 |
|
|---|
| 76 | pfnLog(pReleaseLogger, "Build Type: %s\n", KBUILD_TYPE);
|
|---|
| 77 | int vrc = RTSystemQueryOSInfo(RTSYSOSINFO_PRODUCT, szTmp, sizeof(szTmp));
|
|---|
| 78 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 79 | pfnLog(pReleaseLogger, "OS Product: %s\n", szTmp);
|
|---|
| 80 | vrc = RTSystemQueryOSInfo(RTSYSOSINFO_RELEASE, szTmp, sizeof(szTmp));
|
|---|
| 81 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 82 | pfnLog(pReleaseLogger, "OS Release: %s\n", szTmp);
|
|---|
| 83 | vrc = RTSystemQueryOSInfo(RTSYSOSINFO_VERSION, szTmp, sizeof(szTmp));
|
|---|
| 84 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 85 | pfnLog(pReleaseLogger, "OS Version: %s\n", szTmp);
|
|---|
| 86 | vrc = RTSystemQueryOSInfo(RTSYSOSINFO_SERVICE_PACK, szTmp, sizeof(szTmp));
|
|---|
| 87 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 88 | pfnLog(pReleaseLogger, "OS Service Pack: %s\n", szTmp);
|
|---|
| 89 |
|
|---|
| 90 | vrc = RTSystemQueryDmiString(RTSYSDMISTR_PRODUCT_NAME, szTmp, sizeof(szTmp));
|
|---|
| 91 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 92 | pfnLog(pReleaseLogger, "DMI Product Name: %s\n", szTmp);
|
|---|
| 93 | vrc = RTSystemQueryDmiString(RTSYSDMISTR_PRODUCT_VERSION, szTmp, sizeof(szTmp));
|
|---|
| 94 | if (RT_SUCCESS(vrc) || vrc == VERR_BUFFER_OVERFLOW)
|
|---|
| 95 | pfnLog(pReleaseLogger, "DMI Product Version: %s\n", szTmp);
|
|---|
| 96 |
|
|---|
| 97 | RTSYSFWTYPE enmType;
|
|---|
| 98 | vrc = RTSystemQueryFirmwareType(&enmType);
|
|---|
| 99 | if (RT_SUCCESS(vrc))
|
|---|
| 100 | {
|
|---|
| 101 | pfnLog(pReleaseLogger, "Firmware type: %s\n", RTSystemFirmwareTypeName(enmType));
|
|---|
| 102 | if (enmType == RTSYSFWTYPE_UEFI)
|
|---|
| 103 | {
|
|---|
| 104 | bool fValue;
|
|---|
| 105 | vrc = RTSystemQueryFirmwareBoolean(RTSYSFWBOOL_SECURE_BOOT, &fValue);
|
|---|
| 106 | if (RT_SUCCESS(vrc))
|
|---|
| 107 | pfnLog(pReleaseLogger, "Secure Boot: %s\n", fValue ? "Enabled" : "Disabled");
|
|---|
| 108 | else
|
|---|
| 109 | pfnLog(pReleaseLogger, "Secure Boot: %Rrc\n", vrc);
|
|---|
| 110 | }
|
|---|
| 111 | }
|
|---|
| 112 | else
|
|---|
| 113 | pfnLog(pReleaseLogger, "Firmware type: failed - %Rrc\n", vrc);
|
|---|
| 114 |
|
|---|
| 115 | uint64_t cbHostRam = 0, cbHostRamAvail = 0;
|
|---|
| 116 | vrc = RTSystemQueryTotalRam(&cbHostRam);
|
|---|
| 117 | if (RT_SUCCESS(vrc))
|
|---|
| 118 | vrc = RTSystemQueryAvailableRam(&cbHostRamAvail);
|
|---|
| 119 | if (RT_SUCCESS(vrc))
|
|---|
| 120 | {
|
|---|
| 121 | pfnLog(pReleaseLogger, "Host RAM: %lluMB", cbHostRam / _1M);
|
|---|
| 122 | if (cbHostRam > _2G)
|
|---|
| 123 | pfnLog(pReleaseLogger, " (%lld.%lldGB)",
|
|---|
| 124 | cbHostRam / _1G, (cbHostRam % _1G) / (_1G / 10));
|
|---|
| 125 | pfnLog(pReleaseLogger, " total, %lluMB", cbHostRamAvail / _1M);
|
|---|
| 126 | if (cbHostRamAvail > _2G)
|
|---|
| 127 | pfnLog(pReleaseLogger, " (%lld.%lldGB)",
|
|---|
| 128 | cbHostRamAvail / _1G, (cbHostRamAvail % _1G) / (_1G / 10));
|
|---|
| 129 | pfnLog(pReleaseLogger, " available\n");
|
|---|
| 130 | }
|
|---|
| 131 |
|
|---|
| 132 | /* the package type is interesting for Linux distributions */
|
|---|
| 133 | char szExecName[RTPATH_MAX];
|
|---|
| 134 | char *pszExecName = RTProcGetExecutablePath(szExecName, sizeof(szExecName));
|
|---|
| 135 | pfnLog(pReleaseLogger,
|
|---|
| 136 | "Executable: %s\n"
|
|---|
| 137 | "Process ID: %u\n"
|
|---|
| 138 | "Package type: %s"
|
|---|
| 139 | #ifdef VBOX_OSE
|
|---|
| 140 | " (OSE)"
|
|---|
| 141 | #endif
|
|---|
| 142 | "\n",
|
|---|
| 143 | pszExecName ? pszExecName : "unknown",
|
|---|
| 144 | RTProcSelf(),
|
|---|
| 145 | VBOX_PACKAGE_STRING);
|
|---|
| 146 |
|
|---|
| 147 | #ifdef RT_OS_WINDOWS
|
|---|
| 148 | static struct
|
|---|
| 149 | {
|
|---|
| 150 | const char *pszDesc;
|
|---|
| 151 | RTSYSNTFEATURE enmFeature;
|
|---|
| 152 | } s_aNtFeatures[] =
|
|---|
| 153 | {
|
|---|
| 154 | { "Core Isolation (Memory Integrity)", RTSYSNTFEATURE_CORE_ISOLATION_MEMORY_INTEGRITY }
|
|---|
| 155 | };
|
|---|
| 156 | pfnLog(pReleaseLogger, "Windows Features:\n");
|
|---|
| 157 | for (size_t i = 0; i < RT_ELEMENTS(s_aNtFeatures); i++)
|
|---|
| 158 | {
|
|---|
| 159 | pfnLog(pReleaseLogger, " %s: ", s_aNtFeatures[i].pszDesc);
|
|---|
| 160 | bool fEnabled;
|
|---|
| 161 | vrc = RTSystemQueryNtFeatureEnabled(s_aNtFeatures[i].enmFeature, &fEnabled);
|
|---|
| 162 | if (RT_SUCCESS(vrc))
|
|---|
| 163 | pfnLog(pReleaseLogger, "%s", fEnabled ? "ENABLED\n" : "DISABLED\n");
|
|---|
| 164 | else if (vrc == VERR_NOT_SUPPORTED)
|
|---|
| 165 | pfnLog(pReleaseLogger, "Not supported\n");
|
|---|
| 166 | else
|
|---|
| 167 | pfnLog(pReleaseLogger, "Failed to query (%Rrc)\n", vrc);
|
|---|
| 168 | }
|
|---|
| 169 | #endif
|
|---|
| 170 | RTLogSetBuffering(pReleaseLogger, fOldBuffered);
|
|---|
| 171 | break;
|
|---|
| 172 | }
|
|---|
| 173 |
|
|---|
| 174 | case RTLOGPHASE_PREROTATE:
|
|---|
| 175 | pfnLog(pReleaseLogger, "Log rotated - Log started %s\n", szTmp);
|
|---|
| 176 | break;
|
|---|
| 177 |
|
|---|
| 178 | case RTLOGPHASE_POSTROTATE:
|
|---|
| 179 | pfnLog(pReleaseLogger, "Log continuation - Log started %s\n", szTmp);
|
|---|
| 180 | break;
|
|---|
| 181 |
|
|---|
| 182 | case RTLOGPHASE_END:
|
|---|
| 183 | pfnLog(pReleaseLogger, "End of log file - Log started %s\n", szTmp);
|
|---|
| 184 | break;
|
|---|
| 185 |
|
|---|
| 186 | default:
|
|---|
| 187 | /* nothing */;
|
|---|
| 188 | }
|
|---|
| 189 | }
|
|---|
| 190 |
|
|---|
| 191 | int VBoxLogRelCreate(const char *pcszEntity, const char *pcszLogFile,
|
|---|
| 192 | uint32_t fFlags, const char *pcszGroupSettings,
|
|---|
| 193 | const char *pcszEnvVarBase, uint32_t fDestFlags,
|
|---|
| 194 | uint32_t cMaxEntriesPerGroup, uint32_t cHistory,
|
|---|
| 195 | uint32_t uHistoryFileTime, uint64_t uHistoryFileSize,
|
|---|
| 196 | PRTERRINFO pErrInfo)
|
|---|
| 197 | {
|
|---|
| 198 | return VBoxLogRelCreateEx(pcszEntity, pcszLogFile,
|
|---|
| 199 | fFlags, pcszGroupSettings,
|
|---|
| 200 | pcszEnvVarBase, fDestFlags,
|
|---|
| 201 | cMaxEntriesPerGroup, cHistory,
|
|---|
| 202 | uHistoryFileTime, uHistoryFileSize,
|
|---|
| 203 | NULL /*pOutputIf*/, NULL /*pvOutputIfUser*/,
|
|---|
| 204 | pErrInfo);
|
|---|
| 205 | }
|
|---|
| 206 |
|
|---|
| 207 | int VBoxLogRelCreateEx(const char *pcszEntity, const char *pcszLogFile,
|
|---|
| 208 | uint32_t fFlags, const char *pcszGroupSettings,
|
|---|
| 209 | const char *pcszEnvVarBase, uint32_t fDestFlags,
|
|---|
| 210 | uint32_t cMaxEntriesPerGroup, uint32_t cHistory,
|
|---|
| 211 | uint32_t uHistoryFileTime, uint64_t uHistoryFileSize,
|
|---|
| 212 | const void *pOutputIf, void *pvOutputIfUser,
|
|---|
| 213 | PRTERRINFO pErrInfo)
|
|---|
| 214 | {
|
|---|
| 215 | /* create release logger */
|
|---|
| 216 | PRTLOGGER pReleaseLogger;
|
|---|
| 217 | static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
|
|---|
| 218 | #if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
|
|---|
| 219 | fFlags |= RTLOGFLAGS_USECRLF;
|
|---|
| 220 | #endif
|
|---|
| 221 | g_pszLogEntity = pcszEntity;
|
|---|
| 222 | int vrc = RTLogCreateEx(&pReleaseLogger, pcszEnvVarBase, fFlags, pcszGroupSettings, RT_ELEMENTS(s_apszGroups), s_apszGroups,
|
|---|
| 223 | cMaxEntriesPerGroup, 0 /*cBufDescs*/, NULL /*paBufDescs*/, fDestFlags,
|
|---|
| 224 | vboxHeaderFooter, cHistory, uHistoryFileSize, uHistoryFileTime,
|
|---|
| 225 | (PCRTLOGOUTPUTIF)pOutputIf, pvOutputIfUser,
|
|---|
| 226 | pErrInfo, pcszLogFile ? "%s" : NULL, pcszLogFile);
|
|---|
| 227 | if (RT_SUCCESS(vrc))
|
|---|
| 228 | {
|
|---|
| 229 | /* explicitly flush the log, to have some info when buffering */
|
|---|
| 230 | RTLogFlush(pReleaseLogger);
|
|---|
| 231 |
|
|---|
| 232 | /* register this logger as the release logger */
|
|---|
| 233 | RTLogRelSetDefaultInstance(pReleaseLogger);
|
|---|
| 234 | }
|
|---|
| 235 | return vrc;
|
|---|
| 236 | }
|
|---|
| 237 |
|
|---|
| 238 | } /* namespace com */
|
|---|
