lib/libc/sys/kldload.2

   1 .\"
   2 .\" Copyright (c) 1999 Chris Costello
   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 March 3, 1999
  29 .Dt KLDLOAD 2
  30 .Os
  31 .Sh NAME
  32 .Nm kldload
  33 .Nd load KLD files into the kernel
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/linker.h
  39 .Ft int
  40 .Fn kldload "const char *file"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn kldload
  44 system call
  45 loads a kld file into the kernel using the kernel linker.
  46 .Sh RETURN VALUES
  47 The
  48 .Fn kldload
  49 system call
  50 returns the fileid of the kld file which was loaded into the kernel.
  51 If an error occurs,
  52 .Fn kldload
  53 will return -1 and set
  54 .Va errno
  55 to indicate the error.
  56 .Sh ERRORS
  57 The named file is loaded unless:
  58 .Bl -tag -width Er
  59 .It Bq Er EPERM
  60 You do not have access to read the file or link it with the kernel.
  61 You should be the root user to be able to use the
  62 .Nm kld
  63 system calls.
  64 .It Bq Er EFAULT
  65 Bad address encountered when adding kld info into the kernel space.
  66 .It Bq Er ENOMEM
  67 There is no memory to load the file into the kernel.
  68 .It Bq Er ENOENT
  69 The file was not found.
  70 .It Bq Er ENOEXEC
  71 The file format of
  72 .Fa file
  73 was unrecognized.
  74 .It Bq Er EEXIST
  75 The supplied
  76 .Fa file
  77 has already been loaded.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr kldfind 2 ,
  81 .Xr kldfirstmod 2 ,
  82 .Xr kldnext 2 ,
  83 .Xr kldstat 2 ,
  84 .Xr kldsym 2 ,
  85 .Xr kldunload 2 ,
  86 .Xr modfind 2 ,
  87 .Xr modfnext 2 ,
  88 .Xr modnext 2 ,
  89 .Xr modstat 2 ,
  90 .Xr kld 4 ,
  91 .Xr kldload 8
  92 .Sh HISTORY
  93 The
  94 .Nm kld
  95 interface first appeared in
  96 .Fx 3.0 .