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