trafgen_proto.h

   1 #ifndef TRAFGEN_PROTO_H
   2 #define TRAFGEN_PROTO_H
   3
   4 #include <stddef.h>
   5 #include <stdint.h>
   6 #include <stdbool.h>
   7
   8 enum proto_id {
   9         PROTO_NONE = 0,
  10         PROTO_ETH,
  11         PROTO_VLAN,
  12         PROTO_ARP,
  13         PROTO_MPLS,
  14         PROTO_IP4,
  15         PROTO_ICMP4,
  16         PROTO_IP6,
  17         PROTO_ICMP6,
  18         PROTO_UDP,
  19         PROTO_TCP,
  20         __PROTO_MAX,
  21 };
  22
  23 enum proto_layer {
  24         PROTO_L0, /* invalid layer */
  25         PROTO_L2,
  26         PROTO_L3,
  27         PROTO_L4,
  28 };
  29
  30 struct proto_field;
  31 struct proto_hdr;
  32
  33 struct proto_ops {
  34         enum proto_id id;
  35         enum proto_layer layer;
  36
  37         void (*header_init)(struct proto_hdr *hdr);
  38         void (*header_finish)(struct proto_hdr *hdr);
  39         void (*field_changed)(struct proto_field *field);
  40         void (*packet_finish)(struct proto_hdr *hdr);
  41         void (*packet_update)(struct proto_hdr *hdr);
  42         void (*set_next_proto)(struct proto_hdr *hdr, enum proto_id pid);
  43 };
  44
  45 struct proto_hdr {
  46         const struct proto_ops *ops;
  47         uint16_t pkt_offset;
  48         uint32_t pkt_id;
  49         uint32_t index;
  50         struct proto_field *fields;
  51         size_t fields_count;
  52         bool is_csum_valid;
  53         size_t len;
  54 };
  55
  56 enum proto_field_func_t {
  57         PROTO_FIELD_FUNC_INC = 1 << 0,
  58         PROTO_FIELD_FUNC_MIN = 1 << 1,
  59         PROTO_FIELD_FUNC_RND = 1 << 2,
  60 };
  61
  62 struct proto_field_func {
  63         enum proto_field_func_t type;
  64         uint32_t min;
  65         uint32_t max;
  66         int32_t inc;
  67         uint32_t val;
  68
  69         void (*update_field)(struct proto_field *field);
  70 };
  71
  72 struct proto_field {
  73         uint32_t id;
  74         size_t len;
  75         uint32_t shift;
  76         uint32_t mask;
  77         /* might be negative (e.g. VLAN TPID field) */
  78         int16_t offset;
  79
  80         struct proto_field_func func;
  81         bool is_set;
  82         uint16_t pkt_offset;
  83         struct proto_hdr *hdr;
  84 };
  85
  86 extern void protos_init(const char *dev);
  87 extern void proto_ops_register(const struct proto_ops *ops);
  88
  89 extern struct proto_hdr *proto_header_push(enum proto_id pid);
  90 extern void proto_header_finish(struct proto_hdr *hdr);
  91 extern void proto_packet_finish(void);
  92 extern void proto_packet_update(uint32_t idx);
  93
  94 extern struct proto_hdr *proto_lower_default_add(struct proto_hdr *hdr,
  95                                                  enum proto_id pid);
  96
  97 extern struct proto_hdr *proto_lower_header(struct proto_hdr *hdr);
  98 extern struct proto_hdr *proto_upper_header(struct proto_hdr *hdr);
  99 extern uint8_t *proto_header_ptr(struct proto_hdr *hdr);
 100
 101 extern void proto_header_fields_add(struct proto_hdr *hdr,
 102                                     const struct proto_field *fields,
 103                                     size_t count);
 104
 105 extern bool proto_field_is_set(struct proto_hdr *hdr, uint32_t fid);
 106 extern void proto_field_set_bytes(struct proto_hdr *hdr, uint32_t fid,
 107                                   const uint8_t *bytes);
 108 extern void proto_field_set_u8(struct proto_hdr *hdr, uint32_t fid, uint8_t val);
 109 extern uint8_t proto_field_get_u8(struct proto_hdr *hdr, uint32_t fid);
 110 extern void proto_field_set_u16(struct proto_hdr *hdr, uint32_t fid, uint16_t val);
 111 extern uint16_t proto_field_get_u16(struct proto_hdr *hdr, uint32_t fid);
 112 extern void proto_field_set_u32(struct proto_hdr *hdr, uint32_t fid, uint32_t val);
 113 extern uint32_t proto_field_get_u32(struct proto_hdr *hdr, uint32_t fid);
 114
 115 extern void proto_field_set_default_bytes(struct proto_hdr *hdr, uint32_t fid,
 116                                           const uint8_t *bytes);
 117 extern void proto_field_set_default_u8(struct proto_hdr *hdr, uint32_t fid,
 118                                        uint8_t val);
 119 extern void proto_field_set_default_u16(struct proto_hdr *hdr, uint32_t fid,
 120                                         uint16_t val);
 121 extern void proto_field_set_default_u32(struct proto_hdr *hdr, uint32_t fid,
 122                                         uint32_t val);
 123
 124 extern void proto_field_set_be16(struct proto_hdr *hdr, uint32_t fid, uint16_t val);
 125 extern void proto_field_set_be32(struct proto_hdr *hdr, uint32_t fid, uint32_t val);
 126
 127 extern void proto_field_set_default_be16(struct proto_hdr *hdr, uint32_t fid,
 128                                          uint16_t val);
 129 extern void proto_field_set_default_be32(struct proto_hdr *hdr, uint32_t fid,
 130                                          uint32_t val);
 131
 132 extern void proto_field_set_dev_mac(struct proto_hdr *hdr, uint32_t fid);
 133 extern void proto_field_set_default_dev_mac(struct proto_hdr *hdr, uint32_t fid);
 134
 135 extern void proto_field_set_dev_ipv4(struct proto_hdr *hdr, uint32_t fid);
 136 extern void proto_field_set_default_dev_ipv4(struct proto_hdr *hdr, uint32_t fid);
 137
 138 extern void proto_field_set_dev_ipv6(struct proto_hdr *hdr, uint32_t fid);
 139 extern void proto_field_set_default_dev_ipv6(struct proto_hdr *hdr, uint32_t fid);
 140
 141 extern void proto_field_dyn_apply(struct proto_field *field);
 142
 143 extern void proto_field_func_add(struct proto_hdr *hdr, uint32_t fid,
 144                                  struct proto_field_func *func);
 145
 146 extern struct proto_field *proto_field_by_id(struct proto_hdr *hdr, uint32_t fid);
 147
 148 #endif /* TRAFGEN_PROTO_H */