xref: /linux/tools/accounting/getdelays.c (revision 7c58ed44bd399277c4a14fcb4e447e1da39870d3)
1 // SPDX-License-Identifier: GPL-2.0
2 /* getdelays.c
3  *
4  * Utility to get per-pid and per-tgid delay accounting statistics
5  * Also illustrates usage of the taskstats interface
6  *
7  * Copyright (C) Shailabh Nagar, IBM Corp. 2005
8  * Copyright (C) Balbir Singh, IBM Corp. 2006
9  * Copyright (c) Jay Lan, SGI. 2006
10  *
11  * Compile with
12  *	gcc -I/usr/src/linux/include getdelays.c -o getdelays
13  */
14 
15 #include <stdio.h>
16 #include <stdlib.h>
17 #include <errno.h>
18 #include <unistd.h>
19 #include <poll.h>
20 #include <string.h>
21 #include <fcntl.h>
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/socket.h>
25 #include <sys/wait.h>
26 #include <signal.h>
27 
28 #include <linux/genetlink.h>
29 #include <linux/taskstats.h>
30 #include <linux/cgroupstats.h>
31 
32 /*
33  * Generic macros for dealing with netlink sockets. Might be duplicated
34  * elsewhere. It is recommended that commercial grade applications use
35  * libnl or libnetlink and use the interfaces provided by the library
36  */
37 #define GENLMSG_DATA(glh)	((void *)(NLMSG_DATA(glh) + GENL_HDRLEN))
38 #define GENLMSG_PAYLOAD(glh)	(NLMSG_PAYLOAD(glh, 0) - GENL_HDRLEN)
39 #define NLA_DATA(na)		((void *)((char*)(na) + NLA_HDRLEN))
40 #define NLA_PAYLOAD(len)	(len - NLA_HDRLEN)
41 
42 #define err(code, fmt, arg...)			\
43 	do {					\
44 		fprintf(stderr, fmt, ##arg);	\
45 		exit(code);			\
46 	} while (0)
47 
48 int rcvbufsz;
49 char name[100];
50 int dbg;
51 int print_delays;
52 int print_io_accounting;
53 int print_task_context_switch_counts;
54 
55 #define PRINTF(fmt, arg...) {			\
56 	    if (dbg) {				\
57 		printf(fmt, ##arg);		\
58 	    }					\
59 	}
60 
61 /* Maximum size of response requested or message sent */
62 #define MAX_MSG_SIZE	1024
63 /* Maximum number of cpus expected to be specified in a cpumask */
64 #define MAX_CPUS	32
65 
66 struct msgtemplate {
67 	struct nlmsghdr n;
68 	struct genlmsghdr g;
69 	char buf[MAX_MSG_SIZE];
70 };
71 
72 char cpumask[100+6*MAX_CPUS];
73 
74 static void usage(void)
75 {
76 	fprintf(stderr, "getdelays [-dilv] [-w logfile] [-r bufsize] "
77 			"[-m cpumask] [-t tgid] [-p pid]\n");
78 	fprintf(stderr, "  -d: print delayacct stats\n");
79 	fprintf(stderr, "  -i: print IO accounting (works only with -p)\n");
80 	fprintf(stderr, "  -l: listen forever\n");
81 	fprintf(stderr, "  -v: debug on\n");
82 	fprintf(stderr, "  -C: container path\n");
83 }
84 
85 /*
86  * Create a raw netlink socket and bind
87  */
88 static int create_nl_socket(int protocol)
89 {
90 	int fd;
91 	struct sockaddr_nl local;
92 
93 	fd = socket(AF_NETLINK, SOCK_RAW, protocol);
94 	if (fd < 0)
95 		return -1;
96 
97 	if (rcvbufsz)
98 		if (setsockopt(fd, SOL_SOCKET, SO_RCVBUF,
99 				&rcvbufsz, sizeof(rcvbufsz)) < 0) {
100 			fprintf(stderr, "Unable to set socket rcv buf size to %d\n",
101 				rcvbufsz);
102 			goto error;
103 		}
104 
105 	memset(&local, 0, sizeof(local));
106 	local.nl_family = AF_NETLINK;
107 
108 	if (bind(fd, (struct sockaddr *) &local, sizeof(local)) < 0)
109 		goto error;
110 
111 	return fd;
112 error:
113 	close(fd);
114 	return -1;
115 }
116 
117 
118 static int send_cmd(int sd, __u16 nlmsg_type, __u32 nlmsg_pid,
119 	     __u8 genl_cmd, __u16 nla_type,
120 	     void *nla_data, int nla_len)
121 {
122 	struct nlattr *na;
123 	struct sockaddr_nl nladdr;
124 	int r, buflen;
125 	char *buf;
126 
127 	struct msgtemplate msg;
128 
129 	msg.n.nlmsg_len = NLMSG_LENGTH(GENL_HDRLEN);
130 	msg.n.nlmsg_type = nlmsg_type;
131 	msg.n.nlmsg_flags = NLM_F_REQUEST;
132 	msg.n.nlmsg_seq = 0;
133 	msg.n.nlmsg_pid = nlmsg_pid;
134 	msg.g.cmd = genl_cmd;
135 	msg.g.version = 0x1;
136 	na = (struct nlattr *) GENLMSG_DATA(&msg);
137 	na->nla_type = nla_type;
138 	na->nla_len = nla_len + NLA_HDRLEN;
139 	memcpy(NLA_DATA(na), nla_data, nla_len);
140 	msg.n.nlmsg_len += NLMSG_ALIGN(na->nla_len);
141 
142 	buf = (char *) &msg;
143 	buflen = msg.n.nlmsg_len ;
144 	memset(&nladdr, 0, sizeof(nladdr));
145 	nladdr.nl_family = AF_NETLINK;
146 	while ((r = sendto(sd, buf, buflen, 0, (struct sockaddr *) &nladdr,
147 			   sizeof(nladdr))) < buflen) {
148 		if (r > 0) {
149 			buf += r;
150 			buflen -= r;
151 		} else if (errno != EAGAIN)
152 			return -1;
153 	}
154 	return 0;
155 }
156 
157 
158 /*
159  * Probe the controller in genetlink to find the family id
160  * for the TASKSTATS family
161  */
162 static int get_family_id(int sd)
163 {
164 	struct {
165 		struct nlmsghdr n;
166 		struct genlmsghdr g;
167 		char buf[256];
168 	} ans;
169 
170 	int id = 0, rc;
171 	struct nlattr *na;
172 	int rep_len;
173 
174 	strcpy(name, TASKSTATS_GENL_NAME);
175 	rc = send_cmd(sd, GENL_ID_CTRL, getpid(), CTRL_CMD_GETFAMILY,
176 			CTRL_ATTR_FAMILY_NAME, (void *)name,
177 			strlen(TASKSTATS_GENL_NAME)+1);
178 	if (rc < 0)
179 		return 0;	/* sendto() failure? */
180 
181 	rep_len = recv(sd, &ans, sizeof(ans), 0);
182 	if (ans.n.nlmsg_type == NLMSG_ERROR ||
183 	    (rep_len < 0) || !NLMSG_OK((&ans.n), rep_len))
184 		return 0;
185 
186 	na = (struct nlattr *) GENLMSG_DATA(&ans);
187 	na = (struct nlattr *) ((char *) na + NLA_ALIGN(na->nla_len));
188 	if (na->nla_type == CTRL_ATTR_FAMILY_ID) {
189 		id = *(__u16 *) NLA_DATA(na);
190 	}
191 	return id;
192 }
193 
194 #define average_ms(t, c) (t / 1000000ULL / (c ? c : 1))
195 #define delay_max_ms(t) (t / 1000000ULL)
196 
197 static void print_delayacct(struct taskstats *t)
198 {
199 	printf("\n\nCPU   %15s%15s%15s%15s%15s%15s\n"
200 	       "      %15llu%15llu%15llu%15llu%15.3fms%13.6fms\n"
201 	       "IO    %15s%15s%15s%15s\n"
202 	       "      %15llu%15llu%15.3fms%13.6fms\n"
203 	       "SWAP  %15s%15s%15s%15s\n"
204 	       "      %15llu%15llu%15.3fms%13.6fms\n"
205 	       "RECLAIM  %12s%15s%15s%15s\n"
206 	       "      %15llu%15llu%15.3fms%13.6fms\n"
207 	       "THRASHING%12s%15s%15s%15s\n"
208 	       "      %15llu%15llu%15.3fms%13.6fms\n"
209 	       "COMPACT  %12s%15s%15s%15s\n"
210 	       "      %15llu%15llu%15.3fms%13.6fms\n"
211 	       "WPCOPY   %12s%15s%15s%15s\n"
212 	       "      %15llu%15llu%15.3fms%13.6fms\n"
213 	       "IRQ   %15s%15s%15s%15s\n"
214 	       "      %15llu%15llu%15.3fms%13.6fms\n",
215 	       "count", "real total", "virtual total",
216 	       "delay total", "delay average", "delay max",
217 	       (unsigned long long)t->cpu_count,
218 	       (unsigned long long)t->cpu_run_real_total,
219 	       (unsigned long long)t->cpu_run_virtual_total,
220 	       (unsigned long long)t->cpu_delay_total,
221 	       average_ms((double)t->cpu_delay_total, t->cpu_count),
222 		   delay_max_ms((double)t->cpu_delay_max),
223 	       "count", "delay total", "delay average", "delay max",
224 	       (unsigned long long)t->blkio_count,
225 	       (unsigned long long)t->blkio_delay_total,
226 	       average_ms((double)t->blkio_delay_total, t->blkio_count),
227 		   delay_max_ms((double)t->blkio_delay_max),
228 	       "count", "delay total", "delay average", "delay max",
229 	       (unsigned long long)t->swapin_count,
230 	       (unsigned long long)t->swapin_delay_total,
231 	       average_ms((double)t->swapin_delay_total, t->swapin_count),
232 		   delay_max_ms((double)t->swapin_delay_max),
233 	       "count", "delay total", "delay average", "delay max",
234 	       (unsigned long long)t->freepages_count,
235 	       (unsigned long long)t->freepages_delay_total,
236 	       average_ms((double)t->freepages_delay_total, t->freepages_count),
237 		   delay_max_ms((double)t->freepages_delay_max),
238 	       "count", "delay total", "delay average", "delay max",
239 	       (unsigned long long)t->thrashing_count,
240 	       (unsigned long long)t->thrashing_delay_total,
241 	       average_ms((double)t->thrashing_delay_total, t->thrashing_count),
242 		   delay_max_ms((double)t->thrashing_delay_max),
243 	       "count", "delay total", "delay average", "delay max",
244 	       (unsigned long long)t->compact_count,
245 	       (unsigned long long)t->compact_delay_total,
246 	       average_ms((double)t->compact_delay_total, t->compact_count),
247 		   delay_max_ms((double)t->compact_delay_max),
248 	       "count", "delay total", "delay average", "delay max",
249 	       (unsigned long long)t->wpcopy_count,
250 	       (unsigned long long)t->wpcopy_delay_total,
251 	       average_ms((double)t->wpcopy_delay_total, t->wpcopy_count),
252 		   delay_max_ms((double)t->wpcopy_delay_max),
253 	       "count", "delay total", "delay average", "delay max",
254 	       (unsigned long long)t->irq_count,
255 	       (unsigned long long)t->irq_delay_total,
256 	       average_ms((double)t->irq_delay_total, t->irq_count),
257 		   delay_max_ms((double)t->irq_delay_max));
258 }
259 
260 static void task_context_switch_counts(struct taskstats *t)
261 {
262 	printf("\n\nTask   %15s%15s\n"
263 	       "       %15llu%15llu\n",
264 	       "voluntary", "nonvoluntary",
265 	       (unsigned long long)t->nvcsw, (unsigned long long)t->nivcsw);
266 }
267 
268 static void print_cgroupstats(struct cgroupstats *c)
269 {
270 	printf("sleeping %llu, blocked %llu, running %llu, stopped %llu, "
271 		"uninterruptible %llu\n", (unsigned long long)c->nr_sleeping,
272 		(unsigned long long)c->nr_io_wait,
273 		(unsigned long long)c->nr_running,
274 		(unsigned long long)c->nr_stopped,
275 		(unsigned long long)c->nr_uninterruptible);
276 }
277 
278 
279 static void print_ioacct(struct taskstats *t)
280 {
281 	printf("%s: read=%llu, write=%llu, cancelled_write=%llu\n",
282 		t->ac_comm,
283 		(unsigned long long)t->read_bytes,
284 		(unsigned long long)t->write_bytes,
285 		(unsigned long long)t->cancelled_write_bytes);
286 }
287 
288 int main(int argc, char *argv[])
289 {
290 	int c, rc, rep_len, aggr_len, len2;
291 	int cmd_type = TASKSTATS_CMD_ATTR_UNSPEC;
292 	__u16 id;
293 	__u32 mypid;
294 
295 	struct nlattr *na;
296 	int nl_sd = -1;
297 	int len = 0;
298 	pid_t tid = 0;
299 	pid_t rtid = 0;
300 
301 	int fd = 0;
302 	int write_file = 0;
303 	int maskset = 0;
304 	char *logfile = NULL;
305 	int loop = 0;
306 	int containerset = 0;
307 	char *containerpath = NULL;
308 	int cfd = 0;
309 	int forking = 0;
310 	sigset_t sigset;
311 
312 	struct msgtemplate msg;
313 
314 	while (!forking) {
315 		c = getopt(argc, argv, "qdiw:r:m:t:p:vlC:c:");
316 		if (c < 0)
317 			break;
318 
319 		switch (c) {
320 		case 'd':
321 			printf("print delayacct stats ON\n");
322 			print_delays = 1;
323 			break;
324 		case 'i':
325 			printf("printing IO accounting\n");
326 			print_io_accounting = 1;
327 			break;
328 		case 'q':
329 			printf("printing task/process context switch rates\n");
330 			print_task_context_switch_counts = 1;
331 			break;
332 		case 'C':
333 			containerset = 1;
334 			containerpath = optarg;
335 			break;
336 		case 'w':
337 			logfile = strdup(optarg);
338 			printf("write to file %s\n", logfile);
339 			write_file = 1;
340 			break;
341 		case 'r':
342 			rcvbufsz = atoi(optarg);
343 			printf("receive buf size %d\n", rcvbufsz);
344 			if (rcvbufsz < 0)
345 				err(1, "Invalid rcv buf size\n");
346 			break;
347 		case 'm':
348 			strncpy(cpumask, optarg, sizeof(cpumask));
349 			cpumask[sizeof(cpumask) - 1] = '\0';
350 			maskset = 1;
351 			printf("cpumask %s maskset %d\n", cpumask, maskset);
352 			break;
353 		case 't':
354 			tid = atoi(optarg);
355 			if (!tid)
356 				err(1, "Invalid tgid\n");
357 			cmd_type = TASKSTATS_CMD_ATTR_TGID;
358 			break;
359 		case 'p':
360 			tid = atoi(optarg);
361 			if (!tid)
362 				err(1, "Invalid pid\n");
363 			cmd_type = TASKSTATS_CMD_ATTR_PID;
364 			break;
365 		case 'c':
366 
367 			/* Block SIGCHLD for sigwait() later */
368 			if (sigemptyset(&sigset) == -1)
369 				err(1, "Failed to empty sigset");
370 			if (sigaddset(&sigset, SIGCHLD))
371 				err(1, "Failed to set sigchld in sigset");
372 			sigprocmask(SIG_BLOCK, &sigset, NULL);
373 
374 			/* fork/exec a child */
375 			tid = fork();
376 			if (tid < 0)
377 				err(1, "Fork failed\n");
378 			if (tid == 0)
379 				if (execvp(argv[optind - 1],
380 				    &argv[optind - 1]) < 0)
381 					exit(-1);
382 
383 			/* Set the command type and avoid further processing */
384 			cmd_type = TASKSTATS_CMD_ATTR_PID;
385 			forking = 1;
386 			break;
387 		case 'v':
388 			printf("debug on\n");
389 			dbg = 1;
390 			break;
391 		case 'l':
392 			printf("listen forever\n");
393 			loop = 1;
394 			break;
395 		default:
396 			usage();
397 			exit(-1);
398 		}
399 	}
400 
401 	if (write_file) {
402 		fd = open(logfile, O_WRONLY | O_CREAT | O_TRUNC,
403 			  S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
404 		if (fd == -1) {
405 			perror("Cannot open output file\n");
406 			exit(1);
407 		}
408 	}
409 
410 	nl_sd = create_nl_socket(NETLINK_GENERIC);
411 	if (nl_sd < 0)
412 		err(1, "error creating Netlink socket\n");
413 
414 
415 	mypid = getpid();
416 	id = get_family_id(nl_sd);
417 	if (!id) {
418 		fprintf(stderr, "Error getting family id, errno %d\n", errno);
419 		goto err;
420 	}
421 	PRINTF("family id %d\n", id);
422 
423 	if (maskset) {
424 		rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET,
425 			      TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
426 			      &cpumask, strlen(cpumask) + 1);
427 		PRINTF("Sent register cpumask, retval %d\n", rc);
428 		if (rc < 0) {
429 			fprintf(stderr, "error sending register cpumask\n");
430 			goto err;
431 		}
432 	}
433 
434 	if (tid && containerset) {
435 		fprintf(stderr, "Select either -t or -C, not both\n");
436 		goto err;
437 	}
438 
439 	/*
440 	 * If we forked a child, wait for it to exit. Cannot use waitpid()
441 	 * as all the delicious data would be reaped as part of the wait
442 	 */
443 	if (tid && forking) {
444 		int sig_received;
445 		sigwait(&sigset, &sig_received);
446 	}
447 
448 	if (tid) {
449 		rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET,
450 			      cmd_type, &tid, sizeof(__u32));
451 		PRINTF("Sent pid/tgid, retval %d\n", rc);
452 		if (rc < 0) {
453 			fprintf(stderr, "error sending tid/tgid cmd\n");
454 			goto done;
455 		}
456 	}
457 
458 	if (containerset) {
459 		cfd = open(containerpath, O_RDONLY);
460 		if (cfd < 0) {
461 			perror("error opening container file");
462 			goto err;
463 		}
464 		rc = send_cmd(nl_sd, id, mypid, CGROUPSTATS_CMD_GET,
465 			      CGROUPSTATS_CMD_ATTR_FD, &cfd, sizeof(__u32));
466 		if (rc < 0) {
467 			perror("error sending cgroupstats command");
468 			goto err;
469 		}
470 	}
471 	if (!maskset && !tid && !containerset) {
472 		usage();
473 		goto err;
474 	}
475 
476 	do {
477 		rep_len = recv(nl_sd, &msg, sizeof(msg), 0);
478 		PRINTF("received %d bytes\n", rep_len);
479 
480 		if (rep_len < 0) {
481 			fprintf(stderr, "nonfatal reply error: errno %d\n",
482 				errno);
483 			continue;
484 		}
485 		if (msg.n.nlmsg_type == NLMSG_ERROR ||
486 		    !NLMSG_OK((&msg.n), rep_len)) {
487 			struct nlmsgerr *err = NLMSG_DATA(&msg);
488 			fprintf(stderr, "fatal reply error,  errno %d\n",
489 				err->error);
490 			goto done;
491 		}
492 
493 		PRINTF("nlmsghdr size=%zu, nlmsg_len=%d, rep_len=%d\n",
494 		       sizeof(struct nlmsghdr), msg.n.nlmsg_len, rep_len);
495 
496 
497 		rep_len = GENLMSG_PAYLOAD(&msg.n);
498 
499 		na = (struct nlattr *) GENLMSG_DATA(&msg);
500 		len = 0;
501 		while (len < rep_len) {
502 			len += NLA_ALIGN(na->nla_len);
503 			switch (na->nla_type) {
504 			case TASKSTATS_TYPE_AGGR_TGID:
505 				/* Fall through */
506 			case TASKSTATS_TYPE_AGGR_PID:
507 				aggr_len = NLA_PAYLOAD(na->nla_len);
508 				len2 = 0;
509 				/* For nested attributes, na follows */
510 				na = (struct nlattr *) NLA_DATA(na);
511 				while (len2 < aggr_len) {
512 					switch (na->nla_type) {
513 					case TASKSTATS_TYPE_PID:
514 						rtid = *(int *) NLA_DATA(na);
515 						if (print_delays)
516 							printf("PID\t%d\n", rtid);
517 						break;
518 					case TASKSTATS_TYPE_TGID:
519 						rtid = *(int *) NLA_DATA(na);
520 						if (print_delays)
521 							printf("TGID\t%d\n", rtid);
522 						break;
523 					case TASKSTATS_TYPE_STATS:
524 						if (print_delays)
525 							print_delayacct((struct taskstats *) NLA_DATA(na));
526 						if (print_io_accounting)
527 							print_ioacct((struct taskstats *) NLA_DATA(na));
528 						if (print_task_context_switch_counts)
529 							task_context_switch_counts((struct taskstats *) NLA_DATA(na));
530 						if (fd) {
531 							if (write(fd, NLA_DATA(na), na->nla_len) < 0) {
532 								err(1,"write error\n");
533 							}
534 						}
535 						if (!loop)
536 							goto done;
537 						break;
538 					case TASKSTATS_TYPE_NULL:
539 						break;
540 					default:
541 						fprintf(stderr, "Unknown nested"
542 							" nla_type %d\n",
543 							na->nla_type);
544 						break;
545 					}
546 					len2 += NLA_ALIGN(na->nla_len);
547 					na = (struct nlattr *)((char *)na +
548 							       NLA_ALIGN(na->nla_len));
549 				}
550 				break;
551 
552 			case CGROUPSTATS_TYPE_CGROUP_STATS:
553 				print_cgroupstats(NLA_DATA(na));
554 				break;
555 			default:
556 				fprintf(stderr, "Unknown nla_type %d\n",
557 					na->nla_type);
558 			case TASKSTATS_TYPE_NULL:
559 				break;
560 			}
561 			na = (struct nlattr *) (GENLMSG_DATA(&msg) + len);
562 		}
563 	} while (loop);
564 done:
565 	if (maskset) {
566 		rc = send_cmd(nl_sd, id, mypid, TASKSTATS_CMD_GET,
567 			      TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
568 			      &cpumask, strlen(cpumask) + 1);
569 		printf("Sent deregister mask, retval %d\n", rc);
570 		if (rc < 0)
571 			err(rc, "error sending deregister cpumask\n");
572 	}
573 err:
574 	close(nl_sd);
575 	if (fd)
576 		close(fd);
577 	if (cfd)
578 		close(cfd);
579 	return 0;
580 }
581