xref: /freebsd/lib/libutil/kld.3 (revision 6b129086dcee14496517fae085b448e3edc69bc7)
1.\"-
2.\" Copyright (c) 2006 Dag-Erling Coïdan Smørgrav
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd February 18, 2006
29.Dt KLD 3
30.Os
31.Sh NAME
32.Nm kld_isloaded ,
33.Nm kld_load
34.Nd kld utility functions
35.Sh LIBRARY
36.Lb libutil
37.Sh SYNOPSIS
38.In libutil.h
39.Ft int
40.Fn kld_isloaded "const char *name"
41.Ft int
42.Fn kld_load "const char *name"
43.Sh DESCRIPTION
44These functions facilitate loading kernel modules from userland
45applications.
46.Pp
47The
48.Fn kld_isloaded
49function takes a name and returns a non-zero value if a module of that
50name is currently loaded.
51The name can be either the name of a module file
52.Pq Pa cpufreq.ko ,
53the same name without the
54.Pa .ko
55extension
56.Pq Pa cpufreq ,
57or the name of a module contained within that file
58.Pq Pa cpu/ichss .
59Only the latter will return correct results if the module is compiled
60into the kernel.
61.Pp
62The
63.Fn kld_load
64function is a simple wrapper around the
65.Xr kldload 2
66function.
67It returns zero if and only if the corresponding
68.Fn kldload
69call succeeded or returned
70.Er EEXIST
71(signifying that the requested module was already loaded).
72.Sh SEE ALSO
73.Xr kldfirstmod 2 ,
74.Xr kldload 2 ,
75.Xr kldnext 2 ,
76.Xr kldstat 2 ,
77.Xr modfnext 2 ,
78.Xr modstat 2 ,
79.Xr kld 4
80.Sh HISTORY
81The
82.Fn kld_isloaded
83and
84.Fn kld_load
85functions first appeared in
86.Fx 6.3 .
87.Sh AUTHORS
88The
89.Fn kld_isloaded
90and
91.Fn kld_load
92functions and this manual page were written by
93.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
94