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