]>
Commit | Line | Data |
---|---|---|
09246b99 | 1 | /* |
9f6e20b7 | 2 | * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2016 Nicira, Inc. |
09246b99 BP |
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> | |
c979df05 BP |
21 | #include <sys/types.h> |
22 | #include <netinet/in.h> | |
bdda5aca | 23 | #include "compiler.h" |
e9358af6 | 24 | #include "flow.h" |
064d7f84 | 25 | #include "openvswitch/meta-flow.h" |
e03c096d | 26 | #include "openvswitch/ofp-errors.h" |
c979df05 | 27 | #include "openvswitch/types.h" |
09246b99 | 28 | |
f393f81e | 29 | struct ds; |
81a76618 | 30 | struct match; |
f25d0cf3 BP |
31 | struct ofpact_reg_move; |
32 | struct ofpact_reg_load; | |
bd85dac1 | 33 | struct ofpact_stack; |
09246b99 | 34 | struct ofpbuf; |
b6c9e612 BP |
35 | struct nx_action_reg_load; |
36 | struct nx_action_reg_move; | |
09246b99 | 37 | |
bd85dac1 | 38 | |
09246b99 BP |
39 | /* Nicira Extended Match (NXM) flexible flow match helper functions. |
40 | * | |
41 | * See include/openflow/nicira-ext.h for NXM specification. | |
42 | */ | |
43 | ||
178742f9 BP |
44 | void mf_format_subfield(const struct mf_subfield *, struct ds *); |
45 | char *mf_parse_subfield__(struct mf_subfield *sf, const char **s) | |
cab50449 | 46 | OVS_WARN_UNUSED_RESULT; |
178742f9 | 47 | char *mf_parse_subfield(struct mf_subfield *, const char *s) |
cab50449 | 48 | OVS_WARN_UNUSED_RESULT; |
178742f9 | 49 | |
9f6e20b7 | 50 | /* Decoding matches. */ |
90bf1e07 | 51 | enum ofperr nx_pull_match(struct ofpbuf *, unsigned int match_len, |
81a76618 | 52 | struct match *, |
8d8ab6c2 JG |
53 | ovs_be64 *cookie, ovs_be64 *cookie_mask, |
54 | const struct tun_table *); | |
90bf1e07 | 55 | enum ofperr nx_pull_match_loose(struct ofpbuf *, unsigned int match_len, |
81a76618 | 56 | struct match *, ovs_be64 *cookie, |
8d8ab6c2 JG |
57 | ovs_be64 *cookie_mask, |
58 | const struct tun_table *); | |
59 | enum ofperr oxm_pull_match(struct ofpbuf *, const struct tun_table *, | |
60 | struct match *); | |
61 | enum ofperr oxm_pull_match_loose(struct ofpbuf *, const struct tun_table *, | |
62 | struct match *); | |
63 | enum ofperr oxm_decode_match(const void *, size_t, const struct tun_table *, | |
64 | struct match *); | |
bc65c25a SH |
65 | enum ofperr oxm_pull_field_array(const void *, size_t fields_len, |
66 | struct field_array *); | |
9f6e20b7 BP |
67 | |
68 | /* Encoding matches. */ | |
81a76618 | 69 | int nx_put_match(struct ofpbuf *, const struct match *, |
e729e793 | 70 | ovs_be64 cookie, ovs_be64 cookie_mask); |
9d84066c | 71 | int oxm_put_match(struct ofpbuf *, const struct match *, enum ofp_version); |
9f6e20b7 | 72 | void oxm_put_raw(struct ofpbuf *, const struct match *, enum ofp_version); |
53eb84a5 SH |
73 | void oxm_format_field_array(struct ds *, const struct field_array *); |
74 | int oxm_put_field_array(struct ofpbuf *, const struct field_array *, | |
75 | enum ofp_version version); | |
09246b99 | 76 | |
178742f9 BP |
77 | /* Decoding and encoding OXM/NXM headers (just a field ID) or entries (a field |
78 | * ID followed by a value and possibly a mask). */ | |
79 | enum ofperr nx_pull_entry(struct ofpbuf *, const struct mf_field **, | |
80 | union mf_value *value, union mf_value *mask); | |
81 | enum ofperr nx_pull_header(struct ofpbuf *, const struct mf_field **, | |
82 | bool *masked); | |
1cb20095 JG |
83 | void nxm_put__(struct ofpbuf *b, enum mf_field_id field, |
84 | enum ofp_version version, const void *value, | |
85 | const void *mask, size_t n_bytes); | |
178742f9 BP |
86 | void nx_put_entry(struct ofpbuf *, enum mf_field_id, enum ofp_version, |
87 | const union mf_value *value, const union mf_value *mask); | |
88 | void nx_put_header(struct ofpbuf *, enum mf_field_id, enum ofp_version, | |
89 | bool masked); | |
90 | ||
91 | /* NXM and OXM protocol headers values. | |
92 | * | |
93 | * These are often alternatives to nx_pull_entry/header() and | |
94 | * nx_put_entry/header() for decoding and encoding OXM/NXM. In those cases, | |
95 | * the nx_*() functions should be preferred because they can support the 64-bit | |
96 | * "experimenter" OXM format (even though it is not yet implemented). */ | |
508a9338 | 97 | uint32_t mf_nxm_header(enum mf_field_id); |
178742f9 BP |
98 | const struct mf_field *mf_from_nxm_header(uint32_t nxm_header); |
99 | ||
09246b99 | 100 | char *nx_match_to_string(const uint8_t *, unsigned int match_len); |
db5a1019 | 101 | char *oxm_match_to_string(const struct ofpbuf *, unsigned int match_len); |
09246b99 | 102 | int nx_match_from_string(const char *, struct ofpbuf *); |
7623f4dd | 103 | int oxm_match_from_string(const char *, struct ofpbuf *); |
09246b99 | 104 | |
178742f9 BP |
105 | void nx_format_field_name(enum mf_field_id, enum ofp_version, struct ds *); |
106 | ||
bdda5aca | 107 | char *nxm_parse_reg_move(struct ofpact_reg_move *, const char *) |
cab50449 | 108 | OVS_WARN_UNUSED_RESULT; |
f25d0cf3 BP |
109 | |
110 | void nxm_format_reg_move(const struct ofpact_reg_move *, struct ds *); | |
f393f81e | 111 | |
f25d0cf3 | 112 | enum ofperr nxm_reg_move_check(const struct ofpact_reg_move *, |
816fd533 | 113 | const struct flow *); |
b6c9e612 | 114 | |
f25d0cf3 | 115 | void nxm_reg_load(const struct mf_subfield *, uint64_t src_data, |
f74e7df7 | 116 | struct flow *, struct flow_wildcards *); |
b6c9e612 | 117 | |
bdda5aca | 118 | char *nxm_parse_stack_action(struct ofpact_stack *, const char *) |
cab50449 | 119 | OVS_WARN_UNUSED_RESULT; |
bd85dac1 AZ |
120 | |
121 | void nxm_format_stack_push(const struct ofpact_stack *, struct ds *); | |
122 | void nxm_format_stack_pop(const struct ofpact_stack *, struct ds *); | |
123 | ||
bd85dac1 AZ |
124 | enum ofperr nxm_stack_push_check(const struct ofpact_stack *, |
125 | const struct flow *); | |
126 | enum ofperr nxm_stack_pop_check(const struct ofpact_stack *, | |
127 | const struct flow *); | |
128 | ||
bd85dac1 | 129 | void nxm_execute_stack_push(const struct ofpact_stack *, |
bcd2633a JP |
130 | const struct flow *, struct flow_wildcards *, |
131 | struct ofpbuf *); | |
bd85dac1 | 132 | void nxm_execute_stack_pop(const struct ofpact_stack *, |
f74e7df7 JP |
133 | struct flow *, struct flow_wildcards *, |
134 | struct ofpbuf *); | |
bd85dac1 | 135 | |
178742f9 BP |
136 | ovs_be64 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *, enum ofp_version); |
137 | struct mf_bitmap oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap, | |
138 | enum ofp_version); | |
139 | struct mf_bitmap oxm_writable_fields(void); | |
140 | struct mf_bitmap oxm_matchable_fields(void); | |
141 | struct mf_bitmap oxm_maskable_fields(void); | |
4291acd2 | 142 | |
816fd533 | 143 | /* Dealing with the 'ofs_nbits' members in several Nicira extensions. */ |
c979df05 BP |
144 | |
145 | static inline ovs_be16 | |
146 | nxm_encode_ofs_nbits(int ofs, int n_bits) | |
147 | { | |
148 | return htons((ofs << 6) | (n_bits - 1)); | |
149 | } | |
150 | ||
151 | static inline int | |
152 | nxm_decode_ofs(ovs_be16 ofs_nbits) | |
153 | { | |
154 | return ntohs(ofs_nbits) >> 6; | |
155 | } | |
156 | ||
157 | static inline int | |
158 | nxm_decode_n_bits(ovs_be16 ofs_nbits) | |
159 | { | |
160 | return (ntohs(ofs_nbits) & 0x3f) + 1; | |
161 | } | |
162 | \f | |
2e4f5fcf BP |
163 | /* This is my guess at the length of a "typical" nx_match, for use in |
164 | * predicting space requirements. */ | |
165 | #define NXM_TYPICAL_LEN 64 | |
166 | ||
09246b99 | 167 | #endif /* nx-match.h */ |