Introduce ofpacts, an abstraction of OpenFlow actions.
[sliver-openvswitch.git] / lib / learning-switch.c
index ecc5509..cb0e49b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,8 @@
 #include "hmap.h"
 #include "mac-learning.h"
 #include "ofpbuf.h"
+#include "ofp-actions.h"
+#include "ofp-errors.h"
 #include "ofp-parse.h"
 #include "ofp-print.h"
 #include "ofp-util.h"
@@ -36,6 +38,7 @@
 #include "poll-loop.h"
 #include "rconn.h"
 #include "shash.h"
+#include "simap.h"
 #include "timeval.h"
 #include "vconn.h"
 #include "vlog.h"
@@ -54,6 +57,7 @@ struct lswitch {
      * Otherwise, the switch processes every packet. */
     int max_idle;
 
+    enum ofputil_protocol protocol;
     unsigned long long int datapath_id;
     time_t last_features_request;
     struct mac_learning *ml;    /* NULL to act as hub instead of switch. */
@@ -76,10 +80,10 @@ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
 static void queue_tx(struct lswitch *, struct rconn *, struct ofpbuf *);
 static void send_features_request(struct lswitch *, struct rconn *);
 
-static void process_switch_features(struct lswitch *,
-                                    struct ofp_switch_features *);
+static enum ofperr process_switch_features(struct lswitch *,
+                                           struct ofp_switch_features *);
 static void process_packet_in(struct lswitch *, struct rconn *,
-                              const struct ofp_packet_in *);
+                              const struct ofp_header *);
 static void process_echo_request(struct lswitch *, struct rconn *,
                                  const struct ofp_header *);
 
@@ -90,13 +94,16 @@ static void process_echo_request(struct lswitch *, struct rconn *,
 struct lswitch *
 lswitch_create(struct rconn *rconn, const struct lswitch_config *cfg)
 {
+    enum ofputil_protocol protocol;
     struct lswitch *sw;
 
     sw = xzalloc(sizeof *sw);
     sw->max_idle = cfg->max_idle;
     sw->datapath_id = 0;
     sw->last_features_request = time_now() - 1;
-    sw->ml = cfg->mode == LSW_LEARN ? mac_learning_create() : NULL;
+    sw->ml = (cfg->mode == LSW_LEARN
+              ? mac_learning_create(MAC_ENTRY_DEFAULT_IDLE_TIME)
+              : NULL);
     sw->action_normal = cfg->mode == LSW_NORMAL;
 
     flow_wildcards_init_exact(&sw->wc);
@@ -107,27 +114,27 @@ lswitch_create(struct rconn *rconn, const struct lswitch_config *cfg)
             /* Try to wildcard as many fields as possible, but we cannot
              * wildcard all fields.  We need in_port to detect moves.  We need
              * Ethernet source and dest and VLAN VID to do L2 learning. */
-            ofpfw = (OFPFW_DL_TYPE | OFPFW_DL_VLAN_PCP
-                     | OFPFW_NW_SRC_ALL | OFPFW_NW_DST_ALL
-                     | OFPFW_NW_TOS | OFPFW_NW_PROTO
-                     | OFPFW_TP_SRC | OFPFW_TP_DST);
+            ofpfw = (OFPFW10_DL_TYPE | OFPFW10_DL_VLAN_PCP
+                     | OFPFW10_NW_SRC_ALL | OFPFW10_NW_DST_ALL
+                     | OFPFW10_NW_TOS | OFPFW10_NW_PROTO
+                     | OFPFW10_TP_SRC | OFPFW10_TP_DST);
         } else {
             ofpfw = cfg->wildcards;
         }
 
-        ofputil_wildcard_from_openflow(ofpfw, &sw->wc);
+        ofputil_wildcard_from_ofpfw10(ofpfw, &sw->wc);
     }
 
     sw->default_queue = cfg->default_queue;
     hmap_init(&sw->queue_numbers);
     shash_init(&sw->queue_names);
     if (cfg->port_queues) {
-        struct shash_node *node;
+        struct simap_node *node;
 
-        SHASH_FOR_EACH (node, cfg->port_queues) {
+        SIMAP_FOR_EACH (node, cfg->port_queues) {
             struct lswitch_port *port = xmalloc(sizeof *port);
             hmap_node_nullify(&port->hmap_node);
-            port->queue_id = (uintptr_t) node->data;
+            port->queue_id = node->data;
             shash_add(&sw->queue_names, node->name, port);
         }
     }
@@ -135,20 +142,44 @@ lswitch_create(struct rconn *rconn, const struct lswitch_config *cfg)
     sw->queued = rconn_packet_counter_create();
     send_features_request(sw, rconn);
 
+    protocol = ofputil_protocol_from_ofp_version(rconn_get_version(rconn));
     if (cfg->default_flows) {
-        const struct ofpbuf *b;
-
-        LIST_FOR_EACH (b, list_node, cfg->default_flows) {
-            struct ofpbuf *copy = ofpbuf_clone(b);
-            int error = rconn_send(rconn, copy, NULL);
-            if (error) {
-                VLOG_INFO_RL(&rl, "%s: failed to queue default flows (%s)",
-                             rconn_get_name(rconn), strerror(error));
-                ofpbuf_delete(copy);
-                break;
+        enum ofputil_protocol usable_protocols;
+        struct ofpbuf *msg = NULL;
+        int error = 0;
+        size_t i;
+
+        /* If the initial protocol isn't good enough for default_flows, then
+         * pick one that will work and encode messages to set up that
+         * protocol.
+         *
+         * This could be improved by actually negotiating a mutually acceptable
+         * flow format with the switch, but that would require an asynchronous
+         * state machine.  This version ought to work fine in practice. */
+        usable_protocols = ofputil_flow_mod_usable_protocols(
+            cfg->default_flows, cfg->n_default_flows);
+        if (!(protocol & usable_protocols)) {
+            enum ofputil_protocol want = rightmost_1bit(usable_protocols);
+            while (!error) {
+                msg = ofputil_encode_set_protocol(protocol, want, &protocol);
+                if (!msg) {
+                    break;
+                }
+                error = rconn_send(rconn, msg, NULL);
             }
         }
+
+        for (i = 0; !error && i < cfg->n_default_flows; i++) {
+            msg = ofputil_encode_flow_mod(&cfg->default_flows[i], protocol);
+            error = rconn_send(rconn, msg, NULL);
+        }
+
+        if (error) {
+            VLOG_INFO_RL(&rl, "%s: failed to queue default flows (%s)",
+                         rconn_get_name(rconn), strerror(error));
+        }
     }
+    sw->protocol = protocol;
 
     return sw;
 }
@@ -218,6 +249,7 @@ lswitch_process_packet(struct lswitch *sw, struct rconn *rconn,
         break;
 
     case OFPUTIL_OFPT_PACKET_IN:
+    case OFPUTIL_NXT_PACKET_IN:
         process_packet_in(sw, rconn, msg->data);
         break;
 
@@ -247,18 +279,24 @@ lswitch_process_packet(struct lswitch *sw, struct rconn *rconn,
     case OFPUTIL_OFPST_TABLE_REQUEST:
     case OFPUTIL_OFPST_PORT_REQUEST:
     case OFPUTIL_OFPST_QUEUE_REQUEST:
+    case OFPUTIL_OFPST_PORT_DESC_REQUEST:
     case OFPUTIL_OFPST_DESC_REPLY:
     case OFPUTIL_OFPST_FLOW_REPLY:
     case OFPUTIL_OFPST_QUEUE_REPLY:
     case OFPUTIL_OFPST_PORT_REPLY:
     case OFPUTIL_OFPST_TABLE_REPLY:
     case OFPUTIL_OFPST_AGGREGATE_REPLY:
+    case OFPUTIL_OFPST_PORT_DESC_REPLY:
     case OFPUTIL_NXT_ROLE_REQUEST:
     case OFPUTIL_NXT_ROLE_REPLY:
     case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
     case OFPUTIL_NXT_SET_FLOW_FORMAT:
+    case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
     case OFPUTIL_NXT_FLOW_MOD:
     case OFPUTIL_NXT_FLOW_REMOVED:
+    case OFPUTIL_NXT_FLOW_AGE:
+    case OFPUTIL_NXT_SET_ASYNC_CONFIG:
+    case OFPUTIL_NXT_SET_CONTROLLER_ID:
     case OFPUTIL_NXST_FLOW_REQUEST:
     case OFPUTIL_NXST_AGGREGATE_REQUEST:
     case OFPUTIL_NXST_FLOW_REPLY:
@@ -310,27 +348,32 @@ queue_tx(struct lswitch *sw, struct rconn *rconn, struct ofpbuf *b)
     }
 }
 
-static void
+static enum ofperr
 process_switch_features(struct lswitch *sw, struct ofp_switch_features *osf)
 {
-    size_t n_ports;
-    size_t i;
-
-    sw->datapath_id = ntohll(osf->datapath_id);
+    struct ofputil_switch_features features;
+    struct ofputil_phy_port port;
+    enum ofperr error;
+    struct ofpbuf b;
+
+    error = ofputil_decode_switch_features(osf, &features, &b);
+    if (error) {
+        VLOG_ERR("received invalid switch feature reply (%s)",
+                 ofperr_to_string(error));
+        return error;
+    }
 
-    n_ports = (ntohs(osf->header.length) - sizeof *osf) / sizeof *osf->ports;
-    for (i = 0; i < n_ports; i++) {
-        struct ofp_phy_port *opp = &osf->ports[i];
-        struct lswitch_port *lp;
+    sw->datapath_id = features.datapath_id;
 
-        opp->name[OFP_MAX_PORT_NAME_LEN - 1] = '\0';
-        lp = shash_find_data(&sw->queue_names, opp->name);
+    while (!ofputil_pull_phy_port(osf->header.version, &b, &port)) {
+        struct lswitch_port *lp = shash_find_data(&sw->queue_names, port.name);
         if (lp && hmap_node_is_null(&lp->hmap_node)) {
-            lp->port_no = ntohs(opp->port_no);
+            lp->port_no = port.port_no;
             hmap_insert(&sw->queue_numbers, &lp->hmap_node,
                         hash_int(lp->port_no, 0));
         }
     }
+    return 0;
 }
 
 static uint16_t
@@ -395,89 +438,98 @@ get_queue_id(const struct lswitch *sw, uint16_t in_port)
 
 static void
 process_packet_in(struct lswitch *sw, struct rconn *rconn,
-                  const struct ofp_packet_in *opi)
+                  const struct ofp_header *oh)
 {
-    uint16_t in_port = ntohs(opi->in_port);
+    struct ofputil_packet_in pi;
     uint32_t queue_id;
     uint16_t out_port;
 
-    struct ofp_action_header actions[2];
-    size_t actions_len;
+    uint64_t ofpacts_stub[64 / 8];
+    struct ofpbuf ofpacts;
+
+    struct ofputil_packet_out po;
+    enum ofperr error;
 
-    size_t pkt_ofs, pkt_len;
     struct ofpbuf pkt;
     struct flow flow;
 
+    error = ofputil_decode_packet_in(&pi, oh);
+    if (error) {
+        VLOG_WARN_RL(&rl, "failed to decode packet-in: %s",
+                     ofperr_to_string(error));
+        return;
+    }
+
     /* Ignore packets sent via output to OFPP_CONTROLLER.  This library never
      * uses such an action.  You never know what experiments might be going on,
      * though, and it seems best not to interfere with them. */
-    if (opi->reason != OFPR_NO_MATCH) {
+    if (pi.reason != OFPR_NO_MATCH) {
         return;
     }
 
     /* Extract flow data from 'opi' into 'flow'. */
-    pkt_ofs = offsetof(struct ofp_packet_in, data);
-    pkt_len = ntohs(opi->header.length) - pkt_ofs;
-    ofpbuf_use_const(&pkt, opi->data, pkt_len);
-    flow_extract(&pkt, 0, 0, in_port, &flow);
+    ofpbuf_use_const(&pkt, pi.packet, pi.packet_len);
+    flow_extract(&pkt, 0, pi.fmd.tun_id, pi.fmd.in_port, &flow);
 
     /* Choose output port. */
     out_port = lswitch_choose_destination(sw, &flow);
 
     /* Make actions. */
-    queue_id = get_queue_id(sw, in_port);
+    queue_id = get_queue_id(sw, pi.fmd.in_port);
+    ofpbuf_use_stack(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
     if (out_port == OFPP_NONE) {
-        actions_len = 0;
+        /* No actions. */
     } else if (queue_id == UINT32_MAX || out_port >= OFPP_MAX) {
-        struct ofp_action_output oao;
-
-        memset(&oao, 0, sizeof oao);
-        oao.type = htons(OFPAT_OUTPUT);
-        oao.len = htons(sizeof oao);
-        oao.port = htons(out_port);
-
-        memcpy(actions, &oao, sizeof oao);
-        actions_len = sizeof oao;
+        ofpact_put_OUTPUT(&ofpacts)->port = out_port;
     } else {
-        struct ofp_action_enqueue oae;
-
-        memset(&oae, 0, sizeof oae);
-        oae.type = htons(OFPAT_ENQUEUE);
-        oae.len = htons(sizeof oae);
-        oae.port = htons(out_port);
-        oae.queue_id = htonl(queue_id);
+        struct ofpact_enqueue *enqueue = ofpact_put_ENQUEUE(&ofpacts);
+        enqueue->port = out_port;
+        enqueue->queue = queue_id;
+    }
+    ofpact_pad(&ofpacts);
 
-        memcpy(actions, &oae, sizeof oae);
-        actions_len = sizeof oae;
+    /* Prepare packet_out in case we need one. */
+    po.buffer_id = pi.buffer_id;
+    if (po.buffer_id == UINT32_MAX) {
+        po.packet = pkt.data;
+        po.packet_len = pkt.size;
+    } else {
+        po.packet = NULL;
+        po.packet_len = 0;
     }
-    assert(actions_len <= sizeof actions);
+    po.in_port = pi.fmd.in_port;
+    po.ofpacts = ofpacts.data;
+    po.ofpacts_len = ofpacts.size;
 
     /* Send the packet, and possibly the whole flow, to the output port. */
     if (sw->max_idle >= 0 && (!sw->ml || out_port != OFPP_FLOOD)) {
+        struct ofputil_flow_mod fm;
         struct ofpbuf *buffer;
-        struct cls_rule rule;
 
         /* The output port is known, or we always flood everything, so add a
          * new flow. */
-        cls_rule_init(&flow, &sw->wc, 0, &rule);
-        buffer = make_add_flow(&rule, ntohl(opi->buffer_id),
-                               sw->max_idle, actions_len);
-        ofpbuf_put(buffer, actions, actions_len);
+        memset(&fm, 0, sizeof fm);
+        cls_rule_init(&flow, &sw->wc, 0, &fm.cr);
+        fm.table_id = 0xff;
+        fm.command = OFPFC_ADD;
+        fm.idle_timeout = sw->max_idle;
+        fm.buffer_id = pi.buffer_id;
+        fm.out_port = OFPP_NONE;
+        fm.ofpacts = ofpacts.data;
+        fm.ofpacts_len = ofpacts.size;
+        buffer = ofputil_encode_flow_mod(&fm, sw->protocol);
+
         queue_tx(sw, rconn, buffer);
 
         /* If the switch didn't buffer the packet, we need to send a copy. */
-        if (ntohl(opi->buffer_id) == UINT32_MAX && actions_len > 0) {
-            queue_tx(sw, rconn,
-                     make_packet_out(&pkt, UINT32_MAX, in_port,
-                                     actions, actions_len / sizeof *actions));
+        if (pi.buffer_id == UINT32_MAX && out_port != OFPP_NONE) {
+            queue_tx(sw, rconn, ofputil_encode_packet_out(&po));
         }
     } else {
         /* We don't know that MAC, or we don't set up flows.  Send along the
          * packet without setting up a flow. */
-        if (ntohl(opi->buffer_id) != UINT32_MAX || actions_len > 0) {
-            queue_tx(sw, rconn,
-                     make_packet_out(&pkt, ntohl(opi->buffer_id), in_port,
-                                     actions, actions_len / sizeof *actions));
+        if (pi.buffer_id != UINT32_MAX || out_port != OFPP_NONE) {
+            queue_tx(sw, rconn, ofputil_encode_packet_out(&po));
         }
     }
 }