File: emscripten_log.cpp

package info (click to toggle)
emscripten 3.1.6~dfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 114,112 kB
  • sloc: ansic: 583,052; cpp: 391,943; javascript: 79,361; python: 54,180; sh: 49,997; pascal: 4,658; makefile: 3,426; asm: 2,191; lisp: 1,869; ruby: 488; cs: 142
file content (172 lines) | stat: -rw-r--r-- 6,841 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
// Copyright 2013 The Emscripten Authors.  All rights reserved.
// Emscripten is available under two separate licenses, the MIT license and the
// University of Illinois/NCSA Open Source License.  Both these licenses can be
// found in the LICENSE file.

#include <emscripten.h>
#include <stdio.h>
#include <cstring>

#define STRINGIZE_HELPER(x) #x
#define STRINGIZE(x) STRINGIZE_HELPER(x)

int failed = 0; // If 1, this test failed.

// A custom assert macro to test varargs routing to emscripten_log().
#define MYASSERT(condition, msg, ...) \
  do { \
    if (!(condition)) { \
      emscripten_log(EM_LOG_ERROR, "%s", "Condition '" #condition "' failed in file " __FILE__ ":" STRINGIZE(__LINE__) "!"); \
      emscripten_log(EM_LOG_ERROR, msg, ##__VA_ARGS__); \
      failed = 1; \
    } \
  } while(0)

void __attribute__((noinline)) kitten() {
  // Log to Emscripten Module.
  emscripten_log(EM_LOG_NO_PATHS, "Print a log message: int: %d, string: %s.", 42, "hello");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_WARN, "Print a warning message");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_ERROR, "This is an error!");

  // Log directly to Browser web inspector/console.
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_CONSOLE, "Info log to console: int: %d, string: %s", 42, "hello");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_CONSOLE | EM_LOG_WARN, "Warning message to console.");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_CONSOLE | EM_LOG_ERROR, "Error message to console! This should appear in red!");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_CONSOLE | EM_LOG_INFO, "Info message to console.");
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_CONSOLE | EM_LOG_DEBUG, "Debug message to console.");

  // Log to with full callstack information (both original C source and JS callstacks):
  emscripten_log(EM_LOG_C_STACK | EM_LOG_JS_STACK, "A message with as full call stack information as possible:");

  // Log with just mangled JS callstacks:
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_JS_STACK, "This is a message with a mangled JS callstack:");

  // Log only clean C callstack:
  emscripten_log(EM_LOG_NO_PATHS | EM_LOG_C_STACK, "This message should have a clean C callstack:");
}

  // Arbitrary function signature to add some content to callstack.
void __attribute__((noinline)) bar(int = 0, char * = 0, double = 0) {
  if (1 == 2)
    MYASSERT(2 == 1, "World falls apart!");
  else
    MYASSERT(1 == 1, "");

  int flags = EM_LOG_NO_PATHS | EM_LOG_JS_STACK | EM_LOG_FUNC_PARAMS;
#ifndef RUN_FROM_JS_SHELL
  flags |= EM_LOG_C_STACK;
#endif

  // We can programmatically get the callstack.
  // 1. Ask for callstack length:
  int nbytes = emscripten_get_callstack(flags, 0, 0);
  // 2. Allocate temp memory to hold the callstack.
  char *callstack = new char[nbytes];
  // 3. Obtain it.
  // 4. Do something with the callstack string.

  emscripten_get_callstack(flags, callstack, nbytes);

  /* The callstack should be something like
    at bar(int, char*, double) (src.cpp.o.js:5383:12)
    at void Foo<int>() (src.cpp.o.js:5417:4)
    at main() (src.cpp.o.js:5404:2)
    at Object.callMain (src.cpp.o.js:71344:30)
    at doRun (src.cpp.o.js:71383:25)
    at run (src.cpp.o.js:71396:5)
    at Object.<anonymous> (src.cpp.o.js:71439:1)
    at Module._compile (module.js:456:26)

    but the line numbers will greatly vary depending on the mode we are compiling in, so cannot test with direct string comparison. */

  if ((flags & EM_LOG_C_STACK) != 0) {
    // TODO(https://github.com/emscripten-core/emscripten/issues/13089)
    // We should be able to check for emscripten_log.cpp here but sadly
    // source maps seems to be broken under wasm.
#if 0
    MYASSERT(!!strstr(callstack, ".cpp:"), "Callstack was %s!", callstack);
#endif
  } else {
    MYASSERT(!!strstr(callstack, ".js:"), "Callstack was %s!", callstack);
  }
  MYASSERT(!!strstr(callstack, "at bar(int, char*, double)"), "Callstack was %s!", callstack);
  MYASSERT(!!strstr(callstack, "at void Foo<int>()"), "Callstack was %s!", callstack);

  // 5. Clean up.
  delete[] callstack;

  // Test that obtaining a truncated callstack works. (https://github.com/emscripten-core/emscripten/issues/2171)
  char *buffer = new char[21];
  buffer[20] = 0x01; // Magic sentinel that should not change its value.
  emscripten_get_callstack(EM_LOG_C_STACK | EM_LOG_NO_PATHS | EM_LOG_FUNC_PARAMS, buffer, 20);
  MYASSERT(!!strstr(buffer, "at bar(int,"), "Truncated callstack was %s!", buffer);
  MYASSERT(buffer[20] == 0x01, "");
  delete[] buffer;

  // Or alternatively use a fixed-size buffer for the callstack (and get a truncated output if it was too small).
  char str[1024];
  emscripten_get_callstack(EM_LOG_NO_PATHS | EM_LOG_JS_STACK, str, 1024);

  // TODO(sbc): should we try to revive these checks? The callstacks don't look quite like
  // this in the wasm world and we already have coverage above I think?
#if 0
  /* With EM_LOG_JS_STACK, the callstack will be
    at __Z3bariPcd (src.cpp.o.js:5394:12)
    at __Z3FooIiEvv (src.cpp.o.js:5417:4)
    at Object._main (src.cpp.o.js:5404:2)
    at Object.callMain (src.cpp.o.js:71344:30)
    at doRun (src.cpp.o.js:71383:25)
    at run (src.cpp.o.js:71396:5)
    at Object.<anonymous> (src.cpp.o.js:71439:1)
    at Module._compile (module.js:456:26) */
#ifdef RUN_FROM_JS_SHELL
  MYASSERT(!!strstr(str, "at __Z3bariPcd (src.cpp"), "Callstack was %s!", str);
  MYASSERT(!!strstr(str, "at __Z3FooIiEvv (src.cpp"), "Callstack was %s!", str);
#else
  MYASSERT(!!strstr(str, "at __Z3bariPcd (page.js"), "Callstack was %s!", str);
  MYASSERT(!!strstr(str, "at __Z3FooIiEvv (page.js"), "Callstack was %s!", str);
#endif
#endif
}

// Arbitrary function signature to add some content to callstack.
template<typename T>
void __attribute__((noinline)) Foo() {
  bar();
}

#define TestLog(args...)        emscripten_log(EM_LOG_CONSOLE, args)

void PrintDoubleStuff(double first, double second) {
  double divided = first / second;

  TestLog("%f %f %f\n", first, second, divided);
  TestLog("%d %d %d\n", (int)(first * 1000000), (int)(second * 1000000), (int)(divided * 1000000));
  TestLog("%f %d %d\n", first, (int)(second * 1000000), (int)(divided * 1000000));
  TestLog("%d %f %d\n", (int)(first * 1000000), second, (int)(divided * 1000000));
  TestLog("%d %d %f\n", (int)(first * 1000000), (int)(second * 1000000), divided);
  TestLog("%d %f %f\n", (int)(first * 1000000), second, divided);
  TestLog("%f %d %f\n", first, (int)(second * 1000000), divided);
  TestLog("%f %f %d\n", first, second, (int)(divided * 1000000));
}

void DoubleTest() {
  PrintDoubleStuff(12.3456789, 9.12345678);
}

int main() {
  int test = 123;
  emscripten_log(EM_LOG_FUNC_PARAMS | EM_LOG_CONSOLE, "test print %d\n", test);

  Foo<int>();

  DoubleTest();

  if (failed) {
    printf("Failed!\n");
    return 1;
  }

  printf("Success!\n");
  return 0;
}