xref: /dflybsd-src/lib/libc/sys/kldload.2 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\"
286d7f5d3SJohn Marino.\" Copyright (c) 1999 Chris Costello
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
686d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
786d7f5d3SJohn Marino.\" are met:
886d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
986d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1086d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1286d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1386d7f5d3SJohn Marino.\"
1486d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1586d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1686d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1786d7f5d3SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1886d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1986d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2086d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2186d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2286d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2386d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2486d7f5d3SJohn Marino.\" SUCH DAMAGE.
2586d7f5d3SJohn Marino.\"
2686d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/sys/kldload.2,v 1.5.2.7 2001/12/14 18:34:01 ru Exp $
2786d7f5d3SJohn Marino.\" $DragonFly: src/lib/libc/sys/kldload.2,v 1.3 2004/03/08 12:46:12 hmp Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd March 3, 1999
3086d7f5d3SJohn Marino.Dt KLDLOAD 2
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm kldload
3486d7f5d3SJohn Marino.Nd load KLD files into the kernel
3586d7f5d3SJohn Marino.Sh LIBRARY
3686d7f5d3SJohn Marino.Lb libc
3786d7f5d3SJohn Marino.Sh SYNOPSIS
3886d7f5d3SJohn Marino.In sys/param.h
3986d7f5d3SJohn Marino.In sys/linker.h
4086d7f5d3SJohn Marino.Ft int
4186d7f5d3SJohn Marino.Fn kldload "const char *file"
4286d7f5d3SJohn Marino.Sh DESCRIPTION
4386d7f5d3SJohn MarinoThe function
4486d7f5d3SJohn Marino.Fn kldload
4586d7f5d3SJohn Marinoloads a kld file into the kernel using the kernel linker.
4686d7f5d3SJohn Marino.Sh RETURN VALUES
4786d7f5d3SJohn MarinoThe function
4886d7f5d3SJohn Marino.Fn kldload
4986d7f5d3SJohn Marinoreturns the fileid of the kld file which was loaded into the kernel.
5086d7f5d3SJohn MarinoIf an error occurs,
5186d7f5d3SJohn Marino.Fn kldload
5286d7f5d3SJohn Marinowill return -1 and set
5386d7f5d3SJohn Marino.Va errno
5486d7f5d3SJohn Marinoto indicate the error.
5586d7f5d3SJohn Marino.Sh ERRORS
5686d7f5d3SJohn MarinoThe named file is loaded unless:
5786d7f5d3SJohn Marino.Bl -tag -width Er
5886d7f5d3SJohn Marino.It Bq Er EPERM
5986d7f5d3SJohn MarinoYou do not have access to read the file or link it with the kernel.
6086d7f5d3SJohn MarinoYou should be the root user to be able to use the
6186d7f5d3SJohn Marino.Nm kld
6286d7f5d3SJohn Marinofunctions.
6386d7f5d3SJohn Marino.It Bq Er EFAULT
6486d7f5d3SJohn MarinoBad address encountered when adding kld info into the kernel space.
6586d7f5d3SJohn Marino.It Bq Er ENOMEM
6686d7f5d3SJohn MarinoThere is no memory to load the file into the kernel.
6786d7f5d3SJohn Marino.It Bq Er ENOENT
6886d7f5d3SJohn MarinoThe file was not found.
6986d7f5d3SJohn Marino.It Bq Er ENOEXEC
7086d7f5d3SJohn MarinoThe file format of
7186d7f5d3SJohn Marino.Fa file
7286d7f5d3SJohn Marinowas unrecognized.
7386d7f5d3SJohn Marino.It Bq Er EEXIST
7486d7f5d3SJohn MarinoThe supplied
7586d7f5d3SJohn Marino.Fa file
7686d7f5d3SJohn Marinohas already been loaded.
7786d7f5d3SJohn Marino.El
7886d7f5d3SJohn Marino.Sh SEE ALSO
7986d7f5d3SJohn Marino.Xr kldfind 2 ,
8086d7f5d3SJohn Marino.Xr kldfirstmod 2 ,
8186d7f5d3SJohn Marino.Xr kldnext 2 ,
8286d7f5d3SJohn Marino.Xr kldstat 2 ,
8386d7f5d3SJohn Marino.Xr kldsym 2 ,
8486d7f5d3SJohn Marino.Xr kldunload 2 ,
8586d7f5d3SJohn Marino.Xr modfind 2 ,
8686d7f5d3SJohn Marino.Xr modfnext 2 ,
8786d7f5d3SJohn Marino.Xr modnext 2 ,
8886d7f5d3SJohn Marino.Xr modstat 2 ,
8986d7f5d3SJohn Marino.Xr kld 4 ,
9086d7f5d3SJohn Marino.Xr kldload 8
9186d7f5d3SJohn Marino.Sh HISTORY
9286d7f5d3SJohn MarinoThe
9386d7f5d3SJohn Marino.Nm kld
9486d7f5d3SJohn Marinointerface first appeared in
9586d7f5d3SJohn Marino.Fx 3.0 .
96