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/config.h>
  47 #include <linux/mm.h>
  48 #include <linux/slab.h>
  49 #include <linux/acct.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 <asm/uaccess.h>
  57 #include <asm/div64.h>
  58 #include <linux/blkdev.h> /* sector_div */
  59
  60 /*
  61  * These constants control the amount of freespace that suspend and
  62  * resume the process accounting system, and the time delay between
  63  * each check.
  64  * Turned into sysctl-controllable parameters. AV, 12/11/98
  65  */
  66
  67 int acct_parm[3] = {4, 2, 30};
  68 #define RESUME          (acct_parm[0])  /* >foo% free space - resume */
  69 #define SUSPEND         (acct_parm[1])  /* <foo% free space - suspend */
  70 #define ACCT_TIMEOUT    (acct_parm[2])  /* foo second timeout between checks */
  71
  72 /*
  73  * External references and all of the globals.
  74  */
  75 static void do_acct_process(long, struct file *);
  76
  77 /*
  78  * This structure is used so that all the data protected by lock
  79  * can be placed in the same cache line as the lock.  This primes
  80  * the cache line to have the data after getting the lock.
  81  */
  82 struct acct_glbs {
  83         spinlock_t              lock;
  84         volatile int            active;
  85         volatile int            needcheck;
  86         struct file             *file;
  87         struct timer_list       timer;
  88 };
  89
  90 static struct acct_glbs acct_globals __cacheline_aligned = {SPIN_LOCK_UNLOCKED};
  91
  92 /*
  93  * Called whenever the timer says to check the free space.
  94  */
  95 static void acct_timeout(unsigned long unused)
  96 {
  97         acct_globals.needcheck = 1;
  98 }
  99
 100 /*
 101  * Check the amount of free space and suspend/resume accordingly.
 102  */
 103 static int check_free_space(struct file *file)
 104 {
 105         struct kstatfs sbuf;
 106         int res;
 107         int act;
 108         sector_t resume;
 109         sector_t suspend;
 110
 111         spin_lock(&acct_globals.lock);
 112         res = acct_globals.active;
 113         if (!file || !acct_globals.needcheck)
 114                 goto out;
 115         spin_unlock(&acct_globals.lock);
 116
 117         /* May block */
 118         if (vfs_statfs(file->f_dentry->d_inode->i_sb, &sbuf))
 119                 return res;
 120         suspend = sbuf.f_blocks * SUSPEND;
 121         resume = sbuf.f_blocks * RESUME;
 122
 123         sector_div(suspend, 100);
 124         sector_div(resume, 100);
 125
 126         if (sbuf.f_bavail <= suspend)
 127                 act = -1;
 128         else if (sbuf.f_bavail >= resume)
 129                 act = 1;
 130         else
 131                 act = 0;
 132
 133         /*
 134          * If some joker switched acct_globals.file under us we'ld better be
 135          * silent and _not_ touch anything.
 136          */
 137         spin_lock(&acct_globals.lock);
 138         if (file != acct_globals.file) {
 139                 if (act)
 140                         res = act>0;
 141                 goto out;
 142         }
 143
 144         if (acct_globals.active) {
 145                 if (act < 0) {
 146                         acct_globals.active = 0;
 147                         printk(KERN_INFO "Process accounting paused\n");
 148                 }
 149         } else {
 150                 if (act > 0) {
 151                         acct_globals.active = 1;
 152                         printk(KERN_INFO "Process accounting resumed\n");
 153                 }
 154         }
 155
 156         del_timer(&acct_globals.timer);
 157         acct_globals.needcheck = 0;
 158         acct_globals.timer.expires = jiffies + ACCT_TIMEOUT*HZ;
 159         add_timer(&acct_globals.timer);
 160         res = acct_globals.active;
 161 out:
 162         spin_unlock(&acct_globals.lock);
 163         return res;
 164 }
 165
 166 /*
 167  * Close the old accouting file (if currently open) and then replace
 168  * it with file (if non-NULL).
 169  *
 170  * NOTE: acct_globals.lock MUST be held on entry and exit.
 171  */
 172 void acct_file_reopen(struct file *file)
 173 {
 174         struct file *old_acct = NULL;
 175
 176         if (acct_globals.file) {
 177                 old_acct = acct_globals.file;
 178                 del_timer(&acct_globals.timer);
 179                 acct_globals.active = 0;
 180                 acct_globals.needcheck = 0;
 181                 acct_globals.file = NULL;
 182         }
 183         if (file) {
 184                 acct_globals.file = file;
 185                 acct_globals.needcheck = 0;
 186                 acct_globals.active = 1;
 187                 /* It's been deleted if it was used before so this is safe */
 188                 init_timer(&acct_globals.timer);
 189                 acct_globals.timer.function = acct_timeout;
 190                 acct_globals.timer.expires = jiffies + ACCT_TIMEOUT*HZ;
 191                 add_timer(&acct_globals.timer);
 192         }
 193         if (old_acct) {
 194                 spin_unlock(&acct_globals.lock);
 195                 do_acct_process(0, old_acct);
 196                 filp_close(old_acct, NULL);
 197                 spin_lock(&acct_globals.lock);
 198         }
 199 }
 200
 201 /*
 202  *  sys_acct() is the only system call needed to implement process
 203  *  accounting. It takes the name of the file where accounting records
 204  *  should be written. If the filename is NULL, accounting will be
 205  *  shutdown.
 206  */
 207 asmlinkage long sys_acct(const char __user *name)
 208 {
 209         struct file *file = NULL;
 210         char *tmp;
 211         int error;
 212
 213         if (!capable(CAP_SYS_PACCT))
 214                 return -EPERM;
 215
 216         if (name) {
 217                 tmp = getname(name);
 218                 if (IS_ERR(tmp)) {
 219                         return (PTR_ERR(tmp));
 220                 }
 221                 /* Difference from BSD - they don't do O_APPEND */
 222                 file = filp_open(tmp, O_WRONLY|O_APPEND, 0);
 223                 putname(tmp);
 224                 if (IS_ERR(file)) {
 225                         return (PTR_ERR(file));
 226                 }
 227                 if (!S_ISREG(file->f_dentry->d_inode->i_mode)) {
 228                         filp_close(file, NULL);
 229                         return (-EACCES);
 230                 }
 231
 232                 if (!file->f_op->write) {
 233                         filp_close(file, NULL);
 234                         return (-EIO);
 235                 }
 236         }
 237
 238         error = security_acct(file);
 239         if (error) {
 240                 if (file)
 241                         filp_close(file, NULL);
 242                 return error;
 243         }
 244
 245         spin_lock(&acct_globals.lock);
 246         acct_file_reopen(file);
 247         spin_unlock(&acct_globals.lock);
 248
 249         return (0);
 250 }
 251
 252 /*
 253  * If the accouting is turned on for a file in the filesystem pointed
 254  * to by sb, turn accouting off.
 255  */
 256 void acct_auto_close(struct super_block *sb)
 257 {
 258         spin_lock(&acct_globals.lock);
 259         if (acct_globals.file &&
 260             acct_globals.file->f_dentry->d_inode->i_sb == sb) {
 261                 acct_file_reopen((struct file *)NULL);
 262         }
 263         spin_unlock(&acct_globals.lock);
 264 }
 265
 266 /*
 267  *  encode an unsigned long into a comp_t
 268  *
 269  *  This routine has been adopted from the encode_comp_t() function in
 270  *  the kern_acct.c file of the FreeBSD operating system. The encoding
 271  *  is a 13-bit fraction with a 3-bit (base 8) exponent.
 272  */
 273
 274 #define MANTSIZE        13                      /* 13 bit mantissa. */
 275 #define EXPSIZE         3                       /* Base 8 (3 bit) exponent. */
 276 #define MAXFRACT        ((1 << MANTSIZE) - 1)   /* Maximum fractional value. */
 277
 278 static comp_t encode_comp_t(unsigned long value)
 279 {
 280         int exp, rnd;
 281
 282         exp = rnd = 0;
 283         while (value > MAXFRACT) {
 284                 rnd = value & (1 << (EXPSIZE - 1));     /* Round up? */
 285                 value >>= EXPSIZE;      /* Base 8 exponent == 3 bit shift. */
 286                 exp++;
 287         }
 288
 289         /*
 290          * If we need to round up, do it (and handle overflow correctly).
 291          */
 292         if (rnd && (++value > MAXFRACT)) {
 293                 value >>= EXPSIZE;
 294                 exp++;
 295         }
 296
 297         /*
 298          * Clean it up and polish it off.
 299          */
 300         exp <<= MANTSIZE;               /* Shift the exponent into place */
 301         exp += value;                   /* and add on the mantissa. */
 302         return exp;
 303 }
 304
 305 #if ACCT_VERSION==1 || ACCT_VERSION==2
 306 /*
 307  * encode an u64 into a comp2_t (24 bits)
 308  *
 309  * Format: 5 bit base 2 exponent, 20 bits mantissa.
 310  * The leading bit of the mantissa is not stored, but implied for
 311  * non-zero exponents.
 312  * Largest encodable value is 50 bits.
 313  */
 314
 315 #define MANTSIZE2       20                      /* 20 bit mantissa. */
 316 #define EXPSIZE2        5                       /* 5 bit base 2 exponent. */
 317 #define MAXFRACT2       ((1ul << MANTSIZE2) - 1) /* Maximum fractional value. */
 318 #define MAXEXP2         ((1 <<EXPSIZE2) - 1)    /* Maximum exponent. */
 319
 320 static comp2_t encode_comp2_t(u64 value)
 321 {
 322         int exp, rnd;
 323
 324         exp = (value > (MAXFRACT2>>1));
 325         rnd = 0;
 326         while (value > MAXFRACT2) {
 327                 rnd = value & 1;
 328                 value >>= 1;
 329                 exp++;
 330         }
 331
 332         /*
 333          * If we need to round up, do it (and handle overflow correctly).
 334          */
 335         if (rnd && (++value > MAXFRACT2)) {
 336                 value >>= 1;
 337                 exp++;
 338         }
 339
 340         if (exp > MAXEXP2) {
 341                 /* Overflow. Return largest representable number instead. */
 342                 return (1ul << (MANTSIZE2+EXPSIZE2-1)) - 1;
 343         } else {
 344                 return (value & (MAXFRACT2>>1)) | (exp << (MANTSIZE2-1));
 345         }
 346 }
 347 #endif
 348
 349 #if ACCT_VERSION==3
 350 /*
 351  * encode an u64 into a 32 bit IEEE float
 352  */
 353 static u32 encode_float(u64 value)
 354 {
 355         unsigned exp = 190;
 356         unsigned u;
 357
 358         if (value==0) return 0;
 359         while ((s64)value > 0){
 360                 value <<= 1;
 361                 exp--;
 362         }
 363         u = (u32)(value >> 40) & 0x7fffffu;
 364         return u | (exp << 23);
 365 }
 366 #endif
 367
 368 /*
 369  *  Write an accounting entry for an exiting process
 370  *
 371  *  The acct_process() call is the workhorse of the process
 372  *  accounting system. The struct acct is built here and then written
 373  *  into the accounting file. This function should only be called from
 374  *  do_exit().
 375  */
 376
 377 /*
 378  *  do_acct_process does all actual work. Caller holds the reference to file.
 379  */
 380 static void do_acct_process(long exitcode, struct file *file)
 381 {
 382         acct_t ac;
 383         mm_segment_t fs;
 384         unsigned long vsize;
 385         unsigned long flim;
 386         u64 elapsed;
 387
 388         /*
 389          * First check to see if there is enough free_space to continue
 390          * the process accounting system.
 391          */
 392         if (!check_free_space(file))
 393                 return;
 394
 395         /*
 396          * Fill the accounting struct with the needed info as recorded
 397          * by the different kernel functions.
 398          */
 399         memset((caddr_t)&ac, 0, sizeof(acct_t));
 400
 401         ac.ac_version = ACCT_VERSION | ACCT_BYTEORDER;
 402         strlcpy(ac.ac_comm, current->comm, sizeof(ac.ac_comm));
 403
 404         elapsed = jiffies_64_to_AHZ(get_jiffies_64() - current->start_time);
 405 #if ACCT_VERSION==3
 406         ac.ac_etime = encode_float(elapsed);
 407 #else
 408         ac.ac_etime = encode_comp_t(elapsed < (unsigned long) -1l ?
 409                                (unsigned long) elapsed : (unsigned long) -1l);
 410 #endif
 411 #if ACCT_VERSION==1 || ACCT_VERSION==2
 412         {
 413                 /* new enlarged etime field */
 414                 comp2_t etime = encode_comp2_t(elapsed);
 415                 ac.ac_etime_hi = etime >> 16;
 416                 ac.ac_etime_lo = (u16) etime;
 417         }
 418 #endif
 419         do_div(elapsed, AHZ);
 420         ac.ac_btime = xtime.tv_sec - elapsed;
 421         ac.ac_utime = encode_comp_t(jiffies_to_AHZ(current->utime));
 422         ac.ac_stime = encode_comp_t(jiffies_to_AHZ(current->stime));
 423         /* we really need to bite the bullet and change layout */
 424         ac.ac_uid = current->uid;
 425         ac.ac_gid = current->gid;
 426 #if ACCT_VERSION==2
 427         ac.ac_ahz = AHZ;
 428 #endif
 429 #if ACCT_VERSION==1 || ACCT_VERSION==2
 430         /* backward-compatible 16 bit fields */
 431         ac.ac_uid16 = current->uid;
 432         ac.ac_gid16 = current->gid;
 433 #endif
 434 #if ACCT_VERSION==3
 435         ac.ac_pid = current->pid;
 436         ac.ac_ppid = current->parent->pid;
 437 #endif
 438
 439         read_lock(&tasklist_lock);      /* pin current->signal */
 440         ac.ac_tty = current->signal->tty ?
 441                 old_encode_dev(tty_devnum(current->signal->tty)) : 0;
 442         read_unlock(&tasklist_lock);
 443
 444         ac.ac_flag = 0;
 445         if (current->flags & PF_FORKNOEXEC)
 446                 ac.ac_flag |= AFORK;
 447         if (current->flags & PF_SUPERPRIV)
 448                 ac.ac_flag |= ASU;
 449         if (current->flags & PF_DUMPCORE)
 450                 ac.ac_flag |= ACORE;
 451         if (current->flags & PF_SIGNALED)
 452                 ac.ac_flag |= AXSIG;
 453
 454         vsize = 0;
 455         if (current->mm) {
 456                 struct vm_area_struct *vma;
 457                 down_read(&current->mm->mmap_sem);
 458                 vma = current->mm->mmap;
 459                 while (vma) {
 460                         vsize += vma->vm_end - vma->vm_start;
 461                         vma = vma->vm_next;
 462                 }
 463                 up_read(&current->mm->mmap_sem);
 464         }
 465         vsize = vsize / 1024;
 466         ac.ac_mem = encode_comp_t(vsize);
 467         ac.ac_io = encode_comp_t(0 /* current->io_usage */);    /* %% */
 468         ac.ac_rw = encode_comp_t(ac.ac_io / 1024);
 469         ac.ac_minflt = encode_comp_t(current->min_flt);
 470         ac.ac_majflt = encode_comp_t(current->maj_flt);
 471         ac.ac_swaps = encode_comp_t(0);
 472         ac.ac_exitcode = exitcode;
 473
 474         /*
 475          * Kernel segment override to datasegment and write it
 476          * to the accounting file.
 477          */
 478         fs = get_fs();
 479         set_fs(KERNEL_DS);
 480         /*
 481          * Accounting records are not subject to resource limits.
 482          */
 483         flim = current->rlim[RLIMIT_FSIZE].rlim_cur;
 484         current->rlim[RLIMIT_FSIZE].rlim_cur = RLIM_INFINITY;
 485         file->f_op->write(file, (char *)&ac,
 486                                sizeof(acct_t), &file->f_pos);
 487         current->rlim[RLIMIT_FSIZE].rlim_cur = flim;
 488         set_fs(fs);
 489 }
 490
 491 /*
 492  * acct_process - now just a wrapper around do_acct_process
 493  */
 494 void acct_process(long exitcode)
 495 {
 496         struct file *file = NULL;
 497
 498         /*
 499          * accelerate the common fastpath:
 500          */
 501         if (!acct_globals.file)
 502                 return;
 503
 504         spin_lock(&acct_globals.lock);
 505         file = acct_globals.file;
 506         if (unlikely(!file)) {
 507                 spin_unlock(&acct_globals.lock);
 508                 return;
 509         }
 510         get_file(file);
 511         spin_unlock(&acct_globals.lock);
 512
 513         do_acct_process(exitcode, file);
 514         fput(file);
 515 }