slabtop.c 10.9 KB
Newer Older
1
/*
2 3 4 5 6 7
 * slabtop.c - utility to display kernel slab information.
 *
 * Chris Rivera <cmrivera@ufl.edu>
 * Robert Love <rml@tech9.net>
 *
 * Copyright (C) 2003 Chris Rivera
8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 23
 */

24
#include <locale.h>
25 26 27 28 29 30 31 32 33 34
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <signal.h>
#include <ncurses.h>
#include <termios.h>
#include <getopt.h>
#include <ctype.h>
#include <sys/ioctl.h>
35

36
#include <sys/select.h>
37 38 39
#include <sys/time.h>
#include <sys/types.h>
#include <unistd.h>
40

41
#include "c.h"
42
#include "fileutils.h"
43
#include "nls.h"
44
#include "strutils.h"
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
#include "proc/slab.h"
#include "proc/version.h"

#define DEF_SORT_FUNC		sort_nr_objs

static unsigned short cols, rows;
static struct termios saved_tty;
static long delay = 3;
static int (*sort_func)(const struct slab_info *, const struct slab_info *);

static struct slab_info *merge_objs(struct slab_info *a, struct slab_info *b)
{
	struct slab_info sorted_list;
	struct slab_info *curr = &sorted_list;

	while ((a != NULL) && (b != NULL)) {
		if (sort_func(a, b)) {
			curr->next = a;
			curr = a;
			a = a->next;
		} else {
			curr->next = b;
			curr = b;
			b = b->next;
		}
	}

	curr->next = (a == NULL) ? b : a;
	return sorted_list.next;
}

76
/*
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
 * slabsort - merge sort the slab_info linked list based on sort_func
 */
static struct slab_info *slabsort(struct slab_info *list)
{
	struct slab_info *a, *b;

	if ((list == NULL) || (list->next == NULL))
		return list;

	a = list;
	b = list->next;

	while ((b != NULL) && (b->next != NULL)) {
		list = list->next;
		b = b->next->next;
	}
93

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
	b = list->next;
	list->next = NULL;

	return merge_objs(slabsort(a), slabsort(b));
}

/*
 * Sort Routines.  Each of these should be associated with a command-line
 * search option.  The functions should fit the prototype:
 *
 *	int sort_foo(const struct slab_info *a, const struct slab_info *b)
 *
 * They return one if the first parameter is larger than the second
 * Otherwise, they return zero.
 */

static int sort_name(const struct slab_info *a, const struct slab_info *b)
{
	return (strcmp(a->name, b->name) < 0) ? 1 : 0;
}

static int sort_nr_objs(const struct slab_info *a, const struct slab_info *b)
{
	return (a->nr_objs > b->nr_objs);
}

static int sort_nr_active_objs(const struct slab_info *a,
				const struct slab_info *b)
{
	return (a->nr_active_objs > b->nr_active_objs);
}

static int sort_obj_size(const struct slab_info *a, const struct slab_info *b)
{
	return (a->obj_size > b->obj_size);
}

static int sort_objs_per_slab(const struct slab_info *a,
				const struct slab_info *b)
{
	return (a->objs_per_slab > b->objs_per_slab);
}

static int sort_pages_per_slab(const struct slab_info *a,
		const struct slab_info *b)
{
	return (a->pages_per_slab > b->pages_per_slab);
}

static int sort_nr_slabs(const struct slab_info *a, const struct slab_info *b)
{
	return (a->nr_slabs > b->nr_slabs);
}

static int sort_nr_active_slabs(const struct slab_info *a,
			const struct slab_info *b)
{
	return (a->nr_active_slabs > b->nr_active_slabs);
}


static int sort_use(const struct slab_info *a, const struct slab_info *b)
{
	return (a->use > b->use);
}

static int sort_cache_size(const struct slab_info *a, const struct slab_info *b)
{
	return (a->cache_size > b->cache_size);
}

/*
 * term_size - set the globals 'cols' and 'rows' to the current terminal size
 */
168
static void term_size(int unusused __attribute__ ((__unused__)))
169 170 171
{
	struct winsize ws;

172
	if ((ioctl(STDOUT_FILENO, TIOCGWINSZ, &ws) != -1) && ws.ws_row > 10) {
173 174 175 176 177 178 179 180
		cols = ws.ws_col;
		rows = ws.ws_row;
	} else {
		cols = 80;
		rows = 24;
	}
}

181
static void sigint_handler(int unused __attribute__ ((__unused__)))
182 183 184 185
{
	delay = 0;
}

186
static void __attribute__((__noreturn__)) usage(FILE *out)
187
{
188
	fputs(USAGE_HEADER, out);
189
	fprintf(out, _(" %s [options]\n"), program_invocation_short_name);
190
	fputs(USAGE_OPTIONS, out);
191 192 193
	fputs(_(" -d, --delay <secs>  delay updates\n"), out);
	fputs(_(" -o, --once          only display once, then exit\n"), out);
	fputs(_(" -s, --sort <char>   specify sort criteria by character (see below)\n"), out);
194 195 196 197
	fputs(USAGE_SEPARATOR, out);
	fputs(USAGE_HELP, out);
	fputs(USAGE_VERSION, out);

198 199 200 201 202 203 204 205 206 207 208
	fputs(_("\nThe following are valid sort criteria:\n"), out);
	fputs(_(" a: sort by number of active objects\n"), out);
	fputs(_(" b: sort by objects per slab\n"), out);
	fputs(_(" c: sort by cache size\n"), out);
	fputs(_(" l: sort by number of slabs\n"), out);
	fputs(_(" v: sort by number of active slabs\n"), out);
	fputs(_(" n: sort by name\n"), out);
	fputs(_(" o: sort by number of objects (the default)\n"), out);
	fputs(_(" p: sort by pages per slab\n"), out);
	fputs(_(" s: sort by object size\n"), out);
	fputs(_(" u: sort by cache utilization\n"), out);
209
	fprintf(out, USAGE_MAN_TAIL("slabtop(1)"));
210 211

	exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
212 213 214 215 216 217 218 219 220 221
}

/*
 * set_sort_func - return the slab_sort_func that matches the given key.
 * On unrecognizable key, DEF_SORT_FUNC is returned.
 */
static void * set_sort_func(char key)
{
	switch (key) {
	case 'n':
222
		return (void *) sort_name;
223
	case 'o':
224
		return (void *) sort_nr_objs;
225
	case 'a':
226
		return (void *) sort_nr_active_objs;
227
	case 's':
228
		return (void *) sort_obj_size;
229
	case 'b':
230
		return (void *) sort_objs_per_slab;
231
	case 'p':
232
		return (void *) sort_pages_per_slab;
233
	case 'l':
234
		return (void *) sort_nr_slabs;
235
	case 'v':
236
		return (void *) sort_nr_active_slabs;
237
	case 'c':
238
		return (void *) sort_cache_size;
239
	case 'u':
240
		return (void *) sort_use;
241
	default:
242
		return (void *) DEF_SORT_FUNC;
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	}
}

static void parse_input(char c)
{
	c = toupper(c);
	switch(c) {
	case 'A':
		sort_func = sort_nr_active_objs;
		break;
	case 'B':
		sort_func = sort_objs_per_slab;
		break;
	case 'C':
		sort_func = sort_cache_size;
		break;
	case 'L':
		sort_func = sort_nr_slabs;
		break;
	case 'V':
		sort_func = sort_nr_active_slabs;
		break;
	case 'N':
		sort_func = sort_name;
		break;
	case 'O':
		sort_func = sort_nr_objs;
		break;
	case 'P':
		sort_func = sort_pages_per_slab;
		break;
	case 'S':
		sort_func = sort_obj_size;
		break;
	case 'U':
		sort_func = sort_use;
		break;
	case 'Q':
		delay = 0;
		break;
	}
}

286
#define print_line(fmt, ...) if (run_once) printf(fmt, __VA_ARGS__); else printw(fmt, __VA_ARGS__)
287 288
int main(int argc, char *argv[])
{
289
	int is_tty, o;
290 291
	unsigned short old_rows;
	struct slab_info *slab_list = NULL;
292
	int run_once = 0, retval = EXIT_SUCCESS;
293

294 295 296 297 298 299 300
	static const struct option longopts[] = {
		{ "delay",	required_argument, NULL, 'd' },
		{ "sort",	required_argument, NULL, 's' },
		{ "once",	no_argument,	   NULL, 'o' },
		{ "help",	no_argument,	   NULL, 'h' },
		{ "version",	no_argument,	   NULL, 'V' },
		{  NULL, 0, NULL, 0 }
301 302
	};

303
#ifdef HAVE_PROGRAM_INVOCATION_NAME
304
	program_invocation_name = program_invocation_short_name;
305
#endif
306 307 308
	setlocale (LC_ALL, "");
	bindtextdomain(PACKAGE, LOCALEDIR);
	textdomain(PACKAGE);
309
	atexit(close_stdout);
310

311 312 313 314 315 316
	sort_func = DEF_SORT_FUNC;

	while ((o = getopt_long(argc, argv, "d:s:ohV", longopts, NULL)) != -1) {
		switch (o) {
		case 'd':
			errno = 0;
317 318
			delay = strtol_or_err(optarg, _("illegal delay"));
			if (delay < 1)
319
				xerrx(EXIT_FAILURE,
320
					_("delay must be positive integer"));
321 322
			break;
		case 's':
323 324
			sort_func = (int (*)(const struct slab_info*,
				const struct slab_info *)) set_sort_func(optarg[0]);
325 326
			break;
		case 'o':
327
			run_once=1;
328 329 330
			delay = 0;
			break;
		case 'V':
331
			printf(PROCPS_NG_VERSION);
332
			return EXIT_SUCCESS;
333
		case 'h':
334
			usage(stdout);
335
		default:
336
			usage(stderr);
337 338 339
		}
	}

340 341
	is_tty = isatty(STDIN_FILENO);
	if (is_tty && tcgetattr(STDIN_FILENO, &saved_tty) == -1)
342
		xwarn(_("terminal setting retrieval"));
343 344

	old_rows = rows;
345
	term_size(0);
346 347 348 349 350
	if (!run_once) {
		initscr();
		resizeterm(rows, cols);
		signal(SIGWINCH, term_size);
	}
351 352 353 354
	signal(SIGINT, sigint_handler);

	do {
		struct slab_info *curr;
355
		struct slab_stat stats;
356 357 358 359
		struct timeval tv;
		fd_set readfds;
		char c;
		int i;
360
		memset(&stats, 0, sizeof(struct slab_stat));
361

362 363
		if (get_slabinfo(&slab_list, &stats)) {
			retval = EXIT_FAILURE;
364
			break;
365
		}
366

367
		if (!run_once && old_rows != rows) {
368 369 370 371
			resizeterm(rows, cols);
			old_rows = rows;
		}

372
		move(0, 0);
Craig Small's avatar
Craig Small committed
373
		print_line(" %-35s: %d / %d (%.1f%%)\n"
374 375 376 377
		       " %-35s: %d / %d (%.1f%%)\n"
		       " %-35s: %d / %d (%.1f%%)\n"
		       " %-35s: %.2fK / %.2fK (%.1f%%)\n"
		       " %-35s: %.2fK / %.2fK / %.2fK\n\n",
378 379
		       /* Translation Hint: Next five strings must not
			* exceed 35 length in characters.  */
Yuri Chornoivan's avatar
Yuri Chornoivan committed
380
		       /* xgettext:no-c-format */
381 382 383
		       _("Active / Total Objects (% used)"),
		       stats.nr_active_objs, stats.nr_objs,
		       100.0 * stats.nr_active_objs / stats.nr_objs,
Yuri Chornoivan's avatar
Yuri Chornoivan committed
384
	               /* xgettext:no-c-format */
385 386 387
		       _("Active / Total Slabs (% used)"),
		       stats.nr_active_slabs, stats.nr_slabs,
		       100.0 * stats.nr_active_slabs / stats.nr_slabs,
Yuri Chornoivan's avatar
Yuri Chornoivan committed
388
	               /* xgettext:no-c-format */
389 390 391
		       _("Active / Total Caches (% used)"),
		       stats.nr_active_caches, stats.nr_caches,
		       100.0 * stats.nr_active_caches / stats.nr_caches,
Yuri Chornoivan's avatar
Yuri Chornoivan committed
392
	               /* xgettext:no-c-format */
393 394 395 396 397 398
		       _("Active / Total Size (% used)"),
		       stats.active_size / 1024.0, stats.total_size / 1024.0,
		       100.0 * stats.active_size / stats.total_size,
		       _("Minimum / Average / Maximum Object"),
		       stats.min_obj_size / 1024.0, stats.avg_obj_size / 1024.0,
		       stats.max_obj_size / 1024.0);
399 400 401 402

		slab_list = slabsort(slab_list);

		attron(A_REVERSE);
403 404
		/* Translation Hint: Please keep alignment of the
		 * following intact. */
Craig Small's avatar
Craig Small committed
405
		print_line("%-78s\n", _("  OBJS ACTIVE  USE OBJ SIZE  SLABS OBJ/SLAB CACHE SIZE NAME"));
406 407 408 409
		attroff(A_REVERSE);

		curr = slab_list;
		for (i = 0; i < rows - 8 && curr->next; i++) {
410
			print_line("%6u %6u %3u%% %7.2fK %6u %8u %9uK %-23s\n",
411 412
				curr->nr_objs, curr->nr_active_objs, curr->use,
				curr->obj_size / 1024.0, curr->nr_slabs,
albert's avatar
albert committed
413
				curr->objs_per_slab, (unsigned)(curr->cache_size / 1024),
414 415 416 417 418
				curr->name);
			curr = curr->next;
		}

		put_slabinfo(slab_list);
419
		if (!run_once) {
420 421 422 423 424 425
			refresh();
			FD_ZERO(&readfds);
			FD_SET(STDIN_FILENO, &readfds);
			tv.tv_sec = delay;
			tv.tv_usec = 0;
			if (select(STDOUT_FILENO, &readfds, NULL, NULL, &tv) > 0) {
426
				if (read(STDIN_FILENO, &c, 1) != 1)
427 428 429 430
					break;
				parse_input(c);
			}
		}
431 432
	} while (delay);

433 434
	if (is_tty)
		tcsetattr(STDIN_FILENO, TCSAFLUSH, &saved_tty);
435
	free_slabinfo(slab_list);
436 437 438
	if (!run_once)
		endwin();
	return retval;
439
}