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