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