Coverage Report

Created: 2025-12-02 06:09

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