net: filter: cleanup A/X name usage
authorAlexei Starovoitov <ast@plumgrid.com>
Fri, 6 Jun 2014 21:46:06 +0000 (14:46 -0700)
committerDavid S. Miller <davem@davemloft.net>
Wed, 11 Jun 2014 07:13:16 +0000 (00:13 -0700)
commite430f34ee5192c84bcabd3c79ab7e2388b5eec74
tree4b4086b0ecf0c4d67c4ae28d493b5987430da143
parent7b0dcbd879101e829755d1288c1b440ba1f59460
net: filter: cleanup A/X name usage

The macro 'A' used in internal BPF interpreter:
 #define A regs[insn->a_reg]
was easily confused with the name of classic BPF register 'A', since
'A' would mean two different things depending on context.

This patch is trying to clean up the naming and clarify its usage in the
following way:

- A and X are names of two classic BPF registers

- BPF_REG_A denotes internal BPF register R0 used to map classic register A
  in internal BPF programs generated from classic

- BPF_REG_X denotes internal BPF register R7 used to map classic register X
  in internal BPF programs generated from classic

- internal BPF instruction format:
struct sock_filter_int {
        __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_X/BPF_K is 1 bit used to encode source operand of instruction
In classic:
  BPF_X - means use register X as source operand
  BPF_K - means use 32-bit immediate as source operand
In internal:
  BPF_X - means use 'src_reg' register as source operand
  BPF_K - means use 32-bit immediate as source operand

Suggested-by: Chema Gonzalez <chema@google.com>
Signed-off-by: Alexei Starovoitov <ast@plumgrid.com>
Acked-by: Daniel Borkmann <dborkman@redhat.com>
Acked-by: Chema Gonzalez <chema@google.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/filter.txt
arch/x86/net/bpf_jit_comp.c
include/linux/filter.h
net/core/filter.c