Linux Audio

Check our new training course

Loading...
v3.15
 
   1#include "builtin.h"
   2
   3#include "perf.h"
   4#include "util/cache.h"
   5#include "util/debug.h"
   6#include "util/exec_cmd.h"
 
   7#include "util/header.h"
   8#include "util/parse-options.h"
 
   9#include "util/session.h"
  10#include "util/tool.h"
 
 
  11#include "util/symbol.h"
  12#include "util/thread.h"
  13#include "util/trace-event.h"
  14#include "util/util.h"
  15#include "util/evlist.h"
  16#include "util/evsel.h"
 
 
  17#include "util/sort.h"
  18#include "util/data.h"
 
 
 
 
 
 
 
 
 
 
 
 
  19#include <linux/bitmap.h>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  20
  21static char const		*script_name;
  22static char const		*generate_script_lang;
 
 
 
 
  23static bool			debug_mode;
  24static u64			last_timestamp;
  25static u64			nr_unordered;
  26extern const struct option	record_options[];
  27static bool			no_callchain;
  28static bool			latency_format;
  29static bool			system_wide;
 
  30static const char		*cpu_list;
  31static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
 
 
 
 
 
  32
  33enum perf_output_field {
  34	PERF_OUTPUT_COMM            = 1U << 0,
  35	PERF_OUTPUT_TID             = 1U << 1,
  36	PERF_OUTPUT_PID             = 1U << 2,
  37	PERF_OUTPUT_TIME            = 1U << 3,
  38	PERF_OUTPUT_CPU             = 1U << 4,
  39	PERF_OUTPUT_EVNAME          = 1U << 5,
  40	PERF_OUTPUT_TRACE           = 1U << 6,
  41	PERF_OUTPUT_IP              = 1U << 7,
  42	PERF_OUTPUT_SYM             = 1U << 8,
  43	PERF_OUTPUT_DSO             = 1U << 9,
  44	PERF_OUTPUT_ADDR            = 1U << 10,
  45	PERF_OUTPUT_SYMOFFSET       = 1U << 11,
  46	PERF_OUTPUT_SRCLINE         = 1U << 12,
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  47};
  48
  49struct output_option {
  50	const char *str;
  51	enum perf_output_field field;
  52} all_output_options[] = {
  53	{.str = "comm",  .field = PERF_OUTPUT_COMM},
  54	{.str = "tid",   .field = PERF_OUTPUT_TID},
  55	{.str = "pid",   .field = PERF_OUTPUT_PID},
  56	{.str = "time",  .field = PERF_OUTPUT_TIME},
  57	{.str = "cpu",   .field = PERF_OUTPUT_CPU},
  58	{.str = "event", .field = PERF_OUTPUT_EVNAME},
  59	{.str = "trace", .field = PERF_OUTPUT_TRACE},
  60	{.str = "ip",    .field = PERF_OUTPUT_IP},
  61	{.str = "sym",   .field = PERF_OUTPUT_SYM},
  62	{.str = "dso",   .field = PERF_OUTPUT_DSO},
  63	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
  64	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
  65	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  66};
  67
  68/* default set to maintain compatibility with current format */
  69static struct {
  70	bool user_set;
  71	bool wildcard_set;
  72	unsigned int print_ip_opts;
  73	u64 fields;
  74	u64 invalid_fields;
  75} output[PERF_TYPE_MAX] = {
 
 
  76
  77	[PERF_TYPE_HARDWARE] = {
  78		.user_set = false,
  79
  80		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  81			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  82			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
  83				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
 
  84
  85		.invalid_fields = PERF_OUTPUT_TRACE,
  86	},
  87
  88	[PERF_TYPE_SOFTWARE] = {
  89		.user_set = false,
  90
  91		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
  92			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
  93			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
  94				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
 
 
  95
  96		.invalid_fields = PERF_OUTPUT_TRACE,
  97	},
  98
  99	[PERF_TYPE_TRACEPOINT] = {
 100		.user_set = false,
 101
 102		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 103				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 104				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE,
 
 
 
 
 
 
 
 
 
 
 
 
 105	},
 106
 107	[PERF_TYPE_RAW] = {
 108		.user_set = false,
 109
 110		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 111			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 112			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 113				  PERF_OUTPUT_SYM | PERF_OUTPUT_DSO,
 
 
 
 114
 115		.invalid_fields = PERF_OUTPUT_TRACE,
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 116	},
 117};
 118
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 119static bool output_set_by_user(void)
 120{
 121	int j;
 122	for (j = 0; j < PERF_TYPE_MAX; ++j) {
 123		if (output[j].user_set)
 124			return true;
 125	}
 126	return false;
 127}
 128
 129static const char *output_field2str(enum perf_output_field field)
 130{
 131	int i, imax = ARRAY_SIZE(all_output_options);
 132	const char *str = "";
 133
 134	for (i = 0; i < imax; ++i) {
 135		if (all_output_options[i].field == field) {
 136			str = all_output_options[i].str;
 137			break;
 138		}
 139	}
 140	return str;
 141}
 142
 143#define PRINT_FIELD(x)  (output[attr->type].fields & PERF_OUTPUT_##x)
 144
 145static int perf_evsel__check_stype(struct perf_evsel *evsel,
 146				   u64 sample_type, const char *sample_msg,
 147				   enum perf_output_field field)
 148{
 149	struct perf_event_attr *attr = &evsel->attr;
 150	int type = attr->type;
 151	const char *evname;
 152
 153	if (attr->sample_type & sample_type)
 154		return 0;
 155
 156	if (output[type].user_set) {
 157		evname = perf_evsel__name(evsel);
 
 
 158		pr_err("Samples for '%s' event do not have %s attribute set. "
 159		       "Cannot print '%s' field.\n",
 160		       evname, sample_msg, output_field2str(field));
 161		return -1;
 162	}
 163
 164	/* user did not ask for it explicitly so remove from the default list */
 165	output[type].fields &= ~field;
 166	evname = perf_evsel__name(evsel);
 167	pr_debug("Samples for '%s' event do not have %s attribute set. "
 168		 "Skipping '%s' field.\n",
 169		 evname, sample_msg, output_field2str(field));
 170
 171	return 0;
 172}
 173
 174static int perf_evsel__check_attr(struct perf_evsel *evsel,
 175				  struct perf_session *session)
 176{
 177	struct perf_event_attr *attr = &evsel->attr;
 
 
 
 
 
 
 
 
 
 
 
 
 178
 179	if (PRINT_FIELD(TRACE) &&
 180		!perf_session__has_traces(session, "record -R"))
 181		return -EINVAL;
 182
 183	if (PRINT_FIELD(IP)) {
 184		if (perf_evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP",
 185					    PERF_OUTPUT_IP))
 186			return -EINVAL;
 187
 188		if (!no_callchain &&
 189		    !(attr->sample_type & PERF_SAMPLE_CALLCHAIN))
 190			symbol_conf.use_callchain = false;
 191	}
 192
 193	if (PRINT_FIELD(ADDR) &&
 194		perf_evsel__check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR",
 195					PERF_OUTPUT_ADDR))
 196		return -EINVAL;
 197
 198	if (PRINT_FIELD(SYM) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
 
 
 
 
 
 
 
 
 
 199		pr_err("Display of symbols requested but neither sample IP nor "
 200			   "sample address\nis selected. Hence, no addresses to convert "
 201		       "to symbols.\n");
 202		return -EINVAL;
 203	}
 204	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
 205		pr_err("Display of offsets requested but symbol is not"
 206		       "selected.\n");
 207		return -EINVAL;
 208	}
 209	if (PRINT_FIELD(DSO) && !PRINT_FIELD(IP) && !PRINT_FIELD(ADDR)) {
 210		pr_err("Display of DSO requested but neither sample IP nor "
 211			   "sample address\nis selected. Hence, no addresses to convert "
 212		       "to DSO.\n");
 213		return -EINVAL;
 214	}
 215	if (PRINT_FIELD(SRCLINE) && !PRINT_FIELD(IP)) {
 216		pr_err("Display of source line number requested but sample IP is not\n"
 217		       "selected. Hence, no address to lookup the source line number.\n");
 218		return -EINVAL;
 219	}
 220
 
 
 
 
 
 221	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
 222		perf_evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID",
 223					PERF_OUTPUT_TID|PERF_OUTPUT_PID))
 224		return -EINVAL;
 225
 226	if (PRINT_FIELD(TIME) &&
 227		perf_evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME",
 228					PERF_OUTPUT_TIME))
 229		return -EINVAL;
 230
 231	if (PRINT_FIELD(CPU) &&
 232		perf_evsel__check_stype(evsel, PERF_SAMPLE_CPU, "CPU",
 233					PERF_OUTPUT_CPU))
 
 
 
 
 
 
 
 
 
 
 
 234		return -EINVAL;
 235
 236	return 0;
 237}
 238
 239static void set_print_ip_opts(struct perf_event_attr *attr)
 240{
 241	unsigned int type = attr->type;
 242
 243	output[type].print_ip_opts = 0;
 244	if (PRINT_FIELD(IP))
 245		output[type].print_ip_opts |= PRINT_IP_OPT_IP;
 246
 247	if (PRINT_FIELD(SYM))
 248		output[type].print_ip_opts |= PRINT_IP_OPT_SYM;
 249
 250	if (PRINT_FIELD(DSO))
 251		output[type].print_ip_opts |= PRINT_IP_OPT_DSO;
 252
 253	if (PRINT_FIELD(SYMOFFSET))
 254		output[type].print_ip_opts |= PRINT_IP_OPT_SYMOFFSET;
 255
 256	if (PRINT_FIELD(SRCLINE))
 257		output[type].print_ip_opts |= PRINT_IP_OPT_SRCLINE;
 258}
 259
 260/*
 261 * verify all user requested events exist and the samples
 262 * have the expected data
 263 */
 264static int perf_session__check_output_opt(struct perf_session *session)
 265{
 266	int j;
 267	struct perf_evsel *evsel;
 
 268
 269	for (j = 0; j < PERF_TYPE_MAX; ++j) {
 270		evsel = perf_session__find_first_evtype(session, j);
 271
 272		/*
 273		 * even if fields is set to 0 (ie., show nothing) event must
 274		 * exist if user explicitly includes it on the command line
 275		 */
 276		if (!evsel && output[j].user_set && !output[j].wildcard_set) {
 
 277			pr_err("%s events do not exist. "
 278			       "Remove corresponding -f option to proceed.\n",
 279			       event_type(j));
 280			return -1;
 281		}
 282
 283		if (evsel && output[j].fields &&
 284			perf_evsel__check_attr(evsel, session))
 285			return -1;
 286
 287		if (evsel == NULL)
 288			continue;
 289
 290		set_print_ip_opts(&evsel->attr);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 291	}
 292
 293	/*
 294	 * set default for tracepoints to print symbols only
 295	 * if callchains are present
 296	 */
 297	if (symbol_conf.use_callchain &&
 298	    !output[PERF_TYPE_TRACEPOINT].user_set) {
 299		struct perf_event_attr *attr;
 300
 301		j = PERF_TYPE_TRACEPOINT;
 302		evsel = perf_session__find_first_evtype(session, j);
 303		if (evsel == NULL)
 304			goto out;
 305
 306		attr = &evsel->attr;
 
 
 307
 308		if (attr->sample_type & PERF_SAMPLE_CALLCHAIN) {
 309			output[j].fields |= PERF_OUTPUT_IP;
 310			output[j].fields |= PERF_OUTPUT_SYM;
 311			output[j].fields |= PERF_OUTPUT_DSO;
 312			set_print_ip_opts(attr);
 
 
 
 313		}
 314	}
 315
 
 
 
 
 
 316out:
 317	return 0;
 318}
 319
 320static void print_sample_start(struct perf_sample *sample,
 321			       struct thread *thread,
 322			       struct perf_evsel *evsel)
 323{
 324	struct perf_event_attr *attr = &evsel->attr;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 325	unsigned long secs;
 326	unsigned long usecs;
 327	unsigned long long nsecs;
 
 
 328
 329	if (PRINT_FIELD(COMM)) {
 330		if (latency_format)
 331			printf("%8.8s ", thread__comm_str(thread));
 332		else if (PRINT_FIELD(IP) && symbol_conf.use_callchain)
 333			printf("%s ", thread__comm_str(thread));
 334		else
 335			printf("%16s ", thread__comm_str(thread));
 336	}
 337
 338	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
 339		printf("%5d/%-5d ", sample->pid, sample->tid);
 340	else if (PRINT_FIELD(PID))
 341		printf("%5d ", sample->pid);
 342	else if (PRINT_FIELD(TID))
 343		printf("%5d ", sample->tid);
 344
 345	if (PRINT_FIELD(CPU)) {
 346		if (latency_format)
 347			printf("%3d ", sample->cpu);
 348		else
 349			printf("[%03d] ", sample->cpu);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 350	}
 351
 352	if (PRINT_FIELD(TIME)) {
 353		nsecs = sample->time;
 354		secs = nsecs / NSECS_PER_SEC;
 355		nsecs -= secs * NSECS_PER_SEC;
 356		usecs = nsecs / NSECS_PER_USEC;
 357		printf("%5lu.%06lu: ", secs, usecs);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 358	}
 
 
 359}
 360
 361static bool is_bts_event(struct perf_event_attr *attr)
 
 362{
 363	return ((attr->type == PERF_TYPE_HARDWARE) &&
 364		(attr->config & PERF_COUNT_HW_BRANCH_INSTRUCTIONS) &&
 365		(attr->sample_period == 1));
 
 366}
 367
 368static bool sample_addr_correlates_sym(struct perf_event_attr *attr)
 
 
 369{
 370	if ((attr->type == PERF_TYPE_SOFTWARE) &&
 371	    ((attr->config == PERF_COUNT_SW_PAGE_FAULTS) ||
 372	     (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MIN) ||
 373	     (attr->config == PERF_COUNT_SW_PAGE_FAULTS_MAJ)))
 374		return true;
 375
 376	if (is_bts_event(attr))
 377		return true;
 378
 379	return false;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 380}
 381
 382static void print_sample_addr(union perf_event *event,
 383			  struct perf_sample *sample,
 384			  struct machine *machine,
 385			  struct thread *thread,
 386			  struct perf_event_attr *attr)
 387{
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 388	struct addr_location al;
 389	u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
 390
 391	printf("%16" PRIx64, sample->addr);
 
 392
 393	if (!sample_addr_correlates_sym(attr))
 394		return;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 395
 396	thread__find_addr_map(thread, machine, cpumode, MAP__FUNCTION,
 397			      sample->addr, &al);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 398	if (!al.map)
 399		thread__find_addr_map(thread, machine, cpumode, MAP__VARIABLE,
 400				      sample->addr, &al);
 
 
 
 
 
 401
 402	al.cpu = sample->cpu;
 403	al.sym = NULL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 404
 
 
 
 
 
 405	if (al.map)
 406		al.sym = map__find_symbol(al.map, al.addr, NULL);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 407
 408	if (PRINT_FIELD(SYM)) {
 409		printf(" ");
 410		if (PRINT_FIELD(SYMOFFSET))
 411			symbol__fprintf_symname_offs(al.sym, &al, stdout);
 412		else
 413			symbol__fprintf_symname(al.sym, stdout);
 414	}
 415
 416	if (PRINT_FIELD(DSO)) {
 417		printf(" (");
 418		map__fprintf_dsoname(al.map, stdout);
 419		printf(")");
 420	}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 421}
 422
 423static void print_sample_bts(union perf_event *event,
 424			     struct perf_sample *sample,
 425			     struct perf_evsel *evsel,
 426			     struct thread *thread,
 427			     struct addr_location *al)
 428{
 429	struct perf_event_attr *attr = &evsel->attr;
 
 
 
 
 
 
 430
 431	/* print branch_from information */
 432	if (PRINT_FIELD(IP)) {
 433		if (!symbol_conf.use_callchain)
 434			printf(" ");
 435		else
 436			printf("\n");
 437		perf_evsel__print_ip(evsel, sample, al,
 438				     output[attr->type].print_ip_opts,
 439				     PERF_MAX_STACK_DEPTH);
 440	}
 
 
 
 
 
 
 
 
 441
 442	printf(" => ");
 
 
 443
 444	/* print branch_to information */
 445	if (PRINT_FIELD(ADDR) ||
 446	    ((evsel->attr.sample_type & PERF_SAMPLE_ADDR) &&
 447	     !output[attr->type].user_set))
 448		print_sample_addr(event, sample, al->machine, thread, attr);
 
 
 
 
 
 
 
 449
 450	printf("\n");
 
 
 
 
 
 
 
 
 
 
 451}
 452
 453static void process_event(union perf_event *event, struct perf_sample *sample,
 454			  struct perf_evsel *evsel, struct thread *thread,
 455			  struct addr_location *al)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 456{
 457	struct perf_event_attr *attr = &evsel->attr;
 458
 459	if (output[attr->type].fields == 0)
 460		return;
 
 
 461
 462	print_sample_start(sample, thread, evsel);
 
 463
 464	if (PRINT_FIELD(EVNAME)) {
 465		const char *evname = perf_evsel__name(evsel);
 466		printf("%s: ", evname ? evname : "[unknown]");
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 467	}
 468
 469	if (is_bts_event(attr)) {
 470		print_sample_bts(event, sample, evsel, thread, al);
 471		return;
 
 472	}
 473
 474	if (PRINT_FIELD(TRACE))
 475		event_format__print(evsel->tp_format, sample->cpu,
 476				    sample->raw_data, sample->raw_size);
 477	if (PRINT_FIELD(ADDR))
 478		print_sample_addr(event, sample, al->machine, thread, attr);
 
 
 
 
 479
 480	if (PRINT_FIELD(IP)) {
 481		if (!symbol_conf.use_callchain)
 482			printf(" ");
 483		else
 484			printf("\n");
 485
 486		perf_evsel__print_ip(evsel, sample, al,
 487				     output[attr->type].print_ip_opts,
 488				     PERF_MAX_STACK_DEPTH);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 489	}
 490
 491	printf("\n");
 492}
 493
 494static int default_start_script(const char *script __maybe_unused,
 495				int argc __maybe_unused,
 496				const char **argv __maybe_unused)
 497{
 498	return 0;
 
 
 
 
 
 
 
 
 499}
 500
 501static int default_stop_script(void)
 502{
 
 
 
 503	return 0;
 504}
 505
 506static int default_generate_script(struct pevent *pevent __maybe_unused,
 507				   const char *outfile __maybe_unused)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 508{
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 509	return 0;
 510}
 511
 512static struct scripting_ops default_scripting_ops = {
 513	.start_script		= default_start_script,
 514	.stop_script		= default_stop_script,
 515	.process_event		= process_event,
 516	.generate_script	= default_generate_script,
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 517};
 518
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 519static struct scripting_ops	*scripting_ops;
 520
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 521static void setup_scripting(void)
 522{
 523	setup_perl_scripting();
 524	setup_python_scripting();
 
 525
 526	scripting_ops = &default_scripting_ops;
 
 
 527}
 528
 529static int cleanup_scripting(void)
 530{
 531	pr_debug("\nperf script stopped\n");
 532
 533	return scripting_ops->stop_script();
 
 
 
 
 
 
 
 534}
 535
 536static int process_sample_event(struct perf_tool *tool __maybe_unused,
 537				union perf_event *event,
 538				struct perf_sample *sample,
 539				struct perf_evsel *evsel,
 540				struct machine *machine)
 541{
 
 542	struct addr_location al;
 543	struct thread *thread = machine__findnew_thread(machine, sample->pid,
 544							sample->tid);
 545
 546	if (thread == NULL) {
 547		pr_debug("problem processing %d event, skipping it.\n",
 548			 event->header.type);
 549		return -1;
 550	}
 551
 552	if (debug_mode) {
 553		if (sample->time < last_timestamp) {
 554			pr_err("Samples misordered, previous: %" PRIu64
 555				" this: %" PRIu64 "\n", last_timestamp,
 556				sample->time);
 557			nr_unordered++;
 558		}
 559		last_timestamp = sample->time;
 560		return 0;
 561	}
 562
 563	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
 564		pr_err("problem processing %d event, skipping it.\n",
 565		       event->header.type);
 566		return -1;
 567	}
 568
 569	if (al.filtered)
 570		return 0;
 571
 572	if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
 573		return 0;
 574
 575	scripting_ops->process_event(event, sample, evsel, thread, &al);
 
 
 
 576
 577	evsel->hists.stats.total_period += sample->period;
 
 578	return 0;
 579}
 580
 581struct perf_script {
 582	struct perf_tool	tool;
 583	struct perf_session	*session;
 584	bool			show_task_events;
 585	bool			show_mmap_events;
 586};
 587
 588static int process_attr(struct perf_tool *tool, union perf_event *event,
 589			struct perf_evlist **pevlist)
 590{
 591	struct perf_script *scr = container_of(tool, struct perf_script, tool);
 592	struct perf_evlist *evlist;
 593	struct perf_evsel *evsel, *pos;
 
 594	int err;
 
 595
 596	err = perf_event__process_attr(tool, event, pevlist);
 597	if (err)
 598		return err;
 599
 600	evlist = *pevlist;
 601	evsel = perf_evlist__last(*pevlist);
 602
 603	if (evsel->attr.type >= PERF_TYPE_MAX)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 604		return 0;
 605
 606	evlist__for_each(evlist, pos) {
 607		if (pos->attr.type == evsel->attr.type && pos != evsel)
 608			return 0;
 609	}
 610
 611	set_print_ip_opts(&evsel->attr);
 
 
 
 
 
 
 
 
 
 
 
 612
 613	return perf_evsel__check_attr(evsel, scr->session);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 614}
 615
 616static int process_comm_event(struct perf_tool *tool,
 617			      union perf_event *event,
 618			      struct perf_sample *sample,
 619			      struct machine *machine)
 
 620{
 621	struct thread *thread;
 622	struct perf_script *script = container_of(tool, struct perf_script, tool);
 623	struct perf_session *session = script->session;
 624	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
 625	int ret = -1;
 626
 627	thread = machine__findnew_thread(machine, event->comm.pid, event->comm.tid);
 628	if (thread == NULL) {
 629		pr_debug("problem processing COMM event, skipping it.\n");
 630		return -1;
 
 631	}
 632
 633	if (perf_event__process_comm(tool, event, sample, machine) < 0)
 634		goto out;
 635
 636	if (!evsel->attr.sample_id_all) {
 637		sample->cpu = 0;
 638		sample->time = 0;
 639		sample->tid = event->comm.tid;
 640		sample->pid = event->comm.pid;
 641	}
 642	print_sample_start(sample, thread, evsel);
 643	perf_event__fprintf(event, stdout);
 644	ret = 0;
 645
 646out:
 647	return ret;
 
 
 
 
 
 
 
 
 648}
 649
 650static int process_fork_event(struct perf_tool *tool,
 
 
 
 
 
 
 
 651			      union perf_event *event,
 652			      struct perf_sample *sample,
 653			      struct machine *machine)
 654{
 655	struct thread *thread;
 656	struct perf_script *script = container_of(tool, struct perf_script, tool);
 657	struct perf_session *session = script->session;
 658	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
 659
 660	if (perf_event__process_fork(tool, event, sample, machine) < 0)
 661		return -1;
 662
 663	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
 664	if (thread == NULL) {
 665		pr_debug("problem processing FORK event, skipping it.\n");
 
 
 
 
 
 
 
 666		return -1;
 667	}
 668
 669	if (!evsel->attr.sample_id_all) {
 670		sample->cpu = 0;
 671		sample->time = event->fork.time;
 672		sample->tid = event->fork.tid;
 673		sample->pid = event->fork.pid;
 674	}
 675	print_sample_start(sample, thread, evsel);
 676	perf_event__fprintf(event, stdout);
 677
 678	return 0;
 
 
 
 
 
 
 
 
 
 679}
 680static int process_exit_event(struct perf_tool *tool,
 
 681			      union perf_event *event,
 682			      struct perf_sample *sample,
 683			      struct machine *machine)
 684{
 685	struct thread *thread;
 686	struct perf_script *script = container_of(tool, struct perf_script, tool);
 687	struct perf_session *session = script->session;
 688	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
 689
 690	thread = machine__findnew_thread(machine, event->fork.pid, event->fork.tid);
 691	if (thread == NULL) {
 692		pr_debug("problem processing EXIT event, skipping it.\n");
 693		return -1;
 694	}
 695
 696	if (!evsel->attr.sample_id_all) {
 697		sample->cpu = 0;
 698		sample->time = 0;
 699		sample->tid = event->comm.tid;
 700		sample->pid = event->comm.pid;
 701	}
 702	print_sample_start(sample, thread, evsel);
 703	perf_event__fprintf(event, stdout);
 704
 705	if (perf_event__process_exit(tool, event, sample, machine) < 0)
 
 
 706		return -1;
 707
 708	return 0;
 709}
 710
 711static int process_mmap_event(struct perf_tool *tool,
 712			      union perf_event *event,
 713			      struct perf_sample *sample,
 714			      struct machine *machine)
 715{
 716	struct thread *thread;
 717	struct perf_script *script = container_of(tool, struct perf_script, tool);
 718	struct perf_session *session = script->session;
 719	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
 720
 721	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
 722		return -1;
 723
 724	thread = machine__findnew_thread(machine, event->mmap.pid, event->mmap.tid);
 725	if (thread == NULL) {
 726		pr_debug("problem processing MMAP event, skipping it.\n");
 727		return -1;
 728	}
 729
 730	if (!evsel->attr.sample_id_all) {
 731		sample->cpu = 0;
 732		sample->time = 0;
 733		sample->tid = event->mmap.tid;
 734		sample->pid = event->mmap.pid;
 735	}
 736	print_sample_start(sample, thread, evsel);
 737	perf_event__fprintf(event, stdout);
 738
 739	return 0;
 740}
 741
 742static int process_mmap2_event(struct perf_tool *tool,
 743			      union perf_event *event,
 744			      struct perf_sample *sample,
 745			      struct machine *machine)
 746{
 747	struct thread *thread;
 
 
 
 
 
 
 
 
 
 
 
 748	struct perf_script *script = container_of(tool, struct perf_script, tool);
 749	struct perf_session *session = script->session;
 750	struct perf_evsel *evsel = perf_evlist__first(session->evlist);
 751
 752	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
 753		return -1;
 754
 755	thread = machine__findnew_thread(machine, event->mmap2.pid, event->mmap2.tid);
 756	if (thread == NULL) {
 757		pr_debug("problem processing MMAP2 event, skipping it.\n");
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 758		return -1;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 759	}
 
 760
 761	if (!evsel->attr.sample_id_all) {
 762		sample->cpu = 0;
 763		sample->time = 0;
 764		sample->tid = event->mmap2.tid;
 765		sample->pid = event->mmap2.pid;
 
 
 
 
 
 
 
 
 
 
 
 
 
 766	}
 767	print_sample_start(sample, thread, evsel);
 768	perf_event__fprintf(event, stdout);
 769
 770	return 0;
 
 
 
 
 771}
 772
 773static void sig_handler(int sig __maybe_unused)
 774{
 775	session_done = 1;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 776}
 777
 778static int __cmd_script(struct perf_script *script)
 779{
 780	int ret;
 781
 782	signal(SIGINT, sig_handler);
 783
 
 
 784	/* override event processing functions */
 785	if (script->show_task_events) {
 786		script->tool.comm = process_comm_event;
 787		script->tool.fork = process_fork_event;
 788		script->tool.exit = process_exit_event;
 789	}
 790	if (script->show_mmap_events) {
 791		script->tool.mmap = process_mmap_event;
 792		script->tool.mmap2 = process_mmap2_event;
 793	}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 794
 795	ret = perf_session__process_events(script->session, &script->tool);
 
 
 
 796
 797	if (debug_mode)
 798		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
 799
 800	return ret;
 801}
 802
 803struct script_spec {
 804	struct list_head	node;
 805	struct scripting_ops	*ops;
 806	char			spec[0];
 807};
 808
 809static LIST_HEAD(script_specs);
 810
 811static struct script_spec *script_spec__new(const char *spec,
 812					    struct scripting_ops *ops)
 813{
 814	struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
 815
 816	if (s != NULL) {
 817		strcpy(s->spec, spec);
 818		s->ops = ops;
 819	}
 820
 821	return s;
 822}
 823
 824static void script_spec__add(struct script_spec *s)
 825{
 826	list_add_tail(&s->node, &script_specs);
 827}
 828
 829static struct script_spec *script_spec__find(const char *spec)
 830{
 831	struct script_spec *s;
 832
 833	list_for_each_entry(s, &script_specs, node)
 834		if (strcasecmp(s->spec, spec) == 0)
 835			return s;
 836	return NULL;
 837}
 838
 839static struct script_spec *script_spec__findnew(const char *spec,
 840						struct scripting_ops *ops)
 841{
 842	struct script_spec *s = script_spec__find(spec);
 843
 844	if (s)
 845		return s;
 846
 847	s = script_spec__new(spec, ops);
 848	if (!s)
 849		return NULL;
 850
 851	script_spec__add(s);
 852
 853	return s;
 854}
 855
 856int script_spec_register(const char *spec, struct scripting_ops *ops)
 857{
 858	struct script_spec *s;
 859
 860	s = script_spec__find(spec);
 861	if (s)
 862		return -1;
 863
 864	s = script_spec__findnew(spec, ops);
 865	if (!s)
 866		return -1;
 
 
 867
 868	return 0;
 869}
 870
 871static struct scripting_ops *script_spec__lookup(const char *spec)
 872{
 873	struct script_spec *s = script_spec__find(spec);
 874	if (!s)
 875		return NULL;
 876
 877	return s->ops;
 878}
 879
 880static void list_available_languages(void)
 881{
 882	struct script_spec *s;
 883
 884	fprintf(stderr, "\n");
 885	fprintf(stderr, "Scripting language extensions (used in "
 886		"perf script -s [spec:]script.[spec]):\n\n");
 887
 888	list_for_each_entry(s, &script_specs, node)
 889		fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);
 890
 891	fprintf(stderr, "\n");
 892}
 893
 894static int parse_scriptname(const struct option *opt __maybe_unused,
 895			    const char *str, int unset __maybe_unused)
 896{
 897	char spec[PATH_MAX];
 898	const char *script, *ext;
 899	int len;
 900
 901	if (strcmp(str, "lang") == 0) {
 902		list_available_languages();
 903		exit(0);
 904	}
 905
 906	script = strchr(str, ':');
 907	if (script) {
 908		len = script - str;
 909		if (len >= PATH_MAX) {
 910			fprintf(stderr, "invalid language specifier");
 911			return -1;
 912		}
 913		strncpy(spec, str, len);
 914		spec[len] = '\0';
 915		scripting_ops = script_spec__lookup(spec);
 916		if (!scripting_ops) {
 917			fprintf(stderr, "invalid language specifier");
 918			return -1;
 919		}
 920		script++;
 921	} else {
 922		script = str;
 923		ext = strrchr(script, '.');
 924		if (!ext) {
 925			fprintf(stderr, "invalid script extension");
 926			return -1;
 927		}
 928		scripting_ops = script_spec__lookup(++ext);
 929		if (!scripting_ops) {
 930			fprintf(stderr, "invalid script extension");
 931			return -1;
 932		}
 933	}
 934
 935	script_name = strdup(script);
 936
 937	return 0;
 938}
 939
 940static int parse_output_fields(const struct option *opt __maybe_unused,
 941			    const char *arg, int unset __maybe_unused)
 942{
 943	char *tok;
 944	int i, imax = ARRAY_SIZE(all_output_options);
 945	int j;
 946	int rc = 0;
 947	char *str = strdup(arg);
 948	int type = -1;
 
 949
 950	if (!str)
 951		return -ENOMEM;
 952
 953	/* first word can state for which event type the user is specifying
 954	 * the fields. If no type exists, the specified fields apply to all
 955	 * event types found in the file minus the invalid fields for a type.
 956	 */
 957	tok = strchr(str, ':');
 958	if (tok) {
 959		*tok = '\0';
 960		tok++;
 961		if (!strcmp(str, "hw"))
 962			type = PERF_TYPE_HARDWARE;
 963		else if (!strcmp(str, "sw"))
 964			type = PERF_TYPE_SOFTWARE;
 965		else if (!strcmp(str, "trace"))
 966			type = PERF_TYPE_TRACEPOINT;
 967		else if (!strcmp(str, "raw"))
 968			type = PERF_TYPE_RAW;
 
 
 
 
 969		else {
 970			fprintf(stderr, "Invalid event type in field string.\n");
 971			rc = -EINVAL;
 972			goto out;
 973		}
 974
 975		if (output[type].user_set)
 976			pr_warning("Overriding previous field request for %s events.\n",
 977				   event_type(type));
 978
 
 
 
 
 979		output[type].fields = 0;
 980		output[type].user_set = true;
 981		output[type].wildcard_set = false;
 982
 983	} else {
 984		tok = str;
 985		if (strlen(str) == 0) {
 986			fprintf(stderr,
 987				"Cannot set fields to 'none' for all event types.\n");
 988			rc = -EINVAL;
 989			goto out;
 990		}
 991
 
 
 
 
 992		if (output_set_by_user())
 993			pr_warning("Overriding previous field request for all events.\n");
 994
 995		for (j = 0; j < PERF_TYPE_MAX; ++j) {
 996			output[j].fields = 0;
 997			output[j].user_set = true;
 998			output[j].wildcard_set = true;
 999		}
1000	}
1001
1002	tok = strtok(tok, ",");
1003	while (tok) {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1004		for (i = 0; i < imax; ++i) {
1005			if (strcmp(tok, all_output_options[i].str) == 0)
1006				break;
1007		}
 
 
 
 
1008		if (i == imax) {
1009			fprintf(stderr, "Invalid field requested.\n");
1010			rc = -EINVAL;
1011			goto out;
1012		}
1013
1014		if (type == -1) {
1015			/* add user option to all events types for
1016			 * which it is valid
1017			 */
1018			for (j = 0; j < PERF_TYPE_MAX; ++j) {
1019				if (output[j].invalid_fields & all_output_options[i].field) {
1020					pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
1021						   all_output_options[i].str, event_type(j));
1022				} else
1023					output[j].fields |= all_output_options[i].field;
 
 
 
 
 
 
 
 
 
 
 
1024			}
1025		} else {
1026			if (output[type].invalid_fields & all_output_options[i].field) {
1027				fprintf(stderr, "\'%s\' not valid for %s events.\n",
1028					 all_output_options[i].str, event_type(type));
1029
1030				rc = -EINVAL;
1031				goto out;
1032			}
1033			output[type].fields |= all_output_options[i].field;
 
 
 
 
 
1034		}
1035
1036		tok = strtok(NULL, ",");
1037	}
1038
1039	if (type >= 0) {
1040		if (output[type].fields == 0) {
1041			pr_debug("No fields requested for %s type. "
1042				 "Events will not be displayed.\n", event_type(type));
1043		}
1044	}
 
1045
 
 
 
1046out:
1047	free(str);
1048	return rc;
1049}
1050
1051/* Helper function for filesystems that return a dent->d_type DT_UNKNOWN */
1052static int is_directory(const char *base_path, const struct dirent *dent)
1053{
1054	char path[PATH_MAX];
1055	struct stat st;
1056
1057	sprintf(path, "%s/%s", base_path, dent->d_name);
1058	if (stat(path, &st))
1059		return 0;
1060
1061	return S_ISDIR(st.st_mode);
1062}
1063
1064#define for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next)\
1065	while (!readdir_r(scripts_dir, &lang_dirent, &lang_next) &&	\
1066	       lang_next)						\
1067		if ((lang_dirent.d_type == DT_DIR ||			\
1068		     (lang_dirent.d_type == DT_UNKNOWN &&		\
1069		      is_directory(scripts_path, &lang_dirent))) &&	\
1070		    (strcmp(lang_dirent.d_name, ".")) &&		\
1071		    (strcmp(lang_dirent.d_name, "..")))
1072
1073#define for_each_script(lang_path, lang_dir, script_dirent, script_next)\
1074	while (!readdir_r(lang_dir, &script_dirent, &script_next) &&	\
1075	       script_next)						\
1076		if (script_dirent.d_type != DT_DIR &&			\
1077		    (script_dirent.d_type != DT_UNKNOWN ||		\
1078		     !is_directory(lang_path, &script_dirent)))
1079
1080
1081#define RECORD_SUFFIX			"-record"
1082#define REPORT_SUFFIX			"-report"
1083
1084struct script_desc {
1085	struct list_head	node;
1086	char			*name;
1087	char			*half_liner;
1088	char			*args;
1089};
1090
1091static LIST_HEAD(script_descs);
1092
1093static struct script_desc *script_desc__new(const char *name)
1094{
1095	struct script_desc *s = zalloc(sizeof(*s));
1096
1097	if (s != NULL && name)
1098		s->name = strdup(name);
1099
1100	return s;
1101}
1102
1103static void script_desc__delete(struct script_desc *s)
1104{
1105	zfree(&s->name);
1106	zfree(&s->half_liner);
1107	zfree(&s->args);
1108	free(s);
1109}
1110
1111static void script_desc__add(struct script_desc *s)
1112{
1113	list_add_tail(&s->node, &script_descs);
1114}
1115
1116static struct script_desc *script_desc__find(const char *name)
1117{
1118	struct script_desc *s;
1119
1120	list_for_each_entry(s, &script_descs, node)
1121		if (strcasecmp(s->name, name) == 0)
1122			return s;
1123	return NULL;
1124}
1125
1126static struct script_desc *script_desc__findnew(const char *name)
1127{
1128	struct script_desc *s = script_desc__find(name);
1129
1130	if (s)
1131		return s;
1132
1133	s = script_desc__new(name);
1134	if (!s)
1135		goto out_delete_desc;
1136
1137	script_desc__add(s);
1138
1139	return s;
1140
1141out_delete_desc:
1142	script_desc__delete(s);
1143
1144	return NULL;
1145}
1146
1147static const char *ends_with(const char *str, const char *suffix)
1148{
1149	size_t suffix_len = strlen(suffix);
1150	const char *p = str;
1151
1152	if (strlen(str) > suffix_len) {
1153		p = str + strlen(str) - suffix_len;
1154		if (!strncmp(p, suffix, suffix_len))
1155			return p;
1156	}
1157
1158	return NULL;
1159}
1160
1161static int read_script_info(struct script_desc *desc, const char *filename)
1162{
1163	char line[BUFSIZ], *p;
1164	FILE *fp;
1165
1166	fp = fopen(filename, "r");
1167	if (!fp)
1168		return -1;
1169
1170	while (fgets(line, sizeof(line), fp)) {
1171		p = ltrim(line);
1172		if (strlen(p) == 0)
1173			continue;
1174		if (*p != '#')
1175			continue;
1176		p++;
1177		if (strlen(p) && *p == '!')
1178			continue;
1179
1180		p = ltrim(p);
1181		if (strlen(p) && p[strlen(p) - 1] == '\n')
1182			p[strlen(p) - 1] = '\0';
1183
1184		if (!strncmp(p, "description:", strlen("description:"))) {
1185			p += strlen("description:");
1186			desc->half_liner = strdup(ltrim(p));
1187			continue;
1188		}
1189
1190		if (!strncmp(p, "args:", strlen("args:"))) {
1191			p += strlen("args:");
1192			desc->args = strdup(ltrim(p));
1193			continue;
1194		}
1195	}
1196
1197	fclose(fp);
1198
1199	return 0;
1200}
1201
1202static char *get_script_root(struct dirent *script_dirent, const char *suffix)
1203{
1204	char *script_root, *str;
1205
1206	script_root = strdup(script_dirent->d_name);
1207	if (!script_root)
1208		return NULL;
1209
1210	str = (char *)ends_with(script_root, suffix);
1211	if (!str) {
1212		free(script_root);
1213		return NULL;
1214	}
1215
1216	*str = '\0';
1217	return script_root;
1218}
1219
1220static int list_available_scripts(const struct option *opt __maybe_unused,
1221				  const char *s __maybe_unused,
1222				  int unset __maybe_unused)
1223{
1224	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1225	char scripts_path[MAXPATHLEN];
1226	DIR *scripts_dir, *lang_dir;
1227	char script_path[MAXPATHLEN];
1228	char lang_path[MAXPATHLEN];
1229	struct script_desc *desc;
1230	char first_half[BUFSIZ];
1231	char *script_root;
1232
1233	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1234
1235	scripts_dir = opendir(scripts_path);
1236	if (!scripts_dir)
1237		return -1;
 
 
 
 
 
1238
1239	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1240		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1241			 lang_dirent.d_name);
1242		lang_dir = opendir(lang_path);
1243		if (!lang_dir)
1244			continue;
1245
1246		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1247			script_root = get_script_root(&script_dirent, REPORT_SUFFIX);
1248			if (script_root) {
1249				desc = script_desc__findnew(script_root);
1250				snprintf(script_path, MAXPATHLEN, "%s/%s",
1251					 lang_path, script_dirent.d_name);
1252				read_script_info(desc, script_path);
1253				free(script_root);
1254			}
1255		}
1256	}
1257
1258	fprintf(stdout, "List of available trace scripts:\n");
1259	list_for_each_entry(desc, &script_descs, node) {
1260		sprintf(first_half, "%s %s", desc->name,
1261			desc->args ? desc->args : "");
1262		fprintf(stdout, "  %-36s %s\n", first_half,
1263			desc->half_liner ? desc->half_liner : "");
1264	}
1265
1266	exit(0);
1267}
1268
1269/*
1270 * Some scripts specify the required events in their "xxx-record" file,
1271 * this function will check if the events in perf.data match those
1272 * mentioned in the "xxx-record".
1273 *
1274 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
1275 * which is covered well now. And new parsing code should be added to
1276 * cover the future complexing formats like event groups etc.
1277 */
1278static int check_ev_match(char *dir_name, char *scriptname,
1279			struct perf_session *session)
1280{
1281	char filename[MAXPATHLEN], evname[128];
1282	char line[BUFSIZ], *p;
1283	struct perf_evsel *pos;
1284	int match, len;
1285	FILE *fp;
1286
1287	sprintf(filename, "%s/bin/%s-record", dir_name, scriptname);
1288
1289	fp = fopen(filename, "r");
1290	if (!fp)
1291		return -1;
1292
1293	while (fgets(line, sizeof(line), fp)) {
1294		p = ltrim(line);
1295		if (*p == '#')
1296			continue;
1297
1298		while (strlen(p)) {
1299			p = strstr(p, "-e");
1300			if (!p)
1301				break;
1302
1303			p += 2;
1304			p = ltrim(p);
1305			len = strcspn(p, " \t");
1306			if (!len)
1307				break;
1308
1309			snprintf(evname, len + 1, "%s", p);
1310
1311			match = 0;
1312			evlist__for_each(session->evlist, pos) {
1313				if (!strcmp(perf_evsel__name(pos), evname)) {
1314					match = 1;
1315					break;
1316				}
1317			}
1318
1319			if (!match) {
1320				fclose(fp);
1321				return -1;
1322			}
1323		}
1324	}
1325
1326	fclose(fp);
1327	return 0;
1328}
1329
1330/*
1331 * Return -1 if none is found, otherwise the actual scripts number.
1332 *
1333 * Currently the only user of this function is the script browser, which
1334 * will list all statically runnable scripts, select one, execute it and
1335 * show the output in a perf browser.
1336 */
1337int find_scripts(char **scripts_array, char **scripts_path_array)
 
1338{
1339	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1340	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
1341	DIR *scripts_dir, *lang_dir;
1342	struct perf_session *session;
1343	struct perf_data_file file = {
1344		.path = input_name,
1345		.mode = PERF_DATA_MODE_READ,
1346	};
1347	char *temp;
1348	int i = 0;
1349
1350	session = perf_session__new(&file, false, NULL);
1351	if (!session)
1352		return -1;
1353
1354	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1355
1356	scripts_dir = opendir(scripts_path);
1357	if (!scripts_dir) {
1358		perf_session__delete(session);
1359		return -1;
1360	}
1361
1362	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1363		snprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
1364			 lang_dirent.d_name);
1365#ifdef NO_LIBPERL
1366		if (strstr(lang_path, "perl"))
1367			continue;
1368#endif
1369#ifdef NO_LIBPYTHON
1370		if (strstr(lang_path, "python"))
1371			continue;
1372#endif
1373
1374		lang_dir = opendir(lang_path);
1375		if (!lang_dir)
1376			continue;
1377
1378		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1379			/* Skip those real time scripts: xxxtop.p[yl] */
1380			if (strstr(script_dirent.d_name, "top."))
1381				continue;
1382			sprintf(scripts_path_array[i], "%s/%s", lang_path,
1383				script_dirent.d_name);
1384			temp = strchr(script_dirent.d_name, '.');
 
 
 
1385			snprintf(scripts_array[i],
1386				(temp - script_dirent.d_name) + 1,
1387				"%s", script_dirent.d_name);
1388
1389			if (check_ev_match(lang_path,
1390					scripts_array[i], session))
1391				continue;
1392
1393			i++;
1394		}
1395		closedir(lang_dir);
1396	}
1397
1398	closedir(scripts_dir);
1399	perf_session__delete(session);
1400	return i;
1401}
1402
1403static char *get_script_path(const char *script_root, const char *suffix)
1404{
1405	struct dirent *script_next, *lang_next, script_dirent, lang_dirent;
1406	char scripts_path[MAXPATHLEN];
1407	char script_path[MAXPATHLEN];
1408	DIR *scripts_dir, *lang_dir;
1409	char lang_path[MAXPATHLEN];
1410	char *__script_root;
1411
1412	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", perf_exec_path());
1413
1414	scripts_dir = opendir(scripts_path);
1415	if (!scripts_dir)
1416		return NULL;
1417
1418	for_each_lang(scripts_path, scripts_dir, lang_dirent, lang_next) {
1419		snprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
1420			 lang_dirent.d_name);
1421		lang_dir = opendir(lang_path);
1422		if (!lang_dir)
1423			continue;
1424
1425		for_each_script(lang_path, lang_dir, script_dirent, script_next) {
1426			__script_root = get_script_root(&script_dirent, suffix);
1427			if (__script_root && !strcmp(script_root, __script_root)) {
1428				free(__script_root);
1429				closedir(lang_dir);
1430				closedir(scripts_dir);
1431				snprintf(script_path, MAXPATHLEN, "%s/%s",
1432					 lang_path, script_dirent.d_name);
 
1433				return strdup(script_path);
1434			}
1435			free(__script_root);
1436		}
1437		closedir(lang_dir);
1438	}
1439	closedir(scripts_dir);
1440
1441	return NULL;
1442}
1443
1444static bool is_top_script(const char *script_path)
1445{
1446	return ends_with(script_path, "top") == NULL ? false : true;
1447}
1448
1449static int has_required_arg(char *script_path)
1450{
1451	struct script_desc *desc;
1452	int n_args = 0;
1453	char *p;
1454
1455	desc = script_desc__new(NULL);
1456
1457	if (read_script_info(desc, script_path))
1458		goto out;
1459
1460	if (!desc->args)
1461		goto out;
1462
1463	for (p = desc->args; *p; p++)
1464		if (*p == '<')
1465			n_args++;
1466out:
1467	script_desc__delete(desc);
1468
1469	return n_args;
1470}
1471
1472static int have_cmd(int argc, const char **argv)
1473{
1474	char **__argv = malloc(sizeof(const char *) * argc);
1475
1476	if (!__argv) {
1477		pr_err("malloc failed\n");
1478		return -1;
1479	}
1480
1481	memcpy(__argv, argv, sizeof(const char *) * argc);
1482	argc = parse_options(argc, (const char **)__argv, record_options,
1483			     NULL, PARSE_OPT_STOP_AT_NON_OPTION);
1484	free(__argv);
1485
1486	system_wide = (argc == 0);
1487
1488	return 0;
1489}
1490
1491int cmd_script(int argc, const char **argv, const char *prefix __maybe_unused)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1492{
1493	bool show_full_info = false;
1494	bool header = false;
1495	bool header_only = false;
 
1496	char *rec_script_path = NULL;
1497	char *rep_script_path = NULL;
1498	struct perf_session *session;
 
 
 
 
 
1499	char *script_path = NULL;
1500	const char **__argv;
1501	int i, j, err;
1502	struct perf_script script = {
1503		.tool = {
1504			.sample		 = process_sample_event,
1505			.mmap		 = perf_event__process_mmap,
1506			.mmap2		 = perf_event__process_mmap2,
1507			.comm		 = perf_event__process_comm,
 
 
1508			.exit		 = perf_event__process_exit,
1509			.fork		 = perf_event__process_fork,
1510			.attr		 = process_attr,
 
1511			.tracing_data	 = perf_event__process_tracing_data,
 
1512			.build_id	 = perf_event__process_build_id,
1513			.ordered_samples = true,
 
 
 
 
 
 
 
 
 
1514			.ordering_requires_timestamps = true,
1515		},
1516	};
 
 
 
1517	const struct option options[] = {
1518	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1519		    "dump raw trace in ASCII"),
1520	OPT_INCR('v', "verbose", &verbose,
1521		 "be more verbose (show symbol address, etc)"),
1522	OPT_BOOLEAN('L', "Latency", &latency_format,
1523		    "show latency attributes (irqs/preemption disabled, etc)"),
1524	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
1525			   list_available_scripts),
1526	OPT_CALLBACK('s', "script", NULL, "name",
1527		     "script file name (lang:script name, script name, or *)",
1528		     parse_scriptname),
1529	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
1530		   "generate perf-script.xx script in specified language"),
1531	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1532	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
1533		   "do various checks like samples ordering and lost events"),
1534	OPT_BOOLEAN(0, "header", &header, "Show data header."),
1535	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
1536	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1537		   "file", "vmlinux pathname"),
1538	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1539		   "file", "kallsyms pathname"),
1540	OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
1541		    "When printing symbols do not display call chain"),
1542	OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
1543		    "Look for files with symbols relative to this directory"),
1544	OPT_CALLBACK('f', "fields", NULL, "str",
 
1545		     "comma separated output fields prepend with 'type:'. "
1546		     "Valid types: hw,sw,trace,raw. "
 
1547		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
1548		     "addr,symoff", parse_output_fields),
 
 
 
1549	OPT_BOOLEAN('a', "all-cpus", &system_wide,
1550		    "system-wide collection from all CPUs"),
1551	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1552		   "only consider these symbols"),
 
 
 
 
 
 
 
 
 
 
 
 
1553	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
1554	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1555		   "only display events for these comms"),
 
 
 
 
 
 
 
 
 
 
1556	OPT_BOOLEAN('I', "show-info", &show_full_info,
1557		    "display extended information from perf.data file"),
1558	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
1559		    "Show the path of [kernel.kallsyms]"),
1560	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
1561		    "Show the fork/comm/exit events"),
1562	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
1563		    "Show the mmap events"),
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1564	OPT_END()
1565	};
1566	const char * const script_usage[] = {
 
1567		"perf script [<options>]",
1568		"perf script [<options>] record <script> [<record-options>] <command>",
1569		"perf script [<options>] report <script> [script-args]",
1570		"perf script [<options>] <script> [<record-options>] <command>",
1571		"perf script [<options>] <top-script> [script-args]",
1572		NULL
1573	};
1574	struct perf_data_file file = {
1575		.mode = PERF_DATA_MODE_READ,
1576	};
1577
1578	setup_scripting();
1579
1580	argc = parse_options(argc, argv, options, script_usage,
1581			     PARSE_OPT_STOP_AT_NON_OPTION);
1582
1583	file.path = input_name;
 
 
 
 
 
 
 
 
 
 
 
1584
1585	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
1586		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
1587		if (!rec_script_path)
1588			return cmd_record(argc, argv, NULL);
1589	}
1590
1591	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
1592		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
1593		if (!rep_script_path) {
1594			fprintf(stderr,
1595				"Please specify a valid report script"
1596				"(see 'perf script -l' for listing)\n");
1597			return -1;
1598		}
1599	}
1600
 
 
 
 
 
 
 
 
 
 
 
1601	/* make sure PERF_EXEC_PATH is set for scripts */
1602	perf_set_argv_exec_path(perf_exec_path());
1603
1604	if (argc && !script_name && !rec_script_path && !rep_script_path) {
1605		int live_pipe[2];
1606		int rep_args;
1607		pid_t pid;
1608
1609		rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
1610		rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
1611
1612		if (!rec_script_path && !rep_script_path) {
1613			fprintf(stderr, " Couldn't find script %s\n\n See perf"
 
1614				" script -l for available scripts.\n", argv[0]);
1615			usage_with_options(script_usage, options);
1616		}
1617
1618		if (is_top_script(argv[0])) {
1619			rep_args = argc - 1;
1620		} else {
1621			int rec_args;
1622
1623			rep_args = has_required_arg(rep_script_path);
1624			rec_args = (argc - 1) - rep_args;
1625			if (rec_args < 0) {
1626				fprintf(stderr, " %s script requires options."
 
1627					"\n\n See perf script -l for available "
1628					"scripts and options.\n", argv[0]);
1629				usage_with_options(script_usage, options);
1630			}
1631		}
1632
1633		if (pipe(live_pipe) < 0) {
1634			perror("failed to create pipe");
1635			return -1;
1636		}
1637
1638		pid = fork();
1639		if (pid < 0) {
1640			perror("failed to fork");
1641			return -1;
1642		}
1643
1644		if (!pid) {
1645			j = 0;
1646
1647			dup2(live_pipe[1], 1);
1648			close(live_pipe[0]);
1649
1650			if (is_top_script(argv[0])) {
1651				system_wide = true;
1652			} else if (!system_wide) {
1653				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
1654					err = -1;
1655					goto out;
1656				}
1657			}
1658
1659			__argv = malloc((argc + 6) * sizeof(const char *));
1660			if (!__argv) {
1661				pr_err("malloc failed\n");
1662				err = -ENOMEM;
1663				goto out;
1664			}
1665
1666			__argv[j++] = "/bin/sh";
1667			__argv[j++] = rec_script_path;
1668			if (system_wide)
1669				__argv[j++] = "-a";
1670			__argv[j++] = "-q";
1671			__argv[j++] = "-o";
1672			__argv[j++] = "-";
1673			for (i = rep_args + 1; i < argc; i++)
1674				__argv[j++] = argv[i];
1675			__argv[j++] = NULL;
1676
1677			execvp("/bin/sh", (char **)__argv);
1678			free(__argv);
1679			exit(-1);
1680		}
1681
1682		dup2(live_pipe[0], 0);
1683		close(live_pipe[1]);
1684
1685		__argv = malloc((argc + 4) * sizeof(const char *));
1686		if (!__argv) {
1687			pr_err("malloc failed\n");
1688			err = -ENOMEM;
1689			goto out;
1690		}
1691
1692		j = 0;
1693		__argv[j++] = "/bin/sh";
1694		__argv[j++] = rep_script_path;
1695		for (i = 1; i < rep_args + 1; i++)
1696			__argv[j++] = argv[i];
1697		__argv[j++] = "-i";
1698		__argv[j++] = "-";
1699		__argv[j++] = NULL;
1700
1701		execvp("/bin/sh", (char **)__argv);
1702		free(__argv);
1703		exit(-1);
1704	}
1705
1706	if (rec_script_path)
1707		script_path = rec_script_path;
1708	if (rep_script_path)
1709		script_path = rep_script_path;
1710
1711	if (script_path) {
1712		j = 0;
1713
1714		if (!rec_script_path)
1715			system_wide = false;
1716		else if (!system_wide) {
1717			if (have_cmd(argc - 1, &argv[1]) != 0) {
1718				err = -1;
1719				goto out;
1720			}
1721		}
1722
1723		__argv = malloc((argc + 2) * sizeof(const char *));
1724		if (!__argv) {
1725			pr_err("malloc failed\n");
1726			err = -ENOMEM;
1727			goto out;
1728		}
1729
1730		__argv[j++] = "/bin/sh";
1731		__argv[j++] = script_path;
1732		if (system_wide)
1733			__argv[j++] = "-a";
1734		for (i = 2; i < argc; i++)
1735			__argv[j++] = argv[i];
1736		__argv[j++] = NULL;
1737
1738		execvp("/bin/sh", (char **)__argv);
1739		free(__argv);
1740		exit(-1);
1741	}
1742
1743	if (symbol__init() < 0)
1744		return -1;
1745	if (!script_name)
1746		setup_pager();
 
 
1747
1748	session = perf_session__new(&file, false, &script.tool);
1749	if (session == NULL)
1750		return -ENOMEM;
1751
1752	if (header || header_only) {
 
1753		perf_session__fprintf_info(session, stdout, show_full_info);
1754		if (header_only)
1755			return 0;
1756	}
 
 
 
 
 
 
 
 
 
 
 
 
1757
1758	script.session = session;
 
 
 
 
 
 
 
1759
1760	if (cpu_list) {
1761		if (perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap))
1762			return -1;
 
 
1763	}
1764
1765	if (!no_callchain)
1766		symbol_conf.use_callchain = true;
1767	else
1768		symbol_conf.use_callchain = false;
1769
 
 
 
 
 
 
 
 
 
1770	if (generate_script_lang) {
1771		struct stat perf_stat;
1772		int input;
1773
1774		if (output_set_by_user()) {
1775			fprintf(stderr,
1776				"custom fields not supported for generated scripts");
1777			return -1;
 
1778		}
1779
1780		input = open(file.path, O_RDONLY);	/* input_name */
1781		if (input < 0) {
 
1782			perror("failed to open file");
1783			return -1;
1784		}
1785
1786		err = fstat(input, &perf_stat);
1787		if (err < 0) {
1788			perror("failed to stat file");
1789			return -1;
1790		}
1791
1792		if (!perf_stat.st_size) {
1793			fprintf(stderr, "zero-sized file, nothing to do!\n");
1794			return 0;
1795		}
1796
1797		scripting_ops = script_spec__lookup(generate_script_lang);
1798		if (!scripting_ops) {
1799			fprintf(stderr, "invalid language specifier");
1800			return -1;
 
1801		}
1802
1803		err = scripting_ops->generate_script(session->tevent.pevent,
1804						     "perf-script");
1805		goto out;
1806	}
1807
1808	if (script_name) {
1809		err = scripting_ops->start_script(script_name, argc, argv);
1810		if (err)
1811			goto out;
1812		pr_debug("perf script started with script %s\n\n", script_name);
 
1813	}
1814
1815
1816	err = perf_session__check_output_opt(session);
1817	if (err < 0)
1818		goto out;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1819
1820	err = __cmd_script(&script);
1821
 
 
 
 
 
 
 
 
 
1822	perf_session__delete(session);
1823	cleanup_scripting();
 
 
1824out:
1825	return err;
1826}
v5.9
   1// SPDX-License-Identifier: GPL-2.0
   2#include "builtin.h"
   3
   4#include "util/counts.h"
 
   5#include "util/debug.h"
   6#include "util/dso.h"
   7#include <subcmd/exec-cmd.h>
   8#include "util/header.h"
   9#include <subcmd/parse-options.h>
  10#include "util/perf_regs.h"
  11#include "util/session.h"
  12#include "util/tool.h"
  13#include "util/map.h"
  14#include "util/srcline.h"
  15#include "util/symbol.h"
  16#include "util/thread.h"
  17#include "util/trace-event.h"
 
  18#include "util/evlist.h"
  19#include "util/evsel.h"
  20#include "util/evsel_fprintf.h"
  21#include "util/evswitch.h"
  22#include "util/sort.h"
  23#include "util/data.h"
  24#include "util/auxtrace.h"
  25#include "util/cpumap.h"
  26#include "util/thread_map.h"
  27#include "util/stat.h"
  28#include "util/color.h"
  29#include "util/string2.h"
  30#include "util/thread-stack.h"
  31#include "util/time-utils.h"
  32#include "util/path.h"
  33#include "ui/ui.h"
  34#include "print_binary.h"
  35#include "archinsn.h"
  36#include <linux/bitmap.h>
  37#include <linux/kernel.h>
  38#include <linux/stringify.h>
  39#include <linux/time64.h>
  40#include <linux/zalloc.h>
  41#include <sys/utsname.h>
  42#include "asm/bug.h"
  43#include "util/mem-events.h"
  44#include "util/dump-insn.h"
  45#include <dirent.h>
  46#include <errno.h>
  47#include <inttypes.h>
  48#include <signal.h>
  49#include <sys/param.h>
  50#include <sys/types.h>
  51#include <sys/stat.h>
  52#include <fcntl.h>
  53#include <unistd.h>
  54#include <subcmd/pager.h>
  55#include <perf/evlist.h>
  56#include <linux/err.h>
  57#include "util/record.h"
  58#include "util/util.h"
  59#include "perf.h"
  60
  61#include <linux/ctype.h>
  62
  63static char const		*script_name;
  64static char const		*generate_script_lang;
  65static bool			reltime;
  66static bool			deltatime;
  67static u64			initial_time;
  68static u64			previous_time;
  69static bool			debug_mode;
  70static u64			last_timestamp;
  71static u64			nr_unordered;
 
  72static bool			no_callchain;
  73static bool			latency_format;
  74static bool			system_wide;
  75static bool			print_flags;
  76static const char		*cpu_list;
  77static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  78static struct perf_stat_config	stat_config;
  79static int			max_blocks;
  80static bool			native_arch;
  81
  82unsigned int scripting_max_stack = PERF_MAX_STACK_DEPTH;
  83
  84enum perf_output_field {
  85	PERF_OUTPUT_COMM            = 1ULL << 0,
  86	PERF_OUTPUT_TID             = 1ULL << 1,
  87	PERF_OUTPUT_PID             = 1ULL << 2,
  88	PERF_OUTPUT_TIME            = 1ULL << 3,
  89	PERF_OUTPUT_CPU             = 1ULL << 4,
  90	PERF_OUTPUT_EVNAME          = 1ULL << 5,
  91	PERF_OUTPUT_TRACE           = 1ULL << 6,
  92	PERF_OUTPUT_IP              = 1ULL << 7,
  93	PERF_OUTPUT_SYM             = 1ULL << 8,
  94	PERF_OUTPUT_DSO             = 1ULL << 9,
  95	PERF_OUTPUT_ADDR            = 1ULL << 10,
  96	PERF_OUTPUT_SYMOFFSET       = 1ULL << 11,
  97	PERF_OUTPUT_SRCLINE         = 1ULL << 12,
  98	PERF_OUTPUT_PERIOD          = 1ULL << 13,
  99	PERF_OUTPUT_IREGS	    = 1ULL << 14,
 100	PERF_OUTPUT_BRSTACK	    = 1ULL << 15,
 101	PERF_OUTPUT_BRSTACKSYM	    = 1ULL << 16,
 102	PERF_OUTPUT_DATA_SRC	    = 1ULL << 17,
 103	PERF_OUTPUT_WEIGHT	    = 1ULL << 18,
 104	PERF_OUTPUT_BPF_OUTPUT	    = 1ULL << 19,
 105	PERF_OUTPUT_CALLINDENT	    = 1ULL << 20,
 106	PERF_OUTPUT_INSN	    = 1ULL << 21,
 107	PERF_OUTPUT_INSNLEN	    = 1ULL << 22,
 108	PERF_OUTPUT_BRSTACKINSN	    = 1ULL << 23,
 109	PERF_OUTPUT_BRSTACKOFF	    = 1ULL << 24,
 110	PERF_OUTPUT_SYNTH           = 1ULL << 25,
 111	PERF_OUTPUT_PHYS_ADDR       = 1ULL << 26,
 112	PERF_OUTPUT_UREGS	    = 1ULL << 27,
 113	PERF_OUTPUT_METRIC	    = 1ULL << 28,
 114	PERF_OUTPUT_MISC            = 1ULL << 29,
 115	PERF_OUTPUT_SRCCODE	    = 1ULL << 30,
 116	PERF_OUTPUT_IPC             = 1ULL << 31,
 117	PERF_OUTPUT_TOD             = 1ULL << 32,
 118};
 119
 120struct perf_script {
 121	struct perf_tool	tool;
 122	struct perf_session	*session;
 123	bool			show_task_events;
 124	bool			show_mmap_events;
 125	bool			show_switch_events;
 126	bool			show_namespace_events;
 127	bool			show_lost_events;
 128	bool			show_round_events;
 129	bool			show_bpf_events;
 130	bool			show_cgroup_events;
 131	bool			show_text_poke_events;
 132	bool			allocated;
 133	bool			per_event_dump;
 134	bool			stitch_lbr;
 135	struct evswitch		evswitch;
 136	struct perf_cpu_map	*cpus;
 137	struct perf_thread_map *threads;
 138	int			name_width;
 139	const char              *time_str;
 140	struct perf_time_interval *ptime_range;
 141	int			range_size;
 142	int			range_num;
 143};
 144
 145struct output_option {
 146	const char *str;
 147	enum perf_output_field field;
 148} all_output_options[] = {
 149	{.str = "comm",  .field = PERF_OUTPUT_COMM},
 150	{.str = "tid",   .field = PERF_OUTPUT_TID},
 151	{.str = "pid",   .field = PERF_OUTPUT_PID},
 152	{.str = "time",  .field = PERF_OUTPUT_TIME},
 153	{.str = "cpu",   .field = PERF_OUTPUT_CPU},
 154	{.str = "event", .field = PERF_OUTPUT_EVNAME},
 155	{.str = "trace", .field = PERF_OUTPUT_TRACE},
 156	{.str = "ip",    .field = PERF_OUTPUT_IP},
 157	{.str = "sym",   .field = PERF_OUTPUT_SYM},
 158	{.str = "dso",   .field = PERF_OUTPUT_DSO},
 159	{.str = "addr",  .field = PERF_OUTPUT_ADDR},
 160	{.str = "symoff", .field = PERF_OUTPUT_SYMOFFSET},
 161	{.str = "srcline", .field = PERF_OUTPUT_SRCLINE},
 162	{.str = "period", .field = PERF_OUTPUT_PERIOD},
 163	{.str = "iregs", .field = PERF_OUTPUT_IREGS},
 164	{.str = "uregs", .field = PERF_OUTPUT_UREGS},
 165	{.str = "brstack", .field = PERF_OUTPUT_BRSTACK},
 166	{.str = "brstacksym", .field = PERF_OUTPUT_BRSTACKSYM},
 167	{.str = "data_src", .field = PERF_OUTPUT_DATA_SRC},
 168	{.str = "weight",   .field = PERF_OUTPUT_WEIGHT},
 169	{.str = "bpf-output",   .field = PERF_OUTPUT_BPF_OUTPUT},
 170	{.str = "callindent", .field = PERF_OUTPUT_CALLINDENT},
 171	{.str = "insn", .field = PERF_OUTPUT_INSN},
 172	{.str = "insnlen", .field = PERF_OUTPUT_INSNLEN},
 173	{.str = "brstackinsn", .field = PERF_OUTPUT_BRSTACKINSN},
 174	{.str = "brstackoff", .field = PERF_OUTPUT_BRSTACKOFF},
 175	{.str = "synth", .field = PERF_OUTPUT_SYNTH},
 176	{.str = "phys_addr", .field = PERF_OUTPUT_PHYS_ADDR},
 177	{.str = "metric", .field = PERF_OUTPUT_METRIC},
 178	{.str = "misc", .field = PERF_OUTPUT_MISC},
 179	{.str = "srccode", .field = PERF_OUTPUT_SRCCODE},
 180	{.str = "ipc", .field = PERF_OUTPUT_IPC},
 181	{.str = "tod", .field = PERF_OUTPUT_TOD},
 182};
 183
 184enum {
 185	OUTPUT_TYPE_SYNTH = PERF_TYPE_MAX,
 186	OUTPUT_TYPE_MAX
 187};
 188
 189/* default set to maintain compatibility with current format */
 190static struct {
 191	bool user_set;
 192	bool wildcard_set;
 193	unsigned int print_ip_opts;
 194	u64 fields;
 195	u64 invalid_fields;
 196	u64 user_set_fields;
 197	u64 user_unset_fields;
 198} output[OUTPUT_TYPE_MAX] = {
 199
 200	[PERF_TYPE_HARDWARE] = {
 201		.user_set = false,
 202
 203		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 204			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 205			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 206			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 207			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 208
 209		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 210	},
 211
 212	[PERF_TYPE_SOFTWARE] = {
 213		.user_set = false,
 214
 215		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 216			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 217			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 218			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 219			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
 220			      PERF_OUTPUT_BPF_OUTPUT,
 221
 222		.invalid_fields = PERF_OUTPUT_TRACE,
 223	},
 224
 225	[PERF_TYPE_TRACEPOINT] = {
 226		.user_set = false,
 227
 228		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 229				  PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 230				  PERF_OUTPUT_EVNAME | PERF_OUTPUT_TRACE
 231	},
 232
 233	[PERF_TYPE_HW_CACHE] = {
 234		.user_set = false,
 235
 236		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 237			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 238			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 239			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 240			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 241
 242		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 243	},
 244
 245	[PERF_TYPE_RAW] = {
 246		.user_set = false,
 247
 248		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 249			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 250			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 251			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 252			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD |
 253			      PERF_OUTPUT_ADDR | PERF_OUTPUT_DATA_SRC |
 254			      PERF_OUTPUT_WEIGHT | PERF_OUTPUT_PHYS_ADDR,
 255
 256		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 257	},
 258
 259	[PERF_TYPE_BREAKPOINT] = {
 260		.user_set = false,
 261
 262		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 263			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 264			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 265			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 266			      PERF_OUTPUT_DSO | PERF_OUTPUT_PERIOD,
 267
 268		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 269	},
 270
 271	[OUTPUT_TYPE_SYNTH] = {
 272		.user_set = false,
 273
 274		.fields = PERF_OUTPUT_COMM | PERF_OUTPUT_TID |
 275			      PERF_OUTPUT_CPU | PERF_OUTPUT_TIME |
 276			      PERF_OUTPUT_EVNAME | PERF_OUTPUT_IP |
 277			      PERF_OUTPUT_SYM | PERF_OUTPUT_SYMOFFSET |
 278			      PERF_OUTPUT_DSO | PERF_OUTPUT_SYNTH,
 279
 280		.invalid_fields = PERF_OUTPUT_TRACE | PERF_OUTPUT_BPF_OUTPUT,
 281	},
 282};
 283
 284struct evsel_script {
 285       char *filename;
 286       FILE *fp;
 287       u64  samples;
 288       /* For metric output */
 289       u64  val;
 290       int  gnum;
 291};
 292
 293static inline struct evsel_script *evsel_script(struct evsel *evsel)
 294{
 295	return (struct evsel_script *)evsel->priv;
 296}
 297
 298static struct evsel_script *perf_evsel_script__new(struct evsel *evsel,
 299							struct perf_data *data)
 300{
 301	struct evsel_script *es = zalloc(sizeof(*es));
 302
 303	if (es != NULL) {
 304		if (asprintf(&es->filename, "%s.%s.dump", data->file.path, evsel__name(evsel)) < 0)
 305			goto out_free;
 306		es->fp = fopen(es->filename, "w");
 307		if (es->fp == NULL)
 308			goto out_free_filename;
 309	}
 310
 311	return es;
 312out_free_filename:
 313	zfree(&es->filename);
 314out_free:
 315	free(es);
 316	return NULL;
 317}
 318
 319static void perf_evsel_script__delete(struct evsel_script *es)
 320{
 321	zfree(&es->filename);
 322	fclose(es->fp);
 323	es->fp = NULL;
 324	free(es);
 325}
 326
 327static int perf_evsel_script__fprintf(struct evsel_script *es, FILE *fp)
 328{
 329	struct stat st;
 330
 331	fstat(fileno(es->fp), &st);
 332	return fprintf(fp, "[ perf script: Wrote %.3f MB %s (%" PRIu64 " samples) ]\n",
 333		       st.st_size / 1024.0 / 1024.0, es->filename, es->samples);
 334}
 335
 336static inline int output_type(unsigned int type)
 337{
 338	switch (type) {
 339	case PERF_TYPE_SYNTH:
 340		return OUTPUT_TYPE_SYNTH;
 341	default:
 342		return type;
 343	}
 344}
 345
 346static inline unsigned int attr_type(unsigned int type)
 347{
 348	switch (type) {
 349	case OUTPUT_TYPE_SYNTH:
 350		return PERF_TYPE_SYNTH;
 351	default:
 352		return type;
 353	}
 354}
 355
 356static bool output_set_by_user(void)
 357{
 358	int j;
 359	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
 360		if (output[j].user_set)
 361			return true;
 362	}
 363	return false;
 364}
 365
 366static const char *output_field2str(enum perf_output_field field)
 367{
 368	int i, imax = ARRAY_SIZE(all_output_options);
 369	const char *str = "";
 370
 371	for (i = 0; i < imax; ++i) {
 372		if (all_output_options[i].field == field) {
 373			str = all_output_options[i].str;
 374			break;
 375		}
 376	}
 377	return str;
 378}
 379
 380#define PRINT_FIELD(x)  (output[output_type(attr->type)].fields & PERF_OUTPUT_##x)
 381
 382static int evsel__do_check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
 383				 enum perf_output_field field, bool allow_user_set)
 
 384{
 385	struct perf_event_attr *attr = &evsel->core.attr;
 386	int type = output_type(attr->type);
 387	const char *evname;
 388
 389	if (attr->sample_type & sample_type)
 390		return 0;
 391
 392	if (output[type].user_set_fields & field) {
 393		if (allow_user_set)
 394			return 0;
 395		evname = evsel__name(evsel);
 396		pr_err("Samples for '%s' event do not have %s attribute set. "
 397		       "Cannot print '%s' field.\n",
 398		       evname, sample_msg, output_field2str(field));
 399		return -1;
 400	}
 401
 402	/* user did not ask for it explicitly so remove from the default list */
 403	output[type].fields &= ~field;
 404	evname = evsel__name(evsel);
 405	pr_debug("Samples for '%s' event do not have %s attribute set. "
 406		 "Skipping '%s' field.\n",
 407		 evname, sample_msg, output_field2str(field));
 408
 409	return 0;
 410}
 411
 412static int evsel__check_stype(struct evsel *evsel, u64 sample_type, const char *sample_msg,
 413			      enum perf_output_field field)
 414{
 415	return evsel__do_check_stype(evsel, sample_type, sample_msg, field, false);
 416}
 417
 418static int evsel__check_attr(struct evsel *evsel, struct perf_session *session)
 419{
 420	struct perf_event_attr *attr = &evsel->core.attr;
 421	bool allow_user_set;
 422
 423	if (perf_header__has_feat(&session->header, HEADER_STAT))
 424		return 0;
 425
 426	allow_user_set = perf_header__has_feat(&session->header,
 427					       HEADER_AUXTRACE);
 428
 429	if (PRINT_FIELD(TRACE) &&
 430	    !perf_session__has_traces(session, "record -R"))
 431		return -EINVAL;
 432
 433	if (PRINT_FIELD(IP)) {
 434		if (evsel__check_stype(evsel, PERF_SAMPLE_IP, "IP", PERF_OUTPUT_IP))
 
 435			return -EINVAL;
 
 
 
 
 436	}
 437
 438	if (PRINT_FIELD(ADDR) &&
 439	    evsel__do_check_stype(evsel, PERF_SAMPLE_ADDR, "ADDR", PERF_OUTPUT_ADDR, allow_user_set))
 
 440		return -EINVAL;
 441
 442	if (PRINT_FIELD(DATA_SRC) &&
 443	    evsel__check_stype(evsel, PERF_SAMPLE_DATA_SRC, "DATA_SRC", PERF_OUTPUT_DATA_SRC))
 444		return -EINVAL;
 445
 446	if (PRINT_FIELD(WEIGHT) &&
 447	    evsel__check_stype(evsel, PERF_SAMPLE_WEIGHT, "WEIGHT", PERF_OUTPUT_WEIGHT))
 448		return -EINVAL;
 449
 450	if (PRINT_FIELD(SYM) &&
 451	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
 452		pr_err("Display of symbols requested but neither sample IP nor "
 453			   "sample address\navailable. Hence, no addresses to convert "
 454		       "to symbols.\n");
 455		return -EINVAL;
 456	}
 457	if (PRINT_FIELD(SYMOFFSET) && !PRINT_FIELD(SYM)) {
 458		pr_err("Display of offsets requested but symbol is not"
 459		       "selected.\n");
 460		return -EINVAL;
 461	}
 462	if (PRINT_FIELD(DSO) &&
 463	    !(evsel->core.attr.sample_type & (PERF_SAMPLE_IP|PERF_SAMPLE_ADDR))) {
 464		pr_err("Display of DSO requested but no address to convert.\n");
 
 465		return -EINVAL;
 466	}
 467	if ((PRINT_FIELD(SRCLINE) || PRINT_FIELD(SRCCODE)) && !PRINT_FIELD(IP)) {
 468		pr_err("Display of source line number requested but sample IP is not\n"
 469		       "selected. Hence, no address to lookup the source line number.\n");
 470		return -EINVAL;
 471	}
 472	if (PRINT_FIELD(BRSTACKINSN) && !allow_user_set &&
 473	    !(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) {
 474		pr_err("Display of branch stack assembler requested, but non all-branch filter set\n"
 475		       "Hint: run 'perf record -b ...'\n");
 476		return -EINVAL;
 477	}
 478	if ((PRINT_FIELD(PID) || PRINT_FIELD(TID)) &&
 479	    evsel__check_stype(evsel, PERF_SAMPLE_TID, "TID", PERF_OUTPUT_TID|PERF_OUTPUT_PID))
 
 480		return -EINVAL;
 481
 482	if (PRINT_FIELD(TIME) &&
 483	    evsel__check_stype(evsel, PERF_SAMPLE_TIME, "TIME", PERF_OUTPUT_TIME))
 
 484		return -EINVAL;
 485
 486	if (PRINT_FIELD(CPU) &&
 487	    evsel__do_check_stype(evsel, PERF_SAMPLE_CPU, "CPU", PERF_OUTPUT_CPU, allow_user_set))
 488		return -EINVAL;
 489
 490	if (PRINT_FIELD(IREGS) &&
 491	    evsel__do_check_stype(evsel, PERF_SAMPLE_REGS_INTR, "IREGS", PERF_OUTPUT_IREGS, allow_user_set))
 492		return -EINVAL;
 493
 494	if (PRINT_FIELD(UREGS) &&
 495	    evsel__check_stype(evsel, PERF_SAMPLE_REGS_USER, "UREGS", PERF_OUTPUT_UREGS))
 496		return -EINVAL;
 497
 498	if (PRINT_FIELD(PHYS_ADDR) &&
 499	    evsel__check_stype(evsel, PERF_SAMPLE_PHYS_ADDR, "PHYS_ADDR", PERF_OUTPUT_PHYS_ADDR))
 500		return -EINVAL;
 501
 502	return 0;
 503}
 504
 505static void set_print_ip_opts(struct perf_event_attr *attr)
 506{
 507	unsigned int type = output_type(attr->type);
 508
 509	output[type].print_ip_opts = 0;
 510	if (PRINT_FIELD(IP))
 511		output[type].print_ip_opts |= EVSEL__PRINT_IP;
 512
 513	if (PRINT_FIELD(SYM))
 514		output[type].print_ip_opts |= EVSEL__PRINT_SYM;
 515
 516	if (PRINT_FIELD(DSO))
 517		output[type].print_ip_opts |= EVSEL__PRINT_DSO;
 518
 519	if (PRINT_FIELD(SYMOFFSET))
 520		output[type].print_ip_opts |= EVSEL__PRINT_SYMOFFSET;
 521
 522	if (PRINT_FIELD(SRCLINE))
 523		output[type].print_ip_opts |= EVSEL__PRINT_SRCLINE;
 524}
 525
 526/*
 527 * verify all user requested events exist and the samples
 528 * have the expected data
 529 */
 530static int perf_session__check_output_opt(struct perf_session *session)
 531{
 532	bool tod = false;
 533	unsigned int j;
 534	struct evsel *evsel;
 535
 536	for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
 537		evsel = perf_session__find_first_evtype(session, attr_type(j));
 538
 539		/*
 540		 * even if fields is set to 0 (ie., show nothing) event must
 541		 * exist if user explicitly includes it on the command line
 542		 */
 543		if (!evsel && output[j].user_set && !output[j].wildcard_set &&
 544		    j != OUTPUT_TYPE_SYNTH) {
 545			pr_err("%s events do not exist. "
 546			       "Remove corresponding -F option to proceed.\n",
 547			       event_type(j));
 548			return -1;
 549		}
 550
 551		if (evsel && output[j].fields &&
 552			evsel__check_attr(evsel, session))
 553			return -1;
 554
 555		if (evsel == NULL)
 556			continue;
 557
 558		set_print_ip_opts(&evsel->core.attr);
 559		tod |= output[j].fields & PERF_OUTPUT_TOD;
 560	}
 561
 562	if (!no_callchain) {
 563		bool use_callchain = false;
 564		bool not_pipe = false;
 565
 566		evlist__for_each_entry(session->evlist, evsel) {
 567			not_pipe = true;
 568			if (evsel__has_callchain(evsel)) {
 569				use_callchain = true;
 570				break;
 571			}
 572		}
 573		if (not_pipe && !use_callchain)
 574			symbol_conf.use_callchain = false;
 575	}
 576
 577	/*
 578	 * set default for tracepoints to print symbols only
 579	 * if callchains are present
 580	 */
 581	if (symbol_conf.use_callchain &&
 582	    !output[PERF_TYPE_TRACEPOINT].user_set) {
 
 
 583		j = PERF_TYPE_TRACEPOINT;
 
 
 
 584
 585		evlist__for_each_entry(session->evlist, evsel) {
 586			if (evsel->core.attr.type != j)
 587				continue;
 588
 589			if (evsel__has_callchain(evsel)) {
 590				output[j].fields |= PERF_OUTPUT_IP;
 591				output[j].fields |= PERF_OUTPUT_SYM;
 592				output[j].fields |= PERF_OUTPUT_SYMOFFSET;
 593				output[j].fields |= PERF_OUTPUT_DSO;
 594				set_print_ip_opts(&evsel->core.attr);
 595				goto out;
 596			}
 597		}
 598	}
 599
 600	if (tod && !session->header.env.clock.enabled) {
 601		pr_err("Can't provide 'tod' time, missing clock data. "
 602		       "Please record with -k/--clockid option.\n");
 603		return -1;
 604	}
 605out:
 606	return 0;
 607}
 608
 609static int perf_sample__fprintf_regs(struct regs_dump *regs, uint64_t mask,
 610				     FILE *fp)
 
 611{
 612	unsigned i = 0, r;
 613	int printed = 0;
 614
 615	if (!regs || !regs->regs)
 616		return 0;
 617
 618	printed += fprintf(fp, " ABI:%" PRIu64 " ", regs->abi);
 619
 620	for_each_set_bit(r, (unsigned long *) &mask, sizeof(mask) * 8) {
 621		u64 val = regs->regs[i++];
 622		printed += fprintf(fp, "%5s:0x%"PRIx64" ", perf_reg_name(r), val);
 623	}
 624
 625	return printed;
 626}
 627
 628#define DEFAULT_TOD_FMT "%F %H:%M:%S"
 629
 630static char*
 631tod_scnprintf(struct perf_script *script, char *buf, int buflen,
 632	     u64 timestamp)
 633{
 634	u64 tod_ns, clockid_ns;
 635	struct perf_env *env;
 636	unsigned long nsec;
 637	struct tm ltime;
 638	char date[64];
 639	time_t sec;
 640
 641	buf[0] = '\0';
 642	if (buflen < 64 || !script)
 643		return buf;
 644
 645	env = &script->session->header.env;
 646	if (!env->clock.enabled) {
 647		scnprintf(buf, buflen, "disabled");
 648		return buf;
 649	}
 650
 651	clockid_ns = env->clock.clockid_ns;
 652	tod_ns     = env->clock.tod_ns;
 653
 654	if (timestamp > clockid_ns)
 655		tod_ns += timestamp - clockid_ns;
 656	else
 657		tod_ns -= clockid_ns - timestamp;
 658
 659	sec  = (time_t) (tod_ns / NSEC_PER_SEC);
 660	nsec = tod_ns - sec * NSEC_PER_SEC;
 661
 662	if (localtime_r(&sec, &ltime) == NULL) {
 663		scnprintf(buf, buflen, "failed");
 664	} else {
 665		strftime(date, sizeof(date), DEFAULT_TOD_FMT, &ltime);
 666
 667		if (symbol_conf.nanosecs) {
 668			snprintf(buf, buflen, "%s.%09lu", date, nsec);
 669		} else {
 670			snprintf(buf, buflen, "%s.%06lu",
 671				 date, nsec / NSEC_PER_USEC);
 672		}
 673	}
 674
 675	return buf;
 676}
 677
 678static int perf_sample__fprintf_iregs(struct perf_sample *sample,
 679				      struct perf_event_attr *attr, FILE *fp)
 680{
 681	return perf_sample__fprintf_regs(&sample->intr_regs,
 682					 attr->sample_regs_intr, fp);
 683}
 684
 685static int perf_sample__fprintf_uregs(struct perf_sample *sample,
 686				      struct perf_event_attr *attr, FILE *fp)
 687{
 688	return perf_sample__fprintf_regs(&sample->user_regs,
 689					 attr->sample_regs_user, fp);
 690}
 691
 692static int perf_sample__fprintf_start(struct perf_script *script,
 693				      struct perf_sample *sample,
 694				      struct thread *thread,
 695				      struct evsel *evsel,
 696				      u32 type, FILE *fp)
 697{
 698	struct perf_event_attr *attr = &evsel->core.attr;
 699	unsigned long secs;
 
 700	unsigned long long nsecs;
 701	int printed = 0;
 702	char tstr[128];
 703
 704	if (PRINT_FIELD(COMM)) {
 705		if (latency_format)
 706			printed += fprintf(fp, "%8.8s ", thread__comm_str(thread));
 707		else if (PRINT_FIELD(IP) && evsel__has_callchain(evsel) && symbol_conf.use_callchain)
 708			printed += fprintf(fp, "%s ", thread__comm_str(thread));
 709		else
 710			printed += fprintf(fp, "%16s ", thread__comm_str(thread));
 711	}
 712
 713	if (PRINT_FIELD(PID) && PRINT_FIELD(TID))
 714		printed += fprintf(fp, "%5d/%-5d ", sample->pid, sample->tid);
 715	else if (PRINT_FIELD(PID))
 716		printed += fprintf(fp, "%5d ", sample->pid);
 717	else if (PRINT_FIELD(TID))
 718		printed += fprintf(fp, "%5d ", sample->tid);
 719
 720	if (PRINT_FIELD(CPU)) {
 721		if (latency_format)
 722			printed += fprintf(fp, "%3d ", sample->cpu);
 723		else
 724			printed += fprintf(fp, "[%03d] ", sample->cpu);
 725	}
 726
 727	if (PRINT_FIELD(MISC)) {
 728		int ret = 0;
 729
 730		#define has(m) \
 731			(sample->misc & PERF_RECORD_MISC_##m) == PERF_RECORD_MISC_##m
 732
 733		if (has(KERNEL))
 734			ret += fprintf(fp, "K");
 735		if (has(USER))
 736			ret += fprintf(fp, "U");
 737		if (has(HYPERVISOR))
 738			ret += fprintf(fp, "H");
 739		if (has(GUEST_KERNEL))
 740			ret += fprintf(fp, "G");
 741		if (has(GUEST_USER))
 742			ret += fprintf(fp, "g");
 743
 744		switch (type) {
 745		case PERF_RECORD_MMAP:
 746		case PERF_RECORD_MMAP2:
 747			if (has(MMAP_DATA))
 748				ret += fprintf(fp, "M");
 749			break;
 750		case PERF_RECORD_COMM:
 751			if (has(COMM_EXEC))
 752				ret += fprintf(fp, "E");
 753			break;
 754		case PERF_RECORD_SWITCH:
 755		case PERF_RECORD_SWITCH_CPU_WIDE:
 756			if (has(SWITCH_OUT)) {
 757				ret += fprintf(fp, "S");
 758				if (sample->misc & PERF_RECORD_MISC_SWITCH_OUT_PREEMPT)
 759					ret += fprintf(fp, "p");
 760			}
 761		default:
 762			break;
 763		}
 764
 765		#undef has
 766
 767		ret += fprintf(fp, "%*s", 6 - ret, " ");
 768		printed += ret;
 769	}
 770
 771	if (PRINT_FIELD(TOD)) {
 772		tod_scnprintf(script, tstr, sizeof(tstr), sample->time);
 773		printed += fprintf(fp, "%s ", tstr);
 774	}
 775
 776	if (PRINT_FIELD(TIME)) {
 777		u64 t = sample->time;
 778		if (reltime) {
 779			if (!initial_time)
 780				initial_time = sample->time;
 781			t = sample->time - initial_time;
 782		} else if (deltatime) {
 783			if (previous_time)
 784				t = sample->time - previous_time;
 785			else {
 786				t = 0;
 787			}
 788			previous_time = sample->time;
 789		}
 790		nsecs = t;
 791		secs = nsecs / NSEC_PER_SEC;
 792		nsecs -= secs * NSEC_PER_SEC;
 793
 794		if (symbol_conf.nanosecs)
 795			printed += fprintf(fp, "%5lu.%09llu: ", secs, nsecs);
 796		else {
 797			char sample_time[32];
 798			timestamp__scnprintf_usec(t, sample_time, sizeof(sample_time));
 799			printed += fprintf(fp, "%12s: ", sample_time);
 800		}
 801	}
 802
 803	return printed;
 804}
 805
 806static inline char
 807mispred_str(struct branch_entry *br)
 808{
 809	if (!(br->flags.mispred  || br->flags.predicted))
 810		return '-';
 811
 812	return br->flags.predicted ? 'P' : 'M';
 813}
 814
 815static int perf_sample__fprintf_brstack(struct perf_sample *sample,
 816					struct thread *thread,
 817					struct perf_event_attr *attr, FILE *fp)
 818{
 819	struct branch_stack *br = sample->branch_stack;
 820	struct branch_entry *entries = perf_sample__branch_entries(sample);
 821	struct addr_location alf, alt;
 822	u64 i, from, to;
 823	int printed = 0;
 824
 825	if (!(br && br->nr))
 826		return 0;
 827
 828	for (i = 0; i < br->nr; i++) {
 829		from = entries[i].from;
 830		to   = entries[i].to;
 831
 832		if (PRINT_FIELD(DSO)) {
 833			memset(&alf, 0, sizeof(alf));
 834			memset(&alt, 0, sizeof(alt));
 835			thread__find_map_fb(thread, sample->cpumode, from, &alf);
 836			thread__find_map_fb(thread, sample->cpumode, to, &alt);
 837		}
 838
 839		printed += fprintf(fp, " 0x%"PRIx64, from);
 840		if (PRINT_FIELD(DSO)) {
 841			printed += fprintf(fp, "(");
 842			printed += map__fprintf_dsoname(alf.map, fp);
 843			printed += fprintf(fp, ")");
 844		}
 845
 846		printed += fprintf(fp, "/0x%"PRIx64, to);
 847		if (PRINT_FIELD(DSO)) {
 848			printed += fprintf(fp, "(");
 849			printed += map__fprintf_dsoname(alt.map, fp);
 850			printed += fprintf(fp, ")");
 851		}
 852
 853		printed += fprintf(fp, "/%c/%c/%c/%d ",
 854			mispred_str(entries + i),
 855			entries[i].flags.in_tx ? 'X' : '-',
 856			entries[i].flags.abort ? 'A' : '-',
 857			entries[i].flags.cycles);
 858	}
 859
 860	return printed;
 861}
 862
 863static int perf_sample__fprintf_brstacksym(struct perf_sample *sample,
 864					   struct thread *thread,
 865					   struct perf_event_attr *attr, FILE *fp)
 
 
 866{
 867	struct branch_stack *br = sample->branch_stack;
 868	struct branch_entry *entries = perf_sample__branch_entries(sample);
 869	struct addr_location alf, alt;
 870	u64 i, from, to;
 871	int printed = 0;
 872
 873	if (!(br && br->nr))
 874		return 0;
 875
 876	for (i = 0; i < br->nr; i++) {
 877
 878		memset(&alf, 0, sizeof(alf));
 879		memset(&alt, 0, sizeof(alt));
 880		from = entries[i].from;
 881		to   = entries[i].to;
 882
 883		thread__find_symbol_fb(thread, sample->cpumode, from, &alf);
 884		thread__find_symbol_fb(thread, sample->cpumode, to, &alt);
 885
 886		printed += symbol__fprintf_symname_offs(alf.sym, &alf, fp);
 887		if (PRINT_FIELD(DSO)) {
 888			printed += fprintf(fp, "(");
 889			printed += map__fprintf_dsoname(alf.map, fp);
 890			printed += fprintf(fp, ")");
 891		}
 892		printed += fprintf(fp, "%c", '/');
 893		printed += symbol__fprintf_symname_offs(alt.sym, &alt, fp);
 894		if (PRINT_FIELD(DSO)) {
 895			printed += fprintf(fp, "(");
 896			printed += map__fprintf_dsoname(alt.map, fp);
 897			printed += fprintf(fp, ")");
 898		}
 899		printed += fprintf(fp, "/%c/%c/%c/%d ",
 900			mispred_str(entries + i),
 901			entries[i].flags.in_tx ? 'X' : '-',
 902			entries[i].flags.abort ? 'A' : '-',
 903			entries[i].flags.cycles);
 904	}
 905
 906	return printed;
 907}
 908
 909static int perf_sample__fprintf_brstackoff(struct perf_sample *sample,
 910					   struct thread *thread,
 911					   struct perf_event_attr *attr, FILE *fp)
 912{
 913	struct branch_stack *br = sample->branch_stack;
 914	struct branch_entry *entries = perf_sample__branch_entries(sample);
 915	struct addr_location alf, alt;
 916	u64 i, from, to;
 917	int printed = 0;
 918
 919	if (!(br && br->nr))
 920		return 0;
 921
 922	for (i = 0; i < br->nr; i++) {
 923
 924		memset(&alf, 0, sizeof(alf));
 925		memset(&alt, 0, sizeof(alt));
 926		from = entries[i].from;
 927		to   = entries[i].to;
 928
 929		if (thread__find_map_fb(thread, sample->cpumode, from, &alf) &&
 930		    !alf.map->dso->adjust_symbols)
 931			from = map__map_ip(alf.map, from);
 932
 933		if (thread__find_map_fb(thread, sample->cpumode, to, &alt) &&
 934		    !alt.map->dso->adjust_symbols)
 935			to = map__map_ip(alt.map, to);
 936
 937		printed += fprintf(fp, " 0x%"PRIx64, from);
 938		if (PRINT_FIELD(DSO)) {
 939			printed += fprintf(fp, "(");
 940			printed += map__fprintf_dsoname(alf.map, fp);
 941			printed += fprintf(fp, ")");
 942		}
 943		printed += fprintf(fp, "/0x%"PRIx64, to);
 944		if (PRINT_FIELD(DSO)) {
 945			printed += fprintf(fp, "(");
 946			printed += map__fprintf_dsoname(alt.map, fp);
 947			printed += fprintf(fp, ")");
 948		}
 949		printed += fprintf(fp, "/%c/%c/%c/%d ",
 950			mispred_str(entries + i),
 951			entries[i].flags.in_tx ? 'X' : '-',
 952			entries[i].flags.abort ? 'A' : '-',
 953			entries[i].flags.cycles);
 954	}
 955
 956	return printed;
 957}
 958#define MAXBB 16384UL
 959
 960static int grab_bb(u8 *buffer, u64 start, u64 end,
 961		    struct machine *machine, struct thread *thread,
 962		    bool *is64bit, u8 *cpumode, bool last)
 963{
 964	long offset, len;
 965	struct addr_location al;
 966	bool kernel;
 967
 968	if (!start || !end)
 969		return 0;
 970
 971	kernel = machine__kernel_ip(machine, start);
 972	if (kernel)
 973		*cpumode = PERF_RECORD_MISC_KERNEL;
 974	else
 975		*cpumode = PERF_RECORD_MISC_USER;
 976
 977	/*
 978	 * Block overlaps between kernel and user.
 979	 * This can happen due to ring filtering
 980	 * On Intel CPUs the entry into the kernel is filtered,
 981	 * but the exit is not. Let the caller patch it up.
 982	 */
 983	if (kernel != machine__kernel_ip(machine, end)) {
 984		pr_debug("\tblock %" PRIx64 "-%" PRIx64 " transfers between kernel and user\n", start, end);
 985		return -ENXIO;
 986	}
 987
 988	memset(&al, 0, sizeof(al));
 989	if (end - start > MAXBB - MAXINSN) {
 990		if (last)
 991			pr_debug("\tbrstack does not reach to final jump (%" PRIx64 "-%" PRIx64 ")\n", start, end);
 992		else
 993			pr_debug("\tblock %" PRIx64 "-%" PRIx64 " (%" PRIu64 ") too long to dump\n", start, end, end - start);
 994		return 0;
 995	}
 996
 997	if (!thread__find_map(thread, *cpumode, start, &al) || !al.map->dso) {
 998		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
 999		return 0;
1000	}
1001	if (al.map->dso->data.status == DSO_DATA_STATUS_ERROR) {
1002		pr_debug("\tcannot resolve %" PRIx64 "-%" PRIx64 "\n", start, end);
1003		return 0;
1004	}
1005
1006	/* Load maps to ensure dso->is_64_bit has been updated */
1007	map__load(al.map);
1008
1009	offset = al.map->map_ip(al.map, start);
1010	len = dso__data_read_offset(al.map->dso, machine, offset, (u8 *)buffer,
1011				    end - start + MAXINSN);
1012
1013	*is64bit = al.map->dso->is_64_bit;
1014	if (len <= 0)
1015		pr_debug("\tcannot fetch code for block at %" PRIx64 "-%" PRIx64 "\n",
1016			start, end);
1017	return len;
1018}
1019
1020static int map__fprintf_srccode(struct map *map, u64 addr, FILE *fp, struct srccode_state *state)
1021{
1022	char *srcfile;
1023	int ret = 0;
1024	unsigned line;
1025	int len;
1026	char *srccode;
1027
1028	if (!map || !map->dso)
1029		return 0;
1030	srcfile = get_srcline_split(map->dso,
1031				    map__rip_2objdump(map, addr),
1032				    &line);
1033	if (!srcfile)
1034		return 0;
1035
1036	/* Avoid redundant printing */
1037	if (state &&
1038	    state->srcfile &&
1039	    !strcmp(state->srcfile, srcfile) &&
1040	    state->line == line) {
1041		free(srcfile);
1042		return 0;
1043	}
1044
1045	srccode = find_sourceline(srcfile, line, &len);
1046	if (!srccode)
1047		goto out_free_line;
1048
1049	ret = fprintf(fp, "|%-8d %.*s", line, len, srccode);
1050
1051	if (state) {
1052		state->srcfile = srcfile;
1053		state->line = line;
1054	}
1055	return ret;
1056
1057out_free_line:
1058	free(srcfile);
1059	return ret;
1060}
1061
1062static int print_srccode(struct thread *thread, u8 cpumode, uint64_t addr)
1063{
1064	struct addr_location al;
1065	int ret = 0;
1066
1067	memset(&al, 0, sizeof(al));
1068	thread__find_map(thread, cpumode, addr, &al);
1069	if (!al.map)
1070		return 0;
1071	ret = map__fprintf_srccode(al.map, al.addr, stdout,
1072		    &thread->srccode_state);
1073	if (ret)
1074		ret += printf("\n");
1075	return ret;
1076}
1077
1078static int ip__fprintf_jump(uint64_t ip, struct branch_entry *en,
1079			    struct perf_insn *x, u8 *inbuf, int len,
1080			    int insn, FILE *fp, int *total_cycles)
1081{
1082	int printed = fprintf(fp, "\t%016" PRIx64 "\t%-30s\t#%s%s%s%s", ip,
1083			      dump_insn(x, ip, inbuf, len, NULL),
1084			      en->flags.predicted ? " PRED" : "",
1085			      en->flags.mispred ? " MISPRED" : "",
1086			      en->flags.in_tx ? " INTX" : "",
1087			      en->flags.abort ? " ABORT" : "");
1088	if (en->flags.cycles) {
1089		*total_cycles += en->flags.cycles;
1090		printed += fprintf(fp, " %d cycles [%d]", en->flags.cycles, *total_cycles);
1091		if (insn)
1092			printed += fprintf(fp, " %.2f IPC", (float)insn / en->flags.cycles);
1093	}
1094	return printed + fprintf(fp, "\n");
1095}
1096
1097static int ip__fprintf_sym(uint64_t addr, struct thread *thread,
1098			   u8 cpumode, int cpu, struct symbol **lastsym,
1099			   struct perf_event_attr *attr, FILE *fp)
1100{
1101	struct addr_location al;
1102	int off, printed = 0;
1103
1104	memset(&al, 0, sizeof(al));
1105
1106	thread__find_map(thread, cpumode, addr, &al);
1107
1108	if ((*lastsym) && al.addr >= (*lastsym)->start && al.addr < (*lastsym)->end)
1109		return 0;
1110
1111	al.cpu = cpu;
1112	al.sym = NULL;
1113	if (al.map)
1114		al.sym = map__find_symbol(al.map, al.addr);
1115
1116	if (!al.sym)
1117		return 0;
1118
1119	if (al.addr < al.sym->end)
1120		off = al.addr - al.sym->start;
1121	else
1122		off = al.addr - al.map->start - al.sym->start;
1123	printed += fprintf(fp, "\t%s", al.sym->name);
1124	if (off)
1125		printed += fprintf(fp, "%+d", off);
1126	printed += fprintf(fp, ":");
1127	if (PRINT_FIELD(SRCLINE))
1128		printed += map__fprintf_srcline(al.map, al.addr, "\t", fp);
1129	printed += fprintf(fp, "\n");
1130	*lastsym = al.sym;
1131
1132	return printed;
1133}
1134
1135static int perf_sample__fprintf_brstackinsn(struct perf_sample *sample,
1136					    struct thread *thread,
1137					    struct perf_event_attr *attr,
1138					    struct machine *machine, FILE *fp)
1139{
1140	struct branch_stack *br = sample->branch_stack;
1141	struct branch_entry *entries = perf_sample__branch_entries(sample);
1142	u64 start, end;
1143	int i, insn, len, nr, ilen, printed = 0;
1144	struct perf_insn x;
1145	u8 buffer[MAXBB];
1146	unsigned off;
1147	struct symbol *lastsym = NULL;
1148	int total_cycles = 0;
1149
1150	if (!(br && br->nr))
1151		return 0;
1152	nr = br->nr;
1153	if (max_blocks && nr > max_blocks + 1)
1154		nr = max_blocks + 1;
1155
1156	x.thread = thread;
1157	x.cpu = sample->cpu;
1158
1159	printed += fprintf(fp, "%c", '\n');
1160
1161	/* Handle first from jump, of which we don't know the entry. */
1162	len = grab_bb(buffer, entries[nr-1].from,
1163			entries[nr-1].from,
1164			machine, thread, &x.is64bit, &x.cpumode, false);
1165	if (len > 0) {
1166		printed += ip__fprintf_sym(entries[nr - 1].from, thread,
1167					   x.cpumode, x.cpu, &lastsym, attr, fp);
1168		printed += ip__fprintf_jump(entries[nr - 1].from, &entries[nr - 1],
1169					    &x, buffer, len, 0, fp, &total_cycles);
1170		if (PRINT_FIELD(SRCCODE))
1171			printed += print_srccode(thread, x.cpumode, entries[nr - 1].from);
1172	}
1173
1174	/* Print all blocks */
1175	for (i = nr - 2; i >= 0; i--) {
1176		if (entries[i].from || entries[i].to)
1177			pr_debug("%d: %" PRIx64 "-%" PRIx64 "\n", i,
1178				 entries[i].from,
1179				 entries[i].to);
1180		start = entries[i + 1].to;
1181		end   = entries[i].from;
1182
1183		len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1184		/* Patch up missing kernel transfers due to ring filters */
1185		if (len == -ENXIO && i > 0) {
1186			end = entries[--i].from;
1187			pr_debug("\tpatching up to %" PRIx64 "-%" PRIx64 "\n", start, end);
1188			len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, false);
1189		}
1190		if (len <= 0)
1191			continue;
1192
1193		insn = 0;
1194		for (off = 0; off < (unsigned)len; off += ilen) {
1195			uint64_t ip = start + off;
1196
1197			printed += ip__fprintf_sym(ip, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1198			if (ip == end) {
1199				printed += ip__fprintf_jump(ip, &entries[i], &x, buffer + off, len - off, ++insn, fp,
1200							    &total_cycles);
1201				if (PRINT_FIELD(SRCCODE))
1202					printed += print_srccode(thread, x.cpumode, ip);
1203				break;
1204			} else {
1205				ilen = 0;
1206				printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", ip,
1207						   dump_insn(&x, ip, buffer + off, len - off, &ilen));
1208				if (ilen == 0)
1209					break;
1210				if (PRINT_FIELD(SRCCODE))
1211					print_srccode(thread, x.cpumode, ip);
1212				insn++;
1213			}
1214		}
1215		if (off != end - start)
1216			printed += fprintf(fp, "\tmismatch of LBR data and executable\n");
1217	}
1218
1219	/*
1220	 * Hit the branch? In this case we are already done, and the target
1221	 * has not been executed yet.
1222	 */
1223	if (entries[0].from == sample->ip)
1224		goto out;
1225	if (entries[0].flags.abort)
1226		goto out;
1227
1228	/*
1229	 * Print final block upto sample
1230	 *
1231	 * Due to pipeline delays the LBRs might be missing a branch
1232	 * or two, which can result in very large or negative blocks
1233	 * between final branch and sample. When this happens just
1234	 * continue walking after the last TO until we hit a branch.
1235	 */
1236	start = entries[0].to;
1237	end = sample->ip;
1238	if (end < start) {
1239		/* Missing jump. Scan 128 bytes for the next branch */
1240		end = start + 128;
1241	}
1242	len = grab_bb(buffer, start, end, machine, thread, &x.is64bit, &x.cpumode, true);
1243	printed += ip__fprintf_sym(start, thread, x.cpumode, x.cpu, &lastsym, attr, fp);
1244	if (len <= 0) {
1245		/* Print at least last IP if basic block did not work */
1246		len = grab_bb(buffer, sample->ip, sample->ip,
1247			      machine, thread, &x.is64bit, &x.cpumode, false);
1248		if (len <= 0)
1249			goto out;
1250		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", sample->ip,
1251			dump_insn(&x, sample->ip, buffer, len, NULL));
1252		if (PRINT_FIELD(SRCCODE))
1253			print_srccode(thread, x.cpumode, sample->ip);
1254		goto out;
1255	}
1256	for (off = 0; off <= end - start; off += ilen) {
1257		ilen = 0;
1258		printed += fprintf(fp, "\t%016" PRIx64 "\t%s\n", start + off,
1259				   dump_insn(&x, start + off, buffer + off, len - off, &ilen));
1260		if (ilen == 0)
1261			break;
1262		if (arch_is_branch(buffer + off, len - off, x.is64bit) && start + off != sample->ip) {
1263			/*
1264			 * Hit a missing branch. Just stop.
1265			 */
1266			printed += fprintf(fp, "\t... not reaching sample ...\n");
1267			break;
1268		}
1269		if (PRINT_FIELD(SRCCODE))
1270			print_srccode(thread, x.cpumode, start + off);
1271	}
1272out:
1273	return printed;
1274}
1275
1276static int perf_sample__fprintf_addr(struct perf_sample *sample,
1277				     struct thread *thread,
1278				     struct perf_event_attr *attr, FILE *fp)
1279{
1280	struct addr_location al;
1281	int printed = fprintf(fp, "%16" PRIx64, sample->addr);
1282
1283	if (!sample_addr_correlates_sym(attr))
1284		goto out;
1285
1286	thread__resolve(thread, &al, sample);
1287
1288	if (PRINT_FIELD(SYM)) {
1289		printed += fprintf(fp, " ");
1290		if (PRINT_FIELD(SYMOFFSET))
1291			printed += symbol__fprintf_symname_offs(al.sym, &al, fp);
1292		else
1293			printed += symbol__fprintf_symname(al.sym, fp);
1294	}
1295
1296	if (PRINT_FIELD(DSO)) {
1297		printed += fprintf(fp, " (");
1298		printed += map__fprintf_dsoname(al.map, fp);
1299		printed += fprintf(fp, ")");
1300	}
1301out:
1302	return printed;
1303}
1304
1305static const char *resolve_branch_sym(struct perf_sample *sample,
1306				      struct evsel *evsel,
1307				      struct thread *thread,
1308				      struct addr_location *al,
1309				      u64 *ip)
1310{
1311	struct addr_location addr_al;
1312	struct perf_event_attr *attr = &evsel->core.attr;
1313	const char *name = NULL;
1314
1315	if (sample->flags & (PERF_IP_FLAG_CALL | PERF_IP_FLAG_TRACE_BEGIN)) {
1316		if (sample_addr_correlates_sym(attr)) {
1317			thread__resolve(thread, &addr_al, sample);
1318			if (addr_al.sym)
1319				name = addr_al.sym->name;
1320			else
1321				*ip = sample->addr;
1322		} else {
1323			*ip = sample->addr;
1324		}
1325	} else if (sample->flags & (PERF_IP_FLAG_RETURN | PERF_IP_FLAG_TRACE_END)) {
1326		if (al->sym)
1327			name = al->sym->name;
1328		else
1329			*ip = sample->ip;
1330	}
1331	return name;
1332}
1333
1334static int perf_sample__fprintf_callindent(struct perf_sample *sample,
1335					   struct evsel *evsel,
1336					   struct thread *thread,
1337					   struct addr_location *al, FILE *fp)
1338{
1339	struct perf_event_attr *attr = &evsel->core.attr;
1340	size_t depth = thread_stack__depth(thread, sample->cpu);
1341	const char *name = NULL;
1342	static int spacing;
1343	int len = 0;
1344	int dlen = 0;
1345	u64 ip = 0;
1346
1347	/*
1348	 * The 'return' has already been popped off the stack so the depth has
1349	 * to be adjusted to match the 'call'.
1350	 */
1351	if (thread->ts && sample->flags & PERF_IP_FLAG_RETURN)
1352		depth += 1;
1353
1354	name = resolve_branch_sym(sample, evsel, thread, al, &ip);
1355
1356	if (PRINT_FIELD(DSO) && !(PRINT_FIELD(IP) || PRINT_FIELD(ADDR))) {
1357		dlen += fprintf(fp, "(");
1358		dlen += map__fprintf_dsoname(al->map, fp);
1359		dlen += fprintf(fp, ")\t");
1360	}
1361
1362	if (name)
1363		len = fprintf(fp, "%*s%s", (int)depth * 4, "", name);
1364	else if (ip)
1365		len = fprintf(fp, "%*s%16" PRIx64, (int)depth * 4, "", ip);
1366
1367	if (len < 0)
1368		return len;
1369
1370	/*
1371	 * Try to keep the output length from changing frequently so that the
1372	 * output lines up more nicely.
1373	 */
1374	if (len > spacing || (len && len < spacing - 52))
1375		spacing = round_up(len + 4, 32);
1376
1377	if (len < spacing)
1378		len += fprintf(fp, "%*s", spacing - len, "");
1379
1380	return len + dlen;
1381}
1382
1383__weak void arch_fetch_insn(struct perf_sample *sample __maybe_unused,
1384			    struct thread *thread __maybe_unused,
1385			    struct machine *machine __maybe_unused)
1386{
1387}
1388
1389static int perf_sample__fprintf_insn(struct perf_sample *sample,
1390				     struct perf_event_attr *attr,
1391				     struct thread *thread,
1392				     struct machine *machine, FILE *fp)
1393{
1394	int printed = 0;
1395
1396	if (sample->insn_len == 0 && native_arch)
1397		arch_fetch_insn(sample, thread, machine);
1398
1399	if (PRINT_FIELD(INSNLEN))
1400		printed += fprintf(fp, " ilen: %d", sample->insn_len);
1401	if (PRINT_FIELD(INSN) && sample->insn_len) {
1402		int i;
1403
1404		printed += fprintf(fp, " insn:");
1405		for (i = 0; i < sample->insn_len; i++)
1406			printed += fprintf(fp, " %02x", (unsigned char)sample->insn[i]);
1407	}
1408	if (PRINT_FIELD(BRSTACKINSN))
1409		printed += perf_sample__fprintf_brstackinsn(sample, thread, attr, machine, fp);
1410
1411	return printed;
1412}
1413
1414static int perf_sample__fprintf_ipc(struct perf_sample *sample,
1415				    struct perf_event_attr *attr, FILE *fp)
1416{
1417	unsigned int ipc;
1418
1419	if (!PRINT_FIELD(IPC) || !sample->cyc_cnt || !sample->insn_cnt)
1420		return 0;
1421
1422	ipc = (sample->insn_cnt * 100) / sample->cyc_cnt;
1423
1424	return fprintf(fp, " \t IPC: %u.%02u (%" PRIu64 "/%" PRIu64 ") ",
1425		       ipc / 100, ipc % 100, sample->insn_cnt, sample->cyc_cnt);
1426}
1427
1428static int perf_sample__fprintf_bts(struct perf_sample *sample,
1429				    struct evsel *evsel,
1430				    struct thread *thread,
1431				    struct addr_location *al,
1432				    struct machine *machine, FILE *fp)
1433{
1434	struct perf_event_attr *attr = &evsel->core.attr;
1435	unsigned int type = output_type(attr->type);
1436	bool print_srcline_last = false;
1437	int printed = 0;
1438
1439	if (PRINT_FIELD(CALLINDENT))
1440		printed += perf_sample__fprintf_callindent(sample, evsel, thread, al, fp);
1441
1442	/* print branch_from information */
1443	if (PRINT_FIELD(IP)) {
1444		unsigned int print_opts = output[type].print_ip_opts;
1445		struct callchain_cursor *cursor = NULL;
1446
1447		if (symbol_conf.use_callchain && sample->callchain &&
1448		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1449					      sample, NULL, NULL, scripting_max_stack) == 0)
1450			cursor = &callchain_cursor;
1451
1452		if (cursor == NULL) {
1453			printed += fprintf(fp, " ");
1454			if (print_opts & EVSEL__PRINT_SRCLINE) {
1455				print_srcline_last = true;
1456				print_opts &= ~EVSEL__PRINT_SRCLINE;
1457			}
1458		} else
1459			printed += fprintf(fp, "\n");
1460
1461		printed += sample__fprintf_sym(sample, al, 0, print_opts, cursor,
1462					       symbol_conf.bt_stop_list, fp);
1463	}
1464
1465	/* print branch_to information */
1466	if (PRINT_FIELD(ADDR) ||
1467	    ((evsel->core.attr.sample_type & PERF_SAMPLE_ADDR) &&
1468	     !output[type].user_set)) {
1469		printed += fprintf(fp, " => ");
1470		printed += perf_sample__fprintf_addr(sample, thread, attr, fp);
1471	}
1472
1473	printed += perf_sample__fprintf_ipc(sample, attr, fp);
1474
1475	if (print_srcline_last)
1476		printed += map__fprintf_srcline(al->map, al->addr, "\n  ", fp);
1477
1478	printed += perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
1479	printed += fprintf(fp, "\n");
1480	if (PRINT_FIELD(SRCCODE)) {
1481		int ret = map__fprintf_srccode(al->map, al->addr, stdout,
1482					 &thread->srccode_state);
1483		if (ret) {
1484			printed += ret;
1485			printed += printf("\n");
1486		}
1487	}
1488	return printed;
1489}
1490
1491static struct {
1492	u32 flags;
1493	const char *name;
1494} sample_flags[] = {
1495	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL, "call"},
1496	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN, "return"},
1497	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CONDITIONAL, "jcc"},
1498	{PERF_IP_FLAG_BRANCH, "jmp"},
1499	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_INTERRUPT, "int"},
1500	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_INTERRUPT, "iret"},
1501	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_SYSCALLRET, "syscall"},
1502	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_RETURN | PERF_IP_FLAG_SYSCALLRET, "sysret"},
1503	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_ASYNC, "async"},
1504	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_CALL | PERF_IP_FLAG_ASYNC |	PERF_IP_FLAG_INTERRUPT, "hw int"},
1505	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TX_ABORT, "tx abrt"},
1506	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_BEGIN, "tr strt"},
1507	{PERF_IP_FLAG_BRANCH | PERF_IP_FLAG_TRACE_END, "tr end"},
1508	{0, NULL}
1509};
1510
1511static const char *sample_flags_to_name(u32 flags)
1512{
1513	int i;
1514
1515	for (i = 0; sample_flags[i].name ; i++) {
1516		if (sample_flags[i].flags == flags)
1517			return sample_flags[i].name;
1518	}
1519
1520	return NULL;
1521}
1522
1523static int perf_sample__fprintf_flags(u32 flags, FILE *fp)
1524{
1525	const char *chars = PERF_IP_FLAG_CHARS;
1526	const int n = strlen(PERF_IP_FLAG_CHARS);
1527	bool in_tx = flags & PERF_IP_FLAG_IN_TX;
1528	const char *name = NULL;
1529	char str[33];
1530	int i, pos = 0;
1531
1532	name = sample_flags_to_name(flags & ~PERF_IP_FLAG_IN_TX);
1533	if (name)
1534		return fprintf(fp, "  %-15s%4s ", name, in_tx ? "(x)" : "");
1535
1536	if (flags & PERF_IP_FLAG_TRACE_BEGIN) {
1537		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_BEGIN));
1538		if (name)
1539			return fprintf(fp, "  tr strt %-7s%4s ", name, in_tx ? "(x)" : "");
1540	}
1541
1542	if (flags & PERF_IP_FLAG_TRACE_END) {
1543		name = sample_flags_to_name(flags & ~(PERF_IP_FLAG_IN_TX | PERF_IP_FLAG_TRACE_END));
1544		if (name)
1545			return fprintf(fp, "  tr end  %-7s%4s ", name, in_tx ? "(x)" : "");
1546	}
1547
1548	for (i = 0; i < n; i++, flags >>= 1) {
1549		if (flags & 1)
1550			str[pos++] = chars[i];
1551	}
1552	for (; i < 32; i++, flags >>= 1) {
1553		if (flags & 1)
1554			str[pos++] = '?';
1555	}
1556	str[pos] = 0;
1557
1558	return fprintf(fp, "  %-19s ", str);
1559}
 
 
 
1560
1561struct printer_data {
1562	int line_no;
1563	bool hit_nul;
1564	bool is_printable;
1565};
1566
1567static int sample__fprintf_bpf_output(enum binary_printer_ops op,
1568				      unsigned int val,
1569				      void *extra, FILE *fp)
1570{
1571	unsigned char ch = (unsigned char)val;
1572	struct printer_data *printer_data = extra;
1573	int printed = 0;
1574
1575	switch (op) {
1576	case BINARY_PRINT_DATA_BEGIN:
1577		printed += fprintf(fp, "\n");
1578		break;
1579	case BINARY_PRINT_LINE_BEGIN:
1580		printed += fprintf(fp, "%17s", !printer_data->line_no ? "BPF output:" :
1581						        "           ");
1582		break;
1583	case BINARY_PRINT_ADDR:
1584		printed += fprintf(fp, " %04x:", val);
1585		break;
1586	case BINARY_PRINT_NUM_DATA:
1587		printed += fprintf(fp, " %02x", val);
1588		break;
1589	case BINARY_PRINT_NUM_PAD:
1590		printed += fprintf(fp, "   ");
1591		break;
1592	case BINARY_PRINT_SEP:
1593		printed += fprintf(fp, "  ");
1594		break;
1595	case BINARY_PRINT_CHAR_DATA:
1596		if (printer_data->hit_nul && ch)
1597			printer_data->is_printable = false;
1598
1599		if (!isprint(ch)) {
1600			printed += fprintf(fp, "%c", '.');
1601
1602			if (!printer_data->is_printable)
1603				break;
1604
1605			if (ch == '\0')
1606				printer_data->hit_nul = true;
1607			else
1608				printer_data->is_printable = false;
1609		} else {
1610			printed += fprintf(fp, "%c", ch);
1611		}
1612		break;
1613	case BINARY_PRINT_CHAR_PAD:
1614		printed += fprintf(fp, " ");
1615		break;
1616	case BINARY_PRINT_LINE_END:
1617		printed += fprintf(fp, "\n");
1618		printer_data->line_no++;
1619		break;
1620	case BINARY_PRINT_DATA_END:
1621	default:
1622		break;
1623	}
1624
1625	return printed;
1626}
1627
1628static int perf_sample__fprintf_bpf_output(struct perf_sample *sample, FILE *fp)
 
 
1629{
1630	unsigned int nr_bytes = sample->raw_size;
1631	struct printer_data printer_data = {0, false, true};
1632	int printed = binary__fprintf(sample->raw_data, nr_bytes, 8,
1633				      sample__fprintf_bpf_output, &printer_data, fp);
1634
1635	if (printer_data.is_printable && printer_data.hit_nul)
1636		printed += fprintf(fp, "%17s \"%s\"\n", "BPF string:", (char *)(sample->raw_data));
1637
1638	return printed;
1639}
1640
1641static int perf_sample__fprintf_spacing(int len, int spacing, FILE *fp)
1642{
1643	if (len > 0 && len < spacing)
1644		return fprintf(fp, "%*s", spacing - len, "");
1645
1646	return 0;
1647}
1648
1649static int perf_sample__fprintf_pt_spacing(int len, FILE *fp)
1650{
1651	return perf_sample__fprintf_spacing(len, 34, fp);
1652}
1653
1654static int perf_sample__fprintf_synth_ptwrite(struct perf_sample *sample, FILE *fp)
1655{
1656	struct perf_synth_intel_ptwrite *data = perf_sample__synth_ptr(sample);
1657	int len;
1658
1659	if (perf_sample__bad_synth_size(sample, *data))
1660		return 0;
1661
1662	len = fprintf(fp, " IP: %u payload: %#" PRIx64 " ",
1663		     data->ip, le64_to_cpu(data->payload));
1664	return len + perf_sample__fprintf_pt_spacing(len, fp);
1665}
1666
1667static int perf_sample__fprintf_synth_mwait(struct perf_sample *sample, FILE *fp)
1668{
1669	struct perf_synth_intel_mwait *data = perf_sample__synth_ptr(sample);
1670	int len;
1671
1672	if (perf_sample__bad_synth_size(sample, *data))
1673		return 0;
1674
1675	len = fprintf(fp, " hints: %#x extensions: %#x ",
1676		      data->hints, data->extensions);
1677	return len + perf_sample__fprintf_pt_spacing(len, fp);
1678}
1679
1680static int perf_sample__fprintf_synth_pwre(struct perf_sample *sample, FILE *fp)
1681{
1682	struct perf_synth_intel_pwre *data = perf_sample__synth_ptr(sample);
1683	int len;
1684
1685	if (perf_sample__bad_synth_size(sample, *data))
1686		return 0;
1687
1688	len = fprintf(fp, " hw: %u cstate: %u sub-cstate: %u ",
1689		      data->hw, data->cstate, data->subcstate);
1690	return len + perf_sample__fprintf_pt_spacing(len, fp);
1691}
1692
1693static int perf_sample__fprintf_synth_exstop(struct perf_sample *sample, FILE *fp)
1694{
1695	struct perf_synth_intel_exstop *data = perf_sample__synth_ptr(sample);
1696	int len;
1697
1698	if (perf_sample__bad_synth_size(sample, *data))
1699		return 0;
1700
1701	len = fprintf(fp, " IP: %u ", data->ip);
1702	return len + perf_sample__fprintf_pt_spacing(len, fp);
1703}
1704
1705static int perf_sample__fprintf_synth_pwrx(struct perf_sample *sample, FILE *fp)
1706{
1707	struct perf_synth_intel_pwrx *data = perf_sample__synth_ptr(sample);
1708	int len;
1709
1710	if (perf_sample__bad_synth_size(sample, *data))
1711		return 0;
1712
1713	len = fprintf(fp, " deepest cstate: %u last cstate: %u wake reason: %#x ",
1714		     data->deepest_cstate, data->last_cstate,
1715		     data->wake_reason);
1716	return len + perf_sample__fprintf_pt_spacing(len, fp);
1717}
1718
1719static int perf_sample__fprintf_synth_cbr(struct perf_sample *sample, FILE *fp)
1720{
1721	struct perf_synth_intel_cbr *data = perf_sample__synth_ptr(sample);
1722	unsigned int percent, freq;
1723	int len;
1724
1725	if (perf_sample__bad_synth_size(sample, *data))
1726		return 0;
1727
1728	freq = (le32_to_cpu(data->freq) + 500) / 1000;
1729	len = fprintf(fp, " cbr: %2u freq: %4u MHz ", data->cbr, freq);
1730	if (data->max_nonturbo) {
1731		percent = (5 + (1000 * data->cbr) / data->max_nonturbo) / 10;
1732		len += fprintf(fp, "(%3u%%) ", percent);
1733	}
1734	return len + perf_sample__fprintf_pt_spacing(len, fp);
1735}
1736
1737static int perf_sample__fprintf_synth(struct perf_sample *sample,
1738				      struct evsel *evsel, FILE *fp)
1739{
1740	switch (evsel->core.attr.config) {
1741	case PERF_SYNTH_INTEL_PTWRITE:
1742		return perf_sample__fprintf_synth_ptwrite(sample, fp);
1743	case PERF_SYNTH_INTEL_MWAIT:
1744		return perf_sample__fprintf_synth_mwait(sample, fp);
1745	case PERF_SYNTH_INTEL_PWRE:
1746		return perf_sample__fprintf_synth_pwre(sample, fp);
1747	case PERF_SYNTH_INTEL_EXSTOP:
1748		return perf_sample__fprintf_synth_exstop(sample, fp);
1749	case PERF_SYNTH_INTEL_PWRX:
1750		return perf_sample__fprintf_synth_pwrx(sample, fp);
1751	case PERF_SYNTH_INTEL_CBR:
1752		return perf_sample__fprintf_synth_cbr(sample, fp);
1753	default:
1754		break;
1755	}
1756
1757	return 0;
1758}
1759
1760static int evlist__max_name_len(struct evlist *evlist)
1761{
1762	struct evsel *evsel;
1763	int max = 0;
1764
1765	evlist__for_each_entry(evlist, evsel) {
1766		int len = strlen(evsel__name(evsel));
1767
1768		max = MAX(len, max);
1769	}
1770
1771	return max;
1772}
1773
1774static int data_src__fprintf(u64 data_src, FILE *fp)
1775{
1776	struct mem_info mi = { .data_src.val = data_src };
1777	char decode[100];
1778	char out[100];
1779	static int maxlen;
1780	int len;
1781
1782	perf_script__meminfo_scnprintf(decode, 100, &mi);
1783
1784	len = scnprintf(out, 100, "%16" PRIx64 " %s", data_src, decode);
1785	if (maxlen < len)
1786		maxlen = len;
1787
1788	return fprintf(fp, "%-*s", maxlen, out);
1789}
1790
1791struct metric_ctx {
1792	struct perf_sample	*sample;
1793	struct thread		*thread;
1794	struct evsel	*evsel;
1795	FILE 			*fp;
1796};
1797
1798static void script_print_metric(struct perf_stat_config *config __maybe_unused,
1799				void *ctx, const char *color,
1800			        const char *fmt,
1801			        const char *unit, double val)
1802{
1803	struct metric_ctx *mctx = ctx;
1804
1805	if (!fmt)
1806		return;
1807	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1808				   PERF_RECORD_SAMPLE, mctx->fp);
1809	fputs("\tmetric: ", mctx->fp);
1810	if (color)
1811		color_fprintf(mctx->fp, color, fmt, val);
1812	else
1813		printf(fmt, val);
1814	fprintf(mctx->fp, " %s\n", unit);
1815}
1816
1817static void script_new_line(struct perf_stat_config *config __maybe_unused,
1818			    void *ctx)
1819{
1820	struct metric_ctx *mctx = ctx;
1821
1822	perf_sample__fprintf_start(NULL, mctx->sample, mctx->thread, mctx->evsel,
1823				   PERF_RECORD_SAMPLE, mctx->fp);
1824	fputs("\tmetric: ", mctx->fp);
1825}
1826
1827static void perf_sample__fprint_metric(struct perf_script *script,
1828				       struct thread *thread,
1829				       struct evsel *evsel,
1830				       struct perf_sample *sample,
1831				       FILE *fp)
1832{
1833	struct perf_stat_output_ctx ctx = {
1834		.print_metric = script_print_metric,
1835		.new_line = script_new_line,
1836		.ctx = &(struct metric_ctx) {
1837				.sample = sample,
1838				.thread = thread,
1839				.evsel  = evsel,
1840				.fp     = fp,
1841			 },
1842		.force_header = false,
1843	};
1844	struct evsel *ev2;
1845	u64 val;
1846
1847	if (!evsel->stats)
1848		perf_evlist__alloc_stats(script->session->evlist, false);
1849	if (evsel_script(evsel->leader)->gnum++ == 0)
1850		perf_stat__reset_shadow_stats();
1851	val = sample->period * evsel->scale;
1852	perf_stat__update_shadow_stats(evsel,
1853				       val,
1854				       sample->cpu,
1855				       &rt_stat);
1856	evsel_script(evsel)->val = val;
1857	if (evsel_script(evsel->leader)->gnum == evsel->leader->core.nr_members) {
1858		for_each_group_member (ev2, evsel->leader) {
1859			perf_stat__print_shadow_stats(&stat_config, ev2,
1860						      evsel_script(ev2)->val,
1861						      sample->cpu,
1862						      &ctx,
1863						      NULL,
1864						      &rt_stat);
1865		}
1866		evsel_script(evsel->leader)->gnum = 0;
1867	}
1868}
1869
1870static bool show_event(struct perf_sample *sample,
1871		       struct evsel *evsel,
1872		       struct thread *thread,
1873		       struct addr_location *al)
1874{
1875	int depth = thread_stack__depth(thread, sample->cpu);
1876
1877	if (!symbol_conf.graph_function)
1878		return true;
1879
1880	if (thread->filter) {
1881		if (depth <= thread->filter_entry_depth) {
1882			thread->filter = false;
1883			return false;
1884		}
1885		return true;
1886	} else {
1887		const char *s = symbol_conf.graph_function;
1888		u64 ip;
1889		const char *name = resolve_branch_sym(sample, evsel, thread, al,
1890				&ip);
1891		unsigned nlen;
1892
1893		if (!name)
1894			return false;
1895		nlen = strlen(name);
1896		while (*s) {
1897			unsigned len = strcspn(s, ",");
1898			if (nlen == len && !strncmp(name, s, len)) {
1899				thread->filter = true;
1900				thread->filter_entry_depth = depth;
1901				return true;
1902			}
1903			s += len;
1904			if (*s == ',')
1905				s++;
1906		}
1907		return false;
1908	}
1909}
1910
1911static void process_event(struct perf_script *script,
1912			  struct perf_sample *sample, struct evsel *evsel,
1913			  struct addr_location *al,
1914			  struct machine *machine)
1915{
1916	struct thread *thread = al->thread;
1917	struct perf_event_attr *attr = &evsel->core.attr;
1918	unsigned int type = output_type(attr->type);
1919	struct evsel_script *es = evsel->priv;
1920	FILE *fp = es->fp;
1921
1922	if (output[type].fields == 0)
1923		return;
1924
1925	if (!show_event(sample, evsel, thread, al))
1926		return;
1927
1928	if (evswitch__discard(&script->evswitch, evsel))
1929		return;
1930
1931	++es->samples;
1932
1933	perf_sample__fprintf_start(script, sample, thread, evsel,
1934				   PERF_RECORD_SAMPLE, fp);
1935
1936	if (PRINT_FIELD(PERIOD))
1937		fprintf(fp, "%10" PRIu64 " ", sample->period);
1938
1939	if (PRINT_FIELD(EVNAME)) {
1940		const char *evname = evsel__name(evsel);
1941
1942		if (!script->name_width)
1943			script->name_width = evlist__max_name_len(script->session->evlist);
1944
1945		fprintf(fp, "%*s: ", script->name_width, evname ?: "[unknown]");
1946	}
1947
1948	if (print_flags)
1949		perf_sample__fprintf_flags(sample->flags, fp);
1950
1951	if (is_bts_event(attr)) {
1952		perf_sample__fprintf_bts(sample, evsel, thread, al, machine, fp);
1953		return;
1954	}
1955
1956	if (PRINT_FIELD(TRACE) && sample->raw_data) {
1957		event_format__fprintf(evsel->tp_format, sample->cpu,
1958				      sample->raw_data, sample->raw_size, fp);
1959	}
1960
1961	if (attr->type == PERF_TYPE_SYNTH && PRINT_FIELD(SYNTH))
1962		perf_sample__fprintf_synth(sample, evsel, fp);
1963
1964	if (PRINT_FIELD(ADDR))
1965		perf_sample__fprintf_addr(sample, thread, attr, fp);
1966
1967	if (PRINT_FIELD(DATA_SRC))
1968		data_src__fprintf(sample->data_src, fp);
1969
1970	if (PRINT_FIELD(WEIGHT))
1971		fprintf(fp, "%16" PRIu64, sample->weight);
1972
1973	if (PRINT_FIELD(IP)) {
1974		struct callchain_cursor *cursor = NULL;
1975
1976		if (script->stitch_lbr)
1977			al->thread->lbr_stitch_enable = true;
1978
1979		if (symbol_conf.use_callchain && sample->callchain &&
1980		    thread__resolve_callchain(al->thread, &callchain_cursor, evsel,
1981					      sample, NULL, NULL, scripting_max_stack) == 0)
1982			cursor = &callchain_cursor;
1983
1984		fputc(cursor ? '\n' : ' ', fp);
1985		sample__fprintf_sym(sample, al, 0, output[type].print_ip_opts, cursor,
1986				    symbol_conf.bt_stop_list, fp);
1987	}
1988
1989	if (PRINT_FIELD(IREGS))
1990		perf_sample__fprintf_iregs(sample, attr, fp);
1991
1992	if (PRINT_FIELD(UREGS))
1993		perf_sample__fprintf_uregs(sample, attr, fp);
1994
1995	if (PRINT_FIELD(BRSTACK))
1996		perf_sample__fprintf_brstack(sample, thread, attr, fp);
1997	else if (PRINT_FIELD(BRSTACKSYM))
1998		perf_sample__fprintf_brstacksym(sample, thread, attr, fp);
1999	else if (PRINT_FIELD(BRSTACKOFF))
2000		perf_sample__fprintf_brstackoff(sample, thread, attr, fp);
2001
2002	if (evsel__is_bpf_output(evsel) && PRINT_FIELD(BPF_OUTPUT))
2003		perf_sample__fprintf_bpf_output(sample, fp);
2004	perf_sample__fprintf_insn(sample, attr, thread, machine, fp);
2005
2006	if (PRINT_FIELD(PHYS_ADDR))
2007		fprintf(fp, "%16" PRIx64, sample->phys_addr);
2008
2009	perf_sample__fprintf_ipc(sample, attr, fp);
2010
2011	fprintf(fp, "\n");
2012
2013	if (PRINT_FIELD(SRCCODE)) {
2014		if (map__fprintf_srccode(al->map, al->addr, stdout,
2015					 &thread->srccode_state))
2016			printf("\n");
2017	}
2018
2019	if (PRINT_FIELD(METRIC))
2020		perf_sample__fprint_metric(script, thread, evsel, sample, fp);
2021
2022	if (verbose)
2023		fflush(fp);
2024}
2025
2026static struct scripting_ops	*scripting_ops;
2027
2028static void __process_stat(struct evsel *counter, u64 tstamp)
2029{
2030	int nthreads = perf_thread_map__nr(counter->core.threads);
2031	int ncpus = evsel__nr_cpus(counter);
2032	int cpu, thread;
2033	static int header_printed;
2034
2035	if (counter->core.system_wide)
2036		nthreads = 1;
2037
2038	if (!header_printed) {
2039		printf("%3s %8s %15s %15s %15s %15s %s\n",
2040		       "CPU", "THREAD", "VAL", "ENA", "RUN", "TIME", "EVENT");
2041		header_printed = 1;
2042	}
2043
2044	for (thread = 0; thread < nthreads; thread++) {
2045		for (cpu = 0; cpu < ncpus; cpu++) {
2046			struct perf_counts_values *counts;
2047
2048			counts = perf_counts(counter->counts, cpu, thread);
2049
2050			printf("%3d %8d %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %15" PRIu64 " %s\n",
2051				counter->core.cpus->map[cpu],
2052				perf_thread_map__pid(counter->core.threads, thread),
2053				counts->val,
2054				counts->ena,
2055				counts->run,
2056				tstamp,
2057				evsel__name(counter));
2058		}
2059	}
2060}
2061
2062static void process_stat(struct evsel *counter, u64 tstamp)
2063{
2064	if (scripting_ops && scripting_ops->process_stat)
2065		scripting_ops->process_stat(&stat_config, counter, tstamp);
2066	else
2067		__process_stat(counter, tstamp);
2068}
2069
2070static void process_stat_interval(u64 tstamp)
2071{
2072	if (scripting_ops && scripting_ops->process_stat_interval)
2073		scripting_ops->process_stat_interval(tstamp);
2074}
2075
2076static void setup_scripting(void)
2077{
2078	setup_perl_scripting();
2079	setup_python_scripting();
2080}
2081
2082static int flush_scripting(void)
2083{
2084	return scripting_ops ? scripting_ops->flush_script() : 0;
2085}
2086
2087static int cleanup_scripting(void)
2088{
2089	pr_debug("\nperf script stopped\n");
2090
2091	return scripting_ops ? scripting_ops->stop_script() : 0;
2092}
2093
2094static bool filter_cpu(struct perf_sample *sample)
2095{
2096	if (cpu_list && sample->cpu != (u32)-1)
2097		return !test_bit(sample->cpu, cpu_bitmap);
2098	return false;
2099}
2100
2101static int process_sample_event(struct perf_tool *tool,
2102				union perf_event *event,
2103				struct perf_sample *sample,
2104				struct evsel *evsel,
2105				struct machine *machine)
2106{
2107	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2108	struct addr_location al;
 
 
2109
2110	if (perf_time__ranges_skip_sample(scr->ptime_range, scr->range_num,
2111					  sample->time)) {
2112		return 0;
 
2113	}
2114
2115	if (debug_mode) {
2116		if (sample->time < last_timestamp) {
2117			pr_err("Samples misordered, previous: %" PRIu64
2118				" this: %" PRIu64 "\n", last_timestamp,
2119				sample->time);
2120			nr_unordered++;
2121		}
2122		last_timestamp = sample->time;
2123		return 0;
2124	}
2125
2126	if (machine__resolve(machine, &al, sample) < 0) {
2127		pr_err("problem processing %d event, skipping it.\n",
2128		       event->header.type);
2129		return -1;
2130	}
2131
2132	if (al.filtered)
2133		goto out_put;
2134
2135	if (filter_cpu(sample))
2136		goto out_put;
2137
2138	if (scripting_ops)
2139		scripting_ops->process_event(event, sample, evsel, &al);
2140	else
2141		process_event(scr, sample, evsel, &al, machine);
2142
2143out_put:
2144	addr_location__put(&al);
2145	return 0;
2146}
2147
 
 
 
 
 
 
 
2148static int process_attr(struct perf_tool *tool, union perf_event *event,
2149			struct evlist **pevlist)
2150{
2151	struct perf_script *scr = container_of(tool, struct perf_script, tool);
2152	struct evlist *evlist;
2153	struct evsel *evsel, *pos;
2154	u64 sample_type;
2155	int err;
2156	static struct evsel_script *es;
2157
2158	err = perf_event__process_attr(tool, event, pevlist);
2159	if (err)
2160		return err;
2161
2162	evlist = *pevlist;
2163	evsel = evlist__last(*pevlist);
2164
2165	if (!evsel->priv) {
2166		if (scr->per_event_dump) {
2167			evsel->priv = perf_evsel_script__new(evsel,
2168						scr->session->data);
2169		} else {
2170			es = zalloc(sizeof(*es));
2171			if (!es)
2172				return -ENOMEM;
2173			es->fp = stdout;
2174			evsel->priv = es;
2175		}
2176	}
2177
2178	if (evsel->core.attr.type >= PERF_TYPE_MAX &&
2179	    evsel->core.attr.type != PERF_TYPE_SYNTH)
2180		return 0;
2181
2182	evlist__for_each_entry(evlist, pos) {
2183		if (pos->core.attr.type == evsel->core.attr.type && pos != evsel)
2184			return 0;
2185	}
2186
2187	if (evsel->core.attr.sample_type) {
2188		err = evsel__check_attr(evsel, scr->session);
2189		if (err)
2190			return err;
2191	}
2192
2193	/*
2194	 * Check if we need to enable callchains based
2195	 * on events sample_type.
2196	 */
2197	sample_type = evlist__combined_sample_type(evlist);
2198	callchain_param_setup(sample_type);
2199
2200	/* Enable fields for callchain entries */
2201	if (symbol_conf.use_callchain &&
2202	    (sample_type & PERF_SAMPLE_CALLCHAIN ||
2203	     sample_type & PERF_SAMPLE_BRANCH_STACK ||
2204	     (sample_type & PERF_SAMPLE_REGS_USER &&
2205	      sample_type & PERF_SAMPLE_STACK_USER))) {
2206		int type = output_type(evsel->core.attr.type);
2207
2208		if (!(output[type].user_unset_fields & PERF_OUTPUT_IP))
2209			output[type].fields |= PERF_OUTPUT_IP;
2210		if (!(output[type].user_unset_fields & PERF_OUTPUT_SYM))
2211			output[type].fields |= PERF_OUTPUT_SYM;
2212	}
2213	set_print_ip_opts(&evsel->core.attr);
2214	return 0;
2215}
2216
2217static int print_event_with_time(struct perf_tool *tool,
2218				 union perf_event *event,
2219				 struct perf_sample *sample,
2220				 struct machine *machine,
2221				 pid_t pid, pid_t tid, u64 timestamp)
2222{
 
2223	struct perf_script *script = container_of(tool, struct perf_script, tool);
2224	struct perf_session *session = script->session;
2225	struct evsel *evsel = perf_evlist__id2evsel(session->evlist, sample->id);
2226	struct thread *thread = NULL;
2227
2228	if (evsel && !evsel->core.attr.sample_id_all) {
2229		sample->cpu = 0;
2230		sample->time = timestamp;
2231		sample->pid = pid;
2232		sample->tid = tid;
2233	}
2234
2235	if (filter_cpu(sample))
2236		return 0;
2237
2238	if (tid != -1)
2239		thread = machine__findnew_thread(machine, pid, tid);
 
 
 
 
 
 
 
2240
2241	if (thread && evsel) {
2242		perf_sample__fprintf_start(script, sample, thread, evsel,
2243					   event->header.type, stdout);
2244	}
2245
2246	perf_event__fprintf(event, machine, stdout);
2247
2248	thread__put(thread);
2249
2250	return 0;
2251}
2252
2253static int print_event(struct perf_tool *tool, union perf_event *event,
2254		       struct perf_sample *sample, struct machine *machine,
2255		       pid_t pid, pid_t tid)
2256{
2257	return print_event_with_time(tool, event, sample, machine, pid, tid, 0);
2258}
2259
2260static int process_comm_event(struct perf_tool *tool,
2261			      union perf_event *event,
2262			      struct perf_sample *sample,
2263			      struct machine *machine)
2264{
2265	if (perf_event__process_comm(tool, event, sample, machine) < 0)
 
 
 
 
 
2266		return -1;
2267
2268	return print_event(tool, event, sample, machine, event->comm.pid,
2269			   event->comm.tid);
2270}
2271
2272static int process_namespaces_event(struct perf_tool *tool,
2273				    union perf_event *event,
2274				    struct perf_sample *sample,
2275				    struct machine *machine)
2276{
2277	if (perf_event__process_namespaces(tool, event, sample, machine) < 0)
2278		return -1;
 
2279
2280	return print_event(tool, event, sample, machine, event->namespaces.pid,
2281			   event->namespaces.tid);
2282}
 
 
 
 
 
2283
2284static int process_cgroup_event(struct perf_tool *tool,
2285				union perf_event *event,
2286				struct perf_sample *sample,
2287				struct machine *machine)
2288{
2289	if (perf_event__process_cgroup(tool, event, sample, machine) < 0)
2290		return -1;
2291
2292	return print_event(tool, event, sample, machine, sample->pid,
2293			    sample->tid);
2294}
2295
2296static int process_fork_event(struct perf_tool *tool,
2297			      union perf_event *event,
2298			      struct perf_sample *sample,
2299			      struct machine *machine)
2300{
2301	if (perf_event__process_fork(tool, event, sample, machine) < 0)
 
 
 
 
 
 
 
2302		return -1;
 
2303
2304	return print_event_with_time(tool, event, sample, machine,
2305				     event->fork.pid, event->fork.tid,
2306				     event->fork.time);
2307}
2308static int process_exit_event(struct perf_tool *tool,
2309			      union perf_event *event,
2310			      struct perf_sample *sample,
2311			      struct machine *machine)
2312{
2313	/* Print before 'exit' deletes anything */
2314	if (print_event_with_time(tool, event, sample, machine, event->fork.pid,
2315				  event->fork.tid, event->fork.time))
2316		return -1;
2317
2318	return perf_event__process_exit(tool, event, sample, machine);
2319}
2320
2321static int process_mmap_event(struct perf_tool *tool,
2322			      union perf_event *event,
2323			      struct perf_sample *sample,
2324			      struct machine *machine)
2325{
 
 
 
 
 
2326	if (perf_event__process_mmap(tool, event, sample, machine) < 0)
2327		return -1;
2328
2329	return print_event(tool, event, sample, machine, event->mmap.pid,
2330			   event->mmap.tid);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2331}
2332
2333static int process_mmap2_event(struct perf_tool *tool,
2334			      union perf_event *event,
2335			      struct perf_sample *sample,
2336			      struct machine *machine)
2337{
2338	if (perf_event__process_mmap2(tool, event, sample, machine) < 0)
2339		return -1;
2340
2341	return print_event(tool, event, sample, machine, event->mmap2.pid,
2342			   event->mmap2.tid);
2343}
2344
2345static int process_switch_event(struct perf_tool *tool,
2346				union perf_event *event,
2347				struct perf_sample *sample,
2348				struct machine *machine)
2349{
2350	struct perf_script *script = container_of(tool, struct perf_script, tool);
 
 
2351
2352	if (perf_event__process_switch(tool, event, sample, machine) < 0)
2353		return -1;
2354
2355	if (scripting_ops && scripting_ops->process_switch)
2356		scripting_ops->process_switch(event, sample, machine);
2357
2358	if (!script->show_switch_events)
2359		return 0;
2360
2361	return print_event(tool, event, sample, machine, sample->pid,
2362			   sample->tid);
2363}
2364
2365static int
2366process_lost_event(struct perf_tool *tool,
2367		   union perf_event *event,
2368		   struct perf_sample *sample,
2369		   struct machine *machine)
2370{
2371	return print_event(tool, event, sample, machine, sample->pid,
2372			   sample->tid);
2373}
2374
2375static int
2376process_finished_round_event(struct perf_tool *tool __maybe_unused,
2377			     union perf_event *event,
2378			     struct ordered_events *oe __maybe_unused)
2379
2380{
2381	perf_event__fprintf(event, NULL, stdout);
2382	return 0;
2383}
2384
2385static int
2386process_bpf_events(struct perf_tool *tool __maybe_unused,
2387		   union perf_event *event,
2388		   struct perf_sample *sample,
2389		   struct machine *machine)
2390{
2391	if (machine__process_ksymbol(machine, event, sample) < 0)
2392		return -1;
2393
2394	return print_event(tool, event, sample, machine, sample->pid,
2395			   sample->tid);
2396}
2397
2398static int process_text_poke_events(struct perf_tool *tool,
2399				    union perf_event *event,
2400				    struct perf_sample *sample,
2401				    struct machine *machine)
2402{
2403	if (perf_event__process_text_poke(tool, event, sample, machine) < 0)
2404		return -1;
2405
2406	return print_event(tool, event, sample, machine, sample->pid,
2407			   sample->tid);
2408}
2409
2410static void sig_handler(int sig __maybe_unused)
2411{
2412	session_done = 1;
2413}
2414
2415static void perf_script__fclose_per_event_dump(struct perf_script *script)
2416{
2417	struct evlist *evlist = script->session->evlist;
2418	struct evsel *evsel;
2419
2420	evlist__for_each_entry(evlist, evsel) {
2421		if (!evsel->priv)
2422			break;
2423		perf_evsel_script__delete(evsel->priv);
2424		evsel->priv = NULL;
2425	}
2426}
2427
2428static int perf_script__fopen_per_event_dump(struct perf_script *script)
2429{
2430	struct evsel *evsel;
2431
2432	evlist__for_each_entry(script->session->evlist, evsel) {
2433		/*
2434		 * Already setup? I.e. we may be called twice in cases like
2435		 * Intel PT, one for the intel_pt// and dummy events, then
2436		 * for the evsels syntheized from the auxtrace info.
2437		 *
2438		 * Ses perf_script__process_auxtrace_info.
2439		 */
2440		if (evsel->priv != NULL)
2441			continue;
2442
2443		evsel->priv = perf_evsel_script__new(evsel, script->session->data);
2444		if (evsel->priv == NULL)
2445			goto out_err_fclose;
2446	}
 
 
2447
2448	return 0;
2449
2450out_err_fclose:
2451	perf_script__fclose_per_event_dump(script);
2452	return -1;
2453}
2454
2455static int perf_script__setup_per_event_dump(struct perf_script *script)
2456{
2457	struct evsel *evsel;
2458	static struct evsel_script es_stdout;
2459
2460	if (script->per_event_dump)
2461		return perf_script__fopen_per_event_dump(script);
2462
2463	es_stdout.fp = stdout;
2464
2465	evlist__for_each_entry(script->session->evlist, evsel)
2466		evsel->priv = &es_stdout;
2467
2468	return 0;
2469}
2470
2471static void perf_script__exit_per_event_dump_stats(struct perf_script *script)
2472{
2473	struct evsel *evsel;
2474
2475	evlist__for_each_entry(script->session->evlist, evsel) {
2476		struct evsel_script *es = evsel->priv;
2477
2478		perf_evsel_script__fprintf(es, stdout);
2479		perf_evsel_script__delete(es);
2480		evsel->priv = NULL;
2481	}
2482}
2483
2484static int __cmd_script(struct perf_script *script)
2485{
2486	int ret;
2487
2488	signal(SIGINT, sig_handler);
2489
2490	perf_stat__init_shadow_stats();
2491
2492	/* override event processing functions */
2493	if (script->show_task_events) {
2494		script->tool.comm = process_comm_event;
2495		script->tool.fork = process_fork_event;
2496		script->tool.exit = process_exit_event;
2497	}
2498	if (script->show_mmap_events) {
2499		script->tool.mmap = process_mmap_event;
2500		script->tool.mmap2 = process_mmap2_event;
2501	}
2502	if (script->show_switch_events || (scripting_ops && scripting_ops->process_switch))
2503		script->tool.context_switch = process_switch_event;
2504	if (script->show_namespace_events)
2505		script->tool.namespaces = process_namespaces_event;
2506	if (script->show_cgroup_events)
2507		script->tool.cgroup = process_cgroup_event;
2508	if (script->show_lost_events)
2509		script->tool.lost = process_lost_event;
2510	if (script->show_round_events) {
2511		script->tool.ordered_events = false;
2512		script->tool.finished_round = process_finished_round_event;
2513	}
2514	if (script->show_bpf_events) {
2515		script->tool.ksymbol = process_bpf_events;
2516		script->tool.bpf     = process_bpf_events;
2517	}
2518	if (script->show_text_poke_events) {
2519		script->tool.ksymbol   = process_bpf_events;
2520		script->tool.text_poke = process_text_poke_events;
2521	}
2522
2523	if (perf_script__setup_per_event_dump(script)) {
2524		pr_err("Couldn't create the per event dump files\n");
2525		return -1;
2526	}
2527
2528	ret = perf_session__process_events(script->session);
2529
2530	if (script->per_event_dump)
2531		perf_script__exit_per_event_dump_stats(script);
2532
2533	if (debug_mode)
2534		pr_err("Misordered timestamps: %" PRIu64 "\n", nr_unordered);
2535
2536	return ret;
2537}
2538
2539struct script_spec {
2540	struct list_head	node;
2541	struct scripting_ops	*ops;
2542	char			spec[];
2543};
2544
2545static LIST_HEAD(script_specs);
2546
2547static struct script_spec *script_spec__new(const char *spec,
2548					    struct scripting_ops *ops)
2549{
2550	struct script_spec *s = malloc(sizeof(*s) + strlen(spec) + 1);
2551
2552	if (s != NULL) {
2553		strcpy(s->spec, spec);
2554		s->ops = ops;
2555	}
2556
2557	return s;
2558}
2559
2560static void script_spec__add(struct script_spec *s)
2561{
2562	list_add_tail(&s->node, &script_specs);
2563}
2564
2565static struct script_spec *script_spec__find(const char *spec)
2566{
2567	struct script_spec *s;
2568
2569	list_for_each_entry(s, &script_specs, node)
2570		if (strcasecmp(s->spec, spec) == 0)
2571			return s;
2572	return NULL;
2573}
2574
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2575int script_spec_register(const char *spec, struct scripting_ops *ops)
2576{
2577	struct script_spec *s;
2578
2579	s = script_spec__find(spec);
2580	if (s)
2581		return -1;
2582
2583	s = script_spec__new(spec, ops);
2584	if (!s)
2585		return -1;
2586	else
2587		script_spec__add(s);
2588
2589	return 0;
2590}
2591
2592static struct scripting_ops *script_spec__lookup(const char *spec)
2593{
2594	struct script_spec *s = script_spec__find(spec);
2595	if (!s)
2596		return NULL;
2597
2598	return s->ops;
2599}
2600
2601static void list_available_languages(void)
2602{
2603	struct script_spec *s;
2604
2605	fprintf(stderr, "\n");
2606	fprintf(stderr, "Scripting language extensions (used in "
2607		"perf script -s [spec:]script.[spec]):\n\n");
2608
2609	list_for_each_entry(s, &script_specs, node)
2610		fprintf(stderr, "  %-42s [%s]\n", s->spec, s->ops->name);
2611
2612	fprintf(stderr, "\n");
2613}
2614
2615static int parse_scriptname(const struct option *opt __maybe_unused,
2616			    const char *str, int unset __maybe_unused)
2617{
2618	char spec[PATH_MAX];
2619	const char *script, *ext;
2620	int len;
2621
2622	if (strcmp(str, "lang") == 0) {
2623		list_available_languages();
2624		exit(0);
2625	}
2626
2627	script = strchr(str, ':');
2628	if (script) {
2629		len = script - str;
2630		if (len >= PATH_MAX) {
2631			fprintf(stderr, "invalid language specifier");
2632			return -1;
2633		}
2634		strncpy(spec, str, len);
2635		spec[len] = '\0';
2636		scripting_ops = script_spec__lookup(spec);
2637		if (!scripting_ops) {
2638			fprintf(stderr, "invalid language specifier");
2639			return -1;
2640		}
2641		script++;
2642	} else {
2643		script = str;
2644		ext = strrchr(script, '.');
2645		if (!ext) {
2646			fprintf(stderr, "invalid script extension");
2647			return -1;
2648		}
2649		scripting_ops = script_spec__lookup(++ext);
2650		if (!scripting_ops) {
2651			fprintf(stderr, "invalid script extension");
2652			return -1;
2653		}
2654	}
2655
2656	script_name = strdup(script);
2657
2658	return 0;
2659}
2660
2661static int parse_output_fields(const struct option *opt __maybe_unused,
2662			    const char *arg, int unset __maybe_unused)
2663{
2664	char *tok, *strtok_saveptr = NULL;
2665	int i, imax = ARRAY_SIZE(all_output_options);
2666	int j;
2667	int rc = 0;
2668	char *str = strdup(arg);
2669	int type = -1;
2670	enum { DEFAULT, SET, ADD, REMOVE } change = DEFAULT;
2671
2672	if (!str)
2673		return -ENOMEM;
2674
2675	/* first word can state for which event type the user is specifying
2676	 * the fields. If no type exists, the specified fields apply to all
2677	 * event types found in the file minus the invalid fields for a type.
2678	 */
2679	tok = strchr(str, ':');
2680	if (tok) {
2681		*tok = '\0';
2682		tok++;
2683		if (!strcmp(str, "hw"))
2684			type = PERF_TYPE_HARDWARE;
2685		else if (!strcmp(str, "sw"))
2686			type = PERF_TYPE_SOFTWARE;
2687		else if (!strcmp(str, "trace"))
2688			type = PERF_TYPE_TRACEPOINT;
2689		else if (!strcmp(str, "raw"))
2690			type = PERF_TYPE_RAW;
2691		else if (!strcmp(str, "break"))
2692			type = PERF_TYPE_BREAKPOINT;
2693		else if (!strcmp(str, "synth"))
2694			type = OUTPUT_TYPE_SYNTH;
2695		else {
2696			fprintf(stderr, "Invalid event type in field string.\n");
2697			rc = -EINVAL;
2698			goto out;
2699		}
2700
2701		if (output[type].user_set)
2702			pr_warning("Overriding previous field request for %s events.\n",
2703				   event_type(type));
2704
2705		/* Don't override defaults for +- */
2706		if (strchr(tok, '+') || strchr(tok, '-'))
2707			goto parse;
2708
2709		output[type].fields = 0;
2710		output[type].user_set = true;
2711		output[type].wildcard_set = false;
2712
2713	} else {
2714		tok = str;
2715		if (strlen(str) == 0) {
2716			fprintf(stderr,
2717				"Cannot set fields to 'none' for all event types.\n");
2718			rc = -EINVAL;
2719			goto out;
2720		}
2721
2722		/* Don't override defaults for +- */
2723		if (strchr(str, '+') || strchr(str, '-'))
2724			goto parse;
2725
2726		if (output_set_by_user())
2727			pr_warning("Overriding previous field request for all events.\n");
2728
2729		for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2730			output[j].fields = 0;
2731			output[j].user_set = true;
2732			output[j].wildcard_set = true;
2733		}
2734	}
2735
2736parse:
2737	for (tok = strtok_r(tok, ",", &strtok_saveptr); tok; tok = strtok_r(NULL, ",", &strtok_saveptr)) {
2738		if (*tok == '+') {
2739			if (change == SET)
2740				goto out_badmix;
2741			change = ADD;
2742			tok++;
2743		} else if (*tok == '-') {
2744			if (change == SET)
2745				goto out_badmix;
2746			change = REMOVE;
2747			tok++;
2748		} else {
2749			if (change != SET && change != DEFAULT)
2750				goto out_badmix;
2751			change = SET;
2752		}
2753
2754		for (i = 0; i < imax; ++i) {
2755			if (strcmp(tok, all_output_options[i].str) == 0)
2756				break;
2757		}
2758		if (i == imax && strcmp(tok, "flags") == 0) {
2759			print_flags = change == REMOVE ? false : true;
2760			continue;
2761		}
2762		if (i == imax) {
2763			fprintf(stderr, "Invalid field requested.\n");
2764			rc = -EINVAL;
2765			goto out;
2766		}
2767
2768		if (type == -1) {
2769			/* add user option to all events types for
2770			 * which it is valid
2771			 */
2772			for (j = 0; j < OUTPUT_TYPE_MAX; ++j) {
2773				if (output[j].invalid_fields & all_output_options[i].field) {
2774					pr_warning("\'%s\' not valid for %s events. Ignoring.\n",
2775						   all_output_options[i].str, event_type(j));
2776				} else {
2777					if (change == REMOVE) {
2778						output[j].fields &= ~all_output_options[i].field;
2779						output[j].user_set_fields &= ~all_output_options[i].field;
2780						output[j].user_unset_fields |= all_output_options[i].field;
2781					} else {
2782						output[j].fields |= all_output_options[i].field;
2783						output[j].user_set_fields |= all_output_options[i].field;
2784						output[j].user_unset_fields &= ~all_output_options[i].field;
2785					}
2786					output[j].user_set = true;
2787					output[j].wildcard_set = true;
2788				}
2789			}
2790		} else {
2791			if (output[type].invalid_fields & all_output_options[i].field) {
2792				fprintf(stderr, "\'%s\' not valid for %s events.\n",
2793					 all_output_options[i].str, event_type(type));
2794
2795				rc = -EINVAL;
2796				goto out;
2797			}
2798			if (change == REMOVE)
2799				output[type].fields &= ~all_output_options[i].field;
2800			else
2801				output[type].fields |= all_output_options[i].field;
2802			output[type].user_set = true;
2803			output[type].wildcard_set = true;
2804		}
 
 
2805	}
2806
2807	if (type >= 0) {
2808		if (output[type].fields == 0) {
2809			pr_debug("No fields requested for %s type. "
2810				 "Events will not be displayed.\n", event_type(type));
2811		}
2812	}
2813	goto out;
2814
2815out_badmix:
2816	fprintf(stderr, "Cannot mix +-field with overridden fields\n");
2817	rc = -EINVAL;
2818out:
2819	free(str);
2820	return rc;
2821}
2822
2823#define for_each_lang(scripts_path, scripts_dir, lang_dirent)		\
2824	while ((lang_dirent = readdir(scripts_dir)) != NULL)		\
2825		if ((lang_dirent->d_type == DT_DIR ||			\
2826		     (lang_dirent->d_type == DT_UNKNOWN &&		\
2827		      is_directory(scripts_path, lang_dirent))) &&	\
2828		    (strcmp(lang_dirent->d_name, ".")) &&		\
2829		    (strcmp(lang_dirent->d_name, "..")))
2830
2831#define for_each_script(lang_path, lang_dir, script_dirent)		\
2832	while ((script_dirent = readdir(lang_dir)) != NULL)		\
2833		if (script_dirent->d_type != DT_DIR &&			\
2834		    (script_dirent->d_type != DT_UNKNOWN ||		\
2835		     !is_directory(lang_path, script_dirent)))
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2836
2837
2838#define RECORD_SUFFIX			"-record"
2839#define REPORT_SUFFIX			"-report"
2840
2841struct script_desc {
2842	struct list_head	node;
2843	char			*name;
2844	char			*half_liner;
2845	char			*args;
2846};
2847
2848static LIST_HEAD(script_descs);
2849
2850static struct script_desc *script_desc__new(const char *name)
2851{
2852	struct script_desc *s = zalloc(sizeof(*s));
2853
2854	if (s != NULL && name)
2855		s->name = strdup(name);
2856
2857	return s;
2858}
2859
2860static void script_desc__delete(struct script_desc *s)
2861{
2862	zfree(&s->name);
2863	zfree(&s->half_liner);
2864	zfree(&s->args);
2865	free(s);
2866}
2867
2868static void script_desc__add(struct script_desc *s)
2869{
2870	list_add_tail(&s->node, &script_descs);
2871}
2872
2873static struct script_desc *script_desc__find(const char *name)
2874{
2875	struct script_desc *s;
2876
2877	list_for_each_entry(s, &script_descs, node)
2878		if (strcasecmp(s->name, name) == 0)
2879			return s;
2880	return NULL;
2881}
2882
2883static struct script_desc *script_desc__findnew(const char *name)
2884{
2885	struct script_desc *s = script_desc__find(name);
2886
2887	if (s)
2888		return s;
2889
2890	s = script_desc__new(name);
2891	if (!s)
2892		return NULL;
2893
2894	script_desc__add(s);
2895
2896	return s;
 
 
 
 
 
2897}
2898
2899static const char *ends_with(const char *str, const char *suffix)
2900{
2901	size_t suffix_len = strlen(suffix);
2902	const char *p = str;
2903
2904	if (strlen(str) > suffix_len) {
2905		p = str + strlen(str) - suffix_len;
2906		if (!strncmp(p, suffix, suffix_len))
2907			return p;
2908	}
2909
2910	return NULL;
2911}
2912
2913static int read_script_info(struct script_desc *desc, const char *filename)
2914{
2915	char line[BUFSIZ], *p;
2916	FILE *fp;
2917
2918	fp = fopen(filename, "r");
2919	if (!fp)
2920		return -1;
2921
2922	while (fgets(line, sizeof(line), fp)) {
2923		p = skip_spaces(line);
2924		if (strlen(p) == 0)
2925			continue;
2926		if (*p != '#')
2927			continue;
2928		p++;
2929		if (strlen(p) && *p == '!')
2930			continue;
2931
2932		p = skip_spaces(p);
2933		if (strlen(p) && p[strlen(p) - 1] == '\n')
2934			p[strlen(p) - 1] = '\0';
2935
2936		if (!strncmp(p, "description:", strlen("description:"))) {
2937			p += strlen("description:");
2938			desc->half_liner = strdup(skip_spaces(p));
2939			continue;
2940		}
2941
2942		if (!strncmp(p, "args:", strlen("args:"))) {
2943			p += strlen("args:");
2944			desc->args = strdup(skip_spaces(p));
2945			continue;
2946		}
2947	}
2948
2949	fclose(fp);
2950
2951	return 0;
2952}
2953
2954static char *get_script_root(struct dirent *script_dirent, const char *suffix)
2955{
2956	char *script_root, *str;
2957
2958	script_root = strdup(script_dirent->d_name);
2959	if (!script_root)
2960		return NULL;
2961
2962	str = (char *)ends_with(script_root, suffix);
2963	if (!str) {
2964		free(script_root);
2965		return NULL;
2966	}
2967
2968	*str = '\0';
2969	return script_root;
2970}
2971
2972static int list_available_scripts(const struct option *opt __maybe_unused,
2973				  const char *s __maybe_unused,
2974				  int unset __maybe_unused)
2975{
2976	struct dirent *script_dirent, *lang_dirent;
2977	char scripts_path[MAXPATHLEN];
2978	DIR *scripts_dir, *lang_dir;
2979	char script_path[MAXPATHLEN];
2980	char lang_path[MAXPATHLEN];
2981	struct script_desc *desc;
2982	char first_half[BUFSIZ];
2983	char *script_root;
2984
2985	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
2986
2987	scripts_dir = opendir(scripts_path);
2988	if (!scripts_dir) {
2989		fprintf(stdout,
2990			"open(%s) failed.\n"
2991			"Check \"PERF_EXEC_PATH\" env to set scripts dir.\n",
2992			scripts_path);
2993		exit(-1);
2994	}
2995
2996	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
2997		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
2998			  lang_dirent->d_name);
2999		lang_dir = opendir(lang_path);
3000		if (!lang_dir)
3001			continue;
3002
3003		for_each_script(lang_path, lang_dir, script_dirent) {
3004			script_root = get_script_root(script_dirent, REPORT_SUFFIX);
3005			if (script_root) {
3006				desc = script_desc__findnew(script_root);
3007				scnprintf(script_path, MAXPATHLEN, "%s/%s",
3008					  lang_path, script_dirent->d_name);
3009				read_script_info(desc, script_path);
3010				free(script_root);
3011			}
3012		}
3013	}
3014
3015	fprintf(stdout, "List of available trace scripts:\n");
3016	list_for_each_entry(desc, &script_descs, node) {
3017		sprintf(first_half, "%s %s", desc->name,
3018			desc->args ? desc->args : "");
3019		fprintf(stdout, "  %-36s %s\n", first_half,
3020			desc->half_liner ? desc->half_liner : "");
3021	}
3022
3023	exit(0);
3024}
3025
3026/*
3027 * Some scripts specify the required events in their "xxx-record" file,
3028 * this function will check if the events in perf.data match those
3029 * mentioned in the "xxx-record".
3030 *
3031 * Fixme: All existing "xxx-record" are all in good formats "-e event ",
3032 * which is covered well now. And new parsing code should be added to
3033 * cover the future complexing formats like event groups etc.
3034 */
3035static int check_ev_match(char *dir_name, char *scriptname,
3036			struct perf_session *session)
3037{
3038	char filename[MAXPATHLEN], evname[128];
3039	char line[BUFSIZ], *p;
3040	struct evsel *pos;
3041	int match, len;
3042	FILE *fp;
3043
3044	scnprintf(filename, MAXPATHLEN, "%s/bin/%s-record", dir_name, scriptname);
3045
3046	fp = fopen(filename, "r");
3047	if (!fp)
3048		return -1;
3049
3050	while (fgets(line, sizeof(line), fp)) {
3051		p = skip_spaces(line);
3052		if (*p == '#')
3053			continue;
3054
3055		while (strlen(p)) {
3056			p = strstr(p, "-e");
3057			if (!p)
3058				break;
3059
3060			p += 2;
3061			p = skip_spaces(p);
3062			len = strcspn(p, " \t");
3063			if (!len)
3064				break;
3065
3066			snprintf(evname, len + 1, "%s", p);
3067
3068			match = 0;
3069			evlist__for_each_entry(session->evlist, pos) {
3070				if (!strcmp(evsel__name(pos), evname)) {
3071					match = 1;
3072					break;
3073				}
3074			}
3075
3076			if (!match) {
3077				fclose(fp);
3078				return -1;
3079			}
3080		}
3081	}
3082
3083	fclose(fp);
3084	return 0;
3085}
3086
3087/*
3088 * Return -1 if none is found, otherwise the actual scripts number.
3089 *
3090 * Currently the only user of this function is the script browser, which
3091 * will list all statically runnable scripts, select one, execute it and
3092 * show the output in a perf browser.
3093 */
3094int find_scripts(char **scripts_array, char **scripts_path_array, int num,
3095		 int pathlen)
3096{
3097	struct dirent *script_dirent, *lang_dirent;
3098	char scripts_path[MAXPATHLEN], lang_path[MAXPATHLEN];
3099	DIR *scripts_dir, *lang_dir;
3100	struct perf_session *session;
3101	struct perf_data data = {
3102		.path = input_name,
3103		.mode = PERF_DATA_MODE_READ,
3104	};
3105	char *temp;
3106	int i = 0;
3107
3108	session = perf_session__new(&data, false, NULL);
3109	if (IS_ERR(session))
3110		return PTR_ERR(session);
3111
3112	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3113
3114	scripts_dir = opendir(scripts_path);
3115	if (!scripts_dir) {
3116		perf_session__delete(session);
3117		return -1;
3118	}
3119
3120	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3121		scnprintf(lang_path, MAXPATHLEN, "%s/%s", scripts_path,
3122			  lang_dirent->d_name);
3123#ifndef HAVE_LIBPERL_SUPPORT
3124		if (strstr(lang_path, "perl"))
3125			continue;
3126#endif
3127#ifndef HAVE_LIBPYTHON_SUPPORT
3128		if (strstr(lang_path, "python"))
3129			continue;
3130#endif
3131
3132		lang_dir = opendir(lang_path);
3133		if (!lang_dir)
3134			continue;
3135
3136		for_each_script(lang_path, lang_dir, script_dirent) {
3137			/* Skip those real time scripts: xxxtop.p[yl] */
3138			if (strstr(script_dirent->d_name, "top."))
3139				continue;
3140			if (i >= num)
3141				break;
3142			snprintf(scripts_path_array[i], pathlen, "%s/%s",
3143				lang_path,
3144				script_dirent->d_name);
3145			temp = strchr(script_dirent->d_name, '.');
3146			snprintf(scripts_array[i],
3147				(temp - script_dirent->d_name) + 1,
3148				"%s", script_dirent->d_name);
3149
3150			if (check_ev_match(lang_path,
3151					scripts_array[i], session))
3152				continue;
3153
3154			i++;
3155		}
3156		closedir(lang_dir);
3157	}
3158
3159	closedir(scripts_dir);
3160	perf_session__delete(session);
3161	return i;
3162}
3163
3164static char *get_script_path(const char *script_root, const char *suffix)
3165{
3166	struct dirent *script_dirent, *lang_dirent;
3167	char scripts_path[MAXPATHLEN];
3168	char script_path[MAXPATHLEN];
3169	DIR *scripts_dir, *lang_dir;
3170	char lang_path[MAXPATHLEN];
3171	char *__script_root;
3172
3173	snprintf(scripts_path, MAXPATHLEN, "%s/scripts", get_argv_exec_path());
3174
3175	scripts_dir = opendir(scripts_path);
3176	if (!scripts_dir)
3177		return NULL;
3178
3179	for_each_lang(scripts_path, scripts_dir, lang_dirent) {
3180		scnprintf(lang_path, MAXPATHLEN, "%s/%s/bin", scripts_path,
3181			  lang_dirent->d_name);
3182		lang_dir = opendir(lang_path);
3183		if (!lang_dir)
3184			continue;
3185
3186		for_each_script(lang_path, lang_dir, script_dirent) {
3187			__script_root = get_script_root(script_dirent, suffix);
3188			if (__script_root && !strcmp(script_root, __script_root)) {
3189				free(__script_root);
 
3190				closedir(scripts_dir);
3191				scnprintf(script_path, MAXPATHLEN, "%s/%s",
3192					  lang_path, script_dirent->d_name);
3193				closedir(lang_dir);
3194				return strdup(script_path);
3195			}
3196			free(__script_root);
3197		}
3198		closedir(lang_dir);
3199	}
3200	closedir(scripts_dir);
3201
3202	return NULL;
3203}
3204
3205static bool is_top_script(const char *script_path)
3206{
3207	return ends_with(script_path, "top") == NULL ? false : true;
3208}
3209
3210static int has_required_arg(char *script_path)
3211{
3212	struct script_desc *desc;
3213	int n_args = 0;
3214	char *p;
3215
3216	desc = script_desc__new(NULL);
3217
3218	if (read_script_info(desc, script_path))
3219		goto out;
3220
3221	if (!desc->args)
3222		goto out;
3223
3224	for (p = desc->args; *p; p++)
3225		if (*p == '<')
3226			n_args++;
3227out:
3228	script_desc__delete(desc);
3229
3230	return n_args;
3231}
3232
3233static int have_cmd(int argc, const char **argv)
3234{
3235	char **__argv = malloc(sizeof(const char *) * argc);
3236
3237	if (!__argv) {
3238		pr_err("malloc failed\n");
3239		return -1;
3240	}
3241
3242	memcpy(__argv, argv, sizeof(const char *) * argc);
3243	argc = parse_options(argc, (const char **)__argv, record_options,
3244			     NULL, PARSE_OPT_STOP_AT_NON_OPTION);
3245	free(__argv);
3246
3247	system_wide = (argc == 0);
3248
3249	return 0;
3250}
3251
3252static void script__setup_sample_type(struct perf_script *script)
3253{
3254	struct perf_session *session = script->session;
3255	u64 sample_type = evlist__combined_sample_type(session->evlist);
3256
3257	if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
3258		if ((sample_type & PERF_SAMPLE_REGS_USER) &&
3259		    (sample_type & PERF_SAMPLE_STACK_USER)) {
3260			callchain_param.record_mode = CALLCHAIN_DWARF;
3261			dwarf_callchain_users = true;
3262		} else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
3263			callchain_param.record_mode = CALLCHAIN_LBR;
3264		else
3265			callchain_param.record_mode = CALLCHAIN_FP;
3266	}
3267
3268	if (script->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
3269		pr_warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
3270			   "Please apply --call-graph lbr when recording.\n");
3271		script->stitch_lbr = false;
3272	}
3273}
3274
3275static int process_stat_round_event(struct perf_session *session,
3276				    union perf_event *event)
3277{
3278	struct perf_record_stat_round *round = &event->stat_round;
3279	struct evsel *counter;
3280
3281	evlist__for_each_entry(session->evlist, counter) {
3282		perf_stat_process_counter(&stat_config, counter);
3283		process_stat(counter, round->time);
3284	}
3285
3286	process_stat_interval(round->time);
3287	return 0;
3288}
3289
3290static int process_stat_config_event(struct perf_session *session __maybe_unused,
3291				     union perf_event *event)
3292{
3293	perf_event__read_stat_config(&stat_config, &event->stat_config);
3294	return 0;
3295}
3296
3297static int set_maps(struct perf_script *script)
3298{
3299	struct evlist *evlist = script->session->evlist;
3300
3301	if (!script->cpus || !script->threads)
3302		return 0;
3303
3304	if (WARN_ONCE(script->allocated, "stats double allocation\n"))
3305		return -EINVAL;
3306
3307	perf_evlist__set_maps(&evlist->core, script->cpus, script->threads);
3308
3309	if (perf_evlist__alloc_stats(evlist, true))
3310		return -ENOMEM;
3311
3312	script->allocated = true;
3313	return 0;
3314}
3315
3316static
3317int process_thread_map_event(struct perf_session *session,
3318			     union perf_event *event)
3319{
3320	struct perf_tool *tool = session->tool;
3321	struct perf_script *script = container_of(tool, struct perf_script, tool);
3322
3323	if (script->threads) {
3324		pr_warning("Extra thread map event, ignoring.\n");
3325		return 0;
3326	}
3327
3328	script->threads = thread_map__new_event(&event->thread_map);
3329	if (!script->threads)
3330		return -ENOMEM;
3331
3332	return set_maps(script);
3333}
3334
3335static
3336int process_cpu_map_event(struct perf_session *session,
3337			  union perf_event *event)
3338{
3339	struct perf_tool *tool = session->tool;
3340	struct perf_script *script = container_of(tool, struct perf_script, tool);
3341
3342	if (script->cpus) {
3343		pr_warning("Extra cpu map event, ignoring.\n");
3344		return 0;
3345	}
3346
3347	script->cpus = cpu_map__new_data(&event->cpu_map.data);
3348	if (!script->cpus)
3349		return -ENOMEM;
3350
3351	return set_maps(script);
3352}
3353
3354static int process_feature_event(struct perf_session *session,
3355				 union perf_event *event)
3356{
3357	if (event->feat.feat_id < HEADER_LAST_FEATURE)
3358		return perf_event__process_feature(session, event);
3359	return 0;
3360}
3361
3362#ifdef HAVE_AUXTRACE_SUPPORT
3363static int perf_script__process_auxtrace_info(struct perf_session *session,
3364					      union perf_event *event)
3365{
3366	struct perf_tool *tool = session->tool;
3367
3368	int ret = perf_event__process_auxtrace_info(session, event);
3369
3370	if (ret == 0) {
3371		struct perf_script *script = container_of(tool, struct perf_script, tool);
3372
3373		ret = perf_script__setup_per_event_dump(script);
3374	}
3375
3376	return ret;
3377}
3378#else
3379#define perf_script__process_auxtrace_info 0
3380#endif
3381
3382static int parse_insn_trace(const struct option *opt __maybe_unused,
3383			    const char *str __maybe_unused,
3384			    int unset __maybe_unused)
3385{
3386	parse_output_fields(NULL, "+insn,-event,-period", 0);
3387	itrace_parse_synth_opts(opt, "i0ns", 0);
3388	symbol_conf.nanosecs = true;
3389	return 0;
3390}
3391
3392static int parse_xed(const struct option *opt __maybe_unused,
3393		     const char *str __maybe_unused,
3394		     int unset __maybe_unused)
3395{
3396	if (isatty(1))
3397		force_pager("xed -F insn: -A -64 | less");
3398	else
3399		force_pager("xed -F insn: -A -64");
3400	return 0;
3401}
3402
3403static int parse_call_trace(const struct option *opt __maybe_unused,
3404			    const char *str __maybe_unused,
3405			    int unset __maybe_unused)
3406{
3407	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent", 0);
3408	itrace_parse_synth_opts(opt, "cewp", 0);
3409	symbol_conf.nanosecs = true;
3410	symbol_conf.pad_output_len_dso = 50;
3411	return 0;
3412}
3413
3414static int parse_callret_trace(const struct option *opt __maybe_unused,
3415			    const char *str __maybe_unused,
3416			    int unset __maybe_unused)
3417{
3418	parse_output_fields(NULL, "-ip,-addr,-event,-period,+callindent,+flags", 0);
3419	itrace_parse_synth_opts(opt, "crewp", 0);
3420	symbol_conf.nanosecs = true;
3421	return 0;
3422}
3423
3424int cmd_script(int argc, const char **argv)
3425{
3426	bool show_full_info = false;
3427	bool header = false;
3428	bool header_only = false;
3429	bool script_started = false;
3430	char *rec_script_path = NULL;
3431	char *rep_script_path = NULL;
3432	struct perf_session *session;
3433	struct itrace_synth_opts itrace_synth_opts = {
3434		.set = false,
3435		.default_no_sample = true,
3436	};
3437	struct utsname uts;
3438	char *script_path = NULL;
3439	const char **__argv;
3440	int i, j, err = 0;
3441	struct perf_script script = {
3442		.tool = {
3443			.sample		 = process_sample_event,
3444			.mmap		 = perf_event__process_mmap,
3445			.mmap2		 = perf_event__process_mmap2,
3446			.comm		 = perf_event__process_comm,
3447			.namespaces	 = perf_event__process_namespaces,
3448			.cgroup		 = perf_event__process_cgroup,
3449			.exit		 = perf_event__process_exit,
3450			.fork		 = perf_event__process_fork,
3451			.attr		 = process_attr,
3452			.event_update   = perf_event__process_event_update,
3453			.tracing_data	 = perf_event__process_tracing_data,
3454			.feature	 = process_feature_event,
3455			.build_id	 = perf_event__process_build_id,
3456			.id_index	 = perf_event__process_id_index,
3457			.auxtrace_info	 = perf_script__process_auxtrace_info,
3458			.auxtrace	 = perf_event__process_auxtrace,
3459			.auxtrace_error	 = perf_event__process_auxtrace_error,
3460			.stat		 = perf_event__process_stat_event,
3461			.stat_round	 = process_stat_round_event,
3462			.stat_config	 = process_stat_config_event,
3463			.thread_map	 = process_thread_map_event,
3464			.cpu_map	 = process_cpu_map_event,
3465			.ordered_events	 = true,
3466			.ordering_requires_timestamps = true,
3467		},
3468	};
3469	struct perf_data data = {
3470		.mode = PERF_DATA_MODE_READ,
3471	};
3472	const struct option options[] = {
3473	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
3474		    "dump raw trace in ASCII"),
3475	OPT_INCR('v', "verbose", &verbose,
3476		 "be more verbose (show symbol address, etc)"),
3477	OPT_BOOLEAN('L', "Latency", &latency_format,
3478		    "show latency attributes (irqs/preemption disabled, etc)"),
3479	OPT_CALLBACK_NOOPT('l', "list", NULL, NULL, "list available scripts",
3480			   list_available_scripts),
3481	OPT_CALLBACK('s', "script", NULL, "name",
3482		     "script file name (lang:script name, script name, or *)",
3483		     parse_scriptname),
3484	OPT_STRING('g', "gen-script", &generate_script_lang, "lang",
3485		   "generate perf-script.xx script in specified language"),
3486	OPT_STRING('i', "input", &input_name, "file", "input file name"),
3487	OPT_BOOLEAN('d', "debug-mode", &debug_mode,
3488		   "do various checks like samples ordering and lost events"),
3489	OPT_BOOLEAN(0, "header", &header, "Show data header."),
3490	OPT_BOOLEAN(0, "header-only", &header_only, "Show only data header."),
3491	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
3492		   "file", "vmlinux pathname"),
3493	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
3494		   "file", "kallsyms pathname"),
3495	OPT_BOOLEAN('G', "hide-call-graph", &no_callchain,
3496		    "When printing symbols do not display call chain"),
3497	OPT_CALLBACK(0, "symfs", NULL, "directory",
3498		     "Look for files with symbols relative to this directory",
3499		     symbol__config_symfs),
3500	OPT_CALLBACK('F', "fields", NULL, "str",
3501		     "comma separated output fields prepend with 'type:'. "
3502		     "+field to add and -field to remove."
3503		     "Valid types: hw,sw,trace,raw,synth. "
3504		     "Fields: comm,tid,pid,time,cpu,event,trace,ip,sym,dso,"
3505		     "addr,symoff,srcline,period,iregs,uregs,brstack,"
3506		     "brstacksym,flags,bpf-output,brstackinsn,brstackoff,"
3507		     "callindent,insn,insnlen,synth,phys_addr,metric,misc,ipc,tod",
3508		     parse_output_fields),
3509	OPT_BOOLEAN('a', "all-cpus", &system_wide,
3510		    "system-wide collection from all CPUs"),
3511	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
3512		   "only consider these symbols"),
3513	OPT_CALLBACK_OPTARG(0, "insn-trace", &itrace_synth_opts, NULL, NULL,
3514			"Decode instructions from itrace", parse_insn_trace),
3515	OPT_CALLBACK_OPTARG(0, "xed", NULL, NULL, NULL,
3516			"Run xed disassembler on output", parse_xed),
3517	OPT_CALLBACK_OPTARG(0, "call-trace", &itrace_synth_opts, NULL, NULL,
3518			"Decode calls from from itrace", parse_call_trace),
3519	OPT_CALLBACK_OPTARG(0, "call-ret-trace", &itrace_synth_opts, NULL, NULL,
3520			"Decode calls and returns from itrace", parse_callret_trace),
3521	OPT_STRING(0, "graph-function", &symbol_conf.graph_function, "symbol[,symbol...]",
3522			"Only print symbols and callees with --call-trace/--call-ret-trace"),
3523	OPT_STRING(0, "stop-bt", &symbol_conf.bt_stop_list_str, "symbol[,symbol...]",
3524		   "Stop display of callgraph at these symbols"),
3525	OPT_STRING('C', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
3526	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
3527		   "only display events for these comms"),
3528	OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
3529		   "only consider symbols in these pids"),
3530	OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
3531		   "only consider symbols in these tids"),
3532	OPT_UINTEGER(0, "max-stack", &scripting_max_stack,
3533		     "Set the maximum stack depth when parsing the callchain, "
3534		     "anything beyond the specified depth will be ignored. "
3535		     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
3536	OPT_BOOLEAN(0, "reltime", &reltime, "Show time stamps relative to start"),
3537	OPT_BOOLEAN(0, "deltatime", &deltatime, "Show time stamps relative to previous event"),
3538	OPT_BOOLEAN('I', "show-info", &show_full_info,
3539		    "display extended information from perf.data file"),
3540	OPT_BOOLEAN('\0', "show-kernel-path", &symbol_conf.show_kernel_path,
3541		    "Show the path of [kernel.kallsyms]"),
3542	OPT_BOOLEAN('\0', "show-task-events", &script.show_task_events,
3543		    "Show the fork/comm/exit events"),
3544	OPT_BOOLEAN('\0', "show-mmap-events", &script.show_mmap_events,
3545		    "Show the mmap events"),
3546	OPT_BOOLEAN('\0', "show-switch-events", &script.show_switch_events,
3547		    "Show context switch events (if recorded)"),
3548	OPT_BOOLEAN('\0', "show-namespace-events", &script.show_namespace_events,
3549		    "Show namespace events (if recorded)"),
3550	OPT_BOOLEAN('\0', "show-cgroup-events", &script.show_cgroup_events,
3551		    "Show cgroup events (if recorded)"),
3552	OPT_BOOLEAN('\0', "show-lost-events", &script.show_lost_events,
3553		    "Show lost events (if recorded)"),
3554	OPT_BOOLEAN('\0', "show-round-events", &script.show_round_events,
3555		    "Show round events (if recorded)"),
3556	OPT_BOOLEAN('\0', "show-bpf-events", &script.show_bpf_events,
3557		    "Show bpf related events (if recorded)"),
3558	OPT_BOOLEAN('\0', "show-text-poke-events", &script.show_text_poke_events,
3559		    "Show text poke related events (if recorded)"),
3560	OPT_BOOLEAN('\0', "per-event-dump", &script.per_event_dump,
3561		    "Dump trace output to files named by the monitored events"),
3562	OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
3563	OPT_INTEGER(0, "max-blocks", &max_blocks,
3564		    "Maximum number of code blocks to dump with brstackinsn"),
3565	OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs,
3566		    "Use 9 decimal places when displaying time"),
3567	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
3568			    "Instruction Tracing options\n" ITRACE_HELP,
3569			    itrace_parse_synth_opts),
3570	OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
3571			"Show full source file name path for source lines"),
3572	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
3573			"Enable symbol demangling"),
3574	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
3575			"Enable kernel symbol demangling"),
3576	OPT_STRING(0, "time", &script.time_str, "str",
3577		   "Time span of interest (start,stop)"),
3578	OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
3579		    "Show inline function"),
3580	OPT_STRING(0, "guestmount", &symbol_conf.guestmount, "directory",
3581		   "guest mount directory under which every guest os"
3582		   " instance has a subdir"),
3583	OPT_STRING(0, "guestvmlinux", &symbol_conf.default_guest_vmlinux_name,
3584		   "file", "file saving guest os vmlinux"),
3585	OPT_STRING(0, "guestkallsyms", &symbol_conf.default_guest_kallsyms,
3586		   "file", "file saving guest os /proc/kallsyms"),
3587	OPT_STRING(0, "guestmodules", &symbol_conf.default_guest_modules,
3588		   "file", "file saving guest os /proc/modules"),
3589	OPT_BOOLEAN('\0', "stitch-lbr", &script.stitch_lbr,
3590		    "Enable LBR callgraph stitching approach"),
3591	OPTS_EVSWITCH(&script.evswitch),
3592	OPT_END()
3593	};
3594	const char * const script_subcommands[] = { "record", "report", NULL };
3595	const char *script_usage[] = {
3596		"perf script [<options>]",
3597		"perf script [<options>] record <script> [<record-options>] <command>",
3598		"perf script [<options>] report <script> [script-args]",
3599		"perf script [<options>] <script> [<record-options>] <command>",
3600		"perf script [<options>] <top-script> [script-args]",
3601		NULL
3602	};
3603
3604	perf_set_singlethreaded();
 
3605
3606	setup_scripting();
3607
3608	argc = parse_options_subcommand(argc, argv, options, script_subcommands, script_usage,
3609			     PARSE_OPT_STOP_AT_NON_OPTION);
3610
3611	if (symbol_conf.guestmount ||
3612	    symbol_conf.default_guest_vmlinux_name ||
3613	    symbol_conf.default_guest_kallsyms ||
3614	    symbol_conf.default_guest_modules) {
3615		/*
3616		 * Enable guest sample processing.
3617		 */
3618		perf_guest = true;
3619	}
3620
3621	data.path  = input_name;
3622	data.force = symbol_conf.force;
3623
3624	if (argc > 1 && !strncmp(argv[0], "rec", strlen("rec"))) {
3625		rec_script_path = get_script_path(argv[1], RECORD_SUFFIX);
3626		if (!rec_script_path)
3627			return cmd_record(argc, argv);
3628	}
3629
3630	if (argc > 1 && !strncmp(argv[0], "rep", strlen("rep"))) {
3631		rep_script_path = get_script_path(argv[1], REPORT_SUFFIX);
3632		if (!rep_script_path) {
3633			fprintf(stderr,
3634				"Please specify a valid report script"
3635				"(see 'perf script -l' for listing)\n");
3636			return -1;
3637		}
3638	}
3639
3640	if (reltime && deltatime) {
3641		fprintf(stderr,
3642			"reltime and deltatime - the two don't get along well. "
3643			"Please limit to --reltime or --deltatime.\n");
3644		return -1;
3645	}
3646
3647	if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
3648	    itrace_synth_opts.callchain_sz > scripting_max_stack)
3649		scripting_max_stack = itrace_synth_opts.callchain_sz;
3650
3651	/* make sure PERF_EXEC_PATH is set for scripts */
3652	set_argv_exec_path(get_argv_exec_path());
3653
3654	if (argc && !script_name && !rec_script_path && !rep_script_path) {
3655		int live_pipe[2];
3656		int rep_args;
3657		pid_t pid;
3658
3659		rec_script_path = get_script_path(argv[0], RECORD_SUFFIX);
3660		rep_script_path = get_script_path(argv[0], REPORT_SUFFIX);
3661
3662		if (!rec_script_path && !rep_script_path) {
3663			usage_with_options_msg(script_usage, options,
3664				"Couldn't find script `%s'\n\n See perf"
3665				" script -l for available scripts.\n", argv[0]);
 
3666		}
3667
3668		if (is_top_script(argv[0])) {
3669			rep_args = argc - 1;
3670		} else {
3671			int rec_args;
3672
3673			rep_args = has_required_arg(rep_script_path);
3674			rec_args = (argc - 1) - rep_args;
3675			if (rec_args < 0) {
3676				usage_with_options_msg(script_usage, options,
3677					"`%s' script requires options."
3678					"\n\n See perf script -l for available "
3679					"scripts and options.\n", argv[0]);
 
3680			}
3681		}
3682
3683		if (pipe(live_pipe) < 0) {
3684			perror("failed to create pipe");
3685			return -1;
3686		}
3687
3688		pid = fork();
3689		if (pid < 0) {
3690			perror("failed to fork");
3691			return -1;
3692		}
3693
3694		if (!pid) {
3695			j = 0;
3696
3697			dup2(live_pipe[1], 1);
3698			close(live_pipe[0]);
3699
3700			if (is_top_script(argv[0])) {
3701				system_wide = true;
3702			} else if (!system_wide) {
3703				if (have_cmd(argc - rep_args, &argv[rep_args]) != 0) {
3704					err = -1;
3705					goto out;
3706				}
3707			}
3708
3709			__argv = malloc((argc + 6) * sizeof(const char *));
3710			if (!__argv) {
3711				pr_err("malloc failed\n");
3712				err = -ENOMEM;
3713				goto out;
3714			}
3715
3716			__argv[j++] = "/bin/sh";
3717			__argv[j++] = rec_script_path;
3718			if (system_wide)
3719				__argv[j++] = "-a";
3720			__argv[j++] = "-q";
3721			__argv[j++] = "-o";
3722			__argv[j++] = "-";
3723			for (i = rep_args + 1; i < argc; i++)
3724				__argv[j++] = argv[i];
3725			__argv[j++] = NULL;
3726
3727			execvp("/bin/sh", (char **)__argv);
3728			free(__argv);
3729			exit(-1);
3730		}
3731
3732		dup2(live_pipe[0], 0);
3733		close(live_pipe[1]);
3734
3735		__argv = malloc((argc + 4) * sizeof(const char *));
3736		if (!__argv) {
3737			pr_err("malloc failed\n");
3738			err = -ENOMEM;
3739			goto out;
3740		}
3741
3742		j = 0;
3743		__argv[j++] = "/bin/sh";
3744		__argv[j++] = rep_script_path;
3745		for (i = 1; i < rep_args + 1; i++)
3746			__argv[j++] = argv[i];
3747		__argv[j++] = "-i";
3748		__argv[j++] = "-";
3749		__argv[j++] = NULL;
3750
3751		execvp("/bin/sh", (char **)__argv);
3752		free(__argv);
3753		exit(-1);
3754	}
3755
3756	if (rec_script_path)
3757		script_path = rec_script_path;
3758	if (rep_script_path)
3759		script_path = rep_script_path;
3760
3761	if (script_path) {
3762		j = 0;
3763
3764		if (!rec_script_path)
3765			system_wide = false;
3766		else if (!system_wide) {
3767			if (have_cmd(argc - 1, &argv[1]) != 0) {
3768				err = -1;
3769				goto out;
3770			}
3771		}
3772
3773		__argv = malloc((argc + 2) * sizeof(const char *));
3774		if (!__argv) {
3775			pr_err("malloc failed\n");
3776			err = -ENOMEM;
3777			goto out;
3778		}
3779
3780		__argv[j++] = "/bin/sh";
3781		__argv[j++] = script_path;
3782		if (system_wide)
3783			__argv[j++] = "-a";
3784		for (i = 2; i < argc; i++)
3785			__argv[j++] = argv[i];
3786		__argv[j++] = NULL;
3787
3788		execvp("/bin/sh", (char **)__argv);
3789		free(__argv);
3790		exit(-1);
3791	}
3792
3793	if (!script_name) {
 
 
3794		setup_pager();
3795		use_browser = 0;
3796	}
3797
3798	session = perf_session__new(&data, false, &script.tool);
3799	if (IS_ERR(session))
3800		return PTR_ERR(session);
3801
3802	if (header || header_only) {
3803		script.tool.show_feat_hdr = SHOW_FEAT_HEADER;
3804		perf_session__fprintf_info(session, stdout, show_full_info);
3805		if (header_only)
3806			goto out_delete;
3807	}
3808	if (show_full_info)
3809		script.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
3810
3811	if (symbol__init(&session->header.env) < 0)
3812		goto out_delete;
3813
3814	uname(&uts);
3815	if (data.is_pipe ||  /* assume pipe_mode indicates native_arch */
3816	    !strcmp(uts.machine, session->header.env.arch) ||
3817	    (!strcmp(uts.machine, "x86_64") &&
3818	     !strcmp(session->header.env.arch, "i386")))
3819		native_arch = true;
3820
3821	script.session = session;
3822	script__setup_sample_type(&script);
3823
3824	if ((output[PERF_TYPE_HARDWARE].fields & PERF_OUTPUT_CALLINDENT) ||
3825	    symbol_conf.graph_function)
3826		itrace_synth_opts.thread_stack = true;
3827
3828	session->itrace_synth_opts = &itrace_synth_opts;
3829
3830	if (cpu_list) {
3831		err = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
3832		if (err < 0)
3833			goto out_delete;
3834		itrace_synth_opts.cpu_bitmap = cpu_bitmap;
3835	}
3836
3837	if (!no_callchain)
3838		symbol_conf.use_callchain = true;
3839	else
3840		symbol_conf.use_callchain = false;
3841
3842	if (session->tevent.pevent &&
3843	    tep_set_function_resolver(session->tevent.pevent,
3844				      machine__resolve_kernel_addr,
3845				      &session->machines.host) < 0) {
3846		pr_err("%s: failed to set libtraceevent function resolver\n", __func__);
3847		err = -1;
3848		goto out_delete;
3849	}
3850
3851	if (generate_script_lang) {
3852		struct stat perf_stat;
3853		int input;
3854
3855		if (output_set_by_user()) {
3856			fprintf(stderr,
3857				"custom fields not supported for generated scripts");
3858			err = -EINVAL;
3859			goto out_delete;
3860		}
3861
3862		input = open(data.path, O_RDONLY);	/* input_name */
3863		if (input < 0) {
3864			err = -errno;
3865			perror("failed to open file");
3866			goto out_delete;
3867		}
3868
3869		err = fstat(input, &perf_stat);
3870		if (err < 0) {
3871			perror("failed to stat file");
3872			goto out_delete;
3873		}
3874
3875		if (!perf_stat.st_size) {
3876			fprintf(stderr, "zero-sized file, nothing to do!\n");
3877			goto out_delete;
3878		}
3879
3880		scripting_ops = script_spec__lookup(generate_script_lang);
3881		if (!scripting_ops) {
3882			fprintf(stderr, "invalid language specifier");
3883			err = -ENOENT;
3884			goto out_delete;
3885		}
3886
3887		err = scripting_ops->generate_script(session->tevent.pevent,
3888						     "perf-script");
3889		goto out_delete;
3890	}
3891
3892	if (script_name) {
3893		err = scripting_ops->start_script(script_name, argc, argv);
3894		if (err)
3895			goto out_delete;
3896		pr_debug("perf script started with script %s\n\n", script_name);
3897		script_started = true;
3898	}
3899
3900
3901	err = perf_session__check_output_opt(session);
3902	if (err < 0)
3903		goto out_delete;
3904
3905	if (script.time_str) {
3906		err = perf_time__parse_for_ranges_reltime(script.time_str, session,
3907						  &script.ptime_range,
3908						  &script.range_size,
3909						  &script.range_num,
3910						  reltime);
3911		if (err < 0)
3912			goto out_delete;
3913
3914		itrace_synth_opts__set_time_range(&itrace_synth_opts,
3915						  script.ptime_range,
3916						  script.range_num);
3917	}
3918
3919	err = evswitch__init(&script.evswitch, session->evlist, stderr);
3920	if (err)
3921		goto out_delete;
3922
3923	if (zstd_init(&(session->zstd_data), 0) < 0)
3924		pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
3925
3926	err = __cmd_script(&script);
3927
3928	flush_scripting();
3929
3930out_delete:
3931	if (script.ptime_range) {
3932		itrace_synth_opts__clear_time_range(&itrace_synth_opts);
3933		zfree(&script.ptime_range);
3934	}
3935
3936	perf_evlist__free_stats(session->evlist);
3937	perf_session__delete(session);
3938
3939	if (script_started)
3940		cleanup_scripting();
3941out:
3942	return err;
3943}