aboutsummaryrefslogtreecommitdiff
path: root/rumba/testbeds/dockertb.py
blob: d2a133445af87e5f7c2645f7d209eb08d8cd4fac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
#
# A library to manage ARCFIRE experiments
#
#    Copyright (C) 2017-2018 Nextworks S.r.l.
#    Copyright (C) 2017-2018 imec
#
#    Sander Vrijders   <sander.vrijders@ugent.be>
#    Dimitri Staessens <dimitri.staessens@ugent.be>
#    Vincenzo Maffione <v.maffione@nextworks.it>
#    Marco Capitani    <m.capitani@nextworks.it>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., http://www.fsf.org/about/contact/.
#

import os
from time import sleep
import docker
import subprocess

import rumba.model as mod
import rumba.log as log
from rumba.executors.docker import DockerExecutor

logger = log.get_logger(__name__)


class Testbed(mod.Testbed):
    """
    Represents a docker testbed.
    """
    def __init__(self, base_image=None, exp_name='foo',
                 pull_image=True, use_ovs=False):
        """
        Initializes the testbed class.

        :param exp_name: The experiment name.
        :param base_image: The docker base image.
        :param pull_image: Retrieve the docker image from the Docker hub?
        :param use_ovs: Use the OVS switch instead of the Linux bridge?

        .. note:: In case no base image is provided, Rumba will automatically
                  download the latest version available from docker hub.
        """
        mod.Testbed.__init__(self, exp_name, "", "", "rumba")

        self.base_image = base_image
        self.pull_image = pull_image
        self.use_ovs = use_ovs

        self.running_containers = {}
        self.active_bridges = set()
        self.active_ipcps = set()

        self.docker_client = docker.from_env()
        self.executor = DockerExecutor(self)

    def _swap_in(self, experiment):
        docker_client = self.docker_client

        if not self.base_image:
            if experiment.prototype_name() == 'ouroboros':
                self.base_image = 'arcfirerumba/ouroboros'
            else:
                raise Exception('Only Ouroboros supported for now.')

        img = self.base_image.rsplit(":", 1)

        self.base_image_repo = img[0]
        self.base_image_tag = "latest" if len(img) == 1 else img[1]
        self.base_image = "%s:%s" % (self.base_image_repo, self.base_image_tag)

        # Pull image
        if self.pull_image:
            logger.info("Fetching image...")
            docker_client.images.pull(self.base_image_repo,
                                      self.base_image_tag)

        docker_client.images.get("%s:%s" % (self.base_image_repo,
                                            self.base_image_tag))

        logger.info("Starting nodes...")

        # Start all nodes
        for node in experiment.nodes:
            logger.debug('Starting node %s', node.name)
            self.running_containers[node.name] = docker_client.containers.run(
                self.base_image, command=node.startup_command,
                name='node-' + node.name, detach=True, network="none",
                privileged=True, devices=["/dev/fuse"])

        cmd = 'sudo mkdir /var/run/netns'

        logger.debug('executing >> %s', cmd)

        if not os.path.exists("/var/run/netns"):
            subprocess.check_call(cmd.split())

        for shim in experiment.dif_ordering:
            if not isinstance(shim, mod.ShimEthDIF):
                # Nothing to do here
                continue

            cmd = ""
            if self.use_ovs:
                cmd += 'sudo ovs-vsctl add-br %(shim)s'
            else:
                cmd += 'sudo ip link add %(shim)s type bridge'
            cmd = cmd % {'shim': shim.name}

            self.active_bridges.add(shim.name)

            logger.debug('executing >> %s', cmd)

            subprocess.check_call(cmd.split())

            if not self.use_ovs:
                logger.debug('executing >> %s', cmd)
                cmd = 'sudo ip link set dev %(shim)s up' % {'shim': shim.name}
                subprocess.check_call(cmd.split())
        for node in experiment.nodes:
            container = self.running_containers[node.name]

            container.reload()

            state = container.attrs["State"]

            while not state["Running"]:
                sleep(0.2)
                container.reload()
                state = container.attrs["State"]

            pid = state["Pid"]

            cmd = ('sudo ln -s /proc/%(pid)i/ns/net '
                   '/var/run/netns/%(pid)i' % {'pid': pid})

            logger.debug('executing >> %s', cmd)

            subprocess.check_call(cmd.split())

            for ipcp in node.ipcps:
                if isinstance(ipcp, mod.ShimEthIPCP):
                    if ipcp.ifname is None:
                        ipcp.ifname = "e%i" % node.ipcps.index(ipcp)

                    # Linux has a limit on the length of interface names
                    node_name = node.name[0:11]

                    cmd = ('sudo ip link add %(node)s.%(ifname)s type veth '
                           'peer name _%(node)s.%(ifname)s'\
                           % {'node': node_name, 'ifname': ipcp.ifname})

                    logger.debug('executing >> %s', cmd)

                    subprocess.check_call(cmd.split())

                    cmd = ""
                    if self.use_ovs:
                        cmd += ('sudo ovs-vsctl add-port %(dif)s %(node)s.%('
                               'ifname)s')
                    else:
                        cmd += ('sudo ip link set %(node)s.%(ifname)s master '
                               '%(dif)s')

                    cmd = (cmd % {'node': node_name,
                                 'ifname': ipcp.ifname,
                                 'dif': ipcp.dif.name})

                    logger.debug('executing >> %s', cmd)

                    subprocess.check_call(cmd.split())

                    cmd = ('sudo ip link set _%(node)s.%(ifname)s '
                           'netns %(pid)i '
                           'name %(ifname)s'
                           % {'node': node_name,
                              'pid': pid,
                              'ifname': ipcp.ifname})

                    logger.debug('executing >> %s', cmd)
                    subprocess.check_call(cmd.split())

                    cmd = ('sudo ip link set dev %(node)s.%(ifname)s up'
                           % {'node': node_name, 'ifname': ipcp.ifname})
                    logger.debug('executing >> %s', cmd)
                    subprocess.check_call(cmd.split())

                    cmd = ('sudo ip netns exec %(pid)i ip link set dev '
                           '%(ifname)s up'
                           % {'pid': pid, 'ifname': ipcp.ifname})
                    logger.debug('executing >> %s', cmd)
                    subprocess.check_call(cmd.split())

                    self.active_ipcps.add(ipcp)

        logger.info("Experiment swapped in")

    def _swap_out(self, experiment):
        for name, container in self.running_containers.items():
            logger.debug('Stopping node %s' % name)
            container.remove(force=True)

        for shim in experiment.dif_ordering:
            if isinstance(shim, mod.ShimEthDIF) \
               and shim.name in self.active_bridges:
                cmd = ""
                if self.use_ovs:
                    cmd += 'sudo ovs-vsctl del-br %(shim)s'
                else:
                    cmd += 'sudo ip link del %(shim)s'
                cmd = cmd % {'shim': shim.name}

                logger.debug('executing >> %s', cmd)

                subprocess.check_call(cmd.split())

                self.active_bridges.remove(shim.name)

        for name, container in self.running_containers.items():
            pid = container.attrs["State"]["Pid"]

            if pid == 0:
                continue

            path = '/var/run/netns/%d' % pid
            if os.path.islink(path):
                cmd = 'sudo rm '+ path
                logger.debug('executing >> %s', cmd)
                subprocess.check_call(cmd.split())

        self.running_containers = {}

        logger.info("Experiment swapped out")