kernel/acct.c

   1 /*
   2  *  linux/kernel/acct.c
   3  *
   4  *  BSD Process Accounting for Linux
   5  *
   6  *  Author: Marco van Wieringen <mvw@planets.elm.net>
   7  *
   8  *  Some code based on ideas and code from:
   9  *  Thomas K. Dyas <tdyas@eden.rutgers.edu>
  10  *
  11  *  This file implements BSD-style process accounting. Whenever any
  12  *  process exits, an accounting record of type "struct acct" is
  13  *  written to the file specified with the acct() system call. It is
  14  *  up to user-level programs to do useful things with the accounting
  15  *  log. The kernel just provides the raw accounting information.
  16  *
  17  * (C) Copyright 1995 - 1997 Marco van Wieringen - ELM Consultancy B.V.
  18  *
  19  *  Plugged two leaks. 1) It didn't return acct_file into the free_filps if
  20  *  the file happened to be read-only. 2) If the accounting was suspended
  21  *  due to the lack of space it happily allowed to reopen it and completely
  22  *  lost the old acct_file. 3/10/98, Al Viro.
  23  *
  24  *  Now we silently close acct_file on attempt to reopen. Cleaned sys_acct().
  25  *  XTerms and EMACS are manifestations of pure evil. 21/10/98, AV.
  26  *
  27  *  Fixed a nasty interaction with with sys_umount(). If the accointing
  28  *  was suspeneded we failed to stop it on umount(). Messy.
  29  *  Another one: remount to readonly didn't stop accounting.
  30  *      Question: what should we do if we have CAP_SYS_ADMIN but not
  31  *  CAP_SYS_PACCT? Current code does the following: umount returns -EBUSY
  32  *  unless we are messing with the root. In that case we are getting a
  33  *  real mess with do_remount_sb(). 9/11/98, AV.
  34  *
  35  *  Fixed a bunch of races (and pair of leaks). Probably not the best way,
  36  *  but this one obviously doesn't introduce deadlocks. Later. BTW, found
  37  *  one race (and leak) in BSD implementation.
  38  *  OK, that's better. ANOTHER race and leak in BSD variant. There always
  39  *  is one more bug... 10/11/98, AV.
  40  *
  41  *      Oh, fsck... Oopsable SMP race in do_process_acct() - we must hold
  42  * ->mmap_sem to walk the vma list of current->mm. Nasty, since it leaks
  43  * a struct file opened for write. Fixed. 2/6/2000, AV.
  44  */
  45
  46 #include <linux/mm.h>
  47 #include <linux/slab.h>
  48 #include <linux/acct.h>
  49 #include <linux/capability.h>
  50 #include <linux/file.h>
  51 #include <linux/tty.h>
  52 #include <linux/security.h>
  53 #include <linux/vfs.h>
  54 #include <linux/jiffies.h>
  55 #include <linux/times.h>
  56 #include <linux/syscalls.h>
  57 #include <linux/mount.h>
  58 #include <linux/uaccess.h>
  59 #include <asm/div64.h>
  60 #include <linux/blkdev.h> /* sector_div */
  61 #include <linux/pid_namespace.h>
  62 #include <../fs/mount.h>        /* will go away when we refactor */
  63
  64 /*
  65  * These constants control the amount of freespace that suspend and
  66  * resume the process accounting system, and the time delay between
  67  * each check.
  68  * Turned into sysctl-controllable parameters. AV, 12/11/98
  69  */
  70
  71 int acct_parm[3] = {4, 2, 30};
  72 #define RESUME          (acct_parm[0])  /* >foo% free space - resume */
  73 #define SUSPEND         (acct_parm[1])  /* <foo% free space - suspend */
  74 #define ACCT_TIMEOUT    (acct_parm[2])  /* foo second timeout between checks */
  75
  76 /*
  77  * External references and all of the globals.
  78  */
  79 static void do_acct_process(struct bsd_acct_struct *acct);
  80
  81 struct fs_pin {
  82         atomic_long_t           count;
  83         union {
  84                 struct {
  85                         struct hlist_node       s_list;
  86                         struct hlist_node       m_list;
  87                 };
  88                 struct rcu_head rcu;
  89         };
  90 };
  91
  92 struct bsd_acct_struct {
  93         struct fs_pin           pin;
  94         struct mutex            lock;
  95         int                     active;
  96         unsigned long           needcheck;
  97         struct file             *file;
  98         struct pid_namespace    *ns;
  99         struct work_struct      work;
 100         struct completion       done;
 101 };
 102
 103 static void pin_free_rcu(struct rcu_head *head)
 104 {
 105         kfree(container_of(head, struct fs_pin, rcu));
 106 }
 107
 108 static DEFINE_SPINLOCK(acct_lock);
 109
 110 /*
 111  * Check the amount of free space and suspend/resume accordingly.
 112  */
 113 static int check_free_space(struct bsd_acct_struct *acct)
 114 {
 115         struct kstatfs sbuf;
 116
 117         if (time_is_before_jiffies(acct->needcheck))
 118                 goto out;
 119
 120         /* May block */
 121         if (vfs_statfs(&acct->file->f_path, &sbuf))
 122                 goto out;
 123
 124         if (acct->active) {
 125                 u64 suspend = sbuf.f_blocks * SUSPEND;
 126                 do_div(suspend, 100);
 127                 if (sbuf.f_bavail <= suspend) {
 128                         acct->active = 0;
 129                         printk(KERN_INFO "Process accounting paused\n");
 130                 }
 131         } else {
 132                 u64 resume = sbuf.f_blocks * RESUME;
 133                 do_div(resume, 100);
 134                 if (sbuf.f_bavail >= resume) {
 135                         acct->active = 1;
 136                         printk(KERN_INFO "Process accounting resumed\n");
 137                 }
 138         }
 139
 140         acct->needcheck = jiffies + ACCT_TIMEOUT*HZ;
 141 out:
 142         return acct->active;
 143 }
 144
 145 static void pin_put(struct fs_pin *p)
 146 {
 147         if (atomic_long_dec_and_test(&p->count))
 148                 call_rcu(&p->rcu, pin_free_rcu);
 149 }
 150
 151 static struct bsd_acct_struct *__acct_get(struct bsd_acct_struct *res)
 152 {
 153         if (!atomic_long_inc_not_zero(&res->pin.count)) {
 154                 rcu_read_unlock();
 155                 cpu_relax();
 156                 return NULL;
 157         }
 158         rcu_read_unlock();
 159         mutex_lock(&res->lock);
 160         if (!res->ns) {
 161                 mutex_unlock(&res->lock);
 162                 pin_put(&res->pin);
 163                 return NULL;
 164         }
 165         return res;
 166 }
 167
 168 static struct bsd_acct_struct *acct_get(struct pid_namespace *ns)
 169 {
 170         struct bsd_acct_struct *res;
 171 again:
 172         smp_rmb();
 173         rcu_read_lock();
 174         res = ACCESS_ONCE(ns->bacct);
 175         if (!res) {
 176                 rcu_read_unlock();
 177                 return NULL;
 178         }
 179         res = __acct_get(res);
 180         if (!res)
 181                 goto again;
 182         return res;
 183 }
 184
 185 static void close_work(struct work_struct *work)
 186 {
 187         struct bsd_acct_struct *acct = container_of(work, struct bsd_acct_struct, work);
 188         struct file *file = acct->file;
 189         mnt_unpin(file->f_path.mnt);
 190         if (file->f_op->flush)
 191                 file->f_op->flush(file, NULL);
 192         __fput_sync(file);
 193         complete(&acct->done);
 194 }
 195
 196 static void acct_kill(struct bsd_acct_struct *acct,
 197                       struct bsd_acct_struct *new)
 198 {
 199         if (acct) {
 200                 struct pid_namespace *ns = acct->ns;
 201                 do_acct_process(acct);
 202                 INIT_WORK(&acct->work, close_work);
 203                 init_completion(&acct->done);
 204                 schedule_work(&acct->work);
 205                 wait_for_completion(&acct->done);
 206                 spin_lock(&acct_lock);
 207                 hlist_del(&acct->pin.m_list);
 208                 hlist_del(&acct->pin.s_list);
 209                 spin_unlock(&acct_lock);
 210                 ns->bacct = new;
 211                 if (new) {
 212                         struct vfsmount *m = new->file->f_path.mnt;
 213                         spin_lock(&acct_lock);
 214                         hlist_add_head(&new->pin.s_list, &m->mnt_sb->s_pins);
 215                         hlist_add_head(&new->pin.m_list, &real_mount(m)->mnt_pins);
 216                         spin_unlock(&acct_lock);
 217                         mutex_unlock(&new->lock);
 218                 }
 219                 acct->ns = NULL;
 220                 atomic_long_dec(&acct->pin.count);
 221                 mutex_unlock(&acct->lock);
 222                 pin_put(&acct->pin);
 223         }
 224 }
 225
 226 static int acct_on(struct filename *pathname)
 227 {
 228         struct file *file;
 229         struct vfsmount *mnt;
 230         struct pid_namespace *ns = task_active_pid_ns(current);
 231         struct bsd_acct_struct *acct, *old;
 232
 233         acct = kzalloc(sizeof(struct bsd_acct_struct), GFP_KERNEL);
 234         if (!acct)
 235                 return -ENOMEM;
 236
 237         /* Difference from BSD - they don't do O_APPEND */
 238         file = file_open_name(pathname, O_WRONLY|O_APPEND|O_LARGEFILE, 0);
 239         if (IS_ERR(file)) {
 240                 kfree(acct);
 241                 return PTR_ERR(file);
 242         }
 243
 244         if (!S_ISREG(file_inode(file)->i_mode)) {
 245                 kfree(acct);
 246                 filp_close(file, NULL);
 247                 return -EACCES;
 248         }
 249
 250         if (!file->f_op->write) {
 251                 kfree(acct);
 252                 filp_close(file, NULL);
 253                 return -EIO;
 254         }
 255
 256         atomic_long_set(&acct->pin.count, 1);
 257         acct->file = file;
 258         acct->needcheck = jiffies;
 259         acct->ns = ns;
 260         mutex_init(&acct->lock);
 261         mnt = file->f_path.mnt;
 262         mnt_pin(mnt);
 263
 264         old = acct_get(ns);
 265         mutex_lock_nested(&acct->lock, 1);      /* nobody has seen it yet */
 266         if (old) {
 267                 acct_kill(old, acct);
 268         } else {
 269                 ns->bacct = acct;
 270                 spin_lock(&acct_lock);
 271                 hlist_add_head(&acct->pin.s_list, &mnt->mnt_sb->s_pins);
 272                 hlist_add_head(&acct->pin.m_list, &real_mount(mnt)->mnt_pins);
 273                 spin_unlock(&acct_lock);
 274                 mutex_unlock(&acct->lock);
 275         }
 276         mntput(mnt); /* it's pinned, now give up active reference */
 277         return 0;
 278 }
 279
 280 static DEFINE_MUTEX(acct_on_mutex);
 281
 282 /**
 283  * sys_acct - enable/disable process accounting
 284  * @name: file name for accounting records or NULL to shutdown accounting
 285  *
 286  * Returns 0 for success or negative errno values for failure.
 287  *
 288  * sys_acct() is the only system call needed to implement process
 289  * accounting. It takes the name of the file where accounting records
 290  * should be written. If the filename is NULL, accounting will be
 291  * shutdown.
 292  */
 293 SYSCALL_DEFINE1(acct, const char __user *, name)
 294 {
 295         int error = 0;
 296
 297         if (!capable(CAP_SYS_PACCT))
 298                 return -EPERM;
 299
 300         if (name) {
 301                 struct filename *tmp = getname(name);
 302                 if (IS_ERR(tmp))
 303                         return PTR_ERR(tmp);
 304                 mutex_lock(&acct_on_mutex);
 305                 error = acct_on(tmp);
 306                 mutex_unlock(&acct_on_mutex);
 307                 putname(tmp);
 308         } else {
 309                 acct_kill(acct_get(task_active_pid_ns(current)), NULL);
 310         }
 311
 312         return error;
 313 }
 314
 315 void acct_auto_close_mnt(struct hlist_head *list)
 316 {
 317         rcu_read_lock();
 318         while (1) {
 319                 struct hlist_node *p = ACCESS_ONCE(list->first);
 320                 if (!p)
 321                         break;
 322                 acct_kill(__acct_get(hlist_entry(p,
 323                                                  struct bsd_acct_struct,
 324                                                  pin.m_list)), NULL);
 325                 rcu_read_lock();
 326         }
 327         rcu_read_unlock();
 328 }
 329
 330 void acct_auto_close(struct hlist_head *list)
 331 {
 332         rcu_read_lock();
 333         while (1) {
 334                 struct hlist_node *p = ACCESS_ONCE(list->first);
 335                 if (!p)
 336                         break;
 337                 acct_kill(__acct_get(hlist_entry(p,
 338                                                  struct bsd_acct_struct,
 339                                                  pin.s_list)), NULL);
 340                 rcu_read_lock();
 341         }
 342         rcu_read_unlock();
 343 }
 344
 345 void acct_exit_ns(struct pid_namespace *ns)
 346 {
 347         acct_kill(acct_get(ns), NULL);
 348 }
 349
 350 /*
 351  *  encode an unsigned long into a comp_t
 352  *
 353  *  This routine has been adopted from the encode_comp_t() function in
 354  *  the kern_acct.c file of the FreeBSD operating system. The encoding
 355  *  is a 13-bit fraction with a 3-bit (base 8) exponent.
 356  */
 357
 358 #define MANTSIZE        13                      /* 13 bit mantissa. */
 359 #define EXPSIZE         3                       /* Base 8 (3 bit) exponent. */
 360 #define MAXFRACT        ((1 << MANTSIZE) - 1)   /* Maximum fractional value. */
 361
 362 static comp_t encode_comp_t(unsigned long value)
 363 {
 364         int exp, rnd;
 365
 366         exp = rnd = 0;
 367         while (value > MAXFRACT) {
 368                 rnd = value & (1 << (EXPSIZE - 1));     /* Round up? */
 369                 value >>= EXPSIZE;      /* Base 8 exponent == 3 bit shift. */
 370                 exp++;
 371         }
 372
 373         /*
 374          * If we need to round up, do it (and handle overflow correctly).
 375          */
 376         if (rnd && (++value > MAXFRACT)) {
 377                 value >>= EXPSIZE;
 378                 exp++;
 379         }
 380
 381         /*
 382          * Clean it up and polish it off.
 383          */
 384         exp <<= MANTSIZE;               /* Shift the exponent into place */
 385         exp += value;                   /* and add on the mantissa. */
 386         return exp;
 387 }
 388
 389 #if ACCT_VERSION==1 || ACCT_VERSION==2
 390 /*
 391  * encode an u64 into a comp2_t (24 bits)
 392  *
 393  * Format: 5 bit base 2 exponent, 20 bits mantissa.
 394  * The leading bit of the mantissa is not stored, but implied for
 395  * non-zero exponents.
 396  * Largest encodable value is 50 bits.
 397  */
 398
 399 #define MANTSIZE2       20                      /* 20 bit mantissa. */
 400 #define EXPSIZE2        5                       /* 5 bit base 2 exponent. */
 401 #define MAXFRACT2       ((1ul << MANTSIZE2) - 1) /* Maximum fractional value. */
 402 #define MAXEXP2         ((1 <<EXPSIZE2) - 1)    /* Maximum exponent. */
 403
 404 static comp2_t encode_comp2_t(u64 value)
 405 {
 406         int exp, rnd;
 407
 408         exp = (value > (MAXFRACT2>>1));
 409         rnd = 0;
 410         while (value > MAXFRACT2) {
 411                 rnd = value & 1;
 412                 value >>= 1;
 413                 exp++;
 414         }
 415
 416         /*
 417          * If we need to round up, do it (and handle overflow correctly).
 418          */
 419         if (rnd && (++value > MAXFRACT2)) {
 420                 value >>= 1;
 421                 exp++;
 422         }
 423
 424         if (exp > MAXEXP2) {
 425                 /* Overflow. Return largest representable number instead. */
 426                 return (1ul << (MANTSIZE2+EXPSIZE2-1)) - 1;
 427         } else {
 428                 return (value & (MAXFRACT2>>1)) | (exp << (MANTSIZE2-1));
 429         }
 430 }
 431 #endif
 432
 433 #if ACCT_VERSION==3
 434 /*
 435  * encode an u64 into a 32 bit IEEE float
 436  */
 437 static u32 encode_float(u64 value)
 438 {
 439         unsigned exp = 190;
 440         unsigned u;
 441
 442         if (value==0) return 0;
 443         while ((s64)value > 0){
 444                 value <<= 1;
 445                 exp--;
 446         }
 447         u = (u32)(value >> 40) & 0x7fffffu;
 448         return u | (exp << 23);
 449 }
 450 #endif
 451
 452 /*
 453  *  Write an accounting entry for an exiting process
 454  *
 455  *  The acct_process() call is the workhorse of the process
 456  *  accounting system. The struct acct is built here and then written
 457  *  into the accounting file. This function should only be called from
 458  *  do_exit() or when switching to a different output file.
 459  */
 460
 461 static void fill_ac(acct_t *ac)
 462 {
 463         struct pacct_struct *pacct = &current->signal->pacct;
 464         u64 elapsed, run_time;
 465         struct tty_struct *tty;
 466
 467         /*
 468          * Fill the accounting struct with the needed info as recorded
 469          * by the different kernel functions.
 470          */
 471         memset(ac, 0, sizeof(acct_t));
 472
 473         ac->ac_version = ACCT_VERSION | ACCT_BYTEORDER;
 474         strlcpy(ac->ac_comm, current->comm, sizeof(ac->ac_comm));
 475
 476         /* calculate run_time in nsec*/
 477         run_time = ktime_get_ns();
 478         run_time -= current->group_leader->start_time;
 479         /* convert nsec -> AHZ */
 480         elapsed = nsec_to_AHZ(run_time);
 481 #if ACCT_VERSION==3
 482         ac->ac_etime = encode_float(elapsed);
 483 #else
 484         ac->ac_etime = encode_comp_t(elapsed < (unsigned long) -1l ?
 485                                (unsigned long) elapsed : (unsigned long) -1l);
 486 #endif
 487 #if ACCT_VERSION==1 || ACCT_VERSION==2
 488         {
 489                 /* new enlarged etime field */
 490                 comp2_t etime = encode_comp2_t(elapsed);
 491                 ac->ac_etime_hi = etime >> 16;
 492                 ac->ac_etime_lo = (u16) etime;
 493         }
 494 #endif
 495         do_div(elapsed, AHZ);
 496         ac->ac_btime = get_seconds() - elapsed;
 497 #if ACCT_VERSION==2
 498         ac->ac_ahz = AHZ;
 499 #endif
 500
 501         spin_lock_irq(&current->sighand->siglock);
 502         tty = current->signal->tty;     /* Safe as we hold the siglock */
 503         ac->ac_tty = tty ? old_encode_dev(tty_devnum(tty)) : 0;
 504         ac->ac_utime = encode_comp_t(jiffies_to_AHZ(cputime_to_jiffies(pacct->ac_utime)));
 505         ac->ac_stime = encode_comp_t(jiffies_to_AHZ(cputime_to_jiffies(pacct->ac_stime)));
 506         ac->ac_flag = pacct->ac_flag;
 507         ac->ac_mem = encode_comp_t(pacct->ac_mem);
 508         ac->ac_minflt = encode_comp_t(pacct->ac_minflt);
 509         ac->ac_majflt = encode_comp_t(pacct->ac_majflt);
 510         ac->ac_exitcode = pacct->ac_exitcode;
 511         spin_unlock_irq(&current->sighand->siglock);
 512 }
 513 /*
 514  *  do_acct_process does all actual work. Caller holds the reference to file.
 515  */
 516 static void do_acct_process(struct bsd_acct_struct *acct)
 517 {
 518         acct_t ac;
 519         unsigned long flim;
 520         const struct cred *orig_cred;
 521         struct pid_namespace *ns = acct->ns;
 522         struct file *file = acct->file;
 523
 524         /*
 525          * Accounting records are not subject to resource limits.
 526          */
 527         flim = current->signal->rlim[RLIMIT_FSIZE].rlim_cur;
 528         current->signal->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
 529         /* Perform file operations on behalf of whoever enabled accounting */
 530         orig_cred = override_creds(file->f_cred);
 531
 532         /*
 533          * First check to see if there is enough free_space to continue
 534          * the process accounting system.
 535          */
 536         if (!check_free_space(acct))
 537                 goto out;
 538
 539         fill_ac(&ac);
 540         /* we really need to bite the bullet and change layout */
 541         ac.ac_uid = from_kuid_munged(file->f_cred->user_ns, orig_cred->uid);
 542         ac.ac_gid = from_kgid_munged(file->f_cred->user_ns, orig_cred->gid);
 543 #if ACCT_VERSION==1 || ACCT_VERSION==2
 544         /* backward-compatible 16 bit fields */
 545         ac.ac_uid16 = ac.ac_uid;
 546         ac.ac_gid16 = ac.ac_gid;
 547 #endif
 548 #if ACCT_VERSION==3
 549         ac.ac_pid = task_tgid_nr_ns(current, ns);
 550         rcu_read_lock();
 551         ac.ac_ppid = task_tgid_nr_ns(rcu_dereference(current->real_parent), ns);
 552         rcu_read_unlock();
 553 #endif
 554         /*
 555          * Get freeze protection. If the fs is frozen, just skip the write
 556          * as we could deadlock the system otherwise.
 557          */
 558         if (file_start_write_trylock(file)) {
 559                 /* it's been opened O_APPEND, so position is irrelevant */
 560                 loff_t pos = 0;
 561                 __kernel_write(file, (char *)&ac, sizeof(acct_t), &pos);
 562                 file_end_write(file);
 563         }
 564 out:
 565         current->signal->rlim[RLIMIT_FSIZE].rlim_cur = flim;
 566         revert_creds(orig_cred);
 567 }
 568
 569 /**
 570  * acct_collect - collect accounting information into pacct_struct
 571  * @exitcode: task exit code
 572  * @group_dead: not 0, if this thread is the last one in the process.
 573  */
 574 void acct_collect(long exitcode, int group_dead)
 575 {
 576         struct pacct_struct *pacct = &current->signal->pacct;
 577         cputime_t utime, stime;
 578         unsigned long vsize = 0;
 579
 580         if (group_dead && current->mm) {
 581                 struct vm_area_struct *vma;
 582                 down_read(&current->mm->mmap_sem);
 583                 vma = current->mm->mmap;
 584                 while (vma) {
 585                         vsize += vma->vm_end - vma->vm_start;
 586                         vma = vma->vm_next;
 587                 }
 588                 up_read(&current->mm->mmap_sem);
 589         }
 590
 591         spin_lock_irq(&current->sighand->siglock);
 592         if (group_dead)
 593                 pacct->ac_mem = vsize / 1024;
 594         if (thread_group_leader(current)) {
 595                 pacct->ac_exitcode = exitcode;
 596                 if (current->flags & PF_FORKNOEXEC)
 597                         pacct->ac_flag |= AFORK;
 598         }
 599         if (current->flags & PF_SUPERPRIV)
 600                 pacct->ac_flag |= ASU;
 601         if (current->flags & PF_DUMPCORE)
 602                 pacct->ac_flag |= ACORE;
 603         if (current->flags & PF_SIGNALED)
 604                 pacct->ac_flag |= AXSIG;
 605         task_cputime(current, &utime, &stime);
 606         pacct->ac_utime += utime;
 607         pacct->ac_stime += stime;
 608         pacct->ac_minflt += current->min_flt;
 609         pacct->ac_majflt += current->maj_flt;
 610         spin_unlock_irq(&current->sighand->siglock);
 611 }
 612
 613 static void slow_acct_process(struct pid_namespace *ns)
 614 {
 615         for ( ; ns; ns = ns->parent) {
 616                 struct bsd_acct_struct *acct = acct_get(ns);
 617                 if (acct) {
 618                         do_acct_process(acct);
 619                         mutex_unlock(&acct->lock);
 620                         pin_put(&acct->pin);
 621                 }
 622         }
 623 }
 624
 625 /**
 626  * acct_process
 627  *
 628  * handles process accounting for an exiting task
 629  */
 630 void acct_process(void)
 631 {
 632         struct pid_namespace *ns;
 633
 634         /*
 635          * This loop is safe lockless, since current is still
 636          * alive and holds its namespace, which in turn holds
 637          * its parent.
 638          */
 639         for (ns = task_active_pid_ns(current); ns != NULL; ns = ns->parent) {
 640                 if (ns->bacct)
 641                         break;
 642         }
 643         if (unlikely(ns))
 644                 slow_acct_process(ns);
 645 }