tests/test-bundle.c

   1 /* Copyright (c) 2011, 2012, 2013 Nicira, Inc.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "bundle.h"
  19
  20 #include <math.h>
  21 #include <stdlib.h>
  22
  23 #include "flow.h"
  24 #include "ofp-actions.h"
  25 #include "ofpbuf.h"
  26 #include "random.h"
  27
  28 #include "util.h"
  29
  30 #define N_FLOWS  50000
  31 #define MAX_SLAVES 8 /* Maximum supported by this test framework. */
  32
  33 struct slave {
  34     ofp_port_t slave_id;
  35
  36     bool enabled;
  37     size_t flow_count;
  38 };
  39
  40 struct slave_group {
  41     size_t n_slaves;
  42     struct slave slaves[MAX_SLAVES];
  43 };
  44
  45 static struct slave *
  46 slave_lookup(struct slave_group *sg, ofp_port_t slave_id)
  47 {
  48     size_t i;
  49
  50     for (i = 0; i < sg->n_slaves; i++) {
  51         if (sg->slaves[i].slave_id == slave_id) {
  52             return &sg->slaves[i];
  53         }
  54     }
  55
  56     return NULL;
  57 }
  58
  59 static bool
  60 slave_enabled_cb(ofp_port_t slave_id, void *aux)
  61 {
  62     struct slave *slave;
  63
  64     slave = slave_lookup(aux, slave_id);
  65     return slave ? slave->enabled : false;
  66 }
  67
  68 static struct ofpact_bundle *
  69 parse_bundle_actions(char *actions)
  70 {
  71     struct ofpact_bundle *bundle;
  72     struct ofpbuf ofpacts;
  73     struct ofpact *action;
  74     char *error;
  75
  76     ofpbuf_init(&ofpacts, 0);
  77     error = bundle_parse_load(actions, &ofpacts);
  78     if (error) {
  79         ovs_fatal(0, "%s", error);
  80     }
  81
  82     action = ofpacts.data;
  83     bundle = ofpact_get_BUNDLE(xmemdup(action, action->len));
  84     ofpbuf_uninit(&ofpacts);
  85
  86     if (bundle->n_slaves > MAX_SLAVES) {
  87         ovs_fatal(0, "At most %u slaves are supported", MAX_SLAVES);
  88     }
  89
  90     return bundle;
  91 }
  92
  93 static const char *
  94 mask_str(uint8_t mask, size_t n_bits)
  95 {
  96     static char str[9];
  97     size_t i;
  98
  99     n_bits = MIN(n_bits, 8);
 100     for (i = 0; i < n_bits; i++) {
 101         str[i] = (1 << i) & mask ? '1' : '0';
 102     }
 103     str[i] = '\0';
 104
 105     return str;
 106 }
 107
 108 int
 109 main(int argc, char *argv[])
 110 {
 111     bool ok = true;
 112     struct ofpact_bundle *bundle;
 113     struct flow *flows;
 114     size_t i, n_permute, old_n_enabled;
 115     struct slave_group sg;
 116     int old_active;
 117
 118     set_program_name(argv[0]);
 119     random_init();
 120
 121     if (argc != 2) {
 122         ovs_fatal(0, "usage: %s bundle_action", program_name);
 123     }
 124
 125     bundle = parse_bundle_actions(argv[1]);
 126
 127     /* Generate 'slaves' array. */
 128     sg.n_slaves = 0;
 129     for (i = 0; i < bundle->n_slaves; i++) {
 130         ofp_port_t slave_id = bundle->slaves[i];
 131
 132         if (slave_lookup(&sg, slave_id)) {
 133             ovs_fatal(0, "Redundant slaves are not supported. ");
 134         }
 135
 136         sg.slaves[sg.n_slaves].slave_id = slave_id;
 137         sg.n_slaves++;
 138     }
 139
 140     /* Generate flows. */
 141     flows = xmalloc(N_FLOWS * sizeof *flows);
 142     for (i = 0; i < N_FLOWS; i++) {
 143         random_bytes(&flows[i], sizeof flows[i]);
 144         memset(flows[i].zeros, 0, sizeof flows[i].zeros);
 145         flows[i].mpls_depth = 0;
 146         flows[i].regs[0] = ofp_to_u16(OFPP_NONE);
 147     }
 148
 149     /* Cycles through each possible liveness permutation for the given
 150      * n_slaves.  The initial state is equivalent to all slaves down, so we
 151      * skip it by starting at i = 1. We do one extra iteration to cover
 152      * transitioning from the final state back to the initial state. */
 153     old_n_enabled = 0;
 154     old_active = -1;
 155     n_permute = 1 << sg.n_slaves;
 156     for (i = 1; i <= n_permute + 1; i++) {
 157         struct slave *slave;
 158         size_t j, n_enabled, changed;
 159         double disruption, perfect;
 160         uint8_t mask;
 161         int active;
 162
 163         mask = i % n_permute;
 164
 165         /* Gray coding ensures that in each iteration exactly one slave
 166          * changes its liveness.  This makes the expected disruption a bit
 167          * easier to calculate, and is likely similar to how failures will be
 168          * experienced in the wild. */
 169         mask = mask ^ (mask >> 1);
 170
 171         /* Initialize slaves. */
 172         n_enabled = 0;
 173         for (j = 0; j < sg.n_slaves; j++) {
 174             slave = &sg.slaves[j];
 175             slave->flow_count = 0;
 176             slave->enabled = ((1 << j) & mask) != 0;
 177
 178             if (slave->enabled) {
 179                 n_enabled++;
 180             }
 181         }
 182
 183         active = -1;
 184         for (j = 0; j < sg.n_slaves; j++) {
 185             if (sg.slaves[j].enabled) {
 186                 active = j;
 187                 break;
 188             }
 189         }
 190
 191         changed = 0;
 192         for (j = 0; j < N_FLOWS; j++) {
 193             struct flow *flow = &flows[j];
 194             ofp_port_t old_slave_id, ofp_port;
 195             struct flow_wildcards wc;
 196
 197             old_slave_id = u16_to_ofp(flow->regs[0]);
 198             ofp_port = bundle_execute(bundle, flow, &wc, slave_enabled_cb,
 199                                       &sg);
 200             flow->regs[0] = ofp_to_u16(ofp_port);
 201
 202             if (ofp_port != OFPP_NONE) {
 203                 slave_lookup(&sg, ofp_port)->flow_count++;
 204             }
 205
 206             if (old_slave_id != ofp_port) {
 207                 changed++;
 208             }
 209         }
 210
 211         if (bundle->algorithm == NX_BD_ALG_ACTIVE_BACKUP) {
 212             perfect = active == old_active ? 0.0 : 1.0;
 213         } else {
 214             if (old_n_enabled || n_enabled) {
 215                 perfect = 1.0 / MAX(old_n_enabled, n_enabled);
 216             } else {
 217                 /* This will happen when 'sg.n_slaves' is 0. */
 218                 perfect = 0;
 219             }
 220         }
 221
 222         disruption = changed / (double)N_FLOWS;
 223         printf("%s: disruption=%.2f (perfect=%.2f)",
 224                mask_str(mask, sg.n_slaves), disruption, perfect);
 225
 226         for (j = 0 ; j < sg.n_slaves; j++) {
 227             struct slave *slave = &sg.slaves[j];
 228             double flow_percent;
 229
 230             flow_percent = slave->flow_count / (double)N_FLOWS;
 231             printf( " %.2f", flow_percent);
 232
 233             if (slave->enabled) {
 234                 double perfect_fp;
 235
 236                 if (bundle->algorithm == NX_BD_ALG_ACTIVE_BACKUP) {
 237                     perfect_fp = j == active ? 1.0 : 0.0;
 238                 } else {
 239                     perfect_fp = 1.0 / n_enabled;
 240                 }
 241
 242                 if (fabs(flow_percent - perfect_fp) >= .01) {
 243                     fprintf(stderr, "%s: slave %d: flow_percentage=%.5f for"
 244                             " differs from perfect=%.5f by more than .01\n",
 245                             mask_str(mask, sg.n_slaves), slave->slave_id,
 246                             flow_percent, perfect_fp);
 247                     ok = false;
 248                 }
 249             } else if (slave->flow_count) {
 250                 fprintf(stderr, "%s: slave %d: disabled slave received"
 251                         " flows.\n", mask_str(mask, sg.n_slaves),
 252                         slave->slave_id);
 253                 ok = false;
 254             }
 255         }
 256         printf("\n");
 257
 258         if (fabs(disruption - perfect) >= .01) {
 259             fprintf(stderr, "%s: disruption=%.5f differs from perfect=%.5f by"
 260                     " more than .01\n", mask_str(mask, sg.n_slaves),
 261                     disruption, perfect);
 262             ok = false;
 263         }
 264
 265         old_active = active;
 266         old_n_enabled = n_enabled;
 267     }
 268
 269     free(bundle);
 270     free(flows);
 271     return ok ? 0 : 1;
 272 }