]>
Commit | Line | Data |
---|---|---|
09246b99 | 1 | /* |
04f48a68 | 2 | * Copyright (c) 2010-2017 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). */ | |
04f48a68 YHW |
79 | enum ofperr nx_pull_entry(struct ofpbuf *, const struct vl_mff_map *, |
80 | const struct mf_field **, union mf_value *value, | |
81 | union mf_value *mask); | |
82 | enum ofperr nx_pull_header(struct ofpbuf *, const struct vl_mff_map *, | |
83 | const struct mf_field **, bool *masked); | |
1cb20095 JG |
84 | void nxm_put__(struct ofpbuf *b, enum mf_field_id field, |
85 | enum ofp_version version, const void *value, | |
86 | const void *mask, size_t n_bytes); | |
04f48a68 | 87 | void nx_put_entry(struct ofpbuf *, const struct mf_field *, enum ofp_version, |
178742f9 BP |
88 | const union mf_value *value, const union mf_value *mask); |
89 | void nx_put_header(struct ofpbuf *, enum mf_field_id, enum ofp_version, | |
90 | bool masked); | |
04f48a68 YHW |
91 | void nx_put_mff_header(struct ofpbuf *, const struct mf_field *, |
92 | enum ofp_version, bool); | |
178742f9 BP |
93 | |
94 | /* NXM and OXM protocol headers values. | |
95 | * | |
96 | * These are often alternatives to nx_pull_entry/header() and | |
97 | * nx_put_entry/header() for decoding and encoding OXM/NXM. In those cases, | |
98 | * the nx_*() functions should be preferred because they can support the 64-bit | |
99 | * "experimenter" OXM format (even though it is not yet implemented). */ | |
508a9338 | 100 | uint32_t mf_nxm_header(enum mf_field_id); |
04f48a68 YHW |
101 | uint32_t nxm_header_from_mff(const struct mf_field *); |
102 | const struct mf_field *mf_from_nxm_header(uint32_t nxm_header, | |
103 | const struct vl_mff_map *); | |
178742f9 | 104 | |
09246b99 | 105 | char *nx_match_to_string(const uint8_t *, unsigned int match_len); |
db5a1019 | 106 | char *oxm_match_to_string(const struct ofpbuf *, unsigned int match_len); |
09246b99 | 107 | int nx_match_from_string(const char *, struct ofpbuf *); |
7623f4dd | 108 | int oxm_match_from_string(const char *, struct ofpbuf *); |
09246b99 | 109 | |
178742f9 BP |
110 | void nx_format_field_name(enum mf_field_id, enum ofp_version, struct ds *); |
111 | ||
bdda5aca | 112 | char *nxm_parse_reg_move(struct ofpact_reg_move *, const char *) |
cab50449 | 113 | OVS_WARN_UNUSED_RESULT; |
f25d0cf3 BP |
114 | |
115 | void nxm_format_reg_move(const struct ofpact_reg_move *, struct ds *); | |
f393f81e | 116 | |
f25d0cf3 | 117 | enum ofperr nxm_reg_move_check(const struct ofpact_reg_move *, |
816fd533 | 118 | const struct flow *); |
b6c9e612 | 119 | |
f25d0cf3 | 120 | void nxm_reg_load(const struct mf_subfield *, uint64_t src_data, |
f74e7df7 | 121 | struct flow *, struct flow_wildcards *); |
b6c9e612 | 122 | |
bdda5aca | 123 | char *nxm_parse_stack_action(struct ofpact_stack *, const char *) |
cab50449 | 124 | OVS_WARN_UNUSED_RESULT; |
bd85dac1 AZ |
125 | |
126 | void nxm_format_stack_push(const struct ofpact_stack *, struct ds *); | |
127 | void nxm_format_stack_pop(const struct ofpact_stack *, struct ds *); | |
128 | ||
bd85dac1 AZ |
129 | enum ofperr nxm_stack_push_check(const struct ofpact_stack *, |
130 | const struct flow *); | |
131 | enum ofperr nxm_stack_pop_check(const struct ofpact_stack *, | |
132 | const struct flow *); | |
84cf3c1f JR |
133 | void nx_stack_push(struct ofpbuf *stack, const void *v, uint8_t bytes); |
134 | void nx_stack_push_bottom(struct ofpbuf *stack, const void *v, uint8_t bytes); | |
135 | void *nx_stack_pop(struct ofpbuf *stack, uint8_t *bytes); | |
bd85dac1 | 136 | |
bd85dac1 | 137 | void nxm_execute_stack_push(const struct ofpact_stack *, |
bcd2633a JP |
138 | const struct flow *, struct flow_wildcards *, |
139 | struct ofpbuf *); | |
2d9b49dd BP |
140 | bool nxm_execute_stack_pop(const struct ofpact_stack *, |
141 | struct flow *, struct flow_wildcards *, | |
142 | struct ofpbuf *); | |
bd85dac1 | 143 | |
178742f9 BP |
144 | ovs_be64 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *, enum ofp_version); |
145 | struct mf_bitmap oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap, | |
146 | enum ofp_version); | |
147 | struct mf_bitmap oxm_writable_fields(void); | |
148 | struct mf_bitmap oxm_matchable_fields(void); | |
149 | struct mf_bitmap oxm_maskable_fields(void); | |
4291acd2 | 150 | |
816fd533 | 151 | /* Dealing with the 'ofs_nbits' members in several Nicira extensions. */ |
c979df05 BP |
152 | |
153 | static inline ovs_be16 | |
154 | nxm_encode_ofs_nbits(int ofs, int n_bits) | |
155 | { | |
156 | return htons((ofs << 6) | (n_bits - 1)); | |
157 | } | |
158 | ||
159 | static inline int | |
160 | nxm_decode_ofs(ovs_be16 ofs_nbits) | |
161 | { | |
162 | return ntohs(ofs_nbits) >> 6; | |
163 | } | |
164 | ||
165 | static inline int | |
166 | nxm_decode_n_bits(ovs_be16 ofs_nbits) | |
167 | { | |
168 | return (ntohs(ofs_nbits) & 0x3f) + 1; | |
169 | } | |
170 | \f | |
2e4f5fcf BP |
171 | /* This is my guess at the length of a "typical" nx_match, for use in |
172 | * predicting space requirements. */ | |
173 | #define NXM_TYPICAL_LEN 64 | |
174 | ||
09246b99 | 175 | #endif /* nx-match.h */ |