lib/libcr/i386/sys/i386_get_ldt.2

   1 .\" Copyright (c) 1980, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     from: @(#)fork.2        6.5 (Berkeley) 3/10/91
  33 .\" $FreeBSD: src/lib/libc/i386/sys/i386_get_ldt.2,v 1.6.2.7 2001/12/14 18:33:54 ru Exp $
  34 .\"
  35 .Dd September 20, 1993
  36 .Dt I386_GET_LDT 2
  37 .Os
  38 .Sh NAME
  39 .Nm i386_get_ldt ,
  40 .Nm i386_set_ldt
  41 .Nd manage i386 per-process Local Descriptor Table entries
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In machine/segments.h
  46 .In machine/sysarch.h
  47 .Ft int
  48 .Fn i386_get_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  49 .Ft int
  50 .Fn i386_set_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  51 .Sh DESCRIPTION
  52 .Fn i386_get_ldt
  53 will return the list of i386 descriptors that the process has in its
  54 LDT.
  55 .Fn i386_set_ldt
  56 will set a list of i386 descriptors for the current process in its
  57 LDT.
  58 Both routines accept a starting selector number
  59 .Fa start_sel ,
  60 an array of memory that
  61 will contain the descriptors to be set or returned
  62 .Fa descs ,
  63 and the number of entries to set or return
  64 .Fa num_sels .
  65 .Pp
  66 The argument
  67 .Fa descs
  68 can be either segment_descriptor or gate_descriptor and are defined in
  69 .Aq Pa i386/segments.h .
  70 These structures are defined by the architecture
  71 as disjoint bit-fields, so care must be taken in constructing them.
  72 .Pp
  73 Note that you must have
  74 .Dq options USER_LDT
  75 in your kernel configuration file to use these functions.
  76 .Sh RETURN VALUES
  77 Upon successful completion,
  78 .Fn i386_get_ldt
  79 returns the number of descriptors currently in the LDT.
  80 .Fn i386_set_ldt
  81 returns the first selector set.
  82 Otherwise, a value of -1 is returned and the global
  83 variable
  84 .Va errno
  85 is set to indicate the error.
  86 .Sh ERRORS
  87 .Fn i386_get_ldt
  88 and
  89 .Fn i386_set_ldt
  90 will fail if:
  91 .Bl -tag -width Er
  92 .It Bq Er EINVAL
  93 An inappropriate parameter was used for
  94 .Fa start_sel
  95 or
  96 .Fa num_sels .
  97 .It Bq Er EACCES
  98 The caller attempted to use a descriptor that would
  99 circumvent protection or cause a failure.
 100 .El
 101 .Sh SEE ALSO
 102 i386 Microprocessor Programmer's Reference Manual, Intel
 103 .Sh WARNING
 104 You can really hose your process using this.