third_party/pigweed/repo/pw_trace_tokenized/example/filter.cc

   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 // BUID
  16 // ninja -C out
  17 // host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_filter
  18 //
  19 // RUN
  20 // .out/host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_filter
  21 // trace.bin
  22 //
  23 // DECODE
  24 // python pw_trace_tokenized/py/trace_tokenized.py -i trace.bin -o trace.json
  25 // ./out/host_clang_debug/obj/pw_trace_tokenized/bin/trace_tokenized_example_basic
  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 pw_trace_TraceEventReturnFlags TraceEventCallback(void* user_data,
  38                                                   uint32_t trace_ref,
  39                                                   pw_trace_EventType event_type,
  40                                                   const char* module,
  41                                                   uint32_t trace_id,
  42                                                   uint8_t flags) {
  43   // Filter out all traces from processing task, which aren't traceId 3
  44   PW_UNUSED(user_data);
  45   PW_UNUSED(event_type);
  46   PW_UNUSED(trace_ref);
  47   PW_UNUSED(flags);
  48   static constexpr uint32_t kFilterId = 3;
  49   return (strcmp("Processing", module) == 0 && trace_id != kFilterId)
  50              ? PW_TRACE_EVENT_RETURN_FLAGS_SKIP_EVENT
  51              : 0;
  52 }
  53
  54 int main(int argc, char** argv) {  // Take filename as arg
  55   if (argc != 2) {
  56     PW_LOG_ERROR("Expected output file name as argument.\n");
  57     return -1;
  58   }
  59
  60   // Register filter callback
  61   pw::trace::Callbacks::Instance().RegisterEventCallback(TraceEventCallback);
  62
  63   PW_TRACE_SET_ENABLED(true);  // Start with tracing enabled
  64
  65   // Dump trace data to the file passed in.
  66   pw::trace::TraceToFile trace_to_file(argv[1]);
  67
  68   PW_LOG_INFO("Running filter example...");
  69   RunTraceSampleApp();
  70   return 0;
  71 }