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 <stdlib.h>
  39 #include <string.h>
  40 #include "buffer.h"
  41 #include "chain.h"
  42 #include "flow.h"
  43 #include "netdev.h"
  44 #include "packets.h"
  45 #include "poll-loop.h"
  46 #include "rconn.h"
  47 #include "vconn.h"
  48 #include "table.h"
  49 #include "xtoxll.h"
  50
  51 #define THIS_MODULE VLM_datapath
  52 #include "vlog.h"
  53
  54 #define BRIDGE_PORT_NO_FLOOD    0x00000001
  55
  56 /* Capabilities supported by this implementation. */
  57 #define OFP_SUPPORTED_CAPABILITIES (OFPC_MULTI_PHY_TX)
  58
  59 /* Actions supported by this implementation. */
  60 #define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT)         \
  61                                 | (1 << OFPAT_SET_DL_VLAN)  \
  62                                 | (1 << OFPAT_SET_DL_SRC)   \
  63                                 | (1 << OFPAT_SET_DL_DST)   \
  64                                 | (1 << OFPAT_SET_NW_SRC)   \
  65                                 | (1 << OFPAT_SET_NW_DST)   \
  66                                 | (1 << OFPAT_SET_TP_SRC)   \
  67                                 | (1 << OFPAT_SET_TP_DST) )
  68
  69 struct sw_port {
  70     uint32_t flags;
  71     struct datapath *dp;
  72     struct netdev *netdev;
  73     struct list node; /* Element in datapath.ports. */
  74     unsigned long long int rx_count, tx_count, drop_count;
  75 };
  76
  77 /* A connection to a controller or a management device. */
  78 struct remote {
  79     struct list node;
  80     struct rconn *rconn;
  81 };
  82
  83 /* The origin of a received OpenFlow message, to enable sending a reply. */
  84 struct sender {
  85     struct remote *remote;      /* The device that sent the message. */
  86     uint32_t xid;               /* The OpenFlow transaction ID. */
  87 };
  88
  89 struct datapath {
  90     /* Remote connections. */
  91     struct remote *controller;  /* Connection to controller. */
  92     struct list remotes;        /* All connections (including controller). */
  93     struct vconn *listen_vconn;
  94
  95     time_t last_timeout;
  96
  97     /* Unique identifier for this datapath */
  98     uint64_t  id;
  99
 100     struct sw_chain *chain;  /* Forwarding rules. */
 101
 102     struct ofp_switch_config config;
 103
 104     /* Switch ports. */
 105     struct sw_port ports[OFPP_MAX];
 106     struct list port_list; /* List of ports, for flooding. */
 107 };
 108
 109 static struct remote *remote_create(struct datapath *, struct rconn *);
 110 static void remote_run(struct datapath *, struct remote *);
 111 static void remote_wait(struct remote *);
 112 static void remote_destroy(struct remote *);
 113
 114 void dp_output_port(struct datapath *, struct buffer *,
 115                     int in_port, int out_port);
 116 void dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp);
 117 void dp_output_control(struct datapath *, struct buffer *, int in_port,
 118                        size_t max_len, int reason);
 119 static void send_flow_expired(struct datapath *, struct sw_flow *);
 120 static void send_port_status(struct sw_port *p, uint8_t status);
 121 static void del_switch_port(struct sw_port *p);
 122 static void execute_actions(struct datapath *, struct buffer *,
 123                             int in_port, const struct sw_flow_key *,
 124                             const struct ofp_action *, int n_actions);
 125 static void modify_vlan(struct buffer *buffer, const struct sw_flow_key *key,
 126                         const struct ofp_action *a);
 127 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 128                       uint8_t nw_proto, const struct ofp_action *a);
 129 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 130                           uint8_t nw_proto, const struct ofp_action *a);
 131
 132 /* Buffers are identified to userspace by a 31-bit opaque ID.  We divide the ID
 133  * into a buffer number (low bits) and a cookie (high bits).  The buffer number
 134  * is an index into an array of buffers.  The cookie distinguishes between
 135  * different packets that have occupied a single buffer.  Thus, the more
 136  * buffers we have, the lower-quality the cookie... */
 137 #define PKT_BUFFER_BITS 8
 138 #define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
 139 #define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
 140
 141 #define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
 142
 143 void fwd_port_input(struct datapath *, struct buffer *, int in_port);
 144 int fwd_control_input(struct datapath *, const struct sender *,
 145                       const void *, size_t);
 146
 147 uint32_t save_buffer(struct buffer *);
 148 static struct buffer *retrieve_buffer(uint32_t id);
 149 static void discard_buffer(uint32_t id);
 150
 151 static int port_no(struct datapath *dp, struct sw_port *p)
 152 {
 153     assert(p >= dp->ports && p < &dp->ports[ARRAY_SIZE(dp->ports)]);
 154     return p - dp->ports;
 155 }
 156
 157 /* Generates a unique datapath id.  It incorporates the datapath index
 158  * and a hardware address, if available.  If not, it generates a random
 159  * one.
 160  */
 161 static uint64_t
 162 gen_datapath_id(void)
 163 {
 164     /* Choose a random datapath id. */
 165     uint64_t id = 0;
 166     int i;
 167
 168     srand(time(0));
 169
 170     for (i = 0; i < ETH_ADDR_LEN; i++) {
 171         id |= (uint64_t)(rand() & 0xff) << (8*(ETH_ADDR_LEN-1 - i));
 172     }
 173
 174     return id;
 175 }
 176
 177 int
 178 dp_new(struct datapath **dp_, uint64_t dpid, struct rconn *rconn)
 179 {
 180     struct datapath *dp;
 181
 182     dp = calloc(1, sizeof *dp);
 183     if (!dp) {
 184         return ENOMEM;
 185     }
 186
 187     dp->last_timeout = time(0);
 188     list_init(&dp->remotes);
 189     dp->controller = remote_create(dp, rconn);
 190     dp->listen_vconn = NULL;
 191     dp->id = dpid <= UINT64_C(0xffffffffffff) ? dpid : gen_datapath_id();
 192     dp->chain = chain_create();
 193     if (!dp->chain) {
 194         VLOG_ERR("could not create chain");
 195         free(dp);
 196         return ENOMEM;
 197     }
 198
 199     list_init(&dp->port_list);
 200     dp->config.flags = 0;
 201     dp->config.miss_send_len = htons(OFP_DEFAULT_MISS_SEND_LEN);
 202     *dp_ = dp;
 203     return 0;
 204 }
 205
 206 int
 207 dp_add_port(struct datapath *dp, const char *name)
 208 {
 209     struct netdev *netdev;
 210     struct sw_port *p;
 211     int error;
 212
 213     error = netdev_open(name, &netdev);
 214     if (error) {
 215         return error;
 216     }
 217
 218     for (p = dp->ports; ; p++) {
 219         if (p >= &dp->ports[ARRAY_SIZE(dp->ports)]) {
 220             return EXFULL;
 221         } else if (!p->netdev) {
 222             break;
 223         }
 224     }
 225
 226     p->dp = dp;
 227     p->netdev = netdev;
 228     p->tx_count = 0;
 229     p->rx_count = 0;
 230     p->drop_count = 0;
 231     list_push_back(&dp->port_list, &p->node);
 232
 233     /* Notify the ctlpath that this port has been added */
 234     send_port_status(p, OFPPR_ADD);
 235
 236     return 0;
 237 }
 238
 239 void
 240 dp_add_listen_vconn(struct datapath *dp, struct vconn *listen_vconn)
 241 {
 242     assert(!dp->listen_vconn);
 243     dp->listen_vconn = listen_vconn;
 244 }
 245
 246 void
 247 dp_run(struct datapath *dp)
 248 {
 249     time_t now = time(0);
 250     struct sw_port *p, *pn;
 251     struct remote *r, *rn;
 252     struct buffer *buffer = NULL;
 253
 254     if (now != dp->last_timeout) {
 255         struct list deleted = LIST_INITIALIZER(&deleted);
 256         struct sw_flow *f, *n;
 257
 258         chain_timeout(dp->chain, &deleted);
 259         LIST_FOR_EACH_SAFE (f, n, struct sw_flow, node, &deleted) {
 260             send_flow_expired(dp, f);
 261             list_remove(&f->node);
 262             flow_free(f);
 263         }
 264         dp->last_timeout = now;
 265     }
 266     poll_timer_wait(1000);
 267
 268     LIST_FOR_EACH_SAFE (p, pn, struct sw_port, node, &dp->port_list) {
 269         int error;
 270
 271         if (!buffer) {
 272             /* Allocate buffer with some headroom to add headers in forwarding
 273              * to the controller or adding a vlan tag, plus an extra 2 bytes to
 274              * allow IP headers to be aligned on a 4-byte boundary.  */
 275             const int headroom = 128 + 2;
 276             const int hard_header = VLAN_ETH_HEADER_LEN;
 277             const int mtu = netdev_get_mtu(p->netdev);
 278             buffer = buffer_new(headroom + hard_header + mtu);
 279             buffer->data += headroom;
 280         }
 281         error = netdev_recv(p->netdev, buffer);
 282         if (!error) {
 283             p->rx_count++;
 284             fwd_port_input(dp, buffer, port_no(dp, p));
 285             buffer = NULL;
 286         } else if (error != EAGAIN) {
 287             VLOG_ERR("Error receiving data from %s: %s",
 288                      netdev_get_name(p->netdev), strerror(error));
 289             del_switch_port(p);
 290         }
 291     }
 292     buffer_delete(buffer);
 293
 294     /* Talk to remotes. */
 295     LIST_FOR_EACH_SAFE (r, rn, struct remote, node, &dp->remotes) {
 296         remote_run(dp, r);
 297     }
 298     if (dp->listen_vconn) {
 299         for (;;) {
 300             struct vconn *new_vconn;
 301             int retval;
 302
 303             retval = vconn_accept(dp->listen_vconn, &new_vconn);
 304             if (retval) {
 305                 if (retval != EAGAIN) {
 306                     VLOG_WARN("accept failed (%s)", strerror(retval));
 307                 }
 308                 break;
 309             }
 310             remote_create(dp, rconn_new_from_vconn("passive", 128, new_vconn));
 311         }
 312     }
 313 }
 314
 315 static void
 316 remote_run(struct datapath *dp, struct remote *r)
 317 {
 318     int i;
 319
 320     rconn_run(r->rconn);
 321
 322     /* Process a number of commands from the remote, but cap them at a
 323      * reasonable number so that other processing doesn't starve. */
 324     for (i = 0; i < 50; i++) {
 325         struct buffer *buffer;
 326         struct ofp_header *oh;
 327
 328         buffer = rconn_recv(r->rconn);
 329         if (!buffer) {
 330             break;
 331         }
 332
 333         if (buffer->size >= sizeof *oh) {
 334             struct sender sender;
 335
 336             oh = buffer->data;
 337             sender.remote = r;
 338             sender.xid = oh->xid;
 339             fwd_control_input(dp, &sender, buffer->data, buffer->size);
 340         } else {
 341             VLOG_WARN("received too-short OpenFlow message");
 342         }
 343         buffer_delete(buffer);
 344     }
 345
 346     if (!rconn_is_alive(r->rconn)) {
 347         remote_destroy(r);
 348     }
 349 }
 350
 351 static void
 352 remote_wait(struct remote *r)
 353 {
 354     rconn_run_wait(r->rconn);
 355     rconn_recv_wait(r->rconn);
 356 }
 357
 358 static void
 359 remote_destroy(struct remote *r)
 360 {
 361     if (r) {
 362         list_remove(&r->node);
 363         rconn_destroy(r->rconn);
 364         free(r);
 365     }
 366 }
 367
 368 static struct remote *
 369 remote_create(struct datapath *dp, struct rconn *rconn)
 370 {
 371     struct remote *remote = xmalloc(sizeof *remote);
 372     list_push_back(&dp->remotes, &remote->node);
 373     remote->rconn = rconn;
 374     return remote;
 375 }
 376
 377 void
 378 dp_wait(struct datapath *dp)
 379 {
 380     struct sw_port *p;
 381     struct remote *r;
 382
 383     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 384         netdev_recv_wait(p->netdev);
 385     }
 386     LIST_FOR_EACH (r, struct remote, node, &dp->remotes) {
 387         remote_wait(r);
 388     }
 389     if (dp->listen_vconn) {
 390         vconn_accept_wait(dp->listen_vconn);
 391     }
 392 }
 393
 394 /* Delete 'p' from switch. */
 395 static void
 396 del_switch_port(struct sw_port *p)
 397 {
 398     send_port_status(p, OFPPR_DELETE);
 399     netdev_close(p->netdev);
 400     p->netdev = NULL;
 401     list_remove(&p->node);
 402 }
 403
 404 void
 405 dp_destroy(struct datapath *dp)
 406 {
 407     struct sw_port *p, *n;
 408
 409     if (!dp) {
 410         return;
 411     }
 412
 413     LIST_FOR_EACH_SAFE (p, n, struct sw_port, node, &dp->port_list) {
 414         del_switch_port(p);
 415     }
 416     chain_destroy(dp->chain);
 417     free(dp);
 418 }
 419
 420 static int
 421 flood(struct datapath *dp, struct buffer *buffer, int in_port)
 422 {
 423     struct sw_port *p;
 424     int prev_port;
 425
 426     prev_port = -1;
 427     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 428         if (port_no(dp, p) == in_port || p->flags & BRIDGE_PORT_NO_FLOOD) {
 429             continue;
 430         }
 431         if (prev_port != -1) {
 432             dp_output_port(dp, buffer_clone(buffer), in_port, prev_port);
 433         }
 434         prev_port = port_no(dp, p);
 435     }
 436     if (prev_port != -1)
 437         dp_output_port(dp, buffer, in_port, prev_port);
 438     else
 439         buffer_delete(buffer);
 440
 441     return 0;
 442 }
 443
 444 void
 445 output_packet(struct datapath *dp, struct buffer *buffer, int out_port)
 446 {
 447     if (out_port >= 0 && out_port < OFPP_MAX) {
 448         struct sw_port *p = &dp->ports[out_port];
 449         if (p->netdev != NULL) {
 450             if (!netdev_send(p->netdev, buffer)) {
 451                 p->tx_count++;
 452             } else {
 453                 p->drop_count++;
 454             }
 455             return;
 456         }
 457     }
 458
 459     buffer_delete(buffer);
 460     /* FIXME: ratelimit */
 461     VLOG_DBG("can't forward to bad port %d\n", out_port);
 462 }
 463
 464 /* Takes ownership of 'buffer' and transmits it to 'out_port' on 'dp'.
 465  */
 466 void
 467 dp_output_port(struct datapath *dp, struct buffer *buffer,
 468                int in_port, int out_port)
 469 {
 470
 471     assert(buffer);
 472     if (out_port == OFPP_FLOOD) {
 473         flood(dp, buffer, in_port);
 474     } else if (out_port == OFPP_CONTROLLER) {
 475         dp_output_control(dp, buffer, in_port, 0, OFPR_ACTION);
 476     } else if (out_port == OFPP_TABLE) {
 477         struct sw_flow_key key;
 478         struct sw_flow *flow;
 479
 480         key.wildcards = 0;
 481         flow_extract(buffer, in_port, &key.flow);
 482         flow = chain_lookup(dp->chain, &key);
 483         if (flow != NULL) {
 484             flow_used(flow, buffer);
 485             execute_actions(dp, buffer, in_port, &key,
 486                             flow->actions, flow->n_actions);
 487         }
 488     } else {
 489         output_packet(dp, buffer, out_port);
 490     }
 491 }
 492
 493 static void *
 494 alloc_openflow_buffer(struct datapath *dp, size_t openflow_len, uint8_t type,
 495                       const struct sender *sender, struct buffer **bufferp)
 496 {
 497         struct buffer *buffer;
 498         struct ofp_header *oh;
 499
 500         buffer = *bufferp = buffer_new(openflow_len);
 501         oh = buffer_put_uninit(buffer, openflow_len);
 502         oh->version = OFP_VERSION;
 503         oh->type = type;
 504         oh->length = 0;             /* Filled in by send_openflow_buffer(). */
 505         oh->xid = sender ? sender->xid : 0;
 506         return oh;
 507 }
 508
 509 static int
 510 send_openflow_buffer(struct datapath *dp, struct buffer *buffer,
 511                      const struct sender *sender)
 512 {
 513     struct remote *remote = sender ? sender->remote : dp->controller;
 514     struct rconn *rconn = remote->rconn;
 515     struct ofp_header *oh;
 516     int retval;
 517
 518     oh = buffer_at_assert(buffer, 0, sizeof *oh);
 519     oh->length = htons(buffer->size);
 520
 521     retval = rconn_send(rconn, buffer);
 522     if (retval) {
 523         VLOG_WARN("send to %s failed: %s",
 524                   rconn_get_name(rconn), strerror(retval));
 525         buffer_delete(buffer);
 526     }
 527     return retval;
 528 }
 529
 530 /* Takes ownership of 'buffer' and transmits it to 'dp''s controller.  If the
 531  * packet can be saved in a buffer, then only the first max_len bytes of
 532  * 'buffer' are sent; otherwise, all of 'buffer' is sent.  'reason' indicates
 533  * why 'buffer' is being sent. 'max_len' sets the maximum number of bytes that
 534  * the caller wants to be sent; a value of 0 indicates the entire packet should
 535  * be sent. */
 536 void
 537 dp_output_control(struct datapath *dp, struct buffer *buffer, int in_port,
 538                   size_t max_len, int reason)
 539 {
 540     struct ofp_packet_in *opi;
 541     size_t total_len;
 542     uint32_t buffer_id;
 543
 544     buffer_id = save_buffer(buffer);
 545     total_len = buffer->size;
 546     if (buffer_id != UINT32_MAX && buffer->size > max_len) {
 547         buffer->size = max_len;
 548     }
 549
 550     opi = buffer_push_uninit(buffer, offsetof(struct ofp_packet_in, data));
 551     opi->header.version = OFP_VERSION;
 552     opi->header.type    = OFPT_PACKET_IN;
 553     opi->header.length  = htons(buffer->size);
 554     opi->header.xid     = htonl(0);
 555     opi->buffer_id      = htonl(buffer_id);
 556     opi->total_len      = htons(total_len);
 557     opi->in_port        = htons(in_port);
 558     opi->reason         = reason;
 559     opi->pad            = 0;
 560     send_openflow_buffer(dp, buffer, NULL);
 561 }
 562
 563 static void fill_port_desc(struct datapath *dp, struct sw_port *p,
 564                            struct ofp_phy_port *desc)
 565 {
 566     desc->port_no = htons(port_no(dp, p));
 567     strncpy((char *) desc->name, netdev_get_name(p->netdev),
 568             sizeof desc->name);
 569     desc->name[sizeof desc->name - 1] = '\0';
 570     memcpy(desc->hw_addr, netdev_get_etheraddr(p->netdev), ETH_ADDR_LEN);
 571     desc->flags = htonl(p->flags);
 572     desc->features = htonl(netdev_get_features(p->netdev));
 573     desc->speed = htonl(netdev_get_speed(p->netdev));
 574 }
 575
 576 static void
 577 dp_send_features_reply(struct datapath *dp, const struct sender *sender)
 578 {
 579     struct buffer *buffer;
 580     struct ofp_switch_features *ofr;
 581     struct sw_port *p;
 582
 583     ofr = alloc_openflow_buffer(dp, sizeof *ofr, OFPT_FEATURES_REPLY,
 584                                 sender, &buffer);
 585     ofr->datapath_id    = htonll(dp->id);
 586     ofr->n_exact        = htonl(2 * TABLE_HASH_MAX_FLOWS);
 587     ofr->n_compression  = 0;         /* Not supported */
 588     ofr->n_general      = htonl(TABLE_LINEAR_MAX_FLOWS);
 589     ofr->buffer_mb      = htonl(UINT32_MAX);
 590     ofr->n_buffers      = htonl(N_PKT_BUFFERS);
 591     ofr->capabilities   = htonl(OFP_SUPPORTED_CAPABILITIES);
 592     ofr->actions        = htonl(OFP_SUPPORTED_ACTIONS);
 593     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 594         struct ofp_phy_port *opp = buffer_put_uninit(buffer, sizeof *opp);
 595         memset(opp, 0, sizeof *opp);
 596         fill_port_desc(dp, p, opp);
 597     }
 598     send_openflow_buffer(dp, buffer, sender);
 599 }
 600
 601 void
 602 dp_update_port_flags(struct datapath *dp, const struct ofp_phy_port *opp)
 603 {
 604     struct sw_port *p;
 605
 606     p = &dp->ports[htons(opp->port_no)];
 607
 608     /* Make sure the port id hasn't changed since this was sent */
 609     if (!p || memcmp(opp->hw_addr, netdev_get_etheraddr(p->netdev),
 610                      ETH_ADDR_LEN) != 0)
 611         return;
 612
 613     p->flags = htonl(opp->flags);
 614 }
 615
 616 static void
 617 send_port_status(struct sw_port *p, uint8_t status)
 618 {
 619     struct buffer *buffer;
 620     struct ofp_port_status *ops;
 621     ops = alloc_openflow_buffer(p->dp, sizeof *ops, OFPT_PORT_STATUS, NULL,
 622                                 &buffer);
 623     ops->reason         = status;
 624     fill_port_desc(p->dp, p, &ops->desc);
 625     send_openflow_buffer(p->dp, buffer, NULL);
 626 }
 627
 628 void
 629 send_flow_expired(struct datapath *dp, struct sw_flow *flow)
 630 {
 631     struct buffer *buffer;
 632     struct ofp_flow_expired *ofe;
 633     ofe = alloc_openflow_buffer(dp, sizeof *ofe, OFPT_FLOW_EXPIRED, NULL,
 634                                 &buffer);
 635     flow_fill_match(&ofe->match, &flow->key);
 636     ofe->duration   = htonl(flow->timeout - flow->max_idle - flow->created);
 637     ofe->packet_count   = htonll(flow->packet_count);
 638     ofe->byte_count     = htonll(flow->byte_count);
 639     send_openflow_buffer(dp, buffer, NULL);
 640 }
 641
 642 void
 643 dp_send_error_msg(struct datapath *dp, const struct sender *sender,
 644         uint16_t type, uint16_t code, const uint8_t *data, size_t len)
 645 {
 646     struct buffer *buffer;
 647     struct ofp_error_msg *oem;
 648     oem = alloc_openflow_buffer(dp, sizeof(*oem)+len, OFPT_ERROR_MSG,
 649                                 sender, &buffer);
 650     oem->type = htons(type);
 651     oem->code = htons(code);
 652     memcpy(oem->data, data, len);
 653     send_openflow_buffer(dp, buffer, sender);
 654 }
 655
 656 static void
 657 fill_flow_stats(struct ofp_flow_stats *ofs, struct sw_flow *flow,
 658                 int table_idx, time_t now)
 659 {
 660         ofs->match.wildcards = htons(flow->key.wildcards);
 661         ofs->match.in_port   = flow->key.flow.in_port;
 662         memcpy(ofs->match.dl_src, flow->key.flow.dl_src, ETH_ADDR_LEN);
 663         memcpy(ofs->match.dl_dst, flow->key.flow.dl_dst, ETH_ADDR_LEN);
 664         ofs->match.dl_vlan   = flow->key.flow.dl_vlan;
 665         ofs->match.dl_type   = flow->key.flow.dl_type;
 666         ofs->match.nw_src    = flow->key.flow.nw_src;
 667         ofs->match.nw_dst    = flow->key.flow.nw_dst;
 668         ofs->match.nw_proto  = flow->key.flow.nw_proto;
 669         memset(ofs->match.pad, 0, sizeof ofs->match.pad);
 670         ofs->match.tp_src    = flow->key.flow.tp_src;
 671         ofs->match.tp_dst    = flow->key.flow.tp_dst;
 672         ofs->duration        = htonl(now - flow->created);
 673         ofs->packet_count    = htonll(flow->packet_count);
 674         ofs->byte_count      = htonll(flow->byte_count);
 675         ofs->priority        = htons(flow->priority);
 676         ofs->table_id        = table_idx;
 677     memset(ofs->pad, 0, sizeof ofs->pad);
 678 }
 679
 680 int
 681 dp_send_flow_stats(struct datapath *dp, const struct sender *sender,
 682                    const struct ofp_match *match)
 683 {
 684     struct buffer *buffer;
 685     struct ofp_flow_stats_reply *fsr;
 686     size_t header_size, fudge, flow_size;
 687     struct sw_flow_key match_key;
 688     int table_idx, n_flows, max_flows;
 689     time_t now;
 690
 691     header_size = offsetof(struct ofp_flow_stats_reply, flows);
 692     fudge = 128;
 693     flow_size = sizeof fsr->flows[0];
 694     max_flows = (65536 - header_size - fudge) / flow_size;
 695     fsr = alloc_openflow_buffer(dp, header_size,
 696                                 OFPT_FLOW_STATS_REPLY, sender, &buffer);
 697
 698     n_flows = 0;
 699     flow_extract_match(&match_key, match);
 700     now = time(0);
 701     for (table_idx = 0; table_idx < dp->chain->n_tables; table_idx++) {
 702         struct sw_table *table = dp->chain->tables[table_idx];
 703         struct swt_iterator iter;
 704
 705         if (n_flows >= max_flows) {
 706             break;
 707         }
 708
 709         if (!table->iterator(table, &iter)) {
 710             printf("iterator failed for table %d\n", table_idx);
 711             continue;
 712         }
 713
 714         for (; iter.flow; table->iterator_next(&iter)) {
 715             if (flow_matches(&match_key, &iter.flow->key)) {
 716                 struct ofp_flow_stats *ofs = buffer_put_uninit(buffer,
 717                                                                sizeof *ofs);
 718                 fill_flow_stats(ofs, iter.flow, table_idx, now);
 719                 if (++n_flows >= max_flows) {
 720                     break;
 721                 }
 722             }
 723         }
 724         table->iterator_destroy(&iter);
 725     }
 726     return send_openflow_buffer(dp, buffer, sender);
 727 }
 728
 729 int
 730 dp_send_port_stats(struct datapath *dp, const struct sender *sender)
 731 {
 732         struct buffer *buffer;
 733         struct ofp_port_stats_reply *psr;
 734     struct sw_port *p;
 735
 736         psr = alloc_openflow_buffer(dp, offsetof(struct ofp_port_stats_reply,
 737                                              ports),
 738                                 OFPT_PORT_STATS_REPLY, sender, &buffer);
 739     LIST_FOR_EACH (p, struct sw_port, node, &dp->port_list) {
 740                 struct ofp_port_stats *ps = buffer_put_uninit(buffer, sizeof *ps);
 741                 ps->port_no = htons(port_no(dp, p));
 742                 memset(ps->pad, 0, sizeof ps->pad);
 743                 ps->rx_count = htonll(p->rx_count);
 744                 ps->tx_count = htonll(p->tx_count);
 745                 ps->drop_count = htonll(p->drop_count);
 746         }
 747         return send_openflow_buffer(dp, buffer, sender);
 748 }
 749
 750 int
 751 dp_send_table_stats(struct datapath *dp, const struct sender *sender)
 752 {
 753         struct buffer *buffer;
 754         struct ofp_table_stats_reply *tsr;
 755         int i;
 756
 757         tsr = alloc_openflow_buffer(dp, offsetof(struct ofp_table_stats_reply,
 758                                              tables),
 759                                 OFPT_TABLE_STATS_REPLY, sender, &buffer);
 760         for (i = 0; i < dp->chain->n_tables; i++) {
 761                 struct ofp_table_stats *ots = buffer_put_uninit(buffer, sizeof *ots);
 762                 struct sw_table_stats stats;
 763                 dp->chain->tables[i]->stats(dp->chain->tables[i], &stats);
 764                 strncpy(ots->name, stats.name, sizeof ots->name);
 765                 ots->table_id = i;
 766                 ots->pad[0] = ots->pad[1] = 0;
 767                 ots->max_entries = htonl(stats.max_flows);
 768                 ots->active_count = htonl(stats.n_flows);
 769                 ots->matched_count = htonll(0); /* FIXME */
 770         }
 771         return send_openflow_buffer(dp, buffer, sender);
 772 }
 773 \f
 774 /* 'buffer' was received on 'in_port', a physical switch port between 0 and
 775  * OFPP_MAX.  Process it according to 'chain'. */
 776 void fwd_port_input(struct datapath *dp, struct buffer *buffer, int in_port)
 777 {
 778     struct sw_flow_key key;
 779     struct sw_flow *flow;
 780
 781     key.wildcards = 0;
 782     flow_extract(buffer, in_port, &key.flow);
 783     flow = chain_lookup(dp->chain, &key);
 784     if (flow != NULL) {
 785         flow_used(flow, buffer);
 786         execute_actions(dp, buffer, in_port, &key,
 787                         flow->actions, flow->n_actions);
 788     } else {
 789         dp_output_control(dp, buffer, in_port, ntohs(dp->config.miss_send_len),
 790                           OFPR_NO_MATCH);
 791     }
 792 }
 793
 794 static void
 795 do_output(struct datapath *dp, struct buffer *buffer, int in_port,
 796           size_t max_len, int out_port)
 797 {
 798     if (out_port != OFPP_CONTROLLER) {
 799         dp_output_port(dp, buffer, in_port, out_port);
 800     } else {
 801         dp_output_control(dp, buffer, in_port, max_len, OFPR_ACTION);
 802     }
 803 }
 804
 805 static void
 806 execute_actions(struct datapath *dp, struct buffer *buffer,
 807                 int in_port, const struct sw_flow_key *key,
 808                 const struct ofp_action *actions, int n_actions)
 809 {
 810     /* Every output action needs a separate clone of 'buffer', but the common
 811      * case is just a single output action, so that doing a clone and then
 812      * freeing the original buffer is wasteful.  So the following code is
 813      * slightly obscure just to avoid that. */
 814     int prev_port;
 815     size_t max_len=0;        /* Initialze to make compiler happy */
 816     uint16_t eth_proto;
 817     int i;
 818
 819     prev_port = -1;
 820     eth_proto = ntohs(key->flow.dl_type);
 821
 822     for (i = 0; i < n_actions; i++) {
 823         const struct ofp_action *a = &actions[i];
 824         struct eth_header *eh = buffer->l2;
 825
 826         if (prev_port != -1) {
 827             do_output(dp, buffer_clone(buffer), in_port, max_len, prev_port);
 828             prev_port = -1;
 829         }
 830
 831         switch (ntohs(a->type)) {
 832         case OFPAT_OUTPUT:
 833             prev_port = ntohs(a->arg.output.port);
 834             max_len = ntohs(a->arg.output.max_len);
 835             break;
 836
 837         case OFPAT_SET_DL_VLAN:
 838             modify_vlan(buffer, key, a);
 839             break;
 840
 841         case OFPAT_SET_DL_SRC:
 842             memcpy(eh->eth_src, a->arg.dl_addr, sizeof eh->eth_src);
 843             break;
 844
 845         case OFPAT_SET_DL_DST:
 846             memcpy(eh->eth_dst, a->arg.dl_addr, sizeof eh->eth_dst);
 847             break;
 848
 849         case OFPAT_SET_NW_SRC:
 850         case OFPAT_SET_NW_DST:
 851             modify_nh(buffer, eth_proto, key->flow.nw_proto, a);
 852             break;
 853
 854         case OFPAT_SET_TP_SRC:
 855         case OFPAT_SET_TP_DST:
 856             modify_th(buffer, eth_proto, key->flow.nw_proto, a);
 857             break;
 858
 859         default:
 860             NOT_REACHED();
 861         }
 862     }
 863     if (prev_port != -1)
 864         do_output(dp, buffer, in_port, max_len, prev_port);
 865     else
 866         buffer_delete(buffer);
 867 }
 868
 869 /* Returns the new checksum for a packet in which the checksum field previously
 870  * contained 'old_csum' and in which a field that contained 'old_u16' was
 871  * changed to contain 'new_u16'. */
 872 static uint16_t
 873 recalc_csum16(uint16_t old_csum, uint16_t old_u16, uint16_t new_u16)
 874 {
 875     /* Ones-complement arithmetic is endian-independent, so this code does not
 876      * use htons() or ntohs().
 877      *
 878      * See RFC 1624 for formula and explanation. */
 879     uint16_t hc_complement = ~old_csum;
 880     uint16_t m_complement = ~old_u16;
 881     uint16_t m_prime = new_u16;
 882     uint32_t sum = hc_complement + m_complement + m_prime;
 883     uint16_t hc_prime_complement = sum + (sum >> 16);
 884     return ~hc_prime_complement;
 885 }
 886
 887 /* Returns the new checksum for a packet in which the checksum field previously
 888  * contained 'old_csum' and in which a field that contained 'old_u32' was
 889  * changed to contain 'new_u32'. */
 890 static uint16_t
 891 recalc_csum32(uint16_t old_csum, uint32_t old_u32, uint32_t new_u32)
 892 {
 893     return recalc_csum16(recalc_csum16(old_csum, old_u32, new_u32),
 894                          old_u32 >> 16, new_u32 >> 16);
 895 }
 896
 897 static void modify_nh(struct buffer *buffer, uint16_t eth_proto,
 898                       uint8_t nw_proto, const struct ofp_action *a)
 899 {
 900     if (eth_proto == ETH_TYPE_IP) {
 901         struct ip_header *nh = buffer->l3;
 902         uint32_t new, *field;
 903
 904         new = a->arg.nw_addr;
 905         field = a->type == OFPAT_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
 906         if (nw_proto == IP_TYPE_TCP) {
 907             struct tcp_header *th = buffer->l4;
 908             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, new);
 909         } else if (nw_proto == IP_TYPE_UDP) {
 910             struct udp_header *th = buffer->l4;
 911             if (th->udp_csum) {
 912                 th->udp_csum = recalc_csum32(th->udp_csum, *field, new);
 913                 if (!th->udp_csum) {
 914                     th->udp_csum = 0xffff;
 915                 }
 916             }
 917         }
 918         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, new);
 919         *field = new;
 920     }
 921 }
 922
 923 static void modify_th(struct buffer *buffer, uint16_t eth_proto,
 924                       uint8_t nw_proto, const struct ofp_action *a)
 925 {
 926     if (eth_proto == ETH_TYPE_IP) {
 927         uint16_t new, *field;
 928
 929         new = a->arg.tp;
 930
 931         if (nw_proto == IP_TYPE_TCP) {
 932             struct tcp_header *th = buffer->l4;
 933             field = a->type == OFPAT_SET_TP_SRC ? &th->tcp_src : &th->tcp_dst;
 934             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, new);
 935             *field = new;
 936         } else if (nw_proto == IP_TYPE_UDP) {
 937             struct udp_header *th = buffer->l4;
 938             field = a->type == OFPAT_SET_TP_SRC ? &th->udp_src : &th->udp_dst;
 939             th->udp_csum = recalc_csum16(th->udp_csum, *field, new);
 940             *field = new;
 941         }
 942     }
 943 }
 944
 945 static void
 946 modify_vlan(struct buffer *buffer,
 947             const struct sw_flow_key *key, const struct ofp_action *a)
 948 {
 949     uint16_t new_id = a->arg.vlan_id;
 950     struct vlan_eth_header *veh;
 951
 952     if (new_id != OFP_VLAN_NONE) {
 953         if (key->flow.dl_vlan != htons(OFP_VLAN_NONE)) {
 954             /* Modify vlan id, but maintain other TCI values */
 955             veh = buffer->l2;
 956             veh->veth_tci &= ~htons(VLAN_VID);
 957             veh->veth_tci |= htons(new_id);
 958         } else {
 959             /* Insert new vlan id. */
 960             struct eth_header *eh = buffer->l2;
 961             struct vlan_eth_header tmp;
 962             memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
 963             memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
 964             tmp.veth_type = htons(ETH_TYPE_VLAN);
 965             tmp.veth_tci = new_id;
 966             tmp.veth_next_type = eh->eth_type;
 967
 968             veh = buffer_push_uninit(buffer, VLAN_HEADER_LEN);
 969             memcpy(veh, &tmp, sizeof tmp);
 970             buffer->l2 -= VLAN_HEADER_LEN;
 971         }
 972     } else  {
 973         /* Remove an existing vlan header if it exists */
 974         veh = buffer->l2;
 975         if (veh->veth_type == htons(ETH_TYPE_VLAN)) {
 976             struct eth_header tmp;
 977
 978             memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
 979             memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
 980             tmp.eth_type = veh->veth_next_type;
 981
 982             buffer->size -= VLAN_HEADER_LEN;
 983             buffer->data += VLAN_HEADER_LEN;
 984             buffer->l2 += VLAN_HEADER_LEN;
 985             memcpy(buffer->data, &tmp, sizeof tmp);
 986         }
 987     }
 988 }
 989
 990 static int
 991 recv_features_request(struct datapath *dp, const struct sender *sender,
 992                       const void *msg)
 993 {
 994     dp_send_features_reply(dp, sender);
 995     return 0;
 996 }
 997
 998 static int
 999 recv_get_config_request(struct datapath *dp, const struct sender *sender,
1000                         const void *msg)
1001 {
1002     struct buffer *buffer;
1003     struct ofp_switch_config *osc;
1004
1005     osc = alloc_openflow_buffer(dp, sizeof *osc, OFPT_GET_CONFIG_REPLY,
1006                                 sender, &buffer);
1007
1008     assert(sizeof *osc == sizeof dp->config);
1009         memcpy(((char *)osc) + sizeof osc->header,
1010                ((char *)&dp->config) + sizeof dp->config.header,
1011                sizeof dp->config - sizeof dp->config.header);
1012
1013     return send_openflow_buffer(dp, buffer, sender);
1014 }
1015
1016 static int
1017 recv_set_config(struct datapath *dp, const struct sender *sender UNUSED,
1018                 const void *msg)
1019 {
1020     const struct ofp_switch_config *osc = msg;
1021     dp->config = *osc;
1022     return 0;
1023 }
1024
1025 static int
1026 recv_packet_out(struct datapath *dp, const struct sender *sender UNUSED,
1027                 const void *msg)
1028 {
1029     const struct ofp_packet_out *opo = msg;
1030
1031     if (ntohl(opo->buffer_id) == (uint32_t) -1) {
1032         /* FIXME: can we avoid copying data here? */
1033         int data_len = ntohs(opo->header.length) - sizeof *opo;
1034         struct buffer *buffer = buffer_new(data_len);
1035         buffer_put(buffer, opo->u.data, data_len);
1036         dp_output_port(dp, buffer,
1037                        ntohs(opo->in_port), ntohs(opo->out_port));
1038     } else {
1039         struct sw_flow_key key;
1040         struct buffer *buffer;
1041         int n_acts;
1042
1043         buffer = retrieve_buffer(ntohl(opo->buffer_id));
1044         if (!buffer) {
1045             return -ESRCH;
1046         }
1047
1048         n_acts = (ntohs(opo->header.length) - sizeof *opo)
1049             / sizeof *opo->u.actions;
1050         flow_extract(buffer, ntohs(opo->in_port), &key.flow);
1051         execute_actions(dp, buffer, ntohs(opo->in_port),
1052                         &key, opo->u.actions, n_acts);
1053     }
1054     return 0;
1055 }
1056
1057 static int
1058 recv_port_mod(struct datapath *dp, const struct sender *sender UNUSED,
1059               const void *msg)
1060 {
1061     const struct ofp_port_mod *opm = msg;
1062
1063     dp_update_port_flags(dp, &opm->desc);
1064
1065     return 0;
1066 }
1067
1068 static int
1069 add_flow(struct datapath *dp, const struct ofp_flow_mod *ofm)
1070 {
1071     int error = -ENOMEM;
1072     int n_acts;
1073     int i;
1074     struct sw_flow *flow;
1075
1076
1077     /* Check number of actions. */
1078     n_acts = (ntohs(ofm->header.length) - sizeof *ofm) / sizeof *ofm->actions;
1079     if (n_acts > MAX_ACTIONS) {
1080         error = -E2BIG;
1081         goto error;
1082     }
1083
1084     /* To prevent loops, make sure there's no action to send to the
1085      * OFP_TABLE virtual port.
1086      */
1087     for (i=0; i<n_acts; i++) {
1088         const struct ofp_action *a = &ofm->actions[i];
1089
1090         if (a->type == htons(OFPAT_OUTPUT)
1091                     && a->arg.output.port == htons(OFPP_TABLE)) {
1092             /* xxx Send fancy new error message? */
1093             goto error;
1094         }
1095     }
1096
1097     /* Allocate memory. */
1098     flow = flow_alloc(n_acts);
1099     if (flow == NULL)
1100         goto error;
1101
1102     /* Fill out flow. */
1103     flow_extract_match(&flow->key, &ofm->match);
1104     flow->max_idle = ntohs(ofm->max_idle);
1105     flow->priority = ntohs(ofm->priority);
1106     flow->timeout = time(0) + flow->max_idle; /* FIXME */
1107     flow->n_actions = n_acts;
1108     flow->created = time(0);    /* FIXME */
1109     flow->byte_count = 0;
1110     flow->packet_count = 0;
1111     memcpy(flow->actions, ofm->actions, n_acts * sizeof *flow->actions);
1112
1113     /* Act. */
1114     error = chain_insert(dp->chain, flow);
1115     if (error) {
1116         goto error_free_flow;
1117     }
1118     error = 0;
1119     if (ntohl(ofm->buffer_id) != UINT32_MAX) {
1120         struct buffer *buffer = retrieve_buffer(ntohl(ofm->buffer_id));
1121         if (buffer) {
1122             struct sw_flow_key key;
1123             uint16_t in_port = ntohs(ofm->match.in_port);
1124             flow_used(flow, buffer);
1125             flow_extract(buffer, in_port, &key.flow);
1126             execute_actions(dp, buffer, in_port, &key, ofm->actions, n_acts);
1127         } else {
1128             error = -ESRCH;
1129         }
1130     }
1131     return error;
1132
1133 error_free_flow:
1134     flow_free(flow);
1135 error:
1136     if (ntohl(ofm->buffer_id) != (uint32_t) -1)
1137         discard_buffer(ntohl(ofm->buffer_id));
1138     return error;
1139 }
1140
1141 static int
1142 recv_flow(struct datapath *dp, const struct sender *sender UNUSED,
1143           const void *msg)
1144 {
1145     const struct ofp_flow_mod *ofm = msg;
1146     uint16_t command = ntohs(ofm->command);
1147
1148     if (command == OFPFC_ADD) {
1149         return add_flow(dp, ofm);
1150     }  else if (command == OFPFC_DELETE) {
1151         struct sw_flow_key key;
1152         flow_extract_match(&key, &ofm->match);
1153         return chain_delete(dp->chain, &key, 0, 0) ? 0 : -ESRCH;
1154     } else if (command == OFPFC_DELETE_STRICT) {
1155         struct sw_flow_key key;
1156         flow_extract_match(&key, &ofm->match);
1157         return chain_delete(dp->chain, &key,
1158                     ntohs(ofm->priority), 1) ? 0 : -ESRCH;
1159     } else {
1160         return -ENODEV;
1161     }
1162 }
1163
1164 static int
1165 recv_flow_stats_request(struct datapath *dp, const struct sender *sender,
1166                          const void *msg)
1167 {
1168         const struct ofp_flow_stats_request *fsr = msg;
1169         if (fsr->type == OFPFS_INDIV) {
1170                 return dp_send_flow_stats(dp, sender, &fsr->match);
1171         } else {
1172                 /* FIXME */
1173                 return -ENOSYS;
1174         }
1175 }
1176
1177 static int
1178 recv_port_stats_request(struct datapath *dp, const struct sender *sender,
1179                          const void *msg)
1180 {
1181         return dp_send_port_stats(dp, sender);
1182 }
1183
1184 static int
1185 recv_table_stats_request(struct datapath *dp, const struct sender *sender,
1186                           const void *msg)
1187 {
1188         return dp_send_table_stats(dp, sender);
1189 }
1190
1191 /* 'msg', which is 'length' bytes long, was received from the control path.
1192  * Apply it to 'chain'. */
1193 int
1194 fwd_control_input(struct datapath *dp, const struct sender *sender,
1195                   const void *msg, size_t length)
1196 {
1197     struct openflow_packet {
1198         size_t min_size;
1199         int (*handler)(struct datapath *, const struct sender *, const void *);
1200     };
1201
1202     static const struct openflow_packet packets[] = {
1203         [OFPT_FEATURES_REQUEST] = {
1204             sizeof (struct ofp_header),
1205             recv_features_request,
1206         },
1207         [OFPT_GET_CONFIG_REQUEST] = {
1208             sizeof (struct ofp_header),
1209             recv_get_config_request,
1210         },
1211         [OFPT_SET_CONFIG] = {
1212             sizeof (struct ofp_switch_config),
1213             recv_set_config,
1214         },
1215         [OFPT_PACKET_OUT] = {
1216             sizeof (struct ofp_packet_out),
1217             recv_packet_out,
1218         },
1219         [OFPT_FLOW_MOD] = {
1220             sizeof (struct ofp_flow_mod),
1221             recv_flow,
1222         },
1223         [OFPT_PORT_MOD] = {
1224             sizeof (struct ofp_port_mod),
1225             recv_port_mod,
1226         },
1227                 [OFPT_FLOW_STATS_REQUEST] = {
1228                         sizeof (struct ofp_flow_stats_request),
1229                         recv_flow_stats_request,
1230                 },
1231                 [OFPT_PORT_STATS_REQUEST] = {
1232                         sizeof (struct ofp_port_stats_request),
1233                         recv_port_stats_request,
1234                 },
1235                 [OFPT_TABLE_STATS_REQUEST] = {
1236                         sizeof (struct ofp_table_stats_request),
1237                         recv_table_stats_request,
1238                 },
1239     };
1240
1241     const struct openflow_packet *pkt;
1242     struct ofp_header *oh;
1243
1244     oh = (struct ofp_header *) msg;
1245     if (oh->version != OFP_VERSION || oh->type >= ARRAY_SIZE(packets)
1246         || ntohs(oh->length) > length)
1247         return -EINVAL;
1248
1249     pkt = &packets[oh->type];
1250     if (!pkt->handler)
1251         return -ENOSYS;
1252     if (length < pkt->min_size)
1253         return -EFAULT;
1254
1255     return pkt->handler(dp, sender, msg);
1256 }
1257 \f
1258 /* Packet buffering. */
1259
1260 #define OVERWRITE_SECS  1
1261
1262 struct packet_buffer {
1263     struct buffer *buffer;
1264     uint32_t cookie;
1265     time_t timeout;
1266 };
1267
1268 static struct packet_buffer buffers[N_PKT_BUFFERS];
1269 static unsigned int buffer_idx;
1270
1271 uint32_t save_buffer(struct buffer *buffer)
1272 {
1273     struct packet_buffer *p;
1274     uint32_t id;
1275
1276     buffer_idx = (buffer_idx + 1) & PKT_BUFFER_MASK;
1277     p = &buffers[buffer_idx];
1278     if (p->buffer) {
1279         /* Don't buffer packet if existing entry is less than
1280          * OVERWRITE_SECS old. */
1281         if (time(0) < p->timeout) { /* FIXME */
1282             return -1;
1283         } else {
1284             buffer_delete(p->buffer);
1285         }
1286     }
1287     /* Don't use maximum cookie value since the all-bits-1 id is
1288      * special. */
1289     if (++p->cookie >= (1u << PKT_COOKIE_BITS) - 1)
1290         p->cookie = 0;
1291     p->buffer = buffer_clone(buffer);      /* FIXME */
1292     p->timeout = time(0) + OVERWRITE_SECS; /* FIXME */
1293     id = buffer_idx | (p->cookie << PKT_BUFFER_BITS);
1294
1295     return id;
1296 }
1297
1298 static struct buffer *retrieve_buffer(uint32_t id)
1299 {
1300     struct buffer *buffer = NULL;
1301     struct packet_buffer *p;
1302
1303     p = &buffers[id & PKT_BUFFER_MASK];
1304     if (p->cookie == id >> PKT_BUFFER_BITS) {
1305         buffer = p->buffer;
1306         p->buffer = NULL;
1307     } else {
1308         printf("cookie mismatch: %x != %x\n",
1309                id >> PKT_BUFFER_BITS, p->cookie);
1310     }
1311
1312     return buffer;
1313 }
1314
1315 static void discard_buffer(uint32_t id)
1316 {
1317     struct packet_buffer *p;
1318
1319     p = &buffers[id & PKT_BUFFER_MASK];
1320     if (p->cookie == id >> PKT_BUFFER_BITS) {
1321         buffer_delete(p->buffer);
1322         p->buffer = NULL;
1323     }
1324 }