]> git.karo-electronics.de Git - karo-tx-linux.git/blob - tools/perf/util/scripting-engines/trace-event-python.c
Merge branch 'rc-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild
[karo-tx-linux.git] / tools / perf / util / scripting-engines / trace-event-python.c
1 /*
2  * trace-event-python.  Feed trace events to an embedded Python interpreter.
3  *
4  * Copyright (C) 2010 Tom Zanussi <tzanussi@gmail.com>
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #include <Python.h>
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <errno.h>
28
29 #include "../../perf.h"
30 #include "../evsel.h"
31 #include "../util.h"
32 #include "../event.h"
33 #include "../thread.h"
34 #include "../trace-event.h"
35
36 PyMODINIT_FUNC initperf_trace_context(void);
37
38 #define FTRACE_MAX_EVENT                                \
39         ((1 << (sizeof(unsigned short) * 8)) - 1)
40
41 struct event_format *events[FTRACE_MAX_EVENT];
42
43 #define MAX_FIELDS      64
44 #define N_COMMON_FIELDS 7
45
46 extern struct scripting_context *scripting_context;
47
48 static char *cur_field_name;
49 static int zero_flag_atom;
50
51 static PyObject *main_module, *main_dict;
52
53 static void handler_call_die(const char *handler_name)
54 {
55         PyErr_Print();
56         Py_FatalError("problem in Python trace event handler");
57 }
58
59 /*
60  * Insert val into into the dictionary and decrement the reference counter.
61  * This is necessary for dictionaries since PyDict_SetItemString() does not 
62  * steal a reference, as opposed to PyTuple_SetItem().
63  */
64 static void pydict_set_item_string_decref(PyObject *dict, const char *key, PyObject *val)
65 {
66         PyDict_SetItemString(dict, key, val);
67         Py_DECREF(val);
68 }
69
70 static void define_value(enum print_arg_type field_type,
71                          const char *ev_name,
72                          const char *field_name,
73                          const char *field_value,
74                          const char *field_str)
75 {
76         const char *handler_name = "define_flag_value";
77         PyObject *handler, *t, *retval;
78         unsigned long long value;
79         unsigned n = 0;
80
81         if (field_type == PRINT_SYMBOL)
82                 handler_name = "define_symbolic_value";
83
84         t = PyTuple_New(4);
85         if (!t)
86                 Py_FatalError("couldn't create Python tuple");
87
88         value = eval_flag(field_value);
89
90         PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
91         PyTuple_SetItem(t, n++, PyString_FromString(field_name));
92         PyTuple_SetItem(t, n++, PyInt_FromLong(value));
93         PyTuple_SetItem(t, n++, PyString_FromString(field_str));
94
95         handler = PyDict_GetItemString(main_dict, handler_name);
96         if (handler && PyCallable_Check(handler)) {
97                 retval = PyObject_CallObject(handler, t);
98                 if (retval == NULL)
99                         handler_call_die(handler_name);
100         }
101
102         Py_DECREF(t);
103 }
104
105 static void define_values(enum print_arg_type field_type,
106                           struct print_flag_sym *field,
107                           const char *ev_name,
108                           const char *field_name)
109 {
110         define_value(field_type, ev_name, field_name, field->value,
111                      field->str);
112
113         if (field->next)
114                 define_values(field_type, field->next, ev_name, field_name);
115 }
116
117 static void define_field(enum print_arg_type field_type,
118                          const char *ev_name,
119                          const char *field_name,
120                          const char *delim)
121 {
122         const char *handler_name = "define_flag_field";
123         PyObject *handler, *t, *retval;
124         unsigned n = 0;
125
126         if (field_type == PRINT_SYMBOL)
127                 handler_name = "define_symbolic_field";
128
129         if (field_type == PRINT_FLAGS)
130                 t = PyTuple_New(3);
131         else
132                 t = PyTuple_New(2);
133         if (!t)
134                 Py_FatalError("couldn't create Python tuple");
135
136         PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
137         PyTuple_SetItem(t, n++, PyString_FromString(field_name));
138         if (field_type == PRINT_FLAGS)
139                 PyTuple_SetItem(t, n++, PyString_FromString(delim));
140
141         handler = PyDict_GetItemString(main_dict, handler_name);
142         if (handler && PyCallable_Check(handler)) {
143                 retval = PyObject_CallObject(handler, t);
144                 if (retval == NULL)
145                         handler_call_die(handler_name);
146         }
147
148         Py_DECREF(t);
149 }
150
151 static void define_event_symbols(struct event_format *event,
152                                  const char *ev_name,
153                                  struct print_arg *args)
154 {
155         switch (args->type) {
156         case PRINT_NULL:
157                 break;
158         case PRINT_ATOM:
159                 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
160                              args->atom.atom);
161                 zero_flag_atom = 0;
162                 break;
163         case PRINT_FIELD:
164                 free(cur_field_name);
165                 cur_field_name = strdup(args->field.name);
166                 break;
167         case PRINT_FLAGS:
168                 define_event_symbols(event, ev_name, args->flags.field);
169                 define_field(PRINT_FLAGS, ev_name, cur_field_name,
170                              args->flags.delim);
171                 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
172                               cur_field_name);
173                 break;
174         case PRINT_SYMBOL:
175                 define_event_symbols(event, ev_name, args->symbol.field);
176                 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
177                 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
178                               cur_field_name);
179                 break;
180         case PRINT_HEX:
181                 define_event_symbols(event, ev_name, args->hex.field);
182                 define_event_symbols(event, ev_name, args->hex.size);
183                 break;
184         case PRINT_STRING:
185                 break;
186         case PRINT_TYPE:
187                 define_event_symbols(event, ev_name, args->typecast.item);
188                 break;
189         case PRINT_OP:
190                 if (strcmp(args->op.op, ":") == 0)
191                         zero_flag_atom = 1;
192                 define_event_symbols(event, ev_name, args->op.left);
193                 define_event_symbols(event, ev_name, args->op.right);
194                 break;
195         default:
196                 /* gcc warns for these? */
197         case PRINT_BSTRING:
198         case PRINT_DYNAMIC_ARRAY:
199         case PRINT_FUNC:
200         case PRINT_BITMASK:
201                 /* we should warn... */
202                 return;
203         }
204
205         if (args->next)
206                 define_event_symbols(event, ev_name, args->next);
207 }
208
209 static inline struct event_format *find_cache_event(struct perf_evsel *evsel)
210 {
211         static char ev_name[256];
212         struct event_format *event;
213         int type = evsel->attr.config;
214
215         /*
216          * XXX: Do we really need to cache this since now we have evsel->tp_format
217          * cached already? Need to re-read this "cache" routine that as well calls
218          * define_event_symbols() :-\
219          */
220         if (events[type])
221                 return events[type];
222
223         events[type] = event = evsel->tp_format;
224         if (!event)
225                 return NULL;
226
227         sprintf(ev_name, "%s__%s", event->system, event->name);
228
229         define_event_symbols(event, ev_name, event->print_fmt.args);
230
231         return event;
232 }
233
234 static void python_process_tracepoint(struct perf_sample *sample,
235                                       struct perf_evsel *evsel,
236                                       struct thread *thread,
237                                       struct addr_location *al)
238 {
239         PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
240         static char handler_name[256];
241         struct format_field *field;
242         unsigned long long val;
243         unsigned long s, ns;
244         struct event_format *event;
245         unsigned n = 0;
246         int pid;
247         int cpu = sample->cpu;
248         void *data = sample->raw_data;
249         unsigned long long nsecs = sample->time;
250         const char *comm = thread__comm_str(thread);
251
252         t = PyTuple_New(MAX_FIELDS);
253         if (!t)
254                 Py_FatalError("couldn't create Python tuple");
255
256         event = find_cache_event(evsel);
257         if (!event)
258                 die("ug! no event found for type %d", (int)evsel->attr.config);
259
260         pid = raw_field_value(event, "common_pid", data);
261
262         sprintf(handler_name, "%s__%s", event->system, event->name);
263
264         handler = PyDict_GetItemString(main_dict, handler_name);
265         if (handler && !PyCallable_Check(handler))
266                 handler = NULL;
267         if (!handler) {
268                 dict = PyDict_New();
269                 if (!dict)
270                         Py_FatalError("couldn't create Python dict");
271         }
272         s = nsecs / NSECS_PER_SEC;
273         ns = nsecs - s * NSECS_PER_SEC;
274
275         scripting_context->event_data = data;
276         scripting_context->pevent = evsel->tp_format->pevent;
277
278         context = PyCObject_FromVoidPtr(scripting_context, NULL);
279
280         PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
281         PyTuple_SetItem(t, n++, context);
282
283         if (handler) {
284                 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
285                 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
286                 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
287                 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
288                 PyTuple_SetItem(t, n++, PyString_FromString(comm));
289         } else {
290                 pydict_set_item_string_decref(dict, "common_cpu", PyInt_FromLong(cpu));
291                 pydict_set_item_string_decref(dict, "common_s", PyInt_FromLong(s));
292                 pydict_set_item_string_decref(dict, "common_ns", PyInt_FromLong(ns));
293                 pydict_set_item_string_decref(dict, "common_pid", PyInt_FromLong(pid));
294                 pydict_set_item_string_decref(dict, "common_comm", PyString_FromString(comm));
295         }
296         for (field = event->format.fields; field; field = field->next) {
297                 if (field->flags & FIELD_IS_STRING) {
298                         int offset;
299                         if (field->flags & FIELD_IS_DYNAMIC) {
300                                 offset = *(int *)(data + field->offset);
301                                 offset &= 0xffff;
302                         } else
303                                 offset = field->offset;
304                         obj = PyString_FromString((char *)data + offset);
305                 } else { /* FIELD_IS_NUMERIC */
306                         val = read_size(event, data + field->offset,
307                                         field->size);
308                         if (field->flags & FIELD_IS_SIGNED) {
309                                 if ((long long)val >= LONG_MIN &&
310                                     (long long)val <= LONG_MAX)
311                                         obj = PyInt_FromLong(val);
312                                 else
313                                         obj = PyLong_FromLongLong(val);
314                         } else {
315                                 if (val <= LONG_MAX)
316                                         obj = PyInt_FromLong(val);
317                                 else
318                                         obj = PyLong_FromUnsignedLongLong(val);
319                         }
320                 }
321                 if (handler)
322                         PyTuple_SetItem(t, n++, obj);
323                 else
324                         pydict_set_item_string_decref(dict, field->name, obj);
325
326         }
327         if (!handler)
328                 PyTuple_SetItem(t, n++, dict);
329
330         if (_PyTuple_Resize(&t, n) == -1)
331                 Py_FatalError("error resizing Python tuple");
332
333         if (handler) {
334                 retval = PyObject_CallObject(handler, t);
335                 if (retval == NULL)
336                         handler_call_die(handler_name);
337         } else {
338                 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
339                 if (handler && PyCallable_Check(handler)) {
340
341                         retval = PyObject_CallObject(handler, t);
342                         if (retval == NULL)
343                                 handler_call_die("trace_unhandled");
344                 }
345                 Py_DECREF(dict);
346         }
347
348         Py_DECREF(t);
349 }
350
351 static void python_process_general_event(struct perf_sample *sample,
352                                          struct perf_evsel *evsel,
353                                          struct thread *thread,
354                                          struct addr_location *al)
355 {
356         PyObject *handler, *retval, *t, *dict;
357         static char handler_name[64];
358         unsigned n = 0;
359
360         /*
361          * Use the MAX_FIELDS to make the function expandable, though
362          * currently there is only one item for the tuple.
363          */
364         t = PyTuple_New(MAX_FIELDS);
365         if (!t)
366                 Py_FatalError("couldn't create Python tuple");
367
368         dict = PyDict_New();
369         if (!dict)
370                 Py_FatalError("couldn't create Python dictionary");
371
372         snprintf(handler_name, sizeof(handler_name), "%s", "process_event");
373
374         handler = PyDict_GetItemString(main_dict, handler_name);
375         if (!handler || !PyCallable_Check(handler))
376                 goto exit;
377
378         pydict_set_item_string_decref(dict, "ev_name", PyString_FromString(perf_evsel__name(evsel)));
379         pydict_set_item_string_decref(dict, "attr", PyString_FromStringAndSize(
380                         (const char *)&evsel->attr, sizeof(evsel->attr)));
381         pydict_set_item_string_decref(dict, "sample", PyString_FromStringAndSize(
382                         (const char *)sample, sizeof(*sample)));
383         pydict_set_item_string_decref(dict, "raw_buf", PyString_FromStringAndSize(
384                         (const char *)sample->raw_data, sample->raw_size));
385         pydict_set_item_string_decref(dict, "comm",
386                         PyString_FromString(thread__comm_str(thread)));
387         if (al->map) {
388                 pydict_set_item_string_decref(dict, "dso",
389                         PyString_FromString(al->map->dso->name));
390         }
391         if (al->sym) {
392                 pydict_set_item_string_decref(dict, "symbol",
393                         PyString_FromString(al->sym->name));
394         }
395
396         PyTuple_SetItem(t, n++, dict);
397         if (_PyTuple_Resize(&t, n) == -1)
398                 Py_FatalError("error resizing Python tuple");
399
400         retval = PyObject_CallObject(handler, t);
401         if (retval == NULL)
402                 handler_call_die(handler_name);
403 exit:
404         Py_DECREF(dict);
405         Py_DECREF(t);
406 }
407
408 static void python_process_event(union perf_event *event __maybe_unused,
409                                  struct perf_sample *sample,
410                                  struct perf_evsel *evsel,
411                                  struct thread *thread,
412                                  struct addr_location *al)
413 {
414         switch (evsel->attr.type) {
415         case PERF_TYPE_TRACEPOINT:
416                 python_process_tracepoint(sample, evsel, thread, al);
417                 break;
418         /* Reserve for future process_hw/sw/raw APIs */
419         default:
420                 python_process_general_event(sample, evsel, thread, al);
421         }
422 }
423
424 static int run_start_sub(void)
425 {
426         PyObject *handler, *retval;
427         int err = 0;
428
429         main_module = PyImport_AddModule("__main__");
430         if (main_module == NULL)
431                 return -1;
432         Py_INCREF(main_module);
433
434         main_dict = PyModule_GetDict(main_module);
435         if (main_dict == NULL) {
436                 err = -1;
437                 goto error;
438         }
439         Py_INCREF(main_dict);
440
441         handler = PyDict_GetItemString(main_dict, "trace_begin");
442         if (handler == NULL || !PyCallable_Check(handler))
443                 goto out;
444
445         retval = PyObject_CallObject(handler, NULL);
446         if (retval == NULL)
447                 handler_call_die("trace_begin");
448
449         Py_DECREF(retval);
450         return err;
451 error:
452         Py_XDECREF(main_dict);
453         Py_XDECREF(main_module);
454 out:
455         return err;
456 }
457
458 /*
459  * Start trace script
460  */
461 static int python_start_script(const char *script, int argc, const char **argv)
462 {
463         const char **command_line;
464         char buf[PATH_MAX];
465         int i, err = 0;
466         FILE *fp;
467
468         command_line = malloc((argc + 1) * sizeof(const char *));
469         command_line[0] = script;
470         for (i = 1; i < argc + 1; i++)
471                 command_line[i] = argv[i - 1];
472
473         Py_Initialize();
474
475         initperf_trace_context();
476
477         PySys_SetArgv(argc + 1, (char **)command_line);
478
479         fp = fopen(script, "r");
480         if (!fp) {
481                 sprintf(buf, "Can't open python script \"%s\"", script);
482                 perror(buf);
483                 err = -1;
484                 goto error;
485         }
486
487         err = PyRun_SimpleFile(fp, script);
488         if (err) {
489                 fprintf(stderr, "Error running python script %s\n", script);
490                 goto error;
491         }
492
493         err = run_start_sub();
494         if (err) {
495                 fprintf(stderr, "Error starting python script %s\n", script);
496                 goto error;
497         }
498
499         free(command_line);
500
501         return err;
502 error:
503         Py_Finalize();
504         free(command_line);
505
506         return err;
507 }
508
509 /*
510  * Stop trace script
511  */
512 static int python_stop_script(void)
513 {
514         PyObject *handler, *retval;
515         int err = 0;
516
517         handler = PyDict_GetItemString(main_dict, "trace_end");
518         if (handler == NULL || !PyCallable_Check(handler))
519                 goto out;
520
521         retval = PyObject_CallObject(handler, NULL);
522         if (retval == NULL)
523                 handler_call_die("trace_end");
524         else
525                 Py_DECREF(retval);
526 out:
527         Py_XDECREF(main_dict);
528         Py_XDECREF(main_module);
529         Py_Finalize();
530
531         return err;
532 }
533
534 static int python_generate_script(struct pevent *pevent, const char *outfile)
535 {
536         struct event_format *event = NULL;
537         struct format_field *f;
538         char fname[PATH_MAX];
539         int not_first, count;
540         FILE *ofp;
541
542         sprintf(fname, "%s.py", outfile);
543         ofp = fopen(fname, "w");
544         if (ofp == NULL) {
545                 fprintf(stderr, "couldn't open %s\n", fname);
546                 return -1;
547         }
548         fprintf(ofp, "# perf script event handlers, "
549                 "generated by perf script -g python\n");
550
551         fprintf(ofp, "# Licensed under the terms of the GNU GPL"
552                 " License version 2\n\n");
553
554         fprintf(ofp, "# The common_* event handler fields are the most useful "
555                 "fields common to\n");
556
557         fprintf(ofp, "# all events.  They don't necessarily correspond to "
558                 "the 'common_*' fields\n");
559
560         fprintf(ofp, "# in the format files.  Those fields not available as "
561                 "handler params can\n");
562
563         fprintf(ofp, "# be retrieved using Python functions of the form "
564                 "common_*(context).\n");
565
566         fprintf(ofp, "# See the perf-trace-python Documentation for the list "
567                 "of available functions.\n\n");
568
569         fprintf(ofp, "import os\n");
570         fprintf(ofp, "import sys\n\n");
571
572         fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
573         fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
574         fprintf(ofp, "\nfrom perf_trace_context import *\n");
575         fprintf(ofp, "from Core import *\n\n\n");
576
577         fprintf(ofp, "def trace_begin():\n");
578         fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
579
580         fprintf(ofp, "def trace_end():\n");
581         fprintf(ofp, "\tprint \"in trace_end\"\n\n");
582
583         while ((event = trace_find_next_event(pevent, event))) {
584                 fprintf(ofp, "def %s__%s(", event->system, event->name);
585                 fprintf(ofp, "event_name, ");
586                 fprintf(ofp, "context, ");
587                 fprintf(ofp, "common_cpu,\n");
588                 fprintf(ofp, "\tcommon_secs, ");
589                 fprintf(ofp, "common_nsecs, ");
590                 fprintf(ofp, "common_pid, ");
591                 fprintf(ofp, "common_comm,\n\t");
592
593                 not_first = 0;
594                 count = 0;
595
596                 for (f = event->format.fields; f; f = f->next) {
597                         if (not_first++)
598                                 fprintf(ofp, ", ");
599                         if (++count % 5 == 0)
600                                 fprintf(ofp, "\n\t");
601
602                         fprintf(ofp, "%s", f->name);
603                 }
604                 fprintf(ofp, "):\n");
605
606                 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
607                         "common_secs, common_nsecs,\n\t\t\t"
608                         "common_pid, common_comm)\n\n");
609
610                 fprintf(ofp, "\t\tprint \"");
611
612                 not_first = 0;
613                 count = 0;
614
615                 for (f = event->format.fields; f; f = f->next) {
616                         if (not_first++)
617                                 fprintf(ofp, ", ");
618                         if (count && count % 3 == 0) {
619                                 fprintf(ofp, "\" \\\n\t\t\"");
620                         }
621                         count++;
622
623                         fprintf(ofp, "%s=", f->name);
624                         if (f->flags & FIELD_IS_STRING ||
625                             f->flags & FIELD_IS_FLAG ||
626                             f->flags & FIELD_IS_ARRAY ||
627                             f->flags & FIELD_IS_SYMBOLIC)
628                                 fprintf(ofp, "%%s");
629                         else if (f->flags & FIELD_IS_SIGNED)
630                                 fprintf(ofp, "%%d");
631                         else
632                                 fprintf(ofp, "%%u");
633                 }
634
635                 fprintf(ofp, "\\n\" %% \\\n\t\t(");
636
637                 not_first = 0;
638                 count = 0;
639
640                 for (f = event->format.fields; f; f = f->next) {
641                         if (not_first++)
642                                 fprintf(ofp, ", ");
643
644                         if (++count % 5 == 0)
645                                 fprintf(ofp, "\n\t\t");
646
647                         if (f->flags & FIELD_IS_FLAG) {
648                                 if ((count - 1) % 5 != 0) {
649                                         fprintf(ofp, "\n\t\t");
650                                         count = 4;
651                                 }
652                                 fprintf(ofp, "flag_str(\"");
653                                 fprintf(ofp, "%s__%s\", ", event->system,
654                                         event->name);
655                                 fprintf(ofp, "\"%s\", %s)", f->name,
656                                         f->name);
657                         } else if (f->flags & FIELD_IS_SYMBOLIC) {
658                                 if ((count - 1) % 5 != 0) {
659                                         fprintf(ofp, "\n\t\t");
660                                         count = 4;
661                                 }
662                                 fprintf(ofp, "symbol_str(\"");
663                                 fprintf(ofp, "%s__%s\", ", event->system,
664                                         event->name);
665                                 fprintf(ofp, "\"%s\", %s)", f->name,
666                                         f->name);
667                         } else
668                                 fprintf(ofp, "%s", f->name);
669                 }
670
671                 fprintf(ofp, "),\n\n");
672         }
673
674         fprintf(ofp, "def trace_unhandled(event_name, context, "
675                 "event_fields_dict):\n");
676
677         fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
678                 "for k,v in sorted(event_fields_dict.items())])\n\n");
679
680         fprintf(ofp, "def print_header("
681                 "event_name, cpu, secs, nsecs, pid, comm):\n"
682                 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
683                 "(event_name, cpu, secs, nsecs, pid, comm),\n");
684
685         fclose(ofp);
686
687         fprintf(stderr, "generated Python script: %s\n", fname);
688
689         return 0;
690 }
691
692 struct scripting_ops python_scripting_ops = {
693         .name = "Python",
694         .start_script = python_start_script,
695         .stop_script = python_stop_script,
696         .process_event = python_process_event,
697         .generate_script = python_generate_script,
698 };