include/linux/bpf_verifier.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   3  */
   4 #ifndef _LINUX_BPF_VERIFIER_H
   5 #define _LINUX_BPF_VERIFIER_H 1
   6
   7 #include <linux/bpf.h> /* for enum bpf_reg_type */
   8 #include <linux/filter.h> /* for MAX_BPF_STACK */
   9 #include <linux/tnum.h>
  10
  11 /* Maximum variable offset umax_value permitted when resolving memory accesses.
  12  * In practice this is far bigger than any realistic pointer offset; this limit
  13  * ensures that umax_value + (int)off + (int)size cannot overflow a u64.
  14  */
  15 #define BPF_MAX_VAR_OFF (1 << 29)
  16 /* Maximum variable size permitted for ARG_CONST_SIZE[_OR_ZERO].  This ensures
  17  * that converting umax_value to int cannot overflow.
  18  */
  19 #define BPF_MAX_VAR_SIZ (1 << 29)
  20
  21 /* Liveness marks, used for registers and spilled-regs (in stack slots).
  22  * Read marks propagate upwards until they find a write mark; they record that
  23  * "one of this state's descendants read this reg" (and therefore the reg is
  24  * relevant for states_equal() checks).
  25  * Write marks collect downwards and do not propagate; they record that "the
  26  * straight-line code that reached this state (from its parent) wrote this reg"
  27  * (and therefore that reads propagated from this state or its descendants
  28  * should not propagate to its parent).
  29  * A state with a write mark can receive read marks; it just won't propagate
  30  * them to its parent, since the write mark is a property, not of the state,
  31  * but of the link between it and its parent.  See mark_reg_read() and
  32  * mark_stack_slot_read() in kernel/bpf/verifier.c.
  33  */
  34 enum bpf_reg_liveness {
  35         REG_LIVE_NONE = 0, /* reg hasn't been read or written this branch */
  36         REG_LIVE_READ32 = 0x1, /* reg was read, so we're sensitive to initial value */
  37         REG_LIVE_READ64 = 0x2, /* likewise, but full 64-bit content matters */
  38         REG_LIVE_READ = REG_LIVE_READ32 | REG_LIVE_READ64,
  39         REG_LIVE_WRITTEN = 0x4, /* reg was written first, screening off later reads */
  40         REG_LIVE_DONE = 0x8, /* liveness won't be updating this register anymore */
  41 };
  42
  43 struct bpf_reg_state {
  44         /* Ordering of fields matters.  See states_equal() */
  45         enum bpf_reg_type type;
  46         union {
  47                 /* valid when type == PTR_TO_PACKET */
  48                 u16 range;
  49
  50                 /* valid when type == CONST_PTR_TO_MAP | PTR_TO_MAP_VALUE |
  51                  *   PTR_TO_MAP_VALUE_OR_NULL
  52                  */
  53                 struct bpf_map *map_ptr;
  54
  55                 u32 btf_id; /* for PTR_TO_BTF_ID */
  56
  57                 /* Max size from any of the above. */
  58                 unsigned long raw;
  59         };
  60         /* Fixed part of pointer offset, pointer types only */
  61         s32 off;
  62         /* For PTR_TO_PACKET, used to find other pointers with the same variable
  63          * offset, so they can share range knowledge.
  64          * For PTR_TO_MAP_VALUE_OR_NULL this is used to share which map value we
  65          * came from, when one is tested for != NULL.
  66          * For PTR_TO_SOCKET this is used to share which pointers retain the
  67          * same reference to the socket, to determine proper reference freeing.
  68          */
  69         u32 id;
  70         /* PTR_TO_SOCKET and PTR_TO_TCP_SOCK could be a ptr returned
  71          * from a pointer-cast helper, bpf_sk_fullsock() and
  72          * bpf_tcp_sock().
  73          *
  74          * Consider the following where "sk" is a reference counted
  75          * pointer returned from "sk = bpf_sk_lookup_tcp();":
  76          *
  77          * 1: sk = bpf_sk_lookup_tcp();
  78          * 2: if (!sk) { return 0; }
  79          * 3: fullsock = bpf_sk_fullsock(sk);
  80          * 4: if (!fullsock) { bpf_sk_release(sk); return 0; }
  81          * 5: tp = bpf_tcp_sock(fullsock);
  82          * 6: if (!tp) { bpf_sk_release(sk); return 0; }
  83          * 7: bpf_sk_release(sk);
  84          * 8: snd_cwnd = tp->snd_cwnd;  // verifier will complain
  85          *
  86          * After bpf_sk_release(sk) at line 7, both "fullsock" ptr and
  87          * "tp" ptr should be invalidated also.  In order to do that,
  88          * the reg holding "fullsock" and "sk" need to remember
  89          * the original refcounted ptr id (i.e. sk_reg->id) in ref_obj_id
  90          * such that the verifier can reset all regs which have
  91          * ref_obj_id matching the sk_reg->id.
  92          *
  93          * sk_reg->ref_obj_id is set to sk_reg->id at line 1.
  94          * sk_reg->id will stay as NULL-marking purpose only.
  95          * After NULL-marking is done, sk_reg->id can be reset to 0.
  96          *
  97          * After "fullsock = bpf_sk_fullsock(sk);" at line 3,
  98          * fullsock_reg->ref_obj_id is set to sk_reg->ref_obj_id.
  99          *
 100          * After "tp = bpf_tcp_sock(fullsock);" at line 5,
 101          * tp_reg->ref_obj_id is set to fullsock_reg->ref_obj_id
 102          * which is the same as sk_reg->ref_obj_id.
 103          *
 104          * From the verifier perspective, if sk, fullsock and tp
 105          * are not NULL, they are the same ptr with different
 106          * reg->type.  In particular, bpf_sk_release(tp) is also
 107          * allowed and has the same effect as bpf_sk_release(sk).
 108          */
 109         u32 ref_obj_id;
 110         /* For scalar types (SCALAR_VALUE), this represents our knowledge of
 111          * the actual value.
 112          * For pointer types, this represents the variable part of the offset
 113          * from the pointed-to object, and is shared with all bpf_reg_states
 114          * with the same id as us.
 115          */
 116         struct tnum var_off;
 117         /* Used to determine if any memory access using this register will
 118          * result in a bad access.
 119          * These refer to the same value as var_off, not necessarily the actual
 120          * contents of the register.
 121          */
 122         s64 smin_value; /* minimum possible (s64)value */
 123         s64 smax_value; /* maximum possible (s64)value */
 124         u64 umin_value; /* minimum possible (u64)value */
 125         u64 umax_value; /* maximum possible (u64)value */
 126         /* parentage chain for liveness checking */
 127         struct bpf_reg_state *parent;
 128         /* Inside the callee two registers can be both PTR_TO_STACK like
 129          * R1=fp-8 and R2=fp-8, but one of them points to this function stack
 130          * while another to the caller's stack. To differentiate them 'frameno'
 131          * is used which is an index in bpf_verifier_state->frame[] array
 132          * pointing to bpf_func_state.
 133          */
 134         u32 frameno;
 135         /* Tracks subreg definition. The stored value is the insn_idx of the
 136          * writing insn. This is safe because subreg_def is used before any insn
 137          * patching which only happens after main verification finished.
 138          */
 139         s32 subreg_def;
 140         enum bpf_reg_liveness live;
 141         /* if (!precise && SCALAR_VALUE) min/max/tnum don't affect safety */
 142         bool precise;
 143 };
 144
 145 enum bpf_stack_slot_type {
 146         STACK_INVALID,    /* nothing was stored in this stack slot */
 147         STACK_SPILL,      /* register spilled into stack */
 148         STACK_MISC,       /* BPF program wrote some data into this slot */
 149         STACK_ZERO,       /* BPF program wrote constant zero */
 150 };
 151
 152 #define BPF_REG_SIZE 8  /* size of eBPF register in bytes */
 153
 154 struct bpf_stack_state {
 155         struct bpf_reg_state spilled_ptr;
 156         u8 slot_type[BPF_REG_SIZE];
 157 };
 158
 159 struct bpf_reference_state {
 160         /* Track each reference created with a unique id, even if the same
 161          * instruction creates the reference multiple times (eg, via CALL).
 162          */
 163         int id;
 164         /* Instruction where the allocation of this reference occurred. This
 165          * is used purely to inform the user of a reference leak.
 166          */
 167         int insn_idx;
 168 };
 169
 170 /* state of the program:
 171  * type of all registers and stack info
 172  */
 173 struct bpf_func_state {
 174         struct bpf_reg_state regs[MAX_BPF_REG];
 175         /* index of call instruction that called into this func */
 176         int callsite;
 177         /* stack frame number of this function state from pov of
 178          * enclosing bpf_verifier_state.
 179          * 0 = main function, 1 = first callee.
 180          */
 181         u32 frameno;
 182         /* subprog number == index within subprog_stack_depth
 183          * zero == main subprog
 184          */
 185         u32 subprogno;
 186
 187         /* The following fields should be last. See copy_func_state() */
 188         int acquired_refs;
 189         struct bpf_reference_state *refs;
 190         int allocated_stack;
 191         struct bpf_stack_state *stack;
 192 };
 193
 194 struct bpf_idx_pair {
 195         u32 prev_idx;
 196         u32 idx;
 197 };
 198
 199 #define MAX_CALL_FRAMES 8
 200 struct bpf_verifier_state {
 201         /* call stack tracking */
 202         struct bpf_func_state *frame[MAX_CALL_FRAMES];
 203         struct bpf_verifier_state *parent;
 204         /*
 205          * 'branches' field is the number of branches left to explore:
 206          * 0 - all possible paths from this state reached bpf_exit or
 207          * were safely pruned
 208          * 1 - at least one path is being explored.
 209          * This state hasn't reached bpf_exit
 210          * 2 - at least two paths are being explored.
 211          * This state is an immediate parent of two children.
 212          * One is fallthrough branch with branches==1 and another
 213          * state is pushed into stack (to be explored later) also with
 214          * branches==1. The parent of this state has branches==1.
 215          * The verifier state tree connected via 'parent' pointer looks like:
 216          * 1
 217          * 1
 218          * 2 -> 1 (first 'if' pushed into stack)
 219          * 1
 220          * 2 -> 1 (second 'if' pushed into stack)
 221          * 1
 222          * 1
 223          * 1 bpf_exit.
 224          *
 225          * Once do_check() reaches bpf_exit, it calls update_branch_counts()
 226          * and the verifier state tree will look:
 227          * 1
 228          * 1
 229          * 2 -> 1 (first 'if' pushed into stack)
 230          * 1
 231          * 1 -> 1 (second 'if' pushed into stack)
 232          * 0
 233          * 0
 234          * 0 bpf_exit.
 235          * After pop_stack() the do_check() will resume at second 'if'.
 236          *
 237          * If is_state_visited() sees a state with branches > 0 it means
 238          * there is a loop. If such state is exactly equal to the current state
 239          * it's an infinite loop. Note states_equal() checks for states
 240          * equvalency, so two states being 'states_equal' does not mean
 241          * infinite loop. The exact comparison is provided by
 242          * states_maybe_looping() function. It's a stronger pre-check and
 243          * much faster than states_equal().
 244          *
 245          * This algorithm may not find all possible infinite loops or
 246          * loop iteration count may be too high.
 247          * In such cases BPF_COMPLEXITY_LIMIT_INSNS limit kicks in.
 248          */
 249         u32 branches;
 250         u32 insn_idx;
 251         u32 curframe;
 252         u32 active_spin_lock;
 253         bool speculative;
 254
 255         /* first and last insn idx of this verifier state */
 256         u32 first_insn_idx;
 257         u32 last_insn_idx;
 258         /* jmp history recorded from first to last.
 259          * backtracking is using it to go from last to first.
 260          * For most states jmp_history_cnt is [0-3].
 261          * For loops can go up to ~40.
 262          */
 263         struct bpf_idx_pair *jmp_history;
 264         u32 jmp_history_cnt;
 265 };
 266
 267 #define bpf_get_spilled_reg(slot, frame)                                \
 268         (((slot < frame->allocated_stack / BPF_REG_SIZE) &&             \
 269           (frame->stack[slot].slot_type[0] == STACK_SPILL))             \
 270          ? &frame->stack[slot].spilled_ptr : NULL)
 271
 272 /* Iterate over 'frame', setting 'reg' to either NULL or a spilled register. */
 273 #define bpf_for_each_spilled_reg(iter, frame, reg)                      \
 274         for (iter = 0, reg = bpf_get_spilled_reg(iter, frame);          \
 275              iter < frame->allocated_stack / BPF_REG_SIZE;              \
 276              iter++, reg = bpf_get_spilled_reg(iter, frame))
 277
 278 /* linked list of verifier states used to prune search */
 279 struct bpf_verifier_state_list {
 280         struct bpf_verifier_state state;
 281         struct bpf_verifier_state_list *next;
 282         int miss_cnt, hit_cnt;
 283 };
 284
 285 /* Possible states for alu_state member. */
 286 #define BPF_ALU_SANITIZE_SRC            1U
 287 #define BPF_ALU_SANITIZE_DST            2U
 288 #define BPF_ALU_NEG_VALUE               (1U << 2)
 289 #define BPF_ALU_NON_POINTER             (1U << 3)
 290 #define BPF_ALU_SANITIZE                (BPF_ALU_SANITIZE_SRC | \
 291                                          BPF_ALU_SANITIZE_DST)
 292
 293 struct bpf_insn_aux_data {
 294         union {
 295                 enum bpf_reg_type ptr_type;     /* pointer type for load/store insns */
 296                 unsigned long map_ptr_state;    /* pointer/poison value for maps */
 297                 s32 call_imm;                   /* saved imm field of call insn */
 298                 u32 alu_limit;                  /* limit for add/sub register with pointer */
 299                 struct {
 300                         u32 map_index;          /* index into used_maps[] */
 301                         u32 map_off;            /* offset from value base address */
 302                 };
 303         };
 304         u64 map_key_state; /* constant (32 bit) key tracking for maps */
 305         int ctx_field_size; /* the ctx field size for load insn, maybe 0 */
 306         int sanitize_stack_off; /* stack slot to be cleared */
 307         bool seen; /* this insn was processed by the verifier */
 308         bool zext_dst; /* this insn zero extends dst reg */
 309         u8 alu_state; /* used in combination with alu_limit */
 310         bool prune_point;
 311         unsigned int orig_idx; /* original instruction index */
 312 };
 313
 314 #define MAX_USED_MAPS 64 /* max number of maps accessed by one eBPF program */
 315
 316 #define BPF_VERIFIER_TMP_LOG_SIZE       1024
 317
 318 struct bpf_verifier_log {
 319         u32 level;
 320         char kbuf[BPF_VERIFIER_TMP_LOG_SIZE];
 321         char __user *ubuf;
 322         u32 len_used;
 323         u32 len_total;
 324 };
 325
 326 static inline bool bpf_verifier_log_full(const struct bpf_verifier_log *log)
 327 {
 328         return log->len_used >= log->len_total - 1;
 329 }
 330
 331 #define BPF_LOG_LEVEL1  1
 332 #define BPF_LOG_LEVEL2  2
 333 #define BPF_LOG_STATS   4
 334 #define BPF_LOG_LEVEL   (BPF_LOG_LEVEL1 | BPF_LOG_LEVEL2)
 335 #define BPF_LOG_MASK    (BPF_LOG_LEVEL | BPF_LOG_STATS)
 336 #define BPF_LOG_KERNEL  (BPF_LOG_MASK + 1) /* kernel internal flag */
 337
 338 static inline bool bpf_verifier_log_needed(const struct bpf_verifier_log *log)
 339 {
 340         return (log->level && log->ubuf && !bpf_verifier_log_full(log)) ||
 341                 log->level == BPF_LOG_KERNEL;
 342 }
 343
 344 #define BPF_MAX_SUBPROGS 256
 345
 346 struct bpf_subprog_info {
 347         /* 'start' has to be the first field otherwise find_subprog() won't work */
 348         u32 start; /* insn idx of function entry point */
 349         u32 linfo_idx; /* The idx to the main_prog->aux->linfo */
 350         u16 stack_depth; /* max. stack depth used by this function */
 351 };
 352
 353 /* single container for all structs
 354  * one verifier_env per bpf_check() call
 355  */
 356 struct bpf_verifier_env {
 357         u32 insn_idx;
 358         u32 prev_insn_idx;
 359         struct bpf_prog *prog;          /* eBPF program being verified */
 360         const struct bpf_verifier_ops *ops;
 361         struct bpf_verifier_stack_elem *head; /* stack of verifier states to be processed */
 362         int stack_size;                 /* number of states to be processed */
 363         bool strict_alignment;          /* perform strict pointer alignment checks */
 364         bool test_state_freq;           /* test verifier with different pruning frequency */
 365         struct bpf_verifier_state *cur_state; /* current verifier state */
 366         struct bpf_verifier_state_list **explored_states; /* search pruning optimization */
 367         struct bpf_verifier_state_list *free_list;
 368         struct bpf_map *used_maps[MAX_USED_MAPS]; /* array of map's used by eBPF program */
 369         u32 used_map_cnt;               /* number of used maps */
 370         u32 id_gen;                     /* used to generate unique reg IDs */
 371         bool allow_ptr_leaks;
 372         bool seen_direct_write;
 373         struct bpf_insn_aux_data *insn_aux_data; /* array of per-insn state */
 374         const struct bpf_line_info *prev_linfo;
 375         struct bpf_verifier_log log;
 376         struct bpf_subprog_info subprog_info[BPF_MAX_SUBPROGS + 1];
 377         struct {
 378                 int *insn_state;
 379                 int *insn_stack;
 380                 int cur_stack;
 381         } cfg;
 382         u32 subprog_cnt;
 383         /* number of instructions analyzed by the verifier */
 384         u32 prev_insn_processed, insn_processed;
 385         /* number of jmps, calls, exits analyzed so far */
 386         u32 prev_jmps_processed, jmps_processed;
 387         /* total verification time */
 388         u64 verification_time;
 389         /* maximum number of verifier states kept in 'branching' instructions */
 390         u32 max_states_per_insn;
 391         /* total number of allocated verifier states */
 392         u32 total_states;
 393         /* some states are freed during program analysis.
 394          * this is peak number of states. this number dominates kernel
 395          * memory consumption during verification
 396          */
 397         u32 peak_states;
 398         /* longest register parentage chain walked for liveness marking */
 399         u32 longest_mark_read_walk;
 400 };
 401
 402 __printf(2, 0) void bpf_verifier_vlog(struct bpf_verifier_log *log,
 403                                       const char *fmt, va_list args);
 404 __printf(2, 3) void bpf_verifier_log_write(struct bpf_verifier_env *env,
 405                                            const char *fmt, ...);
 406 __printf(2, 3) void bpf_log(struct bpf_verifier_log *log,
 407                             const char *fmt, ...);
 408
 409 static inline struct bpf_func_state *cur_func(struct bpf_verifier_env *env)
 410 {
 411         struct bpf_verifier_state *cur = env->cur_state;
 412
 413         return cur->frame[cur->curframe];
 414 }
 415
 416 static inline struct bpf_reg_state *cur_regs(struct bpf_verifier_env *env)
 417 {
 418         return cur_func(env)->regs;
 419 }
 420
 421 int bpf_prog_offload_verifier_prep(struct bpf_prog *prog);
 422 int bpf_prog_offload_verify_insn(struct bpf_verifier_env *env,
 423                                  int insn_idx, int prev_insn_idx);
 424 int bpf_prog_offload_finalize(struct bpf_verifier_env *env);
 425 void
 426 bpf_prog_offload_replace_insn(struct bpf_verifier_env *env, u32 off,
 427                               struct bpf_insn *insn);
 428 void
 429 bpf_prog_offload_remove_insns(struct bpf_verifier_env *env, u32 off, u32 cnt);
 430
 431 #endif /* _LINUX_BPF_VERIFIER_H */