/*      $NetBSD: subr_kobj_vfs.c,v 1.12 2021/06/29 22:40:53 dholland Exp $      */

/*-
* Copyright (c) 2008 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software developed for The NetBSD Foundation
* by Andrew Doran.
*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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) 1998-2000 Doug Rabson
* Copyright (c) 2004 Peter Wemm
* All rights reserved.
*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
*/

/*
* Kernel loader vfs routines.
*/

#include <sys/kobj_impl.h>

#ifdef _KERNEL_OPT
#include "opt_modular.h"
#endif

#ifdef MODULAR

#include <sys/param.h>
#include <sys/fcntl.h>
#include <sys/module.h>
#include <sys/namei.h>
#include <sys/vnode.h>

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: subr_kobj_vfs.c,v 1.12 2021/06/29 22:40:53 dholland Exp $");

static void
kobj_close_vfs(kobj_t ko)
{

       VOP_UNLOCK(ko->ko_source);
       vn_close(ko->ko_source, FREAD, kauth_cred_get());
}

/*
* kobj_read:
*
*      Utility function: read from the object.
*/
static int
kobj_read_vfs(kobj_t ko, void **basep, size_t size, off_t off,
       bool allocate)
{
       size_t resid;
       void *base;
       int error;

       KASSERT(ko->ko_source != NULL);

       if (allocate) {
               base = kmem_alloc(size, KM_SLEEP);
       } else {
               base = *basep;
#ifdef DIAGNOSTIC
               bool ok = false;
               if ((uintptr_t)base >= (uintptr_t)ko->ko_text_address &&
                   (uintptr_t)base + size <=
                   (uintptr_t)ko->ko_text_address + ko->ko_text_size)
                       ok = true;
               if ((uintptr_t)base >= (uintptr_t)ko->ko_data_address &&
                   (uintptr_t)base + size <=
                   (uintptr_t)ko->ko_data_address + ko->ko_data_size)
                       ok = true;
               if ((uintptr_t)base >= (uintptr_t)ko->ko_rodata_address &&
                   (uintptr_t)base + size <=
                   (uintptr_t)ko->ko_rodata_address + ko->ko_rodata_size)
                       ok = true;
               if (!ok)
                       panic("kobj_read_vfs: not in a dedicated segment");
#endif
       }

       error = vn_rdwr(UIO_READ, ko->ko_source, base, size, off,
           UIO_SYSSPACE, IO_NODELOCKED, curlwp->l_cred, &resid,
           curlwp);

       if (error == 0 && resid != 0) {
               error = EINVAL;
       }

       if (allocate && error != 0) {
               kmem_free(base, size);
               base = NULL;
       }

       if (allocate)
               *basep = base;

       return error;
}

/*
* kobj_load_vfs:
*
*      Load an object located in the file system.
*/
int
kobj_load_vfs(kobj_t *kop, const char *path, const bool nochroot)
{
       struct pathbuf *pb;
       struct vnode *vp;
       int error;
       kobj_t ko;

       KASSERT(path != NULL);
       if (strchr(path, '/') == NULL)
               return ENOENT;

       ko = kmem_zalloc(sizeof(*ko), KM_SLEEP);
       pb = pathbuf_create(path);
       if (pb == NULL) {
               kmem_free(ko, sizeof(*ko));
               return ENOMEM;
       }

       error = vn_open(NULL, pb, (nochroot ? NOCHROOT : 0), FREAD, 0,
           &vp, NULL, NULL);

       if (error != 0) {
               pathbuf_destroy(pb);
               kmem_free(ko, sizeof(*ko));
               return error;
       }

       ko->ko_type = KT_VNODE;
       kobj_setname(ko, path);
       ko->ko_source = vp;
       ko->ko_read = kobj_read_vfs;
       ko->ko_close = kobj_close_vfs;
       pathbuf_destroy(pb);

       *kop = ko;
       return kobj_load(ko);
}

#else /* MODULAR */

int
kobj_load_vfs(kobj_t *kop, const char *path, const bool nochroot)
{

       return ENOSYS;
}

#endif