Merge "citrix" branch into "master".
[openvswitch] / lib / vconn.h
1 /*
2  * Copyright (c) 2008, 2009, 2010 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 VCONN_H
18 #define VCONN_H 1
19
20 #include <assert.h>
21 #include <stdbool.h>
22 #include <stddef.h>
23 #include <stdint.h>
24
25 #include "flow.h"
26
27 struct ofpbuf;
28 struct ofp_action_header;
29 struct ofp_header;
30 struct ofp_match;
31 struct ofp_stats_reply;
32 struct pvconn;
33 struct vconn;
34
35 void vconn_usage(bool active, bool passive, bool bootstrap);
36
37 /* Active vconns: virtual connections to OpenFlow devices. */
38 int vconn_verify_name(const char *name);
39 int vconn_open(const char *name, int min_version, struct vconn **);
40 void vconn_close(struct vconn *);
41 const char *vconn_get_name(const struct vconn *);
42 uint32_t vconn_get_remote_ip(const struct vconn *);
43 uint16_t vconn_get_remote_port(const struct vconn *);
44 uint32_t vconn_get_local_ip(const struct vconn *);
45 uint16_t vconn_get_local_port(const struct vconn *);
46 int vconn_connect(struct vconn *);
47 int vconn_recv(struct vconn *, struct ofpbuf **);
48 int vconn_send(struct vconn *, struct ofpbuf *);
49 int vconn_recv_xid(struct vconn *, uint32_t xid, struct ofpbuf **);
50 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
51
52 void vconn_run(struct vconn *);
53 void vconn_run_wait(struct vconn *);
54
55 int vconn_open_block(const char *name, int min_version, struct vconn **);
56 int vconn_send_block(struct vconn *, struct ofpbuf *);
57 int vconn_recv_block(struct vconn *, struct ofpbuf **);
58
59 enum vconn_wait_type {
60     WAIT_CONNECT,
61     WAIT_RECV,
62     WAIT_SEND
63 };
64 void vconn_wait(struct vconn *, enum vconn_wait_type);
65 void vconn_connect_wait(struct vconn *);
66 void vconn_recv_wait(struct vconn *);
67 void vconn_send_wait(struct vconn *);
68
69 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
70 int pvconn_verify_name(const char *name);
71 int pvconn_open(const char *name, struct pvconn **);
72 const char *pvconn_get_name(const struct pvconn *);
73 void pvconn_close(struct pvconn *);
74 int pvconn_accept(struct pvconn *, int min_version, struct vconn **);
75 void pvconn_wait(struct pvconn *);
76
77 /* OpenFlow protocol utility functions. */
78 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
79 void *make_openflow_xid(size_t openflow_len, uint8_t type,
80                         uint32_t xid, struct ofpbuf **);
81 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
82 void *put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
83                        struct ofpbuf *);
84 void update_openflow_length(struct ofpbuf *);
85 struct ofpbuf *make_flow_mod(uint16_t command, const flow_t *,
86                              size_t actions_len);
87 struct ofpbuf *make_add_flow(const flow_t *, uint32_t buffer_id,
88                              uint16_t max_idle, size_t actions_len);
89 struct ofpbuf *make_del_flow(const flow_t *);
90 struct ofpbuf *make_add_simple_flow(const flow_t *,
91                                     uint32_t buffer_id, uint16_t out_port,
92                                     uint16_t max_idle);
93 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
94                               uint8_t reason,
95                               const struct ofpbuf *payload, int max_send_len);
96 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
97                                uint16_t in_port,
98                                const struct ofp_action_header *,
99                                size_t n_actions);
100 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
101                                         uint16_t in_port, uint16_t out_port);
102 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
103                                           uint16_t in_port, uint16_t out_port);
104 struct ofpbuf *make_echo_request(void);
105 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
106 int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size);
107 int check_ofp_message_array(const struct ofp_header *, uint8_t type,
108                             size_t size, size_t array_elt_size,
109                             size_t *n_array_elts);
110 int check_ofp_packet_out(const struct ofp_header *, struct ofpbuf *data,
111                          int *n_actions, int max_ports);
112
113 struct flow_stats_iterator {
114     const uint8_t *pos, *end;
115 };
116 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
117                                               const struct ofp_stats_reply *);
118 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
119
120 struct actions_iterator {
121     const union ofp_action *pos, *end;
122 };
123 const union ofp_action *actions_first(struct actions_iterator *,
124                                       const union ofp_action *,
125                                       size_t n_actions);
126 const union ofp_action *actions_next(struct actions_iterator *);
127 int validate_actions(const union ofp_action *, size_t n_actions,
128                      int max_ports);
129
130 void normalize_match(struct ofp_match *);
131
132 static inline int
133 ofp_mkerr(uint16_t type, uint16_t code)
134 {
135     assert(type > 0 && type <= 0x7fff);
136     return (type << 16) | code;
137 }
138
139 #endif /* vconn.h */