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