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 extern char serial_num;
  70
  71 /* Capabilities supported by this implementation. */
  72 #define OFP_SUPPORTED_CAPABILITIES ( OFPC_FLOW_STATS \
  73         | OFPC_TABLE_STATS \
  74         | OFPC_PORT_STATS \
  75         | OFPC_MULTI_PHY_TX )
  76
  77 /* Actions supported by this implementation. */
  78 #define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT)         \
  79                                 | (1 << OFPAT_SET_DL_VLAN)  \
  80                                 | (1 << OFPAT_SET_DL_SRC)   \
  81                                 | (1 << OFPAT_SET_DL_DST)   \
  82                                 | (1 << OFPAT_SET_NW_SRC)   \
  83                                 | (1 << OFPAT_SET_NW_DST)   \
  84                                 | (1 << OFPAT_SET_TP_SRC)   \
  85                                 | (1 << OFPAT_SET_TP_DST) )
  86
  87 struct sw_port {
  88     uint32_t flags;                    /* BRPF_* flags */
  89     uint32_t status;                   /* BRPS_* flags */
  90     struct datapath *dp;
  91     struct netdev *netdev;
  92     struct list node; /* Element in datapath.ports. */
  93     unsigned long long int rx_packets, tx_packets;
  94     unsigned long long int rx_bytes, tx_bytes;
  95     unsigned long long int tx_dropped;
  96 };
  97
  98 /* The origin of a received OpenFlow message, to enable sending a reply. */
  99 struct sender {
 100     struct remote *remote;      /* The device that sent the message. */
 101     uint32_t xid;               /* The OpenFlow transaction ID. */
 102 };
 103
 104 /* A connection to a controller or a management device. */
 105 struct remote {
 106     struct list node;
 107     struct rconn *rconn;
 108 #define TXQ_LIMIT 128           /* Max number of packets to queue for tx. */
 109     int n_txq;                  /* Number of packets queued for tx on rconn. */
 110
 111     /* Support for reliable, multi-message replies to requests.
 112      *
 113      * If an incoming request needs to have a reliable reply that might
 114      * require multiple messages, it can use remote_start_dump() to set up
 115      * a callback that will be called as buffer space for replies. */
 116     int (*cb_dump)(struct datapath *, void *aux);
 117     void (*cb_done)(void *aux);
 118     void *cb_aux;
 119 };
 120
 121 struct datapath {
 122     /* Remote connections. */
 123     struct remote *controller;  /* Connection to controller. */
 124     struct list remotes;        /* All connections (including controller). */
 125     struct vconn *listen_vconn;
 126
 127     time_t last_timeout;
 128
 129     /* Unique identifier for this datapath */
 130     uint64_t  id;
 131
 132     struct sw_chain *chain;  /* Forwarding rules. */
 133
 134     /* Configuration set from controller. */
 135     uint16_t flags;
 136     uint16_t miss_send_len;
 137
 138     /* Switch ports. */
 139     struct sw_port ports[OFPP_MAX];
 140     struct list port_list; /* List of ports, for flooding. */
 141 };
 142
 143 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(60, 60);
 144
 145 static struct remote *remote_create(struct datapath *, struct rconn *);
 146 static void remote_run(struct datapath *, struct remote *);
 147 static void remote_wait(struct remote *);
 148 static void remote_destroy(struct remote *);
 149
 150 void dp_output_port(struct datapath *, struct buffer *,
 151                     int in_port, int out_port);
 152 void dp_update_port_flags(struct datapath *dp, const struct ofp_port_mod *opm);
 153 void dp_output_control(struct datapath *, struct buffer *, int in_port,
 154                        size_t max_len, int reason);
 155 static void send_flow_expired(struct datapath *, struct sw_flow *,
 156                               enum ofp_flow_expired_reason);
 157 static int update_port_status(struct sw_port *p);
 158 static void send_port_status(struct sw_port *p, uint8_t status);
 159 static void del_switch_port(struct sw_port *p);
 160 static void execute_actions(struct datapath *, struct buffer *,
 161                             int in_port, const struct sw_flow_key *,
 162                             const struct ofp_action *, int n_actions);
 163 static void modify_vlan(struct buffer *buffer, const struct sw_flow_key *key,
 164                         const struct ofp_action *a);
 165 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 166                       uint8_t nw_proto, const struct ofp_action *a);
 167 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 168                           uint8_t nw_proto, const struct ofp_action *a);
 169
 170 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
 171  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
 172  * is an index into an array of buffers.  The cookie distinguishes between
 173  * different packets that have occupied a single buffer.  Thus, the more
 174  * buffers we have, the lower-quality the cookie... */
 175 #define PKT_BUFFER_BITS 8
 176 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
 177 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
 178
 179 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
 180
 181 int run_flow_through_tables(struct datapath *, struct buffer *, int in_port);
 182 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
 183 int fwd_control_input(struct datapath *, const struct sender *,
 184                       const void *, size_t);
 185
 186 uint32_t save_buffer(struct buffer *);
 187 static struct buffer *retrieve_buffer(uint32_t id);
 188 static void discard_buffer(uint32_t id);
 189
 190 static int port_no(struct datapath *dp, struct sw_port *p)
 191 {
 192     assert(p >= dp->ports && p < &dp->ports[ARRAY_SIZE(dp->ports)]);
 193     return p - dp->ports;
 194 }
 195
 196 /* Generates and returns a random datapath id. */
 197 static uint64_t
 198 gen_datapath_id(void)
 199 {
 200     uint8_t ea[ETH_ADDR_LEN];
 201     eth_addr_random(ea);
 202     return eth_addr_to_uint64(ea);
 203 }
 204
 205 int
 206 dp_new(struct datapath **dp_, uint64_t dpid, struct rconn *rconn)
 207 {
 208     struct datapath *dp;
 209
 210     dp = calloc(1, sizeof *dp);
 211     if (!dp) {
 212         return ENOMEM;
 213     }
 214
 215     dp->last_timeout = time_now();
 216     list_init(&dp->remotes);
 217     dp->controller = remote_create(dp, rconn);
 218     dp->listen_vconn = NULL;
 219     dp->id = dpid <= UINT64_C(0xffffffffffff) ? dpid : gen_datapath_id();
 220     dp->chain = chain_create();
 221     if (!dp->chain) {
 222         VLOG_ERR("could not create chain");
 223         free(dp);
 224         return ENOMEM;
 225     }
 226
 227     list_init(&dp->port_list);
 228     dp->flags = 0;
 229     dp->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 230     *dp_ = dp;
 231     return 0;
 232 }
 233
 234 int
 235 dp_add_port(struct datapath *dp, const char *name)
 236 {
 237     struct netdev *netdev;
 238     struct in6_addr in6;
 239     struct in_addr in4;
 240     struct sw_port *p;
 241     int error;
 242
 243     error = netdev_open(name, NETDEV_ETH_TYPE_ANY, &netdev);
 244     if (error) {
 245         return error;
 246     }
 247     error = netdev_set_flags(netdev, NETDEV_UP | NETDEV_PROMISC, false);
 248     if (error) {
 249         VLOG_ERR("couldn't set promiscuous mode on %s device", name);
 250         netdev_close(netdev);
 251         return error;
 252     }
 253     if (netdev_get_in4(netdev, &in4)) {
 254         VLOG_ERR("%s device has assigned IP address %s", name, inet_ntoa(in4));
 255     }
 256     if (netdev_get_in6(netdev, &in6)) {
 257         char in6_name[INET6_ADDRSTRLEN + 1];
 258         inet_ntop(AF_INET6, &in6, in6_name, sizeof in6_name);
 259         VLOG_ERR("%s device has assigned IPv6 address %s", name, in6_name);
 260     }
 261
 262     for (p = dp->ports; ; p++) {
 263         if (p >= &dp->ports[ARRAY_SIZE(dp->ports)]) {
 264             return EXFULL;
 265         } else if (!p->netdev) {
 266             break;
 267         }
 268     }
 269
 270     memset(p, '\0', sizeof *p);
 271
 272     p->dp = dp;
 273     p->netdev = netdev;
 274     list_push_back(&dp->port_list, &p->node);
 275
 276     /* Notify the ctlpath that this port has been added */
 277     send_port_status(p, OFPPR_ADD);
 278
 279     return 0;
 280 }
 281
 282 void
 283 dp_add_listen_vconn(struct datapath *dp, struct vconn *listen_vconn)
 284 {
 285     assert(!dp->listen_vconn);
 286     dp->listen_vconn = listen_vconn;
 287 }
 288
 289 void
 290 dp_run(struct datapath *dp)
 291 {
 292     time_t now = time_now();
 293     struct sw_port *p, *pn;
 294     struct remote *r, *rn;
 295     struct buffer *buffer = NULL;
 296
 297     if (now != dp->last_timeout) {
 298         struct list deleted = LIST_INITIALIZER(&deleted);
 299         struct sw_flow *f, *n;
 300
 301         LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 302             if (update_port_status(p)) {
 303                 send_port_status(p, OFPPR_MOD);
 304             }
 305         }
 306
 307         chain_timeout(dp->chain, &deleted);
 308         LIST_FOR_EACH_SAFE (f, n, struct sw_flow, node, &deleted) {
 309             send_flow_expired(dp, f, f->reason);
 310             list_remove(&f->node);
 311             flow_free(f);
 312         }
 313         dp->last_timeout = now;
 314     }
 315     poll_timer_wait(1000);
 316
 317     LIST_FOR_EACH_SAFE (p, pn, struct sw_port, node, &dp->port_list) {
 318         int error;
 319
 320         if (!buffer) {
 321             /* Allocate buffer with some headroom to add headers in forwarding
 322              * to the controller or adding a vlan tag, plus an extra 2 bytes to
 323              * allow IP headers to be aligned on a 4-byte boundary.  */
 324             const int headroom = 128 + 2;
 325             const int hard_header = VLAN_ETH_HEADER_LEN;
 326             const int mtu = netdev_get_mtu(p->netdev);
 327             buffer = buffer_new(headroom + hard_header + mtu);
 328             buffer->data += headroom;
 329         }
 330         error = netdev_recv(p->netdev, buffer);
 331         if (!error) {
 332             p->rx_packets++;
 333             p->rx_bytes += buffer->size;
 334             fwd_port_input(dp, buffer, port_no(dp, p));
 335             buffer = NULL;
 336         } else if (error != EAGAIN) {
 337             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
 338                         netdev_get_name(p->netdev), strerror(error));
 339         }
 340     }
 341     buffer_delete(buffer);
 342
 343     /* Talk to remotes. */
 344     LIST_FOR_EACH_SAFE (r, rn, struct remote, node, &dp->remotes) {
 345         remote_run(dp, r);
 346     }
 347     if (dp->listen_vconn) {
 348         for (;;) {
 349             struct vconn *new_vconn;
 350             int retval;
 351
 352             retval = vconn_accept(dp->listen_vconn, &new_vconn);
 353             if (retval) {
 354                 if (retval != EAGAIN) {
 355                     VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 356                 }
 357                 break;
 358             }
 359             remote_create(dp, rconn_new_from_vconn("passive", new_vconn));
 360         }
 361     }
 362 }
 363
 364 static void
 365 remote_run(struct datapath *dp, struct remote *r)
 366 {
 367     int i;
 368
 369     rconn_run(r->rconn);
 370
 371     /* Do some remote processing, but cap it at a reasonable amount so that
 372      * other processing doesn't starve. */
 373     for (i = 0; i < 50; i++) {
 374         if (!r->cb_dump) {
 375             struct buffer *buffer;
 376             struct ofp_header *oh;
 377
 378             buffer = rconn_recv(r->rconn);
 379             if (!buffer) {
 380                 break;
 381             }
 382
 383             if (buffer->size >= sizeof *oh) {
 384                 struct sender sender;
 385
 386                 oh = buffer->data;
 387                 sender.remote = r;
 388                 sender.xid = oh->xid;
 389                 fwd_control_input(dp, &sender, buffer->data, buffer->size);
 390             } else {
 391                 VLOG_WARN_RL(&rl, "received too-short OpenFlow message");
 392             }
 393             buffer_delete(buffer);
 394         } else {
 395             if (r->n_txq < TXQ_LIMIT) {
 396                 int error = r->cb_dump(dp, r->cb_aux);
 397                 if (error <= 0) {
 398                     if (error) {
 399                         VLOG_WARN_RL(&rl, "dump callback error: %s",
 400                                      strerror(-error));
 401                     }
 402                     r->cb_done(r->cb_aux);
 403                     r->cb_dump = NULL;
 404                 }
 405             } else {
 406                 break;
 407             }
 408         }
 409     }
 410
 411     if (!rconn_is_alive(r->rconn)) {
 412         remote_destroy(r);
 413     }
 414 }
 415
 416 static void
 417 remote_wait(struct remote *r)
 418 {
 419     rconn_run_wait(r->rconn);
 420     rconn_recv_wait(r->rconn);
 421 }
 422
 423 static void
 424 remote_destroy(struct remote *r)
 425 {
 426     if (r) {
 427         if (r->cb_dump && r->cb_done) {
 428             r->cb_done(r->cb_aux);
 429         }
 430         list_remove(&r->node);
 431         rconn_destroy(r->rconn);
 432         free(r);
 433     }
 434 }
 435
 436 static struct remote *
 437 remote_create(struct datapath *dp, struct rconn *rconn)
 438 {
 439     struct remote *remote = xmalloc(sizeof *remote);
 440     list_push_back(&dp->remotes, &remote->node);
 441     remote->rconn = rconn;
 442     remote->cb_dump = NULL;
 443     remote->n_txq = 0;
 444     return remote;
 445 }
 446
 447 /* Starts a callback-based, reliable, possibly multi-message reply to a
 448  * request made by 'remote'.
 449  *
 450  * 'dump' designates a function that will be called when the 'remote' send
 451  * queue has an empty slot.  It should compose a message and send it on
 452  * 'remote'.  On success, it should return 1 if it should be called again when
 453  * another send queue slot opens up, 0 if its transmissions are complete, or a
 454  * negative errno value on failure.
 455  *
 456  * 'done' designates a function to clean up any resources allocated for the
 457  * dump.  It must handle being called before the dump is complete (which will
 458  * happen if 'remote' is closed unexpectedly).
 459  *
 460  * 'aux' is passed to 'dump' and 'done'. */
 461 static void
 462 remote_start_dump(struct remote *remote,
 463                   int (*dump)(struct datapath *, void *),
 464                   void (*done)(void *),
 465                   void *aux)
 466 {
 467     assert(!remote->cb_dump);
 468     remote->cb_dump = dump;
 469     remote->cb_done = done;
 470     remote->cb_aux = aux;
 471 }
 472
 473 void
 474 dp_wait(struct datapath *dp)
 475 {
 476     struct sw_port *p;
 477     struct remote *r;
 478
 479     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 480         netdev_recv_wait(p->netdev);
 481     }
 482     LIST_FOR_EACH (r, struct remote, node, &dp->remotes) {
 483         remote_wait(r);
 484     }
 485     if (dp->listen_vconn) {
 486         vconn_accept_wait(dp->listen_vconn);
 487     }
 488 }
 489
 490 /* Delete 'p' from switch. */
 491 static void
 492 del_switch_port(struct sw_port *p)
 493 {
 494     send_port_status(p, OFPPR_DELETE);
 495     netdev_close(p->netdev);
 496     p->netdev = NULL;
 497     list_remove(&p->node);
 498 }
 499
 500 void
 501 dp_destroy(struct datapath *dp)
 502 {
 503     struct sw_port *p, *n;
 504
 505     if (!dp) {
 506         return;
 507     }
 508
 509     LIST_FOR_EACH_SAFE (p, n, struct sw_port, node, &dp->port_list) {
 510         del_switch_port(p);
 511     }
 512     chain_destroy(dp->chain);
 513     free(dp);
 514 }
 515
 516 /* Send packets out all the ports except the originating one.  If the
 517  * "flood" argument is set, don't send out ports with flooding disabled.
 518  */
 519 static int
 520 output_all(struct datapath *dp, struct buffer *buffer, int in_port, int flood)
 521 {
 522     struct sw_port *p;
 523     int prev_port;
 524
 525     prev_port = -1;
 526     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 527         if (port_no(dp, p) == in_port) {
 528             continue;
 529         }
 530         if (flood && p->flags & BRPF_NO_FLOOD) {
 531             continue;
 532         }
 533         if (prev_port != -1) {
 534             dp_output_port(dp, buffer_clone(buffer), in_port, prev_port);
 535         }
 536         prev_port = port_no(dp, p);
 537     }
 538     if (prev_port != -1)
 539         dp_output_port(dp, buffer, in_port, prev_port);
 540     else
 541         buffer_delete(buffer);
 542
 543     return 0;
 544 }
 545
 546 void
 547 output_packet(struct datapath *dp, struct buffer *buffer, int out_port)
 548 {
 549     if (out_port >= 0 && out_port < OFPP_MAX) {
 550         struct sw_port *p = &dp->ports[out_port];
 551         if (p->netdev != NULL && !(p->status & BRPS_PORT_DOWN)) {
 552             if (!netdev_send(p->netdev, buffer)) {
 553                 p->tx_packets++;
 554                 p->tx_bytes += buffer->size;
 555             } else {
 556                 p->tx_dropped++;
 557             }
 558             return;
 559         }
 560     }
 561
 562     buffer_delete(buffer);
 563     VLOG_DBG_RL(&rl, "can't forward to bad port %d\n", out_port);
 564 }
 565
 566 /* Takes ownership of 'buffer' and transmits it to 'out_port' on 'dp'.
 567  */
 568 void
 569 dp_output_port(struct datapath *dp, struct buffer *buffer,
 570                int in_port, int out_port)
 571 {
 572
 573     assert(buffer);
 574     if (out_port == OFPP_FLOOD) {
 575         output_all(dp, buffer, in_port, 1);
 576     } else if (out_port == OFPP_ALL) {
 577         output_all(dp, buffer, in_port, 0);
 578     } else if (out_port == OFPP_CONTROLLER) {
 579         dp_output_control(dp, buffer, in_port, 0, OFPR_ACTION);
 580     } else if (out_port == OFPP_IN_PORT) {
 581         output_packet(dp, buffer, in_port);
 582     } else if (out_port == OFPP_TABLE) {
 583                 if (run_flow_through_tables(dp, buffer, in_port)) {
 584                         buffer_delete(buffer);
 585         }
 586     } else {
 587         if (in_port == out_port) {
 588             VLOG_DBG_RL(&rl, "can't directly forward to input port");
 589             return;
 590         }
 591         output_packet(dp, buffer, out_port);
 592     }
 593 }
 594
 595 static void *
 596 make_openflow_reply(size_t openflow_len, uint8_t type,
 597                     const struct sender *sender, struct buffer **bufferp)
 598 {
 599     return make_openflow_xid(openflow_len, type, sender ? sender->xid : 0,
 600                              bufferp);
 601 }
 602
 603 static int
 604 send_openflow_buffer(struct datapath *dp, struct buffer *buffer,
 605                      const struct sender *sender)
 606 {
 607     struct remote *remote = sender ? sender->remote : dp->controller;
 608     struct rconn *rconn = remote->rconn;
 609     int retval;
 610
 611     update_openflow_length(buffer);
 612     retval = rconn_send_with_limit(rconn, buffer, &remote->n_txq, TXQ_LIMIT);
 613     if (retval) {
 614         VLOG_WARN_RL(&rl, "send to %s failed: %s",
 615                      rconn_get_name(rconn), strerror(retval));
 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_RL(&rl, "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_RL(&rl, "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 desc_stats_dump(struct datapath *dp, void *state,
1242                               struct buffer *buffer)
1243 {
1244     struct ofp_desc_stats *ods = buffer_put_uninit(buffer, sizeof *ods);
1245
1246     strncpy(ods->mfr_desc, &mfr_desc, sizeof ods->mfr_desc);
1247     strncpy(ods->hw_desc, &hw_desc, sizeof ods->hw_desc);
1248     strncpy(ods->sw_desc, &sw_desc, sizeof ods->sw_desc);
1249     strncpy(ods->serial_num, &serial_num, sizeof ods->serial_num);
1250
1251     return 0;
1252 }
1253
1254 struct flow_stats_state {
1255     int table_idx;
1256     struct sw_table_position position;
1257     struct ofp_flow_stats_request rq;
1258     time_t now;
1259
1260     struct buffer *buffer;
1261 };
1262
1263 #define MAX_FLOW_STATS_BYTES 4096
1264
1265 static int flow_stats_init(struct datapath *dp, const void *body, int body_len,
1266                            void **state)
1267 {
1268     const struct ofp_flow_stats_request *fsr = body;
1269     struct flow_stats_state *s = xmalloc(sizeof *s);
1270     s->table_idx = fsr->table_id == 0xff ? 0 : fsr->table_id;
1271     memset(&s->position, 0, sizeof s->position);
1272     s->rq = *fsr;
1273     *state = s;
1274     return 0;
1275 }
1276
1277 static int flow_stats_dump_callback(struct sw_flow *flow, void *private)
1278 {
1279     struct flow_stats_state *s = private;
1280     fill_flow_stats(s->buffer, flow, s->table_idx, s->now);
1281     return s->buffer->size >= MAX_FLOW_STATS_BYTES;
1282 }
1283
1284 static int flow_stats_dump(struct datapath *dp, void *state,
1285                            struct buffer *buffer)
1286 {
1287     struct flow_stats_state *s = state;
1288     struct sw_flow_key match_key;
1289
1290     flow_extract_match(&match_key, &s->rq.match);
1291     s->buffer = buffer;
1292     s->now = time_now();
1293     while (s->table_idx < dp->chain->n_tables
1294            && (s->rq.table_id == 0xff || s->rq.table_id == s->table_idx))
1295     {
1296         struct sw_table *table = dp->chain->tables[s->table_idx];
1297
1298         if (table->iterate(table, &match_key, &s->position,
1299                            flow_stats_dump_callback, s))
1300             break;
1301
1302         s->table_idx++;
1303         memset(&s->position, 0, sizeof s->position);
1304     }
1305     return s->buffer->size >= MAX_FLOW_STATS_BYTES;
1306 }
1307
1308 static void flow_stats_done(void *state)
1309 {
1310     free(state);
1311 }
1312
1313 struct aggregate_stats_state {
1314     struct ofp_aggregate_stats_request rq;
1315 };
1316
1317 static int aggregate_stats_init(struct datapath *dp,
1318                                 const void *body, int body_len,
1319                                 void **state)
1320 {
1321     const struct ofp_aggregate_stats_request *rq = body;
1322     struct aggregate_stats_state *s = xmalloc(sizeof *s);
1323     s->rq = *rq;
1324     *state = s;
1325     return 0;
1326 }
1327
1328 static int aggregate_stats_dump_callback(struct sw_flow *flow, void *private)
1329 {
1330     struct ofp_aggregate_stats_reply *rpy = private;
1331     rpy->packet_count += flow->packet_count;
1332     rpy->byte_count += flow->byte_count;
1333     rpy->flow_count++;
1334     return 0;
1335 }
1336
1337 static int aggregate_stats_dump(struct datapath *dp, void *state,
1338                                 struct buffer *buffer)
1339 {
1340     struct aggregate_stats_state *s = state;
1341     struct ofp_aggregate_stats_request *rq = &s->rq;
1342     struct ofp_aggregate_stats_reply *rpy;
1343     struct sw_table_position position;
1344     struct sw_flow_key match_key;
1345     int table_idx;
1346
1347     rpy = buffer_put_uninit(buffer, sizeof *rpy);
1348     memset(rpy, 0, sizeof *rpy);
1349
1350     flow_extract_match(&match_key, &rq->match);
1351     table_idx = rq->table_id == 0xff ? 0 : rq->table_id;
1352     memset(&position, 0, sizeof position);
1353     while (table_idx < dp->chain->n_tables
1354            && (rq->table_id == 0xff || rq->table_id == table_idx))
1355     {
1356         struct sw_table *table = dp->chain->tables[table_idx];
1357         int error;
1358
1359         error = table->iterate(table, &match_key, &position,
1360                                aggregate_stats_dump_callback, rpy);
1361         if (error)
1362             return error;
1363
1364         table_idx++;
1365         memset(&position, 0, sizeof position);
1366     }
1367
1368     rpy->packet_count = htonll(rpy->packet_count);
1369     rpy->byte_count = htonll(rpy->byte_count);
1370     rpy->flow_count = htonl(rpy->flow_count);
1371     return 0;
1372 }
1373
1374 static void aggregate_stats_done(void *state)
1375 {
1376     free(state);
1377 }
1378
1379 static int table_stats_dump(struct datapath *dp, void *state,
1380                             struct buffer *buffer)
1381 {
1382     int i;
1383     for (i = 0; i < dp->chain->n_tables; i++) {
1384         struct ofp_table_stats *ots = buffer_put_uninit(buffer, sizeof *ots);
1385         struct sw_table_stats stats;
1386         dp->chain->tables[i]->stats(dp->chain->tables[i], &stats);
1387         strncpy(ots->name, stats.name, sizeof ots->name);
1388         ots->table_id = i;
1389         memset(ots->pad, 0, sizeof ots->pad);
1390         ots->max_entries = htonl(stats.max_flows);
1391         ots->active_count = htonl(stats.n_flows);
1392         ots->matched_count = htonll(stats.n_matched);
1393     }
1394     return 0;
1395 }
1396
1397 struct port_stats_state {
1398     int port;
1399 };
1400
1401 static int port_stats_init(struct datapath *dp, const void *body, int body_len,
1402                void **state)
1403 {
1404     struct port_stats_state *s = xmalloc(sizeof *s);
1405     s->port = 0;
1406     *state = s;
1407     return 0;
1408 }
1409
1410 static int port_stats_dump(struct datapath *dp, void *state,
1411                            struct buffer *buffer)
1412 {
1413     struct port_stats_state *s = state;
1414     int i;
1415
1416     for (i = s->port; i < OFPP_MAX; i++) {
1417         struct sw_port *p = &dp->ports[i];
1418         struct ofp_port_stats *ops;
1419         if (!p->netdev) {
1420             continue;
1421         }
1422         ops = buffer_put_uninit(buffer, sizeof *ops);
1423         ops->port_no = htons(port_no(dp, p));
1424         memset(ops->pad, 0, sizeof ops->pad);
1425         ops->rx_packets   = htonll(p->rx_packets);
1426         ops->tx_packets   = htonll(p->tx_packets);
1427         ops->rx_bytes     = htonll(p->rx_bytes);
1428         ops->tx_bytes     = htonll(p->tx_bytes);
1429         ops->rx_dropped   = htonll(-1);
1430         ops->tx_dropped   = htonll(p->tx_dropped);
1431         ops->rx_errors    = htonll(-1);
1432         ops->tx_errors    = htonll(-1);
1433         ops->rx_frame_err = htonll(-1);
1434         ops->rx_over_err  = htonll(-1);
1435         ops->rx_crc_err   = htonll(-1);
1436         ops->collisions   = htonll(-1);
1437         ops++;
1438     }
1439     s->port = i;
1440     return 0;
1441 }
1442
1443 static void port_stats_done(void *state)
1444 {
1445     free(state);
1446 }
1447
1448 struct stats_type {
1449     /* Minimum and maximum acceptable number of bytes in body member of
1450      * struct ofp_stats_request. */
1451     size_t min_body, max_body;
1452
1453     /* Prepares to dump some kind of statistics on 'dp'.  'body' and
1454      * 'body_len' are the 'body' member of the struct ofp_stats_request.
1455      * Returns zero if successful, otherwise a negative error code.
1456      * May initialize '*state' to state information.  May be null if no
1457      * initialization is required.*/
1458     int (*init)(struct datapath *dp, const void *body, int body_len,
1459             void **state);
1460
1461     /* Appends statistics for 'dp' to 'buffer', which initially contains a
1462      * struct ofp_stats_reply.  On success, it should return 1 if it should be
1463      * called again later with another buffer, 0 if it is done, or a negative
1464      * errno value on failure. */
1465     int (*dump)(struct datapath *dp, void *state, struct buffer *buffer);
1466
1467     /* Cleans any state created by the init or dump functions.  May be null
1468      * if no cleanup is required. */
1469     void (*done)(void *state);
1470 };
1471
1472 static const struct stats_type stats[] = {
1473     [OFPST_DESC] = {
1474         0,
1475         0,
1476         NULL,
1477         desc_stats_dump,
1478         NULL
1479     },
1480     [OFPST_FLOW] = {
1481         sizeof(struct ofp_flow_stats_request),
1482         sizeof(struct ofp_flow_stats_request),
1483         flow_stats_init,
1484         flow_stats_dump,
1485         flow_stats_done
1486     },
1487     [OFPST_AGGREGATE] = {
1488         sizeof(struct ofp_aggregate_stats_request),
1489         sizeof(struct ofp_aggregate_stats_request),
1490         aggregate_stats_init,
1491         aggregate_stats_dump,
1492         aggregate_stats_done
1493     },
1494     [OFPST_TABLE] = {
1495         0,
1496         0,
1497         NULL,
1498         table_stats_dump,
1499         NULL
1500     },
1501     [OFPST_PORT] = {
1502         0,
1503         0,
1504         port_stats_init,
1505         port_stats_dump,
1506         port_stats_done
1507     },
1508 };
1509
1510 struct stats_dump_cb {
1511     bool done;
1512     struct ofp_stats_request *rq;
1513     struct sender sender;
1514     const struct stats_type *s;
1515     void *state;
1516 };
1517
1518 static int
1519 stats_dump(struct datapath *dp, void *cb_)
1520 {
1521     struct stats_dump_cb *cb = cb_;
1522     struct ofp_stats_reply *osr;
1523     struct buffer *buffer;
1524     int err;
1525
1526     if (cb->done) {
1527         return 0;
1528     }
1529
1530     osr = make_openflow_reply(sizeof *osr, OFPT_STATS_REPLY, &cb->sender,
1531                               &buffer);
1532     osr->type = htons(cb->s - stats);
1533     osr->flags = 0;
1534
1535     err = cb->s->dump(dp, cb->state, buffer);
1536     if (err >= 0) {
1537         int err2;
1538         if (!err) {
1539             cb->done = true;
1540         } else {
1541             /* Buffer might have been reallocated, so find our data again. */
1542             osr = buffer_at_assert(buffer, 0, sizeof *osr);
1543             osr->flags = ntohs(OFPSF_REPLY_MORE);
1544         }
1545         err2 = send_openflow_buffer(dp, buffer, &cb->sender);
1546         if (err2) {
1547             err = err2;
1548         }
1549     }
1550
1551     return err;
1552 }
1553
1554 static void
1555 stats_done(void *cb_)
1556 {
1557     struct stats_dump_cb *cb = cb_;
1558     if (cb) {
1559         if (cb->s->done) {
1560             cb->s->done(cb->state);
1561         }
1562         free(cb);
1563     }
1564 }
1565
1566 static int
1567 recv_stats_request(struct datapath *dp, const struct sender *sender,
1568                    const void *oh)
1569 {
1570     const struct ofp_stats_request *rq = oh;
1571     size_t rq_len = ntohs(rq->header.length);
1572     struct stats_dump_cb *cb;
1573     int type, body_len;
1574     int err;
1575
1576     type = ntohs(rq->type);
1577     if (type >= ARRAY_SIZE(stats) || !stats[type].dump) {
1578         VLOG_WARN_RL(&rl, "received stats request of unknown type %d", type);
1579         return -EINVAL;
1580     }
1581
1582     cb = xmalloc(sizeof *cb);
1583     cb->done = false;
1584     cb->rq = xmemdup(rq, rq_len);
1585     cb->sender = *sender;
1586     cb->s = &stats[type];
1587     cb->state = NULL;
1588
1589     body_len = rq_len - offsetof(struct ofp_stats_request, body);
1590     if (body_len < cb->s->min_body || body_len > cb->s->max_body) {
1591         VLOG_WARN_RL(&rl, "stats request type %d with bad body length %d",
1592                      type, body_len);
1593         err = -EINVAL;
1594         goto error;
1595     }
1596
1597     if (cb->s->init) {
1598         err = cb->s->init(dp, rq->body, body_len, &cb->state);
1599         if (err) {
1600             VLOG_WARN_RL(&rl,
1601                          "failed initialization of stats request type %d: %s",
1602                          type, strerror(-err));
1603             goto error;
1604         }
1605     }
1606
1607     remote_start_dump(sender->remote, stats_dump, stats_done, cb);
1608     return 0;
1609
1610 error:
1611     free(cb->rq);
1612     free(cb);
1613     return err;
1614 }
1615
1616 static int
1617 recv_echo_request(struct datapath *dp, const struct sender *sender,
1618                   const void *oh)
1619 {
1620     return send_openflow_buffer(dp, make_echo_reply(oh), sender);
1621 }
1622
1623 static int
1624 recv_echo_reply(struct datapath *dp UNUSED, const struct sender *sender UNUSED,
1625                   const void *oh UNUSED)
1626 {
1627     return 0;
1628 }
1629
1630 /* 'msg', which is 'length' bytes long, was received from the control path.
1631  * Apply it to 'chain'. */
1632 int
1633 fwd_control_input(struct datapath *dp, const struct sender *sender,
1634                   const void *msg, size_t length)
1635 {
1636     struct openflow_packet {
1637         size_t min_size;
1638         int (*handler)(struct datapath *, const struct sender *, const void *);
1639     };
1640
1641     static const struct openflow_packet packets[] = {
1642         [OFPT_FEATURES_REQUEST] = {
1643             sizeof (struct ofp_header),
1644             recv_features_request,
1645         },
1646         [OFPT_GET_CONFIG_REQUEST] = {
1647             sizeof (struct ofp_header),
1648             recv_get_config_request,
1649         },
1650         [OFPT_SET_CONFIG] = {
1651             sizeof (struct ofp_switch_config),
1652             recv_set_config,
1653         },
1654         [OFPT_PACKET_OUT] = {
1655             sizeof (struct ofp_packet_out),
1656             recv_packet_out,
1657         },
1658         [OFPT_FLOW_MOD] = {
1659             sizeof (struct ofp_flow_mod),
1660             recv_flow,
1661         },
1662         [OFPT_PORT_MOD] = {
1663             sizeof (struct ofp_port_mod),
1664             recv_port_mod,
1665         },
1666         [OFPT_STATS_REQUEST] = {
1667             sizeof (struct ofp_stats_request),
1668             recv_stats_request,
1669         },
1670         [OFPT_ECHO_REQUEST] = {
1671             sizeof (struct ofp_header),
1672             recv_echo_request,
1673         },
1674         [OFPT_ECHO_REPLY] = {
1675             sizeof (struct ofp_header),
1676             recv_echo_reply,
1677         },
1678     };
1679
1680     const struct openflow_packet *pkt;
1681     struct ofp_header *oh;
1682
1683     oh = (struct ofp_header *) msg;
1684     assert(oh->version == OFP_VERSION);
1685     if (oh->type >= ARRAY_SIZE(packets) || ntohs(oh->length) > length)
1686         return -EINVAL;
1687
1688     pkt = &packets[oh->type];
1689     if (!pkt->handler)
1690         return -ENOSYS;
1691     if (length < pkt->min_size)
1692         return -EFAULT;
1693
1694     return pkt->handler(dp, sender, msg);
1695 }
1696 \f
1697 /* Packet buffering. */
1698
1699 #define OVERWRITE_SECS  1
1700
1701 struct packet_buffer {
1702     struct buffer *buffer;
1703     uint32_t cookie;
1704     time_t timeout;
1705 };
1706
1707 static struct packet_buffer buffers[N_PKT_BUFFERS];
1708 static unsigned int buffer_idx;
1709
1710 uint32_t save_buffer(struct buffer *buffer)
1711 {
1712     struct packet_buffer *p;
1713     uint32_t id;
1714
1715     buffer_idx = (buffer_idx + 1) & PKT_BUFFER_MASK;
1716     p = &buffers[buffer_idx];
1717     if (p->buffer) {
1718         /* Don't buffer packet if existing entry is less than
1719          * OVERWRITE_SECS old. */
1720         if (time_now() < p->timeout) { /* FIXME */
1721             return -1;
1722         } else {
1723             buffer_delete(p->buffer);
1724         }
1725     }
1726     /* Don't use maximum cookie value since the all-bits-1 id is
1727      * special. */
1728     if (++p->cookie >= (1u << PKT_COOKIE_BITS) - 1)
1729         p->cookie = 0;
1730     p->buffer = buffer_clone(buffer);      /* FIXME */
1731     p->timeout = time_now() + OVERWRITE_SECS; /* FIXME */
1732     id = buffer_idx | (p->cookie << PKT_BUFFER_BITS);
1733
1734     return id;
1735 }
1736
1737 static struct buffer *retrieve_buffer(uint32_t id)
1738 {
1739     struct buffer *buffer = NULL;
1740     struct packet_buffer *p;
1741
1742     p = &buffers[id & PKT_BUFFER_MASK];
1743     if (p->cookie == id >> PKT_BUFFER_BITS) {
1744         buffer = p->buffer;
1745         p->buffer = NULL;
1746     } else {
1747         printf("cookie mismatch: %x != %x\n",
1748                id >> PKT_BUFFER_BITS, p->cookie);
1749     }
1750
1751     return buffer;
1752 }
1753
1754 static void discard_buffer(uint32_t id)
1755 {
1756     struct packet_buffer *p;
1757
1758     p = &buffers[id & PKT_BUFFER_MASK];
1759     if (p->cookie == id >> PKT_BUFFER_BITS) {
1760         buffer_delete(p->buffer);
1761         p->buffer = NULL;
1762     }
1763 }