[mirror_iproute2.git] / include / linux / bpf.h

/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
 *
 * 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.
 */
#ifndef __LINUX_BPF_H__
#define __LINUX_BPF_H__

#include <linux/types.h>
#include <linux/bpf_common.h>

/* Extended instruction set based on top of classic BPF */

/* instruction classes */
#define BPF_ALU64	0x07	/* alu mode in double word width */

/* ld/ldx fields */
#define BPF_DW		0x18	/* double word */
#define BPF_XADD	0xc0	/* exclusive add */

/* alu/jmp fields */
#define BPF_MOV		0xb0	/* mov reg to reg */
#define BPF_ARSH	0xc0	/* sign extending arithmetic shift right */

/* change endianness of a register */
#define BPF_END		0xd0	/* flags for endianness conversion: */
#define BPF_TO_LE	0x00	/* convert to little-endian */
#define BPF_TO_BE	0x08	/* convert to big-endian */
#define BPF_FROM_LE	BPF_TO_LE
#define BPF_FROM_BE	BPF_TO_BE

#define BPF_JNE		0x50	/* jump != */
#define BPF_JSGT	0x60	/* SGT is signed '>', GT in x86 */
#define BPF_JSGE	0x70	/* SGE is signed '>=', GE in x86 */
#define BPF_CALL	0x80	/* function call */
#define BPF_EXIT	0x90	/* function return */

/* Register numbers */
enum {
	BPF_REG_0 = 0,
	BPF_REG_1,
	BPF_REG_2,
	BPF_REG_3,
	BPF_REG_4,
	BPF_REG_5,
	BPF_REG_6,
	BPF_REG_7,
	BPF_REG_8,
	BPF_REG_9,
	BPF_REG_10,
	__MAX_BPF_REG,
};

/* BPF has 10 general purpose 64-bit registers and stack frame. */
#define MAX_BPF_REG	__MAX_BPF_REG

struct bpf_insn {
	__u8	code;		/* opcode */
	__u8	dst_reg:4;	/* dest register */
	__u8	src_reg:4;	/* source register */
	__s16	off;		/* signed offset */
	__s32	imm;		/* signed immediate constant */
};

/* BPF syscall commands */
enum bpf_cmd {
	/* create a map with given type and attributes
	 * fd = bpf(BPF_MAP_CREATE, union bpf_attr *, u32 size)
	 * returns fd or negative error
	 * map is deleted when fd is closed
	 */
	BPF_MAP_CREATE,

	/* lookup key in a given map
	 * err = bpf(BPF_MAP_LOOKUP_ELEM, union bpf_attr *attr, u32 size)
	 * Using attr->map_fd, attr->key, attr->value
	 * returns zero and stores found elem into value
	 * or negative error
	 */
	BPF_MAP_LOOKUP_ELEM,

	/* create or update key/value pair in a given map
	 * err = bpf(BPF_MAP_UPDATE_ELEM, union bpf_attr *attr, u32 size)
	 * Using attr->map_fd, attr->key, attr->value, attr->flags
	 * returns zero or negative error
	 */
	BPF_MAP_UPDATE_ELEM,

	/* find and delete elem by key in a given map
	 * err = bpf(BPF_MAP_DELETE_ELEM, union bpf_attr *attr, u32 size)
	 * Using attr->map_fd, attr->key
	 * returns zero or negative error
	 */
	BPF_MAP_DELETE_ELEM,

	/* lookup key in a given map and return next key
	 * err = bpf(BPF_MAP_GET_NEXT_KEY, union bpf_attr *attr, u32 size)
	 * Using attr->map_fd, attr->key, attr->next_key
	 * returns zero and stores next key or negative error
	 */
	BPF_MAP_GET_NEXT_KEY,

	/* verify and load eBPF program
	 * prog_fd = bpf(BPF_PROG_LOAD, union bpf_attr *attr, u32 size)
	 * Using attr->prog_type, attr->insns, attr->license
	 * returns fd or negative error
	 */
	BPF_PROG_LOAD,
};

enum bpf_map_type {
	BPF_MAP_TYPE_UNSPEC,
	BPF_MAP_TYPE_HASH,
	BPF_MAP_TYPE_ARRAY,
	BPF_MAP_TYPE_PROG_ARRAY,
};

enum bpf_prog_type {
	BPF_PROG_TYPE_UNSPEC,
	BPF_PROG_TYPE_SOCKET_FILTER,
	BPF_PROG_TYPE_KPROBE,
	BPF_PROG_TYPE_SCHED_CLS,
	BPF_PROG_TYPE_SCHED_ACT,
};

#define BPF_PSEUDO_MAP_FD	1

/* flags for BPF_MAP_UPDATE_ELEM command */
#define BPF_ANY		0 /* create new element or update existing */
#define BPF_NOEXIST	1 /* create new element if it didn't exist */
#define BPF_EXIST	2 /* update existing element */

union bpf_attr {
	struct { /* anonymous struct used by BPF_MAP_CREATE command */
		__u32	map_type;	/* one of enum bpf_map_type */
		__u32	key_size;	/* size of key in bytes */
		__u32	value_size;	/* size of value in bytes */
		__u32	max_entries;	/* max number of entries in a map */
	};

	struct { /* anonymous struct used by BPF_MAP_*_ELEM commands */
		__u32		map_fd;
		__aligned_u64	key;
		union {
			__aligned_u64 value;
			__aligned_u64 next_key;
		};
		__u64		flags;
	};

	struct { /* anonymous struct used by BPF_PROG_LOAD command */
		__u32		prog_type;	/* one of enum bpf_prog_type */
		__u32		insn_cnt;
		__aligned_u64	insns;
		__aligned_u64	license;
		__u32		log_level;	/* verbosity level of verifier */
		__u32		log_size;	/* size of user buffer */
		__aligned_u64	log_buf;	/* user supplied buffer */
		__u32		kern_version;	/* checked when prog_type=kprobe */
	};
} __attribute__((aligned(8)));

/* integer value in 'imm' field of BPF_CALL instruction selects which helper
 * function eBPF program intends to call
 */
enum bpf_func_id {
	BPF_FUNC_unspec,
	BPF_FUNC_map_lookup_elem, /* void *map_lookup_elem(&map, &key) */
	BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
	BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
	BPF_FUNC_probe_read,      /* int bpf_probe_read(void *dst, int size, void *src) */
	BPF_FUNC_ktime_get_ns,    /* u64 bpf_ktime_get_ns(void) */
	BPF_FUNC_trace_printk,    /* int bpf_trace_printk(const char *fmt, int fmt_size, ...) */
	BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
	BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */

	/**
	 * skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
	 * @skb: pointer to skb
	 * @offset: offset within packet from skb->mac_header
	 * @from: pointer where to copy bytes from
	 * @len: number of bytes to store into packet
	 * @flags: bit 0 - if true, recompute skb->csum
	 *         other bits - reserved
	 * Return: 0 on success
	 */
	BPF_FUNC_skb_store_bytes,

	/**
	 * l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
	 * @skb: pointer to skb
	 * @offset: offset within packet where IP checksum is located
	 * @from: old value of header field
	 * @to: new value of header field
	 * @flags: bits 0-3 - size of header field
	 *         other bits - reserved
	 * Return: 0 on success
	 */
	BPF_FUNC_l3_csum_replace,

	/**
	 * l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
	 * @skb: pointer to skb
	 * @offset: offset within packet where TCP/UDP checksum is located
	 * @from: old value of header field
	 * @to: new value of header field
	 * @flags: bits 0-3 - size of header field
	 *         bit 4 - is pseudo header
	 *         other bits - reserved
	 * Return: 0 on success
	 */
	BPF_FUNC_l4_csum_replace,

	/**
	 * bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
	 * @ctx: context pointer passed to next program
	 * @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
	 * @index: index inside array that selects specific program to run
	 * Return: 0 on success
	 */
	BPF_FUNC_tail_call,
	__BPF_FUNC_MAX_ID,
};

/* user accessible mirror of in-kernel sk_buff.
 * new fields can only be added to the end of this structure
 */
struct __sk_buff {
	__u32 len;
	__u32 pkt_type;
	__u32 mark;
	__u32 queue_mapping;
	__u32 protocol;
	__u32 vlan_present;
	__u32 vlan_tci;
	__u32 vlan_proto;
	__u32 priority;
};

#endif /* __LINUX_BPF_H__ */
Commit	Line	Data
b54ac87e DB	1	/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
	2	*
	3	* This program is free software; you can redistribute it and/or
	4	* modify it under the terms of version 2 of the GNU General Public
	5	* License as published by the Free Software Foundation.
	6	*/
	7	#ifndef __LINUX_BPF_H__
	8	#define __LINUX_BPF_H__
	9
	10	#include <linux/types.h>
	11	#include <linux/bpf_common.h>
	12
	13	/* Extended instruction set based on top of classic BPF */
	14
	15	/* instruction classes */
	16	#define BPF_ALU64 0x07 /* alu mode in double word width */
	17
	18	/* ld/ldx fields */
	19	#define BPF_DW 0x18 /* double word */
	20	#define BPF_XADD 0xc0 /* exclusive add */
	21
	22	/* alu/jmp fields */
	23	#define BPF_MOV 0xb0 /* mov reg to reg */
	24	#define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
	25
	26	/* change endianness of a register */
	27	#define BPF_END 0xd0 /* flags for endianness conversion: */
	28	#define BPF_TO_LE 0x00 /* convert to little-endian */
	29	#define BPF_TO_BE 0x08 /* convert to big-endian */
	30	#define BPF_FROM_LE BPF_TO_LE
	31	#define BPF_FROM_BE BPF_TO_BE
	32
	33	#define BPF_JNE 0x50 /* jump != */
	34	#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
	35	#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
	36	#define BPF_CALL 0x80 /* function call */
	37	#define BPF_EXIT 0x90 /* function return */
	38
	39	/* Register numbers */
	40	enum {
	41	BPF_REG_0 = 0,
	42	BPF_REG_1,
	43	BPF_REG_2,
	44	BPF_REG_3,
	45	BPF_REG_4,
	46	BPF_REG_5,
	47	BPF_REG_6,
	48	BPF_REG_7,
	49	BPF_REG_8,
	50	BPF_REG_9,
	51	BPF_REG_10,
	52	__MAX_BPF_REG,
	53	};
	54
	55	/* BPF has 10 general purpose 64-bit registers and stack frame. */
	56	#define MAX_BPF_REG __MAX_BPF_REG
	57
	58	struct bpf_insn {
	59	__u8 code; /* opcode */
	60	__u8 dst_reg:4; /* dest register */
	61	__u8 src_reg:4; /* source register */
	62	__s16 off; /* signed offset */
	63	__s32 imm; /* signed immediate constant */
	64	};
65
66	/* BPF syscall commands */
67	enum bpf_cmd {
68	/* create a map with given type and attributes
69	* fd = bpf(BPF_MAP_CREATE, union bpf_attr *, u32 size)
70	* returns fd or negative error
71	* map is deleted when fd is closed
72	*/
73	BPF_MAP_CREATE,
74
75	/* lookup key in a given map
76	* err = bpf(BPF_MAP_LOOKUP_ELEM, union bpf_attr *attr, u32 size)
77	* Using attr->map_fd, attr->key, attr->value
78	* returns zero and stores found elem into value
79	* or negative error
80	*/
81	BPF_MAP_LOOKUP_ELEM,
82
83	/* create or update key/value pair in a given map
84	* err = bpf(BPF_MAP_UPDATE_ELEM, union bpf_attr *attr, u32 size)
85	* Using attr->map_fd, attr->key, attr->value, attr->flags
86	* returns zero or negative error
87	*/
88	BPF_MAP_UPDATE_ELEM,
89
90	/* find and delete elem by key in a given map
91	* err = bpf(BPF_MAP_DELETE_ELEM, union bpf_attr *attr, u32 size)
92	* Using attr->map_fd, attr->key
93	* returns zero or negative error
94	*/
95	BPF_MAP_DELETE_ELEM,
96
97	/* lookup key in a given map and return next key
98	* err = bpf(BPF_MAP_GET_NEXT_KEY, union bpf_attr *attr, u32 size)
99	* Using attr->map_fd, attr->key, attr->next_key
100	* returns zero and stores next key or negative error
101	*/
102	BPF_MAP_GET_NEXT_KEY,
103
104	/* verify and load eBPF program
105	* prog_fd = bpf(BPF_PROG_LOAD, union bpf_attr *attr, u32 size)
106	* Using attr->prog_type, attr->insns, attr->license
107	* returns fd or negative error
108	*/
109	BPF_PROG_LOAD,
110	};
111
112	enum bpf_map_type {
113	BPF_MAP_TYPE_UNSPEC,
114	BPF_MAP_TYPE_HASH,
115	BPF_MAP_TYPE_ARRAY,
8f42ceaf	116	BPF_MAP_TYPE_PROG_ARRAY,
b54ac87e DB	117	};
	118
	119	enum bpf_prog_type {
	120	BPF_PROG_TYPE_UNSPEC,
	121	BPF_PROG_TYPE_SOCKET_FILTER,
aeedd8e1	122	BPF_PROG_TYPE_KPROBE,
b54ac87e	123	BPF_PROG_TYPE_SCHED_CLS,
cbdc3ed8	124	BPF_PROG_TYPE_SCHED_ACT,
b54ac87e DB	125	};
	126
	127	#define BPF_PSEUDO_MAP_FD 1
	128
	129	/* flags for BPF_MAP_UPDATE_ELEM command */
	130	#define BPF_ANY 0 /* create new element or update existing */
	131	#define BPF_NOEXIST 1 /* create new element if it didn't exist */
	132	#define BPF_EXIST 2 /* update existing element */
	133
	134	union bpf_attr {
	135	struct { /* anonymous struct used by BPF_MAP_CREATE command */
	136	__u32 map_type; /* one of enum bpf_map_type */
	137	__u32 key_size; /* size of key in bytes */
	138	__u32 value_size; /* size of value in bytes */
	139	__u32 max_entries; /* max number of entries in a map */
	140	};
	141
	142	struct { /* anonymous struct used by BPF_MAP__ELEM commands /
	143	__u32 map_fd;
	144	__aligned_u64 key;
	145	union {
	146	__aligned_u64 value;
	147	__aligned_u64 next_key;
	148	};
	149	__u64 flags;
	150	};
	151
	152	struct { /* anonymous struct used by BPF_PROG_LOAD command */
	153	__u32 prog_type; /* one of enum bpf_prog_type */
	154	__u32 insn_cnt;
	155	__aligned_u64 insns;
	156	__aligned_u64 license;
	157	__u32 log_level; /* verbosity level of verifier */
	158	__u32 log_size; /* size of user buffer */
	159	__aligned_u64 log_buf; /* user supplied buffer */
aeedd8e1	160	__u32 kern_version; /* checked when prog_type=kprobe */
b54ac87e DB	161	};
	162	} __attribute__((aligned(8)));
	163
	164	/* integer value in 'imm' field of BPF_CALL instruction selects which helper
	165	* function eBPF program intends to call
	166	*/
	167	enum bpf_func_id {
	168	BPF_FUNC_unspec,
	169	BPF_FUNC_map_lookup_elem, /* void map_lookup_elem(&map, &key) /
	170	BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
	171	BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
aeedd8e1 SH	172	BPF_FUNC_probe_read, /* int bpf_probe_read(void dst, int size, void src) */
	173	BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */
	174	BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char fmt, int fmt_size, ...) /
b54ac87e DB	175	BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
b54ac87e DB	176	BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */
e46efaed SH	177
	178	/**
	179	* skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
	180	* @skb: pointer to skb
aeedd8e1	181	* @offset: offset within packet from skb->mac_header
e46efaed SH	182	* @from: pointer where to copy bytes from
	183	* @len: number of bytes to store into packet
	184	* @flags: bit 0 - if true, recompute skb->csum
	185	* other bits - reserved
	186	* Return: 0 on success
	187	*/
	188	BPF_FUNC_skb_store_bytes,
	189
	190	/**
	191	* l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
	192	* @skb: pointer to skb
	193	* @offset: offset within packet where IP checksum is located
	194	* @from: old value of header field
	195	* @to: new value of header field
	196	* @flags: bits 0-3 - size of header field
	197	* other bits - reserved
	198	* Return: 0 on success
	199	*/
	200	BPF_FUNC_l3_csum_replace,
	201
	202	/**
	203	* l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
	204	* @skb: pointer to skb
	205	* @offset: offset within packet where TCP/UDP checksum is located
	206	* @from: old value of header field
	207	* @to: new value of header field
	208	* @flags: bits 0-3 - size of header field
	209	* bit 4 - is pseudo header
	210	* other bits - reserved
	211	* Return: 0 on success
	212	*/
	213	BPF_FUNC_l4_csum_replace,
8f42ceaf SH	214
	215	/**
	216	* bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
	217	* @ctx: context pointer passed to next program
	218	* @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
	219	* @index: index inside array that selects specific program to run
	220	* Return: 0 on success
	221	*/
	222	BPF_FUNC_tail_call,
b54ac87e DB	223	__BPF_FUNC_MAX_ID,
	224	};
	225
	226	/* user accessible mirror of in-kernel sk_buff.
	227	* new fields can only be added to the end of this structure
	228	*/
	229	struct __sk_buff {
	230	__u32 len;
	231	__u32 pkt_type;
	232	__u32 mark;
	233	__u32 queue_mapping;
cbdc3ed8 SH	234	__u32 protocol;
	235	__u32 vlan_present;
	236	__u32 vlan_tci;
	237	__u32 vlan_proto;
e46efaed	238	__u32 priority;
b54ac87e DB	239	};
	240
	241	#endif /* __LINUX_BPF_H__ */