Coverage Report

Created: 2025-11-24 06:33

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/FreeRDP/winpr/libwinpr/utils/wlog/Layout.c
Line
Count
Source
1
/**
2
 * WinPR: Windows Portable Runtime
3
 * WinPR Logger
4
 *
5
 * Copyright 2013 Marc-Andre Moreau <marcandre.moreau@gmail.com>
6
 *
7
 * Licensed under the Apache License, Version 2.0 (the "License");
8
 * you may not use this file except in compliance with the License.
9
 * You may obtain a copy of the License at
10
 *
11
 *     http://www.apache.org/licenses/LICENSE-2.0
12
 *
13
 * Unless required by applicable law or agreed to in writing, software
14
 * distributed under the License is distributed on an "AS IS" BASIS,
15
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
 * See the License for the specific language governing permissions and
17
 * limitations under the License.
18
 */
19
20
#include <winpr/config.h>
21
22
#include <stdio.h>
23
#include <string.h>
24
#include <stdarg.h>
25
26
#include <winpr/crt.h>
27
#include <winpr/assert.h>
28
#include <winpr/print.h>
29
#include <winpr/sysinfo.h>
30
#include <winpr/environment.h>
31
32
#include "wlog.h"
33
34
#include "Layout.h"
35
36
#if defined __linux__ && !defined ANDROID
37
#include <unistd.h>
38
#include <sys/syscall.h>
39
#endif
40
41
#ifndef MIN
42
0
#define MIN(x, y) (((x) < (y)) ? (x) : (y))
43
#endif
44
45
struct format_option_recurse;
46
47
struct format_tid_arg
48
{
49
  char tid[32];
50
};
51
52
struct format_option
53
{
54
  const char* fmt;
55
  size_t fmtlen;
56
  const char* replace;
57
  size_t replacelen;
58
  const char* (*fkt)(void*);
59
  union
60
  {
61
    void* pv;
62
    const void* cpv;
63
    size_t s;
64
  } arg;
65
  const char* (*ext)(const struct format_option* opt, const char* str, size_t* preplacelen,
66
                     size_t* pskiplen);
67
  struct format_option_recurse* recurse;
68
};
69
70
struct format_option_recurse
71
{
72
  struct format_option* options;
73
  size_t nroptions;
74
  wLog* log;
75
  wLogLayout* layout;
76
  const wLogMessage* message;
77
  char buffer[WLOG_MAX_PREFIX_SIZE];
78
};
79
80
/**
81
 * Log Layout
82
 */
83
WINPR_ATTR_FORMAT_ARG(3, 0)
84
static void WLog_PrintMessagePrefixVA(char* prefix, size_t prefixlen,
85
                                      WINPR_FORMAT_ARG const char* format, va_list args)
86
0
{
87
0
  (void)vsnprintf(prefix, prefixlen, format, args);
88
0
}
89
90
WINPR_ATTR_FORMAT_ARG(3, 4)
91
static void WLog_PrintMessagePrefix(char* prefix, size_t prefixlen,
92
                                    WINPR_FORMAT_ARG const char* format, ...)
93
0
{
94
0
  va_list args;
95
0
  va_start(args, format);
96
0
  WLog_PrintMessagePrefixVA(prefix, prefixlen, format, args);
97
0
  va_end(args);
98
0
}
99
100
static const char* get_tid(void* arg)
101
0
{
102
0
  struct format_tid_arg* targ = arg;
103
0
  WINPR_ASSERT(targ);
104
105
0
  size_t tid = 0;
106
0
#if defined __linux__ && !defined ANDROID
107
  /* On Linux we prefer to see the LWP id */
108
0
  tid = (size_t)syscall(SYS_gettid);
109
#else
110
  tid = (size_t)GetCurrentThreadId();
111
#endif
112
0
  (void)_snprintf(targ->tid, sizeof(targ->tid), "%08" PRIxz, tid);
113
0
  return targ->tid;
114
0
}
115
116
static BOOL log_invalid_fmt(const char* what)
117
0
{
118
0
  (void)fprintf(stderr, "Invalid format string '%s'\n", what);
119
0
  return FALSE;
120
0
}
121
122
static BOOL check_and_log_format_size(char* format, size_t size, size_t index, size_t add)
123
0
{
124
  /* format string must be '\0' terminated, so abort at size - 1 */
125
0
  if (index + add + 1 >= size)
126
0
  {
127
0
    (void)fprintf(stderr,
128
0
                  "Format string too long ['%s', max %" PRIuz ", used %" PRIuz
129
0
                  ", adding %" PRIuz "]\n",
130
0
                  format, size, index, add);
131
0
    return FALSE;
132
0
  }
133
0
  return TRUE;
134
0
}
135
136
static int opt_compare_fn(const void* a, const void* b)
137
0
{
138
0
  const char* what = a;
139
0
  const struct format_option* opt = b;
140
0
  if (!opt)
141
0
    return -1;
142
0
  return strncmp(what, opt->fmt, opt->fmtlen);
143
0
}
144
145
static BOOL replace_format_string(const char* FormatString, struct format_option_recurse* recurse,
146
                                  char* format, size_t formatlen);
147
148
static const char* skip_if_null(const struct format_option* opt, const char* fmt,
149
                                size_t* preplacelen, size_t* pskiplen)
150
0
{
151
0
  WINPR_ASSERT(opt);
152
0
  WINPR_ASSERT(fmt);
153
0
  WINPR_ASSERT(preplacelen);
154
0
  WINPR_ASSERT(pskiplen);
155
156
0
  *preplacelen = 0;
157
0
  *pskiplen = 0;
158
159
0
  const char* str = &fmt[opt->fmtlen]; /* Skip first %{ from string */
160
0
  const char* end = strstr(str, opt->replace);
161
0
  if (!end)
162
0
    return NULL;
163
0
  *pskiplen = WINPR_ASSERTING_INT_CAST(size_t, end - fmt) + opt->replacelen;
164
165
0
  if (!opt->arg.cpv)
166
0
    return NULL;
167
168
0
  const size_t replacelen = WINPR_ASSERTING_INT_CAST(size_t, end - str);
169
170
0
  char buffer[WLOG_MAX_PREFIX_SIZE] = { 0 };
171
0
  memcpy(buffer, str, MIN(replacelen, ARRAYSIZE(buffer) - 1));
172
173
0
  if (!replace_format_string(buffer, opt->recurse, opt->recurse->buffer,
174
0
                             ARRAYSIZE(opt->recurse->buffer)))
175
0
    return NULL;
176
177
0
  *preplacelen = strnlen(opt->recurse->buffer, ARRAYSIZE(opt->recurse->buffer));
178
0
  return opt->recurse->buffer;
179
0
}
180
181
static BOOL replace_format_string(const char* FormatString, struct format_option_recurse* recurse,
182
                                  char* format, size_t formatlen)
183
0
{
184
0
  WINPR_ASSERT(FormatString);
185
0
  WINPR_ASSERT(recurse);
186
187
0
  size_t index = 0;
188
189
0
  while (*FormatString)
190
0
  {
191
0
    const struct format_option* opt =
192
0
        bsearch(FormatString, recurse->options, recurse->nroptions,
193
0
                sizeof(struct format_option), opt_compare_fn);
194
0
    if (opt)
195
0
    {
196
0
      size_t replacelen = opt->replacelen;
197
0
      size_t fmtlen = opt->fmtlen;
198
0
      const char* replace = opt->replace;
199
0
      const void* arg = opt->arg.cpv;
200
201
0
      if (opt->ext)
202
0
        replace = opt->ext(opt, FormatString, &replacelen, &fmtlen);
203
0
      if (opt->fkt)
204
0
        arg = opt->fkt(opt->arg.pv);
205
206
0
      if (replace && (replacelen > 0))
207
0
      {
208
0
        WINPR_PRAGMA_DIAG_PUSH
209
0
        WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
210
0
        const int rc = _snprintf(&format[index], formatlen - index, replace, arg);
211
0
        WINPR_PRAGMA_DIAG_POP
212
0
        if (rc < 0)
213
0
          return FALSE;
214
0
        if (!check_and_log_format_size(format, formatlen, index,
215
0
                                       WINPR_ASSERTING_INT_CAST(size_t, rc)))
216
0
          return FALSE;
217
0
        index += WINPR_ASSERTING_INT_CAST(size_t, rc);
218
0
      }
219
0
      FormatString += fmtlen;
220
0
    }
221
0
    else
222
0
    {
223
      /* Unknown format string */
224
0
      if (*FormatString == '%')
225
0
        return log_invalid_fmt(FormatString);
226
227
0
      if (!check_and_log_format_size(format, formatlen, index, 1))
228
0
        return FALSE;
229
0
      format[index++] = *FormatString++;
230
0
    }
231
0
  }
232
233
0
  if (!check_and_log_format_size(format, formatlen, index, 0))
234
0
    return FALSE;
235
0
  return TRUE;
236
0
}
237
238
BOOL WLog_Layout_GetMessagePrefix(wLog* log, wLogLayout* layout, const wLogMessage* message,
239
                                  char* prefix, size_t prefixlen)
240
0
{
241
0
  char format[WLOG_MAX_PREFIX_SIZE] = { 0 };
242
243
0
  WINPR_ASSERT(layout);
244
0
  WINPR_ASSERT(message);
245
0
  WINPR_ASSERT(prefix);
246
247
0
  struct format_tid_arg targ = { 0 };
248
249
0
  SYSTEMTIME localTime = { 0 };
250
0
  GetLocalTime(&localTime);
251
252
0
  struct format_option_recurse recurse = {
253
0
    .options = NULL, .nroptions = 0, .log = log, .layout = layout, .message = message
254
0
  };
255
256
0
#define ENTRY(x) x, sizeof(x) - 1
257
0
  struct format_option options[] = {
258
0
    { ENTRY("%ctx"),
259
0
      ENTRY("%s"),
260
0
      log->custom,
261
0
      { .pv = log->context },
262
0
      NULL,
263
0
      &recurse }, /* log context */
264
0
    { ENTRY("%dw"),
265
0
      ENTRY("%u"),
266
0
      NULL,
267
0
      { .s = localTime.wDayOfWeek },
268
0
      NULL,
269
0
      &recurse }, /* day of week */
270
0
    { ENTRY("%dy"), ENTRY("%u"), NULL, { .s = localTime.wDay }, NULL, &recurse }, /* day of year
271
                                                                                   */
272
0
    { ENTRY("%fl"), ENTRY("%s"), NULL, { .cpv = message->FileName }, NULL, &recurse }, /* file
273
                                                                                        */
274
0
    { ENTRY("%fn"),
275
0
      ENTRY("%s"),
276
0
      NULL,
277
0
      { .cpv = message->FunctionName },
278
0
      NULL,
279
0
      &recurse },                                                                    /* function
280
                                                                                      */
281
0
    { ENTRY("%hr"), ENTRY("%02u"), NULL, { .s = localTime.wHour }, NULL, &recurse }, /* hours */
282
0
    { ENTRY("%ln"),
283
0
      ENTRY("%" PRIuz),
284
0
      NULL,
285
0
      { .s = message->LineNumber },
286
0
      NULL,
287
0
      &recurse }, /* line number */
288
0
    { ENTRY("%lv"),
289
0
      ENTRY("%s"),
290
0
      NULL,
291
0
      { .cpv = WLOG_LEVELS[message->Level] },
292
0
      NULL,
293
0
      &recurse }, /* log level */
294
0
    { ENTRY("%mi"),
295
0
      ENTRY("%02u"),
296
0
      NULL,
297
0
      { .s = localTime.wMinute },
298
0
      NULL,
299
0
      &recurse }, /* minutes
300
                   */
301
0
    { ENTRY("%ml"),
302
0
      ENTRY("%03u"),
303
0
      NULL,
304
0
      { .s = localTime.wMilliseconds },
305
0
      NULL,
306
0
      &recurse }, /* milliseconds */
307
0
    { ENTRY("%mn"), ENTRY("%s"), NULL, { .cpv = log->Name }, NULL, &recurse }, /* module name */
308
0
    { ENTRY("%mo"), ENTRY("%u"), NULL, { .s = localTime.wMonth }, NULL, &recurse }, /* month */
309
0
    { ENTRY("%pid"),
310
0
      ENTRY("%u"),
311
0
      NULL,
312
0
      { .s = GetCurrentProcessId() },
313
0
      NULL,
314
0
      &recurse }, /* process id */
315
0
    { ENTRY("%se"),
316
0
      ENTRY("%02u"),
317
0
      NULL,
318
0
      { .s = localTime.wSecond },
319
0
      NULL,
320
0
      &recurse },                                                             /* seconds
321
                                                                               */
322
0
    { ENTRY("%tid"), ENTRY("%s"), get_tid, { .pv = &targ }, NULL, &recurse }, /* thread id */
323
0
    { ENTRY("%yr"), ENTRY("%u"), NULL, { .s = localTime.wYear }, NULL, &recurse }, /* year */
324
0
    { ENTRY("%{"),
325
0
      ENTRY("%}"),
326
0
      NULL,
327
0
      { .pv = log->context },
328
0
      skip_if_null,
329
0
      &recurse }, /* skip if no context */
330
0
  };
331
332
0
  recurse.options = options;
333
0
  recurse.nroptions = ARRAYSIZE(options);
334
335
0
  if (!replace_format_string(layout->FormatString, &recurse, format, ARRAYSIZE(format)))
336
0
    return FALSE;
337
338
0
  WINPR_PRAGMA_DIAG_PUSH
339
0
  WINPR_PRAGMA_DIAG_IGNORED_FORMAT_SECURITY
340
341
0
  WLog_PrintMessagePrefix(prefix, prefixlen, format);
342
343
0
  WINPR_PRAGMA_DIAG_POP
344
345
0
  return TRUE;
346
0
}
347
348
wLogLayout* WLog_GetLogLayout(wLog* log)
349
0
{
350
0
  wLogAppender* appender = NULL;
351
0
  appender = WLog_GetLogAppender(log);
352
0
  return appender->Layout;
353
0
}
354
355
BOOL WLog_Layout_SetPrefixFormat(WINPR_ATTR_UNUSED wLog* log, wLogLayout* layout,
356
                                 const char* format)
357
0
{
358
0
  free(layout->FormatString);
359
0
  layout->FormatString = NULL;
360
361
0
  if (format)
362
0
  {
363
0
    layout->FormatString = _strdup(format);
364
365
0
    if (!layout->FormatString)
366
0
      return FALSE;
367
0
  }
368
369
0
  return TRUE;
370
0
}
371
372
wLogLayout* WLog_Layout_New(WINPR_ATTR_UNUSED wLog* log)
373
0
{
374
0
  LPCSTR prefix = "WLOG_PREFIX";
375
0
  DWORD nSize = 0;
376
0
  char* env = NULL;
377
0
  wLogLayout* layout = NULL;
378
0
  layout = (wLogLayout*)calloc(1, sizeof(wLogLayout));
379
380
0
  if (!layout)
381
0
    return NULL;
382
383
0
  nSize = GetEnvironmentVariableA(prefix, NULL, 0);
384
385
0
  if (nSize)
386
0
  {
387
0
    env = (LPSTR)malloc(nSize);
388
389
0
    if (!env)
390
0
    {
391
0
      free(layout);
392
0
      return NULL;
393
0
    }
394
395
0
    if (GetEnvironmentVariableA(prefix, env, nSize) != nSize - 1)
396
0
    {
397
0
      free(env);
398
0
      free(layout);
399
0
      return NULL;
400
0
    }
401
0
  }
402
403
0
  if (env)
404
0
    layout->FormatString = env;
405
0
  else
406
0
  {
407
#ifdef ANDROID
408
    layout->FormatString = _strdup("[pid=%pid:tid=%tid] - [%fn]%{[%ctx]%}: ");
409
#else
410
0
    layout->FormatString =
411
0
        _strdup("[%hr:%mi:%se:%ml] [%pid:%tid] [%lv][%mn] - [%fn]%{[%ctx]%}: ");
412
0
#endif
413
414
0
    if (!layout->FormatString)
415
0
    {
416
0
      free(layout);
417
0
      return NULL;
418
0
    }
419
0
  }
420
421
0
  return layout;
422
0
}
423
424
void WLog_Layout_Free(WINPR_ATTR_UNUSED wLog* log, wLogLayout* layout)
425
0
{
426
0
  if (layout)
427
0
  {
428
0
    if (layout->FormatString)
429
0
    {
430
0
      free(layout->FormatString);
431
0
      layout->FormatString = NULL;
432
0
    }
433
434
0
    free(layout);
435
0
  }
436
0
}