1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
/*********************************************************
* Copyright (C) 1998 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
#ifndef VMWARE_LOG_H
#define VMWARE_LOG_H
#define INCLUDE_ALLOW_USERLEVEL
#define INCLUDE_ALLOW_VMCORE
#include "includeCheck.h"
#include <stdarg.h>
/*
* The bora/lig Log Facility log level model.
* This the same as the vmacore/hostd Log Facility.
*
* The VMW_LOG_BASE is chosen to ensure that on all platforms commonly
* used system logger values will be invalid and the errant usage caught.
*/
#define VMW_LOG_BASE 100
#define VMW_LOG_PANIC (VMW_LOG_BASE + 0) // highest priority
#define VMW_LOG_ERROR (VMW_LOG_BASE + 5)
#define VMW_LOG_WARNING (VMW_LOG_BASE + 10) // <= goes to stderr by default
#define VMW_LOG_AUDIT (VMW_LOG_BASE + 15) // *ALWAYS* output to the log
#define VMW_LOG_INFO (VMW_LOG_BASE + 20) // <= goes to log by default
#define VMW_LOG_VERBOSE (VMW_LOG_BASE + 25)
#define VMW_LOG_TRIVIA (VMW_LOG_BASE + 30)
#define VMW_LOG_DEBUG_00 (VMW_LOG_BASE + 35) // noisiest level of debugging
#define VMW_LOG_DEBUG_01 (VMW_LOG_DEBUG_00 + 1)
#define VMW_LOG_DEBUG_02 (VMW_LOG_DEBUG_00 + 2)
#define VMW_LOG_DEBUG_03 (VMW_LOG_DEBUG_00 + 3)
#define VMW_LOG_DEBUG_04 (VMW_LOG_DEBUG_00 + 4)
#define VMW_LOG_DEBUG_05 (VMW_LOG_DEBUG_00 + 5)
#define VMW_LOG_DEBUG_06 (VMW_LOG_DEBUG_00 + 6)
#define VMW_LOG_DEBUG_07 (VMW_LOG_DEBUG_00 + 7)
#define VMW_LOG_DEBUG_08 (VMW_LOG_DEBUG_00 + 8)
#define VMW_LOG_DEBUG_09 (VMW_LOG_DEBUG_00 + 9)
#define VMW_LOG_DEBUG_10 (VMW_LOG_DEBUG_00 + 10) // lowest priority; least noisy
#define VMW_LOG_NO_ROUTE 0x80000000 // Force routing to Log
#define VMW_LOG_NO_ROUTE_STDERR 0x40000000 // Allow stderr on suitable msgs
void LogV(uint32 routing,
const char *fmt,
va_list args);
/*
* Handy wrapper functions.
*
* Log -> VMW_LOG_INFO
* Warning -> VMW_LOG_WARNING
*
* TODO: even Log and Warning become wrapper functions around LogV.
*/
static INLINE void PRINTF_DECL(2, 3)
Log_Level(uint32 routing,
const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(routing, fmt, ap);
va_end(ap);
}
static INLINE void
Log_String(uint32 routing,
const char *string)
{
Log_Level(routing, "%s", string);
}
static INLINE void PRINTF_DECL(1, 2)
Log_Panic(const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(VMW_LOG_PANIC, fmt, ap);
va_end(ap);
}
static INLINE void PRINTF_DECL(1, 2)
Log_Audit(const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(VMW_LOG_AUDIT, fmt, ap);
va_end(ap);
}
static INLINE void PRINTF_DECL(1, 2)
Log_Error(const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(VMW_LOG_ERROR, fmt, ap);
va_end(ap);
}
static INLINE void PRINTF_DECL(1, 2)
Log_Verbose(const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(VMW_LOG_VERBOSE, fmt, ap);
va_end(ap);
}
static INLINE void PRINTF_DECL(1, 2)
Log_Trivia(const char *fmt,
...)
{
va_list ap;
va_start(ap, fmt);
LogV(VMW_LOG_TRIVIA, fmt, ap);
va_end(ap);
}
#if !defined(VMM)
/* Forward decl */
struct MsgList;
typedef void (LogOverrideFunc)(int level,
const char *msg);
typedef enum {
LOG_SYSTEM_LOGGER_NONE,
LOG_SYSTEM_LOGGER_ADJUNCT,
LOG_SYSTEM_LOGGER_ONLY
} SysLogger;
typedef struct
{
uint32 signature; // initialization signature
const char *fileName; // File name, if known
const char *config; // Config variable to look up
const char *suffix; // Suffix to generate log file name
const char *appName; // App name for log header
const char *appVersion; // App version for log header
Bool append; // Append to log file
Bool switchFile; // Switch the initial log file
Bool useThreadName; // Thread name on log line
Bool useTimeStamp; // Use a log line time stamp
Bool useMilliseconds; // Show milliseconds in time stamp
Bool useLevelDesignator; // Show level designator
Bool fastRotation; // ESX log rotation optimization
Bool preventRemove; // prevent Log_RemoveFile(FALSE)
Bool syncAfterWrite; // Sync after a write. Expensive!
int32 stderrMinLevel; // This level and above to stderr
int32 logMinLevel; // This level and above to log
uint32 keepOld; // Number of old logs to keep
uint32 throttleThreshold; // Threshold for throttling
uint32 throttleBPS; // BPS for throttle
uint32 rotateSize; // Size at which log should be rotated
SysLogger systemLoggerUse; // System logger options
char systemLoggerID[128]; // Identifier for system logger
} LogInitParams;
void Log_GetStaticDefaults(LogInitParams *params);
void Log_ApplyConfigValues(const char *appPrefix,
LogInitParams *params);
Bool Log_InitEx(const LogInitParams *params);
Bool Log_InitWithFile(const char *fileName,
const char *appPrefix);
Bool Log_InitWithConfig(const char *appPrefix);
void Log_UpdateFileControl(Bool append,
unsigned keepOld,
size_t rotateSize,
Bool fastRotation,
uint32 throttleThreshold,
uint32 throttleBPS);
void Log_UpdatePerLine(Bool perLineTimeStamps,
Bool perLineMilliseconds,
Bool perLineThreadNames);
void Log_Exit(void);
Bool Log_Outputting(void);
const char *Log_GetFileName(void);
void Log_SkipLocking(Bool skipLocking);
void Log_SetAlwaysKeep(Bool alwaysKeep);
Bool Log_RemoveFile(Bool alwaysRemove);
void Log_DisableThrottling(void);
void Log_EnableStderrWarnings(Bool stderrOutput);
void Log_BackupOldFiles(const char *fileName,
Bool noRename);
Bool Log_CopyFile(const char *fileName,
struct MsgList **errs);
uint32 Log_MaxLineLength(void);
void Log_OverrideFunction(LogOverrideFunc *func);
Bool Log_SetOutput(const char *fileName,
const char *config,
Bool copy,
uint32 systemLoggerUse,
char *systemLoggerID,
struct MsgList **errs);
size_t Log_MakeTimeString(Bool millisec,
char *buf,
size_t max);
typedef Bool (LogOwnerFunc)(void *userData,
const char *fileName);
Bool Log_BoundNumFiles(LogOwnerFunc *func,
void *userData);
/* Logging that uses the custom guest throttling configuration. */
void GuestLog_Init(void);
void GuestLog_Log(const char *fmt,
...) PRINTF_DECL(1, 2);
/*
* Default values for the log are obtained via Log_GetStaticDefaults.
*
* These values represent commonly used override values.
*/
#if defined(VMX86_SERVER)
#define LOG_KEEPOLD 6 // Old log files to keep around; ESX value
#else
#define LOG_KEEPOLD 3 // Old log files to keep around; non-ESX value
#endif
#define LOG_NO_KEEPOLD 0 // Keep no old log files
#define LOG_NO_ROTATION_SIZE 0 // Do not rotate based on file size
#define LOG_NO_THROTTLE_THRESHOLD 0 // No threshold before throttling
#define LOG_NO_BPS_LIMIT 0xFFFFFFFF // unlimited input rate
/*
* Debugging
*/
void Log_HexDump(const char *prefix,
const uint8 *data,
int size);
void Log_Time(VmTimeType *time,
int count,
const char *message);
void Log_Histogram(uint32 n,
uint32 histo[],
int nbuckets,
const char *message,
int *count,
int limit);
#endif /* !VMM */
#endif /* VMWARE_LOG_H */
|