[deliverable/linux.git] / include / uapi / 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 _UAPI__LINUX_BPF_H__
#define _UAPI__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, see bpf(2) man-page for details. */
enum bpf_cmd {
	BPF_MAP_CREATE,
	BPF_MAP_LOOKUP_ELEM,
	BPF_MAP_UPDATE_ELEM,
	BPF_MAP_DELETE_ELEM,
	BPF_MAP_GET_NEXT_KEY,
	BPF_PROG_LOAD,
	BPF_OBJ_PIN,
	BPF_OBJ_GET,
};

enum bpf_map_type {
	BPF_MAP_TYPE_UNSPEC,
	BPF_MAP_TYPE_HASH,
	BPF_MAP_TYPE_ARRAY,
	BPF_MAP_TYPE_PROG_ARRAY,
	BPF_MAP_TYPE_PERF_EVENT_ARRAY,
	BPF_MAP_TYPE_PERCPU_HASH,
	BPF_MAP_TYPE_PERCPU_ARRAY,
	BPF_MAP_TYPE_STACK_TRACE,
	BPF_MAP_TYPE_CGROUP_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,
	BPF_PROG_TYPE_TRACEPOINT,
	BPF_PROG_TYPE_XDP,
	BPF_PROG_TYPE_PERF_EVENT,
};

#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 */

#define BPF_F_NO_PREALLOC	(1U << 0)

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 */
		__u32	map_flags;	/* prealloc or not */
	};

	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 */
	};

	struct { /* anonymous struct used by BPF_OBJ_* commands */
		__aligned_u64	pathname;
		__u32		bpf_fd;
	};
} __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_clone_redirect(skb, ifindex, flags) - redirect to another netdev
	 * @skb: pointer to skb
	 * @ifindex: ifindex of the net device
	 * @flags: bit 0 - if set, redirect to ingress instead of egress
	 *         other bits - reserved
	 * Return: 0 on success
	 */
	BPF_FUNC_clone_redirect,

	/**
	 * u64 bpf_get_current_pid_tgid(void)
	 * Return: current->tgid << 32 | current->pid
	 */
	BPF_FUNC_get_current_pid_tgid,

	/**
	 * u64 bpf_get_current_uid_gid(void)
	 * Return: current_gid << 32 | current_uid
	 */
	BPF_FUNC_get_current_uid_gid,

	/**
	 * bpf_get_current_comm(char *buf, int size_of_buf)
	 * stores current->comm into buf
	 * Return: 0 on success
	 */
	BPF_FUNC_get_current_comm,

	/**
	 * bpf_get_cgroup_classid(skb) - retrieve a proc's classid
	 * @skb: pointer to skb
	 * Return: classid if != 0
	 */
	BPF_FUNC_get_cgroup_classid,
	BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */
	BPF_FUNC_skb_vlan_pop,  /* bpf_skb_vlan_pop(skb) */

	/**
	 * bpf_skb_[gs]et_tunnel_key(skb, key, size, flags)
	 * retrieve or populate tunnel metadata
	 * @skb: pointer to skb
	 * @key: pointer to 'struct bpf_tunnel_key'
	 * @size: size of 'struct bpf_tunnel_key'
	 * @flags: room for future extensions
	 * Retrun: 0 on success
	 */
	BPF_FUNC_skb_get_tunnel_key,
	BPF_FUNC_skb_set_tunnel_key,
	BPF_FUNC_perf_event_read,	/* u64 bpf_perf_event_read(&map, index) */
	/**
	 * bpf_redirect(ifindex, flags) - redirect to another netdev
	 * @ifindex: ifindex of the net device
	 * @flags: bit 0 - if set, redirect to ingress instead of egress
	 *         other bits - reserved
	 * Return: TC_ACT_REDIRECT
	 */
	BPF_FUNC_redirect,

	/**
	 * bpf_get_route_realm(skb) - retrieve a dst's tclassid
	 * @skb: pointer to skb
	 * Return: realm if != 0
	 */
	BPF_FUNC_get_route_realm,

	/**
	 * bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample
	 * @ctx: struct pt_regs*
	 * @map: pointer to perf_event_array map
	 * @index: index of event in the map
	 * @data: data on stack to be output as raw data
	 * @size: size of data
	 * Return: 0 on success
	 */
	BPF_FUNC_perf_event_output,
	BPF_FUNC_skb_load_bytes,

	/**
	 * bpf_get_stackid(ctx, map, flags) - walk user or kernel stack and return id
	 * @ctx: struct pt_regs*
	 * @map: pointer to stack_trace map
	 * @flags: bits 0-7 - numer of stack frames to skip
	 *         bit 8 - collect user stack instead of kernel
	 *         bit 9 - compare stacks by hash only
	 *         bit 10 - if two different stacks hash into the same stackid
	 *                  discard old
	 *         other bits - reserved
	 * Return: >= 0 stackid on success or negative error
	 */
	BPF_FUNC_get_stackid,

	/**
	 * bpf_csum_diff(from, from_size, to, to_size, seed) - calculate csum diff
	 * @from: raw from buffer
	 * @from_size: length of from buffer
	 * @to: raw to buffer
	 * @to_size: length of to buffer
	 * @seed: optional seed
	 * Return: csum result
	 */
	BPF_FUNC_csum_diff,

	/**
	 * bpf_skb_[gs]et_tunnel_opt(skb, opt, size)
	 * retrieve or populate tunnel options metadata
	 * @skb: pointer to skb
	 * @opt: pointer to raw tunnel option data
	 * @size: size of @opt
	 * Return: 0 on success for set, option size for get
	 */
	BPF_FUNC_skb_get_tunnel_opt,
	BPF_FUNC_skb_set_tunnel_opt,

	/**
	 * bpf_skb_change_proto(skb, proto, flags)
	 * Change protocol of the skb. Currently supported is
	 * v4 -> v6, v6 -> v4 transitions. The helper will also
	 * resize the skb. eBPF program is expected to fill the
	 * new headers via skb_store_bytes and lX_csum_replace.
	 * @skb: pointer to skb
	 * @proto: new skb->protocol type
	 * @flags: reserved
	 * Return: 0 on success or negative error
	 */
	BPF_FUNC_skb_change_proto,

	/**
	 * bpf_skb_change_type(skb, type)
	 * Change packet type of skb.
	 * @skb: pointer to skb
	 * @type: new skb->pkt_type type
	 * Return: 0 on success or negative error
	 */
	BPF_FUNC_skb_change_type,

	/**
	 * bpf_skb_under_cgroup(skb, map, index) - Check cgroup2 membership of skb
	 * @skb: pointer to skb
	 * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
	 * @index: index of the cgroup in the bpf_map
	 * Return:
	 *   == 0 skb failed the cgroup2 descendant test
	 *   == 1 skb succeeded the cgroup2 descendant test
	 *    < 0 error
	 */
	BPF_FUNC_skb_under_cgroup,

	/**
	 * bpf_get_hash_recalc(skb)
	 * Retrieve and possibly recalculate skb->hash.
	 * @skb: pointer to skb
	 * Return: hash
	 */
	BPF_FUNC_get_hash_recalc,

	/**
	 * u64 bpf_get_current_task(void)
	 * Returns current task_struct
	 * Return: current
	 */
	BPF_FUNC_get_current_task,

	/**
	 * bpf_probe_write_user(void *dst, void *src, int len)
	 * safely attempt to write to a location
	 * @dst: destination address in userspace
	 * @src: source address on stack
	 * @len: number of bytes to copy
	 * Return: 0 on success or negative error
	 */
	BPF_FUNC_probe_write_user,

	/**
	 * bpf_current_task_under_cgroup(map, index) - Check cgroup2 membership of current task
	 * @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
	 * @index: index of the cgroup in the bpf_map
	 * Return:
	 *   == 0 current failed the cgroup2 descendant test
	 *   == 1 current succeeded the cgroup2 descendant test
	 *    < 0 error
	 */
	BPF_FUNC_current_task_under_cgroup,

	/**
	 * bpf_skb_change_tail(skb, len, flags)
	 * The helper will resize the skb to the given new size,
	 * to be used f.e. with control messages.
	 * @skb: pointer to skb
	 * @len: new skb length
	 * @flags: reserved
	 * Return: 0 on success or negative error
	 */
	BPF_FUNC_skb_change_tail,

	__BPF_FUNC_MAX_ID,
};

/* All flags used by eBPF helper functions, placed here. */

/* BPF_FUNC_skb_store_bytes flags. */
#define BPF_F_RECOMPUTE_CSUM		(1ULL << 0)
#define BPF_F_INVALIDATE_HASH		(1ULL << 1)

/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
 * First 4 bits are for passing the header field size.
 */
#define BPF_F_HDR_FIELD_MASK		0xfULL

/* BPF_FUNC_l4_csum_replace flags. */
#define BPF_F_PSEUDO_HDR		(1ULL << 4)
#define BPF_F_MARK_MANGLED_0		(1ULL << 5)

/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
#define BPF_F_INGRESS			(1ULL << 0)

/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
#define BPF_F_TUNINFO_IPV6		(1ULL << 0)

/* BPF_FUNC_get_stackid flags. */
#define BPF_F_SKIP_FIELD_MASK		0xffULL
#define BPF_F_USER_STACK		(1ULL << 8)
#define BPF_F_FAST_STACK_CMP		(1ULL << 9)
#define BPF_F_REUSE_STACKID		(1ULL << 10)

/* BPF_FUNC_skb_set_tunnel_key flags. */
#define BPF_F_ZERO_CSUM_TX		(1ULL << 1)
#define BPF_F_DONT_FRAGMENT		(1ULL << 2)

/* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */
#define BPF_F_INDEX_MASK		0xffffffffULL
#define BPF_F_CURRENT_CPU		BPF_F_INDEX_MASK
/* BPF_FUNC_perf_event_output for sk_buff input context. */
#define BPF_F_CTXLEN_MASK		(0xfffffULL << 32)

/* 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;
	__u32 ingress_ifindex;
	__u32 ifindex;
	__u32 tc_index;
	__u32 cb[5];
	__u32 hash;
	__u32 tc_classid;
	__u32 data;
	__u32 data_end;
};

struct bpf_tunnel_key {
	__u32 tunnel_id;
	union {
		__u32 remote_ipv4;
		__u32 remote_ipv6[4];
	};
	__u8 tunnel_tos;
	__u8 tunnel_ttl;
	__u16 tunnel_ext;
	__u32 tunnel_label;
};

/* User return codes for XDP prog type.
 * A valid XDP program must return one of these defined values. All other
 * return codes are reserved for future use. Unknown return codes will result
 * in packet drop.
 */
enum xdp_action {
	XDP_ABORTED = 0,
	XDP_DROP,
	XDP_PASS,
	XDP_TX,
};

/* user accessible metadata for XDP packet hook
 * new fields must be added to the end of this structure
 */
struct xdp_md {
	__u32 data;
	__u32 data_end;
};

#endif /* _UAPI__LINUX_BPF_H__ */
Commit	Line	Data
daedfb22 AS	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 _UAPI__LINUX_BPF_H__
	8	#define _UAPI__LINUX_BPF_H__
	9
	10	#include <linux/types.h>
c15952dc	11	#include <linux/bpf_common.h>
daedfb22 AS	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
b2197755	66	/* BPF syscall commands, see bpf(2) man-page for details. */
99c55f7d	67	enum bpf_cmd {
99c55f7d	68	BPF_MAP_CREATE,
db20fd2b	69	BPF_MAP_LOOKUP_ELEM,
db20fd2b	70	BPF_MAP_UPDATE_ELEM,
db20fd2b	71	BPF_MAP_DELETE_ELEM,
db20fd2b	72	BPF_MAP_GET_NEXT_KEY,
09756af4	73	BPF_PROG_LOAD,
b2197755 DB	74	BPF_OBJ_PIN,
b2197755 DB	75	BPF_OBJ_GET,
99c55f7d AS	76	};
	77
	78	enum bpf_map_type {
	79	BPF_MAP_TYPE_UNSPEC,
0f8e4bd8	80	BPF_MAP_TYPE_HASH,
28fbcfa0	81	BPF_MAP_TYPE_ARRAY,
04fd61ab	82	BPF_MAP_TYPE_PROG_ARRAY,
ea317b26	83	BPF_MAP_TYPE_PERF_EVENT_ARRAY,
824bd0ce	84	BPF_MAP_TYPE_PERCPU_HASH,
a10423b8	85	BPF_MAP_TYPE_PERCPU_ARRAY,
d5a3b1f6	86	BPF_MAP_TYPE_STACK_TRACE,
4ed8ec52	87	BPF_MAP_TYPE_CGROUP_ARRAY,
99c55f7d AS	88	};
99c55f7d AS	89
09756af4 AS	90	enum bpf_prog_type {
09756af4 AS	91	BPF_PROG_TYPE_UNSPEC,
ddd872bc	92	BPF_PROG_TYPE_SOCKET_FILTER,
2541517c	93	BPF_PROG_TYPE_KPROBE,
96be4325	94	BPF_PROG_TYPE_SCHED_CLS,
94caee8c	95	BPF_PROG_TYPE_SCHED_ACT,
98b5c2c6	96	BPF_PROG_TYPE_TRACEPOINT,
6a773a15	97	BPF_PROG_TYPE_XDP,
0515e599	98	BPF_PROG_TYPE_PERF_EVENT,
09756af4 AS	99	};
09756af4 AS	100
f1a66f85 DB	101	#define BPF_PSEUDO_MAP_FD 1
f1a66f85 DB	102
3274f520 AS	103	/* flags for BPF_MAP_UPDATE_ELEM command */
	104	#define BPF_ANY 0 /* create new element or update existing */
	105	#define BPF_NOEXIST 1 /* create new element if it didn't exist */
	106	#define BPF_EXIST 2 /* update existing element */
	107
6c905981 AS	108	#define BPF_F_NO_PREALLOC (1U << 0)
6c905981 AS	109
99c55f7d AS	110	union bpf_attr {
	111	struct { /* anonymous struct used by BPF_MAP_CREATE command */
	112	__u32 map_type; /* one of enum bpf_map_type */
	113	__u32 key_size; /* size of key in bytes */
	114	__u32 value_size; /* size of value in bytes */
	115	__u32 max_entries; /* max number of entries in a map */
6c905981	116	__u32 map_flags; /* prealloc or not */
99c55f7d	117	};
db20fd2b AS	118
	119	struct { /* anonymous struct used by BPF_MAP__ELEM commands /
	120	__u32 map_fd;
	121	__aligned_u64 key;
	122	union {
	123	__aligned_u64 value;
	124	__aligned_u64 next_key;
	125	};
3274f520	126	__u64 flags;
db20fd2b	127	};
09756af4 AS	128
	129	struct { /* anonymous struct used by BPF_PROG_LOAD command */
	130	__u32 prog_type; /* one of enum bpf_prog_type */
	131	__u32 insn_cnt;
	132	__aligned_u64 insns;
	133	__aligned_u64 license;
cbd35700 AS	134	__u32 log_level; /* verbosity level of verifier */
	135	__u32 log_size; /* size of user buffer */
	136	__aligned_u64 log_buf; /* user supplied buffer */
2541517c	137	__u32 kern_version; /* checked when prog_type=kprobe */
09756af4	138	};
b2197755 DB	139
	140	struct { /* anonymous struct used by BPF_OBJ_* commands */
	141	__aligned_u64 pathname;
	142	__u32 bpf_fd;
	143	};
99c55f7d AS	144	} __attribute__((aligned(8)));
99c55f7d AS	145
09756af4 AS	146	/* integer value in 'imm' field of BPF_CALL instruction selects which helper
	147	* function eBPF program intends to call
	148	*/
	149	enum bpf_func_id {
	150	BPF_FUNC_unspec,
d0003ec0 AS	151	BPF_FUNC_map_lookup_elem, /* void map_lookup_elem(&map, &key) /
	152	BPF_FUNC_map_update_elem, /* int map_update_elem(&map, &key, &value, flags) */
	153	BPF_FUNC_map_delete_elem, /* int map_delete_elem(&map, &key) */
2541517c	154	BPF_FUNC_probe_read, /* int bpf_probe_read(void dst, int size, void src) */
d9847d31	155	BPF_FUNC_ktime_get_ns, /* u64 bpf_ktime_get_ns(void) */
9c959c86	156	BPF_FUNC_trace_printk, /* int bpf_trace_printk(const char fmt, int fmt_size, ...) /
03e69b50	157	BPF_FUNC_get_prandom_u32, /* u32 prandom_u32(void) */
c04167ce	158	BPF_FUNC_get_smp_processor_id, /* u32 raw_smp_processor_id(void) */
91bc4822 AS	159
	160	/**
	161	* skb_store_bytes(skb, offset, from, len, flags) - store bytes into packet
	162	* @skb: pointer to skb
a166151c	163	* @offset: offset within packet from skb->mac_header
91bc4822 AS	164	* @from: pointer where to copy bytes from
	165	* @len: number of bytes to store into packet
	166	* @flags: bit 0 - if true, recompute skb->csum
	167	* other bits - reserved
	168	* Return: 0 on success
	169	*/
	170	BPF_FUNC_skb_store_bytes,
	171
	172	/**
	173	* l3_csum_replace(skb, offset, from, to, flags) - recompute IP checksum
	174	* @skb: pointer to skb
	175	* @offset: offset within packet where IP checksum is located
	176	* @from: old value of header field
	177	* @to: new value of header field
	178	* @flags: bits 0-3 - size of header field
	179	* other bits - reserved
	180	* Return: 0 on success
	181	*/
	182	BPF_FUNC_l3_csum_replace,
	183
	184	/**
	185	* l4_csum_replace(skb, offset, from, to, flags) - recompute TCP/UDP checksum
	186	* @skb: pointer to skb
	187	* @offset: offset within packet where TCP/UDP checksum is located
	188	* @from: old value of header field
	189	* @to: new value of header field
	190	* @flags: bits 0-3 - size of header field
	191	* bit 4 - is pseudo header
	192	* other bits - reserved
	193	* Return: 0 on success
	194	*/
	195	BPF_FUNC_l4_csum_replace,
04fd61ab AS	196
	197	/**
	198	* bpf_tail_call(ctx, prog_array_map, index) - jump into another BPF program
	199	* @ctx: context pointer passed to next program
	200	* @prog_array_map: pointer to map which type is BPF_MAP_TYPE_PROG_ARRAY
	201	* @index: index inside array that selects specific program to run
	202	* Return: 0 on success
	203	*/
	204	BPF_FUNC_tail_call,
3896d655 AS	205
	206	/**
	207	* bpf_clone_redirect(skb, ifindex, flags) - redirect to another netdev
	208	* @skb: pointer to skb
	209	* @ifindex: ifindex of the net device
	210	* @flags: bit 0 - if set, redirect to ingress instead of egress
	211	* other bits - reserved
	212	* Return: 0 on success
	213	*/
	214	BPF_FUNC_clone_redirect,
ffeedafb AS	215
	216	/**
	217	* u64 bpf_get_current_pid_tgid(void)
	218	* Return: current->tgid << 32 \| current->pid
	219	*/
	220	BPF_FUNC_get_current_pid_tgid,
	221
	222	/**
	223	* u64 bpf_get_current_uid_gid(void)
	224	* Return: current_gid << 32 \| current_uid
	225	*/
	226	BPF_FUNC_get_current_uid_gid,
	227
	228	/**
	229	* bpf_get_current_comm(char *buf, int size_of_buf)
	230	* stores current->comm into buf
	231	* Return: 0 on success
	232	*/
	233	BPF_FUNC_get_current_comm,
8d20aabe DB	234
	235	/**
	236	* bpf_get_cgroup_classid(skb) - retrieve a proc's classid
	237	* @skb: pointer to skb
	238	* Return: classid if != 0
	239	*/
	240	BPF_FUNC_get_cgroup_classid,
4e10df9a AS	241	BPF_FUNC_skb_vlan_push, /* bpf_skb_vlan_push(skb, vlan_proto, vlan_tci) */
4e10df9a AS	242	BPF_FUNC_skb_vlan_pop, /* bpf_skb_vlan_pop(skb) */
d3aa45ce AS	243
	244	/**
	245	* bpf_skb_[gs]et_tunnel_key(skb, key, size, flags)
	246	* retrieve or populate tunnel metadata
	247	* @skb: pointer to skb
	248	* @key: pointer to 'struct bpf_tunnel_key'
	249	* @size: size of 'struct bpf_tunnel_key'
	250	* @flags: room for future extensions
	251	* Retrun: 0 on success
	252	*/
	253	BPF_FUNC_skb_get_tunnel_key,
	254	BPF_FUNC_skb_set_tunnel_key,
35578d79	255	BPF_FUNC_perf_event_read, /* u64 bpf_perf_event_read(&map, index) */
27b29f63 AS	256	/**
	257	* bpf_redirect(ifindex, flags) - redirect to another netdev
	258	* @ifindex: ifindex of the net device
	259	* @flags: bit 0 - if set, redirect to ingress instead of egress
	260	* other bits - reserved
	261	* Return: TC_ACT_REDIRECT
	262	*/
	263	BPF_FUNC_redirect,
c46646d0 DB	264
	265	/**
	266	* bpf_get_route_realm(skb) - retrieve a dst's tclassid
	267	* @skb: pointer to skb
	268	* Return: realm if != 0
	269	*/
	270	BPF_FUNC_get_route_realm,
a43eec30 AS	271
	272	/**
	273	* bpf_perf_event_output(ctx, map, index, data, size) - output perf raw sample
	274	* @ctx: struct pt_regs*
	275	* @map: pointer to perf_event_array map
	276	* @index: index of event in the map
	277	* @data: data on stack to be output as raw data
	278	* @size: size of data
	279	* Return: 0 on success
	280	*/
	281	BPF_FUNC_perf_event_output,
05c74e5e	282	BPF_FUNC_skb_load_bytes,
d5a3b1f6 AS	283
	284	/**
	285	* bpf_get_stackid(ctx, map, flags) - walk user or kernel stack and return id
	286	* @ctx: struct pt_regs*
	287	* @map: pointer to stack_trace map
	288	* @flags: bits 0-7 - numer of stack frames to skip
	289	* bit 8 - collect user stack instead of kernel
	290	* bit 9 - compare stacks by hash only
	291	* bit 10 - if two different stacks hash into the same stackid
	292	* discard old
	293	* other bits - reserved
	294	* Return: >= 0 stackid on success or negative error
	295	*/
	296	BPF_FUNC_get_stackid,
7d672345 DB	297
	298	/**
	299	* bpf_csum_diff(from, from_size, to, to_size, seed) - calculate csum diff
	300	* @from: raw from buffer
	301	* @from_size: length of from buffer
	302	* @to: raw to buffer
	303	* @to_size: length of to buffer
	304	* @seed: optional seed
	305	* Return: csum result
	306	*/
	307	BPF_FUNC_csum_diff,
14ca0751 DB	308
	309	/**
	310	* bpf_skb_[gs]et_tunnel_opt(skb, opt, size)
	311	* retrieve or populate tunnel options metadata
	312	* @skb: pointer to skb
	313	* @opt: pointer to raw tunnel option data
	314	* @size: size of @opt
	315	* Return: 0 on success for set, option size for get
	316	*/
	317	BPF_FUNC_skb_get_tunnel_opt,
	318	BPF_FUNC_skb_set_tunnel_opt,
6578171a DB	319
	320	/**
	321	* bpf_skb_change_proto(skb, proto, flags)
	322	* Change protocol of the skb. Currently supported is
	323	* v4 -> v6, v6 -> v4 transitions. The helper will also
	324	* resize the skb. eBPF program is expected to fill the
	325	* new headers via skb_store_bytes and lX_csum_replace.
	326	* @skb: pointer to skb
	327	* @proto: new skb->protocol type
	328	* @flags: reserved
	329	* Return: 0 on success or negative error
	330	*/
	331	BPF_FUNC_skb_change_proto,
	332
d2485c42 DB	333	/**
	334	* bpf_skb_change_type(skb, type)
	335	* Change packet type of skb.
	336	* @skb: pointer to skb
	337	* @type: new skb->pkt_type type
	338	* Return: 0 on success or negative error
	339	*/
	340	BPF_FUNC_skb_change_type,
	341
4a482f34	342	/**
747ea55e	343	* bpf_skb_under_cgroup(skb, map, index) - Check cgroup2 membership of skb
4a482f34 MKL	344	* @skb: pointer to skb
	345	* @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
	346	* @index: index of the cgroup in the bpf_map
	347	* Return:
	348	* == 0 skb failed the cgroup2 descendant test
	349	* == 1 skb succeeded the cgroup2 descendant test
	350	* < 0 error
	351	*/
747ea55e	352	BPF_FUNC_skb_under_cgroup,
13c5c240 DB	353
	354	/**
	355	* bpf_get_hash_recalc(skb)
	356	* Retrieve and possibly recalculate skb->hash.
	357	* @skb: pointer to skb
	358	* Return: hash
	359	*/
	360	BPF_FUNC_get_hash_recalc,
	361
606274c5 AS	362	/**
	363	* u64 bpf_get_current_task(void)
	364	* Returns current task_struct
	365	* Return: current
	366	*/
	367	BPF_FUNC_get_current_task,
	368
96ae5227 SD	369	/**
	370	* bpf_probe_write_user(void dst, void src, int len)
	371	* safely attempt to write to a location
	372	* @dst: destination address in userspace
	373	* @src: source address on stack
	374	* @len: number of bytes to copy
	375	* Return: 0 on success or negative error
	376	*/
	377	BPF_FUNC_probe_write_user,
	378
60d20f91 SD	379	/**
	380	* bpf_current_task_under_cgroup(map, index) - Check cgroup2 membership of current task
	381	* @map: pointer to bpf_map in BPF_MAP_TYPE_CGROUP_ARRAY type
	382	* @index: index of the cgroup in the bpf_map
	383	* Return:
	384	* == 0 current failed the cgroup2 descendant test
	385	* == 1 current succeeded the cgroup2 descendant test
	386	* < 0 error
	387	*/
	388	BPF_FUNC_current_task_under_cgroup,
	389
5293efe6 DB	390	/**
	391	* bpf_skb_change_tail(skb, len, flags)
	392	* The helper will resize the skb to the given new size,
	393	* to be used f.e. with control messages.
	394	* @skb: pointer to skb
	395	* @len: new skb length
	396	* @flags: reserved
	397	* Return: 0 on success or negative error
	398	*/
	399	BPF_FUNC_skb_change_tail,
	400
09756af4 AS	401	__BPF_FUNC_MAX_ID,
	402	};
	403
781c53bc DB	404	/* All flags used by eBPF helper functions, placed here. */
	405
	406	/* BPF_FUNC_skb_store_bytes flags. */
	407	#define BPF_F_RECOMPUTE_CSUM (1ULL << 0)
8afd54c8	408	#define BPF_F_INVALIDATE_HASH (1ULL << 1)
781c53bc DB	409
	410	/* BPF_FUNC_l3_csum_replace and BPF_FUNC_l4_csum_replace flags.
	411	* First 4 bits are for passing the header field size.
	412	*/
	413	#define BPF_F_HDR_FIELD_MASK 0xfULL
	414
	415	/* BPF_FUNC_l4_csum_replace flags. */
	416	#define BPF_F_PSEUDO_HDR (1ULL << 4)
2f72959a	417	#define BPF_F_MARK_MANGLED_0 (1ULL << 5)
781c53bc DB	418
	419	/* BPF_FUNC_clone_redirect and BPF_FUNC_redirect flags. */
	420	#define BPF_F_INGRESS (1ULL << 0)
	421
c6c33454 DB	422	/* BPF_FUNC_skb_set_tunnel_key and BPF_FUNC_skb_get_tunnel_key flags. */
	423	#define BPF_F_TUNINFO_IPV6 (1ULL << 0)
	424
d5a3b1f6 AS	425	/* BPF_FUNC_get_stackid flags. */
	426	#define BPF_F_SKIP_FIELD_MASK 0xffULL
	427	#define BPF_F_USER_STACK (1ULL << 8)
	428	#define BPF_F_FAST_STACK_CMP (1ULL << 9)
	429	#define BPF_F_REUSE_STACKID (1ULL << 10)
	430
2da897e5 DB	431	/* BPF_FUNC_skb_set_tunnel_key flags. */
2da897e5 DB	432	#define BPF_F_ZERO_CSUM_TX (1ULL << 1)
22080870	433	#define BPF_F_DONT_FRAGMENT (1ULL << 2)
2da897e5	434
6816a7ff	435	/* BPF_FUNC_perf_event_output and BPF_FUNC_perf_event_read flags. */
1e33759c DB	436	#define BPF_F_INDEX_MASK 0xffffffffULL
1e33759c DB	437	#define BPF_F_CURRENT_CPU BPF_F_INDEX_MASK
555c8a86 DB	438	/* BPF_FUNC_perf_event_output for sk_buff input context. */
555c8a86 DB	439	#define BPF_F_CTXLEN_MASK (0xfffffULL << 32)
1e33759c	440
9bac3d6d AS	441	/* user accessible mirror of in-kernel sk_buff.
	442	* new fields can only be added to the end of this structure
	443	*/
	444	struct __sk_buff {
	445	__u32 len;
	446	__u32 pkt_type;
	447	__u32 mark;
	448	__u32 queue_mapping;
c2497395 AS	449	__u32 protocol;
	450	__u32 vlan_present;
	451	__u32 vlan_tci;
27cd5452	452	__u32 vlan_proto;
bcad5718	453	__u32 priority;
37e82c2f AS	454	__u32 ingress_ifindex;
37e82c2f AS	455	__u32 ifindex;
d691f9e8 AS	456	__u32 tc_index;
d691f9e8 AS	457	__u32 cb[5];
ba7591d8	458	__u32 hash;
045efa82	459	__u32 tc_classid;
969bf05e AS	460	__u32 data;
969bf05e AS	461	__u32 data_end;
9bac3d6d AS	462	};
9bac3d6d AS	463
d3aa45ce AS	464	struct bpf_tunnel_key {
d3aa45ce AS	465	__u32 tunnel_id;
c6c33454 DB	466	union {
	467	__u32 remote_ipv4;
	468	__u32 remote_ipv6[4];
	469	};
	470	__u8 tunnel_tos;
	471	__u8 tunnel_ttl;
c0e760c9	472	__u16 tunnel_ext;
4018ab18	473	__u32 tunnel_label;
d3aa45ce AS	474	};
d3aa45ce AS	475
6a773a15 BB	476	/* User return codes for XDP prog type.
	477	* A valid XDP program must return one of these defined values. All other
	478	* return codes are reserved for future use. Unknown return codes will result
	479	* in packet drop.
	480	*/
	481	enum xdp_action {
	482	XDP_ABORTED = 0,
	483	XDP_DROP,
	484	XDP_PASS,
6ce96ca3	485	XDP_TX,
6a773a15 BB	486	};
	487
	488	/* user accessible metadata for XDP packet hook
	489	* new fields must be added to the end of this structure
	490	*/
	491	struct xdp_md {
	492	__u32 data;
	493	__u32 data_end;
	494	};
	495
daedfb22	496	#endif /* _UAPI__LINUX_BPF_H__ */