lib/learning-switch.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "learning-switch.h"
  36
  37 #include <errno.h>
  38 #include <inttypes.h>
  39 #include <netinet/in.h>
  40 #include <stdlib.h>
  41 #include <time.h>
  42
  43 #include "buffer.h"
  44 #include "flow.h"
  45 #include "mac-learning.h"
  46 #include "ofp-print.h"
  47 #include "openflow.h"
  48 #include "queue.h"
  49 #include "rconn.h"
  50 #include "timeval.h"
  51 #include "vconn.h"
  52 #include "xtoxll.h"
  53
  54 #define THIS_MODULE VLM_learning_switch
  55 #include "vlog.h"
  56
  57 struct lswitch {
  58     /* If nonnegative, the switch sets up flows that expire after the given
  59      * number of seconds (or never expire, if the value is OFP_FLOW_PERMANENT).
  60      * Otherwise, the switch processes every packet. */
  61     int max_idle;
  62
  63     uint64_t datapath_id;
  64     time_t last_features_request;
  65     struct mac_learning *ml;    /* NULL to act as hub instead of switch. */
  66
  67     /* Number of outgoing queued packets on the rconn. */
  68     int n_queued;
  69 };
  70
  71 static void queue_tx(struct lswitch *, struct rconn *, struct buffer *);
  72 static void send_features_request(struct lswitch *, struct rconn *);
  73 static void process_packet_in(struct lswitch *, struct rconn *,
  74                               struct ofp_packet_in *);
  75 static void process_echo_request(struct lswitch *, struct rconn *,
  76                                  struct ofp_header *);
  77
  78 /* Creates and returns a new learning switch.
  79  *
  80  * If 'learn_macs' is true, the new switch will learn the ports on which MAC
  81  * addresses appear.  Otherwise, the new switch will flood all packets.
  82  *
  83  * If 'max_idle' is nonnegative, the new switch will set up flows that expire
  84  * after the given number of seconds (or never expire, if 'max_idle' is
  85  * OFP_FLOW_PERMANENT).  Otherwise, the new switch will process every packet.
  86  *
  87  * 'rconn' is used to send out an OpenFlow features request. */
  88 struct lswitch *
  89 lswitch_create(struct rconn *rconn, bool learn_macs, int max_idle)
  90 {
  91     struct lswitch *sw = xcalloc(1, sizeof *sw);
  92     sw->max_idle = max_idle;
  93     sw->datapath_id = 0;
  94     sw->last_features_request = time_now() - 1;
  95     sw->ml = learn_macs ? mac_learning_create() : NULL;
  96     send_features_request(sw, rconn);
  97     return sw;
  98 }
  99
 100 /* Destroys 'sw'. */
 101 void
 102 lswitch_destroy(struct lswitch *sw)
 103 {
 104     if (sw) {
 105         mac_learning_destroy(sw->ml);
 106         free(sw);
 107     }
 108 }
 109
 110 /* Processes 'msg', which should be an OpenFlow received on 'rconn', according
 111  * to the learning switch state in 'sw'.  The most likely result of processing
 112  * is that flow-setup and packet-out OpenFlow messages will be sent out on
 113  * 'rconn'.  */
 114 void
 115 lswitch_process_packet(struct lswitch *sw, struct rconn *rconn,
 116                        const struct buffer *msg)
 117 {
 118     static const size_t min_size[UINT8_MAX + 1] = {
 119         [0 ... UINT8_MAX] = sizeof (struct ofp_header),
 120         [OFPT_FEATURES_REPLY] = sizeof (struct ofp_switch_features),
 121         [OFPT_PACKET_IN] = offsetof (struct ofp_packet_in, data),
 122     };
 123     struct ofp_header *oh;
 124
 125     oh = msg->data;
 126     if (msg->size < min_size[oh->type]) {
 127         VLOG_WARN("%s: too short (%zu bytes) for type %"PRIu8" (min %zu)",
 128                   rconn_get_name(rconn),
 129                   msg->size, oh->type, min_size[oh->type]);
 130         return;
 131     }
 132
 133     if (oh->type == OFPT_ECHO_REQUEST) {
 134         process_echo_request(sw, rconn, msg->data);
 135     } else if (oh->type == OFPT_FEATURES_REPLY) {
 136         struct ofp_switch_features *osf = msg->data;
 137         sw->datapath_id = osf->datapath_id;
 138     } else if (sw->datapath_id == 0) {
 139         send_features_request(sw, rconn);
 140     } else if (oh->type == OFPT_PACKET_IN) {
 141         process_packet_in(sw, rconn, msg->data);
 142     } else {
 143         if (VLOG_IS_DBG_ENABLED()) {
 144             char *p = ofp_to_string(msg->data, msg->size, 2);
 145             VLOG_DBG("OpenFlow packet ignored: %s", p);
 146             free(p);
 147         }
 148     }
 149 }
 150 \f
 151 static void
 152 send_features_request(struct lswitch *sw, struct rconn *rconn)
 153 {
 154     time_t now = time_now();
 155     if (now >= sw->last_features_request + 1) {
 156         struct buffer *b;
 157         struct ofp_header *ofr;
 158         struct ofp_switch_config *osc;
 159
 160         /* Send OFPT_FEATURES_REQUEST. */
 161         b = buffer_new(0);
 162         ofr = buffer_put_uninit(b, sizeof *ofr);
 163         memset(ofr, 0, sizeof *ofr);
 164         ofr->type = OFPT_FEATURES_REQUEST;
 165         ofr->version = OFP_VERSION;
 166         ofr->length = htons(sizeof *ofr);
 167         queue_tx(sw, rconn, b);
 168
 169         /* Send OFPT_SET_CONFIG. */
 170         b = buffer_new(0);
 171         osc = buffer_put_uninit(b, sizeof *osc);
 172         memset(osc, 0, sizeof *osc);
 173         osc->header.type = OFPT_SET_CONFIG;
 174         osc->header.version = OFP_VERSION;
 175         osc->header.length = htons(sizeof *osc);
 176         osc->flags = htons(OFPC_SEND_FLOW_EXP);
 177         osc->miss_send_len = htons(OFP_DEFAULT_MISS_SEND_LEN);
 178         queue_tx(sw, rconn, b);
 179
 180         sw->last_features_request = now;
 181     }
 182 }
 183
 184 static void
 185 queue_tx(struct lswitch *sw, struct rconn *rconn, struct buffer *b)
 186 {
 187     int retval = rconn_send_with_limit(rconn, b, &sw->n_queued, 10);
 188     if (retval) {
 189         if (retval == EAGAIN) {
 190             /* FIXME: ratelimit. */
 191             VLOG_WARN("%s: tx queue overflow", rconn_get_name(rconn));
 192         } else if (retval == ENOTCONN) {
 193             /* Ignore. */
 194         } else {
 195             /* FIXME: ratelimit. */
 196             VLOG_WARN("%s: send: %s", rconn_get_name(rconn), strerror(retval));
 197         }
 198     }
 199 }
 200
 201 static void
 202 process_packet_in(struct lswitch *sw, struct rconn *rconn,
 203                   struct ofp_packet_in *opi)
 204 {
 205     uint16_t in_port = ntohs(opi->in_port);
 206     uint16_t out_port = OFPP_FLOOD;
 207
 208     size_t pkt_ofs, pkt_len;
 209     struct buffer pkt;
 210     struct flow flow;
 211
 212     /* Extract flow data from 'opi' into 'flow'. */
 213     pkt_ofs = offsetof(struct ofp_packet_in, data);
 214     pkt_len = ntohs(opi->header.length) - pkt_ofs;
 215     pkt.data = opi->data;
 216     pkt.size = pkt_len;
 217     flow_extract(&pkt, in_port, &flow);
 218
 219     if (sw->ml) {
 220         if (mac_learning_learn(sw->ml, flow.dl_src, in_port)) {
 221             VLOG_DBG("learned that "ETH_ADDR_FMT" is on datapath %"
 222                      PRIx64" port %"PRIu16, ETH_ADDR_ARGS(flow.dl_src),
 223                      ntohll(sw->datapath_id), in_port);
 224         }
 225         out_port = mac_learning_lookup(sw->ml, flow.dl_dst);
 226     }
 227
 228     if (in_port == out_port) {
 229         /* The input and output port match.  Set up a flow to drop packets. */
 230         queue_tx(sw, rconn, make_add_flow(&flow, ntohl(opi->buffer_id),
 231                                           sw->max_idle, 0));
 232     } else if (sw->max_idle >= 0 && (!sw->ml || out_port != OFPP_FLOOD)) {
 233         /* The output port is known, or we always flood everything, so add a
 234          * new flow. */
 235         queue_tx(sw, rconn, make_add_simple_flow(&flow, ntohl(opi->buffer_id),
 236                                                  out_port, sw->max_idle));
 237
 238         /* If the switch didn't buffer the packet, we need to send a copy. */
 239         if (ntohl(opi->buffer_id) == UINT32_MAX) {
 240             queue_tx(sw, rconn,
 241                      make_unbuffered_packet_out(&pkt, in_port, out_port));
 242         }
 243     } else {
 244         /* We don't know that MAC, or we don't set up flows.  Send along the
 245          * packet without setting up a flow. */
 246         struct buffer *b;
 247         if (ntohl(opi->buffer_id) == UINT32_MAX) {
 248             b = make_unbuffered_packet_out(&pkt, in_port, out_port);
 249         } else {
 250             b = make_buffered_packet_out(ntohl(opi->buffer_id),
 251                                          in_port, out_port);
 252         }
 253         queue_tx(sw, rconn, b);
 254     }
 255 }
 256
 257 static void
 258 process_echo_request(struct lswitch *sw, struct rconn *rconn,
 259                      struct ofp_header *rq)
 260 {
 261     queue_tx(sw, rconn, make_echo_reply(rq));
 262 }