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