diff options
author | Guido Günther <agx@sigxcpu.org> | 2014-04-18 11:52:52 +0200 |
---|---|---|
committer | Guido Günther <agx@sigxcpu.org> | 2014-04-18 13:45:02 +0200 |
commit | 0e8224cf4b6d2a5ef6e8c7165dc6143db3cbc482 (patch) | |
tree | 5b090f39b251878aa32ea8f55ec2686bb7c9adb5 /whatmaps/command.py | |
parent | a785b391030e9a8936ae61c2de890082311a8c42 (diff) |
Use entrypoint
Diffstat (limited to 'whatmaps/command.py')
-rwxr-xr-x | whatmaps/command.py | 611 |
1 files changed, 611 insertions, 0 deletions
diff --git a/whatmaps/command.py b/whatmaps/command.py new file mode 100755 index 0000000..98de395 --- /dev/null +++ b/whatmaps/command.py @@ -0,0 +1,611 @@ +#!/usr/bin/python -u +# vim: set fileencoding=utf-8 : +# +# (C) 2010,2014 Guido Günther <agx@sigxcpu.org> +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +# + +import glob +import os +import logging +import re +import string +import subprocess +import sys +import errno +from optparse import OptionParser +try: + import apt_pkg +except ImportError: + apt_pkg = None +try: + import lsb_release +except ImportError: + lsb_release = None + + +class PkgError(Exception): + pass + + +class Process(object): + """A process - Linux only so far, needs /proc mounted""" + deleted_re = re.compile(r"(?P<exe>.*) \(deleted\)$") + + def __init__(self, pid): + self.pid = pid + self.mapped = [] + try: + self.exe = os.readlink('/proc/%d/exe' % self.pid) + m = self.deleted_re.match(self.exe) + if m: + self.exe = m.group('exe') + logging.debug("Using deleted exe %s", self.exe) + if not os.path.exists(self.exe): + logging.debug("%s doesn't exist", self.exe) + self.cmdline = open('/proc/%d/cmdline' % self.pid).read() + except OSError: + self.exe = None + self.cmdline = None + + def _read_maps(self): + """Read the SOs from /proc/<pid>/maps""" + try: + f = file('/proc/%d/maps' % self.pid) + except IOError as e: + # ignore killed process + if e.errno != errno.ENOENT: + raise + return + for line in f: + try: + so = line.split()[5].strip() + self.mapped.append(so) + except IndexError: + pass + + def maps(self, path): + """Check if the process maps the object at path""" + if not self.mapped: + self._read_maps() + + if path in self.mapped: + return True + else: + return False + + def __repr__(self): + return "<Process object pid:%d>" % self.pid + + +class Distro(object): + """ + A distribution + @cvar id: distro id as returned by lsb-release + """ + id = None + service_blacklist = set() + _pkg_services = {} + _pkg_blacklist = {} + + @classmethod + def pkg(klass, name): + """Return package object named name""" + raise NotImplementedError + + @classmethod + def pkg_by_file(klass, path): + """Return package object that contains path""" + raise NotImplementedError + + @classmethod + def restart_service_cmd(klass, service): + """Command to restart service""" + raise NotImplementedError + + @classmethod + def restart_service(klass, service): + """Restart a service""" + subprocess.call(klass.restart_service_cmd(service)) + + @classmethod + def pkg_services(klass, pkg): + """ + List of services that package pkg needs restarted that aren't part + of pkg itself + """ + try: + return klass._pkg_services[pkg.name] + except KeyError: + return [] + + @classmethod + def pkg_service_blacklist(klass, pkg): + """ + List of services in pkg that we don't want to be restarted even when + a binary from this package maps a shared lib that changed. + """ + try: + return klass._pkg_service_blacklist[pkg.name] + except KeyError: + return [] + + @classmethod + def has_apt(klass): + """Does the distribution use apt""" + return False + + +class Pkg(object): + """ + A package in a distribution + @var services: list of services provided by package + @var shared_objects: list of shared objects shipped in this package + @cvar type: package type (e.g. RPM or Debian) + @cvar _so_regex: regex that matches shared objects in the list returned by + _get_contents + @cvar _list_contents: command to list contents of a package, will be passed + to subprocess. "$pkg_name" will be replaced by the package + name. + """ + + type = None + services = None + shared_objects = None + _so_regex = re.compile(r'(?P<so>/.*\.so(\.[^/]*)$)') + _list_contents = None + + def __init__(self, name): + self.name = name + self._services = None + self._shared_objects = None + self._contents = None + + def __repr__(self): + return "<%s Pkg object name:'%s'>" % (self.type, self.name) + + def _get_contents(self): + """List of files in the package""" + if self._contents: + return self._contents + else: + cmd = [ string.Template(arg).substitute(arg, pkg_name=self.name) + for arg in self._list_contents ] + list_contents = subprocess.Popen(cmd, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + output = list_contents.communicate()[0] + if list_contents.returncode: + raise PkgError + self.contents = output.split('\n') + return self.contents + + +class DebianDistro(Distro): + "Debian (dpkg) based distribution""" + id = 'Debian' + + _pkg_services = { 'apache2-mpm-worker': [ 'apache2' ], + 'apache2-mpm-prefork': [ 'apache2' ], + 'apache2.2-bin': [ 'apache2' ], + 'dovecot-imapd': [ 'dovecot' ], + 'dovecot-pop3d': [ 'dovecot' ], + 'exim4-daemon-light': [ 'exim4' ], + 'exim4-daemon-heavy': [ 'exim4' ], + 'qemu-system-x86_64': [ 'libvirt-guests' ], + } + + # Per package blacklist + _pkg_service_blacklist = { 'libvirt-bin': [ 'libvirt-guests' ] } + + # Per distro blacklist + service_blacklist = set(['kvm', 'qemu-kvm', 'qemu-system-x86']) + + @classmethod + def pkg(klass, name): + return DebianPkg(name) + + @classmethod + def pkg_by_file(klass, path): + find_file = subprocess.Popen(['dpkg-query', '-S', path], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + output = find_file.communicate()[0] + if find_file.returncode: + return None + pkg = output.split(':')[0] + return DebianPkg(pkg) + + @classmethod + def restart_service_cmd(klass, name): + return ['invoke-rc.d', name, 'restart'] + + @classmethod + def has_apt(klass): + return True + + @staticmethod + def read_apt_pipeline(): + whatmaps_enabled = False + + version = sys.stdin.readline().rstrip() + if version != "VERSION 2": + logging.error("Wrong or missing VERSION from apt pipeline\n" + "(is Dpkg::Tools::Options::/usr/bin/whatmaps::Version set to 2?)") + raise PkgError + + while 1: + aptconfig = sys.stdin.readline() + if not aptconfig or aptconfig == '\n': + break + if aptconfig.startswith('Whatmaps::Enable-Restart=') and \ + aptconfig.strip().split('=', 1)[1].lower() in ["true", "1"]: + logging.debug("Service restarts enabled") + whatmaps_enabled = True + + if not whatmaps_enabled: + return None + + pkgs = {} + for line in sys.stdin.readlines(): + if not line: + break + (pkgname, oldversion, compare, newversion, filename) = line.split() + + if filename == '**CONFIGURE**': + if oldversion != '-': # Updates only + pkgs[pkgname] = DebianPkg(pkgname) + pkgs[pkgname].version = newversion + return pkgs + + + @classmethod + def _security_update_origins(klass): + "Determine security update origins from apt configuration" + codename = lsb_release.get_distro_information()['CODENAME'] + def _subst(line): + mapping = {'distro_codename' : codename, + 'distro_id' : klass.id, } + return string.Template(line).substitute(mapping) + + origins = [] + for s in apt_pkg.config.value_list('Whatmaps::Security-Update-Origins'): + (distro_id, distro_codename) = s.split() + origins.append((_subst(distro_id), + _subst(distro_codename))) + logging.debug("Security Update Origins: %s", origins) + return origins + + + @classmethod + def filter_security_updates(klass, pkgs): + """Filter on security updates""" + + apt_pkg.init() + acquire = apt_pkg.Acquire() + cache = apt_pkg.Cache() + + security_update_origins = klass._security_update_origins() + security_updates = {} + + for pkg in pkgs.values(): + cache_pkg = cache[pkg.name] + for cache_version in cache_pkg.version_list: + if pkg.version == cache_version.ver_str: + for pfile, _ in cache_version.file_list: + for origin in security_update_origins: + if pfile.origin == origin[0] and \ + pfile.archive == origin[1]: + security_updates[pkg] = pkg + break + return security_updates + + +class DebianPkg(Pkg): + type = 'Debian' + _init_script_re = re.compile('/etc/init.d/[\w\-\.]') + _list_contents = ['dpkg-query', '-L', '${pkg_name}' ] + + def __init__(self, name): + Pkg.__init__(self, name) + + @property + def shared_objects(self): + if self._shared_objects != None: + return self._shared_objects + + self._shared_objects = [] + contents = self._get_contents() + + for line in contents: + m = self._so_regex.match(line) + if m: + self._shared_objects.append(m.group('so')) + return self._shared_objects + + @property + def services(self): + if self._services != None: + return self._services + + self._services = [] + contents = self._get_contents() + # Only supports sysvinit so far: + for line in contents: + if self._init_script_re.match(line): + self._services.append(os.path.basename(line.strip())) + return self._services + + +class RedHatDistro(Distro): + "RPM based distribution""" + _pkg_re = re.compile(r'(?P<pkg>[\w\-\+]+)-(?P<ver>[\w\.]+)' + '-(?P<rel>[\w\.]+)\.(?P<arch>.+)') + + @classmethod + def pkg(klass, name): + return RpmPkg(name) + + @classmethod + def pkg_by_file(klass, path): + find_file = subprocess.Popen(['rpm', '-qf', path], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + output = find_file.communicate()[0] + if find_file.returncode: + return None + m = klass._pkg_re.match(output.strip()) + if m: + pkg = m.group('pkg') + else: + pkg = output.strip() + return RpmPkg(pkg) + + @classmethod + def restart_service_cmd(klass, name): + return ['service', name, 'restart'] + + +class FedoraDistro(RedHatDistro): + id = 'Fedora' + + +class RpmPkg(Pkg): + type = 'RPM' + _init_script_re = re.compile('/etc/rc.d/init.d/[\w\-\.]') + _list_contents = [ 'rpm', '-ql', '$pkg_name' ] + + def __init__(self, name): + Pkg.__init__(self, name) + + @property + def shared_objects(self): + if self._shared_objects != None: + return self._shared_objects + + self._shared_objects = [] + contents = self._get_contents() + + for line in contents: + m = self._so_regex.match(line) + if m: + self._shared_objects.append(m.group('so')) + return self._shared_objects + + @property + def services(self): + if self._services != None: + return self._services + + self._services = [] + contents = self._get_contents() + # Only supports sysvinit so far: + for line in contents: + if self._init_script_re.match(line): + self._services.append(os.path.basename(line.strip())) + return self._services + + +def check_maps(procs, shared_objects): + restart_procs = {} + for proc in procs: + for so in shared_objects: + if proc.maps(so): + if restart_procs.has_key(proc.exe): + restart_procs[proc.exe] += [ proc ] + else: + restart_procs[proc.exe] = [ proc ] + continue + return restart_procs + + +def get_all_pids(): + processes = [] + paths = glob.glob('/proc/[0-9]*') + + for path in paths: + p = Process(int(path.rsplit('/')[-1])) + processes.append(p) + + return processes + + +def detect_distro(): + id = None + + if lsb_release: + id = lsb_release.get_distro_information()['ID'] + else: + try: + lsb_cmd = subprocess.Popen(['lsb_release', '--id', '-s'], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + output = lsb_cmd.communicate()[0] + if not lsb_cmd.returncode: + id = output.strip() + except OSError: + # id is None in this case + pass + + if id == DebianDistro.id: + return DebianDistro + elif id == FedoraDistro.id: + return FedoraDistro + else: + if os.path.exists('/usr/bin/dpkg'): + logging.warning("Unknown distro but dpkg found, assuming Debian") + return DebianDistro + elif os.path.exists('/bin/rpm'): + logging.warning("Unknown distro but rpm found, assuming Fedora") + return FedoraDistro + else: + return None + + +def write_cmd_file(services, cmd_file, distro): + "Write out commands needed to restart the services to a file" + out = file(cmd_file, 'w') + print >>out, '#! /bin/sh' + for service in services: + logging.debug("Need to restart %s", service) + print >>out, " ".join(distro.restart_service_cmd(service)) + out.close() + os.chmod(cmd_file, 0755) + + +def main(argv): + shared_objects = [] + + parser = OptionParser(usage='%prog [options] pkg1 [pkg2 pkg3 pkg4]') + parser.add_option("--debug", action="store_true", dest="debug", + default=False, help="enable debug output") + parser.add_option("--verbose", action="store_true", dest="verbose", + default=False, help="enable verbose output") + parser.add_option("--restart", action="store_true", dest="restart", + default=False, help="Restart services") + parser.add_option("--print-cmds", dest="print_cmds", + help="Output restart commands to file instead of restarting") + parser.add_option("--apt", action="store_true", dest="apt", default=False, + help="Use in apt pipeline") + + (options, args) = parser.parse_args(argv[1:]) + + if options.debug: + level = logging.DEBUG + elif options.verbose: + level = logging.INFO + else: + level = logging.WARNING + + logging.basicConfig(level=level, + format='%(levelname)s: %(message)s') + + distro = detect_distro() + if not distro: + logging.error("Unsupported Distribution") + return 1 + else: + logging.debug("Detected distribution: '%s'", distro.id) + + if args: + pkgs = [ distro.pkg(arg) for arg in args ] + elif options.apt and distro.has_apt(): + try: + pkgs = distro.read_apt_pipeline() + except PkgError: + logging.error("Can't read apt pipeline") + return 1 + if not pkgs: + return 0 + pkgs = distro.filter_security_updates(pkgs) + logging.debug("Security Upgrades: %s" % pkgs) + else: + parser.print_help() + return 1 + + # Find shared objects of updated packages + for pkg in pkgs: + try: + shared_objects += pkg.shared_objects + except PkgError: + logging.error("Cannot parse contents of %s" % pkg.name) + return 1 + logging.debug("Found shared objects:") + map(lambda x: logging.debug(" %s", x), shared_objects) + + # Find processes that map them + restart_procs = check_maps(get_all_pids(), shared_objects) + logging.debug("Processes that map them:") + map(lambda (x, y): logging.debug(" Exe: %s Pids: %s", x, y), + restart_procs.items()) + + # Find packages that contain the binaries of these processes + pkgs = {} + for proc in restart_procs: + pkg = distro.pkg_by_file(proc) + if not pkg: + logging.warning("No package found for '%s' - restart manually" % proc) + else: + if pkgs.has_key(pkg.name): + pkgs[pkg.name].procs.append(proc) + else: + pkg.procs = [ proc ] + pkgs[pkg.name] = pkg + + logging.info("Packages that ship the affected binaries:") + map(lambda x: logging.info(" Pkg: %s, binaries: %s" % (x.name, x.procs)), + pkgs.values()) + + all_services = set() + try: + for pkg in pkgs.values(): + services = set(pkg.services + distro.pkg_services(pkg)) + services -= set(distro.pkg_service_blacklist(pkg)) + if not services: + logging.warning("No service script found in '%s' for '%s' " + "- restart manually" % (pkg.name, pkg.procs)) + else: + all_services.update(services) + all_services -= distro.service_blacklist + except NotImplementedError: + if level > logging.INFO: + logging.error("Getting Service listing not implemented " + "for distribution %s - rerun with --verbose to see a list" + "of binaries and packages to map a shared objects from %s", + distro.id, args) + return 1 + else: + return 0 + + if options.restart: + if options.print_cmds and all_services: + write_cmd_file(all_services, options.print_cmds, distro) + else: + for service in all_services: + logging.info("Restarting %s" % service) + distro.restart_service(service) + elif all_services: + print "Services that possibly need to be restarted:" + for s in all_services: + print s + + return 0 + +def run(): + return(main(sys.argv)) + +if __name__ == '__main__': + sys.exit(main(sys.argv)) + +# vim:et:ts=4:sw=4:et:sts=4:ai:set list listchars=tab\:»·,trail\:·: |