ofproto/wdp-xflow.c

   1 /*
   2  * Copyright (c) 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
  19 #include "wdp-xflow.h"
  20
  21 #include <errno.h>
  22 #include <inttypes.h>
  23
  24 #include "coverage.h"
  25 #include "dhcp.h"
  26 #include "netdev.h"
  27 #include "netflow.h"
  28 #include "ofp-util.h"
  29 #include "ofpbuf.h"
  30 #include "openflow/nicira-ext.h"
  31 #include "openflow/openflow.h"
  32 #include "packets.h"
  33 #include "poll-loop.h"
  34 #include "port-array.h"
  35 #include "shash.h"
  36 #include "stp.h"
  37 #include "svec.h"
  38 #include "timeval.h"
  39 #include "util.h"
  40 #include "vconn.h"
  41 #include "wdp-provider.h"
  42 #include "xfif.h"
  43 #include "xflow-util.h"
  44 #include "xtoxll.h"
  45
  46 #include <linux/types.h>        /* XXX */
  47 #include <linux/pkt_sched.h>    /* XXX */
  48
  49 #define THIS_MODULE VLM_wdp_xflow
  50 #include "vlog.h"
  51
  52 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  53 \f
  54 /* Maximum numbers of rules. */
  55 #define WX_MAX_WILD     65536   /* Wildcarded rules. */
  56 #define WX_MAX_EXACT    1048576 /* Exact-match rules. */
  57
  58 struct wx {
  59     struct list list_node;
  60     struct wdp wdp;
  61     struct xfif *xfif;
  62     struct classifier cls;
  63     struct netdev_monitor *netdev_monitor;
  64     struct port_array ports;    /* Index is xflow port nr;
  65                                  * wdp_port->opp.port_no is OFP port nr. */
  66     struct shash port_by_name;
  67     bool need_revalidate;
  68     long long int next_expiration;
  69 };
  70
  71 static struct list all_wx = LIST_INITIALIZER(&all_wx);
  72
  73 static int wx_port_init(struct wx *);
  74 static void wx_port_run(struct wx *);
  75 static void wx_port_refresh_groups(struct wx *);
  76
  77 enum {
  78     WX_GROUP_FLOOD = 0,
  79     WX_GROUP_ALL = 1
  80 };
  81
  82 static struct wx *
  83 wx_cast(const struct wdp *wdp)
  84 {
  85     return CONTAINER_OF(wdp, struct wx, wdp);
  86 }
  87
  88 static int
  89 wx_xlate_actions(struct wx *, const union ofp_action *, size_t n,
  90                  const flow_t *flow, const struct ofpbuf *packet,
  91                  struct xflow_actions *out, bool *may_set_up_flow);
  92 \f
  93 struct wx_rule {
  94     struct wdp_rule wr;
  95
  96     uint64_t packet_count;      /* Number of packets received. */
  97     uint64_t byte_count;        /* Number of bytes received. */
  98     uint64_t accounted_bytes;   /* Number of bytes passed to account_cb. */
  99     long long int used;         /* Last-used time (0 if never used). */
 100
 101     /* If 'super' is non-NULL, this rule is a subrule, that is, it is an
 102      * exact-match rule (having cr.wc.wildcards of 0) generated from the
 103      * wildcard rule 'super'.  In this case, 'list' is an element of the
 104      * super-rule's list.
 105      *
 106      * If 'super' is NULL, this rule is a super-rule, and 'list' is the head of
 107      * a list of subrules.  A super-rule with no wildcards (where
 108      * cr.wc.wildcards is 0) will never have any subrules. */
 109     struct wx_rule *super;
 110     struct list list;
 111
 112     /* Datapath actions.
 113      *
 114      * A super-rule with wildcard fields never has xflow actions (since the
 115      * datapath only supports exact-match flows). */
 116     bool installed;             /* Installed in datapath? */
 117     bool may_install;           /* True ordinarily; false if actions must
 118                                  * be reassessed for every packet. */
 119     int n_xflow_actions;
 120     union xflow_action *xflow_actions;
 121 };
 122
 123 static void wx_rule_destroy(struct wx *, struct wx_rule *);
 124 static void wx_rule_update_actions(struct wx *, struct wx_rule *);
 125 static void wx_rule_execute(struct wx *, struct wx_rule *,
 126                             struct ofpbuf *packet, const flow_t *);
 127 static bool wx_rule_make_actions(struct wx *, struct wx_rule *,
 128                                  const struct ofpbuf *packet);
 129 static void wx_rule_install(struct wx *, struct wx_rule *,
 130                             struct wx_rule *displaced_rule);
 131
 132 static struct wx_rule *
 133 wx_rule_cast(const struct cls_rule *cls_rule)
 134 {
 135     return cls_rule ? CONTAINER_OF(cls_rule, struct wx_rule, wr.cr) : NULL;
 136 }
 137
 138 /* Returns true if 'rule' is merely an implementation detail that should be
 139  * hidden from the client. */
 140 static inline bool
 141 wx_rule_is_hidden(const struct wx_rule *rule)
 142 {
 143     return rule->super != NULL;
 144 }
 145
 146 static void
 147 wx_rule_free(struct wx_rule *rule)
 148 {
 149     wdp_rule_uninit(&rule->wr);
 150     free(rule->xflow_actions);
 151     free(rule);
 152 }
 153
 154 static void
 155 wx_rule_account(struct wx *wx OVS_UNUSED, struct wx_rule *rule OVS_UNUSED,
 156                 uint64_t extra_bytes OVS_UNUSED)
 157 {
 158     /* XXX call account_cb hook */
 159 }
 160
 161 static void
 162 wx_rule_post_uninstall(struct wx *wx, struct wx_rule *rule)
 163 {
 164     struct wx_rule *super = rule->super;
 165
 166     wx_rule_account(wx, rule, 0);
 167
 168     /* XXX netflow expiration */
 169
 170     if (super) {
 171         super->packet_count += rule->packet_count;
 172         super->byte_count += rule->byte_count;
 173
 174         /* Reset counters to prevent double counting if the rule ever gets
 175          * reinstalled. */
 176         rule->packet_count = 0;
 177         rule->byte_count = 0;
 178         rule->accounted_bytes = 0;
 179
 180         //XXX netflow_flow_clear(&rule->nf_flow);
 181     }
 182 }
 183
 184 static long long int
 185 xflow_flow_stats_to_msec(const struct xflow_flow_stats *stats)
 186 {
 187     return (stats->used_sec
 188             ? stats->used_sec * 1000 + stats->used_nsec / 1000000
 189             : 0);
 190 }
 191
 192 static void
 193 wx_rule_update_time(struct wx *wx OVS_UNUSED, struct wx_rule *rule,
 194                     const struct xflow_flow_stats *stats)
 195 {
 196     long long int used = xflow_flow_stats_to_msec(stats);
 197     if (used > rule->used) {
 198         rule->used = used;
 199         if (rule->super && used > rule->super->used) {
 200             rule->super->used = used;
 201         }
 202         //XXX netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, used);
 203     }
 204 }
 205
 206 static void
 207 wx_rule_update_stats(struct wx *wx, struct wx_rule *rule,
 208                      const struct xflow_flow_stats *stats)
 209 {
 210     if (stats->n_packets) {
 211         wx_rule_update_time(wx, rule, stats);
 212         rule->packet_count += stats->n_packets;
 213         rule->byte_count += stats->n_bytes;
 214         /* XXX netflow_flow_update_flags(&rule->nf_flow, stats->ip_tos,
 215            stats->tcp_flags); */
 216     }
 217 }
 218
 219 static void
 220 wx_rule_uninstall(struct wx *wx, struct wx_rule *rule)
 221 {
 222     assert(!rule->wr.cr.flow.wildcards);
 223     if (rule->installed) {
 224         struct xflow_flow xflow_flow;
 225
 226         xflow_key_from_flow(&xflow_flow.key, &rule->wr.cr.flow);
 227         xflow_flow.actions = NULL;
 228         xflow_flow.n_actions = 0;
 229         xflow_flow.flags = 0;
 230         if (!xfif_flow_del(wx->xfif, &xflow_flow)) {
 231             wx_rule_update_stats(wx, rule, &xflow_flow.stats);
 232         }
 233         rule->installed = false;
 234
 235         wx_rule_post_uninstall(wx, rule);
 236     }
 237 }
 238
 239 #if 0
 240 static bool
 241 is_controller_rule(struct wx_rule *rule)
 242 {
 243     /* If the only action is send to the controller then don't report
 244      * NetFlow expiration messages since it is just part of the control
 245      * logic for the network and not real traffic. */
 246
 247     return (rule
 248             && rule->super
 249             && rule->super->n_actions == 1
 250             && action_outputs_to_port(&rule->super->actions[0],
 251                                       htons(OFPP_CONTROLLER)));
 252 }
 253 #endif
 254
 255 static void
 256 wx_rule_remove(struct wx *wx, struct wx_rule *rule)
 257 {
 258     if (rule->wr.cr.flow.wildcards) {
 259         COVERAGE_INC(wx_del_wc_flow);
 260         wx->need_revalidate = true;
 261     } else {
 262         wx_rule_uninstall(wx, rule);
 263     }
 264     classifier_remove(&wx->cls, &rule->wr.cr);
 265     wx_rule_destroy(wx, rule);
 266 }
 267
 268 static bool
 269 wx_rule_revalidate(struct wx *wx, struct wx_rule *rule)
 270 {
 271     const flow_t *flow = &rule->wr.cr.flow;
 272
 273     COVERAGE_INC(wx_rule_revalidate);
 274     if (rule->super) {
 275         struct wx_rule *super;
 276         super = wx_rule_cast(classifier_lookup_wild(&wx->cls, flow));
 277         if (!super) {
 278             wx_rule_remove(wx, rule);
 279             return false;
 280         } else if (super != rule->super) {
 281             COVERAGE_INC(wx_revalidate_moved);
 282             list_remove(&rule->list);
 283             list_push_back(&super->list, &rule->list);
 284             rule->super = super;
 285             rule->wr.hard_timeout = super->wr.hard_timeout;
 286             rule->wr.idle_timeout = super->wr.idle_timeout;
 287             rule->wr.created = super->wr.created;
 288             rule->used = 0;
 289         }
 290     }
 291
 292     wx_rule_update_actions(wx, rule);
 293     return true;
 294 }
 295
 296 /* Destroys 'rule'.  If 'rule' is a subrule, also removes it from its
 297  * super-rule's list of subrules.  If 'rule' is a super-rule, also iterates
 298  * through all of its subrules and revalidates them, destroying any that no
 299  * longer has a super-rule (which is probably all of them).
 300  *
 301  * Before calling this function, the caller must make have removed 'rule' from
 302  * the classifier.  If 'rule' is an exact-match rule, the caller is also
 303  * responsible for ensuring that it has been uninstalled from the datapath. */
 304 static void
 305 wx_rule_destroy(struct wx *wx, struct wx_rule *rule)
 306 {
 307     if (!rule->super) {
 308         struct wx_rule *subrule, *next;
 309         LIST_FOR_EACH_SAFE (subrule, next, struct wx_rule, list, &rule->list) {
 310             wx_rule_revalidate(wx, subrule);
 311         }
 312     } else {
 313         list_remove(&rule->list);
 314     }
 315     wx_rule_free(rule);
 316 }
 317
 318 #if 0
 319 static bool
 320 wx_rule_has_out_port(const struct wx_rule *rule, uint16_t out_port)
 321 {
 322     const union ofp_action *oa;
 323     struct actions_iterator i;
 324
 325     if (out_port == htons(OFPP_NONE)) {
 326         return true;
 327     }
 328     for (oa = actions_first(&i, rule->wr.actions,
 329                             rule->wr.n_actions);
 330          oa;
 331          oa = actions_next(&i)) {
 332         if (oa->type == htons(OFPAT_OUTPUT) && oa->output.port == out_port) {
 333             return true;
 334         }
 335     }
 336     return false;
 337 }
 338 #endif
 339
 340 /* Caller is responsible for initializing the 'cr' member of the returned
 341  * rule. */
 342 static struct wx_rule *
 343 wx_rule_create(struct wx_rule *super,
 344                const union ofp_action *actions, size_t n_actions,
 345                uint16_t idle_timeout, uint16_t hard_timeout)
 346 {
 347     struct wx_rule *rule = xzalloc(sizeof *rule);
 348     wdp_rule_init(&rule->wr, actions, n_actions);
 349     rule->wr.idle_timeout = idle_timeout;
 350     rule->wr.hard_timeout = hard_timeout;
 351     rule->used = rule->wr.created;
 352     rule->super = super;
 353     if (super) {
 354         list_push_back(&super->list, &rule->list);
 355     } else {
 356         list_init(&rule->list);
 357     }
 358 #if 0
 359     netflow_flow_clear(&rule->nf_flow);
 360     netflow_flow_update_time(ofproto->netflow, &rule->nf_flow, rule->created);
 361 #endif
 362
 363     return rule;
 364 }
 365
 366 /* Executes the actions indicated by 'rule' on 'packet', which is in flow
 367  * 'flow' and is considered to have arrived on xflow port 'in_port'.
 368  *
 369  * The flow that 'packet' actually contains does not need to actually match
 370  * 'rule'; the actions in 'rule' will be applied to it either way.  Likewise,
 371  * the packet and byte counters for 'rule' will be credited for the packet sent
 372  * out whether or not the packet actually matches 'rule'.
 373  *
 374  * If 'rule' is an exact-match rule and 'flow' actually equals the rule's flow,
 375  * the caller must already have accurately composed xflow actions for it given
 376  * 'packet' using rule_make_actions().  If 'rule' is a wildcard rule, or if
 377  * 'rule' is an exact-match rule but 'flow' is not the rule's flow, then this
 378  * function will compose a set of xflow actions based on 'rule''s OpenFlow
 379  * actions and apply them to 'packet'. */
 380 static void
 381 wx_rule_execute(struct wx *wx, struct wx_rule *rule,
 382                 struct ofpbuf *packet, const flow_t *flow)
 383 {
 384     const union xflow_action *actions;
 385     size_t n_actions;
 386     struct xflow_actions a;
 387
 388     /* Grab or compose the xflow actions.
 389      *
 390      * The special case for an exact-match 'rule' where 'flow' is not the
 391      * rule's flow is important to avoid, e.g., sending a packet out its input
 392      * port simply because the xflow actions were composed for the wrong
 393      * scenario. */
 394     if (rule->wr.cr.flow.wildcards
 395         || !flow_equal(flow, &rule->wr.cr.flow))
 396     {
 397         struct wx_rule *super = rule->super ? rule->super : rule;
 398         if (wx_xlate_actions(wx, super->wr.actions, super->wr.n_actions, flow,
 399                              packet, &a, NULL)) {
 400             return;
 401         }
 402         actions = a.actions;
 403         n_actions = a.n_actions;
 404     } else {
 405         actions = rule->xflow_actions;
 406         n_actions = rule->n_xflow_actions;
 407     }
 408
 409     /* Execute the xflow actions. */
 410     if (!xfif_execute(wx->xfif, flow->in_port,
 411                       actions, n_actions, packet)) {
 412         struct xflow_flow_stats stats;
 413         flow_extract_stats(flow, packet, &stats);
 414         wx_rule_update_stats(wx, rule, &stats);
 415         rule->used = time_msec();
 416         //XXX netflow_flow_update_time(wx->netflow, &rule->nf_flow, rule->used);
 417     }
 418 }
 419
 420 static void
 421 wx_rule_insert(struct wx *wx, struct wx_rule *rule, struct ofpbuf *packet,
 422                uint16_t in_port)
 423 {
 424     struct wx_rule *displaced_rule;
 425
 426     /* Insert the rule in the classifier. */
 427     displaced_rule = wx_rule_cast(classifier_insert(&wx->cls, &rule->wr.cr));
 428     if (!rule->wr.cr.flow.wildcards) {
 429         wx_rule_make_actions(wx, rule, packet);
 430     }
 431
 432     /* Send the packet and credit it to the rule. */
 433     if (packet) {
 434         flow_t flow;
 435         flow_extract(packet, 0, in_port, &flow);
 436         wx_rule_execute(wx, rule, packet, &flow);
 437     }
 438
 439     /* Install the rule in the datapath only after sending the packet, to
 440      * avoid packet reordering.  */
 441     if (rule->wr.cr.flow.wildcards) {
 442         COVERAGE_INC(wx_add_wc_flow);
 443         wx->need_revalidate = true;
 444     } else {
 445         wx_rule_install(wx, rule, displaced_rule);
 446     }
 447
 448     /* Free the rule that was displaced, if any. */
 449     if (displaced_rule) {
 450         rule->wr.client_data = displaced_rule->wr.client_data;
 451         wx_rule_destroy(wx, displaced_rule);
 452     }
 453 }
 454
 455 static struct wx_rule *
 456 wx_rule_create_subrule(struct wx *wx, struct wx_rule *rule, const flow_t *flow)
 457 {
 458     struct wx_rule *subrule;
 459
 460     subrule = wx_rule_create(rule, NULL, 0,
 461                              rule->wr.idle_timeout,
 462                              rule->wr.hard_timeout);
 463     COVERAGE_INC(wx_subrule_create);
 464     cls_rule_from_flow(flow, &subrule->wr.cr);
 465     classifier_insert_exact(&wx->cls, &subrule->wr.cr);
 466
 467     return subrule;
 468 }
 469
 470 /* Returns true if the actions changed, false otherwise. */
 471 static bool
 472 wx_rule_make_actions(struct wx *wx, struct wx_rule *rule,
 473                      const struct ofpbuf *packet)
 474 {
 475     const struct wx_rule *super;
 476     struct xflow_actions a;
 477     size_t actions_len;
 478
 479     assert(!rule->wr.cr.flow.wildcards);
 480
 481     super = rule->super ? rule->super : rule;
 482     wx_xlate_actions(wx, super->wr.actions, super->wr.n_actions,
 483                      &rule->wr.cr.flow, packet, &a, &rule->may_install);
 484
 485     actions_len = a.n_actions * sizeof *a.actions;
 486     if (rule->n_xflow_actions != a.n_actions
 487         || memcmp(rule->xflow_actions, a.actions, actions_len)) {
 488         COVERAGE_INC(wx_xflow_unchanged);
 489         free(rule->xflow_actions);
 490         rule->n_xflow_actions = a.n_actions;
 491         rule->xflow_actions = xmemdup(a.actions, actions_len);
 492         return true;
 493     } else {
 494         return false;
 495     }
 496 }
 497
 498 static int
 499 do_put_flow(struct wx *wx, struct wx_rule *rule, int flags,
 500             struct xflow_flow_put *put)
 501 {
 502     memset(&put->flow.stats, 0, sizeof put->flow.stats);
 503     xflow_key_from_flow(&put->flow.key, &rule->wr.cr.flow);
 504     put->flow.actions = rule->xflow_actions;
 505     put->flow.n_actions = rule->n_xflow_actions;
 506     put->flow.flags = 0;
 507     put->flags = flags;
 508     return xfif_flow_put(wx->xfif, put);
 509 }
 510
 511 static void
 512 wx_rule_install(struct wx *wx, struct wx_rule *rule, struct wx_rule *displaced_rule)
 513 {
 514     assert(!rule->wr.cr.flow.wildcards);
 515
 516     if (rule->may_install) {
 517         struct xflow_flow_put put;
 518         if (!do_put_flow(wx, rule,
 519                          XFLOWPF_CREATE | XFLOWPF_MODIFY | XFLOWPF_ZERO_STATS,
 520                          &put)) {
 521             rule->installed = true;
 522             if (displaced_rule) {
 523                 wx_rule_update_stats(wx, displaced_rule, &put.flow.stats);
 524                 wx_rule_post_uninstall(wx, displaced_rule);
 525             }
 526         }
 527     } else if (displaced_rule) {
 528         wx_rule_uninstall(wx, displaced_rule);
 529     }
 530 }
 531
 532 static void
 533 wx_rule_reinstall(struct wx *wx, struct wx_rule *rule)
 534 {
 535     if (rule->installed) {
 536         struct xflow_flow_put put;
 537         COVERAGE_INC(wx_dp_missed);
 538         do_put_flow(wx, rule, XFLOWPF_CREATE | XFLOWPF_MODIFY, &put);
 539     } else {
 540         wx_rule_install(wx, rule, NULL);
 541     }
 542 }
 543
 544 static void
 545 wx_rule_update_actions(struct wx *wx, struct wx_rule *rule)
 546 {
 547     bool actions_changed;
 548 #if 0
 549     uint16_t new_out_iface, old_out_iface;
 550
 551     old_out_iface = rule->nf_flow.output_iface;
 552 #endif
 553     actions_changed = wx_rule_make_actions(wx, rule, NULL);
 554
 555     if (rule->may_install) {
 556         if (rule->installed) {
 557             if (actions_changed) {
 558                 struct xflow_flow_put put;
 559                 do_put_flow(wx, rule, XFLOWPF_CREATE | XFLOWPF_MODIFY
 560                             | XFLOWPF_ZERO_STATS, &put);
 561                 wx_rule_update_stats(wx, rule, &put.flow.stats);
 562 #if 0
 563                 /* Temporarily set the old output iface so that NetFlow
 564                  * messages have the correct output interface for the old
 565                  * stats. */
 566                 new_out_iface = rule->nf_flow.output_iface;
 567                 rule->nf_flow.output_iface = old_out_iface;
 568 #endif
 569                 wx_rule_post_uninstall(wx, rule);
 570                 //rule->nf_flow.output_iface = new_out_iface;
 571             }
 572         } else {
 573             wx_rule_install(wx, rule, NULL);
 574         }
 575     } else {
 576         wx_rule_uninstall(wx, rule);
 577     }
 578 }
 579 \f
 580 static void
 581 add_output_group_action(struct xflow_actions *actions, uint16_t group,
 582                         uint16_t *nf_output_iface)
 583 {
 584     xflow_actions_add(actions, XFLOWAT_OUTPUT_GROUP)->output_group.group = group;
 585
 586     if (group == WX_GROUP_ALL || group == WX_GROUP_FLOOD) {
 587         *nf_output_iface = NF_OUT_FLOOD;
 588     }
 589 }
 590
 591 static void
 592 add_controller_action(struct xflow_actions *actions,
 593                       const struct ofp_action_output *oao)
 594 {
 595     union xflow_action *a = xflow_actions_add(actions, XFLOWAT_CONTROLLER);
 596     a->controller.arg = ntohs(oao->max_len);
 597 }
 598
 599 struct wx_xlate_ctx {
 600     /* Input. */
 601     flow_t flow;                /* Flow to which these actions correspond. */
 602     int recurse;                /* Recursion level, via xlate_table_action. */
 603     struct wx *wx;
 604     const struct ofpbuf *packet; /* The packet corresponding to 'flow', or a
 605                                   * null pointer if we are revalidating
 606                                   * without a packet to refer to. */
 607
 608     /* Output. */
 609     struct xflow_actions *out;    /* Datapath actions. */
 610     //tag_type *tags;             /* Tags associated with OFPP_NORMAL actions. */
 611     bool may_set_up_flow;       /* True ordinarily; false if the actions must
 612                                  * be reassessed for every packet. */
 613     uint16_t nf_output_iface;   /* Output interface index for NetFlow. */
 614 };
 615
 616 static void do_xlate_actions(const union ofp_action *in, size_t n_in,
 617                              struct wx_xlate_ctx *ctx);
 618
 619 static void
 620 add_output_action(struct wx_xlate_ctx *ctx, uint16_t port)
 621 {
 622     const struct wdp_port *wdp_port = port_array_get(&ctx->wx->ports, port);
 623
 624     if (wdp_port) {
 625         if (wdp_port->opp.config & OFPPC_NO_FWD) {
 626             /* Forwarding disabled on port. */
 627             return;
 628         }
 629     } else {
 630         /*
 631          * We don't have an ofport record for this port, but it doesn't hurt to
 632          * allow forwarding to it anyhow.  Maybe such a port will appear later
 633          * and we're pre-populating the flow table.
 634          */
 635     }
 636
 637     xflow_actions_add(ctx->out, XFLOWAT_OUTPUT)->output.port = port;
 638     //ctx->nf_output_iface = port;
 639 }
 640
 641 static struct wx_rule *
 642 wx_rule_lookup_valid(struct wx *wx, const flow_t *flow)
 643 {
 644     struct wx_rule *rule = wx_rule_cast(classifier_lookup(&wx->cls, flow));
 645
 646     /* The rule we found might not be valid, since we could be in need of
 647      * revalidation.  If it is not valid, don't return it. */
 648     if (rule
 649         && rule->super
 650         && wx->need_revalidate
 651         && !wx_rule_revalidate(wx, rule)) {
 652         COVERAGE_INC(wx_invalidated);
 653         return NULL;
 654     }
 655
 656     return rule;
 657 }
 658
 659 static void
 660 xlate_table_action(struct wx_xlate_ctx *ctx, uint16_t in_port)
 661 {
 662     if (!ctx->recurse) {
 663         uint16_t old_in_port;
 664         struct wx_rule *rule;
 665
 666         /* Look up a flow with 'in_port' as the input port.  Then restore the
 667          * original input port (otherwise OFPP_NORMAL and OFPP_IN_PORT will
 668          * have surprising behavior). */
 669         old_in_port = ctx->flow.in_port;
 670         ctx->flow.in_port = in_port;
 671         rule = wx_rule_lookup_valid(ctx->wx, &ctx->flow);
 672         ctx->flow.in_port = old_in_port;
 673
 674         if (rule) {
 675             if (rule->super) {
 676                 rule = rule->super;
 677             }
 678
 679             ctx->recurse++;
 680             do_xlate_actions(rule->wr.actions, rule->wr.n_actions, ctx);
 681             ctx->recurse--;
 682         }
 683     }
 684 }
 685
 686 static void
 687 xlate_output_action(struct wx_xlate_ctx *ctx,
 688                     const struct ofp_action_output *oao)
 689 {
 690     uint16_t xflow_port;
 691     uint16_t prev_nf_output_iface = ctx->nf_output_iface;
 692
 693     ctx->nf_output_iface = NF_OUT_DROP;
 694
 695     switch (ntohs(oao->port)) {
 696     case OFPP_IN_PORT:
 697         add_output_action(ctx, ctx->flow.in_port);
 698         break;
 699     case OFPP_TABLE:
 700         xlate_table_action(ctx, ctx->flow.in_port);
 701         break;
 702     case OFPP_NORMAL:
 703 #if 0
 704         if (!ctx->wx->ofhooks->normal_cb(ctx->flow, ctx->packet,
 705                                          ctx->out, ctx->tags,
 706                                          &ctx->nf_output_iface,
 707                                          ctx->wx->aux)) {
 708             COVERAGE_INC(wx_uninstallable);
 709             ctx->may_set_up_flow = false;
 710         }
 711         break;
 712 #else
 713         /* fall through to flood for now */
 714 #endif
 715     case OFPP_FLOOD:
 716         add_output_group_action(ctx->out, WX_GROUP_FLOOD,
 717                                 &ctx->nf_output_iface);
 718         break;
 719     case OFPP_ALL:
 720         add_output_group_action(ctx->out, WX_GROUP_ALL, &ctx->nf_output_iface);
 721         break;
 722     case OFPP_CONTROLLER:
 723         add_controller_action(ctx->out, oao);
 724         break;
 725     case OFPP_LOCAL:
 726         add_output_action(ctx, XFLOWP_LOCAL);
 727         break;
 728     default:
 729         xflow_port = ofp_port_to_xflow_port(ntohs(oao->port));
 730         if (xflow_port != ctx->flow.in_port) {
 731             add_output_action(ctx, xflow_port);
 732         }
 733         break;
 734     }
 735
 736     if (prev_nf_output_iface == NF_OUT_FLOOD) {
 737         ctx->nf_output_iface = NF_OUT_FLOOD;
 738     } else if (ctx->nf_output_iface == NF_OUT_DROP) {
 739         ctx->nf_output_iface = prev_nf_output_iface;
 740     } else if (prev_nf_output_iface != NF_OUT_DROP &&
 741                ctx->nf_output_iface != NF_OUT_FLOOD) {
 742         ctx->nf_output_iface = NF_OUT_MULTI;
 743     }
 744 }
 745
 746 /* If the final xflow action in 'ctx' is "pop priority", drop it, as an
 747  * optimization, because we're going to add another action that sets the
 748  * priority immediately after, or because there are no actions following the
 749  * pop.  */
 750 static void
 751 remove_pop_action(struct wx_xlate_ctx *ctx)
 752 {
 753     size_t n = ctx->out->n_actions;
 754     if (n > 0 && ctx->out->actions[n - 1].type == XFLOWAT_POP_PRIORITY) {
 755         ctx->out->n_actions--;
 756     }
 757 }
 758
 759 static void
 760 xlate_enqueue_action(struct wx_xlate_ctx *ctx,
 761                      const struct ofp_action_enqueue *oae)
 762 {
 763     uint16_t ofp_port, xflow_port;
 764
 765     /* Figure out xflow output port. */
 766     ofp_port = ntohs(oae->port);
 767     if (ofp_port != OFPP_IN_PORT) {
 768         xflow_port = ofp_port_to_xflow_port(ofp_port);
 769     } else {
 770         xflow_port = ctx->flow.in_port;
 771     }
 772
 773     /* Add xflow actions. */
 774     remove_pop_action(ctx);
 775     xflow_actions_add(ctx->out, XFLOWAT_SET_PRIORITY)->priority.priority
 776         = TC_H_MAKE(1, ntohl(oae->queue_id)); /* XXX */
 777     add_output_action(ctx, xflow_port);
 778     xflow_actions_add(ctx->out, XFLOWAT_POP_PRIORITY);
 779
 780     /* Update NetFlow output port. */
 781     if (ctx->nf_output_iface == NF_OUT_DROP) {
 782         ctx->nf_output_iface = xflow_port;
 783     } else if (ctx->nf_output_iface != NF_OUT_FLOOD) {
 784         ctx->nf_output_iface = NF_OUT_MULTI;
 785     }
 786 }
 787
 788 static void
 789 xlate_nicira_action(struct wx_xlate_ctx *ctx,
 790                     const struct nx_action_header *nah)
 791 {
 792     const struct nx_action_resubmit *nar;
 793     const struct nx_action_set_tunnel *nast;
 794     union xflow_action *oa;
 795     int subtype = ntohs(nah->subtype);
 796
 797     assert(nah->vendor == htonl(NX_VENDOR_ID));
 798     switch (subtype) {
 799     case NXAST_RESUBMIT:
 800         nar = (const struct nx_action_resubmit *) nah;
 801         xlate_table_action(ctx, ofp_port_to_xflow_port(ntohs(nar->in_port)));
 802         break;
 803
 804     case NXAST_SET_TUNNEL:
 805         nast = (const struct nx_action_set_tunnel *) nah;
 806         oa = xflow_actions_add(ctx->out, XFLOWAT_SET_TUNNEL);
 807         ctx->flow.tun_id = oa->tunnel.tun_id = nast->tun_id;
 808         break;
 809
 810     /* If you add a new action here that modifies flow data, don't forget to
 811      * update the flow key in ctx->flow at the same time. */
 812
 813     default:
 814         VLOG_DBG_RL(&rl, "unknown Nicira action type %"PRIu16, subtype);
 815         break;
 816     }
 817 }
 818
 819 static void
 820 do_xlate_actions(const union ofp_action *in, size_t n_in,
 821                  struct wx_xlate_ctx *ctx)
 822 {
 823     struct actions_iterator iter;
 824     const union ofp_action *ia;
 825     const struct wdp_port *port;
 826
 827     port = port_array_get(&ctx->wx->ports, ctx->flow.in_port);
 828     if (port && port->opp.config & (OFPPC_NO_RECV | OFPPC_NO_RECV_STP) &&
 829         port->opp.config & (eth_addr_equals(ctx->flow.dl_dst, stp_eth_addr)
 830                             ? OFPPC_NO_RECV_STP : OFPPC_NO_RECV)) {
 831         /* Drop this flow. */
 832         return;
 833     }
 834
 835     for (ia = actions_first(&iter, in, n_in); ia; ia = actions_next(&iter)) {
 836         uint16_t type = ntohs(ia->type);
 837         union xflow_action *oa;
 838
 839         switch (type) {
 840         case OFPAT_OUTPUT:
 841             xlate_output_action(ctx, &ia->output);
 842             break;
 843
 844         case OFPAT_SET_VLAN_VID:
 845             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_DL_TCI);
 846             oa->dl_tci.tci = ia->vlan_vid.vlan_vid & htons(VLAN_VID_MASK);
 847             oa->dl_tci.mask = htons(VLAN_VID_MASK);
 848             ctx->flow.dl_vlan = ia->vlan_vid.vlan_vid;
 849             break;
 850
 851         case OFPAT_SET_VLAN_PCP:
 852             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_DL_TCI);
 853             oa->dl_tci.tci = htons((ia->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT)
 854                                    & VLAN_PCP_MASK);
 855             oa->dl_tci.mask = htons(VLAN_PCP_MASK);
 856
 857             if (ctx->flow.dl_vlan == htons(OFP_VLAN_NONE)) {
 858                 ctx->flow.dl_vlan = htons(0);
 859             }
 860             ctx->flow.dl_vlan_pcp = ia->vlan_pcp.vlan_pcp;
 861             break;
 862
 863         case OFPAT_STRIP_VLAN:
 864             xflow_actions_add(ctx->out, XFLOWAT_STRIP_VLAN);
 865             ctx->flow.dl_vlan = htons(OFP_VLAN_NONE);
 866             ctx->flow.dl_vlan_pcp = 0;
 867             break;
 868
 869         case OFPAT_SET_DL_SRC:
 870             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_DL_SRC);
 871             memcpy(oa->dl_addr.dl_addr,
 872                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
 873             memcpy(ctx->flow.dl_src,
 874                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
 875             break;
 876
 877         case OFPAT_SET_DL_DST:
 878             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_DL_DST);
 879             memcpy(oa->dl_addr.dl_addr,
 880                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
 881             memcpy(ctx->flow.dl_dst,
 882                    ((struct ofp_action_dl_addr *) ia)->dl_addr, ETH_ADDR_LEN);
 883             break;
 884
 885         case OFPAT_SET_NW_SRC:
 886             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_NW_SRC);
 887             ctx->flow.nw_src = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
 888             break;
 889
 890         case OFPAT_SET_NW_DST:
 891             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_NW_DST);
 892             ctx->flow.nw_dst = oa->nw_addr.nw_addr = ia->nw_addr.nw_addr;
 893             break;
 894
 895         case OFPAT_SET_NW_TOS:
 896             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_NW_TOS);
 897             ctx->flow.nw_tos = oa->nw_tos.nw_tos = ia->nw_tos.nw_tos;
 898             break;
 899
 900         case OFPAT_SET_TP_SRC:
 901             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_TP_SRC);
 902             ctx->flow.tp_src = oa->tp_port.tp_port = ia->tp_port.tp_port;
 903             break;
 904
 905         case OFPAT_SET_TP_DST:
 906             oa = xflow_actions_add(ctx->out, XFLOWAT_SET_TP_DST);
 907             ctx->flow.tp_dst = oa->tp_port.tp_port = ia->tp_port.tp_port;
 908             break;
 909
 910         case OFPAT_ENQUEUE:
 911             xlate_enqueue_action(ctx, (const struct ofp_action_enqueue *) ia);
 912             break;
 913
 914         case OFPAT_VENDOR:
 915             xlate_nicira_action(ctx, (const struct nx_action_header *) ia);
 916             break;
 917
 918         default:
 919             VLOG_DBG_RL(&rl, "unknown action type %"PRIu16, type);
 920             break;
 921         }
 922     }
 923 }
 924
 925 /* Returns true if 'flow' and 'actions' may be set up as a flow in the kernel.
 926  * This is true most of the time, but we don't allow flows that would prevent
 927  * DHCP replies from being seen by the local port to be set up in the
 928  * kernel.
 929  *
 930  * We only need this, strictly speaking, when in-band control is turned on. */
 931 static bool
 932 wx_may_set_up(const flow_t *flow, const struct xflow_actions *actions)
 933 {
 934     if (flow->dl_type == htons(ETH_TYPE_IP)
 935         && flow->nw_proto == IP_TYPE_UDP
 936         && flow->tp_src == htons(DHCP_SERVER_PORT)
 937         && flow->tp_dst == htons(DHCP_CLIENT_PORT)) {
 938         int i;
 939
 940         for (i = 0; i < actions->n_actions; i++) {
 941             const struct xflow_action_output *oao = &actions->actions[i].output;
 942             if (oao->type == XFLOWAT_OUTPUT && oao->port == XFLOWP_LOCAL) {
 943                 return true;
 944             }
 945         }
 946         return false;
 947     }
 948
 949     return true;
 950 }
 951
 952 static int
 953 wx_xlate_actions(struct wx *wx, const union ofp_action *in, size_t n_in,
 954                  const flow_t *flow, const struct ofpbuf *packet,
 955                  struct xflow_actions *out, bool *may_set_up_flow)
 956 {
 957     //tag_type no_tags = 0;
 958     struct wx_xlate_ctx ctx;
 959     COVERAGE_INC(wx_ofp2xflow);
 960     xflow_actions_init(out);
 961     ctx.flow = *flow;
 962     ctx.recurse = 0;
 963     ctx.wx = wx;
 964     ctx.packet = packet;
 965     ctx.out = out;
 966     //ctx.tags = tags ? tags : &no_tags;
 967     ctx.may_set_up_flow = true;
 968     ctx.nf_output_iface = NF_OUT_DROP;
 969     do_xlate_actions(in, n_in, &ctx);
 970     remove_pop_action(&ctx);
 971
 972     if (may_set_up_flow) {
 973         *may_set_up_flow = ctx.may_set_up_flow && wx_may_set_up(flow, out);
 974     }
 975 #if 0
 976     if (nf_output_iface) {
 977         *nf_output_iface = ctx.nf_output_iface;
 978     }
 979 #endif
 980     if (xflow_actions_overflow(out)) {
 981         xflow_actions_init(out);
 982         return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_TOO_MANY);
 983     }
 984     return 0;
 985 }
 986 \f
 987 static void
 988 update_used(struct wx *wx)
 989 {
 990     struct xflow_flow *flows;
 991     size_t n_flows;
 992     size_t i;
 993     int error;
 994
 995     error = xfif_flow_list_all(wx->xfif, &flows, &n_flows);
 996     if (error) {
 997         return;
 998     }
 999
1000     for (i = 0; i < n_flows; i++) {
1001         struct xflow_flow *f = &flows[i];
1002         struct wx_rule *rule;
1003         flow_t flow;
1004
1005         xflow_key_to_flow(&f->key, &flow);
1006         rule = wx_rule_cast(classifier_find_rule_exactly(&wx->cls, &flow));
1007         if (!rule || !rule->installed) {
1008             COVERAGE_INC(wx_unexpected_rule);
1009             xfif_flow_del(wx->xfif, f);
1010             continue;
1011         }
1012
1013         wx_rule_update_time(wx, rule, &f->stats);
1014         wx_rule_account(wx, rule, f->stats.n_bytes);
1015     }
1016     free(flows);
1017 }
1018
1019 static void
1020 uninstall_idle_flow(struct wx *wx, struct wx_rule *rule)
1021 {
1022     assert(rule->installed);
1023     assert(!rule->wr.cr.flow.wildcards);
1024
1025     if (rule->super) {
1026         wx_rule_remove(wx, rule);
1027     } else {
1028         wx_rule_uninstall(wx, rule);
1029     }
1030 }
1031
1032 static void
1033 expire_rule(struct cls_rule *cls_rule, void *wx_)
1034 {
1035     struct wx *wx = wx_;
1036     struct wx_rule *rule = wx_rule_cast(cls_rule);
1037     long long int hard_expire, idle_expire, expire, now;
1038
1039     hard_expire = (rule->wr.hard_timeout
1040                    ? rule->wr.created + rule->wr.hard_timeout * 1000
1041                    : LLONG_MAX);
1042     idle_expire = (rule->wr.idle_timeout
1043                    && (rule->super || list_is_empty(&rule->list))
1044                    ? rule->used + rule->wr.idle_timeout * 1000
1045                    : LLONG_MAX);
1046     expire = MIN(hard_expire, idle_expire);
1047
1048     now = time_msec();
1049     if (now < expire) {
1050         if (rule->installed && now >= rule->used + 5000) {
1051             uninstall_idle_flow(wx, rule);
1052         } else if (!rule->wr.cr.flow.wildcards) {
1053             //XXX active_timeout(wx, rule);
1054         }
1055
1056         return;
1057     }
1058
1059     COVERAGE_INC(wx_expired);
1060
1061     /* Update stats.  This code will be a no-op if the rule expired
1062      * due to an idle timeout. */
1063     if (rule->wr.cr.flow.wildcards) {
1064         struct wx_rule *subrule, *next;
1065         LIST_FOR_EACH_SAFE (subrule, next, struct wx_rule, list, &rule->list) {
1066             wx_rule_remove(wx, subrule);
1067         }
1068     } else {
1069         wx_rule_uninstall(wx, rule);
1070     }
1071
1072 #if 0                           /* XXX */
1073     if (!wx_rule_is_hidden(rule)) {
1074         send_flow_removed(wx, rule, now,
1075                           (now >= hard_expire
1076                            ? OFPRR_HARD_TIMEOUT : OFPRR_IDLE_TIMEOUT));
1077     }
1078 #endif
1079     wx_rule_remove(wx, rule);
1080 }
1081
1082 struct revalidate_cbdata {
1083     struct wx *wx;
1084     bool revalidate_all;        /* Revalidate all exact-match rules? */
1085     bool revalidate_subrules;   /* Revalidate all exact-match subrules? */
1086     //struct tag_set revalidate_set; /* Set of tags to revalidate. */
1087 };
1088
1089 static bool
1090 revalidate_rule(struct wx *wx, struct wx_rule *rule)
1091 {
1092     const flow_t *flow = &rule->wr.cr.flow;
1093
1094     COVERAGE_INC(wx_revalidate_rule);
1095     if (rule->super) {
1096         struct wx_rule *super;
1097         super = wx_rule_cast(classifier_lookup_wild(&wx->cls, flow));
1098         if (!super) {
1099             wx_rule_remove(wx, rule);
1100             return false;
1101         } else if (super != rule->super) {
1102             COVERAGE_INC(wx_revalidate_moved);
1103             list_remove(&rule->list);
1104             list_push_back(&super->list, &rule->list);
1105             rule->super = super;
1106             rule->wr.hard_timeout = super->wr.hard_timeout;
1107             rule->wr.idle_timeout = super->wr.idle_timeout;
1108             rule->wr.created = super->wr.created;
1109             rule->used = 0;
1110         }
1111     }
1112
1113     wx_rule_update_actions(wx, rule);
1114     return true;
1115 }
1116
1117 static void
1118 revalidate_cb(struct cls_rule *sub_, void *cbdata_)
1119 {
1120     struct wx_rule *sub = wx_rule_cast(sub_);
1121     struct revalidate_cbdata *cbdata = cbdata_;
1122
1123     if (cbdata->revalidate_all
1124         || (cbdata->revalidate_subrules && sub->super)
1125         /*|| (tag_set_intersects(&cbdata->revalidate_set, sub->tags))*/) {
1126         revalidate_rule(cbdata->wx, sub);
1127     }
1128 }
1129
1130 static void
1131 wx_run_one(struct wx *wx)
1132 {
1133     wx_port_run(wx);
1134
1135     if (time_msec() >= wx->next_expiration) {
1136         COVERAGE_INC(wx_expiration);
1137         wx->next_expiration = time_msec() + 1000;
1138         update_used(wx);
1139
1140         classifier_for_each(&wx->cls, CLS_INC_ALL, expire_rule, wx);
1141
1142         /* XXX account_checkpoint_cb */
1143     }
1144
1145     if (wx->need_revalidate /*|| !tag_set_is_empty(&p->revalidate_set)*/) {
1146         struct revalidate_cbdata cbdata;
1147         cbdata.wx = wx;
1148         cbdata.revalidate_all = false;
1149         cbdata.revalidate_subrules = wx->need_revalidate;
1150         //cbdata.revalidate_set = wx->revalidate_set;
1151         //tag_set_init(&wx->revalidate_set);
1152         COVERAGE_INC(wx_revalidate);
1153         classifier_for_each(&wx->cls, CLS_INC_EXACT, revalidate_cb, &cbdata);
1154         wx->need_revalidate = false;
1155     }
1156 }
1157
1158 static void
1159 wx_run(void)
1160 {
1161     struct wx *wx;
1162
1163     LIST_FOR_EACH (wx, struct wx, list_node, &all_wx) {
1164         wx_run_one(wx);
1165     }
1166     xf_run();
1167 }
1168
1169 static void
1170 wx_wait_one(struct wx *wx)
1171 {
1172     xfif_port_poll_wait(wx->xfif);
1173     netdev_monitor_poll_wait(wx->netdev_monitor);
1174     if (wx->need_revalidate /*|| !tag_set_is_empty(&p->revalidate_set)*/) {
1175         poll_immediate_wake();
1176     } else if (wx->next_expiration != LLONG_MAX) {
1177         poll_timer_wait_until(wx->next_expiration);
1178     }
1179 }
1180
1181 static void
1182 wx_wait(void)
1183 {
1184     struct wx *wx;
1185
1186     LIST_FOR_EACH (wx, struct wx, list_node, &all_wx) {
1187         wx_wait_one(wx);
1188     }
1189     xf_wait();
1190 }
1191 \f
1192 static int wx_flow_flush(struct wdp *);
1193
1194 static int
1195 wx_enumerate(const struct wdp_class *wdp_class, struct svec *all_wdps)
1196 {
1197     struct svec names = SVEC_EMPTY_INITIALIZER;
1198     int error = xf_enumerate_names(wdp_class->type, &names);
1199     svec_move(all_wdps, &names);
1200     return error;
1201 }
1202
1203 static int
1204 wx_open(const struct wdp_class *wdp_class, const char *name, bool create,
1205         struct wdp **wdpp)
1206 {
1207     struct xfif *xfif;
1208     int error;
1209
1210     error = (create
1211              ? xfif_create_and_open(name, wdp_class->type, &xfif)
1212              : xfif_open(name, wdp_class->type, &xfif));
1213     if (!error) {
1214         struct wx *wx;
1215
1216         wx = xzalloc(sizeof *wx);
1217         list_push_back(&all_wx, &wx->list_node);
1218         wdp_init(&wx->wdp, wdp_class, name, 0, 0);
1219         wx->xfif = xfif;
1220         classifier_init(&wx->cls);
1221         wx->netdev_monitor = netdev_monitor_create();
1222         port_array_init(&wx->ports);
1223         shash_init(&wx->port_by_name);
1224         wx->next_expiration = time_msec() + 1000;
1225
1226         wx_port_init(wx);
1227
1228         *wdpp = &wx->wdp;
1229     }
1230
1231     return error;
1232 }
1233
1234 static void
1235 wx_close(struct wdp *wdp)
1236 {
1237     struct wx *wx = wx_cast(wdp);
1238
1239     wx_flow_flush(wdp);
1240     xfif_close(wx->xfif);
1241     classifier_destroy(&wx->cls);
1242     netdev_monitor_destroy(wx->netdev_monitor);
1243     list_remove(&wx->list_node);
1244     free(wx);
1245 }
1246
1247 static int
1248 wx_get_all_names(const struct wdp *wdp, struct svec *all_names)
1249 {
1250     struct wx *wx = wx_cast(wdp);
1251
1252     return xfif_get_all_names(wx->xfif, all_names);
1253 }
1254
1255 static int
1256 wx_destroy(struct wdp *wdp)
1257 {
1258     struct wx *wx = wx_cast(wdp);
1259
1260     return xfif_delete(wx->xfif);
1261 }
1262
1263 static int
1264 wx_get_features(const struct wdp *wdp, struct ofpbuf **featuresp)
1265 {
1266     struct wx *wx = wx_cast(wdp);
1267     struct ofp_switch_features *osf;
1268     struct ofpbuf *buf;
1269     unsigned int port_no;
1270     struct wdp_port *port;
1271
1272     buf = ofpbuf_new(sizeof *osf);
1273     osf = ofpbuf_put_zeros(buf, sizeof *osf);
1274     osf->n_tables = 2;
1275     osf->capabilities = htonl(OFPC_ARP_MATCH_IP);
1276     osf->actions = htonl((1u << OFPAT_OUTPUT) |
1277                          (1u << OFPAT_SET_VLAN_VID) |
1278                          (1u << OFPAT_SET_VLAN_PCP) |
1279                          (1u << OFPAT_STRIP_VLAN) |
1280                          (1u << OFPAT_SET_DL_SRC) |
1281                          (1u << OFPAT_SET_DL_DST) |
1282                          (1u << OFPAT_SET_NW_SRC) |
1283                          (1u << OFPAT_SET_NW_DST) |
1284                          (1u << OFPAT_SET_NW_TOS) |
1285                          (1u << OFPAT_SET_TP_SRC) |
1286                          (1u << OFPAT_SET_TP_DST) |
1287                          (1u << OFPAT_ENQUEUE));
1288
1289     PORT_ARRAY_FOR_EACH (port, &wx->ports, port_no) {
1290         hton_ofp_phy_port(ofpbuf_put(buf, &port->opp, sizeof port->opp));
1291     }
1292
1293     *featuresp = buf;
1294     return 0;
1295 }
1296
1297 static void
1298 count_subrules(struct cls_rule *cls_rule, void *n_subrules_)
1299 {
1300     struct wx_rule *rule = wx_rule_cast(cls_rule);
1301     int *n_subrules = n_subrules_;
1302
1303     if (rule->super) {
1304         (*n_subrules)++;
1305     }
1306 }
1307
1308 static int
1309 wx_get_stats(const struct wdp *wdp, struct wdp_stats *stats)
1310 {
1311     struct wx *wx = wx_cast(wdp);
1312     struct xflow_stats xflow_stats;
1313     int n_subrules;
1314     int error;
1315
1316     error = xfif_get_xf_stats(wx->xfif, &xflow_stats);
1317
1318     n_subrules = 0;
1319     classifier_for_each(&wx->cls, CLS_INC_EXACT, count_subrules, &n_subrules);
1320
1321     stats->exact.n_flows = classifier_count_exact(&wx->cls) - n_subrules;
1322     stats->exact.cur_capacity = xflow_stats.cur_capacity;
1323     stats->exact.max_capacity = MIN(WX_MAX_EXACT, xflow_stats.max_capacity);
1324     stats->exact.n_hit = xflow_stats.n_hit;
1325     stats->exact.n_missed = xflow_stats.n_missed;
1326     stats->exact.n_lost = xflow_stats.n_lost;
1327
1328     stats->wild.n_flows = classifier_count_wild(&wx->cls);
1329     stats->wild.cur_capacity = WX_MAX_WILD;
1330     stats->wild.max_capacity = WX_MAX_WILD;
1331     stats->wild.n_hit = 0;      /* XXX */
1332     stats->wild.n_missed = 0;   /* XXX */
1333     stats->wild.n_lost = 0;     /* XXX */
1334
1335     stats->n_ports = xflow_stats.n_ports;
1336     stats->max_ports = xflow_stats.max_ports;
1337
1338     stats->n_frags = xflow_stats.n_frags;
1339
1340     stats->max_miss_queue = xflow_stats.max_miss_queue;
1341     stats->max_action_queue = xflow_stats.max_action_queue;
1342     stats->max_sflow_queue = xflow_stats.max_sflow_queue;
1343
1344     return error;
1345 }
1346
1347 static int
1348 wx_get_drop_frags(const struct wdp *wdp, bool *drop_frags)
1349 {
1350     struct wx *wx = wx_cast(wdp);
1351
1352     return xfif_get_drop_frags(wx->xfif, drop_frags);
1353 }
1354
1355 static int
1356 wx_set_drop_frags(struct wdp *wdp, bool drop_frags)
1357 {
1358     struct wx *wx = wx_cast(wdp);
1359
1360     return xfif_set_drop_frags(wx->xfif, drop_frags);
1361 }
1362
1363 static int
1364 wx_port_add(struct wdp *wdp, const char *devname,
1365             bool internal, uint16_t *port_no)
1366 {
1367     struct wx *wx = wx_cast(wdp);
1368     uint16_t xflow_flags = internal ? XFLOW_PORT_INTERNAL : 0;
1369     return xfif_port_add(wx->xfif, devname, xflow_flags, port_no);
1370 }
1371
1372 static int
1373 wx_port_del(struct wdp *wdp, uint16_t port_no)
1374 {
1375     struct wx *wx = wx_cast(wdp);
1376
1377     return xfif_port_del(wx->xfif, port_no);
1378 }
1379
1380 static int
1381 wx_answer_port_query(const struct wdp_port *port, struct wdp_port *portp)
1382 {
1383     if (port) {
1384         wdp_port_copy(portp, port);
1385         return 0;
1386     } else {
1387         return ENOENT;
1388     }
1389 }
1390
1391 static int
1392 wx_port_query_by_number(const struct wdp *wdp, uint16_t port_no,
1393                         struct wdp_port *portp)
1394 {
1395     struct wx *wx = wx_cast(wdp);
1396     const struct wdp_port *port;
1397
1398     port = port_array_get(&wx->ports, ofp_port_to_xflow_port(port_no));
1399     return wx_answer_port_query(port, portp);
1400 }
1401
1402 static int
1403 wx_port_query_by_name(const struct wdp *wdp, const char *devname,
1404                       struct wdp_port *portp)
1405 {
1406     struct wx *wx = wx_cast(wdp);
1407
1408     return wx_answer_port_query(shash_find_data(&wx->port_by_name, devname),
1409                                 portp);
1410 }
1411
1412 static int
1413 wx_port_set_config(struct wdp *wdp, uint16_t port_no, uint32_t config)
1414 {
1415     struct wx *wx = wx_cast(wdp);
1416     struct wdp_port *port;
1417     uint32_t changes;
1418
1419     port = port_array_get(&wx->ports, ofp_port_to_xflow_port(port_no));
1420     if (!port) {
1421         return ENOENT;
1422     }
1423     changes = config ^ port->opp.config;
1424
1425     if (changes & OFPPC_PORT_DOWN) {
1426         int error;
1427         if (config & OFPPC_PORT_DOWN) {
1428             error = netdev_turn_flags_off(port->netdev, NETDEV_UP, true);
1429         } else {
1430             error = netdev_turn_flags_on(port->netdev, NETDEV_UP, true);
1431         }
1432         if (!error) {
1433             port->opp.config ^= OFPPC_PORT_DOWN;
1434         }
1435     }
1436
1437 #define REVALIDATE_BITS (OFPPC_NO_RECV | OFPPC_NO_RECV_STP | OFPPC_NO_FWD)
1438     if (changes & REVALIDATE_BITS) {
1439         COVERAGE_INC(wx_costly_flags);
1440         port->opp.config ^= changes & REVALIDATE_BITS;
1441         wx->need_revalidate = true;
1442     }
1443 #undef REVALIDATE_BITS
1444
1445     if (changes & OFPPC_NO_FLOOD) {
1446         port->opp.config ^= OFPPC_NO_FLOOD;
1447         wx_port_refresh_groups(wx);
1448     }
1449
1450     if (changes & OFPPC_NO_PACKET_IN) {
1451         port->opp.config ^= OFPPC_NO_PACKET_IN;
1452     }
1453
1454     return 0;
1455 }
1456
1457 static int
1458 wx_port_list(const struct wdp *wdp, struct wdp_port **portsp, size_t *n_portsp)
1459 {
1460     struct wx *wx = wx_cast(wdp);
1461     struct wdp_port *ports, *port;
1462     unsigned int port_no;
1463     size_t n_ports, i;
1464
1465     *n_portsp = n_ports = port_array_count(&wx->ports);
1466     *portsp = ports = xmalloc(n_ports * sizeof *ports);
1467     i = 0;
1468     PORT_ARRAY_FOR_EACH (port, &wx->ports, port_no) {
1469         wdp_port_copy(&ports[i++], port);
1470     }
1471     assert(i == n_ports);
1472
1473     return 0;
1474 }
1475
1476 static int
1477 wx_port_poll(const struct wdp *wdp, char **devnamep)
1478 {
1479     struct wx *wx = wx_cast(wdp);
1480
1481     return xfif_port_poll(wx->xfif, devnamep);
1482 }
1483
1484 static void
1485 wx_port_poll_wait(const struct wdp *wdp)
1486 {
1487     struct wx *wx = wx_cast(wdp);
1488
1489     xfif_port_poll_wait(wx->xfif);
1490 }
1491
1492 static struct wdp_rule *
1493 wx_flow_get(const struct wdp *wdp, const flow_t *flow)
1494 {
1495     struct wx *wx = wx_cast(wdp);
1496     struct wx_rule *rule;
1497
1498     rule = wx_rule_cast(classifier_find_rule_exactly(&wx->cls, flow));
1499     return rule && !wx_rule_is_hidden(rule) ? &rule->wr : NULL;
1500 }
1501
1502 static struct wdp_rule *
1503 wx_flow_match(const struct wdp *wdp, const flow_t *flow)
1504 {
1505     struct wx *wx = wx_cast(wdp);
1506     struct wx_rule *rule;
1507
1508     rule = wx_rule_cast(classifier_lookup(&wx->cls, flow));
1509     if (rule) {
1510         if (wx_rule_is_hidden(rule)) {
1511             rule = rule->super;
1512         }
1513         return &rule->wr;
1514     } else {
1515         return NULL;
1516     }
1517 }
1518
1519 struct wx_for_each_thunk_aux {
1520     wdp_flow_cb_func *client_callback;
1521     void *client_aux;
1522 };
1523
1524 static void
1525 wx_for_each_thunk(struct cls_rule *cls_rule, void *aux_)
1526 {
1527     struct wx_for_each_thunk_aux *aux = aux_;
1528     struct wx_rule *rule = wx_rule_cast(cls_rule);
1529
1530     if (!wx_rule_is_hidden(rule)) {
1531         aux->client_callback(&rule->wr, aux->client_aux);
1532     }
1533 }
1534
1535 static void
1536 wx_flow_for_each_match(const struct wdp *wdp, const flow_t *target,
1537                        int include,
1538                        wdp_flow_cb_func *client_callback, void *client_aux)
1539 {
1540     struct wx *wx = wx_cast(wdp);
1541     struct wx_for_each_thunk_aux aux;
1542
1543     aux.client_callback = client_callback;
1544     aux.client_aux = client_aux;
1545     classifier_for_each_match(&wx->cls, target, include,
1546                               wx_for_each_thunk, &aux);
1547 }
1548
1549 /* Obtains statistic counters for 'rule' within 'wx' and stores them into
1550  * '*stats'.  If 'rule' is a wildcarded rule, the returned statistic include
1551  * statistics for all of 'rule''s subrules. */
1552 static void
1553 query_stats(struct wx *wx, struct wx_rule *rule, struct wdp_flow_stats *stats)
1554 {
1555     struct wx_rule *subrule;
1556     struct xflow_flow *xflow_flows;
1557     size_t n_xflow_flows;
1558
1559     /* Start from historical data for 'rule' itself that are no longer tracked
1560      * by the datapath.  This counts, for example, subrules that have
1561      * expired. */
1562     stats->n_packets = rule->packet_count;
1563     stats->n_bytes = rule->byte_count;
1564     stats->inserted = rule->wr.created;
1565     stats->used = LLONG_MIN;
1566     stats->tcp_flags = 0;
1567     stats->ip_tos = 0;
1568
1569     /* Prepare to ask the datapath for statistics on 'rule', or if it is
1570      * wildcarded then on all of its subrules.
1571      *
1572      * Also, add any statistics that are not tracked by the datapath for each
1573      * subrule.  This includes, for example, statistics for packets that were
1574      * executed "by hand" by ofproto via xfif_execute() but must be accounted
1575      * to a flow. */
1576     n_xflow_flows = rule->wr.cr.flow.wildcards ? list_size(&rule->list) : 1;
1577     xflow_flows = xzalloc(n_xflow_flows * sizeof *xflow_flows);
1578     if (rule->wr.cr.flow.wildcards) {
1579         size_t i = 0;
1580         LIST_FOR_EACH (subrule, struct wx_rule, list, &rule->list) {
1581             xflow_key_from_flow(&xflow_flows[i++].key, &subrule->wr.cr.flow);
1582             stats->n_packets += subrule->packet_count;
1583             stats->n_bytes += subrule->byte_count;
1584         }
1585     } else {
1586         xflow_key_from_flow(&xflow_flows[0].key, &rule->wr.cr.flow);
1587     }
1588
1589     /* Fetch up-to-date statistics from the datapath and add them in. */
1590     if (!xfif_flow_get_multiple(wx->xfif, xflow_flows, n_xflow_flows)) {
1591         size_t i;
1592         for (i = 0; i < n_xflow_flows; i++) {
1593             struct xflow_flow *xflow_flow = &xflow_flows[i];
1594             long long int used;
1595
1596             stats->n_packets += xflow_flow->stats.n_packets;
1597             stats->n_bytes += xflow_flow->stats.n_bytes;
1598             used = xflow_flow_stats_to_msec(&xflow_flow->stats);
1599             if (used > stats->used) {
1600                 stats->used = used;
1601                 if (xflow_flow->key.dl_type == htons(ETH_TYPE_IP)
1602                     && xflow_flow->key.nw_proto == IP_TYPE_TCP) {
1603                     stats->ip_tos = xflow_flow->stats.ip_tos;
1604                 }
1605             }
1606             stats->tcp_flags |= xflow_flow->stats.tcp_flags;
1607         }
1608     }
1609     free(xflow_flows);
1610 }
1611
1612 static int
1613 wx_flow_get_stats(const struct wdp *wdp,
1614                   const struct wdp_rule *wdp_rule,
1615                   struct wdp_flow_stats *stats)
1616 {
1617     struct wx *wx = wx_cast(wdp);
1618     struct wx_rule *rule = wx_rule_cast(&wdp_rule->cr);
1619
1620     query_stats(wx, rule, stats);
1621     return 0;
1622 }
1623
1624 static bool
1625 wx_flow_overlaps(const struct wdp *wdp, const flow_t *flow)
1626 {
1627     struct wx *wx = wx_cast(wdp);
1628
1629     /* XXX overlap with a subrule? */
1630     return classifier_rule_overlaps(&wx->cls, flow);
1631 }
1632
1633 static int
1634 wx_flow_put(struct wdp *wdp, const struct wdp_flow_put *put,
1635             struct wdp_flow_stats *old_stats, struct wdp_rule **rulep)
1636 {
1637     struct wx *wx = wx_cast(wdp);
1638     struct wx_rule *rule;
1639
1640     rule = wx_rule_cast(classifier_find_rule_exactly(&wx->cls, put->flow));
1641     if (rule && wx_rule_is_hidden(rule)) {
1642         rule = NULL;
1643     }
1644
1645     if (rule) {
1646         if (!(put->flags & WDP_PUT_MODIFY)) {
1647             return EEXIST;
1648         }
1649     } else {
1650         if (!(put->flags & WDP_PUT_CREATE)) {
1651             return EINVAL;
1652         }
1653         if ((put->flow->wildcards
1654              ? classifier_count_wild(&wx->cls) >= WX_MAX_WILD
1655              : classifier_count_exact(&wx->cls) >= WX_MAX_EXACT)) {
1656             /* XXX subrules should not count against exact-match limit */
1657             return ENOBUFS;
1658         }
1659     }
1660
1661     rule = wx_rule_create(NULL, put->actions, put->n_actions,
1662                           put->idle_timeout, put->hard_timeout);
1663     cls_rule_from_flow(put->flow, &rule->wr.cr);
1664     wx_rule_insert(wx, rule, NULL, 0);
1665
1666     if (old_stats) {
1667         /* XXX */
1668         memset(old_stats, 0, sizeof *old_stats);
1669     }
1670     if (rulep) {
1671         *rulep = &rule->wr;
1672     }
1673
1674     return 0;
1675 }
1676
1677 static int
1678 wx_flow_delete(struct wdp *wdp, struct wdp_rule *wdp_rule,
1679                struct wdp_flow_stats *final_stats)
1680 {
1681     struct wx *wx = wx_cast(wdp);
1682     struct wx_rule *rule = wx_rule_cast(&wdp_rule->cr);
1683
1684     wx_rule_remove(wx, rule);
1685     if (final_stats) {
1686         memset(final_stats, 0, sizeof *final_stats); /* XXX */
1687     }
1688     return 0;
1689 }
1690
1691 static void
1692 wx_flush_rule(struct cls_rule *cls_rule, void *wx_)
1693 {
1694     struct wx_rule *rule = wx_rule_cast(cls_rule);
1695     struct wx *wx = wx_;
1696
1697     /* Mark the flow as not installed, even though it might really be
1698      * installed, so that wx_rule_remove() doesn't bother trying to uninstall
1699      * it.  There is no point in uninstalling it individually since we are
1700      * about to blow away all the flows with xfif_flow_flush(). */
1701     rule->installed = false;
1702
1703     wx_rule_remove(wx, rule);
1704 }
1705
1706 static int
1707 wx_flow_flush(struct wdp *wdp)
1708 {
1709     struct wx *wx = wx_cast(wdp);
1710
1711     COVERAGE_INC(wx_flow_flush);
1712     classifier_for_each(&wx->cls, CLS_INC_ALL, wx_flush_rule, wx);
1713     xfif_flow_flush(wx->xfif);
1714     return 0;
1715 }
1716
1717 static int
1718 wx_execute(struct wdp *wdp, uint16_t in_port,
1719            const union ofp_action actions[], int n_actions,
1720            const struct ofpbuf *packet)
1721 {
1722     struct wx *wx = wx_cast(wdp);
1723     struct xflow_actions xflow_actions;
1724     flow_t flow;
1725     int error;
1726
1727     flow_extract((struct ofpbuf *) packet, 0, in_port, &flow);
1728     error = wx_xlate_actions(wx, actions, n_actions, &flow, packet,
1729                              &xflow_actions, NULL);
1730     if (error) {
1731         return error;
1732     }
1733     xfif_execute(wx->xfif, ofp_port_to_xflow_port(in_port),
1734                  xflow_actions.actions, xflow_actions.n_actions, packet);
1735     return 0;
1736 }
1737
1738 static int
1739 wx_flow_inject(struct wdp *wdp, struct wdp_rule *wdp_rule,
1740                uint16_t in_port, const struct ofpbuf *packet)
1741 {
1742     struct wx_rule *rule = wx_rule_cast(&wdp_rule->cr);
1743     int error;
1744
1745     error = wx_execute(wdp, in_port, rule->wr.actions, rule->wr.n_actions,
1746                        packet);
1747     if (!error) {
1748         rule->packet_count++;
1749         rule->byte_count += packet->size;
1750         rule->used = time_msec();
1751     }
1752     return error;
1753 }
1754
1755 static int
1756 wx_recv_get_mask(const struct wdp *wdp, int *listen_mask)
1757 {
1758     struct wx *wx = wx_cast(wdp);
1759     int xflow_listen_mask;
1760     int error;
1761
1762     error = xfif_recv_get_mask(wx->xfif, &xflow_listen_mask);
1763     if (!error) {
1764         *listen_mask = 0;
1765         if (xflow_listen_mask & XFLOWL_MISS) {
1766             *listen_mask |= 1 << WDP_CHAN_MISS;
1767         }
1768         if (xflow_listen_mask & XFLOWL_ACTION) {
1769             *listen_mask |= 1 << WDP_CHAN_ACTION;
1770         }
1771         if (xflow_listen_mask & XFLOWL_SFLOW) {
1772             *listen_mask |= 1 << WDP_CHAN_SFLOW;
1773         }
1774     }
1775     return error;
1776 }
1777
1778 static int
1779 wx_recv_set_mask(struct wdp *wdp, int listen_mask)
1780 {
1781     struct wx *wx = wx_cast(wdp);
1782     int xflow_listen_mask;
1783
1784     xflow_listen_mask = 0;
1785     if (listen_mask & (1 << WDP_CHAN_MISS)) {
1786         xflow_listen_mask |= XFLOWL_MISS;
1787     }
1788     if (listen_mask & (1 << WDP_CHAN_ACTION)) {
1789         xflow_listen_mask |= XFLOWL_ACTION;
1790     }
1791     if (listen_mask & (1 << WDP_CHAN_SFLOW)) {
1792         xflow_listen_mask |= XFLOWL_SFLOW;
1793     }
1794
1795     return xfif_recv_set_mask(wx->xfif, xflow_listen_mask);
1796 }
1797
1798 static int
1799 wx_get_sflow_probability(const struct wdp *wdp, uint32_t *probability)
1800 {
1801     struct wx *wx = wx_cast(wdp);
1802
1803     return xfif_get_sflow_probability(wx->xfif, probability);
1804 }
1805
1806 static int
1807 wx_set_sflow_probability(struct wdp *wdp, uint32_t probability)
1808 {
1809     struct wx *wx = wx_cast(wdp);
1810
1811     return xfif_set_sflow_probability(wx->xfif, probability);
1812 }
1813
1814 static int
1815 wx_translate_xflow_msg(struct xflow_msg *msg, struct ofpbuf *payload,
1816                        struct wdp_packet *packet)
1817 {
1818     packet->in_port = xflow_port_to_ofp_port(msg->port);
1819     packet->send_len = 0;
1820     packet->tun_id = 0;
1821
1822     switch (msg->type) {
1823     case _XFLOWL_MISS_NR:
1824         packet->channel = WDP_CHAN_MISS;
1825         packet->payload = payload;
1826         packet->tun_id = msg->arg;
1827         return 0;
1828
1829     case _XFLOWL_ACTION_NR:
1830         packet->channel = WDP_CHAN_ACTION;
1831         packet->payload = payload;
1832         packet->send_len = msg->arg;
1833         return 0;
1834
1835     case _XFLOWL_SFLOW_NR:
1836         /* XXX */
1837         ofpbuf_delete(payload);
1838         return ENOSYS;
1839
1840     default:
1841         VLOG_WARN_RL(&rl, "received XFLOW message of unexpected type %"PRIu32,
1842                      msg->type);
1843         ofpbuf_delete(payload);
1844         return ENOSYS;
1845     }
1846 }
1847
1848 static const uint8_t *
1849 get_local_mac(const struct wx *wx)
1850 {
1851     const struct wdp_port *port = port_array_get(&wx->ports, XFLOWP_LOCAL);
1852     return port ? port->opp.hw_addr : NULL;
1853 }
1854
1855 /* Returns true if 'packet' is a DHCP reply to the local port.  Such a reply
1856  * should be sent to the local port regardless of the flow table.
1857  *
1858  * We only need this, strictly speaking, when in-band control is turned on. */
1859 static bool
1860 wx_is_local_dhcp_reply(const struct wx *wx,
1861                        const flow_t *flow, const struct ofpbuf *packet)
1862 {
1863     if (flow->dl_type == htons(ETH_TYPE_IP)
1864         && flow->nw_proto == IP_TYPE_UDP
1865         && flow->tp_src == htons(DHCP_SERVER_PORT)
1866         && flow->tp_dst == htons(DHCP_CLIENT_PORT)
1867         && packet->l7)
1868     {
1869         const uint8_t *local_mac = get_local_mac(wx);
1870         struct dhcp_header *dhcp = ofpbuf_at(
1871             packet, (char *)packet->l7 - (char *)packet->data, sizeof *dhcp);
1872         return dhcp && local_mac && eth_addr_equals(dhcp->chaddr, local_mac);
1873     }
1874
1875     return false;
1876 }
1877
1878 static bool
1879 wx_explode_rule(struct wx *wx, struct xflow_msg *msg, struct ofpbuf *payload)
1880 {
1881     struct wx_rule *rule;
1882     flow_t flow;
1883
1884     flow_extract(payload, 0, xflow_port_to_ofp_port(msg->port), &flow);
1885
1886     if (wx_is_local_dhcp_reply(wx, &flow, payload)) {
1887         union xflow_action action;
1888
1889         memset(&action, 0, sizeof(action));
1890         action.output.type = XFLOWAT_OUTPUT;
1891         action.output.port = XFLOWP_LOCAL;
1892         xfif_execute(wx->xfif, msg->port, &action, 1, payload);
1893     }
1894
1895     rule = wx_rule_lookup_valid(wx, &flow);
1896     if (!rule) {
1897         return false;
1898     }
1899
1900     if (rule->wr.cr.flow.wildcards) {
1901         rule = wx_rule_create_subrule(wx, rule, &flow);
1902         wx_rule_make_actions(wx, rule, payload);
1903     } else {
1904         if (!rule->may_install) {
1905             /* The rule is not installable, that is, we need to process every
1906              * packet, so process the current packet and set its actions into
1907              * 'subrule'. */
1908             wx_rule_make_actions(wx, rule, payload);
1909         } else {
1910             /* XXX revalidate rule if it needs it */
1911         }
1912     }
1913
1914     wx_rule_execute(wx, rule, payload, &flow);
1915     wx_rule_reinstall(wx, rule);
1916
1917     return true;
1918 }
1919
1920 static int
1921 wx_recv(struct wdp *wdp, struct wdp_packet *packet)
1922 {
1923     struct wx *wx = wx_cast(wdp);
1924     int i;
1925
1926     /* XXX need to avoid 50*50 potential cost for caller. */
1927     for (i = 0; i < 50; i++) {
1928         struct xflow_msg *msg;
1929         struct ofpbuf *buf;
1930         int error;
1931
1932         error = xfif_recv(wx->xfif, &buf);
1933         if (error) {
1934             return error;
1935         }
1936
1937         msg = ofpbuf_pull(buf, sizeof *msg);
1938         if (msg->type != _XFLOWL_MISS_NR || !wx_explode_rule(wx, msg, buf)) {
1939             return wx_translate_xflow_msg(msg, buf, packet);
1940         }
1941         ofpbuf_delete(buf);
1942     }
1943     return EAGAIN;
1944 }
1945
1946 static void
1947 wx_recv_wait(struct wdp *wdp)
1948 {
1949     struct wx *wx = wx_cast(wdp);
1950
1951     xfif_recv_wait(wx->xfif);
1952 }
1953 \f
1954 static void wx_port_update(struct wx *, const char *devname);
1955 static void wx_port_reinit(struct wx *);
1956
1957 static void
1958 wx_port_process_change(struct wx *wx, int error, char *devname)
1959 {
1960     if (error == ENOBUFS) {
1961         wx_port_reinit(wx);
1962     } else if (!error) {
1963         wx_port_update(wx, devname);
1964         free(devname);
1965     }
1966 }
1967
1968 static void
1969 wx_port_run(struct wx *wx)
1970 {
1971     char *devname;
1972     int error;
1973
1974     while ((error = xfif_port_poll(wx->xfif, &devname)) != EAGAIN) {
1975         wx_port_process_change(wx, error, devname);
1976     }
1977     while ((error = netdev_monitor_poll(wx->netdev_monitor,
1978                                         &devname)) != EAGAIN) {
1979         wx_port_process_change(wx, error, devname);
1980     }
1981 }
1982
1983 static size_t
1984 wx_port_refresh_group(struct wx *wx, unsigned int group)
1985 {
1986     uint16_t *ports;
1987     size_t n_ports;
1988     struct wdp_port *port;
1989     unsigned int port_no;
1990
1991     assert(group == WX_GROUP_ALL || group == WX_GROUP_FLOOD);
1992
1993     ports = xmalloc(port_array_count(&wx->ports) * sizeof *ports);
1994     n_ports = 0;
1995     PORT_ARRAY_FOR_EACH (port, &wx->ports, port_no) {
1996         if (group == WX_GROUP_ALL || !(port->opp.config & OFPPC_NO_FLOOD)) {
1997             ports[n_ports++] = port_no;
1998         }
1999     }
2000     xfif_port_group_set(wx->xfif, group, ports, n_ports);
2001     free(ports);
2002
2003     return n_ports;
2004 }
2005
2006 static void
2007 wx_port_refresh_groups(struct wx *wx)
2008 {
2009     wx_port_refresh_group(wx, WX_GROUP_FLOOD);
2010     wx_port_refresh_group(wx, WX_GROUP_ALL);
2011 }
2012
2013 static void
2014 wx_port_reinit(struct wx *wx)
2015 {
2016     struct svec devnames;
2017     struct wdp_port *wdp_port;
2018     unsigned int port_no;
2019     struct xflow_port *xflow_ports;
2020     size_t n_xflow_ports;
2021     size_t i;
2022
2023     svec_init(&devnames);
2024     PORT_ARRAY_FOR_EACH (wdp_port, &wx->ports, port_no) {
2025         svec_add (&devnames, (char *) wdp_port->opp.name);
2026     }
2027     xfif_port_list(wx->xfif, &xflow_ports, &n_xflow_ports);
2028     for (i = 0; i < n_xflow_ports; i++) {
2029         svec_add(&devnames, xflow_ports[i].devname);
2030     }
2031     free(xflow_ports);
2032
2033     svec_sort_unique(&devnames);
2034     for (i = 0; i < devnames.n; i++) {
2035         wx_port_update(wx, devnames.names[i]);
2036     }
2037     svec_destroy(&devnames);
2038
2039     wx_port_refresh_groups(wx);
2040 }
2041
2042 static struct wdp_port *
2043 make_wdp_port(const struct xflow_port *xflow_port)
2044 {
2045     struct netdev_options netdev_options;
2046     enum netdev_flags flags;
2047     struct wdp_port *wdp_port;
2048     struct netdev *netdev;
2049     bool carrier;
2050     int error;
2051
2052     memset(&netdev_options, 0, sizeof netdev_options);
2053     netdev_options.name = xflow_port->devname;
2054     netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
2055
2056     error = netdev_open(&netdev_options, &netdev);
2057     if (error) {
2058         VLOG_WARN_RL(&rl, "ignoring port %s (%"PRIu16") because netdev %s "
2059                      "cannot be opened (%s)",
2060                      xflow_port->devname, xflow_port->port,
2061                      xflow_port->devname, strerror(error));
2062         return NULL;
2063     }
2064
2065     wdp_port = xmalloc(sizeof *wdp_port);
2066     wdp_port->netdev = netdev;
2067     wdp_port->opp.port_no = xflow_port_to_ofp_port(xflow_port->port);
2068     netdev_get_etheraddr(netdev, wdp_port->opp.hw_addr);
2069     strncpy((char *) wdp_port->opp.name, xflow_port->devname,
2070             sizeof wdp_port->opp.name);
2071     wdp_port->opp.name[sizeof wdp_port->opp.name - 1] = '\0';
2072
2073     netdev_get_flags(netdev, &flags);
2074     wdp_port->opp.config = flags & NETDEV_UP ? 0 : OFPPC_PORT_DOWN;
2075
2076     netdev_get_carrier(netdev, &carrier);
2077     wdp_port->opp.state = carrier ? 0 : OFPPS_LINK_DOWN;
2078
2079     netdev_get_features(netdev,
2080                         &wdp_port->opp.curr, &wdp_port->opp.advertised,
2081                         &wdp_port->opp.supported, &wdp_port->opp.peer);
2082
2083     wdp_port->devname = xstrdup(xflow_port->devname);
2084     wdp_port->internal = (xflow_port->flags & XFLOW_PORT_INTERNAL) != 0;
2085     return wdp_port;
2086 }
2087
2088 static bool
2089 wx_port_conflicts(const struct wx *wx, const struct xflow_port *xflow_port)
2090 {
2091     if (port_array_get(&wx->ports, xflow_port->port)) {
2092         VLOG_WARN_RL(&rl, "ignoring duplicate port %"PRIu16" in datapath",
2093                      xflow_port->port);
2094         return true;
2095     } else if (shash_find(&wx->port_by_name, xflow_port->devname)) {
2096         VLOG_WARN_RL(&rl, "ignoring duplicate device %s in datapath",
2097                      xflow_port->devname);
2098         return true;
2099     } else {
2100         return false;
2101     }
2102 }
2103
2104 static int
2105 wdp_port_equal(const struct wdp_port *a_, const struct wdp_port *b_)
2106 {
2107     const struct ofp_phy_port *a = &a_->opp;
2108     const struct ofp_phy_port *b = &b_->opp;
2109
2110     BUILD_ASSERT_DECL(sizeof *a == 48); /* Detect ofp_phy_port changes. */
2111     return (a->port_no == b->port_no
2112             && !memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr)
2113             && !strcmp((char *) a->name, (char *) b->name)
2114             && a->state == b->state
2115             && a->config == b->config
2116             && a->curr == b->curr
2117             && a->advertised == b->advertised
2118             && a->supported == b->supported
2119             && a->peer == b->peer);
2120 }
2121
2122 static void
2123 wx_port_install(struct wx *wx, struct wdp_port *wdp_port)
2124 {
2125     uint16_t xflow_port = ofp_port_to_xflow_port(wdp_port->opp.port_no);
2126     const char *netdev_name = (const char *) wdp_port->opp.name;
2127
2128     netdev_monitor_add(wx->netdev_monitor, wdp_port->netdev);
2129     port_array_set(&wx->ports, xflow_port, wdp_port);
2130     shash_add(&wx->port_by_name, netdev_name, wdp_port);
2131 }
2132
2133 static void
2134 wx_port_remove(struct wx *wx, struct wdp_port *wdp_port)
2135 {
2136     uint16_t xflow_port = ofp_port_to_xflow_port(wdp_port->opp.port_no);
2137
2138     netdev_monitor_remove(wx->netdev_monitor, wdp_port->netdev);
2139     port_array_delete(&wx->ports, xflow_port);
2140     shash_delete(&wx->port_by_name,
2141                  shash_find(&wx->port_by_name, (char *) wdp_port->opp.name));
2142 }
2143
2144 static void
2145 wx_port_free(struct wdp_port *wdp_port)
2146 {
2147     if (wdp_port) {
2148         netdev_close(wdp_port->netdev);
2149         free(wdp_port);
2150     }
2151 }
2152
2153 static void
2154 wx_port_update(struct wx *wx, const char *devname)
2155 {
2156     struct xflow_port xflow_port;
2157     struct wdp_port *old_wdp_port;
2158     struct wdp_port *new_wdp_port;
2159     int error;
2160
2161     COVERAGE_INC(wx_update_port);
2162
2163     /* Query the datapath for port information. */
2164     error = xfif_port_query_by_name(wx->xfif, devname, &xflow_port);
2165
2166     /* Find the old wdp_port. */
2167     old_wdp_port = shash_find_data(&wx->port_by_name, devname);
2168     if (!error) {
2169         if (!old_wdp_port) {
2170             /* There's no port named 'devname' but there might be a port with
2171              * the same port number.  This could happen if a port is deleted
2172              * and then a new one added in its place very quickly, or if a port
2173              * is renamed.  In the former case we want to send an OFPPR_DELETE
2174              * and an OFPPR_ADD, and in the latter case we want to send a
2175              * single OFPPR_MODIFY.  We can distinguish the cases by comparing
2176              * the old port's ifindex against the new port, or perhaps less
2177              * reliably but more portably by comparing the old port's MAC
2178              * against the new port's MAC.  However, this code isn't that smart
2179              * and always sends an OFPPR_MODIFY (XXX). */
2180             old_wdp_port = port_array_get(&wx->ports, xflow_port.port);
2181         }
2182     } else if (error != ENOENT && error != ENODEV) {
2183         VLOG_WARN_RL(&rl, "xfif_port_query_by_name returned unexpected error "
2184                      "%s", strerror(error));
2185         return;
2186     }
2187
2188     /* Create a new wdp_port. */
2189     new_wdp_port = !error ? make_wdp_port(&xflow_port) : NULL;
2190
2191     /* Eliminate a few pathological cases. */
2192     if (!old_wdp_port && !new_wdp_port) {
2193         return;
2194     } else if (old_wdp_port && new_wdp_port) {
2195         /* Most of the 'config' bits are OpenFlow soft state, but
2196          * OFPPC_PORT_DOWN is maintained by the kernel.  So transfer the
2197          * OpenFlow bits from old_wdp_port.  (make_wdp_port() only sets
2198          * OFPPC_PORT_DOWN and leaves the other bits 0.)  */
2199         new_wdp_port->opp.config |= old_wdp_port->opp.config & ~OFPPC_PORT_DOWN;
2200
2201         if (wdp_port_equal(old_wdp_port, new_wdp_port)) {
2202             /* False alarm--no change. */
2203             wx_port_free(new_wdp_port);
2204             return;
2205         }
2206     }
2207
2208     /* Now deal with the normal cases. */
2209     if (old_wdp_port) {
2210         wx_port_remove(wx, old_wdp_port);
2211     }
2212     if (new_wdp_port) {
2213         wx_port_install(wx, new_wdp_port);
2214     }
2215     wx_port_free(old_wdp_port);
2216
2217     /* Update port groups. */
2218     wx_port_refresh_groups(wx);
2219 }
2220
2221 static int
2222 wx_port_init(struct wx *wx)
2223 {
2224     struct xflow_port *ports;
2225     size_t n_ports;
2226     size_t i;
2227     int error;
2228
2229     error = xfif_port_list(wx->xfif, &ports, &n_ports);
2230     if (error) {
2231         return error;
2232     }
2233
2234     for (i = 0; i < n_ports; i++) {
2235         const struct xflow_port *xflow_port = &ports[i];
2236         if (!wx_port_conflicts(wx, xflow_port)) {
2237             struct wdp_port *wdp_port = make_wdp_port(xflow_port);
2238             if (wdp_port) {
2239                 wx_port_install(wx, wdp_port);
2240             }
2241         }
2242     }
2243     free(ports);
2244     wx_port_refresh_groups(wx);
2245     return 0;
2246 }
2247 \f
2248 void
2249 wdp_xflow_register(void)
2250 {
2251     static const struct wdp_class wdp_xflow_class = {
2252         NULL,                   /* name */
2253         wx_run,
2254         wx_wait,
2255         wx_enumerate,
2256         wx_open,
2257         wx_close,
2258         wx_get_all_names,
2259         wx_destroy,
2260         wx_get_features,
2261         wx_get_stats,
2262         wx_get_drop_frags,
2263         wx_set_drop_frags,
2264         wx_port_add,
2265         wx_port_del,
2266         wx_port_query_by_number,
2267         wx_port_query_by_name,
2268         wx_port_list,
2269         wx_port_set_config,
2270         wx_port_poll,
2271         wx_port_poll_wait,
2272         wx_flow_get,
2273         wx_flow_match,
2274         wx_flow_for_each_match,
2275         wx_flow_get_stats,
2276         wx_flow_overlaps,
2277         wx_flow_put,
2278         wx_flow_delete,
2279         wx_flow_flush,
2280         wx_flow_inject,
2281         wx_execute,
2282         wx_recv_get_mask,
2283         wx_recv_set_mask,
2284         wx_get_sflow_probability,
2285         wx_set_sflow_probability,
2286         wx_recv,
2287         wx_recv_wait,
2288     };
2289
2290     static bool inited = false;
2291
2292     struct svec types;
2293     const char *type;
2294     bool registered;
2295     int i;
2296
2297     if (inited) {
2298         return;
2299     }
2300     inited = true;
2301
2302     svec_init(&types);
2303     xf_enumerate_types(&types);
2304
2305     registered = false;
2306     SVEC_FOR_EACH (i, type, &types) {
2307         struct wdp_class *class;
2308
2309         class = xmalloc(sizeof *class);
2310         *class = wdp_xflow_class;
2311         class->type = xstrdup(type);
2312         if (registered) {
2313             class->run = NULL;
2314             class->wait = NULL;
2315         }
2316         if (!wdp_register_provider(class)) {
2317             registered = true;
2318         }
2319     }
2320
2321     svec_destroy(&types);
2322 }