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 <linux/fs_pin.h>
  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 bsd_acct_struct {
  82         struct fs_pin           pin;
  83         atomic_long_t           count;
  84         struct rcu_head         rcu;
  85         struct mutex            lock;
  86         int                     active;
  87         unsigned long           needcheck;
  88         struct file             *file;
  89         struct pid_namespace    *ns;
  90         struct work_struct      work;
  91         struct completion       done;
  92 };
  93
  94 /*
  95  * Check the amount of free space and suspend/resume accordingly.
  96  */
  97 static int check_free_space(struct bsd_acct_struct *acct)
  98 {
  99         struct kstatfs sbuf;
 100
 101         if (time_is_before_jiffies(acct->needcheck))
 102                 goto out;
 103
 104         /* May block */
 105         if (vfs_statfs(&acct->file->f_path, &sbuf))
 106                 goto out;
 107
 108         if (acct->active) {
 109                 u64 suspend = sbuf.f_blocks * SUSPEND;
 110                 do_div(suspend, 100);
 111                 if (sbuf.f_bavail <= suspend) {
 112                         acct->active = 0;
 113                         pr_info("Process accounting paused\n");
 114                 }
 115         } else {
 116                 u64 resume = sbuf.f_blocks * RESUME;
 117                 do_div(resume, 100);
 118                 if (sbuf.f_bavail >= resume) {
 119                         acct->active = 1;
 120                         pr_info("Process accounting resumed\n");
 121                 }
 122         }
 123
 124         acct->needcheck = jiffies + ACCT_TIMEOUT*HZ;
 125 out:
 126         return acct->active;
 127 }
 128
 129 static void acct_put(struct bsd_acct_struct *p)
 130 {
 131         if (atomic_long_dec_and_test(&p->count))
 132                 kfree_rcu(p, rcu);
 133 }
 134
 135 static struct bsd_acct_struct *acct_get(struct pid_namespace *ns)
 136 {
 137         struct bsd_acct_struct *res;
 138 again:
 139         smp_rmb();
 140         rcu_read_lock();
 141         res = ACCESS_ONCE(ns->bacct);
 142         if (!res) {
 143                 rcu_read_unlock();
 144                 return NULL;
 145         }
 146         if (!atomic_long_inc_not_zero(&res->count)) {
 147                 rcu_read_unlock();
 148                 cpu_relax();
 149                 goto again;
 150         }
 151         rcu_read_unlock();
 152         mutex_lock(&res->lock);
 153         if (!res->ns) {
 154                 mutex_unlock(&res->lock);
 155                 acct_put(res);
 156                 goto again;
 157         }
 158         return res;
 159 }
 160
 161 static void close_work(struct work_struct *work)
 162 {
 163         struct bsd_acct_struct *acct = container_of(work, struct bsd_acct_struct, work);
 164         struct file *file = acct->file;
 165         if (file->f_op->flush)
 166                 file->f_op->flush(file, NULL);
 167         __fput_sync(file);
 168         complete(&acct->done);
 169 }
 170
 171 static void acct_kill(struct bsd_acct_struct *acct,
 172                       struct bsd_acct_struct *new)
 173 {
 174         if (acct) {
 175                 struct pid_namespace *ns = acct->ns;
 176                 do_acct_process(acct);
 177                 INIT_WORK(&acct->work, close_work);
 178                 init_completion(&acct->done);
 179                 schedule_work(&acct->work);
 180                 wait_for_completion(&acct->done);
 181                 pin_remove(&acct->pin);
 182                 ns->bacct = new;
 183                 acct->ns = NULL;
 184                 atomic_long_dec(&acct->count);
 185                 mutex_unlock(&acct->lock);
 186                 acct_put(acct);
 187         }
 188 }
 189
 190 static void acct_pin_kill(struct fs_pin *pin)
 191 {
 192         struct bsd_acct_struct *acct;
 193         acct = container_of(pin, struct bsd_acct_struct, pin);
 194         if (!atomic_long_inc_not_zero(&acct->count)) {
 195                 rcu_read_unlock();
 196                 cpu_relax();
 197                 return;
 198         }
 199         rcu_read_unlock();
 200         mutex_lock(&acct->lock);
 201         if (!acct->ns) {
 202                 mutex_unlock(&acct->lock);
 203                 acct_put(acct);
 204                 acct = NULL;
 205         }
 206         acct_kill(acct, NULL);
 207 }
 208
 209 static int acct_on(struct filename *pathname)
 210 {
 211         struct file *file;
 212         struct vfsmount *mnt, *internal;
 213         struct pid_namespace *ns = task_active_pid_ns(current);
 214         struct bsd_acct_struct *acct, *old;
 215         int err;
 216
 217         acct = kzalloc(sizeof(struct bsd_acct_struct), GFP_KERNEL);
 218         if (!acct)
 219                 return -ENOMEM;
 220
 221         /* Difference from BSD - they don't do O_APPEND */
 222         file = file_open_name(pathname, O_WRONLY|O_APPEND|O_LARGEFILE, 0);
 223         if (IS_ERR(file)) {
 224                 kfree(acct);
 225                 return PTR_ERR(file);
 226         }
 227
 228         if (!S_ISREG(file_inode(file)->i_mode)) {
 229                 kfree(acct);
 230                 filp_close(file, NULL);
 231                 return -EACCES;
 232         }
 233
 234         if (!file->f_op->write) {
 235                 kfree(acct);
 236                 filp_close(file, NULL);
 237                 return -EIO;
 238         }
 239         internal = mnt_clone_internal(&file->f_path);
 240         if (IS_ERR(internal)) {
 241                 kfree(acct);
 242                 filp_close(file, NULL);
 243                 return PTR_ERR(internal);
 244         }
 245         err = mnt_want_write(internal);
 246         if (err) {
 247                 mntput(internal);
 248                 kfree(acct);
 249                 filp_close(file, NULL);
 250                 return err;
 251         }
 252         mnt = file->f_path.mnt;
 253         file->f_path.mnt = internal;
 254
 255         atomic_long_set(&acct->count, 1);
 256         acct->pin.kill = acct_pin_kill;
 257         acct->file = file;
 258         acct->needcheck = jiffies;
 259         acct->ns = ns;
 260         mutex_init(&acct->lock);
 261         mutex_lock_nested(&acct->lock, 1);      /* nobody has seen it yet */
 262         pin_insert(&acct->pin, mnt);
 263
 264         old = acct_get(ns);
 265         if (old)
 266                 acct_kill(old, acct);
 267         else
 268                 ns->bacct = acct;
 269         mutex_unlock(&acct->lock);
 270         mnt_drop_write(mnt);
 271         mntput(mnt);
 272         return 0;
 273 }
 274
 275 static DEFINE_MUTEX(acct_on_mutex);
 276
 277 /**
 278  * sys_acct - enable/disable process accounting
 279  * @name: file name for accounting records or NULL to shutdown accounting
 280  *
 281  * Returns 0 for success or negative errno values for failure.
 282  *
 283  * sys_acct() is the only system call needed to implement process
 284  * accounting. It takes the name of the file where accounting records
 285  * should be written. If the filename is NULL, accounting will be
 286  * shutdown.
 287  */
 288 SYSCALL_DEFINE1(acct, const char __user *, name)
 289 {
 290         int error = 0;
 291
 292         if (!capable(CAP_SYS_PACCT))
 293                 return -EPERM;
 294
 295         if (name) {
 296                 struct filename *tmp = getname(name);
 297
 298                 if (IS_ERR(tmp))
 299                         return PTR_ERR(tmp);
 300                 mutex_lock(&acct_on_mutex);
 301                 error = acct_on(tmp);
 302                 mutex_unlock(&acct_on_mutex);
 303                 putname(tmp);
 304         } else {
 305                 acct_kill(acct_get(task_active_pid_ns(current)), NULL);
 306         }
 307
 308         return error;
 309 }
 310
 311 void acct_exit_ns(struct pid_namespace *ns)
 312 {
 313         acct_kill(acct_get(ns), NULL);
 314 }
 315
 316 /*
 317  *  encode an unsigned long into a comp_t
 318  *
 319  *  This routine has been adopted from the encode_comp_t() function in
 320  *  the kern_acct.c file of the FreeBSD operating system. The encoding
 321  *  is a 13-bit fraction with a 3-bit (base 8) exponent.
 322  */
 323
 324 #define MANTSIZE        13                      /* 13 bit mantissa. */
 325 #define EXPSIZE         3                       /* Base 8 (3 bit) exponent. */
 326 #define MAXFRACT        ((1 << MANTSIZE) - 1)   /* Maximum fractional value. */
 327
 328 static comp_t encode_comp_t(unsigned long value)
 329 {
 330         int exp, rnd;
 331
 332         exp = rnd = 0;
 333         while (value > MAXFRACT) {
 334                 rnd = value & (1 << (EXPSIZE - 1));     /* Round up? */
 335                 value >>= EXPSIZE;      /* Base 8 exponent == 3 bit shift. */
 336                 exp++;
 337         }
 338
 339         /*
 340          * If we need to round up, do it (and handle overflow correctly).
 341          */
 342         if (rnd && (++value > MAXFRACT)) {
 343                 value >>= EXPSIZE;
 344                 exp++;
 345         }
 346
 347         /*
 348          * Clean it up and polish it off.
 349          */
 350         exp <<= MANTSIZE;               /* Shift the exponent into place */
 351         exp += value;                   /* and add on the mantissa. */
 352         return exp;
 353 }
 354
 355 #if ACCT_VERSION == 1 || ACCT_VERSION == 2
 356 /*
 357  * encode an u64 into a comp2_t (24 bits)
 358  *
 359  * Format: 5 bit base 2 exponent, 20 bits mantissa.
 360  * The leading bit of the mantissa is not stored, but implied for
 361  * non-zero exponents.
 362  * Largest encodable value is 50 bits.
 363  */
 364
 365 #define MANTSIZE2       20                      /* 20 bit mantissa. */
 366 #define EXPSIZE2        5                       /* 5 bit base 2 exponent. */
 367 #define MAXFRACT2       ((1ul << MANTSIZE2) - 1) /* Maximum fractional value. */
 368 #define MAXEXP2         ((1 << EXPSIZE2) - 1)    /* Maximum exponent. */
 369
 370 static comp2_t encode_comp2_t(u64 value)
 371 {
 372         int exp, rnd;
 373
 374         exp = (value > (MAXFRACT2>>1));
 375         rnd = 0;
 376         while (value > MAXFRACT2) {
 377                 rnd = value & 1;
 378                 value >>= 1;
 379                 exp++;
 380         }
 381
 382         /*
 383          * If we need to round up, do it (and handle overflow correctly).
 384          */
 385         if (rnd && (++value > MAXFRACT2)) {
 386                 value >>= 1;
 387                 exp++;
 388         }
 389
 390         if (exp > MAXEXP2) {
 391                 /* Overflow. Return largest representable number instead. */
 392                 return (1ul << (MANTSIZE2+EXPSIZE2-1)) - 1;
 393         } else {
 394                 return (value & (MAXFRACT2>>1)) | (exp << (MANTSIZE2-1));
 395         }
 396 }
 397 #endif
 398
 399 #if ACCT_VERSION == 3
 400 /*
 401  * encode an u64 into a 32 bit IEEE float
 402  */
 403 static u32 encode_float(u64 value)
 404 {
 405         unsigned exp = 190;
 406         unsigned u;
 407
 408         if (value == 0)
 409                 return 0;
 410         while ((s64)value > 0) {
 411                 value <<= 1;
 412                 exp--;
 413         }
 414         u = (u32)(value >> 40) & 0x7fffffu;
 415         return u | (exp << 23);
 416 }
 417 #endif
 418
 419 /*
 420  *  Write an accounting entry for an exiting process
 421  *
 422  *  The acct_process() call is the workhorse of the process
 423  *  accounting system. The struct acct is built here and then written
 424  *  into the accounting file. This function should only be called from
 425  *  do_exit() or when switching to a different output file.
 426  */
 427
 428 static void fill_ac(acct_t *ac)
 429 {
 430         struct pacct_struct *pacct = &current->signal->pacct;
 431         u64 elapsed, run_time;
 432         struct tty_struct *tty;
 433
 434         /*
 435          * Fill the accounting struct with the needed info as recorded
 436          * by the different kernel functions.
 437          */
 438         memset(ac, 0, sizeof(acct_t));
 439
 440         ac->ac_version = ACCT_VERSION | ACCT_BYTEORDER;
 441         strlcpy(ac->ac_comm, current->comm, sizeof(ac->ac_comm));
 442
 443         /* calculate run_time in nsec*/
 444         run_time = ktime_get_ns();
 445         run_time -= current->group_leader->start_time;
 446         /* convert nsec -> AHZ */
 447         elapsed = nsec_to_AHZ(run_time);
 448 #if ACCT_VERSION == 3
 449         ac->ac_etime = encode_float(elapsed);
 450 #else
 451         ac->ac_etime = encode_comp_t(elapsed < (unsigned long) -1l ?
 452                                 (unsigned long) elapsed : (unsigned long) -1l);
 453 #endif
 454 #if ACCT_VERSION == 1 || ACCT_VERSION == 2
 455         {
 456                 /* new enlarged etime field */
 457                 comp2_t etime = encode_comp2_t(elapsed);
 458
 459                 ac->ac_etime_hi = etime >> 16;
 460                 ac->ac_etime_lo = (u16) etime;
 461         }
 462 #endif
 463         do_div(elapsed, AHZ);
 464         ac->ac_btime = get_seconds() - elapsed;
 465 #if ACCT_VERSION==2
 466         ac->ac_ahz = AHZ;
 467 #endif
 468
 469         spin_lock_irq(&current->sighand->siglock);
 470         tty = current->signal->tty;     /* Safe as we hold the siglock */
 471         ac->ac_tty = tty ? old_encode_dev(tty_devnum(tty)) : 0;
 472         ac->ac_utime = encode_comp_t(jiffies_to_AHZ(cputime_to_jiffies(pacct->ac_utime)));
 473         ac->ac_stime = encode_comp_t(jiffies_to_AHZ(cputime_to_jiffies(pacct->ac_stime)));
 474         ac->ac_flag = pacct->ac_flag;
 475         ac->ac_mem = encode_comp_t(pacct->ac_mem);
 476         ac->ac_minflt = encode_comp_t(pacct->ac_minflt);
 477         ac->ac_majflt = encode_comp_t(pacct->ac_majflt);
 478         ac->ac_exitcode = pacct->ac_exitcode;
 479         spin_unlock_irq(&current->sighand->siglock);
 480 }
 481 /*
 482  *  do_acct_process does all actual work. Caller holds the reference to file.
 483  */
 484 static void do_acct_process(struct bsd_acct_struct *acct)
 485 {
 486         acct_t ac;
 487         unsigned long flim;
 488         const struct cred *orig_cred;
 489         struct file *file = acct->file;
 490
 491         /*
 492          * Accounting records are not subject to resource limits.
 493          */
 494         flim = current->signal->rlim[RLIMIT_FSIZE].rlim_cur;
 495         current->signal->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
 496         /* Perform file operations on behalf of whoever enabled accounting */
 497         orig_cred = override_creds(file->f_cred);
 498
 499         /*
 500          * First check to see if there is enough free_space to continue
 501          * the process accounting system.
 502          */
 503         if (!check_free_space(acct))
 504                 goto out;
 505
 506         fill_ac(&ac);
 507         /* we really need to bite the bullet and change layout */
 508         ac.ac_uid = from_kuid_munged(file->f_cred->user_ns, orig_cred->uid);
 509         ac.ac_gid = from_kgid_munged(file->f_cred->user_ns, orig_cred->gid);
 510 #if ACCT_VERSION == 1 || ACCT_VERSION == 2
 511         /* backward-compatible 16 bit fields */
 512         ac.ac_uid16 = ac.ac_uid;
 513         ac.ac_gid16 = ac.ac_gid;
 514 #endif
 515 #if ACCT_VERSION == 3
 516         {
 517                 struct pid_namespace *ns = acct->ns;
 518
 519                 ac.ac_pid = task_tgid_nr_ns(current, ns);
 520                 rcu_read_lock();
 521                 ac.ac_ppid = task_tgid_nr_ns(rcu_dereference(current->real_parent),
 522                                              ns);
 523                 rcu_read_unlock();
 524         }
 525 #endif
 526         /*
 527          * Get freeze protection. If the fs is frozen, just skip the write
 528          * as we could deadlock the system otherwise.
 529          */
 530         if (file_start_write_trylock(file)) {
 531                 /* it's been opened O_APPEND, so position is irrelevant */
 532                 loff_t pos = 0;
 533                 __kernel_write(file, (char *)&ac, sizeof(acct_t), &pos);
 534                 file_end_write(file);
 535         }
 536 out:
 537         current->signal->rlim[RLIMIT_FSIZE].rlim_cur = flim;
 538         revert_creds(orig_cred);
 539 }
 540
 541 /**
 542  * acct_collect - collect accounting information into pacct_struct
 543  * @exitcode: task exit code
 544  * @group_dead: not 0, if this thread is the last one in the process.
 545  */
 546 void acct_collect(long exitcode, int group_dead)
 547 {
 548         struct pacct_struct *pacct = &current->signal->pacct;
 549         cputime_t utime, stime;
 550         unsigned long vsize = 0;
 551
 552         if (group_dead && current->mm) {
 553                 struct vm_area_struct *vma;
 554
 555                 down_read(&current->mm->mmap_sem);
 556                 vma = current->mm->mmap;
 557                 while (vma) {
 558                         vsize += vma->vm_end - vma->vm_start;
 559                         vma = vma->vm_next;
 560                 }
 561                 up_read(&current->mm->mmap_sem);
 562         }
 563
 564         spin_lock_irq(&current->sighand->siglock);
 565         if (group_dead)
 566                 pacct->ac_mem = vsize / 1024;
 567         if (thread_group_leader(current)) {
 568                 pacct->ac_exitcode = exitcode;
 569                 if (current->flags & PF_FORKNOEXEC)
 570                         pacct->ac_flag |= AFORK;
 571         }
 572         if (current->flags & PF_SUPERPRIV)
 573                 pacct->ac_flag |= ASU;
 574         if (current->flags & PF_DUMPCORE)
 575                 pacct->ac_flag |= ACORE;
 576         if (current->flags & PF_SIGNALED)
 577                 pacct->ac_flag |= AXSIG;
 578         task_cputime(current, &utime, &stime);
 579         pacct->ac_utime += utime;
 580         pacct->ac_stime += stime;
 581         pacct->ac_minflt += current->min_flt;
 582         pacct->ac_majflt += current->maj_flt;
 583         spin_unlock_irq(&current->sighand->siglock);
 584 }
 585
 586 static void slow_acct_process(struct pid_namespace *ns)
 587 {
 588         for ( ; ns; ns = ns->parent) {
 589                 struct bsd_acct_struct *acct = acct_get(ns);
 590                 if (acct) {
 591                         do_acct_process(acct);
 592                         mutex_unlock(&acct->lock);
 593                         acct_put(acct);
 594                 }
 595         }
 596 }
 597
 598 /**
 599  * acct_process
 600  *
 601  * handles process accounting for an exiting task
 602  */
 603 void acct_process(void)
 604 {
 605         struct pid_namespace *ns;
 606
 607         /*
 608          * This loop is safe lockless, since current is still
 609          * alive and holds its namespace, which in turn holds
 610          * its parent.
 611          */
 612         for (ns = task_active_pid_ns(current); ns != NULL; ns = ns->parent) {
 613                 if (ns->bacct)
 614                         break;
 615         }
 616         if (unlikely(ns))
 617                 slow_acct_process(ns);
 618 }