/
tools.py
652 lines (546 loc) · 20.8 KB
/
tools.py
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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# -*- python-indent: 4 -*-
"""A few things that didn't seem to fit anywhere else."""
import os
import os.path
import pwd
import tempfile
import fcntl
import errno
import threading
import subprocess
import shutil
import sys
import signal
import logger
PID_FILE = '/var/run/nodemanager.pid'
####################
def get_default_if():
interface = get_if_from_hwaddr(get_hwaddr_from_plnode())
if not interface:
interface = "eth0"
return interface
def get_hwaddr_from_plnode():
try:
for line in open("/usr/boot/plnode.txt", 'r').readlines():
if line.startswith("NET_DEVICE"):
return line.split("=")[1].strip().strip('"')
except:
pass
return None
def get_if_from_hwaddr(hwaddr):
import sioc
devs = sioc.gifconf()
for dev in devs:
dev_hwaddr = sioc.gifhwaddr(dev)
if dev_hwaddr == hwaddr:
return dev
return None
####################
# daemonizing
def as_daemon_thread(run):
"""
Call function <run> with no arguments in its own thread.
"""
thr = threading.Thread(target=run)
thr.setDaemon(True)
thr.start()
def close_nonstandard_fds():
"""
Close all open file descriptors other than 0, 1, and 2.
"""
_SC_OPEN_MAX = 4
for fd in range(3, os.sysconf(_SC_OPEN_MAX)):
try:
os.close(fd)
except OSError:
pass # most likely an fd that isn't open
# after http://www.erlenstar.demon.co.uk/unix/faq_2.html
def daemon():
"""
Daemonize the current process.
"""
if os.fork() != 0:
os._exit(0)
os.setsid()
if os.fork() != 0:
os._exit(0)
os.chdir('/')
os.umask(0o022)
devnull = os.open(os.devnull, os.O_RDWR)
os.dup2(devnull, 0)
# xxx fixme - this is just to make sure that nothing gets stupidly lost - should use devnull
crashlog = os.open('/var/log/nodemanager.daemon',
os.O_RDWR | os.O_APPEND | os.O_CREAT, 0o644)
os.dup2(crashlog, 1)
os.dup2(crashlog, 2)
def fork_as(su, function, *args):
"""
fork(), cd / to avoid keeping unused directories open, close all nonstandard
file descriptors (to avoid capturing open sockets), fork() again (to avoid
zombies) and call <function> with arguments <args> in the grandchild
process. If <su> is not None, set our group and user ids appropriately in
the child process.
"""
child_pid = os.fork()
if child_pid == 0:
try:
os.chdir('/')
close_nonstandard_fds()
if su:
pw_ent = pwd.getpwnam(su)
os.setegid(pw_ent[3])
os.seteuid(pw_ent[2])
child_pid = os.fork()
if child_pid == 0:
function(*args)
except:
os.seteuid(os.getuid()) # undo su so we can write the log file
os.setegid(os.getgid())
logger.log_exc("tools: fork_as")
os._exit(0)
else:
os.waitpid(child_pid, 0)
####################
# manage files
def pid_file():
"""
We use a pid file to ensure that only one copy of NM is running at a given
time. If successful, this function will write a pid file containing the pid
of the current process. The return value is the pid of the other running
process, or None otherwise.
"""
other_pid = None
if os.access(PID_FILE, os.F_OK): # check for a pid file
handle = open(PID_FILE) # pid file exists, read it
other_pid = int(handle.read())
handle.close()
# check for a process with that pid by sending signal 0
try:
os.kill(other_pid, 0)
except OSError as e:
if e.errno == errno.ESRCH:
other_pid = None # doesn't exist
else:
raise # who knows
if other_pid == None:
# write a new pid file
write_file(PID_FILE, lambda f: f.write(str(os.getpid())))
return other_pid
def write_file(filename, do_write, **kw_args):
"""
Write file <filename> atomically by opening a temporary file,
using <do_write> to write that file, and then renaming the temporary file.
"""
shutil.move(write_temp_file(do_write, **kw_args), filename)
def write_temp_file(do_write, mode=None, uidgid=None, binary=False):
fd, temporary_filename = tempfile.mkstemp()
if mode:
os.chmod(temporary_filename, mode)
if uidgid:
os.chown(temporary_filename, *uidgid)
open_mode = 'wb' if binary else 'w'
f = os.fdopen(fd, open_mode)
try:
do_write(f)
finally:
f.close()
return temporary_filename
def replace_file_with_string(target, new_contents,
chmod=None, remove_if_empty=False):
"""
Replace a target file with a new contents checks for changes: does not do
anything if previous state was already right can handle chmod if requested
can also remove resulting file if contents are void, if requested performs
atomically: writes in a tmp file, which is then renamed (from sliverauth
originally) returns True if a change occurred, or the file is deleted
"""
try:
with open(target) as feed:
current = feed.read()
except:
current = ""
if current == new_contents:
# if turns out to be an empty string, and remove_if_empty is set,
# then make sure to trash the file if it exists
if remove_if_empty and not new_contents and os.path.isfile(target):
logger.verbose(
"tools.replace_file_with_string: removing file {}".format(target))
try:
os.unlink(target)
finally:
return True
return False
# overwrite target file: create a temp in the same directory
path = os.path.dirname(target) or '.'
fd, name = tempfile.mkstemp('', 'repl', path)
os.write(fd, new_contents.encode())
os.close(fd)
if os.path.exists(target):
os.unlink(target)
shutil.move(name, target)
if chmod:
os.chmod(target, chmod)
return True
####################
# utilities functions to get (cached) information from the node
# get node_id from /etc/planetlab/node_id and cache it
_node_id = None
def node_id():
global _node_id
if _node_id is None:
try:
with open("/etc/planetlab/node_id") as f:
_node_id = int(f.read())
except:
_node_id = ""
return _node_id
_root_context_arch = None
def root_context_arch():
global _root_context_arch
if not _root_context_arch:
sp = subprocess.Popen(["uname", "-i"], stdout=subprocess.PIPE)
(_root_context_arch, _) = sp.communicate()
_root_context_arch = _root_context_arch.strip()
return _root_context_arch
####################
class NMLock:
def __init__(self, file):
logger.log("tools: Lock {} initialized.".format(file), 2)
self.fd = os.open(file, os.O_RDWR | os.O_CREAT, 0o600)
flags = fcntl.fcntl(self.fd, fcntl.F_GETFD)
flags |= fcntl.FD_CLOEXEC
fcntl.fcntl(self.fd, fcntl.F_SETFD, flags)
def __del__(self):
os.close(self.fd)
def acquire(self):
logger.log("tools: Lock acquired.", 2)
fcntl.lockf(self.fd, fcntl.LOCK_SH)
def release(self):
logger.log("tools: Lock released.", 2)
fcntl.lockf(self.fd, fcntl.LOCK_UN)
####################
# Utilities for getting the IP address of a LXC/Openvswitch slice. Do this by
# running ifconfig inside of the slice's context.
def get_sliver_process(slice_name, process_cmdline):
"""
Utility function to find a process inside of an LXC sliver. Returns
(cgroup_fn, pid). cgroup_fn is the filename of the cgroup file for
the process, for example /proc/2592/cgroup. Pid is the process id of
the process. If the process is not found then (None, None) is returned.
"""
try:
cmd = 'grep {} /proc/*/cgroup | grep freezer'.format(slice_name)
output = os.popen(cmd).readlines()
except:
# the slice couldn't be found
logger.log(
"get_sliver_process: couldn't find slice {}".format(slice_name))
return (None, None)
cgroup_fn = None
pid = None
for e in output:
try:
l = e.rstrip()
path = l.split(':')[0]
comp = l.rsplit(':')[-1]
slice_name_check = comp.rsplit('/')[-1]
# the lines below were added by Guilherme <gsm@machados.org>
# due to the LXC requirements
# What we have to consider here is that libervirt on Fedora 18
# uses the following line:
# /proc/1253/cgroup:6:freezer:/machine.slice/auto_sirius.libvirt-lxc
# While the libvirt on Fedora 20 and 21 uses the following line:
# /proc/1253/cgroup:6:freezer:/machine.slice/machine-lxc\x2del_sirius.scope
# Further documentation on:
# https://libvirt.org/cgroups.html#systemdScope
virt = get_node_virt()
if virt == 'lxc':
# This is for Fedora 20 or later
regexf20orlater = re.compile(r'machine-lxc\\x2d(.+).scope')
isf20orlater = regexf20orlater.search(slice_name_check)
if isf20orlater:
slice_name_check = isf20orlater.group(1)
else:
# This is for Fedora 18
slice_name_check = slice_name_check.rsplit('.')[0]
if (slice_name_check == slice_name):
slice_path = path
pid = slice_path.split('/')[2]
with open('/proc/{}/cmdline'.format(pid)) as cmdfile:
cmdline = cmdfile.read().rstrip('\n\x00')
if (cmdline == process_cmdline):
cgroup_fn = slice_path
break
except:
break
if (not cgroup_fn) or (not pid):
logger.log("get_sliver_process: process {} not running in slice {}"
.format(process_cmdline, slice_name))
return (None, None)
return (cgroup_fn, pid)
###################################################
# Added by Guilherme Sperb Machado <gsm@machados.org>
###################################################
try:
import re
import socket
import fileinput
except:
logger.log("Could not import 're', 'socket', or 'fileinput' python packages.")
# TODO: is there anything better to do if the "libvirt", "sliver_libvirt",
# and "sliver_lxc" are not in place?
try:
import libvirt
from sliver_libvirt import Sliver_Libvirt
import sliver_lxc
except:
logger.log("Could not import 'sliver_lxc' or 'libvirt' or 'sliver_libvirt'.")
###################################################
def get_sliver_ifconfig(slice_name, device="eth0"):
"""
return the output of "ifconfig" run from inside the sliver.
side effects: adds "/usr/sbin" to sys.path
"""
# See if setns is installed. If it's not then we're probably not running
# LXC.
if not os.path.exists("/usr/sbin/setns.so"):
return None
# setns is part of lxcsu and is installed to /usr/sbin
if not "/usr/sbin" in sys.path:
sys.path.append("/usr/sbin")
import setns
(cgroup_fn, pid) = get_sliver_process(slice_name, "/sbin/init")
if (not cgroup_fn) or (not pid):
return None
path = '/proc/{}/ns/net'.format(pid)
result = None
try:
setns.chcontext(path)
args = ["/sbin/ifconfig", device]
sub = subprocess.Popen(
args, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
sub.wait()
if (sub.returncode != 0):
logger.log("get_slice_ifconfig: error in ifconfig: {}".format(
sub.stderr.read()))
result = sub.stdout.read()
finally:
setns.chcontext("/proc/1/ns/net")
return result
def get_sliver_ip(slice_name):
ifconfig = get_sliver_ifconfig(slice_name)
if not ifconfig:
return None
for line in ifconfig.split("\n"):
if "inet addr:" in line:
# example: ' inet addr:192.168.122.189 Bcast:192.168.122.255 Mask:255.255.255.0'
parts = line.strip().split()
if len(parts) >= 2 and parts[1].startswith("addr:"):
return parts[1].split(":")[1]
return None
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Get the slice ipv6 address
# Only for LXC!
###################################################
def get_sliver_ipv6(slice_name):
ifconfig = get_sliver_ifconfig(slice_name)
if not ifconfig:
return None, None
# example: 'inet6 2001:67c:16dc:1302:5054:ff:fea7:7882 prefixlen 64 scopeid 0x0<global>'
prog = re.compile(
r'inet6\s+(.*)\s+prefixlen\s+(\d+)\s+scopeid\s+(.+)<global>')
for line in ifconfig.split("\n"):
search = prog.search(line)
if search:
ipv6addr = search.group(1)
prefixlen = search.group(2)
return (ipv6addr, prefixlen)
return None, None
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Check if the address is a AF_INET6 family address
###################################################
def is_valid_ipv6(ipv6addr):
try:
socket.inet_pton(socket.AF_INET6, ipv6addr)
except socket.error:
return False
return True
# this returns the kind of virtualization on the node
# either 'vs' or 'lxc'
# also caches it in /etc/planetlab/virt for next calls
# could be promoted to core nm if need be
virt_stamp = "/etc/planetlab/virt"
def get_node_virt():
try:
with open(virt_stamp) as f:
return f.read().strip()
except:
pass
logger.log("Computing virt..")
try:
virt = 'vs' if subprocess.call(['vserver', '--help']) == 0 else 'lxc'
except:
virt = 'lxc'
with open(virt_stamp, "w") as f:
f.write(virt)
return virt
# this return True or False to indicate that systemctl is present on that box
# cache result in memory as _has_systemctl
_has_systemctl = None
def has_systemctl():
global _has_systemctl
if _has_systemctl is None:
_has_systemctl = (subprocess.call(['systemctl', '--help']) == 0)
return _has_systemctl
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# This method was developed to support the ipv6 plugin
# Only for LXC!
###################################################
def reboot_slivers():
type = 'sliver.LXC'
# connecting to the libvirtd
connLibvirt = Sliver_Libvirt.getConnection(type)
domains = connLibvirt.listAllDomains()
for domain in domains:
try:
# set the flag VIR_DOMAIN_REBOOT_INITCTL, which uses "initctl"
result = domain.reboot(0x04)
if result == 0:
logger.log("tools: REBOOT {}".format(domain.name()))
else:
raise Exception()
except Exception as e:
logger.log("tools: FAILED to reboot {} ({})".format(
domain.name(), e))
logger.log(
"tools: Trying to DESTROY/CREATE {} instead...".format(domain.name()))
try:
result = domain.destroy()
if result == 0:
logger.log("tools: DESTROYED {}".format(domain.name()))
else:
logger.log(
"tools: FAILED in the DESTROY call of {}".format(domain.name()))
result = domain.create()
if result == 0:
logger.log("tools: CREATED {}".format(domain.name()))
else:
logger.log(
"tools: FAILED in the CREATE call of {}".format(domain.name()))
except Exception as e:
logger.log(
"tools: FAILED to DESTROY/CREATE {} ({})".format(domain.name(), e))
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Get the /etc/hosts file path
###################################################
def get_hosts_file_path(slicename):
containerDir = os.path.join(sliver_lxc.Sliver_LXC.CON_BASE_DIR, slicename)
return os.path.join(containerDir, 'etc', 'hosts')
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Search if there is a specific ipv6 address in the
# /etc/hosts file of a given slice
# If the parameter 'ipv6addr' is None, then search
# for any ipv6 address
###################################################
def search_ipv6addr_hosts(slicename, ipv6addr):
hostsFilePath = get_hosts_file_path(slicename)
found = False
try:
for line in fileinput.input(r'{}'.format(hostsFilePath)):
if ipv6addr is not None:
if re.search(r'{}'.format(ipv6addr), line):
found = True
else:
search = re.search(r'^(.*)\s+.*$', line)
if search:
ipv6candidate = search.group(1)
ipv6candidatestrip = ipv6candidate.strip()
valid = is_valid_ipv6(ipv6candidatestrip)
if valid:
found = True
fileinput.close()
return found
except:
logger.log("tools: FAILED to search {} in /etc/hosts file of slice={}"
.format(ipv6addr, slicename))
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Removes all ipv6 addresses from the /etc/hosts
# file of a given slice
###################################################
def remove_all_ipv6addr_hosts(slicename, node):
hostsFilePath = get_hosts_file_path(slicename)
try:
for line in fileinput.input(r'{}'.format(hostsFilePath), inplace=True):
search = re.search(
r'^(.*)\s+({}|{})$'.format(node, 'localhost'), line)
if search:
ipv6candidate = search.group(1)
ipv6candidatestrip = ipv6candidate.strip()
valid = is_valid_ipv6(ipv6candidatestrip)
if not valid:
print(line, end=' ')
fileinput.close()
logger.log("tools: REMOVED IPv6 address from /etc/hosts file of slice={}"
.format(slicename))
except:
logger.log("tools: FAILED to remove the IPv6 address from /etc/hosts file of slice={}"
.format(slicename))
###################################################
# Author: Guilherme Sperb Machado <gsm@machados.org>
###################################################
# Adds an ipv6 address to the /etc/hosts file within a slice
###################################################
def add_ipv6addr_hosts_line(slicename, node, ipv6addr):
hostsFilePath = get_hosts_file_path(slicename)
logger.log("tools: {}".format(hostsFilePath))
# debugging purposes:
#string = "127.0.0.1\tlocalhost\n192.168.100.179\tmyplc-node1-vm.mgmt.local\n"
#string = "127.0.0.1\tlocalhost\n"
try:
with open(hostsFilePath, "a") as file:
file.write(ipv6addr + " " + node + "\n")
file.close()
logger.log("tools: ADDED IPv6 address to /etc/hosts file of slice={}"
.format(slicename))
except:
logger.log("tools: FAILED to add the IPv6 address to /etc/hosts file of slice={}"
.format(slicename))
# how to run a command in a slice
# now this is a painful matter
# the problem is with capsh that forces a bash command to be injected in its exec'ed command
# so because lxcsu uses capsh, you cannot exec anything else than bash
# bottom line is, what actually needs to be called is
# vs: vserver exec slicename command and its arguments
# lxc: lxcsu slicename "command and its arguments"
# which, OK, is no big deal as long as the command is simple enough,
# but do not stretch it with arguments that have spaces or need quoting as that will become a nightmare
def command_in_slice(slicename, argv):
virt = get_node_virt()
if virt == 'vs':
return ['vserver', slicename, 'exec', ] + argv
elif virt == 'lxc':
# wrap up argv in a single string for -c
return ['lxcsu', slicename, ] + [" ".join(argv)]
logger.log("command_in_slice: WARNING: could not find a valid virt")
return argv
####################
def init_signals():
def handler(signum, frame):
logger.log("Received signal {} - exiting".format(signum))
os._exit(1)
signal.signal(signal.SIGHUP, handler)
signal.signal(signal.SIGQUIT, handler)
signal.signal(signal.SIGINT, handler)
signal.signal(signal.SIGTERM, handler)