xref: /src/contrib/processor-trace/libipt/internal/include/pt_packet_decoder.h (revision 85f87cf491bec6f90948a85b10f5523ea24db9e3)
1766f5c51SRuslan Bukin /*
285f87cf4SRuslan Bukin  * Copyright (c) 2014-2019, Intel Corporation
3766f5c51SRuslan Bukin  *
4766f5c51SRuslan Bukin  * Redistribution and use in source and binary forms, with or without
5766f5c51SRuslan Bukin  * modification, are permitted provided that the following conditions are met:
6766f5c51SRuslan Bukin  *
7766f5c51SRuslan Bukin  *  * Redistributions of source code must retain the above copyright notice,
8766f5c51SRuslan Bukin  *    this list of conditions and the following disclaimer.
9766f5c51SRuslan Bukin  *  * Redistributions in binary form must reproduce the above copyright notice,
10766f5c51SRuslan Bukin  *    this list of conditions and the following disclaimer in the documentation
11766f5c51SRuslan Bukin  *    and/or other materials provided with the distribution.
12766f5c51SRuslan Bukin  *  * Neither the name of Intel Corporation nor the names of its contributors
13766f5c51SRuslan Bukin  *    may be used to endorse or promote products derived from this software
14766f5c51SRuslan Bukin  *    without specific prior written permission.
15766f5c51SRuslan Bukin  *
16766f5c51SRuslan Bukin  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17766f5c51SRuslan Bukin  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18766f5c51SRuslan Bukin  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19766f5c51SRuslan Bukin  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20766f5c51SRuslan Bukin  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21766f5c51SRuslan Bukin  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22766f5c51SRuslan Bukin  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23766f5c51SRuslan Bukin  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24766f5c51SRuslan Bukin  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25766f5c51SRuslan Bukin  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26766f5c51SRuslan Bukin  * POSSIBILITY OF SUCH DAMAGE.
27766f5c51SRuslan Bukin  */
28766f5c51SRuslan Bukin 
29766f5c51SRuslan Bukin #ifndef PT_PACKET_DECODER_H
30766f5c51SRuslan Bukin #define PT_PACKET_DECODER_H
31766f5c51SRuslan Bukin 
32766f5c51SRuslan Bukin #include "intel-pt.h"
33766f5c51SRuslan Bukin 
34766f5c51SRuslan Bukin 
35766f5c51SRuslan Bukin /* An Intel PT packet decoder. */
36766f5c51SRuslan Bukin struct pt_packet_decoder {
37766f5c51SRuslan Bukin 	/* The decoder configuration. */
38766f5c51SRuslan Bukin 	struct pt_config config;
39766f5c51SRuslan Bukin 
40766f5c51SRuslan Bukin 	/* The current position in the trace buffer. */
41766f5c51SRuslan Bukin 	const uint8_t *pos;
42766f5c51SRuslan Bukin 
43766f5c51SRuslan Bukin 	/* The position of the last PSB packet. */
44766f5c51SRuslan Bukin 	const uint8_t *sync;
45766f5c51SRuslan Bukin };
46766f5c51SRuslan Bukin 
47766f5c51SRuslan Bukin 
48766f5c51SRuslan Bukin /* Initialize the packet decoder.
49766f5c51SRuslan Bukin  *
50766f5c51SRuslan Bukin  * Returns zero on success, a negative error code otherwise.
51766f5c51SRuslan Bukin  */
52766f5c51SRuslan Bukin extern int pt_pkt_decoder_init(struct pt_packet_decoder *,
53766f5c51SRuslan Bukin 			       const struct pt_config *);
54766f5c51SRuslan Bukin 
55766f5c51SRuslan Bukin /* Finalize the packet decoder. */
56766f5c51SRuslan Bukin extern void pt_pkt_decoder_fini(struct pt_packet_decoder *);
57766f5c51SRuslan Bukin 
58766f5c51SRuslan Bukin 
59766f5c51SRuslan Bukin /* Decoder functions for the packet decoder. */
60766f5c51SRuslan Bukin extern int pt_pkt_decode_unknown(struct pt_packet_decoder *,
61766f5c51SRuslan Bukin 				 struct pt_packet *);
62766f5c51SRuslan Bukin extern int pt_pkt_decode_pad(struct pt_packet_decoder *, struct pt_packet *);
63766f5c51SRuslan Bukin extern int pt_pkt_decode_psb(struct pt_packet_decoder *, struct pt_packet *);
64766f5c51SRuslan Bukin extern int pt_pkt_decode_tip(struct pt_packet_decoder *, struct pt_packet *);
65766f5c51SRuslan Bukin extern int pt_pkt_decode_tnt_8(struct pt_packet_decoder *, struct pt_packet *);
66766f5c51SRuslan Bukin extern int pt_pkt_decode_tnt_64(struct pt_packet_decoder *,
67766f5c51SRuslan Bukin 				struct pt_packet *);
68766f5c51SRuslan Bukin extern int pt_pkt_decode_tip_pge(struct pt_packet_decoder *,
69766f5c51SRuslan Bukin 				 struct pt_packet *);
70766f5c51SRuslan Bukin extern int pt_pkt_decode_tip_pgd(struct pt_packet_decoder *,
71766f5c51SRuslan Bukin 				 struct pt_packet *);
72766f5c51SRuslan Bukin extern int pt_pkt_decode_fup(struct pt_packet_decoder *, struct pt_packet *);
73766f5c51SRuslan Bukin extern int pt_pkt_decode_pip(struct pt_packet_decoder *, struct pt_packet *);
74766f5c51SRuslan Bukin extern int pt_pkt_decode_ovf(struct pt_packet_decoder *, struct pt_packet *);
75766f5c51SRuslan Bukin extern int pt_pkt_decode_mode(struct pt_packet_decoder *, struct pt_packet *);
76766f5c51SRuslan Bukin extern int pt_pkt_decode_psbend(struct pt_packet_decoder *,
77766f5c51SRuslan Bukin 				struct pt_packet *);
78766f5c51SRuslan Bukin extern int pt_pkt_decode_tsc(struct pt_packet_decoder *, struct pt_packet *);
79766f5c51SRuslan Bukin extern int pt_pkt_decode_cbr(struct pt_packet_decoder *, struct pt_packet *);
80766f5c51SRuslan Bukin extern int pt_pkt_decode_tma(struct pt_packet_decoder *, struct pt_packet *);
81766f5c51SRuslan Bukin extern int pt_pkt_decode_mtc(struct pt_packet_decoder *, struct pt_packet *);
82766f5c51SRuslan Bukin extern int pt_pkt_decode_cyc(struct pt_packet_decoder *, struct pt_packet *);
83766f5c51SRuslan Bukin extern int pt_pkt_decode_stop(struct pt_packet_decoder *, struct pt_packet *);
84766f5c51SRuslan Bukin extern int pt_pkt_decode_vmcs(struct pt_packet_decoder *, struct pt_packet *);
85766f5c51SRuslan Bukin extern int pt_pkt_decode_mnt(struct pt_packet_decoder *, struct pt_packet *);
86766f5c51SRuslan Bukin extern int pt_pkt_decode_exstop(struct pt_packet_decoder *, struct pt_packet *);
87766f5c51SRuslan Bukin extern int pt_pkt_decode_mwait(struct pt_packet_decoder *, struct pt_packet *);
88766f5c51SRuslan Bukin extern int pt_pkt_decode_pwre(struct pt_packet_decoder *, struct pt_packet *);
89766f5c51SRuslan Bukin extern int pt_pkt_decode_pwrx(struct pt_packet_decoder *, struct pt_packet *);
90766f5c51SRuslan Bukin extern int pt_pkt_decode_ptw(struct pt_packet_decoder *, struct pt_packet *);
91766f5c51SRuslan Bukin 
92766f5c51SRuslan Bukin #endif /* PT_PACKET_DECODER_H */
93