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