1 # This program is free software; you can redistribute it and/or modify
2 # it under the terms of the GNU General Public License as published by
3 # the Free Software Foundation; either version 2 of the License, or
4 # (at your option) any later version.
6 # This program is distributed in the hope that it will be useful,
7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9 # GNU Library General Public License for more details.
11 # You should have received a copy of the GNU General Public License
12 # along with this program; if not, write to the Free Software
13 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15 # See the COPYING file for license information.
17 # Copyright (c) 2007 Guillaume Chazarain <guichaz@gmail.com>
29 # Check for requirements:
30 # o Linux >= 2.6.20 with I/O accounting and VM event counters
31 # o Python >= 2.5 or Python 2.4 + ctypes
34 ioaccounting
= os
.path
.exists('/proc/self/io')
44 from iotop
.vmstat
import VmStat
47 vm_event_counters
= False
49 vm_event_counters
= True
51 if not ioaccounting
or not has_ctypes
or not vm_event_counters
:
52 print 'Could not run iotop as some of the requirements are not met:'
53 if not ioaccounting
or not vm_event_counters
:
54 print '- Linux >= 2.6.20 with'
56 print ' - I/O accounting support ' \
57 '(CONFIG_TASKSTATS, CONFIG_TASK_DELAY_ACCT, ' \
58 'CONFIG_TASK_IO_ACCOUNTING)'
59 if not vm_event_counters
:
60 print ' - VM event counters (CONFIG_VM_EVENT_COUNTERS)'
62 print '- Python >= 2.5 or Python 2.4 with the ctypes module'
66 from iotop
import ioprio
, vmstat
67 from netlink
import Connection
, NETLINK_GENERIC
, U32Attr
, NLM_F_REQUEST
68 from genetlink
import Controller
, GeNlMessage
70 class DumpableObject(object):
71 """Base class for all objects that allows easy introspection when printed"""
73 return '%s: %s>' % (str(type(self
))[:-1], pprint
.pformat(self
.__dict
__))
77 # Interesting fields in a taskstats output
80 class Stats(DumpableObject
):
82 ('blkio_delay_total', 40),
83 ('swapin_delay_total', 56),
86 ('cancelled_write_bytes', 264)
89 has_blkio_delay_total
= False
91 def __init__(self
, task_stats_buffer
):
93 for name
, offset
in Stats
.members_offsets
:
94 data
= task_stats_buffer
[offset
:offset
+ 8]
95 sd
[name
] = struct
.unpack('Q', data
)[0]
97 # This is a heuristic to detect if CONFIG_TASK_DELAY_ACCT is enabled in
99 if not Stats
.has_blkio_delay_total
:
100 Stats
.has_blkio_delay_total
= self
.blkio_delay_total
!= 0
102 def accumulate(self
, other_stats
, destination
, coeff
=1):
103 """Update destination from operator(self, other_stats)"""
104 dd
= destination
.__dict
__
106 od
= other_stats
.__dict
__
107 for member
, offset
in Stats
.members_offsets
:
108 dd
[member
] = sd
[member
] + coeff
* od
[member
]
110 def delta(self
, other_stats
, destination
):
111 """Update destination with self - other_stats"""
112 return self
.accumulate(other_stats
, destination
, coeff
=-1)
114 def is_all_zero(self
):
116 for name
, offset
in Stats
.members_offsets
:
122 def build_all_zero():
123 stats
= Stats
.__new
__(Stats
)
125 for name
, offset
in Stats
.members_offsets
:
130 # Netlink usage for taskstats
133 TASKSTATS_CMD_GET
= 1
134 TASKSTATS_CMD_ATTR_PID
= 1
135 TASKSTATS_TYPE_AGGR_PID
= 4
136 TASKSTATS_TYPE_PID
= 1
137 TASKSTATS_TYPE_STATS
= 3
139 class TaskStatsNetlink(object):
140 # Keep in sync with format_stats() and pinfo.did_some_io()
142 def __init__(self
, options
):
143 self
.options
= options
144 self
.connection
= Connection(NETLINK_GENERIC
)
145 controller
= Controller(self
.connection
)
146 self
.family_id
= controller
.get_family_id('TASKSTATS')
148 def build_request(self
, tid
):
149 return GeNlMessage(self
.family_id
, cmd
=TASKSTATS_CMD_GET
,
150 attrs
=[U32Attr(TASKSTATS_CMD_ATTR_PID
, tid
)],
153 def get_single_task_stats(self
, thread
):
154 thread
.task_stats_request
.send(self
.connection
)
156 reply
= GeNlMessage
.recv(self
.connection
)
158 if e
.errno
== errno
.ESRCH
:
159 # OSError: Netlink error: No such process (3)
162 for attr_type
, attr_value
in reply
.attrs
.iteritems():
163 if attr_type
== TASKSTATS_TYPE_AGGR_PID
:
164 reply
= attr_value
.nested()
168 taskstats_data
= reply
[TASKSTATS_TYPE_STATS
].data
169 if len(taskstats_data
) < 272:
172 taskstats_version
= struct
.unpack('H', taskstats_data
[:2])[0]
173 assert taskstats_version
>= 4
174 return Stats(taskstats_data
)
180 def find_uids(options
):
181 """Build options.uids from options.users by resolving usernames to UIDs"""
184 for u
in options
.users
or []:
189 passwd
= pwd
.getpwnam(u
)
191 print >> sys
.stderr
, 'Unknown user:', u
196 options
.uids
.append(uid
)
200 def safe_utf8_decode(s
):
202 return s
.decode('utf-8')
203 except UnicodeDecodeError:
204 return s
.encode('string_escape')
206 class ThreadInfo(DumpableObject
):
207 """Stats for a single thread"""
208 def __init__(self
, tid
, taskstats_connection
):
211 self
.stats_total
= None
212 self
.stats_delta
= Stats
.__new
__(Stats
)
213 self
.task_stats_request
= taskstats_connection
.build_request(tid
)
215 def get_ioprio(self
):
216 return ioprio
.get(self
.tid
)
218 def set_ioprio(self
, ioprio_class
, ioprio_data
):
219 return ioprio
.set_ioprio(ioprio
.IOPRIO_WHO_PROCESS
, self
.tid
,
220 ioprio_class
, ioprio_data
)
222 def update_stats(self
, stats
):
223 if not self
.stats_total
:
224 self
.stats_total
= stats
225 stats
.delta(self
.stats_total
, self
.stats_delta
)
226 self
.stats_total
= stats
229 class ProcessInfo(DumpableObject
):
230 """Stats for a single process (a single line in the output): if
231 options.processes is set, it is a collection of threads, otherwise a single
233 def __init__(self
, pid
):
237 self
.threads
= {} # {tid: ThreadInfo}
238 self
.stats_delta
= Stats
.build_all_zero()
239 self
.stats_accum
= Stats
.build_all_zero()
240 self
.stats_accum_timestamp
= time
.time()
242 def is_monitored(self
, options
):
243 if (options
.pids
and not options
.processes
and
244 self
.pid
not in options
.pids
):
245 # We only monitor some threads, not this one
248 if options
.uids
and self
.get_uid() not in options
.uids
:
249 # We only monitor some users, not this one
257 # uid in (None, 0) means either we don't know the UID yet or the process
258 # runs as root so it can change its UID. In both cases it means we have
259 # to find out its current UID.
261 uid
= os
.stat('/proc/%d' % self
.pid
)[stat
.ST_UID
]
263 # The process disappeared
266 # Maybe the process called setuid()
273 if uid
is not None and not self
.user
:
275 self
.user
= safe_utf8_decode(pwd
.getpwuid(uid
).pw_name
)
278 return self
.user
or '{none}'
280 def get_proc_status_name(self
):
282 first_line
= open('/proc/%d/status' % self
.pid
).readline()
284 return '{no such process}'
286 if first_line
.startswith(prefix
):
287 name
= first_line
[6:].strip()
296 def get_cmdline(self
):
297 # A process may exec, so we must always reread its cmdline
299 proc_cmdline
= open('/proc/%d/cmdline' % self
.pid
)
300 cmdline
= proc_cmdline
.read(4096)
302 return '{no such process}'
304 # Probably a kernel thread, get its name from /proc/PID/status
305 return self
.get_proc_status_name()
306 parts
= cmdline
.split('\0')
307 if parts
[0].startswith('/'):
308 first_command_char
= parts
[0].rfind('/') + 1
309 parts
[0] = parts
[0][first_command_char
:]
310 cmdline
= ' '.join(parts
).strip()
311 return safe_utf8_decode(cmdline
)
313 def did_some_io(self
, accumulated
):
315 return not self
.stats_accum
.is_all_zero()
316 for t
in self
.threads
.itervalues():
317 if not t
.stats_delta
.is_all_zero():
321 def get_ioprio(self
):
322 priorities
= set(t
.get_ioprio() for t
in self
.threads
.itervalues())
323 if len(priorities
) == 1:
324 return priorities
.pop()
327 def set_ioprio(self
, ioprio_class
, ioprio_data
):
328 for thread
in self
.threads
.itervalues():
329 thread
.set_ioprio(ioprio_class
, ioprio_data
)
331 def ioprio_sort_key(self
):
332 return ioprio
.sort_key(self
.get_ioprio())
334 def get_thread(self
, tid
, taskstats_connection
):
335 thread
= self
.threads
.get(tid
, None)
337 thread
= ThreadInfo(tid
, taskstats_connection
)
338 self
.threads
[tid
] = thread
341 def update_stats(self
):
342 stats_delta
= Stats
.build_all_zero()
343 for tid
, thread
in self
.threads
.items():
345 del self
.threads
[tid
]
347 stats_delta
.accumulate(thread
.stats_delta
, stats_delta
)
349 nr_threads
= len(self
.threads
)
353 stats_delta
.blkio_delay_total
/= nr_threads
354 stats_delta
.swapin_delay_total
/= nr_threads
356 self
.stats_delta
= stats_delta
357 self
.stats_accum
.accumulate(self
.stats_delta
, self
.stats_accum
)
361 class ProcessList(DumpableObject
):
362 def __init__(self
, taskstats_connection
, options
):
365 self
.taskstats_connection
= taskstats_connection
366 self
.options
= options
367 self
.timestamp
= time
.time()
368 self
.vmstat
= vmstat
.VmStat()
370 # A first time as we are interested in the delta
371 self
.update_process_counts()
373 def get_process(self
, pid
):
374 """Either get the specified PID from self.processes or build a new
375 ProcessInfo if we see this PID for the first time"""
376 process
= self
.processes
.get(pid
, None)
378 process
= ProcessInfo(pid
)
379 self
.processes
[pid
] = process
381 if process
.is_monitored(self
.options
):
384 def list_tgids(self
):
385 if self
.options
.pids
:
386 return self
.options
.pids
388 tgids
= os
.listdir('/proc')
389 if self
.options
.processes
:
390 return [int(tgid
) for tgid
in tgids
if '0' <= tgid
[0] <= '9']
394 if '0' <= tgid
[0] <= '9':
396 tids
.extend(map(int, os
.listdir('/proc/' + tgid
+ '/task')))
402 def list_tids(self
, tgid
):
403 if not self
.options
.processes
:
407 tids
= map(int, os
.listdir('/proc/%d/task' % tgid
))
411 if self
.options
.pids
:
412 tids
= list(set(self
.options
.pids
).intersection(set(tids
)))
416 def update_process_counts(self
):
417 new_timestamp
= time
.time()
418 self
.duration
= new_timestamp
- self
.timestamp
419 self
.timestamp
= new_timestamp
421 for tgid
in self
.list_tgids():
422 process
= self
.get_process(tgid
)
425 for tid
in self
.list_tids(tgid
):
426 thread
= process
.get_thread(tid
, self
.taskstats_connection
)
427 stats
= self
.taskstats_connection
.get_single_task_stats(thread
)
429 thread
.update_stats(stats
)
432 return self
.vmstat
.delta()
434 def refresh_processes(self
):
435 for process
in self
.processes
.itervalues():
436 for thread
in process
.threads
.itervalues():
439 total_read_and_write
= self
.update_process_counts()
441 for pid
, process
in self
.processes
.items():
442 if not process
.update_stats():
443 del self
.processes
[pid
]
445 return total_read_and_write