xref: /freebsd/lib/libutil/kld.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"-
2.\" Copyright (c) 2006 Dag-Erling 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.Dd February 18, 2006
27.Dt KLD 3
28.Os
29.Sh NAME
30.Nm kld_isloaded ,
31.Nm kld_load
32.Nd kld utility functions
33.Sh LIBRARY
34.Lb libutil
35.Sh SYNOPSIS
36.In libutil.h
37.Ft int
38.Fn kld_isloaded "const char *name"
39.Ft int
40.Fn kld_load "const char *name"
41.Sh DESCRIPTION
42These functions facilitate loading kernel modules from userland
43applications.
44.Pp
45The
46.Fn kld_isloaded
47function takes a name and returns a non-zero value if a module of that
48name is currently loaded.
49The name can be either the name of a module file
50.Pq Pa cpufreq.ko ,
51the same name without the
52.Pa .ko
53extension
54.Pq Pa cpufreq ,
55or the name of a module contained within that file
56.Pq Pa cpu/ichss .
57Only the latter will return correct results if the module is compiled
58into the kernel.
59.Pp
60The
61.Fn kld_load
62function is a simple wrapper around the
63.Xr kldload 2
64function.
65It returns zero if and only if the corresponding
66.Fn kldload
67call succeeded or returned
68.Er EEXIST
69(signifying that the requested module was already loaded).
70.Sh SEE ALSO
71.Xr kldfirstmod 2 ,
72.Xr kldload 2 ,
73.Xr kldnext 2 ,
74.Xr kldstat 2 ,
75.Xr modfnext 2 ,
76.Xr modstat 2 ,
77.Xr kld 4
78.Sh HISTORY
79The
80.Fn kld_isloaded
81and
82.Fn kld_load
83functions first appeared in
84.Fx 6.3 .
85.Sh AUTHORS
86The
87.Fn kld_isloaded
88and
89.Fn kld_load
90functions and this manual page were written by
91.An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
92