socket-util: Remove 'passcred' parameter from make_unix_socket().
[openvswitch] / lib / nx-match.h
1 /*
2  * Copyright (c) 2010, 2011, 2012 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 "flow.h"
24 #include "ofp-errors.h"
25 #include "openvswitch/types.h"
26 #include "ofp-errors.h"
27
28 struct cls_rule;
29 struct ds;
30 struct flow;
31 struct mf_subfield;
32 struct ofpact_reg_move;
33 struct ofpact_reg_load;
34 struct ofpbuf;
35 struct nx_action_reg_load;
36 struct nx_action_reg_move;
37
38 /* Nicira Extended Match (NXM) flexible flow match helper functions.
39  *
40  * See include/openflow/nicira-ext.h for NXM specification.
41  */
42
43 enum ofperr nx_pull_match(struct ofpbuf *, unsigned int match_len,
44                           uint16_t priority, struct cls_rule *,
45                           ovs_be64 *cookie, ovs_be64 *cookie_mask);
46 enum ofperr nx_pull_match_loose(struct ofpbuf *, unsigned int match_len,
47                                 uint16_t priority, struct cls_rule *,
48                                 ovs_be64 *cookie, ovs_be64 *cookie_mask);
49 int nx_put_match(struct ofpbuf *, bool oxm, const struct cls_rule *,
50                  ovs_be64 cookie, ovs_be64 cookie_mask);
51
52 char *nx_match_to_string(const uint8_t *, unsigned int match_len);
53 int nx_match_from_string(const char *, struct ofpbuf *);
54
55 void nxm_parse_reg_move(struct ofpact_reg_move *, const char *);
56 void nxm_parse_reg_load(struct ofpact_reg_load *, const char *);
57
58 void nxm_format_reg_move(const struct ofpact_reg_move *, struct ds *);
59 void nxm_format_reg_load(const struct ofpact_reg_load *, struct ds *);
60
61 enum ofperr nxm_reg_move_from_openflow(const struct nx_action_reg_move *,
62                                        struct ofpbuf *ofpacts);
63 enum ofperr nxm_reg_load_from_openflow(const struct nx_action_reg_load *,
64                                        struct ofpbuf *ofpacts);
65
66 enum ofperr nxm_reg_move_check(const struct ofpact_reg_move *,
67                                const struct flow *);
68 enum ofperr nxm_reg_load_check(const struct ofpact_reg_load *,
69                                const struct flow *);
70
71 void nxm_reg_move_to_nxast(const struct ofpact_reg_move *,
72                            struct ofpbuf *openflow);
73 void nxm_reg_load_to_nxast(const struct ofpact_reg_load *,
74                            struct ofpbuf *openflow);
75
76 void nxm_execute_reg_move(const struct ofpact_reg_move *, struct flow *);
77 void nxm_execute_reg_load(const struct ofpact_reg_load *, struct flow *);
78 void nxm_reg_load(const struct mf_subfield *, uint64_t src_data,
79                   struct flow *);
80
81 int nxm_field_bytes(uint32_t header);
82 int nxm_field_bits(uint32_t header);
83
84 /* Dealing with the 'ofs_nbits' members in several Nicira extensions. */
85
86 static inline ovs_be16
87 nxm_encode_ofs_nbits(int ofs, int n_bits)
88 {
89     return htons((ofs << 6) | (n_bits - 1));
90 }
91
92 static inline int
93 nxm_decode_ofs(ovs_be16 ofs_nbits)
94 {
95     return ntohs(ofs_nbits) >> 6;
96 }
97
98 static inline int
99 nxm_decode_n_bits(ovs_be16 ofs_nbits)
100 {
101     return (ntohs(ofs_nbits) & 0x3f) + 1;
102 }
103 \f
104 /* This is my guess at the length of a "typical" nx_match, for use in
105  * predicting space requirements. */
106 #define NXM_TYPICAL_LEN 64
107
108 #endif /* nx-match.h */