pintos-os.org Git - openvswitch/blob - switch/datapath.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   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:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  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
  27  * SOFTWARE.
  28  *
  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.
  32  */
  33
  34 #include "datapath.h"
  35 #include <arpa/inet.h>
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include "buffer.h"
  41 #include "chain.h"
  42 #include "controller.h"
  43 #include "flow.h"
  44 #include "netdev.h"
  45 #include "packets.h"
  46 #include "poll-loop.h"
  47 #include "table.h"
  48 #include "xtoxll.h"
  49
  50 #define THIS_MODULE VLM_datapath
  51 #include "vlog.h"
  52
  53 #define BRIDGE_PORT_NO_FLOOD    0x00000001
  54
  55 /* Capabilities supported by this implementation. */
  56 #define OFP_SUPPORTED_CAPABILITIES (OFPC_MULTI_PHY_TX)
  57
  58 /* Actions supported by this implementation. */
  59 #define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT)         \
  60                                 | (1 << OFPAT_SET_DL_VLAN)  \
  61                                 | (1 << OFPAT_SET_DL_SRC)   \
  62                                 | (1 << OFPAT_SET_DL_DST)   \
  63                                 | (1 << OFPAT_SET_NW_SRC)   \
  64                                 | (1 << OFPAT_SET_NW_DST)   \
  65                                 | (1 << OFPAT_SET_TP_SRC)   \
  66                                 | (1 << OFPAT_SET_TP_DST) )
  67
  68 struct sw_port {
  69     uint32_t flags;
  70     struct datapath *dp;
  71     struct netdev *netdev;
  72     struct list node; /* Element in datapath.ports. */
  73 };
  74
  75 struct datapath {
  76     struct controller_connection *cc;
  77
  78     time_t last_timeout;
  79
  80     /* Unique identifier for this datapath */
  81     uint64_t  id;
  82
  83     struct sw_chain *chain;  /* Forwarding rules. */
  84
  85     /* Flags from the control hello message */
  86     uint16_t hello_flags;
  87
  88     /* Maximum number of bytes that should be sent for flow misses */
  89     uint16_t miss_send_len;
  90
  91     /* Switch ports. */
  92     struct sw_port ports[OFPP_MAX];
  93     struct list port_list; /* List of ports, for flooding. */
  94 };
  95
  96 void dp_output_port(struct datapath *, struct buffer *,
  97                     int in_port, int out_port);
  98 void dp_send_hello(struct datapath *);
  99 void dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp);
 100 void dp_output_control(struct datapath *, struct buffer *, int in_port,
 101                        size_t max_len, int reason);
 102 static void send_flow_expired(struct datapath *, struct sw_flow *);
 103 static void send_port_status(struct sw_port *p, uint8_t status);
 104 static void del_switch_port(struct sw_port *p);
 105 static void execute_actions(struct datapath *, struct buffer *,
 106                             int in_port, const struct sw_flow_key *,
 107                             const struct ofp_action *, int n_actions);
 108 static void modify_vlan(struct buffer *buffer, const struct sw_flow_key *key,
 109                         const struct ofp_action *a);
 110 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 111                       uint8_t nw_proto, const struct ofp_action *a);
 112 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 113                           uint8_t nw_proto, const struct ofp_action *a);
 114
 115 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
 116  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
 117  * is an index into an array of buffers.  The cookie distinguishes between
 118  * different packets that have occupied a single buffer.  Thus, the more
 119  * buffers we have, the lower-quality the cookie... */
 120 #define PKT_BUFFER_BITS 8
 121 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
 122 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
 123
 124 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
 125
 126 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
 127 int fwd_control_input(struct datapath *, const void *, size_t);
 128
 129 uint32_t save_buffer(struct buffer *);
 130 static struct buffer *retrieve_buffer(uint32_t id);
 131 static void discard_buffer(uint32_t id);
 132
 133 static int port_no(struct datapath *dp, struct sw_port *p)
 134 {
 135     assert(p >= dp->ports && p < &dp->ports[ARRAY_SIZE(dp->ports)]);
 136     return p - dp->ports;
 137 }
 138
 139 /* Generates a unique datapath id.  It incorporates the datapath index
 140  * and a hardware address, if available.  If not, it generates a random
 141  * one.
 142  */
 143 static uint64_t
 144 gen_datapath_id(void)
 145 {
 146     /* Choose a random datapath id. */
 147     uint64_t id = 0;
 148     int i;
 149
 150     srand(time(0));
 151
 152     for (i = 0; i < ETH_ADDR_LEN; i++) {
 153         id |= (uint64_t)(rand() & 0xff) << (8*(ETH_ADDR_LEN-1 - i));
 154     }
 155
 156     return id;
 157 }
 158
 159 int
 160 dp_new(struct datapath **dp_, uint64_t dpid, struct controller_connection *cc)
 161 {
 162     struct datapath *dp;
 163
 164     dp = calloc(1, sizeof *dp);
 165     if (!dp) {
 166         return ENOMEM;
 167     }
 168
 169     dp->last_timeout = time(0);
 170     dp->cc = cc;
 171     dp->id = dpid <= UINT64_C(0xffffffffffff) ? dpid : gen_datapath_id();
 172     dp->chain = chain_create();
 173     if (!dp->chain) {
 174         VLOG_ERR("could not create chain");
 175         free(dp);
 176         return ENOMEM;
 177     }
 178
 179     list_init(&dp->port_list);
 180     dp->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 181     *dp_ = dp;
 182     return 0;
 183 }
 184
 185 int
 186 dp_add_port(struct datapath *dp, const char *name)
 187 {
 188     struct netdev *netdev;
 189     struct sw_port *p;
 190     int error;
 191
 192     error = netdev_open(name, &netdev);
 193     if (error) {
 194         return error;
 195     }
 196
 197     for (p = dp->ports; ; p++) {
 198         if (p >= &dp->ports[ARRAY_SIZE(dp->ports)]) {
 199             return EXFULL;
 200         } else if (!p->netdev) {
 201             break;
 202         }
 203     }
 204
 205     p->dp = dp;
 206     p->netdev = netdev;
 207     list_push_back(&dp->port_list, &p->node);
 208
 209     /* Notify the ctlpath that this port has been added */
 210     send_port_status(p, OFPPR_ADD);
 211
 212     return 0;
 213 }
 214
 215 void
 216 dp_run(struct datapath *dp)
 217 {
 218     time_t now = time(0);
 219     struct sw_port *p, *n;
 220     struct buffer *buffer = NULL;
 221     int i;
 222
 223     if (now != dp->last_timeout) {
 224         struct list deleted = LIST_INITIALIZER(&deleted);
 225         struct sw_flow *f, *n;
 226
 227         chain_timeout(dp->chain, &deleted);
 228         LIST_FOR_EACH_SAFE (f, n, struct sw_flow, node, &deleted) {
 229             send_flow_expired(dp, f);
 230             list_remove(&f->node);
 231             flow_free(f);
 232         }
 233         dp->last_timeout = now;
 234     }
 235     poll_timer_wait(1000);
 236
 237     LIST_FOR_EACH_SAFE (p, n, struct sw_port, node, &dp->port_list) {
 238         int error;
 239
 240         if (!buffer) {
 241             /* Allocate buffer with some headroom to add headers in forwarding
 242              * to the controller or adding a vlan tag, plus an extra 2 bytes to
 243              * allow IP headers to be aligned on a 4-byte boundary.  */
 244             const int headroom = 128 + 2;
 245             const int hard_header = VLAN_ETH_HEADER_LEN;
 246             const int mtu = netdev_get_mtu(p->netdev);
 247             buffer = buffer_new(headroom + hard_header + mtu);
 248             buffer->data += headroom;
 249         }
 250         error = netdev_recv(p->netdev, buffer);
 251         if (!error) {
 252             fwd_port_input(dp, buffer, port_no(dp, p));
 253             buffer = NULL;
 254         } else if (error != EAGAIN) {
 255             VLOG_ERR("Error receiving data from %s: %s",
 256                      netdev_get_name(p->netdev), strerror(error));
 257             del_switch_port(p);
 258         }
 259     }
 260     buffer_delete(buffer);
 261
 262     /* Process a number of commands from the controller, but cap it at a
 263      * reasonable number so that other processing doesn't starve. */
 264     for (i = 0; i < 50; i++) {
 265         struct buffer *buffer = controller_recv(dp->cc);
 266         if (!buffer) {
 267             break;
 268         }
 269         fwd_control_input(dp, buffer->data, buffer->size);
 270         buffer_delete(buffer);
 271     }
 272
 273     controller_run(dp->cc);
 274 }
 275
 276 void
 277 dp_wait(struct datapath *dp)
 278 {
 279     struct sw_port *p;
 280
 281     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 282         netdev_recv_wait(p->netdev);
 283     }
 284     controller_recv_wait(dp->cc);
 285 }
 286
 287 /* Delete 'p' from switch. */
 288 static void
 289 del_switch_port(struct sw_port *p)
 290 {
 291     send_port_status(p, OFPPR_DELETE);
 292     netdev_close(p->netdev);
 293     p->netdev = NULL;
 294     list_remove(&p->node);
 295 }
 296
 297 void
 298 dp_destroy(struct datapath *dp)
 299 {
 300     struct sw_port *p, *n;
 301
 302     if (!dp) {
 303         return;
 304     }
 305
 306     LIST_FOR_EACH_SAFE (p, n, struct sw_port, node, &dp->port_list) {
 307         del_switch_port(p);
 308     }
 309     chain_destroy(dp->chain);
 310     free(dp);
 311 }
 312
 313 static int
 314 flood(struct datapath *dp, struct buffer *buffer, int in_port)
 315 {
 316     struct sw_port *p;
 317     int prev_port;
 318
 319     prev_port = -1;
 320     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 321         if (port_no(dp, p) == in_port || p->flags & BRIDGE_PORT_NO_FLOOD) {
 322             continue;
 323         }
 324         if (prev_port != -1) {
 325             dp_output_port(dp, buffer_clone(buffer), in_port, prev_port);
 326         }
 327         prev_port = port_no(dp, p);
 328     }
 329     if (prev_port != -1)
 330         dp_output_port(dp, buffer, in_port, prev_port);
 331     else
 332         buffer_delete(buffer);
 333
 334     return 0;
 335 }
 336
 337 void
 338 output_packet(struct datapath *dp, struct buffer *buffer, int out_port)
 339 {
 340     if (out_port >= 0 && out_port < OFPP_MAX) {
 341         struct sw_port *p = &dp->ports[out_port];
 342         if (p->netdev != NULL) {
 343             netdev_send(p->netdev, buffer);
 344             return;
 345         }
 346     }
 347
 348     buffer_delete(buffer);
 349     /* FIXME: ratelimit */
 350     VLOG_DBG("can't forward to bad port %d\n", out_port);
 351 }
 352
 353 /* Takes ownership of 'buffer' and transmits it to 'out_port' on 'dp'.
 354  */
 355 void
 356 dp_output_port(struct datapath *dp, struct buffer *buffer,
 357                int in_port, int out_port)
 358 {
 359
 360     assert(buffer);
 361     if (out_port == OFPP_FLOOD) {
 362         flood(dp, buffer, in_port);
 363     } else if (out_port == OFPP_CONTROLLER) {
 364         dp_output_control(dp, buffer, in_port, 0, OFPR_ACTION);
 365     } else {
 366         output_packet(dp, buffer, out_port);
 367     }
 368 }
 369
 370 /* Takes ownership of 'buffer' and transmits it to 'dp''s controller.  If
 371  * 'buffer_id' != -1, then only the first 64 bytes of 'buffer' are sent;
 372  * otherwise, all of 'buffer' is sent.  'reason' indicates why 'buffer' is
 373  * being sent. 'max_len' sets the maximum number of bytes that the caller wants
 374  * to be sent; a value of 0 indicates the entire packet should be sent. */
 375 void
 376 dp_output_control(struct datapath *dp, struct buffer *buffer, int in_port,
 377                   size_t max_len, int reason)
 378 {
 379     struct ofp_packet_in *opi;
 380     size_t total_len;
 381     uint32_t buffer_id;
 382
 383     buffer_id = save_buffer(buffer);
 384     total_len = buffer->size;
 385     if (buffer_id != UINT32_MAX && max_len > buffer->size) {
 386         buffer->size = max_len;
 387     }
 388
 389     opi = buffer_push_uninit(buffer, offsetof(struct ofp_packet_in, data));
 390     opi->header.version = OFP_VERSION;
 391     opi->header.type    = OFPT_PACKET_IN;
 392     opi->header.length  = htons(buffer->size);
 393     opi->header.xid     = htonl(0);
 394     opi->buffer_id      = htonl(buffer_id);
 395     opi->total_len      = htons(total_len);
 396     opi->in_port        = htons(in_port);
 397     opi->reason         = reason;
 398     opi->pad            = 0;
 399     controller_send(dp->cc, buffer);
 400 }
 401
 402 static void fill_port_desc(struct datapath *dp, struct sw_port *p,
 403                            struct ofp_phy_port *desc)
 404 {
 405     desc->port_no = htons(port_no(dp, p));
 406     strncpy((char *) desc->name, netdev_get_name(p->netdev),
 407             sizeof desc->name);
 408     desc->name[sizeof desc->name - 1] = '\0';
 409     memcpy(desc->hw_addr, netdev_get_etheraddr(p->netdev), ETH_ADDR_LEN);
 410     desc->flags = htonl(p->flags);
 411     desc->features = htonl(netdev_get_features(p->netdev));
 412     desc->speed = htonl(netdev_get_speed(p->netdev));
 413 }
 414
 415 void
 416 dp_send_hello(struct datapath *dp)
 417 {
 418     struct buffer *buffer;
 419     struct ofp_data_hello *odh;
 420     struct sw_port *p;
 421
 422     buffer = buffer_new(sizeof *odh);
 423     odh = buffer_put_uninit(buffer, sizeof *odh);
 424     memset(odh, 0, sizeof *odh);
 425     odh->header.version = OFP_VERSION;
 426     odh->header.type    = OFPT_DATA_HELLO;
 427     odh->header.xid     = htonl(0);
 428     odh->datapath_id    = htonll(dp->id);
 429     odh->n_exact        = htonl(2 * TABLE_HASH_MAX_FLOWS);
 430     odh->n_mac_only     = htonl(TABLE_MAC_MAX_FLOWS);
 431     odh->n_compression  = 0;                                           /* Not supported */
 432     odh->n_general      = htonl(TABLE_LINEAR_MAX_FLOWS);
 433     odh->buffer_mb      = htonl(UINT32_MAX);
 434     odh->n_buffers      = htonl(N_PKT_BUFFERS);
 435     odh->capabilities   = htonl(OFP_SUPPORTED_CAPABILITIES);
 436     odh->actions        = htonl(OFP_SUPPORTED_ACTIONS);
 437     odh->miss_send_len  = htons(dp->miss_send_len);
 438     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 439         struct ofp_phy_port *opp = buffer_put_uninit(buffer, sizeof *opp);
 440         memset(opp, 0, sizeof *opp);
 441         fill_port_desc(dp, p, opp);
 442     }
 443     odh = buffer_at_assert(buffer, 0, sizeof *odh);
 444     odh->header.length = htons(buffer->size);
 445     controller_send(dp->cc, buffer);
 446 }
 447
 448 void
 449 dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp)
 450 {
 451     struct sw_port *p;
 452
 453     p = &dp->ports[htons(opp->port_no)];
 454
 455     /* Make sure the port id hasn't changed since this was sent */
 456     if (!p || memcmp(opp->hw_addr, netdev_get_etheraddr(p->netdev),
 457                      ETH_ADDR_LEN) != 0)
 458         return;
 459
 460     p->flags = htonl(opp->flags);
 461 }
 462
 463 static void
 464 send_port_status(struct sw_port *p, uint8_t status)
 465 {
 466     struct buffer *buffer;
 467     struct ofp_port_status *ops;
 468     buffer = buffer_new(sizeof *ops);
 469     ops = buffer_put_uninit(buffer, sizeof *ops);
 470     ops->header.version = OFP_VERSION;
 471     ops->header.type    = OFPT_PORT_STATUS;
 472     ops->header.length  = htons(sizeof(*ops));
 473     ops->header.xid     = htonl(0);
 474     ops->reason         = status;
 475     fill_port_desc(p->dp, p, &ops->desc);
 476     controller_send(p->dp->cc, buffer);
 477 }
 478
 479 void
 480 send_flow_expired(struct datapath *dp, struct sw_flow *flow)
 481 {
 482     struct buffer *buffer;
 483     struct ofp_flow_expired *ofe;
 484     buffer = buffer_new(sizeof *ofe);
 485     ofe = buffer_put_uninit(buffer, sizeof *ofe);
 486     ofe->header.version = OFP_VERSION;
 487     ofe->header.type    = OFPT_FLOW_EXPIRED;
 488     ofe->header.length  = htons(sizeof(*ofe));
 489     ofe->header.xid     = htonl(0);
 490     flow_fill_match(&ofe->match, &flow->key);
 491     ofe->duration   = htonl(flow->timeout - flow->max_idle - flow->created);
 492     ofe->packet_count   = htonll(flow->packet_count);
 493     ofe->byte_count     = htonll(flow->byte_count);
 494     controller_send(dp->cc, buffer);
 495 }
 496 \f
 497 /* 'buffer' was received on 'in_port', a physical switch port between 0 and
 498  * OFPP_MAX.  Process it according to 'chain'. */
 499 void fwd_port_input(struct datapath *dp, struct buffer *buffer, int in_port)
 500 {
 501     struct sw_flow_key key;
 502     struct sw_flow *flow;
 503
 504     key.wildcards = 0;
 505     flow_extract(buffer, in_port, &key.flow);
 506     flow = chain_lookup(dp->chain, &key);
 507     if (flow != NULL) {
 508         flow_used(flow, buffer);
 509         execute_actions(dp, buffer, in_port, &key,
 510                         flow->actions, flow->n_actions);
 511     } else {
 512         dp_output_control(dp, buffer, in_port, dp->miss_send_len,
 513                           OFPR_NO_MATCH);
 514     }
 515 }
 516
 517 static void
 518 do_output(struct datapath *dp, struct buffer *buffer, int in_port,
 519           size_t max_len, int out_port)
 520 {
 521     if (out_port != OFPP_CONTROLLER) {
 522         dp_output_port(dp, buffer, in_port, out_port);
 523     } else {
 524         dp_output_control(dp, buffer, in_port, max_len, OFPR_ACTION);
 525     }
 526 }
 527
 528 static void
 529 execute_actions(struct datapath *dp, struct buffer *buffer,
 530                 int in_port, const struct sw_flow_key *key,
 531                 const struct ofp_action *actions, int n_actions)
 532 {
 533     /* Every output action needs a separate clone of 'buffer', but the common
 534      * case is just a single output action, so that doing a clone and then
 535      * freeing the original buffer is wasteful.  So the following code is
 536      * slightly obscure just to avoid that. */
 537     int prev_port;
 538     size_t max_len=0;        /* Initialze to make compiler happy */
 539     uint16_t eth_proto;
 540     int i;
 541
 542     prev_port = -1;
 543     eth_proto = ntohs(key->flow.dl_type);
 544
 545     for (i = 0; i < n_actions; i++) {
 546         const struct ofp_action *a = &actions[i];
 547         struct eth_header *eh = buffer->l2;
 548
 549         if (prev_port != -1) {
 550             do_output(dp, buffer_clone(buffer), in_port, max_len, prev_port);
 551             prev_port = -1;
 552         }
 553
 554         switch (ntohs(a->type)) {
 555         case OFPAT_OUTPUT:
 556             prev_port = ntohs(a->arg.output.port);
 557             max_len = ntohs(a->arg.output.max_len);
 558             break;
 559
 560         case OFPAT_SET_DL_VLAN:
 561             modify_vlan(buffer, key, a);
 562             break;
 563
 564         case OFPAT_SET_DL_SRC:
 565             memcpy(eh->eth_src, a->arg.dl_addr, sizeof eh->eth_src);
 566             break;
 567
 568         case OFPAT_SET_DL_DST:
 569             memcpy(eh->eth_dst, a->arg.dl_addr, sizeof eh->eth_dst);
 570             break;
 571
 572         case OFPAT_SET_NW_SRC:
 573         case OFPAT_SET_NW_DST:
 574             modify_nh(buffer, eth_proto, key->flow.nw_proto, a);
 575             break;
 576
 577         case OFPAT_SET_TP_SRC:
 578         case OFPAT_SET_TP_DST:
 579             modify_th(buffer, eth_proto, key->flow.nw_proto, a);
 580             break;
 581
 582         default:
 583             NOT_REACHED();
 584         }
 585     }
 586     if (prev_port != -1)
 587         do_output(dp, buffer, in_port, max_len, prev_port);
 588     else
 589         buffer_delete(buffer);
 590 }
 591
 592 /* Returns the new checksum for a packet in which the checksum field previously
 593  * contained 'old_csum' and in which a field that contained 'old_u16' was
 594  * changed to contain 'new_u16'. */
 595 static uint16_t
 596 recalc_csum16(uint16_t old_csum, uint16_t old_u16, uint16_t new_u16)
 597 {
 598     /* Ones-complement arithmetic is endian-independent, so this code does not
 599      * use htons() or ntohs().
 600      *
 601      * See RFC 1624 for formula and explanation. */
 602     uint16_t hc_complement = ~old_csum;
 603     uint16_t m_complement = ~old_u16;
 604     uint16_t m_prime = new_u16;
 605     uint32_t sum = hc_complement + m_complement + m_prime;
 606     uint16_t hc_prime_complement = sum + (sum >> 16);
 607     return ~hc_prime_complement;
 608 }
 609
 610 /* Returns the new checksum for a packet in which the checksum field previously
 611  * contained 'old_csum' and in which a field that contained 'old_u32' was
 612  * changed to contain 'new_u32'. */
 613 static uint16_t
 614 recalc_csum32(uint16_t old_csum, uint32_t old_u32, uint32_t new_u32)
 615 {
 616     return recalc_csum16(recalc_csum16(old_csum, old_u32, new_u32),
 617                          old_u32 >> 16, new_u32 >> 16);
 618 }
 619
 620 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 621                       uint8_t nw_proto, const struct ofp_action *a)
 622 {
 623     if (eth_proto == ETH_TYPE_IP) {
 624         struct ip_header *nh = buffer->l3;
 625         uint32_t new, *field;
 626
 627         new = a->arg.nw_addr;
 628         field = a->type == OFPAT_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
 629         if (nw_proto == IP_TYPE_TCP) {
 630             struct tcp_header *th = buffer->l4;
 631             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, new);
 632         } else if (nw_proto == IP_TYPE_UDP) {
 633             struct udp_header *th = buffer->l4;
 634             if (th->udp_csum) {
 635                 th->udp_csum = recalc_csum32(th->udp_csum, *field, new);
 636                 if (!th->udp_csum) {
 637                     th->udp_csum = 0xffff;
 638                 }
 639             }
 640         }
 641         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, new);
 642         *field = new;
 643     }
 644 }
 645
 646 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 647                       uint8_t nw_proto, const struct ofp_action *a)
 648 {
 649     if (eth_proto == ETH_TYPE_IP) {
 650         uint16_t new, *field;
 651
 652         new = a->arg.tp;
 653
 654         if (nw_proto == IP_TYPE_TCP) {
 655             struct tcp_header *th = buffer->l4;
 656             field = a->type == OFPAT_SET_TP_SRC ? &th->tcp_src : &th->tcp_dst;
 657             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, new);
 658             *field = new;
 659         } else if (nw_proto == IP_TYPE_UDP) {
 660             struct udp_header *th = buffer->l4;
 661             field = a->type == OFPAT_SET_TP_SRC ? &th->udp_src : &th->udp_dst;
 662             th->udp_csum = recalc_csum16(th->udp_csum, *field, new);
 663             *field = new;
 664         }
 665     }
 666 }
 667
 668 static void
 669 modify_vlan(struct buffer *buffer,
 670             const struct sw_flow_key *key, const struct ofp_action *a)
 671 {
 672     uint16_t new_id = a->arg.vlan_id;
 673     struct vlan_eth_header *veh;
 674
 675     if (new_id != OFP_VLAN_NONE) {
 676         if (key->flow.dl_vlan != htons(OFP_VLAN_NONE)) {
 677             /* Modify vlan id, but maintain other TCI values */
 678             veh = buffer->l2;
 679             veh->veth_tci &= ~htons(VLAN_VID);
 680             veh->veth_tci |= htons(new_id);
 681         } else {
 682             /* Insert new vlan id. */
 683             struct eth_header *eh = buffer->l2;
 684             struct vlan_eth_header tmp;
 685             memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
 686             memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
 687             tmp.veth_type = htons(ETH_TYPE_VLAN);
 688             tmp.veth_tci = new_id;
 689             tmp.veth_next_type = eh->eth_type;
 690
 691             veh = buffer_push_uninit(buffer, VLAN_HEADER_LEN);
 692             memcpy(veh, &tmp, sizeof tmp);
 693             buffer->l2 -= VLAN_HEADER_LEN;
 694         }
 695     } else  {
 696         /* Remove an existing vlan header if it exists */
 697         veh = buffer->l2;
 698         if (veh->veth_type == htons(ETH_TYPE_VLAN)) {
 699             struct eth_header tmp;
 700
 701             memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
 702             memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
 703             tmp.eth_type = veh->veth_next_type;
 704
 705             buffer->size -= VLAN_HEADER_LEN;
 706             buffer->data += VLAN_HEADER_LEN;
 707             buffer->l2 += VLAN_HEADER_LEN;
 708             memcpy(buffer->data, &tmp, sizeof tmp);
 709         }
 710     }
 711 }
 712
 713 static int
 714 recv_control_hello(struct datapath *dp, const void *msg)
 715 {
 716     const struct ofp_control_hello *och = msg;
 717
 718     printf("control_hello(version=%d)\n", ntohl(och->version));
 719
 720     if (ntohs(och->miss_send_len) != OFP_MISS_SEND_LEN_UNCHANGED) {
 721         dp->miss_send_len = ntohs(och->miss_send_len);
 722     }
 723
 724     dp->hello_flags = ntohs(och->flags);
 725
 726     dp_send_hello(dp);
 727
 728     return 0;
 729 }
 730
 731 static int
 732 recv_packet_out(struct datapath *dp, const void *msg)
 733 {
 734     const struct ofp_packet_out *opo = msg;
 735
 736     if (ntohl(opo->buffer_id) == (uint32_t) -1) {
 737         /* FIXME: can we avoid copying data here? */
 738         int data_len = ntohs(opo->header.length) - sizeof *opo;
 739         struct buffer *buffer = buffer_new(data_len);
 740         buffer_put(buffer, opo->u.data, data_len);
 741         dp_output_port(dp, buffer,
 742                        ntohs(opo->in_port), ntohs(opo->out_port));
 743     } else {
 744         struct sw_flow_key key;
 745         struct buffer *buffer;
 746         int n_acts;
 747
 748         buffer = retrieve_buffer(ntohl(opo->buffer_id));
 749         if (!buffer) {
 750             return -ESRCH;
 751         }
 752
 753         n_acts = (ntohs(opo->header.length) - sizeof *opo)
 754             / sizeof *opo->u.actions;
 755         flow_extract(buffer, ntohs(opo->in_port), &key.flow);
 756         execute_actions(dp, buffer, ntohs(opo->in_port),
 757                         &key, opo->u.actions, n_acts);
 758     }
 759     return 0;
 760 }
 761
 762 static int
 763 recv_port_mod(struct datapath *dp, const void *msg)
 764 {
 765     const struct ofp_port_mod *opm = msg;
 766
 767     dp_update_port_flags(dp, &opm->desc);
 768
 769     return 0;
 770 }
 771
 772 static int
 773 add_flow(struct datapath *dp, const struct ofp_flow_mod *ofm)
 774 {
 775     int error = -ENOMEM;
 776     int n_acts;
 777     struct sw_flow *flow;
 778
 779
 780     /* Check number of actions. */
 781     n_acts = (ntohs(ofm->header.length) - sizeof *ofm) / sizeof *ofm->actions;
 782     if (n_acts > MAX_ACTIONS) {
 783         error = -E2BIG;
 784         goto error;
 785     }
 786
 787     /* Allocate memory. */
 788     flow = flow_alloc(n_acts);
 789     if (flow == NULL)
 790         goto error;
 791
 792     /* Fill out flow. */
 793     flow_extract_match(&flow->key, &ofm->match);
 794     flow->group_id = ntohl(ofm->group_id);
 795     flow->max_idle = ntohs(ofm->max_idle);
 796     flow->timeout = time(0) + flow->max_idle; /* FIXME */
 797     flow->n_actions = n_acts;
 798     flow->created = time(0);    /* FIXME */
 799     flow->byte_count = 0;
 800     flow->packet_count = 0;
 801     memcpy(flow->actions, ofm->actions, n_acts * sizeof *flow->actions);
 802
 803     /* Act. */
 804     error = chain_insert(dp->chain, flow);
 805     if (error) {
 806         goto error_free_flow;
 807     }
 808     error = 0;
 809     if (ntohl(ofm->buffer_id) != UINT32_MAX) {
 810         struct buffer *buffer = retrieve_buffer(ntohl(ofm->buffer_id));
 811         if (buffer) {
 812             struct sw_flow_key key;
 813             uint16_t in_port = ntohs(ofm->match.in_port);
 814             flow_used(flow, buffer);
 815             flow_extract(buffer, in_port, &key.flow);
 816             execute_actions(dp, buffer, in_port, &key, ofm->actions, n_acts);
 817         } else {
 818             error = -ESRCH;
 819         }
 820     }
 821     return error;
 822
 823 error_free_flow:
 824     flow_free(flow);
 825 error:
 826     if (ntohl(ofm->buffer_id) != (uint32_t) -1)
 827         discard_buffer(ntohl(ofm->buffer_id));
 828     return error;
 829 }
 830
 831 static int
 832 recv_flow(struct datapath *dp, const void *msg)
 833 {
 834     const struct ofp_flow_mod *ofm = msg;
 835     uint16_t command = ntohs(ofm->command);
 836
 837     if (command == OFPFC_ADD) {
 838         return add_flow(dp, ofm);
 839     }  else if (command == OFPFC_DELETE) {
 840         struct sw_flow_key key;
 841         flow_extract_match(&key, &ofm->match);
 842         return chain_delete(dp->chain, &key, 0) ? 0 : -ESRCH;
 843     } else if (command == OFPFC_DELETE_STRICT) {
 844         struct sw_flow_key key;
 845         flow_extract_match(&key, &ofm->match);
 846         return chain_delete(dp->chain, &key, 1) ? 0 : -ESRCH;
 847     } else {
 848         return -ENODEV;
 849     }
 850 }
 851
 852 /* 'msg', which is 'length' bytes long, was received from the control path.
 853  * Apply it to 'chain'. */
 854 int
 855 fwd_control_input(struct datapath *dp, const void *msg, size_t length)
 856 {
 857
 858     struct openflow_packet {
 859         size_t min_size;
 860         int (*handler)(struct datapath *, const void *);
 861     };
 862
 863     static const struct openflow_packet packets[] = {
 864         [OFPT_CONTROL_HELLO] = {
 865             sizeof (struct ofp_control_hello),
 866             recv_control_hello,
 867         },
 868         [OFPT_PACKET_OUT] = {
 869             sizeof (struct ofp_packet_out),
 870             recv_packet_out,
 871         },
 872         [OFPT_FLOW_MOD] = {
 873             sizeof (struct ofp_flow_mod),
 874             recv_flow,
 875         },
 876         [OFPT_PORT_MOD] = {
 877             sizeof (struct ofp_port_mod),
 878             recv_port_mod,
 879         },
 880     };
 881
 882     const struct openflow_packet *pkt;
 883     struct ofp_header *oh;
 884
 885     if (length < sizeof(struct ofp_header))
 886         return -EINVAL;
 887
 888     oh = (struct ofp_header *) msg;
 889     if (oh->version != 1 || oh->type >= ARRAY_SIZE(packets)
 890         || ntohs(oh->length) > length)
 891         return -EINVAL;
 892
 893     pkt = &packets[oh->type];
 894     if (!pkt->handler)
 895         return -ENOSYS;
 896     if (length < pkt->min_size)
 897         return -EFAULT;
 898
 899     return pkt->handler(dp, msg);
 900 }
 901 \f
 902 /* Packet buffering. */
 903
 904 #define OVERWRITE_SECS  1
 905
 906 struct packet_buffer {
 907     struct buffer *buffer;
 908     uint32_t cookie;
 909     time_t timeout;
 910 };
 911
 912 static struct packet_buffer buffers[N_PKT_BUFFERS];
 913 static unsigned int buffer_idx;
 914
 915 uint32_t save_buffer(struct buffer *buffer)
 916 {
 917     struct packet_buffer *p;
 918     uint32_t id;
 919
 920     buffer_idx = (buffer_idx + 1) & PKT_BUFFER_MASK;
 921     p = &buffers[buffer_idx];
 922     if (p->buffer) {
 923         /* Don't buffer packet if existing entry is less than
 924          * OVERWRITE_SECS old. */
 925         if (time(0) < p->timeout) { /* FIXME */
 926             return -1;
 927         } else {
 928             buffer_delete(p->buffer);
 929         }
 930     }
 931     /* Don't use maximum cookie value since the all-bits-1 id is
 932      * special. */
 933     if (++p->cookie >= (1u << PKT_COOKIE_BITS) - 1)
 934         p->cookie = 0;
 935     p->buffer = buffer_clone(buffer);      /* FIXME */
 936     p->timeout = time(0) + OVERWRITE_SECS; /* FIXME */
 937     id = buffer_idx | (p->cookie << PKT_BUFFER_BITS);
 938
 939     return id;
 940 }
 941
 942 static struct buffer *retrieve_buffer(uint32_t id)
 943 {
 944     struct buffer *buffer = NULL;
 945     struct packet_buffer *p;
 946
 947     p = &buffers[id & PKT_BUFFER_MASK];
 948     if (p->cookie == id >> PKT_BUFFER_BITS) {
 949         buffer = p->buffer;
 950         p->buffer = NULL;
 951     } else {
 952         printf("cookie mismatch: %x != %x\n",
 953                id >> PKT_BUFFER_BITS, p->cookie);
 954     }
 955
 956     return buffer;
 957 }
 958
 959 static void discard_buffer(uint32_t id)
 960 {
 961     struct packet_buffer *p;
 962
 963     p = &buffers[id & PKT_BUFFER_MASK];
 964     if (p->cookie == id >> PKT_BUFFER_BITS) {
 965         buffer_delete(p->buffer);
 966         p->buffer = NULL;
 967     }
 968 }