lib/nx-match.h

   1 /*
   2  * Copyright (c) 2010, 2011, 2012 Nicira, Inc.
   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 "flow.h"
  24 #include "ofp-errors.h"
  25 #include "openvswitch/types.h"
  26 #include "ofp-errors.h"
  27
  28 struct cls_rule;
  29 struct ds;
  30 struct flow;
  31 struct mf_subfield;
  32 struct ofpact_reg_move;
  33 struct ofpact_reg_load;
  34 struct ofpbuf;
  35 struct nx_action_reg_load;
  36 struct nx_action_reg_move;
  37
  38 /* Nicira Extended Match (NXM) flexible flow match helper functions.
  39  *
  40  * See include/openflow/nicira-ext.h for NXM specification.
  41  */
  42
  43 enum ofperr nx_pull_match(struct ofpbuf *, unsigned int match_len,
  44                           uint16_t priority, struct cls_rule *,
  45                           ovs_be64 *cookie, ovs_be64 *cookie_mask);
  46 enum ofperr nx_pull_match_loose(struct ofpbuf *, unsigned int match_len,
  47                                 uint16_t priority,
  48                                 struct cls_rule *, ovs_be64 *cookie,
  49                                 ovs_be64 *cookie_mask);
  50 enum ofperr oxm_pull_match(struct ofpbuf *, uint16_t priority,
  51                            struct cls_rule *);
  52 enum ofperr oxm_pull_match_loose(struct ofpbuf *, uint16_t priority,
  53                                  struct cls_rule *);
  54 int nx_put_match(struct ofpbuf *, const struct cls_rule *,
  55                  ovs_be64 cookie, ovs_be64 cookie_mask);
  56 int oxm_put_match(struct ofpbuf *, const struct cls_rule *);
  57
  58 char *nx_match_to_string(const uint8_t *, unsigned int match_len);
  59 char *oxm_match_to_string(const uint8_t *, unsigned int match_len);
  60 int nx_match_from_string(const char *, struct ofpbuf *);
  61 int oxm_match_from_string(const char *, struct ofpbuf *);
  62
  63 void nxm_parse_reg_move(struct ofpact_reg_move *, const char *);
  64 void nxm_parse_reg_load(struct ofpact_reg_load *, const char *);
  65
  66 void nxm_format_reg_move(const struct ofpact_reg_move *, struct ds *);
  67 void nxm_format_reg_load(const struct ofpact_reg_load *, struct ds *);
  68
  69 enum ofperr nxm_reg_move_from_openflow(const struct nx_action_reg_move *,
  70                                        struct ofpbuf *ofpacts);
  71 enum ofperr nxm_reg_load_from_openflow(const struct nx_action_reg_load *,
  72                                        struct ofpbuf *ofpacts);
  73
  74 enum ofperr nxm_reg_move_check(const struct ofpact_reg_move *,
  75                                const struct flow *);
  76 enum ofperr nxm_reg_load_check(const struct ofpact_reg_load *,
  77                                const struct flow *);
  78
  79 void nxm_reg_move_to_nxast(const struct ofpact_reg_move *,
  80                            struct ofpbuf *openflow);
  81 void nxm_reg_load_to_nxast(const struct ofpact_reg_load *,
  82                            struct ofpbuf *openflow);
  83
  84 void nxm_execute_reg_move(const struct ofpact_reg_move *, struct flow *);
  85 void nxm_execute_reg_load(const struct ofpact_reg_load *, struct flow *);
  86 void nxm_reg_load(const struct mf_subfield *, uint64_t src_data,
  87                   struct flow *);
  88
  89 int nxm_field_bytes(uint32_t header);
  90 int nxm_field_bits(uint32_t header);
  91
  92 /* Dealing with the 'ofs_nbits' members in several Nicira extensions. */
  93
  94 static inline ovs_be16
  95 nxm_encode_ofs_nbits(int ofs, int n_bits)
  96 {
  97     return htons((ofs << 6) | (n_bits - 1));
  98 }
  99
 100 static inline int
 101 nxm_decode_ofs(ovs_be16 ofs_nbits)
 102 {
 103     return ntohs(ofs_nbits) >> 6;
 104 }
 105
 106 static inline int
 107 nxm_decode_n_bits(ovs_be16 ofs_nbits)
 108 {
 109     return (ntohs(ofs_nbits) & 0x3f) + 1;
 110 }
 111 \f
 112 /* This is my guess at the length of a "typical" nx_match, for use in
 113  * predicting space requirements. */
 114 #define NXM_TYPICAL_LEN 64
 115
 116 #endif /* nx-match.h */