2016-09-21 04:43:57 -06:00
|
|
|
/* 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_VERIFIER_H
|
|
|
|
#define _LINUX_BPF_VERIFIER_H 1
|
|
|
|
|
|
|
|
#include <linux/bpf.h> /* for enum bpf_reg_type */
|
|
|
|
#include <linux/filter.h> /* for MAX_BPF_STACK */
|
2017-08-07 08:26:19 -06:00
|
|
|
#include <linux/tnum.h>
|
2016-09-21 04:43:57 -06:00
|
|
|
|
2017-08-07 08:26:36 -06:00
|
|
|
/* Maximum variable offset umax_value permitted when resolving memory accesses.
|
|
|
|
* In practice this is far bigger than any realistic pointer offset; this limit
|
|
|
|
* ensures that umax_value + (int)off + (int)size cannot overflow a u64.
|
|
|
|
*/
|
|
|
|
#define BPF_MAX_VAR_OFF (1ULL << 31)
|
|
|
|
/* Maximum variable size permitted for ARG_CONST_SIZE[_OR_ZERO]. This ensures
|
|
|
|
* that converting umax_value to int cannot overflow.
|
|
|
|
*/
|
|
|
|
#define BPF_MAX_VAR_SIZ INT_MAX
|
2016-09-28 08:54:32 -06:00
|
|
|
|
2017-08-23 08:11:21 -06:00
|
|
|
/* Liveness marks, used for registers and spilled-regs (in stack slots).
|
|
|
|
* Read marks propagate upwards until they find a write mark; they record that
|
|
|
|
* "one of this state's descendants read this reg" (and therefore the reg is
|
|
|
|
* relevant for states_equal() checks).
|
|
|
|
* Write marks collect downwards and do not propagate; they record that "the
|
|
|
|
* straight-line code that reached this state (from its parent) wrote this reg"
|
|
|
|
* (and therefore that reads propagated from this state or its descendants
|
|
|
|
* should not propagate to its parent).
|
|
|
|
* A state with a write mark can receive read marks; it just won't propagate
|
|
|
|
* them to its parent, since the write mark is a property, not of the state,
|
|
|
|
* but of the link between it and its parent. See mark_reg_read() and
|
|
|
|
* mark_stack_slot_read() in kernel/bpf/verifier.c.
|
|
|
|
*/
|
2017-08-15 13:34:35 -06:00
|
|
|
enum bpf_reg_liveness {
|
|
|
|
REG_LIVE_NONE = 0, /* reg hasn't been read or written this branch */
|
|
|
|
REG_LIVE_READ, /* reg was read, so we're sensitive to initial value */
|
|
|
|
REG_LIVE_WRITTEN, /* reg was written first, screening off later reads */
|
|
|
|
};
|
|
|
|
|
2016-09-21 04:43:57 -06:00
|
|
|
struct bpf_reg_state {
|
|
|
|
enum bpf_reg_type type;
|
|
|
|
union {
|
2017-08-07 08:26:19 -06:00
|
|
|
/* valid when type == PTR_TO_PACKET */
|
|
|
|
u16 range;
|
2016-09-21 04:43:57 -06:00
|
|
|
|
|
|
|
/* valid when type == CONST_PTR_TO_MAP | PTR_TO_MAP_VALUE |
|
|
|
|
* PTR_TO_MAP_VALUE_OR_NULL
|
|
|
|
*/
|
|
|
|
struct bpf_map *map_ptr;
|
|
|
|
};
|
2017-08-07 08:26:19 -06:00
|
|
|
/* Fixed part of pointer offset, pointer types only */
|
|
|
|
s32 off;
|
|
|
|
/* For PTR_TO_PACKET, used to find other pointers with the same variable
|
|
|
|
* offset, so they can share range knowledge.
|
|
|
|
* For PTR_TO_MAP_VALUE_OR_NULL this is used to share which map value we
|
|
|
|
* came from, when one is tested for != NULL.
|
|
|
|
*/
|
2016-12-07 11:57:59 -07:00
|
|
|
u32 id;
|
2017-08-15 13:34:35 -06:00
|
|
|
/* Ordering of fields matters. See states_equal() */
|
2017-08-07 08:26:19 -06:00
|
|
|
/* For scalar types (SCALAR_VALUE), this represents our knowledge of
|
|
|
|
* the actual value.
|
|
|
|
* For pointer types, this represents the variable part of the offset
|
|
|
|
* from the pointed-to object, and is shared with all bpf_reg_states
|
|
|
|
* with the same id as us.
|
|
|
|
*/
|
|
|
|
struct tnum var_off;
|
2016-12-07 11:57:59 -07:00
|
|
|
/* Used to determine if any memory access using this register will
|
2017-08-07 08:26:19 -06:00
|
|
|
* result in a bad access.
|
|
|
|
* These refer to the same value as var_off, not necessarily the actual
|
|
|
|
* contents of the register.
|
2016-12-07 11:57:59 -07:00
|
|
|
*/
|
2017-08-07 08:26:36 -06:00
|
|
|
s64 smin_value; /* minimum possible (s64)value */
|
|
|
|
s64 smax_value; /* maximum possible (s64)value */
|
|
|
|
u64 umin_value; /* minimum possible (u64)value */
|
|
|
|
u64 umax_value; /* maximum possible (u64)value */
|
2017-08-15 13:34:35 -06:00
|
|
|
/* This field must be last, for states_equal() reasons. */
|
|
|
|
enum bpf_reg_liveness live;
|
2016-09-21 04:43:57 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
enum bpf_stack_slot_type {
|
|
|
|
STACK_INVALID, /* nothing was stored in this stack slot */
|
|
|
|
STACK_SPILL, /* register spilled into stack */
|
|
|
|
STACK_MISC /* BPF program wrote some data into this slot */
|
|
|
|
};
|
|
|
|
|
|
|
|
#define BPF_REG_SIZE 8 /* size of eBPF register in bytes */
|
|
|
|
|
|
|
|
/* state of the program:
|
|
|
|
* type of all registers and stack info
|
|
|
|
*/
|
|
|
|
struct bpf_verifier_state {
|
|
|
|
struct bpf_reg_state regs[MAX_BPF_REG];
|
|
|
|
u8 stack_slot_type[MAX_BPF_STACK];
|
|
|
|
struct bpf_reg_state spilled_regs[MAX_BPF_STACK / BPF_REG_SIZE];
|
2017-08-15 13:34:35 -06:00
|
|
|
struct bpf_verifier_state *parent;
|
2016-09-21 04:43:57 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
/* linked list of verifier states used to prune search */
|
|
|
|
struct bpf_verifier_state_list {
|
|
|
|
struct bpf_verifier_state state;
|
|
|
|
struct bpf_verifier_state_list *next;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct bpf_insn_aux_data {
|
2017-03-15 19:26:42 -06:00
|
|
|
union {
|
|
|
|
enum bpf_reg_type ptr_type; /* pointer type for load/store insns */
|
|
|
|
struct bpf_map *map_ptr; /* pointer for call insn into lookup_elem */
|
|
|
|
};
|
2017-06-22 16:07:39 -06:00
|
|
|
int ctx_field_size; /* the ctx field size for load insn, maybe 0 */
|
|
|
|
int converted_op_size; /* the valid value width after perceived conversion */
|
2016-09-21 04:43:57 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
#define MAX_USED_MAPS 64 /* max number of maps accessed by one eBPF program */
|
|
|
|
|
2016-09-21 04:43:58 -06:00
|
|
|
struct bpf_verifier_env;
|
|
|
|
struct bpf_ext_analyzer_ops {
|
|
|
|
int (*insn_hook)(struct bpf_verifier_env *env,
|
|
|
|
int insn_idx, int prev_insn_idx);
|
|
|
|
};
|
|
|
|
|
2016-09-21 04:43:57 -06:00
|
|
|
/* single container for all structs
|
|
|
|
* one verifier_env per bpf_check() call
|
|
|
|
*/
|
|
|
|
struct bpf_verifier_env {
|
|
|
|
struct bpf_prog *prog; /* eBPF program being verified */
|
|
|
|
struct bpf_verifier_stack_elem *head; /* stack of verifier states to be processed */
|
|
|
|
int stack_size; /* number of states to be processed */
|
2017-05-10 12:38:07 -06:00
|
|
|
bool strict_alignment; /* perform strict pointer alignment checks */
|
2016-09-21 04:43:57 -06:00
|
|
|
struct bpf_verifier_state cur_state; /* current verifier state */
|
|
|
|
struct bpf_verifier_state_list **explored_states; /* search pruning optimization */
|
2016-09-21 04:43:58 -06:00
|
|
|
const struct bpf_ext_analyzer_ops *analyzer_ops; /* external analyzer ops */
|
|
|
|
void *analyzer_priv; /* pointer to external analyzer's private data */
|
2016-09-21 04:43:57 -06:00
|
|
|
struct bpf_map *used_maps[MAX_USED_MAPS]; /* array of map's used by eBPF program */
|
|
|
|
u32 used_map_cnt; /* number of used maps */
|
|
|
|
u32 id_gen; /* used to generate unique reg IDs */
|
|
|
|
bool allow_ptr_leaks;
|
|
|
|
bool seen_direct_write;
|
|
|
|
struct bpf_insn_aux_data *insn_aux_data; /* array of per-insn state */
|
|
|
|
};
|
|
|
|
|
2016-09-21 04:43:58 -06:00
|
|
|
int bpf_analyzer(struct bpf_prog *prog, const struct bpf_ext_analyzer_ops *ops,
|
|
|
|
void *priv);
|
|
|
|
|
2016-09-21 04:43:57 -06:00
|
|
|
#endif /* _LINUX_BPF_VERIFIER_H */
|