]>
git.proxmox.com Git - mirror_ovs.git/blob - lib/vconn.h
2 * Copyright (c) 2008, 2009 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
28 struct ofp_action_header
;
31 struct ofp_stats_reply
;
35 void vconn_usage(bool active
, bool passive
, bool bootstrap
);
37 /* Active vconns: virtual connections to OpenFlow devices. */
38 int vconn_open(const char *name
, int min_version
, struct vconn
**);
39 void vconn_close(struct vconn
*);
40 const char *vconn_get_name(const struct vconn
*);
41 uint32_t vconn_get_remote_ip(const struct vconn
*);
42 uint16_t vconn_get_remote_port(const struct vconn
*);
43 uint32_t vconn_get_local_ip(const struct vconn
*);
44 uint16_t vconn_get_local_port(const struct vconn
*);
45 int vconn_connect(struct vconn
*);
46 int vconn_recv(struct vconn
*, struct ofpbuf
**);
47 int vconn_send(struct vconn
*, struct ofpbuf
*);
48 int vconn_recv_xid(struct vconn
*, uint32_t xid
, struct ofpbuf
**);
49 int vconn_transact(struct vconn
*, struct ofpbuf
*, struct ofpbuf
**);
51 int vconn_open_block(const char *name
, int min_version
, struct vconn
**);
52 int vconn_send_block(struct vconn
*, struct ofpbuf
*);
53 int vconn_recv_block(struct vconn
*, struct ofpbuf
**);
55 enum vconn_wait_type
{
60 void vconn_wait(struct vconn
*, enum vconn_wait_type
);
61 void vconn_connect_wait(struct vconn
*);
62 void vconn_recv_wait(struct vconn
*);
63 void vconn_send_wait(struct vconn
*);
65 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
66 int pvconn_open(const char *name
, struct pvconn
**);
67 const char *pvconn_get_name(const struct pvconn
*);
68 void pvconn_close(struct pvconn
*);
69 int pvconn_accept(struct pvconn
*, int min_version
, struct vconn
**);
70 void pvconn_wait(struct pvconn
*);
72 /* OpenFlow protocol utility functions. */
73 void *make_openflow(size_t openflow_len
, uint8_t type
, struct ofpbuf
**);
74 void *make_openflow_xid(size_t openflow_len
, uint8_t type
,
75 uint32_t xid
, struct ofpbuf
**);
76 void *put_openflow(size_t openflow_len
, uint8_t type
, struct ofpbuf
*);
77 void *put_openflow_xid(size_t openflow_len
, uint8_t type
, uint32_t xid
,
79 void update_openflow_length(struct ofpbuf
*);
80 struct ofpbuf
*make_flow_mod(uint16_t command
, const flow_t
*,
82 struct ofpbuf
*make_add_flow(const flow_t
*, uint32_t buffer_id
,
83 uint16_t max_idle
, size_t actions_len
);
84 struct ofpbuf
*make_del_flow(const flow_t
*);
85 struct ofpbuf
*make_add_simple_flow(const flow_t
*,
86 uint32_t buffer_id
, uint16_t out_port
,
88 struct ofpbuf
*make_packet_in(uint32_t buffer_id
, uint16_t in_port
,
90 const struct ofpbuf
*payload
, int max_send_len
);
91 struct ofpbuf
*make_packet_out(const struct ofpbuf
*packet
, uint32_t buffer_id
,
93 const struct ofp_action_header
*,
95 struct ofpbuf
*make_buffered_packet_out(uint32_t buffer_id
,
96 uint16_t in_port
, uint16_t out_port
);
97 struct ofpbuf
*make_unbuffered_packet_out(const struct ofpbuf
*packet
,
98 uint16_t in_port
, uint16_t out_port
);
99 struct ofpbuf
*make_echo_request(void);
100 struct ofpbuf
*make_echo_reply(const struct ofp_header
*rq
);
101 int check_ofp_message(const struct ofp_header
*, uint8_t type
, size_t size
);
102 int check_ofp_message_array(const struct ofp_header
*, uint8_t type
,
103 size_t size
, size_t array_elt_size
,
104 size_t *n_array_elts
);
105 int check_ofp_packet_out(const struct ofp_header
*, struct ofpbuf
*data
,
106 int *n_actions
, int max_ports
);
108 struct flow_stats_iterator
{
109 const uint8_t *pos
, *end
;
111 const struct ofp_flow_stats
*flow_stats_first(struct flow_stats_iterator
*,
112 const struct ofp_stats_reply
*);
113 const struct ofp_flow_stats
*flow_stats_next(struct flow_stats_iterator
*);
115 struct actions_iterator
{
116 const union ofp_action
*pos
, *end
;
118 const union ofp_action
*actions_first(struct actions_iterator
*,
119 const union ofp_action
*,
121 const union ofp_action
*actions_next(struct actions_iterator
*);
122 int validate_actions(const union ofp_action
*, size_t n_actions
,
125 void normalize_match(struct ofp_match
*);
128 ofp_mkerr(uint16_t type
, uint16_t code
)
130 assert(type
> 0 && type
<= 0x7fff);
131 return (type
<< 16) | code
;