]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/nx-match.h
2 * Copyright (c) 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
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.
21 #include <sys/types.h>
22 #include <netinet/in.h>
25 #include "meta-flow.h"
26 #include "ofp-errors.h"
27 #include "openvswitch/types.h"
31 struct ofpact_reg_move
;
32 struct ofpact_reg_load
;
35 struct nx_action_reg_load
;
36 struct nx_action_reg_move
;
39 /* Nicira Extended Match (NXM) flexible flow match helper functions.
41 * See include/openflow/nicira-ext.h for NXM specification.
44 void mf_format_subfield(const struct mf_subfield
*, struct ds
*);
45 char *mf_parse_subfield__(struct mf_subfield
*sf
, const char **s
)
46 OVS_WARN_UNUSED_RESULT
;
47 char *mf_parse_subfield(struct mf_subfield
*, const char *s
)
48 OVS_WARN_UNUSED_RESULT
;
50 enum ofperr
nx_pull_match(struct ofpbuf
*, unsigned int match_len
,
52 ovs_be64
*cookie
, ovs_be64
*cookie_mask
);
53 enum ofperr
nx_pull_match_loose(struct ofpbuf
*, unsigned int match_len
,
54 struct match
*, ovs_be64
*cookie
,
55 ovs_be64
*cookie_mask
);
56 enum ofperr
oxm_pull_match(struct ofpbuf
*, struct match
*);
57 enum ofperr
oxm_pull_match_loose(struct ofpbuf
*, struct match
*);
58 enum ofperr
oxm_pull_field_array(const void *, size_t fields_len
,
59 struct field_array
*);
60 int nx_put_match(struct ofpbuf
*, const struct match
*,
61 ovs_be64 cookie
, ovs_be64 cookie_mask
);
62 int oxm_put_match(struct ofpbuf
*, const struct match
*, enum ofp_version
);
63 void oxm_format_field_array(struct ds
*, const struct field_array
*);
64 int oxm_put_field_array(struct ofpbuf
*, const struct field_array
*,
65 enum ofp_version version
);
67 /* Decoding and encoding OXM/NXM headers (just a field ID) or entries (a field
68 * ID followed by a value and possibly a mask). */
69 enum ofperr
nx_pull_entry(struct ofpbuf
*, const struct mf_field
**,
70 union mf_value
*value
, union mf_value
*mask
);
71 enum ofperr
nx_pull_header(struct ofpbuf
*, const struct mf_field
**,
73 void nxm_put(struct ofpbuf
*b
, enum mf_field_id field
,
74 enum ofp_version version
, const void *value
,
75 const void *mask
, size_t n_bytes
);
76 void nx_put_entry(struct ofpbuf
*, enum mf_field_id
, enum ofp_version
,
77 const union mf_value
*value
, const union mf_value
*mask
);
78 void nx_put_header(struct ofpbuf
*, enum mf_field_id
, enum ofp_version
,
81 /* NXM and OXM protocol headers values.
83 * These are often alternatives to nx_pull_entry/header() and
84 * nx_put_entry/header() for decoding and encoding OXM/NXM. In those cases,
85 * the nx_*() functions should be preferred because they can support the 64-bit
86 * "experimenter" OXM format (even though it is not yet implemented). */
87 uint32_t mf_nxm_header(enum mf_field_id
);
88 const struct mf_field
*mf_from_nxm_header(uint32_t nxm_header
);
90 char *nx_match_to_string(const uint8_t *, unsigned int match_len
);
91 char *oxm_match_to_string(const struct ofpbuf
*, unsigned int match_len
);
92 int nx_match_from_string(const char *, struct ofpbuf
*);
93 int oxm_match_from_string(const char *, struct ofpbuf
*);
95 void nx_format_field_name(enum mf_field_id
, enum ofp_version
, struct ds
*);
97 char *nxm_parse_reg_move(struct ofpact_reg_move
*, const char *)
98 OVS_WARN_UNUSED_RESULT
;
100 void nxm_format_reg_move(const struct ofpact_reg_move
*, struct ds
*);
102 enum ofperr
nxm_reg_move_check(const struct ofpact_reg_move
*,
103 const struct flow
*);
105 void nxm_execute_reg_move(const struct ofpact_reg_move
*, struct flow
*,
106 struct flow_wildcards
*);
107 void nxm_reg_load(const struct mf_subfield
*, uint64_t src_data
,
108 struct flow
*, struct flow_wildcards
*);
110 char *nxm_parse_stack_action(struct ofpact_stack
*, const char *)
111 OVS_WARN_UNUSED_RESULT
;
113 void nxm_format_stack_push(const struct ofpact_stack
*, struct ds
*);
114 void nxm_format_stack_pop(const struct ofpact_stack
*, struct ds
*);
116 enum ofperr
nxm_stack_push_check(const struct ofpact_stack
*,
117 const struct flow
*);
118 enum ofperr
nxm_stack_pop_check(const struct ofpact_stack
*,
119 const struct flow
*);
121 void nxm_execute_stack_push(const struct ofpact_stack
*,
122 const struct flow
*, struct flow_wildcards
*,
124 void nxm_execute_stack_pop(const struct ofpact_stack
*,
125 struct flow
*, struct flow_wildcards
*,
128 ovs_be64
oxm_bitmap_from_mf_bitmap(const struct mf_bitmap
*, enum ofp_version
);
129 struct mf_bitmap
oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap
,
131 struct mf_bitmap
oxm_writable_fields(void);
132 struct mf_bitmap
oxm_matchable_fields(void);
133 struct mf_bitmap
oxm_maskable_fields(void);
135 /* Dealing with the 'ofs_nbits' members in several Nicira extensions. */
137 static inline ovs_be16
138 nxm_encode_ofs_nbits(int ofs
, int n_bits
)
140 return htons((ofs
<< 6) | (n_bits
- 1));
144 nxm_decode_ofs(ovs_be16 ofs_nbits
)
146 return ntohs(ofs_nbits
) >> 6;
150 nxm_decode_n_bits(ovs_be16 ofs_nbits
)
152 return (ntohs(ofs_nbits
) & 0x3f) + 1;
155 /* This is my guess at the length of a "typical" nx_match, for use in
156 * predicting space requirements. */
157 #define NXM_TYPICAL_LEN 64
159 #endif /* nx-match.h */