Coverage Report

Created: 2026-05-11 06:55

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
5.76k
{
87
5.76k
  (void)vsnprintf(prefix, prefixlen, format, args);
88
5.76k
}
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
5.76k
{
94
5.76k
  va_list args = WINPR_C_ARRAY_INIT;
95
5.76k
  va_start(args, format);
96
5.76k
  WLog_PrintMessagePrefixVA(prefix, prefixlen, format, args);
97
5.76k
  va_end(args);
98
5.76k
}
99
100
static const char* get_tid(void* arg)
101
5.76k
{
102
5.76k
  struct format_tid_arg* targ = arg;
103
5.76k
  WINPR_ASSERT(targ);
104
105
5.76k
  size_t tid = 0;
106
5.76k
#if defined __linux__ && !defined ANDROID
107
  /* On Linux we prefer to see the LWP id */
108
5.76k
  tid = (size_t)syscall(SYS_gettid);
109
#else
110
  tid = (size_t)GetCurrentThreadId();
111
#endif
112
5.76k
  (void)_snprintf(targ->tid, sizeof(targ->tid), "%08" PRIxz, tid);
113
5.76k
  return targ->tid;
114
5.76k
}
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
178k
{
124
  /* format string must be '\0' terminated, so abort at size - 1 */
125
178k
  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
178k
  return TRUE;
134
178k
}
135
136
static int opt_compare_fn(const void* a, const void* b)
137
708k
{
138
708k
  const char* what = a;
139
708k
  const struct format_option* opt = b;
140
708k
  if (!opt)
141
0
    return -1;
142
708k
  return strncmp(what, opt->fmt, opt->fmtlen);
143
708k
}
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
5.76k
{
151
5.76k
  WINPR_ASSERT(opt);
152
5.76k
  WINPR_ASSERT(fmt);
153
5.76k
  WINPR_ASSERT(preplacelen);
154
5.76k
  WINPR_ASSERT(pskiplen);
155
156
5.76k
  *preplacelen = 0;
157
5.76k
  *pskiplen = 0;
158
159
5.76k
  const char* str = &fmt[opt->fmtlen]; /* Skip first %{ from string */
160
5.76k
  const char* end = strstr(str, opt->replace);
161
5.76k
  if (!end)
162
0
    return nullptr;
163
5.76k
  *pskiplen = WINPR_ASSERTING_INT_CAST(size_t, end - fmt) + opt->replacelen;
164
165
5.76k
  if (!opt->arg.cpv)
166
5.76k
    return nullptr;
167
168
0
  const size_t replacelen = WINPR_ASSERTING_INT_CAST(size_t, end - str);
169
170
0
  char buffer[WLOG_MAX_PREFIX_SIZE] = WINPR_C_ARRAY_INIT;
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 nullptr;
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
5.76k
{
184
5.76k
  WINPR_ASSERT(FormatString);
185
5.76k
  WINPR_ASSERT(recurse);
186
187
5.76k
  size_t index = 0;
188
5.76k
  const char* prefix = WLog_GetGlobalPrefix();
189
5.76k
  if (prefix)
190
0
  {
191
0
    const int res = _snprintf(format, formatlen, "{%s}", prefix);
192
0
    if (res < 0)
193
0
      return FALSE;
194
0
    index = (size_t)res;
195
0
  }
196
197
184k
  while (*FormatString)
198
178k
  {
199
178k
    const struct format_option* opt =
200
178k
        bsearch(FormatString, recurse->options, recurse->nroptions,
201
178k
                sizeof(struct format_option), opt_compare_fn);
202
178k
    if (opt)
203
57.6k
    {
204
57.6k
      size_t replacelen = opt->replacelen;
205
57.6k
      size_t fmtlen = opt->fmtlen;
206
57.6k
      const char* replace = opt->replace;
207
57.6k
      const void* arg = opt->arg.cpv;
208
209
57.6k
      if (opt->ext)
210
5.76k
        replace = opt->ext(opt, FormatString, &replacelen, &fmtlen);
211
57.6k
      if (opt->fkt)
212
5.76k
        arg = opt->fkt(opt->arg.pv);
213
214
57.6k
      if (replace && (replacelen > 0))
215
51.8k
      {
216
51.8k
        WINPR_PRAGMA_DIAG_PUSH
217
51.8k
        WINPR_PRAGMA_DIAG_IGNORED_FORMAT_NONLITERAL
218
51.8k
        const int rc = _snprintf(&format[index], formatlen - index, replace, arg);
219
51.8k
        WINPR_PRAGMA_DIAG_POP
220
51.8k
        if (rc < 0)
221
0
          return FALSE;
222
51.8k
        if (!check_and_log_format_size(format, formatlen, index,
223
51.8k
                                       WINPR_ASSERTING_INT_CAST(size_t, rc)))
224
0
          return FALSE;
225
51.8k
        index += WINPR_ASSERTING_INT_CAST(size_t, rc);
226
51.8k
      }
227
57.6k
      FormatString += fmtlen;
228
57.6k
    }
229
120k
    else
230
120k
    {
231
      /* Unknown format string */
232
120k
      if (*FormatString == '%')
233
0
        return log_invalid_fmt(FormatString);
234
235
120k
      if (!check_and_log_format_size(format, formatlen, index, 1))
236
0
        return FALSE;
237
120k
      format[index++] = *FormatString++;
238
120k
    }
239
178k
  }
240
241
5.76k
  return check_and_log_format_size(format, formatlen, index, 0);
242
5.76k
}
243
244
BOOL WLog_Layout_GetMessagePrefix(wLog* log, wLogLayout* layout, const wLogMessage* message,
245
                                  char* prefix, size_t prefixlen)
246
5.76k
{
247
5.76k
  char format[WLOG_MAX_PREFIX_SIZE] = WINPR_C_ARRAY_INIT;
248
249
5.76k
  WINPR_ASSERT(layout);
250
5.76k
  WINPR_ASSERT(message);
251
5.76k
  WINPR_ASSERT(prefix);
252
253
5.76k
  struct format_tid_arg targ = WINPR_C_ARRAY_INIT;
254
255
5.76k
  SYSTEMTIME localTime = WINPR_C_ARRAY_INIT;
256
5.76k
  GetLocalTime(&localTime);
257
258
5.76k
  struct format_option_recurse recurse = {
259
5.76k
    .options = nullptr, .nroptions = 0, .log = log, .layout = layout, .message = message
260
5.76k
  };
261
262
195k
#define ENTRY(x) x, sizeof(x) - 1
263
5.76k
  struct format_option options[] = {
264
5.76k
    { ENTRY("%ctx"),
265
5.76k
      ENTRY("%s"),
266
5.76k
      log->custom,
267
5.76k
      { .pv = log->context },
268
5.76k
      nullptr,
269
5.76k
      &recurse }, /* log context */
270
5.76k
    { ENTRY("%dw"),
271
5.76k
      ENTRY("%u"),
272
5.76k
      nullptr,
273
5.76k
      { .s = localTime.wDayOfWeek },
274
5.76k
      nullptr,
275
5.76k
      &recurse }, /* day of week */
276
5.76k
    { ENTRY("%dy"),
277
5.76k
      ENTRY("%u"),
278
5.76k
      nullptr,
279
5.76k
      { .s = localTime.wDay },
280
5.76k
      nullptr,
281
5.76k
      &recurse }, /* day of year
282
                   */
283
5.76k
    { ENTRY("%fl"),
284
5.76k
      ENTRY("%s"),
285
5.76k
      nullptr,
286
5.76k
      { .cpv = message->FileName },
287
5.76k
      nullptr,
288
5.76k
      &recurse }, /* file
289
                   */
290
5.76k
    { ENTRY("%fn"),
291
5.76k
      ENTRY("%s"),
292
5.76k
      nullptr,
293
5.76k
      { .cpv = message->FunctionName },
294
5.76k
      nullptr,
295
5.76k
      &recurse }, /* function
296
                   */
297
5.76k
    { ENTRY("%hr"),
298
5.76k
      ENTRY("%02u"),
299
5.76k
      nullptr,
300
5.76k
      { .s = localTime.wHour },
301
5.76k
      nullptr,
302
5.76k
      &recurse }, /* hours
303
                   */
304
5.76k
    { ENTRY("%ln"),
305
5.76k
      ENTRY("%" PRIuz),
306
5.76k
      nullptr,
307
5.76k
      { .s = message->LineNumber },
308
5.76k
      nullptr,
309
5.76k
      &recurse }, /* line number */
310
5.76k
    { ENTRY("%lv"),
311
5.76k
      ENTRY("%s"),
312
5.76k
      nullptr,
313
5.76k
      { .cpv = WLOG_LEVELS[message->Level] },
314
5.76k
      nullptr,
315
5.76k
      &recurse }, /* log level */
316
5.76k
    { ENTRY("%mi"),
317
5.76k
      ENTRY("%02u"),
318
5.76k
      nullptr,
319
5.76k
      { .s = localTime.wMinute },
320
5.76k
      nullptr,
321
5.76k
      &recurse }, /* minutes
322
                   */
323
5.76k
    { ENTRY("%ml"),
324
5.76k
      ENTRY("%03u"),
325
5.76k
      nullptr,
326
5.76k
      { .s = localTime.wMilliseconds },
327
5.76k
      nullptr,
328
5.76k
      &recurse }, /* milliseconds */
329
5.76k
    { ENTRY("%mn"), ENTRY("%s"), nullptr, { .cpv = log->Name }, nullptr, &recurse }, /* module
330
                                                                                        name */
331
5.76k
    { ENTRY("%mo"),
332
5.76k
      ENTRY("%u"),
333
5.76k
      nullptr,
334
5.76k
      { .s = localTime.wMonth },
335
5.76k
      nullptr,
336
5.76k
      &recurse }, /* month
337
                   */
338
5.76k
    { ENTRY("%pid"),
339
5.76k
      ENTRY("%u"),
340
5.76k
      nullptr,
341
5.76k
      { .s = GetCurrentProcessId() },
342
5.76k
      nullptr,
343
5.76k
      &recurse }, /* process id */
344
5.76k
    { ENTRY("%se"),
345
5.76k
      ENTRY("%02u"),
346
5.76k
      nullptr,
347
5.76k
      { .s = localTime.wSecond },
348
5.76k
      nullptr,
349
5.76k
      &recurse },                                                                /* seconds
350
                                                                                  */
351
5.76k
    { ENTRY("%tid"), ENTRY("%s"), get_tid, { .pv = &targ }, nullptr, &recurse }, /* thread id */
352
5.76k
    { ENTRY("%yr"), ENTRY("%u"), nullptr, { .s = localTime.wYear }, nullptr, &recurse }, /* year
353
                                                                                          */
354
5.76k
    { ENTRY("%{"),
355
5.76k
      ENTRY("%}"),
356
5.76k
      nullptr,
357
5.76k
      { .pv = log->context },
358
5.76k
      skip_if_null,
359
5.76k
      &recurse }, /* skip if no context */
360
5.76k
  };
361
362
5.76k
  recurse.options = options;
363
5.76k
  recurse.nroptions = ARRAYSIZE(options);
364
365
5.76k
  if (!replace_format_string(layout->FormatString, &recurse, format, ARRAYSIZE(format)))
366
0
    return FALSE;
367
368
5.76k
  WINPR_PRAGMA_DIAG_PUSH
369
5.76k
  WINPR_PRAGMA_DIAG_IGNORED_FORMAT_SECURITY
370
371
5.76k
  WLog_PrintMessagePrefix(prefix, prefixlen, format);
372
373
5.76k
  WINPR_PRAGMA_DIAG_POP
374
375
5.76k
  return TRUE;
376
5.76k
}
377
378
wLogLayout* WLog_GetLogLayout(wLog* log)
379
0
{
380
0
  wLogAppender* appender = nullptr;
381
0
  appender = WLog_GetLogAppender(log);
382
0
  return appender->Layout;
383
0
}
384
385
BOOL WLog_Layout_SetPrefixFormat(WINPR_ATTR_UNUSED wLog* log, wLogLayout* layout,
386
                                 const char* format)
387
0
{
388
0
  free(layout->FormatString);
389
0
  layout->FormatString = nullptr;
390
391
0
  if (format)
392
0
  {
393
0
    layout->FormatString = _strdup(format);
394
395
0
    if (!layout->FormatString)
396
0
      return FALSE;
397
0
  }
398
399
0
  return TRUE;
400
0
}
401
402
wLogLayout* WLog_Layout_New(WINPR_ATTR_UNUSED wLog* log)
403
1
{
404
1
  LPCSTR prefix = "WLOG_PREFIX";
405
1
  DWORD nSize = 0;
406
1
  char* env = nullptr;
407
1
  wLogLayout* layout = nullptr;
408
1
  layout = (wLogLayout*)calloc(1, sizeof(wLogLayout));
409
410
1
  if (!layout)
411
0
    return nullptr;
412
413
1
  nSize = GetEnvironmentVariableA(prefix, nullptr, 0);
414
415
1
  if (nSize)
416
0
  {
417
0
    env = (LPSTR)malloc(nSize);
418
419
0
    if (!env)
420
0
    {
421
0
      free(layout);
422
0
      return nullptr;
423
0
    }
424
425
0
    if (GetEnvironmentVariableA(prefix, env, nSize) != nSize - 1)
426
0
    {
427
0
      free(env);
428
0
      free(layout);
429
0
      return nullptr;
430
0
    }
431
0
  }
432
433
1
  if (env)
434
0
    layout->FormatString = env;
435
1
  else
436
1
  {
437
#ifdef ANDROID
438
    layout->FormatString = _strdup("[pid=%pid:tid=%tid] - [%fn]%{[%ctx]%}: ");
439
#else
440
1
    layout->FormatString =
441
1
        _strdup("[%hr:%mi:%se:%ml] [%pid:%tid] [%lv][%mn] - [%fn]%{[%ctx]%}: ");
442
1
#endif
443
444
1
    if (!layout->FormatString)
445
0
    {
446
0
      free(layout);
447
0
      return nullptr;
448
0
    }
449
1
  }
450
451
1
  return layout;
452
1
}
453
454
void WLog_Layout_Free(WINPR_ATTR_UNUSED wLog* log, wLogLayout* layout)
455
1
{
456
1
  if (layout)
457
1
  {
458
1
    if (layout->FormatString)
459
1
    {
460
1
      free(layout->FormatString);
461
1
      layout->FormatString = nullptr;
462
1
    }
463
464
1
    free(layout);
465
1
  }
466
1
}