/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 1995 Terrence R. Lambert
 * All rights reserved.
 *
 * Copyright (c) 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. 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.
 */

#ifndef _SYS_KERNEL_H_
#define _SYS_KERNEL_H_

#include <sys/linker_set.h>

#ifdef _KERNEL

/* for intrhook and sysinit linked list below */
#include <sys/queue.h>

/* for timestamping SYSINITs; other files may assume this is included here */
#include <sys/tslog.h>

/* Global variables for the kernel. */

/* 1.1 */
extern char kernelname[MAXPATHLEN];

extern int tick;                        /* usec per tick (1000000 / hz) */
extern int hz;                          /* system clock's frequency */
extern int psratio;                     /* ratio: prof / stat */
extern int stathz;                      /* statistics clock's frequency */
extern int profhz;                      /* profiling clock's frequency */
extern int profprocs;                   /* number of process's profiling */

/*
 * The ticks and ticksl symbols overlap, giving a 64-bit tick counter on 64-bit
 * platforms while still maintaining compatibility with the legacy 32-bit
 * counter.  Either value can be used, but rollover must be handled; at 1000Hz,
 * ticks (and ticksl on 32-bit platforms) roll over roughly every 25 days.  On
 * 64-bit platforms, ticksl will not roll over in the foreseeable future.
 */
extern volatile int ticks;
extern volatile long ticksl;

#endif /* _KERNEL */

/*
 * Enumerated types for known system startup interfaces.
 *
 * Startup occurs in ascending numeric order; the list entries are
 * sorted prior to attempting startup to guarantee order.  Items
 * of the same level are arbitrated for order based on the 'order'
 * element.
 *
 * These numbers are arbitrary and are chosen ONLY for ordering; the
 * enumeration values are explicit rather than implicit to provide
 * for binary compatibility with inserted elements.
 *
 * The SI_SUB_LAST value must have the highest lexical value.
 */
enum sysinit_sub_id {
        SI_SUB_DUMMY            = 0x0000000,    /* not executed; for linker */
        SI_SUB_TUNABLES         = 0x0700000,    /* establish tunable values */
        SI_SUB_COPYRIGHT        = 0x0800001,    /* first use of console */
        SI_SUB_VM               = 0x1000000,    /* virtual memory system init */
        SI_SUB_COUNTER          = 0x1100000,    /* counter(9) is initialized */
        SI_SUB_KMEM             = 0x1800000,    /* kernel memory */
        SI_SUB_HYPERVISOR       = 0x1A40000,    /*
                                                 * Hypervisor detection and
                                                 * virtualization support
                                                 * setup.
                                                 */
        SI_SUB_WITNESS          = 0x1A80000,    /* witness initialization */
        SI_SUB_MTX_POOL_DYNAMIC = 0x1AC0000,    /* dynamic mutex pool */
        SI_SUB_LOCK             = 0x1B00000,    /* various locks */
        SI_SUB_EVENTHANDLER     = 0x1C00000,    /* eventhandler init */
        SI_SUB_VNET_PRELINK     = 0x1E00000,    /* vnet init before modules */
        SI_SUB_KLD              = 0x2000000,    /* KLD and module setup */
        SI_SUB_KHELP            = 0x2080000,    /* khelp modules */
        SI_SUB_CPU              = 0x2100000,    /* CPU resource(s) */
        SI_SUB_RACCT            = 0x2110000,    /* resource accounting */
        SI_SUB_KDTRACE          = 0x2140000,    /* Kernel dtrace hooks */
        SI_SUB_RANDOM           = 0x2160000,    /* random number generator */
        SI_SUB_MAC              = 0x2180000,    /* TrustedBSD MAC subsystem */
        SI_SUB_MAC_POLICY       = 0x21C0000,    /* TrustedBSD MAC policies */
        SI_SUB_MAC_LATE         = 0x21D0000,    /* TrustedBSD MAC subsystem */
        SI_SUB_VNET             = 0x21E0000,    /* vnet 0 */
        SI_SUB_INTRINSIC        = 0x2200000,    /* proc 0 */
        SI_SUB_VM_CONF          = 0x2300000,    /* config VM, set limits */
        SI_SUB_DDB_SERVICES     = 0x2380000,    /* capture, scripting, etc. */
        SI_SUB_RUN_QUEUE        = 0x2400000,    /* set up run queue */
        SI_SUB_KTRACE           = 0x2480000,    /* ktrace */
        SI_SUB_OPENSOLARIS      = 0x2490000,    /* OpenSolaris compatibility */
        SI_SUB_AUDIT            = 0x24C0000,    /* audit */
        SI_SUB_CREATE_INIT      = 0x2500000,    /* create init process */
        SI_SUB_SCHED_IDLE       = 0x2600000,    /* required idle procs */
        SI_SUB_MBUF             = 0x2700000,    /* mbuf subsystem */
        SI_SUB_INTR             = 0x2800000,    /* interrupt threads */
        SI_SUB_TASKQ            = 0x2880000,    /* task queues */
        SI_SUB_EPOCH            = 0x2888000,    /* epoch subsystem */
#ifdef EARLY_AP_STARTUP
        SI_SUB_SMP              = 0x2900000,    /* start the APs */
#endif
        SI_SUB_SOFTINTR         = 0x2A00000,    /* start soft interrupt thread */
        SI_SUB_DEVFS            = 0x2F00000,    /* devfs ready for devices */
        SI_SUB_INIT_IF          = 0x3000000,    /* prep for net interfaces */
        SI_SUB_NETGRAPH         = 0x3010000,    /* Let Netgraph initialize */
        SI_SUB_DTRACE           = 0x3020000,    /* DTrace subsystem */
        SI_SUB_DTRACE_PROVIDER  = 0x3048000,    /* DTrace providers */
        SI_SUB_DTRACE_ANON      = 0x308C000,    /* DTrace anon enabling */
        SI_SUB_DRIVERS          = 0x3100000,    /* Let Drivers initialize */
        SI_SUB_CONFIGURE        = 0x3800000,    /* Configure devices */
        SI_SUB_VFS              = 0x4000000,    /* virtual filesystem */
        SI_SUB_CLOCKS           = 0x4800000,    /* real time and stat clocks */
        SI_SUB_SYSV_SHM         = 0x6400000,    /* System V shared memory */
        SI_SUB_SYSV_SEM         = 0x6800000,    /* System V semaphores */
        SI_SUB_SYSV_MSG         = 0x6C00000,    /* System V message queues */
        SI_SUB_P1003_1B         = 0x6E00000,    /* P1003.1B realtime */
        SI_SUB_PSEUDO           = 0x7000000,    /* pseudo devices */
        SI_SUB_EXEC             = 0x7400000,    /* execve() handlers */
        SI_SUB_PROTO_BEGIN      = 0x8000000,    /* VNET initialization */
        SI_SUB_PROTO_PFIL       = 0x8100000,    /* Initialize pfil before FWs */
        SI_SUB_PROTO_MC         = 0x8300000,    /* Multicast */
        SI_SUB_PROTO_IF         = 0x8400000,    /* interfaces */
        SI_SUB_PROTO_DOMAININIT = 0x8600000,    /* domain registration system */
        SI_SUB_PROTO_DOMAIN     = 0x8800000,    /* domains (address families?) */
        SI_SUB_PROTO_FIREWALL   = 0x8806000,    /* Firewalls */
        SI_SUB_PROTO_IFATTACHDOMAIN = 0x8808000,/* domain dependent data init */
        SI_SUB_PROTO_END        = 0x8ffffff,    /* VNET helper functions */
        SI_SUB_KPROF            = 0x9000000,    /* kernel profiling */
        SI_SUB_KICK_SCHEDULER   = 0xa000000,    /* start the timeout events */
        SI_SUB_INT_CONFIG_HOOKS = 0xa800000,    /* Interrupts enabled config */
        SI_SUB_ROOT_CONF        = 0xb000000,    /* Find root devices */
        SI_SUB_INTRINSIC_POST   = 0xd000000,    /* proc 0 cleanup */
        SI_SUB_SYSCALLS         = 0xd800000,    /* register system calls */
        SI_SUB_VNET_DONE        = 0xdc00000,    /* vnet registration complete */
        SI_SUB_KTHREAD_INIT     = 0xe000000,    /* init process */
        SI_SUB_KTHREAD_PAGE     = 0xe400000,    /* pageout daemon */
        SI_SUB_KTHREAD_VM       = 0xe800000,    /* vm daemon */
        SI_SUB_KTHREAD_BUF      = 0xea00000,    /* buffer daemon */
        SI_SUB_KTHREAD_UPDATE   = 0xec00000,    /* update daemon */
        SI_SUB_KTHREAD_IDLE     = 0xee00000,    /* idle procs */
#ifndef EARLY_AP_STARTUP
        SI_SUB_SMP              = 0xf000000,    /* start the APs */
#endif
        SI_SUB_RACCTD           = 0xf100000,    /* start racctd */
        SI_SUB_LAST             = 0xfffffff     /* final initialization */
};

/*
 * Some enumerated orders; "ANY" sorts last.
 */
enum sysinit_elem_order {
        SI_ORDER_FIRST          = 0x0000000,    /* first */
        SI_ORDER_SECOND         = 0x0000001,    /* second */
        SI_ORDER_THIRD          = 0x0000002,    /* third */
        SI_ORDER_FOURTH         = 0x0000003,    /* fourth */
        SI_ORDER_FIFTH          = 0x0000004,    /* fifth */
        SI_ORDER_SIXTH          = 0x0000005,    /* sixth */
        SI_ORDER_SEVENTH        = 0x0000006,    /* seventh */
        SI_ORDER_EIGHTH         = 0x0000007,    /* eighth */
        SI_ORDER_MIDDLE         = 0x1000000,    /* somewhere in the middle */
        SI_ORDER_ANY            = 0xfffffff     /* last */
};

/*
 * A system initialization call instance
 *
 * At the moment there is one instance of sysinit.  We probably do not
 * want two which is why this code is if'd out, but we definitely want
 * to discern SYSINIT's which take non-constant data pointers and
 * SYSINIT's which take constant data pointers,
 *
 * The C_* macros take functions expecting const void * arguments
 * while the non-C_* macros take functions expecting just void * arguments.
 *
 * With -Wcast-qual on, the compiler issues warnings:
 *      - if we pass non-const data or functions taking non-const data
 *        to a C_* macro.
 *
 *      - if we pass const data to the normal macros
 *
 * However, no warning is issued if we pass a function taking const data
 * through a normal non-const macro.  This is ok because the function is
 * saying it won't modify the data so we don't care whether the data is
 * modifiable or not.
 */

typedef void (*sysinit_nfunc_t)(void *);
typedef void (*sysinit_cfunc_t)(const void *);

struct sysinit {
        enum sysinit_sub_id     subsystem;      /* subsystem identifier */
        enum sysinit_elem_order order;          /* init order within subsystem */
        STAILQ_ENTRY(sysinit)   next;           /* singly-linked list */
        sysinit_cfunc_t func;                   /* function */
        const void      *udata;                 /* multiplexer/argument */
};

/*
 * Default: no special processing
 *
 * The C_ version of SYSINIT is for data pointers to const
 * data ( and functions taking data pointers to const data ).
 * At the moment it is no different from SYSINIT and thus
 * still results in warnings.
 *
 * The casts are necessary to have the compiler produce the
 * correct warnings when -Wcast-qual is used.
 *
 */
#ifdef TSLOG
struct sysinit_tslog {
        sysinit_cfunc_t func;
        const void *data;
        const char *name;
};
void sysinit_tslog_shim(const void *);

#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
        static struct sysinit_tslog uniquifier ## _sys_init_tslog = {   \
                func,                                           \
                (ident),                                        \
                #uniquifier                                     \
        };                                                      \
        static struct sysinit uniquifier ## _sys_init = {       \
                subsystem,                                      \
                order,                                          \
                { NULL },                                       \
                sysinit_tslog_shim,                             \
                &uniquifier ## _sys_init_tslog                  \
        };                                                      \
        DATA_WSET(sysinit_set, uniquifier ## _sys_init)
#else
#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
        static struct sysinit uniquifier ## _sys_init = {       \
                subsystem,                                      \
                order,                                          \
                { NULL },                                       \
                func,                                           \
                (ident)                                         \
        };                                                      \
        DATA_WSET(sysinit_set, uniquifier ## _sys_init)
#endif

#define SYSINIT(uniquifier, subsystem, order, func, ident)      \
        C_SYSINIT(uniquifier, subsystem, order,                 \
        (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))

/*
 * Called on module unload: no special processing
 */
#define C_SYSUNINIT(uniquifier, subsystem, order, func, ident)  \
        static struct sysinit uniquifier ## _sys_uninit = {     \
                subsystem,                                      \
                order,                                          \
                { NULL },                                       \
                func,                                           \
                (ident)                                         \
        };                                                      \
        DATA_WSET(sysuninit_set, uniquifier ## _sys_uninit)

#define SYSUNINIT(uniquifier, subsystem, order, func, ident)    \
        C_SYSUNINIT(uniquifier, subsystem, order,               \
        (sysinit_cfunc_t)(sysinit_nfunc_t)func, (void *)(ident))

void    sysinit_add(struct sysinit **set, struct sysinit **set_end);

#ifdef _KERNEL

/*
 * Infrastructure for tunable 'constants'.  Value may be specified at compile
 * time or kernel load time.  Rules relating tunables together can be placed
 * in a SYSINIT function at SI_SUB_TUNABLES with SI_ORDER_ANY.
 *
 * WARNING: developers should never use the reserved suffixes specified in
 * loader.conf(5) for any tunables or conflicts will result.
 */

/*
 * int
 * please avoid using for new tunables!
 */
extern void tunable_int_init(const void *);
struct tunable_int {
        const char *path;
        int *var;
};
#define TUNABLE_INT(path, var)                                  \
        static struct tunable_int __CONCAT(__tunable_int_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int_init, \
            &__CONCAT(__tunable_int_, __LINE__))

#define TUNABLE_INT_FETCH(path, var)    getenv_int((path), (var))

/*
 * long
 */
extern void tunable_long_init(const void *);
struct tunable_long {
        const char *path;
        long *var;
};
#define TUNABLE_LONG(path, var)                                 \
        static struct tunable_long __CONCAT(__tunable_long_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_long_init,\
            &__CONCAT(__tunable_long_, __LINE__))

#define TUNABLE_LONG_FETCH(path, var)   getenv_long((path), (var))

/*
 * unsigned long
 */
extern void tunable_ulong_init(const void *);
struct tunable_ulong {
        const char *path;
        unsigned long *var;
};
#define TUNABLE_ULONG(path, var)                                \
        static struct tunable_ulong __CONCAT(__tunable_ulong_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_ulong_init, \
            &__CONCAT(__tunable_ulong_, __LINE__))

#define TUNABLE_ULONG_FETCH(path, var)  getenv_ulong((path), (var))

/*
 * int64_t
 */
extern void tunable_int64_init(const void *);
struct tunable_int64 {
        const char *path;
        int64_t *var;
};
#define TUNABLE_INT64(path, var)                                \
        static struct tunable_int64 __CONCAT(__tunable_int64_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_int64_init, \
            &__CONCAT(__tunable_int64_, __LINE__))

#define TUNABLE_INT64_FETCH(path, var)  getenv_int64((path), (var))

/*
 * uint64_t
 */
extern void tunable_uint64_init(const void *);
struct tunable_uint64 {
        const char *path;
        uint64_t *var;
};
#define TUNABLE_UINT64(path, var)                               \
        static struct tunable_uint64 __CONCAT(__tunable_uint64_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_uint64_init, \
            &__CONCAT(__tunable_uint64_, __LINE__))

#define TUNABLE_UINT64_FETCH(path, var) getenv_uint64((path), (var))

/*
 * quad
 */
extern void tunable_quad_init(const void *);
struct tunable_quad {
        const char *path;
        quad_t *var;
};
#define TUNABLE_QUAD(path, var)                                 \
        static struct tunable_quad __CONCAT(__tunable_quad_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_quad_init, \
            &__CONCAT(__tunable_quad_, __LINE__))

#define TUNABLE_QUAD_FETCH(path, var)   getenv_quad((path), (var))

/*
 * bool
 */
extern void tunable_bool_init(const void *);
struct tunable_bool {
        const char *path;
        bool *var;
};
#define TUNABLE_BOOL(path, var) \
        static struct tunable_bool __CONCAT(__tunable_bool_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_bool_init, \
            &__CONCAT(__tunable_bool_, __LINE__))

#define TUNABLE_BOOL_FETCH(path, var)   getenv_bool((path), (var))

extern void tunable_str_init(const void *);
struct tunable_str {
        const char *path;
        char *var;
        int size;
};
#define TUNABLE_STR(path, var, size)                            \
        static struct tunable_str __CONCAT(__tunable_str_, __LINE__) = { \
                (path),                                         \
                (var),                                          \
                (size),                                         \
        };                                                      \
        SYSINIT(__CONCAT(__Tunable_init_, __LINE__),            \
            SI_SUB_TUNABLES, SI_ORDER_MIDDLE, tunable_str_init, \
            &__CONCAT(__tunable_str_, __LINE__))

#define TUNABLE_STR_FETCH(path, var, size)                      \
        getenv_string((path), (var), (size))

#endif /* _KERNEL */

typedef void (*ich_func_t)(void *_arg);

struct intr_config_hook {
        STAILQ_ENTRY(intr_config_hook) ich_links;
        uintptr_t       ich_state;
#define ICHS_QUEUED     0x1
#define ICHS_RUNNING    0x2
#define ICHS_DONE       0x3
        ich_func_t      ich_func;
        void            *ich_arg;
};

int     config_intrhook_establish(struct intr_config_hook *hook);
void    config_intrhook_disestablish(struct intr_config_hook *hook);
int     config_intrhook_drain(struct intr_config_hook *hook);
void    config_intrhook_oneshot(ich_func_t _func, void *_arg);

#endif /* !_SYS_KERNEL_H_*/