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>
30 from iotop
.data
import find_uids
, TaskStatsNetlink
, ProcessList
, Stats
31 from iotop
.data
import ThreadInfo
32 from iotop
.version
import VERSION
34 from ioprio
import IoprioSetError
37 # Utility functions for the UI
40 UNITS
= ['B', 'K', 'M', 'G', 'T', 'P', 'E']
51 expo
= int(math
.log(size
/ 2, 2) / 10)
52 return '%s%.2f %s' % (sign
, (float(size
) / (1 << (10 * expo
))), UNITS
[expo
])
54 def format_size(options
, bytes
):
56 return '%.2f K' % (bytes
/ 1024.0)
57 return human_size(bytes
)
59 def format_bandwidth(options
, size
, duration
):
60 return format_size(options
, size
and float(size
) / duration
) + '/s'
62 def format_stats(options
, process
, duration
):
63 # Keep in sync with TaskStatsNetlink.members_offsets and
64 # IOTopUI.get_data(self)
65 def delay2percent(delay
): # delay in ns, duration in s
66 return '%.2f %%' % min(99.99, delay
/ (duration
* 10000000.0))
67 if options
.accumulated
:
68 stats
= process
.stats_accum
69 display_format
= lambda size
, duration
: format_size(options
, size
)
70 duration
= time
.time() - process
.stats_accum_timestamp
72 stats
= process
.stats_delta
73 display_format
= lambda size
, duration
: format_bandwidth(
74 options
, size
, duration
)
75 io_delay
= delay2percent(stats
.blkio_delay_total
)
76 swapin_delay
= delay2percent(stats
.swapin_delay_total
)
77 read_bytes
= display_format(stats
.read_bytes
, duration
)
78 written_bytes
= stats
.write_bytes
- stats
.cancelled_write_bytes
79 written_bytes
= max(0, written_bytes
)
80 write_bytes
= display_format(written_bytes
, duration
)
81 return io_delay
, swapin_delay
, read_bytes
, write_bytes
83 def get_max_pid_width():
85 return len(file('/proc/sys/kernel/pid_max').read().strip())
88 # Reasonable default in case something fails
91 MAX_PID_WIDTH
= get_max_pid_width()
97 class CancelInput(Exception): pass
98 class InvalidInt(Exception): pass
99 class InvalidPid(Exception): pass
100 class InvalidTid(Exception): pass
101 class InvalidIoprioData(Exception): pass
107 class IOTopUI(object):
110 (lambda p
, s
: p
.pid
, False),
111 (lambda p
, s
: p
.ioprio_sort_key(), False),
112 (lambda p
, s
: p
.get_user(), False),
113 (lambda p
, s
: s
.read_bytes
, True),
114 (lambda p
, s
: s
.write_bytes
- s
.cancelled_write_bytes
, True),
115 (lambda p
, s
: s
.swapin_delay_total
, True),
116 # The default sorting (by I/O % time) should show processes doing
117 # only writes, without waiting on them
118 (lambda p
, s
: s
.blkio_delay_total
or
119 int(not(not(s
.read_bytes
or s
.write_bytes
))), True),
120 (lambda p
, s
: p
.get_cmdline(), False),
123 def __init__(self
, win
, process_list
, options
):
124 self
.process_list
= process_list
125 self
.options
= options
127 self
.sorting_reverse
= IOTopUI
.sorting_keys
[self
.sorting_key
][1]
128 if not self
.options
.batch
:
132 curses
.use_default_colors()
136 # This call can fail with misconfigured terminals, for example
137 # TERM=xterm-color. This is harmless
141 self
.height
, self
.width
= self
.win
.getmaxyx()
146 if not self
.options
.batch
:
147 poll
.register(sys
.stdin
.fileno(), select
.POLLIN|select
.POLLPRI
)
148 while self
.options
.iterations
is None or \
149 iterations
< self
.options
.iterations
:
150 total
= self
.process_list
.refresh_processes()
151 total_read
, total_write
= total
152 self
.refresh_display(iterations
== 0, total_read
, total_write
,
153 self
.process_list
.duration
)
154 if self
.options
.iterations
is not None:
156 if iterations
>= self
.options
.iterations
:
158 elif iterations
== 0:
162 events
= poll
.poll(self
.options
.delay_seconds
* 1000.0)
163 except select
.error
, e
:
164 if e
.args
and e
.args
[0] == errno
.EINTR
:
168 if not self
.options
.batch
:
171 key
= self
.win
.getch()
174 def reverse_sorting(self
):
175 self
.sorting_reverse
= not self
.sorting_reverse
177 def adjust_sorting_key(self
, delta
):
178 orig_sorting_key
= self
.sorting_key
179 self
.sorting_key
+= delta
180 self
.sorting_key
= max(0, self
.sorting_key
)
181 self
.sorting_key
= min(len(IOTopUI
.sorting_keys
) - 1, self
.sorting_key
)
182 if orig_sorting_key
!= self
.sorting_key
:
183 self
.sorting_reverse
= IOTopUI
.sorting_keys
[self
.sorting_key
][1]
185 # I wonder if switching to urwid for the display would be better here
187 def prompt_str(self
, prompt
, default
=None, empty_is_cancel
=True):
188 self
.win
.hline(1, 0, ord(' ') | curses
.A_NORMAL
, self
.width
)
189 self
.win
.addstr(1, 0, prompt
, curses
.A_BOLD
)
193 inp
= self
.win
.getstr(1, len(prompt
))
196 if inp
not in (None, ''):
202 def prompt_int(self
, prompt
, default
= None, empty_is_cancel
= True):
203 inp
= self
.prompt_str(prompt
, default
, empty_is_cancel
)
209 def prompt_pid(self
):
211 return self
.prompt_int('PID to ionice: ')
217 def prompt_tid(self
):
219 return self
.prompt_int('TID to ionice: ')
225 def prompt_data(self
, ioprio_data
):
227 if ioprio_data
is not None:
228 inp
= self
.prompt_int('I/O priority data (0-7, currently %s): '
229 % ioprio_data
, ioprio_data
, False)
231 inp
= self
.prompt_int('I/O priority data (0-7): ', None, False)
233 raise InvalidIoprioData()
234 if inp
< 0 or inp
> 7:
235 raise InvalidIoprioData()
238 def prompt_set(self
, prompt
, display_list
, ret_list
, selected
):
240 selected
= ret_list
.index(selected
)
243 set_len
= len(display_list
) - 1
245 self
.win
.hline(1, 0, ord(' ') | curses
.A_NORMAL
, self
.width
)
246 self
.win
.insstr(1, 0, prompt
, curses
.A_BOLD
)
248 for i
, item
in enumerate(display_list
):
249 display
= ' %s ' % item
251 attr
= curses
.A_REVERSE
253 attr
= curses
.A_NORMAL
254 self
.win
.insstr(1, offset
, display
, attr
)
255 offset
+= len(display
)
257 key
= self
.win
.getch()
258 if key
in (curses
.KEY_LEFT
, ord('l')) and selected
> 0:
261 elif key
in (curses
.KEY_RIGHT
, ord('r')) and selected
< set_len
:
264 elif key
in (curses
.KEY_ENTER
, ord('\n'), ord('\r')):
265 return ret_list
[selected
]
266 elif key
in (27, curses
.KEY_CANCEL
, curses
.KEY_CLOSE
,
267 curses
.KEY_EXIT
, ord('q'), ord('Q')):
270 def prompt_class(self
, ioprio_class
=None):
271 prompt
= 'I/O priority class: '
272 classes_prompt
= ['Real-time', 'Best-effort', 'Idle']
273 classes_ret
= ['rt', 'be', 'idle']
274 if ioprio_class
is None:
276 inp
= self
.prompt_set(prompt
, classes_prompt
, classes_ret
, ioprio_class
)
279 def prompt_error(self
, error
= 'Error!'):
280 self
.win
.hline(1, 0, ord(' ') | curses
.A_NORMAL
, self
.width
)
281 self
.win
.insstr(1, 0, ' %s ' % error
, curses
.A_REVERSE
)
285 def prompt_clear(self
):
286 self
.win
.hline(1, 0, ord(' ') | curses
.A_NORMAL
, self
.width
)
289 def handle_key(self
, key
):
290 def toggle_accumulated():
291 self
.options
.accumulated ^
= True
292 def toggle_only_io():
293 self
.options
.only ^
= True
294 def toggle_processes():
295 self
.options
.processes ^
= True
296 self
.process_list
.clear()
297 self
.process_list
.refresh_processes()
300 if self
.options
.processes
:
301 pid
= self
.prompt_pid()
302 exec_unit
= self
.process_list
.get_process(pid
)
304 tid
= self
.prompt_tid()
305 exec_unit
= ThreadInfo(tid
,
306 self
.process_list
.taskstats_connection
)
307 ioprio_value
= exec_unit
.get_ioprio()
308 (ioprio_class
, ioprio_data
) = \
309 ioprio
.to_class_and_data(ioprio_value
)
310 ioprio_class
= self
.prompt_class(ioprio_class
)
311 if ioprio_class
== 'idle':
314 ioprio_data
= self
.prompt_data(ioprio_data
)
315 exec_unit
.set_ioprio(ioprio_class
, ioprio_data
)
316 self
.process_list
.clear()
317 self
.process_list
.refresh_processes()
318 except IoprioSetError
, e
:
319 self
.prompt_error('Error setting I/O priority: %s' % e
.err
)
321 self
.prompt_error('Invalid process id!')
323 self
.prompt_error('Invalid thread id!')
324 except InvalidIoprioData
:
325 self
.prompt_error('Invalid I/O priority data!')
327 self
.prompt_error('Invalid integer!')
339 lambda: self
.reverse_sorting(),
341 lambda: self
.reverse_sorting(),
359 lambda: self
.adjust_sorting_key(-1),
361 lambda: self
.adjust_sorting_key(1),
363 lambda: self
.adjust_sorting_key(-len(IOTopUI
.sorting_keys
)),
365 lambda: self
.adjust_sorting_key(len(IOTopUI
.sorting_keys
))
368 action
= key_bindings
.get(key
, lambda: None)
373 stats
= format_stats(self
.options
, p
, self
.process_list
.duration
)
374 io_delay
, swapin_delay
, read_bytes
, write_bytes
= stats
375 if Stats
.has_blkio_delay_total
:
376 delay_stats
= '%7s %7s ' % (swapin_delay
, io_delay
)
378 delay_stats
= ' ?unavailable? '
379 pid_format
= '%%%dd' % MAX_PID_WIDTH
380 line
= (pid_format
+ ' %4s %-8s %11s %11s %s') % (
381 p
.pid
, p
.get_ioprio(), p
.get_user()[:8], read_bytes
,
382 write_bytes
, delay_stats
)
383 cmdline
= p
.get_cmdline()
384 if not self
.options
.batch
:
385 remaining_length
= self
.width
- len(line
)
386 if 2 < remaining_length
< len(cmdline
):
387 len1
= (remaining_length
- 1) // 2
388 offset2
= -(remaining_length
- len1
- 1)
389 cmdline
= cmdline
[:len1
] + '~' + cmdline
[offset2
:]
391 if not self
.options
.batch
:
392 line
= line
[:self
.width
]
395 def should_format(p
):
396 return not self
.options
.only
or \
397 p
.did_some_io(self
.options
.accumulated
)
399 processes
= filter(should_format
, self
.process_list
.processes
.values())
400 key
= IOTopUI
.sorting_keys
[self
.sorting_key
][0]
401 if self
.options
.accumulated
:
402 stats_lambda
= lambda p
: p
.stats_accum
404 stats_lambda
= lambda p
: p
.stats_delta
405 processes
.sort(key
=lambda p
: key(p
, stats_lambda(p
)),
406 reverse
=self
.sorting_reverse
)
407 if not self
.options
.batch
:
408 del processes
[self
.height
- 2:]
409 return map(format
, processes
)
411 def refresh_display(self
, first_time
, total_read
, total_write
, duration
):
412 summary
= 'Total DISK READ: %s | Total DISK WRITE: %s' % (
413 format_bandwidth(self
.options
, total_read
, duration
).rjust(14),
414 format_bandwidth(self
.options
, total_write
, duration
).rjust(14))
416 pid
= max(0, (MAX_PID_WIDTH
- 3)) * ' '
417 if self
.options
.processes
:
421 titles
= [pid
, ' PRIO', ' USER', ' DISK READ', ' DISK WRITE',
422 ' SWAPIN', ' IO', ' COMMAND']
423 lines
= self
.get_data()
424 if self
.options
.time
:
425 titles
= [' TIME'] + titles
426 current_time
= time
.strftime('%H:%M:%S ')
427 lines
= [current_time
+ l
for l
in lines
]
428 summary
= current_time
+ summary
429 if self
.options
.batch
:
430 if self
.options
.quiet
<= 2:
432 if self
.options
.quiet
<= int(first_time
):
433 print ''.join(titles
)
435 print l
.encode('utf-8')
439 self
.win
.addstr(summary
[:self
.width
])
440 self
.win
.hline(1, 0, ord(' ') | curses
.A_REVERSE
, self
.width
)
441 remaining_cols
= self
.width
442 for i
in xrange(len(titles
)):
443 attr
= curses
.A_REVERSE
445 if i
== self
.sorting_key
:
447 if i
== self
.sorting_key
:
448 attr |
= curses
.A_BOLD
449 title
+= self
.sorting_reverse
and '>' or '<'
450 title
= title
[:remaining_cols
]
451 remaining_cols
-= len(title
)
452 self
.win
.addstr(title
, attr
)
453 if Stats
.has_blkio_delay_total
:
456 status_msg
= ('CONFIG_TASK_DELAY_ACCT not enabled in kernel, '
457 'cannot determine SWAPIN and IO %')
458 num_lines
= min(len(lines
), self
.height
- 2 - int(bool(status_msg
)))
459 for i
in xrange(num_lines
):
461 self
.win
.addstr(i
+ 2, 0, lines
[i
].encode('utf-8'))
465 self
.win
.insstr(self
.height
- 1, 0, status_msg
, curses
.A_BOLD
)
468 def run_iotop_window(win
, options
):
470 signal
.signal(signal
.SIGPIPE
, signal
.SIG_DFL
)
471 taskstats_connection
= TaskStatsNetlink(options
)
472 process_list
= ProcessList(taskstats_connection
, options
)
473 ui
= IOTopUI(win
, process_list
, options
)
476 def run_iotop(options
):
479 return run_iotop_window(None, options
)
481 return curses
.wrapper(run_iotop_window
, options
)
483 if e
.errno
== errno
.EPERM
:
484 print >> sys
.stderr
, e
485 print >> sys
.stderr
, ('iotop requires root or the NET_ADMIN '
495 def _profile(continuation
):
496 prof_file
= 'iotop.prof'
500 print 'Profiling using cProfile'
501 cProfile
.runctx('continuation()', globals(), locals(), prof_file
)
502 stats
= pstats
.Stats(prof_file
)
506 prof
= hotshot
.Profile(prof_file
, lineevents
=1)
507 print 'Profiling using hotshot'
508 prof
.runcall(continuation
)
510 stats
= hotshot
.stats
.load(prof_file
)
512 stats
.sort_stats('time', 'calls')
513 stats
.print_stats(50)
514 stats
.print_callees(50)
521 USAGE
= '''%s [OPTIONS]
523 DISK READ and DISK WRITE are the block I/O bandwidth used during the sampling
524 period. SWAPIN and IO are the percentages of time the thread spent respectively
525 while swapping in and waiting on I/O more generally. PRIO is the I/O priority at
526 which the thread is running (set using the ionice command).
528 Controls: left and right arrows to change the sorting column, r to invert the
529 sorting order, o to toggle the --only option, p to toggle the --processes
530 option, a to toggle the --accumulated option, q to quit, any other key to force
531 a refresh.''' % sys
.argv
[0]
535 locale
.setlocale(locale
.LC_ALL
, '')
537 print 'unable to set locale, falling back to the default locale'
538 parser
= optparse
.OptionParser(usage
=USAGE
, version
='iotop ' + VERSION
)
539 parser
.add_option('-o', '--only', action
='store_true',
540 dest
='only', default
=False,
541 help='only show processes or threads actually doing I/O')
542 parser
.add_option('-b', '--batch', action
='store_true', dest
='batch',
543 help='non-interactive mode')
544 parser
.add_option('-n', '--iter', type='int', dest
='iterations',
546 help='number of iterations before ending [infinite]')
547 parser
.add_option('-d', '--delay', type='float', dest
='delay_seconds',
548 help='delay between iterations [1 second]',
549 metavar
='SEC', default
=1)
550 parser
.add_option('-p', '--pid', type='int', dest
='pids', action
='append',
551 help='processes/threads to monitor [all]', metavar
='PID')
552 parser
.add_option('-u', '--user', type='str', dest
='users', action
='append',
553 help='users to monitor [all]', metavar
='USER')
554 parser
.add_option('-P', '--processes', action
='store_true',
555 dest
='processes', default
=False,
556 help='only show processes, not all threads')
557 parser
.add_option('-a', '--accumulated', action
='store_true',
558 dest
='accumulated', default
=False,
559 help='show accumulated I/O instead of bandwidth')
560 parser
.add_option('-k', '--kilobytes', action
='store_true',
561 dest
='kilobytes', default
=False,
562 help='use kilobytes instead of a human friendly unit')
563 parser
.add_option('-t', '--time', action
='store_true', dest
='time',
564 help='add a timestamp on each line (implies --batch)')
565 parser
.add_option('-q', '--quiet', action
='count', dest
='quiet', default
=0,
566 help='suppress some lines of header (implies --batch)')
567 parser
.add_option('--profile', action
='store_true', dest
='profile',
568 default
=False, help=optparse
.SUPPRESS_HELP
)
570 options
, args
= parser
.parse_args()
572 parser
.error('Unexpected arguments: ' + ' '.join(args
))
574 options
.pids
= options
.pids
or []
575 options
.batch
= options
.batch
or options
.time
or options
.quiet
577 main_loop
= lambda: run_iotop(options
)
580 def safe_main_loop():
585 _profile(safe_main_loop
)