root/usr.sbin/makefs/hammer2/hammer2_subr.c
/*
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 2022 Tomohiro Kusumi <tkusumi@netbsd.org>
 * Copyright (c) 2011-2022 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@dragonflybsd.org>
 *
 * 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 DragonFly Project 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 COPYRIGHT HOLDERS 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
 * COPYRIGHT HOLDERS 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.
 */
/*
#include <sys/cdefs.h>
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/types.h>
#include <sys/uuid.h>
*/
#include <sys/time.h>
#include <sys/dirent.h>

#include "hammer2.h"
#include "makefs.h"

/*
 * Return the directory entry type for an inode.
 */
int
hammer2_get_dtype(uint8_t type)
{
        switch(type) {
        case HAMMER2_OBJTYPE_UNKNOWN:
                return (DT_UNKNOWN);
        case HAMMER2_OBJTYPE_DIRECTORY:
                return (DT_DIR);
        case HAMMER2_OBJTYPE_REGFILE:
                return (DT_REG);
        case HAMMER2_OBJTYPE_FIFO:
                return (DT_FIFO);
        case HAMMER2_OBJTYPE_CDEV:
                return (DT_CHR);
        case HAMMER2_OBJTYPE_BDEV:
                return (DT_BLK);
        case HAMMER2_OBJTYPE_SOFTLINK:
                return (DT_LNK);
        case HAMMER2_OBJTYPE_SOCKET:
                return (DT_SOCK);
        case HAMMER2_OBJTYPE_WHITEOUT:  /* not supported */
                return (DT_UNKNOWN);
        default:
                return (DT_UNKNOWN);
        }
        /* not reached */
}

/*
 * Return the directory entry type for an inode
 */
int
hammer2_get_vtype(uint8_t type)
{
        switch(type) {
        case HAMMER2_OBJTYPE_UNKNOWN:
                return (VBAD);
        case HAMMER2_OBJTYPE_DIRECTORY:
                return (VDIR);
        case HAMMER2_OBJTYPE_REGFILE:
                return (VREG);
        case HAMMER2_OBJTYPE_FIFO:
                return (VFIFO);
        case HAMMER2_OBJTYPE_CDEV:
                return (VCHR);
        case HAMMER2_OBJTYPE_BDEV:
                return (VBLK);
        case HAMMER2_OBJTYPE_SOFTLINK:
                return (VLNK);
        case HAMMER2_OBJTYPE_SOCKET:
                return (VSOCK);
        case HAMMER2_OBJTYPE_WHITEOUT:  /* not supported */
                return (VBAD);
        default:
                return (VBAD);
        }
        /* not reached */
}

uint8_t
hammer2_get_obj_type(enum vtype vtype)
{
        switch(vtype) {
        case VDIR:
                return(HAMMER2_OBJTYPE_DIRECTORY);
        case VREG:
                return(HAMMER2_OBJTYPE_REGFILE);
        case VFIFO:
                return(HAMMER2_OBJTYPE_FIFO);
        case VSOCK:
                return(HAMMER2_OBJTYPE_SOCKET);
        case VCHR:
                return(HAMMER2_OBJTYPE_CDEV);
        case VBLK:
                return(HAMMER2_OBJTYPE_BDEV);
        case VLNK:
                return(HAMMER2_OBJTYPE_SOFTLINK);
        default:
                return(HAMMER2_OBJTYPE_UNKNOWN);
        }
        /* not reached */
}

/*
 * Convert a hammer2 64-bit time to a timespec.
 */
void
hammer2_time_to_timespec(uint64_t xtime, struct timespec *ts)
{
        ts->tv_sec = (unsigned long)(xtime / 1000000);
        ts->tv_nsec = (unsigned int)(xtime % 1000000) * 1000L;
}

uint64_t
hammer2_timespec_to_time(const struct timespec *ts)
{
        uint64_t xtime;

        xtime = (unsigned)(ts->tv_nsec / 1000) +
                (unsigned long)ts->tv_sec * 1000000ULL;
        return(xtime);
}

/*
 * Convert a hammer2 64-bit time to a timeval.
 */
void
hammer2_time_to_timeval(uint64_t xtime, struct timeval *tv)
{
        tv->tv_sec = (unsigned long)(xtime / 1000000);
        tv->tv_usec = (unsigned int)(xtime % 1000000);
}

/*
 * Convert a uuid to a unix uid or gid
 */
uint32_t
hammer2_to_unix_xid(const uuid_t *uuid)
{
        return(*(const uint32_t *)&uuid->node[2]);
}

void
hammer2_guid_to_uuid(uuid_t *uuid, uint32_t guid)
{
        bzero(uuid, sizeof(*uuid));
        *(uint32_t *)&uuid->node[2] = guid;
}

/*
 * Borrow HAMMER1's directory hash algorithm #1 with a few modifications.
 * The filename is split into fields which are hashed separately and then
 * added together.
 *
 * Differences include: bit 63 must be set to 1 for HAMMER2 (HAMMER1 sets
 * it to 0), this is because bit63=0 is used for hidden hardlinked inodes.
 * (This means we do not need to do a 0-check/or-with-0x100000000 either).
 *
 * Also, the iscsi crc code is used instead of the old crc32 code.
 */
hammer2_key_t
hammer2_dirhash(const char *aname, size_t len)
{
        uint32_t crcx;
        uint64_t key;
        size_t i;
        size_t j;

        key = 0;

        /*
         * m32
         */
        crcx = 0;
        for (i = j = 0; i < len; ++i) {
                if (aname[i] == '.' ||
                    aname[i] == '-' ||
                    aname[i] == '_' ||
                    aname[i] == '~') {
                        if (i != j)
                                crcx += hammer2_icrc32(aname + j, i - j);
                        j = i + 1;
                }
        }
        if (i != j)
                crcx += hammer2_icrc32(aname + j, i - j);

        /*
         * The directory hash utilizes the top 32 bits of the 64-bit key.
         * Bit 63 must be set to 1.
         */
        crcx |= 0x80000000U;
        key |= (uint64_t)crcx << 32;

        /*
         * l16 - crc of entire filename
         *
         * This crc reduces degenerate hash collision conditions.
         */
        crcx = hammer2_icrc32(aname, len);
        crcx = crcx ^ (crcx << 16);
        key |= crcx & 0xFFFF0000U;

        /*
         * Set bit 15.  This allows readdir to strip bit 63 so a positive
         * 64-bit cookie/offset can always be returned, and still guarantee
         * that the values 0x0000-0x7FFF are available for artificial entries.
         * ('.' and '..').
         */
        key |= 0x8000U;

        return (key);
}

/*
 * Convert bytes to radix with no limitations.
 *
 * 0 bytes is special-cased to a radix of zero (which would normally
 * translate to (1 << 0) == 1).
 */
int
hammer2_getradix(size_t bytes)
{
        int radix;

        /*
         * Optimize the iteration by pre-checking commonly used radixes.
         */
        if (bytes == HAMMER2_PBUFSIZE)
                radix = HAMMER2_PBUFRADIX;
        else if (bytes >= HAMMER2_LBUFSIZE)
                radix = HAMMER2_LBUFRADIX;
        else if (bytes >= HAMMER2_ALLOC_MIN)    /* clamp */
                radix = HAMMER2_RADIX_MIN;
        else
                radix = 0;

        /*
         * Iterate as needed.  Note that bytes == 0 is expected to return
         * a radix of 0 as a special case.
         */
        while (((size_t)1 << radix) < bytes)
                ++radix;
        return (radix);
}

/*
 * The logical block size is currently always PBUFSIZE.
 */
int
hammer2_calc_logical(hammer2_inode_t *ip, hammer2_off_t uoff,
                     hammer2_key_t *lbasep, hammer2_key_t *leofp)
{
        if (lbasep)
                *lbasep = uoff & ~HAMMER2_PBUFMASK64;
        if (leofp) {
                *leofp = (ip->meta.size + HAMMER2_PBUFMASK64) &
                         ~HAMMER2_PBUFMASK64;
        }
        return (HAMMER2_PBUFSIZE);
}

/*
 * Calculate the physical block size.  pblksize <= lblksize.  Primarily
 * used to calculate a smaller physical block for the logical block
 * containing the file EOF.
 *
 * Returns 0 if the requested base offset is beyond the file EOF.
 */
int
hammer2_calc_physical(hammer2_inode_t *ip, hammer2_key_t lbase)
{
        int lblksize;
        int pblksize;
        int eofbytes;

        lblksize = hammer2_calc_logical(ip, lbase, NULL, NULL);
        if (lbase + lblksize <= ip->meta.size)
                return (lblksize);
        if (lbase >= ip->meta.size)
                return (0);
        eofbytes = (int)(ip->meta.size - lbase);
        pblksize = lblksize;
        while (pblksize >= eofbytes && pblksize >= HAMMER2_ALLOC_MIN)
                pblksize >>= 1;
        pblksize <<= 1;

        return (pblksize);
}

extern fsnode *hammer2_curnode;

static void
hammer2_get_curtime(uint64_t *timep)
{
        struct timeval ts;
        int error;

        error = gettimeofday(&ts, NULL);
        KKASSERT(error == 0);
        *timep = (unsigned long)ts.tv_sec * 1000000 + ts.tv_usec;
}

void
hammer2_update_time(uint64_t *timep, bool is_mtime)
{
        struct timespec *ts;
        struct stat *st;

        /* HAMMER2 ioctl commands */
        if (hammer2_curnode == NULL) {
                hammer2_get_curtime(timep);
                return;
        }

        st = stampst.st_ino != 0 ? &stampst : &hammer2_curnode->inode->st;
        ts = is_mtime ? &st->st_mtim : &st->st_ctim;

        *timep = (uint64_t)ts->tv_sec * 1000000 + ts->tv_nsec / 1000;
}

void
hammer2_adjreadcounter(int btype, size_t bytes)
{
        long *counterp;

        switch(btype) {
        case HAMMER2_BREF_TYPE_DATA:
                counterp = &hammer2_iod_file_read;
                break;
        case HAMMER2_BREF_TYPE_DIRENT:
        case HAMMER2_BREF_TYPE_INODE:
                counterp = &hammer2_iod_meta_read;
                break;
        case HAMMER2_BREF_TYPE_INDIRECT:
                counterp = &hammer2_iod_indr_read;
                break;
        case HAMMER2_BREF_TYPE_FREEMAP_NODE:
        case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
                counterp = &hammer2_iod_fmap_read;
                break;
        case HAMMER2_BREF_TYPE_FREEMAP:
        case HAMMER2_BREF_TYPE_VOLUME:
                counterp = &hammer2_iod_volu_read;
                break;
        case HAMMER2_BREF_TYPE_EMPTY:
        default:
                return;
        }
        *counterp += bytes;
}

void
hammer2_adjwritecounter(int btype, size_t bytes)
{
        long *counterp;

        switch(btype) {
        case HAMMER2_BREF_TYPE_DATA:
                counterp = &hammer2_iod_file_write;
                break;
        case HAMMER2_BREF_TYPE_DIRENT:
        case HAMMER2_BREF_TYPE_INODE:
                counterp = &hammer2_iod_meta_write;
                break;
        case HAMMER2_BREF_TYPE_INDIRECT:
                counterp = &hammer2_iod_indr_write;
                break;
        case HAMMER2_BREF_TYPE_FREEMAP_NODE:
        case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
                counterp = &hammer2_iod_fmap_write;
                break;
        case HAMMER2_BREF_TYPE_FREEMAP:
        case HAMMER2_BREF_TYPE_VOLUME:
                counterp = &hammer2_iod_volu_write;
                break;
        case HAMMER2_BREF_TYPE_EMPTY:
        default:
                return;
        }
        *counterp += bytes;
}

/*
 * Check for pending signal to allow interruption.  This function will
 * return immediately if the calling thread is a kernel thread and not
 * a user thread.
 */
int
hammer2_signal_check(time_t *timep)
{
#if 0
        thread_t td = curthread;
        int error = 0;

        if (td->td_lwp) {
                lwkt_user_yield();
                if (*timep != time_second) {
                        *timep = time_second;
                        if (CURSIG_NOBLOCK(curthread->td_lwp) != 0)
                                error = HAMMER2_ERROR_ABORTED;
                }
        } else {
                lwkt_yield();
        }
        return error;
#endif
        return 0;
}

const char *
hammer2_error_str(int error)
{
        if (error & HAMMER2_ERROR_EIO)
                return("I/O Error");
        if (error & HAMMER2_ERROR_CHECK)
                return("Check Error");
        if (error & HAMMER2_ERROR_INCOMPLETE)
                return("Cluster Quorum Error");
        if (error & HAMMER2_ERROR_DEPTH)
                return("Chain Depth Error");
        if (error & HAMMER2_ERROR_BADBREF)
                return("Bad Blockref Error");
        if (error & HAMMER2_ERROR_ENOSPC)
                return("No Space on Device");
        if (error & HAMMER2_ERROR_ENOENT)
                return("Entry Not Found");
        if (error & HAMMER2_ERROR_ENOTEMPTY)
                return("Directory Not Empty");
        if (error & HAMMER2_ERROR_EAGAIN)
                return("EAGAIN");
        if (error & HAMMER2_ERROR_ENOTDIR)
                return("Not a Directory");
        if (error & HAMMER2_ERROR_EISDIR)
                return("Is a Directory");
        if (error & HAMMER2_ERROR_EINPROGRESS)
                return("Operation in Progress");
        if (error & HAMMER2_ERROR_ABORTED)
                return("Operation Aborted");
        if (error & HAMMER2_ERROR_EOF)
                return("Operation Complete");
        if (error & HAMMER2_ERROR_EINVAL)
                return("Invalid Operation");
        if (error & HAMMER2_ERROR_EEXIST)
                return("Object Exists");
        if (error & HAMMER2_ERROR_EDEADLK)
                return("Deadlock Detected");
        if (error & HAMMER2_ERROR_ESRCH)
                return("Object Not Found");
        if (error & HAMMER2_ERROR_ETIMEDOUT)
                return("Timeout");
        return("Unknown Error");
}

const char *
hammer2_bref_type_str(int btype)
{
        switch(btype) {
        case HAMMER2_BREF_TYPE_EMPTY:
                return("empty");
        case HAMMER2_BREF_TYPE_INODE:
                return("inode");
        case HAMMER2_BREF_TYPE_INDIRECT:
                return("indirect");
        case HAMMER2_BREF_TYPE_DATA:
                return("data");
        case HAMMER2_BREF_TYPE_DIRENT:
                return("dirent");
        case HAMMER2_BREF_TYPE_FREEMAP_NODE:
                return("freemap_node");
        case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
                return("freemap_leaf");
        case HAMMER2_BREF_TYPE_INVALID:
                return("invalid");
        case HAMMER2_BREF_TYPE_FREEMAP:
                return("freemap");
        case HAMMER2_BREF_TYPE_VOLUME:
                return("volume");
        default:
                return("unknown");
        }
}