20#include <winpr/config.h>
28#include <winpr/assert.h>
29#include <winpr/print.h>
30#include <winpr/debug.h>
31#include <winpr/environment.h>
32#include <winpr/wlog.h>
35#include <android/log.h>
48#define WLOG_FILTER_NOT_FILTERED (-1)
49#define WLOG_FILTER_NOT_INITIALIZED (-2)
60LPCSTR WLOG_LEVELS[7] = {
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"FATAL",
"OFF" };
62static INIT_ONCE g_WLogInitialized = INIT_ONCE_STATIC_INIT;
63static DWORD g_FilterCount = 0;
64static wLogFilter* g_Filters = NULL;
65static wLog* g_RootLog = NULL;
67static wLog* WLog_New(LPCSTR name, wLog* rootLogger);
68static void WLog_Free(wLog* log);
69static LONG WLog_GetFilterLogLevel(wLog* log);
70static int WLog_ParseLogLevel(LPCSTR level);
71static BOOL WLog_ParseFilter(wLog* root, wLogFilter* filter, LPCSTR name);
72static BOOL WLog_ParseFilters(wLog* root);
73static wLog* WLog_Get_int(wLog* root, LPCSTR name);
76static void WLog_Uninit_(
void) __attribute__((destructor));
79static void WLog_Uninit_(
void)
82 wLog* root = g_RootLog;
87 for (DWORD index = 0; index < root->ChildrenCount; index++)
89 child = root->Children[index];
97static void WLog_Lock(wLog* log)
100 EnterCriticalSection(&log->lock);
103static void WLog_Unlock(wLog* log)
106 LeaveCriticalSection(&log->lock);
109static BOOL CALLBACK WLog_InitializeRoot(
PINIT_ONCE InitOnce, PVOID Parameter, PVOID* Context)
113 DWORD logAppenderType = 0;
114 LPCSTR appender =
"WLOG_APPENDER";
116 WINPR_UNUSED(InitOnce);
117 WINPR_UNUSED(Parameter);
118 WINPR_UNUSED(Context);
120 if (!(g_RootLog = WLog_New(
"", NULL)))
123 g_RootLog->IsRoot = TRUE;
124 logAppenderType = WLOG_APPENDER_CONSOLE;
125 nSize = GetEnvironmentVariableA(appender, NULL, 0);
129 env = (LPSTR)malloc(nSize);
134 if (GetEnvironmentVariableA(appender, env, nSize) != nSize - 1)
136 (void)fprintf(stderr,
"%s environment variable modified in my back", appender);
141 if (_stricmp(env,
"CONSOLE") == 0)
142 logAppenderType = WLOG_APPENDER_CONSOLE;
143 else if (_stricmp(env,
"FILE") == 0)
144 logAppenderType = WLOG_APPENDER_FILE;
145 else if (_stricmp(env,
"BINARY") == 0)
146 logAppenderType = WLOG_APPENDER_BINARY;
148#ifdef WINPR_HAVE_SYSLOG_H
149 else if (_stricmp(env,
"SYSLOG") == 0)
150 logAppenderType = WLOG_APPENDER_SYSLOG;
153#ifdef WINPR_HAVE_JOURNALD_H
154 else if (_stricmp(env,
"JOURNALD") == 0)
155 logAppenderType = WLOG_APPENDER_JOURNALD;
158 else if (_stricmp(env,
"UDP") == 0)
159 logAppenderType = WLOG_APPENDER_UDP;
164 if (!WLog_SetLogAppenderType(g_RootLog, logAppenderType))
167 if (!WLog_ParseFilters(g_RootLog))
170 (void)atexit(WLog_Uninit_);
178static BOOL log_recursion(LPCSTR file, LPCSTR fkt,
size_t line)
183 void* bt = winpr_backtrace(20);
185 LPCSTR tag = WINPR_TAG(
"utils.wlog");
191 msg = winpr_backtrace_symbols(bt, &used);
198 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"Recursion detected!!!") < 0)
201 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"Check %s [%s:%zu]", fkt, file, line) < 0)
204 for (
size_t i = 0; i < used; i++)
205 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"%zu: %s", i, msg[i]) < 0)
210 if (fprintf(stderr,
"[%s]: Recursion detected!\n", fkt) < 0)
213 if (fprintf(stderr,
"[%s]: Check %s:%" PRIuz
"\n", fkt, file, line) < 0)
216 for (
size_t i = 0; i < used; i++)
217 if (fprintf(stderr,
"%s: %" PRIuz
": %s\n", fkt, i, msg[i]) < 0)
224 winpr_backtrace_free(bt);
228static BOOL WLog_Write(wLog* log,
wLogMessage* message)
231 wLogAppender* appender = NULL;
232 appender = WLog_GetLogAppender(log);
237 if (!appender->active)
238 if (!WLog_OpenAppender(log))
241 EnterCriticalSection(&appender->lock);
243 if (appender->WriteMessage)
245 if (appender->recursive)
246 status = log_recursion(message->FileName, message->FunctionName, message->LineNumber);
249 appender->recursive = TRUE;
250 status = appender->WriteMessage(log, appender, message);
251 appender->recursive = FALSE;
255 LeaveCriticalSection(&appender->lock);
259static BOOL WLog_WriteData(wLog* log,
wLogMessage* message)
262 wLogAppender* appender = NULL;
263 appender = WLog_GetLogAppender(log);
268 if (!appender->active)
269 if (!WLog_OpenAppender(log))
272 if (!appender->WriteDataMessage)
275 EnterCriticalSection(&appender->lock);
277 if (appender->recursive)
278 status = log_recursion(message->FileName, message->FunctionName, message->LineNumber);
281 appender->recursive = TRUE;
282 status = appender->WriteDataMessage(log, appender, message);
283 appender->recursive = FALSE;
286 LeaveCriticalSection(&appender->lock);
290static BOOL WLog_WriteImage(wLog* log,
wLogMessage* message)
293 wLogAppender* appender = NULL;
294 appender = WLog_GetLogAppender(log);
299 if (!appender->active)
300 if (!WLog_OpenAppender(log))
303 if (!appender->WriteImageMessage)
306 EnterCriticalSection(&appender->lock);
308 if (appender->recursive)
309 status = log_recursion(message->FileName, message->FunctionName, message->LineNumber);
312 appender->recursive = TRUE;
313 status = appender->WriteImageMessage(log, appender, message);
314 appender->recursive = FALSE;
317 LeaveCriticalSection(&appender->lock);
321static BOOL WLog_WritePacket(wLog* log,
wLogMessage* message)
324 wLogAppender* appender = NULL;
325 appender = WLog_GetLogAppender(log);
330 if (!appender->active)
331 if (!WLog_OpenAppender(log))
334 if (!appender->WritePacketMessage)
337 EnterCriticalSection(&appender->lock);
339 if (appender->recursive)
340 status = log_recursion(message->FileName, message->FunctionName, message->LineNumber);
343 appender->recursive = TRUE;
344 status = appender->WritePacketMessage(log, appender, message);
345 appender->recursive = FALSE;
348 LeaveCriticalSection(&appender->lock);
352BOOL WLog_PrintMessageVA(wLog* log, DWORD type, DWORD level,
size_t line,
const char* file,
353 const char* function, va_list args)
358 message.Level = level;
359 message.LineNumber = line;
360 message.FileName = file;
361 message.FunctionName = function;
365 case WLOG_MESSAGE_TEXT:
366 message.FormatString = va_arg(args,
const char*);
368 if (!strchr(message.FormatString,
'%'))
370 message.TextString = message.FormatString;
371 status = WLog_Write(log, &message);
375 char formattedLogMessage[WLOG_MAX_STRING_SIZE] = { 0 };
377 WINPR_PRAGMA_DIAG_PUSH
378 WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
379 if (vsnprintf(formattedLogMessage, WLOG_MAX_STRING_SIZE - 1, message.FormatString,
382 WINPR_PRAGMA_DIAG_POP
384 message.TextString = formattedLogMessage;
385 status = WLog_Write(log, &message);
390 case WLOG_MESSAGE_DATA:
391 message.Data = va_arg(args,
void*);
392 message.Length = va_arg(args,
size_t);
393 status = WLog_WriteData(log, &message);
396 case WLOG_MESSAGE_IMAGE:
397 message.ImageData = va_arg(args,
void*);
398 message.ImageWidth = va_arg(args,
size_t);
399 message.ImageHeight = va_arg(args,
size_t);
400 message.ImageBpp = va_arg(args,
size_t);
401 status = WLog_WriteImage(log, &message);
404 case WLOG_MESSAGE_PACKET:
405 message.PacketData = va_arg(args,
void*);
406 message.PacketLength = va_arg(args,
size_t);
407 message.PacketFlags = va_arg(args,
unsigned);
408 status = WLog_WritePacket(log, &message);
418BOOL WLog_PrintTextMessageVA(wLog* log, DWORD level,
size_t line,
const char* file,
419 const char* function,
const char* fmt, va_list args)
423 message.Type = WLOG_MESSAGE_TEXT;
424 message.Level = level;
425 message.LineNumber = line;
426 message.FileName = file;
427 message.FunctionName = function;
429 message.FormatString = fmt;
431 if (!strchr(message.FormatString,
'%'))
433 message.TextString = message.FormatString;
434 status = WLog_Write(log, &message);
438 char formattedLogMessage[WLOG_MAX_STRING_SIZE] = { 0 };
440 WINPR_PRAGMA_DIAG_PUSH
441 WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
442 if (vsnprintf(formattedLogMessage, WLOG_MAX_STRING_SIZE - 1, message.FormatString, args) <
445 WINPR_PRAGMA_DIAG_POP
447 message.TextString = formattedLogMessage;
448 status = WLog_Write(log, &message);
454BOOL WLog_PrintMessage(wLog* log, DWORD type, DWORD level,
size_t line,
const char* file,
455 const char* function, ...)
459 va_start(args, function);
460 status = WLog_PrintMessageVA(log, type, level, line, file, function, args);
465BOOL WLog_PrintTextMessage(wLog* log, DWORD level,
size_t line,
const char* file,
466 const char* function,
const char* fmt, ...)
471 status = WLog_PrintTextMessageVA(log, level, line, file, function, fmt, args);
476DWORD WLog_GetLogLevel(wLog* log)
481 if (log->FilterLevel <= WLOG_FILTER_NOT_INITIALIZED)
482 log->FilterLevel = WLog_GetFilterLogLevel(log);
484 if (log->FilterLevel > WLOG_FILTER_NOT_FILTERED)
485 return (DWORD)log->FilterLevel;
486 else if (log->Level == WLOG_LEVEL_INHERIT)
487 log->Level = WLog_GetLogLevel(log->Parent);
492BOOL WLog_IsLevelActive(wLog* _log, DWORD _log_level)
499 level = WLog_GetLogLevel(_log);
501 if (level == WLOG_OFF)
504 return _log_level >= level;
507BOOL WLog_SetStringLogLevel(wLog* log, LPCSTR level)
514 lvl = WLog_ParseLogLevel(level);
519 return WLog_SetLogLevel(log, (DWORD)lvl);
522static BOOL WLog_reset_log_filters(wLog* log)
527 log->FilterLevel = WLOG_FILTER_NOT_INITIALIZED;
529 for (DWORD x = 0; x < log->ChildrenCount; x++)
531 wLog* child = log->Children[x];
533 if (!WLog_reset_log_filters(child))
540static BOOL WLog_AddStringLogFilters_int(wLog* root, LPCSTR filter)
543 LPCSTR filterStr = NULL;
551 while ((cpp = strchr(cpp,
',')) != NULL)
557 DWORD pos = g_FilterCount;
558 DWORD size = g_FilterCount + count;
559 wLogFilter* tmp = (wLogFilter*)realloc(g_Filters, size *
sizeof(wLogFilter));
565 LPSTR cp = (LPSTR)_strdup(filter);
582 if (!WLog_ParseFilter(root, &g_Filters[pos++], filterStr))
598 g_FilterCount = size;
600 return WLog_reset_log_filters(root);
603BOOL WLog_AddStringLogFilters(LPCSTR filter)
606 wLog* root = WLog_GetRoot();
607 return WLog_AddStringLogFilters_int(root, filter);
610static BOOL WLog_UpdateInheritLevel(wLog* log, DWORD logLevel)
617 log->Level = logLevel;
619 for (DWORD x = 0; x < log->ChildrenCount; x++)
621 wLog* child = log->Children[x];
623 if (!WLog_UpdateInheritLevel(child, logLevel))
631BOOL WLog_SetLogLevel(wLog* log, DWORD logLevel)
636 if ((logLevel > WLOG_OFF) && (logLevel != WLOG_LEVEL_INHERIT))
639 log->Level = logLevel;
640 log->inherit = (logLevel == WLOG_LEVEL_INHERIT) ? TRUE : FALSE;
642 for (DWORD x = 0; x < log->ChildrenCount; x++)
644 wLog* child = log->Children[x];
646 if (!WLog_UpdateInheritLevel(child, logLevel))
650 return WLog_reset_log_filters(log);
653int WLog_ParseLogLevel(LPCSTR level)
660 if (_stricmp(level,
"TRACE") == 0)
662 else if (_stricmp(level,
"DEBUG") == 0)
664 else if (_stricmp(level,
"INFO") == 0)
666 else if (_stricmp(level,
"WARN") == 0)
668 else if (_stricmp(level,
"ERROR") == 0)
670 else if (_stricmp(level,
"FATAL") == 0)
672 else if (_stricmp(level,
"OFF") == 0)
678BOOL WLog_ParseFilter(wLog* root, wLogFilter* filter, LPCSTR name)
680 const char* pc = NULL;
697 while ((pc = strchr(pc,
'.')) != NULL)
704 names = _strdup(name);
709 filter->NameCount = count;
710 filter->Names = (LPSTR*)calloc((count + 1UL),
sizeof(LPSTR));
715 filter->NameCount = 0;
719 filter->Names[count] = NULL;
722 filter->Names[count++] = p;
728 free((
void*)filter->Names);
729 filter->Names = NULL;
730 filter->NameCount = 0;
736 iLevel = WLog_ParseLogLevel(q);
741 free((
void*)filter->Names);
742 filter->Names = NULL;
743 filter->NameCount = 0;
747 filter->Level = (DWORD)iLevel;
749 while ((p = strchr(p,
'.')) != NULL)
751 if (count < filter->NameCount)
752 filter->Names[count++] = p + 1;
761BOOL WLog_ParseFilters(wLog* root)
763 LPCSTR filter =
"WLOG_FILTER";
770 nSize = GetEnvironmentVariableA(filter, NULL, 0);
775 env = (LPSTR)malloc(nSize);
780 if (GetEnvironmentVariableA(filter, env, nSize) == nSize - 1)
781 res = WLog_AddStringLogFilters_int(root, env);
787LONG WLog_GetFilterLogLevel(wLog* log)
791 if (log->FilterLevel >= 0)
792 return log->FilterLevel;
794 log->FilterLevel = WLOG_FILTER_NOT_FILTERED;
795 for (DWORD i = 0; i < g_FilterCount; i++)
797 const wLogFilter* filter = &g_Filters[i];
798 for (DWORD j = 0; j < filter->NameCount; j++)
800 if (j >= log->NameCount)
803 if (_stricmp(filter->Names[j],
"*") == 0)
806 assert(filter->Level <= INT32_MAX);
807 log->FilterLevel = (LONG)filter->Level;
811 if (_stricmp(filter->Names[j], log->Names[j]) != 0)
814 if (j == (log->NameCount - 1))
816 match = log->NameCount == filter->NameCount;
819 assert(filter->Level <= INT32_MAX);
820 log->FilterLevel = (LONG)filter->Level;
830 return log->FilterLevel;
833static BOOL WLog_ParseName(wLog* log, LPCSTR name)
835 const char* cp = name;
840 while ((cp = strchr(cp,
'.')) != NULL)
846 names = _strdup(name);
851 log->NameCount = count;
852 log->Names = (LPSTR*)calloc((count + 1UL),
sizeof(LPSTR));
860 log->Names[count] = NULL;
863 log->Names[count++] = p;
865 while ((p = strchr(p,
'.')) != NULL)
867 if (count < log->NameCount)
868 log->Names[count++] = p + 1;
877wLog* WLog_New(LPCSTR name, wLog* rootLogger)
883 log = (wLog*)calloc(1,
sizeof(wLog));
888 log->Name = _strdup(name);
893 if (!WLog_ParseName(log, name))
896 log->Parent = rootLogger;
897 log->ChildrenCount = 0;
898 log->ChildrenSize = 16;
899 log->FilterLevel = WLOG_FILTER_NOT_INITIALIZED;
901 if (!(log->Children = (wLog**)calloc(log->ChildrenSize,
sizeof(wLog*))))
904 log->Appender = NULL;
908 log->Level = WLOG_LEVEL_INHERIT;
913 LPCSTR level =
"WLOG_LEVEL";
914 log->Level = WLOG_INFO;
915 nSize = GetEnvironmentVariableA(level, NULL, 0);
919 env = (LPSTR)malloc(nSize);
924 if (GetEnvironmentVariableA(level, env, nSize) != nSize - 1)
926 (void)fprintf(stderr,
"%s environment variable changed in my back !\n", level);
931 iLevel = WLog_ParseLogLevel(env);
936 if (!WLog_SetLogLevel(log, (DWORD)iLevel))
942 iLevel = WLog_GetFilterLogLevel(log);
946 if (!WLog_SetLogLevel(log, (DWORD)iLevel))
950 InitializeCriticalSectionAndSpinCount(&log->lock, 4000);
958void WLog_Free(wLog* log)
964 WLog_Appender_Free(log, log->Appender);
965 log->Appender = NULL;
973 free((
void*)log->Names);
974 free((
void*)log->Children);
975 DeleteCriticalSection(&log->lock);
980wLog* WLog_GetRoot(
void)
982 if (!InitOnceExecuteOnce(&g_WLogInitialized, WLog_InitializeRoot, NULL, NULL))
988static BOOL WLog_AddChild(wLog* parent, wLog* child)
994 if (parent->ChildrenCount >= parent->ChildrenSize)
997 parent->ChildrenSize *= 2;
999 if (!parent->ChildrenSize)
1001 free((
void*)parent->Children);
1002 parent->Children = NULL;
1006 tmp = (wLog**)realloc((
void*)parent->Children,
sizeof(wLog*) * parent->ChildrenSize);
1010 free((
void*)parent->Children);
1011 parent->Children = NULL;
1015 parent->Children = tmp;
1019 if (!parent->Children)
1022 parent->Children[parent->ChildrenCount++] = child;
1023 child->Parent = parent;
1025 WLog_Unlock(parent);
1032static wLog* WLog_FindChild(wLog* root, LPCSTR name)
1042 for (DWORD index = 0; index < root->ChildrenCount; index++)
1044 child = root->Children[index];
1046 if (strcmp(child->Name, name) == 0)
1055 return (found) ? child : NULL;
1058static wLog* WLog_Get_int(wLog* root, LPCSTR name)
1062 if (!(log = WLog_FindChild(root, name)))
1067 if (!(log = WLog_New(name, root)))
1070 if (!WLog_AddChild(root, log))
1080wLog* WLog_Get(LPCSTR name)
1082 wLog* root = WLog_GetRoot();
1083 return WLog_Get_int(root, name);
1086#if defined(WITH_WINPR_DEPRECATED)
1089 return WLog_GetRoot() != NULL;
1092BOOL WLog_Uninit(
void)
1094 wLog* root = g_RootLog;
1101 for (DWORD index = 0; index < root->ChildrenCount; index++)
1103 wLog* child = root->Children[index];
1116BOOL WLog_SetContext(wLog* log,
const char* (*fkt)(
void*),
void* context)
1121 log->context = context;