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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
|
# Copyright (c) 2012, Calxeda Inc.
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of Calxeda Inc. nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
# OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
# DAMAGE.
""" The controller object mediates between a UI and the application model.
In this case, the controller understands the model's container structure
and the objects it contains: tftp, images, and targets. """
import atexit
import os
import shutil
import tempfile
import threading
import time
import ConfigParser
import tarfile
from cxmanage.image import Image
from cxmanage.target import Target
from cxmanage.tftp import InternalTftp, ExternalTftp
from cxmanage.indicator import Indicator
from cxmanage.ubootenv import UbootEnv
class Controller:
""" The controller class serves as a manager for all the internals of
cxmanage. Scripts or UIs can build on top of this to provide an user
interface. """
def __init__(self, verbosity=0, max_threads=1,
image_class=Image, target_class=Target):
self.tftp = None
self.targets = []
self.images = []
self.verbosity = verbosity
self.max_threads = max_threads
self.target_class = target_class
self.image_class = image_class
self.work_dir = tempfile.mkdtemp(prefix="cxmanage-")
atexit.register(self._cleanup)
def _cleanup(self):
""" Clean up working directory and tftp server """
if os.path.exists(self.work_dir):
shutil.rmtree(self.work_dir)
########################### TFTP-specific methods ###########################
def set_internal_tftp_server(self, address=None, port=0):
""" Set up a TFTP server to be hosted locally """
self.tftp = InternalTftp(address, port, self.verbosity)
def set_external_tftp_server(self, address, port=69):
""" Set up a remote TFTP server """
self.tftp = ExternalTftp(address, port, self.verbosity)
########################### Images-specific methods ##########################
def add_image(self, filename, image_type, simg=None,
version=None, daddr=None, skip_crc32=False):
""" Add an image to our collection """
if image_type == "PACKAGE":
# Extract files and read config
try:
tarfile.open(filename, "r").extractall(self.work_dir)
except (IOError, tarfile.ReadError):
raise ValueError("%s is not a valid tar.gz file"
% os.path.basename(filename))
config = ConfigParser.SafeConfigParser()
if len(config.read(self.work_dir + "/MANIFEST")) == 0:
raise ValueError("%s is not a valid firmware package"
% os.path.basename(filename))
# Add all images from package
for section in config.sections():
filename = "%s/%s" % (self.work_dir, section)
image_type = config.get(section, "type").upper()
image_simg = simg
image_version = version
image_daddr = daddr
image_skip_crc32 = skip_crc32
# Read image options from config
if simg == None and config.has_option(section, "simg"):
image_simg = config.getboolean(section, "simg")
if version == None and config.has_option(section, "version"):
image_version = config.getint(section, "version")
if daddr == None and config.has_option(section, "daddr"):
image_daddr = int(config.get(section, "daddr"), 16)
if (skip_crc32 == False and
config.has_option(section, "skip_crc32")):
image_skip_crc32 = config.getboolean(section, "skip_crc32")
image = self.image_class(filename, image_type, image_simg,
image_version, image_daddr, image_skip_crc32)
self.images.append(image)
else:
image = self.image_class(filename, image_type,
simg, version, daddr, skip_crc32)
self.images.append(image)
def save_package(self, filename):
""" Save all images as a firmware package """
# Create the manifest
config = ConfigParser.SafeConfigParser()
for image in self.images:
section = os.path.basename(image.filename)
config.add_section(section)
config.set(section, "type", image.type)
config.set(section, "simg", str(image.simg))
if image.version != None:
config.set(section, "version", str(image.version))
if image.daddr != None:
config.set(section, "daddr", "%x" % image.daddr)
if image.skip_crc32:
config.set(section, "skip_crc32", str(image.skip_crc32))
manifest = open("%s/MANIFEST" % self.work_dir, "w")
config.write(manifest)
manifest.close()
# Create the tar.gz package
if filename.endswith("gz"):
tar = tarfile.open(filename, "w:gz")
elif filename.endswith("bz2"):
tar = tarfile.open(filename, "w:bz2")
else:
tar = tarfile.open(filename, "w")
tar.add("%s/MANIFEST" % self.work_dir, "MANIFEST")
for image in self.images:
tar.add(image.filename, os.path.basename(image.filename))
tar.close()
def print_images(self):
""" Print image info """
for image in self.images:
print "File: %s" % os.path.basename(image.filename)
print "Type: %s" % image.type
print "SIMG: %s" % image.simg
if image.version != None:
print "Version: %i" % image.version
if image.daddr != None:
print "Daddr: %x" % image.daddr
if image.skip_crc32:
print "Skip CRC32: %s" % image.skip_crc32
print
########################### Targets-specific methods #########################
def add_target(self, address, username, password, all_nodes=False):
""" Add the target to the list of targets for the group. """
# Do nothing if the target is already present
for target in self.targets:
if target.address == address:
return
target = self.target_class(address, username, password, self.verbosity)
if all_nodes:
for entry in target.get_ipinfo(self.tftp):
self.add_target(entry[1], username, password)
else:
self.targets.append(target)
def get_addresses_in_range(self, start, end):
""" Return a list of addresses in the given IP range """
try:
# Convert startaddr to int
start_bytes = map(int, start.split("."))
start_i = ((start_bytes[0] << 24) | (start_bytes[1] << 16)
| (start_bytes[2] << 8) | (start_bytes[3]))
# Convert endaddr to int
end_bytes = map(int, end.split("."))
end_i = ((end_bytes[0] << 24) | (end_bytes[1] << 16)
| (end_bytes[2] << 8) | (end_bytes[3]))
# Get ip addresses in range
addresses = []
for i in range(start_i, end_i + 1):
address_bytes = [(i >> (24 - 8 * x)) & 0xff for x in range(4)]
addresses.append("%i.%i.%i.%i" % tuple(address_bytes))
return addresses
except IndexError:
raise ValueError("Invalid arguments to get_targets_in_range")
######################### Execution methods #########################
def power(self, mode):
""" Send the given power command to all targets """
if self.verbosity >= 1:
print "Sending power %s command to these hosts:" % mode
for target in self.targets:
print target.address
print
results, errors = self._run_command("set_power", mode)
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def power_status(self):
""" Retrieve power status from all targets in group """
results, errors = self._run_command("get_power")
# Print results
if len(results) > 0:
print "Power status"
for target in self.targets:
if target.address in results:
if results[target.address]:
result = "on"
else:
result = "off"
print "%s: %s" % (target.address.ljust(16), result)
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def power_policy(self, mode):
""" Set the power policy for all targets """
if self.verbosity >= 1:
print "Setting power policy on these hosts:"
for target in self.targets:
print target.address
print
results, errors = self._run_command("set_power_policy", mode)
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def power_policy_status(self):
""" Get power policy status for all targets """
results, errors = self._run_command("get_power_policy")
# Print results
if len(results) > 0:
print "Power policy status"
for target in self.targets:
if target.address in results:
print "%s: %s" % (target.address.ljust(16),
results[target.address])
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def mc_reset(self):
""" Send an MC reset command to all targets """
if self.verbosity >= 1:
print "Sending MC reset command to these hosts:"
for target in self.targets:
print target.address
print
results, errors = self._run_command("mc_reset")
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def update_firmware(self, partition_arg="INACTIVE"):
""" Send firmware update commands to all targets in group. """
if self.verbosity >= 1:
print "Updating firmware on these hosts:"
for target in self.targets:
print target.address
print
# Get results and errors
results, errors = self._run_command("update_firmware",
self.tftp, self.images, partition_arg)
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def get_sensors(self, name=""):
""" Get sensor readings from all targets """
results, errors = self._run_command("get_sensors", name)
if len(results) > 0:
# Get sensor names
sensor_names = []
for address in results:
for sensor in results[address]:
sensor_name = sensor.sensor_name
if not sensor_name in sensor_names:
sensor_names.append(sensor_name)
# Print all sensors
for sensor_name in sensor_names:
print sensor_name
count = 0
average = 0.0
for target in self.targets:
address = target.address
if address in results:
try:
sensor = [x for x in results[address]
if x.sensor_name == sensor_name][0]
reading = sensor.sensor_reading.replace(
"(+/- 0) ", "")
# Add to average and print
try:
value = float(reading.split()[0])
if average != None:
count += 1
average += value
suffix = reading.lstrip("%f " % value)
print "%s: %.2f %s" % (address.ljust(16),
value, suffix)
except ValueError:
average = None
print "%s: %s" % (address.ljust(16), reading)
except IndexError:
pass
# Print average
if count > 1 and average != None:
average /= count
print "%s: %.2f %s" % ("Average".ljust(16),
average, suffix)
print
self._print_errors(errors)
return len(errors) > 0
def get_ipinfo(self):
""" Get IP info from all targets """
results, errors = self._run_command("get_ipinfo", self.tftp)
# Print results
if len(results) > 0:
for target in self.targets:
if target.address in results:
print "IP info from %s" % target.address
ipinfo = results[target.address]
for entry in ipinfo:
print "Node %i: %s" % entry
print
self._print_errors(errors)
return len(errors) > 0
def get_macaddrs(self):
""" Get mac addresses from all targets """
results, errors = self._run_command("get_macaddrs", self.tftp)
# Print results
if len(results) > 0:
for target in self.targets:
if target.address in results:
print "Mac addresses from %s" % target.address
macaddrs = results[target.address]
for entry in macaddrs:
print "Node %i, Port %i: %s" % entry
if target != self.targets[-1] or len(errors) > 0:
print
self._print_errors(errors)
return len(errors) > 0
def config_reset(self):
""" Send config reset command to all targets """
if self.verbosity >= 1:
print "Resetting configuration on these hosts:"
for target in self.targets:
print target.address
print
results, errors = self._run_command("config_reset", self.tftp)
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def config_boot(self, boot_args):
""" Send config boot command to all targets """
# Make sure boot_args are valid
try:
UbootEnv().set_boot_order(boot_args)
except ValueError as e:
print e
return True
if self.verbosity >= 1:
print "Setting boot order on these hosts:"
for target in self.targets:
print target.address
print
results, errors = self._run_command("set_boot_order",
self.tftp, boot_args)
if self.verbosity >= 1 and len(errors) == 0:
print "Command completed successfully.\n"
self._print_errors(errors)
return len(errors) > 0
def config_boot_status(self):
""" Get boot order from all targets """
results, errors = self._run_command("get_boot_order", self.tftp)
# Print results
if len(results) > 0:
print "Boot order"
for target in self.targets:
if target.address in results:
print "%s: %s" % (target.address.ljust(16),
",".join(results[target.address]))
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def info_basic(self):
""" Get basic SoC info from all targets """
results, errors = self._run_command("info_basic")
# Print results
if len(results) > 0:
for target in self.targets:
if target.address in results:
result = results[target.address]
print "[ Info from %s ]" % target.address
print result.header
print " Version: %s" % result.version
print " Build Number: %s" % result.build_number
print " Timestamp (%s): %s" % (result.timestamp,
time.ctime(int(result.timestamp)))
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def info_ubootenv(self):
""" Print u-boot environment for all targets """
results, errors = self._run_command("get_ubootenv", self.tftp)
# Print results
if len(results) > 0:
for target in self.targets:
if target.address in results:
ubootenv = results[target.address]
print "[ U-Boot Environment from %s ]" % target.address
for variable in ubootenv.variables:
print "%s=%s" % (variable, ubootenv.variables[variable])
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def info_dump(self):
""" Dump info from all targets """
for target in self.targets:
print "[ Info dump from %s ]" % target.address
target.info_dump(self.tftp)
return False
def ipmitool_command(self, ipmitool_args):
""" Run an arbitrary ipmitool command on all targets """
results, errors = self._run_command("ipmitool_command", ipmitool_args)
# Print results
if len(results) > 0:
for target in self.targets:
if target.address in results and results[target.address] != "":
print "[ IPMItool output from %s ]" % target.address
print results[target.address]
print
# Print errors
self._print_errors(errors)
return len(errors) > 0
def _run_command(self, name, *args):
""" Run a target command with multiple threads
Returns (results, errors) which map addresses to their results """
threads = set()
results = {}
errors = {}
# Start indicator
indicator = Indicator(self.targets, results, errors)
if self.verbosity == 1:
indicator.start()
for target in self.targets:
# Wait while we have too many running threads
while len(threads) >= self.max_threads:
time.sleep(0.001)
for thread in threads:
if not thread.is_alive():
threads.remove(thread)
if thread.error == None:
results[thread.target.address] = thread.result
else:
errors[thread.target.address] = thread.error
break
# Start the new thread
thread = ControllerCommandThread(target, name, args)
thread.start()
threads.add(thread)
# Join with any remaining threads
while len(threads) > 0:
time.sleep(0.001)
for thread in threads:
if not thread.is_alive():
threads.remove(thread)
if thread.error == None:
results[thread.target.address] = thread.result
else:
errors[thread.target.address] = thread.error
break
# Stop indicator
if self.verbosity == 1:
indicator.stop()
print "\n"
return results, errors
def _print_errors(self, errors):
""" Print errors if they occured """
if len(errors) > 0:
print "Command failed on these hosts"
for target in self.targets:
if target.address in errors:
print "%s: %s" % (target.address.ljust(16),
errors[target.address])
print
class ControllerCommandThread(threading.Thread):
""" Thread for executing a command on a target """
def __init__(self, target, name, args):
threading.Thread.__init__(self)
self.daemon = True
self.target = target
self.function = getattr(target, name)
self.args = args
self.result = None
self.error = None
def run(self):
try:
self.result = self.function(*self.args)
except Exception as e:
self.error = e
|