/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. */ #ifndef _SYS_MODCTL_H #define _SYS_MODCTL_H #pragma ident "%Z%%M% %I% %E% SMI" /* * loadable module support. */ #include <sys/types.h> #include <sys/ioccom.h> #include <sys/nexusdefs.h> #include <sys/thread.h> #include <sys/t_lock.h> #include <sys/dditypes.h> #include <sys/hwconf.h> #ifdef __cplusplus extern "C" { #endif /* * The following structure defines the operations used by modctl * to load and unload modules. Each supported loadable module type * requires a set of mod_ops. */ struct mod_ops { int (*modm_install)(); /* install module in kernel */ int (*modm_remove)(); /* remove from kernel */ int (*modm_info)(); /* module info */ }; #ifdef _KERNEL /* * The defined set of mod_ops structures for each loadable module type * Defined in modctl.c */ extern struct mod_ops mod_brandops; #if defined(__i386) || defined(__amd64) extern struct mod_ops mod_cpuops; #endif extern struct mod_ops mod_cryptoops; extern struct mod_ops mod_driverops; extern struct mod_ops mod_execops; extern struct mod_ops mod_fsops; extern struct mod_ops mod_miscops; extern struct mod_ops mod_schedops; extern struct mod_ops mod_strmodops; extern struct mod_ops mod_syscallops; #ifdef _SYSCALL32_IMPL extern struct mod_ops mod_syscallops32; #endif extern struct mod_ops mod_dacfops; extern struct mod_ops mod_ippops; extern struct mod_ops mod_pcbeops; extern struct mod_ops mod_devfsops; extern struct mod_ops mod_kiconvops; #endif /* _KERNEL */ /* * Definitions for the module specific linkage structures. * The first two fields are the same in all of the structures. * The linkinfo is for informational purposes only and is returned by * modctl with the MODINFO cmd. */ /* For drivers */ struct modldrv { struct mod_ops *drv_modops; char *drv_linkinfo; struct dev_ops *drv_dev_ops; }; /* For system calls */ struct modlsys { struct mod_ops *sys_modops; char *sys_linkinfo; struct sysent *sys_sysent; }; /* For filesystems */ struct modlfs { struct mod_ops *fs_modops; char *fs_linkinfo; struct vfsdef_v5 *fs_vfsdef; /* version may actually vary */ }; #if defined(__i386) || defined(__amd64) struct cmi_ops; /* For CPU modules */ struct modlcpu { struct mod_ops *cpu_modops; char *cpu_linkinfo; struct cmi_ops *cpu_cmiops; }; #endif /* For cryptographic providers */ struct modlcrypto { struct mod_ops *crypto_modops; char *crypto_linkinfo; }; /* For misc */ struct modlmisc { struct mod_ops *misc_modops; char *misc_linkinfo; }; /* For IP Modules */ struct modlipp { struct mod_ops *ipp_modops; char *ipp_linkinfo; struct ipp_ops *ipp_ops; }; /* For Streams Modules. */ struct modlstrmod { struct mod_ops *strmod_modops; char *strmod_linkinfo; struct fmodsw *strmod_fmodsw; }; /* For Scheduling classes */ struct modlsched { struct mod_ops *sched_modops; char *sched_linkinfo; struct sclass *sched_class; }; /* For Exec file type (like ELF, ...) */ struct modlexec { struct mod_ops *exec_modops; char *exec_linkinfo; struct execsw *exec_execsw; }; /* For dacf modules */ struct modldacf { struct mod_ops *dacf_modops; char *dacf_linkinfo; struct dacfsw *dacf_dacfsw; }; /* For PCBE modules */ struct modlpcbe { struct mod_ops *pcbe_modops; char *pcbe_linkinfo; struct __pcbe_ops *pcbe_ops; }; /* For Brand modules */ struct modlbrand { struct mod_ops *brand_modops; char *brand_linkinfo; struct brand *brand_branddef; }; /* for devname fs */ struct modldev { struct mod_ops *dev_modops; char *dev_linkinfo; struct devname_ops *dev_ops; }; /* For kiconv modules */ struct modlkiconv { struct mod_ops *kiconv_modops; char *kiconv_linkinfo; struct kiconv_mod_info *kiconv_moddef; }; /* * Revision number of loadable modules support. This is the value * that must be used in the modlinkage structure. */ #define MODREV_1 1 /* * The modlinkage structure is the structure that the module writer * provides to the routines to install, remove, and stat a module. * The ml_linkage element is an array of pointers to linkage structures. * For most modules there is only one linkage structure. We allocate * enough space for 3 linkage structures which happens to be the most * we have in any sun supplied module. For those modules with more * than 3 linkage structures (which is very unlikely), a modlinkage * structure must be kmem_alloc'd in the module wrapper to be big enough * for all of the linkage structures. */ struct modlinkage { int ml_rev; /* rev of loadable modules system */ #ifdef _LP64 void *ml_linkage[7]; /* more space in 64-bit OS */ #else void *ml_linkage[4]; /* NULL terminated list of */ /* linkage structures */ #endif }; /* * commands. These are the commands supported by the modctl system call. */ #define MODLOAD 0 #define MODUNLOAD 1 #define MODINFO 2 #define MODRESERVED 3 #define MODSETMINIROOT 4 #define MODADDMAJBIND 5 #define MODGETPATH 6 #define MODREADSYSBIND 7 #define MODGETMAJBIND 8 #define MODGETNAME 9 #define MODSIZEOF_DEVID 10 #define MODGETDEVID 11 #define MODSIZEOF_MINORNAME 12 #define MODGETMINORNAME 13 #define MODGETPATHLEN 14 #define MODEVENTS 15 #define MODGETFBNAME 16 #define MODREREADDACF 17 #define MODLOADDRVCONF 18 #define MODUNLOADDRVCONF 19 #define MODREMMAJBIND 20 #define MODDEVT2INSTANCE 21 #define MODGETDEVFSPATH_LEN 22 #define MODGETDEVFSPATH 23 #define MODDEVID2PATHS 24 #define MODSETDEVPOLICY 26 #define MODGETDEVPOLICY 27 #define MODALLOCPRIV 28 #define MODGETDEVPOLICYBYNAME 29 #define MODLOADMINORPERM 31 #define MODADDMINORPERM 32 #define MODREMMINORPERM 33 #define MODREMDRVCLEANUP 34 #define MODDEVEXISTS 35 #define MODDEVREADDIR 36 #define MODDEVNAME 37 #define MODGETDEVFSPATH_MI_LEN 38 #define MODGETDEVFSPATH_MI 39 #define MODRETIRE 40 #define MODUNRETIRE 41 #define MODISRETIRED 42 #define MODDEVEMPTYDIR 43 /* * sub cmds for MODEVENTS */ #define MODEVENTS_FLUSH 0 #define MODEVENTS_FLUSH_DUMP 1 #define MODEVENTS_SET_DOOR_UPCALL_FILENAME 2 #define MODEVENTS_GETDATA 3 #define MODEVENTS_FREEDATA 4 #define MODEVENTS_POST_EVENT 5 #define MODEVENTS_REGISTER_EVENT 6 /* * devname subcmds for MODDEVNAME */ #define MODDEVNAME_LOOKUPDOOR 0 #define MODDEVNAME_DEVFSADMNODE 1 #define MODDEVNAME_NSMAPS 2 #define MODDEVNAME_PROFILE 3 #define MODDEVNAME_RECONFIG 4 #define MODDEVNAME_SYSAVAIL 5 /* * Data structure passed to modconfig command in kernel to build devfs tree */ struct aliases { struct aliases *a_next; char *a_name; int a_len; }; #define MAXMODCONFNAME 256 struct modconfig { char drvname[MAXMODCONFNAME]; char drvclass[MAXMODCONFNAME]; int major; int num_aliases; struct aliases *ap; }; #if defined(_SYSCALL32) struct aliases32 { caddr32_t a_next; caddr32_t a_name; int32_t a_len; }; struct modconfig32 { char drvname[MAXMODCONFNAME]; char drvclass[MAXMODCONFNAME]; int32_t major; int32_t num_aliases; caddr32_t ap; }; #endif /* _SYSCALL32 */ /* * Max module path length */ #define MOD_MAXPATH 256 /* * Default search path for modules ADDITIONAL to the directory * where the kernel components we booted from are. * * Most often, this will be "/platform/{platform}/kernel /kernel /usr/kernel", * but we don't wire it down here. */ #define MOD_DEFPATH "/kernel /usr/kernel" /* * Default file name extension for autoloading modules. */ #define MOD_DEFEXT "" /* * Parameters for modinfo */ #define MODMAXNAMELEN 32 /* max module name length */ #define MODMAXLINKINFOLEN 32 /* max link info length */ /* * Module specific information. */ struct modspecific_info { char msi_linkinfo[MODMAXLINKINFOLEN]; /* name in linkage struct */ int msi_p0; /* module specific information */ }; /* * Structure returned by modctl with MODINFO command. */ #define MODMAXLINK 10 /* max linkages modinfo can handle */ struct modinfo { int mi_info; /* Flags for info wanted */ int mi_state; /* Flags for module state */ int mi_id; /* id of this loaded module */ int mi_nextid; /* id of next module or -1 */ caddr_t mi_base; /* virtual addr of text */ size_t mi_size; /* size of module in bytes */ int mi_rev; /* loadable modules rev */ int mi_loadcnt; /* # of times loaded */ char mi_name[MODMAXNAMELEN]; /* name of module */ struct modspecific_info mi_msinfo[MODMAXLINK]; /* mod specific info */ }; #if defined(_SYSCALL32) #define MODMAXNAMELEN32 32 /* max module name length */ #define MODMAXLINKINFOLEN32 32 /* max link info length */ #define MODMAXLINK32 10 /* max linkages modinfo can handle */ struct modspecific_info32 { char msi_linkinfo[MODMAXLINKINFOLEN32]; /* name in linkage struct */ int32_t msi_p0; /* module specific information */ }; struct modinfo32 { int32_t mi_info; /* Flags for info wanted */ int32_t mi_state; /* Flags for module state */ int32_t mi_id; /* id of this loaded module */ int32_t mi_nextid; /* id of next module or -1 */ caddr32_t mi_base; /* virtual addr of text */ uint32_t mi_size; /* size of module in bytes */ int32_t mi_rev; /* loadable modules rev */ int32_t mi_loadcnt; /* # of times loaded */ char mi_name[MODMAXNAMELEN32]; /* name of module */ struct modspecific_info32 mi_msinfo[MODMAXLINK32]; /* mod specific info */ }; #endif /* _SYSCALL32 */ /* Values for mi_info flags */ #define MI_INFO_ONE 1 #define MI_INFO_ALL 2 #define MI_INFO_CNT 4 #ifdef _KERNEL #define MI_INFO_LINKAGE 8 /* used internally to extract modlinkage */ #endif /* * MI_INFO_NOBASE indicates caller does not need mi_base. Failure to use this * flag may lead 32-bit apps to receive an EOVERFLOW error from modctl(MODINFO) * when used with a 64-bit kernel. */ #define MI_INFO_NOBASE 16 /* Values for mi_state */ #define MI_LOADED 1 #define MI_INSTALLED 2 /* * Macros to vector to the appropriate module specific routine. */ #define MODL_INSTALL(MODL, MODLP) \ (*(MODL)->misc_modops->modm_install)(MODL, MODLP) #define MODL_REMOVE(MODL, MODLP) \ (*(MODL)->misc_modops->modm_remove)(MODL, MODLP) #define MODL_INFO(MODL, MODLP, P0) \ (*(MODL)->misc_modops->modm_info)(MODL, MODLP, P0) /* * Definitions for stubs */ struct mod_stub_info { uintptr_t mods_func_adr; struct mod_modinfo *mods_modinfo; uintptr_t mods_stub_adr; int (*mods_errfcn)(); int mods_flag; /* flags defined below */ }; /* * Definitions for mods_flag. */ #define MODS_WEAK 0x01 /* weak stub (not loaded if called) */ #define MODS_NOUNLOAD 0x02 /* module not unloadable (no _fini()) */ #define MODS_INSTALLED 0x10 /* module installed */ struct mod_modinfo { char *modm_module_name; struct modctl *mp; struct mod_stub_info modm_stubs[1]; }; struct modctl_list { struct modctl_list *modl_next; struct modctl *modl_modp; }; /* * Structure to manage a loadable module. * Note: the module (mod_mp) structure's "text" and "text_size" information * are replicated in the modctl structure so that mod_containing_pc() * doesn't have to grab any locks (modctls are persistent; modules are not.) */ typedef struct modctl { struct modctl *mod_next; /* &modules based list */ struct modctl *mod_prev; int mod_id; void *mod_mp; kthread_t *mod_inprogress_thread; struct mod_modinfo *mod_modinfo; struct modlinkage *mod_linkage; char *mod_filename; char *mod_modname; char mod_busy; /* inprogress_thread has locked */ char mod_want; /* someone waiting for unlock */ char mod_prim; /* primary module */ int mod_ref; /* ref count - from dependent or stub */ char mod_loaded; /* module in memory */ char mod_installed; /* post _init pre _fini */ char mod_loadflags; char mod_delay_unload; /* deferred unload */ struct modctl_list *mod_requisites; /* mods this one depends on. */ void *__unused; /* NOTE: reuse (same size) is OK, */ /* deletion causes mdb.vs.core issues */ int mod_loadcnt; /* number of times mod was loaded */ int mod_nenabled; /* # of enabled DTrace probes in mod */ char *mod_text; size_t mod_text_size; int mod_gencount; /* # times loaded/unloaded */ struct modctl *mod_requisite_loading; /* mod circular dependency */ } modctl_t; /* * mod_loadflags */ #define MOD_NOAUTOUNLOAD 0x1 /* Auto mod-unloader skips this mod */ #define MOD_NONOTIFY 0x2 /* No krtld notifications on (un)load */ #define MOD_NOUNLOAD 0x4 /* Assume EBUSY for all _fini's */ #ifdef _KERNEL #define MOD_BIND_HASHSIZE 64 #define MOD_BIND_HASHMASK (MOD_BIND_HASHSIZE-1) typedef int modid_t; /* * global function and data declarations */ extern kmutex_t mod_lock; extern char *systemfile; extern char **syscallnames; extern int moddebug; /* * this is the head of a doubly linked list. Only the next and prev * pointers are used */ extern modctl_t modules; extern int modload_qualified(const char *, const char *, const char *, const char *, uint_t[], int, int *); extern void mod_setup(void); extern int modload(const char *, const char *); extern int modloadonly(const char *, const char *); extern int modunload(int); extern int mod_hold_stub(struct mod_stub_info *); extern void modunload_disable(void); extern void modunload_enable(void); extern void modunload_begin(void); extern void modunload_end(void); extern int mod_remove_by_name(char *); extern int mod_sysvar(const char *, const char *, u_longlong_t *); extern int mod_sysctl(int, void *); struct sysparam; extern int mod_hold_by_modctl(modctl_t *, int); #define MOD_WAIT_ONCE 0x01 #define MOD_WAIT_FOREVER 0x02 #define MOD_LOCK_HELD 0x04 #define MOD_LOCK_NOT_HELD 0x08 extern int mod_sysctl_type(int, int (*)(struct sysparam *, void *), void *); extern void mod_read_system_file(int); extern void mod_release_stub(struct mod_stub_info *); extern void mod_askparams(void); extern void mod_uninstall_daemon(void); extern void modreap(void); extern modctl_t *mod_hold_by_id(modid_t); extern modctl_t *mod_hold_by_name(const char *); extern void mod_release_mod(modctl_t *); extern uintptr_t modlookup(const char *, const char *); extern uintptr_t modlookup_by_modctl(modctl_t *, const char *); extern char *modgetsymname(uintptr_t, unsigned long *); extern void mod_release_requisites(modctl_t *); extern modctl_t *mod_load_requisite(modctl_t *, char *); extern modctl_t *mod_find_by_filename(char *, char *); extern uintptr_t modgetsymvalue(char *, int); extern void mod_rele_dev_by_major(major_t); extern struct dev_ops *mod_hold_dev_by_major(major_t); extern struct dev_ops *mod_hold_dev_by_devi(dev_info_t *); extern void mod_rele_dev_by_devi(dev_info_t *); extern int make_devname(char *, major_t); extern int gmatch(const char *, const char *); struct bind; extern void make_aliases(struct bind **); extern int read_binding_file(char *, struct bind **, int (*line_parser)(char *, int, char *, struct bind **)); extern void clear_binding_hash(struct bind **); extern void read_class_file(void); extern void setbootpath(char *); extern void setbootfstype(char *); extern int install_stubs_by_name(modctl_t *, char *); extern void install_stubs(modctl_t *); extern void uninstall_stubs(modctl_t *); extern void reset_stubs(modctl_t *); extern modctl_t *mod_getctl(struct modlinkage *); extern major_t mod_name_to_major(char *); extern modid_t mod_name_to_modid(char *); extern char *mod_major_to_name(major_t); extern void init_devnamesp(int); extern void init_syscallnames(int); extern char *mod_getsysname(int); extern int mod_getsysnum(char *); extern char *mod_containing_pc(caddr_t); extern int mod_in_autounload(void); extern const char *mod_modname(struct modlinkage *); extern int dev_minorperm(dev_info_t *, char *, mperm_t *); extern void dev_devices_cleanup(void); /* * Declarations used for dynamic linking support routines. Interfaces * are marked with the pragma "unknown_control_flow" to prevent tail call * optimization, so that implementations can reliably use caller() to * determine initiating module. */ #define KRTLD_MODE_FIRST 0x0001 typedef struct __ddi_modhandle *ddi_modhandle_t; extern ddi_modhandle_t ddi_modopen(const char *, int, int *); extern void *ddi_modsym(ddi_modhandle_t, const char *, int *); extern int ddi_modclose(ddi_modhandle_t); #pragma unknown_control_flow(ddi_modopen, ddi_modsym, ddi_modclose) /* * Only the following are part of the DDI/DKI */ extern int _init(void); extern int _fini(void); extern int _info(struct modinfo *); extern int mod_install(struct modlinkage *); extern int mod_remove(struct modlinkage *); extern int mod_info(struct modlinkage *, struct modinfo *); #else /* _KERNEL */ extern int modctl(int, ...); #endif /* _KERNEL */ /* * bit definitions for moddebug. */ #define MODDEBUG_LOADMSG 0x80000000 /* print "[un]loading..." msg */ #define MODDEBUG_ERRMSG 0x40000000 /* print detailed error msgs */ #define MODDEBUG_LOADMSG2 0x20000000 /* print 2nd level msgs */ #define MODDEBUG_RETIRE 0x10000000 /* print retire msgs */ #define MODDEBUG_FINI_EBUSY 0x00020000 /* pretend fini returns EBUSY */ #define MODDEBUG_NOAUL_IPP 0x00010000 /* no Autounloading ipp mods */ #define MODDEBUG_NOAUL_DACF 0x00008000 /* no Autounloading dacf mods */ #define MODDEBUG_KEEPTEXT 0x00004000 /* keep text after unloading */ #define MODDEBUG_NOAUL_DRV 0x00001000 /* no Autounloading Drivers */ #define MODDEBUG_NOAUL_EXEC 0x00000800 /* no Autounloading Execs */ #define MODDEBUG_NOAUL_FS 0x00000400 /* no Autounloading File sys */ #define MODDEBUG_NOAUL_MISC 0x00000200 /* no Autounloading misc */ #define MODDEBUG_NOAUL_SCHED 0x00000100 /* no Autounloading scheds */ #define MODDEBUG_NOAUL_STR 0x00000080 /* no Autounloading streams */ #define MODDEBUG_NOAUL_SYS 0x00000040 /* no Autounloading syscalls */ #define MODDEBUG_NOCTF 0x00000020 /* do not load CTF debug data */ #define MODDEBUG_NOAUTOUNLOAD 0x00000010 /* no autounloading at all */ #define MODDEBUG_DDI_MOD 0x00000008 /* ddi_mod{open,sym,close} */ #define MODDEBUG_MP_MATCH 0x00000004 /* dev_minorperm */ #define MODDEBUG_MINORPERM 0x00000002 /* minor perm modctls */ #define MODDEBUG_USERDEBUG 0x00000001 /* bpt after init_module() */ #ifdef __cplusplus } #endif #endif /* _SYS_MODCTL_H */