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