tests/ofproto-macros.at

   1 m4_divert_push([PREPARE_TESTS])
   2 [
   3 # Strips out uninteresting parts of ovs-ofctl output, as well as parts
   4 # that vary from one run to another.
   5 ofctl_strip () {
   6     sed '
   7 s/ (xid=0x[0-9a-fA-F]*)//
   8 s/ duration=[0-9.]*s,//
   9 s/ cookie=0x0,//
  10 s/ table=0,//
  11 s/ n_packets=0,//
  12 s/ n_bytes=0,//
  13 s/ idle_age=[0-9]*,//
  14 s/ hard_age=[0-9]*,//
  15 s/dp_hash=0x[0-9a-f]*\//dp_hash=0x0\//
  16 s/recirc_id=0x[0-9a-f]*,/recirc_id=0x0,/
  17 '
  18 }
  19
  20 # Filter (multiline) vconn debug messages from ovs-vswitchd.log.
  21 # Use with vconn_sub() and ofctl_strip()
  22 print_vconn_debug () { awk -F\| < ovs-vswitchd.log '
  23 BEGIN { prt=0 }
  24 /\|vconn\|DBG\|/ { sub(/[ \t]*$/, ""); print $3 "|" $4 "|" $5; prt=1; next }
  25 $4 != "" { prt=0; next }
  26 prt==1 { sub(/[ \t]*$/, ""); print $0 }
  27 '
  28 }
  29
  30 vconn_sub() {
  31     sed '
  32 s/tcp:127.0.0.1:[0-9][0-9]*:/unix:/
  33 '
  34 }
  35 ]
  36
  37 # PARSE_LISTENING_PORT LOGFILE VARIABLE
  38 #
  39 # Parses the TCP or SSL port on which a server is listening from
  40 # LOGFILE, given that the server was told to listen on a kernel-chosen
  41 # port, and assigns the port number to shell VARIABLE.  You should
  42 # specify the listening remote as ptcp:0:127.0.0.1 or
  43 # pssl:0:127.0.0.1, or the equivalent with [::1] instead of 127.0.0.1.
  44 #
  45 # Here's an example of how to use this with ovsdb-server:
  46 #
  47 #    ovsdb-server --log-file --remote=ptcp:0:127.0.0.1 ...
  48 #    PARSE_LISTENING_PORT([ovsdb-server.log], [TCP_PORT])
  49 #    # Now $TCP_PORT holds the listening port.
  50 m4_define([PARSE_LISTENING_PORT],
  51     [OVS_WAIT_UNTIL([$2=`sed -n 's/.*0:.*: listening on port \([[0-9]]*\)$/\1/p' "$1"` && test X != X"[$]$2"])])
  52
  53 start_daemon () {
  54     "$@" -vconsole:off --detach --no-chdir --pidfile --log-file
  55     pid=`cat "$OVS_RUNDIR"/$1.pid`
  56     on_exit "kill $pid"
  57 }
  58
  59 # sim_add SANDBOX
  60 #
  61 # Starts a new simulated Open vSwitch instance named SANDBOX.  Files related to
  62 # the instance, such as logs, databases, sockets, and pidfiles, are created in
  63 # a subdirectory of the main test directory also named SANDBOX.  Afterward, the
  64 # "as" command (see below) can be used to run Open vSwitch utilities in the
  65 # context of the new sandbox.
  66 #
  67 # The new sandbox starts out without any bridges.  Use ovs-vsctl in the context
  68 # of the new sandbox to create a bridge, e.g.:
  69 #
  70 #     sim_add hv0           # Create sandbox hv0.
  71 #     as hv0                # Set hv0 as default sandbox.
  72 #     ovs-vsctl add-br br0  # Add bridge br0 inside hv0.
  73 #
  74 # or:
  75 #
  76 #     sim_add hv0
  77 #     as hv0 ovs-vsctl add-br br0
  78 sims=
  79 sim_add () {
  80    echo "adding simulator '$1'"
  81
  82    sims="$sims $1"
  83
  84    # Create sandbox.
  85    local d="$ovs_base"/$1
  86    mkdir "$d" || return 1
  87    ovs_setenv $1
  88
  89    # Create database and start ovsdb-server.
  90    : > "$d"/.conf.db.~lock~
  91    as $1 ovsdb-tool create "$d"/conf.db "$abs_top_srcdir"/vswitchd/vswitch.ovsschema || return 1
  92    as $1 start_daemon ovsdb-server --remote=punix:"$d"/db.sock || return 1
  93
  94    # Initialize database.
  95    as $1 ovs-vsctl --no-wait -- init || return 1
  96
  97    # Start ovs-vswitchd
  98    as $1 start_daemon ovs-vswitchd --enable-dummy=system -vvconn -vofproto_dpif -vunixctl
  99 }
 100
 101 # "as $1" sets the OVS_*DIR environment variables to point to $ovs_base/$1.
 102 #
 103 # "as $1 COMMAND..." sets those variables in a subshell and invokes COMMAND
 104 # there.
 105 as() {
 106     if test "X$2" != X; then
 107         (ovs_setenv $1; shift; $@)
 108     else
 109         ovs_setenv $1
 110     fi
 111 }
 112
 113 # ovn_init_db DATABASE
 114 #
 115 # Creates and initializes the given DATABASE (one of "ovn-sb" or "ovn-nb"),
 116 # starts its ovsdb-server instance, and sets the appropriate environment
 117 # variable (OVN_SB_DB or OVN_NB_DB) so that ovn-sbctl or ovn-nbctl uses the
 118 # database by default.
 119 #
 120 # Usually invoked from ovn_start.
 121 ovn_init_db () {
 122     echo "creating $1 database"
 123     local d=$ovs_base/$1
 124     mkdir "$d" || return 1
 125     : > "$d"/.$1.db.~lock~
 126     as $1 ovsdb-tool create "$d"/$1.db "$abs_top_srcdir"/ovn/$1.ovsschema
 127     as $1 start_daemon ovsdb-server --remote=punix:"$d"/$1.sock "$d"/$1.db
 128     local var=`echo $1_db | tr a-z- A-Z_`
 129     AS_VAR_SET([$var], [unix:$ovs_base/$1/$1.sock]); export $var
 130 }
 131
 132 # ovn_start
 133 #
 134 # Creates and initializes ovn-sb and ovn-nb databases and starts their
 135 # ovsdb-server instance, sets appropriate environment variables so that
 136 # ovn-sbctl and ovn-nbctl use them by default, and starts ovn-northd running
 137 # against them.
 138 ovn_start () {
 139     ovn_init_db ovn-sb
 140     ovn_init_db ovn-nb
 141
 142     echo "starting ovn-northd"
 143     mkdir "$ovs_base"/northd
 144     as northd start_daemon ovn-northd \
 145                --ovnnb-db=unix:"$ovs_base"/ovn-nb/ovn-nb.sock \
 146                --ovnsb-db=unix:"$ovs_base"/ovn-sb/ovn-sb.sock
 147 }
 148
 149 # Interconnection networks.
 150 #
 151 # When multiple sandboxed Open vSwitch instances exist, one will inevitably
 152 # want to connect them together.  These commands allow for that.  Conceptually,
 153 # an interconnection network is a switch for which these functions make it easy
 154 # to plug into other switches in other sandboxed Open vSwitch instances.
 155 # Interconnection networks are implemented as bridges in a switch named "main",
 156 # so to use interconnection networks please avoid working with that switch
 157 # directly.
 158
 159 # net_add NETWORK
 160 #
 161 # Creates a new interconnection network named NETWORK.
 162 net_add () {
 163     test -d "$ovs_base"/main || sim_add main || return 1
 164     as main ovs-vsctl add-br "$1"
 165 }
 166
 167 # net_attach NETWORK BRIDGE
 168 #
 169 # Adds a new port to BRIDGE in the default sandbox (as set with as()) and plugs
 170 # it into the NETWORK interconnection network.  NETWORK must already have been
 171 # created by a previous invocation of net_add.  The default sandbox must not be
 172 # "main".
 173 net_attach () {
 174     local net=$1 bridge=$2
 175
 176     local port=${sandbox}_$bridge
 177     as main ovs-vsctl \
 178         -- add-port $net $port \
 179         -- set Interface $port options:pstream="punix:$ovs_base/main/$port.sock" options:rxq_pcap="$ovs_base/main/$port-rx.pcap" options:tx_pcap="$ovs_base/main/$port-tx.pcap" \
 180         || return 1
 181
 182     ovs-vsctl \
 183         -- set Interface $bridge options:tx_pcap="$ovs_base/$sandbox/$bridge-tx.pcap" options:rxq_pcap="$ovs_base/$sandbox/$bridge-rx.pcap" \
 184         -- add-port $bridge ${bridge}_$net \
 185         -- set Interface ${bridge}_$net options:stream="unix:$ovs_base/main/$port.sock" options:rxq_pcap="$ovs_base/$sandbox/${bridge}_$net-rx.pcap" options:tx_pcap="$ovs_base/$sandbox/${bridge}_$net-tx.pcap" \
 186         || return 1
 187 }
 188
 189 # ovn_attach NETWORK BRIDGE IP [MASKLEN]
 190 #
 191 # First, this command attaches BRIDGE to interconnection network NETWORK, just
 192 # like "net_attach NETWORK BRIDGE".  Second, it configures (simulated) IP
 193 # address IP (with network mask length MASKLEN, which defaults to 24) on
 194 # BRIDGE.  Finally, it configures the Open vSwitch database to work with OVN
 195 # and starts ovn-controller.
 196 ovn_attach() {
 197     local net=$1 bridge=$2 ip=$3 masklen=${4-24}
 198     net_attach $net $bridge || return 1
 199
 200     mac=`ovs-vsctl get Interface $bridge mac_in_use | sed s/\"//g`
 201     arp_table="$arp_table $sandbox,$bridge,$ip,$mac"
 202     ovs-appctl netdev-dummy/ip4addr $bridge $ip/$masklen >/dev/null || return 1
 203     ovs-appctl ovs/route/add $ip/$masklen $bridge >/dev/null || return 1
 204     ovs-vsctl \
 205         -- set Open_vSwitch . external-ids:system-id=$sandbox \
 206         -- set Open_vSwitch . external-ids:ovn-remote=unix:$ovs_base/ovn-sb/ovn-sb.sock \
 207         -- set Open_vSwitch . external-ids:ovn-encap-type=geneve,vxlan \
 208         -- set Open_vSwitch . external-ids:ovn-encap-ip=$ip \
 209         -- add-br br-int \
 210         -- set bridge br-int fail-mode=secure other-config:disable-in-band=true \
 211         || return 1
 212     start_daemon ovn-controller || return 1
 213 }
 214
 215 # ovn_populate_arp
 216 #
 217 # This pre-populates the ARP tables of all of the OVN instances that have been
 218 # started with ovn_attach().  That means that packets sent from one hypervisor
 219 # to another never get dropped or delayed by ARP resolution, which makes
 220 # testing easier.
 221 ovn_populate_arp() {
 222     for e1 in $arp_table; do
 223         set `echo $e1 | sed 's/,/ /g'`; sb1=$1 br1=$2 ip=$3 mac=$4
 224         for e2 in $arp_table; do
 225             set `echo $e2 | sed 's/,/ /g'`; sb2=$1 br2=$2
 226             if test $sb1,$br1 != $sb2,$br2; then
 227                 as $sb2 ovs-appctl tnl/neigh/set $br2 $ip $mac
 228             fi
 229         done
 230     done
 231 }
 232
 233 # Strips 'xid=0x1234' from ovs-ofctl output.
 234 strip_xids () {
 235     sed 's/ (xid=0x[[0-9a-fA-F]]*)//'
 236 }
 237
 238 # Changes all 'used:...' to say 'used:0.0', to make output easier to compare.
 239 strip_used () {
 240     sed 's/used:[[0-9]]\.[[0-9]]*/used:0.0/'
 241 }
 242
 243 # Strips 'ufid:...' from output, to make it easier to compare.
 244 # (ufids are random.)
 245 strip_ufid () {
 246     sed 's/ufid:[[-0-9a-f]]* //'
 247 }
 248 m4_divert_pop([PREPARE_TESTS])
 249
 250 m4_define([TESTABLE_LOG], [-vPATTERN:ANY:'%c|%p|%m'])
 251
 252 # _OVS_VSWITCHD_START([vswitchd-aux-args])
 253 #
 254 # Creates an empty database and starts ovsdb-server.
 255 # Starts ovs-vswitchd, with additional arguments 'vswitchd-aux-args'.
 256 #
 257 m4_define([_OVS_VSWITCHD_START],
 258   [dnl Create database.
 259    touch .conf.db.~lock~
 260    AT_CHECK([ovsdb-tool create conf.db $abs_top_srcdir/vswitchd/vswitch.ovsschema])
 261
 262    dnl Start ovsdb-server.
 263    AT_CHECK([ovsdb-server --detach --no-chdir --pidfile --log-file --remote=punix:$OVS_RUNDIR/db.sock], [0], [], [stderr])
 264    on_exit "kill `cat ovsdb-server.pid`"
 265    AT_CHECK([[sed < stderr '
 266 /vlog|INFO|opened log file/d
 267 /ovsdb_server|INFO|ovsdb-server (Open vSwitch)/d']])
 268    AT_CAPTURE_FILE([ovsdb-server.log])
 269
 270    dnl Initialize database.
 271    AT_CHECK([ovs-vsctl --no-wait init])
 272
 273    dnl Start ovs-vswitchd.
 274    AT_CHECK([ovs-vswitchd $1 --detach --no-chdir --pidfile --log-file -vvconn -vofproto_dpif -vunixctl], [0], [], [stderr])
 275    AT_CAPTURE_FILE([ovs-vswitchd.log])
 276    on_exit "kill `cat ovs-vswitchd.pid`"
 277    AT_CHECK([[sed < stderr '
 278 /ovs_numa|INFO|Discovered /d
 279 /vlog|INFO|opened log file/d
 280 /vswitchd|INFO|ovs-vswitchd (Open vSwitch)/d
 281 /reconnect|INFO|/d
 282 /ofproto|INFO|using datapath ID/d
 283 /netdev_linux|INFO|.*device has unknown hardware address family/d
 284 /ofproto|INFO|datapath ID changed to fedcba9876543210/d']])
 285 ])
 286
 287 # OVS_VSWITCHD_START([vsctl-args], [vsctl-output], [=override])
 288 #
 289 # Creates a database and starts ovsdb-server, starts ovs-vswitchd
 290 # connected to that database, calls ovs-vsctl to create a bridge named
 291 # br0 with predictable settings, passing 'vsctl-args' as additional
 292 # commands to ovs-vsctl.  If 'vsctl-args' causes ovs-vsctl to provide
 293 # output (e.g. because it includes "create" commands) then 'vsctl-output'
 294 # specifies the expected output after filtering through uuidfilt.pl.
 295 #
 296 # If a test needs to use "system" devices (as dummies), then specify
 297 # =override (literally) as the third argument.  Otherwise, system devices
 298 # won't work at all (which makes sense because tests should not access a
 299 # system's real Ethernet devices).
 300 m4_define([OVS_VSWITCHD_START],
 301   [_OVS_VSWITCHD_START([--enable-dummy$3 --disable-system])
 302    AT_CHECK([add_of_br 0 $1 m4_if([$2], [], [], [| ${PERL} $srcdir/uuidfilt.pl])], [0], [$2])
 303 ])
 304
 305 # check_logs scans through all *.log files (except '*.log' and testsuite.log)
 306 # and reports all WARN, ERR, EMER log entries.  User can add custom sed filters
 307 # in $1.
 308 m4_divert_push([PREPARE_TESTS])
 309 check_logs () {
 310     local logs
 311     for log in *.log; do
 312         case ${log} in # (
 313             '*.log'|testsuite.log) ;; # (
 314             *) logs="${logs} ${log}" ;;
 315         esac
 316     done
 317
 318     sed -n "$1
 319 /timeval.*Unreasonably long [[0-9]]*ms poll interval/d
 320 /timeval.*faults: [[0-9]]* minor, [[0-9]]* major/d
 321 /timeval.*disk: [[0-9]]* reads, [[0-9]]* writes/d
 322 /timeval.*context switches: [[0-9]]* voluntary, [[0-9]]* involuntary/d
 323 /ovs_rcu.*blocked [[0-9]]* ms waiting for .* to quiesce/d
 324 /|WARN|/p
 325 /|ERR|/p
 326 /|EMER|/p" ${logs}
 327 }
 328
 329 # add_of_br BRNUM [ARG...]
 330 add_of_br () {
 331     local brnum=$1; shift
 332     local br=br$brnum
 333     local dpid=fedcba987654321$brnum
 334     local mac=aa:55:aa:55:00:0$brnum
 335     ovs-vsctl --timeout=20 \
 336         -- add-br $br \
 337         -- set bridge $br datapath-type=dummy \
 338                           fail-mode=secure \
 339                           other-config:datapath-id=$dpid \
 340                           other-config:hwaddr=$mac \
 341                           protocols="[[OpenFlow10,OpenFlow11,OpenFlow12,\
 342                                        OpenFlow13,OpenFlow14,OpenFlow15,\
 343                                        OpenFlow16]]" \
 344         -- "$@"
 345 }
 346
 347 # add_of_ports [--pcap] BRIDGE PNUM...
 348 #
 349 # Creates dummy interfaces in BRIDGE named pPNUM, OpenFlow port number
 350 # PNUM, and datapath port number PNUM (the latter is a consequence of
 351 # the dummy implementation, which tries to assign datapath port
 352 # numbers based on port names).
 353 #
 354 # If --pcap is supplied then packets received from the interface will
 355 # be written to $port-rx.pcap and those sent to it to $port-tx.pcap.
 356 add_of_ports () {
 357     local args
 358     local pcap=false
 359     if test "$1" = --pcap; then
 360         pcap=:
 361         shift
 362     fi
 363     local br=$1; shift
 364     for pnum; do
 365         AS_VAR_APPEND([args], [" -- add-port $br p$pnum -- set Interface p$pnum type=dummy ofport_request=$pnum"])
 366         if $pcap; then
 367             AS_VAR_APPEND([args], [" -- set Interface p$pnum options:rxq_pcap=p$pnum-rx.pcap options:tx_pcap=p$pnum-tx.pcap"])
 368         fi
 369     done
 370     echo ovs-vsctl $args
 371     ovs-vsctl $args
 372 }
 373 m4_divert_pop([PREPARE_TESTS])
 374
 375 # OVS_VSWITCHD_STOP([WHITELIST])
 376 #
 377 # Gracefully stops ovs-vswitchd and ovsdb-server, checking their log files
 378 # for messages with severity WARN or higher and signaling an error if any
 379 # is present.  The optional WHITELIST may contain shell-quoted "sed"
 380 # commands to delete any warnings that are actually expected, e.g.:
 381 #
 382 #   OVS_VSWITCHD_STOP(["/expected error/d"])
 383 m4_define([OVS_VSWITCHD_STOP],
 384   [AT_CHECK([check_logs $1])
 385    OVS_APP_EXIT_AND_WAIT([ovs-vswitchd])
 386    OVS_APP_EXIT_AND_WAIT([ovsdb-server])])
 387
 388 m4_define([OVS_VSWITCHD_DISABLE_TUNNEL_PUSH_POP],
 389   [AT_CHECK([ovs-appctl ofproto/tnl-push-pop off], [0], [dnl
 390 Tunnel push-pop off
 391 ])])
 392
 393 # WAIT_FOR_DUMMY_PORTS(NETDEV_DUMMY_PORT[, NETDEV_DUMMY_PORT...])
 394 #
 395 # Wait until the netdev dummy ports are connected to each other
 396 m4_define([WAIT_FOR_DUMMY_PORTS], \
 397   [m4_foreach([dummy_port], [$@],
 398       [  \
 399          OVS_WAIT_WHILE([ovs-appctl netdev-dummy/conn-state dummy_port \
 400                   | grep 'unknown\|disconnected'])])])