VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/win/VBoxDbgLog.h@ 104448

Last change on this file since 104448 was 98103, checked in by vboxsync, 22 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.2 KB
Line 
1/* $Id: VBoxDbgLog.h 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * Logging helper
4 */
5
6/*
7 * Copyright (C) 2011-2023 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 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37#ifndef VBOX_INCLUDED_SRC_win_VBoxDbgLog_h
38#define VBOX_INCLUDED_SRC_win_VBoxDbgLog_h
39#ifndef RT_WITHOUT_PRAGMA_ONCE
40# pragma once
41#endif
42
43#ifndef VBOX_DBG_LOG_NAME
44# error VBOX_DBG_LOG_NAME should be defined!
45#endif
46
47/* Uncomment to show file/line info in the log */
48/*#define VBOX_DBG_LOG_SHOWLINEINFO*/
49
50#define VBOX_DBG_LOG_PREFIX_FMT VBOX_DBG_LOG_NAME"::"LOG_FN_FMT": "
51#define VBOX_DBG_LOG_PREFIX_PARMS __PRETTY_FUNCTION__
52
53#ifdef VBOX_DBG_LOG_SHOWLINEINFO
54# define VBOX_DBG_LOG_SUFFIX_FMT " (%s:%d)\n"
55# define VBOX_DBG_LOG_SUFFIX_PARMS ,__FILE__, __LINE__
56#else
57# define VBOX_DBG_LOG_SUFFIX_FMT "\n"
58# define VBOX_DBG_LOG_SUFFIX_PARMS
59#endif
60
61#ifdef DEBUG_misha
62# define BP_WARN() AssertFailed()
63#else
64# define BP_WARN() do { } while (0)
65#endif
66
67#define _LOGMSG_EXACT(_logger, _a) \
68 do \
69 { \
70 _logger(_a); \
71 } while (0)
72
73#define _LOGMSG(_logger, _a) \
74 do \
75 { \
76 _logger((VBOX_DBG_LOG_PREFIX_FMT, VBOX_DBG_LOG_PREFIX_PARMS)); \
77 _logger(_a); \
78 _logger((VBOX_DBG_LOG_SUFFIX_FMT VBOX_DBG_LOG_SUFFIX_PARMS)); \
79 } while (0)
80
81/* we can not print paged strings to RT logger, do it this way */
82#define _LOGMSG_STR(_logger, _a, _f) do {\
83 int _i = 0; \
84 _logger(("\"")); \
85 for (;(_a)[_i];++_i) { \
86 _logger(("%"_f, (_a)[_i])); \
87 }\
88 _logger(("\"\n")); \
89 } while (0)
90
91#define _LOGMSG_USTR(_logger, _a) do {\
92 int _i = 0; \
93 _logger(("\"")); \
94 for (;_i<(_a)->Length/2;++_i) { \
95 _logger(("%c", (_a)->Buffer[_i])); \
96 }\
97 _logger(("\"\n")); \
98 } while (0)
99
100#define WARN_NOBP(_a) \
101 do \
102 { \
103 Log((VBOX_DBG_LOG_PREFIX_FMT"WARNING! ", VBOX_DBG_LOG_PREFIX_PARMS)); \
104 Log(_a); \
105 Log((VBOX_DBG_LOG_SUFFIX_FMT VBOX_DBG_LOG_SUFFIX_PARMS)); \
106 } while (0)
107
108#define WARN(_a) \
109 do \
110 { \
111 WARN_NOBP(_a); \
112 BP_WARN(); \
113 } while (0)
114
115#define ASSERT_WARN(_a, _w) do {\
116 if(!(_a)) { \
117 WARN(_w); \
118 }\
119 } while (0)
120
121#define LOG(_a) _LOGMSG(Log, _a)
122#define LOGREL(_a) _LOGMSG(LogRel, _a)
123#define LOGF(_a) _LOGMSG(LogFlow, _a)
124#define LOGF_ENTER() LOGF(("ENTER"))
125#define LOGF_LEAVE() LOGF(("LEAVE"))
126#define LOG_EXACT(_a) _LOGMSG_EXACT(Log, _a)
127#define LOGREL_EXACT(_a) _LOGMSG_EXACT(LogRel, _a)
128/* we can not print paged strings to RT logger, do it this way */
129#define LOG_STRA(_a) do {\
130 _LOGMSG_STR(Log, _a, "c"); \
131 } while (0)
132#define LOG_STRW(_a) do {\
133 _LOGMSG_STR(Log, _a, "c"); \
134 } while (0)
135#define LOG_USTR(_a) do {\
136 _LOGMSG_USTR(Log, _a); \
137 } while (0)
138#define LOGREL_STRA(_a) do {\
139 _LOGMSG_STR(LogRel, _a, "c"); \
140 } while (0)
141#define LOGREL_STRW(_a) do {\
142 _LOGMSG_STR(LogRel, _a, "c"); \
143 } while (0)
144#define LOGREL_USTR(_a) do {\
145 _LOGMSG_USTR(LogRel, _a); \
146 } while (0)
147
148
149#endif /* !VBOX_INCLUDED_SRC_win_VBoxDbgLog_h */
150
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