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