Merge commit 'origin/citrix'
[sliver-openvswitch.git] / ofproto / ofproto.h
1 /*
2  * Copyright (c) 2009 Nicira Networks.
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 OFPROTO_H
18 #define OFPROTO_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23 #include "flow.h"
24 #include "tag.h"
25
26 struct odp_actions;
27 struct ofhooks;
28 struct ofproto;
29 struct svec;
30
31 struct ofexpired {
32     flow_t flow;
33     uint64_t packet_count;      /* Packets from *expired* subrules. */
34     uint64_t byte_count;        /* Bytes from *expired* subrules. */
35     long long int used;         /* Last-used time (0 if never used). */
36     long long int created;      /* Creation time. */
37     uint8_t tcp_flags;          /* Bitwise-OR of all TCP flags seen. */
38     uint8_t ip_tos;             /* Last-seen IP type-of-service. */
39 };
40
41 int ofproto_create(const char *datapath, const struct ofhooks *, void *aux,
42                    struct ofproto **ofprotop);
43 void ofproto_destroy(struct ofproto *);
44 int ofproto_run(struct ofproto *);
45 int ofproto_run1(struct ofproto *);
46 int ofproto_run2(struct ofproto *, bool revalidate_all);
47 void ofproto_wait(struct ofproto *);
48 bool ofproto_is_alive(const struct ofproto *);
49
50 /* Configuration. */
51 void ofproto_set_datapath_id(struct ofproto *, uint64_t datapath_id);
52 void ofproto_set_mgmt_id(struct ofproto *, uint64_t mgmt_id);
53 void ofproto_set_probe_interval(struct ofproto *, int probe_interval);
54 void ofproto_set_max_backoff(struct ofproto *, int max_backoff);
55 void ofproto_set_desc(struct ofproto *,
56                       const char *manufacturer, const char *hardware,
57                       const char *software, const char *serial);
58 int ofproto_set_in_band(struct ofproto *, bool in_band);
59 int ofproto_set_discovery(struct ofproto *, bool discovery,
60                           const char *accept_controller_re,
61                           bool update_resolv_conf);
62 int ofproto_set_controller(struct ofproto *, const char *controller);
63 int ofproto_set_listeners(struct ofproto *, const struct svec *listeners);
64 int ofproto_set_snoops(struct ofproto *, const struct svec *snoops);
65 int ofproto_set_netflow(struct ofproto *, const struct svec *collectors,
66         uint8_t engine_type, uint8_t engine_id, bool add_id_to_iface);
67 void ofproto_set_failure(struct ofproto *, bool fail_open);
68 void ofproto_set_rate_limit(struct ofproto *, int rate_limit, int burst_limit);
69 int ofproto_set_stp(struct ofproto *, bool enable_stp);
70 int ofproto_set_remote_execution(struct ofproto *, const char *command_acl,
71                                  const char *command_dir);
72
73 /* Configuration querying. */
74 uint64_t ofproto_get_datapath_id(const struct ofproto *);
75 uint64_t ofproto_get_mgmt_id(const struct ofproto *);
76 int ofproto_get_probe_interval(const struct ofproto *);
77 int ofproto_get_max_backoff(const struct ofproto *);
78 bool ofproto_get_in_band(const struct ofproto *);
79 bool ofproto_get_discovery(const struct ofproto *);
80 const char *ofproto_get_controller(const struct ofproto *);
81 void ofproto_get_listeners(const struct ofproto *, struct svec *);
82 void ofproto_get_snoops(const struct ofproto *, struct svec *);
83 void ofproto_get_all_flows(struct ofproto *p, struct ds *);
84
85 /* Functions for use by ofproto implementation modules, not by clients. */
86 int ofproto_send_packet(struct ofproto *, const flow_t *,
87                         const union ofp_action *, size_t n_actions,
88                         const struct ofpbuf *);
89 void ofproto_add_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
90                       unsigned int priority,
91                       const union ofp_action *, size_t n_actions,
92                       int idle_timeout);
93 void ofproto_delete_flow(struct ofproto *, const flow_t *, uint32_t wildcards,
94                          unsigned int priority);
95 void ofproto_flush_flows(struct ofproto *);
96
97 /* Hooks for ovs-vswitchd. */
98 struct ofhooks {
99     void (*port_changed_cb)(enum ofp_port_reason, const struct ofp_phy_port *,
100                             void *aux);
101     bool (*normal_cb)(const flow_t *, const struct ofpbuf *packet,
102                       struct odp_actions *, tag_type *, void *aux);
103     void (*account_flow_cb)(const flow_t *, const union odp_action *,
104                             size_t n_actions, unsigned long long int n_bytes,
105                             void *aux);
106     void (*account_checkpoint_cb)(void *aux);
107 };
108 void ofproto_revalidate(struct ofproto *, tag_type);
109 struct tag_set *ofproto_get_revalidate_set(struct ofproto *);
110
111 #endif /* ofproto.h */