2 * Copyright (c) 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
26 struct nx_action_reg_load;
27 struct nx_action_reg_move;
29 /* Nicira Extended Match (NXM) flexible flow match helper functions.
31 * See include/openflow/nicira-ext.h for NXM specification.
34 int nx_pull_match(struct ofpbuf *, unsigned int match_len, uint16_t priority,
36 int nx_put_match(struct ofpbuf *, const struct cls_rule *);
38 char *nx_match_to_string(const uint8_t *, unsigned int match_len);
39 int nx_match_from_string(const char *, struct ofpbuf *);
41 void nxm_parse_reg_move(struct nx_action_reg_move *, const char *);
42 void nxm_parse_reg_load(struct nx_action_reg_load *, const char *);
44 void nxm_format_reg_move(const struct nx_action_reg_move *, struct ds *);
45 void nxm_format_reg_load(const struct nx_action_reg_load *, struct ds *);
47 int nxm_check_reg_move(const struct nx_action_reg_move *, const struct flow *);
48 int nxm_check_reg_load(const struct nx_action_reg_load *, const struct flow *);
50 void nxm_execute_reg_move(const struct nx_action_reg_move *, struct flow *);
51 void nxm_execute_reg_load(const struct nx_action_reg_load *, struct flow *);
53 /* Upper bound on the length of an nx_match. The longest nx_match (assuming
54 * we implement 4 registers) would be:
56 * header value mask total
57 * ------ ----- ---- -----
58 * NXM_OF_IN_PORT 4 2 -- 6
59 * NXM_OF_ETH_DST_W 4 6 6 16
60 * NXM_OF_ETH_SRC 4 6 -- 10
61 * NXM_OF_ETH_TYPE 4 2 -- 6
62 * NXM_OF_VLAN_TCI 4 2 2 8
63 * NXM_OF_IP_TOS 4 1 -- 5
64 * NXM_OF_IP_PROTO 4 2 -- 6
65 * NXM_OF_IP_SRC_W 4 4 4 12
66 * NXM_OF_IP_DST_W 4 4 4 12
67 * NXM_OF_TCP_SRC 4 2 -- 6
68 * NXM_OF_TCP_DST 4 2 -- 6
69 * NXM_NX_REG_W(0) 4 4 4 12
70 * NXM_NX_REG_W(1) 4 4 4 12
71 * NXM_NX_REG_W(2) 4 4 4 12
72 * NXM_NX_REG_W(3) 4 4 4 12
73 * NXM_NX_TUN_ID_W 4 8 8 20
74 * -------------------------------------------
77 * So this value is conservative.
79 #define NXM_MAX_LEN 192
81 /* This is my guess at the length of a "typical" nx_match, for use in
82 * predicting space requirements. */
83 #define NXM_TYPICAL_LEN 64
85 #endif /* nx-match.h */