lib/nx-match.h

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef NX_MATCH_H
  18 #define NX_MATCH_H 1
  19
  20 #include <stdint.h>
  21 #include <sys/types.h>
  22 #include <netinet/in.h>
  23 #include "openvswitch/types.h"
  24
  25 struct cls_rule;
  26 struct ds;
  27 struct flow;
  28 struct ofpbuf;
  29 struct nx_action_reg_load;
  30 struct nx_action_reg_move;
  31
  32 /* Nicira Extended Match (NXM) flexible flow match helper functions.
  33  *
  34  * See include/openflow/nicira-ext.h for NXM specification.
  35  */
  36
  37 int nx_pull_match(struct ofpbuf *, unsigned int match_len, uint16_t priority,
  38                   struct cls_rule *, ovs_be64 *cookie, ovs_be64 *cookie_mask);
  39 int nx_pull_match_loose(struct ofpbuf *, unsigned int match_len,
  40                         uint16_t priority, struct cls_rule *,
  41                         ovs_be64 *cookie, ovs_be64 *cookie_mask);
  42 int nx_put_match(struct ofpbuf *, const struct cls_rule *,
  43                  ovs_be64 cookie, ovs_be64 cookie_mask);
  44
  45 char *nx_match_to_string(const uint8_t *, unsigned int match_len);
  46 int nx_match_from_string(const char *, struct ofpbuf *);
  47
  48 uint64_t nxm_read_field_bits(ovs_be32 header, ovs_be16 ofs_nbits,
  49                              const struct flow *);
  50
  51 void nxm_parse_reg_move(struct nx_action_reg_move *, const char *);
  52 void nxm_parse_reg_load(struct nx_action_reg_load *, const char *);
  53
  54 void nxm_format_reg_move(const struct nx_action_reg_move *, struct ds *);
  55 void nxm_format_reg_load(const struct nx_action_reg_load *, struct ds *);
  56
  57 int nxm_check_reg_move(const struct nx_action_reg_move *, const struct flow *);
  58 int nxm_check_reg_load(const struct nx_action_reg_load *, const struct flow *);
  59 int nxm_src_check(ovs_be32 src, unsigned int ofs, unsigned int n_bits,
  60                   const struct flow *);
  61 int nxm_dst_check(ovs_be32 dst, unsigned int ofs, unsigned int n_bits,
  62                   const struct flow *);
  63
  64 void nxm_execute_reg_move(const struct nx_action_reg_move *, struct flow *);
  65 void nxm_execute_reg_load(const struct nx_action_reg_load *, struct flow *);
  66 void nxm_reg_load(ovs_be32 dst, ovs_be16 ofs_nbits, uint64_t src_data,
  67                   struct flow *);
  68
  69 int nxm_field_bytes(uint32_t header);
  70 int nxm_field_bits(uint32_t header);
  71
  72 const char *nxm_parse_field_bits(const char *s,
  73                                  uint32_t *headerp, int *ofsp, int *n_bitsp);
  74 void nxm_format_field_bits(struct ds *, uint32_t header, int ofs, int n_bits);
  75
  76 /* Dealing with the 'ofs_nbits' members of struct nx_action_reg_load and struct
  77  * nx_action_multipath. */
  78
  79 static inline ovs_be16
  80 nxm_encode_ofs_nbits(int ofs, int n_bits)
  81 {
  82     return htons((ofs << 6) | (n_bits - 1));
  83 }
  84
  85 static inline int
  86 nxm_decode_ofs(ovs_be16 ofs_nbits)
  87 {
  88     return ntohs(ofs_nbits) >> 6;
  89 }
  90
  91 static inline int
  92 nxm_decode_n_bits(ovs_be16 ofs_nbits)
  93 {
  94     return (ntohs(ofs_nbits) & 0x3f) + 1;
  95 }
  96 \f
  97 /* Upper bound on the length of an nx_match.  The longest nx_match (an
  98  * IPV6 neighbor discovery message using 5 registers) would be:
  99  *
 100  *                   header  value  mask  total
 101  *                   ------  -----  ----  -----
 102  *  NXM_OF_IN_PORT      4       2    --      6
 103  *  NXM_OF_ETH_DST_W    4       6     6     16
 104  *  NXM_OF_ETH_SRC      4       6    --     10
 105  *  NXM_OF_ETH_TYPE     4       2    --      6
 106  *  NXM_OF_VLAN_TCI     4       2     2      8
 107  *  NXM_OF_IP_TOS       4       1    --      5
 108  *  NXM_NX_IP_ECN       4       1    --      5
 109  *  NXM_OF_IP_TTL       4       1    --      5
 110  *  NXM_NX_IP_FRAG      4       1     1      8
 111  *  NXM_OF_IP_PROTO     4       2    --      6
 112  *  NXM_OF_IPV6_SRC_W   4      16    16     36
 113  *  NXM_OF_IPV6_DST_W   4      16    16     36
 114  *  NXM_OF_IPV6_LABEL   4       4    --      8
 115  *  NXM_OF_ICMP_TYPE    4       1    --      5
 116  *  NXM_OF_ICMP_CODE    4       1    --      5
 117  *  NXM_NX_ND_TARGET    4      16    --     20
 118  *  NXM_NX_ND_SLL       4       6    --     10
 119  *  NXM_NX_REG_W(0)     4       4     4     12
 120  *  NXM_NX_REG_W(1)     4       4     4     12
 121  *  NXM_NX_REG_W(2)     4       4     4     12
 122  *  NXM_NX_REG_W(3)     4       4     4     12
 123  *  NXM_NX_REG_W(4)     4       4     4     12
 124  *  NXM_NX_TUN_ID_W     4       8     8     20
 125  *  -------------------------------------------
 126  *  total                                  275
 127  *
 128  * So this value is conservative.
 129  */
 130 #define NXM_MAX_LEN 384
 131
 132 /* This is my guess at the length of a "typical" nx_match, for use in
 133  * predicting space requirements. */
 134 #define NXM_TYPICAL_LEN 64
 135
 136 #endif /* nx-match.h */