diff --git a/.gitignore b/.gitignore
index 1ea55fa..e56d449 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,24 +1,19 @@
+# Python
build
-crypto
-ChronoSync
dist
-doc/html
-doc/latex
-.DS_Store
-examples
-infoedit
-jndn
Mini_NDN.egg-info
-mininet
-NFD
-NLSR
-ndn-cpp
-ndn-cxx
-ndn-js
-ndn-tools
-openflow
-PyNDN2
-PSync
-util
-.vagrant
*.pyc
+
+# Docs
+docs/html
+docs/latex
+docs/_build
+
+# Misc
+.DS_Store
+mininet
+ndn-src
+openflow
+
+# Vagrant
+.vagrant
diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index f263972..0000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,92 +0,0 @@
-Mini-NDN Installation Instructions
-================================
-
-### What equipment will I need?
-
-For this guide, you will need a laptop/desktop with a recent version
-of a Linux distro such as Ubuntu or any of its variants. Fedora is not
-officially supported but has also been reported to work for some
-users. For this guide, the _Ubuntu 18.04 LTS_ release was used.
-Also, note that you'll need administrative privileges in order to
-download and install extra packages and also to execute **Mini-NDN**.
-
-### Installing **Mini-NDN**
-
-NOTE: Mini-NDN, while providing a high level of emulation of hosts,
-requires programs to be installed onto your computer. It will not work
-if they are not installed. If you do not want NDN software installed
-onto your computer, you can use a virtual machine, which can be quite
-simply set up with the provided vagrantfile.
-
-If you have all the dependencies (see sections below) installed simply clone this repository and run:
-
- ./install.sh -i
-
-else if you don't have the dependencies, the following command will install them from source along with Mini-NDN:
-
- ./install.sh -a
-
-If you want to install the dependencies manually or from the Named Data PPA, follow the instructions below:
-
-### Installing NDN
-
-Each node in **Mini-NDN** will run the official implementation of NDN installed on your system. The following dependencies are needed:
-
-Mini-NDN uses NFD, NLSR, and ndn-tools.
-
-To install NFD:
-https://named-data.net/doc/NFD/current/INSTALL.html
-
-To install NLSR:
-https://named-data.net/doc/NLSR/current/INSTALL.html
-
-To install ndn-tools:
-https://github.com/named-data/ndn-tools
-
-Note that all three of these can be installed from the Named Data PPA. Instructions for setting it up can
-be found in the NFD insallation instructions. Note that PPA and installs from source **cannot** be mixed.
-
-###Special Instructions for PPA Installs
-
-If you are using a custom nfd.conf file in an experiment, you should place it in /usr/local/etc/ndn/
-rather than /etc/ndn/. This is to avoid a bug from the default configuration file for the PPA, which
-is incompatiable with Mini-NDN.
-
-### Installing Mininet
-
-**Mini-NDN** is based on Mininet. To install Mininet:
-
-First, clone Mininet from github:
-
- git clone --depth 1 https://github.com/mininet/mininet.git
-
-After Mininet source is on your system, run the following command to
-install Mininet core dependencies and Open vSwitch:
-
- ./util/install.sh -nv
-
-To check if Mininet is working correctly, run this test:
-
- sudo mn --test pingall
-
-This will print out a series of statements that show the test setup
-and the results of the test. Look for `Results:` two-thirds of the way
-down where it will indicate the percentage of dropped packets.
-Your results should show "0% dropped (2/2 received)".
-
-### Installing Infoedit
-
-Infoedit is used to edit configuration files such as NFD configuration
-file.
-
-To install infoedit:
-https://github.com/NDN-Routing/infoedit
-
-### Verification
-
-You can use these steps to verify your installation:
-
-1. Issue the command: `sudo minindn --experiment=pingall --nPings=50`
-2. When the `mini-ndn>` CLI prompt appears, the experiment has finished. On the Mini-NDN CLI, issue the command `exit` to exit the experiment.
-3. Issue the command: `grep -c content /tmp/minindn/*/ping-data/*.txt`. Each file should report a count of 50.
-4. Issue the command: `grep -c timeout /tmp/minindn/*/ping-data/*.txt`. Each file should report a count of 0.
\ No newline at end of file
diff --git a/README.md b/README.md
index 146d953..5a1d007 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,9 @@ If you are new to the NDN community of software generally, read the
### What is Mini-NDN?
Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
-research on the NDN platform. Based on [Mini-CCNx](https://github.com/chesteve/mn-ccnx) which
-is a fork of [Mininet](https://github.com/mininet/mininet), Mini-NDN uses the NDN libraries,
-NFD, NLSR, and tools released by the [NDN project](http://named-data.net/codebase/platform/)
-to emulate an NDN network on a single system.
+research on the NDN platform based on [Mininet](https://github.com/mininet/mininet).
+Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the
+[NDN project](http://named-data.net/codebase/platform/) to emulate an NDN network on a single system.
Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all
users and developers. For more information about licensing details and limitations,
@@ -25,9 +24,9 @@ Bug reports and feedback are highly appreciated and can be made through our
### Documentation
-* [Installation](INSTALL.md)
-* [Getting Started](docs/GETTING-STARTED.md)
-* [Mini-NDN Edit](docs/GUI.md)
-* [Running Experiments](docs/EXPERIMENTS.md)
-* [Mini-NDN Redmine](http://redmine.named-data.net/projects/mini-ndn)
-* [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md)
+Please refer to http://minindn.memphis.edu/ or [docs/index.rst](docs/index.rst) for installation, usage, and other documentation.
+The documentation can be built using:
+
+ ./install.sh -d
+
+and is available under `docs/_build/html`.
diff --git a/Vagrantfile b/Vagrantfile
index 6083675..f3bb364 100644
--- a/Vagrantfile
+++ b/Vagrantfile
@@ -2,18 +2,27 @@
# vi: set ft=ruby :
$script = <.
-#
-# This file incorporates work covered by the following copyright and
-# permission notice:
-#
-# Mininet 2.3.0d1 License
-#
-# Copyright (c) 2013-2016 Open Networking Laboratory
-# Copyright (c) 2009-2012 Bob Lantz and The Board of Trustees of
-# The Leland Stanford Junior University
-#
-# Original authors: Bob Lantz and Brandon Heller
-#
-# We are making Mininet available for public use and benefit with the
-# expectation that others will use, modify and enhance the Software and
-# contribute those enhancements back to the community. However, since we
-# would like to make the Software available for broadest use, with as few
-# restrictions as possible permission is hereby granted, free of charge, to
-# any person obtaining a copy of this Software to deal in the Software
-# under the copyrights without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included
-# in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-# The name and trademarks of copyright holder(s) may NOT be used in
-# advertising or publicity pertaining to the Software or any derivatives
-# without specific, written prior permission.
-
-from mininet.topo import Topo
-from mininet.net import Mininet
-from mininet.log import setLogLevel, output, info, error, warn
-from mininet.link import TCLink
-from mininet.util import ipStr, ipParse
-
-from mininet.examples.cluster import MininetCluster, RoundRobinPlacer, ClusterCleanup
-from mininet.examples.clustercli import ClusterCLI
-
-from ndn import ExperimentManager
-from ndn.experiments.experiment import Experiment
-from ndn.ndn_host import NdnHost, CpuLimitedNdnHost, RemoteNdnHost
-from ndn.conf_parser import parse_hosts, parse_switches, parse_links
-from ndn.remote_ndn_link import RemoteNdnLink, RemoteGRENdnLink
-from ndn.placer import GuidedPlacer, PopulatePlacement
-from ndn.nfd import Nfd
-from ndn.util import ssh, scp, MiniNDNCLI, ProgramOptions
-
-import os.path, time
-import shutil
-import argparse
-import datetime
-from os.path import expanduser
-import sys
-import signal
-from subprocess import call
-import glob
-from functools import partial
-import re
-
-try:
- import argcomplete
-except ImportError:
- pass
-
-VERSION_NUMBER = "0.4.0"
-INSTALL_DIR='/usr/local/etc/mini-ndn/'
-
-class PrintExperimentNames(argparse.Action):
- def __init__(self, option_strings, dest, nargs=0, help=None):
- super(PrintExperimentNames, self).__init__(option_strings=option_strings, dest=dest, nargs=nargs, help=help)
-
- def __call__(self, parser, namespace, values, option_string=None):
- experimentNames = ExperimentManager.getExperimentNames()
-
- print("Mini-NDN experiments:")
- for experiment in experimentNames:
- print(" {}".format(experiment))
-
- sys.exit(0)
-
-def createResultsDir(resultDir, faces, rType):
- if faces == 0:
- faces = "all"
-
- routingChoice = "/{}/".format(rType)
-
- resultDir = "{}/{}/faces-{}".format(resultDir, routingChoice, faces)
- resultDir = os.path.abspath(resultDir)
-
- if not os.path.isdir(resultDir):
- os.makedirs(resultDir)
- else:
- warn("Results directory ({}) already exists!".format(resultDir))
- sys.exit(1)
-
- info("Results will be stored at: {}".format(resultDir))
- return resultDir
-
-def parse_args():
- parser = argparse.ArgumentParser(prog='minindn')
-
- # nargs='?' required here since optional argument
- parser.add_argument('tempfile', nargs='?', default=INSTALL_DIR + 'default-topology.conf',
- help="If no template_file is given, topologies/default-topology.conf (given sample file) will be used.")
-
- parser.add_argument("--ctime", type=int, default=60,
- help="Specify convergence time for the topology (Default: 60 seconds)")
-
- parser.add_argument("--experiment", choices=[experiment for experiment in ExperimentManager.getExperimentNames()],
- help="Runs the specified experiment")
-
- parser.add_argument("--faces", type=int, default=3,
- help="Specify number of max faces per prefix for NLSR 0-60")
-
- parser.add_argument("--routing", dest="routingType", default='link-state', choices=['link-state', 'hr', 'dry'],
- help="""choices for routing are 'link-state' for link state, 'hr' for hyperbolic, and 'dry'
- to test hyperbolic routing and compare with link state. Default is link-state.""")
-
- parser.add_argument("--no-nlsr", action="store_false", dest="isNlsrEnabled",
- help="Run mini-ndn without NLSR routing")
-
- parser.add_argument("--list-experiments", action=PrintExperimentNames,
- help="Lists the names of all available experiments")
-
- parser.add_argument("--no-cli", action="store_false", dest="isCliEnabled",
- help="Run experiments and exit without showing the command line interface")
-
- parser.add_argument("--nPings", type=int, default=300,
- help="Number of pings to perform between each node in the experiment")
-
- # store_true stores default value of False
- parser.add_argument("--nlsr-security", action="store_true", dest="nlsrSecurity",
- help="Enables NLSR security")
-
- parser.add_argument("-t", "--testbed", action="store_true", dest="testbed",
- help="Instantiates a snapshot of the NDN Testbed irrespective of the tempfile provided")
-
- parser.add_argument("--work-dir", action="store", dest="workDir", default="/tmp/minindn",
- help="Specify the working directory; default is /tmp/minindn")
-
- parser.add_argument("--result-dir", action="store", dest="resultDir", default=None,
- help="Specify the full path destination folder where experiment results will be moved")
-
- parser.add_argument("--pct-traffic", dest="pctTraffic", type=float, default=1.0,
- help="Specify the percentage of nodes each node should ping")
-
- parser.add_argument('--version', '-V', action='version', version='%(prog)s ' + VERSION_NUMBER,
- help='Displays version information')
-
- parser.add_argument("--cluster", metavar='localhost,server2,...',
- help="Run cluster edition")
-
- parser.add_argument("--placement", default='guided',
- choices=['roundRobin', 'guided'])
-
- parser.add_argument("--place-list", dest="placeList",
- help="""Provide corresponding number of nodes (comma separated) to put on
- each node respectively of --cluster when guided placement is used""")
-
- parser.add_argument("--tunnel-type", dest="tunnelType", default='ssh',
- choices=['ssh', 'gre'])
-
- parser.add_argument("--face-type", dest='faceType', default='udp', choices=['udp', 'tcp'])
-
- parser.add_argument("--cs-size", dest='csSize', type=int, default=65536,
- help="Set CS size in NFD's conf file")
-
- ExperimentManager.addExperimentArgs(parser)
-
- if "argcomplete" in sys.modules:
- argcomplete.autocomplete(parser)
-
- args = parser.parse_args()
-
- options = ProgramOptions()
- options.templateFile = args.tempfile
- options.ctime = args.ctime
- options.experimentName = args.experiment
- options.nFaces = args.faces
- options.routingType = args.routingType
- options.isNlsrEnabled = args.isNlsrEnabled
- options.isCliEnabled = args.isCliEnabled
- options.nlsrSecurity = args.nlsrSecurity
- options.nPings = args.nPings
-
- options.testbed = args.testbed
- options.workDir = args.workDir
- options.resultDir = args.resultDir
- options.pctTraffic = args.pctTraffic
- options.cluster = args.cluster
- options.placement = args.placement
- options.tunnelType = args.tunnelType
- options.placeList = args.placeList
- options.faceType = args.faceType
- options.csSize = args.csSize
- options.arguments = args
-
- if options.experimentName is not None and options.experimentName not in ExperimentManager.getExperimentNames():
- error("No experiment named {}\n".format(options.experimentName))
- sys.exit(1)
-
- if options.experimentName is not None and options.resultDir is None:
- warn("No results folder specified; experiment results will remain in the working directory\n")
-
- if options.cluster is not None:
- servers = options.cluster.split(',')
- for server in servers:
- ClusterCleanup.add(server)
- options.servers = servers
-
- if options.placement == "roundRobin":
- options.placement = RoundRobinPlacer
- elif options.placement == "guided":
- if options.placeList is None or not re.match("^[0-9,]+$", options.placeList):
- error("Please specify correctly how many nodes you want to place on each node!")
- sys.exit(1)
- else:
- try:
- options.placeList = map(int, options.placeList.split(","))
- except ValueError:
- error("Please specify the nodes correctly, no comma at the beginning/end!")
- sys.exit(1)
-
- PopulatePlacement(options.placeList)
- options.placement = GuidedPlacer
-
- if options.tunnelType == "ssh":
- options.tunnelType = RemoteNdnLink
- else:
- options.tunnelType = RemoteGRENdnLink
-
- return options
-
-class NdnTopo(Topo):
- def __init__(self, conf_arq, workDir, **opts):
- Topo.__init__(self, **opts)
-
- self.hosts_conf = parse_hosts(conf_arq)
- self.switches_conf = parse_switches(conf_arq)
- self.links_conf = parse_links(conf_arq)
-
- self.isTCLink = False
- self.isLimited = False
-
- for host in self.hosts_conf:
- if host.cpu != None and self.isLimited != True:
- self.isLimited = True
- self.addHost(host.name, app=host.app, params=host.params, cpu=host.cpu,
- cores=host.cores,cache=host.cache, workdir=workDir)
-
- for switch in self.switches_conf:
- self.addSwitch(switch.name)
-
- for link in self.links_conf:
- if len(link.linkDict) == 0:
- self.addLink(link.h1, link.h2)
- else:
- self.addLink(link.h1, link.h2, **link.linkDict)
- self.isTCLink = True
-
- info('Parse of ' + conf_arq + ' done.\n')
-
-def execute(options):
- "Create a network based on template_file"
-
- if options.testbed:
- options.templateFile = INSTALL_DIR + 'minindn.testbed.conf'
-
- if os.path.exists(options.templateFile) == False:
- error('Template file cannot be found. Exiting...\n')
- sys.exit(1)
-
- if options.cluster is not None and options.placement == GuidedPlacer:
- num_nodes = 0
- with open(options.templateFile, 'r') as topo:
- for line in topo:
- if ': _' in line:
- num_nodes += 1
-
- if sum(options.placeList) != num_nodes:
- error("Placement list sum is not equal to number of nodes!")
- sys.exit(1)
-
- # Copy nfd.conf to remote hosts - this assumes that NDN versions across
- # the cluster are at least compatible if not the same
- if options.cluster is not None:
- for server in options.servers:
- if server != "localhost":
- login = "mininet@{}".format(server)
- src = nfdConfFile
- dst = "{}:/tmp/nfd.conf".format(login)
- scp(src, dst)
- ssh(login, "sudo cp /tmp/nfd.conf {}".format(src))
-
- if options.resultDir is not None:
- options.resultDir = createResultsDir(options.resultDir, options.nFaces, options.routingType)
-
- topo = NdnTopo(options.templateFile, options.workDir)
-
- if topo.isTCLink == True and topo.isLimited == True:
- net = Mininet(topo,host=CpuLimitedNdnHost,link=TCLink)
- elif topo.isTCLink == True and topo.isLimited == False:
- if options.cluster is not None:
- mn = partial(MininetCluster, servers=options.servers, placement=options.placement)
- net = mn(topo=topo, host=RemoteNdnHost, link=options.tunnelType)
- else:
- net = Mininet(topo, host=NdnHost, link=TCLink)
- elif topo.isTCLink == False and topo.isLimited == True:
- net = Mininet(topo, host=CpuLimitedNdnHost)
- else:
- net = Mininet(topo, host=NdnHost)
-
- net.start()
-
- # Giving proper IPs to intf so neighbor nodes can communicate
- # This is one way of giving connectivity, another way could be
- # to insert a switch between each pair of neighbors
- ndnNetBase = "1.0.0.0"
- interfaces = []
- for host in net.hosts:
- for intf in host.intfList():
- link = intf.link
- node1, node2 = link.intf1.node, link.intf2.node
-
- if node1 in net.switches or node2 in net.switches:
- continue
-
- if link.intf1 not in interfaces and link.intf2 not in interfaces:
- interfaces.append(link.intf1)
- interfaces.append(link.intf2)
- node1.setIP(ipStr(ipParse(ndnNetBase) + 1) + '/30', intf=link.intf1)
- node2.setIP(ipStr(ipParse(ndnNetBase) + 2) + '/30', intf=link.intf2)
- ndnNetBase = ipStr(ipParse(ndnNetBase) + 4)
-
- time.sleep(2)
-
- info('Starting NFD on nodes\n')
- for host in net.hosts:
- host.nfd = Nfd(host, options.csSize)
- host.nfd.start()
-
- for host in net.hosts:
- if 'app' in host.params:
- if host.params['app'] != '':
- app = host.params['app']
- info("Starting {} on node {}".format(app, host.name))
- info(host.cmd(app))
-
- # Determine if each host is running NFD
- for host in net.hosts:
- nfdStatus = host.cmd("ps -g -U root | grep 'nfd --config {}/[n]fd.conf'".format(host.homeFolder))
- if not host.nfd.isRunning or not nfdStatus:
- error("NFD on host {} is not running. Printing log file and exiting...".format(host.name))
- info(host.cmd("tail {}/nfd.log".format(host.homeFolder)))
- net.stop()
- sys.exit(1)
-
- # Load experiment
- experimentName = options.experimentName
-
- experimentArgs = {
- "net": net,
- "options": options
- }
-
- if experimentName is not None:
- info("Loading experiment: {}\n".format(experimentName))
-
- experiment = ExperimentManager.create(experimentName, experimentArgs)
-
- if experiment is not None:
- experiment.start()
- else:
- error("Experiment '{}' does not exist\n".format(experimentName))
- return
- else:
- experiment = Experiment(experimentArgs)
- if options.isNlsrEnabled:
- experiment.startNlsr(checkConvergence = False)
-
- if options.isCliEnabled is True:
- MiniNDNCLI(net)
-
- net.stop()
-
- if options.resultDir is not None:
- info("Moving results to {}".format(options.resultDir))
- for file in glob.glob('{}/*'.format(options.workDir)):
- shutil.move(file, options.resultDir)
- if options.cluster is not None:
- for server in options.servers:
- if server != "localhost":
- login = "mininet@{}".format(server)
- src = "{}:{}/*".format(login, options.workDir)
- dst = options.resultDir
- scp(src, dst)
- info("Please clean work directories of other machines before running the cluster again")
-
-def signal_handler(signal, frame):
- info('Cleaning up...')
- call(["nfd-stop"])
- call(["sudo", "mn", "--clean"])
- sys.exit(1)
-
-def verify_dependencies():
- "Prevent MiniNDN from running without necessary dependencies"
- dependencies = ["nfd", "nlsr", "infoedit", "ndnping", "ndnpingserver"]
- devnull = open("/dev/null", "w")
- # Checks that each program is in the system path
- for program in dependencies:
- if call(["which", program], stdout=devnull):
- error("{} is missing from the system path! Exiting...".format(program))
- sys.exit(1)
- devnull.close()
-
-if __name__ == '__main__':
-
- signal.signal(signal.SIGQUIT, signal_handler)
-
- options = parse_args()
-
- setLogLevel('info')
- verify_dependencies()
-
- try:
- execute(options)
- except Exception as e:
- error("{}".format(e))
- call(["nfd-stop"])
- call(["sudo", "mn", "--clean"])
- sys.exit(1)
diff --git a/bin/minindnedit b/bin/minindnedit
deleted file mode 100755
index 0bdcb5d..0000000
--- a/bin/minindnedit
+++ /dev/null
@@ -1,1901 +0,0 @@
-# -*- Mode:python; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
-#
-# Copyright (C) 2015-2018, The University of Memphis,
-# Arizona Board of Regents,
-# Regents of the University of California.
-#
-# This file is part of Mini-NDN.
-# See AUTHORS.md for a complete list of Mini-NDN authors and contributors.
-#
-# Mini-NDN is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Mini-NDN is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Mini-NDN, e.g., in COPYING.md file.
-# If not, see .
-#
-# This file incorporates work covered by the following copyright and
-# permission notice:
-#
-# Mininet 2.2.1 License
-#
-# Copyright (c) 2013-2015 Open Networking Laboratory
-# Copyright (c) 2009-2012 Bob Lantz and The Board of Trustees of
-# The Leland Stanford Junior University
-#
-# Original authors: Bob Lantz and Brandon Heller
-#
-# We are making Mininet available for public use and benefit with the
-# expectation that others will use, modify and enhance the Software and
-# contribute those enhancements back to the community. However, since we
-# would like to make the Software available for broadest use, with as few
-# restrictions as possible permission is hereby granted, free of charge, to
-# any person obtaining a copy of this Software to deal in the Software
-# under the copyrights without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included
-# in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#
-# The name and trademarks of copyright holder(s) may NOT be used in
-# advertising or publicity pertaining to the Software or any derivatives
-# without specific, written prior permission.
-
-"""
-MiniNDNEdit: a simple network editor for MiniNDN
-
-Based on miniccnxedit by:
-Carlos Cabral, Jan 2013
-Caio Elias, Nov 2014
-
-Based on miniedit by:
-Bob Lantz, April 2010
-Gregory Gee, July 2013
-
-"""
-
-MINIEDIT_VERSION = '2.2.0.1'
-
-from optparse import OptionParser
-from Tkinter import *
-from ttk import Notebook
-from tkMessageBox import showinfo, showerror, showwarning
-from subprocess import call, Popen
-import tkFont
-import csv
-import tkFileDialog
-import tkSimpleDialog
-import re
-import json
-from distutils.version import StrictVersion
-import os
-import sys
-import threading
-from functools import partial
-
-import pdb
-
-if 'PYTHONPATH' in os.environ:
- sys.path = os.environ[ 'PYTHONPATH' ].split( ':' ) + sys.path
-
-# someday: from ttk import *
-
-from mininet.log import info, error, debug, output, setLogLevel
-from mininet.net import Mininet, VERSION
-from mininet.util import ipStr, netParse, ipAdd, quietRun
-from mininet.util import buildTopo
-from mininet.util import custom
-from mininet.term import makeTerm, cleanUpScreens
-from mininet.node import Controller, RemoteController, NOX, OVSController
-from mininet.node import CPULimitedHost, Host, Node
-from mininet.node import OVSKernelSwitch, OVSSwitch, UserSwitch
-from mininet.link import TCLink, Intf, Link
-from mininet.cli import CLI
-from mininet.moduledeps import moduleDeps, pathCheck
-from mininet.topo import SingleSwitchTopo, LinearTopo, SingleSwitchReversedTopo
-from mininet.topolib import TreeTopo
-
-print 'MiniNDNEdit running...' #+VERSION
-MININET_VERSION = re.sub(r'[^\d\.]', '', VERSION)
-if StrictVersion(MININET_VERSION) > StrictVersion('2.0'):
- from mininet.node import IVSSwitch
-
-
-from ndn.gui import NfdFrame, NlsrFrame
-
-TOPODEF = 'none'
-TOPOS = { 'minimal': lambda: SingleSwitchTopo( k=2 ),
- 'linear': LinearTopo,
- 'reversed': SingleSwitchReversedTopo,
- 'single': SingleSwitchTopo,
- 'none': None,
- 'tree': TreeTopo }
-LINKDEF = 'default'
-LINKS = { 'default': Link,
- 'tc': TCLink }
-HOSTDEF = 'proc'
-HOSTS = { 'proc': Host,
- 'rt': custom( CPULimitedHost, sched='rt' ),
- 'cfs': custom( CPULimitedHost, sched='cfs' ) }
-
-def runMiniNdn(window, template):
- # Hide window
- window.withdraw()
-
- proc = Popen("sudo minindn %s" % template, shell=True)
- proc.wait()
-
- # Restore window
- window.deiconify()
-
-class LegacyRouter( Node ):
-
- def __init__( self, name, inNamespace=True, **params ):
- Node.__init__( self, name, inNamespace, **params )
-
- def config( self, **_params ):
- if self.intfs:
- self.setParam( _params, 'setIP', ip='0.0.0.0' )
- r = Node.config( self, **_params )
- self.cmd('sysctl -w net.ipv4.ip_forward=1')
- return r
-
-class CustomDialog(object):
-
- # TODO: Fix button placement and Title and window focus lock
- def __init__(self, master, title):
- self.top=Toplevel(master)
-
- self.bodyFrame = Frame(self.top)
- self.bodyFrame.grid(row=0, column=0, sticky='nswe')
- self.body(self.bodyFrame)
-
- #return self.b # initial focus
- buttonFrame = Frame(self.top, relief='ridge', bd=3, bg='lightgrey')
- buttonFrame.grid(row=1 , column=0, sticky='nswe')
-
- okButton = Button(buttonFrame, width=8, text='OK', relief='groove',
- bd=4, command=self.okAction)
- okButton.grid(row=1, column=0, sticky=E)
-
- canlceButton = Button(buttonFrame, width=8, text='Cancel', relief='groove',
- bd=4, command=self.cancelAction)
- canlceButton.grid(row=1, column=1, sticky=W)
-
- def body(self, master):
- self.rootFrame = master
-
- def apply(self):
- self.top.destroy()
-
- def cancelAction(self):
- self.top.destroy()
-
- def okAction(self):
- self.apply()
- self.top.destroy()
-
-class HostDialog(CustomDialog):
-
- def __init__(self, master, title, prefDefaults, isRouter):
-
- self.prefValues = prefDefaults
- self.result = None
- self.isRouter = isRouter
- self.title = title
-
- CustomDialog.__init__(self, master, title)
-
- def body(self, master):
- self.rootFrame = master
- n = Notebook(self.rootFrame)
- self.propFrame = Frame(n)
-
- # NDN
- self.nfdFrame = NfdFrame(n, self.prefValues)
- self.nlsrFrame = NlsrFrame(n,self.prefValues)
-
- n.add(self.propFrame, text='Properties')
-
- n.add(self.nfdFrame, text=self.nfdFrame.frameLabel)
- n.add(self.nlsrFrame, text=self.nlsrFrame.frameLabel)
-
- n.pack()
-
- ### TAB 1
- # Field for Hostname
- Label(self.propFrame, text="Hostname:").grid(row=0, sticky=E)
- self.hostnameEntry = Entry(self.propFrame)
- self.hostnameEntry.grid(row=0, column=1)
- if 'hostname' in self.prefValues:
- self.hostnameEntry.insert(0, self.prefValues['hostname'])
-
- # Field for CPU
- Label(self.propFrame, text="Amount CPU:").grid(row=2, sticky=E)
- self.cpuEntry = Entry(self.propFrame)
- self.cpuEntry.grid(row=2, column=1)
- Label(self.propFrame, text="%").grid(row=2, column=2, sticky=W)
- if 'cpu' in self.prefValues:
- self.cpuEntry.insert(0, str(self.prefValues['cpu']))
-
- # Field for Memory
- Label(self.propFrame, text="Amount MEM:").grid(row=3, sticky=E)
- self.memEntry = Entry(self.propFrame)
- self.memEntry.grid(row=3, column=1)
- Label(self.propFrame, text="%").grid(row=3, column=2, sticky=W)
- if 'mem' in self.prefValues:
- self.memEntry.insert(0, str(self.prefValues['mem']))
-
- # Field for Cache
- Label(self.propFrame, text="Amount CACHE:").grid(row=4, sticky=E)
- self.cacheEntry = Entry(self.propFrame)
- self.cacheEntry.grid(row=4, column=1)
- Label(self.propFrame, text="KBytes").grid(row=4, column=2, sticky=W)
- if 'cache' in self.prefValues:
- self.cacheEntry.insert(0, str(self.prefValues['cache']))
-
- # Start command
- #print self.isRouter
- if self.isRouter == 'False':
- Label(self.propFrame, text="Start Command(s):").grid(row=5, sticky=E)
- self.scrollbar = Scrollbar(self.propFrame, orient="horizontal")
- self.startEntry = Entry(self.propFrame, xscrollcommand=self.scrollbar.set,)
- self.startEntry.grid(row=5, column=1)
- self.scrollbar.grid(row=6, column=1, sticky=N+S+E+W)
- self.scrollbar.config(command=self.startEntry.xview)
- Label(self.propFrame, text="[Use bash syntax]").grid(row=5, column=2, sticky=W)
- if 'startCommand' in self.prefValues:
- self.startEntry.insert(0, str(self.prefValues['startCommand']))
- else:
- self.startEntry= Entry(self.propFrame)
-
- def apply(self):
- results = {'cpu': self.cpuEntry.get(),
- 'cache': self.cacheEntry.get(),
- 'mem': self.memEntry.get(),
- 'hostname':self.hostnameEntry.get(),
- 'startCommand':self.startEntry.get(),
- 'nfd': self.nfdFrame.getValues(),
- 'nlsr': self.nlsrFrame.getValues()
- }
-
- self.result = results
-
-class VerticalScrolledTable(LabelFrame):
- """A pure Tkinter scrollable frame that actually works!
-
- * Use the 'interior' attribute to place widgets inside the scrollable frame
- * Construct and pack/place/grid normally
- * This frame only allows vertical scrolling
-
- """
- def __init__(self, parent, rows=2, columns=2, title=None, *args, **kw):
- LabelFrame.__init__(self, parent, text=title, padx=5, pady=5, *args, **kw)
-
- # create a canvas object and a vertical scrollbar for scrolling it
- vscrollbar = Scrollbar(self, orient=VERTICAL)
- vscrollbar.pack(fill=Y, side=RIGHT, expand=FALSE)
- canvas = Canvas(self, bd=0, highlightthickness=0,
- yscrollcommand=vscrollbar.set)
- canvas.pack(side=LEFT, fill=BOTH, expand=TRUE)
- vscrollbar.config(command=canvas.yview)
-
- # reset the view
- canvas.xview_moveto(0)
- canvas.yview_moveto(0)
-
- # create a frame inside the canvas which will be scrolled with it
- self.interior = interior = TableFrame(canvas, rows=rows, columns=columns)
- interior_id = canvas.create_window(0, 0, window=interior,
- anchor=NW)
-
- # track changes to the canvas and frame width and sync them,
- # also updating the scrollbar
- def _configure_interior(event):
- # update the scrollbars to match the size of the inner frame
- size = (interior.winfo_reqwidth(), interior.winfo_reqheight())
- canvas.config(scrollregion="0 0 %s %s" % size)
- if interior.winfo_reqwidth() != canvas.winfo_width():
- # update the canvas's width to fit the inner frame
- canvas.config(width=interior.winfo_reqwidth())
- interior.bind('', _configure_interior)
-
- def _configure_canvas(event):
- if interior.winfo_reqwidth() != canvas.winfo_width():
- # update the inner frame's width to fill the canvas
- canvas.itemconfigure(interior_id, width=canvas.winfo_width())
- canvas.bind('', _configure_canvas)
-
- return
-
-class TableFrame(Frame):
- def __init__(self, parent, rows=2, columns=2):
-
- Frame.__init__(self, parent, background="black")
- self._widgets = []
- self.rows = rows
- self.columns = columns
- for row in range(rows):
- current_row = []
- for column in range(columns):
- label = Entry(self, borderwidth=0)
- label.grid(row=row, column=column, sticky="wens", padx=1, pady=1)
- current_row.append(label)
- self._widgets.append(current_row)
-
- def set(self, row, column, value):
- widget = self._widgets[row][column]
- widget.insert(0, value)
-
- def get(self, row, column):
- widget = self._widgets[row][column]
- return widget.get()
-
- def addRow( self, value=None, readonly=False ):
- #print "Adding row " + str(self.rows +1)
- current_row = []
- for column in range(self.columns):
- label = Entry(self, borderwidth=0)
- label.grid(row=self.rows, column=column, sticky="wens", padx=1, pady=1)
- if value is not None:
- label.insert(0, value[column])
- if (readonly == True):
- label.configure(state='readonly')
- current_row.append(label)
- self._widgets.append(current_row)
- self.update_idletasks()
- self.rows += 1
-
-class LinkDialog(tkSimpleDialog.Dialog):
-
- def __init__(self, parent, title, linkDefaults):
-
- self.linkValues = linkDefaults
-
- tkSimpleDialog.Dialog.__init__(self, parent, title)
-
- def body(self, master):
-
- self.var = StringVar(master)
- Label(master, text="Bandwidth:").grid(row=0, sticky=E)
- self.e1 = Entry(master)
- self.e1.grid(row=0, column=1)
- Label(master, text="[1-1000] Mbps").grid(row=0, column=2, sticky=W)
- if 'bw' in self.linkValues:
- self.e1.insert(0,str(self.linkValues['bw']))
-
- Label(master, text="Delay:").grid(row=1, sticky=E)
- self.e2 = Entry(master)
- self.e2.grid(row=1, column=1)
- Label(master, text="[0-1000] ms").grid(row=1, column=2, sticky=W)
- if 'delay' in self.linkValues:
- self.e2.insert(0, self.linkValues['delay'])
-
- Label(master, text="Loss:").grid(row=2, sticky=E)
- self.e3 = Entry(master)
- self.e3.grid(row=2, column=1)
- Label(master, text="%").grid(row=2, column=2, sticky=W)
- if 'loss' in self.linkValues:
- self.e3.insert(0, str(self.linkValues['loss']))
-
- return self.e1 # initial focus
-
- def apply(self):
- self.result = {}
- if (len(self.e1.get()) > 0):
- self.result['bw'] = int(self.e1.get())
- if (len(self.e2.get()) > 0):
- self.result['delay'] = self.e2.get()
- if (len(self.e3.get()) > 0):
- self.result['loss'] = int(self.e3.get())
-
-class ToolTip(object):
-
- def __init__(self, widget):
- self.widget = widget
- self.tipwindow = None
- self.id = None
- self.x = self.y = 0
-
- def showtip(self, text):
- "Display text in tooltip window"
- self.text = text
- if self.tipwindow or not self.text:
- return
- x, y, cx, cy = self.widget.bbox("insert")
- x = x + self.widget.winfo_rootx() + 27
- y = y + cy + self.widget.winfo_rooty() +27
- self.tipwindow = tw = Toplevel(self.widget)
- tw.wm_overrideredirect(1)
- tw.wm_geometry("+%d+%d" % (x, y))
- try:
- # For Mac OS
- tw.tk.call("::tk::unsupported::MacWindowStyle",
- "style", tw._w,
- "help", "noActivates")
- except TclError:
- pass
- label = Label(tw, text=self.text, justify=LEFT,
- background="#ffffe0", relief=SOLID, borderwidth=1,
- font=("tahoma", "8", "normal"))
- label.pack(ipadx=1)
-
- def hidetip(self):
- tw = self.tipwindow
- self.tipwindow = None
- if tw:
- tw.destroy()
-
-class MiniEdit( Frame ):
-
- "A simple network editor for MiniNDN."
-
- def __init__( self, parent=None, cheight=600, cwidth=1000, template_file='minindn.conf' ):
-
- self.template_file = template_file
-
- Frame.__init__( self, parent )
- self.action = None
- self.appName = 'MiniNDNEdit'
- self.fixedFont = tkFont.Font ( family="DejaVu Sans Mono", size="14" )
-
- # Style
- self.font = ( 'Geneva', 9 )
- self.smallFont = ( 'Geneva', 7 )
- self.bg = 'white'
-
- # Title
- self.top = self.winfo_toplevel()
- self.top.title( self.appName )
-
- # Menu bar
- self.createMenubar()
-
- # Editing canvas
- self.cheight, self.cwidth = cheight, cwidth
- self.cframe, self.canvas = self.createCanvas()
-
- # Toolbar
- self.controllers = {}
-
- # Toolbar
- self.images = miniEditImages()
- self.buttons = {}
- self.active = None
- self.tools = ( 'Select', 'Host', 'Switch', 'NetLink' )
- #self.customColors = { 'LegacyRouter': 'darkGreen', 'Host': 'blue' }
- self.toolbar = self.createToolbar()
-
- # Layout
- self.toolbar.grid( column=0, row=0, sticky='nsew')
- self.cframe.grid( column=1, row=0 )
- self.columnconfigure( 1, weight=1 )
- self.rowconfigure( 0, weight=1 )
- self.pack( expand=True, fill='both' )
-
- # About box
- self.aboutBox = None
-
- # Initialize node data
- self.nodeBindings = self.createNodeBindings()
- self.nodePrefixes = { 'LegacyRouter': 'r', 'Host': 'h', 'Switch': 's'}
- self.widgetToItem = {}
- self.itemToWidget = {}
-
- # Initialize link tool
- self.link = self.linkWidget = None
-
- # Selection support
- self.selection = None
-
- # Keyboard bindings
- self.bind( '', lambda event: self.quit() )
- self.bind( '', self.deleteSelection )
- self.bind( '', self.deleteSelection )
- self.focus()
-
- #Mouse bindings
- self.bind( '', lambda event: self.clearPopups )
-
- self.hostPopup = Menu(self.top, tearoff=0)
- self.hostPopup.add_command(label='Host Options', font=self.font, command=self.hostDetails)
- #self.hostPopup.add_separator()
- #self.hostPopup.add_command(label='Properties', font=self.font, command=self.hostDetails )
-
- self.legacyRouterPopup = Menu(self.top, tearoff=0)
- self.legacyRouterPopup.add_command(label='Router Options', font=self.font, command=self.hostDetails)
-
- self.linkPopup = Menu(self.top, tearoff=0)
- self.linkPopup.add_command(label='Link Options', font=self.font, command=self.linkDetails)
- #self.linkPopup.add_separator()
- #self.linkPopup.add_command(label='Properties', font=self.font, command=self.linkDetails )
-
- # Event handling initalization
- self.linkx = self.linky = self.linkItem = None
- self.lastSelection = None
-
- # Model initialization
- self.links = {}
- self.hostOpts = {}
- self.switchOpts = {}
- self.routerOpts = {}
- self.hostCount = 0
- self.switchCount = 0
- self.routerCount = 0
- self.net = None
-
- # Close window gracefully
- Wm.wm_protocol( self.top, name='WM_DELETE_WINDOW', func=self.quit )
-
- def quit( self ):
- "Stop our network, if any, then quit."
- #sself.stop()
- Frame.quit( self )
-
- def createMenubar( self ): # MODIFICADO - OK
- "Create our menu bar."
-
- font = self.font
-
- mbar = Menu( self.top, font=font )
- self.top.configure( menu=mbar )
-
- fileMenu = Menu( mbar, tearoff=False )
- mbar.add_cascade( label="File", font=font, menu=fileMenu )
- fileMenu.add_command( label="New", font=font, command=self.newTopology )
- fileMenu.add_command( label="Open", font=font, command=self.loadTopology )
- fileMenu.add_command( label="Save", font=font, command=self.saveTopology )
- fileMenu.add_command( label="Generate", font=font, command=self.doGenerate )
- fileMenu.add_command( label="Run", font=font, command=self.doRun )
- fileMenu.add_separator()
- fileMenu.add_command( label='Quit', command=self.quit, font=font )
-
- editMenu = Menu( mbar, tearoff=False )
- mbar.add_cascade( label="Edit", font=font, menu=editMenu )
- editMenu.add_command( label="Cut", font=font,
- command=lambda: self.deleteSelection( None ) )
-
- # Application menu
- appMenu = Menu( mbar, tearoff=False )
- mbar.add_cascade( label=self.appName, font=font, menu=appMenu )
- appMenu.add_command( label='About Mini-NDN', command=self.about,
- font=font)
- #appMenu.add_separator()
- #appMenu.add_command( label='Quit', command=self.quit, font=font )
-
- # Canvas - TUDO IGUAL - OK
-
- def createCanvas( self ):
- "Create and return our scrolling canvas frame."
- f = Frame( self )
-
- canvas = Canvas( f, width=self.cwidth, height=self.cheight,
- bg=self.bg )
-
- # Scroll bars
- xbar = Scrollbar( f, orient='horizontal', command=canvas.xview )
- ybar = Scrollbar( f, orient='vertical', command=canvas.yview )
- canvas.configure( xscrollcommand=xbar.set, yscrollcommand=ybar.set )
-
- # Resize box
- resize = Label( f, bg='white' )
-
- # Layout
- canvas.grid( row=0, column=1, sticky='nsew')
- ybar.grid( row=0, column=2, sticky='ns')
- xbar.grid( row=1, column=1, sticky='ew' )
- resize.grid( row=1, column=2, sticky='nsew' )
-
- # Resize behavior
- f.rowconfigure( 0, weight=1 )
- f.columnconfigure( 1, weight=1 )
- f.grid( row=0, column=0, sticky='nsew' )
- f.bind( '', lambda event: self.updateScrollRegion() )
-
- # Mouse bindings
- canvas.bind( '', self.clickCanvas )
- canvas.bind( '', self.dragCanvas )
- canvas.bind( '', self.releaseCanvas )
-
- return f, canvas
-
- def updateScrollRegion( self ):
- "Update canvas scroll region to hold everything."
- bbox = self.canvas.bbox( 'all' )
- if bbox is not None:
- self.canvas.configure( scrollregion=( 0, 0, bbox[ 2 ],
- bbox[ 3 ] ) )
-
- def canvasx( self, x_root ):
- "Convert root x coordinate to canvas coordinate."
- c = self.canvas
- return c.canvasx( x_root ) - c.winfo_rootx()
-
- def canvasy( self, y_root ):
- "Convert root y coordinate to canvas coordinate."
- c = self.canvas
- return c.canvasy( y_root ) - c.winfo_rooty()
-
- # Toolbar
-
- def activate( self, toolName ): #IGUAL - OK
- "Activate a tool and press its button."
- # Adjust button appearance
- if self.active:
- self.buttons[ self.active ].configure( relief='raised' )
- self.buttons[ toolName ].configure( relief='sunken' )
- # Activate dynamic bindings
- self.active = toolName
-
-
- def createToolTip(self, widget, text): #NOVA - CRIA HINTS E TIPS
- toolTip = ToolTip(widget)
- def enter(event):
- toolTip.showtip(text)
- def leave(event):
- toolTip.hidetip()
- widget.bind('', enter)
- widget.bind('', leave)
-
- def createToolbar( self ): #MODIFICADO - OK
- "Create and return our toolbar frame."
-
- toolbar = Frame( self )
-
- # Tools
- for tool in self.tools:
- cmd = ( lambda t=tool: self.activate( t ) )
- b = Button( toolbar, text=tool, font=self.smallFont, command=cmd)
- if tool in self.images:
- b.config( height=35, image=self.images[ tool ] )
- self.createToolTip(b, str(tool))
- # b.config( compound='top' )
- b.pack( fill='x' )
- self.buttons[ tool ] = b
- self.activate( self.tools[ 0 ] )
-
- # Spacer
- Label( toolbar, text='' ).pack()
-
- # abaixo copiado Mini-NDN para criar botao Generate
-
- for cmd, color in [ ( 'Generate', 'darkGreen' ) ]:
- doCmd = getattr( self, 'do' + cmd )
- b = Button( toolbar, text=cmd, font=self.smallFont,
- fg=color, command=doCmd )
- b.pack( fill='x', side='bottom' )
-
- return toolbar
-
- def doGenerate( self ): #COPIA Mini-NDN - GERA TEMPLATE
- "Generate template."
- self.activate( 'Select' )
- for tool in self.tools:
- self.buttons[ tool ].config( state='disabled' )
-
- self.buildTemplate()
-
- for tool in self.tools:
- self.buttons[ tool ].config( state='normal' )
-
- toplevel = Toplevel()
- label1 = Label(toplevel, text="Template file generated successfully", height=0, width=30)
- label1.pack()
- b=Button(toplevel, text="Ok", width=5, command=toplevel.destroy)
- b.pack(side='bottom', padx=0,pady=0)
-
- def doRun( self ):
- "Use current configuration to generate a template and run the topology"
-
- # Generate temporary template file
- old_template_file = self.template_file
- self.template_file = "/tmp/tmp.conf"
- self.doGenerate()
-
- thread = threading.Thread(target=runMiniNdn, args=(self.master, self.template_file))
- thread.start()
-
- self.template_file = old_template_file
-
- def buildTemplate( self ): #COPIA Mini-NDN para criar Template
- "Generate template"
-
- template = open(self.template_file, 'w')
-
- # hosts
- template.write('[nodes]\n')
- for widget in self.widgetToItem:
- name = widget[ 'text' ]
- tags = self.canvas.gettags( self.widgetToItem[ widget ] )
-
- if 'Host' in tags:
- hOpts=self.hostOpts[name]
- print hOpts
-
- template.write(name + ': ')
- if 'startCommand' in hOpts:
- cmds = hOpts['startCommand'].replace("\"", "\\\"")
- template.write('apps="%s" ' % cmds)
- else:
- template.write('_ ')
- if 'cache' in hOpts:
- template.write('cache=' + hOpts['cache'] + ' ')
- if 'cpu' in hOpts:
- cpu=float(hOpts['cpu'])/100
- template.write('cpu=' + repr(cpu) + ' ')
- if 'mem' in hOpts:
- mem=float(hOpts['mem'])/100
- template.write('mem=' + repr(mem) + ' ')
- if 'nlsr' in hOpts:
- values = hOpts['nlsr']
-
- template.write('hyperbolic-state=' + values['hyperbolic-state'] + ' ')
- template.write('radius=' + values['radius'] + ' ')
- template.write('angle=' + values['angle'] + ' ')
- template.write('network=' + values['network'] + ' ')
- template.write('router=' + values['router'] + ' ')
- template.write('site=' + values['site'] + ' ')
- template.write('nlsr-log-level=' + values['log-level'] + ' ')
- template.write('max-faces-per-prefix=' + values['max-faces-per-prefix'] + ' ')
- if 'nfd' in hOpts:
- values = hOpts['nfd']
-
- template.write('nfd-log-level=' + values['log-level'] + ' ')
-
- template.write('\n')
-
- # switches/routers
- #template.write('[routers]\n')
-
- for router in self.routerOpts.values():
-
- hasOpt='False'
- routerName=router['hostname']
- #nodetype=router['nodetype']
- #nodenum=router['nodenum']
-
- rOpts=self.routerOpts[routerName]
-
- template.write(routerName + ': ')
-
- if 'cpu' in rOpts:
- cpu=float(rOpts['cpu'])/100
- template.write('cpu=' + repr(cpu) + ' ')
- hasOpt='True'
- if 'mem' in rOpts:
- mem=float(rOpts['mem'])/100
- template.write('mem=' + repr(mem) + ' ')
- hasOpt='True'
- if 'cache' in rOpts:
- template.write('cache=' + rOpts['cache'] + ' ')
- hasOpt='True'
- if hasOpt == 'False':
- template.write('_')
-
- template.write('\n')
-
- # Write switches
- template.write('[switches]\n')
-
- for switch in self.switchOpts.values():
- print "Switch%s" % switch
-
- name = switch['hostname']
- template.write(name + ': _\n')
-
- # Make links
- template.write('[links]\n')
- for link in self.links.values():
- dst=link['dest']
- src=link['src']
- linkopts=link['linkOpts']
- linktype=link['type']
-
- srcName, dstName = src[ 'text' ], dst[ 'text' ]
- template.write(srcName + ':' + dstName + ' ')
- if 'bw' in linkopts:
- template.write('bw=' + str(linkopts['bw']) + ' ' )
- if 'loss' in linkopts:
- template.write('loss=' + repr(linkopts['loss']) + ' ' )
- if 'delay' in linkopts:
- template.write('delay=' + str(linkopts['delay'])+ 'ms' )
-
- template.write('\n')
-
- template.close()
-
- def addNode( self, node, nodeNum, x, y, name=None):
- "Add a new node to our canvas."
-
- if 'LegacyRouter' == node:
- self.routerCount += 1
- if 'Host' == node:
- self.hostCount += 1
- if 'Switch' == node:
- self.switchCount += 1
- if name is None:
- name = self.nodePrefixes[ node ] + nodeNum
- self.addNamedNode(node, name, x, y)
-
- def addNamedNode( self, node, name, x, y):
- "Add a new node to our canvas."
- c = self.canvas
- icon = self.nodeIcon( node, name )
- item = self.canvas.create_window( x, y, anchor='c', window=icon,
- tags=node )
- self.widgetToItem[ icon ] = item
- self.itemToWidget[ item ] = icon
- icon.links = {}
-
- def convertJsonUnicode(self, input):
- "Some part of Mininet don't like Unicode"
- if isinstance(input, dict):
- return {self.convertJsonUnicode(key): self.convertJsonUnicode(value) for key, value in input.iteritems()}
- elif isinstance(input, list):
- return [self.convertJsonUnicode(element) for element in input]
- elif isinstance(input, unicode):
- return input.encode('utf-8')
- else:
- return input
-
- def loadTopology( self ):
- "Load command."
- c = self.canvas
-
- myFormats = [
- ('MiniNDN Topology','*.mnndn'),
- ('All Files','*'),
- ]
- f = tkFileDialog.askopenfile(filetypes=myFormats, mode='rb')
- if f == None:
- return
- self.newTopology()
- loadedTopology = self.convertJsonUnicode(json.load(f))
-
- # Load hosts
- hosts = loadedTopology['hosts']
- for host in hosts:
- nodeNum = host['number']
- hostname = 'h'+nodeNum
- if 'hostname' in host['opts']:
- hostname = host['opts']['hostname']
- else:
- host['opts']['hostname'] = hostname
- if 'nodeNum' not in host['opts']:
- host['opts']['nodeNum'] = int(nodeNum)
-
- x = host['x']
- y = host['y']
-
- self.addNode('Host', nodeNum, float(x), float(y), name=hostname)
-
- # Fix JSON converting tuple to list when saving
- if 'privateDirectory' in host['opts']:
- newDirList = []
- for privateDir in host['opts']['privateDirectory']:
- if isinstance( privateDir, list ):
- newDirList.append((privateDir[0],privateDir[1]))
- else:
- newDirList.append(privateDir)
- host['opts']['privateDirectory'] = newDirList
- self.hostOpts[hostname] = host['opts']
- icon = self.findWidgetByName(hostname)
- icon.bind('', self.do_hostPopup )
-
- # Load routers
- routers = loadedTopology['routers']
- for router in routers:
- nodeNum = router['number']
- hostname = 'r'+nodeNum
- #print router
- if 'nodeType' not in router['opts']:
- router['opts']['nodeType'] = 'legacyRouter'
- if 'hostname' in router['opts']:
- hostname = router['opts']['hostname']
- else:
- router['opts']['hostname'] = hostname
- if 'nodeNum' not in router['opts']:
- router['opts']['nodeNum'] = int(nodeNum)
- x = router['x']
- y = router['y']
- if router['opts']['nodeType'] == "legacyRouter":
- self.addNode('LegacyRouter', nodeNum, float(x), float(y), name=hostname)
- icon = self.findWidgetByName(hostname)
- icon.bind('', self.do_legacyRouterPopup )
- self.routerOpts[hostname] = router['opts']
-
- # Load switches
- switches = loadedTopology['switches']
-
- for switch in switches:
- nodeNum = switch['number']
- hostname = 's' + nodeNum
-
- if 'hostname' in switch['opts']:
- hostname = switch['opts']['hostname']
- else:
- switch['opts']['hostname'] = hostname
-
- if 'nodeNum' not in switch['opts']:
- switch['opts']['nodeNum'] = int(nodeNum)
-
- x = switch['x']
- y = switch['y']
-
- self.addNode('Switch', nodeNum, float(x), float(y), name=hostname)
- icon = self.findWidgetByName(hostname)
-
- self.switchOpts[hostname] = switch['opts']
-
- # Load links
- links = loadedTopology['links']
- for link in links:
- srcNode = link['src']
- src = self.findWidgetByName(srcNode)
- sx, sy = self.canvas.coords( self.widgetToItem[ src ] )
-
- destNode = link['dest']
- dest = self.findWidgetByName(destNode)
- dx, dy = self.canvas.coords( self.widgetToItem[ dest ] )
-
- self.link = self.canvas.create_line( sx, sy, dx, dy, width=4,
- fill='blue', tag='link' )
- c.itemconfig(self.link, tags=c.gettags(self.link)+('data',))
- self.addLink( src, dest, linkopts=link['opts'] )
- self.createDataLinkBindings()
- self.link = self.linkWidget = None
-
- f.close
-
- def findWidgetByName( self, name ):
- for widget in self.widgetToItem:
- if name == widget[ 'text' ]:
- return widget
-
- def newTopology( self ):
- "New command."
- for widget in self.widgetToItem.keys():
- self.deleteItem( self.widgetToItem[ widget ] )
- self.hostCount = 0
- self.routerCount = 0
- self.switchCount = 0
- self.links = {}
- self.hostOpts = {}
- self.routerOpts = {}
-
- def saveTopology( self ):
- "Save command."
- myFormats = [
- ('MiniNDN Topology','*.mnndn'),
- ('All Files','*'),
- ]
-
- savingDictionary = {}
- fileName = tkFileDialog.asksaveasfilename(filetypes=myFormats ,title="Save the topology as...")
- if len(fileName ) > 0:
- # Save Application preferences
- savingDictionary['version'] = '2'
-
- # Save routers and Hosts
- hostsToSave = []
- routersToSave = []
- switchesToSave = []
-
- for widget in self.widgetToItem:
- name = widget[ 'text' ]
- tags = self.canvas.gettags( self.widgetToItem[ widget ] )
- x1, y1 = self.canvas.coords( self.widgetToItem[ widget ] )
- if 'LegacyRouter' in tags:
- nodeNum = self.routerOpts[name]['nodeNum']
- nodeToSave = {'number':str(nodeNum),
- 'x':str(x1),
- 'y':str(y1),
- 'opts':self.routerOpts[name] }
- routersToSave.append(nodeToSave)
- elif 'Host' in tags:
- nodeNum = self.hostOpts[name]['nodeNum']
- nodeToSave = {'number':str(nodeNum),
- 'x':str(x1),
- 'y':str(y1),
- 'opts':self.hostOpts[name] }
- hostsToSave.append(nodeToSave)
- elif 'Switch' in tags:
- nodeNum = self.switchOpts[name]['nodeNum']
- nodeToSave = {'number':str(nodeNum),
- 'x':str(x1),
- 'y':str(y1),
- 'opts':self.switchOpts[name] }
- switchesToSave.append(nodeToSave)
- else:
- raise Exception( "Cannot create mystery node: " + name )
- savingDictionary['hosts'] = hostsToSave
- savingDictionary['routers'] = routersToSave
- savingDictionary['switches'] = switchesToSave
-
- # Save Links
- linksToSave = []
- for link in self.links.values():
- src = link['src']
- dst = link['dest']
- linkopts = link['linkOpts']
-
- srcName, dstName = src[ 'text' ], dst[ 'text' ]
- linkToSave = {'src':srcName,
- 'dest':dstName,
- 'opts':linkopts}
- if link['type'] == 'data':
- linksToSave.append(linkToSave)
- savingDictionary['links'] = linksToSave
-
- # Save Application preferences
- #savingDictionary['application'] = self.appPrefs
-
- try:
- f = open(fileName, 'wb')
- f.write(json.dumps(savingDictionary, sort_keys=True, indent=4, separators=(',', ': ')))
- except Exception as er:
- print er
- finally:
- f.close()
-
- # Generic canvas handler
- #
- # We could have used bindtags, as in nodeIcon, but
- # the dynamic approach used here
- # may actually require less code. In any case, it's an
- # interesting introspection-based alternative to bindtags.
-
- def canvasHandle( self, eventName, event ):
- "Generic canvas event handler"
- if self.active is None:
- return
- toolName = self.active
- handler = getattr( self, eventName + toolName, None )
- if handler is not None:
- handler( event )
-
- def clickCanvas( self, event ):
- "Canvas click handler."
- self.canvasHandle( 'click', event )
-
- def dragCanvas( self, event ):
- "Canvas drag handler."
- self.canvasHandle( 'drag', event )
-
- def releaseCanvas( self, event ):
- "Canvas mouse up handler."
- self.canvasHandle( 'release', event )
-
- # Currently the only items we can select directly are
- # links. Nodes are handled by bindings in the node icon.
-
- def findItem( self, x, y ):
- "Find items at a location in our canvas."
- items = self.canvas.find_overlapping( x, y, x, y )
- if len( items ) == 0:
- return None
- else:
- return items[ 0 ]
-
- # Canvas bindings for Select, Host, Router and Link tools
-
- def clickSelect( self, event ):
- "Select an item."
- self.selectItem( self.findItem( event.x, event.y ) )
-
- def deleteItem( self, item ):
- "Delete an item."
- # Don't delete while network is running
- if self.buttons[ 'Select' ][ 'state' ] == 'disabled':
- return
- # Delete from model
- if item in self.links:
- self.deleteLink( item )
- if item in self.itemToWidget:
- self.deleteNode( item )
- # Delete from view
- self.canvas.delete( item )
-
- def deleteSelection( self, _event ):
- "Delete the selected item."
- if self.selection is not None:
- self.deleteItem( self.selection )
- self.selectItem( None )
-
- def clearPopups(self):
- print 'Entrou funcao clear_popups'
- if isHostPopup == True:
- print 'Hostpopup = true'
- self.hostPopup.unpost
- isHostPopup = False
- #if isRouterPopup == True
- #if isLinkPopup == True
-
- def nodeIcon( self, node, name ):
- "Create a new node icon."
- icon = Button( self.canvas, image=self.images[ node ],
- text=name, compound='top' )
- # Unfortunately bindtags wants a tuple
- bindtags = [ str( self.nodeBindings ) ]
- bindtags += list( icon.bindtags() )
- icon.bindtags( tuple( bindtags ) )
- return icon
-
- def newNode( self, node, event ):
- "Add a new node to our canvas."
- c = self.canvas
- x, y = c.canvasx( event.x ), c.canvasy( event.y )
- name = self.nodePrefixes[ node ]
-
- if 'LegacyRouter' == node:
- self.routerCount += 1
- name = self.nodePrefixes[ node ] + str( self.routerCount )
- self.routerOpts[name] = {}
- self.routerOpts[name]['nodeNum']=self.routerCount
- self.routerOpts[name]['hostname']=name
- self.routerOpts[name]['nodeType']='legacyRouter'
-
- if 'Host' == node:
- self.hostCount += 1
- name = self.nodePrefixes[ node ] + str( self.hostCount )
- self.hostOpts[name] = {'sched':'host'}
- self.hostOpts[name]['nodeNum']=self.hostCount
- self.hostOpts[name]['hostname']=name
-
- if 'Switch' == node:
- self.switchCount += 1
- name = self.nodePrefixes[ node ] + str( self.switchCount )
- self.switchOpts[name] = {}
- self.switchOpts[name]['nodeNum']=self.switchCount
- self.switchOpts[name]['hostname']=name
-
- icon = self.nodeIcon( node, name )
- item = self.canvas.create_window( x, y, anchor='c', window=icon,
- tags=node )
- self.widgetToItem[ icon ] = item
- self.itemToWidget[ item ] = icon
- self.selectItem( item )
- icon.links = {}
- if 'LegacyRouter' == node:
- icon.bind('', self.do_legacyRouterPopup )
- if 'Host' == node:
- icon.bind('', self.do_hostPopup )
-
- def clickHost( self, event ):
- "Add a new host to our canvas."
- self.newNode( 'Host', event )
-
- def clickSwitch( self, event ):
- "Add a new switch to the canvas."
- self.newNode( 'Switch', event )
-
- def clickLegacyRouter( self, event ):
- "Add a new router to our canvas."
- self.newNode( 'LegacyRouter', event )
-
- def dragNetLink( self, event ):
- "Drag a link's endpoint to another node."
- if self.link is None:
- return
- # Since drag starts in widget, we use root coords
- x = self.canvasx( event.x_root )
- y = self.canvasy( event.y_root )
- c = self.canvas
- c.coords( self.link, self.linkx, self.linky, x, y )
-
- def releaseNetLink( self, _event ):
- "Give up on the current link."
- if self.link is not None:
- self.canvas.delete( self.link )
- self.linkWidget = self.linkItem = self.link = None
-
- # Generic node handlers
-
- def createNodeBindings( self ):
- "Create a set of bindings for nodes."
- bindings = {
- '': self.clickNode,
- '': self.dragNode,
- '': self.releaseNode,
- '': self.enterNode,
- '': self.leaveNode
- }
- l = Label() # lightweight-ish owner for bindings
- for event, binding in bindings.items():
- l.bind( event, binding )
- return l
-
- def selectItem( self, item ):
- "Select an item and remember old selection."
- self.lastSelection = self.selection
- self.selection = item
-
- def enterNode( self, event ):
- "Select node on entry."
- self.selectNode( event )
-
- def leaveNode( self, _event ):
- "Restore old selection on exit."
- self.selectItem( self.lastSelection )
-
- def clickNode( self, event ):
- "Node click handler."
- if self.active is 'NetLink':
- self.startLink( event )
- else:
- self.selectNode( event )
- return 'break'
-
- def dragNode( self, event ):
- "Node drag handler."
- if self.active is 'NetLink':
- self.dragNetLink( event )
- else:
- self.dragNodeAround( event )
-
- def releaseNode( self, event ):
- "Node release handler."
- if self.active is 'NetLink':
- self.finishLink( event )
-
- # Specific node handlers
-
- def selectNode( self, event ):
- "Select the node that was clicked on."
- item = self.widgetToItem.get( event.widget, None )
- self.selectItem( item )
-
- def dragNodeAround( self, event ):
- "Drag a node around on the canvas."
- c = self.canvas
- # Convert global to local coordinates;
- # Necessary since x, y are widget-relative
- x = self.canvasx( event.x_root )
- y = self.canvasy( event.y_root )
- w = event.widget
- # Adjust node position
- item = self.widgetToItem[ w ]
- c.coords( item, x, y )
- # Adjust link positions
- for dest in w.links:
- link = w.links[ dest ]
- item = self.widgetToItem[ dest ]
- x1, y1 = c.coords( item )
- c.coords( link, x, y, x1, y1 )
- self.updateScrollRegion()
-
- def createDataLinkBindings( self ):
- "Create a set of bindings for nodes."
- # Link bindings
- # Selection still needs a bit of work overall
- # Callbacks ignore event
-
- def select( _event, link=self.link ):
- "Select item on mouse entry."
- self.selectItem( link )
-
- def highlight( _event, link=self.link ):
- "Highlight item on mouse entry."
- self.selectItem( link )
- self.canvas.itemconfig( link, fill='green' )
-
- def unhighlight( _event, link=self.link ):
- "Unhighlight item on mouse exit."
- self.canvas.itemconfig( link, fill='blue' )
- #self.selectItem( None )
-
- self.canvas.tag_bind( self.link, '', highlight )
- self.canvas.tag_bind( self.link, '', unhighlight )
- self.canvas.tag_bind( self.link, '', select )
- self.canvas.tag_bind( self.link, '', self.do_linkPopup )
-
- def startLink( self, event ):
- "Start a new link."
- if event.widget not in self.widgetToItem:
- # Didn't click on a node
- return
-
- w = event.widget
- item = self.widgetToItem[ w ]
- x, y = self.canvas.coords( item )
- self.link = self.canvas.create_line( x, y, x, y, width=4,
- fill='blue', tag='link' )
- self.linkx, self.linky = x, y
- self.linkWidget = w
- self.linkItem = item
-
- def finishLink( self, event ):
- "Finish creating a link"
- if self.link is None:
- return
- source = self.linkWidget
- c = self.canvas
- # Since we dragged from the widget, use root coords
- x, y = self.canvasx( event.x_root ), self.canvasy( event.y_root )
- target = self.findItem( x, y )
- dest = self.itemToWidget.get( target, None )
- if ( source is None or dest is None or source == dest
- or dest in source.links or source in dest.links ):
- self.releaseNetLink( event )
- return
- # For now, don't allow hosts to be directly linked
- stags = self.canvas.gettags( self.widgetToItem[ source ] )
- dtags = self.canvas.gettags( target )
- #if (('Host' in stags and 'Host' in dtags)):
- #self.releaseNetLink( event )
- #return
-
- # Set link type
- linkType='data'
-
- self.createDataLinkBindings()
- c.itemconfig(self.link, tags=c.gettags(self.link)+(linkType,))
-
- x, y = c.coords( target )
- c.coords( self.link, self.linkx, self.linky, x, y )
- self.addLink( source, dest, linktype=linkType )
-
- # We're done
- self.link = self.linkWidget = None
-
- # Menu handlers
-
- def about( self ):
- "Display about box."
- about = self.aboutBox
- if about is None:
- bg = 'white'
- about = Toplevel( bg='white' )
- about.title( 'About' )
- info = self.appName + ': a simple network editor for MiniNDN - based on Miniedit'
- warning = 'Development version - not entirely functional!'
- #version = 'MiniEdit '+MINIEDIT_VERSION
- author = 'Vince Lehman, Jan 2015'
- author2 = 'Ashlesh Gawande, Jan 2015'
- author3 = 'Carlos Cabral, Jan 2013'
- author4 = 'Caio Elias, Nov 2014'
- author5 = 'Originally by: Bob Lantz , April 2010'
- enhancements = 'Enhancements by: Gregory Gee, Since July 2013'
- www = 'http://gregorygee.wordpress.com/category/miniedit/'
- line1 = Label( about, text=info, font='Helvetica 10 bold', bg=bg )
- line2 = Label( about, text=warning, font='Helvetica 9', bg=bg )
- line3 = Label( about, text=author, font='Helvetica 9', bg=bg )
- line4 = Label( about, text=author2, font='Helvetica 9', bg=bg )
- line5 = Label( about, text=author3, font='Helvetica 9', bg=bg )
- line6 = Label( about, text=author4, font='Helvetica 9', bg=bg )
- line7 = Label( about, text=author5, font='Helvetica 9', bg=bg )
- line8 = Label( about, text=enhancements, font='Helvetica 9', bg=bg )
- line9 = Entry( about, font='Helvetica 9', bg=bg, width=len(www), justify=CENTER )
-
-
- line9.insert(0, www)
- line9.configure(state='readonly')
- line1.pack( padx=20, pady=10 )
- line2.pack(pady=10 )
- line3.pack(pady=10 )
- line4.pack(pady=10 )
- line5.pack(pady=10 )
- line6.pack(pady=10 )
- line7.pack(pady=10 )
- line8.pack(pady=10 )
- line9.pack(pady=10 )
- hide = ( lambda about=about: about.withdraw() )
- self.aboutBox = about
- # Hide on close rather than destroying window
- Wm.wm_protocol( about, name='WM_DELETE_WINDOW', func=hide )
- # Show (existing) window
- about.deiconify()
-
- def createToolImages( self ):
- "Create toolbar (and icon) images."
-
- def hostDetails( self, _ignore=None ):
- if ( self.selection is None or
- self.net is not None or
- self.selection not in self.itemToWidget ):
- return
- widget = self.itemToWidget[ self.selection ]
- name = widget[ 'text' ]
- tags = self.canvas.gettags( self.selection )
-
- #print tags
- if 'Host' in tags:
-
- prefDefaults = self.hostOpts[name]
- hostBox = HostDialog(self, title='Host Details', prefDefaults=prefDefaults, isRouter='False')
- self.master.wait_window(hostBox.top)
- if hostBox.result:
- newHostOpts = {'nodeNum':self.hostOpts[name]['nodeNum']}
-
- if len(hostBox.result['startCommand']) > 0:
- newHostOpts['startCommand'] = hostBox.result['startCommand']
- if hostBox.result['cpu']:
- newHostOpts['cpu'] = hostBox.result['cpu']
- if hostBox.result['mem']:
- newHostOpts['mem'] = hostBox.result['mem']
- if len(hostBox.result['hostname']) > 0:
- newHostOpts['hostname'] = hostBox.result['hostname']
- name = hostBox.result['hostname']
- widget[ 'text' ] = name
- if len(hostBox.result['cache']) > 0:
- newHostOpts['cache'] = hostBox.result['cache']
-
- newHostOpts['nlsr'] = hostBox.nlsrFrame.getValues()
- newHostOpts['nfd'] = hostBox.nfdFrame.getValues()
-
- self.hostOpts[name] = newHostOpts
-
- print 'New host details for ' + name + ' = ' + str(newHostOpts)
-
- elif 'LegacyRouter' in tags:
-
- prefDefaults = self.routerOpts[name]
- hostBox = HostDialog(self, title='Router Details', prefDefaults=prefDefaults, isRouter='True')
- self.master.wait_window(hostBox.top)
- if hostBox.result:
- newRouterOpts = {'nodeNum':self.routerOpts[name]['nodeNum']}
-
- if hostBox.result['cpu']:
- newRouterOpts['cpu'] = hostBox.result['cpu']
- if hostBox.result['mem']:
- newRouterOpts['mem'] = hostBox.result['mem']
- if len(hostBox.result['hostname']) > 0:
- newRouterOpts['hostname'] = hostBox.result['hostname']
- name = hostBox.result['hostname']
- widget[ 'text' ] = name
- if len(hostBox.result['cache']) > 0:
- newRouterOpts['cache'] = hostBox.result['cache']
- self.routerOpts[name] = newRouterOpts
-
- print 'New host details for ' + name + ' = ' + str(newRouterOpts)
-
- def linkDetails( self, _ignore=None ):
- if ( self.selection is None or
- self.net is not None):
- return
- link = self.selection
-
- linkDetail = self.links[link]
- src = linkDetail['src']
- dest = linkDetail['dest']
- linkopts = linkDetail['linkOpts']
- linkBox = LinkDialog(self, title='Link Details', linkDefaults=linkopts)
- if linkBox.result is not None:
- linkDetail['linkOpts'] = linkBox.result
- print 'New link details = ' + str(linkBox.result)
-
- # Model interface
- #
- # Ultimately we will either want to use a topo or
- # mininet object here, probably.
-
- def addLink( self, source, dest, linktype='data', linkopts={} ):
- "Add link to model."
- source.links[ dest ] = self.link
- dest.links[ source ] = self.link
- self.links[ self.link ] = {'type' :linktype,
- 'src':source,
- 'dest':dest,
- 'linkOpts':linkopts}
-
- def deleteLink( self, link ):
- "Delete link from model."
- pair = self.links.get( link, None )
- if pair is not None:
- source=pair['src']
- dest=pair['dest']
- del source.links[ dest ]
- del dest.links[ source ]
- stags = self.canvas.gettags( self.widgetToItem[ source ] )
- dtags = self.canvas.gettags( self.widgetToItem[ dest ] )
- ltags = self.canvas.gettags( link )
-
- if link is not None:
- del self.links[ link ]
-
- def deleteNode( self, item ):
- "Delete node (and its links) from model."
-
- widget = self.itemToWidget[ item ]
- tags = self.canvas.gettags(item)
-
- for link in widget.links.values():
- # Delete from view and model
- self.deleteItem( link )
- del self.itemToWidget[ item ]
- del self.widgetToItem[ widget ]
-
- def do_linkPopup(self, event):
- # display the popup menu
- if ( self.net is None ):
- try:
- self.linkPopup.tk_popup(event.x_root, event.y_root)
- finally:
- # make sure to release the grab (Tk 8.0a1 only)
- self.linkPopup.grab_release()
-
- def do_legacyRouterPopup(self, event):
- # display the popup menu
- if ( self.net is None ):
- try:
- self.legacyRouterPopup.tk_popup(event.x_root, event.y_root)
- finally:
- # make sure to release the grab (Tk 8.0a1 only)
- self.legacyRouterPopup.grab_release()
-
- def do_hostPopup(self, event):
- # display the popup menu
- if ( self.net is None ):
- try:
- self.hostPopup.tk_popup(event.x_root, event.y_root)
- isHostPopup = True
- finally:
- # make sure to release the grab (Tk 8.0a1 only)
- self.hostPopup.grab_release()
-
- def xterm( self, _ignore=None ):
- "Make an xterm when a button is pressed."
- if ( self.selection is None or
- self.net is None or
- self.selection not in self.itemToWidget ):
- return
- name = self.itemToWidget[ self.selection ][ 'text' ]
- if name not in self.net.nameToNode:
- return
- term = makeTerm( self.net.nameToNode[ name ], 'Host', term=self.appPrefs['terminalType'] )
- if StrictVersion(MININET_VERSION) > StrictVersion('2.0'):
- self.net.terms += term
- else:
- self.net.terms.append(term)
-
- def iperf( self, _ignore=None ):
- "Make an xterm when a button is pressed."
- if ( self.selection is None or
- self.net is None or
- self.selection not in self.itemToWidget ):
- return
- name = self.itemToWidget[ self.selection ][ 'text' ]
- if name not in self.net.nameToNode:
- return
- self.net.nameToNode[ name ].cmd( 'iperf -s -p 5001 &' )
-
- """ BELOW HERE IS THE TOPOLOGY IMPORT CODE """
-
- def parseArgs( self ):
- """Parse command-line args and return options object.
- returns: opts parse options dict"""
-
- if '--custom' in sys.argv:
- index = sys.argv.index( '--custom' )
- if len( sys.argv ) > index + 1:
- filename = sys.argv[ index + 1 ]
- self.parseCustomFile( filename )
- else:
- raise Exception( 'Custom file name not found' )
-
- desc = ( "The %prog utility creates Minindn network from the\n"
- "command line. It can create parametrized topologies,\n"
- "invoke the Minindn CLI, and run tests." )
-
- usage = ( '%prog [options] [template_file]\n'
- '\nIf no template_file is given, generated template will be written to the file minindn.conf in the current directory.\n'
- 'Type %prog -h for details)' )
-
- opts = OptionParser( description=desc, usage=usage )
-
- addDictOption( opts, TOPOS, TOPODEF, 'topo' )
- addDictOption( opts, LINKS, LINKDEF, 'link' )
-
- opts.add_option( '--custom', type='string', default=None,
- help='read custom topo and node params from .py' +
- 'file' )
-
- self.options, self.args = opts.parse_args()
- # We don't accept extra arguments after the options
- if self.args:
- if len(self.args) > 1:
- opts.print_help()
- exit()
- else:
- self.template_file=self.args[0]
-
- def setCustom( self, name, value ):
- "Set custom parameters for MininetRunner."
- if name in ( 'topos', 'switches', 'hosts', 'controllers' ):
- # Update dictionaries
- param = name.upper()
- globals()[ param ].update( value )
- elif name == 'validate':
- # Add custom validate function
- self.validate = value
- else:
- # Add or modify global variable or class
- globals()[ name ] = value
-
- def parseCustomFile( self, fileName ):
- "Parse custom file and add params before parsing cmd-line options."
- customs = {}
- if os.path.isfile( fileName ):
- execfile( fileName, customs, customs )
- for name, val in customs.iteritems():
- self.setCustom( name, val )
- else:
- raise Exception( 'could not find custom file: %s' % fileName )
-
- def importTopo( self ):
- print 'topo='+self.options.topo
- if self.options.topo == 'none':
- return
- self.newTopology()
- topo = buildTopo( TOPOS, self.options.topo )
- link = customConstructor( LINKS, self.options.link )
- importNet = Mininet(topo=topo, build=False, link=link)
- importNet.build()
-
- c = self.canvas
- rowIncrement = 100
- currentY = 100
-
- # Add switches
- print 'switches:'+str(len(importNet.switches))
- columnCount = 0
- for switch in importNet.switches:
- name = switch.name
- self.switchOpts[name] = {}
- self.switchOpts[name]['nodeNum']=self.switchCount
- self.switchOpts[name]['hostname']=name
- self.switchOpts[name]['switchType']='default'
- self.switchOpts[name]['controllers']=[]
-
- x = columnCount*100+100
- self.addNode('Switch', self.switchCount,
- float(x), float(currentY), name=name)
- icon = self.findWidgetByName(name)
- icon.bind('', self.do_switchPopup )
-
- if columnCount == 9:
- columnCount = 0
- currentY = currentY + rowIncrement
- else:
- columnCount =columnCount+1
-
- currentY = currentY + rowIncrement
- # Add hosts
- print 'hosts:'+str(len(importNet.hosts))
- columnCount = 0
- for host in importNet.hosts:
- name = host.name
- self.hostOpts[name] = {'sched':'host'}
- self.hostOpts[name]['nodeNum']=self.hostCount
- self.hostOpts[name]['hostname']=name
- #self.hostOpts[name]['ip']=host.IP()
-
- x = columnCount*100+100
- self.addNode('Host', self.hostCount,
- float(x), float(currentY), name=name)
- icon = self.findWidgetByName(name)
- icon.bind('', self.do_hostPopup )
- if columnCount == 9:
- columnCount = 0
- currentY = currentY + rowIncrement
- else:
- columnCount =columnCount+1
-
- print 'links:'+str(len(topo.links()))
- #[('h1', 's3'), ('h2', 's4'), ('s3', 's4')]
- for link in topo.links():
- print str(link)
- srcNode = link[0]
- src = self.findWidgetByName(srcNode)
- sx, sy = self.canvas.coords( self.widgetToItem[ src ] )
-
- destNode = link[1]
- dest = self.findWidgetByName(destNode)
- dx, dy = self.canvas.coords( self.widgetToItem[ dest] )
-
- params = topo.linkInfo( srcNode, destNode )
- print 'Link Parameters='+str(params)
-
- self.link = self.canvas.create_line( sx, sy, dx, dy, width=4,
- fill='blue', tag='link' )
- c.itemconfig(self.link, tags=c.gettags(self.link)+('data',))
- self.addLink( src, dest, linkopts=params )
- self.createDataLinkBindings()
- self.link = self.linkWidget = None
-
- importNet.stop()
-
-def miniEditImages():
- "Create and return images for MiniEdit."
-
- # Image data. Git will be unhappy. However, the alternative
- # is to keep track of separate binary files, which is also
- # unappealing.
-
- return {
- 'Select': BitmapImage(
- file='/usr/include/X11/bitmaps/left_ptr' ),
-
- 'LegacyRouter': PhotoImage( data=r"""
- R0lGODlhMgAYAPcAAAEBAXZ8gQNAgL29vQNctjl/xVSa4j1dfCF+
- 3QFq1DmL3wJMmAMzZZW11dnZ2SFrtyNdmTSO6gIZMUKa8gJVqEOH
- zR9Pf5W74wFjxgFx4jltn+np6Eyi+DuT6qKiohdtwwUPGWiq6ymF
- 4LHH3Rh11CV81kKT5AMoUA9dq1ap/mV0gxdXlytRdR1ptRNPjTt9
- vwNgvwJZsX+69gsXJQFHjTtjizF0tvHx8VOm9z2V736Dhz2N3QM2
- acPZ70qe8gFo0HS19wVRnTiR6hMpP0eP1i6J5iNlqAtgtktjfQFu
- 3TNxryx4xAMTIzOE1XqAh1uf5SWC4AcfNy1XgQJny93n8a2trRh3
- 12Gt+VGm/AQIDTmByAF37QJasydzvxM/ayF3zhdLf8zLywFdu4i5
- 6gFlyi2J4yV/1w8wUo2/8j+X8D2Q5Eee9jeR7Uia7DpeggFt2QNP
- m97e3jRong9bpziH2DuT7aipqQoVICmG45vI9R5720eT4Q1hs1er
- /yVVhwJJktPh70tfdbHP7Xev5xs5V7W1sz9jhz11rUVZcQ9WoCVV
- hQk7cRdtwWuw9QYOFyFHbSBnr0dznxtWkS18zKfP9wwcLAMHCwFF
- iS5UeqGtuRNNiwMfPS1hlQMtWRE5XzGM5yhxusLCwCljnwMdOFWh
- 7cve8pG/7Tlxp+Tr8g9bpXF3f0lheStrrYu13QEXLS1ppTV3uUuR
- 1RMjNTF3vU2X4TZupwRSolNne4nB+T+L2YGz4zJ/zYe99YGHjRdD
- cT95sx09XQldsgMLEwMrVc/X3yN3yQ1JhTRbggsdMQNfu9HPz6Wl
- pW2t7RctQ0GFyeHh4dvl8SBZklCb5kOO2kWR3Vmt/zdjkQIQHi90
- uvPz8wIVKBp42SV5zbfT7wtXpStVfwFWrBVvyTt3swFz5kGBv2+1
- /QlbrVFjdQM7d1+j54i67UmX51qn9i1vsy+D2TuR5zddhQsjOR1t
- u0GV6ghbsDVZf4+76RRisent8Xd9hQFBgwFNmwJLlcPDwwFr1z2T
- 5yH5BAEAAAAALAAAAAAyABgABwj/AAEIHEiQYJY7Qwg9UsTplRIb
- ENuxEiXJgpcz8e5YKsixY8Essh7JcbbOBwcOa1JOmJAmTY4cHeoI
- abJrCShI0XyB8YRso0eOjoAdWpciBZajJ1GuWcnSZY46Ed5N8hPA
- TqEBoRB9gVJsxRlhPwHI0kDkVywcRpGe9LF0adOnMpt8CxDnxg1o
- 9lphKoEACoIvmlxxvHOKVg0n/Tzku2WoVoU2J1P6WNkSrtwADuxC
- G/MOjwgRUEIjGG3FhaOBzaThiDSCil27G8Isc3LLjZwXsA6YYJmD
- jhTMmseoKQIFDx7RoxHo2abnwygAlUj1mV6tWjlelEpRwfd6gzI7
- VeJQ/2vZoVaDUqigqftXpH0R46H9Kl++zUo4JnKq9dGvv09RHFhc
- IUMe0NiFDyql0OJUHWywMc87TXRhhCRGiHAccvNZUR8JxpDTH38p
- 9HEUFhxgMSAvjbBjQge8PSXEC6uo0IsHA6gAAShmgCbffNtsQwIJ
- ifhRHX/TpUUiSijlUk8AqgQixSwdNBjCa7CFoVggmEgCyRf01WcF
- CYvYUgB104k4YlK5HONEXXfpokYdMrXRAzMhmNINNNzB9p0T57Ag
- yZckpKKPGFNgw06ZWKR10jTw6MAmFWj4AJcQQkQQwSefvFeGCemM
- IQggeaJywSQ/wgHOAmJskQEfWqBlFBEH1P/QaGY3QOpDZXA2+A6m
- 7hl3IRQKGDCIAj6iwE8yGKC6xbJv8IHNHgACQQybN2QiTi5NwdlB
- pZdiisd7vyanByOJ7CMGGRhgwE+qyy47DhnBPLDLEzLIAEQjBtCh
- RmVPNWgpr+Be+Nc9icARww9TkIEuDAsQ0O7DzGIQzD2QdDEJHTsI
- AROc3F7qWQncyHPPHN5QQAAG/vjzw8oKp8sPPxDH3O44/kwBQzLB
- xBCMOTzzHEMMBMBARgJvZJBBEm/4k0ACKydMBgwYoKNNEjJXbTXE
- 42Q9jtFIp8z0Dy1jQMA1AGziz9VoW7310V0znYDTGMQgwUDXLDBO
- 2nhvoTXbbyRk/XXL+pxWkAT8UJ331WsbnbTSK8MggDZhCTOMLQkc
- jvXeSPedAAw0nABWWARZIgEDfyTzxt15Z53BG1PEcEknrvgEelhZ
- MDHKCTwI8EcQFHBBAAFcgGPLHwLwcMIo12Qxu0ABAQA7
- """),
-
- 'Host': PhotoImage( data=r"""
- R0lGODlhIAAYAPcAMf//////zP//mf//Zv//M///AP/M///MzP/M
- mf/MZv/MM//MAP+Z//+ZzP+Zmf+ZZv+ZM/+ZAP9m//9mzP9mmf9m
- Zv9mM/9mAP8z//8zzP8zmf8zZv8zM/8zAP8A//8AzP8Amf8AZv8A
- M/8AAMz//8z/zMz/mcz/Zsz/M8z/AMzM/8zMzMzMmczMZszMM8zM
- AMyZ/8yZzMyZmcyZZsyZM8yZAMxm/8xmzMxmmcxmZsxmM8xmAMwz
- /8wzzMwzmcwzZswzM8wzAMwA/8wAzMwAmcwAZswAM8wAAJn//5n/
- zJn/mZn/Zpn/M5n/AJnM/5nMzJnMmZnMZpnMM5nMAJmZ/5mZzJmZ
- mZmZZpmZM5mZAJlm/5lmzJlmmZlmZplmM5lmAJkz/5kzzJkzmZkz
- ZpkzM5kzAJkA/5kAzJkAmZkAZpkAM5kAAGb//2b/zGb/mWb/Zmb/
- M2b/AGbM/2bMzGbMmWbMZmbMM2bMAGaZ/2aZzGaZmWaZZmaZM2aZ
- AGZm/2ZmzGZmmWZmZmZmM2ZmAGYz/2YzzGYzmWYzZmYzM2YzAGYA
- /2YAzGYAmWYAZmYAM2YAADP//zP/zDP/mTP/ZjP/MzP/ADPM/zPM
- zDPMmTPMZjPMMzPMADOZ/zOZzDOZmTOZZjOZMzOZADNm/zNmzDNm
- mTNmZjNmMzNmADMz/zMzzDMzmTMzZjMzMzMzADMA/zMAzDMAmTMA
- ZjMAMzMAAAD//wD/zAD/mQD/ZgD/MwD/AADM/wDMzADMmQDMZgDM
- MwDMAACZ/wCZzACZmQCZZgCZMwCZAABm/wBmzABmmQBmZgBmMwBm
- AAAz/wAzzAAzmQAzZgAzMwAzAAAA/wAAzAAAmQAAZgAAM+4AAN0A
- ALsAAKoAAIgAAHcAAFUAAEQAACIAABEAAADuAADdAAC7AACqAACI
- AAB3AABVAABEAAAiAAARAAAA7gAA3QAAuwAAqgAAiAAAdwAAVQAA
- RAAAIgAAEe7u7t3d3bu7u6qqqoiIiHd3d1VVVURERCIiIhEREQAA
- ACH5BAEAAAAALAAAAAAgABgAAAiNAAH8G0iwoMGDCAcKTMiw4UBw
- BPXVm0ixosWLFvVBHFjPoUeC9Tb+6/jRY0iQ/8iVbHiS40CVKxG2
- HEkQZsyCM0mmvGkw50uePUV2tEnOZkyfQA8iTYpTKNOgKJ+C3AhO
- p9SWVaVOfWj1KdauTL9q5UgVbFKsEjGqXVtP40NwcBnCjXtw7tx/
- C8cSBBAQADs=
- """ ),
-
- 'Switch': PhotoImage( data=r"""
- R0lGODlhMgAYAPcAAAEBAXmDjbe4uAE5cjF7xwFWq2Sa0S9biSlrrdTW1k2Ly02a5xUvSQFHjmep
- 6bfI2Q5SlQIYLwFfvj6M3Jaan8fHyDuFzwFp0Vah60uU3AEiRhFgrgFRogFr10N9uTFrpytHYQFM
- mGWt9wIwX+bm5kaT4gtFgR1cnJPF9yt80CF0yAIMGHmp2c/P0AEoUb/P4Fei7qK4zgpLjgFkyQlf
- t1mf5jKD1WWJrQ86ZwFAgBhYmVOa4MPV52uv8y+A0iR3ywFbtUyX5ECI0Q1UmwIcOUGQ3RBXoQI0
- aRJbpr3BxVeJvQUJDafH5wIlS2aq7xBmv52lr7fH12el5Wml3097ph1ru7vM3HCz91Ke6lid40KQ
- 4GSQvgQGClFnfwVJjszMzVCX3hljrdPT1AFLlBRnutPf6yd5zjeI2QE9eRBdrBNVl+3v70mV4ydf
- lwMVKwErVlul8AFChTGB1QE3bsTFxQImTVmAp0FjiUSM1k+b6QQvWQ1SlxMgLgFixEqU3xJhsgFT
- pn2Xs5OluZ+1yz1Xb6HN+Td9wy1zuYClykV5r0x2oeDh4qmvt8LDwxhuxRlLfyRioo2124mft9bi
- 71mDr7fT79nl8Z2hpQs9b7vN4QMQIOPj5XOPrU2Jx32z6xtvwzeBywFFikFnjwcPFa29yxJjuFmP
- xQFv3qGxwRc/Z8vb6wsRGBNqwqmpqTdvqQIbNQFPngMzZAEfP0mQ13mHlQFYsAFnznOXu2mPtQxj
- vQ1Vn4Ot1+/x8my0/CJgnxNNh8DT5CdJaWyx+AELFWmt8QxPkxBZpwMFB015pgFduGCNuyx7zdnZ
- 2WKm6h1xyOPp8aW70QtPkUmM0LrCyr/FyztljwFPm0OJzwFny7/L1xFjswE/e12i50iR2VR8o2Gf
- 3xszS2eTvz2BxSlloQdJiwMHDzF3u7bJ3T2I1WCp8+Xt80FokQFJklef6mORw2ap7SJ1y77Q47nN
- 3wFfu1Kb5cXJyxdhrdDR0wlNkTSF11Oa4yp4yQEuW0WQ3QIDBQI7dSH5BAEAAAAALAAAAAAyABgA
- Bwj/AAEIHDjKF6SDvhImPMHwhA6HOiLqUENRDYSLEIplxBcNHz4Z5GTI8BLKS5OBA1Ply2fDhxwf
- PlLITGFmmRkzP+DlVKHCmU9nnz45csSqKKsn9gileZKrVC4aRFACOGZu5UobNuRohRkzhc2b+36o
- qCaqrFmzZEV1ERBg3BOmMl5JZTBhwhm7ZyycYZnvJdeuNl21qkCHTiPDhxspTtKoQgUKCJ6wehMV
- 5QctWupeo6TkjOd8e1lmdQkTGbTTMaDFiDGINeskX6YhEicUiQa5A/kUKaFFwQ0oXzjZ8Tbcm3Hj
- irwpMtTSgg9QMJf5WEZ9375AiED19ImpSQSUB4Kw/8HFSMyiRWJaqG/xhf2X91+oCbmq1e/MFD/2
- EcApVkWVJhp8J9AqsywQxDfAbLJJPAy+kMkL8shjxTkUnhOJZ5+JVp8cKfhwxwdf4fQLgG4MFAwW
- KOZRAxM81EAPPQvoE0QQfrDhx4399OMBMjz2yCMVivCoCAWXKLKMTPvoUYcsKwi0RCcwYCAlFjU0
- A6OBM4pXAhsl8FYELYWFWZhiZCbRQgIC2AGTLy408coxAoEDx5wwtGPALTVg0E4NKC7gp4FsBKoA
- Ki8U+oIVmVih6DnZPMBMAlGwIARWOLiggSYC+ZNIOulwY4AkSZCyxaikbqHMqaeaIp4+rAaxQxBg
- 2P+IozuRzvLZIS4syYVAfMAhwhSC1EPCGoskIIYY9yS7Hny75OFnEIAGyiVvWkjjRxF11fXIG3WU
- KNA6wghDTCW88PKMJZOkm24Z7LarSjPtoIjFn1lKyyVmmBVhwRtvaDDMgFL0Eu4VhaiDwhXCXNFD
- D8QQw7ATEDsBw8RSxotFHs7CKJ60XWrRBj91EOGPQCA48c7J7zTjSTPctOzynjVkkYU+O9S8Axg4
- Z6BzBt30003Ps+AhNB5C4PCGC5gKJMMTZJBRytOl/CH1HxvQkMbVVxujtdZGGKGL17rsEfYQe+xR
- zNnFcGQCv7LsKlAtp8R9Sgd0032BLXjPoPcMffTd3YcEgAMOxOBA1GJ4AYgXAMjiHDTgggveCgRI
- 3RfcnffefgcOeDKEG3444osDwgEspMNiTQhx5FoOShxcrrfff0uQjOycD+554qFzMHrpp4cwBju/
- 5+CmVNbArnntndeCO+O689777+w0IH0o1P/TRJMohRA4EJwn47nyiocOSOmkn/57COxE3wD11Mfh
- fg45zCGyVF4Ufvvyze8ewv5jQK9++6FwXxzglwM0GPAfR8AeSo4gwAHCbxsQNCAa/kHBAVhwAHPI
- 4BE2eIRYeHAEIBwBP0Y4Qn41YWRSCQgAOw==
- """ ),
-
- 'NetLink': PhotoImage( data=r"""
- R0lGODlhFgAWAPcAMf//////zP//mf//Zv//M///AP/M///MzP/M
- mf/MZv/MM//MAP+Z//+ZzP+Zmf+ZZv+ZM/+ZAP9m//9mzP9mmf9m
- Zv9mM/9mAP8z//8zzP8zmf8zZv8zM/8zAP8A//8AzP8Amf8AZv8A
- M/8AAMz//8z/zMz/mcz/Zsz/M8z/AMzM/8zMzMzMmczMZszMM8zM
- AMyZ/8yZzMyZmcyZZsyZM8yZAMxm/8xmzMxmmcxmZsxmM8xmAMwz
- /8wzzMwzmcwzZswzM8wzAMwA/8wAzMwAmcwAZswAM8wAAJn//5n/
- zJn/mZn/Zpn/M5n/AJnM/5nMzJnMmZnMZpnMM5nMAJmZ/5mZzJmZ
- mZmZZpmZM5mZAJlm/5lmzJlmmZlmZplmM5lmAJkz/5kzzJkzmZkz
- ZpkzM5kzAJkA/5kAzJkAmZkAZpkAM5kAAGb//2b/zGb/mWb/Zmb/
- M2b/AGbM/2bMzGbMmWbMZmbMM2bMAGaZ/2aZzGaZmWaZZmaZM2aZ
- AGZm/2ZmzGZmmWZmZmZmM2ZmAGYz/2YzzGYzmWYzZmYzM2YzAGYA
- /2YAzGYAmWYAZmYAM2YAADP//zP/zDP/mTP/ZjP/MzP/ADPM/zPM
- zDPMmTPMZjPMMzPMADOZ/zOZzDOZmTOZZjOZMzOZADNm/zNmzDNm
- mTNmZjNmMzNmADMz/zMzzDMzmTMzZjMzMzMzADMA/zMAzDMAmTMA
- ZjMAMzMAAAD//wD/zAD/mQD/ZgD/MwD/AADM/wDMzADMmQDMZgDM
- MwDMAACZ/wCZzACZmQCZZgCZMwCZAABm/wBmzABmmQBmZgBmMwBm
- AAAz/wAzzAAzmQAzZgAzMwAzAAAA/wAAzAAAmQAAZgAAM+4AAN0A
- ALsAAKoAAIgAAHcAAFUAAEQAACIAABEAAADuAADdAAC7AACqAACI
- AAB3AABVAABEAAAiAAARAAAA7gAA3QAAuwAAqgAAiAAAdwAAVQAA
- RAAAIgAAEe7u7t3d3bu7u6qqqoiIiHd3d1VVVURERCIiIhEREQAA
- ACH5BAEAAAAALAAAAAAWABYAAAhIAAEIHEiwoEGBrhIeXEgwoUKG
- Cx0+hGhQoiuKBy1irChxY0GNHgeCDAlgZEiTHlFuVImRJUWXEGEy
- lBmxI8mSNknm1Dnx5sCAADs=
- """ )
- }
-
-def addDictOption( opts, choicesDict, default, name, helpStr=None ):
- """Convenience function to add choices dicts to OptionParser.
- opts: OptionParser instance
- choicesDict: dictionary of valid choices, must include default
- default: default choice key
- name: long option name
- help: string"""
- if default not in choicesDict:
- raise Exception( 'Invalid default %s for choices dict: %s' %
- ( default, name ) )
- if not helpStr:
- helpStr = ( '|'.join( sorted( choicesDict.keys() ) ) +
- '[,param=value...]' )
- opts.add_option( '--' + name,
- type='string',
- default = default,
- help = helpStr )
-
-if __name__ == '__main__':
- setLogLevel( 'info' )
- app = MiniEdit()
- """ import topology if specified """
- app.parseArgs()
- app.importTopo()
-
- global isHostPopup
- global isRouterPopup
- global isLinkPopup
-
- app.mainloop()
diff --git a/docs/CLUSTER.md b/docs/CLUSTER.md
deleted file mode 100644
index e1e52ad..0000000
--- a/docs/CLUSTER.md
+++ /dev/null
@@ -1,25 +0,0 @@
-Mini-NDN cluster edition
-========================
-
-Mini-NDN cluster edition uses the experimental Mininet cluster edition.
-**Make sure that you can run the Mininet cluster edition by following
-[these instructions](https://github.com/mininet/mininet/wiki/Cluster-Edition-Prototype)**.
-Mini-NDN will use the "mininet" username created in Mininet cluster edition setup.
-
-## Mini-NDN cluster options
-
-To run Mini-NDN cluster on `localhost` and another server `server1` with
-the guided node placement strategy (default), the following command can be used:
-
- sudo minindn --cluster=localhost,server1 --place-list=1,3
-
-Note that `place-list` specifies the number of nodes to be placed on the corresponding servers
-of the cluster.
-In the example, one node will be placed on `localhost` and three nodes on `server1`.
-Unless specified, the default 4 node topology is used.
-Another placement can be `roundRobin` placement algorithm from Mininet.
-This does not require a place-list.
-
- sudo minindn --cluster=localhost,server1 --placement roundRobin
-
-By default the tunnel type used is SSH, but GRE tunnel can be specified by `--tunnel-type=gre`
diff --git a/docs/CONFIG.md b/docs/CONFIG.md
deleted file mode 100644
index d2a5bf1..0000000
--- a/docs/CONFIG.md
+++ /dev/null
@@ -1,68 +0,0 @@
-Configuration
-=============
-
-Mini-NDN uses a configuration file describing the topology and its parameters to setup a network.
-It can be generated by the GUI or written by hand or scripts.
-
-## Configuration file format:
-
-### The [nodes] section:
-
-At the bare minimum, the node section describes the nodes present in the topology.
-
- [nodes]
- a: _
- b: _
-
-Additionally each node can take the following parameters:
-
-* app : Default application(s) to be started on a node (specify '_' if no app needs to be started - required).
-The app is the only parameter which needs double quotes (see example below).
-
-* cpu : Amount of cpu available to a node (0.00 - 1.00), optional
-
-* mem : Amount of memory available to a node in KB
-
-* cache : Amount of cache memory available to a node in KB
-
-* nfd-log-level: Set the log level of the NFD running on the node (ex: DEBUG). For finer control,
-nfd.conf or nfd.conf.sample needs to be modified in /usr/local/etc/ndn/
-
-* nlsr-log-level: Set the log level of the NLSR running on the node (ex: DEBUG).
-
- e.g.)
-
- [nodes]
- a: _ cpu=0.3 nfd-log-level=TRACE nlsr-log-level=NONE
- b: app="sample app 1; sampleapp2.sh" cpu=0.3
-
-### The [links] section:
-
-The links section describes the links in the topology.
-
- e.g.)
-
- [links]
- a:b delay=10ms
-
-This would create a link between a and b. 'b:a' would also result in the same.
-The following parameters can be configured for a node:
-
-* delay : Delay parameter is a required parameter which defines the delay of the link (1-1000ms)
-
-* bw : Bandwidth of a link (<1-1000> Mbps)
-
-* loss : Percentage of packet loss (<1-100>)
-
-### Example configuration file
-
- [nodes]
- a: _ cpu=0.3
- b: app="sampleApp1; ./sampleApp2.sh" cpu=0.3
- [links]
- a:b delay=10ms bw=100
-
-Note that `sampleApp1` and `sampleApp2` must be either installed in the system (ex: /usr/bin)
-or an absolute path needs to be given.
-
-See `topologies` for more sample files
diff --git a/docs/EXPERIMENTS.md b/docs/EXPERIMENTS.md
deleted file mode 100644
index a2191ac..0000000
--- a/docs/EXPERIMENTS.md
+++ /dev/null
@@ -1,207 +0,0 @@
-Experiments
-===========
-
-Mini-NDN includes an experimentation framework which allows a user to create and automate
-networking experiments. Users can run existing experiments, included with Mini-NDN, or define
-their own custom experiment.
-
-## Running existing experiments
-
-Mini-NDN includes three example experiments that can be used to test the network or as reference
-for custom experiment implementations. `ndn-tools` must be installed to run the example
-experiments as each experiment uses both `ndnpingserver` and `ndnping`. Please see
-[INSTALL.md](../INSTALL.md) for instructions on installing `ndn-tools`.
-
-To see a list of the available experiments, run Mini-NDN using the `--list-experiments` parameter:
-
- minindn --list-experiments
-
-To run an experiment, provide the experiment name as an argument to the `--experiment` parameter:
-
- sudo minindn --experiment=pingall
-
-Each experiment will run until completion or exit if there is an error setting up the
-test environment.
-
-The three included experiments are set up using the same starting
-configuration. Each node runs NFD, NLSR, and an ndnpingserver which advertises the node's
-site name. After a waiting period to allow the network to converge (default is 60 seconds),
-the convergence status of the network is checked. If each node's FIB does not have an entry
-for every other node's router name and advertised prefix, the experiment is aborted and an error
-is reported.
-
-#### Common experiment parameters
-
-The time allowed for convergence (in seconds) can be configured using the `--ctime` parameter:
-
- sudo minindn --ctime=30 ...
-
-After the experiment has finished running, the command-line interface (CLI) will be launched and the
-user can then interact with the test environment. To disable the CLI and instead exit Mini-NDN
-as soon as the experiment has finished, use the `--no-cli` parameter:
-
- sudo minindn --no-cli ...
-
-To ping only a percentage of nodes `--pct-traffic` can be set.
-
- sudo minindn --pct-traffic=0.5 ...
-
-The above command will ping only 50% of other nodes from each node.
-The default value is 1 i.e. ping every other node.
-
-To move the experiment results to a results directory from the working directory
-after the experiment is complete (either --no-cli or quit) the following option
-can be used:
-
- sudo minindn --result-dir /home/mydir/result-dir ...
-
-The included experiments are described in detail below along with additional
-parameters that can be provided to modify the execution of the experiments.
-
-### Pingall experiment
-
-**Scenario**: Each node in the network simultaneously pings every other node in the network at a
-one second interval.
-
-**Experiment ID**: `--pingall`
-
-The number of pings sent in the experiment can be configured using the `--nPings` parameter:
-
- sudo minindn --experiment=pingall --nPings=120
-
-By default, `--nPings` is 300 for the Pingall experiment.
-
-### Failure experiment
-
-**Scenario**: Each node in the network simultaneously pings every other node in the network at a
-one second interval. After 60 seconds, the node with the name "csu" is brought down. The node is
-left in a failed state for 120 seconds while the other nodes continue pinging. After this period,
-the failed node is recovered and pings are collected for an additional 90 seconds.
-
-**Experiment ID**: `--failure`
-
-`--nPings` is 300 for the Failure experiment and cannot be modified.
-
-### Multiple failure experiment
-
-**Scenario**: Each node in the network simultaneously pings every other node in the network at a
-one second interval. After 60 seconds, the first node in the network will be brought down and remain
-in failed state for 60 seconds. After the failure period, the node is recovered and the network
-is allowed to recover for 60 seconds. After the recovery period, the next node will go through this
-failure and recovery process. Once every node in the network has gone through the failure and
-recovery process, the experiment will end.
-
-**Experiment ID**: `--multiple-failure`
-
-`--nPings` is dependent on the size of the topology being tested. 120 pings are scheduled for
-each node's failure/recovery period as well as an additional 60 pings for the initial collection
-period.
-
-### MCN failure experiment
-
-**Scenario**: This is exactly like the failure experiment but instead of failing the node named "csu" it fails the most connected node (MCN) i.e the node with the most links.
-
-Experiment ID: `--mcn-failure`
-
-### Experiment data
-
-The ping data is stored at `/tmp/minindn/node-name/ping-data`.
-
-The ping server log is stored at `/tmp/minindn/node-name/ping-server`
-
-## Creating custom experiments
-
-Mini-NDN provides a simple Python based framework which allows a user to define their own experiment
-and run it from the command line.
-
-To create an experiment, follow these steps:
-
-1. Create a Python source file for the experiment in the `ndn/experiments` directory.
-
- e.g.) `ndn/experiments/example.py`
-
-2. Derive the experiment from the `Experiment` base class defined in
- `ndn/experiments/experiment.py`.
-
- #!/usr/bin/python
-
- from ndn.experiments.experiment import Experiment
-
- class ExampleExperiment(Experiment):
- def __init__(self, args):
- Experiment.__init__(self, args)
-
-3. Override `start()` if the experiments want to override NLSR setup and skip `setup()` and `run()`
-as described below. `start()` is the entry point for an experiment.
-
-4. Override the `setup()` method to define how the experiment should be initialized
-
- e.g.) Run an ndnping server in the background on each node
-
- def setup(self):
- for host in self.net.hosts:
- host.cmd("ndnpingserver host.name &")
-
-
-5. Override the `run()` method to define how the experiment should behave
-
- e.g.) Obtain the NFD status of each node and save it to file
-
- def run(self):
- for host in self.net.hosts:
- host.cmd("nfdc status report > status.txt")
-
-6. Register the experiment with the `ExperimentManager` to make the experiment runnable from the
-command line.
-
- Experiment.register("example-name", ExampleExperiment)
-
-The experiment can then be run from the command-line using the name registered.
-"example-name" in the above example:
-
- sudo minindn --experiment=example-name
-
-### Full example experiment code
-
- #!/usr/bin/python
-
- from ndn.experiments.experiment import Experiment
-
- class ExampleExperiment(Experiment):
- def __init__(self, args):
- Experiment.__init__(self, args)
-
- def setup(self):
- for host in self.net.hosts:
- host.cmd("ndnpingserver host.name &")
-
- def run(self):
- for host in self.net.hosts:
- # By default status.txt would be stored
- # at /tmp/minindn/host/status.txt
- host.cmd("nfdc status report > status.txt")
-
- Experiment.register("example-name", ExampleExperiment)
-
-## Passing arguments to experiments
-
-Mini-NDN has the capacity to pass arguments to experiments, insofar
-as they do not clash with those of Mini-NDN. This feature
-allows users to pass arguments to Mini-NDN and process them in an
-experiment without having to rewrite Mini-NDN's core.
-
-An example of an experiment implementing this functionality is given in
-`ndn/experiments/arguments_experiment.py`, which demonstrates how to
-write code which handles arguments. Documentation for these arguments
-appears when called with `sudo minindn -h`, as does documentation for
-fixed arguments defined in core code, so it is strongly recommended to
-differentiate those you write yourself. Note that Bash and Zsh users
-can make use of autocomplete functionality when calling these arguments.
-
-To run the experiment:
-
- sudo minindn --experiment arg-exp --ds 226 --logging
-
-The experiment will print out the supplied value for --ds and a boolean
-value for the presence of --logging. --experiment is a fixed argument of
-Mini-NDN.
\ No newline at end of file
diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md
deleted file mode 100644
index d15e95f..0000000
--- a/docs/GETTING-STARTED.md
+++ /dev/null
@@ -1,115 +0,0 @@
-Getting Started
-===============
-
-## Installation
-Please see [INSTALL.md](../INSTALL.md) for instructions on installing Mini-NDN and its dependencies.
-
-## Running Mini-NDN
-
-To run Mini-NDN with the default topology, `ndn_utils/topologies/default-topology.conf`, type:
-
- sudo minindn
-
-A full list of options can be printed by using:
-
- sudo minindn --help
-
-To run Mini-NDN with a topology file, provide the filename as the first argument:
-
- sudo minindn my-topology.conf
-
-During set up, the list of nodes in the network will be listed as they are initialized:
-
- *** Adding hosts:
- a b c d
-
-After set up, the command-line interface (CLI) will display a prompt.
-
- mini-ndn>
-
-To interact with a node, first type the node's name and then the command to be executed:
-
- mini-ndn> a echo "Hello, world!"
- Hello, world!
-
-To see the status of the forwarder on the node:
-
- mini-ndn> a nfdc status report
-
-To see the status of routing on the node:
-
- mini-ndn> a nlsrc status
-
-To exit Mini-NDN, type `quit` in the CLI:
-
- mini-ndn> quit
-
-Another option to quit Mini-NDN is sending a SIGQUIT (ctrl+\). SIGINT (ctrl+c)
-is reserved for the purpose of stopping applications initiated on the minindn command
-line.
-
-For a more in depth explanation of the CLI, please see the
-[Mininet Walkthrough](http://mininet.org/walkthrough/).
-
-## Command-line options
-
-To run Mini-NDN with a replica of the NDN testbed, use the `--testbed` parameter:
-
- sudo minindn --testbed
-
-To change the working directory from default `/tmp/minindn` following option can be used:
-
- sudo minindn --work-dir /home/mydir/test
-
-Autocomplete of command-line options is available for users of Bash and Zsh.
-
-#### Routing options
-
-To run minindn without NLSR, use the `--no-nlsr` parameter:
-
- sudo minindn --no-nlsr
-
-To run NLSR with hyperbolic routing enabled, use the `--routing` parameter:
-
- sudo minindn --routing hr
-
-Topology files given under ndn_utils/topologies/minindn* have hyperbolic coordinates configured
-and can be used with this option.
-
-To run NLSR in dry-run mode, use the `--routing` parameter:
-
- sudo minindn --routing dry
-
-To configure the max number of faces added by NLSR to reach each name prefix, use the `--faces`
-parameter:
-
- sudo minindn --faces 3
-
-`--faces` can be an integer from 0 to 60; 0 indicates NLSR can add all available faces.
-
-To run Mini-NDN with NLSR security configured
-
- sudo minindn --nlsr-security
-
-## Working Directory Structure
-
-Currently Mini-NDN uses /tmp/minindn as the working directory if not specified otherwise by using
-the option --work-dir.
-
-Each node is given a HOME directory under /tmp/minindn/node-name
-where node-name is the name of the node specified in the [nodes] section of the conf file.
-
-### NFD
-NFD conf file is stored at `/tmp/minindn/node-name/node-name.conf`
-
-NFD log file is stored at `/tmp/minindn/node-name/node-name.log`
-
-`.ndn` folder is stored at `/tmp/minindn/node-name/.ndn`
-
-### NLSR
-NLSR conf file is stored at `/tmp/minindn/node-name/nlsr.conf`
-
-NLSR log file is stored at `/tmp/minindn/node-name/log/nlsr.log`
-
-When security is enabled, NLSR security certificates are stored in: `/tmp/minindn/node-name/security`
-Note that no NLSR publishes the root certificate, Mini-NDN installs root.cert in security folder for each NLSR.
diff --git a/docs/GUI.md b/docs/GUI.md
deleted file mode 100644
index b190eeb..0000000
--- a/docs/GUI.md
+++ /dev/null
@@ -1,81 +0,0 @@
-Mini-NDN Edit
-=============
-
-Mini-NDN Edit is a GUI program designed to simplify the creation of Mini-NDN topology
-configuration files. Mini-NDN Edit allows the user to build a topology, configure the hosts and
-links, and generate a topology file that can be used by Mini-NDN.
-
-
-
-## Working with topology files
-
-#### File formats
-
-There are two file formats used by Mini-NDN edit.
-
-* `.mnndn` files store topology information used by the GUI. Mini-NDN Edit can open and
-save `.mnndn` files.
-
-* `.conf` files are used by Mini-NDN to create and run topologies. Mini-NDN Edit can generate a
-`.conf` file from a `.mnndn` file. Mini-NDN edit cannot open `.conf` files. Please see
-[CONFIG-FILE.md](CONFIG.md) for more information on the content and format of `.conf` files.
-
-#### File menu
-
-
-
-* **New** - Erase the current canvas and provide a new empty topology
-* **Open** - Open a `.mnndn` topology file
-* **Save** - Save the current topology as a `.mnndn` topology file
-* **Generate** - Convert the current topology to a `.conf` file runnable by Mini-NDN
-* **Run** - Run the current topology in Mini-NDN. The GUI will disappear and Mini-NDN will run on
- the command-line.
-* **Quit** - Exit Mini-NDN edit
-
-## Tools
-
-### Cursor tool
-
-
-The *cursor tool* is used to select and move nodes in the topology. A selected node or link can be
-removed from the topology using the `backspace` key or by selecting `edit/cut`.
-
-### Host tool
-
-
-The *host tool* is used to add a host node to the topology. Click on the canvas to create a new host
-node at the mouse cursor's position.
-
-### Switch tool
-
-
-The *switch tool* is used to add a switch to the topology. Click on the canvas to create a new
-switch at the mouse cursor's position.
-
-### Link tool
-
-
-The *link tool* is used to connect two nodes with a network link. Click on a node and drag the mouse
-cursor to another node to create a link between the two nodes.
-
-## Configuration
-
-#### Editing host information
-
-To edit a host's information and configuration, right-click on the desired node and select
-`Host Options`.
-
-The *Host Options* window will include tabs to modify the node's properties as well as the
-configuration files for NFD and NLSR on that node.
-
-*Note: Network, Site, and Router in the NLSR tab are unused in v0.1.0*
-
-
-
-#### Editing link configuration
-
-To edit a link's configuration, right-click on the desired link and select `Link Options`.
-
-The *Link Options* window will allow configuration of the link's bandwidth, delay, and loss rate.
-
-
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d4bb2cb
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/RELEASE-NOTES.md b/docs/RELEASE-NOTES.md
deleted file mode 100644
index 9a825d7..0000000
--- a/docs/RELEASE-NOTES.md
+++ /dev/null
@@ -1,176 +0,0 @@
-Release Notes
-=============
-
-Mini-NDN version 0.4.0 (changes since version 0.3.0)
-----------------------------------------------------
-
-Release date: January 10, 2018
-
-**New features**:
-
-- Use SIGQUIT to quit Mini-NDN, SIGINT to kill programs
-
-- Use Infoedit to edit NFD and NLSR configuration files
-
-- Use nlsr.conf installed in the system
-
-- Provide a Vagrantfile to setup Mini-NDN and NDN
-
-- Provide option to disable NLSR
-
-- Provide an option to run NLSR in dry-run mode
-
-- Add option to specify whether to use TCP or UDP face in nlsr.conf
-
-- Add option to specify arbitrary arguments to use in experiments
-
-- Include a single option to install Mini-NDN and all the dependencies
-
-**Bug fixes**:
-
-- Fix "key does not exist error" after NLSR starts
-
-- Update install.sh to call ldconfig after installing ChronoSync
-
-- Add hyperbolic coordinates to default topology
-
-**Misc changes**:
-
-- Add an experiment to test nlsrc
-
-- Create faces in NFD for each neighbor in NLSR
-
-- Update to latest ndn-cxx
-
-- Use /tmp/minindn folder as default work dir instead of /tmp
-
-Mini-NDN version 0.3.0 (changes since version 0.2.0)
-----------------------------------------------------
-
-Release date: March 3, 2017
-
-**New features**:
-
-- Mini-NDN cluster edition
-
-- New experiments for making NLSR testing easier
-
-**Bug fixes**:
-
-- Set site name correctly
-
-- Install missing certificates in NLSR security config
-
-- Fix quitting of NLSR due to key not found error
-
-**Misc changes**:
-
-- Removed nlsr.conf file, generate it within the code
-
-- Use argparse instead of deprecated optparse
-
-- Update security config section for NLSR
-
-- Change mininet prompt to mini-ndn
-
-- Set network name at one place
-
-- Update install.sh script to install openssl
-
-- Update install.sh script to install cryptopp from package instead of compiling from source
-
-- Update install.sh to clean build folder every time to get rid of removed files such as old experiments
-
-- Fix old code - use net.hosts instead of storing hosts in a variable
-
-- Use nfdc instead of deprecated nfd-status
-
-Mini-NDN version 0.2.0 (changes since version 0.1.1)
-----------------------------------------
-
-Release date: August 18, 2016
-
-**New features**:
-
-- Automatic security configuration for NLSR
-
-- Use /usr/local/etc/ndn/nfd.conf as default config file for NFD
-
-- Class to monitor /proc/$PID/stat file for PID
-
-- Mini-NDN exits gracefully on SIGINT and non-convergence
-
-- Faster Mini-NDN install script - does not do apt-get update everytime
-
-- NLSR is launched with explicit config file for easier process identification
-
-- Add and update more documentation
-
-**Bug fixes**:
-
-- NFD is killed correctly on exit
-
-- Best route strategy is set correctly
-
-Mini-NDN version 0.1.1 (changes since version 0.1.0)
-----------------------------------------
-
-Release date: November 4, 2015
-
-**New features**:
-
-- Use nfd.conf.sample from currently installed NFD
-
-- Add working directory option to allow execution environment outside of /tmp
-
-- Add results directory option to store experiment results after completion
-
-- Add support for switches in GUI and configuration file
-
-- Add failNode and recoverNode methods to Experiment class
-
-- Add most connected node (MCN) failure experiment
-
-- Add option to specify percentage of nodes pinged
-
-**Code changes**:
-
-- Refactor program options into container class
-
-- Remove unused "FIB Entries" option from NDN host options
-
-**Bug fixes**:
-
-- Abort start up if experiment name is invalid
-
-- Restart pings after recovery in failure experiment
-
-Mini-NDN version 0.1.0 (initial release)
-----------------------------------------
-
-Release date: July 15, 2015
-
-Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
-research on the NDN platform. Based on Mininet, Mini-NDN uses the NDN libraries, NFD, NLSR, and
-tools released by the [NDN project](http://named-data.net/codebase/platform/) to emulate
-an NDN network on a single system.
-
-**Included features**:
-
-- Run a complete NDN network on a single system
-
-- Automatic configuration of NLSR to provide a routable NDN network
-
-- Supports user created NDN applications
-
-- Create a topology using the included Mini-NDN Edit GUI application
-
-- Allows individual configuration of NFD and NLSR parameters for each node
-
-- Provides an experiment management framework for easy creation of custom networking experiments
-
-- Uses a simple topology file format to define hosts, links, and configuration values
-
-- Configure network link parameters including bandwidth, delay, and loss rate
-
-- Includes a pre-configured topology file to replicate the NDN testbed
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..54591c1
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+from datetime import datetime
+from minindn import __version__
+
+# -- Project information -----------------------------------------------------
+
+project = 'Mini-NDN'
+copyright = '2015-{}, Mini-NDN. This research is partially supported by NSF.'.format(datetime.now().year)
+author = 'Mini-NDN'
+
+# The full version, including alpha/beta/rc tags
+release = __version__
+version = __version__
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
\ No newline at end of file
diff --git a/docs/experiment.rst b/docs/experiment.rst
new file mode 100644
index 0000000..58cc303
--- /dev/null
+++ b/docs/experiment.rst
@@ -0,0 +1,235 @@
+Experiment
+==========
+
+Configuration
+-------------
+
+Mini-NDN uses a configuration file describing the topology and its parameters to setup a network.
+
+The [nodes] section:
+
+At the bare minimum, the node section describes the nodes present in the
+topology.
+
+::
+
+ [nodes]
+ a: key1=value1 key2=value2
+ b: key1=value1
+
+Any key and value passed here is accessible in Mini-NDN as:
+
+::
+
+ ndn = Minindn(...)
+ value = ndn.net.hosts[0].params['params'].get('key1', "defaultValue")
+
+One can specify log levels for each node's NFD and NLSR using this key-value system:
+
+::
+
+ [nodes]
+ a: nfd-log-level=DEBUG nlsr-log-level=DEBUG
+ b: nfd-log-level=INFO
+
+To specify a log level for certain modules of NFD, the following line can be added to `nfd.py`:
+
+::
+
+ node.cmd('infoedit -f {} -s log.Forwarder -v {}'.format(self.confFile, 'INFO'))
+
+This will turn on FORWARDER logging to INFO for all nodes.
+
+.. Todo: Add switch section
+
+The [links] section:
+
+The links section describes the links in the topology.
+
+::
+
+ e.g.)
+
+ [links]
+ a:b delay=10ms
+
+This would create a link between a and b. 'b:a' would also result in the
+same. The following parameters can be configured for a node:
+
+- delay : Delay parameter is a required parameter which defines the
+ delay of the link (1-1000ms)
+
+- bw : Bandwidth of a link (<1-1000> Mbps)
+
+- loss : Percentage of packet loss (<1-100>)
+
+Example configuration file
+
+::
+
+ [nodes]
+ a:
+ b:
+ [links]
+ a:b delay=10ms bw=100
+
+See ``ndn_utils/topologies`` for more sample files
+
+Sample
+------
+
+Sample experiment may written as follows:
+
+.. code:: python
+
+ from mininet.log import setLogLevel, info
+
+ from minindn.minindn import Minindn
+ from minindn.util import MiniNDNCLI
+ from minindn.apps.appmanager import AppManager
+ from minindn.apps.nfd import Nfd
+ from minindn.apps.nlsr import Nlsr
+ from minindn.helpers.routing_helper import IPRoutingHelper
+
+ if __name__ == '__main__':
+ setLogLevel('info')
+
+ Minindn.cleanUp()
+ Minindn.verifyDependencies()
+
+ # Can pass a custom parser, custom topology, or any Mininet params here
+ ndn = Minindn()
+
+ ndn.start()
+
+ # IP reachability if needed
+ # IPRoutingHelper.calcAllRoutes(ndn.net)
+ # info("IP routes configured, start ping\n")
+ # ndn.net.pingAll()
+
+ # Start apps with AppManager which registers a clean up function with ndn
+ info('Starting NFD on nodes\n')
+ nfds = AppManager(ndn, ndn.net.hosts, Nfd)
+ info('Starting NLSR on nodes\n')
+ nlsrs = AppManager(ndn, ndn.net.hosts, Nlsr)
+
+ # or can not start NLSRs with some delay in between:
+ # nlsrs = AppManager(ndn, ndn.net.hosts, Nlsr)
+ # for host in ndn.net.hosts:
+ # nlsrs.startOnNode(host)
+ # time.sleep(30)
+
+ MiniNDNCLI(ndn.net)
+
+ # Calls the clean up functions registered via AppManager
+ ndn.stop()
+
+Users may look at how the NFD and NLSR applications are written as a sub class of Application
+in the ``minindn/apps`` folder. Or users may choose to directly run their application on nodes
+such as ndnpingserver is run in ``minindn/helpers/experiment.py``.
+
+Execution
+---------
+
+To run Mini-NDN with the default topology,
+``ndn_utils/topologies/default-topology.conf``, type:
+
+::
+
+ sudo python examples/minindn.py
+
+To run Mini-NDN with a topology file, provide the filename as the first
+argument:
+
+::
+
+ sudo python examples/minindn.py my-topology.conf
+
+After Mini-NDN is installed, users can run examples from anywhere with python directly as follows:
+
+::
+
+ sudo python /path/to/myexample.py
+
+The user no longer needs to create an experiment in the old Mini-NDN way, then install it to the system before executing it via the minindn binary. The new examples can be separate from the Mini-NDN folder if the core is not being modified.
+
+CLI Interface
+_____________
+
+During set up, the list of nodes in the network will be listed as they
+are initialized:
+
+::
+
+ *** Adding hosts:
+ a b c d
+
+After set up, the command-line interface (CLI) will display a prompt.
+
+::
+
+ mini-ndn>
+
+To interact with a node, first type the node's name and then the command
+to be executed:
+
+::
+
+ mini-ndn> a echo "Hello, world!"
+ Hello, world!
+
+To see the status of the forwarder on the node:
+
+::
+
+ mini-ndn> a nfdc status report
+
+To see the status of routing on the node:
+
+::
+
+ mini-ndn> a nlsrc status
+
+To exit Mini-NDN, type ``quit`` in the CLI or use ``ctrl + D``:
+
+::
+
+ mini-ndn> quit
+
+``Ctrl + C`` is used to quit an application run in the foreground of the command line.
+
+For a more in depth explanation of the CLI, please see the `Mininet
+Walkthrough `__.
+
+To run NDN commands from the outside the command line user can also open a new terminal
+and export the HOME folder of a node ``export HOME=/tmp/minindn/a && cd ~``
+
+Working Directory Structure
+---------------------------
+
+Currently Mini-NDN uses /tmp/minindn as the working directory if not
+specified otherwise by using the option --work-dir.
+
+Each node is given a HOME directory under /tmp/minindn/ where
+ is the name of the node specified in the [nodes] section of
+the conf file.
+
+NFD
+___
+
+- NFD conf file is stored at ``/tmp/minindn//nfd.conf``
+
+- NFD log file is stored at ``/tmp/minindn//log/nfd.log``
+
+- ``.ndn`` folder is stored at ``/tmp/minindn//.ndn``
+
+NLSR
+____
+
+- NLSR conf file is stored at ``/tmp/minindn//nlsr.conf``
+- NLSR log file is stored at ``/tmp/minindn//log/nlsr.log``
+
+When security is enabled, NLSR security certificates are stored in:
+``/tmp/minindn//security`` Note that no NLSR publishes the root
+certificate, Mini-NDN installs root.cert in security folder for each
+NLSR.
diff --git a/docs/faq.rst b/docs/faq.rst
new file mode 100644
index 0000000..991dd06
--- /dev/null
+++ b/docs/faq.rst
@@ -0,0 +1,48 @@
+FAQ
+=========
+
+* ``How does Mini-NDN work?``
+
+Mini-NDN's principles of operation most heavily rely on the underlying Mininet code it relies on.
+Mininet uses a combination of limited containerization via network namespaces (which give processes
+isolated interfaces and routing tables) and emulated ethernet connections via veth connections.
+In practical terms, Mini-NDN ensures that processes running on distinct nodes will run seperately
+and without interfering with each other.
+
+* ``How does Mini-NDN apply link loss/delay/etc.?``
+
+Mini-NDN relies on Mininet's code, which in turn uses the Linux tc utility on a stations' virtualized
+interfaces to apply configurations known as qdiscs to these links. Note that these will only be applied
+on egress packets from a station where it's applied.
+For more information on qdiscs and tc, view the information `here `_.
+
+* ``Why use Mini-NDN rather than a simulator such as ndnSIM?``
+
+Mini-NDN is easier and faster to use because, rather than serving as a mathematical model of a network,
+it is instead running real NDN code on a real Linux kernel. This also means it's quite useful for testing code changes, as it can more accurately test the interaction of software componenents.
+
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Criteria | Mini-NDN | ndnSIM |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Based On | Mininet | ns-3 |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Language | Python | C++ |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Library/Forwarder/Applications | Use system binaries (free to use any compatible versions) | Integrated (fixed release version) |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Application language | C++ (ndn-cxx), CCL (ndn-cpp, PyNDN, ndn-js, jNDN) | C++ (ndn-cxx) |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Simulation size | Medium - Large (cluster edition in development) | Large (can be parallelized using MPI) |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Simulation time | Real time | Quick (depending on size/memory) |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Porting real applications | Drop in | Changes required |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Interactivity | Can interact directly with NFD, NLSR or Apps | Can show stats while running |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Logs | May need to manually setup to collect | Available with tracer |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Post processing scripts | Not available, users need to write their own | Available to use to process the logs |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
+| Other | Not yet supported (Wifi in development) | WiFi, LTE, etc available from ns-3 |
++--------------------------------+-----------------------------------------------------------+-----------------------------------------+
diff --git a/docs/hackathon.rst b/docs/hackathon.rst
new file mode 100644
index 0000000..e51ec74
--- /dev/null
+++ b/docs/hackathon.rst
@@ -0,0 +1,9 @@
+Past NDN Hackathon projects
+===========================
+
+- 1st NDN Hackathon: `NFD integration test `_.
+- 2st NDN Hackathon: `Mini-NDN metrics `_.
+- 3rd NDN Hackathon: `Mini-NDN cluster `_.
+- 4th NDN Hackathon: `Mini-NDN wifi `_.
+- 7th NDN Hackathon: `Mini-NDN documentation `_.
+
diff --git a/docs/CONNECT-TO-OUTSIDE.md b/docs/howtos.rst
similarity index 57%
rename from docs/CONNECT-TO-OUTSIDE.md
rename to docs/howtos.rst
index eb3f5b6..b95bde3 100644
--- a/docs/CONNECT-TO-OUTSIDE.md
+++ b/docs/howtos.rst
@@ -1,40 +1,45 @@
-Connect Mini-NDN nodes to an outside network
-============================================
+Howtos
+======
-Mini-NDN nodes can be connected to an outside network indirectly by running NFD on the local machine:
+Connect Mini-NDN nodes to an outside network
+---------------------------------------------
+
+Mini-NDN nodes can be connected to an outside network indirectly by
+running NFD on the local machine:
+
+::
(Mini-NDN node) ------ (NFD running on the host machine where Mini-NDN is running) ------- (External Network)
-## Add a node in root namespace
+Add a node in root namespace
+____________________________
-For this simple example, we use the default topology:
+For this simple example, we can use a single node topology with node 'a'
- c----a----b----d
+If we want node 'a' to connect to the host machine, we need to add a
+"root" node which has a link with node "a."
-If we want node "a" to connect to the host machine, we need to add a "root" node which has a link with node "a."
+Then the following code can be used:
-To do so, we need to add the following import statement at the top of `bin/minindn`:
+.. code:: python
-```python
-from mininet.node import Node
-```
+ topo = Topo()
+ root = topo.addHost('root', inNamespace=False)
+ a = topo.addHost('a')
+ topo.addLink(root, a, delay='10ms')
-Then the following lines can be added to `bin/minindn` before net.start():
+ ndn = Minindn(topo=topo)
-```python
-root = Node( 'root', inNamespace=False )
-net.addLink(root, 'a')
-```
+ ...
-Adding these before net.start() is important as node "root" would then be assigned an IP automatically.
-Re-install Mini-NDN by issuing the following command in the mini-ndn folder:
+Configuration
+_____________
- sudo ./install.sh -i
+Run Mini-NDN with the above code and issue ifconfig on the local
+machine to confirm the addition of the interface. You should be able to
+locate "root-eth0":
-## Configuration
-
-Run Mini-NDN with the simple topology and issue ifconfig on the local machine to confirm the addition of
-the interface. You should be able to locate "root-eth0":
+::
root-eth0 Link encap:Ethernet HWaddr 3e:eb:77:d2:6f:1f
inet addr:1.0.0.9 Bcast:1.0.0.11 Mask:255.255.255.252
@@ -45,25 +50,36 @@ the interface. You should be able to locate "root-eth0":
collisions:0 txqueuelen:1000
RX bytes:2667 (2.6 KB) TX bytes:2797 (2.7 KB)
-To make the IP address associated with this interface persistent, add the following line to
-/etc/network/interfaces and reboot your machine:
+To make the IP address associated with this interface persistent, add
+the following line to /etc/network/interfaces and reboot your machine:
+
+::
iface root-eth0 inet manual
-## Check connection
+Check connection
+________________
After rebooting, run Mini-NDN and issue the following command:
+::
+
mini-ndn>net
a a-eth0:b-eth0 a-eth1:c-eth0 a-eth2:root-eth0
-Node "a" is connected to "root-eth0". Now issue "ifconfig a-eth2" on node "a":
+Node "a" is connected to "root-eth0". Now issue "ifconfig a-eth2" on
+node "a":
+
+::
mini-ndn>a ifconfig a-eth2
a-eth2 Link encap:Ethernet HWaddr fa:76:d4:86:d3:ba
inet addr:1.0.0.10 Bcast:1.0.0.11 Mask:255.255.255.252
-As learned from the previous step, the IP address of root-eth0 is 1.0.0.9.
+As learned from the previous step, the IP address of root-eth0 is
+1.0.0.9.
+
+::
mini-ndn>a ping 1.0.0.9
PING 1.0.0.9 (1.0.0.9) 56(84) bytes of data.
@@ -72,20 +88,28 @@ As learned from the previous step, the IP address of root-eth0 is 1.0.0.9.
The host machine will also be able to ping node "a":
+::
+
VirtualBox:~$ ping 1.0.0.10
PING 1.0.0.10 (1.0.0.10) 56(84) bytes of data.
64 bytes from 1.0.0.10: icmp_seq=1 ttl=64 time=0.086 ms
-## Run NFD on local machine and register route
+Run NFD on local machine and register route
+___________________________________________
Start NFD on the local machine by using:
+::
+
sudo nfd
-The "nfd-start" script cannot be used, since the script allows only one instance of NFD at a time.
-The NFD processes running on the Mini-NDN nodes will prevent the "nfd-start" script from working.
+The "nfd-start" script cannot be used, since the script allows only one
+instance of NFD at a time. The NFD processes running on the Mini-NDN
+nodes will prevent the "nfd-start" script from working.
-Now, using "nfdc register", we can register a route from node "a" in Mini-NDN to the NFD process on the
-host machine and from the host machine to an external machine.
+Now, using "nfdc register", we can register a route from node "a" in
+Mini-NDN to the NFD process on the host machine and from the host
+machine to an external machine.
-Also, if the local machine has a public IP, Mini-NDN nodes can be reached via external machines.
+Also, if the local machine has a public IP, Mini-NDN nodes can be
+reached via external machines.
diff --git a/docs/img/gui/cursor-tool.png b/docs/img/gui/cursor-tool.png
deleted file mode 100644
index 6d53812..0000000
Binary files a/docs/img/gui/cursor-tool.png and /dev/null differ
diff --git a/docs/img/gui/file-dropdown.png b/docs/img/gui/file-dropdown.png
deleted file mode 100644
index 9e0354c..0000000
Binary files a/docs/img/gui/file-dropdown.png and /dev/null differ
diff --git a/docs/img/gui/host-config.png b/docs/img/gui/host-config.png
deleted file mode 100644
index 5cd79a8..0000000
Binary files a/docs/img/gui/host-config.png and /dev/null differ
diff --git a/docs/img/gui/host-tool.png b/docs/img/gui/host-tool.png
deleted file mode 100644
index 4f54d53..0000000
Binary files a/docs/img/gui/host-tool.png and /dev/null differ
diff --git a/docs/img/gui/link-details.png b/docs/img/gui/link-details.png
deleted file mode 100644
index 99e2449..0000000
Binary files a/docs/img/gui/link-details.png and /dev/null differ
diff --git a/docs/img/gui/link-tool.png b/docs/img/gui/link-tool.png
deleted file mode 100644
index 7772ecf..0000000
Binary files a/docs/img/gui/link-tool.png and /dev/null differ
diff --git a/docs/img/gui/minindnedit.png b/docs/img/gui/minindnedit.png
deleted file mode 100644
index 0fe6879..0000000
Binary files a/docs/img/gui/minindnedit.png and /dev/null differ
diff --git a/docs/img/gui/switch-tool.png b/docs/img/gui/switch-tool.png
deleted file mode 100644
index 919b11d..0000000
Binary files a/docs/img/gui/switch-tool.png and /dev/null differ
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..d7d8f01
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,29 @@
+.. Mini-NDN documentation master file, created by
+ sphinx-quickstart on Mon Sep 23 11:15:54 2019.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Mini-NDN: A Mininet-based NDN emulator
+======================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents
+
+ introduction
+ install
+ experiment
+ howtos
+ release-notes
+ faq
+ hackathon
+ videos
+
+Helpful Links
+-------------
+
+* `NDN Website `_
+* `NDN Contributor's Guide `_
+* `Mininet Documentation `_
+* `Mini-NDN redmine `_
+* `Mailing list `_
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..391fdfa
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,174 @@
+Install
+=======
+
+Prerequisites
+-------------
+
+For this guide, you will need a laptop/desktop with a recent version of
+a Linux distro that is supported by Mininet. For this guide, the *Ubuntu 18.04 LTS* release was used.
+Some tweaks maybe required to Mini-NDN's install.sh file for other distros.
+Note that you'll need administrative privileges in order to download and install
+extra packages and also to execute **Mini-NDN**.
+
+Using Vagrantfile
+-----------------
+
+With Vagrant installed, simply do ``vagrant up`` which will bring up an Ubuntu 18.04 virtual machine
+and install Mini-NDN and all its dependencies on it. Please make sure to tweak the CPU core count
+(default 4 cores) and RAM (default 4GB) according to your needs before doing vagrant up. Mini-NDN
+can be found in /home/vagrant/mini-ndn which is a symlink to /vagrant if Vagrantfile was used from within mini-ndn cloned on the host. Otherwise it is an actual clone of mini-ndn.
+
+Using install.sh
+----------------
+
+Mini-NDN depends on Mininet and NDN software to be installed in the system.
+If you have all the dependencies (see sections below) **installed in the system** simply
+clone this repository and run:
+
+::
+
+ ./install.sh -i
+
+The ``-i`` option uses ``setup.py develop`` to point the system install
+to the current directory. So any changes made to the cloned ``mini-ndn``
+folder will be used without having to install it again to the system.
+If you do not need to modify the core of Mini-NDN, then setup.py install (or pip install .)
+can be used directly. See :doc:`experiment ` for more information on running.
+
+If you don't have the dependencies, the following command will
+install them from source along with Mini-NDN. The dependencies include
+Mininet, NDN core (ndn-cxx, NFD, Chronosync, PSync, NLSR), Infoedit,
+and NDN Common Client Libraries (CCL). If you do not wish to install
+the master versions of the NDN core or want to switch to specific versions,
+you can edit the install.sh with release tags/specific versions.
+
+.. _scaling-note:
+.. important::
+ If you wish to scale Mini-NDN experiments and do not have use for security extensions
+ in your emulations, you should apply the ndn-cxx patch given in the ``patches`` folder
+ using ``./install.sh -p`` before running the following commands. The ndn-cxx patch is
+ taken from ndnSIM which provides an in-memory dummy KeyChain to reduce CPU computations.
+ After these patches are applied sleep time after NFD, nfdc, NLSR, etc. is not required
+ making the startup **MUCH** faster and scaling of Mini-NDN **MUCH** better.
+
+::
+
+ ./install.sh -a
+
+This pulls the NDN software from Github to ``ndn-src`` folder under the project.
+
+.. note::
+ If any changes are made to ``ndn-src`` folder, please don't forgot to re-install
+ the sources to the system.
+
+To install without CCL, use:
+
+::
+
+ ./install.sh -mni
+
+See ``install.sh -h`` for detailed options.
+
+Installing Dependencies
+-----------------------
+
+Mininet
+_______
+
+Mini-NDN is based on Mininet. To install Mininet:
+
+::
+
+ git clone --depth 1 https://github.com/mininet/mininet.git
+
+After Mininet source is on your system, run the following command to
+install Mininet core dependencies and Open vSwitch:
+
+::
+
+ ./util/install.sh -nv
+
+To check if Mininet is working correctly, run this test:
+
+::
+
+ sudo mn --test pingall
+
+This will print out a series of statements that show the test setup and
+the results of the test. Look for ``Results:`` two-thirds of the way
+down where it will indicate the percentage of dropped packets. Your
+results should show "0% dropped (2/2 received)".
+
+NOTE: Mini-NDN, while providing a high level of emulation of hosts,
+requires programs to be installed onto your computer. It will not work
+if they are not installed. If you do not want NDN software installed
+onto your computer, you can use a virtual machine, which can be quite
+simply set up with the provided Vagrantfile.
+
+NDN dependencies
+________________
+
+Each node in Mini-NDN will run the official implementation of NDN
+installed on your system. The following dependencies are needed:
+
+Mini-NDN uses NFD, NLSR, and ndn-tools.
+
+- To install NFD: https://named-data.net/doc/NFD/current/INSTALL.html
+- To install NLSR: https://named-data.net/doc/NLSR/current/INSTALL.html
+- To install ndn-tools: https://github.com/named-data/ndn-tools
+
+.. warning::
+ Please do not try to install NDN software from both the source (GitHub) and PPA (apt).
+ It will not work in most cases! If you used ./install.sh -a in the past but now want
+ to use apt, please run ``sudo ./waf uninstall`` in all the NDN projects before proceeding
+ with apt. Similarly, remove from apt if switching to source.
+
+Please see the :ref:`scaling-note ` to learn about disabling
+security for better scalability.
+
+Note that all three of these can be installed from the Named Data PPA.
+Instructions for setting it up can be found in the NFD installation
+instructions. Note that PPA and installs from source **cannot** be
+mixed. You must completely remove PPA installs from the system if switching
+to source and vice-versa.
+
+For PPA installs, if you are using a custom nfd.conf file in an experiment, you should
+place it in /usr/local/etc/ndn/ rather than /etc/ndn/. This is to avoid
+a bug from the default configuration file for the PPA, which is
+incompatible with Mini-NDN.
+
+Infoedit
+________
+
+Infoedit is used to edit configuration files for NFD and NLSR.
+To install infoedit:
+
+::
+
+ git clone --depth 1 https://github.com/NDN-Routing/infoedit
+ cd infoedit
+ make
+ sudo make install
+
+Verification
+------------
+
+You can execute the following example to bring up the Mini-NDN command line
+with NFD and NLSR running on each node:
+
+::
+
+ sudo python examples/mnndn.py
+
+You can use these steps to run the sample pingall experiment:
+
+1. Issue the command: ``sudo python examples/nlsr/pingall.py``
+2. When the ``mini-ndn>`` CLI prompt appears, the experiment has
+ finished. On the Mini-NDN CLI, issue the command ``exit`` to exit the
+ experiment.
+3. Issue the command:
+ ``grep -c content /tmp/minindn/*/ping-data/*.txt``. Each file should
+ report a count of 50.
+4. Issue the command:
+ ``grep -c timeout /tmp/minindn/*/ping-data/*.txt``. Each file should
+ report a count of 0.
diff --git a/docs/introduction.rst b/docs/introduction.rst
new file mode 100644
index 0000000..fe19ad8
--- /dev/null
+++ b/docs/introduction.rst
@@ -0,0 +1,40 @@
+Introduction
+=================
+
+If you are new to the NDN community of software generally, read the
+`Contributor's Guide `_.
+
+What is Mini-NDN?
+-----------------
+
+Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
+research on the NDN platform. It was initially based on `Mini-CCNx `_ which was a fork of `Mininet `_. Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the `NDN project `_ to emulate an NDN network on a single system.
+
+The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team.
+Mini-NDN is open to contribution from the public.
+
+.. image:: minindnnet.svg
+
+License
+_______
+
+Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all
+users and developers. For more information about licensing details and limitations,
+please refer to COPYING.md.
+
+Feedback/Mailing List
+_____________________
+
+Bug reports and feedback are highly appreciated and can be made through our
+`Redmine site `_ and the
+`mini-ndn mailing list `_.
+
+Video
+_____
+
+.. raw:: html
+
+
+
Mini-NDN (content maybe outdated)
+
+
\ No newline at end of file
diff --git a/docs/minindnnet.svg b/docs/minindnnet.svg
new file mode 100644
index 0000000..0bc985a
--- /dev/null
+++ b/docs/minindnnet.svg
@@ -0,0 +1,126 @@
+
\ No newline at end of file
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
new file mode 100644
index 0000000..79cbb0f
--- /dev/null
+++ b/docs/release-notes.rst
@@ -0,0 +1,186 @@
+Release Notes
+=============
+
+Mini-NDN version 0.4.0 (changes since version 0.3.0)
+----------------------------------------------------
+
+Release date: January 10, 2018
+
+**New features**:
+
+- Use SIGQUIT to quit Mini-NDN, SIGINT to kill programs
+
+- Use Infoedit to edit NFD and NLSR configuration files
+
+- Use nlsr.conf installed in the system
+
+- Provide a Vagrantfile to setup Mini-NDN and NDN
+
+- Provide option to disable NLSR
+
+- Provide an option to run NLSR in dry-run mode
+
+- Add option to specify whether to use TCP or UDP face in nlsr.conf
+
+- Add option to specify arbitrary arguments to use in experiments
+
+- Include a single option to install Mini-NDN and all the dependencies
+
+**Bug fixes**:
+
+- Fix "key does not exist error" after NLSR starts
+
+- Update install.sh to call ldconfig after installing ChronoSync
+
+- Add hyperbolic coordinates to default topology
+
+**Misc changes**:
+
+- Add an experiment to test nlsrc
+
+- Create faces in NFD for each neighbor in NLSR
+
+- Update to latest ndn-cxx
+
+- Use /tmp/minindn folder as default work dir instead of /tmp
+
+Mini-NDN version 0.3.0 (changes since version 0.2.0)
+----------------------------------------------------
+
+Release date: March 3, 2017
+
+**New features**:
+
+- Mini-NDN cluster edition
+
+- New experiments for making NLSR testing easier
+
+**Bug fixes**:
+
+- Set site name correctly
+
+- Install missing certificates in NLSR security config
+
+- Fix quitting of NLSR due to key not found error
+
+**Misc changes**:
+
+- Removed nlsr.conf file, generate it within the code
+
+- Use argparse instead of deprecated optparse
+
+- Update security config section for NLSR
+
+- Change mininet prompt to mini-ndn
+
+- Set network name at one place
+
+- Update install.sh script to install openssl
+
+- Update install.sh script to install cryptopp from package instead of
+ compiling from source
+
+- Update install.sh to clean build folder every time to get rid of
+ removed files such as old experiments
+
+- Fix old code - use net.hosts instead of storing hosts in a variable
+
+- Use nfdc instead of deprecated nfd-status
+
+Mini-NDN version 0.2.0 (changes since version 0.1.1)
+----------------------------------------------------
+
+Release date: August 18, 2016
+
+**New features**:
+
+- Automatic security configuration for NLSR
+
+- Use /usr/local/etc/ndn/nfd.conf as default config file for NFD
+
+- Class to monitor /proc/$PID/stat file for PID
+
+- Mini-NDN exits gracefully on SIGINT and non-convergence
+
+- Faster Mini-NDN install script - does not do apt-get update everytime
+
+- NLSR is launched with explicit config file for easier process
+ identification
+
+- Add and update more documentation
+
+**Bug fixes**:
+
+- NFD is killed correctly on exit
+
+- Best route strategy is set correctly
+
+Mini-NDN version 0.1.1 (changes since version 0.1.0)
+----------------------------------------------------
+
+Release date: November 4, 2015
+
+**New features**:
+
+- Use nfd.conf.sample from currently installed NFD
+
+- Add working directory option to allow execution environment outside
+ of /tmp
+
+- Add results directory option to store experiment results after
+ completion
+
+- Add support for switches in GUI and configuration file
+
+- Add failNode and recoverNode methods to Experiment class
+
+- Add most connected node (MCN) failure experiment
+
+- Add option to specify percentage of nodes pinged
+
+**Code changes**:
+
+- Refactor program options into container class
+
+- Remove unused "FIB Entries" option from NDN host options
+
+**Bug fixes**:
+
+- Abort start up if experiment name is invalid
+
+- Restart pings after recovery in failure experiment
+
+Mini-NDN version 0.1.0 (initial release)
+----------------------------------------
+
+Release date: July 15, 2015
+
+Mini-NDN is a lightweight networking emulation tool that enables
+testing, experimentation, and research on the NDN platform. Based on
+Mininet, Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released
+by the `NDN project `__ to
+emulate an NDN network on a single system.
+
+**Included features**:
+
+- Run a complete NDN network on a single system
+
+- Automatic configuration of NLSR to provide a routable NDN network
+
+- Supports user created NDN applications
+
+- Create a topology using the included Mini-NDN Edit GUI application
+
+- Allows individual configuration of NFD and NLSR parameters for each
+ node
+
+- Provides an experiment management framework for easy creation of
+ custom networking experiments
+
+- Uses a simple topology file format to define hosts, links, and
+ configuration values
+
+- Configure network link parameters including bandwidth, delay, and
+ loss rate
+
+- Includes a pre-configured topology file to replicate the NDN testbed
diff --git a/docs/videos.rst b/docs/videos.rst
new file mode 100644
index 0000000..b6b3a51
--- /dev/null
+++ b/docs/videos.rst
@@ -0,0 +1,18 @@
+Video Tutorials
+===============
+
+Maybe outdated since version 0.5.0.
+
+.. raw:: html
+
+