lib/learn.c

   1 /*
   2  * Copyright (c) 2011, 2012, 2013, 2014 Nicira, Inc.
   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 "learn.h"
  20
  21 #include "byte-order.h"
  22 #include "dynamic-string.h"
  23 #include "match.h"
  24 #include "meta-flow.h"
  25 #include "nx-match.h"
  26 #include "ofp-actions.h"
  27 #include "ofp-errors.h"
  28 #include "ofp-util.h"
  29 #include "ofpbuf.h"
  30 #include "openflow/openflow.h"
  31 #include "unaligned.h"
  32
  33
  34 /* Checks that 'learn' is a valid action on 'flow'.  Returns 0 if it is valid,
  35  * otherwise an OFPERR_*. */
  36 enum ofperr
  37 learn_check(const struct ofpact_learn *learn, const struct flow *flow)
  38 {
  39     const struct ofpact_learn_spec *spec;
  40     struct match match;
  41
  42     match_init_catchall(&match);
  43     for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
  44         enum ofperr error;
  45
  46         /* Check the source. */
  47         if (spec->src_type == NX_LEARN_SRC_FIELD) {
  48             error = mf_check_src(&spec->src, flow);
  49             if (error) {
  50                 return error;
  51             }
  52         }
  53
  54         /* Check the destination. */
  55         switch (spec->dst_type) {
  56         case NX_LEARN_DST_MATCH:
  57             error = mf_check_src(&spec->dst, &match.flow);
  58             if (error) {
  59                 return error;
  60             }
  61
  62             mf_write_subfield(&spec->dst, &spec->src_imm, &match);
  63             break;
  64
  65         case NX_LEARN_DST_LOAD:
  66             error = mf_check_dst(&spec->dst, &match.flow);
  67             if (error) {
  68                 return error;
  69             }
  70             break;
  71
  72         case NX_LEARN_DST_OUTPUT:
  73             /* Nothing to do. */
  74             break;
  75         }
  76     }
  77     return 0;
  78 }
  79
  80 /* Composes 'fm' so that executing it will implement 'learn' given that the
  81  * packet being processed has 'flow' as its flow.
  82  *
  83  * Uses 'ofpacts' to store the flow mod's actions.  The caller must initialize
  84  * 'ofpacts' and retains ownership of it.  'fm->ofpacts' will point into the
  85  * 'ofpacts' buffer.
  86  *
  87  * The caller has to actually execute 'fm'. */
  88 void
  89 learn_execute(const struct ofpact_learn *learn, const struct flow *flow,
  90               struct ofputil_flow_mod *fm, struct ofpbuf *ofpacts)
  91 {
  92     const struct ofpact_learn_spec *spec;
  93
  94     match_init_catchall(&fm->match);
  95     fm->priority = learn->priority;
  96     fm->cookie = htonll(0);
  97     fm->cookie_mask = htonll(0);
  98     fm->new_cookie = learn->cookie;
  99     fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
 100     fm->table_id = learn->table_id;
 101     fm->command = OFPFC_MODIFY_STRICT;
 102     fm->idle_timeout = learn->idle_timeout;
 103     fm->hard_timeout = learn->hard_timeout;
 104     fm->buffer_id = UINT32_MAX;
 105     fm->out_port = OFPP_NONE;
 106     fm->flags = 0;
 107     if (learn->flags & NX_LEARN_F_SEND_FLOW_REM) {
 108         fm->flags |= OFPUTIL_FF_SEND_FLOW_REM;
 109     }
 110     fm->ofpacts = NULL;
 111     fm->ofpacts_len = 0;
 112     fm->delete_reason = OFPRR_DELETE;
 113
 114     if (learn->fin_idle_timeout || learn->fin_hard_timeout) {
 115         struct ofpact_fin_timeout *oft;
 116
 117         oft = ofpact_put_FIN_TIMEOUT(ofpacts);
 118         oft->fin_idle_timeout = learn->fin_idle_timeout;
 119         oft->fin_hard_timeout = learn->fin_hard_timeout;
 120     }
 121
 122     for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
 123         struct ofpact_set_field *sf;
 124         union mf_subvalue value;
 125
 126         if (spec->src_type == NX_LEARN_SRC_FIELD) {
 127             mf_read_subfield(&spec->src, flow, &value);
 128         } else {
 129             value = spec->src_imm;
 130         }
 131
 132         switch (spec->dst_type) {
 133         case NX_LEARN_DST_MATCH:
 134             mf_write_subfield(&spec->dst, &value, &fm->match);
 135             break;
 136
 137         case NX_LEARN_DST_LOAD:
 138             sf = ofpact_put_reg_load(ofpacts);
 139             sf->field = spec->dst.field;
 140             bitwise_copy(&value, sizeof value, 0,
 141                          &sf->value, spec->dst.field->n_bytes, spec->dst.ofs,
 142                          spec->n_bits);
 143             bitwise_one(&sf->mask, spec->dst.field->n_bytes, spec->dst.ofs,
 144                         spec->n_bits);
 145             break;
 146
 147         case NX_LEARN_DST_OUTPUT:
 148             if (spec->n_bits <= 16
 149                 || is_all_zeros(value.u8, sizeof value - 2)) {
 150                 ofp_port_t port = u16_to_ofp(ntohs(value.be16[7]));
 151
 152                 if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)
 153                     || port == OFPP_IN_PORT
 154                     || port == OFPP_FLOOD
 155                     || port == OFPP_LOCAL
 156                     || port == OFPP_ALL) {
 157                     ofpact_put_OUTPUT(ofpacts)->port = port;
 158                 }
 159             }
 160             break;
 161         }
 162     }
 163     ofpact_pad(ofpacts);
 164
 165     fm->ofpacts = ofpbuf_data(ofpacts);
 166     fm->ofpacts_len = ofpbuf_size(ofpacts);
 167 }
 168
 169 /* Perform a bitwise-OR on 'wc''s fields that are relevant as sources in
 170  * the learn action 'learn'. */
 171 void
 172 learn_mask(const struct ofpact_learn *learn, struct flow_wildcards *wc)
 173 {
 174     const struct ofpact_learn_spec *spec;
 175     union mf_subvalue value;
 176
 177     memset(&value, 0xff, sizeof value);
 178     for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
 179         if (spec->src_type == NX_LEARN_SRC_FIELD) {
 180             mf_write_subfield_flow(&spec->src, &value, &wc->masks);
 181         }
 182     }
 183 }
 184
 185 /* Returns NULL if successful, otherwise a malloc()'d string describing the
 186  * error.  The caller is responsible for freeing the returned string. */
 187 static char * WARN_UNUSED_RESULT
 188 learn_parse_load_immediate(const char *s, struct ofpact_learn_spec *spec)
 189 {
 190     const char *full_s = s;
 191     const char *arrow = strstr(s, "->");
 192     struct mf_subfield dst;
 193     union mf_subvalue imm;
 194     char *error;
 195
 196     memset(&imm, 0, sizeof imm);
 197     if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X') && arrow) {
 198         const char *in = arrow - 1;
 199         uint8_t *out = imm.u8 + sizeof imm.u8 - 1;
 200         int n = arrow - (s + 2);
 201         int i;
 202
 203         for (i = 0; i < n; i++) {
 204             int hexit = hexit_value(in[-i]);
 205             if (hexit < 0) {
 206                 return xasprintf("%s: bad hex digit in value", full_s);
 207             }
 208             out[-(i / 2)] |= i % 2 ? hexit << 4 : hexit;
 209         }
 210         s = arrow;
 211     } else {
 212         imm.be64[1] = htonll(strtoull(s, (char **) &s, 0));
 213     }
 214
 215     if (strncmp(s, "->", 2)) {
 216         return xasprintf("%s: missing `->' following value", full_s);
 217     }
 218     s += 2;
 219
 220     error = mf_parse_subfield(&dst, s);
 221     if (error) {
 222         return error;
 223     }
 224
 225     if (!bitwise_is_all_zeros(&imm, sizeof imm, dst.n_bits,
 226                               (8 * sizeof imm) - dst.n_bits)) {
 227         return xasprintf("%s: value does not fit into %u bits",
 228                          full_s, dst.n_bits);
 229     }
 230
 231     spec->n_bits = dst.n_bits;
 232     spec->src_type = NX_LEARN_SRC_IMMEDIATE;
 233     spec->src_imm = imm;
 234     spec->dst_type = NX_LEARN_DST_LOAD;
 235     spec->dst = dst;
 236     return NULL;
 237 }
 238
 239 /* Returns NULL if successful, otherwise a malloc()'d string describing the
 240  * error.  The caller is responsible for freeing the returned string. */
 241 static char * WARN_UNUSED_RESULT
 242 learn_parse_spec(const char *orig, char *name, char *value,
 243                  struct ofpact_learn_spec *spec)
 244 {
 245     if (mf_from_name(name)) {
 246         const struct mf_field *dst = mf_from_name(name);
 247         union mf_value imm;
 248         char *error;
 249
 250         error = mf_parse_value(dst, value, &imm);
 251         if (error) {
 252             return error;
 253         }
 254
 255         spec->n_bits = dst->n_bits;
 256         spec->src_type = NX_LEARN_SRC_IMMEDIATE;
 257         memset(&spec->src_imm, 0, sizeof spec->src_imm);
 258         memcpy(&spec->src_imm.u8[sizeof spec->src_imm - dst->n_bytes],
 259                &imm, dst->n_bytes);
 260         spec->dst_type = NX_LEARN_DST_MATCH;
 261         spec->dst.field = dst;
 262         spec->dst.ofs = 0;
 263         spec->dst.n_bits = dst->n_bits;
 264     } else if (strchr(name, '[')) {
 265         /* Parse destination and check prerequisites. */
 266         char *error;
 267
 268         error = mf_parse_subfield(&spec->dst, name);
 269         if (error) {
 270             return error;
 271         }
 272
 273         /* Parse source and check prerequisites. */
 274         if (value[0] != '\0') {
 275             error = mf_parse_subfield(&spec->src, value);
 276             if (error) {
 277                 return error;
 278             }
 279             if (spec->src.n_bits != spec->dst.n_bits) {
 280                 return xasprintf("%s: bit widths of %s (%u) and %s (%u) "
 281                                  "differ", orig, name, spec->src.n_bits, value,
 282                                  spec->dst.n_bits);
 283             }
 284         } else {
 285             spec->src = spec->dst;
 286         }
 287
 288         spec->n_bits = spec->src.n_bits;
 289         spec->src_type = NX_LEARN_SRC_FIELD;
 290         spec->dst_type = NX_LEARN_DST_MATCH;
 291     } else if (!strcmp(name, "load")) {
 292         if (value[strcspn(value, "[-")] == '-') {
 293             char *error = learn_parse_load_immediate(value, spec);
 294             if (error) {
 295                 return error;
 296             }
 297         } else {
 298             struct ofpact_reg_move move;
 299             char *error;
 300
 301             error = nxm_parse_reg_move(&move, value);
 302             if (error) {
 303                 return error;
 304             }
 305
 306             spec->n_bits = move.src.n_bits;
 307             spec->src_type = NX_LEARN_SRC_FIELD;
 308             spec->src = move.src;
 309             spec->dst_type = NX_LEARN_DST_LOAD;
 310             spec->dst = move.dst;
 311         }
 312     } else if (!strcmp(name, "output")) {
 313         char *error = mf_parse_subfield(&spec->src, value);
 314         if (error) {
 315             return error;
 316         }
 317
 318         spec->n_bits = spec->src.n_bits;
 319         spec->src_type = NX_LEARN_SRC_FIELD;
 320         spec->dst_type = NX_LEARN_DST_OUTPUT;
 321     } else {
 322         return xasprintf("%s: unknown keyword %s", orig, name);
 323     }
 324
 325     return NULL;
 326 }
 327
 328 /* Returns NULL if successful, otherwise a malloc()'d string describing the
 329  * error.  The caller is responsible for freeing the returned string. */
 330 static char * WARN_UNUSED_RESULT
 331 learn_parse__(char *orig, char *arg, struct ofpbuf *ofpacts)
 332 {
 333     struct ofpact_learn *learn;
 334     struct match match;
 335     char *name, *value;
 336
 337     learn = ofpact_put_LEARN(ofpacts);
 338     learn->idle_timeout = OFP_FLOW_PERMANENT;
 339     learn->hard_timeout = OFP_FLOW_PERMANENT;
 340     learn->priority = OFP_DEFAULT_PRIORITY;
 341     learn->table_id = 1;
 342
 343     match_init_catchall(&match);
 344     while (ofputil_parse_key_value(&arg, &name, &value)) {
 345         if (!strcmp(name, "table")) {
 346             learn->table_id = atoi(value);
 347             if (learn->table_id == 255) {
 348                 return xasprintf("%s: table id 255 not valid for `learn' "
 349                                  "action", orig);
 350             }
 351         } else if (!strcmp(name, "priority")) {
 352             learn->priority = atoi(value);
 353         } else if (!strcmp(name, "idle_timeout")) {
 354             learn->idle_timeout = atoi(value);
 355         } else if (!strcmp(name, "hard_timeout")) {
 356             learn->hard_timeout = atoi(value);
 357         } else if (!strcmp(name, "fin_idle_timeout")) {
 358             learn->fin_idle_timeout = atoi(value);
 359         } else if (!strcmp(name, "fin_hard_timeout")) {
 360             learn->fin_hard_timeout = atoi(value);
 361         } else if (!strcmp(name, "cookie")) {
 362             learn->cookie = htonll(strtoull(value, NULL, 0));
 363         } else if (!strcmp(name, "send_flow_rem")) {
 364             learn->flags |= NX_LEARN_F_SEND_FLOW_REM;
 365         } else if (!strcmp(name, "delete_learned")) {
 366             learn->flags |= NX_LEARN_F_DELETE_LEARNED;
 367         } else {
 368             struct ofpact_learn_spec *spec;
 369             char *error;
 370
 371             spec = ofpbuf_put_zeros(ofpacts, sizeof *spec);
 372             learn = ofpacts->frame;
 373             learn->n_specs++;
 374
 375             error = learn_parse_spec(orig, name, value, spec);
 376             if (error) {
 377                 return error;
 378             }
 379
 380             /* Update 'match' to allow for satisfying destination
 381              * prerequisites. */
 382             if (spec->src_type == NX_LEARN_SRC_IMMEDIATE
 383                 && spec->dst_type == NX_LEARN_DST_MATCH) {
 384                 mf_write_subfield(&spec->dst, &spec->src_imm, &match);
 385             }
 386         }
 387     }
 388     ofpact_update_len(ofpacts, &learn->ofpact);
 389
 390     return NULL;
 391 }
 392
 393 /* Parses 'arg' as a set of arguments to the "learn" action and appends a
 394  * matching OFPACT_LEARN action to 'ofpacts'.  ovs-ofctl(8) describes the
 395  * format parsed.
 396  *
 397  * Returns NULL if successful, otherwise a malloc()'d string describing the
 398  * error.  The caller is responsible for freeing the returned string.
 399  *
 400  * If 'flow' is nonnull, then it should be the flow from a struct match that is
 401  * the matching rule for the learning action.  This helps to better validate
 402  * the action's arguments.
 403  *
 404  * Modifies 'arg'. */
 405 char * WARN_UNUSED_RESULT
 406 learn_parse(char *arg, struct ofpbuf *ofpacts)
 407 {
 408     char *orig = xstrdup(arg);
 409     char *error = learn_parse__(orig, arg, ofpacts);
 410     free(orig);
 411     return error;
 412 }
 413
 414 /* Appends a description of 'learn' to 's', in the format that ovs-ofctl(8)
 415  * describes. */
 416 void
 417 learn_format(const struct ofpact_learn *learn, struct ds *s)
 418 {
 419     const struct ofpact_learn_spec *spec;
 420     struct match match;
 421
 422     match_init_catchall(&match);
 423
 424     ds_put_format(s, "learn(table=%"PRIu8, learn->table_id);
 425     if (learn->idle_timeout != OFP_FLOW_PERMANENT) {
 426         ds_put_format(s, ",idle_timeout=%"PRIu16, learn->idle_timeout);
 427     }
 428     if (learn->hard_timeout != OFP_FLOW_PERMANENT) {
 429         ds_put_format(s, ",hard_timeout=%"PRIu16, learn->hard_timeout);
 430     }
 431     if (learn->fin_idle_timeout) {
 432         ds_put_format(s, ",fin_idle_timeout=%"PRIu16, learn->fin_idle_timeout);
 433     }
 434     if (learn->fin_hard_timeout) {
 435         ds_put_format(s, ",fin_hard_timeout=%"PRIu16, learn->fin_hard_timeout);
 436     }
 437     if (learn->priority != OFP_DEFAULT_PRIORITY) {
 438         ds_put_format(s, ",priority=%"PRIu16, learn->priority);
 439     }
 440     if (learn->flags & NX_LEARN_F_SEND_FLOW_REM) {
 441         ds_put_cstr(s, ",send_flow_rem");
 442     }
 443     if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
 444         ds_put_cstr(s, ",delete_learned");
 445     }
 446     if (learn->cookie != 0) {
 447         ds_put_format(s, ",cookie=%#"PRIx64, ntohll(learn->cookie));
 448     }
 449
 450     for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
 451         ds_put_char(s, ',');
 452
 453         switch (spec->src_type | spec->dst_type) {
 454         case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_MATCH:
 455             if (spec->dst.ofs == 0
 456                 && spec->dst.n_bits == spec->dst.field->n_bits) {
 457                 union mf_value value;
 458
 459                 memset(&value, 0, sizeof value);
 460                 bitwise_copy(&spec->src_imm, sizeof spec->src_imm, 0,
 461                              &value, spec->dst.field->n_bytes, 0,
 462                              spec->dst.field->n_bits);
 463                 ds_put_format(s, "%s=", spec->dst.field->name);
 464                 mf_format(spec->dst.field, &value, NULL, s);
 465             } else {
 466                 mf_format_subfield(&spec->dst, s);
 467                 ds_put_char(s, '=');
 468                 mf_format_subvalue(&spec->src_imm, s);
 469             }
 470             break;
 471
 472         case NX_LEARN_SRC_FIELD | NX_LEARN_DST_MATCH:
 473             mf_format_subfield(&spec->dst, s);
 474             if (spec->src.field != spec->dst.field ||
 475                 spec->src.ofs != spec->dst.ofs) {
 476                 ds_put_char(s, '=');
 477                 mf_format_subfield(&spec->src, s);
 478             }
 479             break;
 480
 481         case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_LOAD:
 482             ds_put_format(s, "load:");
 483             mf_format_subvalue(&spec->src_imm, s);
 484             ds_put_cstr(s, "->");
 485             mf_format_subfield(&spec->dst, s);
 486             break;
 487
 488         case NX_LEARN_SRC_FIELD | NX_LEARN_DST_LOAD:
 489             ds_put_cstr(s, "load:");
 490             mf_format_subfield(&spec->src, s);
 491             ds_put_cstr(s, "->");
 492             mf_format_subfield(&spec->dst, s);
 493             break;
 494
 495         case NX_LEARN_SRC_FIELD | NX_LEARN_DST_OUTPUT:
 496             ds_put_cstr(s, "output:");
 497             mf_format_subfield(&spec->src, s);
 498             break;
 499         }
 500     }
 501     ds_put_char(s, ')');
 502 }