Coverage Report

Created: 2026-03-04 06:13

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