Merge branch 'master' of github.com:simbricks/simbricks

.gitignore

@@ -4,6 +4,7 @@
 *.ko
 .*.cmd
 *.pyc
+*.swp
 __pycache__/
 _vimrc_local.vim
 sims/nic/corundum/obj_dir

README.md

@@ -15,33 +15,46 @@ Code structure:
     + `netsim_common/`: helper library for network simulations
     + `libnicbm/`: helper library for behavioral nic models
 
+# Dependencies
+
+ - Tested to work on Ubuntu 18.04
+ - Verilator (branch v4.010)
+ - unzip
+ - libpcap-dev
+ - libglib2.0-dev
+ - python (>= 3.7)
+ - libgoogle-perftools-dev
+ - libboost-iostreams-dev
+ - scons
+ - ninja-build
+ - libpixman-1-dev
+ - qemu
+
 # Building
- - `unzip`, `libpcap-dev`
- - External dependencies for qemu: `libglib2.0-dev libpixman-1-dev`
- - External dependencies for gem5: `scons`, `python-dev`, `libgoogle-perftools-dev`
 
-Then build everything with:
+First, initialize all submodules:
+```
+git submodule init
+git submodule update
+```
+
+Then, build the project, all submodules, and experiment images:
 ```
 make -j`nproc` all external build-images
 ```
 
+Note: building system images requires KVM support (and KVM permissions).
+
 # Running
 
-We use the scripts in the `experiments/` directory. `make` in that directory
-should run all the experiments for the paper. This will take a while (>>1h).
-While simulations can be run in parallel, some of them use a lot of core, and we
-currently don't have jobserver integration, so blindly running make with a high
-`-j` parameter here is a bad idea. You can run individual experiment (see
-`experiments/*` for their names) with `make out/$NAME/1/ready`, which will
-result in log files in `out/$NAME/1/`. Start with one of the qemu simulations.
-
-To run the experiments multiple times which restore from the common check point,
-the script should be added to EXP_CP in experiments/makefile. There should be a 
-pair script has "-mck" as suffix to that experiment script to make the check point.
-(eg. gem5-timing-corundum-verilator-pair-cp.sh AND gem5-timing-corundum-verilator-pair-cp-mck.sh)
-
-The script doesn't need to restore from the common check point, should be added to 
-EXP_NCP in experiments/makefile
+A list of available simulations is listed in `experiments/pyexps`.
+
+To run one of the simulations:
+```
+cd experiments
+python3 run.py pyexps/EXP
+```
+where `EXP` is the name of the simulation file.
 
 ## Running Qemu
 

experiments/simbricks/simulators.py

@@ -223,30 +223,30 @@ class CorundumVerilatorNIC(NICSim):
         return 512
 
     def run_cmd(self, env):
-        return self.basic_run_cmd(env, 'corundum/corundum_verilator',
+        return self.basic_run_cmd(env, 'sims/nic/corundum/corundum_verilator',
             str(self.clock_freq))
 
 class CorundumBMNIC(NICSim):
     def run_cmd(self, env):
-        return self.basic_run_cmd(env, 'corundum_bm/corundum_bm')
+        return self.basic_run_cmd(env, 'sims/nic/corundum_bm/corundum_bm')
 
 class I40eNIC(NICSim):
     def run_cmd(self, env):
-        return self.basic_run_cmd(env, 'i40e_bm/i40e_bm')
+        return self.basic_run_cmd(env, 'sims/nic/i40e_bm/i40e_bm')
 
 
 
 class WireNet(NetSim):
     def run_cmd(self, env):
         assert len(self.nics) == 2
-        return '%s/net_wire/net_wire %s %s %d %d %d' % \
-                (env.repodir + '/sims/net', env.nic_eth_path(self.nics[0]),
+        return '%s/sims/net/wire/net_wire %s %s %d %d %d' % \
+                (env.repodir, env.nic_eth_path(self.nics[0]),
                         env.nic_eth_path(self.nics[1]),
                         self.sync_mode, self.sync_period, self.eth_latency)
 
 class SwitchNet(NetSim):
     def run_cmd(self, env):
-        cmd = env.repodir  + '/sims/net' + '/switch/net_switch'
+        cmd = env.repodir + '/sims/net/switch/net_switch'
         cmd += f' -m {self.sync_mode} -S {self.sync_period} -E {self.eth_latency}'
         for n in self.nics:
             cmd += ' -s ' + env.nic_eth_path(n)
@@ -262,7 +262,7 @@ class NS3DumbbellNet(NetSim):
             else:
                 ports += '--CosimPortRight=' + env.nic_eth_path(n) + ' '
 
-        cmd = env.repodir  + '/sims/external' + '/ns-3' + '/cosim-run.sh cosim cosim-dumbbell-example ' + ports + ' ' + self.opt
+        cmd = env.repodir + '/sims/external/ns-3' + '/cosim-run.sh cosim cosim-dumbbell-example ' + ports + ' ' + self.opt
         print(cmd)
 
         return cmd
@@ -273,7 +273,7 @@ class NS3BridgeNet(NetSim):
         for n in self.nics:
             ports += '--CosimPort=' + env.nic_eth_path(n) + ' '
 
-        cmd = env.repodir + '/sims/external' + '/ns-3' + '/cosim-run.sh cosim cosim-bridge-example ' + ports + ' ' + self.opt
+        cmd = env.repodir + '/sims/external/ns-3' + '/cosim-run.sh cosim cosim-bridge-example ' + ports + ' ' + self.opt
         print(cmd)
 
         return cmd
@@ -290,7 +290,7 @@ class NS3SequencerNet(NetSim):
                 ports += '--EndhostSequencerPort=' + env.nic_eth_path(n) + ' '
             else:
                 raise Exception('Wrong NIC type')
-        cmd = env.repodir + '/sims/external' + '/ns-3' + '/cosim-run.sh sequencer sequencer-single-switch-example ' + ports + ' ' + self.opt
+        cmd = env.repodir + '/sims/external/ns-3' + '/cosim-run.sh sequencer sequencer-single-switch-example ' + ports + ' ' + self.opt
         return cmd