include/trace/trace_events.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Stage 1 of the trace events.
   4  *
   5  * Override the macros in the event tracepoint header <trace/events/XXX.h>
   6  * to include the following:
   7  *
   8  * struct trace_event_raw_<call> {
   9  *      struct trace_entry              ent;
  10  *      <type>                          <item>;
  11  *      <type2>                         <item2>[<len>];
  12  *      [...]
  13  * };
  14  *
  15  * The <type> <item> is created by the __field(type, item) macro or
  16  * the __array(type2, item2, len) macro.
  17  * We simply do "type item;", and that will create the fields
  18  * in the structure.
  19  */
  20
  21 #include <linux/trace_events.h>
  22
  23 #ifndef TRACE_SYSTEM_VAR
  24 #define TRACE_SYSTEM_VAR TRACE_SYSTEM
  25 #endif
  26
  27 #define __app__(x, y) str__##x##y
  28 #define __app(x, y) __app__(x, y)
  29
  30 #define TRACE_SYSTEM_STRING __app(TRACE_SYSTEM_VAR,__trace_system_name)
  31
  32 #define TRACE_MAKE_SYSTEM_STR()                         \
  33         static const char TRACE_SYSTEM_STRING[] =       \
  34                 __stringify(TRACE_SYSTEM)
  35
  36 TRACE_MAKE_SYSTEM_STR();
  37
  38 #undef TRACE_DEFINE_ENUM
  39 #define TRACE_DEFINE_ENUM(a)                            \
  40         static struct trace_eval_map __used __initdata  \
  41         __##TRACE_SYSTEM##_##a =                        \
  42         {                                               \
  43                 .system = TRACE_SYSTEM_STRING,          \
  44                 .eval_string = #a,                      \
  45                 .eval_value = a                         \
  46         };                                              \
  47         static struct trace_eval_map __used             \
  48         __section("_ftrace_eval_map")                   \
  49         *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
  50
  51 #undef TRACE_DEFINE_SIZEOF
  52 #define TRACE_DEFINE_SIZEOF(a)                          \
  53         static struct trace_eval_map __used __initdata  \
  54         __##TRACE_SYSTEM##_##a =                        \
  55         {                                               \
  56                 .system = TRACE_SYSTEM_STRING,          \
  57                 .eval_string = "sizeof(" #a ")",        \
  58                 .eval_value = sizeof(a)                 \
  59         };                                              \
  60         static struct trace_eval_map __used             \
  61         __section("_ftrace_eval_map")                   \
  62         *TRACE_SYSTEM##_##a = &__##TRACE_SYSTEM##_##a
  63
  64 /*
  65  * DECLARE_EVENT_CLASS can be used to add a generic function
  66  * handlers for events. That is, if all events have the same
  67  * parameters and just have distinct trace points.
  68  * Each tracepoint can be defined with DEFINE_EVENT and that
  69  * will map the DECLARE_EVENT_CLASS to the tracepoint.
  70  *
  71  * TRACE_EVENT is a one to one mapping between tracepoint and template.
  72  */
  73 #undef TRACE_EVENT
  74 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
  75         DECLARE_EVENT_CLASS(name,                              \
  76                              PARAMS(proto),                    \
  77                              PARAMS(args),                     \
  78                              PARAMS(tstruct),                  \
  79                              PARAMS(assign),                   \
  80                              PARAMS(print));                   \
  81         DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args));
  82
  83
  84 #undef __field
  85 #define __field(type, item)             type    item;
  86
  87 #undef __field_ext
  88 #define __field_ext(type, item, filter_type)    type    item;
  89
  90 #undef __field_struct
  91 #define __field_struct(type, item)      type    item;
  92
  93 #undef __field_struct_ext
  94 #define __field_struct_ext(type, item, filter_type)     type    item;
  95
  96 #undef __array
  97 #define __array(type, item, len)        type    item[len];
  98
  99 #undef __dynamic_array
 100 #define __dynamic_array(type, item, len) u32 __data_loc_##item;
 101
 102 #undef __string
 103 #define __string(item, src) __dynamic_array(char, item, -1)
 104
 105 #undef __string_len
 106 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
 107
 108 #undef __bitmask
 109 #define __bitmask(item, nr_bits) __dynamic_array(char, item, -1)
 110
 111 #undef __rel_dynamic_array
 112 #define __rel_dynamic_array(type, item, len) u32 __rel_loc_##item;
 113
 114 #undef __rel_string
 115 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
 116
 117 #undef __rel_string_len
 118 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
 119
 120 #undef __rel_bitmask
 121 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(char, item, -1)
 122
 123 #undef TP_STRUCT__entry
 124 #define TP_STRUCT__entry(args...) args
 125
 126 #undef DECLARE_EVENT_CLASS
 127 #define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print)  \
 128         struct trace_event_raw_##name {                                 \
 129                 struct trace_entry      ent;                            \
 130                 tstruct                                                 \
 131                 char                    __data[0];                      \
 132         };                                                              \
 133                                                                         \
 134         static struct trace_event_class event_class_##name;
 135
 136 #undef DEFINE_EVENT
 137 #define DEFINE_EVENT(template, name, proto, args)       \
 138         static struct trace_event_call  __used          \
 139         __attribute__((__aligned__(4))) event_##name
 140
 141 #undef DEFINE_EVENT_FN
 142 #define DEFINE_EVENT_FN(template, name, proto, args, reg, unreg)        \
 143         DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
 144
 145 #undef DEFINE_EVENT_PRINT
 146 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)  \
 147         DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
 148
 149 /* Callbacks are meaningless to ftrace. */
 150 #undef TRACE_EVENT_FN
 151 #define TRACE_EVENT_FN(name, proto, args, tstruct,                      \
 152                 assign, print, reg, unreg)                              \
 153         TRACE_EVENT(name, PARAMS(proto), PARAMS(args),                  \
 154                 PARAMS(tstruct), PARAMS(assign), PARAMS(print))         \
 155
 156 #undef TRACE_EVENT_FN_COND
 157 #define TRACE_EVENT_FN_COND(name, proto, args, cond, tstruct,   \
 158                 assign, print, reg, unreg)                              \
 159         TRACE_EVENT_CONDITION(name, PARAMS(proto), PARAMS(args), PARAMS(cond),          \
 160                 PARAMS(tstruct), PARAMS(assign), PARAMS(print))         \
 161
 162 #undef TRACE_EVENT_FLAGS
 163 #define TRACE_EVENT_FLAGS(name, value)                                  \
 164         __TRACE_EVENT_FLAGS(name, value)
 165
 166 #undef TRACE_EVENT_PERF_PERM
 167 #define TRACE_EVENT_PERF_PERM(name, expr...)                            \
 168         __TRACE_EVENT_PERF_PERM(name, expr)
 169
 170 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 171
 172 /*
 173  * Stage 2 of the trace events.
 174  *
 175  * Include the following:
 176  *
 177  * struct trace_event_data_offsets_<call> {
 178  *      u32                             <item1>;
 179  *      u32                             <item2>;
 180  *      [...]
 181  * };
 182  *
 183  * The __dynamic_array() macro will create each u32 <item>, this is
 184  * to keep the offset of each array from the beginning of the event.
 185  * The size of an array is also encoded, in the higher 16 bits of <item>.
 186  */
 187
 188 #undef TRACE_DEFINE_ENUM
 189 #define TRACE_DEFINE_ENUM(a)
 190
 191 #undef TRACE_DEFINE_SIZEOF
 192 #define TRACE_DEFINE_SIZEOF(a)
 193
 194 #undef __field
 195 #define __field(type, item)
 196
 197 #undef __field_ext
 198 #define __field_ext(type, item, filter_type)
 199
 200 #undef __field_struct
 201 #define __field_struct(type, item)
 202
 203 #undef __field_struct_ext
 204 #define __field_struct_ext(type, item, filter_type)
 205
 206 #undef __array
 207 #define __array(type, item, len)
 208
 209 #undef __dynamic_array
 210 #define __dynamic_array(type, item, len)        u32 item;
 211
 212 #undef __string
 213 #define __string(item, src) __dynamic_array(char, item, -1)
 214
 215 #undef __bitmask
 216 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
 217
 218 #undef __string_len
 219 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
 220
 221 #undef __rel_dynamic_array
 222 #define __rel_dynamic_array(type, item, len)    u32 item;
 223
 224 #undef __rel_string
 225 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
 226
 227 #undef __rel_string_len
 228 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
 229
 230 #undef __rel_bitmask
 231 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
 232
 233 #undef DECLARE_EVENT_CLASS
 234 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)  \
 235         struct trace_event_data_offsets_##call {                        \
 236                 tstruct;                                                \
 237         };
 238
 239 #undef DEFINE_EVENT
 240 #define DEFINE_EVENT(template, name, proto, args)
 241
 242 #undef DEFINE_EVENT_PRINT
 243 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
 244
 245 #undef TRACE_EVENT_FLAGS
 246 #define TRACE_EVENT_FLAGS(event, flag)
 247
 248 #undef TRACE_EVENT_PERF_PERM
 249 #define TRACE_EVENT_PERF_PERM(event, expr...)
 250
 251 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 252
 253 /*
 254  * Stage 3 of the trace events.
 255  *
 256  * Override the macros in the event tracepoint header <trace/events/XXX.h>
 257  * to include the following:
 258  *
 259  * enum print_line_t
 260  * trace_raw_output_<call>(struct trace_iterator *iter, int flags)
 261  * {
 262  *      struct trace_seq *s = &iter->seq;
 263  *      struct trace_event_raw_<call> *field; <-- defined in stage 1
 264  *      struct trace_seq *p = &iter->tmp_seq;
 265  *
 266  * -------(for event)-------
 267  *
 268  *      struct trace_entry *entry;
 269  *
 270  *      entry = iter->ent;
 271  *
 272  *      if (entry->type != event_<call>->event.type) {
 273  *              WARN_ON_ONCE(1);
 274  *              return TRACE_TYPE_UNHANDLED;
 275  *      }
 276  *
 277  *      field = (typeof(field))entry;
 278  *
 279  *      trace_seq_init(p);
 280  *      return trace_output_call(iter, <call>, <TP_printk> "\n");
 281  *
 282  * ------(or, for event class)------
 283  *
 284  *      int ret;
 285  *
 286  *      field = (typeof(field))iter->ent;
 287  *
 288  *      ret = trace_raw_output_prep(iter, trace_event);
 289  *      if (ret != TRACE_TYPE_HANDLED)
 290  *              return ret;
 291  *
 292  *      trace_event_printf(iter, <TP_printk> "\n");
 293  *
 294  *      return trace_handle_return(s);
 295  * -------
 296  *  }
 297  *
 298  * This is the method used to print the raw event to the trace
 299  * output format. Note, this is not needed if the data is read
 300  * in binary.
 301  */
 302
 303 #undef __entry
 304 #define __entry field
 305
 306 #undef TP_printk
 307 #define TP_printk(fmt, args...) fmt "\n", args
 308
 309 #undef __get_dynamic_array
 310 #define __get_dynamic_array(field)      \
 311                 ((void *)__entry + (__entry->__data_loc_##field & 0xffff))
 312
 313 #undef __get_dynamic_array_len
 314 #define __get_dynamic_array_len(field)  \
 315                 ((__entry->__data_loc_##field >> 16) & 0xffff)
 316
 317 #undef __get_str
 318 #define __get_str(field) ((char *)__get_dynamic_array(field))
 319
 320 #undef __get_rel_dynamic_array
 321 #define __get_rel_dynamic_array(field)  \
 322                 ((void *)(&__entry->__rel_loc_##field) +        \
 323                  sizeof(__entry->__rel_loc_##field) +           \
 324                  (__entry->__rel_loc_##field & 0xffff))
 325
 326 #undef __get_rel_dynamic_array_len
 327 #define __get_rel_dynamic_array_len(field)      \
 328                 ((__entry->__rel_loc_##field >> 16) & 0xffff)
 329
 330 #undef __get_rel_str
 331 #define __get_rel_str(field) ((char *)__get_rel_dynamic_array(field))
 332
 333 #undef __get_bitmask
 334 #define __get_bitmask(field)                                            \
 335         ({                                                              \
 336                 void *__bitmask = __get_dynamic_array(field);           \
 337                 unsigned int __bitmask_size;                            \
 338                 __bitmask_size = __get_dynamic_array_len(field);        \
 339                 trace_print_bitmask_seq(p, __bitmask, __bitmask_size);  \
 340         })
 341
 342 #undef __get_rel_bitmask
 343 #define __get_rel_bitmask(field)                                                \
 344         ({                                                              \
 345                 void *__bitmask = __get_rel_dynamic_array(field);               \
 346                 unsigned int __bitmask_size;                            \
 347                 __bitmask_size = __get_rel_dynamic_array_len(field);    \
 348                 trace_print_bitmask_seq(p, __bitmask, __bitmask_size);  \
 349         })
 350
 351 #undef __print_flags
 352 #define __print_flags(flag, delim, flag_array...)                       \
 353         ({                                                              \
 354                 static const struct trace_print_flags __flags[] =       \
 355                         { flag_array, { -1, NULL }};                    \
 356                 trace_print_flags_seq(p, delim, flag, __flags); \
 357         })
 358
 359 #undef __print_symbolic
 360 #define __print_symbolic(value, symbol_array...)                        \
 361         ({                                                              \
 362                 static const struct trace_print_flags symbols[] =       \
 363                         { symbol_array, { -1, NULL }};                  \
 364                 trace_print_symbols_seq(p, value, symbols);             \
 365         })
 366
 367 #undef __print_flags_u64
 368 #undef __print_symbolic_u64
 369 #if BITS_PER_LONG == 32
 370 #define __print_flags_u64(flag, delim, flag_array...)                   \
 371         ({                                                              \
 372                 static const struct trace_print_flags_u64 __flags[] =   \
 373                         { flag_array, { -1, NULL } };                   \
 374                 trace_print_flags_seq_u64(p, delim, flag, __flags);     \
 375         })
 376
 377 #define __print_symbolic_u64(value, symbol_array...)                    \
 378         ({                                                              \
 379                 static const struct trace_print_flags_u64 symbols[] =   \
 380                         { symbol_array, { -1, NULL } };                 \
 381                 trace_print_symbols_seq_u64(p, value, symbols); \
 382         })
 383 #else
 384 #define __print_flags_u64(flag, delim, flag_array...)                   \
 385                         __print_flags(flag, delim, flag_array)
 386
 387 #define __print_symbolic_u64(value, symbol_array...)                    \
 388                         __print_symbolic(value, symbol_array)
 389 #endif
 390
 391 #undef __print_hex
 392 #define __print_hex(buf, buf_len)                                       \
 393         trace_print_hex_seq(p, buf, buf_len, false)
 394
 395 #undef __print_hex_str
 396 #define __print_hex_str(buf, buf_len)                                   \
 397         trace_print_hex_seq(p, buf, buf_len, true)
 398
 399 #undef __print_array
 400 #define __print_array(array, count, el_size)                            \
 401         ({                                                              \
 402                 BUILD_BUG_ON(el_size != 1 && el_size != 2 &&            \
 403                              el_size != 4 && el_size != 8);             \
 404                 trace_print_array_seq(p, array, count, el_size);        \
 405         })
 406
 407 #undef __print_hex_dump
 408 #define __print_hex_dump(prefix_str, prefix_type,                       \
 409                          rowsize, groupsize, buf, len, ascii)           \
 410         trace_print_hex_dump_seq(p, prefix_str, prefix_type,            \
 411                                  rowsize, groupsize, buf, len, ascii)
 412
 413 #undef __print_ns_to_secs
 414 #define __print_ns_to_secs(value)                       \
 415         ({                                              \
 416                 u64 ____val = (u64)(value);             \
 417                 do_div(____val, NSEC_PER_SEC);          \
 418                 ____val;                                \
 419         })
 420
 421 #undef __print_ns_without_secs
 422 #define __print_ns_without_secs(value)                  \
 423         ({                                              \
 424                 u64 ____val = (u64)(value);             \
 425                 (u32) do_div(____val, NSEC_PER_SEC);    \
 426         })
 427
 428 #undef DECLARE_EVENT_CLASS
 429 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)  \
 430 static notrace enum print_line_t                                        \
 431 trace_raw_output_##call(struct trace_iterator *iter, int flags,         \
 432                         struct trace_event *trace_event)                \
 433 {                                                                       \
 434         struct trace_seq *s = &iter->seq;                               \
 435         struct trace_seq __maybe_unused *p = &iter->tmp_seq;            \
 436         struct trace_event_raw_##call *field;                           \
 437         int ret;                                                        \
 438                                                                         \
 439         field = (typeof(field))iter->ent;                               \
 440                                                                         \
 441         ret = trace_raw_output_prep(iter, trace_event);                 \
 442         if (ret != TRACE_TYPE_HANDLED)                                  \
 443                 return ret;                                             \
 444                                                                         \
 445         trace_event_printf(iter, print);                                \
 446                                                                         \
 447         return trace_handle_return(s);                                  \
 448 }                                                                       \
 449 static struct trace_event_functions trace_event_type_funcs_##call = {   \
 450         .trace                  = trace_raw_output_##call,              \
 451 };
 452
 453 #undef DEFINE_EVENT_PRINT
 454 #define DEFINE_EVENT_PRINT(template, call, proto, args, print)          \
 455 static notrace enum print_line_t                                        \
 456 trace_raw_output_##call(struct trace_iterator *iter, int flags,         \
 457                          struct trace_event *event)                     \
 458 {                                                                       \
 459         struct trace_event_raw_##template *field;                       \
 460         struct trace_entry *entry;                                      \
 461         struct trace_seq *p = &iter->tmp_seq;                           \
 462                                                                         \
 463         entry = iter->ent;                                              \
 464                                                                         \
 465         if (entry->type != event_##call.event.type) {                   \
 466                 WARN_ON_ONCE(1);                                        \
 467                 return TRACE_TYPE_UNHANDLED;                            \
 468         }                                                               \
 469                                                                         \
 470         field = (typeof(field))entry;                                   \
 471                                                                         \
 472         trace_seq_init(p);                                              \
 473         return trace_output_call(iter, #call, print);                   \
 474 }                                                                       \
 475 static struct trace_event_functions trace_event_type_funcs_##call = {   \
 476         .trace                  = trace_raw_output_##call,              \
 477 };
 478
 479 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 480
 481 #undef __field_ext
 482 #define __field_ext(_type, _item, _filter_type) {                       \
 483         .type = #_type, .name = #_item,                                 \
 484         .size = sizeof(_type), .align = __alignof__(_type),             \
 485         .is_signed = is_signed_type(_type), .filter_type = _filter_type },
 486
 487 #undef __field_struct_ext
 488 #define __field_struct_ext(_type, _item, _filter_type) {                \
 489         .type = #_type, .name = #_item,                                 \
 490         .size = sizeof(_type), .align = __alignof__(_type),             \
 491         0, .filter_type = _filter_type },
 492
 493 #undef __field
 494 #define __field(type, item)     __field_ext(type, item, FILTER_OTHER)
 495
 496 #undef __field_struct
 497 #define __field_struct(type, item) __field_struct_ext(type, item, FILTER_OTHER)
 498
 499 #undef __array
 500 #define __array(_type, _item, _len) {                                   \
 501         .type = #_type"["__stringify(_len)"]", .name = #_item,          \
 502         .size = sizeof(_type[_len]), .align = __alignof__(_type),       \
 503         .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
 504
 505 #undef __dynamic_array
 506 #define __dynamic_array(_type, _item, _len) {                           \
 507         .type = "__data_loc " #_type "[]", .name = #_item,              \
 508         .size = 4, .align = 4,                                          \
 509         .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
 510
 511 #undef __string
 512 #define __string(item, src) __dynamic_array(char, item, -1)
 513
 514 #undef __string_len
 515 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
 516
 517 #undef __bitmask
 518 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
 519
 520 #undef __rel_dynamic_array
 521 #define __rel_dynamic_array(_type, _item, _len) {                       \
 522         .type = "__rel_loc " #_type "[]", .name = #_item,               \
 523         .size = 4, .align = 4,                                          \
 524         .is_signed = is_signed_type(_type), .filter_type = FILTER_OTHER },
 525
 526 #undef __rel_string
 527 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
 528
 529 #undef __rel_string_len
 530 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
 531
 532 #undef __rel_bitmask
 533 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
 534
 535 #undef DECLARE_EVENT_CLASS
 536 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, func, print)    \
 537 static struct trace_event_fields trace_event_fields_##call[] = {        \
 538         tstruct                                                         \
 539         {} };
 540
 541 #undef DEFINE_EVENT_PRINT
 542 #define DEFINE_EVENT_PRINT(template, name, proto, args, print)
 543
 544 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 545
 546 /*
 547  * remember the offset of each array from the beginning of the event.
 548  */
 549
 550 #undef __entry
 551 #define __entry entry
 552
 553 #undef __field
 554 #define __field(type, item)
 555
 556 #undef __field_ext
 557 #define __field_ext(type, item, filter_type)
 558
 559 #undef __field_struct
 560 #define __field_struct(type, item)
 561
 562 #undef __field_struct_ext
 563 #define __field_struct_ext(type, item, filter_type)
 564
 565 #undef __array
 566 #define __array(type, item, len)
 567
 568 #undef __dynamic_array
 569 #define __dynamic_array(type, item, len)                                \
 570         __item_length = (len) * sizeof(type);                           \
 571         __data_offsets->item = __data_size +                            \
 572                                offsetof(typeof(*entry), __data);        \
 573         __data_offsets->item |= __item_length << 16;                    \
 574         __data_size += __item_length;
 575
 576 #undef __string
 577 #define __string(item, src) __dynamic_array(char, item,                 \
 578                     strlen((src) ? (const char *)(src) : "(null)") + 1)
 579
 580 #undef __string_len
 581 #define __string_len(item, src, len) __dynamic_array(char, item, (len) + 1)
 582
 583 #undef __rel_dynamic_array
 584 #define __rel_dynamic_array(type, item, len)                            \
 585         __item_length = (len) * sizeof(type);                           \
 586         __data_offsets->item = __data_size +                            \
 587                                offsetof(typeof(*entry), __data) -       \
 588                                offsetof(typeof(*entry), __rel_loc_##item) -     \
 589                                sizeof(u32);                             \
 590         __data_offsets->item |= __item_length << 16;                    \
 591         __data_size += __item_length;
 592
 593 #undef __rel_string
 594 #define __rel_string(item, src) __rel_dynamic_array(char, item,                 \
 595                     strlen((src) ? (const char *)(src) : "(null)") + 1)
 596
 597 #undef __rel_string_len
 598 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, (len) + 1)
 599 /*
 600  * __bitmask_size_in_bytes_raw is the number of bytes needed to hold
 601  * num_possible_cpus().
 602  */
 603 #define __bitmask_size_in_bytes_raw(nr_bits)    \
 604         (((nr_bits) + 7) / 8)
 605
 606 #define __bitmask_size_in_longs(nr_bits)                        \
 607         ((__bitmask_size_in_bytes_raw(nr_bits) +                \
 608           ((BITS_PER_LONG / 8) - 1)) / (BITS_PER_LONG / 8))
 609
 610 /*
 611  * __bitmask_size_in_bytes is the number of bytes needed to hold
 612  * num_possible_cpus() padded out to the nearest long. This is what
 613  * is saved in the buffer, just to be consistent.
 614  */
 615 #define __bitmask_size_in_bytes(nr_bits)                                \
 616         (__bitmask_size_in_longs(nr_bits) * (BITS_PER_LONG / 8))
 617
 618 #undef __bitmask
 619 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item,   \
 620                                          __bitmask_size_in_longs(nr_bits))
 621
 622 #undef __rel_bitmask
 623 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item,   \
 624                                          __bitmask_size_in_longs(nr_bits))
 625
 626 #undef DECLARE_EVENT_CLASS
 627 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)  \
 628 static inline notrace int trace_event_get_offsets_##call(               \
 629         struct trace_event_data_offsets_##call *__data_offsets, proto)  \
 630 {                                                                       \
 631         int __data_size = 0;                                            \
 632         int __maybe_unused __item_length;                               \
 633         struct trace_event_raw_##call __maybe_unused *entry;            \
 634                                                                         \
 635         tstruct;                                                        \
 636                                                                         \
 637         return __data_size;                                             \
 638 }
 639
 640 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 641
 642 /*
 643  * Stage 4 of the trace events.
 644  *
 645  * Override the macros in the event tracepoint header <trace/events/XXX.h>
 646  * to include the following:
 647  *
 648  * For those macros defined with TRACE_EVENT:
 649  *
 650  * static struct trace_event_call event_<call>;
 651  *
 652  * static void trace_event_raw_event_<call>(void *__data, proto)
 653  * {
 654  *      struct trace_event_file *trace_file = __data;
 655  *      struct trace_event_call *event_call = trace_file->event_call;
 656  *      struct trace_event_data_offsets_<call> __maybe_unused __data_offsets;
 657  *      unsigned long eflags = trace_file->flags;
 658  *      enum event_trigger_type __tt = ETT_NONE;
 659  *      struct ring_buffer_event *event;
 660  *      struct trace_event_raw_<call> *entry; <-- defined in stage 1
 661  *      struct trace_buffer *buffer;
 662  *      unsigned long irq_flags;
 663  *      int __data_size;
 664  *      int pc;
 665  *
 666  *      if (!(eflags & EVENT_FILE_FL_TRIGGER_COND)) {
 667  *              if (eflags & EVENT_FILE_FL_TRIGGER_MODE)
 668  *                      event_triggers_call(trace_file, NULL);
 669  *              if (eflags & EVENT_FILE_FL_SOFT_DISABLED)
 670  *                      return;
 671  *      }
 672  *
 673  *      local_save_flags(irq_flags);
 674  *      pc = preempt_count();
 675  *
 676  *      __data_size = trace_event_get_offsets_<call>(&__data_offsets, args);
 677  *
 678  *      event = trace_event_buffer_lock_reserve(&buffer, trace_file,
 679  *                                event_<call>->event.type,
 680  *                                sizeof(*entry) + __data_size,
 681  *                                irq_flags, pc);
 682  *      if (!event)
 683  *              return;
 684  *      entry   = ring_buffer_event_data(event);
 685  *
 686  *      { <assign>; }  <-- Here we assign the entries by the __field and
 687  *                         __array macros.
 688  *
 689  *      if (eflags & EVENT_FILE_FL_TRIGGER_COND)
 690  *              __tt = event_triggers_call(trace_file, entry);
 691  *
 692  *      if (test_bit(EVENT_FILE_FL_SOFT_DISABLED_BIT,
 693  *                   &trace_file->flags))
 694  *              ring_buffer_discard_commit(buffer, event);
 695  *      else if (!filter_check_discard(trace_file, entry, buffer, event))
 696  *              trace_buffer_unlock_commit(buffer, event, irq_flags, pc);
 697  *
 698  *      if (__tt)
 699  *              event_triggers_post_call(trace_file, __tt);
 700  * }
 701  *
 702  * static struct trace_event ftrace_event_type_<call> = {
 703  *      .trace                  = trace_raw_output_<call>, <-- stage 2
 704  * };
 705  *
 706  * static char print_fmt_<call>[] = <TP_printk>;
 707  *
 708  * static struct trace_event_class __used event_class_<template> = {
 709  *      .system                 = "<system>",
 710  *      .fields_array           = trace_event_fields_<call>,
 711  *      .fields                 = LIST_HEAD_INIT(event_class_##call.fields),
 712  *      .raw_init               = trace_event_raw_init,
 713  *      .probe                  = trace_event_raw_event_##call,
 714  *      .reg                    = trace_event_reg,
 715  * };
 716  *
 717  * static struct trace_event_call event_<call> = {
 718  *      .class                  = event_class_<template>,
 719  *      {
 720  *              .tp                     = &__tracepoint_<call>,
 721  *      },
 722  *      .event                  = &ftrace_event_type_<call>,
 723  *      .print_fmt              = print_fmt_<call>,
 724  *      .flags                  = TRACE_EVENT_FL_TRACEPOINT,
 725  * };
 726  * // its only safe to use pointers when doing linker tricks to
 727  * // create an array.
 728  * static struct trace_event_call __used
 729  * __section("_ftrace_events") *__event_<call> = &event_<call>;
 730  *
 731  */
 732
 733 #ifdef CONFIG_PERF_EVENTS
 734
 735 #define _TRACE_PERF_PROTO(call, proto)                                  \
 736         static notrace void                                             \
 737         perf_trace_##call(void *__data, proto);
 738
 739 #define _TRACE_PERF_INIT(call)                                          \
 740         .perf_probe             = perf_trace_##call,
 741
 742 #else
 743 #define _TRACE_PERF_PROTO(call, proto)
 744 #define _TRACE_PERF_INIT(call)
 745 #endif /* CONFIG_PERF_EVENTS */
 746
 747 #undef __entry
 748 #define __entry entry
 749
 750 #undef __field
 751 #define __field(type, item)
 752
 753 #undef __field_struct
 754 #define __field_struct(type, item)
 755
 756 #undef __array
 757 #define __array(type, item, len)
 758
 759 #undef __dynamic_array
 760 #define __dynamic_array(type, item, len)                                \
 761         __entry->__data_loc_##item = __data_offsets.item;
 762
 763 #undef __string
 764 #define __string(item, src) __dynamic_array(char, item, -1)
 765
 766 #undef __string_len
 767 #define __string_len(item, src, len) __dynamic_array(char, item, -1)
 768
 769 #undef __assign_str
 770 #define __assign_str(dst, src)                                          \
 771         strcpy(__get_str(dst), (src) ? (const char *)(src) : "(null)");
 772
 773 #undef __assign_str_len
 774 #define __assign_str_len(dst, src, len)                                 \
 775         do {                                                            \
 776                 memcpy(__get_str(dst), (src), (len));                   \
 777                 __get_str(dst)[len] = '\0';                             \
 778         } while(0)
 779
 780 #undef __bitmask
 781 #define __bitmask(item, nr_bits) __dynamic_array(unsigned long, item, -1)
 782
 783 #undef __get_bitmask
 784 #define __get_bitmask(field) (char *)__get_dynamic_array(field)
 785
 786 #undef __assign_bitmask
 787 #define __assign_bitmask(dst, src, nr_bits)                                     \
 788         memcpy(__get_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
 789
 790 #undef __rel_dynamic_array
 791 #define __rel_dynamic_array(type, item, len)                            \
 792         __entry->__rel_loc_##item = __data_offsets.item;
 793
 794 #undef __rel_string
 795 #define __rel_string(item, src) __rel_dynamic_array(char, item, -1)
 796
 797 #undef __rel_string_len
 798 #define __rel_string_len(item, src, len) __rel_dynamic_array(char, item, -1)
 799
 800 #undef __assign_rel_str
 801 #define __assign_rel_str(dst, src)                                      \
 802         strcpy(__get_rel_str(dst), (src) ? (const char *)(src) : "(null)");
 803
 804 #undef __assign_rel_str_len
 805 #define __assign_rel_str_len(dst, src, len)                             \
 806         do {                                                            \
 807                 memcpy(__get_rel_str(dst), (src), (len));               \
 808                 __get_rel_str(dst)[len] = '\0';                         \
 809         } while (0)
 810
 811 #undef __rel_bitmask
 812 #define __rel_bitmask(item, nr_bits) __rel_dynamic_array(unsigned long, item, -1)
 813
 814 #undef __get_rel_bitmask
 815 #define __get_rel_bitmask(field) (char *)__get_rel_dynamic_array(field)
 816
 817 #undef __assign_rel_bitmask
 818 #define __assign_rel_bitmask(dst, src, nr_bits)                                 \
 819         memcpy(__get_rel_bitmask(dst), (src), __bitmask_size_in_bytes(nr_bits))
 820
 821 #undef TP_fast_assign
 822 #define TP_fast_assign(args...) args
 823
 824 #undef __perf_count
 825 #define __perf_count(c) (c)
 826
 827 #undef __perf_task
 828 #define __perf_task(t)  (t)
 829
 830 #undef DECLARE_EVENT_CLASS
 831 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)  \
 832                                                                         \
 833 static notrace void                                                     \
 834 trace_event_raw_event_##call(void *__data, proto)                       \
 835 {                                                                       \
 836         struct trace_event_file *trace_file = __data;                   \
 837         struct trace_event_data_offsets_##call __maybe_unused __data_offsets;\
 838         struct trace_event_buffer fbuffer;                              \
 839         struct trace_event_raw_##call *entry;                           \
 840         int __data_size;                                                \
 841                                                                         \
 842         if (trace_trigger_soft_disabled(trace_file))                    \
 843                 return;                                                 \
 844                                                                         \
 845         __data_size = trace_event_get_offsets_##call(&__data_offsets, args); \
 846                                                                         \
 847         entry = trace_event_buffer_reserve(&fbuffer, trace_file,        \
 848                                  sizeof(*entry) + __data_size);         \
 849                                                                         \
 850         if (!entry)                                                     \
 851                 return;                                                 \
 852                                                                         \
 853         tstruct                                                         \
 854                                                                         \
 855         { assign; }                                                     \
 856                                                                         \
 857         trace_event_buffer_commit(&fbuffer);                            \
 858 }
 859 /*
 860  * The ftrace_test_probe is compiled out, it is only here as a build time check
 861  * to make sure that if the tracepoint handling changes, the ftrace probe will
 862  * fail to compile unless it too is updated.
 863  */
 864
 865 #undef DEFINE_EVENT
 866 #define DEFINE_EVENT(template, call, proto, args)                       \
 867 static inline void ftrace_test_probe_##call(void)                       \
 868 {                                                                       \
 869         check_trace_callback_type_##call(trace_event_raw_event_##template); \
 870 }
 871
 872 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 873
 874 #undef __entry
 875 #define __entry REC
 876
 877 #undef __print_flags
 878 #undef __print_symbolic
 879 #undef __print_hex
 880 #undef __print_hex_str
 881 #undef __get_dynamic_array
 882 #undef __get_dynamic_array_len
 883 #undef __get_str
 884 #undef __get_bitmask
 885 #undef __get_rel_dynamic_array
 886 #undef __get_rel_dynamic_array_len
 887 #undef __get_rel_str
 888 #undef __get_rel_bitmask
 889 #undef __print_array
 890 #undef __print_hex_dump
 891
 892 /*
 893  * The below is not executed in the kernel. It is only what is
 894  * displayed in the print format for userspace to parse.
 895  */
 896 #undef __print_ns_to_secs
 897 #define __print_ns_to_secs(val) (val) / 1000000000UL
 898
 899 #undef __print_ns_without_secs
 900 #define __print_ns_without_secs(val) (val) % 1000000000UL
 901
 902 #undef TP_printk
 903 #define TP_printk(fmt, args...) "\"" fmt "\", "  __stringify(args)
 904
 905 #undef DECLARE_EVENT_CLASS
 906 #define DECLARE_EVENT_CLASS(call, proto, args, tstruct, assign, print)  \
 907 _TRACE_PERF_PROTO(call, PARAMS(proto));                                 \
 908 static char print_fmt_##call[] = print;                                 \
 909 static struct trace_event_class __used __refdata event_class_##call = { \
 910         .system                 = TRACE_SYSTEM_STRING,                  \
 911         .fields_array           = trace_event_fields_##call,            \
 912         .fields                 = LIST_HEAD_INIT(event_class_##call.fields),\
 913         .raw_init               = trace_event_raw_init,                 \
 914         .probe                  = trace_event_raw_event_##call,         \
 915         .reg                    = trace_event_reg,                      \
 916         _TRACE_PERF_INIT(call)                                          \
 917 };
 918
 919 #undef DEFINE_EVENT
 920 #define DEFINE_EVENT(template, call, proto, args)                       \
 921                                                                         \
 922 static struct trace_event_call __used event_##call = {                  \
 923         .class                  = &event_class_##template,              \
 924         {                                                               \
 925                 .tp                     = &__tracepoint_##call,         \
 926         },                                                              \
 927         .event.funcs            = &trace_event_type_funcs_##template,   \
 928         .print_fmt              = print_fmt_##template,                 \
 929         .flags                  = TRACE_EVENT_FL_TRACEPOINT,            \
 930 };                                                                      \
 931 static struct trace_event_call __used                                   \
 932 __section("_ftrace_events") *__event_##call = &event_##call
 933
 934 #undef DEFINE_EVENT_PRINT
 935 #define DEFINE_EVENT_PRINT(template, call, proto, args, print)          \
 936                                                                         \
 937 static char print_fmt_##call[] = print;                                 \
 938                                                                         \
 939 static struct trace_event_call __used event_##call = {                  \
 940         .class                  = &event_class_##template,              \
 941         {                                                               \
 942                 .tp                     = &__tracepoint_##call,         \
 943         },                                                              \
 944         .event.funcs            = &trace_event_type_funcs_##call,       \
 945         .print_fmt              = print_fmt_##call,                     \
 946         .flags                  = TRACE_EVENT_FL_TRACEPOINT,            \
 947 };                                                                      \
 948 static struct trace_event_call __used                                   \
 949 __section("_ftrace_events") *__event_##call = &event_##call
 950
 951 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)