lib/libcr/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 .\"
  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 function
  43 .Fn kldload
  44 loads a kld file into the kernel using the kernel linker.
  45 .Sh RETURN VALUES
  46 The function
  47 .Fn kldload
  48 returns the fileid of the kld file which was loaded into the kernel.
  49 If an error occurs,
  50 .Fn kldload
  51 will return -1 and set
  52 .Va errno
  53 to indicate the error.
  54 .Sh ERRORS
  55 The named file is loaded unless:
  56 .Bl -tag -width Er
  57 .It Bq Er EPERM
  58 You do not have access to read the file or link it with the kernel.
  59 You should be the root user to be able to use the
  60 .Nm kld
  61 functions.
  62 .It Bq Er EFAULT
  63 Bad address encountered when adding kld info into the kernel space.
  64 .It Bq Er ENOMEM
  65 There is no memory to load the file into the kernel.
  66 .It Bq Er ENOENT
  67 The file was not found.
  68 .It Bq Er ENOEXEC
  69 The file format of
  70 .Fa file
  71 was unrecognized.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr kldfind 2 ,
  75 .Xr kldfirstmod 2 ,
  76 .Xr kldnext 2 ,
  77 .Xr kldstat 2 ,
  78 .Xr kldsym 2 ,
  79 .Xr kldunload 2 ,
  80 .Xr modfind 2 ,
  81 .Xr modfnext 2 ,
  82 .Xr modnext 2 ,
  83 .Xr modstat 2 ,
  84 .Xr kld 4 ,
  85 .Xr kldload 8
  86 .Sh HISTORY
  87 The
  88 .Nm kld
  89 interface first appeared in
  90 .Fx 3.0 .