Introduce ofpacts, an abstraction of OpenFlow actions.
[cascardo/ovs.git] / lib / learn.h
1 /*
2  * Copyright (c) 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 LEARN_H
18 #define LEARN_H 1
19
20 #include "ofp-errors.h"
21
22 struct ds;
23 struct flow;
24 struct ofpbuf;
25 struct ofpact_learn;
26 struct ofputil_flow_mod;
27 struct nx_action_learn;
28
29 /* NXAST_LEARN helper functions.
30  *
31  * See include/openflow/nicira-ext.h for NXAST_LEARN specification.
32  */
33
34 enum ofperr learn_from_openflow(const struct nx_action_learn *,
35                                 struct ofpbuf *ofpacts);
36 enum ofperr learn_check(const struct ofpact_learn *, const struct flow *);
37 void learn_to_nxast(const struct ofpact_learn *, struct ofpbuf *openflow);
38
39 void learn_execute(const struct ofpact_learn *, const struct flow *,
40                    struct ofputil_flow_mod *, struct ofpbuf *ofpacts);
41
42 void learn_parse(char *, const struct flow *, struct ofpbuf *ofpacts);
43 void learn_format(const struct ofpact_learn *, struct ds *);
44
45 #endif /* learn.h */