import errno import glob import os import pprint import pwd import socket import stat import struct import sys import time from iotop import ioprio, vmstat from netlink import Connection, NETLINK_GENERIC, U32Attr, NLM_F_REQUEST from genetlink import Controller, GeNlMessage # # Check for requirements: # o Python >= 2.5 for AF_NETLINK sockets # o Linux >= 2.6.20 with I/O accounting # try: socket.NETLINK_ROUTE python25 = True except AttributeError: python25 = False ioaccounting = os.path.exists('/proc/self/io') if not python25 or not ioaccounting: def boolean2string(boolean): return boolean and 'Found' or 'Not found' print 'Could not run iotop as some of the requirements are not met:' print '- Python >= 2.5 for AF_NETLINK support:', boolean2string(python25) print '- Linux >= 2.6.20 with I/O accounting support ' \ '(CONFIG_TASKSTATS, CONFIG_TASK_DELAY_ACCT, ' \ 'CONFIG_TASK_IO_ACCOUNTING):', \ boolean2string(ioaccounting) sys.exit(1) class DumpableObject(object): """Base class for all objects that allows easy introspection when printed""" def __repr__(self): return '%s: %s>' % (str(type(self))[:-1], pprint.pformat(self.__dict__)) # # Interesting fields in a taskstats output # class Stats(DumpableObject): members_offsets = [ ('blkio_delay_total', 40), ('swapin_delay_total', 56), ('read_bytes', 248), ('write_bytes', 256), ('cancelled_write_bytes', 264) ] def __init__(self, task_stats_buffer): for name, offset in Stats.members_offsets: data = task_stats_buffer[offset:offset + 8] setattr(self, name, struct.unpack('Q', data)[0]) def accumulate(self, other_stats, operator=sum): """Returns a new Stats object built from operator(self, other_stats)""" delta_stats = Stats.__new__(Stats) for name, offset in Stats.members_offsets: self_value = getattr(self, name) other_value = getattr(other_stats, name) setattr(delta_stats, name, operator((self_value, other_value))) return delta_stats def delta(self, other_stats): """Returns self - other_stats""" def subtract((me, other)): return me - other return self.accumulate(other_stats, operator=subtract) def is_all_zero(self): for name, offset in Stats.members_offsets: if getattr(self, name) != 0: return False return True @staticmethod def build_all_zero(): stats = Stats.__new__(Stats) for name, offset in Stats.members_offsets: setattr(stats, name, 0) return stats # # Netlink usage for taskstats # TASKSTATS_CMD_GET = 1 TASKSTATS_CMD_ATTR_PID = 1 class TaskStatsNetlink(object): # Keep in sync with format_stats() and pinfo.did_some_io() def __init__(self, options): self.options = options self.connection = Connection(NETLINK_GENERIC) controller = Controller(self.connection) self.family_id = controller.get_family_id('TASKSTATS') def get_single_task_stats(self, pid): request = GeNlMessage(self.family_id, cmd=TASKSTATS_CMD_GET, attrs=[U32Attr(TASKSTATS_CMD_ATTR_PID, pid)], flags=NLM_F_REQUEST) request.send(self.connection) try: reply = self.connection.recv() except OSError, e: if e.errno == errno.ESRCH: # OSError: Netlink error: No such process (3) return raise if len(reply.payload) < 292: # Short reply return reply_data = reply.payload[20:] reply_length, reply_type = struct.unpack('HH', reply.payload[4:8]) reply_version = struct.unpack('H', reply.payload[20:22])[0] assert reply_length >= 288 assert reply_type == TASKSTATS_CMD_ATTR_PID + 3 assert reply_version >= 4 return Stats(reply_data) # # PIDs manipulations # def find_uids(options): """Build options.uids from options.users by resolving usernames to UIDs""" options.uids = [] error = False for u in options.users or []: try: uid = int(u) except ValueError: try: passwd = pwd.getpwnam(u) except KeyError: print >> sys.stderr, 'Unknown user:', u error = True else: uid = passwd.pw_uid if not error: options.uids.append(uid) if error: sys.exit(1) def safe_utf8_decode(s): try: return s.decode('utf-8') except UnicodeDecodeError: return s.encode('string_escape') class ThreadInfo(DumpableObject): """Stats for a single thread""" def __init__(self, tid): self.tid = tid self.mark = True self.stats_total = None self.stats_delta = None def get_ioprio(self): return ioprio.get(self.tid) def update_stats(self, stats): if not self.stats_total: self.stats_total = stats self.stats_delta = stats.delta(self.stats_total) self.stats_total = stats class ProcessInfo(DumpableObject): """Stats for a single process (a single line in the output): if options.processes is set, it is a collection of threads, otherwise a single thread.""" def __init__(self, pid): self.pid = pid self.uid = None self.user = None self.threads = {} # {tid: ThreadInfo} self.stats_delta = Stats.build_all_zero() self.stats_accum = Stats.build_all_zero() self.stats_accum_timestamp = time.time() def is_monitored(self, options): if (options.pids and not options.processes and self.pid not in options.pids): # We only monitor some threads, not this one return False if options.uids and self.get_uid() not in options.uids: # We only monitor some users, not this one return False return True def get_uid(self): if self.uid: return self.uid # uid in (None, 0) means either we don't know the UID yet or the process # runs as root so it can change its UID. In both cases it means we have # to find out its current UID. try: uid = os.stat('/proc/%d' % self.pid)[stat.ST_UID] except OSError: # The process disappeared uid = None if uid != self.uid: # Maybe the process called setuid() self.user = None return uid def get_user(self): uid = self.get_uid() if uid is not None and not self.user: try: self.user = safe_utf8_decode(pwd.getpwuid(uid).pw_name) except KeyError: self.user = str(uid) return self.user or '{none}' def get_proc_status_name(self): try: proc_status = open('/proc/%d/status' % self.pid) except IOError: return '{no such process}' first_line = proc_status.readline() prefix = 'Name:\t' if first_line.startswith(prefix): name = first_line[6:].strip() else: name = '' if name: name = '[%s]' % name else: name = '{no name}' return name def get_cmdline(self): # A process may exec, so we must always reread its cmdline try: proc_cmdline = open('/proc/%d/cmdline' % self.pid) cmdline = proc_cmdline.read(4096) except IOError: return '{no such process}' if not cmdline: # Probably a kernel thread, get its name from /proc/PID/status return self.get_proc_status_name() parts = cmdline.split('\0') if parts[0].startswith('/'): first_command_char = parts[0].rfind('/') + 1 parts[0] = parts[0][first_command_char:] cmdline = ' '.join(parts).strip() return safe_utf8_decode(cmdline) def did_some_io(self): return not all(t.stats_delta.is_all_zero() for t in self.threads.itervalues()) def get_ioprio(self): priorities = set(t.get_ioprio() for t in self.threads.itervalues()) if len(priorities) == 1: return priorities.pop() return '?' def ioprio_sort_key(self): return ioprio.sort_key(self.get_ioprio()) def get_thread(self, tid): thread = self.threads.get(tid, None) if not thread: thread = ThreadInfo(tid) self.threads[tid] = thread return thread def update_stats(self): stats_delta = Stats.build_all_zero() for tid, thread in self.threads.items(): if thread.mark: del self.threads[tid] else: stats_delta = stats_delta.accumulate(thread.stats_delta) nr_threads = len(self.threads) if not nr_threads: return False stats_delta.blkio_delay_total /= nr_threads stats_delta.swapin_delay_total /= nr_threads self.stats_delta = stats_delta self.stats_accum = self.stats_accum.accumulate(self.stats_delta) return True class ProcessList(DumpableObject): def __init__(self, taskstats_connection, options): # {pid: ProcessInfo} self.processes = {} self.taskstats_connection = taskstats_connection self.options = options self.timestamp = time.time() self.vmstat = vmstat.VmStat() # A first time as we are interested in the delta self.update_process_counts() def get_process(self, pid): """Either get the specified PID from self.processes or build a new ProcessInfo if we see this PID for the first time""" process = self.processes.get(pid, None) if not process: process = ProcessInfo(pid) self.processes[pid] = process if process.is_monitored(self.options): return process def list_tgids(self): if self.options.pids: for pid in self.options.pids: yield pid pattern = '/proc/[0-9]*' if not self.options.processes: pattern += '/task/*' for path in glob.iglob(pattern): yield int(os.path.basename(path)) def list_tids(self, tgid): if not self.options.processes: return [tgid] try: tids = map(int, os.listdir('/proc/%d/task' % tgid)) except OSError: return [] if self.options.pids: tids = list(set(self.options.pids).intersection(set(tids))) return tids def update_process_counts(self): new_timestamp = time.time() self.duration = new_timestamp - self.timestamp self.timestamp = new_timestamp for tgid in self.list_tgids(): process = self.get_process(tgid) if not process: continue for tid in self.list_tids(tgid): thread = process.get_thread(tid) stats = self.taskstats_connection.get_single_task_stats(tid) if stats: thread.update_stats(stats) thread.mark = False return self.vmstat.delta() def refresh_processes(self): for process in self.processes.itervalues(): for thread in process.threads.itervalues(): thread.mark = True total_read_and_write = self.update_process_counts() for pid, process in self.processes.items(): if not process.update_stats(): del self.processes[pid] return total_read_and_write def clear(self): self.processes = {}