xref: /OK3568_Linux_fs/kernel/tools/perf/util/jitdump.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * jitdump.h: jitted code info encapsulation file format
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Adapted from OProfile GPLv2 support jidump.h:
6*4882a593Smuzhiyun  * Copyright 2007 OProfile authors
7*4882a593Smuzhiyun  * Jens Wilke
8*4882a593Smuzhiyun  * Daniel Hansel
9*4882a593Smuzhiyun  * Copyright IBM Corporation 2007
10*4882a593Smuzhiyun  */
11*4882a593Smuzhiyun #ifndef JITDUMP_H
12*4882a593Smuzhiyun #define JITDUMP_H
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <sys/time.h>
15*4882a593Smuzhiyun #include <time.h>
16*4882a593Smuzhiyun #include <stdint.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun /* JiTD */
19*4882a593Smuzhiyun #define JITHEADER_MAGIC		0x4A695444
20*4882a593Smuzhiyun #define JITHEADER_MAGIC_SW	0x4454694A
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define PADDING_8ALIGNED(x) ((((x) + 7) & 7) ^ 7)
23*4882a593Smuzhiyun #define ALIGN_8(x) (((x) + 7) & (~7))
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #define JITHEADER_VERSION 1
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun enum jitdump_flags_bits {
28*4882a593Smuzhiyun 	JITDUMP_FLAGS_ARCH_TIMESTAMP_BIT,
29*4882a593Smuzhiyun 	JITDUMP_FLAGS_MAX_BIT,
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #define JITDUMP_FLAGS_ARCH_TIMESTAMP	(1ULL << JITDUMP_FLAGS_ARCH_TIMESTAMP_BIT)
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #define JITDUMP_FLAGS_RESERVED (JITDUMP_FLAGS_MAX_BIT < 64 ? \
35*4882a593Smuzhiyun 				(~((1ULL << JITDUMP_FLAGS_MAX_BIT) - 1)) : 0)
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun struct jitheader {
38*4882a593Smuzhiyun 	uint32_t magic;		/* characters "jItD" */
39*4882a593Smuzhiyun 	uint32_t version;	/* header version */
40*4882a593Smuzhiyun 	uint32_t total_size;	/* total size of header */
41*4882a593Smuzhiyun 	uint32_t elf_mach;	/* elf mach target */
42*4882a593Smuzhiyun 	uint32_t pad1;		/* reserved */
43*4882a593Smuzhiyun 	uint32_t pid;		/* JIT process id */
44*4882a593Smuzhiyun 	uint64_t timestamp;	/* timestamp */
45*4882a593Smuzhiyun 	uint64_t flags;		/* flags */
46*4882a593Smuzhiyun };
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun enum jit_record_type {
49*4882a593Smuzhiyun 	JIT_CODE_LOAD		= 0,
50*4882a593Smuzhiyun         JIT_CODE_MOVE           = 1,
51*4882a593Smuzhiyun 	JIT_CODE_DEBUG_INFO	= 2,
52*4882a593Smuzhiyun 	JIT_CODE_CLOSE		= 3,
53*4882a593Smuzhiyun 	JIT_CODE_UNWINDING_INFO	= 4,
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	JIT_CODE_MAX,
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun /* record prefix (mandatory in each record) */
59*4882a593Smuzhiyun struct jr_prefix {
60*4882a593Smuzhiyun 	uint32_t id;
61*4882a593Smuzhiyun 	uint32_t total_size;
62*4882a593Smuzhiyun 	uint64_t timestamp;
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun struct jr_code_load {
66*4882a593Smuzhiyun 	struct jr_prefix p;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	uint32_t pid;
69*4882a593Smuzhiyun 	uint32_t tid;
70*4882a593Smuzhiyun 	uint64_t vma;
71*4882a593Smuzhiyun 	uint64_t code_addr;
72*4882a593Smuzhiyun 	uint64_t code_size;
73*4882a593Smuzhiyun 	uint64_t code_index;
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun struct jr_code_close {
77*4882a593Smuzhiyun 	struct jr_prefix p;
78*4882a593Smuzhiyun };
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun struct jr_code_move {
81*4882a593Smuzhiyun 	struct jr_prefix p;
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	uint32_t pid;
84*4882a593Smuzhiyun 	uint32_t tid;
85*4882a593Smuzhiyun 	uint64_t vma;
86*4882a593Smuzhiyun 	uint64_t old_code_addr;
87*4882a593Smuzhiyun 	uint64_t new_code_addr;
88*4882a593Smuzhiyun 	uint64_t code_size;
89*4882a593Smuzhiyun 	uint64_t code_index;
90*4882a593Smuzhiyun };
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun struct debug_entry {
93*4882a593Smuzhiyun 	uint64_t addr;
94*4882a593Smuzhiyun 	int lineno;	    /* source line number starting at 1 */
95*4882a593Smuzhiyun 	int discrim;	    /* column discriminator, 0 is default */
96*4882a593Smuzhiyun 	const char name[]; /* null terminated filename, \xff\0 if same as previous entry */
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun struct jr_code_debug_info {
100*4882a593Smuzhiyun 	struct jr_prefix p;
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	uint64_t code_addr;
103*4882a593Smuzhiyun 	uint64_t nr_entry;
104*4882a593Smuzhiyun 	struct debug_entry entries[];
105*4882a593Smuzhiyun };
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun struct jr_code_unwinding_info {
108*4882a593Smuzhiyun 	struct jr_prefix p;
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun 	uint64_t unwinding_size;
111*4882a593Smuzhiyun 	uint64_t eh_frame_hdr_size;
112*4882a593Smuzhiyun 	uint64_t mapped_size;
113*4882a593Smuzhiyun 	const char unwinding_data[];
114*4882a593Smuzhiyun };
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun union jr_entry {
117*4882a593Smuzhiyun         struct jr_code_debug_info info;
118*4882a593Smuzhiyun         struct jr_code_close close;
119*4882a593Smuzhiyun         struct jr_code_load load;
120*4882a593Smuzhiyun         struct jr_code_move move;
121*4882a593Smuzhiyun         struct jr_prefix prefix;
122*4882a593Smuzhiyun         struct jr_code_unwinding_info unwinding;
123*4882a593Smuzhiyun };
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun static inline struct debug_entry *
debug_entry_next(struct debug_entry * ent)126*4882a593Smuzhiyun debug_entry_next(struct debug_entry *ent)
127*4882a593Smuzhiyun {
128*4882a593Smuzhiyun 	void *a = ent + 1;
129*4882a593Smuzhiyun 	size_t l = strlen(ent->name) + 1;
130*4882a593Smuzhiyun 	return a + l;
131*4882a593Smuzhiyun }
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun static inline char *
debug_entry_file(struct debug_entry * ent)134*4882a593Smuzhiyun debug_entry_file(struct debug_entry *ent)
135*4882a593Smuzhiyun {
136*4882a593Smuzhiyun 	void *a = ent + 1;
137*4882a593Smuzhiyun 	return a;
138*4882a593Smuzhiyun }
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun #endif /* !JITDUMP_H */
141