root/sbin/quotacheck/quotacheck.c
/*
 * Copyright (c) 1980, 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Robert Elz at The University of Melbourne.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * @(#) Copyright (c) 1980, 1990, 1993 The Regents of the University of California.  All rights reserved.
 * @(#)quotacheck.c     8.3 (Berkeley) 1/29/94
 * $FreeBSD: src/sbin/quotacheck/quotacheck.c,v 1.11 1999/08/28 00:14:01 peter Exp $
 */

/*
 * Fix up / report on disk quotas & usage
 */
#include <sys/param.h>
#include <sys/stat.h>

#include <vfs/ufs/dinode.h>
#include <vfs/ufs/quota.h>
#include <vfs/ufs/fs.h>

#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <fstab.h>
#include <grp.h>
#include <pwd.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

const char *qfname = QUOTAFILENAME;
const char *qfextension[] = INITQFNAMES;
const char *quotagroup = QUOTAGROUP;

union {
        struct  fs      sblk;
        char    dummy[MAXBSIZE];
} un;
#define sblock  un.sblk
long dev_bsize = 1;
ino_t quotamaxino;

struct quotaname {
        long    flags;
        char    grpqfname[MAXPATHLEN + 1];
        char    usrqfname[MAXPATHLEN + 1];
};
#define HASUSR  1
#define HASGRP  2

struct fileusage {
        struct  fileusage *fu_next;
        u_long  fu_curinodes;
        u_long  fu_curblocks;
        u_long  fu_id;
        char    fu_name[1];
        /* actually bigger */
};
#define FUHASH 1024     /* must be power of two */
struct fileusage *fuhead[MAXQUOTAS][FUHASH];

int     aflag;                  /* all file systems */
int     gflag;                  /* check group quotas */
int     uflag;                  /* check user quotas */
int     vflag;                  /* verbose */
int     fi;                     /* open disk file descriptor */
u_long  highid[MAXQUOTAS];      /* highest addid()'ed identifier per type */

struct fileusage *
         addid(u_long, int, char *);
char    *blockcheck(char *);
void     bread(daddr_t, char *, long);
extern int checkfstab(int, int, void * (*)(struct fstab *),
                                int (*)(char *, char *, struct quotaname *));
int      chkquota(char *, char *, struct quotaname *);
void     freeinodebuf(void);
struct ufs1_dinode *
         getnextinode(ino_t);
int      getquotagid(void);
int      hasquota(struct fstab *, int, char **);
struct fileusage *
         lookup(u_long, int);
void    *needchk(struct fstab *);
int      oneof(char *, char*[], int);
void     resetinodebuf(void);
int      update(char *, char *, int);
void     usage(void) __dead2;

int
main(int argc, char **argv)
{
        struct fstab *fs;
        struct passwd *pw;
        struct group *gr;
        struct quotaname *auxdata;
        int i, argnum, maxrun, errs;
        long done = 0;
        char ch, *name;

        errs = maxrun = 0;
        while ((ch = getopt(argc, argv, "aguvl:")) != -1) {
                switch(ch) {
                case 'a':
                        aflag++;
                        break;
                case 'g':
                        gflag++;
                        break;
                case 'u':
                        uflag++;
                        break;
                case 'v':
                        vflag++;
                        break;
                case 'l':
                        maxrun = atoi(optarg);
                        break;
                default:
                        usage();
                }
        }
        argc -= optind;
        argv += optind;
        if ((argc == 0 && !aflag) || (argc > 0 && aflag))
                usage();
        if (!gflag && !uflag) {
                gflag++;
                uflag++;
        }
        if (gflag) {
                setgrent();
                while ((gr = getgrent()) != NULL)
                        addid((u_long)gr->gr_gid, GRPQUOTA, gr->gr_name);
                endgrent();
        }
        if (uflag) {
                setpwent();
                while ((pw = getpwent()) != NULL)
                        addid((u_long)pw->pw_uid, USRQUOTA, pw->pw_name);
                endpwent();
        }
        if (aflag)
                exit(checkfstab(1, maxrun, needchk, chkquota));
        if (setfsent() == 0)
                errx(1, "%s: can't open", FSTAB);
        while ((fs = getfsent()) != NULL) {
                if (((argnum = oneof(fs->fs_file, argv, argc)) >= 0 ||
                    (argnum = oneof(fs->fs_spec, argv, argc)) >= 0) &&
                    (auxdata = needchk(fs)) &&
                    (name = blockcheck(fs->fs_spec))) {
                        done |= 1 << argnum;
                        errs += chkquota(name, fs->fs_file, auxdata);
                }
        }
        endfsent();
        for (i = 0; i < argc; i++)
                if ((done & (1 << i)) == 0)
                        fprintf(stderr, "%s not found in %s\n",
                                argv[i], FSTAB);
        exit(errs);
}

void
usage(void)
{
        fprintf(stderr, "%s\n%s\n", 
                "usage: quotacheck -a [-guv]",
                "       quotacheck [-guv] filesys ...");
        exit(1);
}

void *
needchk(struct fstab *fs)
{
        struct quotaname *qnp;
        char *qfnp;

        if (strcmp(fs->fs_vfstype, "ufs") ||
            strcmp(fs->fs_type, FSTAB_RW))
                return (NULL);
        if ((qnp = malloc(sizeof(*qnp))) == NULL)
                errx(1, "malloc failed");
        qnp->flags = 0;
        if (gflag && hasquota(fs, GRPQUOTA, &qfnp)) {
                strcpy(qnp->grpqfname, qfnp);
                qnp->flags |= HASGRP;
        }
        if (uflag && hasquota(fs, USRQUOTA, &qfnp)) {
                strcpy(qnp->usrqfname, qfnp);
                qnp->flags |= HASUSR;
        }
        if (qnp->flags)
                return (qnp);
        free(qnp);
        return (NULL);
}

/*
 * Scan the specified filesystem to check quota(s) present on it.
 */
int
chkquota(char *fsname, char *mntpt, struct quotaname *qnp)
{
        struct fileusage *fup;
        struct ufs1_dinode *dp;
        int cg, i, mode, errs = 0;
        ino_t ino;

        if ((fi = open(fsname, O_RDONLY, 0)) < 0) {
                warn("%s", fsname);
                return (1);
        }
        if (vflag) {
                printf("*** Checking ");
                if (qnp->flags & HASUSR)
                        printf("%s%s", qfextension[USRQUOTA],
                            (qnp->flags & HASGRP) ? " and " : "");
                if (qnp->flags & HASGRP)
                        printf("%s", qfextension[GRPQUOTA]);
                printf(" quotas for %s (%s)\n", fsname, mntpt);
        }
        sync();
        dev_bsize = 1;
        bread(SBOFF, (char *)&sblock, (long)SBSIZE);
        dev_bsize = sblock.fs_fsize / fsbtodb(&sblock, 1);
        quotamaxino = sblock.fs_ncg * sblock.fs_ipg;
        resetinodebuf();
        for (ino = 0, cg = 0; cg < sblock.fs_ncg; cg++) {
                for (i = 0; i < sblock.fs_ipg; i++, ino++) {
                        if (ino < UFS_ROOTINO)
                                continue;
                        if ((dp = getnextinode(ino)) == NULL)
                                continue;
                        if ((mode = dp->di_mode & IFMT) == 0)
                                continue;
                        if (qnp->flags & HASGRP) {
                                fup = addid((u_long)dp->di_gid, GRPQUOTA,
                                    NULL);
                                fup->fu_curinodes++;
                                if (mode == IFREG || mode == IFDIR ||
                                    mode == IFLNK)
                                        fup->fu_curblocks += dp->di_blocks;
                        }
                        if (qnp->flags & HASUSR) {
                                fup = addid((u_long)dp->di_uid, USRQUOTA,
                                    NULL);
                                fup->fu_curinodes++;
                                if (mode == IFREG || mode == IFDIR ||
                                    mode == IFLNK)
                                        fup->fu_curblocks += dp->di_blocks;
                        }
                }
        }
        freeinodebuf();
        if (qnp->flags & HASUSR)
                errs += update(mntpt, qnp->usrqfname, USRQUOTA);
        if (qnp->flags & HASGRP)
                errs += update(mntpt, qnp->grpqfname, GRPQUOTA);
        close(fi);
        return (errs);
}

/*
 * Update a specified quota file.
 */
int
update(char *fsname, char *quotafile, int type)
{
        struct fileusage *fup;
        FILE *qfi, *qfo;
        u_long id, lastid;
        off_t offset;
        struct ufs_dqblk dqbuf;
        static int warned = 0;
        static struct ufs_dqblk zerodqbuf;
        static struct fileusage zerofileusage;

        if ((qfo = fopen(quotafile, "r+")) == NULL) {
                if (errno == ENOENT)
                        qfo = fopen(quotafile, "w+");
                if (qfo) {
                        warnx("creating quota file %s", quotafile);
#define MODE    (S_IRUSR|S_IWUSR|S_IRGRP)
                        fchown(fileno(qfo), getuid(), getquotagid());
                        fchmod(fileno(qfo), MODE);
                } else {
                        warn("%s", quotafile);
                        return (1);
                }
        }
        if ((qfi = fopen(quotafile, "r")) == NULL) {
                warn("%s", quotafile);
                fclose(qfo);
                return (1);
        }
        if (quotactl(fsname, QCMD(Q_SYNC, type), (u_long)0, (caddr_t)0) < 0 &&
            errno == EOPNOTSUPP && !warned && vflag) {
                warned++;
                printf("*** Warning: %s\n",
                    "Quotas are not compiled into this kernel");
        }
        for (lastid = highid[type], id = 0, offset = 0; id <= lastid; 
            id++, offset += sizeof(struct ufs_dqblk)) {
                if (fread((char *)&dqbuf, sizeof(struct ufs_dqblk), 1, qfi) == 0)
                        dqbuf = zerodqbuf;
                if ((fup = lookup(id, type)) == NULL)
                        fup = &zerofileusage;
                if (dqbuf.dqb_curinodes == fup->fu_curinodes &&
                    dqbuf.dqb_curblocks == fup->fu_curblocks) {
                        fup->fu_curinodes = 0;
                        fup->fu_curblocks = 0;
                        continue;
                }
                if (vflag) {
                        if (aflag)
                                printf("%s: ", fsname);
                        printf("%-8s fixed:", fup->fu_name);
                        if (dqbuf.dqb_curinodes != fup->fu_curinodes)
                                printf("\tinodes %lu -> %lu",
                                    (u_long)dqbuf.dqb_curinodes,
                                    (u_long)fup->fu_curinodes);
                        if (dqbuf.dqb_curblocks != fup->fu_curblocks)
                                printf("\tblocks %lu -> %lu",
                                    (u_long)dqbuf.dqb_curblocks,
                                    (u_long)fup->fu_curblocks);
                        printf("\n");
                }
                /*
                 * Reset time limit if have a soft limit and were
                 * previously under it, but are now over it.
                 */
                if (dqbuf.dqb_bsoftlimit &&
                    dqbuf.dqb_curblocks < dqbuf.dqb_bsoftlimit &&
                    fup->fu_curblocks >= dqbuf.dqb_bsoftlimit)
                        dqbuf.dqb_btime = 0;
                if (dqbuf.dqb_isoftlimit &&
                    dqbuf.dqb_curblocks < dqbuf.dqb_isoftlimit &&
                    fup->fu_curblocks >= dqbuf.dqb_isoftlimit)
                        dqbuf.dqb_itime = 0;
                dqbuf.dqb_curinodes = fup->fu_curinodes;
                dqbuf.dqb_curblocks = fup->fu_curblocks;
                if (fseek(qfo, (long)offset, SEEK_SET) < 0) {
                        warn("%s: seek failed", quotafile);
                        return(1);
                }
                fwrite((char *)&dqbuf, sizeof(struct ufs_dqblk), 1, qfo);
                quotactl(fsname, QCMD(Q_SETUSE, type), id,
                    (caddr_t)&dqbuf);
                fup->fu_curinodes = 0;
                fup->fu_curblocks = 0;
        }
        fclose(qfi);
        fflush(qfo);
        ftruncate(fileno(qfo),
            (off_t)((highid[type] + 1) * sizeof(struct ufs_dqblk)));
        fclose(qfo);
        return (0);
}

/*
 * Check to see if target appears in list of size cnt.
 */
int
oneof(char *target, char **list, int cnt)
{
        int i;

        for (i = 0; i < cnt; i++)
                if (strcmp(target, list[i]) == 0)
                        return (i);
        return (-1);
}

/*
 * Determine the group identifier for quota files.
 */
int
getquotagid(void)
{
        struct group *gr;

        if ((gr = getgrnam(quotagroup)) != NULL)
                return (gr->gr_gid);
        return (-1);
}

/*
 * Check to see if a particular quota is to be enabled.
 */
int
hasquota(struct fstab *fs, int type, char **qfnamep)
{
        char *opt;
        char *cp;
        static char initname, usrname[100], grpname[100];
        static char buf[BUFSIZ];

        if (!initname) {
                snprintf(usrname, sizeof(usrname),
                    "%s%s", qfextension[USRQUOTA], qfname);
                snprintf(grpname, sizeof(grpname),
                    "%s%s", qfextension[GRPQUOTA], qfname);
                initname = 1;
        }
        strcpy(buf, fs->fs_mntops);
        for (opt = strtok(buf, ","); opt; opt = strtok(NULL, ",")) {
                if ((cp = strchr(opt, '=')) != NULL)
                        *cp++ = '\0';
                if (type == USRQUOTA && strcmp(opt, usrname) == 0)
                        break;
                if (type == GRPQUOTA && strcmp(opt, grpname) == 0)
                        break;
        }
        if (!opt)
                return (0);
        if (cp)
                *qfnamep = cp;
        else {
                snprintf(buf, sizeof(buf),
                    "%s/%s.%s", fs->fs_file, qfname, qfextension[type]);
                *qfnamep = buf;
        }
        return (1);
}

/*
 * Routines to manage the file usage table.
 *
 * Lookup an id of a specific type.
 */
struct fileusage *
lookup(u_long id, int type)
{
        struct fileusage *fup;

        for (fup = fuhead[type][id & (FUHASH-1)]; fup != NULL; fup = fup->fu_next)
                if (fup->fu_id == id)
                        return (fup);
        return (NULL);
}

/*
 * Add a new file usage id if it does not already exist.
 */
struct fileusage *
addid(u_long id, int type, char *name)
{
        struct fileusage *fup, **fhp;
        int len;

        if ((fup = lookup(id, type)) != NULL)
                return (fup);
        if (name)
                len = strlen(name);
        else
                len = 10;
        if ((fup = calloc(1, sizeof(*fup) + len)) == NULL)
                errx(1, "calloc failed");
        fhp = &fuhead[type][id & (FUHASH - 1)];
        fup->fu_next = *fhp;
        *fhp = fup;
        fup->fu_id = id;
        if (id > highid[type])
                highid[type] = id;
        if (name)
                bcopy(name, fup->fu_name, len + 1);
        else {
                sprintf(fup->fu_name, "%lu", id);
                if (vflag) 
                        printf("unknown %cid: %lu\n", 
                            type == USRQUOTA ? 'u' : 'g', id);
        }
        return (fup);
}

/*
 * Special purpose version of ginode used to optimize pass
 * over all the inodes in numerical order.
 */
ino_t nextino, lastinum;
long readcnt, readpercg, fullcnt, inobufsize, partialcnt, partialsize;
struct ufs1_dinode *inodebuf;
#define INOBUFSIZE      56*1024 /* size of buffer to read inodes */

struct ufs1_dinode *
getnextinode(ino_t inumber)
{
        long size;
        daddr_t dblk;
        static struct ufs1_dinode *dp;

        if (inumber != nextino++ || inumber > quotamaxino) {
                errx(1, "bad inode number %ju to nextinode",
                        (intmax_t)inumber);
        }
        if (inumber >= lastinum) {
                readcnt++;
                dblk = fsbtodb(&sblock, ino_to_fsba(&sblock, lastinum));
                if (readcnt % readpercg == 0) {
                        size = partialsize;
                        lastinum += partialcnt;
                } else {
                        size = inobufsize;
                        lastinum += fullcnt;
                }
                bread(dblk, (char *)inodebuf, size);
                dp = inodebuf;
        }
        return (dp++);
}

/*
 * Prepare to scan a set of inodes.
 */
void
resetinodebuf(void)
{

        nextino = 0;
        lastinum = 0;
        readcnt = 0;
        inobufsize = blkroundup(&sblock, INOBUFSIZE);
        fullcnt = inobufsize / sizeof(struct ufs1_dinode);
        readpercg = sblock.fs_ipg / fullcnt;
        partialcnt = sblock.fs_ipg % fullcnt;
        partialsize = partialcnt * sizeof(struct ufs1_dinode);
        if (partialcnt != 0) {
                readpercg++;
        } else {
                partialcnt = fullcnt;
                partialsize = inobufsize;
        }
        if (inodebuf == NULL &&
           (inodebuf = malloc((u_int)inobufsize)) == NULL)
                errx(1, "malloc failed");
        while (nextino < UFS_ROOTINO)
                getnextinode(nextino);
}

/*
 * Free up data structures used to scan inodes.
 */
void
freeinodebuf(void)
{

        if (inodebuf != NULL)
                free(inodebuf);
        inodebuf = NULL;
}

/*
 * Read specified disk blocks.
 */
void
bread(daddr_t bno, char *buf, long cnt)
{

        if (lseek(fi, (off_t)bno * dev_bsize, SEEK_SET) < 0 ||
            read(fi, buf, cnt) != cnt)
                errx(1, "block %ld", (long)bno);
}