[linux-2.6-block.git] / kernel / bpf / disasm.c

/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
 * Copyright (c) 2016 Facebook
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that 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.
 */

#include <linux/bpf.h>

#include "disasm.h"

#define __BPF_FUNC_STR_FN(x) [BPF_FUNC_ ## x] = __stringify(bpf_ ## x)
static const char * const func_id_str[] = {
	__BPF_FUNC_MAPPER(__BPF_FUNC_STR_FN)
};
#undef __BPF_FUNC_STR_FN

static const char *__func_get_name(const struct bpf_insn_cbs *cbs,
				   const struct bpf_insn *insn,
				   char *buff, size_t len)
{
	BUILD_BUG_ON(ARRAY_SIZE(func_id_str) != __BPF_FUNC_MAX_ID);

	if (insn->src_reg != BPF_PSEUDO_CALL &&
	    insn->imm >= 0 && insn->imm < __BPF_FUNC_MAX_ID &&
	    func_id_str[insn->imm])
		return func_id_str[insn->imm];

	if (cbs && cbs->cb_call)
		return cbs->cb_call(cbs->private_data, insn);

	if (insn->src_reg == BPF_PSEUDO_CALL)
		snprintf(buff, len, "%+d", insn->imm);

	return buff;
}

static const char *__func_imm_name(const struct bpf_insn_cbs *cbs,
				   const struct bpf_insn *insn,
				   u64 full_imm, char *buff, size_t len)
{
	if (cbs && cbs->cb_imm)
		return cbs->cb_imm(cbs->private_data, insn, full_imm);

	snprintf(buff, len, "0x%llx", (unsigned long long)full_imm);
	return buff;
}

const char *func_id_name(int id)
{
	if (id >= 0 && id < __BPF_FUNC_MAX_ID && func_id_str[id])
		return func_id_str[id];
	else
		return "unknown";
}

const char *const bpf_class_string[8] = {
	[BPF_LD]    = "ld",
	[BPF_LDX]   = "ldx",
	[BPF_ST]    = "st",
	[BPF_STX]   = "stx",
	[BPF_ALU]   = "alu",
	[BPF_JMP]   = "jmp",
	[BPF_RET]   = "BUG",
	[BPF_ALU64] = "alu64",
};

const char *const bpf_alu_string[16] = {
	[BPF_ADD >> 4]  = "+=",
	[BPF_SUB >> 4]  = "-=",
	[BPF_MUL >> 4]  = "*=",
	[BPF_DIV >> 4]  = "/=",
	[BPF_OR  >> 4]  = "|=",
	[BPF_AND >> 4]  = "&=",
	[BPF_LSH >> 4]  = "<<=",
	[BPF_RSH >> 4]  = ">>=",
	[BPF_NEG >> 4]  = "neg",
	[BPF_MOD >> 4]  = "%=",
	[BPF_XOR >> 4]  = "^=",
	[BPF_MOV >> 4]  = "=",
	[BPF_ARSH >> 4] = "s>>=",
	[BPF_END >> 4]  = "endian",
};

static const char *const bpf_ldst_string[] = {
	[BPF_W >> 3]  = "u32",
	[BPF_H >> 3]  = "u16",
	[BPF_B >> 3]  = "u8",
	[BPF_DW >> 3] = "u64",
};

static const char *const bpf_jmp_string[16] = {
	[BPF_JA >> 4]   = "jmp",
	[BPF_JEQ >> 4]  = "==",
	[BPF_JGT >> 4]  = ">",
	[BPF_JLT >> 4]  = "<",
	[BPF_JGE >> 4]  = ">=",
	[BPF_JLE >> 4]  = "<=",
	[BPF_JSET >> 4] = "&",
	[BPF_JNE >> 4]  = "!=",
	[BPF_JSGT >> 4] = "s>",
	[BPF_JSLT >> 4] = "s<",
	[BPF_JSGE >> 4] = "s>=",
	[BPF_JSLE >> 4] = "s<=",
	[BPF_CALL >> 4] = "call",
	[BPF_EXIT >> 4] = "exit",
};

static void print_bpf_end_insn(bpf_insn_print_t verbose,
			       void *private_data,
			       const struct bpf_insn *insn)
{
	verbose(private_data, "(%02x) r%d = %s%d r%d\n",
		insn->code, insn->dst_reg,
		BPF_SRC(insn->code) == BPF_TO_BE ? "be" : "le",
		insn->imm, insn->dst_reg);
}

void print_bpf_insn(const struct bpf_insn_cbs *cbs,
		    const struct bpf_insn *insn,
		    bool allow_ptr_leaks)
{
	const bpf_insn_print_t verbose = cbs->cb_print;
	u8 class = BPF_CLASS(insn->code);

	if (class == BPF_ALU || class == BPF_ALU64) {
		if (BPF_OP(insn->code) == BPF_END) {
			if (class == BPF_ALU64)
				verbose(cbs->private_data, "BUG_alu64_%02x\n", insn->code);
			else
				print_bpf_end_insn(verbose, cbs->private_data, insn);
		} else if (BPF_OP(insn->code) == BPF_NEG) {
			verbose(cbs->private_data, "(%02x) r%d = %s-r%d\n",
				insn->code, insn->dst_reg,
				class == BPF_ALU ? "(u32) " : "",
				insn->dst_reg);
		} else if (BPF_SRC(insn->code) == BPF_X) {
			verbose(cbs->private_data, "(%02x) %sr%d %s %sr%d\n",
				insn->code, class == BPF_ALU ? "(u32) " : "",
				insn->dst_reg,
				bpf_alu_string[BPF_OP(insn->code) >> 4],
				class == BPF_ALU ? "(u32) " : "",
				insn->src_reg);
		} else {
			verbose(cbs->private_data, "(%02x) %sr%d %s %s%d\n",
				insn->code, class == BPF_ALU ? "(u32) " : "",
				insn->dst_reg,
				bpf_alu_string[BPF_OP(insn->code) >> 4],
				class == BPF_ALU ? "(u32) " : "",
				insn->imm);
		}
	} else if (class == BPF_STX) {
		if (BPF_MODE(insn->code) == BPF_MEM)
			verbose(cbs->private_data, "(%02x) *(%s *)(r%d %+d) = r%d\n",
				insn->code,
				bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
				insn->dst_reg,
				insn->off, insn->src_reg);
		else if (BPF_MODE(insn->code) == BPF_XADD)
			verbose(cbs->private_data, "(%02x) lock *(%s *)(r%d %+d) += r%d\n",
				insn->code,
				bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
				insn->dst_reg, insn->off,
				insn->src_reg);
		else
			verbose(cbs->private_data, "BUG_%02x\n", insn->code);
	} else if (class == BPF_ST) {
		if (BPF_MODE(insn->code) != BPF_MEM) {
			verbose(cbs->private_data, "BUG_st_%02x\n", insn->code);
			return;
		}
		verbose(cbs->private_data, "(%02x) *(%s *)(r%d %+d) = %d\n",
			insn->code,
			bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
			insn->dst_reg,
			insn->off, insn->imm);
	} else if (class == BPF_LDX) {
		if (BPF_MODE(insn->code) != BPF_MEM) {
			verbose(cbs->private_data, "BUG_ldx_%02x\n", insn->code);
			return;
		}
		verbose(cbs->private_data, "(%02x) r%d = *(%s *)(r%d %+d)\n",
			insn->code, insn->dst_reg,
			bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
			insn->src_reg, insn->off);
	} else if (class == BPF_LD) {
		if (BPF_MODE(insn->code) == BPF_ABS) {
			verbose(cbs->private_data, "(%02x) r0 = *(%s *)skb[%d]\n",
				insn->code,
				bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
				insn->imm);
		} else if (BPF_MODE(insn->code) == BPF_IND) {
			verbose(cbs->private_data, "(%02x) r0 = *(%s *)skb[r%d + %d]\n",
				insn->code,
				bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
				insn->src_reg, insn->imm);
		} else if (BPF_MODE(insn->code) == BPF_IMM &&
			   BPF_SIZE(insn->code) == BPF_DW) {
			/* At this point, we already made sure that the second
			 * part of the ldimm64 insn is accessible.
			 */
			u64 imm = ((u64)(insn + 1)->imm << 32) | (u32)insn->imm;
			bool map_ptr = insn->src_reg == BPF_PSEUDO_MAP_FD;
			char tmp[64];

			if (map_ptr && !allow_ptr_leaks)
				imm = 0;

			verbose(cbs->private_data, "(%02x) r%d = %s\n",
				insn->code, insn->dst_reg,
				__func_imm_name(cbs, insn, imm,
						tmp, sizeof(tmp)));
		} else {
			verbose(cbs->private_data, "BUG_ld_%02x\n", insn->code);
			return;
		}
	} else if (class == BPF_JMP) {
		u8 opcode = BPF_OP(insn->code);

		if (opcode == BPF_CALL) {
			char tmp[64];

			if (insn->src_reg == BPF_PSEUDO_CALL) {
				verbose(cbs->private_data, "(%02x) call pc%s\n",
					insn->code,
					__func_get_name(cbs, insn,
							tmp, sizeof(tmp)));
			} else {
				strcpy(tmp, "unknown");
				verbose(cbs->private_data, "(%02x) call %s#%d\n", insn->code,
					__func_get_name(cbs, insn,
							tmp, sizeof(tmp)),
					insn->imm);
			}
		} else if (insn->code == (BPF_JMP | BPF_JA)) {
			verbose(cbs->private_data, "(%02x) goto pc%+d\n",
				insn->code, insn->off);
		} else if (insn->code == (BPF_JMP | BPF_EXIT)) {
			verbose(cbs->private_data, "(%02x) exit\n", insn->code);
		} else if (BPF_SRC(insn->code) == BPF_X) {
			verbose(cbs->private_data, "(%02x) if r%d %s r%d goto pc%+d\n",
				insn->code, insn->dst_reg,
				bpf_jmp_string[BPF_OP(insn->code) >> 4],
				insn->src_reg, insn->off);
		} else {
			verbose(cbs->private_data, "(%02x) if r%d %s 0x%x goto pc%+d\n",
				insn->code, insn->dst_reg,
				bpf_jmp_string[BPF_OP(insn->code) >> 4],
				insn->imm, insn->off);
		}
	} else {
		verbose(cbs->private_data, "(%02x) %s\n",
			insn->code, bpf_class_string[class]);
	}
}
Commit	Line	Data
f4ac7e0b JK	1	/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
	2	* Copyright (c) 2016 Facebook
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of version 2 of the GNU General Public
	6	* License as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but
	9	* WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	11	* General Public License for more details.
	12	*/
	13
	14	#include <linux/bpf.h>
	15
	16	#include "disasm.h"
	17
	18	#define __BPF_FUNC_STR_FN(x) [BPF_FUNC_ ## x] = __stringify(bpf_ ## x)
	19	static const char * const func_id_str[] = {
	20	__BPF_FUNC_MAPPER(__BPF_FUNC_STR_FN)
	21	};
	22	#undef __BPF_FUNC_STR_FN
	23
7105e828 DB	24	static const char __func_get_name(const struct bpf_insn_cbs cbs,
	25	const struct bpf_insn *insn,
	26	char *buff, size_t len)
f4ac7e0b JK	27	{
	28	BUILD_BUG_ON(ARRAY_SIZE(func_id_str) != __BPF_FUNC_MAX_ID);
	29
7105e828 DB	30	if (insn->src_reg != BPF_PSEUDO_CALL &&
	31	insn->imm >= 0 && insn->imm < __BPF_FUNC_MAX_ID &&
	32	func_id_str[insn->imm])
	33	return func_id_str[insn->imm];
	34
	35	if (cbs && cbs->cb_call)
	36	return cbs->cb_call(cbs->private_data, insn);
	37
	38	if (insn->src_reg == BPF_PSEUDO_CALL)
	39	snprintf(buff, len, "%+d", insn->imm);
	40
	41	return buff;
	42	}
	43
	44	static const char __func_imm_name(const struct bpf_insn_cbs cbs,
	45	const struct bpf_insn *insn,
	46	u64 full_imm, char *buff, size_t len)
	47	{
	48	if (cbs && cbs->cb_imm)
	49	return cbs->cb_imm(cbs->private_data, insn, full_imm);
	50
	51	snprintf(buff, len, "0x%llx", (unsigned long long)full_imm);
	52	return buff;
	53	}
	54
	55	const char *func_id_name(int id)
	56	{
f4ac7e0b JK	57	if (id >= 0 && id < __BPF_FUNC_MAX_ID && func_id_str[id])
	58	return func_id_str[id];
	59	else
	60	return "unknown";
	61	}
	62
	63	const char *const bpf_class_string[8] = {
	64	[BPF_LD] = "ld",
	65	[BPF_LDX] = "ldx",
	66	[BPF_ST] = "st",
	67	[BPF_STX] = "stx",
	68	[BPF_ALU] = "alu",
	69	[BPF_JMP] = "jmp",
	70	[BPF_RET] = "BUG",
	71	[BPF_ALU64] = "alu64",
	72	};
	73
	74	const char *const bpf_alu_string[16] = {
	75	[BPF_ADD >> 4] = "+=",
	76	[BPF_SUB >> 4] = "-=",
	77	[BPF_MUL >> 4] = "*=",
	78	[BPF_DIV >> 4] = "/=",
	79	[BPF_OR >> 4] = "\|=",
	80	[BPF_AND >> 4] = "&=",
	81	[BPF_LSH >> 4] = "<<=",
	82	[BPF_RSH >> 4] = ">>=",
	83	[BPF_NEG >> 4] = "neg",
	84	[BPF_MOD >> 4] = "%=",
	85	[BPF_XOR >> 4] = "^=",
	86	[BPF_MOV >> 4] = "=",
	87	[BPF_ARSH >> 4] = "s>>=",
	88	[BPF_END >> 4] = "endian",
	89	};
	90
	91	static const char *const bpf_ldst_string[] = {
	92	[BPF_W >> 3] = "u32",
	93	[BPF_H >> 3] = "u16",
	94	[BPF_B >> 3] = "u8",
	95	[BPF_DW >> 3] = "u64",
	96	};
	97
	98	static const char *const bpf_jmp_string[16] = {
	99	[BPF_JA >> 4] = "jmp",
	100	[BPF_JEQ >> 4] = "==",
	101	[BPF_JGT >> 4] = ">",
	102	[BPF_JLT >> 4] = "<",
	103	[BPF_JGE >> 4] = ">=",
	104	[BPF_JLE >> 4] = "<=",
	105	[BPF_JSET >> 4] = "&",
	106	[BPF_JNE >> 4] = "!=",
	107	[BPF_JSGT >> 4] = "s>",
	108	[BPF_JSLT >> 4] = "s<",
	109	[BPF_JSGE >> 4] = "s>=",
	110	[BPF_JSLE >> 4] = "s<=",
	111	[BPF_CALL >> 4] = "call",
	112	[BPF_EXIT >> 4] = "exit",
	113	};
	114
7105e828	115	static void print_bpf_end_insn(bpf_insn_print_t verbose,
abe08840	116	void *private_data,
f4ac7e0b JK	117	const struct bpf_insn *insn)
f4ac7e0b JK	118	{
abe08840 JO	119	verbose(private_data, "(%02x) r%d = %s%d r%d\n",
abe08840 JO	120	insn->code, insn->dst_reg,
f4ac7e0b JK	121	BPF_SRC(insn->code) == BPF_TO_BE ? "be" : "le",
	122	insn->imm, insn->dst_reg);
	123	}
	124
7105e828	125	void print_bpf_insn(const struct bpf_insn_cbs *cbs,
7105e828 DB	126	const struct bpf_insn *insn,
7105e828 DB	127	bool allow_ptr_leaks)
f4ac7e0b	128	{
7105e828	129	const bpf_insn_print_t verbose = cbs->cb_print;
f4ac7e0b JK	130	u8 class = BPF_CLASS(insn->code);
	131
	132	if (class == BPF_ALU \|\| class == BPF_ALU64) {
	133	if (BPF_OP(insn->code) == BPF_END) {
	134	if (class == BPF_ALU64)
abe08840	135	verbose(cbs->private_data, "BUG_alu64_%02x\n", insn->code);
f4ac7e0b	136	else
abe08840	137	print_bpf_end_insn(verbose, cbs->private_data, insn);
f4ac7e0b	138	} else if (BPF_OP(insn->code) == BPF_NEG) {
abe08840	139	verbose(cbs->private_data, "(%02x) r%d = %s-r%d\n",
f4ac7e0b JK	140	insn->code, insn->dst_reg,
	141	class == BPF_ALU ? "(u32) " : "",
	142	insn->dst_reg);
	143	} else if (BPF_SRC(insn->code) == BPF_X) {
abe08840	144	verbose(cbs->private_data, "(%02x) %sr%d %s %sr%d\n",
f4ac7e0b JK	145	insn->code, class == BPF_ALU ? "(u32) " : "",
	146	insn->dst_reg,
	147	bpf_alu_string[BPF_OP(insn->code) >> 4],
	148	class == BPF_ALU ? "(u32) " : "",
	149	insn->src_reg);
	150	} else {
abe08840	151	verbose(cbs->private_data, "(%02x) %sr%d %s %s%d\n",
f4ac7e0b JK	152	insn->code, class == BPF_ALU ? "(u32) " : "",
	153	insn->dst_reg,
	154	bpf_alu_string[BPF_OP(insn->code) >> 4],
	155	class == BPF_ALU ? "(u32) " : "",
	156	insn->imm);
	157	}
	158	} else if (class == BPF_STX) {
	159	if (BPF_MODE(insn->code) == BPF_MEM)
abe08840	160	verbose(cbs->private_data, "(%02x) (%s )(r%d %+d) = r%d\n",
f4ac7e0b JK	161	insn->code,
	162	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	163	insn->dst_reg,
	164	insn->off, insn->src_reg);
	165	else if (BPF_MODE(insn->code) == BPF_XADD)
abe08840	166	verbose(cbs->private_data, "(%02x) lock (%s )(r%d %+d) += r%d\n",
f4ac7e0b JK	167	insn->code,
	168	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	169	insn->dst_reg, insn->off,
	170	insn->src_reg);
	171	else
abe08840	172	verbose(cbs->private_data, "BUG_%02x\n", insn->code);
f4ac7e0b JK	173	} else if (class == BPF_ST) {
f4ac7e0b JK	174	if (BPF_MODE(insn->code) != BPF_MEM) {
abe08840	175	verbose(cbs->private_data, "BUG_st_%02x\n", insn->code);
f4ac7e0b JK	176	return;
f4ac7e0b JK	177	}
abe08840	178	verbose(cbs->private_data, "(%02x) (%s )(r%d %+d) = %d\n",
f4ac7e0b JK	179	insn->code,
	180	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	181	insn->dst_reg,
	182	insn->off, insn->imm);
	183	} else if (class == BPF_LDX) {
	184	if (BPF_MODE(insn->code) != BPF_MEM) {
abe08840	185	verbose(cbs->private_data, "BUG_ldx_%02x\n", insn->code);
f4ac7e0b JK	186	return;
f4ac7e0b JK	187	}
abe08840	188	verbose(cbs->private_data, "(%02x) r%d = (%s )(r%d %+d)\n",
f4ac7e0b JK	189	insn->code, insn->dst_reg,
	190	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	191	insn->src_reg, insn->off);
	192	} else if (class == BPF_LD) {
	193	if (BPF_MODE(insn->code) == BPF_ABS) {
abe08840	194	verbose(cbs->private_data, "(%02x) r0 = (%s )skb[%d]\n",
f4ac7e0b JK	195	insn->code,
	196	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	197	insn->imm);
	198	} else if (BPF_MODE(insn->code) == BPF_IND) {
abe08840	199	verbose(cbs->private_data, "(%02x) r0 = (%s )skb[r%d + %d]\n",
f4ac7e0b JK	200	insn->code,
	201	bpf_ldst_string[BPF_SIZE(insn->code) >> 3],
	202	insn->src_reg, insn->imm);
	203	} else if (BPF_MODE(insn->code) == BPF_IMM &&
	204	BPF_SIZE(insn->code) == BPF_DW) {
	205	/* At this point, we already made sure that the second
	206	* part of the ldimm64 insn is accessible.
	207	*/
	208	u64 imm = ((u64)(insn + 1)->imm << 32) \| (u32)insn->imm;
	209	bool map_ptr = insn->src_reg == BPF_PSEUDO_MAP_FD;
7105e828	210	char tmp[64];
f4ac7e0b JK	211
	212	if (map_ptr && !allow_ptr_leaks)
	213	imm = 0;
	214
abe08840	215	verbose(cbs->private_data, "(%02x) r%d = %s\n",
7105e828 DB	216	insn->code, insn->dst_reg,
	217	__func_imm_name(cbs, insn, imm,
	218	tmp, sizeof(tmp)));
f4ac7e0b	219	} else {
abe08840	220	verbose(cbs->private_data, "BUG_ld_%02x\n", insn->code);
f4ac7e0b JK	221	return;
	222	}
	223	} else if (class == BPF_JMP) {
	224	u8 opcode = BPF_OP(insn->code);
	225
	226	if (opcode == BPF_CALL) {
7105e828 DB	227	char tmp[64];
	228
	229	if (insn->src_reg == BPF_PSEUDO_CALL) {
abe08840	230	verbose(cbs->private_data, "(%02x) call pc%s\n",
7105e828 DB	231	insn->code,
	232	__func_get_name(cbs, insn,
	233	tmp, sizeof(tmp)));
	234	} else {
	235	strcpy(tmp, "unknown");
abe08840	236	verbose(cbs->private_data, "(%02x) call %s#%d\n", insn->code,
7105e828 DB	237	__func_get_name(cbs, insn,
	238	tmp, sizeof(tmp)),
	239	insn->imm);
	240	}
f4ac7e0b	241	} else if (insn->code == (BPF_JMP \| BPF_JA)) {
abe08840	242	verbose(cbs->private_data, "(%02x) goto pc%+d\n",
f4ac7e0b JK	243	insn->code, insn->off);
f4ac7e0b JK	244	} else if (insn->code == (BPF_JMP \| BPF_EXIT)) {
abe08840	245	verbose(cbs->private_data, "(%02x) exit\n", insn->code);
f4ac7e0b	246	} else if (BPF_SRC(insn->code) == BPF_X) {
abe08840	247	verbose(cbs->private_data, "(%02x) if r%d %s r%d goto pc%+d\n",
f4ac7e0b JK	248	insn->code, insn->dst_reg,
	249	bpf_jmp_string[BPF_OP(insn->code) >> 4],
	250	insn->src_reg, insn->off);
	251	} else {
abe08840	252	verbose(cbs->private_data, "(%02x) if r%d %s 0x%x goto pc%+d\n",
f4ac7e0b JK	253	insn->code, insn->dst_reg,
	254	bpf_jmp_string[BPF_OP(insn->code) >> 4],
	255	insn->imm, insn->off);
	256	}
	257	} else {
abe08840	258	verbose(cbs->private_data, "(%02x) %s\n",
f4ac7e0b JK	259	insn->code, bpf_class_string[class]);
	260	}
	261	}