ccci_bm_events.h 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. /*
  2. * If TRACE_SYSTEM is defined, that will be the directory created
  3. * in the ftrace directory under /sys/kernel/debug/tracing/events/<system>
  4. *
  5. * The define_trace.h below will also look for a file name of
  6. * TRACE_SYSTEM.h where TRACE_SYSTEM is what is defined here.
  7. * In this case, it would look for sample.h
  8. *
  9. * If the header name will be different than the system name
  10. * (as in this case), then you can override the header name that
  11. * define_trace.h will look up by defining TRACE_INCLUDE_FILE
  12. *
  13. * This file is called trace-events-sample.h but we want the system
  14. * to be called "sample". Therefore we must define the name of this
  15. * file:
  16. *
  17. * #define TRACE_INCLUDE_FILE trace-events-sample
  18. *
  19. * As we do an the bottom of this file.
  20. *
  21. * Notice that TRACE_SYSTEM should be defined outside of #if
  22. * protection, just like TRACE_INCLUDE_FILE.
  23. */
  24. #undef TRACE_SYSTEM
  25. #define TRACE_SYSTEM ccci
  26. /*
  27. * Notice that this file is not protected like a normal header.
  28. * We also must allow for rereading of this file. The
  29. *
  30. * || defined(TRACE_HEADER_MULTI_READ)
  31. *
  32. * serves this purpose.
  33. */
  34. #if !defined(_TRACE_EVENT_SAMPLE_H) || defined(TRACE_HEADER_MULTI_READ)
  35. #define _TRACE_EVENT_SAMPLE_H
  36. /*
  37. * All trace headers should include tracepoint.h, until we finally
  38. * make it into a standard header.
  39. */
  40. #include <linux/tracepoint.h>
  41. /*
  42. * The TRACE_EVENT macro is broken up into 5 parts.
  43. *
  44. * name: name of the trace point. This is also how to enable the tracepoint.
  45. * A function called trace_foo_bar() will be created.
  46. *
  47. * proto: the prototype of the function trace_foo_bar()
  48. * Here it is trace_foo_bar(char *foo, int bar).
  49. *
  50. * args: must match the arguments in the prototype.
  51. * Here it is simply "foo, bar".
  52. *
  53. * struct: This defines the way the data will be stored in the ring buffer.
  54. * There are currently two types of elements. __field and __array.
  55. * a __field is broken up into (type, name). Where type can be any
  56. * type but an array.
  57. * For an array. there are three fields. (type, name, size). The
  58. * type of elements in the array, the name of the field and the size
  59. * of the array.
  60. *
  61. * __array( char, foo, 10) is the same as saying char foo[10].
  62. *
  63. * fast_assign: This is a C like function that is used to store the items
  64. * into the ring buffer.
  65. *
  66. * printk: This is a way to print out the data in pretty print. This is
  67. * useful if the system crashes and you are logging via a serial line,
  68. * the data can be printed to the console using this "printk" method.
  69. *
  70. * Note, that for both the assign and the printk, __entry is the handler
  71. * to the data structure in the ring buffer, and is defined by the
  72. * TP_STRUCT__entry.
  73. */
  74. TRACE_EVENT(ccci_bm,
  75. TP_PROTO(unsigned int req_bool_size, unsigned int bm_pool1_size, unsigned int bm_pool2_size,
  76. unsigned int bm_pool3_size), TP_ARGS(req_bool_size, bm_pool1_size, bm_pool2_size, bm_pool3_size),
  77. TP_STRUCT__entry(__field(unsigned int, req_bool_size)
  78. __field(unsigned int, bm_pool1_size)
  79. __field(unsigned int, bm_pool2_size)
  80. __field(unsigned int, bm_pool3_size)
  81. ),
  82. TP_fast_assign(__entry->req_bool_size = req_bool_size;
  83. __entry->bm_pool1_size = bm_pool1_size;
  84. __entry->bm_pool2_size = bm_pool2_size;
  85. __entry->bm_pool3_size = bm_pool3_size;),
  86. TP_printk("%u,%u,%u,%u", _entry->req_bool_size, __entry->bm_pool1_size, __entry->bm_pool2_size,
  87. __entry->bm_pool3_size)
  88. );
  89. #endif
  90. /***** NOTICE! The #if protection ends here. *****/
  91. /*
  92. * There are several ways I could have done this. If I left out the
  93. * TRACE_INCLUDE_PATH, then it would default to the kernel source
  94. * include/trace/events directory.
  95. *
  96. * I could specify a path from the define_trace.h file back to this
  97. * file.
  98. *
  99. * #define TRACE_INCLUDE_PATH ../../samples/trace_events
  100. *
  101. * But the safest and easiest way to simply make it use the directory
  102. * that the file is in is to add in the Makefile:
  103. *
  104. * CFLAGS_trace-events-sample.o := -I$(src)
  105. *
  106. * This will make sure the current path is part of the include
  107. * structure for our file so that define_trace.h can find it.
  108. *
  109. * I could have made only the top level directory the include:
  110. *
  111. * CFLAGS_trace-events-sample.o := -I$(PWD)
  112. *
  113. * And then let the path to this directory be the TRACE_INCLUDE_PATH:
  114. *
  115. * #define TRACE_INCLUDE_PATH samples/trace_events
  116. *
  117. * But then if something defines "samples" or "trace_events" as a macro
  118. * then we could risk that being converted too, and give us an unexpected
  119. * result.
  120. */
  121. #undef TRACE_INCLUDE_PATH
  122. #undef TRACE_INCLUDE_FILE
  123. #define TRACE_INCLUDE_PATH .
  124. /*
  125. * TRACE_INCLUDE_FILE is not needed if the filename and TRACE_SYSTEM are equal
  126. */
  127. #define TRACE_INCLUDE_FILE ccci_events
  128. #include <trace/define_trace.h>