[linux-2.6-block.git] / tools / objtool / include / objtool / check.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2017 Josh Poimboeuf <jpoimboe@redhat.com>
 */

#ifndef _CHECK_H
#define _CHECK_H

#include <stdbool.h>
#include <objtool/cfi.h>
#include <objtool/arch.h>

struct insn_state {
	struct cfi_state cfi;
	unsigned int uaccess_stack;
	bool uaccess;
	bool df;
	bool noinstr;
	s8 instr;
};

struct alt_group {
	/*
	 * Pointer from a replacement group to the original group.  NULL if it
	 * *is* the original group.
	 */
	struct alt_group *orig_group;

	/* First and last instructions in the group */
	struct instruction *first_insn, *last_insn, *nop;

	/*
	 * Byte-offset-addressed len-sized array of pointers to CFI structs.
	 * This is shared with the other alt_groups in the same alternative.
	 */
	struct cfi_state **cfi;
};

#define INSN_CHUNK_BITS		8
#define INSN_CHUNK_SIZE		(1 << INSN_CHUNK_BITS)
#define INSN_CHUNK_MAX		(INSN_CHUNK_SIZE - 1)

struct instruction {
	struct hlist_node hash;
	struct list_head call_node;
	struct section *sec;
	unsigned long offset;
	unsigned long immediate;

	u8 len;
	u8 prev_len;
	u8 type;
	s8 instr;

	u32 idx			: INSN_CHUNK_BITS,
	    dead_end		: 1,
	    ignore		: 1,
	    ignore_alts		: 1,
	    hint		: 1,
	    save		: 1,
	    restore		: 1,
	    retpoline_safe	: 1,
	    noendbr		: 1,
	    entry		: 1,
	    visited		: 4,
	    no_reloc		: 1;
		/* 10 bit hole */

	struct alt_group *alt_group;
	struct instruction *jump_dest;
	struct instruction *first_jump_src;
	union {
		struct symbol *_call_dest;
		struct reloc *_jump_table;
	};
	struct alternative *alts;
	struct symbol *sym;
	struct stack_op *stack_ops;
	struct cfi_state *cfi;
};

static inline struct symbol *insn_func(struct instruction *insn)
{
	struct symbol *sym = insn->sym;

	if (sym && sym->type != STT_FUNC)
		sym = NULL;

	return sym;
}

#define VISITED_BRANCH		0x01
#define VISITED_BRANCH_UACCESS	0x02
#define VISITED_BRANCH_MASK	0x03
#define VISITED_ENTRY		0x04

static inline bool is_static_jump(struct instruction *insn)
{
	return insn->type == INSN_JUMP_CONDITIONAL ||
	       insn->type == INSN_JUMP_UNCONDITIONAL;
}

static inline bool is_dynamic_jump(struct instruction *insn)
{
	return insn->type == INSN_JUMP_DYNAMIC ||
	       insn->type == INSN_JUMP_DYNAMIC_CONDITIONAL;
}

static inline bool is_jump(struct instruction *insn)
{
	return is_static_jump(insn) || is_dynamic_jump(insn);
}

struct instruction *find_insn(struct objtool_file *file,
			      struct section *sec, unsigned long offset);

struct instruction *next_insn_same_sec(struct objtool_file *file, struct instruction *insn);

#define sec_for_each_insn(file, _sec, insn)				\
	for (insn = find_insn(file, _sec, 0);				\
	     insn && insn->sec == _sec;					\
	     insn = next_insn_same_sec(file, insn))

#endif /* _CHECK_H */
Commit	Line	Data
1ccea77e	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
dcc914f4 JP	2	/*
dcc914f4 JP	3	* Copyright (C) 2017 Josh Poimboeuf <jpoimboe@redhat.com>
dcc914f4 JP	4	*/
	5
	6	#ifndef _CHECK_H
	7	#define _CHECK_H
	8
	9	#include <stdbool.h>
7786032e VG	10	#include <objtool/cfi.h>
7786032e VG	11	#include <objtool/arch.h>
dcc914f4	12
baa41469	13	struct insn_state {
e7c0219b	14	struct cfi_state cfi;
ea24213d	15	unsigned int uaccess_stack;
e7c0219b PZ	16	bool uaccess;
e7c0219b PZ	17	bool df;
c4a33939 PZ	18	bool noinstr;
c4a33939 PZ	19	s8 instr;
baa41469 JP	20	};
baa41469 JP	21
b23cc71c JP	22	struct alt_group {
	23	/*
	24	* Pointer from a replacement group to the original group. NULL if it
	25	* is the original group.
	26	*/
	27	struct alt_group *orig_group;
	28
	29	/* First and last instructions in the group */
1c34496e	30	struct instruction first_insn, last_insn, *nop;
c9c324dc JP	31
	32	/*
	33	* Byte-offset-addressed len-sized array of pointers to CFI structs.
	34	* This is shared with the other alt_groups in the same alternative.
	35	*/
	36	struct cfi_state **cfi;
b23cc71c JP	37	};
b23cc71c JP	38
1c34496e PZ	39	#define INSN_CHUNK_BITS 8
	40	#define INSN_CHUNK_SIZE (1 << INSN_CHUNK_BITS)
	41	#define INSN_CHUNK_MAX (INSN_CHUNK_SIZE - 1)
	42
dcc914f4	43	struct instruction {
dcc914f4	44	struct hlist_node hash;
43d5430a	45	struct list_head call_node;
dcc914f4 JP	46	struct section *sec;
dcc914f4 JP	47	unsigned long offset;
dcc914f4	48	unsigned long immediate;
a09a6e23	49
1c34496e PZ	50	u8 len;
	51	u8 prev_len;
	52	u8 type;
c4a33939	53	s8 instr;
96db4a98	54
1c34496e PZ	55	u32 idx : INSN_CHUNK_BITS,
	56	dead_end : 1,
	57	ignore : 1,
	58	ignore_alts : 1,
	59	hint : 1,
	60	save : 1,
	61	restore : 1,
	62	retpoline_safe : 1,
	63	noendbr : 1,
	64	entry : 1,
	65	visited : 4,
	66	no_reloc : 1;
	67	/* 10 bit hole */
	68
b23cc71c	69	struct alt_group *alt_group;
dcc914f4	70	struct instruction *jump_dest;
99ce7962	71	struct instruction *first_jump_src;
c6f5dc28 PZ	72	union {
	73	struct symbol *_call_dest;
	74	struct reloc *_jump_table;
	75	};
d5406654	76	struct alternative *alts;
dbcdbdfd	77	struct symbol *sym;
3ee88df1	78	struct stack_op *stack_ops;
8b946cc3	79	struct cfi_state *cfi;
dcc914f4 JP	80	};
dcc914f4 JP	81
dbcdbdfd PZ	82	static inline struct symbol insn_func(struct instruction insn)
	83	{
	84	struct symbol *sym = insn->sym;
	85
	86	if (sym && sym->type != STT_FUNC)
	87	sym = NULL;
	88
	89	return sym;
	90	}
	91
a09a6e23 PZ	92	#define VISITED_BRANCH 0x01
	93	#define VISITED_BRANCH_UACCESS 0x02
	94	#define VISITED_BRANCH_MASK 0x03
	95	#define VISITED_ENTRY 0x04
	96
45245f51 JT	97	static inline bool is_static_jump(struct instruction *insn)
	98	{
	99	return insn->type == INSN_JUMP_CONDITIONAL \|\|
	100	insn->type == INSN_JUMP_UNCONDITIONAL;
	101	}
	102
1f9a1b74 JP	103	static inline bool is_dynamic_jump(struct instruction *insn)
	104	{
	105	return insn->type == INSN_JUMP_DYNAMIC \|\|
	106	insn->type == INSN_JUMP_DYNAMIC_CONDITIONAL;
	107	}
	108
	109	static inline bool is_jump(struct instruction *insn)
	110	{
	111	return is_static_jump(insn) \|\| is_dynamic_jump(insn);
	112	}
	113
627fce14 JP	114	struct instruction find_insn(struct objtool_file file,
627fce14 JP	115	struct section *sec, unsigned long offset);
dcc914f4	116
1c34496e	117	struct instruction next_insn_same_sec(struct objtool_file file, struct instruction *insn);
baa41469	118
1c34496e PZ	119	#define sec_for_each_insn(file, _sec, insn) \
	120	for (insn = find_insn(file, _sec, 0); \
	121	insn && insn->sec == _sec; \
	122	insn = next_insn_same_sec(file, insn))
627fce14	123
dcc914f4	124	#endif /* _CHECK_H */