]> bbs.cooldavid.org Git - net-next-2.6.git/blame - tools/perf/util/scripting-engines/trace-event-python.c
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[net-next-2.6.git] / tools / perf / util / scripting-engines / trace-event-python.c
CommitLineData
7e4b21b8
TZ
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 <ctype.h>
28#include <errno.h>
29
30#include "../../perf.h"
31#include "../util.h"
32#include "../trace-event.h"
33
34PyMODINIT_FUNC initperf_trace_context(void);
35
36#define FTRACE_MAX_EVENT \
37 ((1 << (sizeof(unsigned short) * 8)) - 1)
38
39struct event *events[FTRACE_MAX_EVENT];
40
41#define MAX_FIELDS 64
42#define N_COMMON_FIELDS 7
43
44extern struct scripting_context *scripting_context;
45
46static char *cur_field_name;
47static int zero_flag_atom;
48
49static PyObject *main_module, *main_dict;
50
51static void handler_call_die(const char *handler_name)
52{
53 PyErr_Print();
54 Py_FatalError("problem in Python trace event handler");
55}
56
57static void define_value(enum print_arg_type field_type,
58 const char *ev_name,
59 const char *field_name,
60 const char *field_value,
61 const char *field_str)
62{
63 const char *handler_name = "define_flag_value";
64 PyObject *handler, *t, *retval;
65 unsigned long long value;
66 unsigned n = 0;
67
68 if (field_type == PRINT_SYMBOL)
69 handler_name = "define_symbolic_value";
70
44ad9cd8 71 t = PyTuple_New(4);
7e4b21b8
TZ
72 if (!t)
73 Py_FatalError("couldn't create Python tuple");
74
75 value = eval_flag(field_value);
76
77 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
78 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
79 PyTuple_SetItem(t, n++, PyInt_FromLong(value));
80 PyTuple_SetItem(t, n++, PyString_FromString(field_str));
81
7e4b21b8
TZ
82 handler = PyDict_GetItemString(main_dict, handler_name);
83 if (handler && PyCallable_Check(handler)) {
84 retval = PyObject_CallObject(handler, t);
85 if (retval == NULL)
86 handler_call_die(handler_name);
87 }
88
89 Py_DECREF(t);
90}
91
92static void define_values(enum print_arg_type field_type,
93 struct print_flag_sym *field,
94 const char *ev_name,
95 const char *field_name)
96{
97 define_value(field_type, ev_name, field_name, field->value,
98 field->str);
99
100 if (field->next)
101 define_values(field_type, field->next, ev_name, field_name);
102}
103
104static void define_field(enum print_arg_type field_type,
105 const char *ev_name,
106 const char *field_name,
107 const char *delim)
108{
109 const char *handler_name = "define_flag_field";
110 PyObject *handler, *t, *retval;
111 unsigned n = 0;
112
113 if (field_type == PRINT_SYMBOL)
114 handler_name = "define_symbolic_field";
115
44ad9cd8
TZ
116 if (field_type == PRINT_FLAGS)
117 t = PyTuple_New(3);
118 else
119 t = PyTuple_New(2);
7e4b21b8
TZ
120 if (!t)
121 Py_FatalError("couldn't create Python tuple");
122
123 PyTuple_SetItem(t, n++, PyString_FromString(ev_name));
124 PyTuple_SetItem(t, n++, PyString_FromString(field_name));
125 if (field_type == PRINT_FLAGS)
126 PyTuple_SetItem(t, n++, PyString_FromString(delim));
127
7e4b21b8
TZ
128 handler = PyDict_GetItemString(main_dict, handler_name);
129 if (handler && PyCallable_Check(handler)) {
130 retval = PyObject_CallObject(handler, t);
131 if (retval == NULL)
132 handler_call_die(handler_name);
133 }
134
135 Py_DECREF(t);
136}
137
138static void define_event_symbols(struct event *event,
139 const char *ev_name,
140 struct print_arg *args)
141{
142 switch (args->type) {
143 case PRINT_NULL:
144 break;
145 case PRINT_ATOM:
146 define_value(PRINT_FLAGS, ev_name, cur_field_name, "0",
147 args->atom.atom);
148 zero_flag_atom = 0;
149 break;
150 case PRINT_FIELD:
151 if (cur_field_name)
152 free(cur_field_name);
153 cur_field_name = strdup(args->field.name);
154 break;
155 case PRINT_FLAGS:
156 define_event_symbols(event, ev_name, args->flags.field);
157 define_field(PRINT_FLAGS, ev_name, cur_field_name,
158 args->flags.delim);
159 define_values(PRINT_FLAGS, args->flags.flags, ev_name,
160 cur_field_name);
161 break;
162 case PRINT_SYMBOL:
163 define_event_symbols(event, ev_name, args->symbol.field);
164 define_field(PRINT_SYMBOL, ev_name, cur_field_name, NULL);
165 define_values(PRINT_SYMBOL, args->symbol.symbols, ev_name,
166 cur_field_name);
167 break;
168 case PRINT_STRING:
169 break;
170 case PRINT_TYPE:
171 define_event_symbols(event, ev_name, args->typecast.item);
172 break;
173 case PRINT_OP:
174 if (strcmp(args->op.op, ":") == 0)
175 zero_flag_atom = 1;
176 define_event_symbols(event, ev_name, args->op.left);
177 define_event_symbols(event, ev_name, args->op.right);
178 break;
179 default:
180 /* we should warn... */
181 return;
182 }
183
184 if (args->next)
185 define_event_symbols(event, ev_name, args->next);
186}
187
188static inline struct event *find_cache_event(int type)
189{
190 static char ev_name[256];
191 struct event *event;
192
193 if (events[type])
194 return events[type];
195
196 events[type] = event = trace_find_event(type);
197 if (!event)
198 return NULL;
199
200 sprintf(ev_name, "%s__%s", event->system, event->name);
201
202 define_event_symbols(event, ev_name, event->print_fmt.args);
203
204 return event;
205}
206
207static void python_process_event(int cpu, void *data,
208 int size __unused,
209 unsigned long long nsecs, char *comm)
210{
c0251485 211 PyObject *handler, *retval, *context, *t, *obj, *dict = NULL;
7e4b21b8
TZ
212 static char handler_name[256];
213 struct format_field *field;
214 unsigned long long val;
215 unsigned long s, ns;
216 struct event *event;
217 unsigned n = 0;
218 int type;
219 int pid;
220
221 t = PyTuple_New(MAX_FIELDS);
222 if (!t)
223 Py_FatalError("couldn't create Python tuple");
224
225 type = trace_parse_common_type(data);
226
227 event = find_cache_event(type);
228 if (!event)
229 die("ug! no event found for type %d", type);
230
231 pid = trace_parse_common_pid(data);
232
233 sprintf(handler_name, "%s__%s", event->system, event->name);
234
c0251485
PT
235 handler = PyDict_GetItemString(main_dict, handler_name);
236 if (handler && !PyCallable_Check(handler))
237 handler = NULL;
238 if (!handler) {
239 dict = PyDict_New();
240 if (!dict)
241 Py_FatalError("couldn't create Python dict");
242 }
7e4b21b8
TZ
243 s = nsecs / NSECS_PER_SEC;
244 ns = nsecs - s * NSECS_PER_SEC;
245
246 scripting_context->event_data = data;
247
248 context = PyCObject_FromVoidPtr(scripting_context, NULL);
249
250 PyTuple_SetItem(t, n++, PyString_FromString(handler_name));
251 PyTuple_SetItem(t, n++,
252 PyCObject_FromVoidPtr(scripting_context, NULL));
7e4b21b8 253
c0251485
PT
254 if (handler) {
255 PyTuple_SetItem(t, n++, PyInt_FromLong(cpu));
256 PyTuple_SetItem(t, n++, PyInt_FromLong(s));
257 PyTuple_SetItem(t, n++, PyInt_FromLong(ns));
258 PyTuple_SetItem(t, n++, PyInt_FromLong(pid));
259 PyTuple_SetItem(t, n++, PyString_FromString(comm));
260 } else {
261 PyDict_SetItemString(dict, "common_cpu", PyInt_FromLong(cpu));
262 PyDict_SetItemString(dict, "common_s", PyInt_FromLong(s));
263 PyDict_SetItemString(dict, "common_ns", PyInt_FromLong(ns));
264 PyDict_SetItemString(dict, "common_pid", PyInt_FromLong(pid));
265 PyDict_SetItemString(dict, "common_comm", PyString_FromString(comm));
266 }
7e4b21b8
TZ
267 for (field = event->format.fields; field; field = field->next) {
268 if (field->flags & FIELD_IS_STRING) {
269 int offset;
270 if (field->flags & FIELD_IS_DYNAMIC) {
271 offset = *(int *)(data + field->offset);
272 offset &= 0xffff;
273 } else
274 offset = field->offset;
b1dcc03c 275 obj = PyString_FromString((char *)data + offset);
7e4b21b8
TZ
276 } else { /* FIELD_IS_NUMERIC */
277 val = read_size(data + field->offset, field->size);
278 if (field->flags & FIELD_IS_SIGNED) {
b1dcc03c
TZ
279 if ((long long)val >= LONG_MIN &&
280 (long long)val <= LONG_MAX)
281 obj = PyInt_FromLong(val);
282 else
283 obj = PyLong_FromLongLong(val);
7e4b21b8 284 } else {
b1dcc03c
TZ
285 if (val <= LONG_MAX)
286 obj = PyInt_FromLong(val);
287 else
288 obj = PyLong_FromUnsignedLongLong(val);
7e4b21b8
TZ
289 }
290 }
c0251485
PT
291 if (handler)
292 PyTuple_SetItem(t, n++, obj);
293 else
294 PyDict_SetItemString(dict, field->name, obj);
295
7e4b21b8 296 }
c0251485
PT
297 if (!handler)
298 PyTuple_SetItem(t, n++, dict);
7e4b21b8
TZ
299
300 if (_PyTuple_Resize(&t, n) == -1)
301 Py_FatalError("error resizing Python tuple");
302
c0251485 303 if (handler) {
7e4b21b8
TZ
304 retval = PyObject_CallObject(handler, t);
305 if (retval == NULL)
306 handler_call_die(handler_name);
307 } else {
308 handler = PyDict_GetItemString(main_dict, "trace_unhandled");
309 if (handler && PyCallable_Check(handler)) {
7e4b21b8
TZ
310
311 retval = PyObject_CallObject(handler, t);
312 if (retval == NULL)
313 handler_call_die("trace_unhandled");
314 }
c0251485 315 Py_DECREF(dict);
7e4b21b8
TZ
316 }
317
318 Py_DECREF(t);
319}
320
321static int run_start_sub(void)
322{
323 PyObject *handler, *retval;
324 int err = 0;
325
326 main_module = PyImport_AddModule("__main__");
327 if (main_module == NULL)
328 return -1;
329 Py_INCREF(main_module);
330
331 main_dict = PyModule_GetDict(main_module);
332 if (main_dict == NULL) {
333 err = -1;
334 goto error;
335 }
336 Py_INCREF(main_dict);
337
338 handler = PyDict_GetItemString(main_dict, "trace_begin");
339 if (handler == NULL || !PyCallable_Check(handler))
340 goto out;
341
342 retval = PyObject_CallObject(handler, NULL);
343 if (retval == NULL)
344 handler_call_die("trace_begin");
345
346 Py_DECREF(retval);
347 return err;
348error:
349 Py_XDECREF(main_dict);
350 Py_XDECREF(main_module);
351out:
352 return err;
353}
354
355/*
356 * Start trace script
357 */
358static int python_start_script(const char *script, int argc, const char **argv)
359{
360 const char **command_line;
361 char buf[PATH_MAX];
362 int i, err = 0;
363 FILE *fp;
364
365 command_line = malloc((argc + 1) * sizeof(const char *));
366 command_line[0] = script;
367 for (i = 1; i < argc + 1; i++)
368 command_line[i] = argv[i - 1];
369
370 Py_Initialize();
371
372 initperf_trace_context();
373
374 PySys_SetArgv(argc + 1, (char **)command_line);
375
376 fp = fopen(script, "r");
377 if (!fp) {
378 sprintf(buf, "Can't open python script \"%s\"", script);
379 perror(buf);
380 err = -1;
381 goto error;
382 }
383
384 err = PyRun_SimpleFile(fp, script);
385 if (err) {
386 fprintf(stderr, "Error running python script %s\n", script);
387 goto error;
388 }
389
390 err = run_start_sub();
391 if (err) {
392 fprintf(stderr, "Error starting python script %s\n", script);
393 goto error;
394 }
395
396 free(command_line);
7e4b21b8
TZ
397
398 return err;
399error:
400 Py_Finalize();
401 free(command_line);
402
403 return err;
404}
405
406/*
407 * Stop trace script
408 */
409static int python_stop_script(void)
410{
411 PyObject *handler, *retval;
412 int err = 0;
413
414 handler = PyDict_GetItemString(main_dict, "trace_end");
415 if (handler == NULL || !PyCallable_Check(handler))
416 goto out;
417
418 retval = PyObject_CallObject(handler, NULL);
419 if (retval == NULL)
420 handler_call_die("trace_end");
421 else
422 Py_DECREF(retval);
423out:
424 Py_XDECREF(main_dict);
425 Py_XDECREF(main_module);
426 Py_Finalize();
427
7e4b21b8
TZ
428 return err;
429}
430
431static int python_generate_script(const char *outfile)
432{
433 struct event *event = NULL;
434 struct format_field *f;
435 char fname[PATH_MAX];
436 int not_first, count;
437 FILE *ofp;
438
439 sprintf(fname, "%s.py", outfile);
440 ofp = fopen(fname, "w");
441 if (ofp == NULL) {
442 fprintf(stderr, "couldn't open %s\n", fname);
443 return -1;
444 }
445 fprintf(ofp, "# perf trace event handlers, "
446 "generated by perf trace -g python\n");
447
448 fprintf(ofp, "# Licensed under the terms of the GNU GPL"
449 " License version 2\n\n");
450
451 fprintf(ofp, "# The common_* event handler fields are the most useful "
452 "fields common to\n");
453
454 fprintf(ofp, "# all events. They don't necessarily correspond to "
455 "the 'common_*' fields\n");
456
457 fprintf(ofp, "# in the format files. Those fields not available as "
458 "handler params can\n");
459
460 fprintf(ofp, "# be retrieved using Python functions of the form "
461 "common_*(context).\n");
462
463 fprintf(ofp, "# See the perf-trace-python Documentation for the list "
464 "of available functions.\n\n");
465
466 fprintf(ofp, "import os\n");
467 fprintf(ofp, "import sys\n\n");
468
469 fprintf(ofp, "sys.path.append(os.environ['PERF_EXEC_PATH'] + \\\n");
470 fprintf(ofp, "\t'/scripts/python/Perf-Trace-Util/lib/Perf/Trace')\n");
471 fprintf(ofp, "\nfrom perf_trace_context import *\n");
472 fprintf(ofp, "from Core import *\n\n\n");
473
474 fprintf(ofp, "def trace_begin():\n");
475 fprintf(ofp, "\tprint \"in trace_begin\"\n\n");
476
477 fprintf(ofp, "def trace_end():\n");
478 fprintf(ofp, "\tprint \"in trace_end\"\n\n");
479
480 while ((event = trace_find_next_event(event))) {
481 fprintf(ofp, "def %s__%s(", event->system, event->name);
482 fprintf(ofp, "event_name, ");
483 fprintf(ofp, "context, ");
484 fprintf(ofp, "common_cpu,\n");
485 fprintf(ofp, "\tcommon_secs, ");
486 fprintf(ofp, "common_nsecs, ");
487 fprintf(ofp, "common_pid, ");
488 fprintf(ofp, "common_comm,\n\t");
489
490 not_first = 0;
491 count = 0;
492
493 for (f = event->format.fields; f; f = f->next) {
494 if (not_first++)
495 fprintf(ofp, ", ");
496 if (++count % 5 == 0)
497 fprintf(ofp, "\n\t");
498
499 fprintf(ofp, "%s", f->name);
500 }
501 fprintf(ofp, "):\n");
502
503 fprintf(ofp, "\t\tprint_header(event_name, common_cpu, "
504 "common_secs, common_nsecs,\n\t\t\t"
505 "common_pid, common_comm)\n\n");
506
507 fprintf(ofp, "\t\tprint \"");
508
509 not_first = 0;
510 count = 0;
511
512 for (f = event->format.fields; f; f = f->next) {
513 if (not_first++)
514 fprintf(ofp, ", ");
515 if (count && count % 3 == 0) {
516 fprintf(ofp, "\" \\\n\t\t\"");
517 }
518 count++;
519
520 fprintf(ofp, "%s=", f->name);
521 if (f->flags & FIELD_IS_STRING ||
522 f->flags & FIELD_IS_FLAG ||
523 f->flags & FIELD_IS_SYMBOLIC)
524 fprintf(ofp, "%%s");
525 else if (f->flags & FIELD_IS_SIGNED)
526 fprintf(ofp, "%%d");
527 else
528 fprintf(ofp, "%%u");
529 }
530
531 fprintf(ofp, "\\n\" %% \\\n\t\t(");
532
533 not_first = 0;
534 count = 0;
535
536 for (f = event->format.fields; f; f = f->next) {
537 if (not_first++)
538 fprintf(ofp, ", ");
539
540 if (++count % 5 == 0)
541 fprintf(ofp, "\n\t\t");
542
543 if (f->flags & FIELD_IS_FLAG) {
544 if ((count - 1) % 5 != 0) {
545 fprintf(ofp, "\n\t\t");
546 count = 4;
547 }
548 fprintf(ofp, "flag_str(\"");
549 fprintf(ofp, "%s__%s\", ", event->system,
550 event->name);
551 fprintf(ofp, "\"%s\", %s)", f->name,
552 f->name);
553 } else if (f->flags & FIELD_IS_SYMBOLIC) {
554 if ((count - 1) % 5 != 0) {
555 fprintf(ofp, "\n\t\t");
556 count = 4;
557 }
558 fprintf(ofp, "symbol_str(\"");
559 fprintf(ofp, "%s__%s\", ", event->system,
560 event->name);
561 fprintf(ofp, "\"%s\", %s)", f->name,
562 f->name);
563 } else
564 fprintf(ofp, "%s", f->name);
565 }
566
567 fprintf(ofp, "),\n\n");
568 }
569
570 fprintf(ofp, "def trace_unhandled(event_name, context, "
c0251485 571 "event_fields_dict):\n");
7e4b21b8 572
c0251485
PT
573 fprintf(ofp, "\t\tprint ' '.join(['%%s=%%s'%%(k,str(v))"
574 "for k,v in sorted(event_fields_dict.items())])\n\n");
7e4b21b8
TZ
575
576 fprintf(ofp, "def print_header("
577 "event_name, cpu, secs, nsecs, pid, comm):\n"
578 "\tprint \"%%-20s %%5u %%05u.%%09u %%8u %%-20s \" %% \\\n\t"
579 "(event_name, cpu, secs, nsecs, pid, comm),\n");
580
581 fclose(ofp);
582
583 fprintf(stderr, "generated Python script: %s\n", fname);
584
585 return 0;
586}
587
588struct scripting_ops python_scripting_ops = {
589 .name = "Python",
590 .start_script = python_start_script,
591 .stop_script = python_stop_script,
592 .process_event = python_process_event,
593 .generate_script = python_generate_script,
594};