lib/nx-match.h

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