/* IBM_PROLOG_BEGIN_TAG                                                   */
/* This is an automatically generated prolog.                             */
/*                                                                        */
/* bos72Q src/bos/kernel/sys/sysconfig.h 1.25.1.7                         */
/*                                                                        */
/* Licensed Materials - Property of IBM                                   */
/*                                                                        */
/* COPYRIGHT International Business Machines Corp. 1989,2019              */
/* All Rights Reserved                                                    */
/*                                                                        */
/* US Government Users Restricted Rights - Use, duplication or            */
/* disclosure restricted by GSA ADP Schedule Contract with IBM Corp.      */
/*                                                                        */
/* IBM_PROLOG_END_TAG                                                     */
/* @(#)03     1.25.1.7  src/bos/kernel/sys/sysconfig.h, sysios, bos72Q, q2019_13A4 2/6/19 00:42:06 */
#ifndef _H_SYSCONFIG
#define _H_SYSCONFIG
/*
 * COMPONENT_NAME: (SYSIOS) Sysconfig system call header file
 *
 * ORIGINS: 27
 *
 */                                                                   

#include <sys/types.h>
#include <sys/lock_def.h>

#ifdef __cplusplus
extern "C" {
#endif

#define CONF_SUCC	0
#define CONF_FAIL	-1

#define SYS_KLOAD	0x01	/* load kernel ext. into kernel	*/
#define SYS_SINGLELOAD	0x02	/* load kernel ext. only once	*/
#define SYS_QUERYLOAD	0x03	/* check if kernel ext. in kernel*/
#define SYS_KULOAD	0x04	/* unload kernel ext.from kernel*/
#define SYS_CFGKMOD	0x05	/* call kernel ext. entry pt.	*/
#define SYS_CFGDD	0x06	/* call dev.driver's entry pt.	*/
#define SYS_QDVSW	0x07	/* check dev.switch entry status*/
#define SYS_GETPARMS	0x08	/* get runtime system parameters*/
#define SYS_SETPARMS	0x09	/* set runtime system parameters*/
#define SYS_SEC_MODE	0x0A	/* set system security level */
#define	SET_SECURE_NLSPATH 0x0B	/* set system secure NLSPATH */
#define	GET_SECURE_NLSPATH 0x0C	/* get system secure NLSPATH */
#define	SYS_GETLPAR_INFO   0x0D	/* get system LPAR info      */
#define	SET_COREPATH    0x0E	/* set  system corepath	*/
#define	GET_COREPATH    0xF	/* get system core path */
#define SYS_XKEXP	0x10	/* load names of new kernel exports */

#define		NLSPATH_MAX 1024 /* maximum length of secure NLSPATH */


/* SYS_64BIT can be used as a sysconfig subcommand or as a modifier flag for
 * the SYS_KLOAD, SYS_SINGLELOAD, SYS_CFGKMOD, and SYS_CFGDD subcommands.
 */
#define SYS_64BIT	0x80000000	/* module understands 64-bit apps*/
#define SYS_64L		0x40000000	/* module understands 64-l apps*/
#define	SYS_LUSAFE      0x20000000	/* load kernext in LU safe mode*/

/*
 * Structure for loading a kernel extension
 */
struct cfg_load
{
	caddr_t	path;		/* ptr to object module pathname	*/
	caddr_t	libpath;	/* ptr to a substitute libpath		*/
	mid_t	kmid;		/* kernel module id (returned)		*/
};

/*
 * Structure for calling a kernel extension's module entry point
 */
struct cfg_kmod
{
	mid_t	kmid;		/* module ID of module to call		*/
	int	cmd;		/* command parameter for module		*/
	caddr_t mdiptr;		/* pointer to module dependent info	*/
	int	mdilen;		/* length of module dependent info	*/
};

/*
 * Structure for calling a device driver's config (module) entry point
 */
struct cfg_dd
{
	mid_t	kmid;		/* module ID of device driver		*/
	dev_t	devno;		/* device major/minor number		*/
	int	cmd;		/* config command code for device driver*/
	caddr_t ddsptr;		/* pointer to device dependent structure*/
	int	ddslen;		/* length of device dependent structure	*/
};

/*
 * Structure for checking the status of a device switch entry
 */
struct qry_devsw
{
	dev_t	devno;		/* device number of entry		*/
	uint	status;		/* returned status information		*/
};

/*
 * Structure for getting LPAR information
 */

struct getlpar_info {
	unsigned short	lpar_flags;	/* LPAR flags, see below	*/
	unsigned short	lpar_namesz;	/* Size of partition name	*/
	int		lpar_num;	/* Partition number		*/
	char		*lpar_name;	/* Partition name		*/
	int		rsvd[8];	/* Reserved fields		*/
};

/* defines for getlpar_info.lpar_flags */

#define LPAR_ENABLED        0x0001
#define LPAR_CAPABLE        0x0002

/*
 * Config notification control block
 */
struct cfgncb
{
	struct cfgncb	*cbnext;	/* next control block on chain	*/
	struct cfgncb	*cbprev;	/* previous control block on chain*/
	int		(*func)();	/* notification function	*/
};

/*
 * The config notification control block lock for use with
 * simple_lock/simple_unlock.
 * This lock is used to serialize cfgnadd()/cfgndel() kernel services
 * (i.e. updates to the config notification control block chain), as well
 * as the running of this chain by the sysconfig SYS_SETPARMS system call.
 */
Simple_lock cfgcb_lock;

/*
 * The secure NLSPATH variable is serialized with the secure environment
 * lock, secure_env_lock.
 */
extern Complex_lock secure_env_lock;

/*
 * The following are the possible values of the cmd parm to the caller's
 * config notification routine.  CFGV_PREPARE is used to check the
 * system parameters in the cfgvar structure for validity.  CFGV_COMMIT
 * is used to indicate that the new values in the cfgvar structure will
 * now be updated (i.e. all values are valid).
 */
#define	CFGV_PREPARE	0x01	/* check parms for validity		*/
#define	CFGV_COMMIT	0x02	/* commit parm changes			*/

#ifndef _NO_PROTO

int sysconfig(
	int cmd,		/* function requested: load, unload, etc*/
	void *parmp,		/* addr of struct containing info for cmd*/
	int parmlen);		/* length of parmp information		*/
uint64_t kgetsystemcfg(int label);

#else

int sysconfig();
uint64_t kgetsystemcfg();

#endif /* _NO_PROTO */

#ifdef _KERNEL

void cfgnadd(			/* register 'change' routine */
	struct cfgncb *cbp);    /* pointer to config control block */

void cfgndel(			/* remove 'change' routine */
	struct cfgncb *cbp);    /* pointer to config control block */

/* System Call Interception */
struct ku_intercept {
    int			ku_version;
#define KU_VERSION 1
    int			ku_hdr_len;	/* sizeof(struct ku_intercept) */
    int			ku_element_len; /* sizeof(struct ku_element) */
    int			ku_num_elements;
};

struct ku_element {
    void		*ku_svc;
    int			(*ku_pre)();
    void		(*ku_post)();
    void		*ku_cookie;
    int			ku_bsize;
    unsigned short	ku_iflags;
#define KU_IGNORE	0x0001
    unsigned short	ku_oflags;
#define KU_ERR_FLAG	0x0001		/* iflags or lflags invalid */
#define KU_ERR_BSIZE	0x0002		/* ku_bsize is invalid */
#define KU_ERR_PNULL	0x0004		/* Both ku_pre and ku_post are NULL. */
#define KU_ERR_PRE	0x0008		/* ku_pre is not in caller's kext */
#define KU_ERR_POST	0x0010		/* ku_post is not in caller's kext */
#define KU_ERR_SVC	0x0020		/* ku_svc appears invalid */
#define KU_ERR_AGAIN	0x0040		/* caller already intercepting sc */
#define KU_NOT_ALLOWED	0x0080		/* sc cannot be intercepted */
};

extern int kmod_util(int cmd, void * buffer, int length);
#define KU_INTERCEPT		1
#define KU_INTERCEPT_STOP	2
#define KU_INTERCEPT_CANCEL	3

#endif  /* _KERNEL */

/* Define offsets for all the RO variables */
#define OFFSET_VLOCK ((int)&((struct var *)0)->v_lock)
#define OFFSET_VFILE ((int)&((struct var *)0)->v_file)
#define OFFSET_VPROC ((int)&((struct var *)0)->v_proc)
#define OFFSET_VCLIST ((int)&((struct var *)0)->v_clist)
#define OFFSET_VTHREAD ((int)&((struct var *)0)->v_thread)
#define OFFSET_VNCPUS ((int)&((struct var *)0)->v_ncpus)
#define OFFSET_VNCPUSCFG ((int)&((struct var *)0)->v_ncpus_cfg)

#define OFFSET_VELOCK ((int)&((struct var *)0)->ve_lock)
#define OFFSET_VEFILE ((int)&((struct var *)0)->ve_file)
#define OFFSET_VEPROC ((int)&((struct var *)0)->ve_proc)
#define OFFSET_VETHREAD ((int)&((struct var *)0)->ve_thread)
#define OFFSET_VBPROC ((int)&((struct var *)0)->vb_proc)
#define OFFSET_VBTHREAD ((int)&((struct var *)0)->vb_thread)

#define NUM_VARS 13  /* size of the ro_vars array */

#ifdef __cplusplus
}
#endif

#endif  /* _H_SYSCONFIG */