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 assert(class->close != NULL);
79 ? !class->recv && !class->send
80 : class->recv && class->send);
81 assert(class->wait != NULL);
86 /* Prints information on active (if 'active') and passive (if 'passive')
87 * connection methods supported by the vconn. */
89 vconn_usage(bool active, bool passive)
91 /* Really this should be implemented via callbacks into the vconn
92 * providers, but that seems too heavy-weight to bother with at the
97 printf("Active OpenFlow connection methods:\n");
100 "local datapath DP_IDX\n");
102 printf(" tcp:HOST[:PORT] "
103 "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
105 printf(" ssl:HOST[:PORT] "
106 "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
111 printf("Passive OpenFlow connection methods:\n");
112 printf(" ptcp:[PORT] "
113 "listen to TCP PORT (default: %d)\n",
116 printf(" pssl:[PORT] "
117 "listen for SSL on PORT (default: %d)\n",
123 printf("PKI configuration (required to use SSL):\n"
124 " -p, --private-key=FILE file with private key\n"
125 " -c, --certificate=FILE file with certificate for private key\n"
126 " -C, --ca-cert=FILE file with peer CA certificate\n");
130 /* Attempts to connect to an OpenFlow device. 'name' is a connection name in
131 * the form "TYPE:ARGS", where TYPE is the vconn class's name and ARGS are
132 * vconn class-specific.
134 * Returns 0 if successful, otherwise a positive errno value. If successful,
135 * stores a pointer to the new connection in '*vconnp', otherwise a null
138 vconn_open(const char *name, struct vconn **vconnp)
143 check_vconn_classes();
145 prefix_len = strcspn(name, ":");
146 if (prefix_len == strlen(name)) {
147 error(0, "`%s' not correct format for peer name", name);
150 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
151 struct vconn_class *class = vconn_classes[i];
152 if (strlen(class->name) == prefix_len
153 && !memcmp(class->name, name, prefix_len)) {
154 char *suffix_copy = xstrdup(name + prefix_len + 1);
155 int retval = class->open(name, suffix_copy, vconnp);
160 assert((*vconnp)->connect_status != EAGAIN
161 || (*vconnp)->class->connect);
166 error(0, "unknown peer type `%.*s'", (int) prefix_len, name);
171 vconn_open_block(const char *name, struct vconn **vconnp)
176 error = vconn_open(name, &vconn);
177 while (error == EAGAIN) {
178 vconn_connect_wait(vconn);
180 error = vconn_connect(vconn);
181 assert(error != EINPROGRESS);
192 /* Closes 'vconn'. */
194 vconn_close(struct vconn *vconn)
197 (vconn->class->close)(vconn);
201 /* Returns true if 'vconn' is a passive vconn, that is, its purpose is to
202 * wait for connections to arrive, not to transfer data. Returns false if
203 * 'vconn' is an active vconn, that is, its purpose is to transfer data, not
204 * to wait for new connections to arrive. */
206 vconn_is_passive(const struct vconn *vconn)
208 return vconn->class->accept != NULL;
211 /* Returns the IP address of the peer, or 0 if the peer is not connected over
212 * an IP-based protocol or if its IP address is not yet known. */
214 vconn_get_ip(const struct vconn *vconn)
219 /* Tries to complete the connection on 'vconn', which must be an active
220 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
221 * was successful or a positive errno value if it failed. If the
222 * connection is still in progress, returns EAGAIN. */
224 vconn_connect(struct vconn *vconn)
226 if (vconn->connect_status == EAGAIN) {
227 vconn->connect_status = (vconn->class->connect)(vconn);
228 assert(vconn->connect_status != EINPROGRESS);
230 return vconn->connect_status;
233 /* Tries to accept a new connection on 'vconn', which must be a passive vconn.
234 * If successful, stores the new connection in '*new_vconn' and returns 0.
235 * Otherwise, returns a positive errno value.
237 * vconn_accept will not block waiting for a connection. If no connection is
238 * ready to be accepted, it returns EAGAIN immediately. */
240 vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
244 retval = (vconn->class->accept)(vconn, new_vconn);
249 assert((*new_vconn)->connect_status != EAGAIN
250 || (*new_vconn)->class->connect);
255 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
256 * vconn. If successful, stores the received message into '*msgp' and returns
257 * 0. The caller is responsible for destroying the message with
258 * buffer_delete(). On failure, returns a positive errno value and stores a
259 * null pointer into '*msgp'. On normal connection close, returns EOF.
261 * vconn_recv will not block waiting for a packet to arrive. If no packets
262 * have been received, it returns EAGAIN immediately. */
264 vconn_recv(struct vconn *vconn, struct buffer **msgp)
266 int retval = vconn_connect(vconn);
268 retval = (vconn->class->recv)(vconn, msgp);
269 if (VLOG_IS_DBG_ENABLED() && !retval) {
270 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
271 VLOG_DBG("received: %s", s);
281 /* Tries to queue 'msg' for transmission on 'vconn', which must be an active
282 * vconn. If successful, returns 0, in which case ownership of 'msg' is
283 * transferred to the vconn. Success does not guarantee that 'msg' has been or
284 * ever will be delivered to the peer, only that it has been queued for
287 * Returns a positive errno value on failure, in which case the caller
288 * retains ownership of 'msg'.
290 * vconn_send will not block. If 'msg' cannot be immediately accepted for
291 * transmission, it returns EAGAIN immediately. */
293 vconn_send(struct vconn *vconn, struct buffer *msg)
295 int retval = vconn_connect(vconn);
297 assert(msg->size >= sizeof(struct ofp_header));
298 assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
299 if (!VLOG_IS_DBG_ENABLED()) {
300 retval = (vconn->class->send)(vconn, msg);
302 char *s = ofp_to_string(msg->data, msg->size, 1);
303 retval = (vconn->class->send)(vconn, msg);
304 if (retval != EAGAIN) {
305 VLOG_DBG("sent (%s): %s", strerror(retval), s);
313 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
315 vconn_send_block(struct vconn *vconn, struct buffer *msg)
318 while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
319 vconn_send_wait(vconn);
320 VLOG_DBG("blocking on vconn send");
326 /* Same as vconn_recv, except that it waits until a message is received. */
328 vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
331 while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
332 vconn_recv_wait(vconn);
333 VLOG_DBG("blocking on vconn receive");
339 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
340 * matching transaction ID. Returns 0 if successful, in which case the reply
341 * is stored in '*replyp' for the caller to examine and free. Otherwise
342 * returns a positive errno value, or EOF, and sets '*replyp' to null.
344 * 'request' is always destroyed, regardless of the return value. */
346 vconn_transact(struct vconn *vconn, struct buffer *request,
347 struct buffer **replyp)
349 uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
353 error = vconn_send_block(vconn, request);
355 buffer_delete(request);
360 struct buffer *reply;
362 error = vconn_recv_block(vconn, &reply);
366 recv_xid = ((struct ofp_header *) reply->data)->xid;
367 if (send_xid == recv_xid) {
372 VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
374 buffer_delete(reply);
379 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
383 assert(vconn_is_passive(vconn)
384 ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
385 : wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
387 connect_status = vconn_connect(vconn);
388 if (connect_status) {
389 if (connect_status == EAGAIN) {
392 poll_immediate_wake();
397 (vconn->class->wait)(vconn, wait);
401 vconn_connect_wait(struct vconn *vconn)
403 vconn_wait(vconn, WAIT_CONNECT);
407 vconn_accept_wait(struct vconn *vconn)
409 vconn_wait(vconn, WAIT_ACCEPT);
413 vconn_recv_wait(struct vconn *vconn)
415 vconn_wait(vconn, WAIT_RECV);
419 vconn_send_wait(struct vconn *vconn)
421 vconn_wait(vconn, WAIT_SEND);
424 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
425 * containing an OpenFlow header with the given 'type' and a random transaction
426 * id. Stores the new buffer in '*bufferp'. The caller must free the buffer
427 * when it is no longer needed. */
429 make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
431 return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
434 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
435 * containing an OpenFlow header with the given 'type' and transaction id
436 * 'xid'. Stores the new buffer in '*bufferp'. The caller must free the
437 * buffer when it is no longer needed. */
439 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
440 struct buffer **bufferp)
442 struct buffer *buffer;
443 struct ofp_header *oh;
445 assert(openflow_len >= sizeof *oh);
446 assert(openflow_len <= UINT16_MAX);
447 buffer = *bufferp = buffer_new(openflow_len);
448 oh = buffer_put_uninit(buffer, openflow_len);
449 memset(oh, 0, openflow_len);
450 oh->version = OFP_VERSION;
452 oh->length = htons(openflow_len);
457 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
460 update_openflow_length(struct buffer *buffer)
462 struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
463 oh->length = htons(buffer->size);
467 make_add_simple_flow(const struct flow *flow,
468 uint32_t buffer_id, uint16_t out_port, uint16_t max_idle)
470 struct ofp_flow_mod *ofm;
471 size_t size = sizeof *ofm + sizeof ofm->actions[0];
472 struct buffer *out = buffer_new(size);
473 ofm = buffer_put_uninit(out, size);
474 memset(ofm, 0, size);
475 ofm->header.version = OFP_VERSION;
476 ofm->header.type = OFPT_FLOW_MOD;
477 ofm->header.length = htons(size);
478 ofm->match.wildcards = htons(0);
479 ofm->match.in_port = flow->in_port;
480 memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
481 memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
482 ofm->match.dl_vlan = flow->dl_vlan;
483 ofm->match.dl_type = flow->dl_type;
484 ofm->match.nw_src = flow->nw_src;
485 ofm->match.nw_dst = flow->nw_dst;
486 ofm->match.nw_proto = flow->nw_proto;
487 ofm->match.tp_src = flow->tp_src;
488 ofm->match.tp_dst = flow->tp_dst;
489 ofm->command = htons(OFPFC_ADD);
490 ofm->max_idle = htons(max_idle);
491 ofm->buffer_id = htonl(buffer_id);
492 ofm->actions[0].type = htons(OFPAT_OUTPUT);
493 ofm->actions[0].arg.output.max_len = htons(0);
494 ofm->actions[0].arg.output.port = htons(out_port);
499 make_unbuffered_packet_out(const struct buffer *packet,
500 uint16_t in_port, uint16_t out_port)
502 struct ofp_packet_out *opo;
503 size_t size = sizeof *opo + packet->size;
504 struct buffer *out = buffer_new(size);
505 opo = buffer_put_uninit(out, size);
506 memset(opo, 0, sizeof *opo);
507 opo->header.version = OFP_VERSION;
508 opo->header.type = OFPT_PACKET_OUT;
509 opo->header.length = htons(size);
510 opo->buffer_id = htonl(UINT32_MAX);
511 opo->in_port = htons(in_port);
512 opo->out_port = htons(out_port);
513 memcpy(opo->u.data, packet->data, packet->size);
518 make_buffered_packet_out(uint32_t buffer_id,
519 uint16_t in_port, uint16_t out_port)
521 struct ofp_packet_out *opo;
522 size_t size = sizeof *opo + sizeof opo->u.actions[0];
523 struct buffer *out = buffer_new(size);
524 opo = buffer_put_uninit(out, size);
525 memset(opo, 0, size);
526 opo->header.version = OFP_VERSION;
527 opo->header.type = OFPT_PACKET_OUT;
528 opo->header.length = htons(size);
529 opo->buffer_id = htonl(buffer_id);
530 opo->in_port = htons(in_port);
531 opo->out_port = htons(out_port);
532 opo->u.actions[0].type = htons(OFPAT_OUTPUT);
533 opo->u.actions[0].arg.output.max_len = htons(0);
534 opo->u.actions[0].arg.output.port = htons(out_port);
538 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
540 make_echo_request(void)
542 struct ofp_header *rq;
543 struct buffer *out = buffer_new(sizeof *rq);
544 rq = buffer_put_uninit(out, sizeof *rq);
545 rq->version = OFP_VERSION;
546 rq->type = OFPT_ECHO_REQUEST;
547 rq->length = htons(sizeof *rq);
552 /* Creates and returns an OFPT_ECHO_REPLY message matching the
553 * OFPT_ECHO_REQUEST message in 'rq'. */
555 make_echo_reply(const struct ofp_header *rq)
557 size_t size = ntohs(rq->length);
558 struct buffer *out = buffer_new(size);
559 struct ofp_header *reply = buffer_put(out, rq, size);
560 reply->type = OFPT_ECHO_REPLY;