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>
41#define WLOG_MAX_STRING_SIZE 16384
50#define WLOG_FILTER_NOT_FILTERED (-1)
51#define WLOG_FILTER_NOT_INITIALIZED (-2)
62LPCSTR WLOG_LEVELS[7] = {
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"FATAL",
"OFF" };
64static INIT_ONCE g_WLogInitialized = INIT_ONCE_STATIC_INIT;
65static DWORD g_FilterCount = 0;
66static wLogFilter* g_Filters = NULL;
67static wLog* g_RootLog = NULL;
69static wLog* WLog_New(LPCSTR name, wLog* rootLogger);
70static void WLog_Free(wLog* log);
71static LONG WLog_GetFilterLogLevel(wLog* log);
72static int WLog_ParseLogLevel(LPCSTR level);
73static BOOL WLog_ParseFilter(wLog* root, wLogFilter* filter, LPCSTR name);
74static BOOL WLog_ParseFilters(wLog* root);
75static wLog* WLog_Get_int(wLog* root, LPCSTR name);
78static void WLog_Uninit_(
void) __attribute__((destructor));
81static void WLog_Uninit_(
void)
84 wLog* root = g_RootLog;
89 for (DWORD index = 0; index < root->ChildrenCount; index++)
91 child = root->Children[index];
99static void WLog_Lock(wLog* log)
102 EnterCriticalSection(&log->lock);
105static void WLog_Unlock(wLog* log)
108 LeaveCriticalSection(&log->lock);
111static BOOL CALLBACK WLog_InitializeRoot(
PINIT_ONCE InitOnce, PVOID Parameter, PVOID* Context)
115 DWORD logAppenderType = 0;
116 LPCSTR appender =
"WLOG_APPENDER";
118 WINPR_UNUSED(InitOnce);
119 WINPR_UNUSED(Parameter);
120 WINPR_UNUSED(Context);
122 if (!(g_RootLog = WLog_New(
"", NULL)))
125 g_RootLog->IsRoot = TRUE;
126 logAppenderType = WLOG_APPENDER_CONSOLE;
127 nSize = GetEnvironmentVariableA(appender, NULL, 0);
131 env = (LPSTR)malloc(nSize);
136 if (GetEnvironmentVariableA(appender, env, nSize) != nSize - 1)
138 (void)fprintf(stderr,
"%s environment variable modified in my back", appender);
143 if (_stricmp(env,
"CONSOLE") == 0)
144 logAppenderType = WLOG_APPENDER_CONSOLE;
145 else if (_stricmp(env,
"FILE") == 0)
146 logAppenderType = WLOG_APPENDER_FILE;
147 else if (_stricmp(env,
"BINARY") == 0)
148 logAppenderType = WLOG_APPENDER_BINARY;
150#ifdef WINPR_HAVE_SYSLOG_H
151 else if (_stricmp(env,
"SYSLOG") == 0)
152 logAppenderType = WLOG_APPENDER_SYSLOG;
155#ifdef WINPR_HAVE_JOURNALD_H
156 else if (_stricmp(env,
"JOURNALD") == 0)
157 logAppenderType = WLOG_APPENDER_JOURNALD;
160 else if (_stricmp(env,
"UDP") == 0)
161 logAppenderType = WLOG_APPENDER_UDP;
166 if (!WLog_SetLogAppenderType(g_RootLog, logAppenderType))
169 if (!WLog_ParseFilters(g_RootLog))
172 (void)atexit(WLog_Uninit_);
180static BOOL log_recursion(LPCSTR file, LPCSTR fkt,
size_t line)
185 void* bt = winpr_backtrace(20);
187 LPCSTR tag = WINPR_TAG(
"utils.wlog");
193 msg = winpr_backtrace_symbols(bt, &used);
200 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"Recursion detected!!!") < 0)
203 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"Check %s [%s:%zu]", fkt, file, line) < 0)
206 for (
size_t i = 0; i < used; i++)
207 if (__android_log_print(ANDROID_LOG_FATAL, tag,
"%zu: %s", i, msg[i]) < 0)
212 if (fprintf(stderr,
"[%s]: Recursion detected!\n", fkt) < 0)
215 if (fprintf(stderr,
"[%s]: Check %s:%" PRIuz
"\n", fkt, file, line) < 0)
218 for (
size_t i = 0; i < used; i++)
219 if (fprintf(stderr,
"%s: %" PRIuz
": %s\n", fkt, i, msg[i]) < 0)
226 winpr_backtrace_free(bt);
230static BOOL WLog_Write(wLog* log,
const wLogMessage* message)
233 wLogAppender* appender = WLog_GetLogAppender(log);
238 if (!appender->active)
239 if (!WLog_OpenAppender(log))
242 EnterCriticalSection(&appender->lock);
244 if (appender->WriteMessage)
246 if (appender->recursive)
247 status = log_recursion(message->FileName, message->FunctionName, message->LineNumber);
250 appender->recursive = TRUE;
251 status = appender->WriteMessage(log, appender, message);
252 appender->recursive = FALSE;
256 LeaveCriticalSection(&appender->lock);
260static BOOL WLog_WriteData(wLog* log,
const wLogMessage* message)
263 wLogAppender* 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);
352static BOOL WLog_PrintTextMessageInternal(wLog* log,
const wLogMessage* cmessage, va_list args)
356 char formattedLogMessage[WLOG_MAX_STRING_SIZE] = { 0 };
358 message.TextString = formattedLogMessage;
360 WINPR_PRAGMA_DIAG_PUSH
361 WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
362 if (vsnprintf(formattedLogMessage, ARRAYSIZE(formattedLogMessage) - 1, cmessage->FormatString,
365 WINPR_PRAGMA_DIAG_POP
367 return WLog_Write(log, &message);
370BOOL WLog_PrintMessageVA(wLog* log, DWORD type, DWORD level,
size_t line,
const char* file,
371 const char* function, va_list args)
376 message.Level = level;
377 message.LineNumber = line;
378 message.FileName = file;
379 message.FunctionName = function;
383 case WLOG_MESSAGE_TEXT:
384 message.FormatString = va_arg(args,
const char*);
386 status = WLog_PrintTextMessageInternal(log, &message, args);
389 case WLOG_MESSAGE_DATA:
390 message.Data = va_arg(args,
void*);
391 message.Length = va_arg(args,
size_t);
392 status = WLog_WriteData(log, &message);
395 case WLOG_MESSAGE_IMAGE:
396 message.ImageData = va_arg(args,
void*);
397 message.ImageWidth = va_arg(args,
size_t);
398 message.ImageHeight = va_arg(args,
size_t);
399 message.ImageBpp = va_arg(args,
size_t);
400 status = WLog_WriteImage(log, &message);
403 case WLOG_MESSAGE_PACKET:
404 message.PacketData = va_arg(args,
void*);
405 message.PacketLength = va_arg(args,
size_t);
406 message.PacketFlags = va_arg(args,
unsigned);
407 status = WLog_WritePacket(log, &message);
417BOOL WLog_PrintTextMessageVA(wLog* log, DWORD level,
size_t line,
const char* file,
418 const char* function,
const char* fmt, va_list args)
421 message.Type = WLOG_MESSAGE_TEXT;
422 message.Level = level;
423 message.LineNumber = line;
424 message.FileName = file;
425 message.FunctionName = function;
427 message.FormatString = fmt;
429 return WLog_PrintTextMessageInternal(log, &message, args);
432BOOL WLog_PrintMessage(wLog* log, DWORD type, DWORD level,
size_t line,
const char* file,
433 const char* function, ...)
437 va_start(args, function);
438 status = WLog_PrintMessageVA(log, type, level, line, file, function, args);
443BOOL WLog_PrintTextMessage(wLog* log, DWORD level,
size_t line,
const char* file,
444 const char* function,
const char* fmt, ...)
449 status = WLog_PrintTextMessageVA(log, level, line, file, function, fmt, args);
454DWORD WLog_GetLogLevel(wLog* log)
459 if (log->FilterLevel <= WLOG_FILTER_NOT_INITIALIZED)
460 log->FilterLevel = WLog_GetFilterLogLevel(log);
462 if (log->FilterLevel > WLOG_FILTER_NOT_FILTERED)
463 return (DWORD)log->FilterLevel;
464 else if (log->Level == WLOG_LEVEL_INHERIT)
465 log->Level = WLog_GetLogLevel(log->Parent);
470BOOL WLog_IsLevelActive(wLog* _log, DWORD _log_level)
477 level = WLog_GetLogLevel(_log);
479 if (level == WLOG_OFF)
482 return _log_level >= level;
485BOOL WLog_SetStringLogLevel(wLog* log, LPCSTR level)
492 lvl = WLog_ParseLogLevel(level);
497 return WLog_SetLogLevel(log, (DWORD)lvl);
500static BOOL WLog_reset_log_filters(wLog* log)
505 log->FilterLevel = WLOG_FILTER_NOT_INITIALIZED;
507 for (DWORD x = 0; x < log->ChildrenCount; x++)
509 wLog* child = log->Children[x];
511 if (!WLog_reset_log_filters(child))
518static BOOL WLog_AddStringLogFilters_int(wLog* root, LPCSTR filter)
521 LPCSTR filterStr = NULL;
529 while ((cpp = strchr(cpp,
',')) != NULL)
535 DWORD pos = g_FilterCount;
536 DWORD size = g_FilterCount + count;
537 wLogFilter* tmp = (wLogFilter*)realloc(g_Filters, size *
sizeof(wLogFilter));
543 LPSTR cp = (LPSTR)_strdup(filter);
560 if (!WLog_ParseFilter(root, &g_Filters[pos++], filterStr))
576 g_FilterCount = size;
578 return WLog_reset_log_filters(root);
581BOOL WLog_AddStringLogFilters(LPCSTR filter)
584 wLog* root = WLog_GetRoot();
585 return WLog_AddStringLogFilters_int(root, filter);
588static BOOL WLog_UpdateInheritLevel(wLog* log, DWORD logLevel)
595 log->Level = logLevel;
597 for (DWORD x = 0; x < log->ChildrenCount; x++)
599 wLog* child = log->Children[x];
601 if (!WLog_UpdateInheritLevel(child, logLevel))
609BOOL WLog_SetLogLevel(wLog* log, DWORD logLevel)
614 if ((logLevel > WLOG_OFF) && (logLevel != WLOG_LEVEL_INHERIT))
617 log->Level = logLevel;
618 log->inherit = (logLevel == WLOG_LEVEL_INHERIT) ? TRUE : FALSE;
620 for (DWORD x = 0; x < log->ChildrenCount; x++)
622 wLog* child = log->Children[x];
624 if (!WLog_UpdateInheritLevel(child, logLevel))
628 return WLog_reset_log_filters(log);
631int WLog_ParseLogLevel(LPCSTR level)
638 if (_stricmp(level,
"TRACE") == 0)
640 else if (_stricmp(level,
"DEBUG") == 0)
642 else if (_stricmp(level,
"INFO") == 0)
644 else if (_stricmp(level,
"WARN") == 0)
646 else if (_stricmp(level,
"ERROR") == 0)
648 else if (_stricmp(level,
"FATAL") == 0)
650 else if (_stricmp(level,
"OFF") == 0)
656BOOL WLog_ParseFilter(wLog* root, wLogFilter* filter, LPCSTR name)
658 const char* pc = NULL;
675 while ((pc = strchr(pc,
'.')) != NULL)
682 names = _strdup(name);
687 filter->NameCount = count;
688 filter->Names = (LPSTR*)calloc((count + 1UL),
sizeof(LPSTR));
693 filter->NameCount = 0;
697 filter->Names[count] = NULL;
700 filter->Names[count++] = p;
706 free((
void*)filter->Names);
707 filter->Names = NULL;
708 filter->NameCount = 0;
714 iLevel = WLog_ParseLogLevel(q);
719 free((
void*)filter->Names);
720 filter->Names = NULL;
721 filter->NameCount = 0;
725 filter->Level = (DWORD)iLevel;
727 while ((p = strchr(p,
'.')) != NULL)
729 if (count < filter->NameCount)
730 filter->Names[count++] = p + 1;
739BOOL WLog_ParseFilters(wLog* root)
741 LPCSTR filter =
"WLOG_FILTER";
748 nSize = GetEnvironmentVariableA(filter, NULL, 0);
753 env = (LPSTR)malloc(nSize);
758 if (GetEnvironmentVariableA(filter, env, nSize) == nSize - 1)
759 res = WLog_AddStringLogFilters_int(root, env);
765LONG WLog_GetFilterLogLevel(wLog* log)
769 if (log->FilterLevel >= 0)
770 return log->FilterLevel;
772 log->FilterLevel = WLOG_FILTER_NOT_FILTERED;
773 for (DWORD i = 0; i < g_FilterCount; i++)
775 const wLogFilter* filter = &g_Filters[i];
776 for (DWORD j = 0; j < filter->NameCount; j++)
778 if (j >= log->NameCount)
781 if (_stricmp(filter->Names[j],
"*") == 0)
784 assert(filter->Level <= INT32_MAX);
785 log->FilterLevel = (LONG)filter->Level;
789 if (_stricmp(filter->Names[j], log->Names[j]) != 0)
792 if (j == (log->NameCount - 1))
794 match = log->NameCount == filter->NameCount;
797 assert(filter->Level <= INT32_MAX);
798 log->FilterLevel = (LONG)filter->Level;
808 return log->FilterLevel;
811static BOOL WLog_ParseName(wLog* log, LPCSTR name)
813 const char* cp = name;
818 while ((cp = strchr(cp,
'.')) != NULL)
824 names = _strdup(name);
829 log->NameCount = count;
830 log->Names = (LPSTR*)calloc((count + 1UL),
sizeof(LPSTR));
838 log->Names[count] = NULL;
841 log->Names[count++] = p;
843 while ((p = strchr(p,
'.')) != NULL)
845 if (count < log->NameCount)
846 log->Names[count++] = p + 1;
855wLog* WLog_New(LPCSTR name, wLog* rootLogger)
861 log = (wLog*)calloc(1,
sizeof(wLog));
866 log->Name = _strdup(name);
871 if (!WLog_ParseName(log, name))
874 log->Parent = rootLogger;
875 log->ChildrenCount = 0;
876 log->ChildrenSize = 16;
877 log->FilterLevel = WLOG_FILTER_NOT_INITIALIZED;
879 if (!(log->Children = (wLog**)calloc(log->ChildrenSize,
sizeof(wLog*))))
882 log->Appender = NULL;
886 log->Level = WLOG_LEVEL_INHERIT;
891 LPCSTR level =
"WLOG_LEVEL";
892 log->Level = WLOG_INFO;
893 nSize = GetEnvironmentVariableA(level, NULL, 0);
897 env = (LPSTR)malloc(nSize);
902 if (GetEnvironmentVariableA(level, env, nSize) != nSize - 1)
904 (void)fprintf(stderr,
"%s environment variable changed in my back !\n", level);
909 iLevel = WLog_ParseLogLevel(env);
914 if (!WLog_SetLogLevel(log, (DWORD)iLevel))
920 iLevel = WLog_GetFilterLogLevel(log);
924 if (!WLog_SetLogLevel(log, (DWORD)iLevel))
928 InitializeCriticalSectionAndSpinCount(&log->lock, 4000);
936void WLog_Free(wLog* log)
942 WLog_Appender_Free(log, log->Appender);
943 log->Appender = NULL;
951 free((
void*)log->Names);
952 free((
void*)log->Children);
953 DeleteCriticalSection(&log->lock);
958wLog* WLog_GetRoot(
void)
960 if (!InitOnceExecuteOnce(&g_WLogInitialized, WLog_InitializeRoot, NULL, NULL))
966static BOOL WLog_AddChild(wLog* parent, wLog* child)
972 if (parent->ChildrenCount >= parent->ChildrenSize)
975 parent->ChildrenSize *= 2;
977 if (!parent->ChildrenSize)
979 free((
void*)parent->Children);
980 parent->Children = NULL;
984 tmp = (wLog**)realloc((
void*)parent->Children,
sizeof(wLog*) * parent->ChildrenSize);
988 free((
void*)parent->Children);
989 parent->Children = NULL;
993 parent->Children = tmp;
997 if (!parent->Children)
1000 parent->Children[parent->ChildrenCount++] = child;
1001 child->Parent = parent;
1003 WLog_Unlock(parent);
1010static wLog* WLog_FindChild(wLog* root, LPCSTR name)
1020 for (DWORD index = 0; index < root->ChildrenCount; index++)
1022 child = root->Children[index];
1024 if (strcmp(child->Name, name) == 0)
1033 return (found) ? child : NULL;
1036static wLog* WLog_Get_int(wLog* root, LPCSTR name)
1040 if (!(log = WLog_FindChild(root, name)))
1045 if (!(log = WLog_New(name, root)))
1048 if (!WLog_AddChild(root, log))
1058wLog* WLog_Get(LPCSTR name)
1060 wLog* root = WLog_GetRoot();
1061 return WLog_Get_int(root, name);
1064#if defined(WITH_WINPR_DEPRECATED)
1067 return WLog_GetRoot() != NULL;
1070BOOL WLog_Uninit(
void)
1072 wLog* root = g_RootLog;
1079 for (DWORD index = 0; index < root->ChildrenCount; index++)
1081 wLog* child = root->Children[index];
1094BOOL WLog_SetContext(wLog* log,
const char* (*fkt)(
void*),
void* context)
1099 log->context = context;