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.
35 #include "vconn-provider.h"
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[] = {
65 static struct pvconn_class *pvconn_classes[] = {
73 /* High rate limit because most of the rate-limiting here is individual
74 * OpenFlow messages going over the vconn. If those are enabled then we
75 * really need to see them. */
76 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(600, 600);
78 /* Check the validity of the vconn class structures. */
80 check_vconn_classes(void)
85 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
86 struct vconn_class *class = vconn_classes[i];
87 assert(class->name != NULL);
88 assert(class->open != NULL);
89 if (class->close || class->recv || class->send || class->wait) {
90 assert(class->close != NULL);
91 assert(class->recv != NULL);
92 assert(class->send != NULL);
93 assert(class->wait != NULL);
95 /* This class delegates to another one. */
99 for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
100 struct pvconn_class *class = pvconn_classes[i];
101 assert(class->name != NULL);
102 assert(class->listen != NULL);
103 if (class->close || class->accept || class->wait) {
104 assert(class->close != NULL);
105 assert(class->accept != NULL);
106 assert(class->wait != NULL);
108 /* This class delegates to another one. */
114 /* Prints information on active (if 'active') and passive (if 'passive')
115 * connection methods supported by the vconn. */
117 vconn_usage(bool active, bool passive)
119 /* Really this should be implemented via callbacks into the vconn
120 * providers, but that seems too heavy-weight to bother with at the
125 printf("Active OpenFlow connection methods:\n");
128 "local datapath DP_IDX\n");
130 printf(" tcp:HOST[:PORT] "
131 "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
133 printf(" ssl:HOST[:PORT] "
134 "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
136 printf(" unix:FILE Unix domain socket named FILE\n");
140 printf("Passive OpenFlow connection methods:\n");
141 printf(" ptcp:[PORT] "
142 "listen to TCP PORT (default: %d)\n",
145 printf(" pssl:[PORT] "
146 "listen for SSL on PORT (default: %d)\n",
149 printf(" punix:FILE "
150 "listen on Unix domain socket FILE\n");
154 printf("PKI configuration (required to use SSL):\n"
155 " -p, --private-key=FILE file with private key\n"
156 " -c, --certificate=FILE file with certificate for private key\n"
157 " -C, --ca-cert=FILE file with peer CA certificate\n");
161 /* Attempts to connect to an OpenFlow device. 'name' is a connection name in
162 * the form "TYPE:ARGS", where TYPE is an active vconn class's name and ARGS
163 * are vconn class-specific.
165 * Returns 0 if successful, otherwise a positive errno value. If successful,
166 * stores a pointer to the new connection in '*vconnp', otherwise a null
169 vconn_open(const char *name, struct vconn **vconnp)
174 check_vconn_classes();
177 prefix_len = strcspn(name, ":");
178 if (prefix_len == strlen(name)) {
181 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
182 struct vconn_class *class = vconn_classes[i];
183 if (strlen(class->name) == prefix_len
184 && !memcmp(class->name, name, prefix_len)) {
186 char *suffix_copy = xstrdup(name + prefix_len + 1);
187 int retval = class->open(name, suffix_copy, &vconn);
190 assert(vconn->connect_status != EAGAIN
191 || vconn->class->connect);
201 vconn_open_block(const char *name, struct vconn **vconnp)
206 error = vconn_open(name, &vconn);
207 while (error == EAGAIN) {
208 vconn_connect_wait(vconn);
210 error = vconn_connect(vconn);
211 assert(error != EINPROGRESS);
222 /* Closes 'vconn'. */
224 vconn_close(struct vconn *vconn)
227 char *name = vconn->name;
228 (vconn->class->close)(vconn);
233 /* Returns the name of 'vconn', that is, the string passed to vconn_open(). */
235 vconn_get_name(const struct vconn *vconn)
240 /* Returns the IP address of the peer, or 0 if the peer is not connected over
241 * an IP-based protocol or if its IP address is not yet known. */
243 vconn_get_ip(const struct vconn *vconn)
248 /* Tries to complete the connection on 'vconn', which must be an active
249 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
250 * was successful or a positive errno value if it failed. If the
251 * connection is still in progress, returns EAGAIN. */
253 vconn_connect(struct vconn *vconn)
255 if (vconn->connect_status == EAGAIN) {
256 vconn->connect_status = (vconn->class->connect)(vconn);
257 assert(vconn->connect_status != EINPROGRESS);
259 return vconn->connect_status;
262 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
263 * vconn. If successful, stores the received message into '*msgp' and returns
264 * 0. The caller is responsible for destroying the message with
265 * buffer_delete(). On failure, returns a positive errno value and stores a
266 * null pointer into '*msgp'. On normal connection close, returns EOF.
268 * vconn_recv will not block waiting for a packet to arrive. If no packets
269 * have been received, it returns EAGAIN immediately. */
271 vconn_recv(struct vconn *vconn, struct buffer **msgp)
273 int retval = vconn_connect(vconn);
275 retval = (vconn->class->recv)(vconn, msgp);
277 struct ofp_header *oh;
279 if (VLOG_IS_DBG_ENABLED()) {
280 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
281 VLOG_DBG_RL(&rl, "%s: received: %s", vconn->name, s);
285 oh = buffer_at_assert(*msgp, 0, sizeof *oh);
286 if (oh->version != OFP_VERSION) {
287 VLOG_ERR_RL(&rl, "%s: received OpenFlow version %02"PRIx8" "
289 vconn->name, oh->version, OFP_VERSION);
290 buffer_delete(*msgp);
302 /* Tries to queue 'msg' for transmission on 'vconn', which must be an active
303 * vconn. If successful, returns 0, in which case ownership of 'msg' is
304 * transferred to the vconn. Success does not guarantee that 'msg' has been or
305 * ever will be delivered to the peer, only that it has been queued for
308 * Returns a positive errno value on failure, in which case the caller
309 * retains ownership of 'msg'.
311 * vconn_send will not block. If 'msg' cannot be immediately accepted for
312 * transmission, it returns EAGAIN immediately. */
314 vconn_send(struct vconn *vconn, struct buffer *msg)
316 int retval = vconn_connect(vconn);
318 assert(msg->size >= sizeof(struct ofp_header));
319 assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
320 if (!VLOG_IS_DBG_ENABLED()) {
321 retval = (vconn->class->send)(vconn, msg);
323 char *s = ofp_to_string(msg->data, msg->size, 1);
324 retval = (vconn->class->send)(vconn, msg);
325 if (retval != EAGAIN) {
326 VLOG_DBG_RL(&rl, "%s: sent (%s): %s", vconn->name, strerror(retval), s);
334 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
336 vconn_send_block(struct vconn *vconn, struct buffer *msg)
339 while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
340 vconn_send_wait(vconn);
346 /* Same as vconn_recv, except that it waits until a message is received. */
348 vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
351 while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
352 vconn_recv_wait(vconn);
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_RL(&rl, "%s: received reply with xid %08"PRIx32" != expected "
392 "%08"PRIx32, vconn->name, recv_xid, send_xid);
393 buffer_delete(reply);
398 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
402 assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
404 connect_status = vconn_connect(vconn);
405 if (connect_status) {
406 if (connect_status == EAGAIN) {
409 poll_immediate_wake();
414 (vconn->class->wait)(vconn, wait);
418 vconn_connect_wait(struct vconn *vconn)
420 vconn_wait(vconn, WAIT_CONNECT);
424 vconn_recv_wait(struct vconn *vconn)
426 vconn_wait(vconn, WAIT_RECV);
430 vconn_send_wait(struct vconn *vconn)
432 vconn_wait(vconn, WAIT_SEND);
435 /* Attempts to start listening for OpenFlow connections. 'name' is a
436 * connection name in the form "TYPE:ARGS", where TYPE is an passive vconn
437 * class's name and ARGS are vconn class-specific.
439 * Returns 0 if successful, otherwise a positive errno value. If successful,
440 * stores a pointer to the new connection in '*pvconnp', otherwise a null
443 pvconn_open(const char *name, struct pvconn **pvconnp)
448 check_vconn_classes();
451 prefix_len = strcspn(name, ":");
452 if (prefix_len == strlen(name)) {
455 for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
456 struct pvconn_class *class = pvconn_classes[i];
457 if (strlen(class->name) == prefix_len
458 && !memcmp(class->name, name, prefix_len)) {
459 char *suffix_copy = xstrdup(name + prefix_len + 1);
460 int retval = class->listen(name, suffix_copy, pvconnp);
471 /* Closes 'pvconn'. */
473 pvconn_close(struct pvconn *pvconn)
475 if (pvconn != NULL) {
476 char *name = pvconn->name;
477 (pvconn->class->close)(pvconn);
482 /* Tries to accept a new connection on 'pvconn'. If successful, stores the new
483 * connection in '*new_vconn' and returns 0. Otherwise, returns a positive
486 * pvconn_accept() will not block waiting for a connection. If no connection
487 * is ready to be accepted, it returns EAGAIN immediately. */
489 pvconn_accept(struct pvconn *pvconn, struct vconn **new_vconn)
491 int retval = (pvconn->class->accept)(pvconn, new_vconn);
495 assert((*new_vconn)->connect_status == 0
496 || (*new_vconn)->class->connect);
502 pvconn_wait(struct pvconn *pvconn)
504 (pvconn->class->wait)(pvconn);
507 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
508 * containing an OpenFlow header with the given 'type' and a random transaction
509 * id. Stores the new buffer in '*bufferp'. The caller must free the buffer
510 * when it is no longer needed. */
512 make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
514 return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
517 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
518 * containing an OpenFlow header with the given 'type' and transaction id
519 * 'xid'. Stores the new buffer in '*bufferp'. The caller must free the
520 * buffer when it is no longer needed. */
522 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
523 struct buffer **bufferp)
525 struct buffer *buffer;
526 struct ofp_header *oh;
528 assert(openflow_len >= sizeof *oh);
529 assert(openflow_len <= UINT16_MAX);
530 buffer = *bufferp = buffer_new(openflow_len);
531 oh = buffer_put_uninit(buffer, openflow_len);
532 memset(oh, 0, openflow_len);
533 oh->version = OFP_VERSION;
535 oh->length = htons(openflow_len);
540 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
543 update_openflow_length(struct buffer *buffer)
545 struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
546 oh->length = htons(buffer->size);
550 make_add_flow(const struct flow *flow, uint32_t buffer_id,
551 uint16_t idle_timeout, size_t n_actions)
553 struct ofp_flow_mod *ofm;
554 size_t size = sizeof *ofm + n_actions * sizeof ofm->actions[0];
555 struct buffer *out = buffer_new(size);
556 ofm = buffer_put_uninit(out, size);
557 memset(ofm, 0, size);
558 ofm->header.version = OFP_VERSION;
559 ofm->header.type = OFPT_FLOW_MOD;
560 ofm->header.length = htons(size);
561 ofm->match.wildcards = htonl(0);
562 ofm->match.in_port = flow->in_port;
563 memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
564 memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
565 ofm->match.dl_vlan = flow->dl_vlan;
566 ofm->match.dl_type = flow->dl_type;
567 ofm->match.nw_src = flow->nw_src;
568 ofm->match.nw_dst = flow->nw_dst;
569 ofm->match.nw_proto = flow->nw_proto;
570 ofm->match.tp_src = flow->tp_src;
571 ofm->match.tp_dst = flow->tp_dst;
572 ofm->command = htons(OFPFC_ADD);
573 ofm->idle_timeout = htons(idle_timeout);
574 ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
575 ofm->buffer_id = htonl(buffer_id);
580 make_add_simple_flow(const struct flow *flow,
581 uint32_t buffer_id, uint16_t out_port,
582 uint16_t idle_timeout)
584 struct buffer *buffer = make_add_flow(flow, buffer_id, idle_timeout, 1);
585 struct ofp_flow_mod *ofm = buffer->data;
586 ofm->actions[0].type = htons(OFPAT_OUTPUT);
587 ofm->actions[0].arg.output.max_len = htons(0);
588 ofm->actions[0].arg.output.port = htons(out_port);
593 make_unbuffered_packet_out(const struct buffer *packet,
594 uint16_t in_port, uint16_t out_port)
596 struct ofp_packet_out *opo;
597 size_t size = sizeof *opo + sizeof opo->actions[0];
598 struct buffer *out = buffer_new(size + packet->size);
599 opo = buffer_put_uninit(out, size);
600 memset(opo, 0, size);
601 opo->header.version = OFP_VERSION;
602 opo->header.type = OFPT_PACKET_OUT;
603 opo->buffer_id = htonl(UINT32_MAX);
604 opo->in_port = htons(in_port);
605 opo->n_actions = htons(1);
606 opo->actions[0].type = htons(OFPAT_OUTPUT);
607 opo->actions[0].arg.output.max_len = htons(0);
608 opo->actions[0].arg.output.port = htons(out_port);
609 buffer_put(out, packet->data, packet->size);
610 update_openflow_length(out);
615 make_buffered_packet_out(uint32_t buffer_id,
616 uint16_t in_port, uint16_t out_port)
618 struct ofp_packet_out *opo;
619 size_t size = sizeof *opo + sizeof opo->actions[0];
620 struct buffer *out = buffer_new(size);
621 opo = buffer_put_uninit(out, size);
622 memset(opo, 0, size);
623 opo->header.version = OFP_VERSION;
624 opo->header.type = OFPT_PACKET_OUT;
625 opo->header.length = htons(size);
626 opo->buffer_id = htonl(buffer_id);
627 opo->in_port = htons(in_port);
628 opo->n_actions = htons(1);
629 opo->actions[0].type = htons(OFPAT_OUTPUT);
630 opo->actions[0].arg.output.max_len = htons(0);
631 opo->actions[0].arg.output.port = htons(out_port);
635 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
637 make_echo_request(void)
639 struct ofp_header *rq;
640 struct buffer *out = buffer_new(sizeof *rq);
641 rq = buffer_put_uninit(out, sizeof *rq);
642 rq->version = OFP_VERSION;
643 rq->type = OFPT_ECHO_REQUEST;
644 rq->length = htons(sizeof *rq);
649 /* Creates and returns an OFPT_ECHO_REPLY message matching the
650 * OFPT_ECHO_REQUEST message in 'rq'. */
652 make_echo_reply(const struct ofp_header *rq)
654 size_t size = ntohs(rq->length);
655 struct buffer *out = buffer_new(size);
656 struct ofp_header *reply = buffer_put(out, rq, size);
657 reply->type = OFPT_ECHO_REPLY;
662 vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
663 uint32_t ip, const char *name)
665 vconn->class = class;
666 vconn->connect_status = connect_status;
668 vconn->name = xstrdup(name);
672 pvconn_init(struct pvconn *pvconn, struct pvconn_class *class,
675 pvconn->class = class;
676 pvconn->name = xstrdup(name);