Documentation/accounting/getdelays.c

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