ppapi/api/dev/ppb_trace_event_dev.idl

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines the <code>PPB_Trace_Event</code> interface. It is meant
   8  * to be used in plugins as the API that trace macros from trace_event.h use.
   9  */
  10
  11 label Chrome {
  12   M25 = 0.1
  13 };
  14
  15 interface PPB_Trace_Event_Dev {
  16   /**
  17    * Gets a pointer to a character for identifying a category name in the
  18    * tracing system as well as for being able to early exit in client-side
  19    * tracing code.
  20    *
  21    * NB: This mem_t return value should technically be const, but return values
  22    * for Pepper IDL of mem_t type are not const.  The same is true for the arg
  23    * |category_enabled| for AddTraceEvent.
  24    */
  25   mem_t GetCategoryEnabled([in] cstr_t category_name);
  26
  27   /**
  28    * Adds a trace event to the platform tracing system. This function call is
  29    * usually the result of a TRACE_* macro from trace_event.h when tracing and
  30    * the category of the particular trace are enabled. It is not advisable to
  31    * call this function on its own; it is really only meant to be used by the
  32    * trace macros.
  33    */
  34   void AddTraceEvent(
  35       [in] int8_t phase,
  36       [in] mem_t category_enabled,
  37       [in] cstr_t name,
  38       [in] uint64_t id,
  39       [in] uint32_t num_args,
  40       [in, size_as=num_args] str_t[] arg_names,
  41       [in, size_as=num_args] uint8_t[] arg_types,
  42       [in, size_as=num_args] uint64_t[] arg_values,
  43       [in] uint8_t flags);
  44
  45   /**
  46    * Sets the thread name of the calling thread in the tracing system so it will
  47    * show up properly in chrome://tracing.
  48    */
  49   void SetThreadName([in] cstr_t thread_name);
  50 };