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 <inttypes.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include "buffer.h"
  42 #include "chain.h"
  43 #include "flow.h"
  44 #include "netdev.h"
  45 #include "packets.h"
  46 #include "poll-loop.h"
  47 #include "rconn.h"
  48 #include "vconn.h"
  49 #include "table.h"
  50 #include "xtoxll.h"
  51
  52 #define THIS_MODULE VLM_datapath
  53 #include "vlog.h"
  54
  55 #define BRIDGE_PORT_NO_FLOOD    0x00000001
  56
  57 /* Capabilities supported by this implementation. */
  58 #define OFP_SUPPORTED_CAPABILITIES (OFPC_MULTI_PHY_TX)
  59
  60 /* Actions supported by this implementation. */
  61 #define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT)         \
  62                                 | (1 << OFPAT_SET_DL_VLAN)  \
  63                                 | (1 << OFPAT_SET_DL_SRC)   \
  64                                 | (1 << OFPAT_SET_DL_DST)   \
  65                                 | (1 << OFPAT_SET_NW_SRC)   \
  66                                 | (1 << OFPAT_SET_NW_DST)   \
  67                                 | (1 << OFPAT_SET_TP_SRC)   \
  68                                 | (1 << OFPAT_SET_TP_DST) )
  69
  70 struct sw_port {
  71     uint32_t flags;
  72     struct datapath *dp;
  73     struct netdev *netdev;
  74     struct list node; /* Element in datapath.ports. */
  75     unsigned long long int rx_count, tx_count, drop_count;
  76 };
  77
  78 /* The origin of a received OpenFlow message, to enable sending a reply. */
  79 struct sender {
  80     struct remote *remote;      /* The device that sent the message. */
  81     uint32_t xid;               /* The OpenFlow transaction ID. */
  82 };
  83
  84 /* A connection to a controller or a management device. */
  85 struct remote {
  86     struct list node;
  87     struct rconn *rconn;
  88
  89     /* Support for reliable, multi-message replies to requests.
  90      *
  91      * If an incoming request needs to have a reliable reply that might
  92      * require multiple messages, it can use remote_start_dump() to set up
  93      * a callback that will be called as buffer space for replies. */
  94     int (*cb_dump)(struct datapath *, void *aux);
  95     void (*cb_done)(void *aux);
  96     void *cb_aux;
  97 };
  98
  99 struct datapath {
 100     /* Remote connections. */
 101     struct remote *controller;  /* Connection to controller. */
 102     struct list remotes;        /* All connections (including controller). */
 103     struct vconn *listen_vconn;
 104
 105     time_t last_timeout;
 106
 107     /* Unique identifier for this datapath */
 108     uint64_t  id;
 109
 110     struct sw_chain *chain;  /* Forwarding rules. */
 111
 112     struct ofp_switch_config config;
 113
 114     /* Switch ports. */
 115     struct sw_port ports[OFPP_MAX];
 116     struct list port_list; /* List of ports, for flooding. */
 117 };
 118
 119 static struct remote *remote_create(struct datapath *, struct rconn *);
 120 static void remote_run(struct datapath *, struct remote *);
 121 static void remote_wait(struct remote *);
 122 static void remote_destroy(struct remote *);
 123
 124 void dp_output_port(struct datapath *, struct buffer *,
 125                     int in_port, int out_port);
 126 void dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp);
 127 void dp_output_control(struct datapath *, struct buffer *, int in_port,
 128                        size_t max_len, int reason);
 129 static void send_flow_expired(struct datapath *, struct sw_flow *);
 130 static void send_port_status(struct sw_port *p, uint8_t status);
 131 static void del_switch_port(struct sw_port *p);
 132 static void execute_actions(struct datapath *, struct buffer *,
 133                             int in_port, const struct sw_flow_key *,
 134                             const struct ofp_action *, int n_actions);
 135 static void modify_vlan(struct buffer *buffer, const struct sw_flow_key *key,
 136                         const struct ofp_action *a);
 137 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 138                       uint8_t nw_proto, const struct ofp_action *a);
 139 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 140                           uint8_t nw_proto, const struct ofp_action *a);
 141
 142 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
 143  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
 144  * is an index into an array of buffers.  The cookie distinguishes between
 145  * different packets that have occupied a single buffer.  Thus, the more
 146  * buffers we have, the lower-quality the cookie... */
 147 #define PKT_BUFFER_BITS 8
 148 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
 149 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
 150
 151 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
 152
 153 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
 154 int fwd_control_input(struct datapath *, const struct sender *,
 155                       const void *, size_t);
 156
 157 uint32_t save_buffer(struct buffer *);
 158 static struct buffer *retrieve_buffer(uint32_t id);
 159 static void discard_buffer(uint32_t id);
 160
 161 static int port_no(struct datapath *dp, struct sw_port *p)
 162 {
 163     assert(p >= dp->ports && p < &dp->ports[ARRAY_SIZE(dp->ports)]);
 164     return p - dp->ports;
 165 }
 166
 167 /* Generates a unique datapath id.  It incorporates the datapath index
 168  * and a hardware address, if available.  If not, it generates a random
 169  * one.
 170  */
 171 static uint64_t
 172 gen_datapath_id(void)
 173 {
 174     /* Choose a random datapath id. */
 175     uint64_t id = 0;
 176     int i;
 177
 178     srand(time(0));
 179
 180     for (i = 0; i < ETH_ADDR_LEN; i++) {
 181         id |= (uint64_t)(rand() & 0xff) << (8*(ETH_ADDR_LEN-1 - i));
 182     }
 183
 184     return id;
 185 }
 186
 187 int
 188 dp_new(struct datapath **dp_, uint64_t dpid, struct rconn *rconn)
 189 {
 190     struct datapath *dp;
 191
 192     dp = calloc(1, sizeof *dp);
 193     if (!dp) {
 194         return ENOMEM;
 195     }
 196
 197     dp->last_timeout = time(0);
 198     list_init(&dp->remotes);
 199     dp->controller = remote_create(dp, rconn);
 200     dp->listen_vconn = NULL;
 201     dp->id = dpid <= UINT64_C(0xffffffffffff) ? dpid : gen_datapath_id();
 202     dp->chain = chain_create();
 203     if (!dp->chain) {
 204         VLOG_ERR("could not create chain");
 205         free(dp);
 206         return ENOMEM;
 207     }
 208
 209     list_init(&dp->port_list);
 210     dp->config.flags = 0;
 211     dp->config.miss_send_len = htons(OFP_DEFAULT_MISS_SEND_LEN);
 212     *dp_ = dp;
 213     return 0;
 214 }
 215
 216 int
 217 dp_add_port(struct datapath *dp, const char *name)
 218 {
 219     struct netdev *netdev;
 220     struct in6_addr in6;
 221     struct in_addr in4;
 222     struct sw_port *p;
 223     int error;
 224
 225     error = netdev_open(name, &netdev);
 226     if (error) {
 227         return error;
 228     }
 229     error = netdev_set_flags(netdev, NETDEV_UP | NETDEV_PROMISC);
 230     if (error) {
 231         VLOG_ERR("Couldn't set promiscuous mode on %s device", name);
 232         netdev_close(netdev);
 233         return error;
 234     }
 235     if (netdev_get_in4(netdev, &in4)) {
 236         VLOG_ERR("%s device has assigned IP address %s", name, inet_ntoa(in4));
 237     }
 238     if (netdev_get_in6(netdev, &in6)) {
 239         char in6_name[INET6_ADDRSTRLEN + 1];
 240         inet_ntop(AF_INET6, &in6, in6_name, sizeof in6_name);
 241         VLOG_ERR("%s device has assigned IPv6 address %s", name, in6_name);
 242     }
 243
 244     for (p = dp->ports; ; p++) {
 245         if (p >= &dp->ports[ARRAY_SIZE(dp->ports)]) {
 246             return EXFULL;
 247         } else if (!p->netdev) {
 248             break;
 249         }
 250     }
 251
 252     p->dp = dp;
 253     p->netdev = netdev;
 254     p->tx_count = 0;
 255     p->rx_count = 0;
 256     p->drop_count = 0;
 257     list_push_back(&dp->port_list, &p->node);
 258
 259     /* Notify the ctlpath that this port has been added */
 260     send_port_status(p, OFPPR_ADD);
 261
 262     return 0;
 263 }
 264
 265 void
 266 dp_add_listen_vconn(struct datapath *dp, struct vconn *listen_vconn)
 267 {
 268     assert(!dp->listen_vconn);
 269     dp->listen_vconn = listen_vconn;
 270 }
 271
 272 void
 273 dp_run(struct datapath *dp)
 274 {
 275     time_t now = time(0);
 276     struct sw_port *p, *pn;
 277     struct remote *r, *rn;
 278     struct buffer *buffer = NULL;
 279
 280     if (now != dp->last_timeout) {
 281         struct list deleted = LIST_INITIALIZER(&deleted);
 282         struct sw_flow *f, *n;
 283
 284         chain_timeout(dp->chain, &deleted);
 285         LIST_FOR_EACH_SAFE (f, n, struct sw_flow, node, &deleted) {
 286             send_flow_expired(dp, f);
 287             list_remove(&f->node);
 288             flow_free(f);
 289         }
 290         dp->last_timeout = now;
 291     }
 292     poll_timer_wait(1000);
 293
 294     LIST_FOR_EACH_SAFE (p, pn, struct sw_port, node, &dp->port_list) {
 295         int error;
 296
 297         if (!buffer) {
 298             /* Allocate buffer with some headroom to add headers in forwarding
 299              * to the controller or adding a vlan tag, plus an extra 2 bytes to
 300              * allow IP headers to be aligned on a 4-byte boundary.  */
 301             const int headroom = 128 + 2;
 302             const int hard_header = VLAN_ETH_HEADER_LEN;
 303             const int mtu = netdev_get_mtu(p->netdev);
 304             buffer = buffer_new(headroom + hard_header + mtu);
 305             buffer->data += headroom;
 306         }
 307         error = netdev_recv(p->netdev, buffer);
 308         if (!error) {
 309             p->rx_count++;
 310             fwd_port_input(dp, buffer, port_no(dp, p));
 311             buffer = NULL;
 312         } else if (error != EAGAIN) {
 313             VLOG_ERR("Error receiving data from %s: %s",
 314                      netdev_get_name(p->netdev), strerror(error));
 315             del_switch_port(p);
 316         }
 317     }
 318     buffer_delete(buffer);
 319
 320     /* Talk to remotes. */
 321     LIST_FOR_EACH_SAFE (r, rn, struct remote, node, &dp->remotes) {
 322         remote_run(dp, r);
 323     }
 324     if (dp->listen_vconn) {
 325         for (;;) {
 326             struct vconn *new_vconn;
 327             int retval;
 328
 329             retval = vconn_accept(dp->listen_vconn, &new_vconn);
 330             if (retval) {
 331                 if (retval != EAGAIN) {
 332                     VLOG_WARN("accept failed (%s)", strerror(retval));
 333                 }
 334                 break;
 335             }
 336             remote_create(dp, rconn_new_from_vconn("passive", 128, new_vconn));
 337         }
 338     }
 339 }
 340
 341 static void
 342 remote_run(struct datapath *dp, struct remote *r)
 343 {
 344     int i;
 345
 346     rconn_run(r->rconn);
 347
 348     /* Do some remote processing, but cap it at a reasonable amount so that
 349      * other processing doesn't starve. */
 350     for (i = 0; i < 50; i++) {
 351         if (!r->cb_dump) {
 352             struct buffer *buffer;
 353             struct ofp_header *oh;
 354
 355             buffer = rconn_recv(r->rconn);
 356             if (!buffer) {
 357                 break;
 358             }
 359
 360             if (buffer->size >= sizeof *oh) {
 361                 struct sender sender;
 362
 363                 oh = buffer->data;
 364                 sender.remote = r;
 365                 sender.xid = oh->xid;
 366                 fwd_control_input(dp, &sender, buffer->data, buffer->size);
 367             } else {
 368                 VLOG_WARN("received too-short OpenFlow message");
 369             }
 370             buffer_delete(buffer);
 371         } else {
 372             if (!rconn_is_full(r->rconn)) {
 373                 int error = r->cb_dump(dp, r->cb_aux);
 374                 if (error <= 0) {
 375                     if (error) {
 376                         VLOG_WARN("dump callback error: %s", strerror(-error));
 377                     }
 378                     r->cb_done(r->cb_aux);
 379                     r->cb_dump = NULL;
 380                 }
 381             } else {
 382                 break;
 383             }
 384         }
 385     }
 386
 387     if (!rconn_is_alive(r->rconn)) {
 388         remote_destroy(r);
 389     }
 390 }
 391
 392 static void
 393 remote_wait(struct remote *r)
 394 {
 395     rconn_run_wait(r->rconn);
 396     rconn_recv_wait(r->rconn);
 397 }
 398
 399 static void
 400 remote_destroy(struct remote *r)
 401 {
 402     if (r) {
 403         if (r->cb_dump && r->cb_done) {
 404             r->cb_done(r->cb_aux);
 405         }
 406         list_remove(&r->node);
 407         rconn_destroy(r->rconn);
 408         free(r);
 409     }
 410 }
 411
 412 static struct remote *
 413 remote_create(struct datapath *dp, struct rconn *rconn)
 414 {
 415     struct remote *remote = xmalloc(sizeof *remote);
 416     list_push_back(&dp->remotes, &remote->node);
 417     remote->rconn = rconn;
 418     remote->cb_dump = NULL;
 419     return remote;
 420 }
 421
 422 /* Starts a callback-based, reliable, possibly multi-message reply to a
 423  * request made by 'remote'.
 424  *
 425  * 'dump' designates a function that will be called when the 'remote' send
 426  * queue has an empty slot.  It should compose a message and send it on
 427  * 'remote'.  On success, it should return 1 if it should be called again when
 428  * another send queue slot opens up, 0 if its transmissions are complete, or a
 429  * negative errno value on failure.
 430  *
 431  * 'done' designates a function to clean up any resources allocated for the
 432  * dump.  It must handle being called before the dump is complete (which will
 433  * happen if 'remote' is closed unexpectedly).
 434  *
 435  * 'aux' is passed to 'dump' and 'done'. */
 436 static void
 437 remote_start_dump(struct remote *remote,
 438                   int (*dump)(struct datapath *, void *),
 439                   void (*done)(void *),
 440                   void *aux)
 441 {
 442     assert(!remote->cb_dump);
 443     remote->cb_dump = dump;
 444     remote->cb_done = done;
 445     remote->cb_aux = aux;
 446 }
 447
 448 void
 449 dp_wait(struct datapath *dp)
 450 {
 451     struct sw_port *p;
 452     struct remote *r;
 453
 454     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 455         netdev_recv_wait(p->netdev);
 456     }
 457     LIST_FOR_EACH (r, struct remote, node, &dp->remotes) {
 458         remote_wait(r);
 459     }
 460     if (dp->listen_vconn) {
 461         vconn_accept_wait(dp->listen_vconn);
 462     }
 463 }
 464
 465 /* Delete 'p' from switch. */
 466 static void
 467 del_switch_port(struct sw_port *p)
 468 {
 469     send_port_status(p, OFPPR_DELETE);
 470     netdev_close(p->netdev);
 471     p->netdev = NULL;
 472     list_remove(&p->node);
 473 }
 474
 475 void
 476 dp_destroy(struct datapath *dp)
 477 {
 478     struct sw_port *p, *n;
 479
 480     if (!dp) {
 481         return;
 482     }
 483
 484     LIST_FOR_EACH_SAFE (p, n, struct sw_port, node, &dp->port_list) {
 485         del_switch_port(p);
 486     }
 487     chain_destroy(dp->chain);
 488     free(dp);
 489 }
 490
 491 /* Send packets out all the ports except the originating one.  If the
 492  * "flood" argument is set, don't send out ports with flooding disabled.
 493  */
 494 static int
 495 output_all(struct datapath *dp, struct buffer *buffer, int in_port, int flood)
 496 {
 497     struct sw_port *p;
 498     int prev_port;
 499
 500     prev_port = -1;
 501     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 502         if (port_no(dp, p) == in_port) {
 503             continue;
 504         }
 505         if (flood && p->flags & BRIDGE_PORT_NO_FLOOD) {
 506             continue;
 507         }
 508         if (prev_port != -1) {
 509             dp_output_port(dp, buffer_clone(buffer), in_port, prev_port);
 510         }
 511         prev_port = port_no(dp, p);
 512     }
 513     if (prev_port != -1)
 514         dp_output_port(dp, buffer, in_port, prev_port);
 515     else
 516         buffer_delete(buffer);
 517
 518     return 0;
 519 }
 520
 521 void
 522 output_packet(struct datapath *dp, struct buffer *buffer, int out_port)
 523 {
 524     if (out_port >= 0 && out_port < OFPP_MAX) {
 525         struct sw_port *p = &dp->ports[out_port];
 526         if (p->netdev != NULL) {
 527             if (!netdev_send(p->netdev, buffer)) {
 528                 p->tx_count++;
 529             } else {
 530                 p->drop_count++;
 531             }
 532             return;
 533         }
 534     }
 535
 536     buffer_delete(buffer);
 537     /* FIXME: ratelimit */
 538     VLOG_DBG("can't forward to bad port %d\n", out_port);
 539 }
 540
 541 /* Takes ownership of 'buffer' and transmits it to 'out_port' on 'dp'.
 542  */
 543 void
 544 dp_output_port(struct datapath *dp, struct buffer *buffer,
 545                int in_port, int out_port)
 546 {
 547
 548     assert(buffer);
 549     if (out_port == OFPP_FLOOD) {
 550         output_all(dp, buffer, in_port, 1);
 551     } else if (out_port == OFPP_ALL) {
 552         output_all(dp, buffer, in_port, 0);
 553     } else if (out_port == OFPP_CONTROLLER) {
 554         dp_output_control(dp, buffer, in_port, 0, OFPR_ACTION);
 555     } else if (out_port == OFPP_TABLE) {
 556         struct sw_flow_key key;
 557         struct sw_flow *flow;
 558
 559         key.wildcards = 0;
 560         flow_extract(buffer, in_port, &key.flow);
 561         flow = chain_lookup(dp->chain, &key);
 562         if (flow != NULL) {
 563             flow_used(flow, buffer);
 564             execute_actions(dp, buffer, in_port, &key,
 565                             flow->actions, flow->n_actions);
 566         }
 567     } else {
 568         output_packet(dp, buffer, out_port);
 569     }
 570 }
 571
 572 static void *
 573 alloc_openflow_buffer(struct datapath *dp, size_t openflow_len, uint8_t type,
 574                       const struct sender *sender, struct buffer **bufferp)
 575 {
 576     struct buffer *buffer;
 577     struct ofp_header *oh;
 578
 579     buffer = *bufferp = buffer_new(openflow_len);
 580     oh = buffer_put_uninit(buffer, openflow_len);
 581     oh->version = OFP_VERSION;
 582     oh->type = type;
 583     oh->length = 0;             /* Filled in by send_openflow_buffer(). */
 584     oh->xid = sender ? sender->xid : 0;
 585     return oh;
 586 }
 587
 588 static int
 589 send_openflow_buffer(struct datapath *dp, struct buffer *buffer,
 590                      const struct sender *sender)
 591 {
 592     struct remote *remote = sender ? sender->remote : dp->controller;
 593     struct rconn *rconn = remote->rconn;
 594     struct ofp_header *oh;
 595     int retval;
 596
 597     oh = buffer_at_assert(buffer, 0, sizeof *oh);
 598     oh->length = htons(buffer->size);
 599
 600     retval = rconn_send(rconn, buffer);
 601     if (retval) {
 602         VLOG_WARN("send to %s failed: %s",
 603                   rconn_get_name(rconn), strerror(retval));
 604         buffer_delete(buffer);
 605     }
 606     return retval;
 607 }
 608
 609 /* Takes ownership of 'buffer' and transmits it to 'dp''s controller.  If the
 610  * packet can be saved in a buffer, then only the first max_len bytes of
 611  * 'buffer' are sent; otherwise, all of 'buffer' is sent.  'reason' indicates
 612  * why 'buffer' is being sent. 'max_len' sets the maximum number of bytes that
 613  * the caller wants to be sent; a value of 0 indicates the entire packet should
 614  * be sent. */
 615 void
 616 dp_output_control(struct datapath *dp, struct buffer *buffer, int in_port,
 617                   size_t max_len, int reason)
 618 {
 619     struct ofp_packet_in *opi;
 620     size_t total_len;
 621     uint32_t buffer_id;
 622
 623     buffer_id = save_buffer(buffer);
 624     total_len = buffer->size;
 625     if (buffer_id != UINT32_MAX && buffer->size > max_len) {
 626         buffer->size = max_len;
 627     }
 628
 629     opi = buffer_push_uninit(buffer, offsetof(struct ofp_packet_in, data));
 630     opi->header.version = OFP_VERSION;
 631     opi->header.type    = OFPT_PACKET_IN;
 632     opi->header.length  = htons(buffer->size);
 633     opi->header.xid     = htonl(0);
 634     opi->buffer_id      = htonl(buffer_id);
 635     opi->total_len      = htons(total_len);
 636     opi->in_port        = htons(in_port);
 637     opi->reason         = reason;
 638     opi->pad            = 0;
 639     send_openflow_buffer(dp, buffer, NULL);
 640 }
 641
 642 static void fill_port_desc(struct datapath *dp, struct sw_port *p,
 643                            struct ofp_phy_port *desc)
 644 {
 645     desc->port_no = htons(port_no(dp, p));
 646     strncpy((char *) desc->name, netdev_get_name(p->netdev),
 647             sizeof desc->name);
 648     desc->name[sizeof desc->name - 1] = '\0';
 649     memcpy(desc->hw_addr, netdev_get_etheraddr(p->netdev), ETH_ADDR_LEN);
 650     desc->flags = htonl(p->flags);
 651     desc->features = htonl(netdev_get_features(p->netdev));
 652     desc->speed = htonl(netdev_get_speed(p->netdev));
 653 }
 654
 655 static void
 656 dp_send_features_reply(struct datapath *dp, const struct sender *sender)
 657 {
 658     struct buffer *buffer;
 659     struct ofp_switch_features *ofr;
 660     struct sw_port *p;
 661
 662     ofr = alloc_openflow_buffer(dp, sizeof *ofr, OFPT_FEATURES_REPLY,
 663                                 sender, &buffer);
 664     ofr->datapath_id    = htonll(dp->id);
 665     ofr->n_exact        = htonl(2 * TABLE_HASH_MAX_FLOWS);
 666     ofr->n_compression  = 0;         /* Not supported */
 667     ofr->n_general      = htonl(TABLE_LINEAR_MAX_FLOWS);
 668     ofr->buffer_mb      = htonl(UINT32_MAX);
 669     ofr->n_buffers      = htonl(N_PKT_BUFFERS);
 670     ofr->capabilities   = htonl(OFP_SUPPORTED_CAPABILITIES);
 671     ofr->actions        = htonl(OFP_SUPPORTED_ACTIONS);
 672     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 673         struct ofp_phy_port *opp = buffer_put_uninit(buffer, sizeof *opp);
 674         memset(opp, 0, sizeof *opp);
 675         fill_port_desc(dp, p, opp);
 676     }
 677     send_openflow_buffer(dp, buffer, sender);
 678 }
 679
 680 void
 681 dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp)
 682 {
 683     int port_no = ntohs(opp->port_no);
 684     if (port_no < OFPP_MAX) {
 685         struct sw_port *p = &dp->ports[port_no];
 686
 687         /* Make sure the port id hasn't changed since this was sent */
 688         if (!p || memcmp(opp->hw_addr, netdev_get_etheraddr(p->netdev),
 689                          ETH_ADDR_LEN) != 0) {
 690             return;
 691         }
 692         p->flags = htonl(opp->flags);
 693     }
 694 }
 695
 696 static void
 697 send_port_status(struct sw_port *p, uint8_t status)
 698 {
 699     struct buffer *buffer;
 700     struct ofp_port_status *ops;
 701     ops = alloc_openflow_buffer(p->dp, sizeof *ops, OFPT_PORT_STATUS, NULL,
 702                                 &buffer);
 703     ops->reason = status;
 704     memset(ops->pad, 0, sizeof ops->pad);
 705     fill_port_desc(p->dp, p, &ops->desc);
 706
 707     send_openflow_buffer(p->dp, buffer, NULL);
 708 }
 709
 710 void
 711 send_flow_expired(struct datapath *dp, struct sw_flow *flow)
 712 {
 713     struct buffer *buffer;
 714     struct ofp_flow_expired *ofe;
 715     ofe = alloc_openflow_buffer(dp, sizeof *ofe, OFPT_FLOW_EXPIRED, NULL,
 716                                 &buffer);
 717     flow_fill_match(&ofe->match, &flow->key);
 718
 719     memset(ofe->pad, 0, sizeof ofe->pad);
 720     ofe->priority = htons(flow->priority);
 721
 722     ofe->duration     = htonl(flow->timeout - flow->max_idle - flow->created);
 723     ofe->packet_count = htonll(flow->packet_count);
 724     ofe->byte_count   = htonll(flow->byte_count);
 725     send_openflow_buffer(dp, buffer, NULL);
 726 }
 727
 728 void
 729 dp_send_error_msg(struct datapath *dp, const struct sender *sender,
 730         uint16_t type, uint16_t code, const uint8_t *data, size_t len)
 731 {
 732     struct buffer *buffer;
 733     struct ofp_error_msg *oem;
 734     oem = alloc_openflow_buffer(dp, sizeof(*oem)+len, OFPT_ERROR_MSG,
 735                                 sender, &buffer);
 736     oem->type = htons(type);
 737     oem->code = htons(code);
 738     memcpy(oem->data, data, len);
 739     send_openflow_buffer(dp, buffer, sender);
 740 }
 741
 742 static void
 743 fill_flow_stats(struct buffer *buffer, struct sw_flow *flow,
 744                 int table_idx, time_t now)
 745 {
 746     struct ofp_flow_stats *ofs;
 747     int length = sizeof *ofs + sizeof *ofs->actions * flow->n_actions;
 748     ofs = buffer_put_uninit(buffer, length);
 749     ofs->length          = htons(length);
 750     ofs->table_id        = table_idx;
 751     ofs->pad             = 0;
 752     ofs->match.wildcards = htons(flow->key.wildcards);
 753     ofs->match.in_port   = flow->key.flow.in_port;
 754     memcpy(ofs->match.dl_src, flow->key.flow.dl_src, ETH_ADDR_LEN);
 755     memcpy(ofs->match.dl_dst, flow->key.flow.dl_dst, ETH_ADDR_LEN);
 756     ofs->match.dl_vlan   = flow->key.flow.dl_vlan;
 757     ofs->match.dl_type   = flow->key.flow.dl_type;
 758     ofs->match.nw_src    = flow->key.flow.nw_src;
 759     ofs->match.nw_dst    = flow->key.flow.nw_dst;
 760     ofs->match.nw_proto  = flow->key.flow.nw_proto;
 761     memset(ofs->match.pad, 0, sizeof ofs->match.pad);
 762     ofs->match.tp_src    = flow->key.flow.tp_src;
 763     ofs->match.tp_dst    = flow->key.flow.tp_dst;
 764     ofs->duration        = htonl(now - flow->created);
 765     ofs->packet_count    = htonll(flow->packet_count);
 766     ofs->byte_count      = htonll(flow->byte_count);
 767     ofs->priority        = htons(flow->priority);
 768     ofs->max_idle        = htons(flow->max_idle);
 769     memcpy(ofs->actions, flow->actions,
 770            sizeof *ofs->actions * flow->n_actions);
 771 }
 772
 773 \f
 774 /* 'buffer' was received on 'in_port', a physical switch port between 0 and
 775  * OFPP_MAX.  Process it according to 'chain'. */
 776 void fwd_port_input(struct datapath *dp, struct buffer *buffer, int in_port)
 777 {
 778     struct sw_flow_key key;
 779     struct sw_flow *flow;
 780
 781     key.wildcards = 0;
 782     flow_extract(buffer, in_port, &key.flow);
 783     flow = chain_lookup(dp->chain, &key);
 784     if (flow != NULL) {
 785         flow_used(flow, buffer);
 786         execute_actions(dp, buffer, in_port, &key,
 787                         flow->actions, flow->n_actions);
 788     } else {
 789         dp_output_control(dp, buffer, in_port, ntohs(dp->config.miss_send_len),
 790                           OFPR_NO_MATCH);
 791     }
 792 }
 793
 794 static void
 795 do_output(struct datapath *dp, struct buffer *buffer, int in_port,
 796           size_t max_len, int out_port)
 797 {
 798     if (out_port != OFPP_CONTROLLER) {
 799         dp_output_port(dp, buffer, in_port, out_port);
 800     } else {
 801         dp_output_control(dp, buffer, in_port, max_len, OFPR_ACTION);
 802     }
 803 }
 804
 805 static void
 806 execute_actions(struct datapath *dp, struct buffer *buffer,
 807                 int in_port, const struct sw_flow_key *key,
 808                 const struct ofp_action *actions, int n_actions)
 809 {
 810     /* Every output action needs a separate clone of 'buffer', but the common
 811      * case is just a single output action, so that doing a clone and then
 812      * freeing the original buffer is wasteful.  So the following code is
 813      * slightly obscure just to avoid that. */
 814     int prev_port;
 815     size_t max_len=0;        /* Initialze to make compiler happy */
 816     uint16_t eth_proto;
 817     int i;
 818
 819     prev_port = -1;
 820     eth_proto = ntohs(key->flow.dl_type);
 821
 822     for (i = 0; i < n_actions; i++) {
 823         const struct ofp_action *a = &actions[i];
 824         struct eth_header *eh = buffer->l2;
 825
 826         if (prev_port != -1) {
 827             do_output(dp, buffer_clone(buffer), in_port, max_len, prev_port);
 828             prev_port = -1;
 829         }
 830
 831         switch (ntohs(a->type)) {
 832         case OFPAT_OUTPUT:
 833             prev_port = ntohs(a->arg.output.port);
 834             max_len = ntohs(a->arg.output.max_len);
 835             break;
 836
 837         case OFPAT_SET_DL_VLAN:
 838             modify_vlan(buffer, key, a);
 839             break;
 840
 841         case OFPAT_SET_DL_SRC:
 842             memcpy(eh->eth_src, a->arg.dl_addr, sizeof eh->eth_src);
 843             break;
 844
 845         case OFPAT_SET_DL_DST:
 846             memcpy(eh->eth_dst, a->arg.dl_addr, sizeof eh->eth_dst);
 847             break;
 848
 849         case OFPAT_SET_NW_SRC:
 850         case OFPAT_SET_NW_DST:
 851             modify_nh(buffer, eth_proto, key->flow.nw_proto, a);
 852             break;
 853
 854         case OFPAT_SET_TP_SRC:
 855         case OFPAT_SET_TP_DST:
 856             modify_th(buffer, eth_proto, key->flow.nw_proto, a);
 857             break;
 858
 859         default:
 860             NOT_REACHED();
 861         }
 862     }
 863     if (prev_port != -1)
 864         do_output(dp, buffer, in_port, max_len, prev_port);
 865     else
 866         buffer_delete(buffer);
 867 }
 868
 869 /* Returns the new checksum for a packet in which the checksum field previously
 870  * contained 'old_csum' and in which a field that contained 'old_u16' was
 871  * changed to contain 'new_u16'. */
 872 static uint16_t
 873 recalc_csum16(uint16_t old_csum, uint16_t old_u16, uint16_t new_u16)
 874 {
 875     /* Ones-complement arithmetic is endian-independent, so this code does not
 876      * use htons() or ntohs().
 877      *
 878      * See RFC 1624 for formula and explanation. */
 879     uint16_t hc_complement = ~old_csum;
 880     uint16_t m_complement = ~old_u16;
 881     uint16_t m_prime = new_u16;
 882     uint32_t sum = hc_complement + m_complement + m_prime;
 883     uint16_t hc_prime_complement = sum + (sum >> 16);
 884     return ~hc_prime_complement;
 885 }
 886
 887 /* Returns the new checksum for a packet in which the checksum field previously
 888  * contained 'old_csum' and in which a field that contained 'old_u32' was
 889  * changed to contain 'new_u32'. */
 890 static uint16_t
 891 recalc_csum32(uint16_t old_csum, uint32_t old_u32, uint32_t new_u32)
 892 {
 893     return recalc_csum16(recalc_csum16(old_csum, old_u32, new_u32),
 894                          old_u32 >> 16, new_u32 >> 16);
 895 }
 896
 897 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 898                       uint8_t nw_proto, const struct ofp_action *a)
 899 {
 900     if (eth_proto == ETH_TYPE_IP) {
 901         struct ip_header *nh = buffer->l3;
 902         uint32_t new, *field;
 903
 904         new = a->arg.nw_addr;
 905         field = a->type == OFPAT_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
 906         if (nw_proto == IP_TYPE_TCP) {
 907             struct tcp_header *th = buffer->l4;
 908             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, new);
 909         } else if (nw_proto == IP_TYPE_UDP) {
 910             struct udp_header *th = buffer->l4;
 911             if (th->udp_csum) {
 912                 th->udp_csum = recalc_csum32(th->udp_csum, *field, new);
 913                 if (!th->udp_csum) {
 914                     th->udp_csum = 0xffff;
 915                 }
 916             }
 917         }
 918         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, new);
 919         *field = new;
 920     }
 921 }
 922
 923 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 924                       uint8_t nw_proto, const struct ofp_action *a)
 925 {
 926     if (eth_proto == ETH_TYPE_IP) {
 927         uint16_t new, *field;
 928
 929         new = a->arg.tp;
 930
 931         if (nw_proto == IP_TYPE_TCP) {
 932             struct tcp_header *th = buffer->l4;
 933             field = a->type == OFPAT_SET_TP_SRC ? &th->tcp_src : &th->tcp_dst;
 934             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, new);
 935             *field = new;
 936         } else if (nw_proto == IP_TYPE_UDP) {
 937             struct udp_header *th = buffer->l4;
 938             field = a->type == OFPAT_SET_TP_SRC ? &th->udp_src : &th->udp_dst;
 939             th->udp_csum = recalc_csum16(th->udp_csum, *field, new);
 940             *field = new;
 941         }
 942     }
 943 }
 944
 945 static void
 946 modify_vlan(struct buffer *buffer,
 947             const struct sw_flow_key *key, const struct ofp_action *a)
 948 {
 949     uint16_t new_id = a->arg.vlan_id;
 950     struct vlan_eth_header *veh;
 951
 952     if (new_id != OFP_VLAN_NONE) {
 953         if (key->flow.dl_vlan != htons(OFP_VLAN_NONE)) {
 954             /* Modify vlan id, but maintain other TCI values */
 955             veh = buffer->l2;
 956             veh->veth_tci &= ~htons(VLAN_VID);
 957             veh->veth_tci |= htons(new_id);
 958         } else {
 959             /* Insert new vlan id. */
 960             struct eth_header *eh = buffer->l2;
 961             struct vlan_eth_header tmp;
 962             memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
 963             memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
 964             tmp.veth_type = htons(ETH_TYPE_VLAN);
 965             tmp.veth_tci = new_id;
 966             tmp.veth_next_type = eh->eth_type;
 967
 968             veh = buffer_push_uninit(buffer, VLAN_HEADER_LEN);
 969             memcpy(veh, &tmp, sizeof tmp);
 970             buffer->l2 -= VLAN_HEADER_LEN;
 971         }
 972     } else  {
 973         /* Remove an existing vlan header if it exists */
 974         veh = buffer->l2;
 975         if (veh->veth_type == htons(ETH_TYPE_VLAN)) {
 976             struct eth_header tmp;
 977
 978             memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
 979             memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
 980             tmp.eth_type = veh->veth_next_type;
 981
 982             buffer->size -= VLAN_HEADER_LEN;
 983             buffer->data += VLAN_HEADER_LEN;
 984             buffer->l2 += VLAN_HEADER_LEN;
 985             memcpy(buffer->data, &tmp, sizeof tmp);
 986         }
 987     }
 988 }
 989
 990 static int
 991 recv_features_request(struct datapath *dp, const struct sender *sender,
 992                       const void *msg)
 993 {
 994     dp_send_features_reply(dp, sender);
 995     return 0;
 996 }
 997
 998 static int
 999 recv_get_config_request(struct datapath *dp, const struct sender *sender,
1000                         const void *msg)
1001 {
1002     struct buffer *buffer;
1003     struct ofp_switch_config *osc;
1004
1005     osc = alloc_openflow_buffer(dp, sizeof *osc, OFPT_GET_CONFIG_REPLY,
1006                                 sender, &buffer);
1007
1008     assert(sizeof *osc == sizeof dp->config);
1009     memcpy(((char *)osc) + sizeof osc->header,
1010            ((char *)&dp->config) + sizeof dp->config.header,
1011            sizeof dp->config - sizeof dp->config.header);
1012
1013     return send_openflow_buffer(dp, buffer, sender);
1014 }
1015
1016 static int
1017 recv_set_config(struct datapath *dp, const struct sender *sender UNUSED,
1018                 const void *msg)
1019 {
1020     const struct ofp_switch_config *osc = msg;
1021     dp->config = *osc;
1022     return 0;
1023 }
1024
1025 static int
1026 recv_packet_out(struct datapath *dp, const struct sender *sender UNUSED,
1027                 const void *msg)
1028 {
1029     const struct ofp_packet_out *opo = msg;
1030
1031     if (ntohl(opo->buffer_id) == (uint32_t) -1) {
1032         /* FIXME: can we avoid copying data here? */
1033         int data_len = ntohs(opo->header.length) - sizeof *opo;
1034         struct buffer *buffer = buffer_new(data_len);
1035         buffer_put(buffer, opo->u.data, data_len);
1036         dp_output_port(dp, buffer,
1037                        ntohs(opo->in_port), ntohs(opo->out_port));
1038     } else {
1039         struct sw_flow_key key;
1040         struct buffer *buffer;
1041         int n_acts;
1042
1043         buffer = retrieve_buffer(ntohl(opo->buffer_id));
1044         if (!buffer) {
1045             return -ESRCH;
1046         }
1047
1048         n_acts = (ntohs(opo->header.length) - sizeof *opo)
1049             / sizeof *opo->u.actions;
1050         flow_extract(buffer, ntohs(opo->in_port), &key.flow);
1051         execute_actions(dp, buffer, ntohs(opo->in_port),
1052                         &key, opo->u.actions, n_acts);
1053     }
1054     return 0;
1055 }
1056
1057 static int
1058 recv_port_mod(struct datapath *dp, const struct sender *sender UNUSED,
1059               const void *msg)
1060 {
1061     const struct ofp_port_mod *opm = msg;
1062
1063     dp_update_port_flags(dp, &opm->desc);
1064
1065     return 0;
1066 }
1067
1068 static int
1069 add_flow(struct datapath *dp, const struct ofp_flow_mod *ofm)
1070 {
1071     int error = -ENOMEM;
1072     int n_acts;
1073     int i;
1074     struct sw_flow *flow;
1075
1076
1077     /* To prevent loops, make sure there's no action to send to the
1078      * OFP_TABLE virtual port.
1079      */
1080     n_acts = (ntohs(ofm->header.length) - sizeof *ofm) / sizeof *ofm->actions;
1081     for (i=0; i<n_acts; i++) {
1082         const struct ofp_action *a = &ofm->actions[i];
1083
1084         if (a->type == htons(OFPAT_OUTPUT)
1085                     && a->arg.output.port == htons(OFPP_TABLE)) {
1086             /* xxx Send fancy new error message? */
1087             goto error;
1088         }
1089     }
1090
1091     /* Allocate memory. */
1092     flow = flow_alloc(n_acts);
1093     if (flow == NULL)
1094         goto error;
1095
1096     /* Fill out flow. */
1097     flow_extract_match(&flow->key, &ofm->match);
1098     flow->max_idle = ntohs(ofm->max_idle);
1099     flow->priority = flow->key.wildcards ? ntohs(ofm->priority) : -1;
1100     flow->timeout = time(0) + flow->max_idle; /* FIXME */
1101     flow->n_actions = n_acts;
1102     flow->created = time(0);    /* FIXME */
1103     flow->byte_count = 0;
1104     flow->packet_count = 0;
1105     memcpy(flow->actions, ofm->actions, n_acts * sizeof *flow->actions);
1106
1107     /* Act. */
1108     error = chain_insert(dp->chain, flow);
1109     if (error) {
1110         goto error_free_flow;
1111     }
1112     error = 0;
1113     if (ntohl(ofm->buffer_id) != UINT32_MAX) {
1114         struct buffer *buffer = retrieve_buffer(ntohl(ofm->buffer_id));
1115         if (buffer) {
1116             struct sw_flow_key key;
1117             uint16_t in_port = ntohs(ofm->match.in_port);
1118             flow_used(flow, buffer);
1119             flow_extract(buffer, in_port, &key.flow);
1120             execute_actions(dp, buffer, in_port, &key, ofm->actions, n_acts);
1121         } else {
1122             error = -ESRCH;
1123         }
1124     }
1125     return error;
1126
1127 error_free_flow:
1128     flow_free(flow);
1129 error:
1130     if (ntohl(ofm->buffer_id) != (uint32_t) -1)
1131         discard_buffer(ntohl(ofm->buffer_id));
1132     return error;
1133 }
1134
1135 static int
1136 recv_flow(struct datapath *dp, const struct sender *sender UNUSED,
1137           const void *msg)
1138 {
1139     const struct ofp_flow_mod *ofm = msg;
1140     uint16_t command = ntohs(ofm->command);
1141
1142     if (command == OFPFC_ADD) {
1143         return add_flow(dp, ofm);
1144     }  else if (command == OFPFC_DELETE) {
1145         struct sw_flow_key key;
1146         flow_extract_match(&key, &ofm->match);
1147         return chain_delete(dp->chain, &key, 0, 0) ? 0 : -ESRCH;
1148     } else if (command == OFPFC_DELETE_STRICT) {
1149         struct sw_flow_key key;
1150         uint16_t priority;
1151         flow_extract_match(&key, &ofm->match);
1152         priority = key.wildcards ? ntohs(ofm->priority) : -1;
1153         return chain_delete(dp->chain, &key, priority, 1) ? 0 : -ESRCH;
1154     } else {
1155         return -ENODEV;
1156     }
1157 }
1158
1159 struct flow_stats_state {
1160     int table_idx;
1161     struct sw_table_position position;
1162     struct ofp_flow_stats_request rq;
1163     time_t now;
1164
1165     struct buffer *buffer;
1166 };
1167
1168 #define MAX_FLOW_STATS_BYTES 4096
1169
1170 static int flow_stats_init(struct datapath *dp, const void *body, int body_len,
1171                            void **state)
1172 {
1173     const struct ofp_flow_stats_request *fsr = body;
1174     struct flow_stats_state *s = xmalloc(sizeof *s);
1175     s->table_idx = fsr->table_id == 0xff ? 0 : fsr->table_id;
1176     memset(&s->position, 0, sizeof s->position);
1177     s->rq = *fsr;
1178     *state = s;
1179     return 0;
1180 }
1181
1182 static int flow_stats_dump_callback(struct sw_flow *flow, void *private)
1183 {
1184     struct flow_stats_state *s = private;
1185     fill_flow_stats(s->buffer, flow, s->table_idx, s->now);
1186     return s->buffer->size >= MAX_FLOW_STATS_BYTES;
1187 }
1188
1189 static int flow_stats_dump(struct datapath *dp, void *state,
1190                            struct buffer *buffer)
1191 {
1192     struct flow_stats_state *s = state;
1193     struct sw_flow_key match_key;
1194
1195     flow_extract_match(&match_key, &s->rq.match);
1196     s->buffer = buffer;
1197     s->now = time(0);
1198     while (s->table_idx < dp->chain->n_tables
1199            && (s->rq.table_id == 0xff || s->rq.table_id == s->table_idx))
1200     {
1201         struct sw_table *table = dp->chain->tables[s->table_idx];
1202
1203         if (table->iterate(table, &match_key, &s->position,
1204                            flow_stats_dump_callback, s))
1205             break;
1206
1207         s->table_idx++;
1208         memset(&s->position, 0, sizeof s->position);
1209     }
1210     return s->buffer->size >= MAX_FLOW_STATS_BYTES;
1211 }
1212
1213 static void flow_stats_done(void *state)
1214 {
1215     free(state);
1216 }
1217
1218 struct aggregate_stats_state {
1219     struct ofp_aggregate_stats_request rq;
1220 };
1221
1222 static int aggregate_stats_init(struct datapath *dp,
1223                                 const void *body, int body_len,
1224                                 void **state)
1225 {
1226     const struct ofp_aggregate_stats_request *rq = body;
1227     struct aggregate_stats_state *s = xmalloc(sizeof *s);
1228     s->rq = *rq;
1229     *state = s;
1230     return 0;
1231 }
1232
1233 static int aggregate_stats_dump_callback(struct sw_flow *flow, void *private)
1234 {
1235     struct ofp_aggregate_stats_reply *rpy = private;
1236     rpy->packet_count += flow->packet_count;
1237     rpy->byte_count += flow->byte_count;
1238     rpy->flow_count++;
1239     return 0;
1240 }
1241
1242 static int aggregate_stats_dump(struct datapath *dp, void *state,
1243                                 struct buffer *buffer)
1244 {
1245     struct aggregate_stats_state *s = state;
1246     struct ofp_aggregate_stats_request *rq = &s->rq;
1247     struct ofp_aggregate_stats_reply *rpy;
1248     struct sw_table_position position;
1249     struct sw_flow_key match_key;
1250     int table_idx;
1251
1252     rpy = buffer_put_uninit(buffer, sizeof *rpy);
1253     memset(rpy, 0, sizeof *rpy);
1254
1255     flow_extract_match(&match_key, &rq->match);
1256     table_idx = rq->table_id == 0xff ? 0 : rq->table_id;
1257     memset(&position, 0, sizeof position);
1258     while (table_idx < dp->chain->n_tables
1259            && (rq->table_id == 0xff || rq->table_id == table_idx))
1260     {
1261         struct sw_table *table = dp->chain->tables[table_idx];
1262         int error;
1263
1264         error = table->iterate(table, &match_key, &position,
1265                                aggregate_stats_dump_callback, rpy);
1266         if (error)
1267             return error;
1268
1269         table_idx++;
1270         memset(&position, 0, sizeof position);
1271     }
1272
1273     rpy->packet_count = htonll(rpy->packet_count);
1274     rpy->byte_count = htonll(rpy->byte_count);
1275     rpy->flow_count = htonl(rpy->flow_count);
1276     return 0;
1277 }
1278
1279 static void aggregate_stats_done(void *state)
1280 {
1281     free(state);
1282 }
1283
1284 static int table_stats_dump(struct datapath *dp, void *state,
1285                             struct buffer *buffer)
1286 {
1287     int i;
1288     for (i = 0; i < dp->chain->n_tables; i++) {
1289         struct ofp_table_stats *ots = buffer_put_uninit(buffer, sizeof *ots);
1290         struct sw_table_stats stats;
1291         dp->chain->tables[i]->stats(dp->chain->tables[i], &stats);
1292         strncpy(ots->name, stats.name, sizeof ots->name);
1293         ots->table_id = i;
1294         memset(ots->pad, 0, sizeof ots->pad);
1295         ots->max_entries = htonl(stats.max_flows);
1296         ots->active_count = htonl(stats.n_flows);
1297         ots->matched_count = htonll(0); /* FIXME */
1298     }
1299     return 0;
1300 }
1301
1302 struct port_stats_state {
1303     int port;
1304 };
1305
1306 static int port_stats_init(struct datapath *dp, const void *body, int body_len,
1307                void **state)
1308 {
1309     struct port_stats_state *s = xmalloc(sizeof *s);
1310     s->port = 0;
1311     *state = s;
1312     return 0;
1313 }
1314
1315 static int port_stats_dump(struct datapath *dp, void *state,
1316                            struct buffer *buffer)
1317 {
1318     struct port_stats_state *s = state;
1319     int i;
1320
1321     for (i = s->port; i < OFPP_MAX; i++) {
1322         struct sw_port *p = &dp->ports[i];
1323         struct ofp_port_stats *ops;
1324         if (!p->netdev) {
1325             continue;
1326         }
1327         ops = buffer_put_uninit(buffer, sizeof *ops);
1328         ops->port_no = htons(port_no(dp, p));
1329         memset(ops->pad, 0, sizeof ops->pad);
1330         ops->rx_count = htonll(p->rx_count);
1331         ops->tx_count = htonll(p->tx_count);
1332         ops->drop_count = htonll(p->drop_count);
1333         ops++;
1334     }
1335     s->port = i;
1336     return 0;
1337 }
1338
1339 static void port_stats_done(void *state)
1340 {
1341     free(state);
1342 }
1343
1344 struct stats_type {
1345     /* Minimum and maximum acceptable number of bytes in body member of
1346      * struct ofp_stats_request. */
1347     size_t min_body, max_body;
1348
1349     /* Prepares to dump some kind of statistics on 'dp'.  'body' and
1350      * 'body_len' are the 'body' member of the struct ofp_stats_request.
1351      * Returns zero if successful, otherwise a negative error code.
1352      * May initialize '*state' to state information.  May be null if no
1353      * initialization is required.*/
1354     int (*init)(struct datapath *dp, const void *body, int body_len,
1355             void **state);
1356
1357     /* Appends statistics for 'dp' to 'buffer', which initially contains a
1358      * struct ofp_stats_reply.  On success, it should return 1 if it should be
1359      * called again later with another buffer, 0 if it is done, or a negative
1360      * errno value on failure. */
1361     int (*dump)(struct datapath *dp, void *state, struct buffer *buffer);
1362
1363     /* Cleans any state created by the init or dump functions.  May be null
1364      * if no cleanup is required. */
1365     void (*done)(void *state);
1366 };
1367
1368 static const struct stats_type stats[] = {
1369     [OFPST_FLOW] = {
1370         sizeof(struct ofp_flow_stats_request),
1371         sizeof(struct ofp_flow_stats_request),
1372         flow_stats_init,
1373         flow_stats_dump,
1374         flow_stats_done
1375     },
1376     [OFPST_AGGREGATE] = {
1377         sizeof(struct ofp_aggregate_stats_request),
1378         sizeof(struct ofp_aggregate_stats_request),
1379         aggregate_stats_init,
1380         aggregate_stats_dump,
1381         aggregate_stats_done
1382     },
1383     [OFPST_TABLE] = {
1384         0,
1385         0,
1386         NULL,
1387         table_stats_dump,
1388         NULL
1389     },
1390     [OFPST_PORT] = {
1391         0,
1392         0,
1393         port_stats_init,
1394         port_stats_dump,
1395         port_stats_done
1396     },
1397 };
1398
1399 struct stats_dump_cb {
1400     bool done;
1401     struct ofp_stats_request *rq;
1402     struct sender sender;
1403     const struct stats_type *s;
1404     void *state;
1405 };
1406
1407 static int
1408 stats_dump(struct datapath *dp, void *cb_)
1409 {
1410     struct stats_dump_cb *cb = cb_;
1411     struct ofp_stats_reply *osr;
1412     struct buffer *buffer;
1413     int err;
1414
1415     if (cb->done) {
1416         return 0;
1417     }
1418
1419     osr = alloc_openflow_buffer(dp, sizeof *osr, OFPT_STATS_REPLY, &cb->sender,
1420                                 &buffer);
1421     osr->type = htons(cb->s - stats);
1422     osr->flags = 0;
1423
1424     err = cb->s->dump(dp, cb->state, buffer);
1425     if (err >= 0) {
1426         int err2;
1427         if (!err) {
1428             cb->done = true;
1429         } else {
1430             /* Buffer might have been reallocated, so find our data again. */
1431             osr = buffer_at_assert(buffer, 0, sizeof *osr);
1432             osr->flags = ntohs(OFPSF_REPLY_MORE);
1433         }
1434         err2 = send_openflow_buffer(dp, buffer, &cb->sender);
1435         if (err2) {
1436             err = err2;
1437         }
1438     }
1439
1440     return err;
1441 }
1442
1443 static void
1444 stats_done(void *cb_)
1445 {
1446     struct stats_dump_cb *cb = cb_;
1447     if (cb) {
1448         if (cb->s->done) {
1449             cb->s->done(cb->state);
1450         }
1451         free(cb);
1452     }
1453 }
1454
1455 static int
1456 recv_stats_request(struct datapath *dp, const struct sender *sender,
1457                    const void *oh)
1458 {
1459     const struct ofp_stats_request *rq = oh;
1460     size_t rq_len = ntohs(rq->header.length);
1461     struct stats_dump_cb *cb;
1462     int type, body_len;
1463     int err;
1464
1465     type = ntohs(rq->type);
1466     if (type >= ARRAY_SIZE(stats) || !stats[type].dump) {
1467         VLOG_WARN("received stats request of unknown type %d", type);
1468         return -EINVAL;
1469     }
1470
1471     cb = xmalloc(sizeof *cb);
1472     cb->done = false;
1473     cb->rq = xmemdup(rq, rq_len);
1474     cb->sender = *sender;
1475     cb->s = &stats[type];
1476     cb->state = NULL;
1477
1478     body_len = rq_len - offsetof(struct ofp_stats_request, body);
1479     if (body_len < cb->s->min_body || body_len > cb->s->max_body) {
1480         VLOG_WARN("stats request type %d with bad body length %d",
1481                   type, body_len);
1482         err = -EINVAL;
1483         goto error;
1484     }
1485
1486     if (cb->s->init) {
1487         err = cb->s->init(dp, rq->body, body_len, &cb->state);
1488         if (err) {
1489             VLOG_WARN("failed initialization of stats request type %d: %s",
1490                       type, strerror(-err));
1491             goto error;
1492         }
1493     }
1494
1495     remote_start_dump(sender->remote, stats_dump, stats_done, cb);
1496     return 0;
1497
1498 error:
1499     free(cb->rq);
1500     free(cb);
1501     return err;
1502 }
1503
1504 /* 'msg', which is 'length' bytes long, was received from the control path.
1505  * Apply it to 'chain'. */
1506 int
1507 fwd_control_input(struct datapath *dp, const struct sender *sender,
1508                   const void *msg, size_t length)
1509 {
1510     struct openflow_packet {
1511         size_t min_size;
1512         int (*handler)(struct datapath *, const struct sender *, const void *);
1513     };
1514
1515     static const struct openflow_packet packets[] = {
1516         [OFPT_FEATURES_REQUEST] = {
1517             sizeof (struct ofp_header),
1518             recv_features_request,
1519         },
1520         [OFPT_GET_CONFIG_REQUEST] = {
1521             sizeof (struct ofp_header),
1522             recv_get_config_request,
1523         },
1524         [OFPT_SET_CONFIG] = {
1525             sizeof (struct ofp_switch_config),
1526             recv_set_config,
1527         },
1528         [OFPT_PACKET_OUT] = {
1529             sizeof (struct ofp_packet_out),
1530             recv_packet_out,
1531         },
1532         [OFPT_FLOW_MOD] = {
1533             sizeof (struct ofp_flow_mod),
1534             recv_flow,
1535         },
1536         [OFPT_PORT_MOD] = {
1537             sizeof (struct ofp_port_mod),
1538             recv_port_mod,
1539         },
1540         [OFPT_STATS_REQUEST] = {
1541             sizeof (struct ofp_stats_request),
1542             recv_stats_request,
1543         },
1544     };
1545
1546     const struct openflow_packet *pkt;
1547     struct ofp_header *oh;
1548
1549     oh = (struct ofp_header *) msg;
1550     if (oh->version != OFP_VERSION || oh->type >= ARRAY_SIZE(packets)
1551         || ntohs(oh->length) > length)
1552         return -EINVAL;
1553
1554     pkt = &packets[oh->type];
1555     if (!pkt->handler)
1556         return -ENOSYS;
1557     if (length < pkt->min_size)
1558         return -EFAULT;
1559
1560     return pkt->handler(dp, sender, msg);
1561 }
1562 \f
1563 /* Packet buffering. */
1564
1565 #define OVERWRITE_SECS  1
1566
1567 struct packet_buffer {
1568     struct buffer *buffer;
1569     uint32_t cookie;
1570     time_t timeout;
1571 };
1572
1573 static struct packet_buffer buffers[N_PKT_BUFFERS];
1574 static unsigned int buffer_idx;
1575
1576 uint32_t save_buffer(struct buffer *buffer)
1577 {
1578     struct packet_buffer *p;
1579     uint32_t id;
1580
1581     buffer_idx = (buffer_idx + 1) & PKT_BUFFER_MASK;
1582     p = &buffers[buffer_idx];
1583     if (p->buffer) {
1584         /* Don't buffer packet if existing entry is less than
1585          * OVERWRITE_SECS old. */
1586         if (time(0) < p->timeout) { /* FIXME */
1587             return -1;
1588         } else {
1589             buffer_delete(p->buffer);
1590         }
1591     }
1592     /* Don't use maximum cookie value since the all-bits-1 id is
1593      * special. */
1594     if (++p->cookie >= (1u << PKT_COOKIE_BITS) - 1)
1595         p->cookie = 0;
1596     p->buffer = buffer_clone(buffer);      /* FIXME */
1597     p->timeout = time(0) + OVERWRITE_SECS; /* FIXME */
1598     id = buffer_idx | (p->cookie << PKT_BUFFER_BITS);
1599
1600     return id;
1601 }
1602
1603 static struct buffer *retrieve_buffer(uint32_t id)
1604 {
1605     struct buffer *buffer = NULL;
1606     struct packet_buffer *p;
1607
1608     p = &buffers[id & PKT_BUFFER_MASK];
1609     if (p->cookie == id >> PKT_BUFFER_BITS) {
1610         buffer = p->buffer;
1611         p->buffer = NULL;
1612     } else {
1613         printf("cookie mismatch: %x != %x\n",
1614                id >> PKT_BUFFER_BITS, p->cookie);
1615     }
1616
1617     return buffer;
1618 }
1619
1620 static void discard_buffer(uint32_t id)
1621 {
1622     struct packet_buffer *p;
1623
1624     p = &buffers[id & PKT_BUFFER_MASK];
1625     if (p->cookie == id >> PKT_BUFFER_BITS) {
1626         buffer_delete(p->buffer);
1627         p->buffer = NULL;
1628     }
1629 }