Statistics
| Branch: | Tag: | Revision:

mininet / mininet / node.py @ 16c57ddb

History | View | Annotate | Download (11.6 KB)

1
#!/usr/bin/env python
2
'''Node objects for Mininet.'''
3

    
4
from subprocess import Popen, PIPE, STDOUT
5
import os, signal, sys, select
6
flush = sys.stdout.flush
7

    
8
from mininet.logging_mod import lg
9
from mininet.util import quietRun
10

    
11
class Node(object):
12
    '''A virtual network node is simply a shell in a network namespace.
13
       We communicate with it using pipes.'''
14
    inToNode = {}
15
    outToNode = {}
16

    
17
    def __init__(self, name, inNamespace = True):
18
        self.name = name
19
        closeFds = False # speed vs. memory use
20
        # xpg_echo is needed so we can echo our sentinel in sendCmd
21
        cmd = ['/bin/bash', '-O', 'xpg_echo']
22
        self.inNamespace = inNamespace
23
        if self.inNamespace:
24
            cmd = ['netns'] + cmd
25
        self.shell = Popen(cmd, stdin = PIPE, stdout = PIPE, stderr = STDOUT,
26
            close_fds = closeFds)
27
        self.stdin = self.shell.stdin
28
        self.stdout = self.shell.stdout
29
        self.pollOut = select.poll()
30
        self.pollOut.register(self.stdout)
31
        # Maintain mapping between file descriptors and nodes
32
        # This could be useful for monitoring multiple nodes
33
        # using select.poll()
34
        self.outToNode[self.stdout.fileno()] = self
35
        self.inToNode[self.stdin.fileno()] = self
36
        self.pid = self.shell.pid
37
        self.intfCount = 0
38
        self.intfs = [] # list of interface names, as strings
39
        self.ips = {}
40
        self.connection = {}
41
        self.waiting = False
42
        self.execed = False
43

    
44
    def fdToNode(self, f):
45
        '''Insert docstring.
46

47
        @param f unknown
48
        @return bool unknown
49
        '''
50
        node = self.outToNode.get(f)
51
        return node or self.inToNode.get(f)
52

    
53
    def cleanup(self):
54
        '''Help python collect its garbage.'''
55
        self.shell = None
56

    
57
    # Subshell I/O, commands and control
58
    def read(self, fileno_max):
59
        '''Insert docstring.
60

61
        @param fileno_max unknown
62
        '''
63
        return os.read(self.stdout.fileno(), fileno_max)
64

    
65
    def write(self, data):
66
        '''Write data to node.
67

68
        @param data string
69
        '''
70
        os.write(self.stdin.fileno(), data)
71

    
72
    def terminate(self):
73
        '''Send kill signal to Node and cleanup after it.'''
74
        os.kill(self.pid, signal.SIGKILL)
75
        self.cleanup()
76

    
77
    def stop(self):
78
        '''Stop node.'''
79
        self.terminate()
80

    
81
    def waitReadable(self):
82
        '''Poll on node.'''
83
        self.pollOut.poll()
84

    
85
    def sendCmd(self, cmd):
86
        '''Send a command, followed by a command to echo a sentinel,
87
           and return without waiting for the command to complete.'''
88
        assert not self.waiting
89
        if cmd[-1] == '&':
90
            separator = '&'
91
            cmd = cmd[:-1]
92
        else:
93
            separator = ';'
94
        if isinstance(cmd, list):
95
            cmd = ' '.join(cmd)
96
        self.write(cmd + separator + ' echo -n "\\0177" \n')
97
        self.waiting = True
98

    
99
    def monitor(self):
100
        '''Monitor the output of a command, returning (done, data).'''
101
        assert self.waiting
102
        self.waitReadable()
103
        data = self.read(1024)
104
        if len(data) > 0 and data[-1] == chr(0177):
105
            self.waiting = False
106
            return True, data[:-1]
107
        else:
108
            return False, data
109

    
110
    def sendInt(self):
111
        '''Send ^C, hopefully interrupting a running subprocess.'''
112
        self.write(chr(3))
113

    
114
    def waitOutput(self):
115
        '''Wait for a command to complete.
116
        
117
        Completion is signaled by a sentinel character, ASCII(127) appearing in
118
        the output stream.  Wait for the sentinel and return the output,
119
        including trailing newline.
120
        '''
121
        assert self.waiting
122
        output = ''
123
        while True:
124
            self.waitReadable()
125
            data = self.read(1024)
126
            if len(data) > 0  and data[-1] == chr(0177):
127
                output += data[:-1]
128
                break
129
            else: output += data
130
        self.waiting = False
131
        return output
132

    
133
    def cmd(self, cmd):
134
        '''Send a command, wait for output, and return it.
135

136
        @param cmd string
137
        '''
138
        self.sendCmd(cmd)
139
        return self.waitOutput()
140

    
141
    def cmdPrint(self, cmd):
142
        '''Call cmd and printing its output
143
        
144
        @param cmd string
145
        '''
146
        #lg.info('*** %s : %s', self.name, cmd)
147
        result = self.cmd(cmd)
148
        #lg.info('%s\n', result)
149
        return result
150

    
151
    # Interface management, configuration, and routing
152
    def intfName(self, n):
153
        '''Construct a canonical interface name node-intf for interface N.'''
154
        return self.name + '-eth' + repr(n)
155

    
156
    def newIntf(self):
157
        '''Reserve and return a new interface name.'''
158
        intfName = self.intfName(self.intfCount)
159
        self.intfCount += 1
160
        self.intfs += [intfName]
161
        return intfName
162

    
163
    def setIP(self, intf, ip, bits):
164
        '''Set the IP address for an interface.
165

166
        @param intf string, interface name
167
        @param ip IP address as integer
168
        @param bits
169
        '''
170
        result = self.cmd(['ifconfig', intf, ip + bits, 'up'])
171
        self.ips[intf] = ip
172
        return result
173

    
174
    def setHostRoute(self, ip, intf):
175
        '''Add route to host.
176

177
        @param ip IP address as dotted decimal
178
        @param intf string, interface name
179
        '''
180
        return self.cmd('route add -host ' + ip + ' dev ' + intf)
181

    
182
    def setDefaultRoute(self, intf):
183
        '''Set the default route to go through intf.
184

185
        @param intf string, interface name
186
        '''
187
        self.cmd('ip route flush')
188
        return self.cmd('route add default ' + intf)
189

    
190
    def IP(self):
191
        '''Return IP address of first interface'''
192
        if len(self.intfs) > 0:
193
            return self.ips.get(self.intfs[ 0 ], None)
194

    
195
    def intfIsUp(self):
196
        '''Check if one of our interfaces is up.'''
197
        return 'UP' in self.cmd('ifconfig ' + self.intfs[0])
198

    
199
    # Other methods
200
    def __str__(self):
201
        result = self.name + ':'
202
        if self.IP():
203
            result += ' IP=' + self.IP()
204
        result += ' intfs=' + ','.join(self.intfs)
205
        result += ' waiting=' + repr(self.waiting)
206
        return result
207

    
208

    
209
class Host(Node):
210
    '''A host is simply a Node.'''
211
    pass
212

    
213

    
214
class Controller(Node):
215
    '''A Controller is a Node that is running (or has execed) an
216
      OpenFlow controller.'''
217

    
218
    def __init__(self, name, inNamespace = False, controller = 'controller',
219
                 cargs = '-v ptcp:', cdir = None):
220
        self.controller = controller
221
        self.cargs = cargs
222
        self.cdir = cdir
223
        Node.__init__(self, name, inNamespace = inNamespace)
224

    
225
    def start(self):
226
        '''Start <controller> <args> on controller.
227

228
        Log to /tmp/cN.log
229
        '''
230
        cout = '/tmp/' + self.name + '.log'
231
        if self.cdir is not None:
232
            self.cmdPrint('cd ' + self.cdir)
233
        self.cmdPrint(self.controller + ' ' + self.cargs +
234
            ' 1> ' + cout + ' 2> ' + cout + ' &')
235
        self.execed = False # XXX Until I fix it
236

    
237
    def stop(self):
238
        '''Stop controller.'''
239
        self.cmd('kill %' + self.controller)
240
        self.terminate()
241

    
242

    
243
class Switch(Node):
244
    '''A Switch is a Node that is running (or has execed)
245
       an OpenFlow switch.'''
246

    
247
    def __init__(self, name, datapath = None):
248
        '''Init.
249

250
        @param name
251
        @param datapath string, datapath name
252
        '''
253
        self.dp = datapath
254
        Node.__init__(self, name, inNamespace = (datapath == None))
255

    
256
    def _startUserDatapath(self, controllers):
257
        '''Start OpenFlow reference user datapath.
258

259
        Log to /tmp/sN-{ofd,ofp}.log.
260

261
        @param controllers dict of controller names to objects
262
        '''
263
        if 'c0' not in controller:
264
            raise Exception('User datapath start() requires controller c0')
265
        controller = controllers['c0']
266
        ofdlog = '/tmp/' + self.name + '-ofd.log'
267
        ofplog = '/tmp/' + self.name + '-ofp.log'
268
        self.cmd('ifconfig lo up')
269
        intfs = self.intfs[1:] # 0 is mgmt interface
270
        self.cmdPrint('ofdatapath -i ' + ','.join(intfs) +
271
                      ' ptcp: 1> ' + ofdlog + ' 2> ' + ofdlog + ' &')
272
        self.cmdPrint('ofprotocol tcp:' + controller.IP() +
273
                      ' tcp:localhost --fail=closed 1> ' + ofplog + ' 2>' +
274
                      ofplog + ' &')
275

    
276
    def _stopUserDatapath(self):
277
        '''Stop OpenFlow reference user datapath.'''
278
        self.cmd('kill %ofdatapath')
279
        self.cmd('kill %ofprotocol')
280

    
281
    def _startKernelDatapath(self):
282
        '''Start up reference kernel datapath.'''
283
        ofplog = '/tmp/' + self.name + '-ofp.log'
284
        quietRun('ifconfig lo up')
285
        # Delete local datapath if it exists;
286
        # then create a new one monitoring the given interfaces
287
        quietRun('dpctl deldp ' + self.dp)
288
        self.cmdPrint('dpctl adddp ' + self.dp)
289
        self.cmdPrint('dpctl addif ' + self.dp + ' ' + ' '.join(self.intfs))
290
        # Run protocol daemon
291
        self.cmdPrint('ofprotocol' +
292
                      ' ' + self.dp + ' tcp:127.0.0.1 ' +
293
                      ' --fail=closed 1> ' + ofplog + ' 2>' + ofplog + ' &')
294
        self.execed = False # XXX until I fix it
295

    
296
    def _stopKernelDatapath(self):
297
        '''Terminate reference kernel datapath.'''
298
        quietRun('dpctl deldp ' + self.dp)
299
        # In theory the interfaces should go away after we shut down.
300
        # However, this takes time, so we're better off to remove them
301
        # explicitly so that we won't get errors if we run before they
302
        # have been removed by the kernel. Unfortunately this is very slow.
303
        self.cmd('kill %ofprotocol')
304
        for intf in self.intfs:
305
            quietRun('ip link del ' + intf)
306
            lg.info('.')
307

    
308
    def start(self, controllers):
309
        '''Start datapath.
310

311
        @param controllers dict of controller names to objects
312
        '''
313
        if self.dp is None:
314
            self._startUserDatapath(controllers)
315
        else:
316
            self._startKernelDatapath()
317

    
318
    def stop(self):
319
        '''Stop datapath.'''
320
        if self.dp is None:
321
            self._stopUserDatapath()
322
        else:
323
            self._stopKernelDatapath()
324

    
325
    def sendCmd(self, cmd):
326
        '''Send command to Node.
327

328
        @param cmd string
329
        '''
330
        if not self.execed:
331
            return Node.sendCmd(self, cmd)
332
        else:
333
            lg.error('*** Error: %s has execed and cannot accept commands' %
334
                     self.name)
335

    
336
    def monitor(self):
337
        '''Monitor node.'''
338
        if not self.execed:
339
            return Node.monitor(self)
340
        else:
341
            return True, ''
342

    
343

    
344
class NOX(Controller):
345
    '''Controller to run a NOX application.'''
346
    def __init__(self, name, inNamespace = False, nox_args = None, **kwargs):
347
        '''Init.
348

349
        @param name name to give controller
350
        @param nox_args list of args, or single arg, to pass to NOX
351
        '''
352
        if type(nox_args) != list:
353
            nox_args = [nox_args]
354
        if not nox_args:
355
            nox_args = ['packetdump']
356
        nox_core_dir = os.environ['NOX_CORE_DIR']
357
        if not nox_core_dir:
358
            raise Exception('please set NOX_CORE_DIR env var\n')
359
        Controller.__init__(self, name,
360
            controller = nox_core_dir + '/nox_core',
361
            cargs = '--libdir=/usr/local/lib -v -i ptcp: ' + \
362
                    ' '.join(nox_args),
363
            cdir = nox_core_dir, **kwargs)
364

    
365

    
366
class ControllerParams(object):
367
    '''Container for controller IP parameters.'''
368
    def __init__(self, ip, subnet_size):
369
        '''Init.
370

371
        @param ip integer, controller IP
372
        @param subnet_size integer, ex 8 for slash-8, covering 17M
373
        '''
374
        self.ip = ip
375
        self.subnet_size = subnet_size