1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
39 #include <netinet/in.h>
45 #include "ofp-print.h"
47 #include "poll-loop.h"
51 #define THIS_MODULE VLM_vconn
54 static struct vconn_class *vconn_classes[] = {
66 /* Check the validity of the vconn class structures. */
68 check_vconn_classes(void)
73 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
74 struct vconn_class *class = vconn_classes[i];
75 assert(class->name != NULL);
76 assert(class->open != NULL);
77 if (class->close || class->accept || class->recv || class->send
79 assert(class->close != NULL);
81 ? !class->recv && !class->send
82 : class->recv && class->send);
83 assert(class->wait != NULL);
85 /* This class delegates to another one. */
91 /* Prints information on active (if 'active') and passive (if 'passive')
92 * connection methods supported by the vconn. */
94 vconn_usage(bool active, bool passive)
96 /* Really this should be implemented via callbacks into the vconn
97 * providers, but that seems too heavy-weight to bother with at the
102 printf("Active OpenFlow connection methods:\n");
105 "local datapath DP_IDX\n");
107 printf(" tcp:HOST[:PORT] "
108 "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
110 printf(" ssl:HOST[:PORT] "
111 "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
116 printf("Passive OpenFlow connection methods:\n");
117 printf(" ptcp:[PORT] "
118 "listen to TCP PORT (default: %d)\n",
121 printf(" pssl:[PORT] "
122 "listen for SSL on PORT (default: %d)\n",
128 printf("PKI configuration (required to use SSL):\n"
129 " -p, --private-key=FILE file with private key\n"
130 " -c, --certificate=FILE file with certificate for private key\n"
131 " -C, --ca-cert=FILE file with peer CA certificate\n");
135 /* Attempts to connect to an OpenFlow device. 'name' is a connection name in
136 * the form "TYPE:ARGS", where TYPE is the vconn class's name and ARGS are
137 * vconn class-specific.
139 * Returns 0 if successful, otherwise a positive errno value. If successful,
140 * stores a pointer to the new connection in '*vconnp', otherwise a null
143 vconn_open(const char *name, struct vconn **vconnp)
148 check_vconn_classes();
150 prefix_len = strcspn(name, ":");
151 if (prefix_len == strlen(name)) {
152 error(0, "`%s' not correct format for peer name", name);
155 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
156 struct vconn_class *class = vconn_classes[i];
157 if (strlen(class->name) == prefix_len
158 && !memcmp(class->name, name, prefix_len)) {
159 char *suffix_copy = xstrdup(name + prefix_len + 1);
160 int retval = class->open(name, suffix_copy, vconnp);
165 assert((*vconnp)->connect_status != EAGAIN
166 || (*vconnp)->class->connect);
171 error(0, "unknown peer type `%.*s'", (int) prefix_len, name);
176 vconn_open_block(const char *name, struct vconn **vconnp)
181 error = vconn_open(name, &vconn);
182 while (error == EAGAIN) {
183 vconn_connect_wait(vconn);
185 error = vconn_connect(vconn);
186 assert(error != EINPROGRESS);
197 /* Closes 'vconn'. */
199 vconn_close(struct vconn *vconn)
202 (vconn->class->close)(vconn);
206 /* Returns true if 'vconn' is a passive vconn, that is, its purpose is to
207 * wait for connections to arrive, not to transfer data. Returns false if
208 * 'vconn' is an active vconn, that is, its purpose is to transfer data, not
209 * to wait for new connections to arrive. */
211 vconn_is_passive(const struct vconn *vconn)
213 return vconn->class->accept != NULL;
216 /* Returns the IP address of the peer, or 0 if the peer is not connected over
217 * an IP-based protocol or if its IP address is not yet known. */
219 vconn_get_ip(const struct vconn *vconn)
224 /* Tries to complete the connection on 'vconn', which must be an active
225 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
226 * was successful or a positive errno value if it failed. If the
227 * connection is still in progress, returns EAGAIN. */
229 vconn_connect(struct vconn *vconn)
231 if (vconn->connect_status == EAGAIN) {
232 vconn->connect_status = (vconn->class->connect)(vconn);
233 assert(vconn->connect_status != EINPROGRESS);
235 return vconn->connect_status;
238 /* Tries to accept a new connection on 'vconn', which must be a passive vconn.
239 * If successful, stores the new connection in '*new_vconn' and returns 0.
240 * Otherwise, returns a positive errno value.
242 * vconn_accept will not block waiting for a connection. If no connection is
243 * ready to be accepted, it returns EAGAIN immediately. */
245 vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
249 retval = (vconn->class->accept)(vconn, new_vconn);
254 assert((*new_vconn)->connect_status != EAGAIN
255 || (*new_vconn)->class->connect);
260 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
261 * vconn. If successful, stores the received message into '*msgp' and returns
262 * 0. The caller is responsible for destroying the message with
263 * buffer_delete(). On failure, returns a positive errno value and stores a
264 * null pointer into '*msgp'. On normal connection close, returns EOF.
266 * vconn_recv will not block waiting for a packet to arrive. If no packets
267 * have been received, it returns EAGAIN immediately. */
269 vconn_recv(struct vconn *vconn, struct buffer **msgp)
271 int retval = vconn_connect(vconn);
273 retval = (vconn->class->recv)(vconn, msgp);
275 struct ofp_header *oh;
277 if (VLOG_IS_DBG_ENABLED()) {
278 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
279 VLOG_DBG("received: %s", s);
283 oh = buffer_at_assert(*msgp, 0, sizeof *oh);
284 if (oh->version != OFP_VERSION) {
285 VLOG_ERR("received OpenFlow version %02"PRIx8" "
287 oh->version, OFP_VERSION);
288 buffer_delete(*msgp);
300 /* Tries to queue 'msg' for transmission on 'vconn', which must be an active
301 * vconn. If successful, returns 0, in which case ownership of 'msg' is
302 * transferred to the vconn. Success does not guarantee that 'msg' has been or
303 * ever will be delivered to the peer, only that it has been queued for
306 * Returns a positive errno value on failure, in which case the caller
307 * retains ownership of 'msg'.
309 * vconn_send will not block. If 'msg' cannot be immediately accepted for
310 * transmission, it returns EAGAIN immediately. */
312 vconn_send(struct vconn *vconn, struct buffer *msg)
314 int retval = vconn_connect(vconn);
316 assert(msg->size >= sizeof(struct ofp_header));
317 assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
318 if (!VLOG_IS_DBG_ENABLED()) {
319 retval = (vconn->class->send)(vconn, msg);
321 char *s = ofp_to_string(msg->data, msg->size, 1);
322 retval = (vconn->class->send)(vconn, msg);
323 if (retval != EAGAIN) {
324 VLOG_DBG("sent (%s): %s", strerror(retval), s);
332 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
334 vconn_send_block(struct vconn *vconn, struct buffer *msg)
337 while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
338 vconn_send_wait(vconn);
339 VLOG_DBG("blocking on vconn send");
345 /* Same as vconn_recv, except that it waits until a message is received. */
347 vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
350 while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
351 vconn_recv_wait(vconn);
352 VLOG_DBG("blocking on vconn receive");
358 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
359 * matching transaction ID. Returns 0 if successful, in which case the reply
360 * is stored in '*replyp' for the caller to examine and free. Otherwise
361 * returns a positive errno value, or EOF, and sets '*replyp' to null.
363 * 'request' is always destroyed, regardless of the return value. */
365 vconn_transact(struct vconn *vconn, struct buffer *request,
366 struct buffer **replyp)
368 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
372 error = vconn_send_block(vconn, request);
374 buffer_delete(request);
379 struct buffer *reply;
381 error = vconn_recv_block(vconn, &reply);
385 recv_xid = ((struct ofp_header *) reply->data)->xid;
386 if (send_xid == recv_xid) {
391 VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
393 buffer_delete(reply);
398 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
402 assert(vconn_is_passive(vconn)
403 ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
404 : wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
406 connect_status = vconn_connect(vconn);
407 if (connect_status) {
408 if (connect_status == EAGAIN) {
411 poll_immediate_wake();
416 (vconn->class->wait)(vconn, wait);
420 vconn_connect_wait(struct vconn *vconn)
422 vconn_wait(vconn, WAIT_CONNECT);
426 vconn_accept_wait(struct vconn *vconn)
428 vconn_wait(vconn, WAIT_ACCEPT);
432 vconn_recv_wait(struct vconn *vconn)
434 vconn_wait(vconn, WAIT_RECV);
438 vconn_send_wait(struct vconn *vconn)
440 vconn_wait(vconn, WAIT_SEND);
443 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
444 * containing an OpenFlow header with the given 'type' and a random transaction
445 * id. Stores the new buffer in '*bufferp'. The caller must free the buffer
446 * when it is no longer needed. */
448 make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
450 return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
453 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
454 * containing an OpenFlow header with the given 'type' and transaction id
455 * 'xid'. Stores the new buffer in '*bufferp'. The caller must free the
456 * buffer when it is no longer needed. */
458 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
459 struct buffer **bufferp)
461 struct buffer *buffer;
462 struct ofp_header *oh;
464 assert(openflow_len >= sizeof *oh);
465 assert(openflow_len <= UINT16_MAX);
466 buffer = *bufferp = buffer_new(openflow_len);
467 oh = buffer_put_uninit(buffer, openflow_len);
468 memset(oh, 0, openflow_len);
469 oh->version = OFP_VERSION;
471 oh->length = htons(openflow_len);
476 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
479 update_openflow_length(struct buffer *buffer)
481 struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
482 oh->length = htons(buffer->size);
486 make_add_simple_flow(const struct flow *flow,
487 uint32_t buffer_id, uint16_t out_port, uint16_t max_idle)
489 struct ofp_flow_mod *ofm;
490 size_t size = sizeof *ofm + sizeof ofm->actions[0];
491 struct buffer *out = buffer_new(size);
492 ofm = buffer_put_uninit(out, size);
493 memset(ofm, 0, size);
494 ofm->header.version = OFP_VERSION;
495 ofm->header.type = OFPT_FLOW_MOD;
496 ofm->header.length = htons(size);
497 ofm->match.wildcards = htons(0);
498 ofm->match.in_port = flow->in_port;
499 memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
500 memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
501 ofm->match.dl_vlan = flow->dl_vlan;
502 ofm->match.dl_type = flow->dl_type;
503 ofm->match.nw_src = flow->nw_src;
504 ofm->match.nw_dst = flow->nw_dst;
505 ofm->match.nw_proto = flow->nw_proto;
506 ofm->match.tp_src = flow->tp_src;
507 ofm->match.tp_dst = flow->tp_dst;
508 ofm->command = htons(OFPFC_ADD);
509 ofm->max_idle = htons(max_idle);
510 ofm->buffer_id = htonl(buffer_id);
511 ofm->actions[0].type = htons(OFPAT_OUTPUT);
512 ofm->actions[0].arg.output.max_len = htons(0);
513 ofm->actions[0].arg.output.port = htons(out_port);
518 make_unbuffered_packet_out(const struct buffer *packet,
519 uint16_t in_port, uint16_t out_port)
521 struct ofp_packet_out *opo;
522 size_t size = sizeof *opo + packet->size;
523 struct buffer *out = buffer_new(size);
524 opo = buffer_put_uninit(out, size);
525 memset(opo, 0, sizeof *opo);
526 opo->header.version = OFP_VERSION;
527 opo->header.type = OFPT_PACKET_OUT;
528 opo->header.length = htons(size);
529 opo->buffer_id = htonl(UINT32_MAX);
530 opo->in_port = htons(in_port);
531 opo->out_port = htons(out_port);
532 memcpy(opo->u.data, packet->data, packet->size);
537 make_buffered_packet_out(uint32_t buffer_id,
538 uint16_t in_port, uint16_t out_port)
540 struct ofp_packet_out *opo;
541 size_t size = sizeof *opo + sizeof opo->u.actions[0];
542 struct buffer *out = buffer_new(size);
543 opo = buffer_put_uninit(out, size);
544 memset(opo, 0, size);
545 opo->header.version = OFP_VERSION;
546 opo->header.type = OFPT_PACKET_OUT;
547 opo->header.length = htons(size);
548 opo->buffer_id = htonl(buffer_id);
549 opo->in_port = htons(in_port);
550 opo->out_port = htons(out_port);
551 opo->u.actions[0].type = htons(OFPAT_OUTPUT);
552 opo->u.actions[0].arg.output.max_len = htons(0);
553 opo->u.actions[0].arg.output.port = htons(out_port);
557 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
559 make_echo_request(void)
561 struct ofp_header *rq;
562 struct buffer *out = buffer_new(sizeof *rq);
563 rq = buffer_put_uninit(out, sizeof *rq);
564 rq->version = OFP_VERSION;
565 rq->type = OFPT_ECHO_REQUEST;
566 rq->length = htons(sizeof *rq);
571 /* Creates and returns an OFPT_ECHO_REPLY message matching the
572 * OFPT_ECHO_REQUEST message in 'rq'. */
574 make_echo_reply(const struct ofp_header *rq)
576 size_t size = ntohs(rq->length);
577 struct buffer *out = buffer_new(size);
578 struct ofp_header *reply = buffer_put(out, rq, size);
579 reply->type = OFPT_ECHO_REPLY;