ofproto/ofproto.c

   1 /*
   2  * Copyright (c) 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofproto.h"
  19 #include <errno.h>
  20 #include <inttypes.h>
  21 #include <net/if.h>
  22 #include <netinet/in.h>
  23 #include <stdbool.h>
  24 #include <stdlib.h>
  25 #include "classifier.h"
  26 #include "coverage.h"
  27 #include "discovery.h"
  28 #include "dpif.h"
  29 #include "dynamic-string.h"
  30 #include "fail-open.h"
  31 #include "in-band.h"
  32 #include "mac-learning.h"
  33 #include "netdev.h"
  34 #include "netflow.h"
  35 #include "odp-util.h"
  36 #include "ofp-print.h"
  37 #include "ofproto-sflow.h"
  38 #include "ofpbuf.h"
  39 #include "openflow/nicira-ext.h"
  40 #include "openflow/openflow.h"
  41 #include "openvswitch/datapath-protocol.h"
  42 #include "packets.h"
  43 #include "pinsched.h"
  44 #include "pktbuf.h"
  45 #include "poll-loop.h"
  46 #include "port-array.h"
  47 #include "rconn.h"
  48 #include "shash.h"
  49 #include "status.h"
  50 #include "stp.h"
  51 #include "stream-ssl.h"
  52 #include "svec.h"
  53 #include "tag.h"
  54 #include "timeval.h"
  55 #include "unixctl.h"
  56 #include "vconn.h"
  57 #include "xtoxll.h"
  58
  59 #define THIS_MODULE VLM_ofproto
  60 #include "vlog.h"
  61
  62 #include "sflow_api.h"
  63
  64 enum {
  65     TABLEID_HASH = 0,
  66     TABLEID_CLASSIFIER = 1
  67 };
  68
  69 struct ofport {
  70     struct netdev *netdev;
  71     struct ofp_phy_port opp;    /* In host byte order. */
  72 };
  73
  74 static void ofport_free(struct ofport *);
  75 static void hton_ofp_phy_port(struct ofp_phy_port *);
  76
  77 static int xlate_actions(const union ofp_action *in, size_t n_in,
  78                          const flow_t *flow, struct ofproto *ofproto,
  79                          const struct ofpbuf *packet,
  80                          struct odp_actions *out, tag_type *tags,
  81                          bool *may_set_up_flow, uint16_t *nf_output_iface);
  82
  83 struct rule {
  84     struct cls_rule cr;
  85
  86     uint64_t flow_cookie;       /* Controller-issued identifier.
  87                                    (Kept in network-byte order.) */
  88     uint16_t idle_timeout;      /* In seconds from time of last use. */
  89     uint16_t hard_timeout;      /* In seconds from time of creation. */
  90     bool send_flow_removed;     /* Send a flow removed message? */
  91     long long int used;         /* Last-used time (0 if never used). */
  92     long long int created;      /* Creation time. */
  93     uint64_t packet_count;      /* Number of packets received. */
  94     uint64_t byte_count;        /* Number of bytes received. */
  95     uint64_t accounted_bytes;   /* Number of bytes passed to account_cb. */
  96     tag_type tags;              /* Tags (set only by hooks). */
  97     struct netflow_flow nf_flow; /* Per-flow NetFlow tracking data. */
  98
  99     /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
 100      * exact-match rule (having cr.wc.wildcards of 0) generated from the
 101      * wildcard rule 'super'.  In this case, 'list' is an element of the
 102      * super-rule's list.
 103      *
 104      * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
 105      * a list of subrules.  A super-rule with no wildcards (where
 106      * cr.wc.wildcards is 0) will never have any subrules. */
 107     struct rule *super;
 108     struct list list;
 109
 110     /* OpenFlow actions.
 111      *
 112      * 'n_actions' is the number of elements in the 'actions' array.  A single
 113      * action may take up more more than one element's worth of space.
 114      *
 115      * A subrule has no actions (it uses the super-rule's actions). */
 116     int n_actions;
 117     union ofp_action *actions;
 118
 119     /* Datapath actions.
 120      *
 121      * A super-rule with wildcard fields never has ODP actions (since the
 122      * datapath only supports exact-match flows). */
 123     bool installed;             /* Installed in datapath? */
 124     bool may_install;           /* True ordinarily; false if actions must
 125                                  * be reassessed for every packet. */
 126     int n_odp_actions;
 127     union odp_action *odp_actions;
 128 };
 129
 130 static inline bool
 131 rule_is_hidden(const struct rule *rule)
 132 {
 133     /* Subrules are merely an implementation detail, so hide them from the
 134      * controller. */
 135     if (rule->super != NULL) {
 136         return true;
 137     }
 138
 139     /* Rules with priority higher than UINT16_MAX are set up by ofproto itself
 140      * (e.g. by in-band control) and are intentionally hidden from the
 141      * controller. */
 142     if (rule->cr.priority > UINT16_MAX) {
 143         return true;
 144     }
 145
 146     return false;
 147 }
 148
 149 static struct rule *rule_create(struct ofproto *, struct rule *super,
 150                                 const union ofp_action *, size_t n_actions,
 151                                 uint16_t idle_timeout, uint16_t hard_timeout,
 152                                 uint64_t flow_cookie, bool send_flow_removed);
 153 static void rule_free(struct rule *);
 154 static void rule_destroy(struct ofproto *, struct rule *);
 155 static struct rule *rule_from_cls_rule(const struct cls_rule *);
 156 static void rule_insert(struct ofproto *, struct rule *,
 157                         struct ofpbuf *packet, uint16_t in_port);
 158 static void rule_remove(struct ofproto *, struct rule *);
 159 static bool rule_make_actions(struct ofproto *, struct rule *,
 160                               const struct ofpbuf *packet);
 161 static void rule_install(struct ofproto *, struct rule *,
 162                          struct rule *displaced_rule);
 163 static void rule_uninstall(struct ofproto *, struct rule *);
 164 static void rule_post_uninstall(struct ofproto *, struct rule *);
 165 static void send_flow_removed(struct ofproto *p, struct rule *rule,
 166                               long long int now, uint8_t reason);
 167
 168 struct ofconn {
 169     struct list node;
 170     struct rconn *rconn;
 171     struct pktbuf *pktbuf;
 172     int miss_send_len;
 173
 174     struct rconn_packet_counter *packet_in_counter;
 175
 176     /* Number of OpenFlow messages queued as replies to OpenFlow requests, and
 177      * the maximum number before we stop reading OpenFlow requests.  */
 178 #define OFCONN_REPLY_MAX 100
 179     struct rconn_packet_counter *reply_counter;
 180 };
 181
 182 static struct ofconn *ofconn_create(struct ofproto *, struct rconn *);
 183 static void ofconn_destroy(struct ofconn *);
 184 static void ofconn_run(struct ofconn *, struct ofproto *);
 185 static void ofconn_wait(struct ofconn *);
 186 static void queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
 187                      struct rconn_packet_counter *counter);
 188
 189 struct ofproto {
 190     /* Settings. */
 191     uint64_t datapath_id;       /* Datapath ID. */
 192     uint64_t fallback_dpid;     /* Datapath ID if no better choice found. */
 193     char *mfr_desc;             /* Manufacturer. */
 194     char *hw_desc;              /* Hardware. */
 195     char *sw_desc;              /* Software version. */
 196     char *serial_desc;          /* Serial number. */
 197     char *dp_desc;              /* Datapath description. */
 198
 199     /* Datapath. */
 200     struct dpif *dpif;
 201     struct netdev_monitor *netdev_monitor;
 202     struct port_array ports;    /* Index is ODP port nr; ofport->opp.port_no is
 203                                  * OFP port nr. */
 204     struct shash port_by_name;
 205     uint32_t max_ports;
 206
 207     /* Configuration. */
 208     struct switch_status *switch_status;
 209     struct status_category *ss_cat;
 210     struct in_band *in_band;
 211     struct discovery *discovery;
 212     struct fail_open *fail_open;
 213     struct pinsched *miss_sched, *action_sched;
 214     struct netflow *netflow;
 215     struct ofproto_sflow *sflow;
 216
 217     /* Flow table. */
 218     struct classifier cls;
 219     bool need_revalidate;
 220     long long int next_expiration;
 221     struct tag_set revalidate_set;
 222
 223     /* OpenFlow connections. */
 224     struct list all_conns;
 225     struct ofconn *controller;
 226     struct pvconn **listeners;
 227     size_t n_listeners;
 228     struct pvconn **snoops;
 229     size_t n_snoops;
 230
 231     /* Hooks for ovs-vswitchd. */
 232     const struct ofhooks *ofhooks;
 233     void *aux;
 234
 235     /* Used by default ofhooks. */
 236     struct mac_learning *ml;
 237 };
 238
 239 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 240
 241 static const struct ofhooks default_ofhooks;
 242
 243 static uint64_t pick_datapath_id(const struct ofproto *);
 244 static uint64_t pick_fallback_dpid(void);
 245 static void send_packet_in_miss(struct ofpbuf *, void *ofproto);
 246 static void send_packet_in_action(struct ofpbuf *, void *ofproto);
 247 static void update_used(struct ofproto *);
 248 static void update_stats(struct ofproto *, struct rule *,
 249                          const struct odp_flow_stats *);
 250 static void expire_rule(struct cls_rule *, void *ofproto);
 251 static void active_timeout(struct ofproto *ofproto, struct rule *rule);
 252 static bool revalidate_rule(struct ofproto *p, struct rule *rule);
 253 static void revalidate_cb(struct cls_rule *rule_, void *p_);
 254
 255 static void handle_odp_msg(struct ofproto *, struct ofpbuf *);
 256
 257 static void handle_openflow(struct ofconn *, struct ofproto *,
 258                             struct ofpbuf *);
 259
 260 static void refresh_port_groups(struct ofproto *);
 261
 262 static void update_port(struct ofproto *, const char *devname);
 263 static int init_ports(struct ofproto *);
 264 static void reinit_ports(struct ofproto *);
 265
 266 int
 267 ofproto_create(const char *datapath, const char *datapath_type,
 268                const struct ofhooks *ofhooks, void *aux,
 269                struct ofproto **ofprotop)
 270 {
 271     struct odp_stats stats;
 272     struct ofproto *p;
 273     struct dpif *dpif;
 274     int error;
 275
 276     *ofprotop = NULL;
 277
 278     /* Connect to datapath and start listening for messages. */
 279     error = dpif_open(datapath, datapath_type, &dpif);
 280     if (error) {
 281         VLOG_ERR("failed to open datapath %s: %s", datapath, strerror(error));
 282         return error;
 283     }
 284     error = dpif_get_dp_stats(dpif, &stats);
 285     if (error) {
 286         VLOG_ERR("failed to obtain stats for datapath %s: %s",
 287                  datapath, strerror(error));
 288         dpif_close(dpif);
 289         return error;
 290     }
 291     error = dpif_recv_set_mask(dpif, ODPL_MISS | ODPL_ACTION | ODPL_SFLOW);
 292     if (error) {
 293         VLOG_ERR("failed to listen on datapath %s: %s",
 294                  datapath, strerror(error));
 295         dpif_close(dpif);
 296         return error;
 297     }
 298     dpif_flow_flush(dpif);
 299     dpif_recv_purge(dpif);
 300
 301     /* Initialize settings. */
 302     p = xzalloc(sizeof *p);
 303     p->fallback_dpid = pick_fallback_dpid();
 304     p->datapath_id = p->fallback_dpid;
 305     p->mfr_desc = xstrdup(DEFAULT_MFR_DESC);
 306     p->hw_desc = xstrdup(DEFAULT_HW_DESC);
 307     p->sw_desc = xstrdup(DEFAULT_SW_DESC);
 308     p->serial_desc = xstrdup(DEFAULT_SERIAL_DESC);
 309     p->dp_desc = xstrdup(DEFAULT_DP_DESC);
 310
 311     /* Initialize datapath. */
 312     p->dpif = dpif;
 313     p->netdev_monitor = netdev_monitor_create();
 314     port_array_init(&p->ports);
 315     shash_init(&p->port_by_name);
 316     p->max_ports = stats.max_ports;
 317
 318     /* Initialize submodules. */
 319     p->switch_status = switch_status_create(p);
 320     p->in_band = NULL;
 321     p->discovery = NULL;
 322     p->fail_open = NULL;
 323     p->miss_sched = p->action_sched = NULL;
 324     p->netflow = NULL;
 325     p->sflow = NULL;
 326
 327     /* Initialize flow table. */
 328     classifier_init(&p->cls);
 329     p->need_revalidate = false;
 330     p->next_expiration = time_msec() + 1000;
 331     tag_set_init(&p->revalidate_set);
 332
 333     /* Initialize OpenFlow connections. */
 334     list_init(&p->all_conns);
 335     p->controller = ofconn_create(p, rconn_create(5, 8));
 336     p->controller->pktbuf = pktbuf_create();
 337     p->controller->miss_send_len = OFP_DEFAULT_MISS_SEND_LEN;
 338     p->listeners = NULL;
 339     p->n_listeners = 0;
 340     p->snoops = NULL;
 341     p->n_snoops = 0;
 342
 343     /* Initialize hooks. */
 344     if (ofhooks) {
 345         p->ofhooks = ofhooks;
 346         p->aux = aux;
 347         p->ml = NULL;
 348     } else {
 349         p->ofhooks = &default_ofhooks;
 350         p->aux = p;
 351         p->ml = mac_learning_create();
 352     }
 353
 354     /* Register switch status category. */
 355     p->ss_cat = switch_status_register(p->switch_status, "remote",
 356                                        rconn_status_cb, p->controller->rconn);
 357
 358     /* Pick final datapath ID. */
 359     p->datapath_id = pick_datapath_id(p);
 360     VLOG_INFO("using datapath ID %016"PRIx64, p->datapath_id);
 361
 362     *ofprotop = p;
 363     return 0;
 364 }
 365
 366 void
 367 ofproto_set_datapath_id(struct ofproto *p, uint64_t datapath_id)
 368 {
 369     uint64_t old_dpid = p->datapath_id;
 370     p->datapath_id = datapath_id ? datapath_id : pick_datapath_id(p);
 371     if (p->datapath_id != old_dpid) {
 372         VLOG_INFO("datapath ID changed to %016"PRIx64, p->datapath_id);
 373         rconn_reconnect(p->controller->rconn);
 374     }
 375 }
 376
 377 void
 378 ofproto_set_probe_interval(struct ofproto *p, int probe_interval)
 379 {
 380     probe_interval = probe_interval ? MAX(probe_interval, 5) : 0;
 381     rconn_set_probe_interval(p->controller->rconn, probe_interval);
 382     if (p->fail_open) {
 383         int trigger_duration = probe_interval ? probe_interval * 3 : 15;
 384         fail_open_set_trigger_duration(p->fail_open, trigger_duration);
 385     }
 386 }
 387
 388 void
 389 ofproto_set_max_backoff(struct ofproto *p, int max_backoff)
 390 {
 391     rconn_set_max_backoff(p->controller->rconn, max_backoff);
 392 }
 393
 394 void
 395 ofproto_set_desc(struct ofproto *p,
 396                  const char *mfr_desc, const char *hw_desc,
 397                  const char *sw_desc, const char *serial_desc,
 398                  const char *dp_desc)
 399 {
 400     struct ofp_desc_stats *ods;
 401
 402     if (mfr_desc) {
 403         if (strlen(mfr_desc) >= sizeof ods->mfr_desc) {
 404             VLOG_WARN("truncating mfr_desc, must be less than %zu characters",
 405                     sizeof ods->mfr_desc);
 406         }
 407         free(p->mfr_desc);
 408         p->mfr_desc = xstrdup(mfr_desc);
 409     }
 410     if (hw_desc) {
 411         if (strlen(hw_desc) >= sizeof ods->hw_desc) {
 412             VLOG_WARN("truncating hw_desc, must be less than %zu characters",
 413                     sizeof ods->hw_desc);
 414         }
 415         free(p->hw_desc);
 416         p->hw_desc = xstrdup(hw_desc);
 417     }
 418     if (sw_desc) {
 419         if (strlen(sw_desc) >= sizeof ods->sw_desc) {
 420             VLOG_WARN("truncating sw_desc, must be less than %zu characters",
 421                     sizeof ods->sw_desc);
 422         }
 423         free(p->sw_desc);
 424         p->sw_desc = xstrdup(sw_desc);
 425     }
 426     if (serial_desc) {
 427         if (strlen(serial_desc) >= sizeof ods->serial_num) {
 428             VLOG_WARN("truncating serial_desc, must be less than %zu "
 429                     "characters",
 430                     sizeof ods->serial_num);
 431         }
 432         free(p->serial_desc);
 433         p->serial_desc = xstrdup(serial_desc);
 434     }
 435     if (dp_desc) {
 436         if (strlen(dp_desc) >= sizeof ods->dp_desc) {
 437             VLOG_WARN("truncating dp_desc, must be less than %zu characters",
 438                     sizeof ods->dp_desc);
 439         }
 440         free(p->dp_desc);
 441         p->dp_desc = xstrdup(dp_desc);
 442     }
 443 }
 444
 445 int
 446 ofproto_set_in_band(struct ofproto *p, bool in_band)
 447 {
 448     if (in_band != (p->in_band != NULL)) {
 449         if (in_band) {
 450             return in_band_create(p, p->dpif, p->switch_status,
 451                                   p->controller->rconn, &p->in_band);
 452         } else {
 453             ofproto_set_discovery(p, false, NULL, true);
 454             in_band_destroy(p->in_band);
 455             p->in_band = NULL;
 456         }
 457         rconn_reconnect(p->controller->rconn);
 458     }
 459     return 0;
 460 }
 461
 462 int
 463 ofproto_set_discovery(struct ofproto *p, bool discovery,
 464                       const char *re, bool update_resolv_conf)
 465 {
 466     if (discovery != (p->discovery != NULL)) {
 467         if (discovery) {
 468             int error = ofproto_set_in_band(p, true);
 469             if (error) {
 470                 return error;
 471             }
 472             error = discovery_create(re, update_resolv_conf,
 473                                      p->dpif, p->switch_status,
 474                                      &p->discovery);
 475             if (error) {
 476                 return error;
 477             }
 478         } else {
 479             discovery_destroy(p->discovery);
 480             p->discovery = NULL;
 481         }
 482         rconn_disconnect(p->controller->rconn);
 483     } else if (discovery) {
 484         discovery_set_update_resolv_conf(p->discovery, update_resolv_conf);
 485         return discovery_set_accept_controller_re(p->discovery, re);
 486     }
 487     return 0;
 488 }
 489
 490 int
 491 ofproto_set_controller(struct ofproto *ofproto, const char *controller)
 492 {
 493     if (ofproto->discovery) {
 494         return EINVAL;
 495     } else if (controller) {
 496         if (strcmp(rconn_get_name(ofproto->controller->rconn), controller)) {
 497             return rconn_connect(ofproto->controller->rconn, controller);
 498         } else {
 499             return 0;
 500         }
 501     } else {
 502         rconn_disconnect(ofproto->controller->rconn);
 503         return 0;
 504     }
 505 }
 506
 507 static int
 508 set_pvconns(struct pvconn ***pvconnsp, size_t *n_pvconnsp,
 509             const struct svec *svec)
 510 {
 511     struct pvconn **pvconns = *pvconnsp;
 512     size_t n_pvconns = *n_pvconnsp;
 513     int retval = 0;
 514     size_t i;
 515
 516     for (i = 0; i < n_pvconns; i++) {
 517         pvconn_close(pvconns[i]);
 518     }
 519     free(pvconns);
 520
 521     pvconns = xmalloc(svec->n * sizeof *pvconns);
 522     n_pvconns = 0;
 523     for (i = 0; i < svec->n; i++) {
 524         const char *name = svec->names[i];
 525         struct pvconn *pvconn;
 526         int error;
 527
 528         error = pvconn_open(name, &pvconn);
 529         if (!error) {
 530             pvconns[n_pvconns++] = pvconn;
 531         } else {
 532             VLOG_ERR("failed to listen on %s: %s", name, strerror(error));
 533             if (!retval) {
 534                 retval = error;
 535             }
 536         }
 537     }
 538
 539     *pvconnsp = pvconns;
 540     *n_pvconnsp = n_pvconns;
 541
 542     return retval;
 543 }
 544
 545 int
 546 ofproto_set_listeners(struct ofproto *ofproto, const struct svec *listeners)
 547 {
 548     return set_pvconns(&ofproto->listeners, &ofproto->n_listeners, listeners);
 549 }
 550
 551 int
 552 ofproto_set_snoops(struct ofproto *ofproto, const struct svec *snoops)
 553 {
 554     return set_pvconns(&ofproto->snoops, &ofproto->n_snoops, snoops);
 555 }
 556
 557 int
 558 ofproto_set_netflow(struct ofproto *ofproto,
 559                     const struct netflow_options *nf_options)
 560 {
 561     if (nf_options && nf_options->collectors.n) {
 562         if (!ofproto->netflow) {
 563             ofproto->netflow = netflow_create();
 564         }
 565         return netflow_set_options(ofproto->netflow, nf_options);
 566     } else {
 567         netflow_destroy(ofproto->netflow);
 568         ofproto->netflow = NULL;
 569         return 0;
 570     }
 571 }
 572
 573 void
 574 ofproto_set_sflow(struct ofproto *ofproto,
 575                   const struct ofproto_sflow_options *oso)
 576 {
 577     struct ofproto_sflow *os = ofproto->sflow;
 578     if (oso) {
 579         if (!os) {
 580             struct ofport *ofport;
 581             unsigned int odp_port;
 582
 583             os = ofproto->sflow = ofproto_sflow_create(ofproto->dpif);
 584             refresh_port_groups(ofproto);
 585             PORT_ARRAY_FOR_EACH (ofport, &ofproto->ports, odp_port) {
 586                 ofproto_sflow_add_port(os, odp_port,
 587                                        netdev_get_name(ofport->netdev));
 588             }
 589         }
 590         ofproto_sflow_set_options(os, oso);
 591     } else {
 592         ofproto_sflow_destroy(os);
 593         ofproto->sflow = NULL;
 594     }
 595 }
 596
 597 void
 598 ofproto_set_failure(struct ofproto *ofproto, bool fail_open)
 599 {
 600     if (fail_open) {
 601         struct rconn *rconn = ofproto->controller->rconn;
 602         int trigger_duration = rconn_get_probe_interval(rconn) * 3;
 603         if (!ofproto->fail_open) {
 604             ofproto->fail_open = fail_open_create(ofproto, trigger_duration,
 605                                                   ofproto->switch_status,
 606                                                   rconn);
 607         } else {
 608             fail_open_set_trigger_duration(ofproto->fail_open,
 609                                            trigger_duration);
 610         }
 611     } else {
 612         fail_open_destroy(ofproto->fail_open);
 613         ofproto->fail_open = NULL;
 614     }
 615 }
 616
 617 void
 618 ofproto_set_rate_limit(struct ofproto *ofproto,
 619                        int rate_limit, int burst_limit)
 620 {
 621     if (rate_limit > 0) {
 622         if (!ofproto->miss_sched) {
 623             ofproto->miss_sched = pinsched_create(rate_limit, burst_limit,
 624                                                   ofproto->switch_status);
 625             ofproto->action_sched = pinsched_create(rate_limit, burst_limit,
 626                                                     NULL);
 627         } else {
 628             pinsched_set_limits(ofproto->miss_sched, rate_limit, burst_limit);
 629             pinsched_set_limits(ofproto->action_sched,
 630                                 rate_limit, burst_limit);
 631         }
 632     } else {
 633         pinsched_destroy(ofproto->miss_sched);
 634         ofproto->miss_sched = NULL;
 635         pinsched_destroy(ofproto->action_sched);
 636         ofproto->action_sched = NULL;
 637     }
 638 }
 639
 640 int
 641 ofproto_set_stp(struct ofproto *ofproto OVS_UNUSED, bool enable_stp)
 642 {
 643     /* XXX */
 644     if (enable_stp) {
 645         VLOG_WARN("STP is not yet implemented");
 646         return EINVAL;
 647     } else {
 648         return 0;
 649     }
 650 }
 651
 652 uint64_t
 653 ofproto_get_datapath_id(const struct ofproto *ofproto)
 654 {
 655     return ofproto->datapath_id;
 656 }
 657
 658 int
 659 ofproto_get_probe_interval(const struct ofproto *ofproto)
 660 {
 661     return rconn_get_probe_interval(ofproto->controller->rconn);
 662 }
 663
 664 int
 665 ofproto_get_max_backoff(const struct ofproto *ofproto)
 666 {
 667     return rconn_get_max_backoff(ofproto->controller->rconn);
 668 }
 669
 670 bool
 671 ofproto_get_in_band(const struct ofproto *ofproto)
 672 {
 673     return ofproto->in_band != NULL;
 674 }
 675
 676 bool
 677 ofproto_get_discovery(const struct ofproto *ofproto)
 678 {
 679     return ofproto->discovery != NULL;
 680 }
 681
 682 const char *
 683 ofproto_get_controller(const struct ofproto *ofproto)
 684 {
 685     return rconn_get_name(ofproto->controller->rconn);
 686 }
 687
 688 void
 689 ofproto_get_listeners(const struct ofproto *ofproto, struct svec *listeners)
 690 {
 691     size_t i;
 692
 693     for (i = 0; i < ofproto->n_listeners; i++) {
 694         svec_add(listeners, pvconn_get_name(ofproto->listeners[i]));
 695     }
 696 }
 697
 698 void
 699 ofproto_get_snoops(const struct ofproto *ofproto, struct svec *snoops)
 700 {
 701     size_t i;
 702
 703     for (i = 0; i < ofproto->n_snoops; i++) {
 704         svec_add(snoops, pvconn_get_name(ofproto->snoops[i]));
 705     }
 706 }
 707
 708 void
 709 ofproto_destroy(struct ofproto *p)
 710 {
 711     struct ofconn *ofconn, *next_ofconn;
 712     struct ofport *ofport;
 713     unsigned int port_no;
 714     size_t i;
 715
 716     if (!p) {
 717         return;
 718     }
 719
 720     /* Destroy fail-open early, because it touches the classifier. */
 721     ofproto_set_failure(p, false);
 722
 723     ofproto_flush_flows(p);
 724     classifier_destroy(&p->cls);
 725
 726     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
 727                         &p->all_conns) {
 728         ofconn_destroy(ofconn);
 729     }
 730
 731     dpif_close(p->dpif);
 732     netdev_monitor_destroy(p->netdev_monitor);
 733     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
 734         ofport_free(ofport);
 735     }
 736     shash_destroy(&p->port_by_name);
 737
 738     switch_status_destroy(p->switch_status);
 739     in_band_destroy(p->in_band);
 740     discovery_destroy(p->discovery);
 741     pinsched_destroy(p->miss_sched);
 742     pinsched_destroy(p->action_sched);
 743     netflow_destroy(p->netflow);
 744     ofproto_sflow_destroy(p->sflow);
 745
 746     switch_status_unregister(p->ss_cat);
 747
 748     for (i = 0; i < p->n_listeners; i++) {
 749         pvconn_close(p->listeners[i]);
 750     }
 751     free(p->listeners);
 752
 753     for (i = 0; i < p->n_snoops; i++) {
 754         pvconn_close(p->snoops[i]);
 755     }
 756     free(p->snoops);
 757
 758     mac_learning_destroy(p->ml);
 759
 760     free(p->mfr_desc);
 761     free(p->hw_desc);
 762     free(p->sw_desc);
 763     free(p->serial_desc);
 764     free(p->dp_desc);
 765
 766     port_array_destroy(&p->ports);
 767
 768     free(p);
 769 }
 770
 771 int
 772 ofproto_run(struct ofproto *p)
 773 {
 774     int error = ofproto_run1(p);
 775     if (!error) {
 776         error = ofproto_run2(p, false);
 777     }
 778     return error;
 779 }
 780
 781 static void
 782 process_port_change(struct ofproto *ofproto, int error, char *devname)
 783 {
 784     if (error == ENOBUFS) {
 785         reinit_ports(ofproto);
 786     } else if (!error) {
 787         update_port(ofproto, devname);
 788         free(devname);
 789     }
 790 }
 791
 792 int
 793 ofproto_run1(struct ofproto *p)
 794 {
 795     struct ofconn *ofconn, *next_ofconn;
 796     char *devname;
 797     int error;
 798     int i;
 799
 800     if (shash_is_empty(&p->port_by_name)) {
 801         init_ports(p);
 802     }
 803
 804     for (i = 0; i < 50; i++) {
 805         struct ofpbuf *buf;
 806         int error;
 807
 808         error = dpif_recv(p->dpif, &buf);
 809         if (error) {
 810             if (error == ENODEV) {
 811                 /* Someone destroyed the datapath behind our back.  The caller
 812                  * better destroy us and give up, because we're just going to
 813                  * spin from here on out. */
 814                 static struct vlog_rate_limit rl2 = VLOG_RATE_LIMIT_INIT(1, 5);
 815                 VLOG_ERR_RL(&rl2, "%s: datapath was destroyed externally",
 816                             dpif_name(p->dpif));
 817                 return ENODEV;
 818             }
 819             break;
 820         }
 821
 822         handle_odp_msg(p, buf);
 823     }
 824
 825     while ((error = dpif_port_poll(p->dpif, &devname)) != EAGAIN) {
 826         process_port_change(p, error, devname);
 827     }
 828     while ((error = netdev_monitor_poll(p->netdev_monitor,
 829                                         &devname)) != EAGAIN) {
 830         process_port_change(p, error, devname);
 831     }
 832
 833     if (p->in_band) {
 834         in_band_run(p->in_band);
 835     }
 836     if (p->discovery) {
 837         char *controller_name;
 838         if (rconn_is_connectivity_questionable(p->controller->rconn)) {
 839             discovery_question_connectivity(p->discovery);
 840         }
 841         if (discovery_run(p->discovery, &controller_name)) {
 842             if (controller_name) {
 843                 rconn_connect(p->controller->rconn, controller_name);
 844             } else {
 845                 rconn_disconnect(p->controller->rconn);
 846             }
 847         }
 848     }
 849     pinsched_run(p->miss_sched, send_packet_in_miss, p);
 850     pinsched_run(p->action_sched, send_packet_in_action, p);
 851
 852     LIST_FOR_EACH_SAFE (ofconn, next_ofconn, struct ofconn, node,
 853                         &p->all_conns) {
 854         ofconn_run(ofconn, p);
 855     }
 856
 857     /* Fail-open maintenance.  Do this after processing the ofconns since
 858      * fail-open checks the status of the controller rconn. */
 859     if (p->fail_open) {
 860         fail_open_run(p->fail_open);
 861     }
 862
 863     for (i = 0; i < p->n_listeners; i++) {
 864         struct vconn *vconn;
 865         int retval;
 866
 867         retval = pvconn_accept(p->listeners[i], OFP_VERSION, &vconn);
 868         if (!retval) {
 869             ofconn_create(p, rconn_new_from_vconn("passive", vconn));
 870         } else if (retval != EAGAIN) {
 871             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 872         }
 873     }
 874
 875     for (i = 0; i < p->n_snoops; i++) {
 876         struct vconn *vconn;
 877         int retval;
 878
 879         retval = pvconn_accept(p->snoops[i], OFP_VERSION, &vconn);
 880         if (!retval) {
 881             rconn_add_monitor(p->controller->rconn, vconn);
 882         } else if (retval != EAGAIN) {
 883             VLOG_WARN_RL(&rl, "accept failed (%s)", strerror(retval));
 884         }
 885     }
 886
 887     if (time_msec() >= p->next_expiration) {
 888         COVERAGE_INC(ofproto_expiration);
 889         p->next_expiration = time_msec() + 1000;
 890         update_used(p);
 891
 892         classifier_for_each(&p->cls, CLS_INC_ALL, expire_rule, p);
 893
 894         /* Let the hook know that we're at a stable point: all outstanding data
 895          * in existing flows has been accounted to the account_cb.  Thus, the
 896          * hook can now reasonably do operations that depend on having accurate
 897          * flow volume accounting (currently, that's just bond rebalancing). */
 898         if (p->ofhooks->account_checkpoint_cb) {
 899             p->ofhooks->account_checkpoint_cb(p->aux);
 900         }
 901     }
 902
 903     if (p->netflow) {
 904         netflow_run(p->netflow);
 905     }
 906     if (p->sflow) {
 907         ofproto_sflow_run(p->sflow);
 908     }
 909
 910     return 0;
 911 }
 912
 913 struct revalidate_cbdata {
 914     struct ofproto *ofproto;
 915     bool revalidate_all;        /* Revalidate all exact-match rules? */
 916     bool revalidate_subrules;   /* Revalidate all exact-match subrules? */
 917     struct tag_set revalidate_set; /* Set of tags to revalidate. */
 918 };
 919
 920 int
 921 ofproto_run2(struct ofproto *p, bool revalidate_all)
 922 {
 923     if (p->need_revalidate || revalidate_all
 924         || !tag_set_is_empty(&p->revalidate_set)) {
 925         struct revalidate_cbdata cbdata;
 926         cbdata.ofproto = p;
 927         cbdata.revalidate_all = revalidate_all;
 928         cbdata.revalidate_subrules = p->need_revalidate;
 929         cbdata.revalidate_set = p->revalidate_set;
 930         tag_set_init(&p->revalidate_set);
 931         COVERAGE_INC(ofproto_revalidate);
 932         classifier_for_each(&p->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
 933         p->need_revalidate = false;
 934     }
 935
 936     return 0;
 937 }
 938
 939 void
 940 ofproto_wait(struct ofproto *p)
 941 {
 942     struct ofconn *ofconn;
 943     size_t i;
 944
 945     dpif_recv_wait(p->dpif);
 946     dpif_port_poll_wait(p->dpif);
 947     netdev_monitor_poll_wait(p->netdev_monitor);
 948     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
 949         ofconn_wait(ofconn);
 950     }
 951     if (p->in_band) {
 952         in_band_wait(p->in_band);
 953     }
 954     if (p->discovery) {
 955         discovery_wait(p->discovery);
 956     }
 957     if (p->fail_open) {
 958         fail_open_wait(p->fail_open);
 959     }
 960     pinsched_wait(p->miss_sched);
 961     pinsched_wait(p->action_sched);
 962     if (p->sflow) {
 963         ofproto_sflow_wait(p->sflow);
 964     }
 965     if (!tag_set_is_empty(&p->revalidate_set)) {
 966         poll_immediate_wake();
 967     }
 968     if (p->need_revalidate) {
 969         /* Shouldn't happen, but if it does just go around again. */
 970         VLOG_DBG_RL(&rl, "need revalidate in ofproto_wait_cb()");
 971         poll_immediate_wake();
 972     } else if (p->next_expiration != LLONG_MAX) {
 973         poll_timer_wait(p->next_expiration - time_msec());
 974     }
 975     for (i = 0; i < p->n_listeners; i++) {
 976         pvconn_wait(p->listeners[i]);
 977     }
 978     for (i = 0; i < p->n_snoops; i++) {
 979         pvconn_wait(p->snoops[i]);
 980     }
 981 }
 982
 983 void
 984 ofproto_revalidate(struct ofproto *ofproto, tag_type tag)
 985 {
 986     tag_set_add(&ofproto->revalidate_set, tag);
 987 }
 988
 989 struct tag_set *
 990 ofproto_get_revalidate_set(struct ofproto *ofproto)
 991 {
 992     return &ofproto->revalidate_set;
 993 }
 994
 995 bool
 996 ofproto_is_alive(const struct ofproto *p)
 997 {
 998     return p->discovery || rconn_is_alive(p->controller->rconn);
 999 }
1000
1001 int
1002 ofproto_send_packet(struct ofproto *p, const flow_t *flow,
1003                     const union ofp_action *actions, size_t n_actions,
1004                     const struct ofpbuf *packet)
1005 {
1006     struct odp_actions odp_actions;
1007     int error;
1008
1009     error = xlate_actions(actions, n_actions, flow, p, packet, &odp_actions,
1010                           NULL, NULL, NULL);
1011     if (error) {
1012         return error;
1013     }
1014
1015     /* XXX Should we translate the dpif_execute() errno value into an OpenFlow
1016      * error code? */
1017     dpif_execute(p->dpif, flow->in_port, odp_actions.actions,
1018                  odp_actions.n_actions, packet);
1019     return 0;
1020 }
1021
1022 void
1023 ofproto_add_flow(struct ofproto *p,
1024                  const flow_t *flow, uint32_t wildcards, unsigned int priority,
1025                  const union ofp_action *actions, size_t n_actions,
1026                  int idle_timeout)
1027 {
1028     struct rule *rule;
1029     rule = rule_create(p, NULL, actions, n_actions,
1030                        idle_timeout >= 0 ? idle_timeout : 5 /* XXX */,
1031                        0, 0, false);
1032     cls_rule_from_flow(&rule->cr, flow, wildcards, priority);
1033     rule_insert(p, rule, NULL, 0);
1034 }
1035
1036 void
1037 ofproto_delete_flow(struct ofproto *ofproto, const flow_t *flow,
1038                     uint32_t wildcards, unsigned int priority)
1039 {
1040     struct rule *rule;
1041
1042     rule = rule_from_cls_rule(classifier_find_rule_exactly(&ofproto->cls,
1043                                                            flow, wildcards,
1044                                                            priority));
1045     if (rule) {
1046         rule_remove(ofproto, rule);
1047     }
1048 }
1049
1050 static void
1051 destroy_rule(struct cls_rule *rule_, void *ofproto_)
1052 {
1053     struct rule *rule = rule_from_cls_rule(rule_);
1054     struct ofproto *ofproto = ofproto_;
1055
1056     /* Mark the flow as not installed, even though it might really be
1057      * installed, so that rule_remove() doesn't bother trying to uninstall it.
1058      * There is no point in uninstalling it individually since we are about to
1059      * blow away all the flows with dpif_flow_flush(). */
1060     rule->installed = false;
1061
1062     rule_remove(ofproto, rule);
1063 }
1064
1065 void
1066 ofproto_flush_flows(struct ofproto *ofproto)
1067 {
1068     COVERAGE_INC(ofproto_flush);
1069     classifier_for_each(&ofproto->cls, CLS_INC_ALL, destroy_rule, ofproto);
1070     dpif_flow_flush(ofproto->dpif);
1071     if (ofproto->in_band) {
1072         in_band_flushed(ofproto->in_band);
1073     }
1074     if (ofproto->fail_open) {
1075         fail_open_flushed(ofproto->fail_open);
1076     }
1077 }
1078 \f
1079 static void
1080 reinit_ports(struct ofproto *p)
1081 {
1082     struct svec devnames;
1083     struct ofport *ofport;
1084     unsigned int port_no;
1085     struct odp_port *odp_ports;
1086     size_t n_odp_ports;
1087     size_t i;
1088
1089     svec_init(&devnames);
1090     PORT_ARRAY_FOR_EACH (ofport, &p->ports, port_no) {
1091         svec_add (&devnames, (char *) ofport->opp.name);
1092     }
1093     dpif_port_list(p->dpif, &odp_ports, &n_odp_ports);
1094     for (i = 0; i < n_odp_ports; i++) {
1095         svec_add (&devnames, odp_ports[i].devname);
1096     }
1097     free(odp_ports);
1098
1099     svec_sort_unique(&devnames);
1100     for (i = 0; i < devnames.n; i++) {
1101         update_port(p, devnames.names[i]);
1102     }
1103     svec_destroy(&devnames);
1104 }
1105
1106 static size_t
1107 refresh_port_group(struct ofproto *p, unsigned int group)
1108 {
1109     uint16_t *ports;
1110     size_t n_ports;
1111     struct ofport *port;
1112     unsigned int port_no;
1113
1114     assert(group == DP_GROUP_ALL || group == DP_GROUP_FLOOD);
1115
1116     ports = xmalloc(port_array_count(&p->ports) * sizeof *ports);
1117     n_ports = 0;
1118     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1119         if (group == DP_GROUP_ALL || !(port->opp.config & OFPPC_NO_FLOOD)) {
1120             ports[n_ports++] = port_no;
1121         }
1122     }
1123     dpif_port_group_set(p->dpif, group, ports, n_ports);
1124     free(ports);
1125
1126     return n_ports;
1127 }
1128
1129 static void
1130 refresh_port_groups(struct ofproto *p)
1131 {
1132     size_t n_flood = refresh_port_group(p, DP_GROUP_FLOOD);
1133     size_t n_all = refresh_port_group(p, DP_GROUP_ALL);
1134     if (p->sflow) {
1135         ofproto_sflow_set_group_sizes(p->sflow, n_flood, n_all);
1136     }
1137 }
1138
1139 static struct ofport *
1140 make_ofport(const struct odp_port *odp_port)
1141 {
1142     struct netdev_options netdev_options;
1143     enum netdev_flags flags;
1144     struct ofport *ofport;
1145     struct netdev *netdev;
1146     bool carrier;
1147     int error;
1148
1149     memset(&netdev_options, 0, sizeof netdev_options);
1150     netdev_options.name = odp_port->devname;
1151     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
1152     netdev_options.may_open = true;
1153
1154     error = netdev_open(&netdev_options, &netdev);
1155     if (error) {
1156         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
1157                      "cannot be opened (%s)",
1158                      odp_port->devname, odp_port->port,
1159                      odp_port->devname, strerror(error));
1160         return NULL;
1161     }
1162
1163     ofport = xmalloc(sizeof *ofport);
1164     ofport->netdev = netdev;
1165     ofport->opp.port_no = odp_port_to_ofp_port(odp_port->port);
1166     netdev_get_etheraddr(netdev, ofport->opp.hw_addr);
1167     memcpy(ofport->opp.name, odp_port->devname,
1168            MIN(sizeof ofport->opp.name, sizeof odp_port->devname));
1169     ofport->opp.name[sizeof ofport->opp.name - 1] = '\0';
1170
1171     netdev_get_flags(netdev, &flags);
1172     ofport->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
1173
1174     netdev_get_carrier(netdev, &carrier);
1175     ofport->opp.state = carrier ? 0 : OFPPS_LINK_DOWN;
1176
1177     netdev_get_features(netdev,
1178                         &ofport->opp.curr, &ofport->opp.advertised,
1179                         &ofport->opp.supported, &ofport->opp.peer);
1180     return ofport;
1181 }
1182
1183 static bool
1184 ofport_conflicts(const struct ofproto *p, const struct odp_port *odp_port)
1185 {
1186     if (port_array_get(&p->ports, odp_port->port)) {
1187         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
1188                      odp_port->port);
1189         return true;
1190     } else if (shash_find(&p->port_by_name, odp_port->devname)) {
1191         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
1192                      odp_port->devname);
1193         return true;
1194     } else {
1195         return false;
1196     }
1197 }
1198
1199 static int
1200 ofport_equal(const struct ofport *a_, const struct ofport *b_)
1201 {
1202     const struct ofp_phy_port *a = &a_->opp;
1203     const struct ofp_phy_port *b = &b_->opp;
1204
1205     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
1206     return (a->port_no == b->port_no
1207             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
1208             && !strcmp((char *) a->name, (char *) b->name)
1209             && a->state == b->state
1210             && a->config == b->config
1211             && a->curr == b->curr
1212             && a->advertised == b->advertised
1213             && a->supported == b->supported
1214             && a->peer == b->peer);
1215 }
1216
1217 static void
1218 send_port_status(struct ofproto *p, const struct ofport *ofport,
1219                  uint8_t reason)
1220 {
1221     /* XXX Should limit the number of queued port status change messages. */
1222     struct ofconn *ofconn;
1223     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
1224         struct ofp_port_status *ops;
1225         struct ofpbuf *b;
1226
1227         ops = make_openflow_xid(sizeof *ops, OFPT_PORT_STATUS, 0, &b);
1228         ops->reason = reason;
1229         ops->desc = ofport->opp;
1230         hton_ofp_phy_port(&ops->desc);
1231         queue_tx(b, ofconn, NULL);
1232     }
1233     if (p->ofhooks->port_changed_cb) {
1234         p->ofhooks->port_changed_cb(reason, &ofport->opp, p->aux);
1235     }
1236 }
1237
1238 static void
1239 ofport_install(struct ofproto *p, struct ofport *ofport)
1240 {
1241     uint16_t odp_port = ofp_port_to_odp_port(ofport->opp.port_no);
1242     const char *netdev_name = (const char *) ofport->opp.name;
1243
1244     netdev_monitor_add(p->netdev_monitor, ofport->netdev);
1245     port_array_set(&p->ports, odp_port, ofport);
1246     shash_add(&p->port_by_name, netdev_name, ofport);
1247     if (p->sflow) {
1248         ofproto_sflow_add_port(p->sflow, odp_port, netdev_name);
1249     }
1250 }
1251
1252 static void
1253 ofport_remove(struct ofproto *p, struct ofport *ofport)
1254 {
1255     uint16_t odp_port = ofp_port_to_odp_port(ofport->opp.port_no);
1256
1257     netdev_monitor_remove(p->netdev_monitor, ofport->netdev);
1258     port_array_set(&p->ports, odp_port, NULL);
1259     shash_delete(&p->port_by_name,
1260                  shash_find(&p->port_by_name, (char *) ofport->opp.name));
1261     if (p->sflow) {
1262         ofproto_sflow_del_port(p->sflow, odp_port);
1263     }
1264 }
1265
1266 static void
1267 ofport_free(struct ofport *ofport)
1268 {
1269     if (ofport) {
1270         netdev_close(ofport->netdev);
1271         free(ofport);
1272     }
1273 }
1274
1275 static void
1276 update_port(struct ofproto *p, const char *devname)
1277 {
1278     struct odp_port odp_port;
1279     struct ofport *old_ofport;
1280     struct ofport *new_ofport;
1281     int error;
1282
1283     COVERAGE_INC(ofproto_update_port);
1284
1285     /* Query the datapath for port information. */
1286     error = dpif_port_query_by_name(p->dpif, devname, &odp_port);
1287
1288     /* Find the old ofport. */
1289     old_ofport = shash_find_data(&p->port_by_name, devname);
1290     if (!error) {
1291         if (!old_ofport) {
1292             /* There's no port named 'devname' but there might be a port with
1293              * the same port number.  This could happen if a port is deleted
1294              * and then a new one added in its place very quickly, or if a port
1295              * is renamed.  In the former case we want to send an OFPPR_DELETE
1296              * and an OFPPR_ADD, and in the latter case we want to send a
1297              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
1298              * the old port's ifindex against the new port, or perhaps less
1299              * reliably but more portably by comparing the old port's MAC
1300              * against the new port's MAC.  However, this code isn't that smart
1301              * and always sends an OFPPR_MODIFY (XXX). */
1302             old_ofport = port_array_get(&p->ports, odp_port.port);
1303         }
1304     } else if (error != ENOENT && error != ENODEV) {
1305         VLOG_WARN_RL(&rl, "dpif_port_query_by_name returned unexpected error "
1306                      "%s", strerror(error));
1307         return;
1308     }
1309
1310     /* Create a new ofport. */
1311     new_ofport = !error ? make_ofport(&odp_port) : NULL;
1312
1313     /* Eliminate a few pathological cases. */
1314     if (!old_ofport && !new_ofport) {
1315         return;
1316     } else if (old_ofport && new_ofport) {
1317         /* Most of the 'config' bits are OpenFlow soft state, but
1318          * OFPPC_PORT_DOWN is maintained the kernel.  So transfer the OpenFlow
1319          * bits from old_ofport.  (make_ofport() only sets OFPPC_PORT_DOWN and
1320          * leaves the other bits 0.)  */
1321         new_ofport->opp.config |= old_ofport->opp.config & ~OFPPC_PORT_DOWN;
1322
1323         if (ofport_equal(old_ofport, new_ofport)) {
1324             /* False alarm--no change. */
1325             ofport_free(new_ofport);
1326             return;
1327         }
1328     }
1329
1330     /* Now deal with the normal cases. */
1331     if (old_ofport) {
1332         ofport_remove(p, old_ofport);
1333     }
1334     if (new_ofport) {
1335         ofport_install(p, new_ofport);
1336     }
1337     send_port_status(p, new_ofport ? new_ofport : old_ofport,
1338                      (!old_ofport ? OFPPR_ADD
1339                       : !new_ofport ? OFPPR_DELETE
1340                       : OFPPR_MODIFY));
1341     ofport_free(old_ofport);
1342
1343     /* Update port groups. */
1344     refresh_port_groups(p);
1345 }
1346
1347 static int
1348 init_ports(struct ofproto *p)
1349 {
1350     struct odp_port *ports;
1351     size_t n_ports;
1352     size_t i;
1353     int error;
1354
1355     error = dpif_port_list(p->dpif, &ports, &n_ports);
1356     if (error) {
1357         return error;
1358     }
1359
1360     for (i = 0; i < n_ports; i++) {
1361         const struct odp_port *odp_port = &ports[i];
1362         if (!ofport_conflicts(p, odp_port)) {
1363             struct ofport *ofport = make_ofport(odp_port);
1364             if (ofport) {
1365                 ofport_install(p, ofport);
1366             }
1367         }
1368     }
1369     free(ports);
1370     refresh_port_groups(p);
1371     return 0;
1372 }
1373 \f
1374 static struct ofconn *
1375 ofconn_create(struct ofproto *p, struct rconn *rconn)
1376 {
1377     struct ofconn *ofconn = xmalloc(sizeof *ofconn);
1378     list_push_back(&p->all_conns, &ofconn->node);
1379     ofconn->rconn = rconn;
1380     ofconn->pktbuf = NULL;
1381     ofconn->miss_send_len = 0;
1382     ofconn->packet_in_counter = rconn_packet_counter_create ();
1383     ofconn->reply_counter = rconn_packet_counter_create ();
1384     return ofconn;
1385 }
1386
1387 static void
1388 ofconn_destroy(struct ofconn *ofconn)
1389 {
1390     list_remove(&ofconn->node);
1391     rconn_destroy(ofconn->rconn);
1392     rconn_packet_counter_destroy(ofconn->packet_in_counter);
1393     rconn_packet_counter_destroy(ofconn->reply_counter);
1394     pktbuf_destroy(ofconn->pktbuf);
1395     free(ofconn);
1396 }
1397
1398 static void
1399 ofconn_run(struct ofconn *ofconn, struct ofproto *p)
1400 {
1401     int iteration;
1402
1403     rconn_run(ofconn->rconn);
1404
1405     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1406         /* Limit the number of iterations to prevent other tasks from
1407          * starving. */
1408         for (iteration = 0; iteration < 50; iteration++) {
1409             struct ofpbuf *of_msg = rconn_recv(ofconn->rconn);
1410             if (!of_msg) {
1411                 break;
1412             }
1413             if (p->fail_open) {
1414                 fail_open_maybe_recover(p->fail_open);
1415             }
1416             handle_openflow(ofconn, p, of_msg);
1417             ofpbuf_delete(of_msg);
1418         }
1419     }
1420
1421     if (ofconn != p->controller && !rconn_is_alive(ofconn->rconn)) {
1422         ofconn_destroy(ofconn);
1423     }
1424 }
1425
1426 static void
1427 ofconn_wait(struct ofconn *ofconn)
1428 {
1429     rconn_run_wait(ofconn->rconn);
1430     if (rconn_packet_counter_read (ofconn->reply_counter) < OFCONN_REPLY_MAX) {
1431         rconn_recv_wait(ofconn->rconn);
1432     } else {
1433         COVERAGE_INC(ofproto_ofconn_stuck);
1434     }
1435 }
1436 \f
1437 /* Caller is responsible for initializing the 'cr' member of the returned
1438  * rule. */
1439 static struct rule *
1440 rule_create(struct ofproto *ofproto, struct rule *super,
1441             const union ofp_action *actions, size_t n_actions,
1442             uint16_t idle_timeout, uint16_t hard_timeout,
1443             uint64_t flow_cookie, bool send_flow_removed)
1444 {
1445     struct rule *rule = xzalloc(sizeof *rule);
1446     rule->idle_timeout = idle_timeout;
1447     rule->hard_timeout = hard_timeout;
1448     rule->flow_cookie = flow_cookie;
1449     rule->used = rule->created = time_msec();
1450     rule->send_flow_removed = send_flow_removed;
1451     rule->super = super;
1452     if (super) {
1453         list_push_back(&super->list, &rule->list);
1454     } else {
1455         list_init(&rule->list);
1456     }
1457     rule->n_actions = n_actions;
1458     rule->actions = xmemdup(actions, n_actions * sizeof *actions);
1459     netflow_flow_clear(&rule->nf_flow);
1460     netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
1461
1462     return rule;
1463 }
1464
1465 static struct rule *
1466 rule_from_cls_rule(const struct cls_rule *cls_rule)
1467 {
1468     return cls_rule ? CONTAINER_OF(cls_rule, struct rule, cr) : NULL;
1469 }
1470
1471 static void
1472 rule_free(struct rule *rule)
1473 {
1474     free(rule->actions);
1475     free(rule->odp_actions);
1476     free(rule);
1477 }
1478
1479 /* Destroys 'rule'.  If 'rule' is a subrule, also removes it from its
1480  * super-rule's list of subrules.  If 'rule' is a super-rule, also iterates
1481  * through all of its subrules and revalidates them, destroying any that no
1482  * longer has a super-rule (which is probably all of them).
1483  *
1484  * Before calling this function, the caller must make have removed 'rule' from
1485  * the classifier.  If 'rule' is an exact-match rule, the caller is also
1486  * responsible for ensuring that it has been uninstalled from the datapath. */
1487 static void
1488 rule_destroy(struct ofproto *ofproto, struct rule *rule)
1489 {
1490     if (!rule->super) {
1491         struct rule *subrule, *next;
1492         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
1493             revalidate_rule(ofproto, subrule);
1494         }
1495     } else {
1496         list_remove(&rule->list);
1497     }
1498     rule_free(rule);
1499 }
1500
1501 static bool
1502 rule_has_out_port(const struct rule *rule, uint16_t out_port)
1503 {
1504     const union ofp_action *oa;
1505     struct actions_iterator i;
1506
1507     if (out_port == htons(OFPP_NONE)) {
1508         return true;
1509     }
1510     for (oa = actions_first(&i, rule->actions, rule->n_actions); oa;
1511          oa = actions_next(&i)) {
1512         if (oa->type == htons(OFPAT_OUTPUT) && oa->output.port == out_port) {
1513             return true;
1514         }
1515     }
1516     return false;
1517 }
1518
1519 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
1520  * 'flow' and is considered to have arrived on ODP port 'in_port'.
1521  *
1522  * The flow that 'packet' actually contains does not need to actually match
1523  * 'rule'; the actions in 'rule' will be applied to it either way.  Likewise,
1524  * the packet and byte counters for 'rule' will be credited for the packet sent
1525  * out whether or not the packet actually matches 'rule'.
1526  *
1527  * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
1528  * the caller must already have accurately composed ODP actions for it given
1529  * 'packet' using rule_make_actions().  If 'rule' is a wildcard rule, or if
1530  * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
1531  * function will compose a set of ODP actions based on 'rule''s OpenFlow
1532  * actions and apply them to 'packet'. */
1533 static void
1534 rule_execute(struct ofproto *ofproto, struct rule *rule,
1535              struct ofpbuf *packet, const flow_t *flow)
1536 {
1537     const union odp_action *actions;
1538     size_t n_actions;
1539     struct odp_actions a;
1540
1541     /* Grab or compose the ODP actions.
1542      *
1543      * The special case for an exact-match 'rule' where 'flow' is not the
1544      * rule's flow is important to avoid, e.g., sending a packet out its input
1545      * port simply because the ODP actions were composed for the wrong
1546      * scenario. */
1547     if (rule->cr.wc.wildcards || !flow_equal(flow, &rule->cr.flow)) {
1548         struct rule *super = rule->super ? rule->super : rule;
1549         if (xlate_actions(super->actions, super->n_actions, flow, ofproto,
1550                           packet, &a, NULL, 0, NULL)) {
1551             return;
1552         }
1553         actions = a.actions;
1554         n_actions = a.n_actions;
1555     } else {
1556         actions = rule->odp_actions;
1557         n_actions = rule->n_odp_actions;
1558     }
1559
1560     /* Execute the ODP actions. */
1561     if (!dpif_execute(ofproto->dpif, flow->in_port,
1562                       actions, n_actions, packet)) {
1563         struct odp_flow_stats stats;
1564         flow_extract_stats(flow, packet, &stats);
1565         update_stats(ofproto, rule, &stats);
1566         rule->used = time_msec();
1567         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->used);
1568     }
1569 }
1570
1571 static void
1572 rule_insert(struct ofproto *p, struct rule *rule, struct ofpbuf *packet,
1573             uint16_t in_port)
1574 {
1575     struct rule *displaced_rule;
1576
1577     /* Insert the rule in the classifier. */
1578     displaced_rule = rule_from_cls_rule(classifier_insert(&p->cls, &rule->cr));
1579     if (!rule->cr.wc.wildcards) {
1580         rule_make_actions(p, rule, packet);
1581     }
1582
1583     /* Send the packet and credit it to the rule. */
1584     if (packet) {
1585         flow_t flow;
1586         flow_extract(packet, in_port, &flow);
1587         rule_execute(p, rule, packet, &flow);
1588     }
1589
1590     /* Install the rule in the datapath only after sending the packet, to
1591      * avoid packet reordering.  */
1592     if (rule->cr.wc.wildcards) {
1593         COVERAGE_INC(ofproto_add_wc_flow);
1594         p->need_revalidate = true;
1595     } else {
1596         rule_install(p, rule, displaced_rule);
1597     }
1598
1599     /* Free the rule that was displaced, if any. */
1600     if (displaced_rule) {
1601         rule_destroy(p, displaced_rule);
1602     }
1603 }
1604
1605 static struct rule *
1606 rule_create_subrule(struct ofproto *ofproto, struct rule *rule,
1607                     const flow_t *flow)
1608 {
1609     struct rule *subrule = rule_create(ofproto, rule, NULL, 0,
1610                                        rule->idle_timeout, rule->hard_timeout,
1611                                        0, false);
1612     COVERAGE_INC(ofproto_subrule_create);
1613     cls_rule_from_flow(&subrule->cr, flow, 0,
1614                        (rule->cr.priority <= UINT16_MAX ? UINT16_MAX
1615                         : rule->cr.priority));
1616     classifier_insert_exact(&ofproto->cls, &subrule->cr);
1617
1618     return subrule;
1619 }
1620
1621 static void
1622 rule_remove(struct ofproto *ofproto, struct rule *rule)
1623 {
1624     if (rule->cr.wc.wildcards) {
1625         COVERAGE_INC(ofproto_del_wc_flow);
1626         ofproto->need_revalidate = true;
1627     } else {
1628         rule_uninstall(ofproto, rule);
1629     }
1630     classifier_remove(&ofproto->cls, &rule->cr);
1631     rule_destroy(ofproto, rule);
1632 }
1633
1634 /* Returns true if the actions changed, false otherwise. */
1635 static bool
1636 rule_make_actions(struct ofproto *p, struct rule *rule,
1637                   const struct ofpbuf *packet)
1638 {
1639     const struct rule *super;
1640     struct odp_actions a;
1641     size_t actions_len;
1642
1643     assert(!rule->cr.wc.wildcards);
1644
1645     super = rule->super ? rule->super : rule;
1646     rule->tags = 0;
1647     xlate_actions(super->actions, super->n_actions, &rule->cr.flow, p,
1648                   packet, &a, &rule->tags, &rule->may_install,
1649                   &rule->nf_flow.output_iface);
1650
1651     actions_len = a.n_actions * sizeof *a.actions;
1652     if (rule->n_odp_actions != a.n_actions
1653         || memcmp(rule->odp_actions, a.actions, actions_len)) {
1654         COVERAGE_INC(ofproto_odp_unchanged);
1655         free(rule->odp_actions);
1656         rule->n_odp_actions = a.n_actions;
1657         rule->odp_actions = xmemdup(a.actions, actions_len);
1658         return true;
1659     } else {
1660         return false;
1661     }
1662 }
1663
1664 static int
1665 do_put_flow(struct ofproto *ofproto, struct rule *rule, int flags,
1666             struct odp_flow_put *put)
1667 {
1668     memset(&put->flow.stats, 0, sizeof put->flow.stats);
1669     put->flow.key = rule->cr.flow;
1670     put->flow.actions = rule->odp_actions;
1671     put->flow.n_actions = rule->n_odp_actions;
1672     put->flags = flags;
1673     return dpif_flow_put(ofproto->dpif, put);
1674 }
1675
1676 static void
1677 rule_install(struct ofproto *p, struct rule *rule, struct rule *displaced_rule)
1678 {
1679     assert(!rule->cr.wc.wildcards);
1680
1681     if (rule->may_install) {
1682         struct odp_flow_put put;
1683         if (!do_put_flow(p, rule,
1684                          ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS,
1685                          &put)) {
1686             rule->installed = true;
1687             if (displaced_rule) {
1688                 update_stats(p, displaced_rule, &put.flow.stats);
1689                 rule_post_uninstall(p, displaced_rule);
1690             }
1691         }
1692     } else if (displaced_rule) {
1693         rule_uninstall(p, displaced_rule);
1694     }
1695 }
1696
1697 static void
1698 rule_reinstall(struct ofproto *ofproto, struct rule *rule)
1699 {
1700     if (rule->installed) {
1701         struct odp_flow_put put;
1702         COVERAGE_INC(ofproto_dp_missed);
1703         do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY, &put);
1704     } else {
1705         rule_install(ofproto, rule, NULL);
1706     }
1707 }
1708
1709 static void
1710 rule_update_actions(struct ofproto *ofproto, struct rule *rule)
1711 {
1712     bool actions_changed;
1713     uint16_t new_out_iface, old_out_iface;
1714
1715     old_out_iface = rule->nf_flow.output_iface;
1716     actions_changed = rule_make_actions(ofproto, rule, NULL);
1717
1718     if (rule->may_install) {
1719         if (rule->installed) {
1720             if (actions_changed) {
1721                 struct odp_flow_put put;
1722                 do_put_flow(ofproto, rule, ODPPF_CREATE | ODPPF_MODIFY
1723                                            | ODPPF_ZERO_STATS, &put);
1724                 update_stats(ofproto, rule, &put.flow.stats);
1725
1726                 /* Temporarily set the old output iface so that NetFlow
1727                  * messages have the correct output interface for the old
1728                  * stats. */
1729                 new_out_iface = rule->nf_flow.output_iface;
1730                 rule->nf_flow.output_iface = old_out_iface;
1731                 rule_post_uninstall(ofproto, rule);
1732                 rule->nf_flow.output_iface = new_out_iface;
1733             }
1734         } else {
1735             rule_install(ofproto, rule, NULL);
1736         }
1737     } else {
1738         rule_uninstall(ofproto, rule);
1739     }
1740 }
1741
1742 static void
1743 rule_account(struct ofproto *ofproto, struct rule *rule, uint64_t extra_bytes)
1744 {
1745     uint64_t total_bytes = rule->byte_count + extra_bytes;
1746
1747     if (ofproto->ofhooks->account_flow_cb
1748         && total_bytes > rule->accounted_bytes)
1749     {
1750         ofproto->ofhooks->account_flow_cb(
1751             &rule->cr.flow, rule->odp_actions, rule->n_odp_actions,
1752             total_bytes - rule->accounted_bytes, ofproto->aux);
1753         rule->accounted_bytes = total_bytes;
1754     }
1755 }
1756
1757 static void
1758 rule_uninstall(struct ofproto *p, struct rule *rule)
1759 {
1760     assert(!rule->cr.wc.wildcards);
1761     if (rule->installed) {
1762         struct odp_flow odp_flow;
1763
1764         odp_flow.key = rule->cr.flow;
1765         odp_flow.actions = NULL;
1766         odp_flow.n_actions = 0;
1767         if (!dpif_flow_del(p->dpif, &odp_flow)) {
1768             update_stats(p, rule, &odp_flow.stats);
1769         }
1770         rule->installed = false;
1771
1772         rule_post_uninstall(p, rule);
1773     }
1774 }
1775
1776 static bool
1777 is_controller_rule(struct rule *rule)
1778 {
1779     /* If the only action is send to the controller then don't report
1780      * NetFlow expiration messages since it is just part of the control
1781      * logic for the network and not real traffic. */
1782
1783     if (rule && rule->super) {
1784         struct rule *super = rule->super;
1785
1786         return super->n_actions == 1 &&
1787                super->actions[0].type == htons(OFPAT_OUTPUT) &&
1788                super->actions[0].output.port == htons(OFPP_CONTROLLER);
1789     }
1790
1791     return false;
1792 }
1793
1794 static void
1795 rule_post_uninstall(struct ofproto *ofproto, struct rule *rule)
1796 {
1797     struct rule *super = rule->super;
1798
1799     rule_account(ofproto, rule, 0);
1800
1801     if (ofproto->netflow && !is_controller_rule(rule)) {
1802         struct ofexpired expired;
1803         expired.flow = rule->cr.flow;
1804         expired.packet_count = rule->packet_count;
1805         expired.byte_count = rule->byte_count;
1806         expired.used = rule->used;
1807         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
1808     }
1809     if (super) {
1810         super->packet_count += rule->packet_count;
1811         super->byte_count += rule->byte_count;
1812
1813         /* Reset counters to prevent double counting if the rule ever gets
1814          * reinstalled. */
1815         rule->packet_count = 0;
1816         rule->byte_count = 0;
1817         rule->accounted_bytes = 0;
1818
1819         netflow_flow_clear(&rule->nf_flow);
1820     }
1821 }
1822 \f
1823 static void
1824 queue_tx(struct ofpbuf *msg, const struct ofconn *ofconn,
1825          struct rconn_packet_counter *counter)
1826 {
1827     update_openflow_length(msg);
1828     if (rconn_send(ofconn->rconn, msg, counter)) {
1829         ofpbuf_delete(msg);
1830     }
1831 }
1832
1833 static void
1834 send_error(const struct ofconn *ofconn, const struct ofp_header *oh,
1835            int error, const void *data, size_t len)
1836 {
1837     struct ofpbuf *buf;
1838     struct ofp_error_msg *oem;
1839
1840     if (!(error >> 16)) {
1841         VLOG_WARN_RL(&rl, "not sending bad error code %d to controller",
1842                      error);
1843         return;
1844     }
1845
1846     COVERAGE_INC(ofproto_error);
1847     oem = make_openflow_xid(len + sizeof *oem, OFPT_ERROR,
1848                             oh ? oh->xid : 0, &buf);
1849     oem->type = htons((unsigned int) error >> 16);
1850     oem->code = htons(error & 0xffff);
1851     memcpy(oem->data, data, len);
1852     queue_tx(buf, ofconn, ofconn->reply_counter);
1853 }
1854
1855 static void
1856 send_error_oh(const struct ofconn *ofconn, const struct ofp_header *oh,
1857               int error)
1858 {
1859     size_t oh_length = ntohs(oh->length);
1860     send_error(ofconn, oh, error, oh, MIN(oh_length, 64));
1861 }
1862
1863 static void
1864 hton_ofp_phy_port(struct ofp_phy_port *opp)
1865 {
1866     opp->port_no = htons(opp->port_no);
1867     opp->config = htonl(opp->config);
1868     opp->state = htonl(opp->state);
1869     opp->curr = htonl(opp->curr);
1870     opp->advertised = htonl(opp->advertised);
1871     opp->supported = htonl(opp->supported);
1872     opp->peer = htonl(opp->peer);
1873 }
1874
1875 static int
1876 handle_echo_request(struct ofconn *ofconn, struct ofp_header *oh)
1877 {
1878     struct ofp_header *rq = oh;
1879     queue_tx(make_echo_reply(rq), ofconn, ofconn->reply_counter);
1880     return 0;
1881 }
1882
1883 static int
1884 handle_features_request(struct ofproto *p, struct ofconn *ofconn,
1885                         struct ofp_header *oh)
1886 {
1887     struct ofp_switch_features *osf;
1888     struct ofpbuf *buf;
1889     unsigned int port_no;
1890     struct ofport *port;
1891
1892     osf = make_openflow_xid(sizeof *osf, OFPT_FEATURES_REPLY, oh->xid, &buf);
1893     osf->datapath_id = htonll(p->datapath_id);
1894     osf->n_buffers = htonl(pktbuf_capacity());
1895     osf->n_tables = 2;
1896     osf->capabilities = htonl(OFPC_FLOW_STATS | OFPC_TABLE_STATS |
1897                               OFPC_PORT_STATS | OFPC_ARP_MATCH_IP);
1898     osf->actions = htonl((1u << OFPAT_OUTPUT) |
1899                          (1u << OFPAT_SET_VLAN_VID) |
1900                          (1u << OFPAT_SET_VLAN_PCP) |
1901                          (1u << OFPAT_STRIP_VLAN) |
1902                          (1u << OFPAT_SET_DL_SRC) |
1903                          (1u << OFPAT_SET_DL_DST) |
1904                          (1u << OFPAT_SET_NW_SRC) |
1905                          (1u << OFPAT_SET_NW_DST) |
1906                          (1u << OFPAT_SET_NW_TOS) |
1907                          (1u << OFPAT_SET_TP_SRC) |
1908                          (1u << OFPAT_SET_TP_DST));
1909
1910     PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
1911         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
1912     }
1913
1914     queue_tx(buf, ofconn, ofconn->reply_counter);
1915     return 0;
1916 }
1917
1918 static int
1919 handle_get_config_request(struct ofproto *p, struct ofconn *ofconn,
1920                           struct ofp_header *oh)
1921 {
1922     struct ofpbuf *buf;
1923     struct ofp_switch_config *osc;
1924     uint16_t flags;
1925     bool drop_frags;
1926
1927     /* Figure out flags. */
1928     dpif_get_drop_frags(p->dpif, &drop_frags);
1929     flags = drop_frags ? OFPC_FRAG_DROP : OFPC_FRAG_NORMAL;
1930
1931     /* Send reply. */
1932     osc = make_openflow_xid(sizeof *osc, OFPT_GET_CONFIG_REPLY, oh->xid, &buf);
1933     osc->flags = htons(flags);
1934     osc->miss_send_len = htons(ofconn->miss_send_len);
1935     queue_tx(buf, ofconn, ofconn->reply_counter);
1936
1937     return 0;
1938 }
1939
1940 static int
1941 handle_set_config(struct ofproto *p, struct ofconn *ofconn,
1942                   struct ofp_switch_config *osc)
1943 {
1944     uint16_t flags;
1945     int error;
1946
1947     error = check_ofp_message(&osc->header, OFPT_SET_CONFIG, sizeof *osc);
1948     if (error) {
1949         return error;
1950     }
1951     flags = ntohs(osc->flags);
1952
1953     if (ofconn == p->controller) {
1954         switch (flags & OFPC_FRAG_MASK) {
1955         case OFPC_FRAG_NORMAL:
1956             dpif_set_drop_frags(p->dpif, false);
1957             break;
1958         case OFPC_FRAG_DROP:
1959             dpif_set_drop_frags(p->dpif, true);
1960             break;
1961         default:
1962             VLOG_WARN_RL(&rl, "requested bad fragment mode (flags=%"PRIx16")",
1963                          osc->flags);
1964             break;
1965         }
1966     }
1967
1968     if ((ntohs(osc->miss_send_len) != 0) != (ofconn->miss_send_len != 0)) {
1969         if (ntohs(osc->miss_send_len) != 0) {
1970             ofconn->pktbuf = pktbuf_create();
1971         } else {
1972             pktbuf_destroy(ofconn->pktbuf);
1973         }
1974     }
1975
1976     ofconn->miss_send_len = ntohs(osc->miss_send_len);
1977
1978     return 0;
1979 }
1980
1981 static void
1982 add_output_group_action(struct odp_actions *actions, uint16_t group,
1983                         uint16_t *nf_output_iface)
1984 {
1985     odp_actions_add(actions, ODPAT_OUTPUT_GROUP)->output_group.group = group;
1986
1987     if (group == DP_GROUP_ALL || group == DP_GROUP_FLOOD) {
1988         *nf_output_iface = NF_OUT_FLOOD;
1989     }
1990 }
1991
1992 static void
1993 add_controller_action(struct odp_actions *actions,
1994                       const struct ofp_action_output *oao)
1995 {
1996     union odp_action *a = odp_actions_add(actions, ODPAT_CONTROLLER);
1997     a->controller.arg = oao->max_len ? ntohs(oao->max_len) : UINT32_MAX;
1998 }
1999
2000 struct action_xlate_ctx {
2001     /* Input. */
2002     const flow_t *flow;         /* Flow to which these actions correspond. */
2003     int recurse;                /* Recursion level, via xlate_table_action. */
2004     struct ofproto *ofproto;
2005     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
2006                                   * null pointer if we are revalidating
2007                                   * without a packet to refer to. */
2008
2009     /* Output. */
2010     struct odp_actions *out;    /* Datapath actions. */
2011     tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
2012     bool may_set_up_flow;       /* True ordinarily; false if the actions must
2013                                  * be reassessed for every packet. */
2014     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
2015 };
2016
2017 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
2018                              struct action_xlate_ctx *ctx);
2019
2020 static void
2021 add_output_action(struct action_xlate_ctx *ctx, uint16_t port)
2022 {
2023     const struct ofport *ofport = port_array_get(&ctx->ofproto->ports, port);
2024
2025     if (ofport) {
2026         if (ofport->opp.config & OFPPC_NO_FWD) {
2027             /* Forwarding disabled on port. */
2028             return;
2029         }
2030     } else {
2031         /*
2032          * We don't have an ofport record for this port, but it doesn't hurt to
2033          * allow forwarding to it anyhow.  Maybe such a port will appear later
2034          * and we're pre-populating the flow table.
2035          */
2036     }
2037
2038     odp_actions_add(ctx->out, ODPAT_OUTPUT)->output.port = port;
2039     ctx->nf_output_iface = port;
2040 }
2041
2042 static struct rule *
2043 lookup_valid_rule(struct ofproto *ofproto, const flow_t *flow)
2044 {
2045     struct rule *rule;
2046     rule = rule_from_cls_rule(classifier_lookup(&ofproto->cls, flow));
2047
2048     /* The rule we found might not be valid, since we could be in need of
2049      * revalidation.  If it is not valid, don't return it. */
2050     if (rule
2051         && rule->super
2052         && ofproto->need_revalidate
2053         && !revalidate_rule(ofproto, rule)) {
2054         COVERAGE_INC(ofproto_invalidated);
2055         return NULL;
2056     }
2057
2058     return rule;
2059 }
2060
2061 static void
2062 xlate_table_action(struct action_xlate_ctx *ctx, uint16_t in_port)
2063 {
2064     if (!ctx->recurse) {
2065         struct rule *rule;
2066         flow_t flow;
2067
2068         flow = *ctx->flow;
2069         flow.in_port = in_port;
2070
2071         rule = lookup_valid_rule(ctx->ofproto, &flow);
2072         if (rule) {
2073             if (rule->super) {
2074                 rule = rule->super;
2075             }
2076
2077             ctx->recurse++;
2078             do_xlate_actions(rule->actions, rule->n_actions, ctx);
2079             ctx->recurse--;
2080         }
2081     }
2082 }
2083
2084 static void
2085 xlate_output_action(struct action_xlate_ctx *ctx,
2086                     const struct ofp_action_output *oao)
2087 {
2088     uint16_t odp_port;
2089     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
2090
2091     ctx->nf_output_iface = NF_OUT_DROP;
2092
2093     switch (ntohs(oao->port)) {
2094     case OFPP_IN_PORT:
2095         add_output_action(ctx, ctx->flow->in_port);
2096         break;
2097     case OFPP_TABLE:
2098         xlate_table_action(ctx, ctx->flow->in_port);
2099         break;
2100     case OFPP_NORMAL:
2101         if (!ctx->ofproto->ofhooks->normal_cb(ctx->flow, ctx->packet,
2102                                               ctx->out, ctx->tags,
2103                                               &ctx->nf_output_iface,
2104                                               ctx->ofproto->aux)) {
2105             COVERAGE_INC(ofproto_uninstallable);
2106             ctx->may_set_up_flow = false;
2107         }
2108         break;
2109     case OFPP_FLOOD:
2110         add_output_group_action(ctx->out, DP_GROUP_FLOOD,
2111                                 &ctx->nf_output_iface);
2112         break;
2113     case OFPP_ALL:
2114         add_output_group_action(ctx->out, DP_GROUP_ALL, &ctx->nf_output_iface);
2115         break;
2116     case OFPP_CONTROLLER:
2117         add_controller_action(ctx->out, oao);
2118         break;
2119     case OFPP_LOCAL:
2120         add_output_action(ctx, ODPP_LOCAL);
2121         break;
2122     default:
2123         odp_port = ofp_port_to_odp_port(ntohs(oao->port));
2124         if (odp_port != ctx->flow->in_port) {
2125             add_output_action(ctx, odp_port);
2126         }
2127         break;
2128     }
2129
2130     if (prev_nf_output_iface == NF_OUT_FLOOD) {
2131         ctx->nf_output_iface = NF_OUT_FLOOD;
2132     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
2133         ctx->nf_output_iface = prev_nf_output_iface;
2134     } else if (prev_nf_output_iface != NF_OUT_DROP &&
2135                ctx->nf_output_iface != NF_OUT_FLOOD) {
2136         ctx->nf_output_iface = NF_OUT_MULTI;
2137     }
2138 }
2139
2140 static void
2141 xlate_nicira_action(struct action_xlate_ctx *ctx,
2142                     const struct nx_action_header *nah)
2143 {
2144     const struct nx_action_resubmit *nar;
2145     int subtype = ntohs(nah->subtype);
2146
2147     assert(nah->vendor == htonl(NX_VENDOR_ID));
2148     switch (subtype) {
2149     case NXAST_RESUBMIT:
2150         nar = (const struct nx_action_resubmit *) nah;
2151         xlate_table_action(ctx, ofp_port_to_odp_port(ntohs(nar->in_port)));
2152         break;
2153
2154     default:
2155         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
2156         break;
2157     }
2158 }
2159
2160 static void
2161 do_xlate_actions(const union ofp_action *in, size_t n_in,
2162                  struct action_xlate_ctx *ctx)
2163 {
2164     struct actions_iterator iter;
2165     const union ofp_action *ia;
2166     const struct ofport *port;
2167
2168     port = port_array_get(&ctx->ofproto->ports, ctx->flow->in_port);
2169     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
2170         port->opp.config & (eth_addr_equals(ctx->flow->dl_dst, stp_eth_addr)
2171                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
2172         /* Drop this flow. */
2173         return;
2174     }
2175
2176     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
2177         uint16_t type = ntohs(ia->type);
2178         union odp_action *oa;
2179
2180         switch (type) {
2181         case OFPAT_OUTPUT:
2182             xlate_output_action(ctx, &ia->output);
2183             break;
2184
2185         case OFPAT_SET_VLAN_VID:
2186             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_VID);
2187             oa->vlan_vid.vlan_vid = ia->vlan_vid.vlan_vid;
2188             break;
2189
2190         case OFPAT_SET_VLAN_PCP:
2191             oa = odp_actions_add(ctx->out, ODPAT_SET_VLAN_PCP);
2192             oa->vlan_pcp.vlan_pcp = ia->vlan_pcp.vlan_pcp;
2193             break;
2194
2195         case OFPAT_STRIP_VLAN:
2196             odp_actions_add(ctx->out, ODPAT_STRIP_VLAN);
2197             break;
2198
2199         case OFPAT_SET_DL_SRC:
2200             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_SRC);
2201             memcpy(oa->dl_addr.dl_addr,
2202                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2203             break;
2204
2205         case OFPAT_SET_DL_DST:
2206             oa = odp_actions_add(ctx->out, ODPAT_SET_DL_DST);
2207             memcpy(oa->dl_addr.dl_addr,
2208                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
2209             break;
2210
2211         case OFPAT_SET_NW_SRC:
2212             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_SRC);
2213             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2214             break;
2215
2216         case OFPAT_SET_NW_DST:
2217             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_DST);
2218             oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
2219             break;
2220
2221         case OFPAT_SET_NW_TOS:
2222             oa = odp_actions_add(ctx->out, ODPAT_SET_NW_TOS);
2223             oa->nw_tos.nw_tos = ia->nw_tos.nw_tos;
2224             break;
2225
2226         case OFPAT_SET_TP_SRC:
2227             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_SRC);
2228             oa->tp_port.tp_port = ia->tp_port.tp_port;
2229             break;
2230
2231         case OFPAT_SET_TP_DST:
2232             oa = odp_actions_add(ctx->out, ODPAT_SET_TP_DST);
2233             oa->tp_port.tp_port = ia->tp_port.tp_port;
2234             break;
2235
2236         case OFPAT_VENDOR:
2237             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
2238             break;
2239
2240         default:
2241             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
2242             break;
2243         }
2244     }
2245 }
2246
2247 static int
2248 xlate_actions(const union ofp_action *in, size_t n_in,
2249               const flow_t *flow, struct ofproto *ofproto,
2250               const struct ofpbuf *packet,
2251               struct odp_actions *out, tag_type *tags, bool *may_set_up_flow,
2252               uint16_t *nf_output_iface)
2253 {
2254     tag_type no_tags = 0;
2255     struct action_xlate_ctx ctx;
2256     COVERAGE_INC(ofproto_ofp2odp);
2257     odp_actions_init(out);
2258     ctx.flow = flow;
2259     ctx.recurse = 0;
2260     ctx.ofproto = ofproto;
2261     ctx.packet = packet;
2262     ctx.out = out;
2263     ctx.tags = tags ? tags : &no_tags;
2264     ctx.may_set_up_flow = true;
2265     ctx.nf_output_iface = NF_OUT_DROP;
2266     do_xlate_actions(in, n_in, &ctx);
2267
2268     /* Check with in-band control to see if we're allowed to set up this
2269      * flow. */
2270     if (!in_band_rule_check(ofproto->in_band, flow, out)) {
2271         ctx.may_set_up_flow = false;
2272     }
2273
2274     if (may_set_up_flow) {
2275         *may_set_up_flow = ctx.may_set_up_flow;
2276     }
2277     if (nf_output_iface) {
2278         *nf_output_iface = ctx.nf_output_iface;
2279     }
2280     if (odp_actions_overflow(out)) {
2281         odp_actions_init(out);
2282         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
2283     }
2284     return 0;
2285 }
2286
2287 static int
2288 handle_packet_out(struct ofproto *p, struct ofconn *ofconn,
2289                   struct ofp_header *oh)
2290 {
2291     struct ofp_packet_out *opo;
2292     struct ofpbuf payload, *buffer;
2293     struct odp_actions actions;
2294     int n_actions;
2295     uint16_t in_port;
2296     flow_t flow;
2297     int error;
2298
2299     error = check_ofp_packet_out(oh, &payload, &n_actions, p->max_ports);
2300     if (error) {
2301         return error;
2302     }
2303     opo = (struct ofp_packet_out *) oh;
2304
2305     COVERAGE_INC(ofproto_packet_out);
2306     if (opo->buffer_id != htonl(UINT32_MAX)) {
2307         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(opo->buffer_id),
2308                                 &buffer, &in_port);
2309         if (error || !buffer) {
2310             return error;
2311         }
2312         payload = *buffer;
2313     } else {
2314         buffer = NULL;
2315     }
2316
2317     flow_extract(&payload, ofp_port_to_odp_port(ntohs(opo->in_port)), &flow);
2318     error = xlate_actions((const union ofp_action *) opo->actions, n_actions,
2319                           &flow, p, &payload, &actions, NULL, NULL, NULL);
2320     if (error) {
2321         return error;
2322     }
2323
2324     dpif_execute(p->dpif, flow.in_port, actions.actions, actions.n_actions,
2325                  &payload);
2326     ofpbuf_delete(buffer);
2327
2328     return 0;
2329 }
2330
2331 static void
2332 update_port_config(struct ofproto *p, struct ofport *port,
2333                    uint32_t config, uint32_t mask)
2334 {
2335     mask &= config ^ port->opp.config;
2336     if (mask & OFPPC_PORT_DOWN) {
2337         if (config & OFPPC_PORT_DOWN) {
2338             netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
2339         } else {
2340             netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
2341         }
2342     }
2343 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
2344     if (mask & REVALIDATE_BITS) {
2345         COVERAGE_INC(ofproto_costly_flags);
2346         port->opp.config ^= mask & REVALIDATE_BITS;
2347         p->need_revalidate = true;
2348     }
2349 #undef REVALIDATE_BITS
2350     if (mask & OFPPC_NO_FLOOD) {
2351         port->opp.config ^= OFPPC_NO_FLOOD;
2352         refresh_port_groups(p);
2353     }
2354     if (mask & OFPPC_NO_PACKET_IN) {
2355         port->opp.config ^= OFPPC_NO_PACKET_IN;
2356     }
2357 }
2358
2359 static int
2360 handle_port_mod(struct ofproto *p, struct ofp_header *oh)
2361 {
2362     const struct ofp_port_mod *opm;
2363     struct ofport *port;
2364     int error;
2365
2366     error = check_ofp_message(oh, OFPT_PORT_MOD, sizeof *opm);
2367     if (error) {
2368         return error;
2369     }
2370     opm = (struct ofp_port_mod *) oh;
2371
2372     port = port_array_get(&p->ports,
2373                           ofp_port_to_odp_port(ntohs(opm->port_no)));
2374     if (!port) {
2375         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT);
2376     } else if (memcmp(port->opp.hw_addr, opm->hw_addr, OFP_ETH_ALEN)) {
2377         return ofp_mkerr(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR);
2378     } else {
2379         update_port_config(p, port, ntohl(opm->config), ntohl(opm->mask));
2380         if (opm->advertise) {
2381             netdev_set_advertisements(port->netdev, ntohl(opm->advertise));
2382         }
2383     }
2384     return 0;
2385 }
2386
2387 static struct ofpbuf *
2388 make_stats_reply(uint32_t xid, uint16_t type, size_t body_len)
2389 {
2390     struct ofp_stats_reply *osr;
2391     struct ofpbuf *msg;
2392
2393     msg = ofpbuf_new(MIN(sizeof *osr + body_len, UINT16_MAX));
2394     osr = put_openflow_xid(sizeof *osr, OFPT_STATS_REPLY, xid, msg);
2395     osr->type = type;
2396     osr->flags = htons(0);
2397     return msg;
2398 }
2399
2400 static struct ofpbuf *
2401 start_stats_reply(const struct ofp_stats_request *request, size_t body_len)
2402 {
2403     return make_stats_reply(request->header.xid, request->type, body_len);
2404 }
2405
2406 static void *
2407 append_stats_reply(size_t nbytes, struct ofconn *ofconn, struct ofpbuf **msgp)
2408 {
2409     struct ofpbuf *msg = *msgp;
2410     assert(nbytes <= UINT16_MAX - sizeof(struct ofp_stats_reply));
2411     if (nbytes + msg->size > UINT16_MAX) {
2412         struct ofp_stats_reply *reply = msg->data;
2413         reply->flags = htons(OFPSF_REPLY_MORE);
2414         *msgp = make_stats_reply(reply->header.xid, reply->type, nbytes);
2415         queue_tx(msg, ofconn, ofconn->reply_counter);
2416     }
2417     return ofpbuf_put_uninit(*msgp, nbytes);
2418 }
2419
2420 static int
2421 handle_desc_stats_request(struct ofproto *p, struct ofconn *ofconn,
2422                            struct ofp_stats_request *request)
2423 {
2424     struct ofp_desc_stats *ods;
2425     struct ofpbuf *msg;
2426
2427     msg = start_stats_reply(request, sizeof *ods);
2428     ods = append_stats_reply(sizeof *ods, ofconn, &msg);
2429     memset(ods, 0, sizeof *ods);
2430     ovs_strlcpy(ods->mfr_desc, p->mfr_desc, sizeof ods->mfr_desc);
2431     ovs_strlcpy(ods->hw_desc, p->hw_desc, sizeof ods->hw_desc);
2432     ovs_strlcpy(ods->sw_desc, p->sw_desc, sizeof ods->sw_desc);
2433     ovs_strlcpy(ods->serial_num, p->serial_desc, sizeof ods->serial_num);
2434     ovs_strlcpy(ods->dp_desc, p->dp_desc, sizeof ods->dp_desc);
2435     queue_tx(msg, ofconn, ofconn->reply_counter);
2436
2437     return 0;
2438 }
2439
2440 static void
2441 count_subrules(struct cls_rule *cls_rule, void *n_subrules_)
2442 {
2443     struct rule *rule = rule_from_cls_rule(cls_rule);
2444     int *n_subrules = n_subrules_;
2445
2446     if (rule->super) {
2447         (*n_subrules)++;
2448     }
2449 }
2450
2451 static int
2452 handle_table_stats_request(struct ofproto *p, struct ofconn *ofconn,
2453                            struct ofp_stats_request *request)
2454 {
2455     struct ofp_table_stats *ots;
2456     struct ofpbuf *msg;
2457     struct odp_stats dpstats;
2458     int n_exact, n_subrules, n_wild;
2459
2460     msg = start_stats_reply(request, sizeof *ots * 2);
2461
2462     /* Count rules of various kinds. */
2463     n_subrules = 0;
2464     classifier_for_each(&p->cls, CLS_INC_EXACT, count_subrules, &n_subrules);
2465     n_exact = classifier_count_exact(&p->cls) - n_subrules;
2466     n_wild = classifier_count(&p->cls) - classifier_count_exact(&p->cls);
2467
2468     /* Hash table. */
2469     dpif_get_dp_stats(p->dpif, &dpstats);
2470     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2471     memset(ots, 0, sizeof *ots);
2472     ots->table_id = TABLEID_HASH;
2473     strcpy(ots->name, "hash");
2474     ots->wildcards = htonl(0);
2475     ots->max_entries = htonl(dpstats.max_capacity);
2476     ots->active_count = htonl(n_exact);
2477     ots->lookup_count = htonll(dpstats.n_frags + dpstats.n_hit +
2478                                dpstats.n_missed);
2479     ots->matched_count = htonll(dpstats.n_hit); /* XXX */
2480
2481     /* Classifier table. */
2482     ots = append_stats_reply(sizeof *ots, ofconn, &msg);
2483     memset(ots, 0, sizeof *ots);
2484     ots->table_id = TABLEID_CLASSIFIER;
2485     strcpy(ots->name, "classifier");
2486     ots->wildcards = htonl(OFPFW_ALL);
2487     ots->max_entries = htonl(65536);
2488     ots->active_count = htonl(n_wild);
2489     ots->lookup_count = htonll(0);              /* XXX */
2490     ots->matched_count = htonll(0);             /* XXX */
2491
2492     queue_tx(msg, ofconn, ofconn->reply_counter);
2493     return 0;
2494 }
2495
2496 static void
2497 append_port_stat(struct ofport *port, uint16_t port_no, struct ofconn *ofconn,
2498                  struct ofpbuf *msg)
2499 {
2500     struct netdev_stats stats;
2501     struct ofp_port_stats *ops;
2502
2503     /* Intentionally ignore return value, since errors will set
2504      * 'stats' to all-1s, which is correct for OpenFlow, and
2505      * netdev_get_stats() will log errors. */
2506     netdev_get_stats(port->netdev, &stats);
2507
2508     ops = append_stats_reply(sizeof *ops, ofconn, &msg);
2509     ops->port_no = htons(odp_port_to_ofp_port(port_no));
2510     memset(ops->pad, 0, sizeof ops->pad);
2511     ops->rx_packets = htonll(stats.rx_packets);
2512     ops->tx_packets = htonll(stats.tx_packets);
2513     ops->rx_bytes = htonll(stats.rx_bytes);
2514     ops->tx_bytes = htonll(stats.tx_bytes);
2515     ops->rx_dropped = htonll(stats.rx_dropped);
2516     ops->tx_dropped = htonll(stats.tx_dropped);
2517     ops->rx_errors = htonll(stats.rx_errors);
2518     ops->tx_errors = htonll(stats.tx_errors);
2519     ops->rx_frame_err = htonll(stats.rx_frame_errors);
2520     ops->rx_over_err = htonll(stats.rx_over_errors);
2521     ops->rx_crc_err = htonll(stats.rx_crc_errors);
2522     ops->collisions = htonll(stats.collisions);
2523 }
2524
2525 static int
2526 handle_port_stats_request(struct ofproto *p, struct ofconn *ofconn,
2527                           struct ofp_stats_request *osr,
2528                           size_t arg_size)
2529 {
2530     struct ofp_port_stats_request *psr;
2531     struct ofp_port_stats *ops;
2532     struct ofpbuf *msg;
2533     struct ofport *port;
2534     unsigned int port_no;
2535
2536     if (arg_size != sizeof *psr) {
2537         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2538     }
2539     psr = (struct ofp_port_stats_request *) osr->body;
2540
2541     msg = start_stats_reply(osr, sizeof *ops * 16);
2542     if (psr->port_no != htons(OFPP_NONE)) {
2543         port = port_array_get(&p->ports,
2544                 ofp_port_to_odp_port(ntohs(psr->port_no)));
2545         if (port) {
2546             append_port_stat(port, ntohs(psr->port_no), ofconn, msg);
2547         }
2548     } else {
2549         PORT_ARRAY_FOR_EACH (port, &p->ports, port_no) {
2550             append_port_stat(port, port_no, ofconn, msg);
2551         }
2552     }
2553
2554     queue_tx(msg, ofconn, ofconn->reply_counter);
2555     return 0;
2556 }
2557
2558 struct flow_stats_cbdata {
2559     struct ofproto *ofproto;
2560     struct ofconn *ofconn;
2561     uint16_t out_port;
2562     struct ofpbuf *msg;
2563 };
2564
2565 /* Obtains statistic counters for 'rule' within 'p' and stores them into
2566  * '*packet_countp' and '*byte_countp'.  If 'rule' is a wildcarded rule, the
2567  * returned statistic include statistics for all of 'rule''s subrules. */
2568 static void
2569 query_stats(struct ofproto *p, struct rule *rule,
2570             uint64_t *packet_countp, uint64_t *byte_countp)
2571 {
2572     uint64_t packet_count, byte_count;
2573     struct rule *subrule;
2574     struct odp_flow *odp_flows;
2575     size_t n_odp_flows;
2576
2577     /* Start from historical data for 'rule' itself that are no longer tracked
2578      * by the datapath.  This counts, for example, subrules that have
2579      * expired. */
2580     packet_count = rule->packet_count;
2581     byte_count = rule->byte_count;
2582
2583     /* Prepare to ask the datapath for statistics on 'rule', or if it is
2584      * wildcarded then on all of its subrules.
2585      *
2586      * Also, add any statistics that are not tracked by the datapath for each
2587      * subrule.  This includes, for example, statistics for packets that were
2588      * executed "by hand" by ofproto via dpif_execute() but must be accounted
2589      * to a flow. */
2590     n_odp_flows = rule->cr.wc.wildcards ? list_size(&rule->list) : 1;
2591     odp_flows = xzalloc(n_odp_flows * sizeof *odp_flows);
2592     if (rule->cr.wc.wildcards) {
2593         size_t i = 0;
2594         LIST_FOR_EACH (subrule, struct rule, list, &rule->list) {
2595             odp_flows[i++].key = subrule->cr.flow;
2596             packet_count += subrule->packet_count;
2597             byte_count += subrule->byte_count;
2598         }
2599     } else {
2600         odp_flows[0].key = rule->cr.flow;
2601     }
2602
2603     /* Fetch up-to-date statistics from the datapath and add them in. */
2604     if (!dpif_flow_get_multiple(p->dpif, odp_flows, n_odp_flows)) {
2605         size_t i;
2606         for (i = 0; i < n_odp_flows; i++) {
2607             struct odp_flow *odp_flow = &odp_flows[i];
2608             packet_count += odp_flow->stats.n_packets;
2609             byte_count += odp_flow->stats.n_bytes;
2610         }
2611     }
2612     free(odp_flows);
2613
2614     /* Return the stats to the caller. */
2615     *packet_countp = packet_count;
2616     *byte_countp = byte_count;
2617 }
2618
2619 static void
2620 flow_stats_cb(struct cls_rule *rule_, void *cbdata_)
2621 {
2622     struct rule *rule = rule_from_cls_rule(rule_);
2623     struct flow_stats_cbdata *cbdata = cbdata_;
2624     struct ofp_flow_stats *ofs;
2625     uint64_t packet_count, byte_count;
2626     size_t act_len, len;
2627     long long int tdiff = time_msec() - rule->created;
2628     uint32_t sec = tdiff / 1000;
2629     uint32_t msec = tdiff - (sec * 1000);
2630
2631     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2632         return;
2633     }
2634
2635     act_len = sizeof *rule->actions * rule->n_actions;
2636     len = offsetof(struct ofp_flow_stats, actions) + act_len;
2637
2638     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2639
2640     ofs = append_stats_reply(len, cbdata->ofconn, &cbdata->msg);
2641     ofs->length = htons(len);
2642     ofs->table_id = rule->cr.wc.wildcards ? TABLEID_CLASSIFIER : TABLEID_HASH;
2643     ofs->pad = 0;
2644     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofs->match);
2645     ofs->duration_sec = htonl(sec);
2646     ofs->duration_nsec = htonl(msec * 1000000);
2647     ofs->cookie = rule->flow_cookie;
2648     ofs->priority = htons(rule->cr.priority);
2649     ofs->idle_timeout = htons(rule->idle_timeout);
2650     ofs->hard_timeout = htons(rule->hard_timeout);
2651     memset(ofs->pad2, 0, sizeof ofs->pad2);
2652     ofs->packet_count = htonll(packet_count);
2653     ofs->byte_count = htonll(byte_count);
2654     memcpy(ofs->actions, rule->actions, act_len);
2655 }
2656
2657 static int
2658 table_id_to_include(uint8_t table_id)
2659 {
2660     return (table_id == TABLEID_HASH ? CLS_INC_EXACT
2661             : table_id == TABLEID_CLASSIFIER ? CLS_INC_WILD
2662             : table_id == 0xff ? CLS_INC_ALL
2663             : 0);
2664 }
2665
2666 static int
2667 handle_flow_stats_request(struct ofproto *p, struct ofconn *ofconn,
2668                           const struct ofp_stats_request *osr,
2669                           size_t arg_size)
2670 {
2671     struct ofp_flow_stats_request *fsr;
2672     struct flow_stats_cbdata cbdata;
2673     struct cls_rule target;
2674
2675     if (arg_size != sizeof *fsr) {
2676         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2677     }
2678     fsr = (struct ofp_flow_stats_request *) osr->body;
2679
2680     COVERAGE_INC(ofproto_flows_req);
2681     cbdata.ofproto = p;
2682     cbdata.ofconn = ofconn;
2683     cbdata.out_port = fsr->out_port;
2684     cbdata.msg = start_stats_reply(osr, 1024);
2685     cls_rule_from_match(&target, &fsr->match, 0);
2686     classifier_for_each_match(&p->cls, &target,
2687                               table_id_to_include(fsr->table_id),
2688                               flow_stats_cb, &cbdata);
2689     queue_tx(cbdata.msg, ofconn, ofconn->reply_counter);
2690     return 0;
2691 }
2692
2693 struct flow_stats_ds_cbdata {
2694     struct ofproto *ofproto;
2695     struct ds *results;
2696 };
2697
2698 static void
2699 flow_stats_ds_cb(struct cls_rule *rule_, void *cbdata_)
2700 {
2701     struct rule *rule = rule_from_cls_rule(rule_);
2702     struct flow_stats_ds_cbdata *cbdata = cbdata_;
2703     struct ds *results = cbdata->results;
2704     struct ofp_match match;
2705     uint64_t packet_count, byte_count;
2706     size_t act_len = sizeof *rule->actions * rule->n_actions;
2707
2708     /* Don't report on subrules. */
2709     if (rule->super != NULL) {
2710         return;
2711     }
2712
2713     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2714     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &match);
2715
2716     ds_put_format(results, "duration=%llds, ",
2717                   (time_msec() - rule->created) / 1000);
2718     ds_put_format(results, "priority=%u, ", rule->cr.priority);
2719     ds_put_format(results, "n_packets=%"PRIu64", ", packet_count);
2720     ds_put_format(results, "n_bytes=%"PRIu64", ", byte_count);
2721     ofp_print_match(results, &match, true);
2722     ofp_print_actions(results, &rule->actions->header, act_len);
2723     ds_put_cstr(results, "\n");
2724 }
2725
2726 /* Adds a pretty-printed description of all flows to 'results', including
2727  * those marked hidden by secchan (e.g., by in-band control). */
2728 void
2729 ofproto_get_all_flows(struct ofproto *p, struct ds *results)
2730 {
2731     struct ofp_match match;
2732     struct cls_rule target;
2733     struct flow_stats_ds_cbdata cbdata;
2734
2735     memset(&match, 0, sizeof match);
2736     match.wildcards = htonl(OFPFW_ALL);
2737
2738     cbdata.ofproto = p;
2739     cbdata.results = results;
2740
2741     cls_rule_from_match(&target, &match, 0);
2742     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
2743                               flow_stats_ds_cb, &cbdata);
2744 }
2745
2746 struct aggregate_stats_cbdata {
2747     struct ofproto *ofproto;
2748     uint16_t out_port;
2749     uint64_t packet_count;
2750     uint64_t byte_count;
2751     uint32_t n_flows;
2752 };
2753
2754 static void
2755 aggregate_stats_cb(struct cls_rule *rule_, void *cbdata_)
2756 {
2757     struct rule *rule = rule_from_cls_rule(rule_);
2758     struct aggregate_stats_cbdata *cbdata = cbdata_;
2759     uint64_t packet_count, byte_count;
2760
2761     if (rule_is_hidden(rule) || !rule_has_out_port(rule, cbdata->out_port)) {
2762         return;
2763     }
2764
2765     query_stats(cbdata->ofproto, rule, &packet_count, &byte_count);
2766
2767     cbdata->packet_count += packet_count;
2768     cbdata->byte_count += byte_count;
2769     cbdata->n_flows++;
2770 }
2771
2772 static int
2773 handle_aggregate_stats_request(struct ofproto *p, struct ofconn *ofconn,
2774                                const struct ofp_stats_request *osr,
2775                                size_t arg_size)
2776 {
2777     struct ofp_aggregate_stats_request *asr;
2778     struct ofp_aggregate_stats_reply *reply;
2779     struct aggregate_stats_cbdata cbdata;
2780     struct cls_rule target;
2781     struct ofpbuf *msg;
2782
2783     if (arg_size != sizeof *asr) {
2784         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
2785     }
2786     asr = (struct ofp_aggregate_stats_request *) osr->body;
2787
2788     COVERAGE_INC(ofproto_agg_request);
2789     cbdata.ofproto = p;
2790     cbdata.out_port = asr->out_port;
2791     cbdata.packet_count = 0;
2792     cbdata.byte_count = 0;
2793     cbdata.n_flows = 0;
2794     cls_rule_from_match(&target, &asr->match, 0);
2795     classifier_for_each_match(&p->cls, &target,
2796                               table_id_to_include(asr->table_id),
2797                               aggregate_stats_cb, &cbdata);
2798
2799     msg = start_stats_reply(osr, sizeof *reply);
2800     reply = append_stats_reply(sizeof *reply, ofconn, &msg);
2801     reply->flow_count = htonl(cbdata.n_flows);
2802     reply->packet_count = htonll(cbdata.packet_count);
2803     reply->byte_count = htonll(cbdata.byte_count);
2804     queue_tx(msg, ofconn, ofconn->reply_counter);
2805     return 0;
2806 }
2807
2808 static int
2809 handle_stats_request(struct ofproto *p, struct ofconn *ofconn,
2810                      struct ofp_header *oh)
2811 {
2812     struct ofp_stats_request *osr;
2813     size_t arg_size;
2814     int error;
2815
2816     error = check_ofp_message_array(oh, OFPT_STATS_REQUEST, sizeof *osr,
2817                                     1, &arg_size);
2818     if (error) {
2819         return error;
2820     }
2821     osr = (struct ofp_stats_request *) oh;
2822
2823     switch (ntohs(osr->type)) {
2824     case OFPST_DESC:
2825         return handle_desc_stats_request(p, ofconn, osr);
2826
2827     case OFPST_FLOW:
2828         return handle_flow_stats_request(p, ofconn, osr, arg_size);
2829
2830     case OFPST_AGGREGATE:
2831         return handle_aggregate_stats_request(p, ofconn, osr, arg_size);
2832
2833     case OFPST_TABLE:
2834         return handle_table_stats_request(p, ofconn, osr);
2835
2836     case OFPST_PORT:
2837         return handle_port_stats_request(p, ofconn, osr, arg_size);
2838
2839     case OFPST_VENDOR:
2840         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
2841
2842     default:
2843         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT);
2844     }
2845 }
2846
2847 static long long int
2848 msec_from_nsec(uint64_t sec, uint32_t nsec)
2849 {
2850     return !sec ? 0 : sec * 1000 + nsec / 1000000;
2851 }
2852
2853 static void
2854 update_time(struct ofproto *ofproto, struct rule *rule,
2855             const struct odp_flow_stats *stats)
2856 {
2857     long long int used = msec_from_nsec(stats->used_sec, stats->used_nsec);
2858     if (used > rule->used) {
2859         rule->used = used;
2860         if (rule->super && used > rule->super->used) {
2861             rule->super->used = used;
2862         }
2863         netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
2864     }
2865 }
2866
2867 static void
2868 update_stats(struct ofproto *ofproto, struct rule *rule,
2869              const struct odp_flow_stats *stats)
2870 {
2871     if (stats->n_packets) {
2872         update_time(ofproto, rule, stats);
2873         rule->packet_count += stats->n_packets;
2874         rule->byte_count += stats->n_bytes;
2875         netflow_flow_update_flags(&rule->nf_flow, stats->ip_tos,
2876                                   stats->tcp_flags);
2877     }
2878 }
2879
2880 /* Implements OFPFC_ADD and the cases for OFPFC_MODIFY and OFPFC_MODIFY_STRICT
2881  * in which no matching flow already exists in the flow table.
2882  *
2883  * Adds the flow specified by 'ofm', which is followed by 'n_actions'
2884  * ofp_actions, to 'p''s flow table.  Returns 0 on success or an OpenFlow error
2885  * code as encoded by ofp_mkerr() on failure.
2886  *
2887  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2888  * if any. */
2889 static int
2890 add_flow(struct ofproto *p, struct ofconn *ofconn,
2891          const struct ofp_flow_mod *ofm, size_t n_actions)
2892 {
2893     struct ofpbuf *packet;
2894     struct rule *rule;
2895     uint16_t in_port;
2896     int error;
2897
2898     if (ofm->flags & htons(OFPFF_CHECK_OVERLAP)) {
2899         flow_t flow;
2900         uint32_t wildcards;
2901
2902         flow_from_match(&flow, &wildcards, &ofm->match);
2903         if (classifier_rule_overlaps(&p->cls, &flow, wildcards,
2904                                      ntohs(ofm->priority))) {
2905             return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP);
2906         }
2907     }
2908
2909     rule = rule_create(p, NULL, (const union ofp_action *) ofm->actions,
2910                        n_actions, ntohs(ofm->idle_timeout),
2911                        ntohs(ofm->hard_timeout),  ofm->cookie,
2912                        ofm->flags & htons(OFPFF_SEND_FLOW_REM));
2913     cls_rule_from_match(&rule->cr, &ofm->match, ntohs(ofm->priority));
2914
2915     error = 0;
2916     if (ofm->buffer_id != htonl(UINT32_MAX)) {
2917         error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
2918                                 &packet, &in_port);
2919     } else {
2920         packet = NULL;
2921         in_port = UINT16_MAX;
2922     }
2923
2924     rule_insert(p, rule, packet, in_port);
2925     ofpbuf_delete(packet);
2926     return error;
2927 }
2928
2929 static struct rule *
2930 find_flow_strict(struct ofproto *p, const struct ofp_flow_mod *ofm)
2931 {
2932     uint32_t wildcards;
2933     flow_t flow;
2934
2935     flow_from_match(&flow, &wildcards, &ofm->match);
2936     return rule_from_cls_rule(classifier_find_rule_exactly(
2937                                   &p->cls, &flow, wildcards,
2938                                   ntohs(ofm->priority)));
2939 }
2940
2941 static int
2942 send_buffered_packet(struct ofproto *ofproto, struct ofconn *ofconn,
2943                      struct rule *rule, const struct ofp_flow_mod *ofm)
2944 {
2945     struct ofpbuf *packet;
2946     uint16_t in_port;
2947     flow_t flow;
2948     int error;
2949
2950     if (ofm->buffer_id == htonl(UINT32_MAX)) {
2951         return 0;
2952     }
2953
2954     error = pktbuf_retrieve(ofconn->pktbuf, ntohl(ofm->buffer_id),
2955                             &packet, &in_port);
2956     if (error) {
2957         return error;
2958     }
2959
2960     flow_extract(packet, in_port, &flow);
2961     rule_execute(ofproto, rule, packet, &flow);
2962     ofpbuf_delete(packet);
2963
2964     return 0;
2965 }
2966 \f
2967 /* OFPFC_MODIFY and OFPFC_MODIFY_STRICT. */
2968
2969 struct modify_flows_cbdata {
2970     struct ofproto *ofproto;
2971     const struct ofp_flow_mod *ofm;
2972     size_t n_actions;
2973     struct rule *match;
2974 };
2975
2976 static int modify_flow(struct ofproto *, const struct ofp_flow_mod *,
2977                        size_t n_actions, struct rule *);
2978 static void modify_flows_cb(struct cls_rule *, void *cbdata_);
2979
2980 /* Implements OFPFC_MODIFY.  Returns 0 on success or an OpenFlow error code as
2981  * encoded by ofp_mkerr() on failure.
2982  *
2983  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
2984  * if any. */
2985 static int
2986 modify_flows_loose(struct ofproto *p, struct ofconn *ofconn,
2987                    const struct ofp_flow_mod *ofm, size_t n_actions)
2988 {
2989     struct modify_flows_cbdata cbdata;
2990     struct cls_rule target;
2991
2992     cbdata.ofproto = p;
2993     cbdata.ofm = ofm;
2994     cbdata.n_actions = n_actions;
2995     cbdata.match = NULL;
2996
2997     cls_rule_from_match(&target, &ofm->match, 0);
2998
2999     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3000                               modify_flows_cb, &cbdata);
3001     if (cbdata.match) {
3002         /* This credits the packet to whichever flow happened to happened to
3003          * match last.  That's weird.  Maybe we should do a lookup for the
3004          * flow that actually matches the packet?  Who knows. */
3005         send_buffered_packet(p, ofconn, cbdata.match, ofm);
3006         return 0;
3007     } else {
3008         return add_flow(p, ofconn, ofm, n_actions);
3009     }
3010 }
3011
3012 /* Implements OFPFC_MODIFY_STRICT.  Returns 0 on success or an OpenFlow error
3013  * code as encoded by ofp_mkerr() on failure.
3014  *
3015  * 'ofconn' is used to retrieve the packet buffer specified in ofm->buffer_id,
3016  * if any. */
3017 static int
3018 modify_flow_strict(struct ofproto *p, struct ofconn *ofconn,
3019                    struct ofp_flow_mod *ofm, size_t n_actions)
3020 {
3021     struct rule *rule = find_flow_strict(p, ofm);
3022     if (rule && !rule_is_hidden(rule)) {
3023         modify_flow(p, ofm, n_actions, rule);
3024         return send_buffered_packet(p, ofconn, rule, ofm);
3025     } else {
3026         return add_flow(p, ofconn, ofm, n_actions);
3027     }
3028 }
3029
3030 /* Callback for modify_flows_loose(). */
3031 static void
3032 modify_flows_cb(struct cls_rule *rule_, void *cbdata_)
3033 {
3034     struct rule *rule = rule_from_cls_rule(rule_);
3035     struct modify_flows_cbdata *cbdata = cbdata_;
3036
3037     if (!rule_is_hidden(rule)) {
3038         cbdata->match = rule;
3039         modify_flow(cbdata->ofproto, cbdata->ofm, cbdata->n_actions, rule);
3040     }
3041 }
3042
3043 /* Implements core of OFPFC_MODIFY and OFPFC_MODIFY_STRICT where 'rule' has
3044  * been identified as a flow in 'p''s flow table to be modified, by changing
3045  * the rule's actions to match those in 'ofm' (which is followed by 'n_actions'
3046  * ofp_action[] structures). */
3047 static int
3048 modify_flow(struct ofproto *p, const struct ofp_flow_mod *ofm,
3049             size_t n_actions, struct rule *rule)
3050 {
3051     size_t actions_len = n_actions * sizeof *rule->actions;
3052
3053     rule->flow_cookie = ofm->cookie;
3054
3055     /* If the actions are the same, do nothing. */
3056     if (n_actions == rule->n_actions
3057         && !memcmp(ofm->actions, rule->actions, actions_len))
3058     {
3059         return 0;
3060     }
3061
3062     /* Replace actions. */
3063     free(rule->actions);
3064     rule->actions = xmemdup(ofm->actions, actions_len);
3065     rule->n_actions = n_actions;
3066
3067     /* Make sure that the datapath gets updated properly. */
3068     if (rule->cr.wc.wildcards) {
3069         COVERAGE_INC(ofproto_mod_wc_flow);
3070         p->need_revalidate = true;
3071     } else {
3072         rule_update_actions(p, rule);
3073     }
3074
3075     return 0;
3076 }
3077 \f
3078 /* OFPFC_DELETE implementation. */
3079
3080 struct delete_flows_cbdata {
3081     struct ofproto *ofproto;
3082     uint16_t out_port;
3083 };
3084
3085 static void delete_flows_cb(struct cls_rule *, void *cbdata_);
3086 static void delete_flow(struct ofproto *, struct rule *, uint16_t out_port);
3087
3088 /* Implements OFPFC_DELETE. */
3089 static void
3090 delete_flows_loose(struct ofproto *p, const struct ofp_flow_mod *ofm)
3091 {
3092     struct delete_flows_cbdata cbdata;
3093     struct cls_rule target;
3094
3095     cbdata.ofproto = p;
3096     cbdata.out_port = ofm->out_port;
3097
3098     cls_rule_from_match(&target, &ofm->match, 0);
3099
3100     classifier_for_each_match(&p->cls, &target, CLS_INC_ALL,
3101                               delete_flows_cb, &cbdata);
3102 }
3103
3104 /* Implements OFPFC_DELETE_STRICT. */
3105 static void
3106 delete_flow_strict(struct ofproto *p, struct ofp_flow_mod *ofm)
3107 {
3108     struct rule *rule = find_flow_strict(p, ofm);
3109     if (rule) {
3110         delete_flow(p, rule, ofm->out_port);
3111     }
3112 }
3113
3114 /* Callback for delete_flows_loose(). */
3115 static void
3116 delete_flows_cb(struct cls_rule *rule_, void *cbdata_)
3117 {
3118     struct rule *rule = rule_from_cls_rule(rule_);
3119     struct delete_flows_cbdata *cbdata = cbdata_;
3120
3121     delete_flow(cbdata->ofproto, rule, cbdata->out_port);
3122 }
3123
3124 /* Implements core of OFPFC_DELETE and OFPFC_DELETE_STRICT where 'rule' has
3125  * been identified as a flow to delete from 'p''s flow table, by deleting the
3126  * flow and sending out a OFPT_FLOW_REMOVED message to any interested
3127  * controller.
3128  *
3129  * Will not delete 'rule' if it is hidden.  Will delete 'rule' only if
3130  * 'out_port' is htons(OFPP_NONE) or if 'rule' actually outputs to the
3131  * specified 'out_port'. */
3132 static void
3133 delete_flow(struct ofproto *p, struct rule *rule, uint16_t out_port)
3134 {
3135     if (rule_is_hidden(rule)) {
3136         return;
3137     }
3138
3139     if (out_port != htons(OFPP_NONE) && !rule_has_out_port(rule, out_port)) {
3140         return;
3141     }
3142
3143     send_flow_removed(p, rule, time_msec(), OFPRR_DELETE);
3144     rule_remove(p, rule);
3145 }
3146 \f
3147 static int
3148 handle_flow_mod(struct ofproto *p, struct ofconn *ofconn,
3149                 struct ofp_flow_mod *ofm)
3150 {
3151     size_t n_actions;
3152     int error;
3153
3154     error = check_ofp_message_array(&ofm->header, OFPT_FLOW_MOD, sizeof *ofm,
3155                                     sizeof *ofm->actions, &n_actions);
3156     if (error) {
3157         return error;
3158     }
3159
3160     /* We do not support the emergency flow cache.  It will hopefully
3161      * get dropped from OpenFlow in the near future. */
3162     if (ofm->flags & htons(OFPFF_EMERG)) {
3163         /* There isn't a good fit for an error code, so just state that the
3164          * flow table is full. */
3165         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL);
3166     }
3167
3168     normalize_match(&ofm->match);
3169     if (!ofm->match.wildcards) {
3170         ofm->priority = htons(UINT16_MAX);
3171     }
3172
3173     error = validate_actions((const union ofp_action *) ofm->actions,
3174                              n_actions, p->max_ports);
3175     if (error) {
3176         return error;
3177     }
3178
3179     switch (ntohs(ofm->command)) {
3180     case OFPFC_ADD:
3181         return add_flow(p, ofconn, ofm, n_actions);
3182
3183     case OFPFC_MODIFY:
3184         return modify_flows_loose(p, ofconn, ofm, n_actions);
3185
3186     case OFPFC_MODIFY_STRICT:
3187         return modify_flow_strict(p, ofconn, ofm, n_actions);
3188
3189     case OFPFC_DELETE:
3190         delete_flows_loose(p, ofm);
3191         return 0;
3192
3193     case OFPFC_DELETE_STRICT:
3194         delete_flow_strict(p, ofm);
3195         return 0;
3196
3197     default:
3198         return ofp_mkerr(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND);
3199     }
3200 }
3201
3202 static int
3203 handle_vendor(struct ofproto *p, struct ofconn *ofconn, void *msg)
3204 {
3205     struct ofp_vendor_header *ovh = msg;
3206     struct nicira_header *nh;
3207
3208     if (ntohs(ovh->header.length) < sizeof(struct ofp_vendor_header)) {
3209         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3210     }
3211     if (ovh->vendor != htonl(NX_VENDOR_ID)) {
3212         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR);
3213     }
3214     if (ntohs(ovh->header.length) < sizeof(struct nicira_header)) {
3215         return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN);
3216     }
3217
3218     nh = msg;
3219     switch (ntohl(nh->subtype)) {
3220     case NXT_STATUS_REQUEST:
3221         return switch_status_handle_request(p->switch_status, ofconn->rconn,
3222                                             msg);
3223     }
3224
3225     return ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE);
3226 }
3227
3228 static int
3229 handle_barrier_request(struct ofconn *ofconn, struct ofp_header *oh)
3230 {
3231     struct ofp_header *ob;
3232     struct ofpbuf *buf;
3233
3234     /* Currently, everything executes synchronously, so we can just
3235      * immediately send the barrier reply. */
3236     ob = make_openflow_xid(sizeof *ob, OFPT_BARRIER_REPLY, oh->xid, &buf);
3237     queue_tx(buf, ofconn, ofconn->reply_counter);
3238     return 0;
3239 }
3240
3241 static void
3242 handle_openflow(struct ofconn *ofconn, struct ofproto *p,
3243                 struct ofpbuf *ofp_msg)
3244 {
3245     struct ofp_header *oh = ofp_msg->data;
3246     int error;
3247
3248     COVERAGE_INC(ofproto_recv_openflow);
3249     switch (oh->type) {
3250     case OFPT_ECHO_REQUEST:
3251         error = handle_echo_request(ofconn, oh);
3252         break;
3253
3254     case OFPT_ECHO_REPLY:
3255         error = 0;
3256         break;
3257
3258     case OFPT_FEATURES_REQUEST:
3259         error = handle_features_request(p, ofconn, oh);
3260         break;
3261
3262     case OFPT_GET_CONFIG_REQUEST:
3263         error = handle_get_config_request(p, ofconn, oh);
3264         break;
3265
3266     case OFPT_SET_CONFIG:
3267         error = handle_set_config(p, ofconn, ofp_msg->data);
3268         break;
3269
3270     case OFPT_PACKET_OUT:
3271         error = handle_packet_out(p, ofconn, ofp_msg->data);
3272         break;
3273
3274     case OFPT_PORT_MOD:
3275         error = handle_port_mod(p, oh);
3276         break;
3277
3278     case OFPT_FLOW_MOD:
3279         error = handle_flow_mod(p, ofconn, ofp_msg->data);
3280         break;
3281
3282     case OFPT_STATS_REQUEST:
3283         error = handle_stats_request(p, ofconn, oh);
3284         break;
3285
3286     case OFPT_VENDOR:
3287         error = handle_vendor(p, ofconn, ofp_msg->data);
3288         break;
3289
3290     case OFPT_BARRIER_REQUEST:
3291         error = handle_barrier_request(ofconn, oh);
3292         break;
3293
3294     default:
3295         if (VLOG_IS_WARN_ENABLED()) {
3296             char *s = ofp_to_string(oh, ntohs(oh->length), 2);
3297             VLOG_DBG_RL(&rl, "OpenFlow message ignored: %s", s);
3298             free(s);
3299         }
3300         error = ofp_mkerr(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE);
3301         break;
3302     }
3303
3304     if (error) {
3305         send_error_oh(ofconn, ofp_msg->data, error);
3306     }
3307 }
3308 \f
3309 static void
3310 handle_odp_miss_msg(struct ofproto *p, struct ofpbuf *packet)
3311 {
3312     struct odp_msg *msg = packet->data;
3313     uint16_t in_port = odp_port_to_ofp_port(msg->port);
3314     struct rule *rule;
3315     struct ofpbuf payload;
3316     flow_t flow;
3317
3318     payload.data = msg + 1;
3319     payload.size = msg->length - sizeof *msg;
3320     flow_extract(&payload, msg->port, &flow);
3321
3322     /* Check with in-band control to see if this packet should be sent
3323      * to the local port regardless of the flow table. */
3324     if (in_band_msg_in_hook(p->in_band, &flow, &payload)) {
3325         union odp_action action;
3326
3327         memset(&action, 0, sizeof(action));
3328         action.output.type = ODPAT_OUTPUT;
3329         action.output.port = ODPP_LOCAL;
3330         dpif_execute(p->dpif, flow.in_port, &action, 1, &payload);
3331     }
3332
3333     rule = lookup_valid_rule(p, &flow);
3334     if (!rule) {
3335         /* Don't send a packet-in if OFPPC_NO_PACKET_IN asserted. */
3336         struct ofport *port = port_array_get(&p->ports, msg->port);
3337         if (port) {
3338             if (port->opp.config & OFPPC_NO_PACKET_IN) {
3339                 COVERAGE_INC(ofproto_no_packet_in);
3340                 /* XXX install 'drop' flow entry */
3341                 ofpbuf_delete(packet);
3342                 return;
3343             }
3344         } else {
3345             VLOG_WARN_RL(&rl, "packet-in on unknown port %"PRIu16, msg->port);
3346         }
3347
3348         COVERAGE_INC(ofproto_packet_in);
3349         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3350         return;
3351     }
3352
3353     if (rule->cr.wc.wildcards) {
3354         rule = rule_create_subrule(p, rule, &flow);
3355         rule_make_actions(p, rule, packet);
3356     } else {
3357         if (!rule->may_install) {
3358             /* The rule is not installable, that is, we need to process every
3359              * packet, so process the current packet and set its actions into
3360              * 'subrule'. */
3361             rule_make_actions(p, rule, packet);
3362         } else {
3363             /* XXX revalidate rule if it needs it */
3364         }
3365     }
3366
3367     rule_execute(p, rule, &payload, &flow);
3368     rule_reinstall(p, rule);
3369
3370     if (rule->super && rule->super->cr.priority == FAIL_OPEN_PRIORITY
3371         && rconn_is_connected(p->controller->rconn)) {
3372         /*
3373          * Extra-special case for fail-open mode.
3374          *
3375          * We are in fail-open mode and the packet matched the fail-open rule,
3376          * but we are connected to a controller too.  We should send the packet
3377          * up to the controller in the hope that it will try to set up a flow
3378          * and thereby allow us to exit fail-open.
3379          *
3380          * See the top-level comment in fail-open.c for more information.
3381          */
3382         pinsched_send(p->miss_sched, in_port, packet, send_packet_in_miss, p);
3383     } else {
3384         ofpbuf_delete(packet);
3385     }
3386 }
3387
3388 static void
3389 handle_odp_msg(struct ofproto *p, struct ofpbuf *packet)
3390 {
3391     struct odp_msg *msg = packet->data;
3392
3393     switch (msg->type) {
3394     case _ODPL_ACTION_NR:
3395         COVERAGE_INC(ofproto_ctlr_action);
3396         pinsched_send(p->action_sched, odp_port_to_ofp_port(msg->port), packet,
3397                       send_packet_in_action, p);
3398         break;
3399
3400     case _ODPL_SFLOW_NR:
3401         if (p->sflow) {
3402             ofproto_sflow_received(p->sflow, msg);
3403         }
3404         ofpbuf_delete(packet);
3405         break;
3406
3407     case _ODPL_MISS_NR:
3408         handle_odp_miss_msg(p, packet);
3409         break;
3410
3411     default:
3412         VLOG_WARN_RL(&rl, "received ODP message of unexpected type %"PRIu32,
3413                      msg->type);
3414         break;
3415     }
3416 }
3417 \f
3418 static void
3419 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
3420 {
3421     struct rule *sub = rule_from_cls_rule(sub_);
3422     struct revalidate_cbdata *cbdata = cbdata_;
3423
3424     if (cbdata->revalidate_all
3425         || (cbdata->revalidate_subrules && sub->super)
3426         || (tag_set_intersects(&cbdata->revalidate_set, sub->tags))) {
3427         revalidate_rule(cbdata->ofproto, sub);
3428     }
3429 }
3430
3431 static bool
3432 revalidate_rule(struct ofproto *p, struct rule *rule)
3433 {
3434     const flow_t *flow = &rule->cr.flow;
3435
3436     COVERAGE_INC(ofproto_revalidate_rule);
3437     if (rule->super) {
3438         struct rule *super;
3439         super = rule_from_cls_rule(classifier_lookup_wild(&p->cls, flow));
3440         if (!super) {
3441             rule_remove(p, rule);
3442             return false;
3443         } else if (super != rule->super) {
3444             COVERAGE_INC(ofproto_revalidate_moved);
3445             list_remove(&rule->list);
3446             list_push_back(&super->list, &rule->list);
3447             rule->super = super;
3448             rule->hard_timeout = super->hard_timeout;
3449             rule->idle_timeout = super->idle_timeout;
3450             rule->created = super->created;
3451             rule->used = 0;
3452         }
3453     }
3454
3455     rule_update_actions(p, rule);
3456     return true;
3457 }
3458
3459 static struct ofpbuf *
3460 compose_flow_removed(const struct rule *rule, long long int now, uint8_t reason)
3461 {
3462     struct ofp_flow_removed *ofr;
3463     struct ofpbuf *buf;
3464     long long int tdiff = now - rule->created;
3465     uint32_t sec = tdiff / 1000;
3466     uint32_t msec = tdiff - (sec * 1000);
3467
3468     ofr = make_openflow(sizeof *ofr, OFPT_FLOW_REMOVED, &buf);
3469     flow_to_match(&rule->cr.flow, rule->cr.wc.wildcards, &ofr->match);
3470     ofr->cookie = rule->flow_cookie;
3471     ofr->priority = htons(rule->cr.priority);
3472     ofr->reason = reason;
3473     ofr->duration_sec = htonl(sec);
3474     ofr->duration_nsec = htonl(msec * 1000000);
3475     ofr->idle_timeout = htons(rule->idle_timeout);
3476     ofr->packet_count = htonll(rule->packet_count);
3477     ofr->byte_count = htonll(rule->byte_count);
3478
3479     return buf;
3480 }
3481
3482 static void
3483 uninstall_idle_flow(struct ofproto *ofproto, struct rule *rule)
3484 {
3485     assert(rule->installed);
3486     assert(!rule->cr.wc.wildcards);
3487
3488     if (rule->super) {
3489         rule_remove(ofproto, rule);
3490     } else {
3491         rule_uninstall(ofproto, rule);
3492     }
3493 }
3494 static void
3495 send_flow_removed(struct ofproto *p, struct rule *rule,
3496                   long long int now, uint8_t reason)
3497 {
3498     struct ofconn *ofconn;
3499     struct ofconn *prev;
3500     struct ofpbuf *buf = NULL;
3501
3502     /* We limit the maximum number of queued flow expirations it by accounting
3503      * them under the counter for replies.  That works because preventing
3504      * OpenFlow requests from being processed also prevents new flows from
3505      * being added (and expiring).  (It also prevents processing OpenFlow
3506      * requests that would not add new flows, so it is imperfect.) */
3507
3508     prev = NULL;
3509     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3510         if (rule->send_flow_removed && rconn_is_connected(ofconn->rconn)) {
3511             if (prev) {
3512                 queue_tx(ofpbuf_clone(buf), prev, prev->reply_counter);
3513             } else {
3514                 buf = compose_flow_removed(rule, now, reason);
3515             }
3516             prev = ofconn;
3517         }
3518     }
3519     if (prev) {
3520         queue_tx(buf, prev, prev->reply_counter);
3521     }
3522 }
3523
3524
3525 static void
3526 expire_rule(struct cls_rule *cls_rule, void *p_)
3527 {
3528     struct ofproto *p = p_;
3529     struct rule *rule = rule_from_cls_rule(cls_rule);
3530     long long int hard_expire, idle_expire, expire, now;
3531
3532     hard_expire = (rule->hard_timeout
3533                    ? rule->created + rule->hard_timeout * 1000
3534                    : LLONG_MAX);
3535     idle_expire = (rule->idle_timeout
3536                    && (rule->super || list_is_empty(&rule->list))
3537                    ? rule->used + rule->idle_timeout * 1000
3538                    : LLONG_MAX);
3539     expire = MIN(hard_expire, idle_expire);
3540
3541     now = time_msec();
3542     if (now < expire) {
3543         if (rule->installed && now >= rule->used + 5000) {
3544             uninstall_idle_flow(p, rule);
3545         } else if (!rule->cr.wc.wildcards) {
3546             active_timeout(p, rule);
3547         }
3548
3549         return;
3550     }
3551
3552     COVERAGE_INC(ofproto_expired);
3553
3554     /* Update stats.  This code will be a no-op if the rule expired
3555      * due to an idle timeout. */
3556     if (rule->cr.wc.wildcards) {
3557         struct rule *subrule, *next;
3558         LIST_FOR_EACH_SAFE (subrule, next, struct rule, list, &rule->list) {
3559             rule_remove(p, subrule);
3560         }
3561     } else {
3562         rule_uninstall(p, rule);
3563     }
3564
3565     if (!rule_is_hidden(rule)) {
3566         send_flow_removed(p, rule, now,
3567                           (now >= hard_expire
3568                            ? OFPRR_HARD_TIMEOUT : OFPRR_IDLE_TIMEOUT));
3569     }
3570     rule_remove(p, rule);
3571 }
3572
3573 static void
3574 active_timeout(struct ofproto *ofproto, struct rule *rule)
3575 {
3576     if (ofproto->netflow && !is_controller_rule(rule) &&
3577         netflow_active_timeout_expired(ofproto->netflow, &rule->nf_flow)) {
3578         struct ofexpired expired;
3579         struct odp_flow odp_flow;
3580
3581         /* Get updated flow stats. */
3582         memset(&odp_flow, 0, sizeof odp_flow);
3583         if (rule->installed) {
3584             odp_flow.key = rule->cr.flow;
3585             odp_flow.flags = ODPFF_ZERO_TCP_FLAGS;
3586             dpif_flow_get(ofproto->dpif, &odp_flow);
3587
3588             if (odp_flow.stats.n_packets) {
3589                 update_time(ofproto, rule, &odp_flow.stats);
3590                 netflow_flow_update_flags(&rule->nf_flow, odp_flow.stats.ip_tos,
3591                                           odp_flow.stats.tcp_flags);
3592             }
3593         }
3594
3595         expired.flow = rule->cr.flow;
3596         expired.packet_count = rule->packet_count +
3597                                odp_flow.stats.n_packets;
3598         expired.byte_count = rule->byte_count + odp_flow.stats.n_bytes;
3599         expired.used = rule->used;
3600
3601         netflow_expire(ofproto->netflow, &rule->nf_flow, &expired);
3602
3603         /* Schedule us to send the accumulated records once we have
3604          * collected all of them. */
3605         poll_immediate_wake();
3606     }
3607 }
3608
3609 static void
3610 update_used(struct ofproto *p)
3611 {
3612     struct odp_flow *flows;
3613     size_t n_flows;
3614     size_t i;
3615     int error;
3616
3617     error = dpif_flow_list_all(p->dpif, &flows, &n_flows);
3618     if (error) {
3619         return;
3620     }
3621
3622     for (i = 0; i < n_flows; i++) {
3623         struct odp_flow *f = &flows[i];
3624         struct rule *rule;
3625
3626         rule = rule_from_cls_rule(
3627             classifier_find_rule_exactly(&p->cls, &f->key, 0, UINT16_MAX));
3628         if (!rule || !rule->installed) {
3629             COVERAGE_INC(ofproto_unexpected_rule);
3630             dpif_flow_del(p->dpif, f);
3631             continue;
3632         }
3633
3634         update_time(p, rule, &f->stats);
3635         rule_account(p, rule, f->stats.n_bytes);
3636     }
3637     free(flows);
3638 }
3639
3640 static void
3641 do_send_packet_in(struct ofconn *ofconn, uint32_t buffer_id,
3642                   const struct ofpbuf *packet, int send_len)
3643 {
3644     struct odp_msg *msg = packet->data;
3645     struct ofpbuf payload;
3646     struct ofpbuf *opi;
3647     uint8_t reason;
3648
3649     /* Extract packet payload from 'msg'. */
3650     payload.data = msg + 1;
3651     payload.size = msg->length - sizeof *msg;
3652
3653     /* Construct ofp_packet_in message. */
3654     reason = msg->type == _ODPL_ACTION_NR ? OFPR_ACTION : OFPR_NO_MATCH;
3655     opi = make_packet_in(buffer_id, odp_port_to_ofp_port(msg->port), reason,
3656                          &payload, send_len);
3657
3658     /* Send. */
3659     rconn_send_with_limit(ofconn->rconn, opi, ofconn->packet_in_counter, 100);
3660 }
3661
3662 static void
3663 send_packet_in_action(struct ofpbuf *packet, void *p_)
3664 {
3665     struct ofproto *p = p_;
3666     struct ofconn *ofconn;
3667     struct odp_msg *msg;
3668
3669     msg = packet->data;
3670     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3671         if (ofconn == p->controller || ofconn->miss_send_len) {
3672             do_send_packet_in(ofconn, UINT32_MAX, packet, msg->arg);
3673         }
3674     }
3675     ofpbuf_delete(packet);
3676 }
3677
3678 static void
3679 send_packet_in_miss(struct ofpbuf *packet, void *p_)
3680 {
3681     struct ofproto *p = p_;
3682     bool in_fail_open = p->fail_open && fail_open_is_active(p->fail_open);
3683     struct ofconn *ofconn;
3684     struct ofpbuf payload;
3685     struct odp_msg *msg;
3686
3687     msg = packet->data;
3688     payload.data = msg + 1;
3689     payload.size = msg->length - sizeof *msg;
3690     LIST_FOR_EACH (ofconn, struct ofconn, node, &p->all_conns) {
3691         if (ofconn->miss_send_len) {
3692             struct pktbuf *pb = ofconn->pktbuf;
3693             uint32_t buffer_id = (in_fail_open
3694                                   ? pktbuf_get_null()
3695                                   : pktbuf_save(pb, &payload, msg->port));
3696             int send_len = (buffer_id != UINT32_MAX ? ofconn->miss_send_len
3697                             : UINT32_MAX);
3698             do_send_packet_in(ofconn, buffer_id, packet, send_len);
3699         }
3700     }
3701     ofpbuf_delete(packet);
3702 }
3703
3704 static uint64_t
3705 pick_datapath_id(const struct ofproto *ofproto)
3706 {
3707     const struct ofport *port;
3708
3709     port = port_array_get(&ofproto->ports, ODPP_LOCAL);
3710     if (port) {
3711         uint8_t ea[ETH_ADDR_LEN];
3712         int error;
3713
3714         error = netdev_get_etheraddr(port->netdev, ea);
3715         if (!error) {
3716             return eth_addr_to_uint64(ea);
3717         }
3718         VLOG_WARN("could not get MAC address for %s (%s)",
3719                   netdev_get_name(port->netdev), strerror(error));
3720     }
3721     return ofproto->fallback_dpid;
3722 }
3723
3724 static uint64_t
3725 pick_fallback_dpid(void)
3726 {
3727     uint8_t ea[ETH_ADDR_LEN];
3728     eth_addr_nicira_random(ea);
3729     return eth_addr_to_uint64(ea);
3730 }
3731 \f
3732 static bool
3733 default_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
3734                          struct odp_actions *actions, tag_type *tags,
3735                          uint16_t *nf_output_iface, void *ofproto_)
3736 {
3737     struct ofproto *ofproto = ofproto_;
3738     int out_port;
3739
3740     /* Drop frames for reserved multicast addresses. */
3741     if (eth_addr_is_reserved(flow->dl_dst)) {
3742         return true;
3743     }
3744
3745     /* Learn source MAC (but don't try to learn from revalidation). */
3746     if (packet != NULL) {
3747         tag_type rev_tag = mac_learning_learn(ofproto->ml, flow->dl_src,
3748                                               0, flow->in_port);
3749         if (rev_tag) {
3750             /* The log messages here could actually be useful in debugging,
3751              * so keep the rate limit relatively high. */
3752             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
3753             VLOG_DBG_RL(&rl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
3754                         ETH_ADDR_ARGS(flow->dl_src), flow->in_port);
3755             ofproto_revalidate(ofproto, rev_tag);
3756         }
3757     }
3758
3759     /* Determine output port. */
3760     out_port = mac_learning_lookup_tag(ofproto->ml, flow->dl_dst, 0, tags);
3761     if (out_port < 0) {
3762         add_output_group_action(actions, DP_GROUP_FLOOD, nf_output_iface);
3763     } else if (out_port != flow->in_port) {
3764         odp_actions_add(actions, ODPAT_OUTPUT)->output.port = out_port;
3765         *nf_output_iface = out_port;
3766     } else {
3767         /* Drop. */
3768     }
3769
3770     return true;
3771 }
3772
3773 static const struct ofhooks default_ofhooks = {
3774     NULL,
3775     default_normal_ofhook_cb,
3776     NULL,
3777     NULL
3778 };