ovs-thread: Add a comment.
[sliver-openvswitch.git] / lib / bundle.h
1 /* Copyright (c) 2011, 2012, 2013 Nicira, Inc.
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #ifndef BUNDLE_H
17 #define BUNDLE_H 1
18
19 #include <arpa/inet.h>
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23
24 #include "compiler.h"
25 #include "ofp-errors.h"
26 #include "openflow/nicira-ext.h"
27 #include "openvswitch/types.h"
28
29 struct ds;
30 struct flow;
31 struct flow_wildcards;
32 struct ofpact_bundle;
33 struct ofpbuf;
34
35 /* NXAST_BUNDLE helper functions.
36  *
37  * See include/openflow/nicira-ext.h for NXAST_BUNDLE specification. */
38
39 ofp_port_t bundle_execute(const struct ofpact_bundle *, const struct flow *,
40                         struct flow_wildcards *wc,
41                         bool (*slave_enabled)(ofp_port_t ofp_port, void *aux),
42                         void *aux);
43 enum ofperr bundle_from_openflow(const struct nx_action_bundle *,
44                                  struct ofpbuf *ofpact);
45 enum ofperr bundle_check(const struct ofpact_bundle *, ofp_port_t max_ports,
46                          const struct flow *);
47 void bundle_to_nxast(const struct ofpact_bundle *, struct ofpbuf *of10);
48 char *bundle_parse(const char *, struct ofpbuf *ofpacts) WARN_UNUSED_RESULT;
49 char *bundle_parse_load(const char *, struct ofpbuf *ofpacts)
50     WARN_UNUSED_RESULT;
51 void bundle_format(const struct ofpact_bundle *, struct ds *);
52
53 #endif /* bundle.h */