Coverage Report

Created: 2025-07-11 06:34

/src/libwebsockets/lib/core/logs.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * libwebsockets - small server side websockets and web server implementation
3
 *
4
 * Copyright (C) 2010 - 2021 Andy Green <andy@warmcat.com>
5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a copy
7
 * of this software and associated documentation files (the "Software"), to
8
 * deal in the Software without restriction, including without limitation the
9
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10
 * sell copies of the Software, and to permit persons to whom the Software is
11
 * furnished to do so, subject to the following conditions:
12
 *
13
 * The above copyright notice and this permission notice shall be included in
14
 * all copies or substantial portions of the Software.
15
 *
16
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22
 * IN THE SOFTWARE.
23
 */
24
25
#include "private-lib-core.h"
26
27
#ifdef LWS_HAVE_SYS_TYPES_H
28
#include <sys/types.h>
29
#endif
30
31
#if defined(LWS_PLAT_OPTEE)
32
void lwsl_emit_optee(int level, const char *line);
33
#endif
34
35
lws_log_cx_t log_cx = {
36
#if !defined(LWS_PLAT_OPTEE)
37
  .u.emit       = lwsl_emit_stderr,
38
#else
39
  .u.emit       = lwsl_emit_optee,
40
#endif
41
  .lll_flags      = LLL_ERR | LLL_WARN | LLL_NOTICE,
42
};
43
44
#if !defined(LWS_PLAT_OPTEE) && !defined(LWS_WITH_NO_LOGS)
45
static const char * log_level_names ="EWNIDPHXCLUT??";
46
#endif
47
48
/*
49
 * Name an instance tag and attach to a group
50
 */
51
52
void
53
__lws_lc_tag(struct lws_context *context, lws_lifecycle_group_t *grp,
54
       lws_lifecycle_t *lc, const char *format, ...)
55
0
{
56
0
  va_list ap;
57
0
  int n = 1;
58
59
0
  if (*lc->gutag == '[') {
60
    /* appending inside [] */
61
62
0
    char *cp = strchr(lc->gutag, ']');
63
0
    char rend[96];
64
0
    size_t ll, k;
65
0
    int n;
66
67
0
    if (!cp)
68
0
      return;
69
70
    /* length of closing brace and anything else after it */
71
0
    k = strlen(cp);
72
73
    /* compute the remaining gutag unused */
74
0
    ll = sizeof(lc->gutag) - lws_ptr_diff_size_t(cp, lc->gutag) - k - 1;
75
0
    if (ll > sizeof(rend) - 1)
76
0
      ll = sizeof(rend) - 1;
77
0
    va_start(ap, format);
78
0
    n = vsnprintf(rend, ll, format, ap);
79
0
    va_end(ap);
80
81
0
    if ((unsigned int)n > ll)
82
0
      n = (int)ll;
83
84
    /* shove the trailer up by what we added */
85
0
    memmove(cp + n, cp, k);
86
0
    assert(k + (unsigned int)n < sizeof(lc->gutag));
87
0
    cp[k + (unsigned int)n] = '\0';
88
    /* copy what we added into place */
89
0
    memcpy(cp, rend, (unsigned int)n);
90
91
0
    return;
92
0
  }
93
94
0
  assert(grp);
95
0
  assert(grp->tag_prefix); /* lc group must have a tag prefix string */
96
97
0
  lc->gutag[0] = '[';
98
99
#if defined(LWS_WITH_SECURE_STREAMS_PROXY_API) /* ie, will have getpid if set */
100
  n += lws_snprintf(&lc->gutag[n], sizeof(lc->gutag) -
101
           (unsigned int)n - 1u, "%u|", getpid());
102
#endif
103
0
  n += lws_snprintf(&lc->gutag[n], sizeof(lc->gutag) -
104
0
           (unsigned int)n - 1u, "%s|%lx|",
105
0
           grp->tag_prefix,
106
0
           (unsigned long)grp->ordinal++);
107
108
0
  va_start(ap, format);
109
0
  n += vsnprintf(&lc->gutag[n], sizeof(lc->gutag) - (unsigned int)n -
110
0
      1u, format, ap);
111
0
  va_end(ap);
112
113
0
  if (n < (int)sizeof(lc->gutag) - 2) {
114
0
    lc->gutag[n++] = ']';
115
0
    lc->gutag[n++] = '\0';
116
0
  } else {
117
0
    lc->gutag[sizeof(lc->gutag) - 2] = ']';
118
0
    lc->gutag[sizeof(lc->gutag) - 1] = '\0';
119
0
  }
120
121
0
  lc->us_creation = (uint64_t)lws_now_usecs();
122
0
  lws_dll2_add_tail(&lc->list, &grp->owner);
123
124
0
  lwsl_refcount_cx(lc->log_cx, 1);
125
126
0
#if defined(LWS_LOG_TAG_LIFECYCLE)
127
0
  lwsl_cx_info(context, " ++ %s (%d)", lc->gutag, (int)grp->owner.count);
128
0
#endif
129
0
}
130
131
/*
132
 * Normally we want to set the tag one time at creation.  But sometimes we
133
 * don't have enough information at that point to give it a meaningful tag, eg,
134
 * it's an accepted, served connection but we haven't read data from it yet
135
 * to find out what it wants to be.
136
 *
137
 * This allows you to append some extra info to the tag in those cases, the
138
 * initial tag remains the same on the lhs so it can be tracked correctly.
139
 */
140
141
void
142
__lws_lc_tag_append(lws_lifecycle_t *lc, const char *app)
143
0
{
144
0
  int n = (int)strlen(lc->gutag);
145
146
0
  if (n && lc->gutag[n - 1] == ']')
147
0
    n--;
148
149
0
  n += lws_snprintf(&lc->gutag[n], sizeof(lc->gutag) - 2u -
150
0
           (unsigned int)n, "|%s]", app);
151
152
0
  if ((unsigned int)n >= sizeof(lc->gutag) - 2u) {
153
0
    lc->gutag[sizeof(lc->gutag) - 2] = ']';
154
0
    lc->gutag[sizeof(lc->gutag) - 1] = '\0';
155
0
  }
156
0
}
157
158
/*
159
 * Remove instance from group
160
 */
161
162
void
163
__lws_lc_untag(struct lws_context *context, lws_lifecycle_t *lc)
164
0
{
165
  //lws_lifecycle_group_t *grp;
166
0
  char buf[24];
167
168
0
  if (!lc->gutag[0]) { /* we never tagged this object... */
169
0
    lwsl_cx_err(context, "%s never tagged", lc->gutag);
170
0
    assert(0);
171
0
    return;
172
0
  }
173
174
0
  if (!lc->list.owner) { /* we already untagged this object... */
175
0
    lwsl_cx_err(context, "%s untagged twice", lc->gutag);
176
0
    assert(0);
177
0
    return;
178
0
  }
179
180
  //grp = lws_container_of(lc->list.owner, lws_lifecycle_group_t, owner);
181
182
0
#if defined(LWS_LOG_TAG_LIFECYCLE)
183
0
  if (lws_humanize(buf, sizeof(buf),
184
0
         (uint64_t)lws_now_usecs() - lc->us_creation,
185
0
         humanize_schema_us) > 0)
186
187
0
  lwsl_cx_info(context, " -- %s (%d) %s", lc->gutag,
188
0
        (int)lc->list.owner->count - 1, buf);
189
0
#endif
190
191
0
  lws_dll2_remove(&lc->list);
192
193
0
  lwsl_refcount_cx(lc->log_cx, -1);
194
0
}
195
196
const char *
197
lws_lc_tag(lws_lifecycle_t *lc)
198
0
{
199
0
  return lc->gutag;
200
0
}
201
202
203
int
204
lwsl_timestamp(int level, char *p, size_t len)
205
47
{
206
47
#if !defined(LWS_PLAT_OPTEE) && !defined(LWS_WITH_NO_LOGS)
207
47
  time_t o_now;
208
47
  unsigned long long now;
209
47
  struct timeval tv;
210
47
  struct tm *ptm = NULL;
211
47
#if defined(LWS_HAVE_LOCALTIME_R)
212
47
  struct tm tm;
213
47
#endif
214
47
  int n;
215
216
47
  gettimeofday(&tv, NULL);
217
47
  o_now = tv.tv_sec;
218
47
  now = ((unsigned long long)tv.tv_sec * 10000) +
219
47
        (unsigned int)(tv.tv_usec / 100);
220
221
47
#if defined(LWS_HAVE_LOCALTIME_R)
222
47
  ptm = localtime_r(&o_now, &tm);
223
#else
224
  ptm = localtime(&o_now);
225
#endif
226
47
  p[0] = '\0';
227
47
  for (n = 0; n < LLL_COUNT; n++) {
228
47
    if (level != (1 << n))
229
0
      continue;
230
231
47
    if (ptm)
232
47
      n = lws_snprintf(p, len,
233
47
        "[%04d/%02d/%02d %02d:%02d:%02d:%04d] %c: ",
234
47
        ptm->tm_year + 1900,
235
47
        ptm->tm_mon + 1,
236
47
        ptm->tm_mday,
237
47
        ptm->tm_hour,
238
47
        ptm->tm_min,
239
47
        ptm->tm_sec,
240
47
        (int)(now % 10000), log_level_names[n]);
241
0
    else
242
0
      n = lws_snprintf(p, len, "[%llu:%04d] %c: ",
243
0
          (unsigned long long) now / 10000,
244
0
          (int)(now % 10000), log_level_names[n]);
245
246
#if defined(LWS_PLAT_FREERTOS)
247
    n += lws_snprintf(p + n, len - n, "%6u: ",
248
#if defined(LWS_AMAZON_RTOS)
249
          (unsigned int)xPortGetFreeHeapSize());
250
#else
251
          (unsigned int)esp_get_free_heap_size());
252
#endif
253
#endif
254
255
47
    return n;
256
47
  }
257
#else
258
  p[0] = '\0';
259
#endif
260
261
0
  return 0;
262
47
}
263
264
#ifndef LWS_PLAT_OPTEE
265
static const char * const colours[] = {
266
  "[31;1m", /* LLL_ERR */
267
  "[36;1m", /* LLL_WARN */
268
  "[35;1m", /* LLL_NOTICE */
269
  "[32;1m", /* LLL_INFO */
270
  "[34;1m", /* LLL_DEBUG */
271
  "[33;1m", /* LLL_PARSER */
272
  "[33m", /* LLL_HEADER */
273
  "[33m", /* LLL_EXT */
274
  "[33m", /* LLL_CLIENT */
275
  "[33;1m", /* LLL_LATENCY */
276
        "[0;1m", /* LLL_USER */
277
  "[31m", /* LLL_THREAD */
278
};
279
280
static char tty;
281
282
static void
283
_lwsl_emit_stderr(int level, const char *line)
284
47
{
285
47
  int n, m = LWS_ARRAY_SIZE(colours) - 1;
286
287
47
  if (!tty)
288
1
    tty = (char)(isatty(2) | 2);
289
290
47
  if (tty == 3) {
291
0
    n = 1 << (LWS_ARRAY_SIZE(colours) - 1);
292
0
    while (n) {
293
0
      if (level & n)
294
0
        break;
295
0
      m--;
296
0
      n >>= 1;
297
0
    }
298
0
    fprintf(stderr, "%c%s%s%c[0m", 27, colours[m], line, 27);
299
0
  } else
300
47
    fprintf(stderr, "%s", line);
301
47
}
302
303
void
304
lwsl_emit_stderr(int level, const char *line)
305
47
{
306
47
  _lwsl_emit_stderr(level, line);
307
47
}
308
309
void
310
lwsl_emit_stderr_notimestamp(int level, const char *line)
311
0
{
312
0
  _lwsl_emit_stderr(level, line);
313
0
}
314
315
#if !defined(LWS_PLAT_FREERTOS) && !defined(LWS_PLAT_OPTEE) && !defined(LWS_PLAT_BAREMETAL)
316
317
/*
318
 * Helper to emit to a file
319
 */
320
321
void
322
lws_log_emit_cx_file(struct lws_log_cx *cx, int level, const char *line,
323
      size_t len)
324
0
{
325
0
  int fd = (int)(intptr_t)cx->stg;
326
327
0
  if (fd >= 0)
328
0
    if (write(fd, line, (unsigned int)len) != (ssize_t)len)
329
0
      fprintf(stderr, "Unable to write log to file\n");
330
0
}
331
332
/*
333
 * Helper to use a .refcount_cb to store logs in a file
334
 */
335
336
void
337
lws_log_use_cx_file(struct lws_log_cx *cx, int _new)
338
0
{
339
0
  int fd;
340
341
0
  if (_new > 0 && cx->refcount == 1) {
342
0
    fd = open((const char *)cx->opaque,
343
0
        LWS_O_CREAT | LWS_O_TRUNC | LWS_O_WRONLY, 0600);
344
0
    if (fd < 0)
345
0
      fprintf(stderr, "Unable to open log %s: errno %d\n",
346
0
        (const char *)cx->opaque, errno);
347
0
    cx->stg = (void *)(intptr_t)fd;
348
349
0
    return;
350
0
  }
351
352
0
  fd = (int)(intptr_t)cx->stg;
353
354
0
  if (_new <= 0 && cx->refcount == 0 && fd >= 0) {
355
0
    close(fd);
356
0
    cx->stg = (void *)(intptr_t)-1;
357
0
  }
358
0
}
359
360
#endif
361
362
#endif
363
364
#if !(defined(LWS_PLAT_OPTEE) && !defined(LWS_WITH_NETWORK))
365
void
366
__lws_logv(lws_log_cx_t *cx, lws_log_prepend_cx_t prep, void *obj,
367
     int filter, const char *_fun, const char *format, va_list vl)
368
11.1k
{
369
11.1k
#if LWS_MAX_SMP == 1 && !defined(LWS_WITH_THREADPOOL)
370
  /* this is incompatible with multithreaded logging */
371
11.1k
  static char buf[256];
372
#else
373
  char buf[1024];
374
#endif
375
11.1k
  char *p = buf, *end = p + sizeof(buf) - 1;
376
11.1k
  lws_log_cx_t *cxp;
377
11.1k
  int n, back = 0;
378
379
  /*
380
   * We need to handle NULL wsi etc at the wrappers as gracefully as
381
   * possible
382
   */
383
384
11.1k
  if (!cx) {
385
0
    lws_strncpy(p, "NULL log cx: ", sizeof(buf) - 1);
386
0
    p += 13;
387
    /* use the processwide one for lack of anything better */
388
0
    cx = &log_cx;
389
0
  }
390
391
11.1k
  cxp = cx;
392
393
11.1k
  if (!(cx->lll_flags & (uint32_t)filter))
394
    /*
395
     * logs may be produced and built in to the code but disabled
396
     * at runtime
397
     */
398
11.0k
    return;
399
400
#if !defined(LWS_LOGS_TIMESTAMP)
401
  if (cx->lll_flags & LLLF_LOG_TIMESTAMP)
402
#endif
403
47
  {
404
47
    buf[0] = '\0';
405
47
    lwsl_timestamp(filter, buf, sizeof(buf));
406
47
    p += strlen(buf);
407
47
  }
408
409
  /*
410
   * prepend parent log ctx content first
411
   * top level cx also gets an opportunity to prepend
412
   */
413
414
47
  while (cxp->parent) {
415
0
    cxp = cxp->parent;
416
0
    back++;
417
0
  }
418
419
47
  do {
420
47
    int b = back;
421
422
47
    cxp = cx;
423
47
    while (b--)
424
0
      cxp = cxp->parent;
425
47
    if (cxp->prepend)
426
0
      cxp->prepend(cxp, NULL, &p, end);
427
428
47
    back--;
429
47
  } while (back > 0);
430
431
47
  if (prep)
432
0
    prep(cxp, obj, &p, end);
433
434
47
  if (_fun)
435
0
    p += lws_snprintf(p, lws_ptr_diff_size_t(end, p), "%s: ", _fun);
436
437
  /*
438
   * The actual log content
439
   */
440
441
47
  n = vsnprintf(p, lws_ptr_diff_size_t(end, p), format, vl);
442
443
  /* vnsprintf returns what it would have written, even if truncated */
444
47
  if (p + n > end - 2) {
445
0
    p = end - 5;
446
0
    *p++ = '.';
447
0
    *p++ = '.';
448
0
    *p++ = '.';
449
0
    *p++ = '\n';
450
0
    *p++ = '\0';
451
0
  } else
452
47
    if (n > 0) {
453
47
      p += n;
454
47
      if (p[-1] != '\n')
455
0
        *p++ = '\n';
456
47
      *p = '\0';
457
47
    }
458
459
  /*
460
   * The actual emit
461
   */
462
463
47
  if (cx->lll_flags & LLLF_LOG_CONTEXT_AWARE)
464
0
    cx->u.emit_cx(cx, filter, buf, lws_ptr_diff_size_t(p, buf));
465
47
  else
466
47
    cx->u.emit(filter, buf);
467
47
}
468
469
void _lws_logv(int filter, const char *format, va_list vl)
470
0
{
471
0
  __lws_logv(&log_cx, NULL, NULL, filter, NULL, format, vl);
472
0
}
473
474
void _lws_log(int filter, const char *format, ...)
475
11.1k
{
476
11.1k
  va_list ap;
477
478
11.1k
  va_start(ap, format);
479
11.1k
  __lws_logv(&log_cx, NULL, NULL, filter, NULL, format, ap);
480
11.1k
  va_end(ap);
481
11.1k
}
482
483
void _lws_log_cx(lws_log_cx_t *cx, lws_log_prepend_cx_t prep, void *obj,
484
     int filter, const char *_fun, const char *format, ...)
485
0
{
486
0
  va_list ap;
487
488
0
  if (!cx)
489
0
    cx = &log_cx;
490
491
0
  va_start(ap, format);
492
0
  __lws_logv(cx, prep, obj, filter, _fun, format, ap);
493
0
  va_end(ap);
494
0
}
495
#endif
496
497
void
498
lws_set_log_level(int flags, lws_log_emit_t func)
499
0
{
500
0
  log_cx.lll_flags = (uint32_t)(flags & (~LLLF_LOG_CONTEXT_AWARE));
501
502
0
  if (func)
503
0
    log_cx.u.emit = func;
504
0
}
505
506
int lwsl_visible(int level)
507
0
{
508
0
  return !!(log_cx.lll_flags & (uint32_t)level);
509
0
}
510
511
int lwsl_visible_cx(lws_log_cx_t *cx, int level)
512
0
{
513
0
  return !!(cx->lll_flags & (uint32_t)level);
514
0
}
515
516
void
517
lwsl_refcount_cx(lws_log_cx_t *cx, int _new)
518
0
{
519
#if LWS_MAX_SMP > 1
520
  volatile lws_log_cx_t *vcx = (volatile lws_log_cx_t *)cx;
521
#endif
522
523
0
  if (!cx)
524
0
    return;
525
526
#if LWS_MAX_SMP > 1
527
  if (!vcx->inited) {
528
    vcx->inited = 1;
529
    lws_pthread_mutex_init(&cx->refcount_lock);
530
    vcx->inited = 2;
531
  }
532
  while (vcx->inited != 2)
533
    ;
534
  lws_pthread_mutex_lock(&cx->refcount_lock);
535
#endif
536
537
0
  if (_new > 0)
538
0
    cx->refcount++;
539
0
  else {
540
0
    assert(cx->refcount);
541
0
    cx->refcount--;
542
0
  }
543
544
0
  if (cx->refcount_cb)
545
0
    cx->refcount_cb(cx, _new);
546
547
#if LWS_MAX_SMP > 1
548
  lws_pthread_mutex_unlock(&cx->refcount_lock);
549
#endif
550
0
}
551
552
void
553
lwsl_hexdump_level_cx(lws_log_cx_t *cx, lws_log_prepend_cx_t prep, void *obj,
554
          int hexdump_level, const void *vbuf, size_t len)
555
0
{
556
0
  unsigned char *buf = (unsigned char *)vbuf;
557
0
  unsigned int n;
558
559
0
  if (!lwsl_visible_cx(cx, hexdump_level))
560
0
    return;
561
562
0
  if (!len) {
563
0
    _lws_log_cx(cx, prep, obj, hexdump_level, NULL,
564
0
          "(hexdump: zero length)\n");
565
0
    return;
566
0
  }
567
568
0
  if (!vbuf) {
569
0
    _lws_log_cx(cx, prep, obj, hexdump_level, NULL,
570
0
          "(hexdump: NULL ptr)\n");
571
0
    return;
572
0
  }
573
574
0
  _lws_log_cx(cx, prep, obj, hexdump_level, NULL, "\n");
575
576
0
  for (n = 0; n < len;) {
577
0
    unsigned int start = n, m;
578
0
    char line[80], *p = line;
579
580
0
    p += lws_snprintf(p, 10, "%04X: ", start);
581
582
0
    for (m = 0; m < 16 && n < len; m++)
583
0
      p += lws_snprintf(p, 5, "%02X ", buf[n++]);
584
0
    while (m++ < 16)
585
0
      p += lws_snprintf(p, 5, "   ");
586
587
0
    p += lws_snprintf(p, 6, "   ");
588
589
0
    for (m = 0; m < 16 && (start + m) < len; m++) {
590
0
      if (buf[start + m] >= ' ' && buf[start + m] < 127)
591
0
        *p++ = (char)buf[start + m];
592
0
      else
593
0
        *p++ = '.';
594
0
    }
595
0
    while (m++ < 16)
596
0
      *p++ = ' ';
597
598
0
    *p++ = '\n';
599
0
    *p = '\0';
600
0
    _lws_log_cx(cx, prep, obj, hexdump_level, NULL, "%s", line);
601
0
    (void)line;
602
0
  }
603
604
0
  _lws_log_cx(cx, prep, obj, hexdump_level, NULL, "\n");
605
0
}
606
607
void
608
lwsl_hexdump_level(int hexdump_level, const void *vbuf, size_t len)
609
0
{
610
0
  lwsl_hexdump_level_cx(&log_cx, NULL, NULL, hexdump_level, vbuf, len);
611
0
}
612
613
void
614
lwsl_hexdump(const void *vbuf, size_t len)
615
0
{
616
0
#if defined(_DEBUG)
617
0
  lwsl_hexdump_level(LLL_DEBUG, vbuf, len);
618
0
#endif
619
0
}