###########################################################################
#   Copyright 2016 IBM Corp.
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
############################################################################

Scripts to evaluate the scalability of OVN control plane using ovs-sim
utility.

* To set up number of hosts, ports, overlapping percentage and cores
assignments, update the vars at the top of perf/perf.rc file.
* To preview the randomly generated networks-to-hosts mappings run sudo
utilities/ovs-sim perf/dry.sh while being inside ovs directory.
* To run the actual measurements, run sudo utilities/ovs-sim perf/test.sh
instead.
* To reset the networks-to-hosts mapping remove rand* files from perf/tmp.
* Use -i flag of ovs-sim to stop the simulator before clean-up, so you can
inspect and further tweak or test the created environment.
* Running the tests results in a few perf/perf.data.* files which can be
inspected offline using perf report -i <filename> to see which functions
 of which executables took most of the cycles.