docs/how-to-build.md: use proper markup for directory names
[unleashed/tickless.git] / include / sys / modctl.h
blob391768d5a515e73e0762e434724bc60836643963
1 /*
2 * CDDL HEADER START
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
19 * CDDL HEADER END
22 * Copyright (c) 1990, 2010, Oracle and/or its affiliates. All rights reserved.
25 #ifndef _SYS_MODCTL_H
26 #define _SYS_MODCTL_H
29 * loadable module support.
32 #include <sys/types.h>
33 #include <sys/ioccom.h>
34 #include <sys/nexusdefs.h>
35 #include <sys/thread.h>
36 #include <sys/t_lock.h>
37 #include <sys/dditypes.h>
38 #include <sys/hwconf.h>
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
45 * The following structure defines the operations used by modctl
46 * to load and unload modules. Each supported loadable module type
47 * requires a set of mod_ops.
49 struct mod_ops {
50 int (*modm_install)(); /* install module in kernel */
51 int (*modm_remove)(); /* remove from kernel */
52 int (*modm_info)(); /* module info */
55 #ifdef _KERNEL
58 * The defined set of mod_ops structures for each loadable module type
59 * Defined in modctl.c
61 extern struct mod_ops mod_brandops;
62 #if defined(__i386) || defined(__amd64)
63 extern struct mod_ops mod_cpuops;
64 #endif
65 extern struct mod_ops mod_cryptoops;
66 extern struct mod_ops mod_driverops;
67 extern struct mod_ops mod_execops;
68 extern struct mod_ops mod_fsops;
69 extern struct mod_ops mod_miscops;
70 extern struct mod_ops mod_schedops;
71 extern struct mod_ops mod_strmodops;
72 extern struct mod_ops mod_syscallops;
73 extern struct mod_ops mod_sockmodops;
74 #ifdef _SYSCALL32_IMPL
75 extern struct mod_ops mod_syscallops32;
76 #endif
77 extern struct mod_ops mod_dacfops;
78 extern struct mod_ops mod_ippops;
79 extern struct mod_ops mod_pcbeops;
80 extern struct mod_ops mod_kiconvops;
82 #endif /* _KERNEL */
85 * Definitions for the module specific linkage structures.
86 * The first two fields are the same in all of the structures.
87 * The linkinfo is for informational purposes only and is returned by
88 * modctl with the MODINFO cmd.
91 /* For drivers */
92 struct modldrv {
93 struct mod_ops *drv_modops;
94 char *drv_linkinfo;
95 struct dev_ops *drv_dev_ops;
98 /* For system calls */
99 struct modlsys {
100 struct mod_ops *sys_modops;
101 char *sys_linkinfo;
102 struct sysent *sys_sysent;
105 /* For filesystems */
106 struct modlfs {
107 struct mod_ops *fs_modops;
108 char *fs_linkinfo;
109 struct vfsdef_v5 *fs_vfsdef; /* version may actually vary */
112 #if defined(__i386) || defined(__amd64)
113 struct cmi_ops;
115 /* For CPU modules */
116 struct modlcpu {
117 struct mod_ops *cpu_modops;
118 char *cpu_linkinfo;
119 struct cmi_ops *cpu_cmiops;
121 #endif
123 /* For cryptographic providers */
124 struct modlcrypto {
125 struct mod_ops *crypto_modops;
126 char *crypto_linkinfo;
129 /* For misc */
130 struct modlmisc {
131 struct mod_ops *misc_modops;
132 char *misc_linkinfo;
135 /* For IP Modules */
136 struct modlipp {
137 struct mod_ops *ipp_modops;
138 char *ipp_linkinfo;
139 struct ipp_ops *ipp_ops;
142 /* For Streams Modules. */
143 struct modlstrmod {
144 struct mod_ops *strmod_modops;
145 char *strmod_linkinfo;
146 struct fmodsw *strmod_fmodsw;
149 /* For Scheduling classes */
150 struct modlsched {
151 struct mod_ops *sched_modops;
152 char *sched_linkinfo;
153 struct sclass *sched_class;
156 /* For Exec file type (like ELF, ...) */
157 struct modlexec {
158 struct mod_ops *exec_modops;
159 char *exec_linkinfo;
160 struct execsw *exec_execsw;
163 /* For dacf modules */
164 struct modldacf {
165 struct mod_ops *dacf_modops;
166 char *dacf_linkinfo;
167 struct dacfsw *dacf_dacfsw;
170 /* For PCBE modules */
171 struct modlpcbe {
172 struct mod_ops *pcbe_modops;
173 char *pcbe_linkinfo;
174 struct __pcbe_ops *pcbe_ops;
177 /* For Brand modules */
178 struct modlbrand {
179 struct mod_ops *brand_modops;
180 char *brand_linkinfo;
181 struct brand *brand_branddef;
184 /* For socket Modules. */
185 struct modlsockmod {
186 struct mod_ops *sockmod_modops;
187 char *sockmod_linkinfo;
188 struct smod_reg_s *sockmod_reg_info;
191 /* For kiconv modules */
192 struct modlkiconv {
193 struct mod_ops *kiconv_modops;
194 char *kiconv_linkinfo;
195 struct kiconv_mod_info *kiconv_moddef;
199 * Revision number of loadable modules support. This is the value
200 * that must be used in the modlinkage structure.
202 #define MODREV_1 1
205 * The modlinkage structure is the structure that the module writer
206 * provides to the routines to install, remove, and stat a module.
207 * The ml_linkage element is an array of pointers to linkage structures.
208 * For most modules there is only one linkage structure. We allocate
209 * enough space for 3 linkage structures which happens to be the most
210 * we have in any sun supplied module. For those modules with more
211 * than 3 linkage structures (which is very unlikely), a modlinkage
212 * structure must be kmem_alloc'd in the module wrapper to be big enough
213 * for all of the linkage structures.
215 struct modlinkage {
216 int ml_rev; /* rev of loadable modules system */
217 #ifdef _LP64
218 void *ml_linkage[7]; /* more space in 64-bit OS */
219 #else
220 void *ml_linkage[4]; /* NULL terminated list of */
221 /* linkage structures */
222 #endif
226 * commands. These are the commands supported by the modctl system call.
228 #define MODLOAD 0
229 #define MODUNLOAD 1
230 #define MODINFO 2
231 #define MODRESERVED 3
232 #define MODSETMINIROOT 4
233 #define MODADDMAJBIND 5
234 #define MODGETPATH 6
235 #define MODREADSYSBIND 7
236 #define MODGETMAJBIND 8
237 #define MODGETNAME 9
238 #define MODSIZEOF_DEVID 10
239 #define MODGETDEVID 11
240 #define MODSIZEOF_MINORNAME 12
241 #define MODGETMINORNAME 13
242 #define MODGETPATHLEN 14
243 #define MODEVENTS 15
244 #define MODGETFBNAME 16
245 #define MODREREADDACF 17
246 #define MODLOADDRVCONF 18
247 #define MODUNLOADDRVCONF 19
248 #define MODREMMAJBIND 20
249 #define MODDEVT2INSTANCE 21
250 #define MODGETDEVFSPATH_LEN 22
251 #define MODGETDEVFSPATH 23
252 #define MODDEVID2PATHS 24
253 #define MODSETDEVPOLICY 26
254 #define MODGETDEVPOLICY 27
255 #define MODALLOCPRIV 28
256 #define MODGETDEVPOLICYBYNAME 29
257 #define MODLOADMINORPERM 31
258 #define MODADDMINORPERM 32
259 #define MODREMMINORPERM 33
260 #define MODREMDRVCLEANUP 34
261 #define MODDEVEXISTS 35
262 #define MODDEVREADDIR 36
263 #define MODDEVNAME 37
264 #define MODGETDEVFSPATH_MI_LEN 38
265 #define MODGETDEVFSPATH_MI 39
266 #define MODRETIRE 40
267 #define MODUNRETIRE 41
268 #define MODISRETIRED 42
269 #define MODDEVEMPTYDIR 43
270 #define MODREMDRVALIAS 44
271 #define MODHPOPS 45
274 * sub cmds for MODEVENTS
276 #define MODEVENTS_FLUSH 0
277 #define MODEVENTS_FLUSH_DUMP 1
278 #define MODEVENTS_SET_DOOR_UPCALL_FILENAME 2
279 #define MODEVENTS_GETDATA 3
280 #define MODEVENTS_FREEDATA 4
281 #define MODEVENTS_POST_EVENT 5
282 #define MODEVENTS_REGISTER_EVENT 6
285 * devname subcmds for MODDEVNAME
287 #define MODDEVNAME_LOOKUPDOOR 0
288 #define MODDEVNAME_PROFILE 3
289 #define MODDEVNAME_RECONFIG 4
290 #define MODDEVNAME_SYSAVAIL 5
293 * subcmds for MODHPOPS
295 #define MODHPOPS_CHANGE_STATE 0
296 #define MODHPOPS_CREATE_PORT 1
297 #define MODHPOPS_REMOVE_PORT 2
298 #define MODHPOPS_BUS_GET 3
299 #define MODHPOPS_BUS_SET 4
303 * Data structure passed to modconfig command in kernel to build devfs tree
306 struct aliases {
307 struct aliases *a_next;
308 char *a_name;
309 int a_len;
312 #define MAXMODCONFNAME 256
314 struct modconfig {
315 char drvname[MAXMODCONFNAME];
316 char drvclass[MAXMODCONFNAME];
317 int major;
318 int flags;
319 int num_aliases;
320 struct aliases *ap;
323 #if defined(_SYSCALL32)
325 struct aliases32 {
326 caddr32_t a_next;
327 caddr32_t a_name;
328 int32_t a_len;
331 struct modconfig32 {
332 char drvname[MAXMODCONFNAME];
333 char drvclass[MAXMODCONFNAME];
334 int32_t major;
335 int32_t flags;
336 int32_t num_aliases;
337 caddr32_t ap;
340 #endif /* _SYSCALL32 */
342 /* flags for modconfig */
343 #define MOD_UNBIND_OVERRIDE 0x01 /* fail unbind if in use */
344 #define MOD_ADDMAJBIND_UPDATE 0x02 /* update only, do not load */
346 /* flags for MODLOADDRVCONF - modctl_load_drvconf() */
347 #define MOD_LOADDRVCONF_RECONF 0x01 /* complete configuration */
348 /* after update-only */
351 * Max module path length
353 #define MOD_MAXPATH 256
356 * Default search path for modules ADDITIONAL to the directory
357 * where the kernel components we booted from are.
359 * Most often, this will be "/platform/{platform}/kernel /kernel /usr/kernel",
360 * but we don't wire it down here.
362 #define MOD_DEFPATH "/kernel /usr/kernel"
365 * Default file name extension for autoloading modules.
367 #define MOD_DEFEXT ""
370 * Parameters for modinfo
372 #define MODMAXNAMELEN 32 /* max module name length */
373 #define MODMAXLINKINFOLEN 32 /* max link info length */
376 * Module specific information.
378 struct modspecific_info {
379 char msi_linkinfo[MODMAXLINKINFOLEN]; /* name in linkage struct */
380 int msi_p0; /* module specific information */
384 * Structure returned by modctl with MODINFO command.
386 #define MODMAXLINK 10 /* max linkages modinfo can handle */
388 struct modinfo {
389 int mi_info; /* Flags for info wanted */
390 int mi_state; /* Flags for module state */
391 int mi_id; /* id of this loaded module */
392 int mi_nextid; /* id of next module or -1 */
393 caddr_t mi_base; /* virtual addr of text */
394 size_t mi_size; /* size of module in bytes */
395 int mi_rev; /* loadable modules rev */
396 int mi_loadcnt; /* # of times loaded */
397 char mi_name[MODMAXNAMELEN]; /* name of module */
398 struct modspecific_info mi_msinfo[MODMAXLINK];
399 /* mod specific info */
403 #if defined(_SYSCALL32)
405 #define MODMAXNAMELEN32 32 /* max module name length */
406 #define MODMAXLINKINFOLEN32 32 /* max link info length */
407 #define MODMAXLINK32 10 /* max linkages modinfo can handle */
409 struct modspecific_info32 {
410 char msi_linkinfo[MODMAXLINKINFOLEN32]; /* name in linkage struct */
411 int32_t msi_p0; /* module specific information */
414 struct modinfo32 {
415 int32_t mi_info; /* Flags for info wanted */
416 int32_t mi_state; /* Flags for module state */
417 int32_t mi_id; /* id of this loaded module */
418 int32_t mi_nextid; /* id of next module or -1 */
419 caddr32_t mi_base; /* virtual addr of text */
420 uint32_t mi_size; /* size of module in bytes */
421 int32_t mi_rev; /* loadable modules rev */
422 int32_t mi_loadcnt; /* # of times loaded */
423 char mi_name[MODMAXNAMELEN32]; /* name of module */
424 struct modspecific_info32 mi_msinfo[MODMAXLINK32];
425 /* mod specific info */
428 #endif /* _SYSCALL32 */
430 /* Values for mi_info flags */
431 #define MI_INFO_ONE 1
432 #define MI_INFO_ALL 2
433 #define MI_INFO_CNT 4
434 #ifdef _KERNEL
435 #define MI_INFO_LINKAGE 8 /* used internally to extract modlinkage */
436 #endif
438 * MI_INFO_NOBASE indicates caller does not need mi_base. Failure to use this
439 * flag may lead 32-bit apps to receive an EOVERFLOW error from modctl(MODINFO)
440 * when used with a 64-bit kernel.
442 #define MI_INFO_NOBASE 16
444 /* Values for mi_state */
445 #define MI_LOADED 1
446 #define MI_INSTALLED 2
449 * Macros to vector to the appropriate module specific routine.
451 #define MODL_INSTALL(MODL, MODLP) \
452 (*(MODL)->misc_modops->modm_install)(MODL, MODLP)
453 #define MODL_REMOVE(MODL, MODLP) \
454 (*(MODL)->misc_modops->modm_remove)(MODL, MODLP)
455 #define MODL_INFO(MODL, MODLP, P0) \
456 (*(MODL)->misc_modops->modm_info)(MODL, MODLP, P0)
459 * Definitions for stubs
461 struct mod_stub_info {
462 uintptr_t mods_func_adr;
463 struct mod_modinfo *mods_modinfo;
464 uintptr_t mods_stub_adr;
465 int (*mods_errfcn)();
466 int mods_flag; /* flags defined below */
470 * Definitions for mods_flag.
472 #define MODS_WEAK 0x01 /* weak stub (not loaded if called) */
473 #define MODS_NOUNLOAD 0x02 /* module not unloadable (no _fini()) */
474 #define MODS_INSTALLED 0x10 /* module installed */
476 struct mod_modinfo {
477 char *modm_module_name;
478 struct modctl *mp;
479 struct mod_stub_info modm_stubs[1];
482 struct modctl_list {
483 struct modctl_list *modl_next;
484 struct modctl *modl_modp;
488 * Structure to manage a loadable module.
489 * Note: the module (mod_mp) structure's "text" and "text_size" information
490 * are replicated in the modctl structure so that mod_containing_pc()
491 * doesn't have to grab any locks (modctls are persistent; modules are not.)
493 typedef struct modctl {
494 struct modctl *mod_next; /* &modules based list */
495 struct modctl *mod_prev;
496 int mod_id;
497 void *mod_mp;
498 kthread_t *mod_inprogress_thread;
499 struct mod_modinfo *mod_modinfo;
500 struct modlinkage *mod_linkage;
501 char *mod_filename;
502 char *mod_modname;
504 char mod_busy; /* inprogress_thread has locked */
505 char mod_want; /* someone waiting for unlock */
506 char mod_prim; /* primary module */
508 int mod_ref; /* ref count - from dependent or stub */
510 char mod_loaded; /* module in memory */
511 char mod_installed; /* post _init pre _fini */
512 char mod_loadflags;
513 char mod_delay_unload; /* deferred unload */
515 struct modctl_list *mod_requisites; /* mods this one depends on. */
516 void *__unused; /* NOTE: reuse (same size) is OK, */
517 /* deletion causes mdb.vs.core issues */
518 int mod_loadcnt; /* number of times mod was loaded */
519 int mod_nenabled; /* # of enabled DTrace probes in mod */
520 char *mod_text;
521 size_t mod_text_size;
523 int mod_gencount; /* # times loaded/unloaded */
524 struct modctl *mod_requisite_loading; /* mod circular dependency */
525 } modctl_t;
528 * mod_loadflags
531 #define MOD_NOAUTOUNLOAD 0x1 /* Auto mod-unloader skips this mod */
532 #define MOD_NONOTIFY 0x2 /* No krtld notifications on (un)load */
533 #define MOD_NOUNLOAD 0x4 /* Assume EBUSY for all _fini's */
536 #ifdef _KERNEL
538 #define MOD_BIND_HASHSIZE 64
539 #define MOD_BIND_HASHMASK (MOD_BIND_HASHSIZE-1)
541 typedef int modid_t;
544 * global function and data declarations
546 extern kmutex_t mod_lock;
548 extern char *systemfile;
549 extern char **syscallnames;
550 extern int moddebug;
553 * this is the head of a doubly linked list. Only the next and prev
554 * pointers are used
556 extern modctl_t modules;
558 extern int modload_qualified(const char *,
559 const char *, const char *, const char *, uint_t[], int, int *);
561 extern void mod_setup(void);
562 extern int modload(const char *, const char *);
563 extern int modloadonly(const char *, const char *);
564 extern int modunload(int);
565 extern int mod_hold_stub(struct mod_stub_info *);
566 extern void modunload_disable(void);
567 extern void modunload_enable(void);
568 extern void modunload_begin(void);
569 extern void modunload_end(void);
570 extern int mod_remove_by_name(char *);
571 extern int mod_sysvar(const char *, const char *, u_longlong_t *);
572 extern int mod_sysctl(int, void *);
573 struct sysparam;
574 extern int mod_hold_by_modctl(modctl_t *, int);
575 #define MOD_WAIT_ONCE 0x01
576 #define MOD_WAIT_FOREVER 0x02
577 #define MOD_LOCK_HELD 0x04
578 #define MOD_LOCK_NOT_HELD 0x08
579 extern int mod_sysctl_type(int, int (*)(struct sysparam *, void *),
580 void *);
581 extern void mod_read_system_file(int);
582 extern void mod_release_stub(struct mod_stub_info *);
583 extern void mod_askparams(void);
584 extern void mod_uninstall_daemon(void);
585 extern void modreap(void);
586 extern modctl_t *mod_hold_by_id(modid_t);
587 extern modctl_t *mod_hold_by_name(const char *);
588 extern void mod_release_mod(modctl_t *);
589 extern uintptr_t modlookup(const char *, const char *);
590 extern uintptr_t modlookup_by_modctl(modctl_t *, const char *);
591 extern char *modgetsymname(uintptr_t, unsigned long *);
592 extern void mod_release_requisites(modctl_t *);
593 extern modctl_t *mod_load_requisite(modctl_t *, char *);
594 extern modctl_t *mod_find_by_filename(char *, char *);
595 extern uintptr_t modgetsymvalue(char *, int);
597 extern int major_valid(major_t);
598 extern int driver_installed(major_t);
599 extern int driver_active(major_t);
601 extern void mod_rele_dev_by_major(major_t);
602 extern struct dev_ops *mod_hold_dev_by_major(major_t);
603 extern struct dev_ops *mod_hold_dev_by_devi(dev_info_t *);
604 extern void mod_rele_dev_by_devi(dev_info_t *);
606 extern int make_devname(char *, major_t, int);
607 extern int gmatch(const char *, const char *);
609 extern void make_aliases(struct bind **);
610 extern int read_binding_file(char *, struct bind **,
611 int (*line_parser)(char *, int, char *, struct bind **));
612 extern void clear_binding_hash(struct bind **);
614 extern void read_class_file(void);
615 extern void setbootpath(char *);
616 extern void setbootfstype(char *);
618 extern int install_stubs_by_name(modctl_t *, char *);
619 extern void install_stubs(modctl_t *);
620 extern void uninstall_stubs(modctl_t *);
621 extern void reset_stubs(modctl_t *);
622 extern modctl_t *mod_getctl(struct modlinkage *);
623 extern major_t mod_name_to_major(char *);
624 extern modid_t mod_name_to_modid(char *);
625 extern char *mod_major_to_name(major_t);
626 extern void init_devnamesp(int);
627 extern void init_syscallnames(int);
629 extern char *mod_getsysname(int);
630 extern int mod_getsysnum(char *);
632 extern char *mod_containing_pc(caddr_t);
633 extern int mod_in_autounload(void);
634 extern const char *mod_modname(struct modlinkage *);
636 extern int dev_minorperm(dev_info_t *, char *, mperm_t *);
637 extern void dev_devices_cleanup(void);
640 * Declarations used for dynamic linking support routines. Interfaces
641 * are marked with the pragma "unknown_control_flow" to prevent tail call
642 * optimization, so that implementations can reliably use caller() to
643 * determine initiating module.
645 #define KRTLD_MODE_FIRST 0x0001
646 typedef struct __ddi_modhandle *ddi_modhandle_t;
647 extern ddi_modhandle_t ddi_modopen(const char *,
648 int, int *);
649 extern void *ddi_modsym(ddi_modhandle_t,
650 const char *, int *);
651 extern int ddi_modclose(ddi_modhandle_t);
652 #pragma unknown_control_flow(ddi_modopen, ddi_modsym, ddi_modclose)
655 * Only the following are part of the DDI/DKI
657 extern int _init(void);
658 extern int _fini(void);
659 extern int _info(struct modinfo *);
660 extern int mod_install(struct modlinkage *);
661 extern int mod_remove(struct modlinkage *);
662 extern int mod_info(struct modlinkage *, struct modinfo *);
664 #else /* _KERNEL */
666 extern int modctl(int, ...);
668 #endif /* _KERNEL */
671 * bit definitions for moddebug.
673 #define MODDEBUG_LOADMSG 0x80000000 /* print "[un]loading..." msg */
674 #define MODDEBUG_ERRMSG 0x40000000 /* print detailed error msgs */
675 #define MODDEBUG_LOADMSG2 0x20000000 /* print 2nd level msgs */
676 #define MODDEBUG_RETIRE 0x10000000 /* print retire msgs */
677 #define MODDEBUG_BINDING 0x00040000 /* driver/alias binding */
678 #define MODDEBUG_FINI_EBUSY 0x00020000 /* pretend fini returns EBUSY */
679 #define MODDEBUG_NOAUL_IPP 0x00010000 /* no Autounloading ipp mods */
680 #define MODDEBUG_NOAUL_DACF 0x00008000 /* no Autounloading dacf mods */
681 #define MODDEBUG_KEEPTEXT 0x00004000 /* keep text after unloading */
682 #define MODDEBUG_NOAUL_DRV 0x00001000 /* no Autounloading Drivers */
683 #define MODDEBUG_NOAUL_EXEC 0x00000800 /* no Autounloading Execs */
684 #define MODDEBUG_NOAUL_FS 0x00000400 /* no Autounloading File sys */
685 #define MODDEBUG_NOAUL_MISC 0x00000200 /* no Autounloading misc */
686 #define MODDEBUG_NOAUL_SCHED 0x00000100 /* no Autounloading scheds */
687 #define MODDEBUG_NOAUL_STR 0x00000080 /* no Autounloading streams */
688 #define MODDEBUG_NOAUL_SYS 0x00000040 /* no Autounloading syscalls */
689 #define MODDEBUG_NOCTF 0x00000020 /* do not load CTF debug data */
690 #define MODDEBUG_NOAUTOUNLOAD 0x00000010 /* no autounloading at all */
691 #define MODDEBUG_DDI_MOD 0x00000008 /* ddi_mod{open,sym,close} */
692 #define MODDEBUG_MP_MATCH 0x00000004 /* dev_minorperm */
693 #define MODDEBUG_MINORPERM 0x00000002 /* minor perm modctls */
694 #define MODDEBUG_USERDEBUG 0x00000001 /* bpt after init_module() */
696 #ifdef __cplusplus
698 #endif
700 #endif /* _SYS_MODCTL_H */