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