2 # iotop: Display I/O usage of processes in a top like UI
3 # Copyright (c) 2007 Guillaume Chazarain <guichaz@yahoo.fr>, GPLv2
4 # See ./iotop.py --help for some help
18 # Check for requirements:
19 # o Python >= 2.5 for AF_NETLINK sockets
20 # o Linux >= 2.6.20 with I/O accounting
25 except AttributeError:
28 ioaccounting
= os
.path
.exists('/proc/self/io')
30 if not python25
or not ioaccounting
:
31 def boolean2string(boolean
):
32 return boolean
and 'Found' or 'Not found'
33 print 'Could not run iotop as some of the requirements are not met:'
34 print '- Python >= 2.5 for AF_NETLINK support:', boolean2string(python25
)
35 print '- Linux >= 2.6.20 with I/O accounting support:', \
36 boolean2string(ioaccounting
)
41 # Based on code from pynl80211: Netlink message generation/parsing
42 # http://git.sipsolutions.net/?p=pynl80211.git
43 # Copyright 2007 Johannes Berg <johannes@sipsolutions.net>
54 def __init__(self
, type, str, *kw
):
57 self
.data
= struct
.pack(str, *kw
)
62 hdr
= struct
.pack('HH', len(self
.data
)+4, self
.type)
63 length
= len(self
.data
)
64 pad
= ((length
+ 4 - 1) & ~
3 ) - length
65 return hdr
+ self
.data
+ '\0' * pad
68 return struct
.unpack('H', self
.data
)[0]
70 class NulStrAttr(Attr
):
71 def __init__(self
, type, str):
72 Attr
.__init
__(self
, type, '%dsB'%len(str), str, 0)
75 def __init__(self
, type, val
):
76 Attr
.__init
__(self
, type, 'L', val
)
81 def __init__(self
, tp
, flags
= 0, seq
= -1, payload
= []):
86 if type(payload
) == list:
89 contents
.append(attr
._dump
())
90 self
.payload
= ''.join(contents
)
92 self
.payload
= payload
99 length
= len(self
.payload
)
101 hdr
= struct
.pack('IHHII', length
+ 4*4, self
.type, self
.flags
,
103 conn
.send(hdr
+ self
.payload
)
106 def __init__(self
, nltype
, groups
=0, unexpected_msg_handler
= None):
107 self
.fd
= socket
.socket(socket
.AF_NETLINK
, socket
.SOCK_RAW
, nltype
)
108 self
.fd
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_SNDBUF
, 65536)
109 self
.fd
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_RCVBUF
, 65536)
110 self
.fd
.bind((0, groups
))
111 self
.pid
, self
.groups
= self
.fd
.getsockname()
113 self
.unexpected
= unexpected_msg_handler
119 cntnts
= self
.fd
.recv(65536)
120 # should check msgflags for TRUNC!
121 len, type, flags
, seq
, pid
= struct
.unpack('IHHII', cntnts
[:16])
122 m
= Message(type, flags
, seq
, cntnts
[16:])
124 if m
.type == NLMSG_ERROR
:
125 errno
= -struct
.unpack('i', m
.payload
[:4])[0]
127 e
= OSError('Netlink error: %s (%d)' % \
128 (os
.strerror(errno
), errno
))
136 def parse_attributes(str):
139 l
, tp
= struct
.unpack('HH', str[:4])
140 attrs
[tp
] = Attr(tp
, str[4:l
])
141 l
= ((l
+ 4 - 1) & ~
3 )
145 CTRL_CMD_GETFAMILY
= 3
147 CTRL_ATTR_FAMILY_ID
= 1
148 CTRL_ATTR_FAMILY_NAME
= 2
151 def __init__(self
, cmd
, version
= 0):
153 self
.version
= version
156 return struct
.pack('BBxx', self
.cmd
, self
.version
)
158 def _genl_hdr_parse(data
):
159 return GenlHdr(*struct
.unpack('BBxx', data
))
161 GENL_ID_CTRL
= NLMSG_MIN_TYPE
163 class GeNlMessage(Message
):
164 def __init__(self
, family
, cmd
, attrs
=[], flags
=0):
168 Message
.__init
__(self
, family
, flags
=flags
,
169 payload
=[GenlHdr(self
.cmd
)] + attrs
)
172 def __init__(self
, conn
):
175 def get_family_id(self
, family
):
176 a
= NulStrAttr(CTRL_ATTR_FAMILY_NAME
, family
)
177 m
= GeNlMessage(GENL_ID_CTRL
, CTRL_CMD_GETFAMILY
,
178 flags
=NLM_F_REQUEST
, attrs
=[a
])
181 gh
= _genl_hdr_parse(m
.payload
[:4])
182 attrs
= parse_attributes(m
.payload
[4:])
183 return attrs
[CTRL_ATTR_FAMILY_ID
].u16()
186 # Netlink usage for taskstats
189 TASKSTATS_CMD_GET
= 1
190 TASKSTATS_CMD_ATTR_PID
= 1
191 TASKSTATS_CMD_ATTR_TGID
= 2
193 class TaskStatsNetlink(object):
194 # Keep in sync with human_stats(stats, duration) and pinfo.did_some_io()
196 ('blkio_delay_total', 40),
197 ('swapin_delay_total', 56),
200 ('write_bytes', 256),
201 ('cancelled_write_bytes', 264)
204 def __init__(self
, options
):
205 self
.options
= options
206 self
.connection
= Connection(NETLINK_GENERIC
)
207 controller
= Controller(self
.connection
)
208 self
.family_id
= controller
.get_family_id('TASKSTATS')
210 def get_task_stats(self
, pid
):
211 if self
.options
.processes
:
212 attr
= TASKSTATS_CMD_ATTR_TGID
214 attr
= TASKSTATS_CMD_ATTR_PID
215 request
= GeNlMessage(self
.family_id
, cmd
=TASKSTATS_CMD_GET
,
216 attrs
=[U32Attr(attr
, pid
)],
218 request
.send(self
.connection
)
220 reply
= self
.connection
.recv()
222 if e
.errno
== errno
.ESRCH
:
223 # OSError: Netlink error: No such process (3)
226 if len(reply
.payload
) < 292:
229 reply_data
= reply
.payload
[20:]
231 reply_length
, reply_type
= struct
.unpack('HH', reply
.payload
[4:8])
232 reply_version
= struct
.unpack('H', reply
.payload
[20:22])[0]
233 assert reply_length
>= 288
234 assert reply_type
== attr
+ 3
235 assert reply_version
>= 4
238 for name
, offset
in TaskStatsNetlink
.members_offsets
:
239 data
= reply_data
[offset
: offset
+ 8]
240 res
[name
] = struct
.unpack('Q', data
)[0]
248 def find_uids(options
):
251 for u
in options
.users
or []:
256 passwd
= pwd
.getpwnam(u
)
258 print >> sys
.stderr
, 'Unknown user:', u
263 options
.uids
.append(uid
)
268 def __init__(self
, pid
, options
):
272 for name
, offset
in TaskStatsNetlink
.members_offsets
:
273 self
.stats
[name
] = (0, 0) # Total, Delta
274 self
.parse_status('/proc/%d/status' % pid
, options
)
276 def check_if_valid(self
, uid
, options
):
277 self
.valid
= options
.pids
or not options
.uids
or uid
in options
.uids
279 def parse_status(self
, path
, options
):
280 for line
in open(path
):
281 if line
.startswith('Name:'):
282 # Name kernel threads
283 self
.name
= '[' + line
.split()[1].strip() + ']'
284 elif line
.startswith('Uid:'):
285 uid
= int(line
.split()[1])
286 # We check monitored PIDs only here
287 self
.check_if_valid(uid
, options
)
289 self
.user
= pwd
.getpwuid(uid
).pw_name
294 def add_stats(self
, stats
):
295 self
.stats_timestamp
= time
.time()
296 for name
, value
in stats
.iteritems():
297 prev_value
= self
.stats
[name
][0]
298 self
.stats
[name
] = (value
, value
- prev_value
)
300 def get_cmdline(self
):
301 # A process may exec, so we must always reread its cmdline
303 proc_cmdline
= open('/proc/%d/cmdline' % self
.pid
)
305 return '{no such process}'
306 cmdline
= proc_cmdline
.read(4096)
307 parts
= cmdline
.split('\0')
308 first_command_char
= parts
[0].rfind('/') + 1
309 parts
[0] = parts
[0][first_command_char
:]
310 cmdline
= ' '.join(parts
).strip()
311 return cmdline
.encode('string_escape') or self
.name
313 def did_some_io(self
):
314 for name
in self
.stats
:
315 if name
!= 'ac_etime' and self
.stats
[name
][1]:
320 class ProcessList(object):
321 def __init__(self
, taskstats_connection
, options
):
324 self
.taskstats_connection
= taskstats_connection
325 self
.options
= options
327 # A first time as we are interested in the delta
328 self
.update_process_counts()
330 def get_process(self
, pid
):
331 process
= self
.processes
.get(pid
, None)
334 process
= pinfo(pid
, self
.options
)
336 # IOError: [Errno 2] No such file or directory: '/proc/...'
338 if not process
.valid
:
340 self
.processes
[pid
] = process
343 def list_pids(self
, tgid
):
344 if self
.options
.processes
or self
.options
.pids
:
347 return map(int, os
.listdir('/proc/%d/task' % tgid
))
351 def update_process_counts(self
):
352 total_read
= total_write
= duration
= 0
353 tgids
= self
.options
.pids
or [int(tgid
) for tgid
in os
.listdir('/proc')
354 if '0' <= tgid
[0] and tgid
[0] <= '9']
356 for pid
in self
.list_pids(tgid
):
357 process
= self
.get_process(pid
)
359 stats
= self
.taskstats_connection
.get_task_stats(pid
)
362 process
.add_stats(stats
)
363 total_read
+= process
.stats
['read_bytes'][1]
364 total_write
+= process
.stats
['write_bytes'][1]
366 duration
= process
.stats
['ac_etime'][1] / 1000000.0
367 return total_read
, total_write
, duration
369 def refresh_processes(self
):
370 for process
in self
.processes
.values():
372 total_read_and_write_and_duration
= self
.update_process_counts()
374 for pid
, process
in self
.processes
.iteritems():
376 to_delete
.append(pid
)
377 for pid
in to_delete
:
378 del self
.processes
[pid
]
379 return total_read_and_write_and_duration
382 # Utility functions for the UI
385 UNITS
= ['B', 'K', 'M', 'G', 'T', 'P', 'E']
387 def human_bandwidth(size
, duration
):
388 bw
= size
and float(size
) / duration
389 for i
in xrange(len(UNITS
) - 1, 0, -1):
392 res
= '%.2f %s' % ((float(bw
) / base
), UNITS
[i
])
395 res
= str(bw
) + ' ' + UNITS
[0]
398 def human_stats(stats
):
399 # Keep in sync with TaskStatsNetlink.members_offsets and
400 # IOTopUI.get_data(self)
401 duration
= stats
['ac_etime'][1] / 1000000.0
402 def delay2percent(name
): # delay in ns, duration in s
405 return '%.2f %%' % min(99.99, stats
[name
][1] / (duration
* 10000000.0))
406 io_delay
= delay2percent('blkio_delay_total')
407 swapin_delay
= delay2percent('swapin_delay_total')
408 read_bytes
= human_bandwidth(stats
['read_bytes'][1], duration
)
409 written_bytes
= stats
['write_bytes'][1] - stats
['cancelled_write_bytes'][1]
410 written_bytes
= max(0, written_bytes
)
411 write_bytes
= human_bandwidth(written_bytes
, duration
)
412 return io_delay
, swapin_delay
, read_bytes
, write_bytes
418 class IOTopUI(object):
421 (lambda p
: p
.pid
, False),
422 (lambda p
: p
.user
, False),
423 (lambda p
: p
.stats
['read_bytes'][1], True),
424 (lambda p
: p
.stats
['write_bytes'][1] -
425 p
.stats
['cancelled_write_bytes'][1], True),
426 (lambda p
: p
.stats
['swapin_delay_total'][1], True),
427 # The default sorting (by I/O % time) should show processes doing
428 # only writes, without waiting on them
429 (lambda p
: p
.stats
['blkio_delay_total'][1] or
430 int(not(not(p
.stats
['read_bytes'][1] or
431 p
.stats
['write_bytes'][1]))), True),
432 (lambda p
: p
.get_cmdline(), False),
435 def __init__(self
, win
, process_list
, options
):
436 self
.process_list
= process_list
437 self
.options
= options
439 self
.sorting_reverse
= IOTopUI
.sorting_keys
[5][1]
440 if not self
.options
.batch
:
443 curses
.use_default_colors()
448 # This call can fail with misconfigured terminals, for example
449 # TERM=xterm-color. This is harmless
453 self
.height
, self
.width
= self
.win
.getmaxyx()
458 if not self
.options
.batch
:
459 poll
.register(sys
.stdin
.fileno(), select
.POLLIN|select
.POLLPRI
)
460 while self
.options
.iterations
is None or \
461 iterations
< self
.options
.iterations
:
462 total
= self
.process_list
.refresh_processes()
463 total_read
, total_write
, duration
= total
464 self
.refresh_display(total_read
, total_write
, duration
)
465 if self
.options
.iterations
is not None:
467 if iterations
>= self
.options
.iterations
:
471 events
= poll
.poll(self
.options
.delay_seconds
* 1000.0)
472 except select
.error
, e
:
473 if e
.args
and e
.args
[0] == errno
.EINTR
:
477 if not self
.options
.batch
:
480 key
= self
.win
.getch()
483 def reverse_sorting(self
):
484 self
.sorting_reverse
= not self
.sorting_reverse
486 def adjust_sorting_key(self
, delta
):
487 orig_sorting_key
= self
.sorting_key
488 self
.sorting_key
+= delta
489 self
.sorting_key
= max(0, self
.sorting_key
)
490 self
.sorting_key
= min(len(IOTopUI
.sorting_keys
) - 1, self
.sorting_key
)
491 if orig_sorting_key
!= self
.sorting_key
:
492 self
.sorting_reverse
= IOTopUI
.sorting_keys
[self
.sorting_key
][1]
494 def handle_key(self
, key
):
501 lambda: self
.reverse_sorting(),
503 lambda: self
.reverse_sorting(),
505 lambda: self
.adjust_sorting_key(-1),
507 lambda: self
.adjust_sorting_key(1),
509 lambda: self
.adjust_sorting_key(-len(IOTopUI
.sorting_keys
)),
511 lambda: self
.adjust_sorting_key(len(IOTopUI
.sorting_keys
))
514 action
= key_bindings
.get(key
, lambda: None)
519 stats
= human_stats(p
.stats
)
520 io_delay
, swapin_delay
, read_bytes
, write_bytes
= stats
521 line
= '%5d %-8s %11s %11s %7s %7s ' % (p
.pid
, p
.user
[:8],
522 read_bytes
, write_bytes
, swapin_delay
, io_delay
)
523 if self
.options
.batch
:
524 max_cmdline_length
= 4096
526 max_cmdline_length
= self
.width
- len(line
)
527 line
+= p
.get_cmdline()[:max_cmdline_length
]
530 def should_format(p
):
531 return not self
.options
.only
or p
.did_some_io()
533 processes
= self
.process_list
.processes
.values()
534 key
= IOTopUI
.sorting_keys
[self
.sorting_key
][0]
535 processes
.sort(key
=key
, reverse
=self
.sorting_reverse
)
536 if not self
.options
.batch
:
537 del processes
[self
.height
- 2:]
538 return [format(p
) for p
in processes
if should_format(p
)]
540 def refresh_display(self
, total_read
, total_write
, duration
):
541 summary
= 'Total DISK READ: %s | Total DISK WRITE: %s' % (
542 human_bandwidth(total_read
, duration
),
543 human_bandwidth(total_write
, duration
))
544 titles
= [' PID', ' USER', ' DISK READ', ' DISK WRITE',
545 ' SWAPIN', ' IO', ' COMMAND']
546 lines
= self
.get_data()
547 if self
.options
.batch
:
549 print ''.join(titles
)
554 self
.win
.addstr(summary
)
555 self
.win
.hline(1, 0, ord(' ') | curses
.A_REVERSE
, self
.width
)
556 for i
in xrange(len(titles
)):
557 attr
= curses
.A_REVERSE
559 if i
== self
.sorting_key
:
560 attr |
= curses
.A_BOLD
561 title
+= self
.sorting_reverse
and '>' or '<'
562 self
.win
.addstr(title
, attr
)
563 for i
in xrange(len(lines
)):
564 self
.win
.insstr(i
+ 2, 0, lines
[i
])
567 def run_iotop(win
, options
):
568 taskstats_connection
= TaskStatsNetlink(options
)
569 process_list
= ProcessList(taskstats_connection
, options
)
570 ui
= IOTopUI(win
, process_list
, options
)
579 USAGE
= 'Usage: %s [OPTIONS]' % sys
.argv
[0] + '''
581 DISK READ and DISK WRITE are the block I/O bandwidth used during the sampling
582 period. SWAPIN and IO are the percentages of time the thread spent respectively
583 while swapping in and waiting on I/O more generally.
584 Controls: left and right arrows to show the sorting column, r to invert the
585 sorting order, q to quit, any other key to force a refresh'''
588 parser
= optparse
.OptionParser(usage
=USAGE
, version
='iotop ' + VERSION
)
589 parser
.add_option('-d', '--delay', type='float', dest
='delay_seconds',
590 help='delay between iterations [1 second]',
591 metavar
='SEC', default
=1)
592 parser
.add_option('-p', '--pid', type='int', dest
='pids', action
='append',
593 help='processes to monitor [all]', metavar
='PID')
594 parser
.add_option('-u', '--user', type='str', dest
='users', action
='append',
595 help='users to monitor [all]', metavar
='USER')
596 parser
.add_option('-b', '--batch', action
='store_true', dest
='batch',
597 help='non-interactive mode')
598 parser
.add_option('-P', '--processes', action
='store_true',
600 help='show only processes, not all threads')
601 parser
.add_option('-o', '--only', action
='store_true',
603 help='only show processes or threads actually doing I/O')
604 parser
.add_option('-n', '--iter', type='int', dest
='iterations',
606 help='number of iterations before ending [infinite]')
607 options
, args
= parser
.parse_args()
609 parser
.error('Unexpected arguments: ' + ' '.join(args
))
611 options
.pids
= options
.pids
or []
613 run_iotop(None, options
)
615 curses
.wrapper(run_iotop
, options
)
617 if __name__
== '__main__':
620 except KeyboardInterrupt: