[mirror_ubuntu-bionic-kernel.git] / tools / perf / util / intel-pt-decoder / intel-pt-decoder.h

/*
 * intel_pt_decoder.h: Intel Processor Trace support
 * Copyright (c) 2013-2014, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#ifndef INCLUDE__INTEL_PT_DECODER_H__
#define INCLUDE__INTEL_PT_DECODER_H__

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>

#include "intel-pt-insn-decoder.h"

#define INTEL_PT_IN_TX		(1 << 0)
#define INTEL_PT_ABORT_TX	(1 << 1)
#define INTEL_PT_ASYNC		(1 << 2)
#define INTEL_PT_FUP_IP		(1 << 3)

enum intel_pt_sample_type {
	INTEL_PT_BRANCH		= 1 << 0,
	INTEL_PT_INSTRUCTION	= 1 << 1,
	INTEL_PT_TRANSACTION	= 1 << 2,
	INTEL_PT_PTW		= 1 << 3,
	INTEL_PT_MWAIT_OP	= 1 << 4,
	INTEL_PT_PWR_ENTRY	= 1 << 5,
	INTEL_PT_EX_STOP	= 1 << 6,
	INTEL_PT_PWR_EXIT	= 1 << 7,
	INTEL_PT_CBR_CHG	= 1 << 8,
};

enum intel_pt_period_type {
	INTEL_PT_PERIOD_NONE,
	INTEL_PT_PERIOD_INSTRUCTIONS,
	INTEL_PT_PERIOD_TICKS,
	INTEL_PT_PERIOD_MTC,
};

enum {
	INTEL_PT_ERR_NOMEM = 1,
	INTEL_PT_ERR_INTERN,
	INTEL_PT_ERR_BADPKT,
	INTEL_PT_ERR_NODATA,
	INTEL_PT_ERR_NOINSN,
	INTEL_PT_ERR_MISMAT,
	INTEL_PT_ERR_OVR,
	INTEL_PT_ERR_LOST,
	INTEL_PT_ERR_UNK,
	INTEL_PT_ERR_NELOOP,
	INTEL_PT_ERR_MAX,
};

struct intel_pt_state {
	enum intel_pt_sample_type type;
	int err;
	uint64_t from_ip;
	uint64_t to_ip;
	uint64_t cr3;
	uint64_t tot_insn_cnt;
	uint64_t timestamp;
	uint64_t est_timestamp;
	uint64_t trace_nr;
	uint64_t ptw_payload;
	uint64_t mwait_payload;
	uint64_t pwre_payload;
	uint64_t pwrx_payload;
	uint64_t cbr_payload;
	uint32_t flags;
	enum intel_pt_insn_op insn_op;
	int insn_len;
	char insn[INTEL_PT_INSN_BUF_SZ];
};

struct intel_pt_insn;

struct intel_pt_buffer {
	const unsigned char *buf;
	size_t len;
	bool consecutive;
	uint64_t ref_timestamp;
	uint64_t trace_nr;
};

struct intel_pt_params {
	int (*get_trace)(struct intel_pt_buffer *buffer, void *data);
	int (*walk_insn)(struct intel_pt_insn *intel_pt_insn,
			 uint64_t *insn_cnt_ptr, uint64_t *ip, uint64_t to_ip,
			 uint64_t max_insn_cnt, void *data);
	bool (*pgd_ip)(uint64_t ip, void *data);
	void *data;
	bool return_compression;
	bool branch_enable;
	uint64_t period;
	enum intel_pt_period_type period_type;
	unsigned max_non_turbo_ratio;
	unsigned int mtc_period;
	uint32_t tsc_ctc_ratio_n;
	uint32_t tsc_ctc_ratio_d;
};

struct intel_pt_decoder;

struct intel_pt_decoder *intel_pt_decoder_new(struct intel_pt_params *params);
void intel_pt_decoder_free(struct intel_pt_decoder *decoder);

const struct intel_pt_state *intel_pt_decode(struct intel_pt_decoder *decoder);

unsigned char *intel_pt_find_overlap(unsigned char *buf_a, size_t len_a,
				     unsigned char *buf_b, size_t len_b,
				     bool have_tsc);

int intel_pt__strerror(int code, char *buf, size_t buflen);

#endif
Commit	Line	Data
f4aa0819 AH	1	/*
	2	* intel_pt_decoder.h: Intel Processor Trace support
	3	* Copyright (c) 2013-2014, Intel Corporation.
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms and conditions of the GNU General Public License,
	7	* version 2, as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	*/
	15
	16	#ifndef INCLUDE__INTEL_PT_DECODER_H__
	17	#define INCLUDE__INTEL_PT_DECODER_H__
	18
	19	#include <stdint.h>
	20	#include <stddef.h>
	21	#include <stdbool.h>
	22
	23	#include "intel-pt-insn-decoder.h"
	24
	25	#define INTEL_PT_IN_TX (1 << 0)
	26	#define INTEL_PT_ABORT_TX (1 << 1)
	27	#define INTEL_PT_ASYNC (1 << 2)
a472e65f	28	#define INTEL_PT_FUP_IP (1 << 3)
f4aa0819 AH	29
	30	enum intel_pt_sample_type {
	31	INTEL_PT_BRANCH = 1 << 0,
	32	INTEL_PT_INSTRUCTION = 1 << 1,
	33	INTEL_PT_TRANSACTION = 1 << 2,
a472e65f AH	34	INTEL_PT_PTW = 1 << 3,
	35	INTEL_PT_MWAIT_OP = 1 << 4,
	36	INTEL_PT_PWR_ENTRY = 1 << 5,
	37	INTEL_PT_EX_STOP = 1 << 6,
	38	INTEL_PT_PWR_EXIT = 1 << 7,
0a7c700d	39	INTEL_PT_CBR_CHG = 1 << 8,
f4aa0819 AH	40	};
	41
	42	enum intel_pt_period_type {
	43	INTEL_PT_PERIOD_NONE,
	44	INTEL_PT_PERIOD_INSTRUCTIONS,
	45	INTEL_PT_PERIOD_TICKS,
79b58424	46	INTEL_PT_PERIOD_MTC,
f4aa0819 AH	47	};
	48
	49	enum {
	50	INTEL_PT_ERR_NOMEM = 1,
	51	INTEL_PT_ERR_INTERN,
	52	INTEL_PT_ERR_BADPKT,
	53	INTEL_PT_ERR_NODATA,
	54	INTEL_PT_ERR_NOINSN,
	55	INTEL_PT_ERR_MISMAT,
	56	INTEL_PT_ERR_OVR,
	57	INTEL_PT_ERR_LOST,
	58	INTEL_PT_ERR_UNK,
	59	INTEL_PT_ERR_NELOOP,
	60	INTEL_PT_ERR_MAX,
	61	};
	62
	63	struct intel_pt_state {
	64	enum intel_pt_sample_type type;
	65	int err;
	66	uint64_t from_ip;
	67	uint64_t to_ip;
	68	uint64_t cr3;
2a21d036	69	uint64_t tot_insn_cnt;
f4aa0819 AH	70	uint64_t timestamp;
	71	uint64_t est_timestamp;
	72	uint64_t trace_nr;
a472e65f AH	73	uint64_t ptw_payload;
	74	uint64_t mwait_payload;
	75	uint64_t pwre_payload;
	76	uint64_t pwrx_payload;
0a7c700d	77	uint64_t cbr_payload;
f4aa0819 AH	78	uint32_t flags;
	79	enum intel_pt_insn_op insn_op;
	80	int insn_len;
faaa8768	81	char insn[INTEL_PT_INSN_BUF_SZ];
f4aa0819 AH	82	};
	83
	84	struct intel_pt_insn;
	85
	86	struct intel_pt_buffer {
	87	const unsigned char *buf;
	88	size_t len;
	89	bool consecutive;
	90	uint64_t ref_timestamp;
	91	uint64_t trace_nr;
	92	};
	93
	94	struct intel_pt_params {
	95	int (get_trace)(struct intel_pt_buffer buffer, void *data);
	96	int (walk_insn)(struct intel_pt_insn intel_pt_insn,
	97	uint64_t insn_cnt_ptr, uint64_t ip, uint64_t to_ip,
	98	uint64_t max_insn_cnt, void *data);
9f1d122b	99	bool (pgd_ip)(uint64_t ip, void data);
f4aa0819 AH	100	void *data;
f4aa0819 AH	101	bool return_compression;
83959817	102	bool branch_enable;
f4aa0819 AH	103	uint64_t period;
	104	enum intel_pt_period_type period_type;
	105	unsigned max_non_turbo_ratio;
11fa7cb8 AH	106	unsigned int mtc_period;
	107	uint32_t tsc_ctc_ratio_n;
	108	uint32_t tsc_ctc_ratio_d;
f4aa0819 AH	109	};
	110
	111	struct intel_pt_decoder;
	112
	113	struct intel_pt_decoder intel_pt_decoder_new(struct intel_pt_params params);
	114	void intel_pt_decoder_free(struct intel_pt_decoder *decoder);
	115
	116	const struct intel_pt_state intel_pt_decode(struct intel_pt_decoder decoder);
	117
	118	unsigned char intel_pt_find_overlap(unsigned char buf_a, size_t len_a,
	119	unsigned char *buf_b, size_t len_b,
	120	bool have_tsc);
	121
	122	int intel_pt__strerror(int code, char *buf, size_t buflen);
	123
	124	#endif