1 // Copyright 2020 The Pigweed Authors
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not
4 // use this file except in compliance with the License. You may obtain a copy of
5 // the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12 // License for the specific language governing permissions and limitations under
13 // the License.
14 //==============================================================================
15 // BUILD
16 // ninja -C out
17 // pw_strict_host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_trigger
18 //
19 // RUN
20 // ./out/pw_strict_host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_trigger
21 // trace.bin
22 //
23 // DECODE
24 // python pw_trace_tokenized/py/trace_tokenized.py -i trace.bin -o trace.json
25 // ./out/pw_strict_host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_basic#trace
26 //
27 // VIEW
28 // In chrome navigate to chrome://tracing, and load the trace.json file.
29
30 #include "pw_log/log.h"
31 #include "pw_trace/example/sample_app.h"
32 #include "pw_trace/trace.h"
33 #include "pw_trace_tokenized/example/trace_to_file.h"
34 #include "pw_trace_tokenized/trace_callback.h"
35 #include "pw_trace_tokenized/trace_tokenized.h"
36
37 namespace {
38
39 constexpr uint32_t kTriggerId = 3;
40 constexpr uint32_t kTriggerStartTraceRef =
41 PW_TRACE_REF_DATA(PW_TRACE_TYPE_ASYNC_START,
42 "Processing", // Module
43 "Job", // Label
44 PW_TRACE_FLAGS_DEFAULT,
45 "Process",
46 "@pw_py_struct_fmt:B");
47 constexpr uint32_t kTriggerEndTraceRef = PW_TRACE_REF(PW_TRACE_TYPE_ASYNC_END,
48 "Processing", // Module
49 "Job", // Label
50 PW_TRACE_FLAGS_DEFAULT,
51 "Process");
52
53 } // namespace
54
TraceEventCallback(void *,pw_trace_tokenized_TraceEvent * event)55 pw_trace_TraceEventReturnFlags TraceEventCallback(
56 void* /* user_data */, pw_trace_tokenized_TraceEvent* event) {
57 if (event->trace_token == kTriggerStartTraceRef &&
58 event->trace_id == kTriggerId) {
59 PW_LOG_INFO("Trace capture started!");
60 PW_TRACE_SET_ENABLED(true);
61 }
62 if (event->trace_token == kTriggerEndTraceRef &&
63 event->trace_id == kTriggerId) {
64 PW_LOG_INFO("Trace capture ended!");
65 return PW_TRACE_EVENT_RETURN_FLAGS_DISABLE_AFTER_PROCESSING;
66 }
67 return 0;
68 }
69
main(int argc,char ** argv)70 int main(int argc, char** argv) { // Take filename as arg
71 if (argc != 2) {
72 PW_LOG_ERROR("Expected output file name as argument.\n");
73 return -1;
74 }
75
76 // Register trigger callback
77 pw::trace::Callbacks& callbacks = pw::trace::GetCallbacks();
78 callbacks
79 .RegisterEventCallback(TraceEventCallback,
80 pw::trace::Callbacks::kCallOnEveryEvent)
81 .IgnoreError(); // TODO: b/242598609 - Handle Status properly
82
83 // Ensure tracing is off at start, the trigger will turn it on.
84 PW_TRACE_SET_ENABLED(false);
85
86 // Dump trace data to the file passed in.
87 pw::trace::TraceToFile trace_to_file(callbacks, argv[1]);
88
89 PW_LOG_INFO("Running trigger example...");
90 RunTraceSampleApp();
91 return 0;
92 }
93