kernel/taskstats.c

   1 /*
   2  * taskstats.c - Export per-task statistics to userland
   3  *
   4  * Copyright (C) Shailabh Nagar, IBM Corp. 2006
   5  *           (C) Balbir Singh,   IBM Corp. 2006
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/taskstats_kern.h>
  21 #include <linux/tsacct_kern.h>
  22 #include <linux/delayacct.h>
  23 #include <linux/cpumask.h>
  24 #include <linux/percpu.h>
  25 #include <linux/slab.h>
  26 #include <linux/cgroupstats.h>
  27 #include <linux/cgroup.h>
  28 #include <linux/fs.h>
  29 #include <linux/file.h>
  30 #include <net/genetlink.h>
  31 #include <asm/atomic.h>
  32
  33 /*
  34  * Maximum length of a cpumask that can be specified in
  35  * the TASKSTATS_CMD_ATTR_REGISTER/DEREGISTER_CPUMASK attribute
  36  */
  37 #define TASKSTATS_CPUMASK_MAXLEN        (100+6*NR_CPUS)
  38
  39 static DEFINE_PER_CPU(__u32, taskstats_seqnum);
  40 static int family_registered;
  41 struct kmem_cache *taskstats_cache;
  42
  43 static struct genl_family family = {
  44         .id             = GENL_ID_GENERATE,
  45         .name           = TASKSTATS_GENL_NAME,
  46         .version        = TASKSTATS_GENL_VERSION,
  47         .maxattr        = TASKSTATS_CMD_ATTR_MAX,
  48 };
  49
  50 static const struct nla_policy taskstats_cmd_get_policy[TASKSTATS_CMD_ATTR_MAX+1] = {
  51         [TASKSTATS_CMD_ATTR_PID]  = { .type = NLA_U32 },
  52         [TASKSTATS_CMD_ATTR_TGID] = { .type = NLA_U32 },
  53         [TASKSTATS_CMD_ATTR_REGISTER_CPUMASK] = { .type = NLA_STRING },
  54         [TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK] = { .type = NLA_STRING },};
  55
  56 static const struct nla_policy cgroupstats_cmd_get_policy[CGROUPSTATS_CMD_ATTR_MAX+1] = {
  57         [CGROUPSTATS_CMD_ATTR_FD] = { .type = NLA_U32 },
  58 };
  59
  60 struct listener {
  61         struct list_head list;
  62         pid_t pid;
  63         char valid;
  64 };
  65
  66 struct listener_list {
  67         struct rw_semaphore sem;
  68         struct list_head list;
  69 };
  70 static DEFINE_PER_CPU(struct listener_list, listener_array);
  71
  72 enum actions {
  73         REGISTER,
  74         DEREGISTER,
  75         CPU_DONT_CARE
  76 };
  77
  78 static int prepare_reply(struct genl_info *info, u8 cmd, struct sk_buff **skbp,
  79                                 size_t size)
  80 {
  81         struct sk_buff *skb;
  82         void *reply;
  83
  84         /*
  85          * If new attributes are added, please revisit this allocation
  86          */
  87         skb = genlmsg_new(size, GFP_KERNEL);
  88         if (!skb)
  89                 return -ENOMEM;
  90
  91         if (!info) {
  92                 int seq = this_cpu_inc_return(taskstats_seqnum) - 1;
  93
  94                 reply = genlmsg_put(skb, 0, seq, &family, 0, cmd);
  95         } else
  96                 reply = genlmsg_put_reply(skb, info, &family, 0, cmd);
  97         if (reply == NULL) {
  98                 nlmsg_free(skb);
  99                 return -EINVAL;
 100         }
 101
 102         *skbp = skb;
 103         return 0;
 104 }
 105
 106 /*
 107  * Send taskstats data in @skb to listener with nl_pid @pid
 108  */
 109 static int send_reply(struct sk_buff *skb, struct genl_info *info)
 110 {
 111         struct genlmsghdr *genlhdr = nlmsg_data(nlmsg_hdr(skb));
 112         void *reply = genlmsg_data(genlhdr);
 113         int rc;
 114
 115         rc = genlmsg_end(skb, reply);
 116         if (rc < 0) {
 117                 nlmsg_free(skb);
 118                 return rc;
 119         }
 120
 121         return genlmsg_reply(skb, info);
 122 }
 123
 124 /*
 125  * Send taskstats data in @skb to listeners registered for @cpu's exit data
 126  */
 127 static void send_cpu_listeners(struct sk_buff *skb,
 128                                         struct listener_list *listeners)
 129 {
 130         struct genlmsghdr *genlhdr = nlmsg_data(nlmsg_hdr(skb));
 131         struct listener *s, *tmp;
 132         struct sk_buff *skb_next, *skb_cur = skb;
 133         void *reply = genlmsg_data(genlhdr);
 134         int rc, delcount = 0;
 135
 136         rc = genlmsg_end(skb, reply);
 137         if (rc < 0) {
 138                 nlmsg_free(skb);
 139                 return;
 140         }
 141
 142         rc = 0;
 143         down_read(&listeners->sem);
 144         list_for_each_entry(s, &listeners->list, list) {
 145                 skb_next = NULL;
 146                 if (!list_is_last(&s->list, &listeners->list)) {
 147                         skb_next = skb_clone(skb_cur, GFP_KERNEL);
 148                         if (!skb_next)
 149                                 break;
 150                 }
 151                 rc = genlmsg_unicast(&init_net, skb_cur, s->pid);
 152                 if (rc == -ECONNREFUSED) {
 153                         s->valid = 0;
 154                         delcount++;
 155                 }
 156                 skb_cur = skb_next;
 157         }
 158         up_read(&listeners->sem);
 159
 160         if (skb_cur)
 161                 nlmsg_free(skb_cur);
 162
 163         if (!delcount)
 164                 return;
 165
 166         /* Delete invalidated entries */
 167         down_write(&listeners->sem);
 168         list_for_each_entry_safe(s, tmp, &listeners->list, list) {
 169                 if (!s->valid) {
 170                         list_del(&s->list);
 171                         kfree(s);
 172                 }
 173         }
 174         up_write(&listeners->sem);
 175 }
 176
 177 static void fill_stats(struct task_struct *tsk, struct taskstats *stats)
 178 {
 179         memset(stats, 0, sizeof(*stats));
 180         /*
 181          * Each accounting subsystem adds calls to its functions to
 182          * fill in relevant parts of struct taskstsats as follows
 183          *
 184          *      per-task-foo(stats, tsk);
 185          */
 186
 187         delayacct_add_tsk(stats, tsk);
 188
 189         /* fill in basic acct fields */
 190         stats->version = TASKSTATS_VERSION;
 191         stats->nvcsw = tsk->nvcsw;
 192         stats->nivcsw = tsk->nivcsw;
 193         bacct_add_tsk(stats, tsk);
 194
 195         /* fill in extended acct fields */
 196         xacct_add_tsk(stats, tsk);
 197 }
 198
 199 static int fill_stats_for_pid(pid_t pid, struct taskstats *stats)
 200 {
 201         struct task_struct *tsk;
 202
 203         rcu_read_lock();
 204         tsk = find_task_by_vpid(pid);
 205         if (tsk)
 206                 get_task_struct(tsk);
 207         rcu_read_unlock();
 208         if (!tsk)
 209                 return -ESRCH;
 210         fill_stats(tsk, stats);
 211         put_task_struct(tsk);
 212         return 0;
 213 }
 214
 215 static int fill_stats_for_tgid(pid_t tgid, struct taskstats *stats)
 216 {
 217         struct task_struct *tsk, *first;
 218         unsigned long flags;
 219         int rc = -ESRCH;
 220
 221         /*
 222          * Add additional stats from live tasks except zombie thread group
 223          * leaders who are already counted with the dead tasks
 224          */
 225         rcu_read_lock();
 226         first = find_task_by_vpid(tgid);
 227
 228         if (!first || !lock_task_sighand(first, &flags))
 229                 goto out;
 230
 231         if (first->signal->stats)
 232                 memcpy(stats, first->signal->stats, sizeof(*stats));
 233         else
 234                 memset(stats, 0, sizeof(*stats));
 235
 236         tsk = first;
 237         do {
 238                 if (tsk->exit_state)
 239                         continue;
 240                 /*
 241                  * Accounting subsystem can call its functions here to
 242                  * fill in relevant parts of struct taskstsats as follows
 243                  *
 244                  *      per-task-foo(stats, tsk);
 245                  */
 246                 delayacct_add_tsk(stats, tsk);
 247
 248                 stats->nvcsw += tsk->nvcsw;
 249                 stats->nivcsw += tsk->nivcsw;
 250         } while_each_thread(first, tsk);
 251
 252         unlock_task_sighand(first, &flags);
 253         rc = 0;
 254 out:
 255         rcu_read_unlock();
 256
 257         stats->version = TASKSTATS_VERSION;
 258         /*
 259          * Accounting subsystems can also add calls here to modify
 260          * fields of taskstats.
 261          */
 262         return rc;
 263 }
 264
 265 static void fill_tgid_exit(struct task_struct *tsk)
 266 {
 267         unsigned long flags;
 268
 269         spin_lock_irqsave(&tsk->sighand->siglock, flags);
 270         if (!tsk->signal->stats)
 271                 goto ret;
 272
 273         /*
 274          * Each accounting subsystem calls its functions here to
 275          * accumalate its per-task stats for tsk, into the per-tgid structure
 276          *
 277          *      per-task-foo(tsk->signal->stats, tsk);
 278          */
 279         delayacct_add_tsk(tsk->signal->stats, tsk);
 280 ret:
 281         spin_unlock_irqrestore(&tsk->sighand->siglock, flags);
 282         return;
 283 }
 284
 285 static int add_del_listener(pid_t pid, const struct cpumask *mask, int isadd)
 286 {
 287         struct listener_list *listeners;
 288         struct listener *s, *tmp;
 289         unsigned int cpu;
 290
 291         if (!cpumask_subset(mask, cpu_possible_mask))
 292                 return -EINVAL;
 293
 294         if (isadd == REGISTER) {
 295                 for_each_cpu(cpu, mask) {
 296                         s = kmalloc_node(sizeof(struct listener), GFP_KERNEL,
 297                                          cpu_to_node(cpu));
 298                         if (!s)
 299                                 goto cleanup;
 300                         s->pid = pid;
 301                         INIT_LIST_HEAD(&s->list);
 302                         s->valid = 1;
 303
 304                         listeners = &per_cpu(listener_array, cpu);
 305                         down_write(&listeners->sem);
 306                         list_add(&s->list, &listeners->list);
 307                         up_write(&listeners->sem);
 308                 }
 309                 return 0;
 310         }
 311
 312         /* Deregister or cleanup */
 313 cleanup:
 314         for_each_cpu(cpu, mask) {
 315                 listeners = &per_cpu(listener_array, cpu);
 316                 down_write(&listeners->sem);
 317                 list_for_each_entry_safe(s, tmp, &listeners->list, list) {
 318                         if (s->pid == pid) {
 319                                 list_del(&s->list);
 320                                 kfree(s);
 321                                 break;
 322                         }
 323                 }
 324                 up_write(&listeners->sem);
 325         }
 326         return 0;
 327 }
 328
 329 static int parse(struct nlattr *na, struct cpumask *mask)
 330 {
 331         char *data;
 332         int len;
 333         int ret;
 334
 335         if (na == NULL)
 336                 return 1;
 337         len = nla_len(na);
 338         if (len > TASKSTATS_CPUMASK_MAXLEN)
 339                 return -E2BIG;
 340         if (len < 1)
 341                 return -EINVAL;
 342         data = kmalloc(len, GFP_KERNEL);
 343         if (!data)
 344                 return -ENOMEM;
 345         nla_strlcpy(data, na, len);
 346         ret = cpulist_parse(data, mask);
 347         kfree(data);
 348         return ret;
 349 }
 350
 351 static struct taskstats *mk_reply(struct sk_buff *skb, int type, u32 pid)
 352 {
 353         struct nlattr *na, *ret;
 354         int aggr;
 355
 356         /* If we don't pad, we end up with alignment on a 4 byte boundary.
 357          * This causes lots of runtime warnings on systems requiring 8 byte
 358          * alignment */
 359         u32 pids[2] = { pid, 0 };
 360         int pid_size = ALIGN(sizeof(pid), sizeof(long));
 361
 362         aggr = (type == TASKSTATS_TYPE_PID)
 363                         ? TASKSTATS_TYPE_AGGR_PID
 364                         : TASKSTATS_TYPE_AGGR_TGID;
 365
 366         na = nla_nest_start(skb, aggr);
 367         if (!na)
 368                 goto err;
 369         if (nla_put(skb, type, pid_size, pids) < 0)
 370                 goto err;
 371         ret = nla_reserve(skb, TASKSTATS_TYPE_STATS, sizeof(struct taskstats));
 372         if (!ret)
 373                 goto err;
 374         nla_nest_end(skb, na);
 375
 376         return nla_data(ret);
 377 err:
 378         return NULL;
 379 }
 380
 381 static int cgroupstats_user_cmd(struct sk_buff *skb, struct genl_info *info)
 382 {
 383         int rc = 0;
 384         struct sk_buff *rep_skb;
 385         struct cgroupstats *stats;
 386         struct nlattr *na;
 387         size_t size;
 388         u32 fd;
 389         struct file *file;
 390         int fput_needed;
 391
 392         na = info->attrs[CGROUPSTATS_CMD_ATTR_FD];
 393         if (!na)
 394                 return -EINVAL;
 395
 396         fd = nla_get_u32(info->attrs[CGROUPSTATS_CMD_ATTR_FD]);
 397         file = fget_light(fd, &fput_needed);
 398         if (!file)
 399                 return 0;
 400
 401         size = nla_total_size(sizeof(struct cgroupstats));
 402
 403         rc = prepare_reply(info, CGROUPSTATS_CMD_NEW, &rep_skb,
 404                                 size);
 405         if (rc < 0)
 406                 goto err;
 407
 408         na = nla_reserve(rep_skb, CGROUPSTATS_TYPE_CGROUP_STATS,
 409                                 sizeof(struct cgroupstats));
 410         stats = nla_data(na);
 411         memset(stats, 0, sizeof(*stats));
 412
 413         rc = cgroupstats_build(stats, file->f_dentry);
 414         if (rc < 0) {
 415                 nlmsg_free(rep_skb);
 416                 goto err;
 417         }
 418
 419         rc = send_reply(rep_skb, info);
 420
 421 err:
 422         fput_light(file, fput_needed);
 423         return rc;
 424 }
 425
 426 static int cmd_attr_register_cpumask(struct genl_info *info)
 427 {
 428         cpumask_var_t mask;
 429         int rc;
 430
 431         if (!alloc_cpumask_var(&mask, GFP_KERNEL))
 432                 return -ENOMEM;
 433         rc = parse(info->attrs[TASKSTATS_CMD_ATTR_REGISTER_CPUMASK], mask);
 434         if (rc < 0)
 435                 goto out;
 436         rc = add_del_listener(info->snd_pid, mask, REGISTER);
 437 out:
 438         free_cpumask_var(mask);
 439         return rc;
 440 }
 441
 442 static int cmd_attr_deregister_cpumask(struct genl_info *info)
 443 {
 444         cpumask_var_t mask;
 445         int rc;
 446
 447         if (!alloc_cpumask_var(&mask, GFP_KERNEL))
 448                 return -ENOMEM;
 449         rc = parse(info->attrs[TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK], mask);
 450         if (rc < 0)
 451                 goto out;
 452         rc = add_del_listener(info->snd_pid, mask, DEREGISTER);
 453 out:
 454         free_cpumask_var(mask);
 455         return rc;
 456 }
 457
 458 static int cmd_attr_pid(struct genl_info *info)
 459 {
 460         struct taskstats *stats;
 461         struct sk_buff *rep_skb;
 462         size_t size;
 463         u32 pid;
 464         int rc;
 465
 466         size = nla_total_size(sizeof(u32)) +
 467                 nla_total_size(sizeof(struct taskstats)) + nla_total_size(0);
 468
 469         rc = prepare_reply(info, TASKSTATS_CMD_NEW, &rep_skb, size);
 470         if (rc < 0)
 471                 return rc;
 472
 473         rc = -EINVAL;
 474         pid = nla_get_u32(info->attrs[TASKSTATS_CMD_ATTR_PID]);
 475         stats = mk_reply(rep_skb, TASKSTATS_TYPE_PID, pid);
 476         if (!stats)
 477                 goto err;
 478
 479         rc = fill_stats_for_pid(pid, stats);
 480         if (rc < 0)
 481                 goto err;
 482         return send_reply(rep_skb, info);
 483 err:
 484         nlmsg_free(rep_skb);
 485         return rc;
 486 }
 487
 488 static int cmd_attr_tgid(struct genl_info *info)
 489 {
 490         struct taskstats *stats;
 491         struct sk_buff *rep_skb;
 492         size_t size;
 493         u32 tgid;
 494         int rc;
 495
 496         size = nla_total_size(sizeof(u32)) +
 497                 nla_total_size(sizeof(struct taskstats)) + nla_total_size(0);
 498
 499         rc = prepare_reply(info, TASKSTATS_CMD_NEW, &rep_skb, size);
 500         if (rc < 0)
 501                 return rc;
 502
 503         rc = -EINVAL;
 504         tgid = nla_get_u32(info->attrs[TASKSTATS_CMD_ATTR_TGID]);
 505         stats = mk_reply(rep_skb, TASKSTATS_TYPE_TGID, tgid);
 506         if (!stats)
 507                 goto err;
 508
 509         rc = fill_stats_for_tgid(tgid, stats);
 510         if (rc < 0)
 511                 goto err;
 512         return send_reply(rep_skb, info);
 513 err:
 514         nlmsg_free(rep_skb);
 515         return rc;
 516 }
 517
 518 static int taskstats_user_cmd(struct sk_buff *skb, struct genl_info *info)
 519 {
 520         if (info->attrs[TASKSTATS_CMD_ATTR_REGISTER_CPUMASK])
 521                 return cmd_attr_register_cpumask(info);
 522         else if (info->attrs[TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK])
 523                 return cmd_attr_deregister_cpumask(info);
 524         else if (info->attrs[TASKSTATS_CMD_ATTR_PID])
 525                 return cmd_attr_pid(info);
 526         else if (info->attrs[TASKSTATS_CMD_ATTR_TGID])
 527                 return cmd_attr_tgid(info);
 528         else
 529                 return -EINVAL;
 530 }
 531
 532 static struct taskstats *taskstats_tgid_alloc(struct task_struct *tsk)
 533 {
 534         struct signal_struct *sig = tsk->signal;
 535         struct taskstats *stats;
 536
 537         if (sig->stats || thread_group_empty(tsk))
 538                 goto ret;
 539
 540         /* No problem if kmem_cache_zalloc() fails */
 541         stats = kmem_cache_zalloc(taskstats_cache, GFP_KERNEL);
 542
 543         spin_lock_irq(&tsk->sighand->siglock);
 544         if (!sig->stats) {
 545                 sig->stats = stats;
 546                 stats = NULL;
 547         }
 548         spin_unlock_irq(&tsk->sighand->siglock);
 549
 550         if (stats)
 551                 kmem_cache_free(taskstats_cache, stats);
 552 ret:
 553         return sig->stats;
 554 }
 555
 556 /* Send pid data out on exit */
 557 void taskstats_exit(struct task_struct *tsk, int group_dead)
 558 {
 559         int rc;
 560         struct listener_list *listeners;
 561         struct taskstats *stats;
 562         struct sk_buff *rep_skb;
 563         size_t size;
 564         int is_thread_group;
 565
 566         if (!family_registered)
 567                 return;
 568
 569         /*
 570          * Size includes space for nested attributes
 571          */
 572         size = nla_total_size(sizeof(u32)) +
 573                 nla_total_size(sizeof(struct taskstats)) + nla_total_size(0);
 574
 575         is_thread_group = !!taskstats_tgid_alloc(tsk);
 576         if (is_thread_group) {
 577                 /* PID + STATS + TGID + STATS */
 578                 size = 2 * size;
 579                 /* fill the tsk->signal->stats structure */
 580                 fill_tgid_exit(tsk);
 581         }
 582
 583         listeners = __this_cpu_ptr(&listener_array);
 584         if (list_empty(&listeners->list))
 585                 return;
 586
 587         rc = prepare_reply(NULL, TASKSTATS_CMD_NEW, &rep_skb, size);
 588         if (rc < 0)
 589                 return;
 590
 591         stats = mk_reply(rep_skb, TASKSTATS_TYPE_PID, tsk->pid);
 592         if (!stats)
 593                 goto err;
 594
 595         fill_stats(tsk, stats);
 596
 597         /*
 598          * Doesn't matter if tsk is the leader or the last group member leaving
 599          */
 600         if (!is_thread_group || !group_dead)
 601                 goto send;
 602
 603         stats = mk_reply(rep_skb, TASKSTATS_TYPE_TGID, tsk->tgid);
 604         if (!stats)
 605                 goto err;
 606
 607         memcpy(stats, tsk->signal->stats, sizeof(*stats));
 608
 609 send:
 610         send_cpu_listeners(rep_skb, listeners);
 611         return;
 612 err:
 613         nlmsg_free(rep_skb);
 614 }
 615
 616 static struct genl_ops taskstats_ops = {
 617         .cmd            = TASKSTATS_CMD_GET,
 618         .doit           = taskstats_user_cmd,
 619         .policy         = taskstats_cmd_get_policy,
 620 };
 621
 622 static struct genl_ops cgroupstats_ops = {
 623         .cmd            = CGROUPSTATS_CMD_GET,
 624         .doit           = cgroupstats_user_cmd,
 625         .policy         = cgroupstats_cmd_get_policy,
 626 };
 627
 628 /* Needed early in initialization */
 629 void __init taskstats_init_early(void)
 630 {
 631         unsigned int i;
 632
 633         taskstats_cache = KMEM_CACHE(taskstats, SLAB_PANIC);
 634         for_each_possible_cpu(i) {
 635                 INIT_LIST_HEAD(&(per_cpu(listener_array, i).list));
 636                 init_rwsem(&(per_cpu(listener_array, i).sem));
 637         }
 638 }
 639
 640 static int __init taskstats_init(void)
 641 {
 642         int rc;
 643
 644         rc = genl_register_family(&family);
 645         if (rc)
 646                 return rc;
 647
 648         rc = genl_register_ops(&family, &taskstats_ops);
 649         if (rc < 0)
 650                 goto err;
 651
 652         rc = genl_register_ops(&family, &cgroupstats_ops);
 653         if (rc < 0)
 654                 goto err_cgroup_ops;
 655
 656         family_registered = 1;
 657         printk("registered taskstats version %d\n", TASKSTATS_GENL_VERSION);
 658         return 0;
 659 err_cgroup_ops:
 660         genl_unregister_ops(&family, &taskstats_ops);
 661 err:
 662         genl_unregister_family(&family);
 663         return rc;
 664 }
 665
 666 /*
 667  * late initcall ensures initialization of statistics collection
 668  * mechanisms precedes initialization of the taskstats interface
 669  */
 670 late_initcall(taskstats_init);