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 .\" $DragonFly: src/lib/libcr/i386/sys/Attic/i386_get_ldt.2,v 1.2 2003/06/17 04:26:43 dillon Exp $
  35 .\"
  36 .Dd September 20, 1993
  37 .Dt I386_GET_LDT 2
  38 .Os
  39 .Sh NAME
  40 .Nm i386_get_ldt ,
  41 .Nm i386_set_ldt
  42 .Nd manage i386 per-process Local Descriptor Table entries
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In machine/segments.h
  47 .In machine/sysarch.h
  48 .Ft int
  49 .Fn i386_get_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  50 .Ft int
  51 .Fn i386_set_ldt "int start_sel" "union descriptor *descs" "int num_sels"
  52 .Sh DESCRIPTION
  53 .Fn i386_get_ldt
  54 will return the list of i386 descriptors that the process has in its
  55 LDT.
  56 .Fn i386_set_ldt
  57 will set a list of i386 descriptors for the current process in its
  58 LDT.
  59 Both routines accept a starting selector number
  60 .Fa start_sel ,
  61 an array of memory that
  62 will contain the descriptors to be set or returned
  63 .Fa descs ,
  64 and the number of entries to set or return
  65 .Fa num_sels .
  66 .Pp
  67 The argument
  68 .Fa descs
  69 can be either segment_descriptor or gate_descriptor and are defined in
  70 .Aq Pa i386/segments.h .
  71 These structures are defined by the architecture
  72 as disjoint bit-fields, so care must be taken in constructing them.
  73 .Pp
  74 Note that you must have
  75 .Dq options USER_LDT
  76 in your kernel configuration file to use these functions.
  77 .Sh RETURN VALUES
  78 Upon successful completion,
  79 .Fn i386_get_ldt
  80 returns the number of descriptors currently in the LDT.
  81 .Fn i386_set_ldt
  82 returns the first selector set.
  83 Otherwise, a value of -1 is returned and the global
  84 variable
  85 .Va errno
  86 is set to indicate the error.
  87 .Sh ERRORS
  88 .Fn i386_get_ldt
  89 and
  90 .Fn i386_set_ldt
  91 will fail if:
  92 .Bl -tag -width Er
  93 .It Bq Er EINVAL
  94 An inappropriate parameter was used for
  95 .Fa start_sel
  96 or
  97 .Fa num_sels .
  98 .It Bq Er EACCES
  99 The caller attempted to use a descriptor that would
 100 circumvent protection or cause a failure.
 101 .El
 102 .Sh SEE ALSO
 103 i386 Microprocessor Programmer's Reference Manual, Intel
 104 .Sh WARNING
 105 You can really hose your process using this.